fix: fix Windows interop issues

Closes #174

Author: Xunnamius

ARCHITECTURE.md

@@ -16,9 +16,9 @@ document.
 <br />
 
 <!-- symbiote-template-region-end -->
+<!-- TODO -->
 
-There are as of yet no notable deviations or additions. See the linked document
-(above) for information on the architecture of this project.
+TODO: talk about DO_REAL_E2E and its effect on e2e tests
 
 [1]: https://github.com/Xunnamius/symbiote/wiki/Generic-Project-Architecture
 [2]: https://github.com/Xunnamius/symbiote

src/discover.ts

@@ -374,11 +374,12 @@ export async function discoverCommands(
             return (await import(maybeConfigFileURL)) as ImportedConfigurationModule;
           } catch (error) {
             if (
-              isUnknownFileExtensionError(error) ||
+              isUnknownFileExtensionSystemError(error) ||
               (isModuleNotFoundSystemError(error) &&
                 (error.moduleName?.endsWith(maybeConfigPath) ||
                   /* istanbul ignore next */
-                  error.url?.endsWith(maybeConfigPath)))
+                  // ? Just match url against url and avoid escape issues (#174)
+                  error.url === maybeConfigFileURL.toString()))
             ) {
               loadDebug.warn(
                 'a recoverable failure occurred while attempting to load configuration: %O',
@@ -1402,7 +1403,7 @@ function isModuleNotFoundSystemError(error: unknown): error is Error & {
 /**
  * Type-guard for Node's "ERR_UNKNOWN_FILE_EXTENSION" so-called `SystemError`s.
  */
-function isUnknownFileExtensionError(error: unknown): error is Error & {
+function isUnknownFileExtensionSystemError(error: unknown): error is Error & {
   code: 'ERR_UNKNOWN_FILE_EXTENSION';
 } {
   return (

test/integration/integration-client.test.ts

@@ -74,9 +74,12 @@ describe("import {...} from '@black-flag/core'", () => {
         // ! is working at every level. Do not change --version. This feature
         // ! has broken between node versions more than once :(
         initialVirtualFiles: {
-          'src/index.cjs': `require('@black-flag/core').configureProgram('${pathToFileURL(
-            toPath(__dirname, '..', 'fixtures', 'one-file-index-cjs')
-          ).toString()}').then(({execute}) => execute(['--version']));`
+          'src/index.cjs': `require('@black-flag/core').configureProgram('${toPath(
+            __dirname,
+            '..',
+            'fixtures',
+            'one-file-index-cjs'
+          ).replaceAll('\\', '\\\\')}').then(({execute}) => execute(['--version']));`
         }
       }
     );
@@ -96,9 +99,12 @@ describe("import {...} from '@black-flag/core'", () => {
         // ! is working at every level. Do not change --version. This feature
         // ! has broken between node versions more than once :(
         initialVirtualFiles: {
-          'src/index.cjs': `require('@black-flag/core').runProgram('${pathToFileURL(
-            toPath(__dirname, '..', 'fixtures', 'one-file-index-cjs')
-          ).toString()}', '--version');`
+          'src/index.cjs': `require('@black-flag/core').runProgram('${toPath(
+            __dirname,
+            '..',
+            'fixtures',
+            'one-file-index-cjs'
+          ).replaceAll('\\', '\\\\')}', '--version');`
         }
       }
     );
@@ -302,6 +308,7 @@ console.log(require('@black-flag/core/util').isPreExecutionContext({}) === false
         expect(context.testResult.stdout).toInclude('--help');
       },
       {
+        // ! In this test, we give Black Flag a file:// URL instead of a path
         initialVirtualFiles: {
           'src/index.cjs': `
 require('@black-flag/core/util').makeRunner({

test/integration/integration-smoke.test.ts

@@ -68,6 +68,7 @@ it('supports both CJS and ESM (js, mjs, cjs) configuration files in node CJS mod
       expect(context.testResult.stdout).toBe('first success');
     },
     {
+      // ! In this test, we give Black Flag a file:// URL instead of a path
       initialVirtualFiles: {
         'src/index.cjs': `require('@black-flag/core').runProgram('${pathToFileURL(
           toPath(__dirname, '..', 'fixtures', 'several-files-cjs-esm')
@@ -95,9 +96,12 @@ if(typeof module !== 'undefined' || typeof require !== 'undefined') {
   throw new Error('expected ESM runtime but detected CJS');
 }
 
-export default runProgram('${pathToFileURL(
-          toPath(__dirname, '..', 'fixtures', 'several-files-cjs-esm')
-        ).toString()}', 'js mjs');`
+export default runProgram('${toPath(
+          __dirname,
+          '..',
+          'fixtures',
+          'several-files-cjs-esm'
+        ).replaceAll('\\', '\\\\')}', 'js mjs');`
       }
     }
   );
@@ -117,9 +121,12 @@ it('supports both CJS and ESM (js, mjs, cjs) configuration files in node CJS mod
         args: ['--no-warnings']
       },
       initialVirtualFiles: {
-        'src/index.cjs': `require('@black-flag/core').runProgram('${pathToFileURL(
-          toPath(__dirname, '..', 'fixtures', 'several-files-cjs-esm')
-        ).toString()}', 'js cjs');`
+        'src/index.cjs': `require('@black-flag/core').runProgram('${toPath(
+          __dirname,
+          '..',
+          'fixtures',
+          'several-files-cjs-esm'
+        ).replaceAll('\\', '\\\\')}', 'js cjs');`
       }
     }
   );
@@ -146,9 +153,12 @@ if(typeof module !== 'undefined' || typeof require !== 'undefined') {
   throw new Error('expected ESM runtime but detected CJS');
 }
 
-export default runProgram('${pathToFileURL(
-          toPath(__dirname, '..', 'fixtures', 'several-files-cjs-esm')
-        ).toString()}', 'js mjs');`
+export default runProgram('${toPath(
+          __dirname,
+          '..',
+          'fixtures',
+          'several-files-cjs-esm'
+        ).replaceAll('\\', '\\\\')}', 'js mjs');`
       }
     }
   );

test/unit.test.ts

@@ -168,7 +168,9 @@ describe('::configureProgram', () => {
       });
 
       await expect(bf.configureProgram('/does-not-exist')).rejects.toMatchObject({
-        message: BfErrorMessage.BadConfigurationPath('/does-not-exist')
+        // ? Windows path will look different than unix, so only expect the
+        // ? dir bit (#174)
+        message: expect.stringContaining('does-not-exist')
       });
 
       // @ts-expect-error: testing bad call