Unit Test an Action

const { getDefaultArguments, loadAction } = require('@auth0/actions/post-login/v3/test');
const path = require('path');
const { compileActionModules } = require('./test-utils/load-compiled-action');

const DIRNAME = path.dirname('../../../');
const ACTION_PATH = path.resolve(DIRNAME, './src/test-an-action.ts');
const CUSTOM_CLAIM_NAMESPACE = 'https://example.com';

describe('onExecutePostLogin', () => {
  let loader: any;
  let event: any;
  let api: any;

  beforeEach(async () => {
    jest.resetAllMocks();
    const { compiledActionPath } = compileActionModules(ACTION_PATH);
    loader = await loadAction(compiledActionPath);
    [event, api] = getDefaultArguments();
    jest.spyOn(api.access, 'deny');
    jest.spyOn(api.idToken, 'setCustomClaim');
  });

  afterEach(() => {
    jest.resetAllMocks();
  });

  it('Admin user', async () => {
    event.authorization = { roles: ['admin'] };

    await loader.execute('onExecutePostLogin', event, api);

    expect(api.idToken.setCustomClaim).toHaveBeenCalledWith(
      `${CUSTOM_CLAIM_NAMESPACE}/roles`,
      ['admin']
    );
    expect(api.access.deny).not.toHaveBeenCalled();
  });

  it('Restricted User - No authorization', async () => {
    delete event.authorization;

    await loader.execute('onExecutePostLogin', event, api);

    expect(api.idToken.setCustomClaim).not.toHaveBeenCalled();
    expect(api.access.deny).toHaveBeenCalledWith('Restricted');
  });

  it('Restricted User - No roles', async () => {
    event.authorization = { roles: [] };

    await loader.execute('onExecutePostLogin', event, api);

    expect(api.idToken.setCustomClaim).not.toHaveBeenCalled();
    expect(api.access.deny).toHaveBeenCalledWith('Restricted');
  });
});

import * as fs from 'fs';
import * as os from 'os';
import * as path from 'path';
import * as ts from 'typescript';

export interface ModuleToCompile {
  name: string;
  filename: string;
}

function transpileToTemp(sourcePath: string): string {
  const source = fs.readFileSync(sourcePath, 'utf8');
  const { outputText } = ts.transpileModule(source, {
    compilerOptions: {
      module: ts.ModuleKind.CommonJS,
      target: ts.ScriptTarget.ES2020,
      esModuleInterop: true,
    },
  });

  const tempPath = path.join(
    os.tmpdir(),
    `${path.basename(sourcePath, path.extname(sourcePath))}-${process.pid}-${Date.now()}-${Math.random().toString(36).slice(2)}.js`,
  );
  fs.writeFileSync(tempPath, outputText);
  return tempPath;
}

/**
 * loadAction() (from @auth0/actions/*\/test) reads its target file from disk and
 * runs it via vm.compileFunction, so it never goes through ts-node/Vitest's own
 * TS transform. Action sources (and any actions:-registered modules) must be
 * transpiled to plain JS on disk first.
 */
export function compileActionModules(actionPath: string, modules: ModuleToCompile[] = []) {
  const compiledActionPath = transpileToTemp(actionPath);
  const compiledModules = modules.map((m) => ({
    name: m.name,
    filename: transpileToTemp(m.filename),
  }));

  return { compiledActionPath, compiledModules };
}

{
  "name": "actions-npm-example-ts-jest",
  "version": "1.0.0",
  "description": "Actions TS",
  "main": "example.ts",
  "scripts": {
    "test": "jest"
  },
  "author": "John Doe",
  "license": "ISC",
  "devDependencies": {
    "@auth0/actions": "^0.32.0",
    "@types/jest": "^29.5.12",
    "@types/node": "22.14.0",
    "jest": "^29.7.0",
    "ts-jest": "^29.1.2",
    "typescript": "^5.9.2"
  }
}

module.exports = {
  preset: 'ts-jest',
  testEnvironment: 'node',
};

{
  "compilerOptions": {
    "target": "ES2020",
    "module": "NodeNext",
    "moduleResolution": "nodenext",
    "esModuleInterop": true,
    "allowSyntheticDefaultImports": true,
    "strict": true,
    "outDir": "dist",
    "declaration": true,
    "sourceMap": true,
    "allowJs": true,
    "checkJs": false,
    "resolveJsonModule": true,
    "skipLibCheck": true,
    "forceConsistentCasingInFileNames": true,
    "isolatedModules": true,
    "noEmit": true,
    "paths": {
      "actions:*": [
        "./src/*"
      ]
    }
  },
  "exclude": [
    "node_modules",
    "dist"
  ],
  "include": [
    "**/*.ts"
  ],
  "ts-node": {
    "transpileOnly": true
  }
}

