github/meteor
1
1
Fork 0
mirror of https://github.com/meteor/meteor.git synced 2026-05-02 03:01:46 -04:00
Code Issues Packages Projects Releases Wiki Activity

Expose options disableOplog, pollingInterval, and pollingThrottle to Cursor.find

Browse Source 
These can be useful to tune performance for application specific data patterns.
This commit is contained in:
Nick Martin
2016-01-12 16:17:35 -08:00
parent c144e0c7d3
commit 741b38017c
4 changed files with 14 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
History.md
View File

@@ -15,6 +15,8 @@
* Allow `git+` URL schemes for npm dependencies #844
* Expose options `disableOplog`, `pollingInterval`, and `pollingThrottle` to `Cursor.find` for tuning observe parameters on the server.
Patches contributed by GitHub users vereed, devgrok, ...

3
packages/mongo/collection.js
View File

@@ -280,6 +280,9 @@ _.extend(Mongo.Collection.prototype, {
* @param {MongoFieldSpecifier} options.fields Dictionary of fields to return or exclude.
* @param {Boolean} options.reactive (Client only) Default `true`; pass `false` to disable reactivity
* @param {Function} options.transform Overrides `transform` on the [`Collection`](#collections) for this cursor. Pass `null` to disable transformation.
* @param {Boolean} options.disableOplog (Server only) Pass true to disable oplog-tailing on this query. This affects the way server processes calls to `observe` on this query. Disabling the oplog can be useful when working with data that updates in large batches.
* @param {Number} options.pollingInterval (Server only) How often to poll this query when observing on the server. In milliseconds. Defaults to 10 seconds.
* @param {Number} options.pollingThrottle (Server only) Minimum time to allow between re-polling. Increasing this will save CPU and mongo load at the expense of slower updates to users. Decreasing this is not recommended. In milliseconds. Defaults to 50 milliseconds.
* @returns {Mongo.Cursor}
*/
find: function (/* selector, options */) {

3
packages/mongo/oplog_observe_driver.js
View File

@@ -959,7 +959,8 @@ OplogObserveDriver.cursorSupported = function (cursorDescription, matcher) {
var options = cursorDescription.options;
// Did the user say no explicitly?
if (options._disableOplog)
// underscored version of the option is COMPAT with 1.2
if (options.disableOplog || options._disableOplog)
return false;
// skip is not supported: to support it we would need to keep track of all

10
packages/mongo/polling_observe_driver.js
View File

@@ -28,7 +28,8 @@ PollingObserveDriver = function (options) {
// Make sure to create a separately throttled function for each
// PollingObserveDriver object.
self._ensurePollIsScheduled = _.throttle(
self._unthrottledEnsurePollIsScheduled, 50 /* ms */);
self._unthrottledEnsurePollIsScheduled,
self._cursorDescription.options.pollingThrottle || 50 /* ms */);
// XXX figure out if we still need a queue
self._taskQueue = new Meteor._SynchronousQueue();
@@ -43,7 +44,7 @@ PollingObserveDriver = function (options) {
self._pendingWrites.push(fence.beginWrite());
// Ensure a poll is scheduled... but if we already know that one is,
// don't hit the throttled _ensurePollIsScheduled function (which might
// lead to us calling it unnecessarily in 50ms).
// lead to us calling it unnecessarily in <pollingThrottle> ms).
if (self._pollsScheduledButNotStarted === 0)
self._ensurePollIsScheduled();
}
@@ -60,7 +61,10 @@ PollingObserveDriver = function (options) {
if (options._testOnlyPollCallback) {
self._testOnlyPollCallback = options._testOnlyPollCallback;
} else {
var pollingInterval = self._cursorDescription.options._pollingInterval || 10 * 1000;
var pollingInterval =
self._cursorDescription.options.pollingInterval ||
self._cursorDescription.options._pollingInterval || // COMPAT with 1.2
10 * 1000;
var intervalHandle = Meteor.setInterval(
_.bind(self._ensurePollIsScheduled, self), pollingInterval);
self._stopCallbacks.push(function () {