feat: check-ins configuration api #1241
Conversation
|
I moved the last 3 TODO points to #1243 because this PR is already too big and a review will be difficult. |
| @@ -290,7 +289,7 @@ export function sanitize(obj, maxDepth = 8) { | |||
| return safeSerialize(obj) | |||
| } | |||
|
|
|||
| export function logger(client: Client): Logger { | |||
| export function logger(client: { config: { debug: boolean; logger: Logger; } }): Logger { | |||
There was a problem hiding this comment.
Support more than one client (CheckinsClient and HoneybadgerClient)
| defaultHeaders(): Record<string, string> { | ||
| return {}; | ||
| } | ||
| send<T>(_options: TransportOptions, _payload: T): Promise<{ statusCode: number; body: string }> { |
There was a problem hiding this comment.
Made the payload to be generic because I didn't want to define the payload for check-ins here (check-ins are not part of the core package)
There was a problem hiding this comment.
Project that demonstrates npx honeybadger-checkins-sync.
| @@ -127,6 +164,7 @@ const singleton = new Honeybadger({ | |||
| uncaughtException(), | |||
| unhandledRejection() | |||
| ], | |||
| ...(readConfigFromFileSystem() ?? {}) | |||
There was a problem hiding this comment.
This line allows loading configuration from a file.
| 'util', | ||
| 'domain', | ||
| 'async_hooks', | ||
| 'cosmiconfig', |
There was a problem hiding this comment.
I'm not entirely sure about this.
My reasoning is:
- this is the server bundle, we want to transform to multiple targets (formats),
- but it can require external modules (i.e. from node_modules)
However, we want the browser bundles to be single files so they can be loaded from the CDN.
This reverts commit 4073ae4.
Status
READY
Description
Check-Ins configuration through the SDK, similar to the Laravel/PHP implementation.
Closes #1208.
Related PRs
Todos
Honeybadger.checkin(checkinName)<- should not throw errorsBonus:
honeybadger.config.js(only for js on the server) - adds dependency to cosmicconfigTests for reading config from fileTests for configuration precedence: config file, constructor parameters, default valuesDocumentation for configuration file - #375