WIP Release/v0.13.11 #71

michaloo · 2018-03-15T08:37:57Z

tl;dr

PR adds custom Error classes which when thrown or passed to promise rejection will be treated differently - it won't be sent to sentry but a datadog metric connector.transient_error with two tags error_name and error_message will be instrumented to see the rate of specific error and optionally bubble up to an internal alert or customer facing information.

full changelog:

this release brings bigger changes to error handling:
- it cleans up a little middleware stack including smart-notifier errors
- it introduces two types of errors - unhandled error which is handled the same as till now, and transient error which won't be pushed to sentry, but only instrumented in datadog
- it deprecates dedicated smartNotifierErrorMiddleware
- smartNotifierHandler in case of error behaves like notifHandler and pass the error down the middleware stack
added timeout option to Hull.Connector constructor to control the timeout value
upgrades raven library
flow types fixes

* **Deprecation** Renamed `userHandlerOptions` to `options` in notifyHandler

unity · 2018-03-15T08:57:46Z

@michaloo can you document usage examples in readme.md

_{Sent with GitHawk}

unity · 2018-03-15T13:34:05Z

README.md

-  return Promise.resolve();
-}
-```
+Hull Node promotes using [SuperAgent](http://visionmedia.github.io/superagent/) as a core HTTP client. We provide two plugins to add more instrumentation over the requests.


@michaloo missing the actual plugins descriptions here

michaloo · 2018-03-15T14:08:58Z

@unity sure, still doing major moves between README.md (focused around how-to and getting started and examples) and API.md (precise and exact information about tools you already know how to use). Thanks for fixes.

…ease/v0.13.11

…h-accounts

[WIP] Add support for batch handlers for accounts

unity · 2018-03-22T14:44:54Z

API.md

+
+Returns **[Function][61]** 
+
+## Types


Weird to have Types in the middle of the rest.

unity · 2018-03-22T14:45:08Z

API.md

+
+Connector (also called ship) object with settings, private settings and manifest.json
+
+Type: {id: [string][58], updated_at: [string][58], created_at: [string][58], name: [string][58], description: [string][58], tags: [Array][64]&lt;[string][58]>, manifest: [Object][57], settings: [Object][57], private_settings: [Object][57], status: [Object][57]}


Formatting broken

unity · 2018-03-22T14:45:19Z

API.md

+Context added to the express app request by hull-node connector sdk.
+Accessible via `req.hull` param.
+
+Type: {requestId: [string][58], config: [Object][57], token: [string][58], client: [Object][57], ship: THullConnector, connector: THullConnector, hostname: [string][58], options: [Object][57], connectorConfig: [Object][57], segments: [Array][64]&lt;THullSegment>, cache: [Object][57], metric: [Object][57], enqueue: [Function][61], helpers: [Object][57], service: [Object][57], shipApp: [Object][57], message: [Object][57]?, notification: [Object][57], smartNotifierResponse: [Object][57]?}


Formatting broken

unity · 2018-03-22T14:47:10Z

API.md

+
+Returns **[Promise][62]** 
+
+## Context


missing introductory paragraph with a code snippet of all the possible items? like on https://github.com/hull/hull-node/blob/develop/API.md#hullconnector

unity · 2018-03-22T14:50:16Z

API.md

+
+Returns **http.Server** 
+
+## Errors


Is it possible to reorder content?
I'd do:

HullConnector

Hull.Middleware

Context

Infra

Utils

Helpers (btw, seems redundant to have Utils & Helpers - but that's probably a refactor)

Types

Errors

good one, I will set that order. Thanks for input.

unity · 2018-03-22T14:53:39Z

API.md

+
+### cache
+
+Cache available as `req.hull.cache` object


Maybe a quick line on Usage and how it relates to CacheAgent would help here.

unity · 2018-03-22T14:54:06Z

API.md

+
+### metric
+
+Metric agent available as `req.hull.metric` object


Some simple code sample of usage would help

unity · 2018-03-22T14:56:53Z

API.md

+
+**Properties**
+
+-   `requestId` **[string][58]** 


Is it possible to render it as raw JS ?

I feel here a format such as

type { requestId: string }

would be much more explicit

unity · 2018-03-22T14:57:41Z

API.md

+
+General utilities
+
+### notifHandler


Do we want to document this since it's deprecated ?

unity · 2018-03-22T14:59:04Z

API.md

+
+### smartNotifierHandler
+
+`smartNotifierHandler` is a next generation `notifHandler` cooperating with our internal notification tool. It handles Backpressure, throttling and retries for you and lets you adapt to any external rate limiting pattern.


If we're deprecating notifHandler we don't want to refer to it here I guess. And we can rename internal notification tool to Kraken.

michaloo and others added 8 commits January 24, 2018 14:23

Typings and error passing

8da4574

Version bump

5b137ce

Merge branch 'master' of github.com:hull/hull-node into hotfix/v0.13.11

55c9335

Fixed error handling flow

06c3a1b

Adds missing deps

9aac472

Add timeout middleware stops

d83188e

Adds superagentErrorPlugin to all utils export

1235522

* Add support for batch handlers for accounts

d34b11b

* **Deprecation** Renamed `userHandlerOptions` to `options` in notifyHandler

Upgrade docs

53594b9

SMK1085 approved these changes Mar 15, 2018

View reviewed changes

spelling and formatting fixes

a260e44

unity reviewed Mar 15, 2018

View reviewed changes

Upgrade docs

90672d0

michaloo and others added 15 commits March 15, 2018 15:09

Merge branch 'release/v0.13.11' of github.com:hull/hull-node into rel…

394ed28

…ease/v0.13.11

Fix tests

6a4d5e0

Auto docs update

ddc4997

Fix segments key for accounts in extract handler

60b96f2

WIP - outgoing/incoming data flow sections

9b82b19

WIP - more sections of the readme.md

5437c79

Upgrade dependencies

2073cd0

WIP - errors support

eb2bc8d

Better errors docs

6ec5688

Merge branch 'develop' of github.com:hull/hull-node into feature/batc…

cf5f0da

…h-accounts

Add missing error class

f453b12

Merge branch 'develop' of github.com:hull/hull-node into feature/batc…

fe56ff0

…h-accounts

Fixes

bafc010

Fix linking

a68a17c

Tests

db0dc3d

michaloo added 5 commits March 22, 2018 15:19

Remove obsolete test

d461a61

Merge pull request #70 from hull/feature/batch-accounts

9f9d6b8

[WIP] Add support for batch handlers for accounts

Improve docs

42d7afd

Prevent types from showing up in public docs

29f134e

Update docs

7a1b9f2

unity reviewed Mar 22, 2018

View reviewed changes

michaloo added 4 commits March 22, 2018 16:17

Docs improvement

461dbce

Improve docs

a932e32

Updates segments docs

7872ffe

Small docs fixes

88def43

michaloo merged commit c50c701 into master Mar 22, 2018

michaloo deleted the release/v0.13.11 branch March 22, 2018 16:48

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

WIP Release/v0.13.11 #71

WIP Release/v0.13.11 #71

michaloo commented Mar 15, 2018

unity commented Mar 15, 2018

unity Mar 15, 2018

michaloo commented Mar 15, 2018

unity Mar 22, 2018

unity Mar 22, 2018

unity Mar 22, 2018

unity Mar 22, 2018

unity Mar 22, 2018

michaloo Mar 22, 2018

unity Mar 22, 2018

unity Mar 22, 2018

unity Mar 22, 2018

unity Mar 22, 2018

unity Mar 22, 2018


		Connector (also called ship) object with settings, private settings and manifest.json

		Type: {id: [string][58], updated_at: [string][58], created_at: [string][58], name: [string][58], description: [string][58], tags: [Array][64]<[string][58]>, manifest: [Object][57], settings: [Object][57], private_settings: [Object][57], status: [Object][57]}


		### metric

		Metric agent available as `req.hull.metric` object


		### smartNotifierHandler

		`smartNotifierHandler` is a next generation `notifHandler` cooperating with our internal notification tool. It handles Backpressure, throttling and retries for you and lets you adapt to any external rate limiting pattern.

WIP Release/v0.13.11 #71

WIP Release/v0.13.11 #71

Conversation

michaloo commented Mar 15, 2018

unity commented Mar 15, 2018

Choose a reason for hiding this comment

michaloo commented Mar 15, 2018

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment