add workaround for protobufjs requiring uppercase package names

I mourn the time lost trying to track this down :-( protobufjs/protobuf.js#1014 We can't patch the minified file in dist without essentially duplicating it, so this change also switches from the external file to including the src file as part of the bundle.
ankitects · Jul 10, 2021 · 1d4b584 · 1d4b584
1 parent 80b98e0
commit 1d4b584
Show file tree

Hide file tree

Showing 19 changed files with 181 additions and 80 deletions.
diff --git a/qt/aqt/data/web/js/vendor/BUILD.bazel b/qt/aqt/data/web/js/vendor/BUILD.bazel
@@ -1,26 +1,22 @@
 load(
     "//ts:vendor.bzl",
+    "copy_bootstrap_js",
     "copy_css_browser_selector",
     "copy_jquery",
     "copy_jquery_ui",
-    "copy_protobufjs",
-    "copy_bootstrap_js",
 )
 
 copy_jquery(name = "jquery")
 
 copy_jquery_ui(name = "jquery-ui")
 
-copy_protobufjs(name = "protobufjs")
-
 copy_css_browser_selector(name = "css-browser-selector")
 
 copy_bootstrap_js(name = "bootstrap")
 
 files = [
     "jquery",
     "jquery-ui",
-    "protobufjs",
     "css-browser-selector",
     "bootstrap",
 ]

diff --git a/qt/aqt/editor.py b/qt/aqt/editor.py
@@ -137,7 +137,6 @@ def setupWeb(self) -> None:
             ],
             js=[
                 "js/vendor/jquery.min.js",
-                "js/vendor/protobuf.min.js",
                 "js/editor.js",
             ],
             context=self,

diff --git a/qt/aqt/reviewer.py b/qt/aqt/reviewer.py
@@ -293,7 +293,6 @@ def _initWeb(self) -> None:
                 "js/mathjax.js",
                 "js/vendor/mathjax/tex-chtml.js",
                 "js/reviewer.js",
-                "js/vendor/protobuf.min.js",
                 "js/reviewer_extras.js",
             ],
             context=self,

