@amplitude/analytics-core 2.7.0 → 2.8.0

package/lib/cjs/remote-config/remote-config-localstorage.d.ts

@@ -0,0 +1,10 @@
+import { RemoteConfigStorage, RemoteConfigInfo } from './remote-config';
+import { ILogger } from '../logger';
+export declare class RemoteConfigLocalStorage implements RemoteConfigStorage {
+    private readonly key;
+    private readonly logger;
+    constructor(apiKey: string, logger: ILogger);
+    fetchConfig(): Promise<RemoteConfigInfo>;
+    setConfig(config: RemoteConfigInfo): Promise<boolean>;
+}
+//# sourceMappingURL=remote-config-localstorage.d.ts.map

package/lib/cjs/remote-config/remote-config-localstorage.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"remote-config-localstorage.d.ts","sourceRoot":"","sources":["../../../src/remote-config/remote-config-localstorage.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,mBAAmB,EAAE,gBAAgB,EAAE,MAAM,iBAAiB,CAAC;AACxE,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AAEpC,qBAAa,wBAAyB,YAAW,mBAAmB;IAClE,OAAO,CAAC,QAAQ,CAAC,GAAG,CAAS;IAC7B,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAU;gBAErB,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,OAAO;IAK3C,WAAW,IAAI,OAAO,CAAC,gBAAgB,CAAC;IAiCxC,SAAS,CAAC,MAAM,EAAE,gBAAgB,GAAG,OAAO,CAAC,OAAO,CAAC;CAUtD"}

package/lib/cjs/remote-config/remote-config-localstorage.js

@@ -0,0 +1,54 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RemoteConfigLocalStorage = void 0;
+var RemoteConfigLocalStorage = /** @class */ (function () {
+    function RemoteConfigLocalStorage(apiKey, logger) {
+        this.key = "AMP_remote_config_".concat(apiKey.substring(0, 10));
+        this.logger = logger;
+    }
+    RemoteConfigLocalStorage.prototype.fetchConfig = function () {
+        var result = null;
+        var failedRemoteConfigInfo = {
+            remoteConfig: null,
+            lastFetch: new Date(),
+        };
+        try {
+            result = localStorage.getItem(this.key);
+        }
+        catch (error) {
+            this.logger.debug('Remote config localstorage failed to access: ', error);
+            return Promise.resolve(failedRemoteConfigInfo);
+        }
+        if (result === null) {
+            this.logger.debug('Remote config localstorage gets null because the key does not exist');
+            return Promise.resolve(failedRemoteConfigInfo);
+        }
+        try {
+            var remoteConfigInfo = JSON.parse(result);
+            this.logger.debug('Remote config localstorage parsed successfully.');
+            return Promise.resolve({
+                remoteConfig: remoteConfigInfo.remoteConfig,
+                lastFetch: new Date(remoteConfigInfo.lastFetch),
+            });
+        }
+        catch (error) {
+            this.logger.debug('Remote config localstorage failed to parse: ', error);
+            localStorage.removeItem(this.key);
+            return Promise.resolve(failedRemoteConfigInfo);
+        }
+    };
+    RemoteConfigLocalStorage.prototype.setConfig = function (config) {
+        try {
+            localStorage.setItem(this.key, JSON.stringify(config));
+            this.logger.debug('Remote config localstorage set successfully.');
+            return Promise.resolve(true);
+        }
+        catch (error) {
+            this.logger.debug('Remote config localstorage failed to set: ', error);
+        }
+        return Promise.resolve(false);
+    };
+    return RemoteConfigLocalStorage;
+}());
+exports.RemoteConfigLocalStorage = RemoteConfigLocalStorage;
+//# sourceMappingURL=remote-config-localstorage.js.map

package/lib/cjs/remote-config/remote-config-localstorage.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"remote-config-localstorage.js","sourceRoot":"","sources":["../../../src/remote-config/remote-config-localstorage.ts"],"names":[],"mappings":";;;AAGA;IAIE,kCAAY,MAAc,EAAE,MAAe;QACzC,IAAI,CAAC,GAAG,GAAG,4BAAqB,MAAM,CAAC,SAAS,CAAC,CAAC,EAAE,EAAE,CAAC,CAAE,CAAC;QAC1D,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;IACvB,CAAC;IAED,8CAAW,GAAX;QACE,IAAI,MAAM,GAAkB,IAAI,CAAC;QACjC,IAAM,sBAAsB,GAAG;YAC7B,YAAY,EAAE,IAAI;YAClB,SAAS,EAAE,IAAI,IAAI,EAAE;SACtB,CAAC;QAEF,IAAI;YACF,MAAM,GAAG,YAAY,CAAC,OAAO,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;SACzC;QAAC,OAAO,KAAK,EAAE;YACd,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,+CAA+C,EAAE,KAAK,CAAC,CAAC;YAC1E,OAAO,OAAO,CAAC,OAAO,CAAC,sBAAsB,CAAC,CAAC;SAChD;QAED,IAAI,MAAM,KAAK,IAAI,EAAE;YACnB,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,qEAAqE,CAAC,CAAC;YACzF,OAAO,OAAO,CAAC,OAAO,CAAC,sBAAsB,CAAC,CAAC;SAChD;QAED,IAAI;YACF,IAAM,gBAAgB,GAAqB,IAAI,CAAC,KAAK,CAAC,MAAM,CAAqB,CAAC;YAClF,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,iDAAiD,CAAC,CAAC;YACrE,OAAO,OAAO,CAAC,OAAO,CAAC;gBACrB,YAAY,EAAE,gBAAgB,CAAC,YAAY;gBAC3C,SAAS,EAAE,IAAI,IAAI,CAAC,gBAAgB,CAAC,SAAS,CAAC;aAChD,CAAC,CAAC;SACJ;QAAC,OAAO,KAAK,EAAE;YACd,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,8CAA8C,EAAE,KAAK,CAAC,CAAC;YACzE,YAAY,CAAC,UAAU,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;YAClC,OAAO,OAAO,CAAC,OAAO,CAAC,sBAAsB,CAAC,CAAC;SAChD;IACH,CAAC;IAED,4CAAS,GAAT,UAAU,MAAwB;QAChC,IAAI;YACF,YAAY,CAAC,OAAO,CAAC,IAAI,CAAC,GAAG,EAAE,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC,CAAC;YACvD,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,8CAA8C,CAAC,CAAC;YAClE,OAAO,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;SAC9B;QAAC,OAAO,KAAK,EAAE;YACd,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,4CAA4C,EAAE,KAAK,CAAC,CAAC;SACxE;QACD,OAAO,OAAO,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;IAChC,CAAC;IACH,+BAAC;AAAD,CAAC,AApDD,IAoDC;AApDY,4DAAwB","sourcesContent":["import { RemoteConfigStorage, RemoteConfigInfo } from './remote-config';\nimport { ILogger } from '../logger';\n\nexport class RemoteConfigLocalStorage implements RemoteConfigStorage {\n  private readonly key: string;\n  private readonly logger: ILogger;\n\n  constructor(apiKey: string, logger: ILogger) {\n    this.key = `AMP_remote_config_${apiKey.substring(0, 10)}`;\n    this.logger = logger;\n  }\n\n  fetchConfig(): Promise<RemoteConfigInfo> {\n    let result: string | null = null;\n    const failedRemoteConfigInfo = {\n      remoteConfig: null,\n      lastFetch: new Date(),\n    };\n\n    try {\n      result = localStorage.getItem(this.key);\n    } catch (error) {\n      this.logger.debug('Remote config localstorage failed to access: ', error);\n      return Promise.resolve(failedRemoteConfigInfo);\n    }\n\n    if (result === null) {\n      this.logger.debug('Remote config localstorage gets null because the key does not exist');\n      return Promise.resolve(failedRemoteConfigInfo);\n    }\n\n    try {\n      const remoteConfigInfo: RemoteConfigInfo = JSON.parse(result) as RemoteConfigInfo;\n      this.logger.debug('Remote config localstorage parsed successfully.');\n      return Promise.resolve({\n        remoteConfig: remoteConfigInfo.remoteConfig,\n        lastFetch: new Date(remoteConfigInfo.lastFetch),\n      });\n    } catch (error) {\n      this.logger.debug('Remote config localstorage failed to parse: ', error);\n      localStorage.removeItem(this.key);\n      return Promise.resolve(failedRemoteConfigInfo);\n    }\n  }\n\n  setConfig(config: RemoteConfigInfo): Promise<boolean> {\n    try {\n      localStorage.setItem(this.key, JSON.stringify(config));\n      this.logger.debug('Remote config localstorage set successfully.');\n      return Promise.resolve(true);\n    } catch (error) {\n      this.logger.debug('Remote config localstorage failed to set: ', error);\n    }\n    return Promise.resolve(false);\n  }\n}\n"]}

package/lib/cjs/remote-config/remote-config.d.ts

@@ -0,0 +1,115 @@
+import { ServerZoneType } from '../types/server-zone';
+import { ILogger } from '../logger';
+/**
+ * Modes for receiving remote config updates:
+ * - `'all'` – Receive all config updates as they occur.
+ * - `{ timeout: number }` – Wait for a remote response until the specified timeout (in milliseconds),
+ *   then return a cached copy if available.
+ */
+export type DeliveryMode = 'all' | {
+    timeout: number;
+};
+/**
+ * Sources of returned remote config:
+ * - `cache` - Fetched from local storage.
+ * - `remote` - Fetched from remote.
+ */
+export type Source = 'cache' | 'remote';
+export declare const US_SERVER_URL = "https://sr-client-cfg.amplitude.com/config";
+export declare const EU_SERVER_URL = "https://sr-client-cfg.eu.amplitude.com/config";
+export declare const DEFAULT_MAX_RETRIES = 3;
+export declare const FETCHED_KEYS: string[];
+export interface RemoteConfig {
+    [key: string]: any;
+}
+export interface RemoteConfigInfo {
+    remoteConfig: RemoteConfig | null;
+    lastFetch: Date;
+}
+export interface RemoteConfigStorage {
+    /**
+     * Fetch remote config from storage asynchronously.
+     */
+    fetchConfig(): Promise<RemoteConfigInfo>;
+    /**
+     * Set remote config to storage asynchronously.
+     */
+    setConfig(config: RemoteConfigInfo): Promise<boolean>;
+}
+/**
+ * Information about each callback registered by `RemoteConfigClient.subscribe()`,
+ * managed internally by `RemoteConfigClient`.
+ */
+export interface CallbackInfo {
+    id: string;
+    key?: string;
+    deliveryMode: DeliveryMode;
+    callback: RemoteConfigCallback;
+    lastCallback?: Date;
+}
+/**
+ * Callback used in `RemoteConfigClient.subscribe()`.
+ * This function is called when the remote config is fetched.
+ */
+type RemoteConfigCallback = (remoteConfig: RemoteConfig | null, source: Source, lastFetch: Date) => void;
+export interface IRemoteConfigClient {
+    /**
+     * Subscribe for updates to remote config.
+     * Callback is guaranteed to be called at least once,
+     * Whether we are able to fetch a config or not.
+     *
+     * @param key - a string containing a series of period delimited keys to filter the returned config.
+     * Ie, {a: {b: {c: ...}}} would return {b: {c: ...}} for "a" or {c: ...} for "a.b".
+     * Set to `undefined` to subscribe all keys.
+     * @param deliveryMode - how the initial callback is sent.
+     * @param callback - a block that will be called when remote config is fetched.
+     * @return id - identification of the subscribe and can be used to unsubscribe from updates.
+     */
+    subscribe(key: string | undefined, deliveryMode: DeliveryMode, callback: RemoteConfigCallback): string;
+    /**
+     * Unsubscribe a callback from receiving future updates.
+     *
+     * @param id - identification of the callback that you want to unsubscribe.
+     * It's the return value of subscribe().
+     * @return boolean - whether the callback is removed.
+     */
+    unsubscribe(id: string): boolean;
+    /**
+     * Request the remote config client to fetch from remote, update cache, and callback.
+     */
+    updateConfigs(): void;
+}
+export declare class RemoteConfigClient implements IRemoteConfigClient {
+    readonly apiKey: string;
+    readonly serverUrl: string;
+    readonly logger: ILogger;
+    readonly storage: RemoteConfigStorage;
+    callbackInfos: CallbackInfo[];
+    constructor(apiKey: string, logger: ILogger, serverZone?: ServerZoneType);
+    subscribe(key: string | undefined, deliveryMode: DeliveryMode, callback: RemoteConfigCallback): string;
+    unsubscribe(id: string): boolean;
+    updateConfigs(): Promise<void>;
+    /**
+     * Send remote first. If it's already complete, we can skip the cached response.
+     * - if remote is fetched first, no cache fetch.
+     * - if cache is fetched first, still fetching remote.
+     */
+    subscribeAll(callbackInfo: CallbackInfo): Promise<void>;
+    /**
+     * Waits for a remote response until the given timeout, then return a cached copy, if available.
+     */
+    subscribeWaitForRemote(callbackInfo: CallbackInfo, timeout: number): Promise<void>;
+    /**
+     * Call the callback with filtered remote config based on key.
+     * @param remoteConfigInfo - the whole remote config object without filtering by key.
+     */
+    sendCallback(callbackInfo: CallbackInfo, remoteConfigInfo: RemoteConfigInfo, source: Source): void;
+    fetch(retries?: number, timeout?: number): Promise<RemoteConfigInfo>;
+    /**
+     * Return jitter in the bound of [0,baseDelay) and then floor round.
+     */
+    getJitterDelay(baseDelay: number): number;
+    getUrlParams(): string;
+}
+export {};
+//# sourceMappingURL=remote-config.d.ts.map

