Fix path handling to work with Windows and add tests for it

dpvc · dpvc · commit f98da55d84fd · 2025-10-01T09:37:08.000-04:00
diff --git a/components/mjs/a11y/speech/speech.js b/components/mjs/a11y/speech/speech.js
@@ -2,20 +2,20 @@ import './lib/speech.js';
 
 import {combineDefaults} from '#js/components/global.js';
 import {Package} from '#js/components/package.js';
-import {hasWindow} from '#js/util/context.js';
+import {context} from '#js/util/context.js';
 import {SpeechHandler} from '#js/a11y/speech.js';
 
 if (MathJax.loader) {
   let path = Package.resolvePath('[sre]', false);
   let maps = Package.resolvePath('[mathmaps]', false);
-  if (hasWindow) {
+  if (context.window) {
     path = new URL(path, location).href;
     maps = new URL(maps, location).href;
   } else {
     const REQUIRE = typeof require !== 'undefined' ? require : MathJax.config.loader.require;
     if (REQUIRE?.resolve) {
-      path = REQUIRE.resolve(`${path}/require.mjs`).replace(/\/[^\/]*$/, '');
-      maps = REQUIRE.resolve(`${maps}/base.json`).replace(/\/[^\/]*$/, '');
+      path = context.path(REQUIRE.resolve(`${path}/require.mjs`)).replace(/\/[^\/]*$/, '');
+      maps = context.path(REQUIRE.resolve(`${maps}/base.json`)).replace(/\/[^\/]*$/, '');
     } else {
       path = maps = '';
     }
diff --git a/components/mjs/node-main/node-main-setup.mjs b/components/mjs/node-main/node-main-setup.mjs
@@ -4,4 +4,4 @@ global.require = createRequire(import.meta.url);
 const path = require("path");
 
 if (!global.MathJax) global.MathJax = {};
-global.MathJax.__dirname =  path.dirname(new URL(import.meta.url).pathname);
+global.MathJax.__dirname = path.dirname(new URL(import.meta.url).pathname);
diff --git a/components/mjs/node-main/node-main.js b/components/mjs/node-main/node-main.js
@@ -23,14 +23,15 @@ import '../startup/init.js';
 import {Loader, CONFIG} from '#js/components/loader.js';
 import {Package} from '#js/components/package.js';
 import {combineDefaults, combineConfig} from '#js/components/global.js';
+import {context} from '#js/util/context.js';
 import '../core/core.js';
 import '../adaptors/liteDOM/liteDOM.js';
 import {source} from '../source.js';
 
 const MathJax = global.MathJax;
 
 const path = eval('require("path")');   // get path from node, not webpack
-const dir = MathJax.config.__dirname;   // set up by node-main.mjs or node-main.cjs
+const dir = context.path(MathJax.config.__dirname);   // set up by node-main.mjs or node-main.cjs
 
 /*
  * Set up the initial configuration
diff --git a/components/mjs/source-lab.js b/components/mjs/source-lab.js
@@ -15,4 +15,4 @@
  *  limitations under the License.
  */
 
-export const src = String(new URL('.', import.meta.url)).replace(/\/$/, '');
+export const dirname = String(new URL('.', import.meta.url)).replace(/\/$/, '');
diff --git a/components/mjs/source.cjs b/components/mjs/source.cjs
@@ -15,4 +15,4 @@
  *  limitations under the License.
  */
 
-module.exports.src = __dirname;
+module.exports.dirname = __dirname;
diff --git a/components/mjs/source.d.cts b/components/mjs/source.d.cts
@@ -1 +1 @@
-export declare const src: string;
+export declare const dirname: string;
diff --git a/components/mjs/source.js b/components/mjs/source.js
@@ -15,7 +15,9 @@
  *  limitations under the License.
  */
 
-import {src} from '#source/source.cjs';
+import {dirname} from '#source/source.cjs';
+import {context} from '#js/util/context.js';
+const src = context.path(dirname);
 
 export const source = {
   'core': `${src}/core/core.js`,
diff --git a/testsuite/tests/util/Context-android.test.ts b/testsuite/tests/util/Context-android.test.ts
@@ -7,6 +7,8 @@ describe('context object', () => {
 
   test('context', async () => {
     let {context, hasWindow} = await import("#js/util/context.js");
+    expect(context.path('C:\\test.js')).toBe('C:\\test.js');
+    delete context.path;
     expect(context).toEqual({window: window, document: window.document, os: 'Unix'});
     expect(hasWindow).toBe(true);
   });
diff --git a/testsuite/tests/util/Context-browser.test.ts b/testsuite/tests/util/Context-browser.test.ts
@@ -7,6 +7,8 @@ describe('context object', () => {
 
   test('context', async () => {
     let {context, hasWindow} = await import("#js/util/context.js");
+    expect(context.path('C:\\test.js')).toBe('C:\\test.js');
+    delete context.path;
     expect(context).toEqual({window: window, document: window.document, os: 'Unix'});
     expect(hasWindow).toBe(true);
   });
diff --git a/testsuite/tests/util/Context-node-unknown.test.ts b/testsuite/tests/util/Context-node-unknown.test.ts
@@ -0,0 +1,15 @@
+import { describe, test, expect } from '@jest/globals';
+
+global.process = {...process, platform: 'test'} as any;
+
+describe('context object', () => {
+
+  test('context', async () => {
+    let {context, hasWindow} = await import("#js/util/context.js");
+    expect(context.path('C:\\test.js')).toBe('C:\\test.js');
+    delete context.path;
+    expect(context).toEqual({window: null, document: null, os: 'test'});
+    expect(hasWindow).toBe(false);
+  });
+
+});
diff --git a/testsuite/tests/util/Context-node.test.ts b/testsuite/tests/util/Context-node.test.ts
@@ -1,10 +1,30 @@
 import { describe, test, expect } from '@jest/globals';
 import { context, hasWindow } from '#js/util/context.js';
 
+const OS = {
+  'linux': 'Unix',
+  'android': 'Unix',
+  'aix': 'Unix',
+  'freebsd': 'Unix',
+  'netbsd': 'Unix',
+  'openbsd': 'Unix',
+  'sunos': 'Unix',
+  'darwin': 'MacOS',
+  'win32': 'Windows',
+  'cygwin': 'Windows',
+  'haiku': 'unknown',
+}[process.platform] || process.platform;
+
 describe('context object', () => {
 
   test('context', () => {
-    expect(context).toEqual({window: null, document: null, os: 'unknown'});
+    if (process.platform as string === 'Windows') {
+      expect(context.path('C:\\test.js')).toBe('C:/test.js');
+    } else {
+      expect(context.path('C:\\test.js')).toBe('C:\\test.js');
+    }
+    delete context.path;
+    expect(context).toEqual({window: null, document: null, os: OS});
     expect(hasWindow).toBe(false);
   });
 
diff --git a/testsuite/tests/util/Context-unknown.test.ts b/testsuite/tests/util/Context-unknown.test.ts
@@ -0,0 +1,16 @@
+import { describe, test, expect } from '@jest/globals';
+
+const window = {document: {}, navigator: {userAgent: '', appVersion: ''}};
+(global as any).window = window;
+
+describe('context object', () => {
+
+  test('context', async () => {
+    let {context, hasWindow} = await import("#js/util/context.js");
+    expect(context.path('C:\\test.js')).toBe('C:\\test.js');
+    delete context.path;
+    expect(context).toEqual({window: window, document: window.document, os: 'unknown'});
+    expect(hasWindow).toBe(true);
+  });
+
+});
diff --git a/testsuite/tests/util/Context-windows.test.ts b/testsuite/tests/util/Context-windows.test.ts
@@ -0,0 +1,18 @@
+import { describe, test, expect } from '@jest/globals';
+
+const window = {document: {}, navigator: {appVersion: 'Win'}};
+(global as any).window = window;
+
+describe('context object', () => {
+
+  test('context', async () => {
+    let {context, hasWindow} = await import("#js/util/context.js");
+    expect(context.path('C:\\test.js')).toBe('C:/test.js');
+    expect(context.path('/C:/test.js')).toBe('C:/test.js');
+    expect(context.path('/test.js')).toBe('/test.js');
+    delete context.path;
+    expect(context).toEqual({window: window, document: window.document, os: 'Windows'});
+    expect(hasWindow).toBe(true);
+  });
+
+});
diff --git a/ts/components/cjs/root.ts b/ts/components/cjs/root.ts
@@ -25,10 +25,13 @@
  * The location of this file
  */
 declare const __dirname: string;
+declare const require: (file: string) => any;
 
 /**
  * @return {string}   The MathJax component root directory
  */
 export function mjxRoot(): string {
-  return __dirname.replace(/[cm]js\/components\/[cm]js$/, 'bundle');
+  return require('../../util/context.js')
+    .context.path(__dirname)
+    .replace(/[cm]js\/components\/[cm]js$/, 'bundle');
 }
diff --git a/ts/components/cjs/sre-root.ts b/ts/components/cjs/sre-root.ts
@@ -25,10 +25,13 @@
  * The location of this file
  */
 declare const __dirname: string;
+declare const require: (file: string) => any;
 
 /**
- * @return {string}   The MathJax mjs SRE root directory
+ * @return {string}   The MathJax cjs SRE root directory
  */
 export function sreRoot(): string {
-  return __dirname.replace(/components\/[cm]js$/, 'a11y/sre');
+  return require('../../util/context.js')
+    .context.path(__dirname)
+    .replace(/components\/[cm]js$/, 'a11y/sre');
 }
diff --git a/ts/components/loader.ts b/ts/components/loader.ts
@@ -120,7 +120,7 @@ export const PathFilters: { [name: string]: PathFilterFunction } = {
    */
   normalize: (data) => {
     const name = data.name;
-    if (!name.match(/^(?:[a-z]+:\/)?\/|[a-z]:\\|\[/i)) {
+    if (!name.match(/^(?:[a-z]+:\/)?\/|[a-z]:[/\\]|\[/i)) {
       data.name = '[mathjax]/' + name.replace(/^\.\//, '');
     }
     return true;
diff --git a/ts/components/mjs/root.ts b/ts/components/mjs/root.ts
@@ -21,12 +21,13 @@
  * @author dpvc@mathjax.org (Davide Cervone)
  */
 
+import { context } from '../../util/context.js';
+
 /**
  * @returns {string}   The MathJax component root directory
  */
 export function mjxRoot(): string {
-  return new URL(import.meta.url).pathname.replace(
-    /[cm]js\/components\/[cm]js\/root.js$/,
-    'bundle'
-  );
+  return context
+    .path(new URL(import.meta.url).pathname)
+    .replace(/[cm]js\/components\/[cm]js\/root.js$/, 'bundle');
 }
diff --git a/ts/components/mjs/sre-root.ts b/ts/components/mjs/sre-root.ts
@@ -21,12 +21,13 @@
  * @author dpvc@mathjax.org (Davide Cervone)
  */
 
+import { context } from '../../util/context.js';
+
 /**
  * @returns {string}   The MathJax mjs SRE root directory
  */
 export function sreRoot(): string {
-  return new URL(import.meta.url).pathname.replace(
-    /components\/[cm]js\/sre-root.js$/,
-    'a11y/sre'
-  );
+  return context
+    .path(new URL(import.meta.url).pathname)
+    .replace(/components\/[cm]js\/sre-root.js$/, 'a11y/sre');
 }
diff --git a/ts/util/asyncLoad/node-import.cjs b/ts/util/asyncLoad/node-import.cjs
@@ -23,9 +23,9 @@
 
 const { mathjax } = require('../../mathjax.js');
 const path = require('path');
-const { src } = require('#source/source.cjs');
+const { dirname } = require('#source/source.cjs');
 
-let root = path.resolve(src, '..', '..', 'cjs');
+let root = path.resolve(dirname, '..', '..', 'cjs');
 
 if (!mathjax.asyncLoad) {
   mathjax.asyncLoad = async (name) => {
diff --git a/ts/util/asyncLoad/node.ts b/ts/util/asyncLoad/node.ts
@@ -23,11 +23,11 @@
 
 import { mathjax } from '../../mathjax.js';
 import * as path from 'path';
-import { src } from '#source/source.cjs';
+import { dirname } from '#source/source.cjs';
 
 declare const require: (name: string) => any;
 
-let root = path.resolve(src, '..', '..', 'cjs');
+let root = path.resolve(dirname, '..', '..', 'cjs');
 
 if (!mathjax.asyncLoad && typeof require !== 'undefined') {
   mathjax.asyncLoad = (name: string) => {
diff --git a/ts/util/context.ts b/ts/util/context.ts
@@ -21,6 +21,8 @@
  * @author dpvc@mathjax.org (Davide Cervone)
  */
 
+declare const process: { platform: string };
+
 /**
  * True if there is a window object
  */
@@ -49,7 +51,30 @@ export const context = {
       if (window.navigator.userAgent.includes('Android')) {
         return 'Unix';
       }
+    } else if (typeof process !== 'undefined') {
+      return (
+        {
+          linux: 'Unix',
+          android: 'Unix',
+          aix: 'Unix',
+          freebsd: 'Unix',
+          netbsd: 'Unix',
+          openbsd: 'Unix',
+          sunos: 'Unix',
+          darwin: 'MacOS',
+          win32: 'Windows',
+          cygwin: 'Windows',
+        }[process.platform] || process.platform
+      );
     }
     return 'unknown';
   })(),
+  path: (file: string) => file,
 };
+
+if (context.os === 'Windows') {
+  context.path = (file: string) =>
+    file.match(/^[/\\]?[a-zA-Z]:[/\\]/)
+      ? file.replace(/\\/g, '/').replace(/^\//, '')
+      : file;
+}

Original file line number	Diff line number	Diff line change
`@@ -1 +1 @@`
`1`		`-export declare const src: string;`
	`1`	`+export declare const dirname: string;`