https://github.com/blimmer/node-ember-cli-deploy-redis
Easily fetch ember-cli-deploy revisions from redis in a node app
https://github.com/blimmer/node-ember-cli-deploy-redis
Last synced: 12 months ago
JSON representation
Easily fetch ember-cli-deploy revisions from redis in a node app
- Host: GitHub
- URL: https://github.com/blimmer/node-ember-cli-deploy-redis
- Owner: blimmer
- Created: 2015-05-24T21:48:47.000Z (about 11 years ago)
- Default Branch: master
- Last Pushed: 2022-02-11T00:28:12.000Z (over 4 years ago)
- Last Synced: 2025-05-21T11:56:00.903Z (about 1 year ago)
- Language: JavaScript
- Homepage:
- Size: 129 KB
- Stars: 13
- Watchers: 2
- Forks: 6
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
Awesome Lists containing this project
README
# node-ember-cli-deploy-redis [](https://travis-ci.org/blimmer/node-ember-cli-deploy-redis)
ExpressJS middleware to fetch the current (or specified) revision of your Ember App deployed by [ember-cli-deploy](https://github.com/ember-cli/ember-cli-deploy).
## Why?
[ember-cli-deploy](https://github.com/ember-cli/ember-cli-deploy) is great. It allows you to run
multiple versions in production at the same time and view revisions without impacting users.
However, [the example provided](https://github.com/philipheinser/ember-lightning) uses [koa](http://koajs.com/)
and many of us are not. This package allows you to easily fetch current and specified `index.html`
revisions from [redis](http://redis.io) with [Express](expressjs.com) and other Node servers.
## Installation
It's important to choose the right version of this library to match the version of
ember-cli-deploy you're using.
| ember-cli-deploy version | node-ember-cli-deploy-redis |
|--------------------------|-----------------------------|
| pre 0.5 | ^0.2.0 or lower |
| 0.5 and beyond | ^0.3.0 or newer |
Make sure to look at the
[older documentation](https://github.com/blimmer/node-ember-cli-deploy-redis/blob/v0.2.0/README.md)
if you're on a pre 0.5 ember-cli-deploy release.
See [the changelog](https://github.com/blimmer/node-ember-cli-deploy-redis/blob/develop/CHANGELOG.md#030---2015-11-07)
for an upgrade guide.
## Usage
There are two main ways of using this library. For most simple Express servers, you'll
want to simply use the middleware. However, if you need more flexibility, you'll
want to use the internal `fetch` methods, with custom logic.
### ExpressJS Middleware
1. `require` the package
2. `use` the package in your app
#### Example
```javascript
const express = require('express');
const app = express();
const nodeEmberCliDeployRedis = require('node-ember-cli-deploy-redis');
app.use('/*', nodeEmberCliDeployRedis('myapp:index', {
host: 'redis.example.org', // default is localhost
port: 6929, // default is 6379
password: 'passw0rd!', // default is undefined
db: 0 // default is undefined
}));
```
### Custom Fetch Method
1. `require` the package
2. Use the `fetchIndex` method
3. Render the index string as you wish.
#### Example
```javascript
const express = require('express');
const app = express();
const fetchIndex = require('node-ember-cli-deploy-redis/fetch');
app.get('/', function(req, res) {
fetchIndex(req, 'myapp:index', {
host: 'redis.example.org',
port: 6929,
password: 'passw0rd!',
db: 0
}).then(function (indexHtml) {
indexHtml = serverVarInjectHelper.injectServerVariables(indexHtml, req);
res.status(200).send(indexHtml);
}).catch(function(err) {
res.status(500).send('Oh noes!\n' + err.message);
});
});
```
Check out [location-aware-ember-server](https://github.com/blimmer/location-aware-ember-server) for a running example.
## Documentation
### `nodeEmberCliDeployRedis(keyPrefix, connectionInfo, options)` (middleware constructor)
* keyPrefix (required) - the application name, specified for ember deploy
the keys in redis are prefaced with this name. For instance, if your redis keys are `my-app:index:current`, you'd pass `my-app:index`.
* connectionInfo (required) - the configuration to connect to redis.
internally, this library uses [ioredis](https://github.com/luin/ioredis), so pass a configuration supported by ioredis. please see their README for more information.
* options (optional) - a hash of params to override [the defaults](https://github.com/blimmer/node-ember-cli-deploy-redis/blob/develop/README.md#options)
### `fetchIndex(request, keyPrefix, connectionInfo, options)`
Arguments
* request (required) - the request object
the request object is used to check for the presence of `revisionQueryParam`
* keyPrefix (required) - the application name, specified for ember deploy
the keys in redis are prefaced with this name. For instance, if your redis keys are `my-app:index:current`, you'd pass `my-app:index`.
* connectionInfo (required) - the configuration to connect to redis.
internally, this library uses [ioredis](https://github.com/luin/ioredis), so pass a configuration supported by ioredis.
* options (optional) - a hash of params to override [the defaults](https://github.com/blimmer/node-ember-cli-deploy-redis/blob/develop/README.md#options)
Returns
* a `Promise`
when resolved, it returns the requested `index.html` string
when failed, it returns an [EmberCliDeployError](https://github.com/blimmer/node-ember-cli-deploy-redis/blob/develop/errors/ember-cli-deploy-error.js).
### options
* `revisionQueryParam` (defaults to `index_key`)
the query parameter to specify a revision (e.g. `http://example.org/?index_key=abc123`). the key will be automatically prefaced with your `keyPrefix` for security.
* `memoize` (defaults to `false`)
enable memoizing Redis `get`s. see [the memoization section](#Memoization) for more details.
* `memoizeOpts` ([see defaults](https://github.com/blimmer/node-ember-cli-deploy-redis/blob/master/fetch.js#L18))
customize memoization parameters. see [the memoization section](#Memoization) for more details.
## Memoization
Since the majority of the requests will be serving the `current` version of your
app, you can enable memoization to reduce the load on Redis. By default, memoization
is disabled. To enable it, simply pass:
```javascript
memoize: true
```
in your options hash. Additionally, you can pass options to the underlying memoization
library ([memoizee](https://github.com/medikoo/memoizee)). Check out their documentation,
and the [defaults](https://github.com/blimmer/node-ember-cli-deploy-redis/blob/master/fetch.js#L18)
for this library.
### Example
```javascript
app.use('/*', nodeEmberCliDeployRedis(
'myapp:index',
{ host: 'redis.example.org' },
{ memoize: true },
));
```
## Testing
In order to facilitate unit testing and/or integration testing this
library exports a mockable redis api. You will need to use a
dependency injection framework such as
[rewire](https://github.com/jhnns/rewire) to activate this testing api.
### Usage with rewire (mocha syntax)
```javascript
// my-module.js
const fetchIndex = require('node-ember-cli-deploy-redis/fetch');
const indexWrapper = function(req, res) {
return fetchIndex(req, 'app', {
// real redis config
}).then(function (indexHtml)) {
// do something with index
});
};
module.exports = indexWrapper;
// my-module-test.js
const redisTestApi = require('node-ember-cli-deploy-redis/test/helpers/test-api');
const fetchIndex = rewire('node-ember-cli-deploy-redis/fetch');
const redis = redisTestApi.ioRedisApi;
const myModule = rewire('my-module');
describe('my module', function() {
afterEach(function() {
fetchIndex.__set__('_initialized', false);
});
it('grabs my content', function() {
// inject mocked content
myModule.__set__('fetchIndex', fetchIndex);
fetchIndex.__set__('ioRedis', redis);
redis.set('app:abc123', "
hello test world
");
myModule(req, res).then(function(){
// assertions here
})
});
});
```
## Notes
* Don't create any other redis keys you don't want exposed to the public under your `keyPrefix`.
## Contributing
Comments/PRs/Issues are welcome!
### Cloning
This project utilizes git submodules. Please use the following command to clone:
```console
git clone --recurse-submodules https://github.com/blimmer/node-ember-cli-deploy-redis.git
```
### Running Project Unit Tests
```console
npm test
```
### Running Project Smoke Tests
```console
npm run smoke-test
```