Merge pull request #60 from saucelabs/devx-2388-npm-install

feat: Install npm packages without package.json

Author: tianfeng92

README.md

@@ -1,12 +1,13 @@
 # Sauce Runner Utils
 
-A utilities library used by other Sauce Runners (e.g.: https://github.com/saucelabs/sauce-cypress-runner/) to share commonly used code between them
+A utilities library that is shared among Sauce Runners (e.g., https://github.com/saucelabs/sauce-cypress-runner/) to provide commonly used code across different runner implementations.
 
 ## Usage
 
 ```javascript
-const sauceRunnerUtils = require('sauce-runner-utils');
-sauceRunnerUtils.
+const sauceRunnerUtils = require('sauce-testrunner-utils');
+
+sauceRunnerUtils.prepareNpmEnv();
 ```
 
 ## Publishing

src/npm.ts

@@ -1,5 +1,5 @@
 import { spawn } from 'child_process';
-import { lstat, rename, rm, writeFile } from 'fs/promises';
+import { lstat, rename } from 'fs/promises';
 import { NodeContext } from './types';
 
 const temporarilyMovedFiles: {[key: string]: string} = {
@@ -34,13 +34,9 @@ export default class NPM {
     }
   }
 
-  public static async install (nodeCtx: NodeContext, pkg: {[key: string]: string}) {
+  public static async install (nodeCtx: NodeContext, pkgs: string[]) {
     await this.renamePackageJson();
-    await writeFile('package.json', JSON.stringify({
-      dependencies: pkg,
-    }));
-
-    const p = spawn(nodeCtx.nodePath, [nodeCtx.npmPath, 'install']);
+    const p = spawn(nodeCtx.nodePath, [nodeCtx.npmPath, 'install', ...pkgs]);
     p.stdout.pipe(process.stdout);
     p.stderr.pipe(process.stderr);
 
@@ -52,7 +48,6 @@ export default class NPM {
 
     const exitCode = await exitPromise;
 
-    await rm('package.json', { force: true });
     await this.restorePackageJson();
 
     return exitCode;

src/types.ts

@@ -1,5 +1,3 @@
-
-
 export type Suite = {
   name: string;
   env?: { [key: string]: string };

src/utils.ts

@@ -60,7 +60,7 @@ export async function setUpNpmConfig (nodeCtx: NodeContext, userConfig: NpmConfi
 export async function installNpmDependencies (nodeCtx: NodeContext, packageList: {[key:string]: string}) {
   const packages = Object.entries(packageList).map(([k, v]) => (`${k}@${v}`));
   console.log(`\nInstalling packages: ${packages.join(' ')}`);
-  await npm.install(nodeCtx, packageList);
+  await npm.install(nodeCtx, packages);
 }
 
 export async function rebuildNpmDependencies (nodeCtx: NodeContext, path: string) {

tests/unit/src/__snapshots__/utils.spec.ts.snap

@@ -63,9 +63,9 @@ Array [
     "nodePath": "node-bin",
     "npmPath": "npm-bin",
   },
-  Object {
-    "mypackage": "1.2.3",
-  },
+  Array [
+    "mypackage@1.2.3",
+  ],
 ]
 `;
 

tests/unit/src/npm.spec.ts

@@ -40,24 +40,10 @@ describe('NPM', function () {
   it('.install must invoke npm install', async function () {
     const interceptor = spawk.spawn(nodeCtx.nodePath).stdout('npm runned').exit(0);
     fsMocked.lstat.mockRejectedValue('non-existing');
-    let writeFile, writeContent;
-    // eslint-disable-next-line @typescript-eslint/no-explicit-any
-    fsMocked.writeFile.mockImplementation(function (name: any, data: any): Promise<void> {
-      writeFile = name;
-      writeContent = data;
-      return new Promise((resolve) => {
-        resolve();
-      });
-    });
-    await NPM.install(nodeCtx, {
-      cypress: '12.6.0'
-    });
+    await NPM.install(nodeCtx, ['cypress@12.6.0']);
     expect(interceptor.calledWith.command).toEqual(nodeCtx.nodePath);
-    expect(interceptor.calledWith.args).toEqual([nodeCtx.npmPath, 'install']);
+    expect(interceptor.calledWith.args).toEqual([nodeCtx.npmPath, 'install', 'cypress@12.6.0']);
     expect(fsMocked.lstat).toBeCalledTimes(4);
-    expect(fsMocked.writeFile).toBeCalledTimes(1);
-    expect(writeFile).toEqual('package.json');
-    expect(writeContent).toEqual(JSON.stringify({dependencies: { cypress: '12.6.0' }}));
   });
 
   it('.install moves package.json / package-lock.json', async function () {
@@ -68,11 +54,9 @@ describe('NPM', function () {
     fsMocked.rename.mockResolvedValue();
     fsMocked.writeFile.mockResolvedValue();
 
-    await NPM.install(nodeCtx, {
-      cypress: '12.6.0'
-    });
+    await NPM.install(nodeCtx, ['cypress@12.6.0']);
     expect(interceptor.calledWith.command).toEqual(nodeCtx.nodePath);
-    expect(interceptor.calledWith.args).toEqual([nodeCtx.npmPath, 'install']);
+    expect(interceptor.calledWith.args).toEqual([nodeCtx.npmPath, 'install', 'cypress@12.6.0']);
     expect(fsMocked.rename.mock.calls).toEqual([
       ['package.json', `.package.json-${process.pid}`],
       ['package-lock.json', `.package-lock.json-${process.pid}`],
@@ -85,8 +69,5 @@ describe('NPM', function () {
       [`.package.json-${process.pid}`],
       [`.package-lock.json-${process.pid}`],
     ]);
-    expect(fsMocked.writeFile.mock.calls).toEqual([
-      ['package.json', JSON.stringify({dependencies: { cypress: '12.6.0' }})],
-    ]);
   });
 });