@temporalio/nyc-test-coverage

@temporalio/nyc-test-coverage

Temporal's TypeScript SDK interceptors and sinks for code coverage with nyc.

Getting Started

• npm install mocha nyc
• Use nyc to manually instrument your Workflow code, for example nyc instrument lib lib --in-place. Make sure you instrument your Workflow code after compiling it with tsc.
• Add this package's sinks and interceptors to your test worker, for example:

import { WorkflowCoverage } from '@temporalio/nyc-test-coverage';

const workflowCoverage = new WorkflowCoverage();

worker = await Worker.create({
  connection: nativeConnection,
  taskQueue,
  workflowsPath: require.resolve("./workflows"),
  interceptors: {
    workflowModules: [workflowCoverage.interceptorModule]
  },
  sinks: workflowCoverage.sinks,
});

• After your tests are done, call mergeIntoGlobalCoverage() to merge your Workflows' code coverage into nyc's global coverage.

after(() => {
  workflowCoverage.mergeIntoGlobalCoverage();
});

For example, the following is a sample npm script that handles instrumenting and running tests. The following assumes that npm run build produces compiled JavaScript in the lib directory.

{
  "test.coverage": "npm run build && nyc instrument lib lib --in-place && nyc --reporter=lcov --reporter=text-summary mocha lib/*.test.js"
}