Merge pull request #269 from microsoft/test-infrastructure

Validate export structure of every entrypoint

Author: andrewbranch

.github/workflows/CI.yml

@@ -9,21 +9,14 @@ jobs:
   ci:
     runs-on: ubuntu-latest
 
-    strategy:
-      matrix:
-        node-version: [12.x, 14.x, 16.x]
-
     steps:
       - uses: actions/checkout@9bb56186c3b09b4f86b1c65136769dd318469633 # v4.1.2
 
-      - name: Use node version ${{ matrix.node-version }}
+      - name: Setup Node.js
         uses: actions/setup-node@60edb5dd545a775178f52524783378180af0d1f8 # v4.0.2
         with:
-          node-version: ${{ matrix.node-version }}
+          node-version: 22.x
 
       - name: Run tests
         run: node ./test/runTests.js
 
-      - name: Run tests
-        run: node ./test/validateModuleExportsMatchCommonJS/index.js
-        if: matrix.node-version == '16.x'

test/cjs/index.js

@@ -0,0 +1,38 @@
+import assert from "node:assert";
+import { test } from "node:test";
+
+import * as tslibJs from "tslib/tslib.js";
+import * as tslibEs6Js from "tslib/tslib.es6.js";
+import * as tslibEs6Mjs from "tslib/tslib.es6.mjs";
+import * as tslibModulesIndex from "tslib/modules/index.js";
+
+test("all helpers available as named exports", () => {
+  compareKeys("tslib.js", tslibJs, "tslib.es6.js", tslibEs6Js);
+  compareKeys("tslib.js", tslibJs, "tslib.es6.mjs", tslibEs6Mjs);
+  compareKeys("tslib.js", tslibJs, "modules/index.js", tslibModulesIndex);
+});
+
+test("default export contains all named exports", () => {
+  assert.ok(tslibJs.default);
+  compareKeys("tslib.js (default export)", tslibJs.default, "tslib.js (namespace)", tslibJs);
+  assert.ok(tslibEs6Js.default);
+  compareKeys("tslib.es6.js (default export)", tslibEs6Js.default, "tslib.es6.js (namespace)", tslibEs6Js);
+  assert.ok(tslibEs6Mjs.default);
+  compareKeys("tslib.es6.mjs (default export)", tslibEs6Mjs.default, "tslib.es6.mjs (namespace)", tslibEs6Mjs);
+});
+
+/**
+ * @param {string} name1
+ * @param {object} tslib1
+ * @param {string} name2
+ * @param {object} tslib2
+ */
+function compareKeys(name1, tslib1, name2, tslib2) {
+  const difference = new Set(Object.keys(tslib1)).symmetricDifference(new Set(Object.keys(tslib2)));
+  difference.delete("__esModule");
+  difference.delete("default"); // Asserted separately where expected
+  const messages = Array.from(difference).map(missing => `'${missing}' missing in ${missing in tslib1 ? name2 : name1}`);
+  if (messages.length > 0) {
+    assert.fail(`Mismatch between ${name1} and ${name2}:\n\n  ${messages.join("\n  ")}\n`);
+  }
+}

test/cjs/package.json

@@ -0,0 +1,6 @@
+{
+  "type": "module",
+  "scripts": {
+    "test": "node --test --experimental-detect-module"
+  }
+}

test/esm-node-native/package.json

@@ -0,0 +1,24 @@
+import { describe } from "node:test";
+
+import * as tslibJs from "tslib/tslib.js";
+import * as tslibEs6Js from "tslib/tslib.es6.js";
+import * as tslibEs6Mjs from "tslib/tslib.es6.mjs";
+
+/**
+ * @template {keyof tslibJs} K
+ * @param {K} helperName 
+ * @param {(helper: tslibJs[K]) => any} test 
+ */
+export function testHelper(helperName, test) {
+  describe(helperName, () => {
+    describe("tslib.js", () => {
+      test(tslibJs[helperName]);
+    });
+    describe("tslib.es6.js", () => {
+      test(tslibEs6Js[helperName]);
+    });
+    describe("tslib.es6.mjs", () => {
+      test(tslibEs6Mjs[helperName]);
+    });
+  });
+}

