Change the git root functions to be constants

Author: leeyi45

lib/buildtools/src/commands/__tests__/lint.test.ts

@@ -1,4 +1,3 @@
-import * as utils from '@sourceacademy/modules-repotools/getGitRoot';
 import * as manifest from '@sourceacademy/modules-repotools/manifest';
 import { ESLint } from 'eslint';
 import { beforeEach, describe, expect, test, vi } from 'vitest';
@@ -7,7 +6,10 @@ import { getCommandRunner } from './testingUtils.js';
 
 const lintFilesMock = vi.hoisted(() => vi.fn());
 
-vi.spyOn(utils, 'getGitRoot').mockResolvedValue('/');
+vi.mock(import('@sourceacademy/modules-repotools/getGitRoot'), async importOriginal => ({
+  ...await importOriginal(),
+  gitRoot: '/'
+}));
 
 const mockedResolveEither = vi.spyOn(manifest, 'resolveEitherBundleOrTab');
 

lib/buildtools/src/commands/__tests__/template.test.ts

@@ -1,14 +1,15 @@
 import fs from 'fs/promises';
-
-import * as gitRoot from '@sourceacademy/modules-repotools/getGitRoot';
 import * as manifest from '@sourceacademy/modules-repotools/manifest';
 import { beforeEach, describe, expect, it, test, vi } from 'vitest';
 import { askQuestion } from '../../templates/print.js';
 import getTemplateCommand from '../template.js';
 import { getCommandRunner } from './testingUtils.js';
 
-vi.spyOn(gitRoot, 'getBundlesDir').mockResolvedValue('/src/bundles');
-vi.spyOn(gitRoot, 'getTabsDir').mockResolvedValue('/src/tabs');
+vi.mock(import('@sourceacademy/modules-repotools/getGitRoot'), async importOriginal => ({
+  ...await importOriginal(),
+  bundlesDir: '/src/bundles',
+  tabsDir: '/src/tabs',
+}));
 
 vi.mock(import('../../templates/print.js'), async importActual => {
   const actualTemplates = await importActual();

lib/buildtools/src/commands/build.ts

@@ -1,5 +1,5 @@
 import { Command } from '@commander-js/extra-typings';
-import { getBundlesDir, getOutDir } from '@sourceacademy/modules-repotools/getGitRoot';
+import { bundlesDir, outDir } from '@sourceacademy/modules-repotools/getGitRoot';
 import { resolveAllBundles, resolveEitherBundleOrTab, resolveSingleBundle, resolveSingleTab } from '@sourceacademy/modules-repotools/manifest';
 import { buildAll } from '../build/all.js';
 import { buildHtml, buildSingleBundleDocs } from '../build/docs/index.js';
@@ -9,9 +9,6 @@ import { buildManifest } from '../build/modules/manifest.js';
 import { runBuilderWithPrebuild } from '../prebuild/index.js';
 import { lintOption, logCommandErrorAndExit, logLevelOption, processResult, tscOption } from './commandUtils.js';
 
-const outDir = await getOutDir();
-const bundlesDir = await getBundlesDir();
-
 // Commands that are specific to a tab or bundle
 
 export const getBuildBundleCommand = () => new Command('bundle')

lib/buildtools/src/commands/list.ts

@@ -1,5 +1,5 @@
 import { Command } from '@commander-js/extra-typings';
-import { getBundlesDir, getTabsDir } from '@sourceacademy/modules-repotools/getGitRoot';
+import { bundlesDir, tabsDir } from '@sourceacademy/modules-repotools/getGitRoot';
 import { resolveAllBundles, resolveAllTabs, resolveSingleBundle, resolveSingleTab } from '@sourceacademy/modules-repotools/manifest';
 import chalk from 'chalk';
 import omit from 'lodash/omit.js';
@@ -10,7 +10,6 @@ export const getListBundlesCommand = () => new Command('bundle')
   .argument('[directory]')
   .action(async directory => {
     if (directory === undefined) {
-      const bundlesDir = await getBundlesDir();
       const manifestResult = await resolveAllBundles(bundlesDir);
       if (manifestResult.severity === 'error') {
         logCommandErrorAndExit(manifestResult);
@@ -43,11 +42,6 @@ export const getListTabsCommand = () => new Command('tabs')
   .argument('[directory]')
   .action(async directory => {
     if (directory === undefined) {
-      const [bundlesDir, tabsDir] = await Promise.all([
-        getBundlesDir(),
-        getTabsDir()
-      ]);
-
       const tabsManifest = await resolveAllTabs(bundlesDir, tabsDir);
       if (tabsManifest.severity === 'error') {
         logCommandErrorAndExit(tabsManifest);

lib/buildtools/src/commands/template.ts

@@ -1,7 +1,6 @@
 import type { Interface } from 'readline/promises';
 import { Command } from '@commander-js/extra-typings';
-import { getBundlesDir, getTabsDir } from '@sourceacademy/modules-repotools/getGitRoot';
-
+import { bundlesDir, tabsDir } from '@sourceacademy/modules-repotools/getGitRoot';
 import { isNodeError } from '@sourceacademy/modules-repotools/utils';
 import { addNew as addNewModule } from '../templates/bundle.js';
 import { askQuestion, error as _error, getRl, info, warn } from '../templates/print.js';
@@ -22,11 +21,6 @@ export default function getTemplateCommand() {
   return new Command('template')
     .description('Interactively create a new module or tab')
     .action(async () => {
-      const [bundlesDir, tabsDir] = await Promise.all([
-        getBundlesDir(),
-        getTabsDir()
-      ]);
-
       const rl = getRl();
       try {
         const mode = await askMode(rl);

lib/buildtools/src/commands/testing.ts

@@ -1,6 +1,6 @@
 import pathlib from 'path';
 import { Command, Option } from '@commander-js/extra-typings';
-import { getGitRoot } from '@sourceacademy/modules-repotools/getGitRoot';
+import { gitRoot } from '@sourceacademy/modules-repotools/getGitRoot';
 import chalk from 'chalk';
 import type { VitestRunMode } from 'vitest/node';
 import { runVitest } from '../testing/runner.js';
@@ -25,7 +25,6 @@ export const getTestCommand = () => new Command('test')
   .option('-p, --project <directory>', 'Path to the directory that is the root of your test project')
   .argument('[patterns...]', 'Test patterns to filter by.')
   .action(async (patterns, { mode, project, ...options }) => {
-    const gitRoot = await getGitRoot();
     const relative = pathlib.relative(project ?? process.cwd(), gitRoot);
 
     if (relative && !relative.startsWith('..') && !pathlib.isAbsolute(relative)) {

lib/buildtools/src/prebuild/lint.ts

@@ -1,6 +1,6 @@
 import { promises as fs, type Dirent } from 'fs';
 import pathlib from 'path';
-import { getBundlesDir, getGitRoot, getOutDir, getTabsDir } from '@sourceacademy/modules-repotools/getGitRoot';
+import { bundlesDir, gitRoot, outDir, tabsDir } from '@sourceacademy/modules-repotools/getGitRoot';
 import type { InputAsset, Severity } from '@sourceacademy/modules-repotools/types';
 import { findSeverity, flatMapAsync, isNodeError } from '@sourceacademy/modules-repotools/utils';
 import chalk from 'chalk';
@@ -35,7 +35,6 @@ async function timePromise<T>(f: () => Promise<T>) {
 }
 
 export async function runEslint(input: InputAsset, fix: boolean, stats: boolean): Promise<LintResult> {
-  const gitRoot = await getGitRoot();
   const linter = new ESLint({
     fix,
     stats,
@@ -49,7 +48,6 @@ export async function runEslint(input: InputAsset, fix: boolean, stats: boolean)
     }
 
     if (stats) {
-      const outDir = await getOutDir();
       await fs.mkdir(`${outDir}/lintstats`, { recursive: true });
 
       const statsFormatter = await linter.loadFormatter('json');
@@ -104,12 +102,6 @@ interface LintGlobalResults {
  * so that the bundles and tabs can be linted separately.
  */
 export async function lintGlobal(fix: boolean): Promise<LintGlobalResults> {
-  const [gitRoot, bundlesDir, tabsDir] = await Promise.all([
-    getGitRoot(),
-    getBundlesDir(),
-    getTabsDir()
-  ]);
-
   const linter = new ESLint({ fix, cwd: gitRoot });
 
   /**

lib/buildtools/src/testing/utils.ts

@@ -1,6 +1,6 @@
 import fs from 'fs/promises';
 import pathlib from 'path';
-import { getGitRoot } from '@sourceacademy/modules-repotools/getGitRoot';
+import { gitRoot } from '@sourceacademy/modules-repotools/getGitRoot';
 import { resolveSingleBundle, resolveSingleTab } from '@sourceacademy/modules-repotools/manifest';
 import type { ErrorResult } from '@sourceacademy/modules-repotools/types';
 import { isNodeError, mapAsync } from '@sourceacademy/modules-repotools/utils';
@@ -13,8 +13,6 @@ import { loadVitestConfigFromDir, sharedTabsConfig, sharedVitestConfiguration }
 // Assign to each configuration a different colour :)
 const colors: Readonly<LabelColor[]> = ['black', 'red', 'green', 'yellow', 'blue', 'magenta', 'cyan', 'white'];
 
-const gitRoot = await getGitRoot();
-
 /**
  * If the vitest project has browser mode enabled, then remove the regular test project as that will run duplicate tests
  * Also, unless `watch` is true, the tests should be run in headless mode.
@@ -214,7 +212,6 @@ export async function getTestConfiguration(directory: string, watch: boolean): P
  * Based on the root Vitest's configuration, get all the projects we need to test
  */
 export async function getAllTestConfigurations(watch: boolean) {
-  const gitRoot = await getGitRoot();
   const rootConfig = await loadVitestConfigFromDir(gitRoot);
   if (!rootConfig?.test?.projects) return [];
 

lib/buildtools/vitest.setup.ts

@@ -53,13 +53,13 @@ vi.mock(import('typescript'), async importOriginal => {
   };
 });
 
-vi.mock(import('@sourceacademy/modules-repotools/getGitRoot'), async () => {
+vi.mock(import('@sourceacademy/modules-repotools/getGitRoot'), () => {
   const testMocksDir = pathlib.resolve(import.meta.dirname, '../__test_mocks__');
   return {
-    getGitRoot: () => Promise.resolve(testMocksDir),
-    getBundlesDir: () => Promise.resolve(pathlib.join(testMocksDir, 'bundles')),
-    getTabsDir: () => Promise.resolve(pathlib.join(testMocksDir, 'tabs')),
-    getOutDir: () => Promise.resolve('/build'),
+    gitRoot: testMocksDir,
+    bundlesDir: pathlib.join(testMocksDir, 'bundles'),
+    tabsDir: pathlib.join(testMocksDir, 'tabs'),
+    outDir: '/build',
   };
 });
 

lib/repotools/src/getGitRoot.ts

@@ -1,6 +1,5 @@
 import { execFile } from 'child_process';
 import pathlib from 'path';
-import memoize from 'lodash/memoize.js';
 
 /*
  * Due to the multi-level directory structure in the repository, some commands can be run anywhere
@@ -21,21 +20,21 @@ function rawGetGitRoot() {
 }
 
 /**
- * Get the path to the root of the git repository
+ * Path to the root of the git repository
  */
-export const getGitRoot = memoize(rawGetGitRoot);
+export const gitRoot = await rawGetGitRoot();
 
 /**
- * Get the path to the directory within which bundles are stored
+ * Path to the directory within which bundles are defined
  */
-export const getBundlesDir = memoize(async () => pathlib.join(await getGitRoot(), 'src', 'bundles'));
+export const bundlesDir = pathlib.join(gitRoot, 'src', 'bundles');
 
 /**
- * Get the path to the directory within which tabs are stored
+ * Path to the directory within which tabs are defined
  */
-export const getTabsDir = memoize(async () => pathlib.join(await getGitRoot(), 'src', 'tabs'));
+export const tabsDir = pathlib.join(gitRoot, 'src', 'tabs');
 
 /**
- * Get the path to the default output directory
+ * Path to the default output directory
  */
-export const getOutDir = memoize(async () => pathlib.join(await getGitRoot(), 'build'));
+export const outDir = pathlib.join(gitRoot, 'build');