Tp/testing obfuscated (#67)

* obfuscated clients
* add other client types

Author: typotter

package-testing/testing-api/package.json

@@ -1,6 +1,6 @@
 {
   "name": "eppo-testing-api",
-  "version": "1.0.0",
+  "version": "1.1.0",
   "description": "UFC server for SDK integration testing",
   "main": "src/server.ts",
   "repository": "github.com/Eppo-exp/sdk-test-data",

package-testing/testing-api/src/app.ts

@@ -33,13 +33,19 @@ class App {
     Object.keys(scenarios).forEach((key) => {
       const ufc = fs.readFileSync(path.join(baseDir, scenarios[key].ufcPath), 'utf-8');
 
+      const obfuscatedUfcFilepath = path.join(baseDir, scenarios[key].ufcPath.replace('.json', '-obfuscated.json'));
+
+      const obfuscatedUfc = fs.existsSync(obfuscatedUfcFilepath)
+        ? fs.readFileSync(obfuscatedUfcFilepath, 'utf-8')
+        : '{}';
+
       const banditModelFile = scenarios[key].banditModelPath;
 
       const bandits = banditModelFile ? fs.readFileSync(path.join(baseDir, banditModelFile), 'utf-8') : '';
 
       console.log('preloaded data for ' + key);
 
-      setDataFile(key, ufc, bandits);
+      setDataFile(key, ufc, obfuscatedUfc, bandits);
     });
   }
 }

package-testing/testing-api/src/routes.ts

@@ -1,5 +1,5 @@
 import { Router } from 'express';
-import { getDataForRequest, updateClientDataMap } from './ufc/data';
+import { getDataForRequest, isObfuscatedSdk, updateClientDataMap } from './ufc/data';
 
 const routes = Router();
 
@@ -17,13 +17,22 @@ routes.get('/api/flag-config/v1/config', (req, res) => {
   if (data) {
     // Some SDKs use HTTP headers to optimize network bytes and sdk-side processing.
     const noneMatch = req.header('IF-NONE-MATCH');
-    if (noneMatch === data.eTag) {
+    const eTagToMatch = isObfuscatedSdk(sdk) ? data.obfuscatedETag : data.eTag;
+
+    if (noneMatch === eTagToMatch) {
+      console.log(`Returning not modified`);
       res.setHeader('ETAG', data.eTag);
       return res.status(304).end();
     }
 
     res.setHeader('Content-Type', 'application/json');
     res.setHeader('ETAG', data.eTag);
+
+    // Check if it should be an obfuscated response
+    if (isObfuscatedSdk(sdk)) {
+      console.log(`Returning obfuscated config`);
+      return res.status(200).end(data.obfuscatedUfc);
+    }
     return res.status(200).end(data.ufc);
   }
 

package-testing/testing-api/src/ufc/data.ts

@@ -1,24 +1,32 @@
 import * as crypto from 'crypto';
 
-const dataFiles: Record<string, { ufc: string; eTag: string; bandits: string }> = {};
+const dataFiles: Record<
+  string,
+  { ufc: string; obfuscatedUfc: string; eTag: string; obfuscatedETag: string; bandits: string }
+> = {};
 const clientDataMap: Record<string, string> = {};
 
+const obfuscatedClients = ['android', 'ios', 'javascript', 'react-native'];
+
+export const isObfuscatedSdk = (sdk: string) => obfuscatedClients.includes(sdk);
+
 export const getDataForRequest = (sdkName: string) => {
   // Get the scenario label for this client.
   let label = clientDataMap[sdkName];
 
   // If there was no label, assign the first of the data files (or null).
   label ??= Object.keys(dataFiles)[0] ?? null;
 
-  console.log(`Returning ${label} for ${sdkName}`);
+  console.log(`Returning scenario ${label} for ${sdkName}`);
 
   return dataFiles[label] ?? null;
 };
 
-export const setDataFile = (label: string, ufc: string, bandits: string) => {
-  const ufcVersionString = crypto.createHash('md5').update(ufc).digest('hex');
+export const setDataFile = (label: string, ufc: string, obfuscatedUfc: string, bandits: string) => {
+  const eTag = crypto.createHash('md5').update(ufc).digest('hex');
+  const obfuscatedETag = crypto.createHash('md5').update(obfuscatedUfc).digest('hex');
 
-  dataFiles[label] = { ufc, eTag: ufcVersionString, bandits };
+  dataFiles[label] = { ufc, obfuscatedUfc, eTag, obfuscatedETag, bandits };
 };
 
 export const updateClientDataMap = (sdkName: string, datafileLabel: string): boolean => {