Bug 1887824 - vendor Transformers.js - r=gregtatum,frontend-codestyle-reviewers,Standard8

Differential Revision: https://phabricator.services.mozilla.com/D205684

.prettierignore

@@ -1430,6 +1430,7 @@ testing/xpcshell/node-ws/
 third_party/
 toolkit/components/certviewer/content/vendor/
 toolkit/components/jsoncpp/
+toolkit/components/ml/vendor/
 toolkit/components/normandy/vendor/
 toolkit/components/passwordmgr/PasswordRulesParser.sys.mjs
 toolkit/components/protobuf/

toolkit/components/ml/vendor/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

toolkit/components/ml/vendor/README.md

@@ -0,0 +1,12 @@
+# vendored dependencies
+
+- onnxruntime-web 1.14.0 (UMD modules)
+- Transformers.js 2.16.1 (patched for gecko)
+
+To build the vendored dependencies, run `./build.sh`.
+
+The Transformers.js patch is required for building Transformers.js
+without including the `onnxruntime-web` NPM bundle. It uses
+webpack's `externals` feature to include the onnxruntime-web UMD
+module and changes the import statement in `backends/onnx.js` to
+point to it.

toolkit/components/ml/vendor/build.sh

@@ -0,0 +1,33 @@
+# !/bin/bash
+set -xe
+
+# grabbing and patching transformers.js for gecko
+rm -rf tmp
+mkdir tmp
+pushd tmp
+git clone --depth 1 --branch 2.16.1 https://github.com/xenova/transformers.js
+cd transformers.js
+git apply ../../gecko.patch
+npm install
+npm run build
+cp dist/transformers.js ../../transformers-dev.js
+cp dist/transformers.min.js ../../transformers.js
+popd
+rm -rf tmp
+
+# grabbing and patching onnxruntime-web for gecko.
+
+# fetch the tarball URL from npm
+TARBALL_URL=$(npm view onnxruntime-web@1.14.0 dist.tarball)
+wget "${TARBALL_URL}" -O dist.tgz
+
+# grab the two files we need
+tar -xzf dist.tgz
+rm dist.tgz
+cp package/dist/ort.js ort-dev.js
+cp package/dist/ort.min.js ort.js
+rm -rf package
+
+# remove the eval() calls
+sed -i '' '1855,1859d' ort-dev.js
+sed -i '' 's/function inquire(moduleName){try{var mod=eval("quire".replace(\/^\/,"re"))(moduleName);if(mod&&(mod.length||Object.keys(mod).length))return mod}catch(t){}return null}/function inquire(moduleName){return null}/g' ort.js

toolkit/components/ml/vendor/gecko.patch

@@ -0,0 +1,84 @@
+From 2804004525c65df99cd8a563cfd316e796618ebd Mon Sep 17 00:00:00 2001
+From: =?UTF-8?q?Tarek=20Ziad=C3=A9?= <tarek@ziade.org>
+Date: Wed, 10 Apr 2024 10:06:19 +0200
+Subject: [PATCH 1/1] patched
+MIME-Version: 1.0
+Content-Type: text/plain; charset=UTF-8
+Content-Transfer-Encoding: 8bit
+
+Signed-off-by: Tarek Ziadé <tarek@ziade.org>
+---
+ package.json         |  2 +-
+ src/backends/onnx.js |  8 ++++++--
+ tsconfig.json        | 13 +++++++++++++
+ webpack.config.js    |  4 ++++
+ 4 files changed, 24 insertions(+), 3 deletions(-)
+ create mode 100644 tsconfig.json
+
+diff --git a/package.json b/package.json
+index 446fd5f..24825d6 100644
+--- a/package.json
++++ b/package.json
+@@ -6,7 +6,7 @@
+   "types": "./types/transformers.d.ts",
+   "type": "module",
+   "scripts": {
+-    "typegen": "tsc ./src/transformers.js --allowJs --declaration --emitDeclarationOnly --declarationMap --outDir types",
++    "typegen": "tsc",
+     "dev": "webpack serve --no-client-overlay",
+     "build": "webpack && npm run typegen",
+     "generate-tests": "python -m tests.generate_tests",
+diff --git a/src/backends/onnx.js b/src/backends/onnx.js
+index 0bee3dc..030eff7 100644
+--- a/src/backends/onnx.js
++++ b/src/backends/onnx.js
+@@ -18,8 +18,12 @@
+ 
+ // NOTE: Import order matters here. We need to import `onnxruntime-node` before `onnxruntime-web`.
+ // In either case, we select the default export if it exists, otherwise we use the named export.
+-import * as ONNX_NODE from 'onnxruntime-node';
+-import * as ONNX_WEB from 'onnxruntime-web';
++//import * as ONNX_NODE from 'onnxruntime-node';
++//import * as ONNX_WEB from 'onnxruntime-web';
++
++import 'onnxruntime-web';
++const ONNX_WEB = ort;
++
+ 
+ /** @type {import('onnxruntime-web')} The ONNX runtime module. */
+ export let ONNX;
+diff --git a/tsconfig.json b/tsconfig.json
+new file mode 100644
+index 0000000..8892b18
+--- /dev/null
++++ b/tsconfig.json
+@@ -0,0 +1,13 @@
++{
++  "files": [
++    "./src/transformers.js"
++  ],
++  "compilerOptions": {
++    "allowJs": true,
++    "declaration": true,
++    "emitDeclarationOnly": true,
++    "declarationMap": true,
++    "outDir": "types",
++    "types": [] // Or specify only the types you need
++  }
++}
+diff --git a/webpack.config.js b/webpack.config.js
+index c958b45..8b6b98b 100644
+--- a/webpack.config.js
++++ b/webpack.config.js
+@@ -51,4 +51,8 @@ export default {
+     experiments: {
+         outputModule: true,
+     },
++    externals: {
++        'onnxruntime-node': 'NOT_USED',
++        'onnxruntime-web': 'chrome://global/content/ml/ort-dev.js',
++    },
+ };
+-- 
+2.43.0
+

toolkit/components/ml/vendor/moz.yaml

@@ -0,0 +1,15 @@
+schema: 1
+
+bugzilla:
+  product: Core
+  component: Machine Learning
+
+origin:
+  name: transformers.js
+  description: Transformers.js Machine Learning Library for the web
+  url: https://huggingface.co/docs/transformers.js/index
+  release: 2.16.1
+  revision: 314b7f0dc4291e8a38a516073b710d7c6a29aefb
+  license: Apache-2.0
+  license-file: LICENSE
+  notes: see README.md for more details.

tools/rewriting/ThirdPartyPaths.txt

@@ -180,6 +180,7 @@ testing/xpcshell/node-ws/
 third_party/
 toolkit/components/certviewer/content/vendor/
 toolkit/components/jsoncpp/
+toolkit/components/ml/vendor/
 toolkit/components/normandy/vendor/
 toolkit/components/passwordmgr/PasswordRulesParser.sys.mjs
 toolkit/components/protobuf/