Skip to content
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

Jump to bottom

For readSnapshots middleware, add method and parameter properties to first parameter #263

Merged
merged 5 commits into from
Feb 14, 2019
Merged

For readSnapshots middleware, add method and parameter properties to first parameter #263

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
5dd070b
For readSnapshots middleware, add requestMethod and requestParams pro…
ericyhwang Jan 16, 2019
58e29e6
Code review changes for readSnapshots middleware
ericyhwang Jan 16, 2019
57c8598
Switch readSnapshots middleware context to use named class/constants
ericyhwang Feb 6, 2019
15a438f
Merge branch 'master' into readSnapshots-context
ericyhwang Feb 7, 2019
7e12683
Support new readSnapshots context info in fetchSnapshotByTimestamp
ericyhwang Feb 7, 2019
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
90 changes: 73 additions & 17 deletions lib/backend.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -77,6 +77,24 @@ Backend.prototype.MIDDLEWARE_ACTIONS = {
submit: 'submit'
};

// Context provided to readSnapshots middleware
function ReadSnapshotsContext(method, parameters, snapshotType) {
this.method = method;
this.parameters = parameters;
this.snapshotType = snapshotType;
this.collection = null; // Set during _sanitizeSnapshots
this.snapshots = null; // Set during _sanitizeSnapshots
}

Backend.prototype.READ_SNAPSHOTS_METHODS = {
fetch: 'fetch',
fetchBulk: 'fetchBulk',
fetchSnapshot: 'fetchSnapshot',
fetchSnapshotByTimestamp: 'fetchSnapshotByTimestamp',
queryFetch: 'queryFetch',
querySubscribe: 'querySubscribe'
};

Backend.prototype.SNAPSHOT_TYPES = {
// The current snapshot is being fetched (eg through backend.fetch)
current: 'current',
Expand Down Expand Up @@ -274,7 +292,7 @@ Backend.prototype._sanitizeOpsBulk = function(agent, projection, collection, ops
}, callback);
};