diff --git a/ts/BUILD.bazel b/ts/BUILD.bazel
@@ -29,7 +29,6 @@ exports_files([
     ".eslintrc.js",
     "licenses.json",
     "sql_format.ts",
-    "protobuf-shim.js",
     "jest.config.js",
     "package.json",
     "protobuf-no-long.js",

diff --git a/ts/change-notetype/BUILD.bazel b/ts/change-notetype/BUILD.bazel
@@ -61,20 +61,13 @@ ts_library(
 
 esbuild(
     name = "change-notetype",
-    srcs = [
-        "//ts:protobuf-shim.js",
-    ],
     args = [
         "--global-name=anki",
-        "--inject:$(location //ts:protobuf-shim.js)",
         "--resolve-extensions=.mjs,.js",
         "--log-level=warning",
         "--loader:.svg=text",
     ],
     entry_point = "index.ts",
-    external = [
-        "protobufjs/light",
-    ],
     output_css = "change-notetype.css",
     visibility = ["//visibility:public"],
     deps = [
@@ -87,6 +80,7 @@ esbuild(
         "//ts/sveltelib",
         "//ts/components",
         "//ts/components:svelte_components",
+        "@npm//protobufjs",
     ] + svelte_names,
 )
 

diff --git a/ts/change-notetype/change-notetype.html b/ts/change-notetype/change-notetype.html
@@ -5,7 +5,6 @@
         <meta name="viewport" id="viewport" content="width=device-width" />
         <link href="change-notetype-base.css" rel="stylesheet" />
         <link href="change-notetype.css" rel="stylesheet" />
-        <script src="../js/vendor/protobuf.min.js"></script>
         <script src="../js/vendor/bootstrap.bundle.min.js"></script>
         <script src="change-notetype.js"></script>
     </head>

diff --git a/ts/congrats/BUILD.bazel b/ts/congrats/BUILD.bazel
@@ -43,19 +43,12 @@ ts_library(
 
 esbuild(
     name = "congrats",
-    srcs = [
-        "//ts:protobuf-shim.js",
-    ],
     args = [
         "--global-name=anki",
-        "--inject:$(location //ts:protobuf-shim.js)",
         "--resolve-extensions=.mjs,.js",
         "--log-level=warning",
     ],
     entry_point = "index.ts",
-    external = [
-        "protobufjs/light",
-    ],
     output_css = "congrats.css",
     visibility = ["//visibility:public"],
     deps = [
@@ -64,6 +57,7 @@ esbuild(
         ":index",
         "//ts/lib",
         "//ts/lib:backend_proto",
+        "@npm//protobufjs",
     ],
 )
 

diff --git a/ts/congrats/congrats.html b/ts/congrats/congrats.html
@@ -5,7 +5,6 @@
         <meta name="viewport" id="viewport" content="width=device-width" />
         <link href="congrats-base.css" rel="stylesheet" />
         <link href="congrats.css" rel="stylesheet" />
-        <script src="../js/vendor/protobuf.min.js"></script>
         <script src="congrats.js"></script>
     </head>
     <body>

diff --git a/ts/deck-options/BUILD.bazel b/ts/deck-options/BUILD.bazel
@@ -26,8 +26,8 @@ compile_svelte(
     name = "svelte",
     srcs = svelte_files,
     deps = [
-        "//ts/sveltelib",
         "//ts/components",
+        "//ts/sveltelib",
         "@npm//@types/bootstrap",
         "@npm//@types/marked",
     ],
@@ -48,8 +48,8 @@ ts_library(
     deps = [
         "DeckOptionsPage",
         "lib",
-        "//ts/lib",
         "//ts/components",
+        "//ts/lib",
         "@npm//@popperjs",
         "@npm//svelte2tsx",
     ],
@@ -66,31 +66,24 @@ ts_library(
     module_name = "deckoptions",
     deps = [
         "//ts:image_module_support",
+        "//ts/components",
         "//ts/lib",
         "//ts/lib:backend_proto",
         "//ts/sveltelib",
-        "//ts/components",
         "@npm//lodash-es",
         "@npm//svelte",
     ],
 )
 
 esbuild(
     name = "deck-options",
-    srcs = [
-        "//ts:protobuf-shim.js",
-    ],
     args = [
         "--global-name=anki",
-        "--inject:$(location //ts:protobuf-shim.js)",
         "--resolve-extensions=.mjs,.js",
         "--log-level=warning",
         "--loader:.svg=text",
     ],
     entry_point = "index.ts",
-    external = [
-        "protobufjs/light",
-    ],
     output_css = "deck-options.css",
     visibility = ["//visibility:public"],
     deps = [
@@ -99,6 +92,7 @@ esbuild(
         ":base_css",
         "@npm//bootstrap",
         "@npm//marked",
+        "@npm//protobufjs",
         "//ts/lib",
         "//ts/lib:backend_proto",
         "//ts/sveltelib",

diff --git a/ts/deck-options/deck-options.html b/ts/deck-options/deck-options.html
@@ -5,7 +5,6 @@
         <meta name="viewport" id="viewport" content="width=device-width" />
         <link href="deck-options-base.css" rel="stylesheet" />
         <link href="deck-options.css" rel="stylesheet" />
-        <script src="../js/vendor/protobuf.min.js"></script>
         <script src="../js/vendor/bootstrap.bundle.min.js"></script>
         <script src="deck-options.js"></script>
     </head>

diff --git a/ts/editor/BUILD.bazel b/ts/editor/BUILD.bazel
@@ -114,7 +114,6 @@ copy_mdi_icons(
         "function-variant.svg",
         "contain.svg",
         "xml.svg",
-
         "format-color-text.svg",
         "format-color-highlight.svg",
         "color-helper.svg",
@@ -124,19 +123,12 @@ copy_mdi_icons(
 
 esbuild(
     name = "editor",
-    srcs = [
-        "//ts:protobuf-shim.js",
-    ],
     args = [
         "--loader:.svg=text",
-        "--inject:$(location //ts:protobuf-shim.js)",
         "--resolve-extensions=.mjs,.js",
         "--log-level=warning",
     ],
     entry_point = "index_wrapper.ts",
-    external = [
-        "protobufjs/light",
-    ],
     output_css = "editor.css",
     visibility = ["//visibility:public"],
     deps = [
@@ -148,6 +140,7 @@ esbuild(
         "svelte_components",
         "//ts/components",
         "//ts/components:svelte_components",
+        "@npm//protobufjs",
     ],
 )
 

diff --git a/ts/graphs/BUILD.bazel b/ts/graphs/BUILD.bazel
@@ -57,19 +57,12 @@ ts_library(
 
 esbuild(
     name = "graphs",
-    srcs = [
-        "//ts:protobuf-shim.js",
-    ],
     args = [
         "--global-name=anki",
-        "--inject:$(location //ts:protobuf-shim.js)",
         "--resolve-extensions=.mjs,.js",
         "--log-level=warning",
     ],
     entry_point = "index.ts",
-    external = [
-        "protobufjs/light",
-    ],
     output_css = "graphs.css",
     visibility = ["//visibility:public"],
     deps = [
@@ -78,6 +71,7 @@ esbuild(
         "//ts/lib:backend_proto",
         ":index",
         ":base_css",
+        "@npm//protobufjs",
     ] + svelte_names,
 )
 

diff --git a/ts/graphs/graphs.html b/ts/graphs/graphs.html
@@ -5,7 +5,6 @@
         <meta name="viewport" id="viewport" content="width=device-width" />
         <link href="graphs-base.css" rel="stylesheet" />
         <link href="graphs.css" rel="stylesheet" />
-        <script src="../js/vendor/protobuf.min.js"></script>
         <script src="graphs.js"></script>
     </head>
     <body>

diff --git a/ts/package.json b/ts/package.json
@@ -37,6 +37,7 @@
         "jsdoc": "^3.6.6",
         "license-checker-rseidelsohn": "^1.2.2",
         "minimist": "^1.2.5",
+        "patch-package": "^6.4.7",
         "prettier": "=2.3.0",
         "prettier-plugin-svelte": "=2.3.0",
         "sass": "=1.32.12",
@@ -51,7 +52,8 @@
         "uglify-js": "^3.13.1"
     },
     "scripts": {
-        "fix": "prettier --write */*.ts */*.svelte"
+        "fix": "prettier --write */*.ts */*.svelte",
+        "postinstall": "patch-package"
     },
     "dependencies": {
         "@fluent/bundle": "^0.15.1",

diff --git a/ts/patches/protobufjs+6.11.2.patch b/ts/patches/protobufjs+6.11.2.patch
@@ -0,0 +1,13 @@
+diff --git a/node_modules/protobufjs/src/root.js b/node_modules/protobufjs/src/root.js
+index df6f11f..112f9e8 100644
+--- a/node_modules/protobufjs/src/root.js
++++ b/node_modules/protobufjs/src/root.js
+@@ -259,7 +259,7 @@ Root.prototype.resolveAll = function resolveAll() {
+ };
+
+ // only uppercased (and thus conflict-free) children are exposed, see below
+-var exposeRe = /^[A-Z]/;
++var exposeRe = /^[A-Za-z]/;
+
+ /**
+  * Handles a deferred declaring extension field by creating a sister field to represent it within its extended type.
diff --git a/ts/protobuf-shim.js b/ts/protobuf-shim.js
diff --git a/ts/reviewer/BUILD.bazel b/ts/reviewer/BUILD.bazel
@@ -16,23 +16,17 @@ ts_library(
 
 esbuild(
     name = "reviewer_extras",
-    srcs = [
-        "//ts:protobuf-shim.js",
-    ],
     args = [
-        "--inject:$(location //ts:protobuf-shim.js)",
         "--resolve-extensions=.mjs,.js",
         "--log-level=warning",
     ],
     entry_point = "index.ts",
-    external = [
-        "protobufjs/light",
-    ],
     visibility = ["//visibility:public"],
     deps = [
         ":lib",
         "//ts/lib",
         "//ts/lib:backend_proto",
+        "@npm//protobufjs",
     ],
 )
 

diff --git a/ts/vendor.bzl b/ts/vendor.bzl
@@ -60,17 +60,6 @@ def copy_jquery_ui(name = "jquery-ui", visibility = ["//visibility:public"]):
         visibility = visibility,
     )
 
-def copy_protobufjs(name = "protobufjs", visibility = ["//visibility:public"]):
-    vendor_js_lib(
-        name = name,
-        pkg = pkg_from_name(name),
-        include = [
-            "dist/protobuf.min.js",
-        ],
-        strip_prefix = "dist/",
-        visibility = visibility,
-    )
-
 def copy_mathjax(name = "mathjax", visibility = ["//visibility:public"]):
     vendor_js_lib(
         name = name,
@@ -140,4 +129,3 @@ def copy_mdi_icons(name = "mdi-icons", icons = [], visibility = ["//visibility:p
         strip_prefix = "svg/",
         visibility = visibility,
     )
-