Remove MathJax v2 (#16961)

GitOrigin-RevId: 32a43361cfc883aa1a5ed85f6be5432b6e838b9d
This commit is contained in:
Alf Eaton 2024-02-08 09:34:07 +00:00 committed by Copybot
parent 2566dff9d8
commit c997d1dc2b
19 changed files with 73 additions and 204 deletions

21
package-lock.json generated
View file

@ -30914,13 +30914,6 @@
"dev": true
},
"node_modules/mathjax": {
"version": "2.7.9",
"resolved": "https://registry.npmjs.org/mathjax/-/mathjax-2.7.9.tgz",
"integrity": "sha512-NOGEDTIM9+MrsqnjPEjVGNx4q0GQxqm61yQwSK+/5S59i26wId5IC5gNu9/bu8+CCVl5p9G2IHcAl/wJa+5+BQ==",
"dev": true
},
"node_modules/mathjax-3": {
"name": "mathjax",
"version": "3.2.2",
"resolved": "https://registry.npmjs.org/mathjax/-/mathjax-3.2.2.tgz",
"integrity": "sha512-Bt+SSVU8eBG27zChVewOicYs7Xsdt40qm4+UpHyX7k0/O9NliPc+x77k1/FEsPsjKPZGJvtRZM1vO+geW0OhGw==",
@ -46261,8 +46254,7 @@
"less": "^3.13.1",
"less-loader": "^11.1.3",
"match-sorter": "^6.2.0",
"mathjax": "^2.7.9",
"mathjax-3": "npm:mathjax@^3.2.2",
"mathjax": "^3.2.2",
"mensch": "^0.3.4",
"mini-css-extract-plugin": "^2.7.6",
"mocha": "^10.2.0",
@ -55142,8 +55134,7 @@
"mailchimp-api-v3": "^1.12.0",
"marked": "^4.1.0",
"match-sorter": "^6.2.0",
"mathjax": "^2.7.9",
"mathjax-3": "npm:mathjax@^3.2.2",
"mathjax": "^3.2.2",
"mensch": "^0.3.4",
"method-override": "^2.3.3",
"mini-css-extract-plugin": "^2.7.6",
@ -74114,13 +74105,7 @@
"dev": true
},
"mathjax": {
"version": "2.7.9",
"resolved": "https://registry.npmjs.org/mathjax/-/mathjax-2.7.9.tgz",
"integrity": "sha512-NOGEDTIM9+MrsqnjPEjVGNx4q0GQxqm61yQwSK+/5S59i26wId5IC5gNu9/bu8+CCVl5p9G2IHcAl/wJa+5+BQ==",
"dev": true
},
"mathjax-3": {
"version": "npm:mathjax@3.2.2",
"version": "3.2.2",
"resolved": "https://registry.npmjs.org/mathjax/-/mathjax-3.2.2.tgz",
"integrity": "sha512-Bt+SSVU8eBG27zChVewOicYs7Xsdt40qm4+UpHyX7k0/O9NliPc+x77k1/FEsPsjKPZGJvtRZM1vO+geW0OhGw==",
"dev": true

View file

@ -1,7 +1,6 @@
const logger = require('@overleaf/logger')
const Metrics = require('@overleaf/metrics')
const Settings = require('@overleaf/settings')
const querystring = require('querystring')
const _ = require('lodash')
const { URL } = require('url')
const Path = require('path')
@ -186,14 +185,7 @@ module.exports = function (webRouter, privateApiRouter, publicApiRouter) {
return chunks.map(chunk => staticFilesBase + chunk)
}
res.locals.mathJaxPath = `/js/libs/mathjax/MathJax.js?${querystring.stringify(
{
config: 'TeX-AMS_HTML,Safe',
v: PackageVersions.version.mathjax,
}
)}`
res.locals.mathJax3Path = `/js/libs/mathjax-3-${PackageVersions.version['mathjax-3']}/es5/tex-svg-full.js`
res.locals.mathJaxPath = `/js/libs/mathjax-${PackageVersions.version.mathjax}/es5/tex-svg-full.js`
res.locals.lib = PackageVersions.lib

View file

@ -1,7 +1,5 @@
const version = {
// Upgrade instructions: https://github.com/overleaf/write_latex/wiki/Upgrading-Ace
mathjax: '2.7.9',
'mathjax-3': '3.2.2',
mathjax: '3.2.2',
}
module.exports = {

View file

@ -37,6 +37,7 @@ html(
//- Configure dynamically loaded assets (via webpack) to be downloaded from CDN
//- See: https://webpack.js.org/guides/public-path/#on-the-fly
meta(name="ol-baseAssetPath" content=buildBaseAssetPath())
meta(name="ol-mathJaxPath" content=mathJaxPath)
meta(name="ol-usersEmail" content=getUserEmail())
meta(name="ol-ab" data-type="json" content={})

View file

@ -33,7 +33,6 @@ meta(name="ol-showTemplatesServerPro", data-type="boolean" content=showTemplates
meta(name="ol-showPersonalAccessToken", data-type="boolean" content=showPersonalAccessToken)
meta(name="ol-optionalPersonalAccessToken", data-type="boolean" content=optionalPersonalAccessToken)
meta(name="ol-hasTrackChangesFeature", data-type="boolean" content=hasTrackChangesFeature)
meta(name="ol-mathJax3Path" content=mathJax3Path)
meta(name="ol-inactiveTutorials", data-type="json" content=user.inactiveTutorials)
meta(name="ol-projectTags" data-type="json" content=projectTags)
meta(name="ol-idePageReact", data-type="boolean" content=idePageReact)

View file

@ -24,9 +24,9 @@ window.MathJax = {
export const interceptMathJax = () => {
// NOTE: this is just a URL to be intercepted with the stub, not the real (versioned) MathJax URL
const url = '/js/libs/mathjax-3/es5/tex-svg-full.js'
const url = '/js/libs/mathjax/es5/tex-svg-full.js'
cy.window().then(win => {
win.metaAttributesCache.set('ol-mathJax3Path', url)
win.metaAttributesCache.set('ol-mathJaxPath', url)
})
cy.intercept('GET', url, MATHJAX_STUB).as('mathjax-load-request')
}

View file

@ -22,7 +22,6 @@ import './modules/errorCatcher'
import './modules/localStorage'
import './modules/sessionStorage'
import getMeta from './utils/meta'
import { configureMathJax } from './features/mathjax/configure'
const App = angular
.module('OverleafApp', [
@ -40,8 +39,6 @@ const App = angular
function ($qProvider, uiSelectConfig) {
$qProvider.errorOnUnhandledRejections(false)
uiSelectConfig.spinnerClass = 'fa fa-refresh ui-select-spin'
configureMathJax()
},
])

View file

@ -1,15 +0,0 @@
/* global MathJax */
import App from '../base'
export default App.directive('mathjax', function () {
return {
link(scope, element, attrs) {
if (!(MathJax && MathJax.Hub)) return
setTimeout(() => {
MathJax.Hub.Queue(['Typeset', MathJax.Hub, element.get(0)])
}, 0)
},
}
})

View file

@ -1,8 +1,6 @@
import { useRef, useEffect, type FC } from 'react'
// @ts-ignore
import Linkify from 'react-linkify'
import useIsMounted from '../../../shared/hooks/use-is-mounted'
import { configureMathJax } from '../../mathjax/configure'
import { loadMathJax } from '../../mathjax/load-mathjax'
import { debugConsole } from '@/utils/debugging'
@ -18,18 +16,6 @@ const MessageContent: FC<{ content: string }> = ({ content }) => {
a.setAttribute('rel', 'noreferrer noopener')
}
// MathJax v2 typesetting
if (window.MathJax?.Hub) {
const { Hub } = window.MathJax
const timeout = setTimeout(() => {
configureMathJax()
Hub.Queue(['Typeset', Hub, root.current])
}, 0)
return () => clearTimeout(timeout)
}
// MathJax v3 typesetting
loadMathJax()
.then(MathJax => {

View file

@ -1,49 +0,0 @@
/* global MathJax */
import { mathJaxLoaded } from './util'
import getMeta from '../../utils/meta'
let configured = false
export function configureMathJax() {
if (configured) return
if (getMeta('ol-mathJax3Path')) return
if (!mathJaxLoaded()) return
const inlineMath = [['\\(', '\\)']]
if (!getMeta('ol-no-single-dollar')) {
inlineMath.push(['$', '$'])
}
MathJax.Hub.Config({
messageStyle: 'none',
imageFont: null,
// Fast preview, introduced in 2.5, is unhelpful due to extra codemirror refresh
// and disabling it avoids issues with math processing errors
// github.com/overleaf/write_latex/pull/1375
'fast-preview': { disabled: true },
'HTML-CSS': {
availableFonts: ['TeX'],
// MathJax's automatic font scaling does not work well when we render math
// that isn't yet on the page, so we disable it and set a global font
// scale factor
scale: 110,
matchFontHeight: false,
},
TeX: {
equationNumbers: { autoNumber: 'AMS' },
useLabelIDs: false,
},
skipStartupTypeset: true,
tex2jax: {
processEscapes: true,
inlineMath,
displayMath: [
['$$', '$$'],
['\\[', '\\]'],
],
},
})
configured = true
}

View file

@ -1,14 +0,0 @@
/* global MathJax */
import { configureMathJax } from './configure'
import { mathJaxLoaded } from './util'
function render(el) {
if (!mathJaxLoaded()) return
configureMathJax()
setTimeout(() => {
MathJax.Hub.Queue(['Typeset', MathJax.Hub, el])
}, 0)
}
document.querySelectorAll('[data-ol-mathjax]').forEach(render)

View file

@ -0,0 +1,17 @@
import { loadMathJax } from '@/features/mathjax/load-mathjax'
import { debugConsole } from '@/utils/debugging'
import getMeta from '@/utils/meta'
window.addEventListener('DOMContentLoaded', function () {
const elements = document.querySelectorAll('[data-ol-mathjax]')
if (elements.length > 0) {
loadMathJax({
enableMenu: true,
numbering: 'ams',
singleDollar: !getMeta('ol-no-single-dollar'),
useLabelIds: true,
})
.then(MathJax => MathJax.typesetPromise([...elements]))
.catch(debugConsole.error)
}
})

View file

@ -2,9 +2,26 @@ import getMeta from '../../utils/meta'
let mathJaxPromise: Promise<typeof window.MathJax>
export const loadMathJax = async () => {
export const loadMathJax = async (options?: {
enableMenu?: boolean
numbering?: string
singleDollar?: boolean
useLabelIds?: boolean
}) => {
if (!mathJaxPromise) {
mathJaxPromise = new Promise((resolve, reject) => {
options = {
enableMenu: false,
singleDollar: true,
useLabelIds: false,
...options,
}
const inlineMath = [['\\(', '\\)']]
if (options.singleDollar) {
inlineMath.push(['$', '$'])
}
// https://docs.mathjax.org/en/v3.2-latest/upgrading/v2.html
window.MathJax = {
// https://docs.mathjax.org/en/latest/options/input/tex.html#the-configuration-block
@ -14,10 +31,7 @@ export const loadMathJax = async () => {
// https://github.com/mathjax/MathJax/issues/1219#issuecomment-341059843
bm: ['\\boldsymbol{#1}', 1],
},
inlineMath: [
['\\(', '\\)'],
['$', '$'],
],
inlineMath,
displayMath: [
['\\[', '\\]'],
['$$', '$$'],
@ -30,6 +44,8 @@ export const loadMathJax = async () => {
},
processEscapes: true,
processEnvironments: true,
useLabelIds: options.useLabelIds,
tags: options.numbering,
},
loader: {
load: [
@ -37,15 +53,22 @@ export const loadMathJax = async () => {
],
},
options: {
enableMenu: false, // https://docs.mathjax.org/en/latest/options/menu.html
enableMenu: options.enableMenu, // https://docs.mathjax.org/en/latest/options/menu.html
},
startup: {
typeset: false,
pageReady() {
// disable the "Math Renderer" option in the context menu,
// as only SVG is available
window.MathJax.startup.document.menu.menu
.findID('Renderer')
.disable()
},
},
}
const script = document.createElement('script')
const path = getMeta('ol-mathJax3Path')
const path = getMeta('ol-mathJaxPath')
if (!path) {
reject(new Error('No MathJax path found'))
return

View file

@ -1,5 +0,0 @@
/* global MathJax */
export function mathJaxLoaded() {
return !!(typeof MathJax !== 'undefined' && MathJax && MathJax.Hub)
}

View file

@ -12,6 +12,7 @@ import './features/fallback-image'
import './features/multi-submit'
import './features/cookie-banner'
import './features/autoplay-video'
import './features/mathjax'
$('[data-ol-lang-selector-tooltip]').tooltip({ trigger: 'hover' })
$('[data-toggle="tooltip"]').tooltip()

View file

@ -1,4 +1,3 @@
import { useEffect } from 'react'
import ChatPane from '../js/features/chat/components/chat-pane'
import useFetchMock from './hooks/use-fetch-mock'
import { generateMessages } from './fixtures/chat-messages'
@ -47,23 +46,5 @@ export default {
args: {
resetUnreadMessages: () => {},
},
decorators: [
ScopeDecorator,
Story => {
useEffect(() => {
window.MathJax = {
Hub: {
Queue: () => {},
config: { tex2jax: { inlineMath: [['$', '$']] } },
},
}
return () => {
delete window.MathJax
}
}, [])
return <Story />
},
],
decorators: [ScopeDecorator],
}

View file

@ -142,7 +142,7 @@ export const Visual = (args: any, { globals: { theme } }: any) => {
})
useMeta({
'ol-showSymbolPalette': true,
'ol-mathJax3Path': 'https://unpkg.com/mathjax@3.2.2/es5/tex-svg-full.js',
'ol-mathJaxPath': 'https://unpkg.com/mathjax@3.2.2/es5/tex-svg-full.js',
'ol-inactiveTutorials': ['table-generator-promotion'],
'ol-project_id': '63e21c07946dd8c76505f85a',
})

View file

@ -303,8 +303,7 @@
"less": "^3.13.1",
"less-loader": "^11.1.3",
"match-sorter": "^6.2.0",
"mathjax": "^2.7.9",
"mathjax-3": "npm:mathjax@^3.2.2",
"mathjax": "^3.2.2",
"mensch": "^0.3.4",
"mini-css-extract-plugin": "^2.7.6",
"mocha": "^10.2.0",

View file

@ -64,7 +64,6 @@ function getModuleDirectory(moduleName) {
}
const mathjaxDir = getModuleDirectory('mathjax')
const mathjax3Dir = getModuleDirectory('mathjax-3')
const pdfjsVersions = ['pdfjs-dist213', 'pdfjs-dist401']
@ -77,13 +76,6 @@ if (MATHJAX_VERSION !== PackageVersions.version.mathjax) {
)
}
const MATHJAX_3_VERSION = require('mathjax-3/package.json').version
if (MATHJAX_3_VERSION !== PackageVersions.version['mathjax-3']) {
throw new Error(
'"mathjax-3" version de-synced, update services/web/app/src/infrastructure/PackageVersions.js'
)
}
module.exports = {
// Defines the "entry point(s)" for the application - i.e. the file which
// bootstraps the application
@ -277,57 +269,38 @@ module.exports = {
// https://www.npmjs.com/package/mathjax#user-content-hosting-your-own-copy-of-the-mathjax-components
{
from: 'es5/tex-svg-full.js',
to: `js/libs/mathjax-3-${PackageVersions.version['mathjax-3']}/es5`,
to: `js/libs/mathjax-${PackageVersions.version.mathjax}/es5`,
toType: 'dir',
context: mathjax3Dir,
context: mathjaxDir,
},
{
from: 'es5/input/tex/extensions/**/*.js',
to: `js/libs/mathjax-3-${PackageVersions.version['mathjax-3']}`,
to: `js/libs/mathjax-${PackageVersions.version.mathjax}`,
toType: 'dir',
context: mathjax3Dir,
context: mathjaxDir,
},
{
from: 'es5/ui/**/*',
to: `js/libs/mathjax-3-${PackageVersions.version['mathjax-3']}`,
to: `js/libs/mathjax-${PackageVersions.version.mathjax}`,
toType: 'dir',
context: mathjax3Dir,
},
{ from: 'MathJax.js', to: 'js/libs/mathjax', context: mathjaxDir },
{ from: 'config/**/*', to: 'js/libs/mathjax', context: mathjaxDir },
{
from: 'extensions/**/*',
globOptions: {
// https://github.com/mathjax/MathJax/issues/2403
ignore: ['**/mathmaps/*.js'],
},
to: 'js/libs/mathjax',
context: mathjaxDir,
},
{
from: 'localization/en/**/*',
to: 'js/libs/mathjax',
from: 'es5/a11y/**/*',
to: `js/libs/mathjax-${PackageVersions.version.mathjax}`,
toType: 'dir',
context: mathjaxDir,
},
{
from: 'jax/output/HTML-CSS/fonts/TeX/**/*',
to: 'js/libs/mathjax',
from: 'es5/input/mml.js',
to: `js/libs/mathjax-${PackageVersions.version.mathjax}/es5/input`,
toType: 'dir',
context: mathjaxDir,
},
{
from: 'jax/output/HTML-CSS/**/*.js',
to: 'js/libs/mathjax',
context: mathjaxDir,
},
{
from: 'jax/element/**/*',
to: 'js/libs/mathjax',
context: mathjaxDir,
},
{ from: 'jax/input/**/*', to: 'js/libs/mathjax', context: mathjaxDir },
{
from: 'fonts/HTML-CSS/TeX/woff/*',
to: 'js/libs/mathjax',
from: 'es5/sre/**/*',
to: `js/libs/mathjax-${PackageVersions.version.mathjax}`,
toType: 'dir',
context: mathjaxDir,
},
...pdfjsVersions.flatMap(version => {