@launchdarkly/node-server-sdk-redis 0.1.0

package/CHANGELOG.md

@@ -0,0 +1,15 @@
+# Changelog
+
+## 0.1.0 (2023-06-15)
+
+
+### Features
+
+* Implement redis persistent store and big segment store. ([#146](https://github.com/launchdarkly/js-core/issues/146)) ([fee603c](https://github.com/launchdarkly/js-core/commit/fee603c615d6d17dc7c3248f5ef25a99539d3221))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * devDependencies
+    * @launchdarkly/node-server-sdk bumped from 0.4.4 to 0.5.0

package/LICENSE

@@ -0,0 +1,13 @@
+Copyright 2023 Catamorphic, Co.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

package/README.md

@@ -0,0 +1,89 @@
+# LaunchDarkly Server-Side SDK for Node.js
+
+[![NPM][node-redis-npm-badge]][node-redis-npm-link]
+[![Actions Status][node-redis-ci-badge]][node-redis-ci]
+[![Documentation](https://img.shields.io/static/v1?label=GitHub+Pages&message=API+reference&color=00add8)](https://launchdarkly.github.io/js-core/packages/store/node-server-sdk-redis/docs/)
+
+This library provides a Redis-backed persistence mechanism (feature store) for the [LaunchDarkly Node.js SDK](https://github.com/launchdarkly/js-core/packages/sdk/server-node), replacing the default in-memory feature store. The underlying Redis client implementation is [ioredis](https://github.com/luin/ioredis).
+
+The minimum version of the LaunchDarkly Server-Side SDK for Node for use with this library is 8.0.0. 
+
+This SDK is a beta version and should not be considered ready for production use while this message is visible.
+
+## LaunchDarkly overview
+
+[LaunchDarkly](https://www.launchdarkly.com) is a feature management platform that serves over 100 billion feature flags daily to help teams build better software, faster. [Get started](https://docs.launchdarkly.com/home/getting-started) using LaunchDarkly today!
+
+[![Twitter Follow](https://img.shields.io/twitter/follow/launchdarkly.svg?style=social&label=Follow&maxAge=2592000)](https://twitter.com/intent/follow?screen_name=launchdarkly)
+
+## Supported Node versions
+
+This package is compatible with Node.js versions 14 and above.
+
+## Getting started
+
+Refer to [Using Redis as a persistent feature store](https://docs.launchdarkly.com/sdk/features/storing-data/redis#nodejs-server-side).
+
+## Quick setup
+
+This assumes that you have already installed the LaunchDarkly Node.js SDK.
+
+1. Install this package with `npm` or `yarn`:
+
+```shell
+npm install @launchdarkly/node-server-sdk-redis --save
+```
+
+2. If your application does not already have its own dependency on the `ioredis` package, add `ioredis` as well:
+
+```shell
+npm install ioredis --save
+```
+
+3. Import the package:
+
+```typescript
+import { RedisFeatureStoreFactory } = from '@launchdarkly/node-server-sdk-redis';
+```
+
+4. When configuring your SDK client, add the Redis feature store:
+
+```typescript
+const storeFactory = RedisFeatureStoreFactory();
+const config = { featureStore: storeFactory };
+const client = LaunchDarkly.init('YOUR SDK KEY', config);
+```
+
+By default, the store will try to connect to a local Redis instance on port 6379. You may specify an alternate configuration as described in the API documentation for `RedisFeatureStoreFactory`.
+
+## Caching behavior
+
+To reduce traffic to Redis, there is an optional in-memory cache that retains the last known data for a configurable amount of time. This is on by default; to turn it off (and guarantee that the latest feature flag data will always be retrieved from Redis for every flag evaluation), configure the store as follows:
+
+```typescript
+const factory = RedisFeatureStoreFactory({ cacheTTL: 0 });
+```
+
+## Contributing
+
+We encourage pull requests and other contributions from the community. Check out our [contributing guidelines](CONTRIBUTING.md) for instructions on how to contribute to this SDK.
+
+## About LaunchDarkly
+
+- LaunchDarkly is a continuous delivery platform that provides feature flags as a service and allows developers to iterate quickly and safely. We allow you to easily flag your features and manage them from the LaunchDarkly dashboard. With LaunchDarkly, you can:
+  - Roll out a new feature to a subset of your users (like a group of users who opt-in to a beta tester group), gathering feedback and bug reports from real-world use cases.
+  - Gradually roll out a feature to an increasing percentage of users, and track the effect that the feature has on key metrics (for instance, how likely is a user to complete a purchase if they have feature A versus feature B?).
+  - Turn off a feature that you realize is causing performance problems in production, without needing to re-deploy, or even restart the application with a changed configuration file.
+  - Grant access to certain features based on user attributes, like payment plan (eg: users on the ‘gold’ plan get access to more features than users in the ‘silver’ plan). Disable parts of your application to facilitate maintenance, without taking everything offline.
+- LaunchDarkly provides feature flag SDKs for a wide variety of languages and technologies. Check out [our documentation](https://docs.launchdarkly.com/sdk) for a complete list.
+- Explore LaunchDarkly
+  - [launchdarkly.com](https://www.launchdarkly.com/ 'LaunchDarkly Main Website') for more information
+  - [docs.launchdarkly.com](https://docs.launchdarkly.com/ 'LaunchDarkly Documentation') for our documentation and SDK reference guides
+  - [apidocs.launchdarkly.com](https://apidocs.launchdarkly.com/ 'LaunchDarkly API Documentation') for our API documentation
+  - [blog.launchdarkly.com](https://blog.launchdarkly.com/ 'LaunchDarkly Blog Documentation') for the latest product updates
+
+[node-redis-ci-badge]: https://github.com/launchdarkly/js-core/actions/workflows/node-redis.yml/badge.svg
+[node-redis-ci]: https://github.com/launchdarkly/js-core/actions/workflows/node-redis.yml
+
+[node-redis-npm-badge]: https://img.shields.io/npm/v/@launchdarkly/node-server-sdk-redis.svg?style=flat-square
+[node-redis-npm-link]: https://www.npmjs.com/package/@launchdarkly/node-server-sdk-redis

package/dist/src/LDRedisOptions.d.ts

@@ -0,0 +1,36 @@
+import { RedisOptions, Redis } from 'ioredis';
+/**
+ * The standard options supported for the LaunchDarkly Redis integration.
+ */
+export default interface LDRedisOptions {
+    /**
+     * Optional configuration parameters to be passed to the `redis` package that handles communication
+     * with the Redis server.
+     *
+     * This includes properties such as `host` and `port`. For more details, see:
+     * https://github.com/luin/ioredis
+     *
+     * If you leave this property empty, the default is to connect to `localhost:6379`.
+     */
+    redisOpts?: RedisOptions;
+    /**
+     * A string that will be prepended to all Redis keys used by the SDK.
+     */
+    prefix?: string;
+    /**
+     * Set this property if you already have a Redis client instance that you wish to reuse. In this
+     * case, `redisOpts` will be ignored.
+     */
+    client?: Redis;
+    /**
+     * The amount of time, in seconds, that recently read or updated items should remain in an
+     * in-memory cache. If it is zero, there will be no in-memory caching. The default TTL will be
+     * 30 seconds if one is not set.
+     *
+     * This parameter applies only to RedisFeatureStore. It is ignored for RedisBigSegmentStore.
+     * Caching for RedisBigSegmentStore is configured separately, in the SDK's
+     * `LDBigSegmentsOptions` type, since it is independent of what database implementation is used.
+     */
+    cacheTTL?: number;
+}
+//# sourceMappingURL=LDRedisOptions.d.ts.map

package/dist/src/LDRedisOptions.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"LDRedisOptions.d.ts","sourceRoot":"","sources":["../../src/LDRedisOptions.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,KAAK,EAAE,MAAM,SAAS,CAAC;AAE9C;;GAEG;AACH,MAAM,CAAC,OAAO,WAAW,cAAc;IACrC;;;;;;;;OAQG;IACH,SAAS,CAAC,EAAE,YAAY,CAAC;IAEzB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;;OAGG;IACH,MAAM,CAAC,EAAE,KAAK,CAAC;IAEf;;;;;;;;OAQG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB"}

package/dist/src/LDRedisOptions.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=LDRedisOptions.js.map

package/dist/src/LDRedisOptions.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"LDRedisOptions.js","sourceRoot":"","sources":["../../src/LDRedisOptions.ts"],"names":[],"mappings":""}

package/dist/src/RedisBigSegmentStore.d.ts

@@ -0,0 +1,11 @@
+import { LDLogger, interfaces } from '@launchdarkly/node-server-sdk';
+import LDRedisOptions from './LDRedisOptions';
+export default class RedisBigSegmentStore implements interfaces.BigSegmentStore {
+    private readonly logger?;
+    private state;
+    constructor(options?: LDRedisOptions, logger?: LDLogger | undefined);
+    getMetadata(): Promise<interfaces.BigSegmentStoreMetadata | undefined>;
+    getUserMembership(userHash: string): Promise<interfaces.BigSegmentStoreMembership | undefined>;
+    close(): void;
+}
+//# sourceMappingURL=RedisBigSegmentStore.d.ts.map

package/dist/src/RedisBigSegmentStore.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"RedisBigSegmentStore.d.ts","sourceRoot":"","sources":["../../src/RedisBigSegmentStore.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,UAAU,EAAE,MAAM,+BAA+B,CAAC;AACrE,OAAO,cAAc,MAAM,kBAAkB,CAAC;AAkB9C,MAAM,CAAC,OAAO,OAAO,oBAAqB,YAAW,UAAU,CAAC,eAAe;IAMvC,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAC;IAL9D,OAAO,CAAC,KAAK,CAAmB;gBAKpB,OAAO,CAAC,EAAE,cAAc,EAAmB,MAAM,CAAC,sBAAU;IAIlE,WAAW,IAAI,OAAO,CAAC,UAAU,CAAC,uBAAuB,GAAG,SAAS,CAAC;IAUtE,iBAAiB,CACrB,QAAQ,EAAE,MAAM,GACf,OAAO,CAAC,UAAU,CAAC,yBAAyB,GAAG,SAAS,CAAC;IAyB5D,KAAK,IAAI,IAAI;CAGd"}

package/dist/src/RedisBigSegmentStore.js

@@ -0,0 +1,72 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.KEY_USER_EXCLUDE = exports.KEY_USER_INCLUDE = exports.KEY_LAST_SYNCHRONIZED = void 0;
+const RedisClientState_1 = require("./RedisClientState");
+/**
+ * @internal
+ */
+exports.KEY_LAST_SYNCHRONIZED = 'big_segments_synchronized_on';
+/**
+ * @internal
+ */
+exports.KEY_USER_INCLUDE = 'big_segment_include';
+/**
+ * @internal
+ */
+exports.KEY_USER_EXCLUDE = 'big_segment_exclude';
+class RedisBigSegmentStore {
+    // Logger is not currently used, but is included to reduce the chance of a
+    // compatibility break to add a log.
+    // eslint-disable-next-line @typescript-eslint/no-unused-vars
+    constructor(options, logger) {
+        this.logger = logger;
+        this.state = new RedisClientState_1.default(options);
+    }
+    getMetadata() {
+        return __awaiter(this, void 0, void 0, function* () {
+            const value = yield this.state.getClient().get(this.state.prefixedKey(exports.KEY_LAST_SYNCHRONIZED));
+            // Value will be true if it is a string containing any characters, which is fine
+            // for this check.
+            if (value) {
+                return { lastUpToDate: parseInt(value, 10) };
+            }
+            return {};
+        });
+    }
+    getUserMembership(userHash) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const includedRefs = yield this.state
+                .getClient()
+                .smembers(this.state.prefixedKey(`${exports.KEY_USER_INCLUDE}:${userHash}`));
+            const excludedRefs = yield this.state
+                .getClient()
+                .smembers(this.state.prefixedKey(`${exports.KEY_USER_EXCLUDE}:${userHash}`));
+            // If there are no included/excluded refs, the don't return any membership.
+            if ((!includedRefs || !includedRefs.length) && (!excludedRefs || !excludedRefs.length)) {
+                return undefined;
+            }
+            const membership = {};
+            excludedRefs === null || excludedRefs === void 0 ? void 0 : excludedRefs.forEach((ref) => {
+                membership[ref] = false;
+            });
+            includedRefs === null || includedRefs === void 0 ? void 0 : includedRefs.forEach((ref) => {
+                membership[ref] = true;
+            });
+            return membership;
+        });
+    }
+    close() {
+        this.state.close();
+    }
+}
+exports.default = RedisBigSegmentStore;
+//# sourceMappingURL=RedisBigSegmentStore.js.map

package/dist/src/RedisBigSegmentStore.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"RedisBigSegmentStore.js","sourceRoot":"","sources":["../../src/RedisBigSegmentStore.ts"],"names":[],"mappings":";;;;;;;;;;;;AAEA,yDAAkD;AAElD;;GAEG;AACU,QAAA,qBAAqB,GAAG,8BAA8B,CAAC;AAEpE;;GAEG;AACU,QAAA,gBAAgB,GAAG,qBAAqB,CAAC;AAEtD;;GAEG;AACU,QAAA,gBAAgB,GAAG,qBAAqB,CAAC;AAEtD,MAAqB,oBAAoB;IAGvC,0EAA0E;IAC1E,oCAAoC;IACpC,6DAA6D;IAC7D,YAAY,OAAwB,EAAmB,MAAiB;QAAjB,WAAM,GAAN,MAAM,CAAW;QACtE,IAAI,CAAC,KAAK,GAAG,IAAI,0BAAgB,CAAC,OAAO,CAAC,CAAC;IAC7C,CAAC;IAEK,WAAW;;YACf,MAAM,KAAK,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,SAAS,EAAE,CAAC,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,6BAAqB,CAAC,CAAC,CAAC;YAC9F,gFAAgF;YAChF,kBAAkB;YAClB,IAAI,KAAK,EAAE;gBACT,OAAO,EAAE,YAAY,EAAE,QAAQ,CAAC,KAAK,EAAE,EAAE,CAAC,EAAE,CAAC;aAC9C;YACD,OAAO,EAAE,CAAC;QACZ,CAAC;KAAA;IAEK,iBAAiB,CACrB,QAAgB;;YAEhB,MAAM,YAAY,GAAG,MAAM,IAAI,CAAC,KAAK;iBAClC,SAAS,EAAE;iBACX,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,GAAG,wBAAgB,IAAI,QAAQ,EAAE,CAAC,CAAC,CAAC;YACvE,MAAM,YAAY,GAAG,MAAM,IAAI,CAAC,KAAK;iBAClC,SAAS,EAAE;iBACX,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,GAAG,wBAAgB,IAAI,QAAQ,EAAE,CAAC,CAAC,CAAC;YAEvE,2EAA2E;YAC3E,IAAI,CAAC,CAAC,YAAY,IAAI,CAAC,YAAY,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,YAAY,IAAI,CAAC,YAAY,CAAC,MAAM,CAAC,EAAE;gBACtF,OAAO,SAAS,CAAC;aAClB;YAED,MAAM,UAAU,GAAyC,EAAE,CAAC;YAE5D,YAAY,aAAZ,YAAY,uBAAZ,YAAY,CAAE,OAAO,CAAC,CAAC,GAAG,EAAE,EAAE;gBAC5B,UAAU,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC;YAC1B,CAAC,CAAC,CAAC;YACH,YAAY,aAAZ,YAAY,uBAAZ,YAAY,CAAE,OAAO,CAAC,CAAC,GAAG,EAAE,EAAE;gBAC5B,UAAU,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC;YACzB,CAAC,CAAC,CAAC;YAEH,OAAO,UAAU,CAAC;QACpB,CAAC;KAAA;IAED,KAAK;QACH,IAAI,CAAC,KAAK,CAAC,KAAK,EAAE,CAAC;IACrB,CAAC;CACF;AAlDD,uCAkDC"}

package/dist/src/RedisBigSegmentStoreFactory.d.ts

@@ -0,0 +1,15 @@
+import { LDOptions, interfaces } from '@launchdarkly/node-server-sdk';
+import LDRedisOptions from './LDRedisOptions';
+/**
+ * Configures a big segment store factory backed by a Redis instance.
+ *
+ * "Big segments" are a specific type of user segments. For more information, read the
+ * LaunchDarkly documentation about user segments: https://docs.launchdarkly.com/home/users/segments
+ *
+ * @param options The standard options supported for all LaunchDarkly Redis features, including both
+ *   options for Redis itself and others related to the SDK's behavior.
+ *
+ * @returns A function which creates big segment stores based on the provided config.
+ */
+export default function RedisBigSegmentStoreFactory(options?: LDRedisOptions): (config: LDOptions) => interfaces.BigSegmentStore;
+//# sourceMappingURL=RedisBigSegmentStoreFactory.d.ts.map

package/dist/src/RedisBigSegmentStoreFactory.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"RedisBigSegmentStoreFactory.d.ts","sourceRoot":"","sources":["../../src/RedisBigSegmentStoreFactory.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,UAAU,EAAE,MAAM,+BAA+B,CAAC;AACtE,OAAO,cAAc,MAAM,kBAAkB,CAAC;AAG9C;;;;;;;;;;GAUG;AACH,MAAM,CAAC,OAAO,UAAU,2BAA2B,CACjD,OAAO,CAAC,EAAE,cAAc,GACvB,CAAC,MAAM,EAAE,SAAS,KAAK,UAAU,CAAC,eAAe,CAEnD"}

package/dist/src/RedisBigSegmentStoreFactory.js

@@ -0,0 +1,19 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const RedisBigSegmentStore_1 = require("./RedisBigSegmentStore");
+/**
+ * Configures a big segment store factory backed by a Redis instance.
+ *
+ * "Big segments" are a specific type of user segments. For more information, read the
+ * LaunchDarkly documentation about user segments: https://docs.launchdarkly.com/home/users/segments
+ *
+ * @param options The standard options supported for all LaunchDarkly Redis features, including both
+ *   options for Redis itself and others related to the SDK's behavior.
+ *
+ * @returns A function which creates big segment stores based on the provided config.
+ */
+function RedisBigSegmentStoreFactory(options) {
+    return (config) => new RedisBigSegmentStore_1.default(options, config.logger);
+}
+exports.default = RedisBigSegmentStoreFactory;
+//# sourceMappingURL=RedisBigSegmentStoreFactory.js.map

package/dist/src/RedisBigSegmentStoreFactory.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"RedisBigSegmentStoreFactory.js","sourceRoot":"","sources":["../../src/RedisBigSegmentStoreFactory.ts"],"names":[],"mappings":";;AAEA,iEAA0D;AAE1D;;;;;;;;;;GAUG;AACH,SAAwB,2BAA2B,CACjD,OAAwB;IAExB,OAAO,CAAC,MAAiB,EAAE,EAAE,CAAC,IAAI,8BAAoB,CAAC,OAAO,EAAE,MAAM,CAAC,MAAM,CAAC,CAAC;AACjF,CAAC;AAJD,8CAIC"}

package/dist/src/RedisClientState.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=RedisClientState.d.ts.map

package/dist/src/RedisClientState.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"RedisClientState.d.ts","sourceRoot":"","sources":["../../src/RedisClientState.ts"],"names":[],"mappings":""}

package/dist/src/RedisClientState.js

@@ -0,0 +1,109 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const ioredis_1 = require("ioredis");
+const DEFAULT_PREFIX = 'launchdarkly';
+/**
+ * Class for managing the state of a redis connection.
+ *
+ * Used for the redis persistent store as well as the redis big segment store.
+ *
+ * @internal
+ */
+class RedisClientState {
+    /**
+     * Construct a state with the given client.
+     *
+     * @param client The client for which state is being tracked.
+     * @param owned Is this client owned by the store integration, or was it
+     * provided externally.
+     */
+    constructor(options, logger) {
+        this.logger = logger;
+        this.connected = false;
+        this.attempt = 0;
+        this.initialConnection = true;
+        if (options === null || options === void 0 ? void 0 : options.client) {
+            this.client = options.client;
+            this.owned = false;
+        }
+        else if (options === null || options === void 0 ? void 0 : options.redisOpts) {
+            this.client = new ioredis_1.Redis(options.redisOpts);
+            this.owned = true;
+        }
+        else {
+            this.client = new ioredis_1.Redis();
+            this.owned = true;
+        }
+        this.base_prefix = (options === null || options === void 0 ? void 0 : options.prefix) || DEFAULT_PREFIX;
+        // If the client is not owned, then it should already be connected.
+        this.connected = !this.owned;
+        // We don't want to log a message on the first connection, only when reconnecting.
+        this.initialConnection = !this.connected;
+        const { client } = this;
+        client.on('error', (err) => {
+            logger === null || logger === void 0 ? void 0 : logger.error(`Redis error - ${err}`);
+        });
+        client.on('reconnecting', (delay) => {
+            this.attempt += 1;
+            logger === null || logger === void 0 ? void 0 : logger.info(`Attempting to reconnect to redis (attempt # ${this.attempt}, delay: ${delay}ms)`);
+        });
+        client.on('connect', () => {
+            var _a;
+            this.attempt = 0;
+            if (!this.initialConnection) {
+                (_a = this === null || this === void 0 ? void 0 : this.logger) === null || _a === void 0 ? void 0 : _a.warn('Reconnecting to Redis');
+            }
+            this.initialConnection = false;
+            this.connected = true;
+        });
+        client.on('end', () => {
+            this.connected = false;
+        });
+    }
+    /**
+     * Get the connection state.
+     *
+     * @returns True if currently connected.
+     */
+    isConnected() {
+        return this.connected;
+    }
+    /**
+     * Get is the client is using its initial connection.
+     *
+     * @returns True if using the initial connection.
+     */
+    isInitialConnection() {
+        return this.initialConnection;
+    }
+    /**
+     * Get the redis client.
+     *
+     * @returns The redis client.
+     */
+    getClient() {
+        return this.client;
+    }
+    /**
+     * If the client is owned, then this will 'quit' the client.
+     */
+    close() {
+        if (this.owned) {
+            this.client.quit().catch((err) => {
+                var _a;
+                // Not any action that can be taken for an error on quit.
+                (_a = this.logger) === null || _a === void 0 ? void 0 : _a.debug('Error closing ioredis client:', err);
+            });
+        }
+    }
+    /**
+     * Get a key with prefix prepended.
+     * @param key The key to prefix.
+     * @returns The prefixed key.
+     */
+    prefixedKey(key) {
+        return `${this.base_prefix}:${key}`;
+    }
+}
+exports.default = RedisClientState;
+//# sourceMappingURL=RedisClientState.js.map

package/dist/src/RedisClientState.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"RedisClientState.js","sourceRoot":"","sources":["../../src/RedisClientState.ts"],"names":[],"mappings":";;AACA,qCAAgC;AAGhC,MAAM,cAAc,GAAG,cAAc,CAAC;AAEtC;;;;;;GAMG;AACH,MAAqB,gBAAgB;IAanC;;;;;;OAMG;IACH,YAAY,OAAwB,EAAmB,MAAiB;QAAjB,WAAM,GAAN,MAAM,CAAW;QAnBhE,cAAS,GAAY,KAAK,CAAC;QAE3B,YAAO,GAAW,CAAC,CAAC;QAEpB,sBAAiB,GAAY,IAAI,CAAC;QAgBxC,IAAI,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,MAAM,EAAE;YACnB,IAAI,CAAC,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;YAC7B,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;SACpB;aAAM,IAAI,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,SAAS,EAAE;YAC7B,IAAI,CAAC,MAAM,GAAG,IAAI,eAAK,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;YAC3C,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC;SACnB;aAAM;YACL,IAAI,CAAC,MAAM,GAAG,IAAI,eAAK,EAAE,CAAC;YAC1B,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC;SACnB;QAED,IAAI,CAAC,WAAW,GAAG,CAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,MAAM,KAAI,cAAc,CAAC;QAErD,mEAAmE;QACnE,IAAI,CAAC,SAAS,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC;QAC7B,kFAAkF;QAClF,IAAI,CAAC,iBAAiB,GAAG,CAAC,IAAI,CAAC,SAAS,CAAC;QAEzC,MAAM,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC;QAExB,MAAM,CAAC,EAAE,CAAC,OAAO,EAAE,CAAC,GAAG,EAAE,EAAE;YACzB,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,KAAK,CAAC,iBAAiB,GAAG,EAAE,CAAC,CAAC;QACxC,CAAC,CAAC,CAAC;QAEH,MAAM,CAAC,EAAE,CAAC,cAAc,EAAE,CAAC,KAAa,EAAE,EAAE;YAC1C,IAAI,CAAC,OAAO,IAAI,CAAC,CAAC;YAClB,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,IAAI,CACV,+CAA+C,IAAI,CAAC,OAAO,YAAY,KAAK,KAAK,CAClF,CAAC;QACJ,CAAC,CAAC,CAAC;QAEH,MAAM,CAAC,EAAE,CAAC,SAAS,EAAE,GAAG,EAAE;;YACxB,IAAI,CAAC,OAAO,GAAG,CAAC,CAAC;YAEjB,IAAI,CAAC,IAAI,CAAC,iBAAiB,EAAE;gBAC3B,MAAA,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,MAAM,0CAAE,IAAI,CAAC,uBAAuB,CAAC,CAAC;aAC7C;YAED,IAAI,CAAC,iBAAiB,GAAG,KAAK,CAAC;YAC/B,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC;QACxB,CAAC,CAAC,CAAC;QAEH,MAAM,CAAC,EAAE,CAAC,KAAK,EAAE,GAAG,EAAE;YACpB,IAAI,CAAC,SAAS,GAAG,KAAK,CAAC;QACzB,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;;;OAIG;IACH,WAAW;QACT,OAAO,IAAI,CAAC,SAAS,CAAC;IACxB,CAAC;IAED;;;;OAIG;IACH,mBAAmB;QACjB,OAAO,IAAI,CAAC,iBAAiB,CAAC;IAChC,CAAC;IAED;;;;OAIG;IACH,SAAS;QACP,OAAO,IAAI,CAAC,MAAM,CAAC;IACrB,CAAC;IAED;;OAEG;IACH,KAAK;QACH,IAAI,IAAI,CAAC,KAAK,EAAE;YACd,IAAI,CAAC,MAAM,CAAC,IAAI,EAAE,CAAC,KAAK,CAAC,CAAC,GAAG,EAAE,EAAE;;gBAC/B,yDAAyD;gBACzD,MAAA,IAAI,CAAC,MAAM,0CAAE,KAAK,CAAC,+BAA+B,EAAE,GAAG,CAAC,CAAC;YAC3D,CAAC,CAAC,CAAC;SACJ;IACH,CAAC;IAED;;;;OAIG;IACH,WAAW,CAAC,GAAW;QACrB,OAAO,GAAG,IAAI,CAAC,WAAW,IAAI,GAAG,EAAE,CAAC;IACtC,CAAC;CACF;AAnHD,mCAmHC"}

package/dist/src/RedisCore.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=RedisCore.d.ts.map

package/dist/src/RedisCore.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"RedisCore.d.ts","sourceRoot":"","sources":["../../src/RedisCore.ts"],"names":[],"mappings":""}

package/dist/src/RedisCore.js

@@ -0,0 +1,177 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+/**
+ * Internal implementation of the Redis data store.
+ *
+ * Feature flags, segments, and any other kind of entity the LaunchDarkly client may wish
+ * to store, are stored as hash values with the main key "{prefix}:features", "{prefix}:segments",
+ * etc.
+ *
+ * Redis only allows a single string value per hash key, so there is no way to store the
+ * item metadata (version number and deletion status) separately from the value. The SDK understands
+ * that some data store implementations don't have that capability, so it will always pass us a
+ * serialized item string that contains the metadata in it, and we're allowed to return 0 as the
+ * version number of a queried item to indicate "you have to deserialize the item to find out the
+ * metadata".
+ *
+ * When doing an upsert operation we will always deserialize the item to get the version so the
+ * version in the updated descriptor will be correct.
+ *
+ * The special key "{prefix}:$inited" indicates that the store contains a complete data set.
+ *
+ * @internal
+ */
+class RedisCore {
+    constructor(state, logger) {
+        this.state = state;
+        this.logger = logger;
+        this.initedKey = this.state.prefixedKey('$inited');
+    }
+    init(allData, callback) {
+        const multi = this.state.getClient().multi();
+        allData.forEach((keyedItems) => {
+            const kind = keyedItems.key;
+            const items = keyedItems.item;
+            const namespaceKey = this.state.prefixedKey(kind.namespace);
+            // Delete the namespace for the kind.
+            multi.del(namespaceKey);
+            const namespaceContent = {};
+            items.forEach((keyedItem) => {
+                // For each item which exists.
+                if (keyedItem.item.serializedItem !== undefined) {
+                    namespaceContent[keyedItem.key] = keyedItem.item.serializedItem;
+                }
+            });
+            // Only set if there is content to set.
+            if (Object.keys(namespaceContent).length > 0) {
+                multi.hmset(namespaceKey, namespaceContent);
+            }
+        });
+        multi.set(this.initedKey, '');
+        multi.exec((err) => {
+            var _a;
+            if (err) {
+                (_a = this.logger) === null || _a === void 0 ? void 0 : _a.error(`Error initializing Redis store ${err}`);
+            }
+            callback();
+        });
+    }
+    get(kind, key, callback) {
+        var _a;
+        if (!this.state.isConnected() && !this.state.isInitialConnection()) {
+            (_a = this.logger) === null || _a === void 0 ? void 0 : _a.warn(`Attempted to fetch key '${key}' while Redis connection is down`);
+            callback(undefined);
+            return;
+        }
+        this.state.getClient().hget(this.state.prefixedKey(kind.namespace), key, (err, val) => {
+            var _a;
+            if (err) {
+                (_a = this.logger) === null || _a === void 0 ? void 0 : _a.error(`Error fetching key '${key}' from Redis in '${kind.namespace}' ${err}`);
+                callback(undefined);
+            }
+            else if (val) {
+                // When getting we do not populate version and deleted.
+                // The SDK will have to deserialize to access these values.
+                callback({
+                    version: 0,
+                    deleted: false,
+                    serializedItem: val,
+                });
+            }
+            else {
+                callback(undefined);
+            }
+        });
+    }
+    getAll(kind, callback) {
+        var _a;
+        if (!this.state.isConnected() && !this.state.isInitialConnection()) {
+            (_a = this.logger) === null || _a === void 0 ? void 0 : _a.warn('Attempted to fetch all keys while Redis connection is down');
+            callback(undefined);
+            return;
+        }
+        this.state.getClient().hgetall(this.state.prefixedKey(kind.namespace), (err, values) => {
+            var _a;
+            if (err) {
+                (_a = this.logger) === null || _a === void 0 ? void 0 : _a.error(`Error fetching '${kind.namespace}' from Redis ${err}`);
+            }
+            else if (values) {
+                const results = [];
+                Object.keys(values).forEach((key) => {
+                    const value = values[key];
+                    // When getting we do not populate version and deleted.
+                    // The SDK will have to deserialize to access these values.
+                    results.push({ key, item: { version: 0, deleted: false, serializedItem: value } });
+                });
+                callback(results);
+            }
+            else {
+                callback(undefined);
+            }
+        });
+    }
+    upsert(kind, key, descriptor, callback) {
+        // The persistent store wrapper manages interactions with a queue, so we can use watch like
+        // this without concerns for overlapping transactions.
+        this.state.getClient().watch(this.state.prefixedKey(kind.namespace));
+        const multi = this.state.getClient().multi();
+        this.get(kind, key, (old) => {
+            var _a;
+            if (old === null || old === void 0 ? void 0 : old.serializedItem) {
+                // Here, unfortunately, we have to deserialize the old item just to find
+                // out its version number. See notes on this class.
+                // Do not look at the meta-data, as we do not read/write it independently
+                // with a redis store.
+                const deserializedOld = kind.deserialize(old.serializedItem);
+                if (((deserializedOld === null || deserializedOld === void 0 ? void 0 : deserializedOld.version) || 0) >= descriptor.version) {
+                    multi.discard();
+                    callback(undefined, {
+                        version: deserializedOld.version,
+                        deleted: !(deserializedOld === null || deserializedOld === void 0 ? void 0 : deserializedOld.item),
+                        serializedItem: old.serializedItem,
+                    });
+                    return;
+                }
+            }
+            if (descriptor.deleted) {
+                multi.hset(this.state.prefixedKey(kind.namespace), key, JSON.stringify({ version: descriptor.version, deleted: true }));
+            }
+            else if (descriptor.serializedItem) {
+                multi.hset(this.state.prefixedKey(kind.namespace), key, descriptor.serializedItem);
+            }
+            else {
+                // This call violates the contract.
+                multi.discard();
+                (_a = this.logger) === null || _a === void 0 ? void 0 : _a.error('Attempt to write a non-deleted item without data to Redis.');
+                callback(undefined, undefined);
+                return;
+            }
+            multi.exec((err, replies) => {
+                var _a;
+                if (!err && (replies === null || replies === undefined)) {
+                    // This means the EXEC failed because someone modified the watched key
+                    (_a = this.logger) === null || _a === void 0 ? void 0 : _a.debug('Concurrent modification detected, retrying');
+                    this.upsert(kind, key, descriptor, callback);
+                }
+                else {
+                    callback(err || undefined, descriptor);
+                }
+            });
+        });
+    }
+    initialized(callback) {
+        this.state.getClient().exists(this.initedKey, (err, count) => {
+            // Initialized if there is not an error and the key does exists.
+            // (A count >= 1)
+            callback(!!(!err && count));
+        });
+    }
+    close() {
+        this.state.close();
+    }
+    getDescription() {
+        return 'Redis';
+    }
+}
+exports.default = RedisCore;
+//# sourceMappingURL=RedisCore.js.map

package/dist/src/RedisCore.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"RedisCore.js","sourceRoot":"","sources":["../../src/RedisCore.ts"],"names":[],"mappings":";;AAGA;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,MAAqB,SAAS;IAG5B,YAA6B,KAAuB,EAAmB,MAAiB;QAA3D,UAAK,GAAL,KAAK,CAAkB;QAAmB,WAAM,GAAN,MAAM,CAAW;QACtF,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,SAAS,CAAC,CAAC;IACrD,CAAC;IAED,IAAI,CACF,OAAsE,EACtE,QAAoB;QAEpB,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,SAAS,EAAE,CAAC,KAAK,EAAE,CAAC;QAC7C,OAAO,CAAC,OAAO,CAAC,CAAC,UAAU,EAAE,EAAE;YAC7B,MAAM,IAAI,GAAG,UAAU,CAAC,GAAG,CAAC;YAC5B,MAAM,KAAK,GAAG,UAAU,CAAC,IAAI,CAAC;YAE9B,MAAM,YAAY,GAAG,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;YAE5D,qCAAqC;YACrC,KAAK,CAAC,GAAG,CAAC,YAAY,CAAC,CAAC;YAExB,MAAM,gBAAgB,GAA8B,EAAE,CAAC;YACvD,KAAK,CAAC,OAAO,CAAC,CAAC,SAAS,EAAE,EAAE;gBAC1B,8BAA8B;gBAC9B,IAAI,SAAS,CAAC,IAAI,CAAC,cAAc,KAAK,SAAS,EAAE;oBAC/C,gBAAgB,CAAC,SAAS,CAAC,GAAG,CAAC,GAAG,SAAS,CAAC,IAAI,CAAC,cAAc,CAAC;iBACjE;YACH,CAAC,CAAC,CAAC;YACH,uCAAuC;YACvC,IAAI,MAAM,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC,MAAM,GAAG,CAAC,EAAE;gBAC5C,KAAK,CAAC,KAAK,CAAC,YAAY,EAAE,gBAAgB,CAAC,CAAC;aAC7C;QACH,CAAC,CAAC,CAAC;QAEH,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,SAAS,EAAE,EAAE,CAAC,CAAC;QAE9B,KAAK,CAAC,IAAI,CAAC,CAAC,GAAG,EAAE,EAAE;;YACjB,IAAI,GAAG,EAAE;gBACP,MAAA,IAAI,CAAC,MAAM,0CAAE,KAAK,CAAC,kCAAkC,GAAG,EAAE,CAAC,CAAC;aAC7D;YACD,QAAQ,EAAE,CAAC;QACb,CAAC,CAAC,CAAC;IACL,CAAC;IAED,GAAG,CACD,IAAwC,EACxC,GAAW,EACX,QAA+E;;QAE/E,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,WAAW,EAAE,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,mBAAmB,EAAE,EAAE;YAClE,MAAA,IAAI,CAAC,MAAM,0CAAE,IAAI,CAAC,2BAA2B,GAAG,kCAAkC,CAAC,CAAC;YACpF,QAAQ,CAAC,SAAS,CAAC,CAAC;YACpB,OAAO;SACR;QAED,IAAI,CAAC,KAAK,CAAC,SAAS,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,GAAG,EAAE,CAAC,GAAG,EAAE,GAAG,EAAE,EAAE;;YACpF,IAAI,GAAG,EAAE;gBACP,MAAA,IAAI,CAAC,MAAM,0CAAE,KAAK,CAAC,uBAAuB,GAAG,oBAAoB,IAAI,CAAC,SAAS,KAAK,GAAG,EAAE,CAAC,CAAC;gBAC3F,QAAQ,CAAC,SAAS,CAAC,CAAC;aACrB;iBAAM,IAAI,GAAG,EAAE;gBACd,uDAAuD;gBACvD,2DAA2D;gBAC3D,QAAQ,CAAC;oBACP,OAAO,EAAE,CAAC;oBACV,OAAO,EAAE,KAAK;oBACd,cAAc,EAAE,GAAG;iBACpB,CAAC,CAAC;aACJ;iBAAM;gBACL,QAAQ,CAAC,SAAS,CAAC,CAAC;aACrB;QACH,CAAC,CAAC,CAAC;IACL,CAAC;IAED,MAAM,CACJ,IAAwC,EACxC,QAES;;QAET,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,WAAW,EAAE,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,mBAAmB,EAAE,EAAE;YAClE,MAAA,IAAI,CAAC,MAAM,0CAAE,IAAI,CAAC,4DAA4D,CAAC,CAAC;YAChF,QAAQ,CAAC,SAAS,CAAC,CAAC;YACpB,OAAO;SACR;QAED,IAAI,CAAC,KAAK,CAAC,SAAS,EAAE,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,CAAC,GAAG,EAAE,MAAM,EAAE,EAAE;;YACrF,IAAI,GAAG,EAAE;gBACP,MAAA,IAAI,CAAC,MAAM,0CAAE,KAAK,CAAC,mBAAmB,IAAI,CAAC,SAAS,gBAAgB,GAAG,EAAE,CAAC,CAAC;aAC5E;iBAAM,IAAI,MAAM,EAAE;gBACjB,MAAM,OAAO,GAAwE,EAAE,CAAC;gBACxF,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,CAAC,GAAG,EAAE,EAAE;oBAClC,MAAM,KAAK,GAAG,MAAM,CAAC,GAAG,CAAC,CAAC;oBAC1B,uDAAuD;oBACvD,2DAA2D;oBAC3D,OAAO,CAAC,IAAI,CAAC,EAAE,GAAG,EAAE,IAAI,EAAE,EAAE,OAAO,EAAE,CAAC,EAAE,OAAO,EAAE,KAAK,EAAE,cAAc,EAAE,KAAK,EAAE,EAAE,CAAC,CAAC;gBACrF,CAAC,CAAC,CAAC;gBACH,QAAQ,CAAC,OAAO,CAAC,CAAC;aACnB;iBAAM;gBACL,QAAQ,CAAC,SAAS,CAAC,CAAC;aACrB;QACH,CAAC,CAAC,CAAC;IACL,CAAC;IAED,MAAM,CACJ,IAAwC,EACxC,GAAW,EACX,UAA+C,EAC/C,QAGS;QAET,2FAA2F;QAC3F,sDAAsD;QACtD,IAAI,CAAC,KAAK,CAAC,SAAS,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC;QACrE,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,SAAS,EAAE,CAAC,KAAK,EAAE,CAAC;QAE7C,IAAI,CAAC,GAAG,CAAC,IAAI,EAAE,GAAG,EAAE,CAAC,GAAG,EAAE,EAAE;;YAC1B,IAAI,GAAG,aAAH,GAAG,uBAAH,GAAG,CAAE,cAAc,EAAE;gBACvB,wEAAwE;gBACxE,mDAAmD;gBACnD,yEAAyE;gBACzE,sBAAsB;gBACtB,MAAM,eAAe,GAAG,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,cAAc,CAAC,CAAC;gBAC7D,IAAI,CAAC,CAAA,eAAe,aAAf,eAAe,uBAAf,eAAe,CAAE,OAAO,KAAI,CAAC,CAAC,IAAI,UAAU,CAAC,OAAO,EAAE;oBACzD,KAAK,CAAC,OAAO,EAAE,CAAC;oBAEhB,QAAQ,CAAC,SAAS,EAAE;wBAClB,OAAO,EAAE,eAAgB,CAAC,OAAO;wBACjC,OAAO,EAAE,CAAC,CAAA,eAAe,aAAf,eAAe,uBAAf,eAAe,CAAE,IAAI,CAAA;wBAC/B,cAAc,EAAE,GAAG,CAAC,cAAc;qBACnC,CAAC,CAAC;oBACH,OAAO;iBACR;aACF;YACD,IAAI,UAAU,CAAC,OAAO,EAAE;gBACtB,KAAK,CAAC,IAAI,CACR,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,IAAI,CAAC,SAAS,CAAC,EACtC,GAAG,EACH,IAAI,CAAC,SAAS,CAAC,EAAE,OAAO,EAAE,UAAU,CAAC,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC,CAC/D,CAAC;aACH;iBAAM,IAAI,UAAU,CAAC,cAAc,EAAE;gBACpC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,GAAG,EAAE,UAAU,CAAC,cAAc,CAAC,CAAC;aACpF;iBAAM;gBACL,mCAAmC;gBACnC,KAAK,CAAC,OAAO,EAAE,CAAC;gBAChB,MAAA,IAAI,CAAC,MAAM,0CAAE,KAAK,CAAC,4DAA4D,CAAC,CAAC;gBACjF,QAAQ,CAAC,SAAS,EAAE,SAAS,CAAC,CAAC;gBAC/B,OAAO;aACR;YACD,KAAK,CAAC,IAAI,CAAC,CAAC,GAAG,EAAE,OAAO,EAAE,EAAE;;gBAC1B,IAAI,CAAC,GAAG,IAAI,CAAC,OAAO,KAAK,IAAI,IAAI,OAAO,KAAK,SAAS,CAAC,EAAE;oBACvD,sEAAsE;oBACtE,MAAA,IAAI,CAAC,MAAM,0CAAE,KAAK,CAAC,4CAA4C,CAAC,CAAC;oBACjE,IAAI,CAAC,MAAM,CAAC,IAAI,EAAE,GAAG,EAAE,UAAU,EAAE,QAAQ,CAAC,CAAC;iBAC9C;qBAAM;oBACL,QAAQ,CAAC,GAAG,IAAI,SAAS,EAAE,UAAU,CAAC,CAAC;iBACxC;YACH,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;IACL,CAAC;IAED,WAAW,CAAC,QAA0C;QACpD,IAAI,CAAC,KAAK,CAAC,SAAS,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,SAAS,EAAE,CAAC,GAAG,EAAE,KAAK,EAAE,EAAE;YAC3D,gEAAgE;YAChE,iBAAiB;YACjB,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,IAAI,KAAK,CAAC,CAAC,CAAC;QAC9B,CAAC,CAAC,CAAC;IACL,CAAC;IAED,KAAK;QACH,IAAI,CAAC,KAAK,CAAC,KAAK,EAAE,CAAC;IACrB,CAAC;IAED,cAAc;QACZ,OAAO,OAAO,CAAC;IACjB,CAAC;CACF;AAjLD,4BAiLC"}

package/dist/src/RedisFeatureStore.d.ts

@@ -0,0 +1,19 @@
+import { interfaces, LDFeatureStore, LDFeatureStoreDataStorage, LDFeatureStoreItem, LDFeatureStoreKindData, LDKeyedFeatureStoreItem, LDLogger } from '@launchdarkly/node-server-sdk';
+import LDRedisOptions from './LDRedisOptions';
+/**
+ * Integration between the LaunchDarkly SDK and Redis.
+ */
+export default class RedisFeatureStore implements LDFeatureStore {
+    private readonly logger?;
+    private wrapper;
+    constructor(options?: LDRedisOptions, logger?: LDLogger | undefined);
+    get(kind: interfaces.DataKind, key: string, callback: (res: LDFeatureStoreItem | null) => void): void;
+    all(kind: interfaces.DataKind, callback: (res: LDFeatureStoreKindData) => void): void;
+    init(allData: LDFeatureStoreDataStorage, callback: () => void): void;
+    delete(kind: interfaces.DataKind, key: string, version: number, callback: () => void): void;
+    upsert(kind: interfaces.DataKind, data: LDKeyedFeatureStoreItem, callback: () => void): void;
+    initialized(callback: (isInitialized: boolean) => void): void;
+    close(): void;
+    getDescription?(): string;
+}
+//# sourceMappingURL=RedisFeatureStore.d.ts.map

package/dist/src/RedisFeatureStore.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"RedisFeatureStore.d.ts","sourceRoot":"","sources":["../../src/RedisFeatureStore.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,UAAU,EACV,cAAc,EACd,yBAAyB,EACzB,kBAAkB,EAClB,sBAAsB,EACtB,uBAAuB,EACvB,QAAQ,EAET,MAAM,+BAA+B,CAAC;AACvC,OAAO,cAAc,MAAM,kBAAkB,CAAC;AAK9C;;GAEG;AACH,MAAM,CAAC,OAAO,OAAO,iBAAkB,YAAW,cAAc;IAGxB,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAC;IAF9D,OAAO,CAAC,OAAO,CAA6B;gBAEhC,OAAO,CAAC,EAAE,cAAc,EAAmB,MAAM,CAAC,sBAAU;IAOxE,GAAG,CACD,IAAI,EAAE,UAAU,CAAC,QAAQ,EACzB,GAAG,EAAE,MAAM,EACX,QAAQ,EAAE,CAAC,GAAG,EAAE,kBAAkB,GAAG,IAAI,KAAK,IAAI,GACjD,IAAI;IAIP,GAAG,CAAC,IAAI,EAAE,UAAU,CAAC,QAAQ,EAAE,QAAQ,EAAE,CAAC,GAAG,EAAE,sBAAsB,KAAK,IAAI,GAAG,IAAI;IAIrF,IAAI,CAAC,OAAO,EAAE,yBAAyB,EAAE,QAAQ,EAAE,MAAM,IAAI,GAAG,IAAI;IAIpE,MAAM,CAAC,IAAI,EAAE,UAAU,CAAC,QAAQ,EAAE,GAAG,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,IAAI,GAAG,IAAI;IAI3F,MAAM,CAAC,IAAI,EAAE,UAAU,CAAC,QAAQ,EAAE,IAAI,EAAE,uBAAuB,EAAE,QAAQ,EAAE,MAAM,IAAI,GAAG,IAAI;IAI5F,WAAW,CAAC,QAAQ,EAAE,CAAC,aAAa,EAAE,OAAO,KAAK,IAAI,GAAG,IAAI;IAI7D,KAAK,IAAI,IAAI;IAIb,cAAc,CAAC,IAAI,MAAM;CAG1B"}

package/dist/src/RedisFeatureStore.js

@@ -0,0 +1,41 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const node_server_sdk_1 = require("@launchdarkly/node-server-sdk");
+const RedisCore_1 = require("./RedisCore");
+const RedisClientState_1 = require("./RedisClientState");
+const TtlFromOptions_1 = require("./TtlFromOptions");
+/**
+ * Integration between the LaunchDarkly SDK and Redis.
+ */
+class RedisFeatureStore {
+    constructor(options, logger) {
+        this.logger = logger;
+        this.wrapper = new node_server_sdk_1.PersistentDataStoreWrapper(new RedisCore_1.default(new RedisClientState_1.default(options, logger), logger), (0, TtlFromOptions_1.default)(options));
+    }
+    get(kind, key, callback) {
+        this.wrapper.get(kind, key, callback);
+    }
+    all(kind, callback) {
+        this.wrapper.all(kind, callback);
+    }
+    init(allData, callback) {
+        this.wrapper.init(allData, callback);
+    }
+    delete(kind, key, version, callback) {
+        this.wrapper.delete(kind, key, version, callback);
+    }
+    upsert(kind, data, callback) {
+        this.wrapper.upsert(kind, data, callback);
+    }
+    initialized(callback) {
+        this.wrapper.initialized(callback);
+    }
+    close() {
+        this.wrapper.close();
+    }
+    getDescription() {
+        return this.wrapper.getDescription();
+    }
+}
+exports.default = RedisFeatureStore;
+//# sourceMappingURL=RedisFeatureStore.js.map

package/dist/src/RedisFeatureStore.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"RedisFeatureStore.js","sourceRoot":"","sources":["../../src/RedisFeatureStore.ts"],"names":[],"mappings":";;AAAA,mEASuC;AAEvC,2CAAoC;AACpC,yDAAkD;AAClD,qDAA8C;AAE9C;;GAEG;AACH,MAAqB,iBAAiB;IAGpC,YAAY,OAAwB,EAAmB,MAAiB;QAAjB,WAAM,GAAN,MAAM,CAAW;QACtE,IAAI,CAAC,OAAO,GAAG,IAAI,4CAA0B,CAC3C,IAAI,mBAAS,CAAC,IAAI,0BAAgB,CAAC,OAAO,EAAE,MAAM,CAAC,EAAE,MAAM,CAAC,EAC5D,IAAA,wBAAc,EAAC,OAAO,CAAC,CACxB,CAAC;IACJ,CAAC;IAED,GAAG,CACD,IAAyB,EACzB,GAAW,EACX,QAAkD;QAElD,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,EAAE,GAAG,EAAE,QAAQ,CAAC,CAAC;IACxC,CAAC;IAED,GAAG,CAAC,IAAyB,EAAE,QAA+C;QAC5E,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;IACnC,CAAC;IAED,IAAI,CAAC,OAAkC,EAAE,QAAoB;QAC3D,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC;IACvC,CAAC;IAED,MAAM,CAAC,IAAyB,EAAE,GAAW,EAAE,OAAe,EAAE,QAAoB;QAClF,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,EAAE,GAAG,EAAE,OAAO,EAAE,QAAQ,CAAC,CAAC;IACpD,CAAC;IAED,MAAM,CAAC,IAAyB,EAAE,IAA6B,EAAE,QAAoB;QACnF,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,EAAE,IAAI,EAAE,QAAQ,CAAC,CAAC;IAC5C,CAAC;IAED,WAAW,CAAC,QAA0C;QACpD,IAAI,CAAC,OAAO,CAAC,WAAW,CAAC,QAAQ,CAAC,CAAC;IACrC,CAAC;IAED,KAAK;QACH,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,CAAC;IACvB,CAAC;IAED,cAAc;QACZ,OAAO,IAAI,CAAC,OAAO,CAAC,cAAc,EAAE,CAAC;IACvC,CAAC;CACF;AA7CD,oCA6CC"}

package/dist/src/RedisFeatureStoreFactory.d.ts

@@ -0,0 +1,25 @@
+import { LDClientContext } from '@launchdarkly/node-server-sdk';
+import RedisFeatureStore from './RedisFeatureStore';
+import LDRedisOptions from './LDRedisOptions';
+/**
+ * Configures a feature store backed by a Redis instance.
+ *
+ * For more details about how and why you can use a persistent feature store, see
+ * the [Using Redis as a persistent feature store](https://docs.launchdarkly.com/sdk/features/storing-data/redis#nodejs-server-side).
+ *
+ * ```
+ * const redisStoreFactory = RedisFeatureStoreFactory(
+ *   {
+ *     redisOpts: { host: 'redishost', port: 6379 },
+ *     prefix: 'app1',
+ *     cacheTTL: 30
+ *   });
+ * ```
+ *
+ * @param options Optional configuration, please refer to {@link LDRedisOptions}.
+ *
+ * @returns
+ *   A factory function suitable for use in the SDK configuration (LDOptions).
+ */
+export default function RedisFeatureStoreFactory(options?: LDRedisOptions): (config: LDClientContext) => RedisFeatureStore;
+//# sourceMappingURL=RedisFeatureStoreFactory.d.ts.map

package/dist/src/RedisFeatureStoreFactory.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"RedisFeatureStoreFactory.d.ts","sourceRoot":"","sources":["../../src/RedisFeatureStoreFactory.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,+BAA+B,CAAC;AAChE,OAAO,iBAAiB,MAAM,qBAAqB,CAAC;AACpD,OAAO,cAAc,MAAM,kBAAkB,CAAC;AAE9C;;;;;;;;;;;;;;;;;;;GAmBG;AACH,MAAM,CAAC,OAAO,UAAU,wBAAwB,CAAC,OAAO,CAAC,EAAE,cAAc,YACvD,eAAe,uBAEhC"}

package/dist/src/RedisFeatureStoreFactory.js

@@ -0,0 +1,28 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const RedisFeatureStore_1 = require("./RedisFeatureStore");
+/**
+ * Configures a feature store backed by a Redis instance.
+ *
+ * For more details about how and why you can use a persistent feature store, see
+ * the [Using Redis as a persistent feature store](https://docs.launchdarkly.com/sdk/features/storing-data/redis#nodejs-server-side).
+ *
+ * ```
+ * const redisStoreFactory = RedisFeatureStoreFactory(
+ *   {
+ *     redisOpts: { host: 'redishost', port: 6379 },
+ *     prefix: 'app1',
+ *     cacheTTL: 30
+ *   });
+ * ```
+ *
+ * @param options Optional configuration, please refer to {@link LDRedisOptions}.
+ *
+ * @returns
+ *   A factory function suitable for use in the SDK configuration (LDOptions).
+ */
+function RedisFeatureStoreFactory(options) {
+    return (config) => new RedisFeatureStore_1.default(options, config.basicConfiguration.logger);
+}
+exports.default = RedisFeatureStoreFactory;
+//# sourceMappingURL=RedisFeatureStoreFactory.js.map

package/dist/src/RedisFeatureStoreFactory.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"RedisFeatureStoreFactory.js","sourceRoot":"","sources":["../../src/RedisFeatureStoreFactory.ts"],"names":[],"mappings":";;AACA,2DAAoD;AAGpD;;;;;;;;;;;;;;;;;;;GAmBG;AACH,SAAwB,wBAAwB,CAAC,OAAwB;IACvE,OAAO,CAAC,MAAuB,EAAE,EAAE,CACjC,IAAI,2BAAiB,CAAC,OAAO,EAAE,MAAM,CAAC,kBAAkB,CAAC,MAAM,CAAC,CAAC;AACrE,CAAC;AAHD,2CAGC"}

package/dist/src/TtlFromOptions.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=TtlFromOptions.d.ts.map

package/dist/src/TtlFromOptions.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"TtlFromOptions.d.ts","sourceRoot":"","sources":["../../src/TtlFromOptions.ts"],"names":[],"mappings":""}

package/dist/src/TtlFromOptions.js

@@ -0,0 +1,22 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+/**
+ * The default TTL cache time in seconds.
+ */
+const DEFAULT_CACHE_TTL_S = 30;
+/**
+ * Get a cache TTL based on LDRedisOptions. If the TTL is not specified, then
+ * the default of 30 seconds will be used.
+ * @param options The options to get a TTL for.
+ * @returns The TTL, in seconds.
+ * @internal
+ */
+function TtlFromOptions(options) {
+    // 0 is a valid option. So we need a null/undefined check.
+    if ((options === null || options === void 0 ? void 0 : options.cacheTTL) === undefined || options.cacheTTL === null) {
+        return DEFAULT_CACHE_TTL_S;
+    }
+    return options.cacheTTL;
+}
+exports.default = TtlFromOptions;
+//# sourceMappingURL=TtlFromOptions.js.map

package/dist/src/TtlFromOptions.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"TtlFromOptions.js","sourceRoot":"","sources":["../../src/TtlFromOptions.ts"],"names":[],"mappings":";;AAEA;;GAEG;AACH,MAAM,mBAAmB,GAAG,EAAE,CAAC;AAE/B;;;;;;GAMG;AACH,SAAwB,cAAc,CAAC,OAAwB;IAC7D,0DAA0D;IAC1D,IAAI,CAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,QAAQ,MAAK,SAAS,IAAI,OAAO,CAAC,QAAQ,KAAK,IAAI,EAAE;QAChE,OAAO,mBAAmB,CAAC;KAC5B;IACD,OAAO,OAAQ,CAAC,QAAQ,CAAC;AAC3B,CAAC;AAND,iCAMC"}

