Merge pull request #4803 from microsoft/octogonz/lfx-fixes

[lockfile explorer] Improve output for Lockfile Lint

apps/lockfile-explorer/src/cli/explorer/ExplorerCommandLineParser.ts

@@ -1,10 +1,26 @@
 // Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
 // See LICENSE in the project root for license information.
 
-import { ConsoleTerminalProvider, type ITerminal, Terminal } from '@rushstack/terminal';
-import { type CommandLineFlagParameter, CommandLineParser } from '@rushstack/ts-command-line';
+import express from 'express';
+import yaml from 'js-yaml';
+import cors from 'cors';
+import process from 'process';
+import open from 'open';
+import updateNotifier from 'update-notifier';
 
-import { StartAction } from './actions/StartAction';
+import { FileSystem, type IPackageJson, JsonFile, PackageJsonLookup } from '@rushstack/node-core-library';
+import { ConsoleTerminalProvider, type ITerminal, Terminal, Colorize } from '@rushstack/terminal';
+import {
+  type CommandLineFlagParameter,
+  CommandLineParser,
+  type IRequiredCommandLineStringParameter
+} from '@rushstack/ts-command-line';
+import type { IAppContext } from '@rushstack/lockfile-explorer-web/lib/AppContext';
+import type { Lockfile } from '@pnpm/lockfile-types';
+
+import type { IAppState } from '../../state';
+import { init } from '../../utils/init';
+import { convertLockfileV6DepPathToV5DepPath, getShrinkwrapFileMajorVersion } from '../../utils/shrinkwrap';
 
 const EXPLORER_TOOL_FILENAME: 'lockfile-explorer' = 'lockfile-explorer';
 