Backend.prototype._sanitizeSnapshots = function(agent, projection, collection, snapshots, snapshotType, callback) {
Backend.prototype._sanitizeSnapshots = function(agent, projection, collection, snapshots, requestContext, callback) {
if (projection) {
try {
projections.projectSnapshots(projection.fields, snapshots);
Expand All @@ -283,13 +301,10 @@ Backend.prototype._sanitizeSnapshots = function(agent, projection, collection, s
}
}

var request = {
collection: collection,
snapshots: snapshots,
snapshotType: snapshotType
};
requestContext.collection = collection;
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It might be a good optimisation to initialise these properties whenever requestContext is initialised. It may be beneficial to declare a class for clarity about what exact information we're expecting in the middleware.

requestContext.snapshots = snapshots;

this.trigger(this.MIDDLEWARE_ACTIONS.readSnapshots, agent, request, callback);
this.trigger(this.MIDDLEWARE_ACTIONS.readSnapshots, agent, requestContext, callback);
};

Backend.prototype._getSnapshotProjection = function(db, projection) {
Expand Down Expand Up @@ -368,7 +383,15 @@ Backend.prototype.fetch = function(agent, index, id, callback) {
if (err) return callback(err);
var snapshotProjection = backend._getSnapshotProjection(backend.db, projection);
var snapshots = [snapshot];
backend._sanitizeSnapshots(agent, snapshotProjection, collection, snapshots, backend.SNAPSHOT_TYPES.current, function(err) {
var requestContext = new ReadSnapshotsContext(
backend.READ_SNAPSHOTS_METHODS.fetch,
{
index: index,
id: id
},
backend.SNAPSHOT_TYPES.current
);
backend._sanitizeSnapshots(agent, snapshotProjection, collection, snapshots, requestContext, function(err) {
if (err) return callback(err);
backend.emit('timing', 'fetch', Date.now() - start, request);
callback(null, snapshot);
Expand All @@ -392,7 +415,15 @@ Backend.prototype.fetchBulk = function(agent, index, ids, callback) {
if (err) return callback(err);
var snapshotProjection = backend._getSnapshotProjection(backend.db, projection);
var snapshots = backend._getSnapshotsFromMap(ids, snapshotMap);
backend._sanitizeSnapshots(agent, snapshotProjection, collection, snapshots, backend.SNAPSHOT_TYPES.current, function(err) {
var requestContext = new ReadSnapshotsContext(
backend.READ_SNAPSHOTS_METHODS.fetchBulk,
{
index: index,
ids: ids
},
backend.SNAPSHOT_TYPES.current
);
backend._sanitizeSnapshots(agent, snapshotProjection, collection, snapshots, requestContext, function(err) {
if (err) return callback(err);
backend.emit('timing', 'fetchBulk', Date.now() - start, request);
callback(null, snapshotMap);
Expand Down Expand Up @@ -501,7 +532,7 @@ Backend.prototype.queryFetch = function(agent, index, query, options, callback)
var backend = this;
backend._triggerQuery(agent, index, query, options, function(err, request) {
if (err) return callback(err);
backend._query(agent, request, function(err, snapshots, extra) {
backend._query(agent, backend.READ_SNAPSHOTS_METHODS.queryFetch, request, function(err, snapshots, extra) {
if (err) return callback(err);
backend.emit('timing', 'queryFetch', Date.now() - start, request);
callback(null, snapshots, extra);
Expand Down Expand Up @@ -535,7 +566,7 @@ Backend.prototype.querySubscribe = function(agent, index, query, options, callba
return;
}
// Issue query on db to get our initial results
backend._query(agent, request, function(err, snapshots, extra) {
backend._query(agent, backend.READ_SNAPSHOTS_METHODS.querySubscribe, request, function(err, snapshots, extra) {
if (err) {
stream.destroy();
return callback(err);
Expand Down Expand Up @@ -576,11 +607,20 @@ Backend.prototype._triggerQuery = function(agent, index, query, options, callbac
});
};

Backend.prototype._query = function(agent, request, callback) {
Backend.prototype._query = function(agent, method, request, callback) {
var backend = this;
request.db.query(request.collection, request.query, request.fields, request.options, function(err, snapshots, extra) {
if (err) return callback(err);
backend._sanitizeSnapshots(agent, request.snapshotProjection, request.collection, snapshots, backend.SNAPSHOT_TYPES.current, function(err) {
var requestContext = new ReadSnapshotsContext(
method,
{
index: request.index,
query: request.query,
options: request.options,
},
backend.SNAPSHOT_TYPES.current
);
backend._sanitizeSnapshots(agent, request.snapshotProjection, request.collection, snapshots, requestContext, function(err) {
callback(err, snapshots, extra);
});
});
Expand Down Expand Up @@ -618,8 +658,16 @@ Backend.prototype.fetchSnapshot = function(agent, index, id, version, callback)
if (error) return callback(error);
var snapshotProjection = backend._getSnapshotProjection(backend.db, projection);
var snapshots = [snapshot];
var snapshotType = backend.SNAPSHOT_TYPES.byVersion;
backend._sanitizeSnapshots(agent, snapshotProjection, collection, snapshots, snapshotType, function (error) {
var requestContext = new ReadSnapshotsContext(
backend.READ_SNAPSHOTS_METHODS.fetchSnapshot,
{
index: index,
id: id,
version: version,
},
backend.SNAPSHOT_TYPES.byVersion
);
backend._sanitizeSnapshots(agent, snapshotProjection, collection, snapshots, requestContext, function (error) {
if (error) return callback(error);
backend.emit('timing', 'fetchSnapshot', Date.now() - start, request);
callback(null, snapshot);
Expand Down Expand Up @@ -671,8 +719,16 @@ Backend.prototype.fetchSnapshotByTimestamp = function (agent, index, id, timesta
if (error) return callback(error);
var snapshotProjection = backend._getSnapshotProjection(backend.db, projection);
var snapshots = [snapshot];
var snapshotType = backend.SNAPSHOT_TYPES.byTimestamp;
backend._sanitizeSnapshots(agent, snapshotProjection, collection, snapshots, snapshotType, function (error) {
var requestContext = new ReadSnapshotsContext(
backend.READ_SNAPSHOTS_METHODS.fetchSnapshotByTimestamp,
{
index: index,
id: id,
timestamp: timestamp,
},
backend.SNAPSHOT_TYPES.byTimestamp
);
backend._sanitizeSnapshots(agent, snapshotProjection, collection, snapshots, requestContext, function (error) {
if (error) return callback(error);
backend.emit('timing', 'fetchSnapshot', Date.now() - start, request);
callback(null, snapshot);
Expand Down
2 changes: 2 additions & 0 deletions test/client/snapshot-timestamp-request.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -326,6 +326,8 @@ describe('SnapshotTimestampRequest', function () {
it('triggers the middleware', function (done) {
backend.use(backend.MIDDLEWARE_ACTIONS.readSnapshots,
function (request) {
expect(request.method).to.eql(backend.READ_SNAPSHOTS_METHODS.fetchSnapshotByTimestamp);
expect(request.parameters).to.eql({index: 'books', id: 'time-machine', timestamp: day3});
expect(request.snapshots[0]).to.eql(v3);
expect(request.snapshotType).to.be(backend.SNAPSHOT_TYPES.byTimestamp);
done();
Expand Down
4 changes: 4 additions & 0 deletions test/middleware.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -199,6 +199,8 @@ describe('middleware', function() {
var doneAfter = util.callAfter(1, done);
backend.use('readSnapshots', function(request, next) {
expect(request.snapshots).to.have.length(1);
expect(request.method).to.be.a('string');
expect(request.parameters).to.be.ok;
expectFido(request);
doneAfter();
next();
Expand All @@ -210,6 +212,8 @@ describe('middleware', function() {
var doneAfter = util.callAfter(1, done);
backend.use('readSnapshots', function(request, next) {
expect(request.snapshots).to.have.length(2);
expect(request.method).to.be.a('string');
expect(request.parameters).to.be.ok;
expectFido(request);
expectSpot(request);
doneAfter();
Expand Down