feat: pollingIntervalMs config param and latest from common (#75)

Author: typotter

docs/node-server-sdk.iclientconfig.md

@@ -23,6 +23,7 @@ export interface IClientConfig
 |  [numInitialRequestRetries?](./node-server-sdk.iclientconfig.numinitialrequestretries.md) |  | number | _(Optional)_ Number of additional times the initial configuration request will be attempted if it fails. This is the request servers typically synchronously wait for completion. A small wait will be done between requests. (Default: 1) |
 |  [numPollRequestRetries?](./node-server-sdk.iclientconfig.numpollrequestretries.md) |  | number | _(Optional)_ Number of additional times polling for updated configurations will be attempted before giving up. Polling is done after a successful initial request. Subsequent attempts are done using an exponential backoff. (Default: 7) |
 |  [pollAfterFailedInitialization?](./node-server-sdk.iclientconfig.pollafterfailedinitialization.md) |  | boolean | _(Optional)_ Poll for new configurations even if the initial configuration request failed. (default: false) |
+|  [pollingIntervalMs?](./node-server-sdk.iclientconfig.pollingintervalms.md) |  | number | _(Optional)_ Amount of time to wait between API calls to refresh configuration data. Default of 30\_000 (30 seconds). |
 |  [requestTimeoutMs?](./node-server-sdk.iclientconfig.requesttimeoutms.md) |  | number | _(Optional)_ \* Timeout in milliseconds for the HTTPS request for the experiment configuration. (Default: 5000) |
 |  [throwOnFailedInitialization?](./node-server-sdk.iclientconfig.throwonfailedinitialization.md) |  | boolean | _(Optional)_ Throw on error if unable to fetch an initial configuration during initialization. (default: true) |
 

docs/node-server-sdk.iclientconfig.pollingintervalms.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@eppo/node-server-sdk](./node-server-sdk.md) &gt; [IClientConfig](./node-server-sdk.iclientconfig.md) &gt; [pollingIntervalMs](./node-server-sdk.iclientconfig.pollingintervalms.md)
+
+## IClientConfig.pollingIntervalMs property
+
+Amount of time to wait between API calls to refresh configuration data. Default of 30\_000 (30 seconds).
+
+**Signature:**
+
+```typescript
+pollingIntervalMs?: number;
+```

node-server-sdk.api.md

@@ -33,6 +33,7 @@ export interface IClientConfig {
     numInitialRequestRetries?: number;
     numPollRequestRetries?: number;
     pollAfterFailedInitialization?: boolean;
+    pollingIntervalMs?: number;
     requestTimeoutMs?: number;
     throwOnFailedInitialization?: boolean;
 }

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@eppo/node-server-sdk",
-  "version": "3.4.0",
+  "version": "3.5.0",
   "description": "Eppo node server SDK",
   "main": "dist/index.js",
   "files": [
@@ -29,7 +29,7 @@
   },
   "homepage": "https://github.com/Eppo-exp/node-server-sdk#readme",
   "dependencies": {
-    "@eppo/js-client-sdk-common": "4.2.0",
+    "@eppo/js-client-sdk-common": "4.3.0",
     "lru-cache": "^10.0.1"
   },
   "devDependencies": {

src/index.spec.ts

@@ -27,7 +27,7 @@ import {
 
 import { getInstance, IAssignmentEvent, IAssignmentLogger, init } from '.';
 
-const { POLL_INTERVAL_MS, POLL_JITTER_PCT } = constants;
+const { DEFAULT_POLL_INTERVAL_MS, POLL_JITTER_PCT } = constants;
 
 describe('EppoClient E2E test', () => {
   const mockLogger: IAssignmentLogger = {
@@ -315,7 +315,7 @@ describe('EppoClient E2E test', () => {
   });
 
   describe('initialization errors', () => {
-    const maxRetryDelay = POLL_INTERVAL_MS * POLL_JITTER_PCT;
+    const maxRetryDelay = DEFAULT_POLL_INTERVAL_MS * POLL_JITTER_PCT;
     const mockConfigResponse = {
       flags: {
         [flagKey]: mockUfcFlagConfig,
@@ -380,7 +380,7 @@ describe('EppoClient E2E test', () => {
       );
 
       // Expect no further configuration requests
-      await jest.advanceTimersByTimeAsync(POLL_INTERVAL_MS);
+      await jest.advanceTimersByTimeAsync(DEFAULT_POLL_INTERVAL_MS);
       expect(callCount).toBe(1);
     });
 
@@ -419,7 +419,7 @@ describe('EppoClient E2E test', () => {
         'default-value',
       );
 
-      await jest.advanceTimersByTimeAsync(POLL_INTERVAL_MS);
+      await jest.advanceTimersByTimeAsync(DEFAULT_POLL_INTERVAL_MS);
 
       // Expect a new call from poller
       expect(callCount).toBe(3);

src/index.ts

@@ -65,6 +65,11 @@ export interface IClientConfig {
    * Poll for new configurations even if the initial configuration request failed. (default: false)
    */
   pollAfterFailedInitialization?: boolean;
+
+  /**
+   * Amount of time to wait between API calls to refresh configuration data. Default of 30_000 (30 seconds).
+   */
+  pollingIntervalMs?: number;
 }
 
 export {
@@ -97,6 +102,7 @@ export async function init(config: IClientConfig): Promise<EppoClient> {
     numPollRequestRetries: config.numPollRequestRetries ?? undefined,
     pollAfterSuccessfulInitialization: true, // For servers, we always want to keep polling for the life of the server
     pollAfterFailedInitialization: config.pollAfterFailedInitialization ?? false,
+    pollingIntervalMs: config.pollingIntervalMs ?? undefined,
     throwOnFailedInitialization: config.throwOnFailedInitialization ?? true,
   };
 

yarn.lock

@@ -460,10 +460,10 @@
   resolved "https://registry.npmjs.org/@bcoe/v8-coverage/-/v8-coverage-0.2.3.tgz"
   integrity sha512-0hYQ8SB4Db5zvZB4axdMHGwEaQjkZzFjQiN9LVYvIFB2nSUHW9tYpxWriPrWDASIxiaXax83REcLxuSdnGPZtw==
 
-"@eppo/js-client-sdk-common@4.2.0":
-  version "4.2.0"
-  resolved "https://registry.yarnpkg.com/@eppo/js-client-sdk-common/-/js-client-sdk-common-4.2.0.tgz#713910bf7c5291300d48b408bced995ae00e2834"
-  integrity sha512-DzT3q1jwpb8yEgKLtPzCxaW6X+rUmYuX5jnGqPzLM2WDlfZ0rkUdDqBt9lzw76DkSZu+C7dpzHcH9EnWuDms8w==
+"@eppo/js-client-sdk-common@4.3.0":
+  version "4.3.0"
+  resolved "https://registry.yarnpkg.com/@eppo/js-client-sdk-common/-/js-client-sdk-common-4.3.0.tgz#66c0e5904091ac1a9c2bc3bf4017637b13404ce8"
+  integrity sha512-ur270vCZjUuKuEohF1vH7yh1MBxtDbVcduCJzJmJ6m7kjoyvqNPzG/+lYPEol6Bpr9wV42ciIB+A1cYeNZ7gSA==
   dependencies:
     js-base64 "^3.7.7"
     md5 "^2.3.0"