Skip to content

Support extracting fastboot specific config from meta tag #854

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

Merged
merged 2 commits into from
Sep 10, 2021
Merged

Support extracting fastboot specific config from meta tag #854

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
fc6fc24
Fix fastboot-script assets with cutom root url
xg-wang Aug 22, 2021
dd38417
Support extracting fastboot specific config from meta tag
xg-wang Aug 22, 2021
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
30 changes: 24 additions & 6 deletions packages/fastboot/src/html-entrypoint.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,21 +4,37 @@ const { JSDOM } = require('jsdom');
const fs = require('fs');
const path = require('path');

function mergeContent(metaElement, config, configName) {
let name = metaElement.getAttribute('name');
if (name && name.endsWith(configName)) {
let content = JSON.parse(decodeURIComponent(metaElement.getAttribute('content')));
content.APP = Object.assign({ autoboot: false }, content.APP);
config[name.slice(0, -1 * configName.length)] = content;
return true;
}
return false;
}

function htmlEntrypoint(appName, distPath, htmlPath) {
let html = fs.readFileSync(path.join(distPath, htmlPath), 'utf8');
let dom = new JSDOM(html);
let scripts = [];

let fastbootConfig = {};
let config = {};
for (let element of dom.window.document.querySelectorAll('meta')) {
let name = element.getAttribute('name');
if (name && name.endsWith('/config/environment')) {
let content = JSON.parse(decodeURIComponent(element.getAttribute('content')));
content.APP = Object.assign({ autoboot: false }, content.APP);
config[name.slice(0, -1 * '/config/environment'.length)] = content;
mergeContent(element, config, '/config/environment');
let fastbootMerged = mergeContent(element, fastbootConfig, '/config/fastboot-environment');
if (fastbootMerged) {
element.remove();
}
}

let isFastbootConfigBuilt = Object.keys(fastbootConfig).length > 0;
if (isFastbootConfigBuilt) {
config = fastbootConfig;
}

let scripts = [];
let rootURL = getRootURL(appName, config);

for (let element of dom.window.document.querySelectorAll('script,fastboot-script')) {
Expand All @@ -27,6 +43,8 @@ function htmlEntrypoint(appName, distPath, htmlPath) {
let relativeSrc = urlWithin(src, rootURL);
if (relativeSrc) {
scripts.push(path.join(distPath, relativeSrc));
} else if (element.tagName === 'FASTBOOT-SCRIPT') {
scripts.push(path.join(distPath, src));
}
}
if (element.tagName === 'FASTBOOT-SCRIPT') {
Expand Down
96 changes: 90 additions & 6 deletions packages/fastboot/test/html-entrypoint-test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -222,11 +222,79 @@ describe('htmlEntrypoint', function() {
it('extracts configs from meta', function() {
let tmpobj = tmp.dirSync();
let tmpLocation = tmpobj.name;
let configObj = {
'my-app': {
APP: {
autoboot: false,
},
configKey: 'someValue',
},
'my-engine': {
APP: {
autoboot: false,
},
engineKey: 'engineValue',
},
};
let metaTags = Object.entries(configObj)
.map(
([name, options]) =>
`<meta name="${name}/config/fastboot-environment" content="${encodeURIComponent(
JSON.stringify(options)
)}"></meta>`
)
.join('\n');

let project = {
'index.html': `
<html>
<head>
${metaTags}
</head>
<body>
<script src="/custom-root-url/bar.js"></script>
</body>
</html>
`,
};

fixturify.writeSync(tmpLocation, project);
let { config } = htmlEntrypoint('my-app', tmpLocation, 'index.html');
expect(config).to.deep.equal(configObj);
});

it('support config fallback name "config/environement" when there is no fastboot-environement in HTML', function() {
let tmpobj = tmp.dirSync();
let tmpLocation = tmpobj.name;
let configObj = {
'my-app': {
APP: {
autoboot: false,
},
configKey: 'someValue',
},
'my-engine': {
APP: {
autoboot: false,
},
engineKey: 'engineValue',
},
};
let metaTags = Object.entries(configObj)
.map(
([name, options]) =>
`<meta name="${name}/config/environment" content="${encodeURIComponent(
JSON.stringify(options)
)}"></meta>`
)
.join('\n');

let project = {
'index.html': `
<html>
<meta name="my-app/config/environment" content="%7B%22rootURL%22%3A%22%2Fcustom-root-url%2F%22%7D" >
<head>
${metaTags}
</head>
<body>
<script src="/custom-root-url/bar.js"></script>
</body>
Expand All @@ -235,21 +303,37 @@ describe('htmlEntrypoint', function() {
};

fixturify.writeSync(tmpLocation, project);

let { config } = htmlEntrypoint('my-app', tmpLocation, 'index.html');
expect(config).to.deep.equal({
'my-app': { APP: { autoboot: false }, rootURL: '/custom-root-url/' },
});
expect(config).to.deep.equal(configObj);
});

it('understands customized rootURL', function() {
let tmpobj = tmp.dirSync();
let tmpLocation = tmpobj.name;
let config = {
'my-app': {
rootURL: '/custom-root-url/',
},
};

let metaTags = Object.entries(config)
.map(
([name, options]) =>
`<meta name="${name}/config/fastboot-environment" content="${encodeURIComponent(
JSON.stringify(options)
)}"></meta>`
)
.join('\n');

let project = {
'index.html': `
<html>
<meta name="my-app/config/environment" content="%7B%22rootURL%22%3A%22%2Fcustom-root-url%2F%22%7D" >
<head>
${metaTags}
</head>
<body>
<fastboot-script src="foo.js"></fastboot-script>
<script src="/custom-root-url/bar.js"></script>
</body>
</html>
Expand All @@ -259,6 +343,6 @@ describe('htmlEntrypoint', function() {
fixturify.writeSync(tmpLocation, project);

let { scripts } = htmlEntrypoint('my-app', tmpLocation, 'index.html');
expect(scripts).to.deep.equal([`${tmpLocation}/bar.js`]);
expect(scripts).to.deep.equal([`${tmpLocation}/foo.js`, `${tmpLocation}/bar.js`]);
});
});