@@ -13,10 +29,13 @@ export class ExplorerCommandLineParser extends CommandLineParser {
   private readonly _terminalProvider: ConsoleTerminalProvider;
   private readonly _debugParameter: CommandLineFlagParameter;
 
+  private readonly _subspaceParameter: IRequiredCommandLineStringParameter;
+
   public constructor() {
     super({
       toolFilename: EXPLORER_TOOL_FILENAME,
-      toolDescription: 'lockfile-lint is a tool for linting lockfiles.'
+      toolDescription:
+        'Lockfile Explorer is a desktop app for investigating and solving version conflicts in a PNPM workspace.'
     });
 
     this._debugParameter = this.defineFlagParameter({
@@ -25,17 +44,206 @@ export class ExplorerCommandLineParser extends CommandLineParser {
       description: 'Show the full call stack if an error occurs while executing the tool'
     });
 
+    this._subspaceParameter = this.defineStringParameter({
+      parameterLongName: '--subspace',
+      argumentName: 'SUBSPACE_NAME',
+      description: 'Specifies an individual Rush subspace to check.',
+      defaultValue: 'default'
+    });
+
     this._terminalProvider = new ConsoleTerminalProvider();
     this.globalTerminal = new Terminal(this._terminalProvider);
-
-    this._populateActions();
-  }
-
-  private _populateActions(): void {
-    this.addAction(new StartAction(this));
   }
 
   public get isDebug(): boolean {
     return this._debugParameter.value;
   }
+
+  protected async onExecute(): Promise<void> {
+    const lockfileExplorerProjectRoot: string = PackageJsonLookup.instance.tryGetPackageFolderFor(__dirname)!;
+    const lockfileExplorerPackageJson: IPackageJson = JsonFile.load(
+      `${lockfileExplorerProjectRoot}/package.json`
+    );
+    const appVersion: string = lockfileExplorerPackageJson.version;
+
+    this.globalTerminal.writeLine(
+      Colorize.bold(`\nRush Lockfile Explorer ${appVersion}`) +
+        Colorize.cyan(' - https://lfx.rushstack.io/\n')
+    );
+
+    updateNotifier({
+      pkg: lockfileExplorerPackageJson,
+      // Normally update-notifier waits a day or so before it starts displaying upgrade notices.
+      // In debug mode, show the notice right away.
+      updateCheckInterval: this.isDebug ? 0 : undefined
+    }).notify({
+      // Make sure it says "-g" in the "npm install" example command line
+      isGlobal: true,
+      // Show the notice immediately, rather than waiting for process.onExit()
+      defer: false
+    });
+
+    const PORT: number = 8091;
+    // Must not have a trailing slash
+    const SERVICE_URL: string = `http://localhost:${PORT}`;
+
+    const appState: IAppState = init({
+      lockfileExplorerProjectRoot,
+      appVersion,
+      debugMode: this.isDebug,
+      subspaceName: this._subspaceParameter.value
+    });
+
+    // Important: This must happen after init() reads the current working directory
+    process.chdir(appState.lockfileExplorerProjectRoot);
+
+    const distFolderPath: string = `${appState.lockfileExplorerProjectRoot}/dist`;
+    const app: express.Application = express();
+    app.use(express.json());
+    app.use(cors());
+
+    // Variable used to check if the front-end client is still connected
+    let awaitingFirstConnect: boolean = true;
+    let isClientConnected: boolean = false;
+    let disconnected: boolean = false;
+    setInterval(() => {
+      if (!isClientConnected && !awaitingFirstConnect && !disconnected) {
+        console.log(Colorize.red('The client has disconnected!'));
+        console.log(`Please open a browser window at http://localhost:${PORT}/app`);
+        disconnected = true;
+      } else if (!awaitingFirstConnect) {
+        isClientConnected = false;
+      }
+    }, 4000);
+
+    // This takes precedence over the `/app` static route, which also has an `initappcontext.js` file.
+    app.get('/initappcontext.js', (req: express.Request, res: express.Response) => {
+      const appContext: IAppContext = {
+        serviceUrl: SERVICE_URL,
+        appVersion: appState.appVersion,
+        debugMode: this.isDebug
+      };
+      const sourceCode: string = [
+        `console.log('Loaded initappcontext.js');`,
+        `appContext = ${JSON.stringify(appContext)}`
+      ].join('\n');
+
+      res.type('application/javascript').send(sourceCode);
+    });
+
+    app.use('/', express.static(distFolderPath));
+
+    app.use('/favicon.ico', express.static(distFolderPath, { index: 'favicon.ico' }));
+
+    app.get('/api/lockfile', async (req: express.Request, res: express.Response) => {
+      const pnpmLockfileText: string = await FileSystem.readFileAsync(appState.pnpmLockfileLocation);
+      const doc = yaml.load(pnpmLockfileText) as Lockfile;
+      const { packages, lockfileVersion } = doc;
+
+      const shrinkwrapFileMajorVersion: number = getShrinkwrapFileMajorVersion(lockfileVersion);
+
+      if (packages && shrinkwrapFileMajorVersion === 6) {
+        const updatedPackages: Lockfile['packages'] = {};
+        for (const [dependencyPath, dependency] of Object.entries(packages)) {
+          updatedPackages[convertLockfileV6DepPathToV5DepPath(dependencyPath)] = dependency;
+        }
+        doc.packages = updatedPackages;
+      }
+
+      res.send({
+        doc,
+        subspaceName: this._subspaceParameter.value
+      });
+    });
+
+    app.get('/api/health', (req: express.Request, res: express.Response) => {
+      awaitingFirstConnect = false;
+      isClientConnected = true;
+      if (disconnected) {
+        disconnected = false;
+        console.log(Colorize.green('The client has reconnected!'));
+      }
+      res.status(200).send();
+    });
+
+    app.post(
+      '/api/package-json',
+      async (req: express.Request<{}, {}, { projectPath: string }, {}>, res: express.Response) => {
+        const { projectPath } = req.body;
+        const fileLocation = `${appState.projectRoot}/${projectPath}/package.json`;
+        let packageJsonText: string;
+        try {
+          packageJsonText = await FileSystem.readFileAsync(fileLocation);
+        } catch (e) {
+          if (FileSystem.isNotExistError(e)) {
+            return res.status(404).send({
+              message: `Could not load package.json file for this package. Have you installed all the dependencies for this workspace?`,
+              error: `No package.json in location: ${projectPath}`
+            });
+          } else {
+            throw e;
+          }
+        }
+
+        res.send(packageJsonText);
+      }
+    );
+
+    app.get('/api/pnpmfile', async (req: express.Request, res: express.Response) => {
+      let pnpmfile: string;
+      try {
+        pnpmfile = await FileSystem.readFileAsync(appState.pnpmfileLocation);
+      } catch (e) {
+        if (FileSystem.isNotExistError(e)) {
+          return res.status(404).send({
+            message: `Could not load pnpmfile file in this repo.`,
+            error: `No .pnpmifile.cjs found.`
+          });
+        } else {
+          throw e;
+        }
+      }
+
+      res.send(pnpmfile);
+    });
+
+    app.post(
+      '/api/package-spec',
+      async (req: express.Request<{}, {}, { projectPath: string }, {}>, res: express.Response) => {
+        const { projectPath } = req.body;
+        const fileLocation = `${appState.projectRoot}/${projectPath}/package.json`;
+        let packageJson: IPackageJson;
+        try {
+          packageJson = await JsonFile.loadAsync(fileLocation);
+        } catch (e) {
+          if (FileSystem.isNotExistError(e)) {
+            return res.status(404).send({
+              message: `Could not load package.json file in location: ${projectPath}`
+            });
+          } else {
+            throw e;
+          }
+        }
+
+        const {
+          hooks: { readPackage }
+        } = require(appState.pnpmfileLocation);
+        const parsedPackage = readPackage(packageJson, {});
+        res.send(parsedPackage);
+      }
+    );
+
+    app.listen(PORT, async () => {
+      console.log(`App launched on ${SERVICE_URL}`);
+
+      if (!appState.debugMode) {
+        try {
+          // Launch the web browser
+          await open(SERVICE_URL);
+        } catch (e) {
+          this.globalTerminal.writeError('Error launching browser: ' + e.toString());
+        }
+      }
+    });
+  }
 }