import * as path from 'path';
import sinon from 'sinon';
import { compileActionModules } from './test-utils/load-compiled-action';

const { getDefaultArguments, loadAction } = require('@auth0/actions/post-login/v3/test');

const DIRNAME = path.dirname('../../../');
const ACTION_PATH = path.resolve(DIRNAME, './src/test-an-action.ts');
const CUSTOM_CLAIM_NAMESPACE = 'https://example.com';

describe('onExecutePostLogin', () => {
  let loader: any;
  let event: any;
  let api: any;

  beforeEach(async () => {
    const { compiledActionPath } = compileActionModules(ACTION_PATH);
    loader = await loadAction(compiledActionPath);
    [event, api] = getDefaultArguments();
    sinon.spy(api.access, 'deny');
    sinon.spy(api.idToken, 'setCustomClaim');
  });

  afterEach(() => {
    sinon.restore();
  });

  it('Admin user', async () => {
    event.authorization = { roles: ['admin'] };

    await loader.execute('onExecutePostLogin', event, api);

    sinon.assert.calledWith(
      api.idToken.setCustomClaim,
      `${CUSTOM_CLAIM_NAMESPACE}/roles`,
      ['admin']
    );
    sinon.assert.notCalled(api.access.deny);
  });

  it('Restricted User - No authorization', async () => {
    delete event.authorization;

    await loader.execute('onExecutePostLogin', event, api);

    sinon.assert.notCalled(api.idToken.setCustomClaim);
    sinon.assert.calledWith(api.access.deny, 'Restricted');
  });

  it('Restricted User - No roles', async () => {
    event.authorization = { roles: [] };

    await loader.execute('onExecutePostLogin', event, api);

    sinon.assert.notCalled(api.idToken.setCustomClaim);
    sinon.assert.calledWith(api.access.deny, 'Restricted');
  });
});

import * as fs from 'fs';
import * as os from 'os';
import * as path from 'path';
import * as ts from 'typescript';

export interface ModuleToCompile {
  name: string;
  filename: string;
}

function transpileToTemp(sourcePath: string): string {
  const source = fs.readFileSync(sourcePath, 'utf8');
  const { outputText } = ts.transpileModule(source, {
    compilerOptions: {
      module: ts.ModuleKind.CommonJS,
      target: ts.ScriptTarget.ES2020,
      esModuleInterop: true,
    },
  });

  const tempPath = path.join(
    os.tmpdir(),
    `${path.basename(sourcePath, path.extname(sourcePath))}-${process.pid}-${Date.now()}-${Math.random().toString(36).slice(2)}.js`,
  );
  fs.writeFileSync(tempPath, outputText);
  return tempPath;
}

/**
 * loadAction() (from @auth0/actions/*\/test) reads its target file from disk and
 * runs it via vm.compileFunction, so it never goes through ts-node/Vitest's own
 * TS transform. Action sources (and any actions:-registered modules) must be
 * transpiled to plain JS on disk first.
 */
export function compileActionModules(actionPath: string, modules: ModuleToCompile[] = []) {
  const compiledActionPath = transpileToTemp(actionPath);
  const compiledModules = modules.map((m) => ({
    name: m.name,
    filename: transpileToTemp(m.filename),
  }));

  return { compiledActionPath, compiledModules };
}

{
  "name": "actions-npm-example-ts-mocha",
  "version": "1.0.0",
  "description": "",
  "license": "ISC",
  "author": "",
  "scripts": {
    "test": "NODE_OPTIONS=--no-experimental-strip-types mocha"
  },
  "devDependencies": {
    "@auth0/actions": "^0.32.0",
    "@types/chai": "^4.3.16",
    "@types/mocha": "^10.0.6",
    "@types/node": "22.14.0",
    "@types/sinon": "^17.0.3",
    "chai": "^4.5.0",
    "mocha": "^11.0.0",
    "sinon": "^19.0.0",
    "ts-node": "^10.9.2",
    "typescript": "^5.9.2"
  }
}

{
  "require": "ts-node/register",
  "extension": ["ts"],
  "spec": "src/**/*.test.ts"
}

{
  "compilerOptions": {
    "target": "ES2020",
    "module": "NodeNext",
    "moduleResolution": "nodenext",
    "esModuleInterop": true,
    "allowSyntheticDefaultImports": true,
    "strict": true,
    "outDir": "dist",
    "declaration": true,
    "sourceMap": true,
    "allowJs": true,
    "checkJs": false,
    "resolveJsonModule": true,
    "skipLibCheck": true,
    "forceConsistentCasingInFileNames": true,
    "isolatedModules": true,
    "noEmit": true,
    "paths": {
      "actions:*": [
        "./src/*"
      ]
    }
  },
  "exclude": [
    "node_modules",
    "dist"
  ],
  "include": [
    "**/*.ts"
  ],
  "ts-node": {
    "transpileOnly": true
  }
}

