Merge branch 'master' into conductor-migration

Author: martin-henz

.github/actions/package.json

@@ -5,13 +5,13 @@
   "type": "module",
   "devDependencies": {
     "@sourceacademy/modules-repotools": "workspace:^",
-    "@types/node": "^22.15.30",
-    "typescript": "^5.8.2",
+    "@types/node": "^24.0.0",
+    "typescript": "^6.0.2",
     "vitest": "4.1.0"
   },
   "dependencies": {
     "@actions/artifact": "^6.0.0",
-    "@actions/core": "^1.11.1",
+    "@actions/core": "^3.0.0",
     "@actions/exec": "^3.0.0",
     "es-toolkit": "^1.44.0",
     "snyk-nodejs-lockfile-parser": "^2.4.2"

.github/actions/src/__tests__/lockfiles.test.ts

@@ -16,6 +16,11 @@ describe(utils.extractPackageName, () => {
       .toEqual('lodash');
   });
 
+  it('works on this weird patch thing', () => {
+    expect(utils.extractPackageName('typescript@patch:typescript@npm:6.0.2'))
+      .toEqual('typescript');
+  });
+
   it('throws an error on an invalid package name', () => {
     expect(() => utils.extractPackageName('something weird'))
       .toThrowError('Invalid package name: something weird');

.github/actions/src/commons.ts

@@ -1,6 +1,8 @@
 import { getExecOutput } from '@actions/exec';
 import { memoize } from 'es-toolkit';
 
+type PackageType = 'bundle' | 'tab' | 'lib' | null;
+
 export interface RawPackageRecord {
   directory: string;
   hasChanges: boolean;
@@ -9,9 +11,10 @@ export interface RawPackageRecord {
     devDependencies: Record<string, string>;
     dependencies: Record<string, string>;
   };
+  type: PackageType;
 }
 
-interface BasePackageRecord {
+interface BasePackageRecord<T extends PackageType> {
   /**
    * Directory within which the `package.json` file was found
    */
@@ -31,17 +34,19 @@ interface BasePackageRecord {
    * might need playwright for its tests
    */
   needsPlaywright: boolean;
+
+  type: T;
 }
 
-export interface BundlePackageRecord extends BasePackageRecord {
+export interface BundlePackageRecord extends BasePackageRecord<'bundle'> {
   bundleName: string;
 }
 
-export interface TabPackageRecord extends BasePackageRecord {
+export interface TabPackageRecord extends BasePackageRecord<'tab'> {
   tabName: string;
 }
 
-export type PackageRecord = BundlePackageRecord | TabPackageRecord | BasePackageRecord;
+export type PackageRecord = BundlePackageRecord | TabPackageRecord | BasePackageRecord<'lib' | null>;
 
 export function isPackageRecord(obj: unknown): obj is PackageRecord {
   if (typeof obj !== 'object' || obj === null) return false;
@@ -76,3 +81,16 @@ export const checkDirForChanges = memoize(async (directory: string) => {
   );
   return exitCode !== 0;
 });
+
+/**
+ * Format of each entry produced when running the command `yarn workspaces list --json`.
+ */
+export interface YarnWorkspaceRecord {
+  location: string;
+  name: string;
+}
+
+export async function runYarnWorkspacesList() {
+  const { stdout } = await getExecOutput('yarn workspaces list --json', [], { silent: true });
+  return stdout.trim();
+}

.github/actions/src/info/__tests__/index.test.ts

@@ -3,11 +3,11 @@ import fs from 'fs/promises';
 import pathlib from 'path';
 import * as core from '@actions/core';
 import { describe, expect, test, vi } from 'vitest';
-import * as git from '../../commons.js';
+import * as commons from '../../commons.js';
 import * as lockfiles from '../../lockfiles.js';
 import { getAllPackages, getRawPackages, main } from '../index.js';
 
-const mockedCheckChanges = vi.spyOn(git, 'checkDirForChanges');
+const mockedCheckChanges = vi.spyOn(commons, 'checkDirForChanges');
 
 vi.mock(import('path'), async importOriginal => {
   const { posix } = await importOriginal();
@@ -22,6 +22,14 @@ vi.mock(import('../../gitRoot.js'), () => ({
   gitRoot: 'root'
 }));
 
+vi.mock(import('@actions/core'), async importOriginal => {
+  const original = await importOriginal();
+  return {
+    ...original,
+    setOutput: vi.fn((_name, _value) => {})
+  };
+});
+
 class NodeError extends Error {
   constructor(public readonly code: string) {
     super();
@@ -119,42 +127,23 @@ function mockReadFile(path: string) {
   return recurser(segments, { root: mockDirectory });
 }
 
+function getMockYarnWorkspaceRecords(): commons.YarnWorkspaceRecord[] {
+  return [
+    { location: '.', name: '@sourceacademy/modules' },
+    { location: 'lib/modules-lib', name: '@sourceacademy/modules-lib' },
+    { location: 'src/bundles/bundle0', name: '@sourceacademy/bundle-bundle0' },
+    { location: 'src/tabs/tab0', name: '@sourceacademy/tab-Tab0' },
+  ];
+}
+
 vi.spyOn(fs, 'readdir').mockImplementation(mockReaddir as any);
 vi.spyOn(fs, 'readFile').mockImplementation(mockReadFile as any);
 vi.spyOn(lockfiles, 'hasLockFileChanged').mockResolvedValue(false);
+vi.spyOn(commons, 'runYarnWorkspacesList').mockResolvedValue(
+  getMockYarnWorkspaceRecords().map(each => JSON.stringify(each)).join('\n')
+);
 
 describe(getRawPackages, () => {
-  test('maxDepth = 1', async () => {
-    mockedCheckChanges.mockResolvedValueOnce(true);
-    const results = Object.entries(await getRawPackages('root', 1));
-    expect(fs.readdir).toHaveBeenCalledTimes(3);
-    expect(results.length).toEqual(1);
-
-    const [[name, packageData]] = results;
-    expect(name).toEqual('@sourceacademy/modules');
-    expect(packageData.hasChanges).toEqual(true);
-    expect(git.checkDirForChanges).toHaveBeenCalledOnce();
-  });
-
-  test('maxDepth = 3', async () => {
-    mockedCheckChanges.mockResolvedValue(true);
-    const results = await getRawPackages('root', 3);
-    expect(Object.values(results).length).toEqual(4);
-    expect(fs.readdir).toHaveBeenCalledTimes(8);
-
-    expect(results).toHaveProperty('@sourceacademy/bundle-bundle0');
-    const bundleResult = results['@sourceacademy/bundle-bundle0'];
-    expect(bundleResult.hasChanges).toEqual(true);
-
-    expect(results).toHaveProperty('@sourceacademy/tab-Tab0');
-    const tabResult = results['@sourceacademy/tab-Tab0'];
-    expect(tabResult.hasChanges).toEqual(true);
-
-    expect(results).toHaveProperty('@sourceacademy/modules-lib');
-    const libResult = results['@sourceacademy/modules-lib'];
-    expect(libResult.hasChanges).toEqual(true);
-  });
-
   test('hasChanges fields accurately reflects value returned from checkChanges', async () => {
     mockedCheckChanges.mockImplementation(p => {
       switch (p) {
@@ -221,7 +210,7 @@ describe(getAllPackages, () => {
 });
 
 describe(main, () => {
-  const mockedSetOutput = vi.spyOn(core, 'setOutput');
+  const mockedSetOutput = vi.mocked(core.setOutput);
 
   vi.spyOn(core.summary, 'addHeading').mockImplementation(() => core.summary);
   vi.spyOn(core.summary, 'addTable').mockImplementation(() => core.summary);

.github/actions/src/info/__tests__/sorter.test.ts

@@ -5,6 +5,7 @@ describe(topoSortPackages, () => {
   test('Without a cycle', () => {
     const result = topoSortPackages({
       '@sourceacademy/0': {
+        type: null,
         hasChanges: false,
         directory: '/',
         package: {
@@ -16,6 +17,7 @@ describe(topoSortPackages, () => {
         }
       },
       '@sourceacademy/1': {
+        type: null,
         hasChanges: false,
         directory: '/',
         package: {
@@ -27,6 +29,7 @@ describe(topoSortPackages, () => {
         }
       },
       '@sourceacademy/2': {
+        type: null,
         hasChanges: false,
         directory: '/',
         package: {
@@ -47,6 +50,7 @@ describe(topoSortPackages, () => {
   test('With a cycle', () => {
     const func = () => topoSortPackages({
       '@sourceacademy/0': {
+        type: null,
         hasChanges: false,
         directory: '/',
         package: {
@@ -58,6 +62,7 @@ describe(topoSortPackages, () => {
         }
       },
       '@sourceacademy/1': {
+        type: null,
         hasChanges: false,
         directory: '/',
         package: {
@@ -69,6 +74,7 @@ describe(topoSortPackages, () => {
         }
       },
       '@sourceacademy/2': {
+        type: null,
         hasChanges: false,
         directory: '/',
         package: {