source-academy
diff --git a/‎.github/actions/build.js‎
Lines changed: 17 additions & 0 deletions b/‎.github/actions/build.js‎
Lines changed: 17 additions & 0 deletions
diff --git a/‎.github/actions/package.json‎
Lines changed: 24 additions & 0 deletions b/‎.github/actions/package.json‎
Lines changed: 24 additions & 0 deletions
diff --git a/‎.github/actions/src/__tests__/commons.test.ts‎
Lines changed: 92 additions & 0 deletions b/‎.github/actions/src/__tests__/commons.test.ts‎
Lines changed: 92 additions & 0 deletions
diff --git a/‎.github/actions/src/commons.ts‎
Lines changed: 85 additions & 0 deletions b/‎.github/actions/src/commons.ts‎
Lines changed: 85 additions & 0 deletions
@@ -0,0 +1,17 @@
+// @ts-check
+import getBuildCommand from '@sourceacademy/modules-repotools/builder';
+
+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',
+  packages: 'external',
+  platform: 'node',
+  target: 'node20',
+});
+
+await buildCommand.parseAsync();
@@ -0,0 +1,24 @@
+{
+  "name": "@sourceacademy/modules-github-actions",
+  "description": "Github Actions for the modules repository",
+  "private": true,
+  "type": "module",
+  "devDependencies": {
+    "@sourceacademy/modules-repotools": "workspace:^",
+    "@types/node": "^22.15.30",
+    "typescript": "^5.8.2",
+    "vitest": "^4.0.4"
+  },
+  "dependencies": {
+    "@actions/artifact": "^2.3.2",
+    "@actions/core": "^1.11.1",
+    "@actions/exec": "^1.1.1",
+    "lodash": "^4.17.21"
+  },
+  "scripts": {
+    "build": "node ./build.js",
+    "postinstall": "yarn build",
+    "test": "vitest",
+    "tsc": "tsc --project ./tsconfig.json"
+  }
+}
@@ -0,0 +1,92 @@
+import * as exec from '@actions/exec';
+import { describe, expect, it, test, vi } from 'vitest';
+import * as commons from '../commons.js';
+
+vi.mock(import('lodash/memoize.js'), () => ({
+  default: (x: any) => x
+}) as any);
+
+const mockedExecOutput = vi.spyOn(exec, 'getExecOutput');
+
+describe(commons.checkForChanges, () => {
+  function mockChanges(value: boolean) {
+    mockedExecOutput.mockResolvedValueOnce({
+      exitCode: value ? 1 : 0, stdout: '', stderr: ''
+    });
+  }
+
+  it('should return true if git diff exits with non zero code', async () => {
+    mockChanges(true);
+    await expect(commons.checkForChanges('/')).resolves.toEqual(true);
+    expect(mockedExecOutput).toHaveBeenCalledOnce();
+  });
+
+  it('should return false if git diff exits with 0', async () => {
+    mockChanges(false);
+
+    await expect(commons.checkForChanges('/')).resolves.toEqual(false);
+    expect(mockedExecOutput).toHaveBeenCalledOnce();
+  });
+});
+
+describe(commons.isPackageRecord, () => {
+  test('no bundleName or tabName property is ok', () => {
+    expect(commons.isPackageRecord({
+      directory: '',
+      name: '',
+      changes: false,
+      needsPlaywright: false
+    })).toEqual(true);
+  });
+
+  test('string bundleName property is ok', () => {
+    expect(commons.isPackageRecord({
+      directory: '',
+      name: '',
+      changes: false,
+      needsPlaywright: false,
+      bundleName: ''
+    })).toEqual(true);
+  });
+
+  test('non-string bundleName property is not ok', () => {
+    expect(commons.isPackageRecord({
+      directory: '',
+      name: '',
+      changes: false,
+      needsPlaywright: false,
+      bundleName: 0
+    })).toEqual(false);
+  });
+
+  test('string tabName property is ok', () => {
+    expect(commons.isPackageRecord({
+      directory: '',
+      name: '',
+      changes: false,
+      needsPlaywright: false,
+      tabName: ''
+    })).toEqual(true);
+  });
+
+  test('non-string tabName property is not ok', () => {
+    expect(commons.isPackageRecord({
+      directory: '',
+      name: '',
+      changes: false,
+      needsPlaywright: false,
+      tabName: 0
+    })).toEqual(false);
+  });
+
+  test('having both bundleName and tabName property is not ok', () => {
+    expect(commons.isPackageRecord({
+      directory: '',
+      name: '',
+      changes: false,
+      needsPlaywright: false,
+      tabName: '',
+      bundleName: ''
+    })).toEqual(false);
+  });
+});
@@ -0,0 +1,85 @@
+import { getExecOutput } from '@actions/exec';
+import memoize from 'lodash/memoize.js';
+
+export interface RawPackageRecord {
+  directory: string;
+  hasChanges: boolean;
+  package: {
+    name: string;
+    devDependencies: Record<string, string>;
+    dependencies: Record<string, string>;
+  };
+}
+
+interface BasePackageRecord {
+  /**
+   * Directory within which the `package.json` file was found
+   */
+  directory: string;
+
+  /**
+   * Full scoped package name
+   */
+  name: string;
+  /**
+   * `true` if git detected changes from within the package's subdirectories,
+   * `false` otherwise
+   */
+  changes: boolean;
+  /**
+   * `true` if playwright is present under devDependencies. This means that the package
+   * might need playwright for its tests
+   */
+  needsPlaywright: boolean;
+}
+
+export interface BundlePackageRecord extends BasePackageRecord {
+  bundleName: string;
+}
+
+export interface TabPackageRecord extends BasePackageRecord {
+  tabName: string;
+}
+
+export type PackageRecord = BundlePackageRecord | TabPackageRecord | BasePackageRecord;
+
+export function isPackageRecord(obj: unknown): obj is PackageRecord {
+  if (typeof obj !== 'object' || obj === null) return false;
+
+  if (!('directory' in obj) || typeof obj.directory !== 'string') return false;
+  if (!('name' in obj) || typeof obj.name !== 'string') return false;
+  if (!('changes' in obj) || typeof obj.changes !== 'boolean') return false;
+  if (!('needsPlaywright' in obj) || typeof obj.needsPlaywright !== 'boolean') return false;
+
+  if ('bundleName' in obj) {
+    if ('tabName' in obj || typeof obj.bundleName !== 'string') return false;
+  } else if ('tabName' in obj) {
+    if (typeof obj.tabName !== 'string') return false;
+  }
+
+  return true;
+}
+
+// Not using the repotools version since this uses @action/exec instead of
+// calling execFile from child_process
+export async function getGitRoot() {
+  const { stdout } = await getExecOutput('git rev-parse --show-toplevel');
+  return stdout.trim();
+}
+
+/**
+ * Returns `true` if there are changes present in the given directory relative to
+ * the master branch\
+ * Used to determine, particularly for libraries, if running tests and tsc are necessary
+ */
+export const checkForChanges = memoize(async (directory: string) => {
+  const { exitCode } = await getExecOutput(
+    'git',
+    ['--no-pager', 'diff', '--quiet', 'origin/master', '--', directory],
+    {
+      failOnStdErr: false,
+      ignoreReturnCode: true
+    }
+  );
+  return exitCode !== 0;
+});