const assert = require('node:assert');
const { describe, it, beforeEach, afterEach, mock } = require('node:test');
const { getDefaultArguments, loadAction } = require('@auth0/actions/post-login/v3/test');
const path = require('path');
const { compileActionModules } = require('./test-utils/load-compiled-action.ts');

const DIRNAME = path.dirname('../../../');
const ACTION_PATH = path.resolve(DIRNAME, './src/test-an-action.ts');
const CUSTOM_CLAIM_NAMESPACE = 'https://example.com';

describe('onExecutePostLogin', () => {
  let loader;
  let event;
  let api;

  beforeEach(async () => {
    const { compiledActionPath } = compileActionModules(ACTION_PATH);
    loader = await loadAction(compiledActionPath);
    [event, api] = getDefaultArguments();
    mock.method(api.access, 'deny');
    mock.method(api.idToken, 'setCustomClaim');
  });

  afterEach(() => {
    mock.reset();
  });

  it('Admin user', async () => {
    event.authorization = { roles: ['admin'] };

    await loader.execute('onExecutePostLogin', event, api);

    assert.deepEqual(api.idToken.setCustomClaim.mock.calls[0].arguments, [
      `${CUSTOM_CLAIM_NAMESPACE}/roles`,
      ['admin'],
    ]);
    assert.strictEqual(api.access.deny.mock.calls.length, 0);
  });

  it('Restricted User - No authorization', async () => {
    delete event.authorization;

    await loader.execute('onExecutePostLogin', event, api);

    assert.strictEqual(api.idToken.setCustomClaim.mock.calls.length, 0);
    assert.deepEqual(api.access.deny.mock.calls[0].arguments, ['Restricted']);
  });

  it('Restricted User - No roles', async () => {
    event.authorization = { roles: [] };

    await loader.execute('onExecutePostLogin', event, api);

    assert.strictEqual(api.idToken.setCustomClaim.mock.calls.length, 0);
    assert.deepEqual(api.access.deny.mock.calls[0].arguments, ['Restricted']);
  });
});

const fs = require('fs');
const os = require('os');
const path = require('path');
const ts = require('typescript');

interface ModuleToCompile {
  name: string;
  filename: string;
}

function transpileToTemp(sourcePath: string): string {
  const source = fs.readFileSync(sourcePath, 'utf8');
  const { outputText } = ts.transpileModule(source, {
    compilerOptions: {
      module: ts.ModuleKind.CommonJS,
      target: ts.ScriptTarget.ES2020,
      esModuleInterop: true,
    },
  });

  const tempPath = path.join(
    os.tmpdir(),
    `${path.basename(sourcePath, path.extname(sourcePath))}-${process.pid}-${Date.now()}-${Math.random().toString(36).slice(2)}.js`,
  );
  fs.writeFileSync(tempPath, outputText);
  return tempPath;
}

/**
 * loadAction() (from @auth0/actions/*\/test) reads its target file from disk and
 * runs it via vm.compileFunction, so it never goes through node's native TS type
 * stripping. Action sources (and any actions:-registered modules) must be
 * transpiled to plain JS on disk first.
 */
exports.compileActionModules = function compileActionModules(actionPath: string, modules: ModuleToCompile[] = []) {
  const compiledActionPath = transpileToTemp(actionPath);
  const compiledModules = modules.map((m: ModuleToCompile) => ({
    name: m.name,
    filename: transpileToTemp(m.filename),
  }));

  return { compiledActionPath, compiledModules };
};

{
  "name": "actions-npm-example-ts-node-test",
  "version": "1.0.0",
  "description": "",
  "license": "ISC",
  "author": "",
  "scripts": {
    "test": "node --test src/*.test.ts"
  },
  "devDependencies": {
    "@auth0/actions": "^0.32.0",
    "@types/node": "22.14.0",
    "typescript": "^5.9.2"
  }
}

{
  "compilerOptions": {
    "target": "ES2020",
    "module": "NodeNext",
    "moduleResolution": "nodenext",
    "esModuleInterop": true,
    "allowSyntheticDefaultImports": true,
    "strict": true,
    "outDir": "dist",
    "declaration": true,
    "sourceMap": true,
    "allowJs": true,
    "checkJs": false,
    "resolveJsonModule": true,
    "skipLibCheck": true,
    "forceConsistentCasingInFileNames": true,
    "isolatedModules": true,
    "noEmit": true,
    "paths": {
      "actions:*": [
        "./src/*"
      ]
    }
  },
  "exclude": [
    "node_modules",
    "dist"
  ],
  "include": [
    "**/*.ts"
  ],
  "ts-node": {
    "transpileOnly": true
  }
}