test/node/exportStructure.test.js

@@ -0,0 +1,10 @@
+{
+  "compilerOptions": {
+    "module": "NodeNext",
+    "checkJs": true,
+    "noEmit": true,
+    "strict": true,
+    "forceConsistentCasingInFileNames": true,
+    "types": ["node"],
+  }
+}

test/node/package.json

@@ -1,11 +1,10 @@
 {
   "dependencies": {
+    "chalk": "^4.1.2",
+    "rollup": "4.22.0",
     "tslib": "file:..",
-    "rollup": "2.28.2",
-    "@rollup/plugin-node-resolve": "9.0.0",
-    "webpack": "4.44.2",
-    "webpack-cli": "3.3.12",
-    "snowpack": "2.12.1",
-    "vite": "2.8.0"
+    "vite": "5.4.6",
+    "webpack": "5.94.0",
+    "webpack-cli": "5.1.4"
   }
 }

test/node/testHelper.js

@@ -1,10 +1,7 @@
-import { nodeResolve } from '@rollup/plugin-node-resolve';
-
 export default {
   input: 'index.js',
   output: {
     dir: 'build',
     format: 'cjs'
   },
-  plugins: [nodeResolve()]
 };

test/node/tsconfig.json

@@ -1,15 +1,15 @@
+// @ts-check
 const { spawnSync } = require("child_process");
 const fs = require("fs");
 const path = require("path");
 const mainVersion = Number(process.version.replace("v","").split(".")[0])
 
 // Loop through all the folders and run `npm test`
 
-const blocklist = ["validateModuleExportsMatchCommonJS", "node_modules"];
 const filesInTest = fs.readdirSync(__dirname);
 const tests = filesInTest
   .filter((f) => fs.statSync(path.join(__dirname, f)).isDirectory())
-  .filter((f) => !blocklist.includes(f));
+  .filter((f) => f !== "node_modules");
 
 // Support setting up the test node modules
 if (!filesInTest.includes("node_modules")) {
@@ -18,7 +18,7 @@ if (!filesInTest.includes("node_modules")) {
   console.log("Installed");
 }
 
-const chalk = require("chalk").default;
+const chalk = require("chalk");
 for (const test of tests) {
   console.log("---> " + chalk.bold(test));
 

test/package.json

@@ -0,0 +1,5 @@
+{
+  "scripts": {
+    "test": "webpack && node build/main.js"
+  }
+}

test/rollup-modules/rollup.config.js

@@ -354,6 +354,10 @@ export default {
     __rest: __rest,
     __decorate: __decorate,
     __param: __param,
+    __esDecorate: __esDecorate,
+    __runInitializers: __runInitializers,
+    __propKey: __propKey,
+    __setFunctionName: __setFunctionName,
     __metadata: __metadata,
     __awaiter: __awaiter,
     __generator: __generator,

test/runTests.js

@@ -353,6 +353,10 @@ export default {
   __rest,
   __decorate,
   __param,
+  __esDecorate,
+  __runInitializers,
+  __propKey,
+  __setFunctionName,
   __metadata,
   __awaiter,
   __generator,

test/snowpack-modules/index.js

@@ -427,3 +427,37 @@ var __disposeResources;
     exporter("__addDisposableResource", __addDisposableResource);
     exporter("__disposeResources", __disposeResources);
 });
+
+0 && (module.exports = {
+    __extends,
+    __assign,
+    __rest,
+    __decorate,
+    __param,
+    __esDecorate,
+    __runInitializers,
+    __propKey,
+    __setFunctionName,
+    __metadata,
+    __awaiter,
+    __generator,
+    __exportStar,
+    __createBinding,
+    __values,
+    __read,
+    __spread,
+    __spreadArrays,
+    __spreadArray,
+    __await,
+    __asyncGenerator,
+    __asyncDelegator,
+    __asyncValues,
+    __makeTemplateObject,
+    __importStar,
+    __importDefault,
+    __classPrivateFieldGet,
+    __classPrivateFieldSet,
+    __classPrivateFieldIn,
+    __addDisposableResource,
+    __disposeResources,
+});