mongodb-livedata-server 0.0.1

package/dist/meteor/ddp/session-document-view.js

@@ -0,0 +1,82 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SessionDocumentView = void 0;
+const ejson_1 = require("../ejson/ejson");
+// Represents a single document in a SessionCollectionView
+class SessionDocumentView {
+    constructor() {
+        this.existsIn = new Set();
+        this.dataByKey = new Map();
+    }
+    ;
+    getFields() {
+        var ret = {};
+        this.dataByKey.forEach((precedenceList, key) => {
+            ret[key] = precedenceList[0].value;
+        });
+        return ret;
+    }
+    clearField(subscriptionHandle, key, changeCollector) {
+        // Publish API ignores _id if present in fields
+        if (key === "_id")
+            return;
+        const precedenceList = this.dataByKey.get(key);
+        // It's okay to clear fields that didn't exist. No need to throw
+        // an error.
+        if (!precedenceList)
+            return;
+        let removedValue = undefined;
+        for (var i = 0; i < precedenceList.length; i++) {
+            var precedence = precedenceList[i];
+            if (precedence.subscriptionHandle === subscriptionHandle) {
+                // The view's value can only change if this subscription is the one that
+                // used to have precedence.
+                if (i === 0)
+                    removedValue = precedence.value;
+                precedenceList.splice(i, 1);
+                break;
+            }
+        }
+        if (precedenceList.length === 0) {
+            this.dataByKey.delete(key);
+            changeCollector[key] = undefined;
+        }
+        else if (removedValue !== undefined && !(0, ejson_1.equals)(removedValue, precedenceList[0].value)) {
+            changeCollector[key] = precedenceList[0].value;
+        }
+    }
+    changeField(subscriptionHandle, key, value, changeCollector, isAdd) {
+        // Publish API ignores _id if present in fields
+        if (key === "_id")
+            return;
+        // Don't share state with the data passed in by the user.
+        value = (0, ejson_1.clone)(value);
+        if (!this.dataByKey.has(key)) {
+            this.dataByKey.set(key, [{
+                    subscriptionHandle: subscriptionHandle,
+                    value: value
+                }]);
+            changeCollector[key] = value;
+            return;
+        }
+        const precedenceList = this.dataByKey.get(key);
+        let elt;
+        if (!isAdd) {
+            elt = precedenceList.find(precedence => {
+                return precedence.subscriptionHandle === subscriptionHandle;
+            });
+        }
+        if (elt) {
+            if (elt === precedenceList[0] && !(0, ejson_1.equals)(value, elt.value)) {
+                // this subscription is changing the value of this field.
+                changeCollector[key] = value;
+            }
+            elt.value = value;
+        }
+        else {
+            // this subscription is newly caring about this field
+            precedenceList.push({ subscriptionHandle: subscriptionHandle, value: value });
+        }
+    }
+}
+exports.SessionDocumentView = SessionDocumentView;

package/dist/meteor/ddp/session.js

