277 lines
9.4 KiB
JavaScript
277 lines
9.4 KiB
JavaScript
/* This Source Code Form is subject to the terms of the Mozilla Public
|
|
* License, v. 2.0. If a copy of the MPL was not distributed with this
|
|
* file, You can obtain one at <http://mozilla.org/MPL/2.0/>. */
|
|
/* globals process, __filename, __dirname */
|
|
|
|
"use strict";
|
|
|
|
const Babel = require("./babel");
|
|
const fs = require("fs");
|
|
const _path = require("path");
|
|
|
|
const EXCLUDED_FILES = {
|
|
"../assets/panel/debugger.properties": "devtools/shared/flags",
|
|
"devtools-connection": "devtools/shared/flags",
|
|
"chrome-remote-interface": "devtools/shared/flags",
|
|
"devtools-launchpad": "devtools/shared/flags",
|
|
};
|
|
|
|
const mappings = Object.assign(
|
|
{
|
|
"./source-editor": "devtools/client/shared/sourceeditor/editor",
|
|
"../editor/source-editor": "devtools/client/shared/sourceeditor/editor",
|
|
"./test-flag": "devtools/shared/flags",
|
|
"./fronts-device": "devtools/shared/fronts/device",
|
|
immutable: "devtools/client/shared/vendor/immutable",
|
|
lodash: "devtools/client/shared/vendor/lodash",
|
|
react: "devtools/client/shared/vendor/react",
|
|
"react-dom": "devtools/client/shared/vendor/react-dom",
|
|
"react-dom-factories": "devtools/client/shared/vendor/react-dom-factories",
|
|
"react-redux": "devtools/client/shared/vendor/react-redux",
|
|
redux: "devtools/client/shared/vendor/redux",
|
|
reselect: "devtools/client/shared/vendor/reselect",
|
|
"prop-types": "devtools/client/shared/vendor/react-prop-types",
|
|
"devtools-services": "Services",
|
|
"wasmparser/dist/WasmParser": "devtools/client/shared/vendor/WasmParser",
|
|
"wasmparser/dist/WasmDis": "devtools/client/shared/vendor/WasmDis",
|
|
"whatwg-url": "devtools/client/shared/vendor/whatwg-url",
|
|
"framework-actions": "devtools/client/framework/actions/index",
|
|
"inspector-shared-utils": "devtools/client/inspector/shared/utils",
|
|
},
|
|
EXCLUDED_FILES
|
|
);
|
|
|
|
const mappingValues = Object.values(mappings);
|
|
|
|
// Add two additional mappings that cannot be reused when creating the
|
|
// webpack bundles.
|
|
mappings["devtools-reps"] = "devtools/client/shared/components/reps/reps.js";
|
|
mappings["devtools-source-map"] = "devtools/client/shared/source-map/index.js";
|
|
|
|
function isRequire(t, node) {
|
|
return node && t.isCallExpression(node) && node.callee.name == "require";
|
|
}
|
|
|
|
// List of vendored modules.
|
|
// Should be synchronized with vendors.js
|
|
const VENDORS = [
|
|
"classnames",
|
|
"devtools-components",
|
|
"devtools-config",
|
|
"devtools-contextmenu",
|
|
"devtools-environment",
|
|
"devtools-modules",
|
|
"devtools-splitter",
|
|
"devtools-utils",
|
|
"fuzzaldrin-plus",
|
|
"lodash-move",
|
|
"react-aria-components/src/tabs",
|
|
"react-transition-group/Transition",
|
|
"Svg",
|
|
];
|
|
|
|
const moduleMapping = {
|
|
Telemetry: "devtools/client/shared/telemetry",
|
|
asyncStoreHelper: "devtools/client/shared/async-store-helper",
|
|
asyncStorage: "devtools/shared/async-storage",
|
|
PluralForm: "devtools/shared/plural-form",
|
|
};
|
|
|
|
/*
|
|
* Updates devtools-modules imports such as
|
|
* `import { Telemetry } from "devtools-modules"`
|
|
* so that we can customize how we resolve certain modules in the package
|
|
*
|
|
* In the case of multiple declarations we need to move
|
|
* the telemetry module into its own import.
|
|
*/
|
|
function updateDevtoolsModulesImport(path, t) {
|
|
const specifiers = path.node.specifiers;
|
|
|
|
for (let i = 0; i < specifiers.length; i++) {
|
|
const specifier = specifiers[i];
|
|
const localName = specifier.local.name;
|
|
if (localName in moduleMapping) {
|
|
const newImport = t.importDeclaration(
|
|
[t.importDefaultSpecifier(specifier.local)],
|
|
t.stringLiteral(moduleMapping[localName])
|
|
);
|
|
|
|
if (specifiers.length > 1) {
|
|
path.insertAfter(newImport);
|
|
specifiers.splice(i, 1);
|
|
} else if (path.node.source) {
|
|
// Note we don't want to update import `Telemetry from "devtools-modules"`
|
|
if (path.node.specifiers[0].type !== "ImportDefaultSpecifier") {
|
|
path.replaceWith(newImport);
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
function shouldLazyLoad(value) {
|
|
return (
|
|
!value.includes("vendors") &&
|
|
!value.includes("codemirror/") &&
|
|
!value.endsWith(".properties") &&
|
|
!value.startsWith("devtools/")
|
|
);
|
|
}
|
|
|
|
/**
|
|
* This Babel plugin is used to transpile a single Debugger module into a module that
|
|
* can be loaded in Firefox via the regular DevTools loader.
|
|
*/
|
|
function transformMC({ types: t }) {
|
|
return {
|
|
visitor: {
|
|
ModuleDeclaration(path, state) {
|
|
const source = path.node.source;
|
|
const value = source && source.value;
|
|
if (value && value.includes(".css")) {
|
|
path.remove();
|
|
}
|
|
|
|
if (value && value == "devtools-modules") {
|
|
updateDevtoolsModulesImport(path, t);
|
|
}
|
|
},
|
|
|
|
StringLiteral(path, state) {
|
|
const { filePath } = state.opts;
|
|
let value = path.node.value;
|
|
|
|
if (!isRequire(t, path.parent)) {
|
|
return;
|
|
}
|
|
|
|
// Handle require() to files mapped to other mozilla-central files.
|
|
// e.g. require("devtools-reps")
|
|
// -> require("devtools/client/shared/components/reps/reps.js")
|
|
if (Object.keys(mappings).includes(value)) {
|
|
path.replaceWith(t.stringLiteral(mappings[value]));
|
|
return;
|
|
}
|
|
|
|
// Handle require() to loadash submodules
|
|
// e.g. require("lodash/escapeRegExp")
|
|
// -> require("devtools/client/shared/vendor/lodash").escapeRegExp
|
|
if (value.startsWith("lodash/")) {
|
|
const lodashSubModule = value.split("/").pop();
|
|
path.replaceWith(t.stringLiteral(mappings.lodash));
|
|
path.parentPath.replaceWith(
|
|
t.memberExpression(path.parent, t.identifier(lodashSubModule))
|
|
);
|
|
return;
|
|
}
|
|
|
|
// Handle require() to files bundled in vendor.js.
|
|
// e.g. require("some-module");
|
|
// -> require("devtools/client/debugger/dist/vendors").vendored["some-module"];
|
|
const isVendored = VENDORS.some(vendored => value.endsWith(vendored));
|
|
if (isVendored) {
|
|
// components/shared/Svg is required using various relative paths.
|
|
// Transform paths such as "../shared/Svg" to "Svg".
|
|
if (value.endsWith("/Svg")) {
|
|
value = "Svg";
|
|
}
|
|
|
|
// Transform the required path to require vendors.js
|
|
path.replaceWith(
|
|
t.stringLiteral("devtools/client/debugger/dist/vendors")
|
|
);
|
|
|
|
// Append `.vendored["some-module"]` after the require().
|
|
path.parentPath.replaceWith(
|
|
t.memberExpression(
|
|
t.memberExpression(path.parent, t.identifier("vendored")),
|
|
t.stringLiteral(value),
|
|
true
|
|
)
|
|
);
|
|
return;
|
|
}
|
|
|
|
// Handle implicit index.js requires:
|
|
// in a node environment, require("my/folder") will automatically load
|
|
// my/folder/index.js if available. The DevTools load does not handle
|
|
// this case, so we need to explicitly transform such requires to point
|
|
// to the index.js file.
|
|
const dir = _path.dirname(filePath);
|
|
const depPath = _path.join(dir, `${value}.js`);
|
|
const exists = fs.existsSync(depPath);
|
|
if (
|
|
!exists &&
|
|
!value.endsWith("index") &&
|
|
!(value.startsWith("devtools") || mappingValues.includes(value))
|
|
) {
|
|
value = `${value}/index`;
|
|
path.replaceWith(t.stringLiteral(value));
|
|
}
|
|
|
|
if (shouldLazyLoad(value)) {
|
|
const requireCall = path.parentPath;
|
|
const declarator = requireCall.parentPath;
|
|
const declaration = declarator.parentPath;
|
|
|
|
// require()s that are not assigned to a variable cannot be safely lazily required
|
|
// since we lack anything to initiate the require (= the getter for the variable)
|
|
if (declarator.type !== "VariableDeclarator") {
|
|
return;
|
|
}
|
|
|
|
// update relative paths to be "absolute" (starting with devtools/)
|
|
// e.g. ./utils/source-queue
|
|
if (value.startsWith(".")) {
|
|
// Create full path
|
|
// e.g. z:\build\build\src\devtools\client\debugger\src\utils\source-queue
|
|
let newValue = _path.join(_path.dirname(filePath), value);
|
|
|
|
// Select the devtools portion of the path
|
|
// e.g. devtools\client\debugger\src\utils\source-queue
|
|
if (!newValue.startsWith("devtools")) {
|
|
newValue = newValue.match(/^(.*?)(devtools.*)/)[2];
|
|
}
|
|
|
|
// Replace forward slashes with back slashes
|
|
// e.g devtools/client/debugger/src/utils/source-queue
|
|
newValue = newValue.replace(/\\/g, "/");
|
|
|
|
value = newValue;
|
|
}
|
|
|
|
// rewrite to: loader.lazyRequireGetter(this, "variableName", "pathToFile")
|
|
const lazyRequire = t.callExpression(
|
|
t.memberExpression(
|
|
t.identifier("loader"),
|
|
t.identifier("lazyRequireGetter")
|
|
),
|
|
[
|
|
t.thisExpression(),
|
|
t.stringLiteral(declarator.node.id.name || ""),
|
|
t.stringLiteral(value),
|
|
]
|
|
);
|
|
|
|
declaration.replaceWith(lazyRequire);
|
|
}
|
|
},
|
|
},
|
|
};
|
|
}
|
|
|
|
Babel.registerPlugin("transform-mc", transformMC);
|
|
|
|
module.exports = function(filePath) {
|
|
return [
|
|
"transform-flow-strip-types",
|
|
"syntax-trailing-function-commas",
|
|
"transform-class-properties",
|
|
"transform-es2015-modules-commonjs",
|
|
"transform-react-jsx",
|
|
"syntax-object-rest-spread",
|
|
["transform-mc", { mappings, vendors: VENDORS, filePath }],
|
|
];
|
|
};
|