Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Good 5.0.0 Release Notes #270

Closed
arb opened this issue Dec 3, 2014 · 0 comments
Closed

Good 5.0.0 Release Notes #270

arb opened this issue Dec 3, 2014 · 0 comments
Assignees
Milestone

Comments

@arb
Copy link
Contributor

@arb arb commented Dec 3, 2014

Summary

The main goal of the 5.0.0 release was to make this good compatible with the changes in hapi 8. A few options were removed and some event names were changed to be more in line with hapi. These changes are outlined below.

  • Upgrade time: low - if you've already updated your servers to hapi8, the hard part is done.
  • Complexity: low - change your options and your version of hapi
  • Risk: low to moderate - possible some cases have changed with the change to hapi8 with how events are emitted and when they occur
  • Dependencies: low - removed async dependency in favor of items.

Breaking Changes

  • Removed extendedRequests option. request.getLog() is always attached to event.log now.
  • Renamed 'request' event to 'response' because it was more accurate to what was happening inside Good and Hapi.
  • The raw error object is now attached to the 'error' event payload. stack and message were removed.
  • requestEvent option renamed to responseEvent

New Features

  • Network monitoring was completely rewritten and should be more accurate now

Updated Dependencies

  • lab from version 4 to version 5
  • added code version 1
  • added items version 1
  • removed async

Migration

  • If you were using the requestEvent option, change to responseEvent.
  • If you had the option extendedRequests set, remove it as this will throw an error if it's present.
  • Any custom logic looking at the event payload for 'error' events should now have direct access to the raw error object via eventData.error. You can access stack and message from there.
  • Any custom logic based on event type needs to be revisited and updated
  • If you are using good-console, you will need to be running the latest version (3.x.x). At present, it is not the latest version, specify version 3.0.0 during install.
  • The options into the individual reporter objects need to be updated to account for the event name change ('request' to 'response'):
var options = {
    reporters: [{
        reporter: require('good-file'),
        args: ['./__log.log', {
            request: '*'
        }]
    }]
};

needs to be

var options = {
    reporters: [{
        reporter: require('good-file'),
        args: ['./__log.log', {
            response: '*'
        }]
    }]
};
@arb arb added this to the 5.0.0 milestone Dec 3, 2014
@arb arb self-assigned this Dec 3, 2014
@arb arb closed this Dec 10, 2014
@arb arb changed the title 5.0.0 Release Notes Good 5.0.0 Release Notes Apr 3, 2015
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
1 participant
You can’t perform that action at this time.