@@ -0,0 +1,570 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DDPSession = void 0;
+const method_invocation_1 = require("./method-invocation");
+const writefence_1 = require("./writefence");
+const double_ended_queue_1 = __importDefault(require("double-ended-queue"));
+const main_1 = require("../random/main");
+const livedata_server_1 = require("./livedata_server");
+const heartbeat_1 = require("./heartbeat");
+const utils_1 = require("./utils");
+const diff_1 = require("../diff-sequence/diff");
+const session_collection_view_1 = require("./session-collection-view");
+const subscription_1 = require("./subscription");
+class DDPSession {
+    constructor(server, version, socket, options) {
+        this.protocol_handlers = {
+            sub: async function (msg) {
+                var self = this;
+                // reject malformed messages
+                if (typeof (msg.id) !== "string" ||
+                    typeof (msg.name) !== "string" ||
+                    (('params' in msg) && !(msg.params instanceof Array))) {
+                    self.sendError("Malformed subscription", msg);
+                    return;
+                }
+                if (!self.server.publish_handlers[msg.name]) {
+                    self.send({
+                        msg: 'nosub', id: msg.id,
+                        error: (0, livedata_server_1.ddpError)(404, `Subscription '${msg.name}' not found`)
+                    });
+                    return;
+                }
+                if (self._namedSubs.has(msg.id))
+                    // subs are idempotent, or rather, they are ignored if a sub
+                    // with that id already exists. this is important during
+                    // reconnect.
+                    return;
+                // XXX It'd be much better if we had generic hooks where any package can
+                // hook into subscription handling, but in the mean while we special case
+                // ddp-rate-limiter package. This is also done for weak requirements to
+                // add the ddp-rate-limiter package in case we don't have Accounts. A
+                // user trying to use the ddp-rate-limiter must explicitly require it.
+                /* if (Package['ddp-rate-limiter']) {
+                  var DDPRateLimiter = Package['ddp-rate-limiter'].DDPRateLimiter;
+                  var rateLimiterInput = {
+                    userId: self.userId,
+                    clientAddress: self.connectionHandle.clientAddress,
+                    type: "subscription",
+                    name: msg.name,
+                    connectionId: self.id
+                  };
+          
+                  DDPRateLimiter._increment(rateLimiterInput);
+                  var rateLimitResult = DDPRateLimiter._check(rateLimiterInput);
+                  if (!rateLimitResult.allowed) {
+                    self.send({
+                      msg: 'nosub', id: msg.id,
+                      error: ddpError(
+                        'too-many-requests',
+                        DDPRateLimiter.getErrorMessage(rateLimitResult),
+                        {timeToReset: rateLimitResult.timeToReset})
+                    });
+                    return;
+                  }
+                }*/
+                var handler = self.server.publish_handlers[msg.name];
+                self._startSubscription(handler, msg.id, msg.params, msg.name);
+            },
+            unsub: async function (msg) {
+                var self = this;
+                self._stopSubscription(msg.id);
+            },
+            method: async function (msg) {
+                var self = this;
+                // Reject malformed messages.
+                // For now, we silently ignore unknown attributes,
+                // for forwards compatibility.
+                if (typeof (msg.id) !== "string" ||
+                    typeof (msg.method) !== "string" ||
+                    (('params' in msg) && !(msg.params instanceof Array)) ||
+                    (('randomSeed' in msg) && (typeof msg.randomSeed !== "string"))) {
+                    self.sendError("Malformed method invocation", msg);
+                    return;
+                }
+                var randomSeed = msg.randomSeed || null;
+                // Set up to mark the method as satisfied once all observers
+                // (and subscriptions) have reacted to any writes that were
+                // done.
+                var fence = new writefence_1._WriteFence();
+                fence.onAllCommitted(function () {
+                    // Retire the fence so that future writes are allowed.
+                    // This means that callbacks like timers are free to use
+                    // the fence, and if they fire before it's armed (for
+                    // example, because the method waits for them) their
+                    // writes will be included in the fence.
+                    fence.retire();
+                    self.send({ msg: 'updated', methods: [msg.id] });
+                });
+                // Find the handler
+                var handler = self.server.method_handlers[msg.method];
+                if (!handler) {
+                    self.send({ msg: 'result', id: msg.id, error: (0, livedata_server_1.ddpError)(404, `Method '${msg.method}' not found`) });
+                    fence.arm();
+                    return;
+                }
+                var setUserId = function (userId) {
+                    self._setUserId(userId);
+                };
+                var invocation = new method_invocation_1.MethodInvocation({
+                    isSimulation: false,
+                    userId: self.userId,
+                    setUserId: setUserId,
+                    connection: self.connectionHandle,
+                    randomSeed: randomSeed
+                });
+                const oldInvocation = livedata_server_1.DDP._CurrentMethodInvocation;
+                const oldFence = writefence_1._WriteFence._CurrentWriteFence;
+                livedata_server_1.DDP._CurrentMethodInvocation = invocation;
+                writefence_1._WriteFence._CurrentWriteFence = fence;
+                function finish() {
+                    livedata_server_1.DDP._CurrentMethodInvocation = oldInvocation;
+                    writefence_1._WriteFence._CurrentWriteFence = oldFence;
+                    fence.arm();
+                }
+                const payload = {
+                    msg: "result",
+                    id: msg.id,
+                    result: undefined,
+                    error: undefined
+                };
+                handler.apply(invocation, msg.params).then((result) => {
+                    finish();
+                    if (result !== undefined) {
+                        payload.result = result;
+                    }
+                    self.send(payload);
+                }, (exception) => {
+                    finish();
+                    payload.error = (0, livedata_server_1.wrapInternalException)(exception, `while invoking method '${msg.method}'`);
+                    self.send(payload);
+                });
+            }
+        };
+        var self = this;
+        self.id = main_1.Random.id();
+        self.server = server;
+        self.version = version;
+        self.initialized = false;
+        self.socket = socket;
+        // Set to null when the session is destroyed. Multiple places below
+        // use this to determine if the session is alive or not.
+        self.inQueue = new double_ended_queue_1.default();
+        self.workerRunning = false;
+        // Sub objects for active subscriptions
+        self._namedSubs = new Map();
+        self._universalSubs = [];
+        self.userId = null;
+        self.collectionViews = new Map();
+        // Set this to false to not send messages when collectionViews are
+        // modified. This is done when rerunning subs in _setUserId and those messages
+        // are calculated via a diff instead.
+        self._isSending = true;
+        // If this is true, don't start a newly-created universal publisher on this
+        // session. The session will take care of starting it when appropriate.
+        self._dontStartNewUniversalSubs = false;
+        // When we are rerunning subscriptions, any ready messages
+        // we want to buffer up for when we are done rerunning subscriptions
+        self._pendingReady = [];
+        // List of callbacks to call when this connection is closed.
+        self._closeCallbacks = [];
+        // XXX HACK: If a sockjs connection, save off the URL. This is
+        // temporary and will go away in the near future.
+        self._socketUrl = socket.url;
+        // Allow tests to disable responding to pings.
+        self._respondToPings = options.respondToPings;
+        // This object is the public interface to the session. In the public
+        // API, it is called the `connection` object.  Internally we call it
+        // a `connectionHandle` to avoid ambiguity.
+        self.connectionHandle = {
+            id: self.id,
+            close: function () {
+                self.close();
+            },
+            onClose: function (cb) {
+                if (self.inQueue) {
+                    self._closeCallbacks.push(cb);
+                }
+                else {
+                    setImmediate(cb);
+                }
+            },
+            clientAddress: self._clientAddress(),
+            httpHeaders: self.socket.headers
+        };
+        self.send({ msg: 'connected', session: self.id });
+        // On initial connect, spin up all the universal publishers.
+        setImmediate(() => this.startUniversalSubs());
+        if (version !== 'pre1' && options.heartbeatInterval !== 0) {
+            // We no longer need the low level timeout because we have heartbeats.
+            socket.setWebsocketTimeout(0);
+            self.heartbeat = new heartbeat_1.Heartbeat({
+                heartbeatInterval: options.heartbeatInterval,
+                heartbeatTimeout: options.heartbeatTimeout,
+                onTimeout: function () {
+                    self.close();
+                },
+                sendPing: function () {
+                    self.send({ msg: 'ping' });
+                }
+            });
+            self.heartbeat.start();
+        }
+    }
+    sendReady(subscriptionIds) {
+        var self = this;
+        if (self._isSending)
+            self.send({ msg: "ready", subs: subscriptionIds });
+        else {
+            for (const subscriptionId of subscriptionIds) {
+                self._pendingReady.push(subscriptionId);
+            }
+        }
+    }
+    _canSend(collectionName) {
+        return this._isSending || !this.server.getPublicationStrategy(collectionName).useCollectionView;
+    }
+    sendAdded(collectionName, id, fields) {
+        if (this._canSend(collectionName))
+            this.send({ msg: "added", collection: collectionName, id, fields });
+    }
+    sendChanged(collectionName, id, fields) {
+        if (fields == null || Object.keys(fields).length === 0)
+            return;
+        if (this._canSend(collectionName)) {
+            this.send({
+                msg: "changed",
+                collection: collectionName,
+                id,
+                fields
+            });
+        }
+    }
+    sendRemoved(collectionName, id) {
+        if (this._canSend(collectionName))
+            this.send({ msg: "removed", collection: collectionName, id });
+    }
+    getSendCallbacks() {
+        return {
+            added: this.sendAdded.bind(this),
+            changed: this.sendChanged.bind(this),
+            removed: this.sendRemoved.bind(this)
+        };
+    }
+    getCollectionView(collectionName) {
+        var self = this;
+        var ret = self.collectionViews.get(collectionName);
+        if (!ret) {
+            ret = new session_collection_view_1.SessionCollectionView(collectionName, self.getSendCallbacks());
+            self.collectionViews.set(collectionName, ret);
+        }
+        return ret;
+    }
+    added(subscriptionHandle, collectionName, id, fields) {
+        if (this.server.getPublicationStrategy(collectionName).useCollectionView) {
+            const view = this.getCollectionView(collectionName);
+            view.added(subscriptionHandle, id, fields);
+        }
+        else {
+            this.sendAdded(collectionName, id, fields);
+        }
+    }
+    removed(subscriptionHandle, collectionName, id) {
+        if (this.server.getPublicationStrategy(collectionName).useCollectionView) {
+            const view = this.getCollectionView(collectionName);
+            view.removed(subscriptionHandle, id);
+            if (view.isEmpty()) {
+                this.collectionViews.delete(collectionName);
+            }
+        }
+        else {
+            this.sendRemoved(collectionName, id);
+        }
+    }
+    changed(subscriptionHandle, collectionName, id, fields) {
+        if (this.server.getPublicationStrategy(collectionName).useCollectionView) {
+            const view = this.getCollectionView(collectionName);
+            view.changed(subscriptionHandle, id, fields);
+        }
+        else {
+            this.sendChanged(collectionName, id, fields);
+        }
+    }
+    startUniversalSubs() {
+        // Make a shallow copy of the set of universal handlers and start them. If
+        // additional universal publishers start while we're running them (due to
+        // yielding), they will run separately as part of Server.publish.
+        var handlers = [...this.server.universal_publish_handlers];
+        for (const handler of handlers) {
+            this._startSubscription(handler);
+        }
+    }
+    // Destroy this session and unregister it at the server.
+    close() {
+        var self = this;
+        // Destroy this session, even if it's not registered at the
+        // server. Stop all processing and tear everything down. If a socket
+        // was attached, close it.
+        // Already destroyed.
+        if (!self.inQueue)
+            return;
+        // Drop the merge box data immediately.
+        self.inQueue = null;
+        self.collectionViews = new Map();
+        if (self.heartbeat) {
+            self.heartbeat.stop();
+            self.heartbeat = null;
+        }
+        if (self.socket) {
+            self.socket.close();
+            self.socket._meteorSession = null;
+        }
+        setImmediate(function () {
+            // Stop callbacks can yield, so we defer this on close.
+            // sub._isDeactivated() detects that we set inQueue to null and
+            // treats it as semi-deactivated (it will ignore incoming callbacks, etc).
+            self._deactivateAllSubscriptions();
+            // Defer calling the close callbacks, so that the caller closing
+            // the session isn't waiting for all the callbacks to complete.
+            for (const callback of self._closeCallbacks) {
+                callback();
+            }
+        });
+        // Unregister the session.
+        self.server._removeSession(self);
+    }
+    // Send a message (doing nothing if no socket is connected right now).
+    // It should be a JSON object (it will be stringified).
+    send(msg) {
+        var self = this;
+        if (self.socket) {
+            self.socket.send((0, utils_1.stringifyDDP)(msg));
+        }
+    }
+    // Send a connection error.
+    sendError(reason, offendingMessage) {
+        var self = this;
+        var msg = { msg: 'error', reason, offendingMessage };
+        self.send(msg);
+    }
+    // Process 'msg' as an incoming message. As a guard against
+    // race conditions during reconnection, ignore the message if
+    // 'socket' is not the currently connected socket.
+    //
+    // We run the messages from the client one at a time, in the order
+    // given by the client. The message handler is passed an idempotent
+    // function 'unblock' which it may call to allow other messages to
+    // begin running in parallel in another fiber (for example, a method
+    // that wants to yield). Otherwise, it is automatically unblocked
+    // when it returns.
+    //
+    // Actually, we don't have to 'totally order' the messages in this
+    // way, but it's the easiest thing that's correct. (unsub needs to
+    // be ordered against sub, methods need to be ordered against each
+    // other).
+    async processMessage(msg_in) {
+        var self = this;
+        if (!self.inQueue) // we have been destroyed.
+            return;
+        // Respond to ping and pong messages immediately without queuing.
+        // If the negotiated DDP version is "pre1" which didn't support
+        // pings, preserve the "pre1" behavior of responding with a "bad
+        // request" for the unknown messages.
+        //
+        // Any message counts as receiving a pong, as it demonstrates that
+        // the client is still alive.
+        if (self.heartbeat) {
+            self.heartbeat.messageReceived();
+        }
+        if (self.version !== 'pre1' && msg_in.msg === 'ping') {
+            if (self._respondToPings)
+                self.send({ msg: "pong", id: msg_in.id });
+            return;
+        }
+        if (self.version !== 'pre1' && msg_in.msg === 'pong') {
+            // Since everything is a pong, there is nothing to do
+            return;
+        }
+        self.inQueue.push(msg_in);
+        if (self.workerRunning)
+            return;
+        self.workerRunning = true;
+        while (self.inQueue && self.inQueue.length > 0) {
+            var msg = self.inQueue.shift();
+            self.server.onMessageHook.each(callback => {
+                callback(msg, self);
+                return true;
+            });
+            if (self.protocol_handlers.hasOwnProperty(msg.msg))
+                await self.protocol_handlers[msg.msg].call(self, msg);
+            else
+                self.sendError('Bad request', msg);
+        }
+        self.workerRunning = false;
+    }
+    _eachSub(f) {
+        var self = this;
+        self._namedSubs.forEach(f);
+        self._universalSubs.forEach(f);
+    }
+    _diffCollectionViews(beforeCVs) {
+        var self = this;
+        diff_1.DiffSequence.diffMaps(beforeCVs, self.collectionViews, {
+            both: function (collectionName, leftValue, rightValue) {
+                rightValue.diff(leftValue);
+            },
+            rightOnly: function (collectionName, rightValue) {
+                rightValue.documents.forEach(function (docView, id) {
+                    self.sendAdded(collectionName, id, docView.getFields());
+                });
+            },
+            leftOnly: function (collectionName, leftValue) {
+                leftValue.documents.forEach(function (doc, id) {
+                    self.sendRemoved(collectionName, id);
+                });
+            }
+        });
+    }
+    // Sets the current user id in all appropriate contexts and reruns
+    // all subscriptions
+    _setUserId(userId) {
+        var self = this;
+        if (userId !== null && typeof userId !== "string")
+            throw new Error("setUserId must be called on string or null, not " +
+                typeof userId);
+        // Prevent newly-created universal subscriptions from being added to our
+        // session. They will be found below when we call startUniversalSubs.
+        //
+        // (We don't have to worry about named subscriptions, because we only add
+        // them when we process a 'sub' message. We are currently processing a
+        // 'method' message, and the method did not unblock, because it is illegal
+        // to call setUserId after unblock. Thus we cannot be concurrently adding a
+        // new named subscription).
+        self._dontStartNewUniversalSubs = true;
+        // Prevent current subs from updating our collectionViews and call their
+        // stop callbacks. This may yield.
+        self._eachSub(function (sub) {
+            sub._deactivate();
+        });
+        // All subs should now be deactivated. Stop sending messages to the client,
+        // save the state of the published collections, reset to an empty view, and
+        // update the userId.
+        self._isSending = false;
+        var beforeCVs = self.collectionViews;
+        self.collectionViews = new Map();
+        self.userId = userId;
+        // _setUserId is normally called from a Meteor method with
+        // DDP._CurrentMethodInvocation set. But DDP._CurrentMethodInvocation is not
+        // expected to be set inside a publish function, so we temporary unset it.
+        // Inside a publish function DDP._CurrentPublicationInvocation is set.
+        const oldInvocation = livedata_server_1.DDP._CurrentMethodInvocation;
+        livedata_server_1.DDP._CurrentMethodInvocation = undefined;
+        try {
+            // Save the old named subs, and reset to having no subscriptions.
+            var oldNamedSubs = self._namedSubs;
+            self._namedSubs = new Map();
+            self._universalSubs = [];
+            oldNamedSubs.forEach(function (sub, subscriptionId) {
+                var newSub = sub._recreate();
+                self._namedSubs.set(subscriptionId, newSub);
+                // nb: if the handler throws or calls this.error(), it will in fact
+                // immediately send its 'nosub'. This is OK, though.
+                newSub._runHandler();
+            });
+            // Allow newly-created universal subs to be started on our connection in
+            // parallel with the ones we're spinning up here, and spin up universal
+            // subs.
+            self._dontStartNewUniversalSubs = false;
+            self.startUniversalSubs();
+        }
+        finally {
+            livedata_server_1.DDP._CurrentMethodInvocation = oldInvocation;
+        }
+        // Start sending messages again, beginning with the diff from the previous
+        // state of the world to the current state. No yields are allowed during
+        // this diff, so that other changes cannot interleave.
+        self._isSending = true;
+        self._diffCollectionViews(beforeCVs);
+        if (!self._pendingReady || self._pendingReady.length === 0) {
+            self.sendReady(self._pendingReady);
+            self._pendingReady = [];
+        }
+    }
+    _startSubscription(handler, subId, params, name) {
+        var self = this;
+        var sub = new subscription_1.Subscription(self, handler, subId, params, name);
+        if (subId)
+            self._namedSubs.set(subId, sub);
+        else
+            self._universalSubs.push(sub);
+        sub._runHandler();
+    }
+    // Tear down specified subscription
+    _stopSubscription(subId, error) {
+        var self = this;
+        var subName = null;
+        if (subId) {
+            var maybeSub = self._namedSubs.get(subId);
+            if (maybeSub) {
+                subName = maybeSub._name;
+                maybeSub._removeAllDocuments();
+                maybeSub._deactivate();
+                self._namedSubs.delete(subId);
+            }
+        }
+        var response = { msg: 'nosub', id: subId, error: undefined };
+        if (error) {
+            response.error = (0, livedata_server_1.wrapInternalException)(error, subName ? ("from sub " + subName + " id " + subId)
+                : ("from sub id " + subId));
+        }
+        self.send(response);
+    }
+    // Tear down all subscriptions. Note that this does NOT send removed or nosub
+    // messages, since we assume the client is gone.
+    _deactivateAllSubscriptions() {
+        var self = this;
+        self._namedSubs.forEach(function (sub, id) {
+            sub._deactivate();
+        });
+        self._namedSubs = new Map();
+        self._universalSubs.forEach(function (sub) {
+            sub._deactivate();
+        });
+        self._universalSubs = [];
+    }
+    // Determine the remote client's IP address, based on the
+    // HTTP_FORWARDED_COUNT environment variable representing how many
+    // proxies the server is behind.
+    _clientAddress() {
+        var self = this;
+        // For the reported client address for a connection to be correct,
+        // the developer must set the HTTP_FORWARDED_COUNT environment
+        // variable to an integer representing the number of hops they
+        // expect in the `x-forwarded-for` header. E.g., set to "1" if the
+        // server is behind one proxy.
+        //
+        // This could be computed once at startup instead of every time.
+        var httpForwardedCount = parseInt(process.env['HTTP_FORWARDED_COUNT']) || 0;
+        if (httpForwardedCount === 0)
+            return self.socket.remoteAddress;
+        let forwardedFor = self.socket.headers["x-forwarded-for"];
+        if (typeof forwardedFor !== "string")
+            return null;
+        forwardedFor = forwardedFor.trim().split(/\s*,\s*/);
+        // Typically the first value in the `x-forwarded-for` header is
+        // the original IP address of the client connecting to the first
+        // proxy.  However, the end user can easily spoof the header, in
+        // which case the first value(s) will be the fake IP address from
+        // the user pretending to be a proxy reporting the original IP
+        // address value.  By counting HTTP_FORWARDED_COUNT back from the
+        // end of the list, we ensure that we get the IP address being
+        // reported by *our* first proxy.
+        if (httpForwardedCount < 0 || httpForwardedCount > forwardedFor.length)
+            return null;
+        return forwardedFor[forwardedFor.length - httpForwardedCount];
+    }
+}
+exports.DDPSession = DDPSession;