flagsmith-nodejs 6.1.0 → 6.2.0

package/build/cjs/sdk/index.js

@@ -279,6 +279,7 @@ class Flagsmith {
         if (this.environmentKey) {
             headers['X-Environment-Key'] = this.environmentKey;
         }
+        headers['User-Agent'] = (0, utils_js_1.getUserAgent)();
         if (this.customHeaders) {
             for (const [k, v] of Object.entries(this.customHeaders)) {
                 headers[k] = v;
@@ -293,7 +294,7 @@ class Flagsmith {
         if (data.status !== 200) {
             throw new errors_js_1.FlagsmithAPIError(`Invalid request made to Flagsmith API. Response status code: ${data.status}`);
         }
-        return data.json();
+        return { response: data, data: await data.json() };
     }
     /**
      * This promise ensures that the environment is retrieved before attempting to locally evaluate.
@@ -320,8 +321,43 @@ class Flagsmith {
         if (!this.environmentUrl) {
             throw new Error('`apiUrl` argument is missing or invalid.');
         }
-        const environment_data = await this.getJSONResponse(this.environmentUrl, 'GET');
-        return (0, util_js_1.buildEnvironmentModel)(environment_data);
+        const startTime = Date.now();
+        const documents = [];
+        let url = this.environmentUrl;
+        let loggedWarning = false;
+        while (true) {
+            try {
+                if (!loggedWarning) {
+                    const elapsedMs = Date.now() - startTime;
+                    if (elapsedMs > this.environmentRefreshIntervalSeconds * 1000) {
+                        this.logger.warn(`Environment document retrieval exceeded the polling interval of ${this.environmentRefreshIntervalSeconds} seconds.`);
+                        loggedWarning = true;
+                    }
+                }
+                const { response, data } = await this.getJSONResponse(url, 'GET');
+                documents.push(data);
+                const linkHeader = response.headers.get('link');
+                if (linkHeader) {
+                    const nextMatch = linkHeader.match(/<([^>]+)>;\s*rel="next"/);
+                    if (nextMatch) {
+                        const relativeUrl = decodeURIComponent(nextMatch[1]);
+                        url = new URL(relativeUrl, this.apiUrl).href;
+                        continue;
+                    }
+                }
+                break;
+            }
+            catch (error) {
+                throw error;
+            }
+        }
+        // Compile the document
+        const compiledDocument = documents[0];
+        for (let i = 1; i < documents.length; i++) {
+            compiledDocument.identity_overrides = compiledDocument.identity_overrides || [];
+            compiledDocument.identity_overrides.push(...(documents[i].identity_overrides || []));
+        }
+        return (0, util_js_1.buildEnvironmentModel)(compiledDocument);
     }
     async getEnvironmentFlagsFromDocument() {
         const environment = await this.getEnvironment();
@@ -357,7 +393,7 @@ class Flagsmith {
         if (!this.environmentFlagsUrl) {
             throw new Error('`apiUrl` argument is missing or invalid.');
         }
-        const apiFlags = await this.getJSONResponse(this.environmentFlagsUrl, 'GET');
+        const { data: apiFlags } = await this.getJSONResponse(this.environmentFlagsUrl, 'GET');
         const flags = models_js_1.Flags.fromAPIFlags({
             apiFlags: apiFlags,
             analyticsProcessor: this.analyticsProcessor,
@@ -373,7 +409,7 @@ class Flagsmith {
             throw new Error('`apiUrl` argument is missing or invalid.');
         }
         const data = (0, utils_js_1.generateIdentitiesData)(identifier, traits, transient);
-        const jsonResponse = await this.getJSONResponse(this.identitiesUrl, 'POST', data);
+        const { data: jsonResponse } = await this.getJSONResponse(this.identitiesUrl, 'POST', data);
         const flags = models_js_1.Flags.fromAPIFlags({
             apiFlags: jsonResponse['flags'],
             analyticsProcessor: this.analyticsProcessor,

package/build/cjs/sdk/utils.d.ts

@@ -56,4 +56,5 @@ export declare class Deferred<T> {
     resolve(value: T | PromiseLike<T>): void;
     reject(reason?: unknown): void;
 }
+export declare function getUserAgent(): string;
 export {};

package/build/cjs/sdk/utils.js

@@ -1,6 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Deferred = exports.retryFetch = exports.delay = exports.generateIdentitiesData = exports.isTraitConfig = void 0;
+exports.getUserAgent = exports.Deferred = exports.retryFetch = exports.delay = exports.generateIdentitiesData = exports.isTraitConfig = void 0;
+const FLAGSMITH_USER_AGENT = 'flagsmith-nodejs-sdk';
+const FLAGSMITH_UNKNOWN_VERSION = 'unknown';
 function isTraitConfig(traitValue) {
     return !!traitValue && typeof traitValue == 'object' && traitValue.value !== undefined;
 }
@@ -93,3 +95,14 @@ class Deferred {
     }
 }
 exports.Deferred = Deferred;
+function getUserAgent() {
+    try {
+        const packageJson = require('../package.json');
+        const version = packageJson?.version;
+        return version ? `${FLAGSMITH_USER_AGENT}/${version}` : FLAGSMITH_UNKNOWN_VERSION;
+    }
+    catch {
+        return FLAGSMITH_UNKNOWN_VERSION;
+    }
+}
+exports.getUserAgent = getUserAgent;

package/build/esm/sdk/analytics.js

@@ -1,4 +1,5 @@
 import { pino } from 'pino';
+import { getUserAgent } from './utils.js';
 export const ANALYTICS_ENDPOINT = './analytics/flags/';
 /** Duration in seconds to wait before trying to flush collected data after {@link trackFeature} is called. **/
 const ANALYTICS_TIMER = 10;
@@ -44,7 +45,8 @@ export class AnalyticsProcessor {
                 signal: AbortSignal.timeout(this.requestTimeoutMs),
                 headers: {
                     'Content-Type': 'application/json',
-                    'X-Environment-Key': this.environmentKey
+                    'X-Environment-Key': this.environmentKey,
+                    'User-Agent': getUserAgent()
                 }
             });
             await this.currentFlush;

package/build/esm/sdk/index.js

@@ -6,7 +6,7 @@ import { ANALYTICS_ENDPOINT, AnalyticsProcessor } from './analytics.js';
 import { FlagsmithAPIError } from './errors.js';
 import { Flags } from './models.js';
 import { EnvironmentDataPollingManager } from './polling_manager.js';
-import { Deferred, generateIdentitiesData, retryFetch } from './utils.js';
+import { Deferred, generateIdentitiesData, getUserAgent, retryFetch } from './utils.js';
 import { getIdentitySegments } from '../flagsmith-engine/segments/evaluators.js';
 import { pino } from 'pino';
 export { AnalyticsProcessor } from './analytics.js';
@@ -269,6 +269,7 @@ export class Flagsmith {
         if (this.environmentKey) {
             headers['X-Environment-Key'] = this.environmentKey;
         }
+        headers['User-Agent'] = getUserAgent();
         if (this.customHeaders) {
             for (const [k, v] of Object.entries(this.customHeaders)) {
                 headers[k] = v;
@@ -283,7 +284,7 @@ export class Flagsmith {
         if (data.status !== 200) {
             throw new FlagsmithAPIError(`Invalid request made to Flagsmith API. Response status code: ${data.status}`);
         }
-        return data.json();
+        return { response: data, data: await data.json() };
     }
     /**
      * This promise ensures that the environment is retrieved before attempting to locally evaluate.
@@ -310,8 +311,43 @@ export class Flagsmith {
         if (!this.environmentUrl) {
             throw new Error('`apiUrl` argument is missing or invalid.');
         }
-        const environment_data = await this.getJSONResponse(this.environmentUrl, 'GET');
-        return buildEnvironmentModel(environment_data);
+        const startTime = Date.now();
+        const documents = [];
+        let url = this.environmentUrl;
+        let loggedWarning = false;
+        while (true) {
+            try {
+                if (!loggedWarning) {
+                    const elapsedMs = Date.now() - startTime;
+                    if (elapsedMs > this.environmentRefreshIntervalSeconds * 1000) {
+                        this.logger.warn(`Environment document retrieval exceeded the polling interval of ${this.environmentRefreshIntervalSeconds} seconds.`);
+                        loggedWarning = true;
+                    }
+                }
+                const { response, data } = await this.getJSONResponse(url, 'GET');
+                documents.push(data);
+                const linkHeader = response.headers.get('link');
+                if (linkHeader) {
+                    const nextMatch = linkHeader.match(/<([^>]+)>;\s*rel="next"/);
+                    if (nextMatch) {
+                        const relativeUrl = decodeURIComponent(nextMatch[1]);
+                        url = new URL(relativeUrl, this.apiUrl).href;
+                        continue;
+                    }
+                }
+                break;
+            }
+            catch (error) {
+                throw error;
+            }
+        }
+        // Compile the document
+        const compiledDocument = documents[0];
+        for (let i = 1; i < documents.length; i++) {
+            compiledDocument.identity_overrides = compiledDocument.identity_overrides || [];
+            compiledDocument.identity_overrides.push(...(documents[i].identity_overrides || []));
+        }
+        return buildEnvironmentModel(compiledDocument);
     }
     async getEnvironmentFlagsFromDocument() {
         const environment = await this.getEnvironment();
@@ -347,7 +383,7 @@ export class Flagsmith {
         if (!this.environmentFlagsUrl) {
             throw new Error('`apiUrl` argument is missing or invalid.');
         }
-        const apiFlags = await this.getJSONResponse(this.environmentFlagsUrl, 'GET');
+        const { data: apiFlags } = await this.getJSONResponse(this.environmentFlagsUrl, 'GET');
         const flags = Flags.fromAPIFlags({
             apiFlags: apiFlags,
             analyticsProcessor: this.analyticsProcessor,
@@ -363,7 +399,7 @@ export class Flagsmith {
             throw new Error('`apiUrl` argument is missing or invalid.');
         }
         const data = generateIdentitiesData(identifier, traits, transient);
-        const jsonResponse = await this.getJSONResponse(this.identitiesUrl, 'POST', data);
+        const { data: jsonResponse } = await this.getJSONResponse(this.identitiesUrl, 'POST', data);
         const flags = Flags.fromAPIFlags({
             apiFlags: jsonResponse['flags'],
             analyticsProcessor: this.analyticsProcessor,

package/build/esm/sdk/utils.d.ts

@@ -56,4 +56,5 @@ export declare class Deferred<T> {
     resolve(value: T | PromiseLike<T>): void;
     reject(reason?: unknown): void;
 }
+export declare function getUserAgent(): string;
 export {};

package/build/esm/sdk/utils.js

@@ -1,3 +1,5 @@
+const FLAGSMITH_USER_AGENT = 'flagsmith-nodejs-sdk';
+const FLAGSMITH_UNKNOWN_VERSION = 'unknown';
 export function isTraitConfig(traitValue) {
     return !!traitValue && typeof traitValue == 'object' && traitValue.value !== undefined;
 }
@@ -85,3 +87,13 @@ export class Deferred {
         this.rejectPromise(reason);
     }
 }
+export function getUserAgent() {
+    try {
+        const packageJson = require('../package.json');
+        const version = packageJson?.version;
+        return version ? `${FLAGSMITH_USER_AGENT}/${version}` : FLAGSMITH_UNKNOWN_VERSION;
+    }
+    catch {
+        return FLAGSMITH_UNKNOWN_VERSION;
+    }
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "flagsmith-nodejs",
-  "version": "6.1.0",
+  "version": "6.2.0",
   "description": "Flagsmith lets you manage features flags and remote config across web, mobile and server side applications. Deliver true Continuous Integration. Get builds out faster. Control who has access to new features.",
   "main": "./build/cjs/index.js",
   "type": "module",

package/release-please-config.json

@@ -0,0 +1,62 @@
+{
+    "bootstrap-sha": "644c5c883ecbb3786507b50cea01903dc2e533bf",
+    "packages": {
+        ".": {
+            "release-type": "node",
+            "changelog-path": "CHANGELOG.md",
+            "bump-minor-pre-major": false,
+            "bump-patch-for-minor-pre-major": false,
+            "draft": false,
+            "prerelease": false,
+            "include-component-in-tag": false
+        }
+    },
+    "$schema": "https://raw.githubusercontent.com/googleapis/release-please/main/schemas/config.json",
+    "changelog-sections": [
+        {
+            "type": "feat",
+            "hidden": false,
+            "section": "Features"
+        },
+        {
+            "type": "fix",
+            "hidden": false,
+            "section": "Bug Fixes"
+        },
+        {
+            "type": "ci",
+            "hidden": false,
+            "section": "CI"
+        },
+        {
+            "type": "docs",
+            "hidden": false,
+            "section": "Docs"
+        },
+        {
+            "type": "deps",
+            "hidden": false,
+            "section": "Dependency Updates"
+        },
+        {
+            "type": "perf",
+            "hidden": false,
+            "section": "Performance Improvements"
+        },
+        {
+            "type": "refactor",
+            "hidden": false,
+            "section": "Refactoring"
+        },
+        {
+            "type": "test",
+            "hidden": false,
+            "section": "Tests"
+        },
+        {
+            "type": "chore",
+            "hidden": false,
+            "section": "Other"
+        }
+    ]
+}

package/sdk/analytics.ts

@@ -1,6 +1,7 @@
 import { pino, Logger } from 'pino';
 import { Fetch } from './types.js';
 import { FlagsmithConfig } from './types.js';
+import { getUserAgent } from './utils.js';
 
 export const ANALYTICS_ENDPOINT = './analytics/flags/';
 
@@ -69,7 +70,8 @@ export class AnalyticsProcessor {
                 signal: AbortSignal.timeout(this.requestTimeoutMs),
                 headers: {
                     'Content-Type': 'application/json',
-                    'X-Environment-Key': this.environmentKey
+                    'X-Environment-Key': this.environmentKey,
+                    'User-Agent': getUserAgent()
                 }
             });
             await this.currentFlush;

package/sdk/index.ts

@@ -14,7 +14,7 @@ import { FlagsmithAPIError } from './errors.js';
 
 import { DefaultFlag, Flags } from './models.js';
 import { EnvironmentDataPollingManager } from './polling_manager.js';
-import { Deferred, generateIdentitiesData, retryFetch } from './utils.js';
+import { Deferred, generateIdentitiesData, getUserAgent, retryFetch } from './utils.js';
 import { SegmentModel } from '../flagsmith-engine/index.js';
 import { getIdentitySegments } from '../flagsmith-engine/segments/evaluators.js';
 import {
@@ -329,12 +329,14 @@ export class Flagsmith {
         url: string,
         method: string,
         body?: { [key: string]: any }
-    ): Promise<any> {
+    ): Promise<{ response: Response; data: any }> {
         const headers: { [key: string]: any } = { 'Content-Type': 'application/json' };
         if (this.environmentKey) {
             headers['X-Environment-Key'] = this.environmentKey as string;
         }
 
+        headers['User-Agent'] = getUserAgent();
+
         if (this.customHeaders) {
             for (const [k, v] of Object.entries(this.customHeaders)) {
                 headers[k] = v;
@@ -361,7 +363,7 @@ export class Flagsmith {
             );
         }
 
-        return data.json();
+        return { response: data, data: await data.json() };
     }
 
     /**
@@ -391,8 +393,52 @@ export class Flagsmith {
         if (!this.environmentUrl) {
             throw new Error('`apiUrl` argument is missing or invalid.');
         }
-        const environment_data = await this.getJSONResponse(this.environmentUrl, 'GET');
-        return buildEnvironmentModel(environment_data);
+        const startTime = Date.now();
+        const documents: any[] = [];
+        let url = this.environmentUrl;
+        let loggedWarning = false;
+
+        while (true) {
+            try {
+                if (!loggedWarning) {
+                    const elapsedMs = Date.now() - startTime;
+                    if (elapsedMs > this.environmentRefreshIntervalSeconds * 1000) {
+                        this.logger.warn(
+                            `Environment document retrieval exceeded the polling interval of ${this.environmentRefreshIntervalSeconds} seconds.`
+                        );
+                        loggedWarning = true;
+                    }
+                }
+
+                const { response, data } = await this.getJSONResponse(url, 'GET');
+
+                documents.push(data);
+
+                const linkHeader = response.headers.get('link');
+                if (linkHeader) {
+                    const nextMatch = linkHeader.match(/<([^>]+)>;\s*rel="next"/);
+
+                    if (nextMatch) {
+                        const relativeUrl = decodeURIComponent(nextMatch[1]);
+                        url = new URL(relativeUrl, this.apiUrl).href;
+
+                        continue;
+                    }
+                }
+                break;
+            } catch (error) {
+                throw error;
+            }
+        }
+
+        // Compile the document
+        const compiledDocument = documents[0];
+        for (let i = 1; i < documents.length; i++) {
+            compiledDocument.identity_overrides = compiledDocument.identity_overrides || [];
+            compiledDocument.identity_overrides.push(...(documents[i].identity_overrides || []));
+        }
+
+        return buildEnvironmentModel(compiledDocument);
     }
 
     private async getEnvironmentFlagsFromDocument(): Promise<Flags> {
@@ -442,7 +488,7 @@ export class Flagsmith {
         if (!this.environmentFlagsUrl) {
             throw new Error('`apiUrl` argument is missing or invalid.');
         }
-        const apiFlags = await this.getJSONResponse(this.environmentFlagsUrl, 'GET');
+        const { data: apiFlags } = await this.getJSONResponse(this.environmentFlagsUrl, 'GET');
         const flags = Flags.fromAPIFlags({
             apiFlags: apiFlags,
             analyticsProcessor: this.analyticsProcessor,
@@ -463,7 +509,7 @@ export class Flagsmith {
             throw new Error('`apiUrl` argument is missing or invalid.');
         }
         const data = generateIdentitiesData(identifier, traits, transient);
-        const jsonResponse = await this.getJSONResponse(this.identitiesUrl, 'POST', data);
+        const { data: jsonResponse } = await this.getJSONResponse(this.identitiesUrl, 'POST', data);
         const flags = Flags.fromAPIFlags({
             apiFlags: jsonResponse['flags'],
             analyticsProcessor: this.analyticsProcessor,

package/sdk/utils.ts

@@ -3,6 +3,9 @@ import { Dispatcher } from 'undici-types';
 
 type Traits = { [key: string]: TraitConfig | FlagsmithTraitValue };
 
+const FLAGSMITH_USER_AGENT = 'flagsmith-nodejs-sdk';
+const FLAGSMITH_UNKNOWN_VERSION = 'unknown';
+
 export function isTraitConfig(
     traitValue: TraitConfig | FlagsmithTraitValue
 ): traitValue is TraitConfig {
@@ -102,3 +105,13 @@ export class Deferred<T> {
         this.rejectPromise(reason);
     }
 }
+
+export function getUserAgent(): string {
+    try {
+        const packageJson = require('../package.json');
+        const version = packageJson?.version;
+        return version ? `${FLAGSMITH_USER_AGENT}/${version}` : FLAGSMITH_UNKNOWN_VERSION;
+    } catch {
+        return FLAGSMITH_UNKNOWN_VERSION;
+    }
+}

package/tests/engine/unit/engine.test.ts

@@ -12,7 +12,6 @@ import {
     environmentWithSegmentOverride,
     feature1,
     getEnvironmentFeatureStateForFeature,
-    getEnvironmentFeatureStateForFeatureByName,
     identity,
     identityInSegment,
     segmentConditionProperty,

package/tests/sdk/analytics.test.ts

@@ -1,3 +1,4 @@
+import { getUserAgent } from '../../sdk/utils.js';
 import { analyticsProcessor, fetch } from './utils.js';
 
 test('test_analytics_processor_track_feature_updates_analytics_data', () => {
@@ -26,7 +27,11 @@ test('test_analytics_processor_flush_post_request_data_match_ananlytics_data', a
         'http://testUrl/analytics/flags/',
         expect.objectContaining({
             body: '{"myFeature1":1,"myFeature2":1}',
-            headers: { 'Content-Type': 'application/json', 'X-Environment-Key': 'test-key' },
+            headers: {
+                'Content-Type': 'application/json',
+                'X-Environment-Key': 'test-key',
+                'User-Agent': getUserAgent()
+            },
             method: 'POST'
         })
     );

package/tests/sdk/flagsmith-environment-flags.test.ts

@@ -1,6 +1,7 @@
 import Flagsmith from '../../sdk/index.js';
 import { environmentJSON, environmentModel, flagsJSON, flagsmith, fetch } from './utils.js';
 import { DefaultFlag } from '../../sdk/models.js';
+import { getUserAgent } from '../../sdk/utils.js';
 
 vi.mock('../../sdk/polling_manager');
 
@@ -72,6 +73,33 @@ test('test_getFeatureValue', async () => {
     expect(featureValue).toBe('some-value');
 });
 
+test('test_user_agent_is_set_when_fetching_environment_flags', async () => {
+    const defaultFlag = new DefaultFlag('some-default-value', true);
+
+    const defaultFlagHandler = (featureName: string) => defaultFlag;
+
+    const flg = flagsmith({
+        environmentKey: 'key',
+        defaultFlagHandler: defaultFlagHandler,
+        enableAnalytics: true
+    });
+    const flags = await flg.getEnvironmentFlags();
+    const featureValue = flags.getFeatureValue('some_feature');
+
+    expect(featureValue).toBe('some-value');
+    expect(fetch).toHaveBeenCalledWith(
+        `https://edge.api.flagsmith.com/api/v1/flags/`,
+        expect.objectContaining({
+            method: 'GET',
+            headers: {
+                'Content-Type': 'application/json',
+                'X-Environment-Key': 'key',
+                'User-Agent': getUserAgent()
+            }
+        })
+    );
+});
+
 test('test_throws_when_no_default_flag_handler_after_multiple_API_errors', async () => {
     fetch.mockRejectedValue('Error during fetching the API response');
 

package/tests/sdk/flagsmith-identity-flags.test.ts

@@ -9,6 +9,7 @@ import {
     badFetch
 } from './utils.js';
 import { DefaultFlag } from '../../sdk/models.js';
+import { getUserAgent } from '../../sdk/utils.js';
 
 vi.mock('../../sdk/polling_manager');
 
@@ -150,7 +151,11 @@ test('test_transient_identity', async () => {
         `https://edge.api.flagsmith.com/api/v1/identities/`,
         expect.objectContaining({
             method: 'POST',
-            headers: { 'Content-Type': 'application/json', 'X-Environment-Key': 'sometestfakekey' },
+            headers: {
+                'Content-Type': 'application/json',
+                'X-Environment-Key': 'sometestfakekey',
+                'User-Agent': getUserAgent()
+            },
             body: JSON.stringify({ identifier, traits: traitsInRequest, transient })
         })
     );
@@ -191,7 +196,11 @@ test('test_identity_with_transient_traits', async () => {
         `https://edge.api.flagsmith.com/api/v1/identities/`,
         expect.objectContaining({
             method: 'POST',
-            headers: { 'Content-Type': 'application/json', 'X-Environment-Key': 'sometestfakekey' },
+            headers: {
+                'Content-Type': 'application/json',
+                'X-Environment-Key': 'sometestfakekey',
+                'User-Agent': getUserAgent()
+            },
             body: JSON.stringify({ identifier, traits: traitsInRequest })
         })
     );