Merge pull request #17 from drone/async_repository

[MAINT] Async repository

Author: enver-bisevac

.prettierrc

@@ -3,7 +3,7 @@
   "trailingComma": "all",
   "overrides": [
     {
-      "files": "*.ts",
+      "files": ["*.ts", "*.js", "*.mjs"],
       "options": {
         "parser": "typescript"
       }

README.md

@@ -55,8 +55,8 @@ const target = {
 ```
 
 ### Evaluate the flag with default value set to false
-```
-const value = client.boolVariation('test', target, false);
+```typescript
+const value = await client.boolVariation('test', target, false);
 ```
 
 ### Shutting down SDK
@@ -65,25 +65,26 @@ client.close();
 ```
 
 ### Avaialable public methods
-```
-const value = client.boolVariation('test', target, false);
-const value = client.stringVariation('test', target, 'BLACK');
-const value = client.numberVariation('test', target, 1);
-const value = client.jsonVariation('test', target, {});
+```typescript
+function boolVariation(identifier: string, target: Target, defaultValue = true): Promise<boolean>;
+function stringVariation(identifier, target: Target, defaultValue = ''): Promise<string>;
+function numberVariation(identifier, target: Target, defaultValue = 1.0): Promise<number>;
+function jsonVariation(identifier, target: Target, defaultValue = {}): Promise<Record<string, unknown>>;
+function close();
 ```
 
 ### Avaialable options
 
 ```
-  baseUrl: string;
-  eventsUrl: string;
-  pollInterval: number;
-  eventsSyncInterval: number;
-  enableStream: boolean;
-  enableAnalytics: boolean;
-  cache: KeyValueStore;
-  store: KeyValueStore;
-  logger: Logger;
+baseUrl: string;             // baseUrl is where the flag configurations are located
+eventsUrl: string;           // eventsUrl is where we send summarized target events
+pollInterval: number;        // pollInterval (default 60s)
+eventsSyncInterval: number;  // Metrics push event (default 60s)
+enableStream: boolean;       // enable server sent events
+enableAnalytics: boolean;    // enable analytics
+cache: KeyValueStore;        // set custom cache (default lru cache)
+store: AsyncKeyValueStore;   // set custom persistent store (default file store)
+logger: Logger;              // set logger (default console)
 ```
 
 ## Singleton example
@@ -101,8 +102,8 @@ const target = {
 };
 const defaultValue = false;
 
-setInterval(() => {
-    const value = CfClient.boolVariation(FLAG_KEY, target, defaultValue);
+setInterval(async() => {
+    const value = await CfClient.boolVariation(FLAG_KEY, target, defaultValue);
     console.log("Evaluation for flag test and target none: ", value);
 }, 10000);
 ```

__tests__/evaluator.test.ts

@@ -20,6 +20,7 @@ const cache = new SimpleCache();
 const repository = new StorageRepository(cache);
 const evaluator = new Evaluator(repository);
 
+const results = [];
 let files = [];
 try {
   files = fs.readdirSync(directory);
@@ -29,8 +30,6 @@ try {
   }
 }
 
-const results = [];
-
 for (const file of files) {
   try {
     const data = fs.readFileSync(path.join(directory, file), 'utf8');
@@ -56,7 +55,7 @@ for (const file of files) {
 describe('evaluation flag', () => {
   test.each(results)(
     `Usecase %p with target %p and expected value %p`,
-    (
+    async (
       _file: string,
       targetIdentifier: string,
       expected: unknown,
@@ -73,24 +72,32 @@ describe('evaluation flag', () => {
       let received: unknown;
       switch (usecase.flag.kind) {
         case FeatureConfigKindEnum.Boolean:
-          received = evaluator.boolVariation(
+          received = await evaluator.boolVariation(
             usecase.flag.feature,
             target,
             false,
           );
           break;
         case FeatureConfigKindEnum.String:
-          received = evaluator.stringVariation(
+          received = await evaluator.stringVariation(
             usecase.flag.feature,
             target,
             '',
           );
           break;
         case FeatureConfigKindEnum.Int:
-          received = evaluator.numberVariation(usecase.flag.feature, target, 0);
+          received = await evaluator.numberVariation(
+            usecase.flag.feature,
+            target,
+            0,
+          );
           break;
         case FeatureConfigKindEnum.Json:
-          received = evaluator.jsonVariation(usecase.flag.feature, target, {});
+          received = await evaluator.jsonVariation(
+            usecase.flag.feature,
+            target,
+            {},
+          );
           break;
       }
       expect(received).toBe(expected);

example/index.js

@@ -4,11 +4,11 @@ const client = new Client('1c100d25-4c3f-487b-b198-3b3d01df5794');
 
 console.log('Starting application');
 
-setInterval(() => {
+setInterval(async () => {
   const target = {
     identifier: 'harness',
   };
-  const value = client.boolVariation('test', target, false);
+  const value = await client.boolVariation('test', target, false);
   console.log('Evaluation for flag test and target: ', value, target);
 }, 10000);
 

example/index.mjs

@@ -2,7 +2,7 @@ import { Client } from 'ff-nodejs-server-sdk';
 
 const client = new Client('1c100d25-4c3f-487b-b198-3b3d01df5794');
 
-setInterval(() => {
-    const value = client.boolVariation('test', null, false);
-    console.log("Evaluation for flag test and target none: ", value);
+setInterval(async() => {
+    const value = await client.boolVariation('test', null, false);
+    console.log('Evaluation for flag test and target none: ', value);
 }, 10000);

example/index_cf.mjs

@@ -2,7 +2,7 @@ import CfClient from 'ff-nodejs-server-sdk';
 
 CfClient.init('1c100d25-4c3f-487b-b198-3b3d01df5794');
 
-setInterval(() => {
-    const value = CfClient.boolVariation('test', null, false);
+setInterval(async() => {
+    const value = await CfClient.boolVariation('test', null, false);
     console.log("Evaluation for flag test and target none: ", value);
 }, 10000);