Add a new action that rebuilds the tabs for the devserver if necessary

Author: leeyi45

.github/actions/build.js

@@ -5,6 +5,7 @@ const buildCommand = getBuildCommand({
   bundle: true,
   entryPoints: [
     { in: './src/info/index.ts', out: 'info' },
+    { in: './src/load-artifacts/index.ts', out: 'load' },
   ],
   format: 'esm',
   outdir: 'dist',

.github/actions/package.json

@@ -9,6 +9,7 @@
     "vitest": "^3.2.3"
   },
   "dependencies": {
+    "@actions/artifact": "^2.3.2",
     "@actions/core": "^1.11.1",
     "@actions/exec": "^1.1.1",
     "lodash": "^4.17.21"

.github/actions/src/load-artifacts/action.yml

@@ -0,0 +1,6 @@
+name: Load Artifacts for Dev Server
+description: This action is mainly intended for loading all of the compiled tabs for the devserver.
+
+runs:
+  using: node20
+  main: ../../dist/load.js

.github/actions/src/load-artifacts/index.ts

@@ -0,0 +1,55 @@
+import pathlib from 'path';
+import { DefaultArtifactClient } from '@actions/artifact';
+import * as core from '@actions/core';
+import { exec } from '@actions/exec';
+import { bundlesDir, outDir, tabsDir } from '@sourceacademy/modules-repotools/getGitRoot';
+import { resolveAllTabs } from '@sourceacademy/modules-repotools/manifest';
+
+async function main() {
+  const artifact = new DefaultArtifactClient();
+  const tabsResult = await resolveAllTabs(bundlesDir, tabsDir);
+
+  if (tabsResult.severity === 'error') {
+    core.startGroup('Tab Resolution errors');
+    for (const error of tabsResult.errors) {
+      core.error(error);
+    }
+    core.endGroup();
+    core.setFailed('Tab resolution failed with errors');
+    return;
+  }
+
+  const tabPromises = Object.keys(tabsResult.tabs).map(async tabName => {
+    try {
+      const { artifact: { id } } = await artifact.getArtifact(`${tabName}-tab`);
+      await artifact.downloadArtifact(id, { path: pathlib.join(outDir, 'tabs', `${tabName}.js`) });
+      core.info(`Downloaded artifact for ${tabName}`);
+    } catch {}
+
+    core.info(`Error retrieving artifact for ${tabName}, will try building`);
+    // Artifact could not be found, we probably need to build it
+    const focusExitCode = await exec('yarn', ['workspaces', 'focus', `@sourceacademy/tab-${tabName}`]);
+    if (focusExitCode !== 0) {
+      core.setFailed(`yarn workspace focus failed for ${tabName}`);
+      return;
+    }
+
+    const buildExitCode = await exec('yarn', ['workspaces', 'foreach', '-A', '--include', `@sourceacademy/tab-${tabName}`, 'run', 'build']);
+    if (buildExitCode !== 0) {
+      core.setFailed(`Building ${tabName} failed`);
+      return;
+    }
+    core.info(`Built ${tabName}`);
+  });
+
+  await Promise.all(tabPromises);
+}
+
+if (process.env.GITHUB_ACTIONS) {
+  // Only automatically execute when running in github actions
+  try {
+    await main();
+  } catch (error: any) {
+    core.setFailed(error.message);
+  }
+}

.github/workflows/pull-request.yml

@@ -109,6 +109,13 @@ jobs:
           cd ${{ matrix.tabInfo.directory }}
           yarn build
 
+      - name: Upload Tab Artifact
+        if: matrix.tabInfo.changes
+        uses: actions/upload-artifact@v4
+        with:
+          name: ${{ matrix.tabInfo.tabName }}-tab
+          path: ./build/tabs/${{ matrix.tabInfo.tabName }}.js
+
       - name: Run Tests
         # https://github.com/vitest-dev/vitest/issues/5477
         # Known Vitest issue for coverage running in browser mode
@@ -183,8 +190,11 @@ jobs:
           package-name: '@sourceacademy/modules-devserver'
           playwright: true
 
-      - name: Build all tabs
-        run: yarn workspaces foreach -ptW --from "./src/tabs/*" run build
+      - name: Install dependencies for other actions
+        run: yarn workspaces focus @sourceacademy/modules-github-actions
+
+      - name: Load/Build all tabs
+        uses: ./.github/actions/src/load-artifacts
 
       - name: Run tests
         run: |

.husky/post-checkout

@@ -24,7 +24,7 @@ export const getLintCommand = () => new Command('lint')
     const resolveResult = await resolveEitherBundleOrTab(fullyResolved);
 
     if (resolveResult.severity === 'error') {
-      if (resolveResult.errors.length === 0 ) {
+      if (resolveResult.errors.length === 0) {
         logCommandErrorAndExit(`No tab or bundle found at ${fullyResolved}`);
       }
 
@@ -86,7 +86,7 @@ export const getTscCommand = () => new Command('tsc')
     const resolveResult = await resolveEitherBundleOrTab(fullyResolved);
 
     if (resolveResult.severity === 'error') {
-      if (resolveResult.errors.length === 0 ) {
+      if (resolveResult.errors.length === 0) {
         logCommandErrorAndExit(`No tab or bundle found at ${fullyResolved}`);
       }
 
@@ -107,14 +107,14 @@ export const getTscCommand = () => new Command('tsc')
   });
 
 export const getPrebuildAllCommand = () => new Command('prebuild')
-  .argument('[directory]', 'Directory to prebuild tasks in', process.cwd())
+  .argument('[directory]', 'Directory to run prebuild tasks in', process.cwd())
   .option('--ci', process.env.CI)
   .action(async (directory, { ci }) => {
     const fullyResolved = pathlib.resolve(directory);
     const resolveResult = await resolveEitherBundleOrTab(fullyResolved);
 
     if (resolveResult.severity === 'error') {
-      if (resolveResult.errors.length === 0 ) {
+      if (resolveResult.errors.length === 0) {
         logCommandErrorAndExit(`No tab or bundle found at ${fullyResolved}`);
       }