Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: infer runtime id from webpack uniqueName option #59

Merged
merged 1 commit into from
Sep 15, 2021
Merged

feat: infer runtime id from webpack uniqueName option #59

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -226,12 +226,13 @@ Note: If a bundle with the provided name does not exist an error will be thrown.
In some cases you may want to embed multiple isolated copies of Marko on the page. Since Marko relies on some `window` properties to initialize this can cause issues. For example, by default Marko will read the server rendered hydration code from `window.$components`. In Marko you can change these `window` properties by rendering with `{ $global: { runtimeId: "MY_MARKO_RUNTIME_ID" } }` as input on the server side.

This plugin exposes a `runtimeId` option produces output that automatically sets `$global.runtimeId` on the server side and initializes properly in the browser.
The `runtimeId` will default to the [`uniqueName` option](https://webpack.js.org/configuration/output/#outputuniquename) from the server compiler in the webpack config.

```js
import MarkoPlugin from "@marko/webpack/plugin";

const markoPlugin = new MarkoPlugin({
runtimeId: "MY_MARKO_RUNTIME_ID"
runtimeId: "MY_MARKO_RUNTIME_ID" // default to webpack `output.uniqueName` option.
});
```

Expand Down
3 changes: 2 additions & 1 deletion src/__tests__/fixtures/asset-tag/__snapshots__/webpack5/server--main.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -162,7 +162,7 @@ function renderAssets(out) {
this.___entries = undefined;

if (entries) {
__webpack_require__.p && out.script(`$mwp=${JSON.stringify(__webpack_require__.p)}`);
__webpack_require__.p && out.script(`$mwp__marko_webpack=${JSON.stringify(__webpack_require__.p)}`);
const buildName = this.buildName;
const nonce = this.cspNonce;
const nonceAttr = nonce ? ` nonce=${JSON.stringify(nonce)}` : "";
Expand Down Expand Up @@ -204,6 +204,7 @@ function renderAssets(out) {
const _marko_componentType = "wUwFs+xe",
_marko_component = {};
_marko_template._ = marko_dist_runtime_components_renderer__WEBPACK_IMPORTED_MODULE_7___default()(function (input, out, _component, component, state) {
out.global.runtimeId = "_marko_webpack";
out.global.___renderAssets = renderAssets;
(out.global.___entries || (out.global.___entries = [])).push("test_wUwF");

Expand Down
2 changes: 1 addition & 1 deletion ..._tests__/fixtures/basic-template-plugin-production/__snapshots__/webpack5/server--main.js
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

3 changes: 2 additions & 1 deletion src/__tests__/fixtures/basic-template-plugin/__snapshots__/webpack5/server--main.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@ function renderAssets(out) {
this.___entries = undefined;

if (entries) {
__webpack_require__.p && out.script(`$mwp=${JSON.stringify(__webpack_require__.p)}`);
__webpack_require__.p && out.script(`$mwp__marko_webpack=${JSON.stringify(__webpack_require__.p)}`);
const buildName = this.buildName;
const nonce = this.cspNonce;
const nonceAttr = nonce ? ` nonce=${JSON.stringify(nonce)}` : "";
Expand Down Expand Up @@ -114,6 +114,7 @@ function renderAssets(out) {
const _marko_componentType = "r9oeuJMR",
_marko_component = {};
_marko_template._ = marko_dist_runtime_components_renderer__WEBPACK_IMPORTED_MODULE_7___default()(function (input, out, _component, component, state) {
out.global.runtimeId = "_marko_webpack";
out.global.___renderAssets = renderAssets;
(out.global.___entries || (out.global.___entries = [])).push("test_r9oe");

Expand Down
9 changes: 6 additions & 3 deletions src/__tests__/fixtures/multiple-entries-plugin/__snapshots__/webpack5/server--main.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,7 @@ function renderAssets(out) {
this.___entries = undefined;

if (entries) {
__webpack_require__.p && out.script(`$mwp=${JSON.stringify(__webpack_require__.p)}`);
__webpack_require__.p && out.script(`$mwp__marko_webpack=${JSON.stringify(__webpack_require__.p)}`);
const buildName = this.buildName;
const nonce = this.cspNonce;
const nonceAttr = nonce ? ` nonce=${JSON.stringify(nonce)}` : "";
Expand Down Expand Up @@ -121,6 +121,7 @@ function renderAssets(out) {
const _marko_componentType = "qMMCl8/W",
_marko_component = {};
_marko_template._ = marko_dist_runtime_components_renderer__WEBPACK_IMPORTED_MODULE_7___default()(function (input, out, _component, component, state) {
out.global.runtimeId = "_marko_webpack";
out.global.___renderAssets = renderAssets;
(out.global.___entries || (out.global.___entries = [])).push("bar_qMMC");

Expand Down Expand Up @@ -252,7 +253,7 @@ function renderAssets(out) {
this.___entries = undefined;

if (entries) {
__webpack_require__.p && out.script(`$mwp=${JSON.stringify(__webpack_require__.p)}`);
__webpack_require__.p && out.script(`$mwp__marko_webpack=${JSON.stringify(__webpack_require__.p)}`);
const buildName = this.buildName;
const nonce = this.cspNonce;
const nonceAttr = nonce ? ` nonce=${JSON.stringify(nonce)}` : "";
Expand Down Expand Up @@ -294,6 +295,7 @@ function renderAssets(out) {
const _marko_componentType = "FRgaW2aC",
_marko_component = {};
_marko_template._ = marko_dist_runtime_components_renderer__WEBPACK_IMPORTED_MODULE_7___default()(function (input, out, _component, component, state) {
out.global.runtimeId = "_marko_webpack";
out.global.___renderAssets = renderAssets;
(out.global.___entries || (out.global.___entries = [])).push("foo_FRga");

Expand Down Expand Up @@ -393,7 +395,7 @@ function renderAssets(out) {
this.___entries = undefined;

if (entries) {
__webpack_require__.p && out.script(`$mwp=${JSON.stringify(__webpack_require__.p)}`);
__webpack_require__.p && out.script(`$mwp__marko_webpack=${JSON.stringify(__webpack_require__.p)}`);
const buildName = this.buildName;
const nonce = this.cspNonce;
const nonceAttr = nonce ? ` nonce=${JSON.stringify(nonce)}` : "";
Expand Down Expand Up @@ -435,6 +437,7 @@ function renderAssets(out) {
const _marko_componentType = "vyXF8r3F",
_marko_component = {};
_marko_template._ = marko_dist_runtime_components_renderer__WEBPACK_IMPORTED_MODULE_7___default()(function (input, out, _component, component, state) {
out.global.runtimeId = "_marko_webpack";
out.global.___renderAssets = renderAssets;
(out.global.___entries || (out.global.___entries = [])).push("nested_vyXF");

Expand Down
2 changes: 1 addition & 1 deletion ...th-class-component-plugin-dynamic-bundle/__snapshots__/webpack5/browser-A--test_xbSt.A.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -194,7 +194,7 @@ __webpack_require__.r(__webpack_exports__);



(0,marko_src_runtime_components__WEBPACK_IMPORTED_MODULE_0__.init)();
(0,marko_src_runtime_components__WEBPACK_IMPORTED_MODULE_0__.init)("_marko_webpack");
})();

/******/ })()
Expand Down
2 changes: 1 addition & 1 deletion ...th-class-component-plugin-dynamic-bundle/__snapshots__/webpack5/browser-B--test_xbSt.B.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -194,7 +194,7 @@ __webpack_require__.r(__webpack_exports__);



(0,marko_src_runtime_components__WEBPACK_IMPORTED_MODULE_0__.init)();
(0,marko_src_runtime_components__WEBPACK_IMPORTED_MODULE_0__.init)("_marko_webpack");
})();

/******/ })()
Expand Down
2 changes: 1 addition & 1 deletion ...th-class-component-plugin-dynamic-bundle/__snapshots__/webpack5/browser-C--test_xbSt.C.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -194,7 +194,7 @@ __webpack_require__.r(__webpack_exports__);



(0,marko_src_runtime_components__WEBPACK_IMPORTED_MODULE_0__.init)();
(0,marko_src_runtime_components__WEBPACK_IMPORTED_MODULE_0__.init)("_marko_webpack");
})();

/******/ })()
Expand Down
3 changes: 2 additions & 1 deletion ...ixtures/with-class-component-plugin-dynamic-bundle/__snapshots__/webpack5/server--main.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -115,7 +115,7 @@ function renderAssets(out) {
this.___entries = undefined;

if (entries) {
__webpack_require__.p && out.script(`$mwp=${JSON.stringify(__webpack_require__.p)}`);
__webpack_require__.p && out.script(`$mwp__marko_webpack=${JSON.stringify(__webpack_require__.p)}`);
const buildName = this.buildName;
const nonce = this.cspNonce;
const nonceAttr = nonce ? ` nonce=${JSON.stringify(nonce)}` : "";
Expand Down Expand Up @@ -157,6 +157,7 @@ function renderAssets(out) {
const _marko_componentType = "xbStr3Q2",
_marko_component = {};
_marko_template._ = marko_dist_runtime_components_renderer__WEBPACK_IMPORTED_MODULE_7___default()(function (input, out, _component, component, state) {
out.global.runtimeId = "_marko_webpack";
out.global.___renderAssets = renderAssets;
(out.global.___entries || (out.global.___entries = [])).push("test_xbSt");

Expand Down
2 changes: 1 addition & 1 deletion ...tests__/fixtures/with-class-component-plugin/__snapshots__/webpack5/browser--test_ntnz.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -192,7 +192,7 @@ __webpack_require__.r(__webpack_exports__);



(0,marko_src_runtime_components__WEBPACK_IMPORTED_MODULE_0__.init)();
(0,marko_src_runtime_components__WEBPACK_IMPORTED_MODULE_0__.init)("_marko_webpack");
})();

/******/ })()
Expand Down
3 changes: 2 additions & 1 deletion src/__tests__/fixtures/with-class-component-plugin/__snapshots__/webpack5/server--main.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -113,7 +113,7 @@ function renderAssets(out) {
this.___entries = undefined;

if (entries) {
__webpack_require__.p && out.script(`$mwp=${JSON.stringify(__webpack_require__.p)}`);
__webpack_require__.p && out.script(`$mwp__marko_webpack=${JSON.stringify(__webpack_require__.p)}`);
const buildName = this.buildName;
const nonce = this.cspNonce;
const nonceAttr = nonce ? ` nonce=${JSON.stringify(nonce)}` : "";
Expand Down Expand Up @@ -155,6 +155,7 @@ function renderAssets(out) {
const _marko_componentType = "ntnz89r6",
_marko_component = {};
_marko_template._ = marko_dist_runtime_components_renderer__WEBPACK_IMPORTED_MODULE_7___default()(function (input, out, _component, component, state) {
out.global.runtimeId = "_marko_webpack";
out.global.___renderAssets = renderAssets;
(out.global.___entries || (out.global.___entries = [])).push("test_ntnz");

Expand Down
1 change: 1 addition & 0 deletions src/__tests__/fixtures/with-public-path/__snapshots__/webpack5/server--main.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -113,6 +113,7 @@ function renderAssets(out) {
const _marko_componentType = "xGHmCIBi",
_marko_component = {};
_marko_template._ = marko_dist_runtime_components_renderer__WEBPACK_IMPORTED_MODULE_7___default()(function (input, out, _component, component, state) {
out.global.runtimeId = "_marko_webpack";
out.global.___renderAssets = renderAssets;
(out.global.___entries || (out.global.___entries = [])).push("test_xGHm");

Expand Down
18 changes: 16 additions & 2 deletions src/plugin/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,8 +36,12 @@ export default class MarkoWebpackPlugin {
};
} = {};

constructor(private options?: { runtimeId?: string }) {
this.options = options;
constructor(private options: { runtimeId?: string } = {}) {
this.options = { ...options };

if (this.options.runtimeId) {
this.options.runtimeId = normalizeRuntimeId(this.options.runtimeId);
}
}

get server() {
Expand Down Expand Up @@ -79,6 +83,12 @@ export default class MarkoWebpackPlugin {
compiler.hooks.thisCompilation.tap(
"MarkoWebpackServer:compilation",
compilation => {
if (!this.options.runtimeId && compilation.outputOptions.uniqueName) {
this.options.runtimeId = normalizeRuntimeId(
compilation.outputOptions.uniqueName
);
}

compilation.hooks.finishModules.tap(
"MarkoWebpackServer:finishModules",
modules => {
Expand Down Expand Up @@ -312,6 +322,10 @@ function patchWatchingWebpack4(compiler: webpack.Compiler) {
}
}

function normalizeRuntimeId(id: string) {
return id.replace(/[^a-z0-9$_]/gi, "_");
}

function addLoaderAlias(config: webpack.Configuration) {
const resolveLoader = (config.resolveLoader ??= {});
const resolveLoaderAlias = (resolveLoader.alias ??= {});
Expand Down