ci(github): add check to validate exported types being correct

Primary Changes
---------------
1. Added get-all-tgz-path.ts to get all tgz files path
2. Added run-attw-on-tgz.ts to run attw on each tgz filepath
3. Added are-the-types-wrong as part of the custom-checks mechanism

Fixes: #3140

Signed-off-by: ruzell22 <[email protected]>

.cspell.json

@@ -15,6 +15,7 @@
     "approveformyorg",
     "askar",
     "Askar",
+    "attw",
     "Authz",
     "authzn",
     "AWSSM",

.github/workflows/ci.yaml

@@ -359,7 +359,12 @@ jobs:
           path: ./.yarn/
           restore-keys: |
             ${{ runner.os }}-yarn-${{ hashFiles('./yarn.lock') }}
+      - name: Installing AreTheTypesWrong Library
+        run: npm i -g @arethetypeswrong/cli
       - run: ./tools/ci.sh
+      - run: yarn lerna exec 'npm pack'
+      - name: Running AreTheTypesWrong scan
+        run: yarn run are-the-types-wrong
   yarn_tools_validate_bundle_names:
     continue-on-error: false
     env:

package.json

@@ -57,6 +57,7 @@
     "format:prettier": "prettier --write --config .prettierrc.js \"./**/{openapi.json,*.ts,*.js}\"",
     "spellcheck": "cspell lint --no-progress \"*/*/src/**/*.{js,ts}\"",
     "tsc": "NODE_OPTIONS=\"--max_old_space_size=3072\" tsc --build --verbose",
+    "are-the-types-wrong": "TS_NODE_PROJECT=./tools/tsconfig.json node --trace-deprecation --experimental-modules --abort-on-uncaught-exception --loader ts-node/esm --experimental-specifier-resolution=node ./tools/custom-checks/run-attw-on-tgz.ts",
     "codegen": "run-s 'codegen:warmup-*' codegen:lerna codegen:cleanup",
     "codegen:cleanup": "rm --force --verbose ./openapitools.json",
     "codegen:lerna": "lerna run codegen",

tools/custom-checks/get-all-tgz-path.ts

@@ -0,0 +1,49 @@
+import path from "path";
+import { fileURLToPath } from "url";
+import { globby, Options as GlobbyOptions } from "globby";
+import lernaCfg from "../../lerna.json" assert { type: "json" };
+
+/**
+ * Interface for the response of the getAllTgzPath function.
+ * @property {Array<string>} relativePaths - An array of relative paths to the
+ * package directories.
+ */
+
+export interface IGetAllTgzPathResponse {
+  readonly relativePaths: Readonly<Array<string>>;
+}
+
+/**
+ * Asynchronous function to get all tgz filepaths in a Lerna monorepo.
+ * @returns {Promise<IGetAllTgzPathResponse>} A promise that resolves to an
+ * object containing the arrays of relative paths to the all tgz files.
+ */
+
+export async function getAllTgzPath(): Promise<IGetAllTgzPathResponse> {
+  const TAG = "[tools/get-all-tgz-path.ts]";
+  const __filename = fileURLToPath(import.meta.url);
+  const __dirname = path.dirname(__filename);
+  const SCRIPT_DIR = __dirname;
+  const PROJECT_DIR = path.join(SCRIPT_DIR, "../../");
+
+  console.log(`${TAG} SCRIPT_DIR=${SCRIPT_DIR}`);
+  console.log(`${TAG} PROJECT_DIR=${PROJECT_DIR}`);
+
+  const globbyOpts: GlobbyOptions = {
+    cwd: PROJECT_DIR,
+    onlyFiles: true,
+    expandDirectories: false,
+    ignore: ["**/node_modules"],
+  };
+
+  const tgzFilesPattern = lernaCfg.packages.map(
+    (pkg: string) => `${pkg}/**/hyperledger-*.tgz`,
+  );
+
+  const tgzFilesRelative = await globby(tgzFilesPattern, globbyOpts);
+  console.log("%s found %s tgz files.", TAG, tgzFilesRelative.length);
+
+  return {
+    relativePaths: tgzFilesRelative,
+  };
+}

tools/custom-checks/run-attw-on-tgz.ts

@@ -0,0 +1,47 @@
+import esMain from "es-main";
+import { getAllTgzPath } from "./get-all-tgz-path";
+import { exec } from "child_process";
+import { exit } from "process";
+import { promisify } from "node:util";
+
+const execPromise = promisify(exec);
+
+export async function runAttwOnTgz(): Promise<[boolean, string[]]> {
+  const TAG = "[tools/custom-checks/run-attw-on-tgz.ts]";
+  console.log(`${TAG} Fetching .tgz file paths.`);
+
+  const { relativePaths: tgzFilesRelative } = await getAllTgzPath();
+  console.log(`${TAG} Found ${tgzFilesRelative.length} .tgz files.`);
+
+  let attwFailedPackages: string[] = [];
+
+  for (const filePath of tgzFilesRelative) {
+    try {
+      await execCommand("attw", filePath);
+    } catch {
+      attwFailedPackages.push(filePath);
+    }
+  }
+
+  const success = attwFailedPackages.length === 0;
+  return [success, attwFailedPackages];
+}
+
+async function execCommand(
+  binaryName: string,
+  filePath: string,
+): Promise<void> {
+  const command = `${binaryName} ./${filePath}`;
+  const { stdout } = await execPromise(command);
+  console.log(stdout);
+}
+
+if (esMain(import.meta)) {
+  const attwFailedPackages = await runAttwOnTgz();
+  if (attwFailedPackages.length > 0) {
+    console.log("Types are wrong for these packages:");
+    console.log(attwFailedPackages);
+    exit(1);
+  }
+  exit(0);
+}

tools/custom-checks/run-custom-checks.ts

@@ -9,6 +9,8 @@ import {
   checkMissingNodeDeps,
 } from "./check-missing-node-deps";
 import { getAllPkgDirs } from "./get-all-pkg-dirs";
+import { getAllTgzPath, IGetAllTgzPathResponse } from "./get-all-tgz-path";
+import { runAttwOnTgz } from "./run-attw-on-tgz";
 
 export async function runCustomChecks(
   argv: string[],
@@ -73,6 +75,18 @@ export async function runCustomChecks(
     overallSuccess = overallSuccess && success;
   }
 
+  {
+    const { relativePaths } = await getAllTgzPath();
+
+    const req: IGetAllTgzPathResponse = {
+      relativePaths,
+    };
+
+    const [success, errors] = await runAttwOnTgz();
+    overallErrors = overallErrors.concat(errors);
+    overallSuccess = overallSuccess && success;
+  }
+
   if (!overallSuccess) {
     overallErrors.forEach((it) => console.error(it));
   } else {