@temporalio/nyc-test-coverage 1.1.0

package/LICENSE.md

@@ -0,0 +1,23 @@
+Temporal TypeScript SDK
+
+MIT License
+
+Copyright (c) 2021 Temporal Technologies Inc. All Rights Reserved
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,44 @@
+# `@temporalio/nyc-test-coverage`
+
+[![NPM](https://img.shields.io/npm/v/@temporalio/nyc-test-coverage?style=for-the-badge)](https://www.npmjs.com/package/@temporalio/nyc-test-coverage)
+
+[Temporal](https://temporal.io)'s [TypeScript SDK](https://docs.temporal.io/typescript/introduction) interceptors and sinks for code coverage with [nyc](https://npmjs.com/package/nyc).
+
+## Getting Started
+
+1. `npm install mocha nyc`
+2. Use [nyc to manually instrument your Workflow code](https://github.com/istanbuljs/nyc/blob/master/docs/instrument.md), for example `nyc instrument lib lib --in-place`. Make sure you instrument your Workflow code _after_ compiling it with `tsc`.
+3. Add this package's sinks and interceptors to your test worker, for example:
+
+```ts
+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,
+});
+```
+
+4. After your tests are done, call `mergeIntoGlobalCoverage()` to merge your Workflows' code coverage into nyc's global coverage.
+
+```ts
+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"
+}
+```

package/package.json

@@ -0,0 +1,35 @@
+{
+  "name": "@temporalio/nyc-test-coverage",
+  "version": "1.1.0",
+  "description": "Temporal.io SDK code coverage integration",
+  "main": "lib/index.js",
+  "types": "./lib/index.d.ts",
+  "keywords": [
+    "temporal",
+    "workflow",
+    "testing",
+    "coverage"
+  ],
+  "author": "Temporal Technologies Inc. <sdk@temporal.io>",
+  "license": "MIT",
+  "dependencies": {
+    "@temporalio/worker": "^1.1.0",
+    "@temporalio/workflow": "^1.1.0",
+    "istanbul-lib-coverage": "^3.2.0"
+  },
+  "devDependencies": {
+    "@types/istanbul-lib-coverage": "^2.0.4"
+  },
+  "bugs": {
+    "url": "https://github.com/temporalio/sdk-typescript/issues"
+  },
+  "homepage": "https://github.com/temporalio/sdk-typescript/tree/main/packages/testing",
+  "files": [
+    "lib",
+    "src"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "gitHead": "132f23a47a93fecf3f39836b31f08ea837b30320"
+}

package/src/index.ts

@@ -0,0 +1,53 @@
+import { InjectedSinks } from '@temporalio/worker';
+import { CoverageSinks } from './sinks';
+import libCoverage from 'istanbul-lib-coverage';
+
+export class WorkflowCoverage {
+  coverageMap = libCoverage.createCoverageMap();
+
+  /**
+   * Interceptor to inject into `WorkerOptions.interceptors.workflowModules`
+   */
+  public get interceptorModule(): string {
+    return require.resolve('./interceptors');
+  }
+
+  /**
+   * Contains sinks that allow Workflows to gather coverage data.
+   */
+  get sinks(): InjectedSinks<CoverageSinks> {
+    return {
+      coverage: {
+        merge: {
+          fn: (_workflowInfo, testCoverage) => {
+            this.coverageMap.merge(testCoverage);
+          },
+          callDuringReplay: false,
+        },
+      },
+    };
+  }
+
+  /**
+   * Merge this WorkflowCoverage's coverage map into the global coverage
+   * map data `global.__coverage__`.
+   */
+  mergeIntoGlobalCoverage(): void {
+    /* eslint-disable @typescript-eslint/ban-ts-comment */
+    // @ts-ignore
+    this.coverageMap.merge(global.__coverage__);
+
+    const coverageMapData: libCoverage.CoverageMapData = Object.keys(this.coverageMap.data).reduce(
+      (cur: libCoverage.CoverageMapData, path) => {
+        const fileCoverage = this.coverageMap.data[path] as libCoverage.FileCoverage;
+
+        cur[path] = fileCoverage.data;
+        return cur;
+      },
+      {}
+    );
+
+    // @ts-ignore
+    global.__coverage__ = coverageMapData;
+  }
+}

package/src/interceptors.ts

@@ -0,0 +1,31 @@
+import { proxySinks, WorkflowInterceptors } from '@temporalio/workflow';
+import { CoverageSinks } from './sinks';
+import type { CoverageMapData } from 'istanbul-lib-coverage';
+
+const { coverage } = proxySinks<CoverageSinks>();
+
+// Export the interceptors
+export const interceptors = (): WorkflowInterceptors => ({
+  internals: [
+    {
+      concludeActivation(input, next) {
+        /* eslint-disable @typescript-eslint/ban-ts-comment */
+        // @ts-ignore
+        const globalCoverage: CoverageMapData = global.__coverage__;
+
+        coverage.merge(JSON.parse(JSON.stringify(globalCoverage)));
+        clearCoverage(globalCoverage);
+
+        return next(input);
+      },
+    },
+  ],
+});
+
+function clearCoverage(coverage: CoverageMapData): void {
+  for (const path of Object.keys(coverage)) {
+    for (const index of Object.keys(coverage[path].s)) {
+      coverage[path].s[index] = 0;
+    }
+  }
+}

package/src/sinks.ts

@@ -0,0 +1,7 @@
+import { Sinks } from '@temporalio/workflow';
+
+export interface CoverageSinks extends Sinks {
+  coverage: {
+    merge(coverageMap: any): void;
+  };
+}