feat: enhance action handling with identifier support

- src/context/directory/handlers/actions.ts: add includeIdentifiers parameter to mapToAction function
- src/context/yaml/handlers/actions.ts: add includeIdentifiers parameter to mapActions function
- src/tools/auth0/handlers/actions.ts: allow additional properties in action schema
- test/context/directory/actions.test.js: add test for dumping actions with identifiers
- test/context/yaml/actions.test.js: add test for dumping actions with identifiers

Author: kushalshit27

src/context/directory/handlers/actions.ts

@@ -73,8 +73,9 @@ function mapActionCode(filePath, action) {
   return `./${constants.ACTIONS_DIRECTORY}/${actionName}/code.js`;
 }
 
-function mapToAction(filePath, action): Partial<Action> {
+function mapToAction(filePath, action, includeIdentifiers: boolean): Partial<Action> {
   return {
+    ...(includeIdentifiers && action.id ? { id: action.id } : {}),
     name: action.name,
     code: mapActionCode(filePath, action),
     runtime: action.runtime,
@@ -105,12 +106,16 @@ async function dump(context: DirectoryContext): Promise<void> {
   // Create Actions folder
   const actionsFolder = path.join(context.filePath, constants.ACTIONS_DIRECTORY);
   fs.ensureDirSync(actionsFolder);
+  const includeIdentifiers = Boolean(context.config.AUTH0_EXPORT_IDENTIFIERS);
   filteredActions.forEach((action) => {
     // Dump template metadata
     const name = sanitize(action.name);
     const actionFile = path.join(actionsFolder, `${name}.json`);
     log.info(`Writing ${actionFile}`);
-    fs.writeFileSync(actionFile, JSON.stringify(mapToAction(context.filePath, action), null, 2));
+    fs.writeFileSync(
+      actionFile,
+      JSON.stringify(mapToAction(context.filePath, action, includeIdentifiers), null, 2)
+    );
   });
 }
 

src/context/yaml/handlers/actions.ts

@@ -11,11 +11,9 @@ import { Action, isMarketplaceAction } from '../../../tools/auth0/handlers/actio
 
 type ParsedActions = ParsedAsset<'actions', Partial<Action>[]>;
 
-type Secret = { name: string; value: string };
-
 function parseCode(context: YAMLContext, code: string) {
   if (code) {
-    //@ts-ignore TODO: understand why two arguments are passed when context.loadFile only accepts one
+    // @ts-ignore TODO: understand why two arguments are passed when context.loadFile only accepts one
     return context.loadFile(code, constants.ACTIONS_DIRECTORY);
   }
 }
@@ -38,7 +36,7 @@ async function parse(context: YAMLContext): Promise<ParsedActions> {
 
 function mapSecrets(secrets) {
   if (typeof secrets === 'string') {
-    return secrets; //Enables keyword preservation to operate on action secrets
+    return secrets; // Enables keyword preservation to operate on action secrets
   }
   if (secrets && secrets.length > 0) {
     return secrets.map((secret) => ({ name: secret.name, value: secret.value }));
@@ -80,11 +78,14 @@ async function dump(context: YAMLContext): Promise<ParsedActions> {
     return true;
   });
 
+  const includeIdentifiers = Boolean(context.config.AUTH0_EXPORT_IDENTIFIERS);
+
   return {
     actions: filteredActions.map((action) => ({
+      ...(includeIdentifiers && action.id ? { id: action.id } : {}),
       name: action.name,
       deployed: !!action.deployed || !!action.all_changes_deployed,
-      //@ts-ignore because Action resource needs to be typed more accurately
+      // @ts-ignore because Action resource needs to be typed more accurately
       code: mapActionCode(context.basePath, action),
       runtime: action.runtime,
       dependencies: action.dependencies || [],

src/tools/auth0/handlers/actions.ts

@@ -42,7 +42,7 @@ export const schema = {
   items: {
     type: 'object',
     required: ['name', 'supported_triggers', 'code'],
-    additionalProperties: false,
+    additionalProperties: true,
     properties: {
       code: { type: 'string', default: '' },
       runtime: { type: 'string' },

test/context/directory/actions.test.js

@@ -223,6 +223,60 @@ describe('#directory context actions', () => {
     );
   });
 
+  it('should dump actions with identifiers when AUTH0_EXPORT_IDENTIFIERS is true', async () => {
+    const actionName = 'action-with-id';
+    const dir = path.join(testDataDir, 'directory', 'test3-with-id');
+    cleanThenMkdir(dir);
+    const context = new Context(
+      { AUTH0_INPUT_FILE: dir, AUTH0_EXPORT_IDENTIFIERS: true },
+      mockMgmtClient()
+    );
+    const codeValidation =
+      '/** @type {PostLoginAction} */ module.exports = async (event, context) => { console.log("test-action"); return {}; };';
+
+    context.assets.actions = [
+      {
+        id: 'act_123',
+        name: actionName,
+        code: codeValidation,
+        runtime: 'node12',
+        dependencies: [],
+        secrets: [],
+        supported_triggers: [
+          {
+            id: 'post-login',
+            version: 'v1',
+          },
+        ],
+        deployed: true,
+        status: 'built',
+      },
+    ];
+
+    await handler.dump(context);
+
+    const actionsFolder = path.join(dir, constants.ACTIONS_DIRECTORY);
+    expect(loadJSON(path.join(actionsFolder, 'action-with-id.json'))).to.deep.equal({
+      id: 'act_123',
+      name: actionName,
+      code: './actions/action-with-id/code.js',
+      runtime: 'node12',
+      dependencies: [],
+      secrets: [],
+      supported_triggers: [
+        {
+          id: 'post-login',
+          version: 'v1',
+        },
+      ],
+      deployed: true,
+      status: 'built',
+    });
+    expect(fs.readFileSync(path.join(actionsFolder, actionName, 'code.js'), 'utf8')).to.deep.equal(
+      codeValidation
+    );
+  });
+
   it('should exclude marketplace actions during dump', async () => {
     const marketplaceAction = {
       id: 'D1AF7CCF-7ZAB-417F-81C0-533595A926D8',

test/context/yaml/actions.test.js

@@ -131,6 +131,63 @@ describe('#YAML context actions', () => {
     );
   });
 
+  it('should dump actions with identifiers when AUTH0_EXPORT_IDENTIFIERS is true', async () => {
+    const dir = path.join(testDataDir, 'yaml', 'actionsDumpWithId');
+    cleanThenMkdir(dir);
+    const context = new Context(
+      { AUTH0_INPUT_FILE: path.join(dir, 'tenant.yaml'), AUTH0_EXPORT_IDENTIFIERS: true },
+      mockMgmtClient()
+    );
+    const codeValidation =
+      '/** @type {PostLoginAction} */ module.exports = async (event, context) => { console.log("test-action"); return {}; };';
+
+    context.assets.actions = [
+      {
+        id: 'act_123',
+        name: 'action-one',
+        code: codeValidation,
+        runtime: 'node12',
+        status: 'built',
+        dependencies: [],
+        supported_triggers: [
+          {
+            id: 'post-login',
+            version: 'v1',
+          },
+        ],
+        secrets: [],
+        deployed: true,
+      },
+    ];
+
+    const dumped = await handler.dump(context);
+    expect(dumped).to.deep.equal({
+      actions: [
+        {
+          id: 'act_123',
+          name: 'action-one',
+          code: './actions/action-one/code.js',
+          runtime: 'node12',
+          status: 'built',
+          dependencies: [],
+          supported_triggers: [
+            {
+              id: 'post-login',
+              version: 'v1',
+            },
+          ],
+          secrets: [],
+          deployed: true,
+        },
+      ],
+    });
+
+    const actionsFolder = path.join(dir, 'actions', 'action-one');
+    expect(fs.readFileSync(path.join(actionsFolder, 'code.js'), 'utf8')).to.deep.equal(
+      codeValidation
+    );
+  });
+
   it('should exclude marketplace actions during dump', async () => {
     const dir = path.join(testDataDir, 'yaml', 'actionsDump');
     cleanThenMkdir(dir);