ci: added runtime validation for package distribution entrypoints

FuelLabs · petertonysmith94 · Apr 16, 2024 · Apr 15, 2024 · Apr 15, 2024 · Apr 15, 2024
commit 7d135c7c572ccd8217e19d9c71d0d0c1249065a5
@@ -43,6 +43,9 @@ jobs:
       - name: Verify package.json integrity
         run: pnpm lint:package-jsons
 
+      - name: Verify package exports integrity
+        run: pnpm verify:package-exports
+
       - name: Forc Format Check
         run: pnpm forc:check
 

@@ -29,6 +29,7 @@
     "lint:fix": "pnpm lint:check --fix",
     "lint:md-links": "tsx ./scripts/lint-md-links",
     "lint:package-jsons": "tsx ./scripts/lint-package-jsons",
+    "verify:package-exports": "tsx ./scripts/verify-package-exports",
     "prettier:check": "prettier --check packages",
     "prettier:format": "prettier --write packages",
     "changeset:publish": "tsx ./scripts/changeset/changeset-publish",

@@ -0,0 +1,50 @@
+import { execSync } from 'child_process';
+import { log, error } from 'console';
+import { readFileSync } from 'fs';
+import { globSync } from 'glob';
+import { dirname, join } from 'path';
+
+interface PackageJson {
+  name: string;
+  private: boolean;
+  exports: Record<string, {
+    require: string;
+    import: string;
+  }>
+}
+
+/**
+ * Get only the package's with exports
+ */
+const packagesWithExports = globSync(`{packages,apps}/*/package.json`)
+  .map((path) => {
+    const pkgJson = JSON.parse(readFileSync(path, 'utf-8')) as PackageJson;
+    return { ...pkgJson, path: dirname(path) };
+  })
+  .filter((json) => !json.private && json.exports)
+
+let errorCode = 0;
+
+/**
+ * 1). Runtime checks on package exports
+ */
+Object
+  .values(packagesWithExports)
+  .flatMap(pkg => Object
+      .values(pkg.exports)
+      .flatMap((e) => [e.require, e.import])
+      .map((entrypoint) => join(pkg.path, entrypoint))
+  )
+  .forEach(entrypoint => {
+    try {
+      execSync(`node ${entrypoint}`)
+      log(`Success | ${entrypoint}`)
+    } catch (e) {
+      error(`Error | Package export types`);
+      error(entrypoint)
+      error(e.toString());
+      errorCode = 1;
+    }
+  })
+
+process.exit(errorCode);