package/dist/src/index.d.ts

@@ -0,0 +1,4 @@
+export { default as RedisFeatureStore } from './RedisFeatureStoreFactory';
+export { default as RedisBigSegmentStore } from './RedisBigSegmentStoreFactory';
+export { default as LDRedisOptions } from './LDRedisOptions';
+//# sourceMappingURL=index.d.ts.map

package/dist/src/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,OAAO,IAAI,iBAAiB,EAAE,MAAM,4BAA4B,CAAC;AAC1E,OAAO,EAAE,OAAO,IAAI,oBAAoB,EAAE,MAAM,+BAA+B,CAAC;AAEhF,OAAO,EAAE,OAAO,IAAI,cAAc,EAAE,MAAM,kBAAkB,CAAC"}

package/dist/src/index.js

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RedisBigSegmentStore = exports.RedisFeatureStore = void 0;
+// Exporting the factories without the 'Factory'. This keeps them in-line with
+// previous store versions. The differentiation between the factory and the store
+// is not critical for consuming the SDK.
+var RedisFeatureStoreFactory_1 = require("./RedisFeatureStoreFactory");
+Object.defineProperty(exports, "RedisFeatureStore", { enumerable: true, get: function () { return RedisFeatureStoreFactory_1.default; } });
+var RedisBigSegmentStoreFactory_1 = require("./RedisBigSegmentStoreFactory");
+Object.defineProperty(exports, "RedisBigSegmentStore", { enumerable: true, get: function () { return RedisBigSegmentStoreFactory_1.default; } });
+//# sourceMappingURL=index.js.map

