chore: added credentials to javascript transformations

src/controllers/userTransform.ts

@@ -33,11 +33,12 @@ export class UserTransformController {
       '(User transform - router:/transformation/test ):: Request to transformer',
       ctx.request.body,
     );
-    const { events, trRevCode, libraryVersionIDs = [] } = ctx.request.body as any;
+    const { events, trRevCode, libraryVersionIDs = [], credentials } = ctx.request.body as any;
     const response = await UserTransformService.testTransformRoutine(
       events,
       trRevCode,
       libraryVersionIDs,
+      credentials,
     );
     ctx.body = response.body;
     ControllerUtility.postProcess(ctx, response.status);

src/services/userTransform.ts

@@ -192,7 +192,7 @@ export class UserTransformService {
     } as UserTransformationServiceResponse;
   }
 
-  public static async testTransformRoutine(events, trRevCode, libraryVersionIDs) {
+  public static async testTransformRoutine(events, trRevCode, libraryVersionIDs, credentials) {
     const response: FixMe = {};
     try {
       if (!trRevCode || !trRevCode.code || !trRevCode.codeVersion) {
@@ -210,6 +210,7 @@ export class UserTransformService {
         trRevCode.versionId,
         libraryVersionIDs,
         trRevCode,
+        credentials,
         true,
       );
       logger.debug(`[CT] Test Output Events: ${JSON.stringify(response.body.transformedEvents)}`);

src/types/index.ts

@@ -137,12 +137,19 @@ type UserTransformationLibrary = {
   VersionID: string;
 };
 
+type Credential = {
+  Key: string;
+  Value: string;
+  isPublic: boolean;
+};
+
 type ProcessorTransformationRequest = {
   request?: object;
   message: object;
   metadata: Metadata;
   destination: Destination;
   libraries?: UserTransformationLibrary[];
+  credentials?: Credential[];
 };
 
 type RouterTransformationRequestData = {

src/util/customTransformer-v1.js

@@ -51,6 +51,7 @@ function calculateMsFromIvmTime(value) {
 async function userTransformHandlerV1(
   events,
   userTransformation,
+  credentials,
   libraryVersionIds,
   testMode = false,
 ) {
@@ -62,6 +63,7 @@ async function userTransformHandlerV1(
     userTransformation.code,
     libraryVersionIds,
     userTransformation.versionId,
+    credentials,
     userTransformation.secrets || {},
     testMode,
   );

src/util/customTransformer.js

@@ -273,6 +273,7 @@
   versionId,
   libraryVersionIDs,
   trRevCode = {},
+  credentials = [],
   testMode = false,
 ) {
   if (versionId) {
@@ -285,12 +286,22 @@
       events.forEach((ev) => {
         eventsMetadata[ev.message.messageId] = ev.metadata;
       });
-
+      const credentialsMap = {};
+      if (testMode === false) {
+        events[0]?.credentials?.forEach((cred) => {
+          credentialsMap[cred.key] = cred.value;
+        });
+      } else {
+        credentials?.forEach((cred) => {
+          credentialsMap[cred.key] = cred.value;
+        });
+      }
       let userTransformedEvents = [];
       let result;
       if (res.codeVersion && res.codeVersion === '1') {
         result = await UserTransformHandlerFactory(res).runUserTransfrom(
           events,
+          credentialsMap,
           testMode,
           libraryVersionIDs,
         );

src/util/customTransformerFactory.js

@@ -13,14 +13,20 @@ const UserTransformHandlerFactory = (userTransformation) => {
       }
     },
 
-    runUserTransfrom: async (events, testMode, libraryVersionIds) => {
+    runUserTransfrom: async (events, credentials, testMode, libraryVersionIds) => {
       switch (userTransformation.language) {
         case 'pythonfaas':
         case 'python':
           return runOpenFaasUserTransform(events, userTransformation, libraryVersionIds, testMode);
 
         default:
-          return userTransformHandlerV1(events, userTransformation, libraryVersionIds, testMode);
+          return userTransformHandlerV1(
+            events,
+            userTransformation,
+            credentials,
+            libraryVersionIds,
+            testMode,
+          );
       }
     },
   };

src/util/ivmFactory.js

@@ -30,7 +30,7 @@ async function loadModule(isolateInternal, contextInternal, moduleName, moduleCo
   return module;
 }
 
-async function createIvm(code, libraryVersionIds, versionId, secrets, testMode) {
+async function createIvm(code, libraryVersionIds, versionId, credentials, secrets, testMode) {
   const createIvmStartTime = new Date();
   const logs = [];
   const libraries = await Promise.all(
@@ -243,6 +243,11 @@ async function createIvm(code, libraryVersionIds, versionId, secrets, testMode)
     }),
   );
 
+  await jail.set('_credentials', function (...args) {
+    if (args.length == 0 || !credentials || !credentials[args[0]]) return 'ERROR';
+    return credentials[args[0]];
+  });
+
   await jail.set('_rsSecrets', function (...args) {
     if (args.length == 0 || !secrets || !secrets[args[0]]) return 'ERROR';
     return secrets[args[0]];
@@ -321,6 +326,14 @@ async function createIvm(code, libraryVersionIds, versionId, secrets, testMode)
         ]);
       };
 
+      let credentials = _credentials;
+      delete _credentials;
+      global.credentials = function(...args) {
+        return credentials([
+          ...args.map(arg => new ivm.ExternalCopy(arg).copyInto())
+        ]);
+      };
+
       return new ivm.Reference(function forwardMainPromise(
         fnRef,
         resolve,
@@ -411,10 +424,10 @@ async function compileUserLibrary(code) {
   return evaluateModule(isolate, context, code);
 }
 
-async function getFactory(code, libraryVersionIds, versionId, secrets, testMode) {
+async function getFactory(code, libraryVersionIds, versionId, credentials, secrets, testMode) {
   const factory = {
     create: async () => {
-      return createIvm(code, libraryVersionIds, versionId, secrets, testMode);
+      return createIvm(code, libraryVersionIds, versionId, credentials, secrets, testMode);
     },
     destroy: async (client) => {
       client.fnRef.release();

test/__tests__/data/user_transformation_input_credentials.json

@@ -0,0 +1,65 @@
+[
+  {
+    "message": {
+      "channel": "web",
+      "context": {
+        "app": {
+          "build": "1.0.0",
+          "name": "RudderLabs JavaScript SDK",
+          "namespace": "com.rudderlabs.javascript",
+          "version": "1.0.0"
+        },
+        "traits": {
+          "email": "[email protected]",
+          "anonymousId": "12345"
+        },
+        "library": {
+          "name": "RudderLabs JavaScript SDK",
+          "version": "1.0.0"
+        },
+        "userAgent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_14_5) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/77.0.3865.90 Safari/537.36",
+        "locale": "en-US",
+        "ip": "0.0.0.0",
+        "os": {
+          "name": "",
+          "version": ""
+        },
+        "screen": {
+          "density": 2
+        }
+      },
+      "type": "track",
+      "messageId": "ec5481b6-a926-4d2e-b293-0b3a77c4d3be",
+      "originalTimestamp": "2019-10-14T11:15:18.300Z",
+      "anonymousId": "00000000000000000000000000",
+      "userId": "12345",
+      "event": "test track event GA3",
+      "properties": {
+        "user_actual_role": "system_admin, system_user",
+        "user_actual_id": 12345
+      },
+      "integrations": {
+        "All": true
+      },
+      "sentAt": "2019-10-14T11:15:53.296Z"
+    },
+    "destination": {
+      "Config": {
+        "trackingID": "UA-149602794-1"
+      },
+      "Enabled": true
+    },
+    "credentials": [
+      {
+        "key": "key1",
+        "value": "value1",
+        "isPublic": true
+      },
+      {
+        "key": "key2",
+        "value": "value2",
+        "isPublic": true
+      }
+    ]
+  }
+]

test/__tests__/user_transformation.test.js

@@ -243,6 +243,34 @@ describe("User transformation", () => {
     expect(output[0].transformedEvent.dummy_key).toEqual(secrets.dummy_key);
   });
 
+  it(`Simple ${name} Test with credentials for codeVersion 1`, async () => {
+    const versionId = randomID();
+
+    const inputData = require(`./data/${integration}_input_credentials.json`);
+
+    const respBody = {
+      versionId: versionId,
+      codeVersion: "1",
+      name,
+      code: `
+        export function transformEvent(event, metadata) {
+            event.credentialValue = credentials("key1");
+            return event;
+          }
+          `
+    };
+    fetch.mockResolvedValue({
+      status: 200,
+      json: jest.fn().mockResolvedValue(respBody)
+    });
+
+    const output = await userTransformHandler(inputData, versionId, []);
+    expect(fetch).toHaveBeenCalledWith(
+      `https://api.rudderlabs.com/transformation/getByVersionId?versionId=${versionId}`
+    );
+    expect(output[0].transformedEvent.credentialValue).toEqual("value1");
+  });
+
   it(`Simple async ${name} FetchV2 Test for V0 transformation`, async () => {
     const versionId = randomID();
     const inputData = require(`./data/${integration}_input.json`);
@@ -1053,6 +1081,7 @@ describe("User transformation", () => {
       trRevCode.versionId,
       [libraryVersionId],
       trRevCode,
+      null,
       true
     );
 
@@ -1089,6 +1118,7 @@ describe("User transformation", () => {
       trRevCode.versionId,
       [],
       trRevCode,
+      null,
       true
     );
     expect(output).toEqual(expectedData);
@@ -1508,6 +1538,7 @@ describe("Python transformations", () => {
       trRevCode.versionId,
       [],
       trRevCode,
+      null,
       true
     );
     expect(output).toEqual(outputData);
@@ -1553,6 +1584,7 @@ describe("Python transformations", () => {
       trRevCode.versionId,
       Object.values(importNameLibraryVersionIdsMap),
       trRevCode,
+      null,
       true
     );
     expect(output).toEqual(outputData);
@@ -1594,6 +1626,7 @@ describe("Python transformations", () => {
       trRevCode.versionId,
       Object.values(importNameLibraryVersionIdsMap),
       trRevCode,
+      null,
       true
     );
     expect(output).toEqual(outputData);

test/__tests__/user_transformation_errors.test.js

@@ -47,6 +47,7 @@ describe("JS Transformation Error Tests", () => {
         versionId,
         [],
         trRevCode,
+        null,
         true,
       );
 
@@ -65,6 +66,7 @@ describe("JS Transformation Error Tests", () => {
         versionId,
         [],
         trRevCode,
+        null,
         true,
       );
 
@@ -102,6 +104,7 @@ describe("JS Transformation Error Tests", () => {
         versionId,
         [libVid],
         trRevCode,
+        null,
         true,
       );
 
@@ -140,6 +143,7 @@ describe("JS Transformation Error Tests", () => {
         versionId,
         [libVid],
         trRevCode,
+        null,
         true,
       );
 
@@ -160,6 +164,7 @@ describe("JS Transformation Error Tests", () => {
         versionId,
         [],
         trRevCode,
+        null,
         true,
       );
 
@@ -181,6 +186,7 @@ describe("JS Transformation Error Tests", () => {
         versionId,
         [],
         trRevCode,
+        null,
         true,
       );
 
@@ -218,6 +224,7 @@ describe("JS Transformation Error Tests", () => {
         versionId,
         [libVid],
         trRevCode,
+        null,
         true,
       );
 
@@ -256,6 +263,7 @@ describe("JS Transformation Error Tests", () => {
         versionId,
         [libVid],
         trRevCode,
+        null,
         true,
       );