appchance / ember-cached-shoe

Fastboot rehydration without redundant ajax

ember-cached-shoe

This addon tries to improve ember-cli-fastboot rehydration process. App served by fastboot server resolves model hooks twice - in node.js environment and in the browser. This behaviour leads to making redundant requests and causes additonal slowdown after initial load.

This addon solves this problem.

Installation

ember install ember-cached-shoe

Usage

Add to your app/adapters/application.js:

import Ember        from 'ember'
import DS           from 'ember-data'
import CachedShoe   from 'ember-cached-shoe'

export default  DS.JSONAPIAdapter.extend(CachedShoe, {
  // code ommited
})

It works with any type of adapter that implements ajax function (e.g. JSONAPIAdapter, RESTAdapter). Since now, second resolvation of model hooks, will serve cached response.

app/routes/my-route.js:

import Ember from 'ember'

export default  Ember.Route.extend({
  model() {
    this.store.findAll('posts') // called twice, second call serves cached response
  }
})

How it works

It leverages capabilities of fastboot.shoebox to store results of ajax calls performed on the server. Special token is generated for each request (based on url and data). Response is stored in shoebox under that token.

ember-cached-shoe's Issues

Cannot read property 'put' of undefined.

Hey, this addon seems like a great idea!

I'm unable to get it to work, ember 2.18.1 and fastboot v1.1.2 - it seems that the shoebox property is undefined in your addon's service.

I'll try and figure out why, but I thought I'd make you aware in the meantime in case I can't find a fix.

Please add the last couple of versions to the Releases tab

versions 0.2.0 and 0.2.1 have been published to npm, but are not showing up in the Releases tab. Would you mind adding the github releases, with some release notes?

ie/edge are broken

Hello,

Please consider upgrading b2a dependency to the latest version "b2a": "1.0.11".
We got exceptions in ie/edge so I had to make a pull request to b2a. Details are here kaelzhang/b2a#3

Thank you.

Not caching some requests

I'm noticing that some requests don't get cached. It works in many simple cases with a top level route but I have a scenario where this doesn't seem to work:

1. FastBoot runs and ember-cached-shoe caches all requests correctly.
2. The browser finishes loading the JS and shoebox <script> tags are correctly available in the DOM
3. Something happens, maybe a re-render by Ember that causes the script tags to disappear from the body
4. Ember tries to make an AJAX call for some async data (maybe a has-many relationship or related data) but the shoebox script tags are now missing so the full request happens again, causing a flicker on the screen.

Have you experienced this issue? Any common workarounds? It sounds like a hack but if the shoebox data could be stored in cookies instead of DOM, it wouldn't get blown away in this scenario.

Does not work with ember-fetch

Hi,

This addon works perfectly when used with the standard ajax requests like this:

import DS from 'ember-data';
import CachedShoe from 'ember-cached-shoe';

export default DS.JSONAPIAdapter.extend(CachedShoe {
});

But not when used together with the ember-fetch adapter mixin.

import DS from 'ember-data';
import AdapterFetch from 'ember-fetch/mixins/adapter-fetch';
import CachedShoe from 'ember-cached-shoe';

export default DS.JSONAPIAdapter.extend(CachedShoe, AdapterFetch {
});

As Ember Data adopts fetch and removes jQuery is this something that should be supported?

Thanks!

Deprecate this addon?

This addon does not appear to be actively maintained, and it seems like ember-data-storefront can provide this same functionality out of the box.

See the active Issues, including this comment.

I suggest marking this addon as deprecated, and redirecting folks to ember-data-storefront.

Broken in ember-cli 3.5+

Probably due to breaking changes in broccoli 2.

See: ember-cli/ember-cli#8140