package/lib/cjs/remote-config/remote-config.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"remote-config.d.ts","sourceRoot":"","sources":["../../../src/remote-config/remote-config.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,sBAAsB,CAAC;AACtD,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AAIpC;;;;;GAKG;AACH,MAAM,MAAM,YAAY,GAAG,KAAK,GAAG;IAAE,OAAO,EAAE,MAAM,CAAA;CAAE,CAAC;AAEvD;;;;GAIG;AACH,MAAM,MAAM,MAAM,GAAG,OAAO,GAAG,QAAQ,CAAC;AAExC,eAAO,MAAM,aAAa,+CAA+C,CAAC;AAC1E,eAAO,MAAM,aAAa,kDAAkD,CAAC;AAC7E,eAAO,MAAM,mBAAmB,IAAI,CAAC;AASrC,eAAO,MAAM,YAAY,UAOxB,CAAC;AAEF,MAAM,WAAW,YAAY;IAC3B,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAC;CACpB;AAED,MAAM,WAAW,gBAAgB;IAC/B,YAAY,EAAE,YAAY,GAAG,IAAI,CAAC;IAElC,SAAS,EAAE,IAAI,CAAC;CACjB;AAED,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,WAAW,IAAI,OAAO,CAAC,gBAAgB,CAAC,CAAC;IAEzC;;OAEG;IACH,SAAS,CAAC,MAAM,EAAE,gBAAgB,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;CACvD;AAED;;;GAGG;AACH,MAAM,WAAW,YAAY;IAC3B,EAAE,EAAE,MAAM,CAAC;IACX,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,YAAY,EAAE,YAAY,CAAC;IAC3B,QAAQ,EAAE,oBAAoB,CAAC;IAC/B,YAAY,CAAC,EAAE,IAAI,CAAC;CACrB;AAED;;;GAGG;AACH,KAAK,oBAAoB,GAAG,CAAC,YAAY,EAAE,YAAY,GAAG,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,SAAS,EAAE,IAAI,KAAK,IAAI,CAAC;AAEzG,MAAM,WAAW,mBAAmB;IAClC;;;;;;;;;;;OAWG;IACH,SAAS,CAAC,GAAG,EAAE,MAAM,GAAG,SAAS,EAAE,YAAY,EAAE,YAAY,EAAE,QAAQ,EAAE,oBAAoB,GAAG,MAAM,CAAC;IAEvG;;;;;;OAMG;IACH,WAAW,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC;IAEjC;;OAEG;IACH,aAAa,IAAI,IAAI,CAAC;CACvB;AAED,qBAAa,kBAAmB,YAAW,mBAAmB;IAC5D,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IACxB,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC;IAC3B,QAAQ,CAAC,MAAM,EAAE,OAAO,CAAC;IACzB,QAAQ,CAAC,OAAO,EAAE,mBAAmB,CAAC;IAEtC,aAAa,EAAE,YAAY,EAAE,CAAM;gBAEvB,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,UAAU,GAAE,cAAqB;IAO9E,SAAS,CAAC,GAAG,EAAE,MAAM,GAAG,SAAS,EAAE,YAAY,EAAE,YAAY,EAAE,QAAQ,EAAE,oBAAoB,GAAG,MAAM;IAmBtG,WAAW,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO;IAY1B,aAAa;IAQnB;;;;OAIG;IACG,YAAY,CAAC,YAAY,EAAE,YAAY;IAsB7C;;OAEG;IACG,sBAAsB,CAAC,YAAY,EAAE,YAAY,EAAE,OAAO,EAAE,MAAM;IA4BxE;;;OAGG;IACH,YAAY,CAAC,YAAY,EAAE,YAAY,EAAE,gBAAgB,EAAE,gBAAgB,EAAE,MAAM,EAAE,MAAM;IAuBrF,KAAK,CAAC,OAAO,GAAE,MAA4B,EAAE,OAAO,GAAE,MAAwB,GAAG,OAAO,CAAC,gBAAgB,CAAC;IA4ChH;;OAEG;IACH,cAAc,CAAC,SAAS,EAAE,MAAM,GAAG,MAAM;IAIzC,YAAY,IAAI,MAAM;CAUvB"}

package/lib/cjs/remote-config/remote-config.js

@@ -0,0 +1,264 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RemoteConfigClient = exports.FETCHED_KEYS = exports.DEFAULT_MAX_RETRIES = exports.EU_SERVER_URL = exports.US_SERVER_URL = void 0;
+var tslib_1 = require("tslib");
+var remote_config_localstorage_1 = require("./remote-config-localstorage");
+var uuid_1 = require("../utils/uuid");
+exports.US_SERVER_URL = 'https://sr-client-cfg.amplitude.com/config';
+exports.EU_SERVER_URL = 'https://sr-client-cfg.eu.amplitude.com/config';
+exports.DEFAULT_MAX_RETRIES = 3;
+/**
+ * The default timeout for fetch in milliseconds.
+ * Linear backoff policy: timeout / retry times is the interval between fetch retry.
+ */
+var DEFAULT_TIMEOUT = 1000;
+// TODO(xinyi)
+// const DEFAULT_MIN_TIME_BETWEEN_FETCHES = 5 * 60 * 1000; // 5 minutes
+exports.FETCHED_KEYS = [
+    'analyticsSDK.browserSDK',
+    'sessionReplay.sr_interaction_config',
+    'sessionReplay.sr_logging_config',
+    'sessionReplay.sr_privacy_config',
+    'sessionReplay.sr_sampling_config',
+    'sessionReplay.sr_targeting_config',
+];
+var RemoteConfigClient = /** @class */ (function () {
+    function RemoteConfigClient(apiKey, logger, serverZone) {
+        if (serverZone === void 0) { serverZone = 'US'; }
+        // Registered callbackInfos by subscribe().
+        this.callbackInfos = [];
+        this.apiKey = apiKey;
+        this.serverUrl = serverZone === 'US' ? exports.US_SERVER_URL : exports.EU_SERVER_URL;
+        this.logger = logger;
+        this.storage = new remote_config_localstorage_1.RemoteConfigLocalStorage(apiKey, logger);
+    }
+    RemoteConfigClient.prototype.subscribe = function (key, deliveryMode, callback) {
+        var id = (0, uuid_1.UUID)();
+        var callbackInfo = {
+            id: id,
+            key: key,
+            deliveryMode: deliveryMode,
+            callback: callback,
+        };
+        this.callbackInfos.push(callbackInfo);
+        if (deliveryMode === 'all') {
+            void this.subscribeAll(callbackInfo);
+        }
+        else {
+            void this.subscribeWaitForRemote(callbackInfo, deliveryMode.timeout);
+        }
+        return id;
+    };
+    RemoteConfigClient.prototype.unsubscribe = function (id) {
+        var index = this.callbackInfos.findIndex(function (callbackInfo) { return callbackInfo.id === id; });
+        if (index === -1) {
+            this.logger.debug("Remote config client unsubscribe failed because callback with id ".concat(id, " doesn't exist."));
+            return false;
+        }
+        this.callbackInfos.splice(index, 1);
+        this.logger.debug("Remote config client unsubscribe succeeded removing callback with id ".concat(id, "."));
+        return true;
+    };
+    RemoteConfigClient.prototype.updateConfigs = function () {
+        return tslib_1.__awaiter(this, void 0, void 0, function () {
+            var result;
+            var _this = this;
+            return tslib_1.__generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0: return [4 /*yield*/, this.fetch()];
+                    case 1:
+                        result = _a.sent();
+                        void this.storage.setConfig(result);
+                        this.callbackInfos.forEach(function (callbackInfo) {
+                            _this.sendCallback(callbackInfo, result, 'remote');
+                        });
+                        return [2 /*return*/];
+                }
+            });
+        });
+    };
+    /**
+     * Send remote first. If it's already complete, we can skip the cached response.
+     * - if remote is fetched first, no cache fetch.
+     * - if cache is fetched first, still fetching remote.
+     */
+    RemoteConfigClient.prototype.subscribeAll = function (callbackInfo) {
+        return tslib_1.__awaiter(this, void 0, void 0, function () {
+            var remotePromise, cachePromise, result;
+            var _this = this;
+            return tslib_1.__generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0:
+                        remotePromise = this.fetch().then(function (result) {
+                            _this.logger.debug('Remote config client subscription all mode fetched from remote.');
+                            _this.sendCallback(callbackInfo, result, 'remote');
+                            void _this.storage.setConfig(result);
+                        });
+                        cachePromise = this.storage.fetchConfig().then(function (result) {
+                            return result;
+                        });
+                        return [4 /*yield*/, Promise.race([remotePromise, cachePromise])];
+                    case 1:
+                        result = _a.sent();
+                        // If cache is fetched first, wait for remote.
+                        if (result !== undefined) {
+                            this.logger.debug('Remote config client subscription all mode fetched from cache.');
+                            this.sendCallback(callbackInfo, result, 'cache');
+                        }
+                        return [4 /*yield*/, remotePromise];
+                    case 2:
+                        _a.sent();
+                        return [2 /*return*/];
+                }
+            });
+        });
+    };
+    /**
+     * Waits for a remote response until the given timeout, then return a cached copy, if available.
+     */
+    RemoteConfigClient.prototype.subscribeWaitForRemote = function (callbackInfo, timeout) {
+        return tslib_1.__awaiter(this, void 0, void 0, function () {
+            var timeoutPromise, result, error_1, result;
+            return tslib_1.__generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0:
+                        timeoutPromise = new Promise(function (_, reject) {
+                            setTimeout(function () {
+                                reject('Timeout exceeded');
+                            }, timeout);
+                        });
+                        _a.label = 1;
+                    case 1:
+                        _a.trys.push([1, 3, , 5]);
+                        return [4 /*yield*/, Promise.race([this.fetch(), timeoutPromise])];
+                    case 2:
+                        result = (_a.sent());
+                        this.logger.debug('Remote config client subscription wait for remote mode returns from remote.');
+                        this.sendCallback(callbackInfo, result, 'remote');
+                        void this.storage.setConfig(result);
+                        return [3 /*break*/, 5];
+                    case 3:
+                        error_1 = _a.sent();
+                        this.logger.debug('Remote config client subscription wait for remote mode exceeded timeout. Try to fetch from cache.');
+                        return [4 /*yield*/, this.storage.fetchConfig()];
+                    case 4:
+                        result = _a.sent();
+                        if (result.remoteConfig !== null) {
+                            this.logger.debug('Remote config client subscription wait for remote mode returns a cached copy.');
+                            this.sendCallback(callbackInfo, result, 'cache');
+                        }
+                        else {
+                            this.logger.debug('Remote config client subscription wait for remote mode failed to fetch cache.');
+                            this.sendCallback(callbackInfo, result, 'remote');
+                        }
+                        return [3 /*break*/, 5];
+                    case 5: return [2 /*return*/];
+                }
+            });
+        });
+    };
+    /**
+     * Call the callback with filtered remote config based on key.
+     * @param remoteConfigInfo - the whole remote config object without filtering by key.
+     */
+    RemoteConfigClient.prototype.sendCallback = function (callbackInfo, remoteConfigInfo, source) {
+        callbackInfo.lastCallback = new Date();
+        var filteredConfig;
+        if (callbackInfo.key) {
+            // Filter remote config by key.
+            // For example, if remote config is {a: {b: {c: 1}}},
+            // if key = 'a', filter result is {b: {c: 1}};
+            // if key = 'a.b', filter result is {c: 1}
+            filteredConfig = callbackInfo.key.split('.').reduce(function (config, key) {
+                if (config === null) {
+                    return config;
+                }
+                return key in config ? config[key] : null;
+            }, remoteConfigInfo.remoteConfig);
+        }
+        else {
+            filteredConfig = remoteConfigInfo.remoteConfig;
+        }
+        callbackInfo.callback(filteredConfig, source, remoteConfigInfo.lastFetch);
+    };
+    RemoteConfigClient.prototype.fetch = function (retries, timeout) {
+        if (retries === void 0) { retries = exports.DEFAULT_MAX_RETRIES; }
+        if (timeout === void 0) { timeout = DEFAULT_TIMEOUT; }
+        return tslib_1.__awaiter(this, void 0, void 0, function () {
+            var interval, failedRemoteConfigInfo, attempt, res, body, remoteConfig, error_2;
+            var _this = this;
+            return tslib_1.__generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0:
+                        interval = timeout / retries;
+                        failedRemoteConfigInfo = {
+                            remoteConfig: null,
+                            lastFetch: new Date(),
+                        };
+                        attempt = 0;
+                        _a.label = 1;
+                    case 1:
+                        if (!(attempt < retries)) return [3 /*break*/, 12];
+                        _a.label = 2;
+                    case 2:
+                        _a.trys.push([2, 8, , 9]);
+                        return [4 /*yield*/, fetch(this.getUrlParams(), {
+                                method: 'GET',
+                                headers: {
+                                    Accept: '*/*',
+                                },
+                            })];
+                    case 3:
+                        res = _a.sent();
+                        if (!!res.ok) return [3 /*break*/, 5];
+                        return [4 /*yield*/, res.text()];
+                    case 4:
+                        body = _a.sent();
+                        this.logger.debug("Remote config client fetch with retry time ".concat(retries, " failed with ").concat(res.status, ": ").concat(body));
+                        return [3 /*break*/, 7];
+                    case 5: return [4 /*yield*/, res.json()];
+                    case 6:
+                        remoteConfig = (_a.sent());
+                        return [2 /*return*/, {
+                                remoteConfig: remoteConfig,
+                                lastFetch: new Date(),
+                            }];
+                    case 7: return [3 /*break*/, 9];
+                    case 8:
+                        error_2 = _a.sent();
+                        // Handle rejects when the request fails, for example, a network error
+                        this.logger.debug("Remote config client fetch with retry time ".concat(retries, " is rejected because: "), error_2);
+                        return [3 /*break*/, 9];
+                    case 9:
+                        if (!(attempt < retries - 1)) return [3 /*break*/, 11];
+                        return [4 /*yield*/, new Promise(function (resolve) { return setTimeout(resolve, _this.getJitterDelay(interval)); })];
+                    case 10:
+                        _a.sent();
+                        _a.label = 11;
+                    case 11:
+                        attempt++;
+                        return [3 /*break*/, 1];
+                    case 12: return [2 /*return*/, failedRemoteConfigInfo];
+                }
+            });
+        });
+    };
+    /**
+     * Return jitter in the bound of [0,baseDelay) and then floor round.
+     */
+    RemoteConfigClient.prototype.getJitterDelay = function (baseDelay) {
+        return Math.floor(Math.random() * baseDelay);
+    };
+    RemoteConfigClient.prototype.getUrlParams = function () {
+        var urlParams = new URLSearchParams({
+            api_key: this.apiKey,
+        });
+        exports.FETCHED_KEYS.forEach(function (key) {
+            urlParams.append('config_keys', key);
+        });
+        return "".concat(this.serverUrl, "?").concat(urlParams.toString());
+    };
+    return RemoteConfigClient;
+}());
+exports.RemoteConfigClient = RemoteConfigClient;
+//# sourceMappingURL=remote-config.js.map

