From c119b9371fe623db0b8653df3da60fd06790dc5a Mon Sep 17 00:00:00 2001 From: Seth Silesky <5115498+silesky@users.noreply.github.com> Date: Mon, 3 Apr 2023 15:04:10 -0500 Subject: [PATCH 1/5] add disable setting to node docs --- .../sources/catalog/libraries/server/node/index.md | 2 ++ .../sources/catalog/libraries/server/node/migration.md | 7 +++++-- 2 files changed, 7 insertions(+), 2 deletions(-) diff --git a/src/connections/sources/catalog/libraries/server/node/index.md b/src/connections/sources/catalog/libraries/server/node/index.md index 439300def3..6a25e75fe7 100644 --- a/src/connections/sources/catalog/libraries/server/node/index.md +++ b/src/connections/sources/catalog/libraries/server/node/index.md @@ -286,6 +286,8 @@ Setting | Details `maxEventsInBatch` _number_ | The number of messages to enqueue before flushing. The default is: `15` `flushInterval` _number_ | The number of milliseconds to wait before flushing the queue automatically. The default is: `10000` `httpRequestTimeout` | The maximum number of milliseconds to wait for an http request. The default is: `10000` +`disable` | Disable the analytics library for testing. The default is: `false` + ## Graceful shutdown Avoid losing events after shutting down your console. Call `.closeAndFlush()` to stop collecting new events and flush all existing events. If a callback on an event call is included, this also waits for all callbacks to be called, and any of their subsequent promises to be resolved. diff --git a/src/connections/sources/catalog/libraries/server/node/migration.md b/src/connections/sources/catalog/libraries/server/node/migration.md index ee06225e5e..18352ead9e 100644 --- a/src/connections/sources/catalog/libraries/server/node/migration.md +++ b/src/connections/sources/catalog/libraries/server/node/migration.md @@ -60,9 +60,12 @@ If you're using the [classic version of Analytics Node.js](/docs/connections/sou ``` * The `flushAt` configuration option changed to `maxEventsInBatch`. +* The `flushAt` configuration option changed to `maxEventsInBatch`. + +* The `enable` setting (for disabling analytics during tests) has become `disable`. `enable: false` -> `disable: true`. + #### Removals The updated Analytics Node.js removed these configuration options: -- `enable` - `errorHandler` (see the docs on [error handling](/docs/connections/sources/catalog/libraries/server/node//#error-handling) for more information) The updated Analytics Node.js library removed undocumented behavior around `track` properties @@ -87,4 +90,4 @@ analytics.track({ myProp: 'abc' } }) -``` \ No newline at end of file +``` From e354afd732b6d4245667d6fe92d5c5993b5664b4 Mon Sep 17 00:00:00 2001 From: Seth Silesky <5115498+silesky@users.noreply.github.com> Date: Mon, 3 Apr 2023 17:15:46 -0500 Subject: [PATCH 2/5] Update src/connections/sources/catalog/libraries/server/node/migration.md Co-authored-by: stayseesong <83784848+stayseesong@users.noreply.github.com> --- .../sources/catalog/libraries/server/node/migration.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/connections/sources/catalog/libraries/server/node/migration.md b/src/connections/sources/catalog/libraries/server/node/migration.md index 18352ead9e..43b2b1dd43 100644 --- a/src/connections/sources/catalog/libraries/server/node/migration.md +++ b/src/connections/sources/catalog/libraries/server/node/migration.md @@ -62,7 +62,7 @@ If you're using the [classic version of Analytics Node.js](/docs/connections/sou * The `flushAt` configuration option changed to `maxEventsInBatch`. -* The `enable` setting (for disabling analytics during tests) has become `disable`. `enable: false` -> `disable: true`. +* The `enable` setting (for disabling analytics during tests) became `disable`. `enable: false` changed to `disable: true`. #### Removals The updated Analytics Node.js removed these configuration options: From 2ace0be1a2251039c6e92a6aafc9dec45d72f9e8 Mon Sep 17 00:00:00 2001 From: Seth Silesky <5115498+silesky@users.noreply.github.com> Date: Tue, 4 Apr 2023 12:03:44 -0500 Subject: [PATCH 3/5] get rid of bad copy and paste --- .../sources/catalog/libraries/server/node/migration.md | 2 -- 1 file changed, 2 deletions(-) diff --git a/src/connections/sources/catalog/libraries/server/node/migration.md b/src/connections/sources/catalog/libraries/server/node/migration.md index 43b2b1dd43..bef251b13e 100644 --- a/src/connections/sources/catalog/libraries/server/node/migration.md +++ b/src/connections/sources/catalog/libraries/server/node/migration.md @@ -60,8 +60,6 @@ If you're using the [classic version of Analytics Node.js](/docs/connections/sou ``` * The `flushAt` configuration option changed to `maxEventsInBatch`. -* The `flushAt` configuration option changed to `maxEventsInBatch`. - * The `enable` setting (for disabling analytics during tests) became `disable`. `enable: false` changed to `disable: true`. #### Removals From 797980adb55a430a39a4302a459b803a809ffd2f Mon Sep 17 00:00:00 2001 From: Seth Silesky <5115498+silesky@users.noreply.github.com> Date: Tue, 4 Apr 2023 12:04:35 -0500 Subject: [PATCH 4/5] get rid of extra space --- src/connections/sources/catalog/libraries/server/node/index.md | 1 - 1 file changed, 1 deletion(-) diff --git a/src/connections/sources/catalog/libraries/server/node/index.md b/src/connections/sources/catalog/libraries/server/node/index.md index 6a25e75fe7..867cb888f8 100644 --- a/src/connections/sources/catalog/libraries/server/node/index.md +++ b/src/connections/sources/catalog/libraries/server/node/index.md @@ -288,7 +288,6 @@ Setting | Details `httpRequestTimeout` | The maximum number of milliseconds to wait for an http request. The default is: `10000` `disable` | Disable the analytics library for testing. The default is: `false` - ## Graceful shutdown Avoid losing events after shutting down your console. Call `.closeAndFlush()` to stop collecting new events and flush all existing events. If a callback on an event call is included, this also waits for all callbacks to be called, and any of their subsequent promises to be resolved. From 6a14ed748cbd6aeb4a44a9810e0e023d316971e0 Mon Sep 17 00:00:00 2001 From: Seth Silesky <5115498+silesky@users.noreply.github.com> Date: Wed, 5 Apr 2023 12:34:58 -0500 Subject: [PATCH 5/5] Update src/connections/sources/catalog/libraries/server/node/migration.md Co-authored-by: stayseesong <83784848+stayseesong@users.noreply.github.com> --- .../sources/catalog/libraries/server/node/migration.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/connections/sources/catalog/libraries/server/node/migration.md b/src/connections/sources/catalog/libraries/server/node/migration.md index bef251b13e..4f0dfbf51a 100644 --- a/src/connections/sources/catalog/libraries/server/node/migration.md +++ b/src/connections/sources/catalog/libraries/server/node/migration.md @@ -60,7 +60,7 @@ If you're using the [classic version of Analytics Node.js](/docs/connections/sou ``` * The `flushAt` configuration option changed to `maxEventsInBatch`. -* The `enable` setting (for disabling analytics during tests) became `disable`. `enable: false` changed to `disable: true`. +* The `enable` setting (for disabling analytics during tests) changed to `disable`. `enable: false` changed to `disable: true`. #### Removals The updated Analytics Node.js removed these configuration options: