Abstract REPL setup complexity in new @seedcompany/nest library (#2915)

Author: CarsonF

package.json

@@ -44,6 +44,7 @@
     "@patarapolw/prettyprint": "^1.0.3",
     "@seedcompany/common": ">=0.11 <1",
     "@seedcompany/data-loader": "^0.5.4",
+    "@seedcompany/nest": ">=0.1 <1",
     "@seedcompany/nestjs-email": "^3.3.2",
     "@seedcompany/scripture": "^0.3.0",
     "argon2": "^0.31.1",

src/repl.ts

@@ -1,15 +1,8 @@
-import { clc } from '@nestjs/common/utils/cli-colors.util.js';
-import { NestFactory } from '@nestjs/core';
-import { assignToObject } from '@nestjs/core/repl/assign-to-object.util.js';
-import { ReplContext } from '@nestjs/core/repl/repl-context.js';
-import { bufferFromStream } from '@seedcompany/common';
+import { runRepl } from '@seedcompany/nest';
 import * as fs from 'fs';
-import { mkdir } from 'fs/promises';
 // eslint-disable-next-line no-restricted-imports
 import * as lodash from 'lodash';
 import { DateTime, Duration, Interval } from 'luxon';
-import { promisify } from 'util';
-import { createContext, runInContext } from 'vm';
 import {
   CalendarDate,
   DateInterval,
@@ -22,75 +15,44 @@ import {
 import * as common from '~/common';
 import './polyfills';
 
-/**
- * This does the same thing as {@link import('@nestjs/core').repl}
- * Just that we use our own logger & add more to the global context
- */
-async function bootstrap() {
-  // Ensure src files are initialized here were init errors can be caught
-  const { AppModule } = await import('./app.module');
-  const { bootstrapLogger, ConfigService, ResourcesHost } = await import(
-    '~/core'
-  );
-  const { AuthenticationService } = await import('./components/authentication');
-  const { Pnp } = await import('./components/pnp');
-
-  const app = await NestFactory.createApplicationContext(AppModule, {
-    abortOnError: false,
-    logger: bootstrapLogger,
-  });
-  await app.init();
-
-  const session = await app
-    .get(AuthenticationService)
-    .sessionForUser(app.get(ConfigService).rootAdmin.id);
-  const Resources = await app.get(ResourcesHost).getEnhancedMap();
-
-  const context = assignToObject(new ReplContext(app).globalScope, {
-    DateTime,
-    Duration,
-    Interval,
-    CalendarDate,
-    DateInterval,
-    mapFromList,
-    many,
-    maybeMany,
-    common,
-    // eslint-disable-next-line @typescript-eslint/naming-convention
-    __: lodash, // single underscore is "last execution result"
-    lodash,
-    session,
-    sessionFor: (role: Role): Session => ({
-      ...session,
-      roles: [`global:${role}`],
-    }),
-    Resources,
-    loadPnp: (filepath: string) => Pnp.fromBuffer(fs.readFileSync(filepath)),
-  });
-
-  if (!process.stdin.isTTY) {
-    const input = await bufferFromStream(process.stdin);
-    runInContext(input.toString(), createContext(context));
-    await app.close();
-    return;
-  }
-
-  const _repl = await Promise.resolve().then(() => import('repl'));
-  const replServer = _repl.start({
-    prompt: clc.green('> '),
-    ignoreUndefined: true,
-  });
-  replServer.on('exit', () => void app.close());
-
-  assignToObject(replServer.context, context);
-
-  await mkdir('.cache', { recursive: true });
-  await promisify(replServer.setupHistory.bind(replServer))(
-    '.cache/repl_history',
-  );
-}
-bootstrap().catch((err) => {
-  // eslint-disable-next-line no-console
-  console.error(err);
-  process.exit(1);
+runRepl({
+  module: () => import('./app.module').then((m) => m.AppModule),
+  options: async () => {
+    const { bootstrapLogger: logger } = await import('~/core');
+    return { logger };
+  },
+  extraContext: async (app) => {
+    const { ConfigService, ResourcesHost } = await import('~/core');
+    const { AuthenticationService } = await import(
+      './components/authentication'
+    );
+    const { Pnp } = await import('./components/pnp');
+
+    const session = await app
+      .get(AuthenticationService)
+      .sessionForUser(app.get(ConfigService).rootAdmin.id);
+    const Resources = await app.get(ResourcesHost).getEnhancedMap();
+
+    return {
+      DateTime,
+      Duration,
+      Interval,
+      CalendarDate,
+      DateInterval,
+      mapFromList,
+      many,
+      maybeMany,
+      common,
+      // eslint-disable-next-line @typescript-eslint/naming-convention
+      __: lodash, // single underscore is "last execution result"
+      lodash,
+      session,
+      sessionFor: (role: Role): Session => ({
+        ...session,
+        roles: [`global:${role}`],
+      }),
+      Resources,
+      loadPnp: (filepath: string) => Pnp.fromBuffer(fs.readFileSync(filepath)),
+    };
+  },
 });