package/lib/cjs/remote-config/remote-config.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"remote-config.js","sourceRoot":"","sources":["../../../src/remote-config/remote-config.ts"],"names":[],"mappings":";;;;AAEA,2EAAwE;AACxE,sCAAqC;AAiBxB,QAAA,aAAa,GAAG,4CAA4C,CAAC;AAC7D,QAAA,aAAa,GAAG,+CAA+C,CAAC;AAChE,QAAA,mBAAmB,GAAG,CAAC,CAAC;AAErC;;;GAGG;AACH,IAAM,eAAe,GAAG,IAAI,CAAC;AAC7B,cAAc;AACd,uEAAuE;AAC1D,QAAA,YAAY,GAAG;IAC1B,yBAAyB;IACzB,qCAAqC;IACrC,iCAAiC;IACjC,iCAAiC;IACjC,kCAAkC;IAClC,mCAAmC;CACpC,CAAC;AAwEF;IAQE,4BAAY,MAAc,EAAE,MAAe,EAAE,UAAiC;QAAjC,2BAAA,EAAA,iBAAiC;QAH9E,2CAA2C;QAC3C,kBAAa,GAAmB,EAAE,CAAC;QAGjC,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,IAAI,CAAC,SAAS,GAAG,UAAU,KAAK,IAAI,CAAC,CAAC,CAAC,qBAAa,CAAC,CAAC,CAAC,qBAAa,CAAC;QACrE,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,IAAI,CAAC,OAAO,GAAG,IAAI,qDAAwB,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAC9D,CAAC;IAED,sCAAS,GAAT,UAAU,GAAuB,EAAE,YAA0B,EAAE,QAA8B;QAC3F,IAAM,EAAE,GAAG,IAAA,WAAI,GAAE,CAAC;QAClB,IAAM,YAAY,GAAG;YACnB,EAAE,EAAE,EAAE;YACN,GAAG,EAAE,GAAG;YACR,YAAY,EAAE,YAAY;YAC1B,QAAQ,EAAE,QAAQ;SACnB,CAAC;QACF,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;QAEtC,IAAI,YAAY,KAAK,KAAK,EAAE;YAC1B,KAAK,IAAI,CAAC,YAAY,CAAC,YAAY,CAAC,CAAC;SACtC;aAAM;YACL,KAAK,IAAI,CAAC,sBAAsB,CAAC,YAAY,EAAE,YAAY,CAAC,OAAO,CAAC,CAAC;SACtE;QAED,OAAO,EAAE,CAAC;IACZ,CAAC;IAED,wCAAW,GAAX,UAAY,EAAU;QACpB,IAAM,KAAK,GAAG,IAAI,CAAC,aAAa,CAAC,SAAS,CAAC,UAAC,YAAY,IAAK,OAAA,YAAY,CAAC,EAAE,KAAK,EAAE,EAAtB,CAAsB,CAAC,CAAC;QACrF,IAAI,KAAK,KAAK,CAAC,CAAC,EAAE;YAChB,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,2EAAoE,EAAE,oBAAiB,CAAC,CAAC;YAC3G,OAAO,KAAK,CAAC;SACd;QAED,IAAI,CAAC,aAAa,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC;QACpC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,+EAAwE,EAAE,MAAG,CAAC,CAAC;QACjG,OAAO,IAAI,CAAC;IACd,CAAC;IAEK,0CAAa,GAAnB;;;;;;4BACiB,qBAAM,IAAI,CAAC,KAAK,EAAE,EAAA;;wBAA3B,MAAM,GAAG,SAAkB;wBACjC,KAAK,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC;wBACpC,IAAI,CAAC,aAAa,CAAC,OAAO,CAAC,UAAC,YAAY;4BACtC,KAAI,CAAC,YAAY,CAAC,YAAY,EAAE,MAAM,EAAE,QAAQ,CAAC,CAAC;wBACpD,CAAC,CAAC,CAAC;;;;;KACJ;IAED;;;;OAIG;IACG,yCAAY,GAAlB,UAAmB,YAA0B;;;;;;;wBACrC,aAAa,GAAG,IAAI,CAAC,KAAK,EAAE,CAAC,IAAI,CAAC,UAAC,MAAM;4BAC7C,KAAI,CAAC,MAAM,CAAC,KAAK,CAAC,iEAAiE,CAAC,CAAC;4BACrF,KAAI,CAAC,YAAY,CAAC,YAAY,EAAE,MAAM,EAAE,QAAQ,CAAC,CAAC;4BAClD,KAAK,KAAI,CAAC,OAAO,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC;wBACtC,CAAC,CAAC,CAAC;wBAEG,YAAY,GAAG,IAAI,CAAC,OAAO,CAAC,WAAW,EAAE,CAAC,IAAI,CAAC,UAAC,MAAM;4BAC1D,OAAO,MAAM,CAAC;wBAChB,CAAC,CAAC,CAAC;wBAGY,qBAAM,OAAO,CAAC,IAAI,CAAC,CAAC,aAAa,EAAE,YAAY,CAAC,CAAC,EAAA;;wBAA1D,MAAM,GAAG,SAAiD;wBAEhE,8CAA8C;wBAC9C,IAAI,MAAM,KAAK,SAAS,EAAE;4BACxB,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,gEAAgE,CAAC,CAAC;4BACpF,IAAI,CAAC,YAAY,CAAC,YAAY,EAAE,MAAM,EAAE,OAAO,CAAC,CAAC;yBAClD;wBACD,qBAAM,aAAa,EAAA;;wBAAnB,SAAmB,CAAC;;;;;KACrB;IAED;;OAEG;IACG,mDAAsB,GAA5B,UAA6B,YAA0B,EAAE,OAAe;;;;;;wBAChE,cAAc,GAAG,IAAI,OAAO,CAAC,UAAC,CAAC,EAAE,MAAM;4BAC3C,UAAU,CAAC;gCACT,MAAM,CAAC,kBAAkB,CAAC,CAAC;4BAC7B,CAAC,EAAE,OAAO,CAAC,CAAC;wBACd,CAAC,CAAC,CAAC;;;;wBAGiC,qBAAM,OAAO,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,KAAK,EAAE,EAAE,cAAc,CAAC,CAAC,EAAA;;wBAA9E,MAAM,GAAqB,CAAC,SAAkD,CAAqB;wBAEzG,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,6EAA6E,CAAC,CAAC;wBACjG,IAAI,CAAC,YAAY,CAAC,YAAY,EAAE,MAAM,EAAE,QAAQ,CAAC,CAAC;wBAClD,KAAK,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC;;;;wBAEpC,IAAI,CAAC,MAAM,CAAC,KAAK,CACf,mGAAmG,CACpG,CAAC;wBACa,qBAAM,IAAI,CAAC,OAAO,CAAC,WAAW,EAAE,EAAA;;wBAAzC,MAAM,GAAG,SAAgC;wBAC/C,IAAI,MAAM,CAAC,YAAY,KAAK,IAAI,EAAE;4BAChC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,+EAA+E,CAAC,CAAC;4BACnG,IAAI,CAAC,YAAY,CAAC,YAAY,EAAE,MAAM,EAAE,OAAO,CAAC,CAAC;yBAClD;6BAAM;4BACL,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,+EAA+E,CAAC,CAAC;4BACnG,IAAI,CAAC,YAAY,CAAC,YAAY,EAAE,MAAM,EAAE,QAAQ,CAAC,CAAC;yBACnD;;;;;;KAEJ;IAED;;;OAGG;IACH,yCAAY,GAAZ,UAAa,YAA0B,EAAE,gBAAkC,EAAE,MAAc;QACzF,YAAY,CAAC,YAAY,GAAG,IAAI,IAAI,EAAE,CAAC;QAEvC,IAAI,cAAmC,CAAC;QACxC,IAAI,YAAY,CAAC,GAAG,EAAE;YACpB,+BAA+B;YAC/B,qDAAqD;YACrD,8CAA8C;YAC9C,0CAA0C;YAC1C,cAAc,GAAG,YAAY,CAAC,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,MAAM,CAAC,UAAC,MAAM,EAAE,GAAG;gBAC9D,IAAI,MAAM,KAAK,IAAI,EAAE;oBACnB,OAAO,MAAM,CAAC;iBACf;gBAED,OAAO,GAAG,IAAI,MAAM,CAAC,CAAC,CAAE,MAAM,CAAC,GAAG,CAAkB,CAAC,CAAC,CAAC,IAAI,CAAC;YAC9D,CAAC,EAAE,gBAAgB,CAAC,YAAY,CAAC,CAAC;SACnC;aAAM;YACL,cAAc,GAAG,gBAAgB,CAAC,YAAY,CAAC;SAChD;QAED,YAAY,CAAC,QAAQ,CAAC,cAAc,EAAE,MAAM,EAAE,gBAAgB,CAAC,SAAS,CAAC,CAAC;IAC5E,CAAC;IAEK,kCAAK,GAAX,UAAY,OAAqC,EAAE,OAAiC;QAAxE,wBAAA,EAAA,UAAkB,2BAAmB;QAAE,wBAAA,EAAA,yBAAiC;;;;;;;wBAC5E,QAAQ,GAAG,OAAO,GAAG,OAAO,CAAC;wBAC7B,sBAAsB,GAAqB;4BAC/C,YAAY,EAAE,IAAI;4BAClB,SAAS,EAAE,IAAI,IAAI,EAAE;yBACtB,CAAC;wBAEO,OAAO,GAAG,CAAC;;;6BAAE,CAAA,OAAO,GAAG,OAAO,CAAA;;;;wBAEvB,qBAAM,KAAK,CAAC,IAAI,CAAC,YAAY,EAAE,EAAE;gCAC3C,MAAM,EAAE,KAAK;gCACb,OAAO,EAAE;oCACP,MAAM,EAAE,KAAK;iCACd;6BACF,CAAC,EAAA;;wBALI,GAAG,GAAG,SAKV;6BAGE,CAAC,GAAG,CAAC,EAAE,EAAP,wBAAO;wBACI,qBAAM,GAAG,CAAC,IAAI,EAAE,EAAA;;wBAAvB,IAAI,GAAG,SAAgB;wBAC7B,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,qDAA8C,OAAO,0BAAgB,GAAG,CAAC,MAAM,eAAK,IAAI,CAAE,CAAC,CAAC;;4BAG1E,qBAAM,GAAG,CAAC,IAAI,EAAE,EAAA;;wBAA9C,YAAY,GAAiB,CAAC,SAAgB,CAAiB;wBACrE,sBAAO;gCACL,YAAY,EAAE,YAAY;gCAC1B,SAAS,EAAE,IAAI,IAAI,EAAE;6BACtB,EAAC;;;;wBAGJ,sEAAsE;wBACtE,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,qDAA8C,OAAO,2BAAwB,EAAE,OAAK,CAAC,CAAC;;;6BAMtG,CAAA,OAAO,GAAG,OAAO,GAAG,CAAC,CAAA,EAArB,yBAAqB;wBACvB,qBAAM,IAAI,OAAO,CAAC,UAAC,OAAO,IAAK,OAAA,UAAU,CAAC,OAAO,EAAE,KAAI,CAAC,cAAc,CAAC,QAAQ,CAAC,CAAC,EAAlD,CAAkD,CAAC,EAAA;;wBAAlF,SAAkF,CAAC;;;wBA9B9C,OAAO,EAAE,CAAA;;6BAkClD,sBAAO,sBAAsB,EAAC;;;;KAC/B;IAED;;OAEG;IACH,2CAAc,GAAd,UAAe,SAAiB;QAC9B,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,EAAE,GAAG,SAAS,CAAC,CAAC;IAC/C,CAAC;IAED,yCAAY,GAAZ;QACE,IAAM,SAAS,GAAG,IAAI,eAAe,CAAC;YACpC,OAAO,EAAE,IAAI,CAAC,MAAM;SACrB,CAAC,CAAC;QACH,oBAAY,CAAC,OAAO,CAAC,UAAC,GAAG;YACvB,SAAS,CAAC,MAAM,CAAC,aAAa,EAAE,GAAG,CAAC,CAAC;QACvC,CAAC,CAAC,CAAC;QAEH,OAAO,UAAG,IAAI,CAAC,SAAS,cAAI,SAAS,CAAC,QAAQ,EAAE,CAAE,CAAC;IACrD,CAAC;IACH,yBAAC;AAAD,CAAC,AAxMD,IAwMC;AAxMY,gDAAkB","sourcesContent":["import { ServerZoneType } from '../types/server-zone';\nimport { ILogger } from '../logger';\nimport { RemoteConfigLocalStorage } from './remote-config-localstorage';\nimport { UUID } from '../utils/uuid';\n\n/**\n * Modes for receiving remote config updates:\n * - `'all'` – Receive all config updates as they occur.\n * - `{ timeout: number }` – Wait for a remote response until the specified timeout (in milliseconds),\n *   then return a cached copy if available.\n */\nexport type DeliveryMode = 'all' | { timeout: number };\n\n/**\n * Sources of returned remote config:\n * - `cache` - Fetched from local storage.\n * - `remote` - Fetched from remote.\n */\nexport type Source = 'cache' | 'remote';\n\nexport const US_SERVER_URL = 'https://sr-client-cfg.amplitude.com/config';\nexport const EU_SERVER_URL = 'https://sr-client-cfg.eu.amplitude.com/config';\nexport const DEFAULT_MAX_RETRIES = 3;\n\n/**\n * The default timeout for fetch in milliseconds.\n * Linear backoff policy: timeout / retry times is the interval between fetch retry.\n */\nconst DEFAULT_TIMEOUT = 1000;\n// TODO(xinyi)\n// const DEFAULT_MIN_TIME_BETWEEN_FETCHES = 5 * 60 * 1000; // 5 minutes\nexport const FETCHED_KEYS = [\n  'analyticsSDK.browserSDK',\n  'sessionReplay.sr_interaction_config',\n  'sessionReplay.sr_logging_config',\n  'sessionReplay.sr_privacy_config',\n  'sessionReplay.sr_sampling_config',\n  'sessionReplay.sr_targeting_config',\n];\n\nexport interface RemoteConfig {\n  [key: string]: any;\n}\n\nexport interface RemoteConfigInfo {\n  remoteConfig: RemoteConfig | null;\n  // Timestamp of when the remote config was fetched.\n  lastFetch: Date;\n}\n\nexport interface RemoteConfigStorage {\n  /**\n   * Fetch remote config from storage asynchronously.\n   */\n  fetchConfig(): Promise<RemoteConfigInfo>;\n\n  /**\n   * Set remote config to storage asynchronously.\n   */\n  setConfig(config: RemoteConfigInfo): Promise<boolean>;\n}\n\n/**\n * Information about each callback registered by `RemoteConfigClient.subscribe()`,\n * managed internally by `RemoteConfigClient`.\n */\nexport interface CallbackInfo {\n  id: string;\n  key?: string;\n  deliveryMode: DeliveryMode;\n  callback: RemoteConfigCallback;\n  lastCallback?: Date;\n}\n\n/**\n * Callback used in `RemoteConfigClient.subscribe()`.\n * This function is called when the remote config is fetched.\n */\ntype RemoteConfigCallback = (remoteConfig: RemoteConfig | null, source: Source, lastFetch: Date) => void;\n\nexport interface IRemoteConfigClient {\n  /**\n   * Subscribe for updates to remote config.\n   * Callback is guaranteed to be called at least once,\n   * Whether we are able to fetch a config or not.\n   *\n   * @param key - a string containing a series of period delimited keys to filter the returned config.\n   * Ie, {a: {b: {c: ...}}} would return {b: {c: ...}} for \"a\" or {c: ...} for \"a.b\".\n   * Set to `undefined` to subscribe all keys.\n   * @param deliveryMode - how the initial callback is sent.\n   * @param callback - a block that will be called when remote config is fetched.\n   * @return id - identification of the subscribe and can be used to unsubscribe from updates.\n   */\n  subscribe(key: string | undefined, deliveryMode: DeliveryMode, callback: RemoteConfigCallback): string;\n\n  /**\n   * Unsubscribe a callback from receiving future updates.\n   *\n   * @param id - identification of the callback that you want to unsubscribe.\n   * It's the return value of subscribe().\n   * @return boolean - whether the callback is removed.\n   */\n  unsubscribe(id: string): boolean;\n\n  /**\n   * Request the remote config client to fetch from remote, update cache, and callback.\n   */\n  updateConfigs(): void;\n}\n\nexport class RemoteConfigClient implements IRemoteConfigClient {\n  readonly apiKey: string;\n  readonly serverUrl: string;\n  readonly logger: ILogger;\n  readonly storage: RemoteConfigStorage;\n  // Registered callbackInfos by subscribe().\n  callbackInfos: CallbackInfo[] = [];\n\n  constructor(apiKey: string, logger: ILogger, serverZone: ServerZoneType = 'US') {\n    this.apiKey = apiKey;\n    this.serverUrl = serverZone === 'US' ? US_SERVER_URL : EU_SERVER_URL;\n    this.logger = logger;\n    this.storage = new RemoteConfigLocalStorage(apiKey, logger);\n  }\n\n  subscribe(key: string | undefined, deliveryMode: DeliveryMode, callback: RemoteConfigCallback): string {\n    const id = UUID();\n    const callbackInfo = {\n      id: id,\n      key: key,\n      deliveryMode: deliveryMode,\n      callback: callback,\n    };\n    this.callbackInfos.push(callbackInfo);\n\n    if (deliveryMode === 'all') {\n      void this.subscribeAll(callbackInfo);\n    } else {\n      void this.subscribeWaitForRemote(callbackInfo, deliveryMode.timeout);\n    }\n\n    return id;\n  }\n\n  unsubscribe(id: string): boolean {\n    const index = this.callbackInfos.findIndex((callbackInfo) => callbackInfo.id === id);\n    if (index === -1) {\n      this.logger.debug(`Remote config client unsubscribe failed because callback with id ${id} doesn't exist.`);\n      return false;\n    }\n\n    this.callbackInfos.splice(index, 1);\n    this.logger.debug(`Remote config client unsubscribe succeeded removing callback with id ${id}.`);\n    return true;\n  }\n\n  async updateConfigs() {\n    const result = await this.fetch();\n    void this.storage.setConfig(result);\n    this.callbackInfos.forEach((callbackInfo) => {\n      this.sendCallback(callbackInfo, result, 'remote');\n    });\n  }\n\n  /**\n   * Send remote first. If it's already complete, we can skip the cached response.\n   * - if remote is fetched first, no cache fetch.\n   * - if cache is fetched first, still fetching remote.\n   */\n  async subscribeAll(callbackInfo: CallbackInfo) {\n    const remotePromise = this.fetch().then((result) => {\n      this.logger.debug('Remote config client subscription all mode fetched from remote.');\n      this.sendCallback(callbackInfo, result, 'remote');\n      void this.storage.setConfig(result);\n    });\n\n    const cachePromise = this.storage.fetchConfig().then((result) => {\n      return result;\n    });\n\n    // Wait for the first result to resolve\n    const result = await Promise.race([remotePromise, cachePromise]);\n\n    // If cache is fetched first, wait for remote.\n    if (result !== undefined) {\n      this.logger.debug('Remote config client subscription all mode fetched from cache.');\n      this.sendCallback(callbackInfo, result, 'cache');\n    }\n    await remotePromise;\n  }\n\n  /**\n   * Waits for a remote response until the given timeout, then return a cached copy, if available.\n   */\n  async subscribeWaitForRemote(callbackInfo: CallbackInfo, timeout: number) {\n    const timeoutPromise = new Promise((_, reject) => {\n      setTimeout(() => {\n        reject('Timeout exceeded');\n      }, timeout);\n    });\n\n    try {\n      const result: RemoteConfigInfo = (await Promise.race([this.fetch(), timeoutPromise])) as RemoteConfigInfo;\n\n      this.logger.debug('Remote config client subscription wait for remote mode returns from remote.');\n      this.sendCallback(callbackInfo, result, 'remote');\n      void this.storage.setConfig(result);\n    } catch (error) {\n      this.logger.debug(\n        'Remote config client subscription wait for remote mode exceeded timeout. Try to fetch from cache.',\n      );\n      const result = await this.storage.fetchConfig();\n      if (result.remoteConfig !== null) {\n        this.logger.debug('Remote config client subscription wait for remote mode returns a cached copy.');\n        this.sendCallback(callbackInfo, result, 'cache');\n      } else {\n        this.logger.debug('Remote config client subscription wait for remote mode failed to fetch cache.');\n        this.sendCallback(callbackInfo, result, 'remote');\n      }\n    }\n  }\n\n  /**\n   * Call the callback with filtered remote config based on key.\n   * @param remoteConfigInfo - the whole remote config object without filtering by key.\n   */\n  sendCallback(callbackInfo: CallbackInfo, remoteConfigInfo: RemoteConfigInfo, source: Source) {\n    callbackInfo.lastCallback = new Date();\n\n    let filteredConfig: RemoteConfig | null;\n    if (callbackInfo.key) {\n      // Filter remote config by key.\n      // For example, if remote config is {a: {b: {c: 1}}},\n      // if key = 'a', filter result is {b: {c: 1}};\n      // if key = 'a.b', filter result is {c: 1}\n      filteredConfig = callbackInfo.key.split('.').reduce((config, key) => {\n        if (config === null) {\n          return config;\n        }\n\n        return key in config ? (config[key] as RemoteConfig) : null;\n      }, remoteConfigInfo.remoteConfig);\n    } else {\n      filteredConfig = remoteConfigInfo.remoteConfig;\n    }\n\n    callbackInfo.callback(filteredConfig, source, remoteConfigInfo.lastFetch);\n  }\n\n  async fetch(retries: number = DEFAULT_MAX_RETRIES, timeout: number = DEFAULT_TIMEOUT): Promise<RemoteConfigInfo> {\n    const interval = timeout / retries;\n    const failedRemoteConfigInfo: RemoteConfigInfo = {\n      remoteConfig: null,\n      lastFetch: new Date(),\n    };\n\n    for (let attempt = 0; attempt < retries; attempt++) {\n      try {\n        const res = await fetch(this.getUrlParams(), {\n          method: 'GET',\n          headers: {\n            Accept: '*/*',\n          },\n        });\n\n        // Handle unsuccessful fetch\n        if (!res.ok) {\n          const body = await res.text();\n          this.logger.debug(`Remote config client fetch with retry time ${retries} failed with ${res.status}: ${body}`);\n        } else {\n          // Handle successful fetch\n          const remoteConfig: RemoteConfig = (await res.json()) as RemoteConfig;\n          return {\n            remoteConfig: remoteConfig,\n            lastFetch: new Date(),\n          };\n        }\n      } catch (error) {\n        // Handle rejects when the request fails, for example, a network error\n        this.logger.debug(`Remote config client fetch with retry time ${retries} is rejected because: `, error);\n      }\n\n      // Linear backoff:\n      // wait for the specified interval before the next attempt\n      // except after the last attempt.\n      if (attempt < retries - 1) {\n        await new Promise((resolve) => setTimeout(resolve, this.getJitterDelay(interval)));\n      }\n    }\n\n    return failedRemoteConfigInfo;\n  }\n\n  /**\n   * Return jitter in the bound of [0,baseDelay) and then floor round.\n   */\n  getJitterDelay(baseDelay: number): number {\n    return Math.floor(Math.random() * baseDelay);\n  }\n\n  getUrlParams(): string {\n    const urlParams = new URLSearchParams({\n      api_key: this.apiKey,\n    });\n    FETCHED_KEYS.forEach((key) => {\n      urlParams.append('config_keys', key);\n    });\n\n    return `${this.serverUrl}?${urlParams.toString()}`;\n  }\n}\n"]}