package/dist/src/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":";;;AAAA,8EAA8E;AAC9E,iFAAiF;AACjF,yCAAyC;AACzC,uEAA0E;AAAjE,6HAAA,OAAO,OAAqB;AACrC,6EAAgF;AAAvE,mIAAA,OAAO,OAAwB"}

package/package.json

@@ -0,0 +1,54 @@
+{
+  "name": "@launchdarkly/node-server-sdk-redis",
+  "version": "0.1.0",
+  "description": "Redis-backed feature store for the LaunchDarkly Server-Side SDK for Node.js",
+  "homepage": "https://github.com/launchdarkly/js-core/tree/main/packages/store/node-server-sdk-redis",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/launchdarkly/js-core.git"
+  },
+  "type": "commonjs",
+  "main": "./dist/src/index.js",
+  "types": "./dist/src/index.d.ts",
+  "files": [
+    "dist"
+  ],
+  "keywords": [
+    "launchdarkly",
+    "analytics",
+    "client"
+  ],
+  "license": "Apache-2.0",
+  "scripts": {
+    "clean": "npx tsc --build --clean",
+    "test": "npx jest --ci --runInBand",
+    "build": "npx tsc",
+    "lint": "npx eslint . --ext .ts",
+    "lint:fix": "yarn run lint --fix",
+    "doc": "../../../scripts/build-doc.sh ."
+  },
+  "dependencies": {
+    "ioredis": "^5.3.2"
+  },
+  "peerDependencies": {
+    "@launchdarkly/node-server-sdk": "0.4.4"
+  },
+  "devDependencies": {
+    "@launchdarkly/node-server-sdk": "0.5.0",
+    "@types/jest": "^29.4.0",
+    "@typescript-eslint/eslint-plugin": "^5.22.0",
+    "@typescript-eslint/parser": "^5.22.0",
+    "eslint": "^8.14.0",
+    "eslint-config-airbnb-base": "^15.0.0",
+    "eslint-config-airbnb-typescript": "^17.0.0",
+    "eslint-config-prettier": "^8.7.0",
+    "eslint-plugin-import": "^2.26.0",
+    "eslint-plugin-prettier": "^4.2.1",
+    "jest": "^29.5.0",
+    "launchdarkly-js-test-helpers": "^2.2.0",
+    "prettier": "^2.8.4",
+    "ts-jest": "^29.0.5",
+    "typedoc": "0.23.26",
+    "typescript": "^4.6.3"
+  }
+}