ci: checks for bundling (#1448)

.github/workflows/test.yml

@@ -16,6 +16,19 @@ jobs:
   windows-unit-tests:
     needs: linux-unit-tests
     uses: salesforcecli/github-workflows/.github/workflows/unitTestsWindows.yml@main
+  test-bundle:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
+        with:
+          node-version: lts/*
+          cache: yarn
+      - uses: salesforcecli/github-workflows/.github/actions/yarnInstallWithRetries@main
+      - name: Build the project
+        run: yarn build
+      - name: check if bundling runs into failures
+        run: node scripts/testEsbuild.js
 
   nuts:
     needs: linux-unit-tests

.husky/pre-commit

@@ -2,3 +2,4 @@
 . "$(dirname "$0")/_/husky.sh"
 
 yarn lint && yarn pretty-quick --staged
+node ./scripts/scanTs.js

package.json

@@ -49,9 +49,11 @@
     "@types/mime": "2.0.3",
     "@types/minimatch": "^5.1.2",
     "deep-equal-in-any-order": "^1.1.19",
+    "esbuild": "^0.24.0",
     "eslint-plugin-sf-plugin": "^1.20.8",
     "mocha-junit-reporter": "^1.23.3",
     "mocha-snap": "^5.0.0",
+    "ts-morph": "^24.0.0",
     "ts-node": "^10.9.2",
     "ts-patch": "^3.2.1",
     "typescript": "^5.5.4"

scripts/esbuild.config.js

@@ -0,0 +1,29 @@
+/**
+ * NOTE: This file does NOT really generate a bundle version of sdr
+ * sdr is bundled directly in salesforcedx-vscode
+ * The file is only used to detect any potential risks to esbuild.
+ **/
+const { build } = require('esbuild');
+
+const sharedConfig = {
+  bundle: true,
+  format: 'cjs',
+  platform: 'node',
+  external: [], // The allowlist of dependencies that are not bundle-able
+  keepNames: true,
+  plugins: [],
+  supported: {
+    'dynamic-import': false,
+  },
+  logOverride: {
+    'unsupported-dynamic-import': 'error',
+  },
+};
+
+(async () => {
+  await build({
+    ...sharedConfig,
+    entryPoints: ['./lib/src/index.js'],
+    outdir: 'dist',
+  });
+})();

scripts/scanTs.js

@@ -0,0 +1,51 @@
+const fs = require('fs');
+const path = require('path');
+const { Project, CallExpression } = require('ts-morph');
+
+const SRC_DIR = path.join(__dirname, '..', 'src');
+const project = new Project({
+  tsConfigFilePath: path.join(__dirname, '..', 'tsconfig.json'),
+});
+
+let detected = false;
+
+const scanDirectory = (dir) => {
+  const files = fs.readdirSync(dir);
+  files.forEach((file) => {
+    const fullPath = path.join(dir, file);
+    const stat = fs.statSync(fullPath);
+    if (stat.isDirectory()) {
+      scanDirectory(fullPath);
+    } else if (fullPath.endsWith('.ts')) {
+      analyzeFile(fullPath);
+    }
+  });
+};
+
+// This function will detect all the usages of fs.read* and send warnings with the location of the usage
+const analyzeFile = (filePath) => {
+  const srcFile = project.addSourceFileAtPath(filePath);
+  const funcCalls = srcFile.getDescendantsOfKind(CallExpression);
+
+  funcCalls.forEach((callExpression) => {
+    const exp = callExpression.getExpression();
+    if (exp.getText().startsWith('fs.read')) {
+      detected = true;
+      console.warn(
+        `Warning: Usage of "${exp.getText()}" in file "${filePath}" at line ${callExpression.getStartLineNumber()}.\n`
+      );
+    }
+  });
+};
+
+scanDirectory(SRC_DIR);
+
+if (detected) {
+  console.log('The warnings above do not mean the usages are wrong.');
+  console.log(`Avoid reading local artifacts with "fs.read*" since esbuild cannot bundle the artifacts together.`);
+  console.log('Consider using import instead or reach out to IDEx Foundations team');
+} else {
+  console.log('No fs.read* usages detected.');
+}
+
+console.log('Scan complete');

scripts/testEsbuild.js

@@ -0,0 +1,20 @@
+const { exec } = require('child_process');
+
+const commandToRun = 'node ./scripts/esbuild.config.js';
+
+// Run the command
+exec(commandToRun, (error, stdout, stderr) => {
+  // Combine stdout and stderr to check the entire output
+  const output = `${stdout}\n${stderr}`;
+  if (error) {
+    console.error(stderr);
+    process.exit(1); // Exit with an error code
+  }
+  // Check if the output contains the error string
+  if (output.includes('[require-resolve-not-external]')) {
+    console.error('Error: A dependency that has to be externalized in esbuild process is found. Please resolve it!');
+    process.exit(1); // Exit with an error code
+  } else {
+    process.exit(0); // Exit with success code
+  }
+});

src/registry/presets/presetMap.ts

@@ -7,6 +7,7 @@
 import { MetadataRegistry } from '../types';
 
 // we have to import all presets explicitly for VSCE's esbuild bundling process
+// other read methods might make esbuild fail to bundle the json file
 import * as decomposeCustomLabelsBeta from './decomposeCustomLabelsBeta.json';
 import * as decomposeCustomLabelsBeta2 from './decomposeCustomLabelsBeta2.json';
 import * as decomposePermissionSetBeta from './decomposePermissionSetBeta.json';

src/registry/registry.ts

@@ -5,6 +5,8 @@
  * For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
  */
 import { deepFreeze } from '../utils/collections';
+// The static import of json file should never be changed,
+// other read methods might make esbuild fail to bundle the json file
 import * as registryData from './metadataRegistry.json';
 import { MetadataRegistry } from './types';
 

src/registry/standardvalueset.ts

@@ -5,6 +5,8 @@
  * For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
  */
 import { deepFreeze } from '../utils/collections';
+// The static import of json file should never be changed,
+// other read methods might make esbuild fail to bundle the json file
 import * as standardValueSetData from './stdValueSetRegistry.json';
 
 /**

src/registry/variants.ts

@@ -7,6 +7,8 @@
 import { Logger, SfProject, SfProjectJson, Lifecycle, SfError } from '@salesforce/core';
 import { deepFreeze } from '../utils/collections';
 import { MetadataRegistry } from './types';
+// The static import of json file should never be changed,
+// other read methods might make esbuild fail to bundle the json file
 import * as registryData from './metadataRegistry.json';
 import { presetMap } from './presets/presetMap';