package/lib/esm/remote-config/remote-config-localstorage.d.ts

@@ -0,0 +1,10 @@
+import { RemoteConfigStorage, RemoteConfigInfo } from './remote-config';
+import { ILogger } from '../logger';
+export declare class RemoteConfigLocalStorage implements RemoteConfigStorage {
+    private readonly key;
+    private readonly logger;
+    constructor(apiKey: string, logger: ILogger);
+    fetchConfig(): Promise<RemoteConfigInfo>;
+    setConfig(config: RemoteConfigInfo): Promise<boolean>;
+}
+//# sourceMappingURL=remote-config-localstorage.d.ts.map

package/lib/esm/remote-config/remote-config-localstorage.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"remote-config-localstorage.d.ts","sourceRoot":"","sources":["../../../src/remote-config/remote-config-localstorage.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,mBAAmB,EAAE,gBAAgB,EAAE,MAAM,iBAAiB,CAAC;AACxE,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AAEpC,qBAAa,wBAAyB,YAAW,mBAAmB;IAClE,OAAO,CAAC,QAAQ,CAAC,GAAG,CAAS;IAC7B,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAU;gBAErB,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,OAAO;IAK3C,WAAW,IAAI,OAAO,CAAC,gBAAgB,CAAC;IAiCxC,SAAS,CAAC,MAAM,EAAE,gBAAgB,GAAG,OAAO,CAAC,OAAO,CAAC;CAUtD"}

