Update to new interface of Good and es6 #67

thebergamo · 2016-03-18T18:43:55Z

Well, this is a refactoring inspired for the issues #63 #64 and #65.

@arb can review?

NOTE: Well, I started this refactoring before the PR #66 are pushed, I have some delay to understand the new interface of Good and deal with Stream was a good xp.


        migrate to es6 classes and new good api

arb · 2016-03-18T19:04:00Z

.travis.yml

@@ -2,5 +2,5 @@ sudo: false
 language: node_js

 node_js:
-  - 0.10
-  - 4
+  - 4 


Need to be "4" and "node"

arb · 2016-03-18T19:04:53Z

README.md

-## Good Console Methods
-### `goodconsole.init(stream, emitter, callback)`
-Initializes the reporter with the following arguments:
+## Usage 


So this is just a standard transform stream. It's not tied to good at all so I don't think we need this usage here.

You should also mention that this stream is always in objectMode.

arb · 2016-03-18T19:07:53Z

lib/index.js

-    this._settings = Hoek.applyToDefaults(internals.defaults, config);
-    this._filter = new Squeeze(events);
-};
+class GoodConsole extends Stream {


Needs to be Stream.Transform

In this case I use const Stream = require('stream').Transform; above.

I'd prefer to see Streams.Transform here so it's very clear what kind of stream this is.

arb · 2016-03-18T19:09:22Z

lib/index.js


-        /*eslint-disable */


What happened to this logic? We need this still somewhere.

tags isn't used on all events. Just in events: response (but is in event.logs[i].tags) log and request event.

If you look at the old code, I normalized this so that every event did include tags and the first tag was always the eventName.

arb · 2016-03-18T19:10:49Z

lib/index.js

-        } else if (data.tags != null) {
-            tags = [data.tags];
+        if (eventName === 'error') {
+            return next(null, this._formatError(data));


Rather than attaching this._formatError and this.formatOps and all the other formatters to this, just make them utility functions in this file since the consumer should never have a need to call them directly.

arb · 2016-03-18T19:12:56Z

lib/schema.js

+
+const Joi = require('joi');
+
+exports.reporter = Joi.object().keys({


Using joi here is kind of overkill. Just use the default values logic that was there before.

arb · 2016-03-18T19:13:15Z

package.json

@@ -9,22 +9,17 @@
    "test-cov-html": "lab -r html -o coverage.html -La code"


Remove this while you're in there.

ok, coverage report will no more generated?

arb · 2016-03-18T19:14:18Z

test/index.js

@@ -1,24 +1,29 @@
+'use strict';


Please add the { plan: n } option to every test.

arb · 2016-03-18T19:14:55Z

test/index.js

-
-        done();
-    });
+    it('throws an error if GoodConsole is called without "new"', (done) => {


Don't need this anymore.

arb · 2016-03-18T19:15:18Z

test/index.js

-        var reporter = GoodConsole({ log: '*' });
-        expect(reporter._settings).to.exist();
+        const reporter = new GoodConsole();
+        expect(reporter).to.exist();


If you're going to keep this test, do an instanceof check.

arb · 2016-03-18T19:15:39Z

test/index.js


-                StandIn.replace(process.stdout, 'write', function (stand, string, enc, callback) {
+            it('return a formatted string for "response" events', (done) => {


arb · 2016-03-18T19:16:59Z

test/index.js


-                event.timestamp = now;
+                const response = Hoek.clone(internals.response);


Rather than Hoek.clone, I think you can use Object.assign for the whole file.

arb · 2016-03-18T19:18:30Z

test/fixture/streams.js

+const Stream = require('stream');
+
+class Writer extends Stream.Writable {
+    constructor(objectMode) {


Since this is only used in objectMode, you don't need it as a parameter, just set it to true.

arb · 2016-03-18T19:18:44Z

test/fixture/streams.js

+
+        super({ objectMode });
+        this.data = [];
+        this.once('finish', () => {


You don't test this anywhere so it can probably be removed.

thebergamo · 2016-03-18T21:55:50Z

@arb can review?

arb · 2016-03-19T02:28:45Z

README.md

@@ -10,33 +10,23 @@ Lead Maintainer: [Adam Bretz](https://github.com/arb)

 `good-console` is a [good](https://github.com/hapijs/good) reporter implementation to write [hapi](http://hapijs.com/) server events to the console.


Change this to read something about a transform stream into formatted strings.

arb · 2016-03-19T02:31:05Z

test/index.js

+        const reporter = new GoodConsole();
+        expect(reporter).to.exist();
+        expect(reporter).to.be.instanceof(GoodConsole);
+        expect(reporter.settings).to.exist();


thebergamo · 2016-03-19T03:23:14Z

any other tips?

arb · 2016-03-21T13:17:53Z

lib/index.js

-    if (typeof event.responsePayload === 'object' && event.responsePayload) {
-        responsePayload = 'response payload: ' + SafeStringify(event.responsePayload);
+        config = config || {};
+        this.settings = Hoek.applyToDefaults(internals.defaults, config);


this._settings since we want to keep people out.

arb · 2016-03-21T13:21:32Z

test/index.js


-                internals.response.timestamp = now;
+    describe('report', () => {


At the end of each test, call you push null through the read stream? Just to make sure good-console deals with nulls in the expected fashion.


        refactoring to new features of es6 and new interface of good. Closes #63

Closes #64 Closes #65

thebergamo · 2016-03-21T16:33:04Z

I update de README.md with the tags information on the example of outputs.

thebergamo · 2016-03-22T20:50:38Z

@arb some news?

arb · 2016-03-22T23:37:22Z

@thebergamo I haven't forgotten; I will get to it when I can.

thebergamo · 2016-03-22T23:45:44Z

ok, sorry for my impatience :(

migrate to es6 classes and new good api

46c6676

thebergamo force-pushed the thebergamo:updates branch from b295d2e to 6fa0128 Mar 18, 2016

arb self-assigned this Mar 18, 2016

arb added this to the 6.0.0 milestone Mar 18, 2016

arb added the breaking changes label Mar 18, 2016