Skip to content

Drop module unification support #825

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
mansona merged 1 commit into from
May 28, 2021
Merged

Drop module unification support #825

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
68 changes: 30 additions & 38 deletions packages/ember-cli-fastboot/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,8 +30,6 @@ function getVersionChecker(context) {
return checker;
}



/*
* Main entrypoint for the Ember CLI addon.
*/
Expand Down Expand Up @@ -62,10 +60,11 @@ module.exports = {
* See: https://ember-cli.com/user-guide/#integration
*/
included(app) {

let assetRev = this.project.addons.find(addon => addon.name === 'broccoli-asset-rev');
if(assetRev && !assetRev.supportsFastboot) {
throw new SilentError("This version of ember-cli-fastboot requires a newer version of broccoli-asset-rev");
if (assetRev && !assetRev.supportsFastboot) {
throw new SilentError(
'This version of ember-cli-fastboot requires a newer version of broccoli-asset-rev'
);
}

// set autoRun to false since we will conditionally include creating app when app files
Expand All @@ -91,8 +90,8 @@ module.exports = {
*/
importTransforms() {
return {
fastbootShim: fastbootTransform
}
fastbootShim: fastbootTransform,
};
},

/**
Expand All @@ -102,16 +101,15 @@ module.exports = {
*/
contentFor(type, config, contents) {
if (type === 'body') {
return "<!-- EMBER_CLI_FASTBOOT_BODY -->";
return '<!-- EMBER_CLI_FASTBOOT_BODY -->';
}

if (type === 'head') {
return "<!-- EMBER_CLI_FASTBOOT_TITLE --><!-- EMBER_CLI_FASTBOOT_HEAD -->";
return '<!-- EMBER_CLI_FASTBOOT_TITLE --><!-- EMBER_CLI_FASTBOOT_HEAD -->';
}

if (type === 'app-boot') {
const isModuleUnification = this._isModuleUnification();
return fastbootAppBoot(config.modulePrefix, JSON.stringify(config.APP || {}), isModuleUnification);
return fastbootAppBoot(config.modulePrefix, JSON.stringify(config.APP || {}));
}

// if the fastboot addon is installed, we overwrite the config-module so that the config can be read
Expand All @@ -121,10 +119,10 @@ module.exports = {
const appConfigModule = `${config.modulePrefix}`;
contents.splice(0, contents.length);
contents.push(
'if (typeof FastBoot !== \'undefined\') {',
'return FastBoot.config(\'' + appConfigModule + '\');',
"if (typeof FastBoot !== 'undefined') {",
"return FastBoot.config('" + appConfigModule + "');",
'} else {',
originalContents,
originalContents,
'}'
);
return;
Expand All @@ -144,7 +142,7 @@ module.exports = {
},

_processAddons(addons, fastbootTrees) {
addons.forEach((addon) => {
addons.forEach(addon => {
this._processAddon(addon, fastbootTrees);
});
},
Expand Down Expand Up @@ -177,7 +175,6 @@ module.exports = {
*/
_getFastbootTree() {
const appName = this._name;
const isModuleUnification = this._isModuleUnification();

let fastbootTrees = [];

Expand All @@ -192,22 +189,22 @@ module.exports = {

// transpile the fastboot JS tree
let mergedFastBootTree = new MergeTrees(fastbootTrees, {
overwrite: true
overwrite: true,
});

let funneledFastbootTrees = new Funnel(mergedFastBootTree, {
destDir: appName
destDir: appName,
});
const processExtraTree = p.preprocessJs(funneledFastbootTrees, '/', this._name, {
registry: this._appRegistry
registry: this._appRegistry,
});

// FastBoot app factory module
const writeFile = require('broccoli-file-creator');
let appFactoryModuleTree = writeFile("app-factory.js", fastbootAppFactoryModule(appName, this._isModuleUnification()));
let appFactoryModuleTree = writeFile('app-factory.js', fastbootAppFactoryModule(appName));

let newProcessExtraTree = new MergeTrees([processExtraTree, appFactoryModuleTree], {
overwrite: true
overwrite: true,
});

function stripLeadingSlash(filePath) {
Expand All @@ -216,7 +213,7 @@ module.exports = {

let appFilePath = stripLeadingSlash(this.app.options.outputPaths.app.js);
let finalFastbootTree = new Concat(newProcessExtraTree, {
outputFile: appFilePath.replace(/\.js$/, '-fastboot.js')
outputFile: appFilePath.replace(/\.js$/, '-fastboot.js'),
});

return finalFastbootTree;
Expand All @@ -235,7 +232,7 @@ module.exports = {
let fastbootConfigTree = this._buildFastbootConfigTree(newTree);

// Merge the package.json with the existing tree
return new MergeTrees([newTree, fastbootConfigTree], {overwrite: true});
return new MergeTrees([newTree, fastbootConfigTree], { overwrite: true });
},

/**
Expand All @@ -251,7 +248,7 @@ module.exports = {

if (config instanceof Array) {
let copy = [];
for (let i=0; i< config.length; i++) {
for (let i = 0; i < config.length; i++) {
copy[i] = this._cloneConfigObject(config[i]);
}

Expand Down Expand Up @@ -305,7 +302,7 @@ module.exports = {
outputPaths: this.app.options.outputPaths,
ui: this.ui,
fastbootAppConfig: fastbootAppConfig,
appConfig: appConfig
appConfig: appConfig,
});
},

Expand All @@ -318,26 +315,25 @@ module.exports = {
// that version contains API to hook fastboot into ember-cli

app.use((req, resp, next) => {
const fastbootQueryParam = (req.query.hasOwnProperty('fastboot') && req.query.fastboot === 'false') ? false : true;
const fastbootQueryParam =
req.query.hasOwnProperty('fastboot') && req.query.fastboot === 'false' ? false : true;
const enableFastBootServe = !process.env.FASTBOOT_DISABLED && fastbootQueryParam;

if (req.serveUrl && enableFastBootServe) {
// if it is a base page request, then have fastboot serve the base page
if (!this.fastboot) {
const broccoliHeader = req.headers['x-broccoli'];
const outputPath = broccoliHeader['outputPath'];
const fastbootOptions = Object.assign(
{},
this.fastbootOptions,
{ distPath: outputPath }
);
const fastbootOptions = Object.assign({}, this.fastbootOptions, {
distPath: outputPath,
});

this.ui.writeLine(chalk.green('App is being served by FastBoot'));
this.fastboot = new FastBoot(fastbootOptions);
}

let fastbootMiddleware = FastBootExpressMiddleware({
fastboot: this.fastboot
fastboot: this.fastboot,
});

fastbootMiddleware(req, resp, next);
Expand All @@ -356,7 +352,7 @@ module.exports = {
// in sandbox.
this.ui.writeLine(chalk.blue('Reloading FastBoot...'));
this.fastboot.reload({
distPath: result.directory
distPath: result.directory,
});
}
},
Expand All @@ -378,10 +374,6 @@ module.exports = {
return checker.for('ember', 'bower');
},

_isModuleUnification() {
return (typeof this.project.isModuleUnification === 'function') && this.project.isModuleUnification();
},

/**
* Reads FastBoot configuration from application's `config/fastboot.js` file if present,
* otherwise returns empty object.
Expand All @@ -398,5 +390,5 @@ module.exports = {
return require(configPath)(environment);
}
return {};
}
},
};
4 changes: 2 additions & 2 deletions packages/ember-cli-fastboot/lib/utilities/fastboot-app-boot.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@

// Added as app boot code to app.js that allows booting of the application
// in browser. This code is injected during app-boot type of contentFor hook for ember-cli.
module.exports = function fastbootAppBoot(prefix, configAppAsString, isModuleUnification) {
var appSuffix = isModuleUnification ? "src/main" : "app";
module.exports = function fastbootAppBoot(prefix, configAppAsString) {
var appSuffix = "app";
return [
"",
"if (typeof FastBoot === 'undefined') {",
Expand Down
8 changes: 4 additions & 4 deletions packages/ember-cli-fastboot/lib/utilities/fastboot-app-factory-module.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
'use strict';

// Expose the an factory for the creating the `Application` object
// Expose an factory for the creating the `Application` object
// with the proper config at a known path, so that the server does
// not have to disover the app's module prefix ("my-app").
// not have to discover the app's module prefix ("my-app").
//
// The module defined here is prefixed with a `~` to make it less
// likely to collide with user code, since it is not possible to
// define a module with a name like this in the file system.
module.exports = function fastBootAppFactoryModule(prefix, isModuleUnification) {
var appSuffix = isModuleUnification ? "src/main" : "app";
module.exports = function fastBootAppFactoryModule(prefix) {
var appSuffix = "app";
return [
"define('~fastboot/app-factory', ['{{MODULE_PREFIX}}/" + appSuffix + "', '{{MODULE_PREFIX}}/config/environment'], function(App, config) {",
" App = App['default'];",
Expand Down