package/lib/esm/remote-config/remote-config-localstorage.js

@@ -0,0 +1,51 @@
+var RemoteConfigLocalStorage = /** @class */ (function () {
+    function RemoteConfigLocalStorage(apiKey, logger) {
+        this.key = "AMP_remote_config_".concat(apiKey.substring(0, 10));
+        this.logger = logger;
+    }
+    RemoteConfigLocalStorage.prototype.fetchConfig = function () {
+        var result = null;
+        var failedRemoteConfigInfo = {
+            remoteConfig: null,
+            lastFetch: new Date(),
+        };
+        try {
+            result = localStorage.getItem(this.key);
+        }
+        catch (error) {
+            this.logger.debug('Remote config localstorage failed to access: ', error);
+            return Promise.resolve(failedRemoteConfigInfo);
+        }
+        if (result === null) {
+            this.logger.debug('Remote config localstorage gets null because the key does not exist');
+            return Promise.resolve(failedRemoteConfigInfo);
+        }
+        try {
+            var remoteConfigInfo = JSON.parse(result);
+            this.logger.debug('Remote config localstorage parsed successfully.');
+            return Promise.resolve({
+                remoteConfig: remoteConfigInfo.remoteConfig,
+                lastFetch: new Date(remoteConfigInfo.lastFetch),
+            });
+        }
+        catch (error) {
+            this.logger.debug('Remote config localstorage failed to parse: ', error);
+            localStorage.removeItem(this.key);
+            return Promise.resolve(failedRemoteConfigInfo);
+        }
+    };
+    RemoteConfigLocalStorage.prototype.setConfig = function (config) {
+        try {
+            localStorage.setItem(this.key, JSON.stringify(config));
+            this.logger.debug('Remote config localstorage set successfully.');
+            return Promise.resolve(true);
+        }
+        catch (error) {
+            this.logger.debug('Remote config localstorage failed to set: ', error);
+        }
+        return Promise.resolve(false);
+    };
+    return RemoteConfigLocalStorage;
+}());
+export { RemoteConfigLocalStorage };
+//# sourceMappingURL=remote-config-localstorage.js.map

package/lib/esm/remote-config/remote-config-localstorage.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"remote-config-localstorage.js","sourceRoot":"","sources":["../../../src/remote-config/remote-config-localstorage.ts"],"names":[],"mappings":"AAGA;IAIE,kCAAY,MAAc,EAAE,MAAe;QACzC,IAAI,CAAC,GAAG,GAAG,4BAAqB,MAAM,CAAC,SAAS,CAAC,CAAC,EAAE,EAAE,CAAC,CAAE,CAAC;QAC1D,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;IACvB,CAAC;IAED,8CAAW,GAAX;QACE,IAAI,MAAM,GAAkB,IAAI,CAAC;QACjC,IAAM,sBAAsB,GAAG;YAC7B,YAAY,EAAE,IAAI;YAClB,SAAS,EAAE,IAAI,IAAI,EAAE;SACtB,CAAC;QAEF,IAAI;YACF,MAAM,GAAG,YAAY,CAAC,OAAO,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;SACzC;QAAC,OAAO,KAAK,EAAE;YACd,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,+CAA+C,EAAE,KAAK,CAAC,CAAC;YAC1E,OAAO,OAAO,CAAC,OAAO,CAAC,sBAAsB,CAAC,CAAC;SAChD;QAED,IAAI,MAAM,KAAK,IAAI,EAAE;YACnB,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,qEAAqE,CAAC,CAAC;YACzF,OAAO,OAAO,CAAC,OAAO,CAAC,sBAAsB,CAAC,CAAC;SAChD;QAED,IAAI;YACF,IAAM,gBAAgB,GAAqB,IAAI,CAAC,KAAK,CAAC,MAAM,CAAqB,CAAC;YAClF,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,iDAAiD,CAAC,CAAC;YACrE,OAAO,OAAO,CAAC,OAAO,CAAC;gBACrB,YAAY,EAAE,gBAAgB,CAAC,YAAY;gBAC3C,SAAS,EAAE,IAAI,IAAI,CAAC,gBAAgB,CAAC,SAAS,CAAC;aAChD,CAAC,CAAC;SACJ;QAAC,OAAO,KAAK,EAAE;YACd,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,8CAA8C,EAAE,KAAK,CAAC,CAAC;YACzE,YAAY,CAAC,UAAU,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;YAClC,OAAO,OAAO,CAAC,OAAO,CAAC,sBAAsB,CAAC,CAAC;SAChD;IACH,CAAC;IAED,4CAAS,GAAT,UAAU,MAAwB;QAChC,IAAI;YACF,YAAY,CAAC,OAAO,CAAC,IAAI,CAAC,GAAG,EAAE,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC,CAAC;YACvD,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,8CAA8C,CAAC,CAAC;YAClE,OAAO,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;SAC9B;QAAC,OAAO,KAAK,EAAE;YACd,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,4CAA4C,EAAE,KAAK,CAAC,CAAC;SACxE;QACD,OAAO,OAAO,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;IAChC,CAAC;IACH,+BAAC;AAAD,CAAC,AApDD,IAoDC","sourcesContent":["import { RemoteConfigStorage, RemoteConfigInfo } from './remote-config';\nimport { ILogger } from '../logger';\n\nexport class RemoteConfigLocalStorage implements RemoteConfigStorage {\n  private readonly key: string;\n  private readonly logger: ILogger;\n\n  constructor(apiKey: string, logger: ILogger) {\n    this.key = `AMP_remote_config_${apiKey.substring(0, 10)}`;\n    this.logger = logger;\n  }\n\n  fetchConfig(): Promise<RemoteConfigInfo> {\n    let result: string | null = null;\n    const failedRemoteConfigInfo = {\n      remoteConfig: null,\n      lastFetch: new Date(),\n    };\n\n    try {\n      result = localStorage.getItem(this.key);\n    } catch (error) {\n      this.logger.debug('Remote config localstorage failed to access: ', error);\n      return Promise.resolve(failedRemoteConfigInfo);\n    }\n\n    if (result === null) {\n      this.logger.debug('Remote config localstorage gets null because the key does not exist');\n      return Promise.resolve(failedRemoteConfigInfo);\n    }\n\n    try {\n      const remoteConfigInfo: RemoteConfigInfo = JSON.parse(result) as RemoteConfigInfo;\n      this.logger.debug('Remote config localstorage parsed successfully.');\n      return Promise.resolve({\n        remoteConfig: remoteConfigInfo.remoteConfig,\n        lastFetch: new Date(remoteConfigInfo.lastFetch),\n      });\n    } catch (error) {\n      this.logger.debug('Remote config localstorage failed to parse: ', error);\n      localStorage.removeItem(this.key);\n      return Promise.resolve(failedRemoteConfigInfo);\n    }\n  }\n\n  setConfig(config: RemoteConfigInfo): Promise<boolean> {\n    try {\n      localStorage.setItem(this.key, JSON.stringify(config));\n      this.logger.debug('Remote config localstorage set successfully.');\n      return Promise.resolve(true);\n    } catch (error) {\n      this.logger.debug('Remote config localstorage failed to set: ', error);\n    }\n    return Promise.resolve(false);\n  }\n}\n"]}

package/lib/esm/remote-config/remote-config.d.ts

@@ -0,0 +1,115 @@
+import { ServerZoneType } from '../types/server-zone';
+import { ILogger } from '../logger';
+/**
+ * Modes for receiving remote config updates:
+ * - `'all'` – Receive all config updates as they occur.
+ * - `{ timeout: number }` – Wait for a remote response until the specified timeout (in milliseconds),
+ *   then return a cached copy if available.
+ */
+export type DeliveryMode = 'all' | {
+    timeout: number;
+};
+/**
+ * Sources of returned remote config:
+ * - `cache` - Fetched from local storage.
+ * - `remote` - Fetched from remote.
+ */
+export type Source = 'cache' | 'remote';
+export declare const US_SERVER_URL = "https://sr-client-cfg.amplitude.com/config";
+export declare const EU_SERVER_URL = "https://sr-client-cfg.eu.amplitude.com/config";
+export declare const DEFAULT_MAX_RETRIES = 3;
+export declare const FETCHED_KEYS: string[];
+export interface RemoteConfig {
+    [key: string]: any;
+}
+export interface RemoteConfigInfo {
+    remoteConfig: RemoteConfig | null;
+    lastFetch: Date;
+}
+export interface RemoteConfigStorage {
+    /**
+     * Fetch remote config from storage asynchronously.
+     */
+    fetchConfig(): Promise<RemoteConfigInfo>;
+    /**
+     * Set remote config to storage asynchronously.
+     */
+    setConfig(config: RemoteConfigInfo): Promise<boolean>;
+}
+/**
+ * Information about each callback registered by `RemoteConfigClient.subscribe()`,
+ * managed internally by `RemoteConfigClient`.
+ */
+export interface CallbackInfo {
+    id: string;
+    key?: string;
+    deliveryMode: DeliveryMode;
+    callback: RemoteConfigCallback;
+    lastCallback?: Date;
+}
+/**
+ * Callback used in `RemoteConfigClient.subscribe()`.
+ * This function is called when the remote config is fetched.
+ */
+type RemoteConfigCallback = (remoteConfig: RemoteConfig | null, source: Source, lastFetch: Date) => void;
+export interface IRemoteConfigClient {
+    /**
+     * Subscribe for updates to remote config.
+     * Callback is guaranteed to be called at least once,
+     * Whether we are able to fetch a config or not.
+     *
+     * @param key - a string containing a series of period delimited keys to filter the returned config.
+     * Ie, {a: {b: {c: ...}}} would return {b: {c: ...}} for "a" or {c: ...} for "a.b".
+     * Set to `undefined` to subscribe all keys.
+     * @param deliveryMode - how the initial callback is sent.
+     * @param callback - a block that will be called when remote config is fetched.
+     * @return id - identification of the subscribe and can be used to unsubscribe from updates.
+     */
+    subscribe(key: string | undefined, deliveryMode: DeliveryMode, callback: RemoteConfigCallback): string;
+    /**
+     * Unsubscribe a callback from receiving future updates.
+     *
+     * @param id - identification of the callback that you want to unsubscribe.
+     * It's the return value of subscribe().
+     * @return boolean - whether the callback is removed.
+     */
+    unsubscribe(id: string): boolean;
+    /**
+     * Request the remote config client to fetch from remote, update cache, and callback.
+     */
+    updateConfigs(): void;
+}
+export declare class RemoteConfigClient implements IRemoteConfigClient {
+    readonly apiKey: string;
+    readonly serverUrl: string;
+    readonly logger: ILogger;
+    readonly storage: RemoteConfigStorage;
+    callbackInfos: CallbackInfo[];
+    constructor(apiKey: string, logger: ILogger, serverZone?: ServerZoneType);
+    subscribe(key: string | undefined, deliveryMode: DeliveryMode, callback: RemoteConfigCallback): string;
+    unsubscribe(id: string): boolean;
+    updateConfigs(): Promise<void>;
+    /**
+     * Send remote first. If it's already complete, we can skip the cached response.
+     * - if remote is fetched first, no cache fetch.
+     * - if cache is fetched first, still fetching remote.
+     */
+    subscribeAll(callbackInfo: CallbackInfo): Promise<void>;
+    /**
+     * Waits for a remote response until the given timeout, then return a cached copy, if available.
+     */
+    subscribeWaitForRemote(callbackInfo: CallbackInfo, timeout: number): Promise<void>;
+    /**
+     * Call the callback with filtered remote config based on key.
+     * @param remoteConfigInfo - the whole remote config object without filtering by key.
+     */
+    sendCallback(callbackInfo: CallbackInfo, remoteConfigInfo: RemoteConfigInfo, source: Source): void;
+    fetch(retries?: number, timeout?: number): Promise<RemoteConfigInfo>;
+    /**
+     * Return jitter in the bound of [0,baseDelay) and then floor round.
+     */
+    getJitterDelay(baseDelay: number): number;
+    getUrlParams(): string;
+}
+export {};
+//# sourceMappingURL=remote-config.d.ts.map

