Skip to content

Commit

Permalink
Allow enviroment set _renderMode to be used in Visit
Browse files Browse the repository at this point in the history
This is part of an arching plan to introduce Glimmer's
rehydration/serializtion modes to Ember proper.

There are 4 PR's that are all interwoven, of which, this is one.

- [ ] Glimmer.js: glimmerjs/glimmer-vm#783 (comment)
- [ ] Ember.js: emberjs/ember.js#16227
- [ ] Fastboot: ember-fastboot/fastboot#185
- [ ] EmberCLI Fastboot: ember-fastboot#580

In order of need to land they are:

Glimmer.js:
glimmerjs/glimmer-vm#783 (comment)

This resolves a rather intimate API problem.  Glimmer-vm expects a very
specific comment node to exist to know whether or not the rehydration
element builder can do it's job properly.  If it is not found on the
first node from `rootElement` it throws.

In fastboot however we are certain that there will already be existant
elements in the way that will happen before rendered content.

This PR just iterates through the nodes until it finds the expected
comment node.  And only throws if it never finds one.

---

Ember.js:
emberjs/ember.js#16227

This PR modifies the `visit` API to allow a private _renderMode to be
set to either serialize or rehydrate.  In SSR environments the
assumption (as it is here in this fastboot PR) is that we'll set the
visit API to serialize mode which ensures glimmer-vm's serialize element
builder is used to build the API.

The serialize element builder ensures that we have the necessary fidelty
to rehydrate correctly and is mandatory input for rehydration.

---

Fastboot:
ember-fastboot/fastboot#185

This allows enviroment variable to set _renderMode to be used in Visit
API.  Fastboot must send content to browser made with the serialization
element builder to ensure rehydration can be sucessful.

---

EmberCLI Fastboot:
ember-fastboot#580

Finally this does the fun part of disabling the current
clear-double-render instance-initializer

We first check to ensure we are in a non-fastboot environment.  Then we
ensure that we can find the expected comment node from glimmer-vm's
serialize element builder.  This ensures that this change will only
effect peoeple who use ember-cli-fastboot with the serialized output
from the currently experimental fastboot setup

Then we ensure `ApplicationInstance#_bootSync` specifies the rehydrate
_renderMode.

This is done in `_bootSync` this way because visit is currently not used
to boot ember applications.  And we must instead set bootOptions this
way instead.

We also remove the markings for `fastboot-body-start` and
`fastboot-body-end` to ensure clear-double render instance-initializer
is never called.
  • Loading branch information
rondale-sc committed Feb 23, 2018
1 parent 95fff79 commit 37d1f21
Show file tree
Hide file tree
Showing 3 changed files with 27 additions and 1 deletion.
1 change: 1 addition & 0 deletions index.js
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,7 @@ module.exports = {
app.options.fingerprint.generateAssetMap = true;
}

app.import('vendor/experimental-render-mode-rehydrate.js');
// get the app registry object and app name so that we can build the fastboot
// tree
this._appRegistry = app.registry;
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@
"ember-cli-lodash-subset": "2.0.1",
"ember-cli-preprocess-registry": "^3.1.0",
"ember-cli-version-checker": "^2.1.0",
"fastboot": "^1.1.3",
"fastboot": "github:rondale-sc/fastboot#utilize-rehydration-serialization-from-glimmer",
"fastboot-express-middleware": "^1.1.0",
"fastboot-transform": "^0.1.2",
"fs-extra": "^4.0.2",
Expand Down
25 changes: 25 additions & 0 deletions vendor/experimental-render-mode-rehydrate.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
(function() {
if (typeof FastBoot === 'undefined') {
var current = document.getElementById('fastboot-body-start');

if (current && current.nextSibling.nodeValue === '%+b:0%') {
Ember.ApplicationInstance.reopen({
_bootSync: function(options) {
if (options === undefined) {
options = {
_renderMode: 'rehydrate'
};
}

return this._super(options);
}
});

// Prevent clearRender by removing `fastboot-body-start` which is already
// guarded for
current.parentNode.removeChild(current);
var end = document.getElementById('fastboot-body-end');
end.parentNode.removeChild(end);
}
}
})();

0 comments on commit 37d1f21

Please sign in to comment.