Merge pull request #210 from beakerandjake/feature/209-support-for-windows

Feature/209 support for windows

Author: beakerandjake

src/errors/solutionWorkerErrors.js

@@ -1,4 +1,4 @@
-import { pathToFileURL } from 'url';
+import { pathToFileURL } from 'node:url';
 
 /**
  * Error raised if the Solution Worker thread exits without posting an answer message.

src/initialize/installPackages.js

@@ -1,7 +1,17 @@
+import { platform } from 'node:process';
 import { spawn } from 'node:child_process';
 import { getConfigValue } from '../config.js';
 import { logger } from '../logger.js';
 
+/**
+ * Returns the npm command to execute for the specific platform.
+ * Fixes ENOENT errors on windows.
+ * @param {String} platform
+ * @private
+ */
+export const getNpmCommand = (platformName) =>
+  /^win/.test(platformName) ? 'npm.cmd' : 'npm';
+
 /**
  * Install packages for the user.
  */
@@ -11,7 +21,7 @@ export const installPackages = async () => {
   logger.debug('installing npm packages');
   await new Promise((resolve, reject) => {
     // run npm install command
-    const childProcess = spawn('npm', ['i', '--omit=dev'], {
+    const childProcess = spawn(getNpmCommand(platform), ['i', '--omit=dev'], {
       cwd: getConfigValue('cwd'),
       stdio: ['ignore', 'ignore', 'pipe'],
       detached: false,

src/solutions/importUserSolutionModule.js

@@ -1,4 +1,4 @@
-/* istanbul ignore file */
+import { pathToFileURL } from 'node:url';
 import {
   UserSolutionFileNotFoundError,
   UserSolutionSyntaxError,
@@ -12,7 +12,9 @@ import {
  */
 export const importUserSolutionModule = async (fileName) => {
   try {
-    const module = await import(fileName);
+    // fix ERR_UNSUPPORTED_EM_URL_SCHEME error on windows, and ensure path starts with file://
+    const fileUrl = pathToFileURL(fileName).href;
+    const module = await import(fileUrl);
     return module;
   } catch (error) {
     // throw nicer error if user file not found.

tests/initialize/installPackages.test.js

@@ -8,7 +8,9 @@ jest.unstable_mockModule('node:child_process', () => ({ spawn: jest.fn() }));
 
 // import after mocks set up
 const { spawn } = await import('node:child_process');
-const { installPackages } = await import('../../src/initialize/installPackages.js');
+const { installPackages, getNpmCommand } = await import(
+  '../../src/initialize/installPackages.js'
+);
 
 describe('initialize', () => {
   describe('installPackages()', () => {
@@ -100,4 +102,19 @@ describe('initialize', () => {
       await expect(promise).resolves.not.toThrow();
     });
   });
+
+  describe('getNpmCommand()', () => {
+    test.each([
+      ['npm', 'aix'],
+      ['npm', 'darwin'],
+      ['npm', 'freebsd'],
+      ['npm', 'linux'],
+      ['npm', 'openbsd'],
+      ['npm', 'sunos'],
+      ['npm.cmd', 'windows'],
+    ])('returns "%s" for platform "%s"', (expected, platform) => {
+      const result = getNpmCommand(platform);
+      expect(result).toBe(expected);
+    });
+  });
 });

tests/solutions/importUserSolutionModule.test.js

@@ -0,0 +1,93 @@
+import { describe, jest, test, afterEach } from '@jest/globals';
+
+// setup mocks
+jest.unstable_mockModule('node:url', () => ({
+  pathToFileURL: (path) => ({ href: path }),
+}));
+class UserSolutionSyntaxErrorMock extends Error {
+  constructor() {
+    super();
+    this.name = 'UserSolutionSyntaxErrorMock';
+  }
+}
+class UserSolutionFileNotFoundErrorMock extends Error {
+  constructor() {
+    super();
+    this.name = 'UserSolutionFileNotFoundErrorMock';
+  }
+}
+jest.unstable_mockModule('src/errors/solutionWorkerErrors.js', () => ({
+  UserSolutionFileNotFoundError: UserSolutionFileNotFoundErrorMock,
+  UserSolutionSyntaxError: UserSolutionSyntaxErrorMock,
+}));
+// import after mocks set up.
+
+describe('importUserSolutionModule', () => {
+  afterEach(() => {
+    jest.clearAllMocks();
+    jest.resetModules();
+  });
+
+  test('returns module', async () => {
+    // mock an module we know exists
+    const modulePath = 'src/main.js';
+    const module = { levelOne: () => {} };
+    jest.unstable_mockModule(modulePath, () => module);
+
+    const { importUserSolutionModule } = await import(
+      '../../src/solutions/importUserSolutionModule.js'
+    );
+    const result = await importUserSolutionModule(modulePath);
+    expect(result).toMatchObject(module);
+  });
+
+  test('throws UserSolutionFileNotFoundError if file not found', async () => {
+    // mock an module we know exists
+    const modulePath = 'src/main.js';
+    const error = new Error();
+    error.code = 'ERR_MODULE_NOT_FOUND';
+    jest.unstable_mockModule(modulePath, () => {
+      throw error;
+    });
+
+    const { importUserSolutionModule } = await import(
+      '../../src/solutions/importUserSolutionModule.js'
+    );
+
+    await expect(async () => importUserSolutionModule(modulePath)).rejects.toThrow(
+      UserSolutionFileNotFoundErrorMock
+    );
+  });
+
+  test('throws UserSolutionSyntaxError if file has syntax error', async () => {
+    // mock an module we know exists
+    const modulePath = 'src/main.js';
+    jest.unstable_mockModule(modulePath, () => {
+      throw new SyntaxError();
+    });
+
+    const { importUserSolutionModule } = await import(
+      '../../src/solutions/importUserSolutionModule.js'
+    );
+
+    await expect(async () => importUserSolutionModule(modulePath)).rejects.toThrow(
+      UserSolutionSyntaxErrorMock
+    );
+  });
+
+  test('throws on unknown error', async () => {
+    // mock an module we know exists
+    const modulePath = 'src/main.js';
+    jest.unstable_mockModule(modulePath, () => {
+      throw new RangeError();
+    });
+
+    const { importUserSolutionModule } = await import(
+      '../../src/solutions/importUserSolutionModule.js'
+    );
+
+    await expect(async () => importUserSolutionModule(modulePath)).rejects.toThrow(
+      RangeError
+    );
+  });
+});