package/lib/esm/remote-config/remote-config.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"remote-config.d.ts","sourceRoot":"","sources":["../../../src/remote-config/remote-config.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,sBAAsB,CAAC;AACtD,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AAIpC;;;;;GAKG;AACH,MAAM,MAAM,YAAY,GAAG,KAAK,GAAG;IAAE,OAAO,EAAE,MAAM,CAAA;CAAE,CAAC;AAEvD;;;;GAIG;AACH,MAAM,MAAM,MAAM,GAAG,OAAO,GAAG,QAAQ,CAAC;AAExC,eAAO,MAAM,aAAa,+CAA+C,CAAC;AAC1E,eAAO,MAAM,aAAa,kDAAkD,CAAC;AAC7E,eAAO,MAAM,mBAAmB,IAAI,CAAC;AASrC,eAAO,MAAM,YAAY,UAOxB,CAAC;AAEF,MAAM,WAAW,YAAY;IAC3B,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAC;CACpB;AAED,MAAM,WAAW,gBAAgB;IAC/B,YAAY,EAAE,YAAY,GAAG,IAAI,CAAC;IAElC,SAAS,EAAE,IAAI,CAAC;CACjB;AAED,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,WAAW,IAAI,OAAO,CAAC,gBAAgB,CAAC,CAAC;IAEzC;;OAEG;IACH,SAAS,CAAC,MAAM,EAAE,gBAAgB,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;CACvD;AAED;;;GAGG;AACH,MAAM,WAAW,YAAY;IAC3B,EAAE,EAAE,MAAM,CAAC;IACX,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,YAAY,EAAE,YAAY,CAAC;IAC3B,QAAQ,EAAE,oBAAoB,CAAC;IAC/B,YAAY,CAAC,EAAE,IAAI,CAAC;CACrB;AAED;;;GAGG;AACH,KAAK,oBAAoB,GAAG,CAAC,YAAY,EAAE,YAAY,GAAG,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,SAAS,EAAE,IAAI,KAAK,IAAI,CAAC;AAEzG,MAAM,WAAW,mBAAmB;IAClC;;;;;;;;;;;OAWG;IACH,SAAS,CAAC,GAAG,EAAE,MAAM,GAAG,SAAS,EAAE,YAAY,EAAE,YAAY,EAAE,QAAQ,EAAE,oBAAoB,GAAG,MAAM,CAAC;IAEvG;;;;;;OAMG;IACH,WAAW,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC;IAEjC;;OAEG;IACH,aAAa,IAAI,IAAI,CAAC;CACvB;AAED,qBAAa,kBAAmB,YAAW,mBAAmB;IAC5D,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IACxB,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC;IAC3B,QAAQ,CAAC,MAAM,EAAE,OAAO,CAAC;IACzB,QAAQ,CAAC,OAAO,EAAE,mBAAmB,CAAC;IAEtC,aAAa,EAAE,YAAY,EAAE,CAAM;gBAEvB,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,UAAU,GAAE,cAAqB;IAO9E,SAAS,CAAC,GAAG,EAAE,MAAM,GAAG,SAAS,EAAE,YAAY,EAAE,YAAY,EAAE,QAAQ,EAAE,oBAAoB,GAAG,MAAM;IAmBtG,WAAW,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO;IAY1B,aAAa;IAQnB;;;;OAIG;IACG,YAAY,CAAC,YAAY,EAAE,YAAY;IAsB7C;;OAEG;IACG,sBAAsB,CAAC,YAAY,EAAE,YAAY,EAAE,OAAO,EAAE,MAAM;IA4BxE;;;OAGG;IACH,YAAY,CAAC,YAAY,EAAE,YAAY,EAAE,gBAAgB,EAAE,gBAAgB,EAAE,MAAM,EAAE,MAAM;IAuBrF,KAAK,CAAC,OAAO,GAAE,MAA4B,EAAE,OAAO,GAAE,MAAwB,GAAG,OAAO,CAAC,gBAAgB,CAAC;IA4ChH;;OAEG;IACH,cAAc,CAAC,SAAS,EAAE,MAAM,GAAG,MAAM;IAIzC,YAAY,IAAI,MAAM;CAUvB"}

package/lib/esm/remote-config/remote-config.js

@@ -0,0 +1,261 @@
+import { __awaiter, __generator } from "tslib";
+import { RemoteConfigLocalStorage } from './remote-config-localstorage';
+import { UUID } from '../utils/uuid';
+export var US_SERVER_URL = 'https://sr-client-cfg.amplitude.com/config';
+export var EU_SERVER_URL = 'https://sr-client-cfg.eu.amplitude.com/config';
+export var DEFAULT_MAX_RETRIES = 3;
+/**
+ * The default timeout for fetch in milliseconds.
+ * Linear backoff policy: timeout / retry times is the interval between fetch retry.
+ */
+var DEFAULT_TIMEOUT = 1000;
+// TODO(xinyi)
+// const DEFAULT_MIN_TIME_BETWEEN_FETCHES = 5 * 60 * 1000; // 5 minutes
+export var FETCHED_KEYS = [
+    'analyticsSDK.browserSDK',
+    'sessionReplay.sr_interaction_config',
+    'sessionReplay.sr_logging_config',
+    'sessionReplay.sr_privacy_config',
+    'sessionReplay.sr_sampling_config',
+    'sessionReplay.sr_targeting_config',
+];
+var RemoteConfigClient = /** @class */ (function () {
+    function RemoteConfigClient(apiKey, logger, serverZone) {
+        if (serverZone === void 0) { serverZone = 'US'; }
+        // Registered callbackInfos by subscribe().
+        this.callbackInfos = [];
+        this.apiKey = apiKey;
+        this.serverUrl = serverZone === 'US' ? US_SERVER_URL : EU_SERVER_URL;
+        this.logger = logger;
+        this.storage = new RemoteConfigLocalStorage(apiKey, logger);
+    }
+    RemoteConfigClient.prototype.subscribe = function (key, deliveryMode, callback) {
+        var id = UUID();
+        var callbackInfo = {
+            id: id,
+            key: key,
+            deliveryMode: deliveryMode,
+            callback: callback,
+        };
+        this.callbackInfos.push(callbackInfo);
+        if (deliveryMode === 'all') {
+            void this.subscribeAll(callbackInfo);
+        }
+        else {
+            void this.subscribeWaitForRemote(callbackInfo, deliveryMode.timeout);
+        }
+        return id;
+    };
+    RemoteConfigClient.prototype.unsubscribe = function (id) {
+        var index = this.callbackInfos.findIndex(function (callbackInfo) { return callbackInfo.id === id; });
+        if (index === -1) {
+            this.logger.debug("Remote config client unsubscribe failed because callback with id ".concat(id, " doesn't exist."));
+            return false;
+        }
+        this.callbackInfos.splice(index, 1);
+        this.logger.debug("Remote config client unsubscribe succeeded removing callback with id ".concat(id, "."));
+        return true;
+    };
+    RemoteConfigClient.prototype.updateConfigs = function () {
+        return __awaiter(this, void 0, void 0, function () {
+            var result;
+            var _this = this;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0: return [4 /*yield*/, this.fetch()];
+                    case 1:
+                        result = _a.sent();
+                        void this.storage.setConfig(result);
+                        this.callbackInfos.forEach(function (callbackInfo) {
+                            _this.sendCallback(callbackInfo, result, 'remote');
+                        });
+                        return [2 /*return*/];
+                }
+            });
+        });
+    };
+    /**
+     * Send remote first. If it's already complete, we can skip the cached response.
+     * - if remote is fetched first, no cache fetch.
+     * - if cache is fetched first, still fetching remote.
+     */
+    RemoteConfigClient.prototype.subscribeAll = function (callbackInfo) {
+        return __awaiter(this, void 0, void 0, function () {
+            var remotePromise, cachePromise, result;
+            var _this = this;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0:
+                        remotePromise = this.fetch().then(function (result) {
+                            _this.logger.debug('Remote config client subscription all mode fetched from remote.');
+                            _this.sendCallback(callbackInfo, result, 'remote');
+                            void _this.storage.setConfig(result);
+                        });
+                        cachePromise = this.storage.fetchConfig().then(function (result) {
+                            return result;
+                        });
+                        return [4 /*yield*/, Promise.race([remotePromise, cachePromise])];
+                    case 1:
+                        result = _a.sent();
+                        // If cache is fetched first, wait for remote.
+                        if (result !== undefined) {
+                            this.logger.debug('Remote config client subscription all mode fetched from cache.');
+                            this.sendCallback(callbackInfo, result, 'cache');
+                        }
+                        return [4 /*yield*/, remotePromise];
+                    case 2:
+                        _a.sent();
+                        return [2 /*return*/];
+                }
+            });
+        });
+    };
+    /**
+     * Waits for a remote response until the given timeout, then return a cached copy, if available.
+     */
+    RemoteConfigClient.prototype.subscribeWaitForRemote = function (callbackInfo, timeout) {
+        return __awaiter(this, void 0, void 0, function () {
+            var timeoutPromise, result, error_1, result;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0:
+                        timeoutPromise = new Promise(function (_, reject) {
+                            setTimeout(function () {
+                                reject('Timeout exceeded');
+                            }, timeout);
+                        });
+                        _a.label = 1;
+                    case 1:
+                        _a.trys.push([1, 3, , 5]);
+                        return [4 /*yield*/, Promise.race([this.fetch(), timeoutPromise])];
+                    case 2:
+                        result = (_a.sent());
+                        this.logger.debug('Remote config client subscription wait for remote mode returns from remote.');
+                        this.sendCallback(callbackInfo, result, 'remote');
+                        void this.storage.setConfig(result);
+                        return [3 /*break*/, 5];
+                    case 3:
+                        error_1 = _a.sent();
+                        this.logger.debug('Remote config client subscription wait for remote mode exceeded timeout. Try to fetch from cache.');
+                        return [4 /*yield*/, this.storage.fetchConfig()];
+                    case 4:
+                        result = _a.sent();
+                        if (result.remoteConfig !== null) {
+                            this.logger.debug('Remote config client subscription wait for remote mode returns a cached copy.');
+                            this.sendCallback(callbackInfo, result, 'cache');
+                        }
+                        else {
+                            this.logger.debug('Remote config client subscription wait for remote mode failed to fetch cache.');
+                            this.sendCallback(callbackInfo, result, 'remote');
+                        }
+                        return [3 /*break*/, 5];
+                    case 5: return [2 /*return*/];
+                }
+            });
+        });
+    };
+    /**
+     * Call the callback with filtered remote config based on key.
+     * @param remoteConfigInfo - the whole remote config object without filtering by key.
+     */
+    RemoteConfigClient.prototype.sendCallback = function (callbackInfo, remoteConfigInfo, source) {
+        callbackInfo.lastCallback = new Date();
+        var filteredConfig;
+        if (callbackInfo.key) {
+            // Filter remote config by key.
+            // For example, if remote config is {a: {b: {c: 1}}},
+            // if key = 'a', filter result is {b: {c: 1}};
+            // if key = 'a.b', filter result is {c: 1}
+            filteredConfig = callbackInfo.key.split('.').reduce(function (config, key) {
+                if (config === null) {
+                    return config;
+                }
+                return key in config ? config[key] : null;
+            }, remoteConfigInfo.remoteConfig);
+        }
+        else {
+            filteredConfig = remoteConfigInfo.remoteConfig;
+        }
+        callbackInfo.callback(filteredConfig, source, remoteConfigInfo.lastFetch);
+    };
+    RemoteConfigClient.prototype.fetch = function (retries, timeout) {
+        if (retries === void 0) { retries = DEFAULT_MAX_RETRIES; }
+        if (timeout === void 0) { timeout = DEFAULT_TIMEOUT; }
+        return __awaiter(this, void 0, void 0, function () {
+            var interval, failedRemoteConfigInfo, attempt, res, body, remoteConfig, error_2;
+            var _this = this;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0:
+                        interval = timeout / retries;
+                        failedRemoteConfigInfo = {
+                            remoteConfig: null,
+                            lastFetch: new Date(),
+                        };
+                        attempt = 0;
+                        _a.label = 1;
+                    case 1:
+                        if (!(attempt < retries)) return [3 /*break*/, 12];
+                        _a.label = 2;
+                    case 2:
+                        _a.trys.push([2, 8, , 9]);
+                        return [4 /*yield*/, fetch(this.getUrlParams(), {
+                                method: 'GET',
+                                headers: {
+                                    Accept: '*/*',
+                                },
+                            })];
+                    case 3:
+                        res = _a.sent();
+                        if (!!res.ok) return [3 /*break*/, 5];
+                        return [4 /*yield*/, res.text()];
+                    case 4:
+                        body = _a.sent();
+                        this.logger.debug("Remote config client fetch with retry time ".concat(retries, " failed with ").concat(res.status, ": ").concat(body));
+                        return [3 /*break*/, 7];
+                    case 5: return [4 /*yield*/, res.json()];
+                    case 6:
+                        remoteConfig = (_a.sent());
+                        return [2 /*return*/, {
+                                remoteConfig: remoteConfig,
+                                lastFetch: new Date(),
+                            }];
+                    case 7: return [3 /*break*/, 9];
+                    case 8:
+                        error_2 = _a.sent();
+                        // Handle rejects when the request fails, for example, a network error
+                        this.logger.debug("Remote config client fetch with retry time ".concat(retries, " is rejected because: "), error_2);
+                        return [3 /*break*/, 9];
+                    case 9:
+                        if (!(attempt < retries - 1)) return [3 /*break*/, 11];
+                        return [4 /*yield*/, new Promise(function (resolve) { return setTimeout(resolve, _this.getJitterDelay(interval)); })];
+                    case 10:
+                        _a.sent();
+                        _a.label = 11;
+                    case 11:
+                        attempt++;
+                        return [3 /*break*/, 1];
+                    case 12: return [2 /*return*/, failedRemoteConfigInfo];
+                }
+            });
+        });
+    };
+    /**
+     * Return jitter in the bound of [0,baseDelay) and then floor round.
+     */
+    RemoteConfigClient.prototype.getJitterDelay = function (baseDelay) {
+        return Math.floor(Math.random() * baseDelay);
+    };
+    RemoteConfigClient.prototype.getUrlParams = function () {
+        var urlParams = new URLSearchParams({
+            api_key: this.apiKey,
+        });
+        FETCHED_KEYS.forEach(function (key) {
+            urlParams.append('config_keys', key);
+        });
+        return "".concat(this.serverUrl, "?").concat(urlParams.toString());
+    };
+    return RemoteConfigClient;
+}());
+export { RemoteConfigClient };
+//# sourceMappingURL=remote-config.js.map

