fix import of SDK interfaces, + minor doc fix (#8)

Author: eli-darkly

CONTRIBUTING.md

@@ -32,7 +32,11 @@ To run all unit tests:
 npm test
 ```
 
-The tests expect you to have Redis running locally on the default port, 6379. One way to do this is with Docker: `docker run -d -p 6379:6379 redis`
+The tests expect you to have Redis running locally on the default port, 6379. One way to do this is with Docker:
+
+```
+docker run -p 6379:6379 redis
+```
 
 To verify that the TypeScript declarations compile correctly (this involves compiling the file `test-types.ts`, so if you have changed any types or interfaces, you will want to update that code):
 

index.d.ts

@@ -8,7 +8,7 @@
 
 declare module 'launchdarkly-node-server-sdk-redis' {
   import { LDFeatureStore, LDLogger, LDOptions } from 'launchdarkly-node-server-sdk';
-  import * as ld from 'launchdarkly-node-server-sdk';
+  import { BigSegmentStore } from 'launchdarkly-node-server-sdk/interfaces';
   import { ClientOpts, RedisClient } from 'redis';
 
   /**
@@ -77,7 +77,7 @@ declare module 'launchdarkly-node-server-sdk-redis' {
    */
   export function RedisBigSegmentStore(
     options?: LDRedisOptions
-  ): (config: LDOptions) => ld.interfaces.BigSegmentStore;
+  ): (config: LDOptions) => BigSegmentStore;
 
   /**
    * The standard options supported for the LaunchDarkly Redis integration.

package.json

@@ -22,7 +22,7 @@
     "jest": "^27.0.4",
     "jest-junit": "^12.2.0",
     "launchdarkly-js-test-helpers": "^1.2.1",
-    "launchdarkly-node-server-sdk": "6.2.0-alpha.bigsegments.3",
+    "launchdarkly-node-server-sdk": "6.2.0-alpha.bigsegments.4",
     "prettier": "^2.3.1",
     "typescript": "^4.3.2"
   },

tests/redis_stores-test.js

@@ -7,16 +7,22 @@ const {
 const redis = require('redis');
 const { promisify } = require('util');
 
+const defaultPrefix = 'launchdarkly';
+
 // Runs the standard test suites provided by the SDK's store_tests module.
 
 // This is a single file because if the two test suites were run from separate files, they could
 // be interleaved by Jest. Since our implementation of clearAllData is not very smart and will
 // remove *all* keys with the given prefix, we could step on another test's data if the shared
 // test suites happen to use the same prefix.
 
+function actualPrefix(prefix) {
+  return prefix || defaultPrefix;
+}
+
 function clearAllData(client) {
   return async prefix => {
-    const keys = await promisify(client.keys.bind(client))(prefix + ':*');
+    const keys = await promisify(client.keys.bind(client))(actualPrefix(prefix) + ':*');
     for (const key of keys) {
       await promisify(client.del.bind(client))(key);
     }
@@ -59,16 +65,16 @@ describe('RedisBigSegmentStore', () => {
   }
 
   async function setMetadata(prefix, metadata) {
-    await promisify(client.set.bind(client))(prefix + ':' + keyLastUpToDate,
+    await promisify(client.set.bind(client))(actualPrefix(prefix) + ':' + keyLastUpToDate,
       metadata.lastUpToDate ? metadata.lastUpToDate.toString() : '');
   }
 
   async function setSegments(prefix, userHashKey, includes, excludes) {
     for (const ref of includes) {
-      await promisify(client.sadd.bind(client))(prefix + ':' + keyUserInclude + userHashKey, ref);
+      await promisify(client.sadd.bind(client))(actualPrefix(prefix) + ':' + keyUserInclude + userHashKey, ref);
     }
     for (const ref of excludes) {
-      await promisify(client.sadd.bind(client))(prefix + ':' + keyUserExclude + userHashKey, ref);
+      await promisify(client.sadd.bind(client))(actualPrefix(prefix) + ':' + keyUserExclude + userHashKey, ref);
     }
   }