Merge pull request #1109 from mathjax/better-asyncLoad

dpvc · web-flow · commit e9156ba59436 · 2024-06-27T10:47:12.000-04:00
Update the asyncLoad implementations to be more consistent, and update tests.
diff --git a/testsuite/tests/util/asyncLoad/esm.test.ts b/testsuite/tests/util/asyncLoad/esm.test.ts
@@ -1,10 +1,11 @@
 import { describe, test, expect } from '@jest/globals';
+import {mathjax} from '#js/mathjax.js';
 import {asyncLoad} from '#js/util/AsyncLoad.js';
 import {setBaseURL} from '#js/util/asyncLoad/esm.js';
 import * as path from 'path';
 
-const root = new URL(path.resolve('..', 'mjs'), 'file://').href;
-const lib = new URL(path.resolve('lib'), 'file://').href;
+const root = path.resolve('..', 'mjs');
+const lib = path.resolve('lib');
 
 describe('asyncLoad() for esm', () => {
 
@@ -20,10 +21,16 @@ describe('asyncLoad() for esm', () => {
     await expect(asyncLoad(absFile)).resolves.toEqual({loaded: true});          // absolute file found
     await expect(asyncLoad(absUnknown).catch(() => true)).resolves.toBe(true);  // absolute file not found
 
+    await expect(asyncLoad('#js/components/version.js')                         // load using package exports
+                 .then((result: any) => result.VERSION)).resolves.toBe(mathjax.version);
+    await expect(asyncLoad('mathjax-full/js/components/version.js')             // load from module
+                 .then((result: any) => result.VERSION)).resolves.toBe(mathjax.version);
+
     await expect(asyncLoad(mjsFile).then((result: any) => result.loaded)).resolves.toBe(true);  // mjs file loads
+    expect(mathjax.asyncIsSynchronous).toBe(false);                             // esm.js is asynchronous
   });
 
-  test('serBaseURL() for esm', async () => {
+  test('setBaseURL() for esm', async () => {
     setBaseURL(lib);
     const relFile = './AsyncLoad.child.cjs';
     const relUnknown = './AsyncLoad.unknown.cjs';
diff --git a/testsuite/tests/util/asyncLoad/node.test.ts b/testsuite/tests/util/asyncLoad/node.test.ts
@@ -1,6 +1,7 @@
 import { describe, test, expect } from '@jest/globals';
 import './dirname.mjs';
 import '#source/../require.mjs';
+import {mathjax} from '#js/mathjax.js';
 import {asyncLoad} from '#js/util/AsyncLoad.js';
 import {setBaseURL} from '#js/util/asyncLoad/node.js';
 import * as path from 'path';
@@ -22,10 +23,16 @@ describe('asyncLoad() for node', () => {
     await expect(asyncLoad(absFile)).resolves.toEqual({loaded: true});          // absolute file found
     await expect(asyncLoad(absUnknown).catch(() => true)).resolves.toBe(true);  // absolute file not found
 
+    await expect(asyncLoad('#js/../cjs/components/version.js')                  // load using package exports
+                 .then((result: any) => result.VERSION)).resolves.toBe(mathjax.version);
+    await expect(asyncLoad('mathjax-full/js/components/version.js')             // load from module
+                 .then((result: any) => result.VERSION)).resolves.toBe(mathjax.version);
+
     await expect(asyncLoad(mjsFile).catch(() => true)).resolves.toBe(true);     // mjs file fails
+    expect(mathjax.asyncIsSynchronous).toBe(true);                              // node.js is synchronous
   });
 
-  test('serBaseURL() for node', async () => {
+  test('setBaseURL() for node', async () => {
     setBaseURL(lib);
     const relFile = './AsyncLoad.child.cjs';
     const relUnknown = './AsyncLoad.unknown.cjs';
diff --git a/testsuite/tests/util/asyncLoad/system.test.ts b/testsuite/tests/util/asyncLoad/system.test.ts
@@ -1,12 +1,13 @@
 import { describe, test, expect } from '@jest/globals';
 import './dirname.mjs';
 import './system.cjs';
+import {mathjax} from '#js/mathjax.js';
 import {asyncLoad} from '#js/util/AsyncLoad.js';
 import {setBaseURL} from '#js/util/asyncLoad/system.js';
 import * as path from 'path';
 
-const root = new URL(path.resolve('..', 'mjs'), 'file://').href;
-const lib = new URL(path.resolve('lib'), 'file://').href;
+const root = path.resolve('..', 'mjs');
+const lib = path.resolve('lib');
 
 describe('asyncLoad() for node', () => {
 
@@ -22,10 +23,16 @@ describe('asyncLoad() for node', () => {
     await expect(asyncLoad(absFile)).resolves.toEqual({loaded: true});          // absolute file found
     await expect(asyncLoad(absUnknown).catch(() => true)).resolves.toBe(true);  // absolute file not found
 
+    await expect(asyncLoad('#js/components/version.js')                         // can't load using package exports
+                 .catch(() => true)).resolves.toBe(true);
+    await expect(asyncLoad('mathjax-full/js/components/version.js')             // can't load from module
+                 .catch(() => true)).resolves.toBe(true);
+
     await expect(asyncLoad(mjsFile).then((result: any) => result.loaded)).resolves.toBe(true);  // mjs file loads
+    expect(mathjax.asyncIsSynchronous).toBe(false);                             // system.js is asynchronous
   });
 
-  test('serBaseURL() for node', async () => {
+  test('setBaseURL() for node', async () => {
     setBaseURL(lib);
     const relFile = './AsyncLoad.child.cjs';
     const relUnknown = './AsyncLoad.unknown.cjs';
diff --git a/ts/mathjax.ts b/ts/mathjax.ts
@@ -64,4 +64,8 @@ export const mathjax = {
    */
   asyncLoad: null as ((file: string) => any),
 
+  /**
+   * When asyncLoad uses require(), it actually operates synchronously and this is true
+   */
+  asyncIsSynchronous: false,
 };
diff --git a/ts/output/common/FontData.ts b/ts/output/common/FontData.ts
@@ -22,11 +22,11 @@
  * @author dpvc@mathjax.org (Davide Cervone)
  */
 
+import {mathjax} from '../../mathjax.js';
 import {OptionList, defaultOptions, userOptions} from '../../util/Options.js';
 import {StyleList} from '../../util/StyleList.js';
 import {asyncLoad} from '../../util/AsyncLoad.js';
 import {retryAfter} from '../../util/Retries.js';
-import {mathjax} from '../../mathjax.js';
 import {DIRECTION} from './Direction.js';
 export {DIRECTION} from './Direction.js';
 
@@ -1101,7 +1101,7 @@ export class FontData<C extends CharOptions, V extends VariantData<C>, D extends
     const prefix = (!dynamic.extension ? this.options.dynamicPrefix :
                     this.CLASS.dynamicExtensions.get(dynamic.extension).prefix);
     return (dynamic.file.match(/^(?:[\/\[]|[a-z]+:\/\/|[a-z]:)/i) ? dynamic.file :
-      prefix + '/' + dynamic.file.replace(/\.js$/, ''));
+      prefix + '/' + dynamic.file.replace(/(?<!\.js)$/, '.js'));
   }
 
   /**
@@ -1141,8 +1141,9 @@ export class FontData<C extends CharOptions, V extends VariantData<C>, D extends
    *   synchronous loading function, as in util/asyncLoad/node.ts.
    */
   public loadDynamicFilesSync() {
-    if (!mathjax.asyncLoad) {
-      throw Error('MathJax(loadDynamicFilesSync): mathjax.asyncLoad must be specified and synchronous');
+    if (!mathjax.asyncIsSynchronous) {
+      throw Error('MathJax(loadDynamicFilesSync): mathjax.asyncLoad must be specified and synchronous\n' +
+                 '    Try importing #js/../components/require.mjs and #js/util/asyncLoad/node.js');
     }
     const dynamicFiles = this.CLASS.dynamicFiles;
     Object.keys(dynamicFiles).forEach(name => this.loadDynamicFileSync(dynamicFiles[name]));
diff --git a/ts/util/AsyncLoad.ts b/ts/util/AsyncLoad.ts
@@ -31,7 +31,7 @@ import {mathjax} from '../mathjax.js';
  */
 export function asyncLoad(name: string): Promise<any> {
   if (!mathjax.asyncLoad) {
-    return Promise.reject(`Can't load '${name}': No asyncLoad method specified`);
+    return Promise.reject(`Can't load '${name}': No mathjax.asyncLoad method specified`);
   }
   return new Promise((ok, fail) => {
     const result = mathjax.asyncLoad(name);
diff --git a/ts/util/asyncLoad/esm.ts b/ts/util/asyncLoad/esm.ts
@@ -27,15 +27,16 @@ let root = new URL(import.meta.url).href.replace(/\/util\/asyncLoad\/esm.js$/, '
 
 if (!mathjax.asyncLoad) {
   mathjax.asyncLoad = async (name: string) => {
-    return import(new URL(name, root).href).then((result) => result?.default || result);
+    const file = (name.charAt(0) === '.' ? new URL(name, root).pathname : name);
+    return import(file).then((result) => result?.default || result);
   };
 }
 
 /**
- * @param {string} URL   the base URL to use for loading relative paths
+ * @param {string} url   the base URL to use for loading relative paths
  */
-export function setBaseURL(URL: string) {
-  root = URL;
+export function setBaseURL(url: string) {
+  root = new URL(url, 'file://').href;
   if (!root.match(/\/$/)) {
     root += '/';
   }
diff --git a/ts/util/asyncLoad/node.ts b/ts/util/asyncLoad/node.ts
@@ -23,18 +23,20 @@
 
 import {mathjax} from '../../mathjax.js';
 import * as path from 'path';
+import {src} from '#source/source.cjs';
 
 declare var require: (name: string) => any;
-declare var __dirname: string;
 
-let root = path.dirname(path.dirname(__dirname));
+let root = path.resolve(src, '..', '..', 'cjs');
 
 if (!mathjax.asyncLoad && typeof require !== 'undefined') {
   mathjax.asyncLoad = (name: string) => {
     return require(name.charAt(0) === '.' ? path.resolve(root, name) : name);
   };
+  mathjax.asyncIsSynchronous = true;
 }
 
+
 /**
  * @param {string} URL   the base URL to use for loading relative paths
  */
diff --git a/ts/util/asyncLoad/path.d.ts b/ts/util/asyncLoad/path.d.ts
@@ -1,4 +1,4 @@
 declare module 'path' {
     export function dirname(dir: string): string;
-    export function resolve(root: string, name: string): string;
+    export function resolve(root: string, ...name: string[]): string;
 }
diff --git a/ts/util/asyncLoad/system.ts b/ts/util/asyncLoad/system.ts
@@ -30,15 +30,16 @@ let root = 'file://' + __dirname.replace(/\/[^\/]*\/[^\/]*$/, '/');
 
 if (!mathjax.asyncLoad && typeof System !== 'undefined' && System.import) {
   mathjax.asyncLoad = (name: string) => {
-    return System.import(name, root).then((result: any) => result?.default || result);
+    const file = (name.charAt(0) === '.' ? new URL(name, root) : new URL(name, 'file://')).href;
+    return System.import(file).then((result: any) => result?.default || result);
   };
 }
 
 /**
- * @param {string} URL   the base URL to use for loading relative paths
+ * @param {string} url   the base URL to use for loading relative paths
  */
-export function setBaseURL(URL: string) {
-  root = URL;
+export function setBaseURL(url: string) {
+  root = new URL(url, 'file://').href;
   if (!root.match(/\/$/)) {
     root += '/';
   }

Original file line number	Diff line number	Diff line change
`@@ -31,7 +31,7 @@ import {mathjax} from '../mathjax.js';`
`31`	`31`	`*/`
`32`	`32`	`export function asyncLoad(name: string): Promise<any> {`
`33`	`33`	`if (!mathjax.asyncLoad) {`
`34`		- return Promise.reject(`Can't load '${name}': No asyncLoad method specified`);
	`34`	+ return Promise.reject(`Can't load '${name}': No mathjax.asyncLoad method specified`);
`35`	`35`	`}`
`36`	`36`	`return new Promise((ok, fail) => {`
`37`	`37`	`const result = mathjax.asyncLoad(name);`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`	`1`	`declare module 'path' {`
`2`	`2`	`export function dirname(dir: string): string;`
`3`		`- export function resolve(root: string, name: string): string;`
	`3`	`+ export function resolve(root: string, ...name: string[]): string;`
`4`	`4`	`}`