package/lib/esm/remote-config/remote-config.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"remote-config.js","sourceRoot":"","sources":["../../../src/remote-config/remote-config.ts"],"names":[],"mappings":";AAEA,OAAO,EAAE,wBAAwB,EAAE,MAAM,8BAA8B,CAAC;AACxE,OAAO,EAAE,IAAI,EAAE,MAAM,eAAe,CAAC;AAiBrC,MAAM,CAAC,IAAM,aAAa,GAAG,4CAA4C,CAAC;AAC1E,MAAM,CAAC,IAAM,aAAa,GAAG,+CAA+C,CAAC;AAC7E,MAAM,CAAC,IAAM,mBAAmB,GAAG,CAAC,CAAC;AAErC;;;GAGG;AACH,IAAM,eAAe,GAAG,IAAI,CAAC;AAC7B,cAAc;AACd,uEAAuE;AACvE,MAAM,CAAC,IAAM,YAAY,GAAG;IAC1B,yBAAyB;IACzB,qCAAqC;IACrC,iCAAiC;IACjC,iCAAiC;IACjC,kCAAkC;IAClC,mCAAmC;CACpC,CAAC;AAwEF;IAQE,4BAAY,MAAc,EAAE,MAAe,EAAE,UAAiC;QAAjC,2BAAA,EAAA,iBAAiC;QAH9E,2CAA2C;QAC3C,kBAAa,GAAmB,EAAE,CAAC;QAGjC,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,IAAI,CAAC,SAAS,GAAG,UAAU,KAAK,IAAI,CAAC,CAAC,CAAC,aAAa,CAAC,CAAC,CAAC,aAAa,CAAC;QACrE,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,IAAI,CAAC,OAAO,GAAG,IAAI,wBAAwB,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAC9D,CAAC;IAED,sCAAS,GAAT,UAAU,GAAuB,EAAE,YAA0B,EAAE,QAA8B;QAC3F,IAAM,EAAE,GAAG,IAAI,EAAE,CAAC;QAClB,IAAM,YAAY,GAAG;YACnB,EAAE,EAAE,EAAE;YACN,GAAG,EAAE,GAAG;YACR,YAAY,EAAE,YAAY;YAC1B,QAAQ,EAAE,QAAQ;SACnB,CAAC;QACF,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;QAEtC,IAAI,YAAY,KAAK,KAAK,EAAE;YAC1B,KAAK,IAAI,CAAC,YAAY,CAAC,YAAY,CAAC,CAAC;SACtC;aAAM;YACL,KAAK,IAAI,CAAC,sBAAsB,CAAC,YAAY,EAAE,YAAY,CAAC,OAAO,CAAC,CAAC;SACtE;QAED,OAAO,EAAE,CAAC;IACZ,CAAC;IAED,wCAAW,GAAX,UAAY,EAAU;QACpB,IAAM,KAAK,GAAG,IAAI,CAAC,aAAa,CAAC,SAAS,CAAC,UAAC,YAAY,IAAK,OAAA,YAAY,CAAC,EAAE,KAAK,EAAE,EAAtB,CAAsB,CAAC,CAAC;QACrF,IAAI,KAAK,KAAK,CAAC,CAAC,EAAE;YAChB,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,2EAAoE,EAAE,oBAAiB,CAAC,CAAC;YAC3G,OAAO,KAAK,CAAC;SACd;QAED,IAAI,CAAC,aAAa,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC;QACpC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,+EAAwE,EAAE,MAAG,CAAC,CAAC;QACjG,OAAO,IAAI,CAAC;IACd,CAAC;IAEK,0CAAa,GAAnB;;;;;;4BACiB,qBAAM,IAAI,CAAC,KAAK,EAAE,EAAA;;wBAA3B,MAAM,GAAG,SAAkB;wBACjC,KAAK,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC;wBACpC,IAAI,CAAC,aAAa,CAAC,OAAO,CAAC,UAAC,YAAY;4BACtC,KAAI,CAAC,YAAY,CAAC,YAAY,EAAE,MAAM,EAAE,QAAQ,CAAC,CAAC;wBACpD,CAAC,CAAC,CAAC;;;;;KACJ;IAED;;;;OAIG;IACG,yCAAY,GAAlB,UAAmB,YAA0B;;;;;;;wBACrC,aAAa,GAAG,IAAI,CAAC,KAAK,EAAE,CAAC,IAAI,CAAC,UAAC,MAAM;4BAC7C,KAAI,CAAC,MAAM,CAAC,KAAK,CAAC,iEAAiE,CAAC,CAAC;4BACrF,KAAI,CAAC,YAAY,CAAC,YAAY,EAAE,MAAM,EAAE,QAAQ,CAAC,CAAC;4BAClD,KAAK,KAAI,CAAC,OAAO,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC;wBACtC,CAAC,CAAC,CAAC;wBAEG,YAAY,GAAG,IAAI,CAAC,OAAO,CAAC,WAAW,EAAE,CAAC,IAAI,CAAC,UAAC,MAAM;4BAC1D,OAAO,MAAM,CAAC;wBAChB,CAAC,CAAC,CAAC;wBAGY,qBAAM,OAAO,CAAC,IAAI,CAAC,CAAC,aAAa,EAAE,YAAY,CAAC,CAAC,EAAA;;wBAA1D,MAAM,GAAG,SAAiD;wBAEhE,8CAA8C;wBAC9C,IAAI,MAAM,KAAK,SAAS,EAAE;4BACxB,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,gEAAgE,CAAC,CAAC;4BACpF,IAAI,CAAC,YAAY,CAAC,YAAY,EAAE,MAAM,EAAE,OAAO,CAAC,CAAC;yBAClD;wBACD,qBAAM,aAAa,EAAA;;wBAAnB,SAAmB,CAAC;;;;;KACrB;IAED;;OAEG;IACG,mDAAsB,GAA5B,UAA6B,YAA0B,EAAE,OAAe;;;;;;wBAChE,cAAc,GAAG,IAAI,OAAO,CAAC,UAAC,CAAC,EAAE,MAAM;4BAC3C,UAAU,CAAC;gCACT,MAAM,CAAC,kBAAkB,CAAC,CAAC;4BAC7B,CAAC,EAAE,OAAO,CAAC,CAAC;wBACd,CAAC,CAAC,CAAC;;;;wBAGiC,qBAAM,OAAO,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,KAAK,EAAE,EAAE,cAAc,CAAC,CAAC,EAAA;;wBAA9E,MAAM,GAAqB,CAAC,SAAkD,CAAqB;wBAEzG,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,6EAA6E,CAAC,CAAC;wBACjG,IAAI,CAAC,YAAY,CAAC,YAAY,EAAE,MAAM,EAAE,QAAQ,CAAC,CAAC;wBAClD,KAAK,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC;;;;wBAEpC,IAAI,CAAC,MAAM,CAAC,KAAK,CACf,mGAAmG,CACpG,CAAC;wBACa,qBAAM,IAAI,CAAC,OAAO,CAAC,WAAW,EAAE,EAAA;;wBAAzC,MAAM,GAAG,SAAgC;wBAC/C,IAAI,MAAM,CAAC,YAAY,KAAK,IAAI,EAAE;4BAChC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,+EAA+E,CAAC,CAAC;4BACnG,IAAI,CAAC,YAAY,CAAC,YAAY,EAAE,MAAM,EAAE,OAAO,CAAC,CAAC;yBAClD;6BAAM;4BACL,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,+EAA+E,CAAC,CAAC;4BACnG,IAAI,CAAC,YAAY,CAAC,YAAY,EAAE,MAAM,EAAE,QAAQ,CAAC,CAAC;yBACnD;;;;;;KAEJ;IAED;;;OAGG;IACH,yCAAY,GAAZ,UAAa,YAA0B,EAAE,gBAAkC,EAAE,MAAc;QACzF,YAAY,CAAC,YAAY,GAAG,IAAI,IAAI,EAAE,CAAC;QAEvC,IAAI,cAAmC,CAAC;QACxC,IAAI,YAAY,CAAC,GAAG,EAAE;YACpB,+BAA+B;YAC/B,qDAAqD;YACrD,8CAA8C;YAC9C,0CAA0C;YAC1C,cAAc,GAAG,YAAY,CAAC,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,MAAM,CAAC,UAAC,MAAM,EAAE,GAAG;gBAC9D,IAAI,MAAM,KAAK,IAAI,EAAE;oBACnB,OAAO,MAAM,CAAC;iBACf;gBAED,OAAO,GAAG,IAAI,MAAM,CAAC,CAAC,CAAE,MAAM,CAAC,GAAG,CAAkB,CAAC,CAAC,CAAC,IAAI,CAAC;YAC9D,CAAC,EAAE,gBAAgB,CAAC,YAAY,CAAC,CAAC;SACnC;aAAM;YACL,cAAc,GAAG,gBAAgB,CAAC,YAAY,CAAC;SAChD;QAED,YAAY,CAAC,QAAQ,CAAC,cAAc,EAAE,MAAM,EAAE,gBAAgB,CAAC,SAAS,CAAC,CAAC;IAC5E,CAAC;IAEK,kCAAK,GAAX,UAAY,OAAqC,EAAE,OAAiC;QAAxE,wBAAA,EAAA,6BAAqC;QAAE,wBAAA,EAAA,yBAAiC;;;;;;;wBAC5E,QAAQ,GAAG,OAAO,GAAG,OAAO,CAAC;wBAC7B,sBAAsB,GAAqB;4BAC/C,YAAY,EAAE,IAAI;4BAClB,SAAS,EAAE,IAAI,IAAI,EAAE;yBACtB,CAAC;wBAEO,OAAO,GAAG,CAAC;;;6BAAE,CAAA,OAAO,GAAG,OAAO,CAAA;;;;wBAEvB,qBAAM,KAAK,CAAC,IAAI,CAAC,YAAY,EAAE,EAAE;gCAC3C,MAAM,EAAE,KAAK;gCACb,OAAO,EAAE;oCACP,MAAM,EAAE,KAAK;iCACd;6BACF,CAAC,EAAA;;wBALI,GAAG,GAAG,SAKV;6BAGE,CAAC,GAAG,CAAC,EAAE,EAAP,wBAAO;wBACI,qBAAM,GAAG,CAAC,IAAI,EAAE,EAAA;;wBAAvB,IAAI,GAAG,SAAgB;wBAC7B,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,qDAA8C,OAAO,0BAAgB,GAAG,CAAC,MAAM,eAAK,IAAI,CAAE,CAAC,CAAC;;4BAG1E,qBAAM,GAAG,CAAC,IAAI,EAAE,EAAA;;wBAA9C,YAAY,GAAiB,CAAC,SAAgB,CAAiB;wBACrE,sBAAO;gCACL,YAAY,EAAE,YAAY;gCAC1B,SAAS,EAAE,IAAI,IAAI,EAAE;6BACtB,EAAC;;;;wBAGJ,sEAAsE;wBACtE,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,qDAA8C,OAAO,2BAAwB,EAAE,OAAK,CAAC,CAAC;;;6BAMtG,CAAA,OAAO,GAAG,OAAO,GAAG,CAAC,CAAA,EAArB,yBAAqB;wBACvB,qBAAM,IAAI,OAAO,CAAC,UAAC,OAAO,IAAK,OAAA,UAAU,CAAC,OAAO,EAAE,KAAI,CAAC,cAAc,CAAC,QAAQ,CAAC,CAAC,EAAlD,CAAkD,CAAC,EAAA;;wBAAlF,SAAkF,CAAC;;;wBA9B9C,OAAO,EAAE,CAAA;;6BAkClD,sBAAO,sBAAsB,EAAC;;;;KAC/B;IAED;;OAEG;IACH,2CAAc,GAAd,UAAe,SAAiB;QAC9B,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,EAAE,GAAG,SAAS,CAAC,CAAC;IAC/C,CAAC;IAED,yCAAY,GAAZ;QACE,IAAM,SAAS,GAAG,IAAI,eAAe,CAAC;YACpC,OAAO,EAAE,IAAI,CAAC,MAAM;SACrB,CAAC,CAAC;QACH,YAAY,CAAC,OAAO,CAAC,UAAC,GAAG;YACvB,SAAS,CAAC,MAAM,CAAC,aAAa,EAAE,GAAG,CAAC,CAAC;QACvC,CAAC,CAAC,CAAC;QAEH,OAAO,UAAG,IAAI,CAAC,SAAS,cAAI,SAAS,CAAC,QAAQ,EAAE,CAAE,CAAC;IACrD,CAAC;IACH,yBAAC;AAAD,CAAC,AAxMD,IAwMC","sourcesContent":["import { ServerZoneType } from '../types/server-zone';\nimport { ILogger } from '../logger';\nimport { RemoteConfigLocalStorage } from './remote-config-localstorage';\nimport { UUID } from '../utils/uuid';\n\n/**\n * Modes for receiving remote config updates:\n * - `'all'` – Receive all config updates as they occur.\n * - `{ timeout: number }` – Wait for a remote response until the specified timeout (in milliseconds),\n *   then return a cached copy if available.\n */\nexport type DeliveryMode = 'all' | { timeout: number };\n\n/**\n * Sources of returned remote config:\n * - `cache` - Fetched from local storage.\n * - `remote` - Fetched from remote.\n */\nexport type Source = 'cache' | 'remote';\n\nexport const US_SERVER_URL = 'https://sr-client-cfg.amplitude.com/config';\nexport const EU_SERVER_URL = 'https://sr-client-cfg.eu.amplitude.com/config';\nexport const DEFAULT_MAX_RETRIES = 3;\n\n/**\n * The default timeout for fetch in milliseconds.\n * Linear backoff policy: timeout / retry times is the interval between fetch retry.\n */\nconst DEFAULT_TIMEOUT = 1000;\n// TODO(xinyi)\n// const DEFAULT_MIN_TIME_BETWEEN_FETCHES = 5 * 60 * 1000; // 5 minutes\nexport const FETCHED_KEYS = [\n  'analyticsSDK.browserSDK',\n  'sessionReplay.sr_interaction_config',\n  'sessionReplay.sr_logging_config',\n  'sessionReplay.sr_privacy_config',\n  'sessionReplay.sr_sampling_config',\n  'sessionReplay.sr_targeting_config',\n];\n\nexport interface RemoteConfig {\n  [key: string]: any;\n}\n\nexport interface RemoteConfigInfo {\n  remoteConfig: RemoteConfig | null;\n  // Timestamp of when the remote config was fetched.\n  lastFetch: Date;\n}\n\nexport interface RemoteConfigStorage {\n  /**\n   * Fetch remote config from storage asynchronously.\n   */\n  fetchConfig(): Promise<RemoteConfigInfo>;\n\n  /**\n   * Set remote config to storage asynchronously.\n   */\n  setConfig(config: RemoteConfigInfo): Promise<boolean>;\n}\n\n/**\n * Information about each callback registered by `RemoteConfigClient.subscribe()`,\n * managed internally by `RemoteConfigClient`.\n */\nexport interface CallbackInfo {\n  id: string;\n  key?: string;\n  deliveryMode: DeliveryMode;\n  callback: RemoteConfigCallback;\n  lastCallback?: Date;\n}\n\n/**\n * Callback used in `RemoteConfigClient.subscribe()`.\n * This function is called when the remote config is fetched.\n */\ntype RemoteConfigCallback = (remoteConfig: RemoteConfig | null, source: Source, lastFetch: Date) => void;\n\nexport interface IRemoteConfigClient {\n  /**\n   * Subscribe for updates to remote config.\n   * Callback is guaranteed to be called at least once,\n   * Whether we are able to fetch a config or not.\n   *\n   * @param key - a string containing a series of period delimited keys to filter the returned config.\n   * Ie, {a: {b: {c: ...}}} would return {b: {c: ...}} for \"a\" or {c: ...} for \"a.b\".\n   * Set to `undefined` to subscribe all keys.\n   * @param deliveryMode - how the initial callback is sent.\n   * @param callback - a block that will be called when remote config is fetched.\n   * @return id - identification of the subscribe and can be used to unsubscribe from updates.\n   */\n  subscribe(key: string | undefined, deliveryMode: DeliveryMode, callback: RemoteConfigCallback): string;\n\n  /**\n   * Unsubscribe a callback from receiving future updates.\n   *\n   * @param id - identification of the callback that you want to unsubscribe.\n   * It's the return value of subscribe().\n   * @return boolean - whether the callback is removed.\n   */\n  unsubscribe(id: string): boolean;\n\n  /**\n   * Request the remote config client to fetch from remote, update cache, and callback.\n   */\n  updateConfigs(): void;\n}\n\nexport class RemoteConfigClient implements IRemoteConfigClient {\n  readonly apiKey: string;\n  readonly serverUrl: string;\n  readonly logger: ILogger;\n  readonly storage: RemoteConfigStorage;\n  // Registered callbackInfos by subscribe().\n  callbackInfos: CallbackInfo[] = [];\n\n  constructor(apiKey: string, logger: ILogger, serverZone: ServerZoneType = 'US') {\n    this.apiKey = apiKey;\n    this.serverUrl = serverZone === 'US' ? US_SERVER_URL : EU_SERVER_URL;\n    this.logger = logger;\n    this.storage = new RemoteConfigLocalStorage(apiKey, logger);\n  }\n\n  subscribe(key: string | undefined, deliveryMode: DeliveryMode, callback: RemoteConfigCallback): string {\n    const id = UUID();\n    const callbackInfo = {\n      id: id,\n      key: key,\n      deliveryMode: deliveryMode,\n      callback: callback,\n    };\n    this.callbackInfos.push(callbackInfo);\n\n    if (deliveryMode === 'all') {\n      void this.subscribeAll(callbackInfo);\n    } else {\n      void this.subscribeWaitForRemote(callbackInfo, deliveryMode.timeout);\n    }\n\n    return id;\n  }\n\n  unsubscribe(id: string): boolean {\n    const index = this.callbackInfos.findIndex((callbackInfo) => callbackInfo.id === id);\n    if (index === -1) {\n      this.logger.debug(`Remote config client unsubscribe failed because callback with id ${id} doesn't exist.`);\n      return false;\n    }\n\n    this.callbackInfos.splice(index, 1);\n    this.logger.debug(`Remote config client unsubscribe succeeded removing callback with id ${id}.`);\n    return true;\n  }\n\n  async updateConfigs() {\n    const result = await this.fetch();\n    void this.storage.setConfig(result);\n    this.callbackInfos.forEach((callbackInfo) => {\n      this.sendCallback(callbackInfo, result, 'remote');\n    });\n  }\n\n  /**\n   * Send remote first. If it's already complete, we can skip the cached response.\n   * - if remote is fetched first, no cache fetch.\n   * - if cache is fetched first, still fetching remote.\n   */\n  async subscribeAll(callbackInfo: CallbackInfo) {\n    const remotePromise = this.fetch().then((result) => {\n      this.logger.debug('Remote config client subscription all mode fetched from remote.');\n      this.sendCallback(callbackInfo, result, 'remote');\n      void this.storage.setConfig(result);\n    });\n\n    const cachePromise = this.storage.fetchConfig().then((result) => {\n      return result;\n    });\n\n    // Wait for the first result to resolve\n    const result = await Promise.race([remotePromise, cachePromise]);\n\n    // If cache is fetched first, wait for remote.\n    if (result !== undefined) {\n      this.logger.debug('Remote config client subscription all mode fetched from cache.');\n      this.sendCallback(callbackInfo, result, 'cache');\n    }\n    await remotePromise;\n  }\n\n  /**\n   * Waits for a remote response until the given timeout, then return a cached copy, if available.\n   */\n  async subscribeWaitForRemote(callbackInfo: CallbackInfo, timeout: number) {\n    const timeoutPromise = new Promise((_, reject) => {\n      setTimeout(() => {\n        reject('Timeout exceeded');\n      }, timeout);\n    });\n\n    try {\n      const result: RemoteConfigInfo = (await Promise.race([this.fetch(), timeoutPromise])) as RemoteConfigInfo;\n\n      this.logger.debug('Remote config client subscription wait for remote mode returns from remote.');\n      this.sendCallback(callbackInfo, result, 'remote');\n      void this.storage.setConfig(result);\n    } catch (error) {\n      this.logger.debug(\n        'Remote config client subscription wait for remote mode exceeded timeout. Try to fetch from cache.',\n      );\n      const result = await this.storage.fetchConfig();\n      if (result.remoteConfig !== null) {\n        this.logger.debug('Remote config client subscription wait for remote mode returns a cached copy.');\n        this.sendCallback(callbackInfo, result, 'cache');\n      } else {\n        this.logger.debug('Remote config client subscription wait for remote mode failed to fetch cache.');\n        this.sendCallback(callbackInfo, result, 'remote');\n      }\n    }\n  }\n\n  /**\n   * Call the callback with filtered remote config based on key.\n   * @param remoteConfigInfo - the whole remote config object without filtering by key.\n   */\n  sendCallback(callbackInfo: CallbackInfo, remoteConfigInfo: RemoteConfigInfo, source: Source) {\n    callbackInfo.lastCallback = new Date();\n\n    let filteredConfig: RemoteConfig | null;\n    if (callbackInfo.key) {\n      // Filter remote config by key.\n      // For example, if remote config is {a: {b: {c: 1}}},\n      // if key = 'a', filter result is {b: {c: 1}};\n      // if key = 'a.b', filter result is {c: 1}\n      filteredConfig = callbackInfo.key.split('.').reduce((config, key) => {\n        if (config === null) {\n          return config;\n        }\n\n        return key in config ? (config[key] as RemoteConfig) : null;\n      }, remoteConfigInfo.remoteConfig);\n    } else {\n      filteredConfig = remoteConfigInfo.remoteConfig;\n    }\n\n    callbackInfo.callback(filteredConfig, source, remoteConfigInfo.lastFetch);\n  }\n\n  async fetch(retries: number = DEFAULT_MAX_RETRIES, timeout: number = DEFAULT_TIMEOUT): Promise<RemoteConfigInfo> {\n    const interval = timeout / retries;\n    const failedRemoteConfigInfo: RemoteConfigInfo = {\n      remoteConfig: null,\n      lastFetch: new Date(),\n    };\n\n    for (let attempt = 0; attempt < retries; attempt++) {\n      try {\n        const res = await fetch(this.getUrlParams(), {\n          method: 'GET',\n          headers: {\n            Accept: '*/*',\n          },\n        });\n\n        // Handle unsuccessful fetch\n        if (!res.ok) {\n          const body = await res.text();\n          this.logger.debug(`Remote config client fetch with retry time ${retries} failed with ${res.status}: ${body}`);\n        } else {\n          // Handle successful fetch\n          const remoteConfig: RemoteConfig = (await res.json()) as RemoteConfig;\n          return {\n            remoteConfig: remoteConfig,\n            lastFetch: new Date(),\n          };\n        }\n      } catch (error) {\n        // Handle rejects when the request fails, for example, a network error\n        this.logger.debug(`Remote config client fetch with retry time ${retries} is rejected because: `, error);\n      }\n\n      // Linear backoff:\n      // wait for the specified interval before the next attempt\n      // except after the last attempt.\n      if (attempt < retries - 1) {\n        await new Promise((resolve) => setTimeout(resolve, this.getJitterDelay(interval)));\n      }\n    }\n\n    return failedRemoteConfigInfo;\n  }\n\n  /**\n   * Return jitter in the bound of [0,baseDelay) and then floor round.\n   */\n  getJitterDelay(baseDelay: number): number {\n    return Math.floor(Math.random() * baseDelay);\n  }\n\n  getUrlParams(): string {\n    const urlParams = new URLSearchParams({\n      api_key: this.apiKey,\n    });\n    FETCHED_KEYS.forEach((key) => {\n      urlParams.append('config_keys', key);\n    });\n\n    return `${this.serverUrl}?${urlParams.toString()}`;\n  }\n}\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@amplitude/analytics-core",
-  "version": "2.7.0",
+  "version": "2.8.0",
   "description": "",
   "author": "Amplitude Inc",
   "homepage": "https://github.com/amplitude/Amplitude-TypeScript",
@@ -40,5 +40,5 @@
   "files": [
     "lib"
   ],
-  "gitHead": "752b2b1ac8983914f501c4cf69da22b75ef572e4"
+  "gitHead": "0f7347c36a91764514bea8508f5792d1a27fde52"
 }