'use strict'; Object.defineProperty(exports, '__esModule', { value: true }); function _interopDefault (ex) { return (ex && (typeof ex === 'object') && 'default' in ex) ? ex['default'] : ex; } var util = require('@firebase/util'); var logger = require('@firebase/logger'); var tslib_1 = require('tslib'); var firebase = _interopDefault(require('@firebase/app')); /** * Copyright 2017 Google Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ /** * Wraps a DOM Storage object and: * - automatically encode objects as JSON strings before storing them to allow us to store arbitrary types. * - prefixes names with "firebase:" to avoid collisions with app data. * * We automatically (see storage.js) create two such wrappers, one for sessionStorage, * and one for localStorage. * * @constructor */ var DOMStorageWrapper = /** @class */ (function () { /** * @param {Storage} domStorage_ The underlying storage object (e.g. localStorage or sessionStorage) */ function DOMStorageWrapper(domStorage_) { this.domStorage_ = domStorage_; // Use a prefix to avoid collisions with other stuff saved by the app. this.prefix_ = 'firebase:'; } /** * @param {string} key The key to save the value under * @param {?Object} value The value being stored, or null to remove the key. */ DOMStorageWrapper.prototype.set = function (key, value) { if (value == null) { this.domStorage_.removeItem(this.prefixedName_(key)); } else { this.domStorage_.setItem(this.prefixedName_(key), util.stringify(value)); } }; /** * @param {string} key * @return {*} The value that was stored under this key, or null */ DOMStorageWrapper.prototype.get = function (key) { var storedVal = this.domStorage_.getItem(this.prefixedName_(key)); if (storedVal == null) { return null; } else { return util.jsonEval(storedVal); } }; /** * @param {string} key */ DOMStorageWrapper.prototype.remove = function (key) { this.domStorage_.removeItem(this.prefixedName_(key)); }; /** * @param {string} name * @return {string} */ DOMStorageWrapper.prototype.prefixedName_ = function (name) { return this.prefix_ + name; }; DOMStorageWrapper.prototype.toString = function () { return this.domStorage_.toString(); }; return DOMStorageWrapper; }()); /** * Copyright 2017 Google Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ /** * An in-memory storage implementation that matches the API of DOMStorageWrapper * (TODO: create interface for both to implement). * * @constructor */ var MemoryStorage = /** @class */ (function () { function MemoryStorage() { this.cache_ = {}; this.isInMemoryStorage = true; } MemoryStorage.prototype.set = function (key, value) { if (value == null) { delete this.cache_[key]; } else { this.cache_[key] = value; } }; MemoryStorage.prototype.get = function (key) { if (util.contains(this.cache_, key)) { return this.cache_[key]; } return null; }; MemoryStorage.prototype.remove = function (key) { delete this.cache_[key]; }; return MemoryStorage; }()); /** * Copyright 2017 Google Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ /** * Helper to create a DOMStorageWrapper or else fall back to MemoryStorage. * TODO: Once MemoryStorage and DOMStorageWrapper have a shared interface this method annotation should change * to reflect this type * * @param {string} domStorageName Name of the underlying storage object * (e.g. 'localStorage' or 'sessionStorage'). * @return {?} Turning off type information until a common interface is defined. */ var createStoragefor = function (domStorageName) { try { // NOTE: just accessing "localStorage" or "window['localStorage']" may throw a security exception, // so it must be inside the try/catch. if (typeof window !== 'undefined' && typeof window[domStorageName] !== 'undefined') { // Need to test cache. Just because it's here doesn't mean it works var domStorage = window[domStorageName]; domStorage.setItem('firebase:sentinel', 'cache'); domStorage.removeItem('firebase:sentinel'); return new DOMStorageWrapper(domStorage); } } catch (e) { } // Failed to create wrapper. Just return in-memory storage. // TODO: log? return new MemoryStorage(); }; /** A storage object that lasts across sessions */ var PersistentStorage = createStoragefor('localStorage'); /** A storage object that only lasts one session */ var SessionStorage = createStoragefor('sessionStorage'); /** * Copyright 2017 Google Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ var logClient = new logger.Logger('@firebase/database'); /** * Returns a locally-unique ID (generated by just incrementing up from 0 each time its called). * @type {function(): number} Generated ID. */ var LUIDGenerator = (function () { var id = 1; return function () { return id++; }; })(); /** * Sha1 hash of the input string * @param {!string} str The string to hash * @return {!string} The resulting hash */ var sha1 = function (str) { var utf8Bytes = util.stringToByteArray(str); var sha1 = new util.Sha1(); sha1.update(utf8Bytes); var sha1Bytes = sha1.digest(); return util.base64.encodeByteArray(sha1Bytes); }; /** * @param {...*} var_args * @return {string} * @private */ var buildLogMessage_ = function () { var var_args = []; for (var _i = 0; _i < arguments.length; _i++) { var_args[_i] = arguments[_i]; } var message = ''; for (var i = 0; i < var_args.length; i++) { if (Array.isArray(var_args[i]) || (var_args[i] && typeof var_args[i] === 'object' && typeof var_args[i].length === 'number')) { message += buildLogMessage_.apply(null, var_args[i]); } else if (typeof var_args[i] === 'object') { message += util.stringify(var_args[i]); } else { message += var_args[i]; } message += ' '; } return message; }; /** * Use this for all debug messages in Firebase. * @type {?function(string)} */ var logger$1 = null; /** * Flag to check for log availability on first log message * @type {boolean} * @private */ var firstLog_ = true; /** * The implementation of Firebase.enableLogging (defined here to break dependencies) * @param {boolean|?function(string)} logger_ A flag to turn on logging, or a custom logger * @param {boolean=} persistent Whether or not to persist logging settings across refreshes */ var enableLogging = function (logger_, persistent) { util.assert(!persistent || (logger_ === true || logger_ === false), "Can't turn on custom loggers persistently."); if (logger_ === true) { logClient.logLevel = logger.LogLevel.VERBOSE; logger$1 = logClient.log.bind(logClient); if (persistent) SessionStorage.set('logging_enabled', true); } else if (typeof logger_ === 'function') { logger$1 = logger_; } else { logger$1 = null; SessionStorage.remove('logging_enabled'); } }; /** * * @param {...(string|Arguments)} var_args */ var log = function () { var var_args = []; for (var _i = 0; _i < arguments.length; _i++) { var_args[_i] = arguments[_i]; } if (firstLog_ === true) { firstLog_ = false; if (logger$1 === null && SessionStorage.get('logging_enabled') === true) enableLogging(true); } if (logger$1) { var message = buildLogMessage_.apply(null, var_args); logger$1(message); } }; /** * @param {!string} prefix * @return {function(...[*])} */ var logWrapper = function (prefix) { return function () { var var_args = []; for (var _i = 0; _i < arguments.length; _i++) { var_args[_i] = arguments[_i]; } log.apply(void 0, [prefix].concat(var_args)); }; }; /** * @param {...string} var_args */ var error = function () { var var_args = []; for (var _i = 0; _i < arguments.length; _i++) { var_args[_i] = arguments[_i]; } var message = 'FIREBASE INTERNAL ERROR: ' + buildLogMessage_.apply(void 0, var_args); logClient.error(message); }; /** * @param {...string} var_args */ var fatal = function () { var var_args = []; for (var _i = 0; _i < arguments.length; _i++) { var_args[_i] = arguments[_i]; } var message = "FIREBASE FATAL ERROR: " + buildLogMessage_.apply(void 0, var_args); logClient.error(message); throw new Error(message); }; /** * @param {...*} var_args */ var warn = function () { var var_args = []; for (var _i = 0; _i < arguments.length; _i++) { var_args[_i] = arguments[_i]; } var message = 'FIREBASE WARNING: ' + buildLogMessage_.apply(void 0, var_args); logClient.warn(message); }; /** * Logs a warning if the containing page uses https. Called when a call to new Firebase * does not use https. */ var warnIfPageIsSecure = function () { // Be very careful accessing browser globals. Who knows what may or may not exist. if (typeof window !== 'undefined' && window.location && window.location.protocol && window.location.protocol.indexOf('https:') !== -1) { warn('Insecure Firebase access from a secure page. ' + 'Please use https in calls to new Firebase().'); } }; /** * Returns true if data is NaN, or +/- Infinity. * @param {*} data * @return {boolean} */ var isInvalidJSONNumber = function (data) { return (typeof data === 'number' && (data != data || // NaN data == Number.POSITIVE_INFINITY || data == Number.NEGATIVE_INFINITY)); }; /** * @param {function()} fn */ var executeWhenDOMReady = function (fn) { if (util.isNodeSdk() || document.readyState === 'complete') { fn(); } else { // Modeled after jQuery. Try DOMContentLoaded and onreadystatechange (which // fire before onload), but fall back to onload. var called_1 = false; var wrappedFn_1 = function () { if (!document.body) { setTimeout(wrappedFn_1, Math.floor(10)); return; } if (!called_1) { called_1 = true; fn(); } }; if (document.addEventListener) { document.addEventListener('DOMContentLoaded', wrappedFn_1, false); // fallback to onload. window.addEventListener('load', wrappedFn_1, false); } else if (document.attachEvent) { // IE. document.attachEvent('onreadystatechange', function () { if (document.readyState === 'complete') wrappedFn_1(); }); // fallback to onload. window.attachEvent('onload', wrappedFn_1); // jQuery has an extra hack for IE that we could employ (based on // http://javascript.nwbox.com/IEContentLoaded/) But it looks really old. // I'm hoping we don't need it. } } }; /** * Minimum key name. Invalid for actual data, used as a marker to sort before any valid names * @type {!string} */ var MIN_NAME = '[MIN_NAME]'; /** * Maximum key name. Invalid for actual data, used as a marker to sort above any valid names * @type {!string} */ var MAX_NAME = '[MAX_NAME]'; /** * Compares valid Firebase key names, plus min and max name * @param {!string} a * @param {!string} b * @return {!number} */ var nameCompare = function (a, b) { if (a === b) { return 0; } else if (a === MIN_NAME || b === MAX_NAME) { return -1; } else if (b === MIN_NAME || a === MAX_NAME) { return 1; } else { var aAsInt = tryParseInt(a), bAsInt = tryParseInt(b); if (aAsInt !== null) { if (bAsInt !== null) { return aAsInt - bAsInt == 0 ? a.length - b.length : aAsInt - bAsInt; } else { return -1; } } else if (bAsInt !== null) { return 1; } else { return a < b ? -1 : 1; } } }; /** * @param {!string} a * @param {!string} b * @return {!number} comparison result. */ var stringCompare = function (a, b) { if (a === b) { return 0; } else if (a < b) { return -1; } else { return 1; } }; /** * @param {string} key * @param {Object} obj * @return {*} */ var requireKey = function (key, obj) { if (obj && key in obj) { return obj[key]; } else { throw new Error('Missing required key (' + key + ') in object: ' + util.stringify(obj)); } }; /** * @param {*} obj * @return {string} */ var ObjectToUniqueKey = function (obj) { if (typeof obj !== 'object' || obj === null) return util.stringify(obj); var keys = []; for (var k in obj) { keys.push(k); } // Export as json, but with the keys sorted. keys.sort(); var key = '{'; for (var i = 0; i < keys.length; i++) { if (i !== 0) key += ','; key += util.stringify(keys[i]); key += ':'; key += ObjectToUniqueKey(obj[keys[i]]); } key += '}'; return key; }; /** * Splits a string into a number of smaller segments of maximum size * @param {!string} str The string * @param {!number} segsize The maximum number of chars in the string. * @return {Array.} The string, split into appropriately-sized chunks */ var splitStringBySize = function (str, segsize) { var len = str.length; if (len <= segsize) { return [str]; } var dataSegs = []; for (var c = 0; c < len; c += segsize) { if (c + segsize > len) { dataSegs.push(str.substring(c, len)); } else { dataSegs.push(str.substring(c, c + segsize)); } } return dataSegs; }; /** * Apply a function to each (key, value) pair in an object or * apply a function to each (index, value) pair in an array * @param {!(Object|Array)} obj The object or array to iterate over * @param {function(?, ?)} fn The function to apply */ var each = function (obj, fn) { if (Array.isArray(obj)) { for (var i = 0; i < obj.length; ++i) { fn(i, obj[i]); } } else { /** * in the conversion of code we removed the goog.object.forEach * function which did a value,key callback. We standardized on * a single impl that does a key, value callback. So we invert * to not have to touch the `each` code points */ util.forEach(obj, function (key, val) { return fn(val, key); }); } }; /** * Borrowed from http://hg.secondlife.com/llsd/src/tip/js/typedarray.js (MIT License) * I made one modification at the end and removed the NaN / Infinity * handling (since it seemed broken [caused an overflow] and we don't need it). See MJL comments. * @param {!number} v A double * @return {string} */ var doubleToIEEE754String = function (v) { util.assert(!isInvalidJSONNumber(v), 'Invalid JSON number'); // MJL var ebits = 11, fbits = 52; var bias = (1 << (ebits - 1)) - 1, s, e, f, ln, i, bits, str; // Compute sign, exponent, fraction // Skip NaN / Infinity handling --MJL. if (v === 0) { e = 0; f = 0; s = 1 / v === -Infinity ? 1 : 0; } else { s = v < 0; v = Math.abs(v); if (v >= Math.pow(2, 1 - bias)) { // Normalized ln = Math.min(Math.floor(Math.log(v) / Math.LN2), bias); e = ln + bias; f = Math.round(v * Math.pow(2, fbits - ln) - Math.pow(2, fbits)); } else { // Denormalized e = 0; f = Math.round(v / Math.pow(2, 1 - bias - fbits)); } } // Pack sign, exponent, fraction bits = []; for (i = fbits; i; i -= 1) { bits.push(f % 2 ? 1 : 0); f = Math.floor(f / 2); } for (i = ebits; i; i -= 1) { bits.push(e % 2 ? 1 : 0); e = Math.floor(e / 2); } bits.push(s ? 1 : 0); bits.reverse(); str = bits.join(''); // Return the data as a hex string. --MJL var hexByteString = ''; for (i = 0; i < 64; i += 8) { var hexByte = parseInt(str.substr(i, 8), 2).toString(16); if (hexByte.length === 1) hexByte = '0' + hexByte; hexByteString = hexByteString + hexByte; } return hexByteString.toLowerCase(); }; /** * Used to detect if we're in a Chrome content script (which executes in an * isolated environment where long-polling doesn't work). * @return {boolean} */ var isChromeExtensionContentScript = function () { return !!(typeof window === 'object' && window['chrome'] && window['chrome']['extension'] && !/^chrome/.test(window.location.href)); }; /** * Used to detect if we're in a Windows 8 Store app. * @return {boolean} */ var isWindowsStoreApp = function () { // Check for the presence of a couple WinRT globals return typeof Windows === 'object' && typeof Windows.UI === 'object'; }; /** * Converts a server error code to a Javascript Error * @param {!string} code * @param {!Query} query * @return {Error} */ var errorForServerCode = function (code, query) { var reason = 'Unknown Error'; if (code === 'too_big') { reason = 'The data requested exceeds the maximum size ' + 'that can be accessed with a single request.'; } else if (code == 'permission_denied') { reason = "Client doesn't have permission to access the desired data."; } else if (code == 'unavailable') { reason = 'The service is unavailable'; } var error = new Error(code + ' at ' + query.path.toString() + ': ' + reason); error.code = code.toUpperCase(); return error; }; /** * Used to test for integer-looking strings * @type {RegExp} * @private */ var INTEGER_REGEXP_ = new RegExp('^-?\\d{1,10}$'); /** * If the string contains a 32-bit integer, return it. Else return null. * @param {!string} str * @return {?number} */ var tryParseInt = function (str) { if (INTEGER_REGEXP_.test(str)) { var intVal = Number(str); if (intVal >= -2147483648 && intVal <= 2147483647) { return intVal; } } return null; }; /** * Helper to run some code but catch any exceptions and re-throw them later. * Useful for preventing user callbacks from breaking internal code. * * Re-throwing the exception from a setTimeout is a little evil, but it's very * convenient (we don't have to try to figure out when is a safe point to * re-throw it), and the behavior seems reasonable: * * * If you aren't pausing on exceptions, you get an error in the console with * the correct stack trace. * * If you're pausing on all exceptions, the debugger will pause on your * exception and then again when we rethrow it. * * If you're only pausing on uncaught exceptions, the debugger will only pause * on us re-throwing it. * * @param {!function()} fn The code to guard. */ var exceptionGuard = function (fn) { try { fn(); } catch (e) { // Re-throw exception when it's safe. setTimeout(function () { // It used to be that "throw e" would result in a good console error with // relevant context, but as of Chrome 39, you just get the firebase.js // file/line number where we re-throw it, which is useless. So we log // e.stack explicitly. var stack = e.stack || ''; warn('Exception was thrown by user callback.', stack); throw e; }, Math.floor(0)); } }; /** * @return {boolean} true if we think we're currently being crawled. */ var beingCrawled = function () { var userAgent = (typeof window === 'object' && window['navigator'] && window['navigator']['userAgent']) || ''; // For now we whitelist the most popular crawlers. We should refine this to be the set of crawlers we // believe to support JavaScript/AJAX rendering. // NOTE: Google Webmaster Tools doesn't really belong, but their "This is how a visitor to your website // would have seen the page" is flaky if we don't treat it as a crawler. return (userAgent.search(/googlebot|google webmaster tools|bingbot|yahoo! slurp|baiduspider|yandexbot|duckduckbot/i) >= 0); }; /** * Same as setTimeout() except on Node.JS it will /not/ prevent the process from exiting. * * It is removed with clearTimeout() as normal. * * @param {Function} fn Function to run. * @param {number} time Milliseconds to wait before running. * @return {number|Object} The setTimeout() return value. */ var setTimeoutNonBlocking = function (fn, time) { var timeout = setTimeout(fn, time); if (typeof timeout === 'object' && timeout['unref']) { timeout['unref'](); } return timeout; }; /** * Copyright 2017 Google Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ /** * An immutable object representing a parsed path. It's immutable so that you * can pass them around to other functions without worrying about them changing * it. */ var Path = /** @class */ (function () { /** * @param {string|Array.} pathOrString Path string to parse, * or another path, or the raw tokens array * @param {number=} pieceNum */ function Path(pathOrString, pieceNum) { if (pieceNum === void 0) { this.pieces_ = pathOrString.split('/'); // Remove empty pieces. var copyTo = 0; for (var i = 0; i < this.pieces_.length; i++) { if (this.pieces_[i].length > 0) { this.pieces_[copyTo] = this.pieces_[i]; copyTo++; } } this.pieces_.length = copyTo; this.pieceNum_ = 0; } else { this.pieces_ = pathOrString; this.pieceNum_ = pieceNum; } } Object.defineProperty(Path, "Empty", { /** * Singleton to represent an empty path * * @const */ get: function () { return new Path(''); }, enumerable: true, configurable: true }); Path.prototype.getFront = function () { if (this.pieceNum_ >= this.pieces_.length) return null; return this.pieces_[this.pieceNum_]; }; /** * @return {number} The number of segments in this path */ Path.prototype.getLength = function () { return this.pieces_.length - this.pieceNum_; }; /** * @return {!Path} */ Path.prototype.popFront = function () { var pieceNum = this.pieceNum_; if (pieceNum < this.pieces_.length) { pieceNum++; } return new Path(this.pieces_, pieceNum); }; /** * @return {?string} */ Path.prototype.getBack = function () { if (this.pieceNum_ < this.pieces_.length) return this.pieces_[this.pieces_.length - 1]; return null; }; Path.prototype.toString = function () { var pathString = ''; for (var i = this.pieceNum_; i < this.pieces_.length; i++) { if (this.pieces_[i] !== '') pathString += '/' + this.pieces_[i]; } return pathString || '/'; }; Path.prototype.toUrlEncodedString = function () { var pathString = ''; for (var i = this.pieceNum_; i < this.pieces_.length; i++) { if (this.pieces_[i] !== '') pathString += '/' + encodeURIComponent(String(this.pieces_[i])); } return pathString || '/'; }; /** * Shallow copy of the parts of the path. * * @param {number=} begin * @return {!Array} */ Path.prototype.slice = function (begin) { if (begin === void 0) { begin = 0; } return this.pieces_.slice(this.pieceNum_ + begin); }; /** * @return {?Path} */ Path.prototype.parent = function () { if (this.pieceNum_ >= this.pieces_.length) return null; var pieces = []; for (var i = this.pieceNum_; i < this.pieces_.length - 1; i++) pieces.push(this.pieces_[i]); return new Path(pieces, 0); }; /** * @param {string|!Path} childPathObj * @return {!Path} */ Path.prototype.child = function (childPathObj) { var pieces = []; for (var i = this.pieceNum_; i < this.pieces_.length; i++) pieces.push(this.pieces_[i]); if (childPathObj instanceof Path) { for (var i = childPathObj.pieceNum_; i < childPathObj.pieces_.length; i++) { pieces.push(childPathObj.pieces_[i]); } } else { var childPieces = childPathObj.split('/'); for (var i = 0; i < childPieces.length; i++) { if (childPieces[i].length > 0) pieces.push(childPieces[i]); } } return new Path(pieces, 0); }; /** * @return {boolean} True if there are no segments in this path */ Path.prototype.isEmpty = function () { return this.pieceNum_ >= this.pieces_.length; }; /** * @param {!Path} outerPath * @param {!Path} innerPath * @return {!Path} The path from outerPath to innerPath */ Path.relativePath = function (outerPath, innerPath) { var outer = outerPath.getFront(), inner = innerPath.getFront(); if (outer === null) { return innerPath; } else if (outer === inner) { return Path.relativePath(outerPath.popFront(), innerPath.popFront()); } else { throw new Error('INTERNAL ERROR: innerPath (' + innerPath + ') is not within ' + 'outerPath (' + outerPath + ')'); } }; /** * @param {!Path} left * @param {!Path} right * @return {number} -1, 0, 1 if left is less, equal, or greater than the right. */ Path.comparePaths = function (left, right) { var leftKeys = left.slice(); var rightKeys = right.slice(); for (var i = 0; i < leftKeys.length && i < rightKeys.length; i++) { var cmp = nameCompare(leftKeys[i], rightKeys[i]); if (cmp !== 0) return cmp; } if (leftKeys.length === rightKeys.length) return 0; return leftKeys.length < rightKeys.length ? -1 : 1; }; /** * * @param {Path} other * @return {boolean} true if paths are the same. */ Path.prototype.equals = function (other) { if (this.getLength() !== other.getLength()) { return false; } for (var i = this.pieceNum_, j = other.pieceNum_; i <= this.pieces_.length; i++, j++) { if (this.pieces_[i] !== other.pieces_[j]) { return false; } } return true; }; /** * * @param {!Path} other * @return {boolean} True if this path is a parent (or the same as) other */ Path.prototype.contains = function (other) { var i = this.pieceNum_; var j = other.pieceNum_; if (this.getLength() > other.getLength()) { return false; } while (i < this.pieces_.length) { if (this.pieces_[i] !== other.pieces_[j]) { return false; } ++i; ++j; } return true; }; return Path; }()); // end Path /** * Dynamic (mutable) path used to count path lengths. * * This class is used to efficiently check paths for valid * length (in UTF8 bytes) and depth (used in path validation). * * Throws Error exception if path is ever invalid. * * The definition of a path always begins with '/'. */ var ValidationPath = /** @class */ (function () { /** * @param {!Path} path Initial Path. * @param {string} errorPrefix_ Prefix for any error messages. */ function ValidationPath(path, errorPrefix_) { this.errorPrefix_ = errorPrefix_; /** @type {!Array} */ this.parts_ = path.slice(); /** @type {number} Initialize to number of '/' chars needed in path. */ this.byteLength_ = Math.max(1, this.parts_.length); for (var i = 0; i < this.parts_.length; i++) { this.byteLength_ += util.stringLength(this.parts_[i]); } this.checkValid_(); } Object.defineProperty(ValidationPath, "MAX_PATH_DEPTH", { /** @const {number} Maximum key depth. */ get: function () { return 32; }, enumerable: true, configurable: true }); Object.defineProperty(ValidationPath, "MAX_PATH_LENGTH_BYTES", { /** @const {number} Maximum number of (UTF8) bytes in a Firebase path. */ get: function () { return 768; }, enumerable: true, configurable: true }); /** @param {string} child */ ValidationPath.prototype.push = function (child) { // Count the needed '/' if (this.parts_.length > 0) { this.byteLength_ += 1; } this.parts_.push(child); this.byteLength_ += util.stringLength(child); this.checkValid_(); }; ValidationPath.prototype.pop = function () { var last = this.parts_.pop(); this.byteLength_ -= util.stringLength(last); // Un-count the previous '/' if (this.parts_.length > 0) { this.byteLength_ -= 1; } }; ValidationPath.prototype.checkValid_ = function () { if (this.byteLength_ > ValidationPath.MAX_PATH_LENGTH_BYTES) { throw new Error(this.errorPrefix_ + 'has a key path longer than ' + ValidationPath.MAX_PATH_LENGTH_BYTES + ' bytes (' + this.byteLength_ + ').'); } if (this.parts_.length > ValidationPath.MAX_PATH_DEPTH) { throw new Error(this.errorPrefix_ + 'path specified exceeds the maximum depth that can be written (' + ValidationPath.MAX_PATH_DEPTH + ') or object contains a cycle ' + this.toErrorString()); } }; /** * String for use in error messages - uses '.' notation for path. * * @return {string} */ ValidationPath.prototype.toErrorString = function () { if (this.parts_.length == 0) { return ''; } return "in property '" + this.parts_.join('.') + "'"; }; return ValidationPath; }()); /** * Copyright 2017 Google Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ var PROTOCOL_VERSION = '5'; var VERSION_PARAM = 'v'; var TRANSPORT_SESSION_PARAM = 's'; var REFERER_PARAM = 'r'; var FORGE_REF = 'f'; var FORGE_DOMAIN = 'firebaseio.com'; var LAST_SESSION_PARAM = 'ls'; var WEBSOCKET = 'websocket'; var LONG_POLLING = 'long_polling'; /** * Copyright 2017 Google Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ /** * A class that holds metadata about a Repo object * * @constructor */ var RepoInfo = /** @class */ (function () { /** * @param {string} host Hostname portion of the url for the repo * @param {boolean} secure Whether or not this repo is accessed over ssl * @param {string} namespace The namespace represented by the repo * @param {boolean} webSocketOnly Whether to prefer websockets over all other transports (used by Nest). * @param {string=} persistenceKey Override the default session persistence storage key */ function RepoInfo(host, secure, namespace, webSocketOnly, persistenceKey) { if (persistenceKey === void 0) { persistenceKey = ''; } this.secure = secure; this.namespace = namespace; this.webSocketOnly = webSocketOnly; this.persistenceKey = persistenceKey; this.host = host.toLowerCase(); this.domain = this.host.substr(this.host.indexOf('.') + 1); this.internalHost = PersistentStorage.get('host:' + host) || this.host; } RepoInfo.prototype.needsQueryParam = function () { return this.host !== this.internalHost || this.isCustomHost(); }; RepoInfo.prototype.isCacheableHost = function () { return this.internalHost.substr(0, 2) === 's-'; }; RepoInfo.prototype.isDemoHost = function () { return this.domain === 'firebaseio-demo.com'; }; RepoInfo.prototype.isCustomHost = function () { return (this.domain !== 'firebaseio.com' && this.domain !== 'firebaseio-demo.com'); }; RepoInfo.prototype.updateHost = function (newHost) { if (newHost !== this.internalHost) { this.internalHost = newHost; if (this.isCacheableHost()) { PersistentStorage.set('host:' + this.host, this.internalHost); } } }; /** * Returns the websocket URL for this repo * @param {string} type of connection * @param {Object} params list * @return {string} The URL for this repo */ RepoInfo.prototype.connectionURL = function (type, params) { util.assert(typeof type === 'string', 'typeof type must == string'); util.assert(typeof params === 'object', 'typeof params must == object'); var connURL; if (type === WEBSOCKET) { connURL = (this.secure ? 'wss://' : 'ws://') + this.internalHost + '/.ws?'; } else if (type === LONG_POLLING) { connURL = (this.secure ? 'https://' : 'http://') + this.internalHost + '/.lp?'; } else { throw new Error('Unknown connection type: ' + type); } if (this.needsQueryParam()) { params['ns'] = this.namespace; } var pairs = []; util.forEach(params, function (key, value) { pairs.push(key + '=' + value); }); return connURL + pairs.join('&'); }; /** @return {string} */ RepoInfo.prototype.toString = function () { var str = this.toURLString(); if (this.persistenceKey) { str += '<' + this.persistenceKey + '>'; } return str; }; /** @return {string} */ RepoInfo.prototype.toURLString = function () { return (this.secure ? 'https://' : 'http://') + this.host; }; return RepoInfo; }()); /** * Copyright 2017 Google Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ /** * @param {!string} pathString * @return {string} */ function decodePath(pathString) { var pathStringDecoded = ''; var pieces = pathString.split('/'); for (var i = 0; i < pieces.length; i++) { if (pieces[i].length > 0) { var piece = pieces[i]; try { piece = decodeURIComponent(piece.replace(/\+/g, ' ')); } catch (e) { } pathStringDecoded += '/' + piece; } } return pathStringDecoded; } /** * @param {!string} queryString * @return {!{[key:string]:string}} key value hash */ function decodeQuery(queryString) { var results = {}; if (queryString.charAt(0) === '?') { queryString = queryString.substring(1); } for (var _i = 0, _a = queryString.split('&'); _i < _a.length; _i++) { var segment = _a[_i]; if (segment.length === 0) { continue; } var kv = segment.split('='); if (kv.length === 2) { results[decodeURIComponent(kv[0])] = decodeURIComponent(kv[1]); } else { warn("Invalid query segment '" + segment + "' in query '" + queryString + "'"); } } return results; } /** * * @param {!string} dataURL * @return {{repoInfo: !RepoInfo, path: !Path}} */ var parseRepoInfo = function (dataURL) { var parsedUrl = parseURL(dataURL), namespace = parsedUrl.subdomain; if (parsedUrl.domain === 'firebase') { fatal(parsedUrl.host + ' is no longer supported. ' + 'Please use .firebaseio.com instead'); } // Catch common error of uninitialized namespace value. if ((!namespace || namespace == 'undefined') && parsedUrl.domain !== 'localhost') { fatal('Cannot parse Firebase url. Please use https://.firebaseio.com'); } if (!parsedUrl.secure) { warnIfPageIsSecure(); } var webSocketOnly = parsedUrl.scheme === 'ws' || parsedUrl.scheme === 'wss'; return { repoInfo: new RepoInfo(parsedUrl.host, parsedUrl.secure, namespace, webSocketOnly), path: new Path(parsedUrl.pathString) }; }; /** * * @param {!string} dataURL * @return {{host: string, port: number, domain: string, subdomain: string, secure: boolean, scheme: string, pathString: string}} */ var parseURL = function (dataURL) { // Default to empty strings in the event of a malformed string. var host = '', domain = '', subdomain = '', pathString = ''; // Always default to SSL, unless otherwise specified. var secure = true, scheme = 'https', port = 443; // Don't do any validation here. The caller is responsible for validating the result of parsing. if (typeof dataURL === 'string') { // Parse scheme. var colonInd = dataURL.indexOf('//'); if (colonInd >= 0) { scheme = dataURL.substring(0, colonInd - 1); dataURL = dataURL.substring(colonInd + 2); } // Parse host, path, and query string. var slashInd = dataURL.indexOf('/'); if (slashInd === -1) { slashInd = dataURL.length; } var questionMarkInd = dataURL.indexOf('?'); if (questionMarkInd === -1) { questionMarkInd = dataURL.length; } host = dataURL.substring(0, Math.min(slashInd, questionMarkInd)); if (slashInd < questionMarkInd) { // For pathString, questionMarkInd will always come after slashInd pathString = decodePath(dataURL.substring(slashInd, questionMarkInd)); } var queryParams = decodeQuery(dataURL.substring(Math.min(dataURL.length, questionMarkInd))); // If we have a port, use scheme for determining if it's secure. colonInd = host.indexOf(':'); if (colonInd >= 0) { secure = scheme === 'https' || scheme === 'wss'; port = parseInt(host.substring(colonInd + 1), 10); } else { colonInd = dataURL.length; } var parts = host.split('.'); if (parts.length === 3) { // Normalize namespaces to lowercase to share storage / connection. domain = parts[1]; subdomain = parts[0].toLowerCase(); } else if (parts.length === 2) { domain = parts[0]; } else if (parts[0].slice(0, colonInd).toLowerCase() === 'localhost') { domain = 'localhost'; } // Support `ns` query param if subdomain not already set if (subdomain === '' && 'ns' in queryParams) { subdomain = queryParams['ns']; } } return { host: host, port: port, domain: domain, subdomain: subdomain, secure: secure, scheme: scheme, pathString: pathString }; }; /** * Copyright 2017 Google Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ /** * True for invalid Firebase keys * @type {RegExp} * @private */ var INVALID_KEY_REGEX_ = /[\[\].#$\/\u0000-\u001F\u007F]/; /** * True for invalid Firebase paths. * Allows '/' in paths. * @type {RegExp} * @private */ var INVALID_PATH_REGEX_ = /[\[\].#$\u0000-\u001F\u007F]/; /** * Maximum number of characters to allow in leaf value * @type {number} * @private */ var MAX_LEAF_SIZE_ = 10 * 1024 * 1024; /** * @param {*} key * @return {boolean} */ var isValidKey = function (key) { return (typeof key === 'string' && key.length !== 0 && !INVALID_KEY_REGEX_.test(key)); }; /** * @param {string} pathString * @return {boolean} */ var isValidPathString = function (pathString) { return (typeof pathString === 'string' && pathString.length !== 0 && !INVALID_PATH_REGEX_.test(pathString)); }; /** * @param {string} pathString * @return {boolean} */ var isValidRootPathString = function (pathString) { if (pathString) { // Allow '/.info/' at the beginning. pathString = pathString.replace(/^\/*\.info(\/|$)/, '/'); } return isValidPathString(pathString); }; /** * @param {*} priority * @return {boolean} */ var isValidPriority = function (priority) { return (priority === null || typeof priority === 'string' || (typeof priority === 'number' && !isInvalidJSONNumber(priority)) || (priority && typeof priority === 'object' && util.contains(priority, '.sv'))); }; /** * Pre-validate a datum passed as an argument to Firebase function. * * @param {string} fnName * @param {number} argumentNumber * @param {*} data * @param {!Path} path * @param {boolean} optional */ var validateFirebaseDataArg = function (fnName, argumentNumber, data, path, optional) { if (optional && data === undefined) return; validateFirebaseData(util.errorPrefix(fnName, argumentNumber, optional), data, path); }; /** * Validate a data object client-side before sending to server. * * @param {string} errorPrefix * @param {*} data * @param {!Path|!ValidationPath} path_ */ var validateFirebaseData = function (errorPrefix, data, path_) { var path = path_ instanceof Path ? new ValidationPath(path_, errorPrefix) : path_; if (data === undefined) { throw new Error(errorPrefix + 'contains undefined ' + path.toErrorString()); } if (typeof data === 'function') { throw new Error(errorPrefix + 'contains a function ' + path.toErrorString() + ' with contents = ' + data.toString()); } if (isInvalidJSONNumber(data)) { throw new Error(errorPrefix + 'contains ' + data.toString() + ' ' + path.toErrorString()); } // Check max leaf size, but try to avoid the utf8 conversion if we can. if (typeof data === 'string' && data.length > MAX_LEAF_SIZE_ / 3 && util.stringLength(data) > MAX_LEAF_SIZE_) { throw new Error(errorPrefix + 'contains a string greater than ' + MAX_LEAF_SIZE_ + ' utf8 bytes ' + path.toErrorString() + " ('" + data.substring(0, 50) + "...')"); } // TODO = Perf = Consider combining the recursive validation of keys into NodeFromJSON // to save extra walking of large objects. if (data && typeof data === 'object') { var hasDotValue_1 = false, hasActualChild_1 = false; util.forEach(data, function (key, value) { if (key === '.value') { hasDotValue_1 = true; } else if (key !== '.priority' && key !== '.sv') { hasActualChild_1 = true; if (!isValidKey(key)) { throw new Error(errorPrefix + ' contains an invalid key (' + key + ') ' + path.toErrorString() + '. Keys must be non-empty strings ' + 'and can\'t contain ".", "#", "$", "/", "[", or "]"'); } } path.push(key); validateFirebaseData(errorPrefix, value, path); path.pop(); }); if (hasDotValue_1 && hasActualChild_1) { throw new Error(errorPrefix + ' contains ".value" child ' + path.toErrorString() + ' in addition to actual children.'); } } }; /** * Pre-validate paths passed in the firebase function. * * @param {string} errorPrefix * @param {Array} mergePaths */ var validateFirebaseMergePaths = function (errorPrefix, mergePaths) { var i, curPath; for (i = 0; i < mergePaths.length; i++) { curPath = mergePaths[i]; var keys = curPath.slice(); for (var j = 0; j < keys.length; j++) { if (keys[j] === '.priority' && j === keys.length - 1) { // .priority is OK } else if (!isValidKey(keys[j])) { throw new Error(errorPrefix + 'contains an invalid key (' + keys[j] + ') in path ' + curPath.toString() + '. Keys must be non-empty strings ' + 'and can\'t contain ".", "#", "$", "/", "[", or "]"'); } } } // Check that update keys are not descendants of each other. // We rely on the property that sorting guarantees that ancestors come // right before descendants. mergePaths.sort(Path.comparePaths); var prevPath = null; for (i = 0; i < mergePaths.length; i++) { curPath = mergePaths[i]; if (prevPath !== null && prevPath.contains(curPath)) { throw new Error(errorPrefix + 'contains a path ' + prevPath.toString() + ' that is ancestor of another path ' + curPath.toString()); } prevPath = curPath; } }; /** * pre-validate an object passed as an argument to firebase function ( * must be an object - e.g. for firebase.update()). * * @param {string} fnName * @param {number} argumentNumber * @param {*} data * @param {!Path} path * @param {boolean} optional */ var validateFirebaseMergeDataArg = function (fnName, argumentNumber, data, path, optional) { if (optional && data === undefined) return; var errorPrefix = util.errorPrefix(fnName, argumentNumber, optional); if (!(data && typeof data === 'object') || Array.isArray(data)) { throw new Error(errorPrefix + ' must be an object containing the children to replace.'); } var mergePaths = []; util.forEach(data, function (key, value) { var curPath = new Path(key); validateFirebaseData(errorPrefix, value, path.child(curPath)); if (curPath.getBack() === '.priority') { if (!isValidPriority(value)) { throw new Error(errorPrefix + "contains an invalid value for '" + curPath.toString() + "', which must be a valid " + 'Firebase priority (a string, finite number, server value, or null).'); } } mergePaths.push(curPath); }); validateFirebaseMergePaths(errorPrefix, mergePaths); }; var validatePriority = function (fnName, argumentNumber, priority, optional) { if (optional && priority === undefined) return; if (isInvalidJSONNumber(priority)) throw new Error(util.errorPrefix(fnName, argumentNumber, optional) + 'is ' + priority.toString() + ', but must be a valid Firebase priority (a string, finite number, ' + 'server value, or null).'); // Special case to allow importing data with a .sv. if (!isValidPriority(priority)) throw new Error(util.errorPrefix(fnName, argumentNumber, optional) + 'must be a valid Firebase priority ' + '(a string, finite number, server value, or null).'); }; var validateEventType = function (fnName, argumentNumber, eventType, optional) { if (optional && eventType === undefined) return; switch (eventType) { case 'value': case 'child_added': case 'child_removed': case 'child_changed': case 'child_moved': break; default: throw new Error(util.errorPrefix(fnName, argumentNumber, optional) + 'must be a valid event type = "value", "child_added", "child_removed", ' + '"child_changed", or "child_moved".'); } }; var validateKey = function (fnName, argumentNumber, key, optional) { if (optional && key === undefined) return; if (!isValidKey(key)) throw new Error(util.errorPrefix(fnName, argumentNumber, optional) + 'was an invalid key = "' + key + '". Firebase keys must be non-empty strings and ' + 'can\'t contain ".", "#", "$", "/", "[", or "]").'); }; var validatePathString = function (fnName, argumentNumber, pathString, optional) { if (optional && pathString === undefined) return; if (!isValidPathString(pathString)) throw new Error(util.errorPrefix(fnName, argumentNumber, optional) + 'was an invalid path = "' + pathString + '". Paths must be non-empty strings and ' + 'can\'t contain ".", "#", "$", "[", or "]"'); }; var validateRootPathString = function (fnName, argumentNumber, pathString, optional) { if (pathString) { // Allow '/.info/' at the beginning. pathString = pathString.replace(/^\/*\.info(\/|$)/, '/'); } validatePathString(fnName, argumentNumber, pathString, optional); }; var validateWritablePath = function (fnName, path) { if (path.getFront() === '.info') { throw new Error(fnName + " failed = Can't modify data under /.info/"); } }; var validateUrl = function (fnName, argumentNumber, parsedUrl) { // TODO = Validate server better. var pathString = parsedUrl.path.toString(); if (!(typeof parsedUrl.repoInfo.host === 'string') || parsedUrl.repoInfo.host.length === 0 || (!isValidKey(parsedUrl.repoInfo.namespace) && parsedUrl.repoInfo.host.split(':')[0] !== 'localhost') || (pathString.length !== 0 && !isValidRootPathString(pathString))) { throw new Error(util.errorPrefix(fnName, argumentNumber, false) + 'must be a valid firebase URL and ' + 'the path can\'t contain ".", "#", "$", "[", or "]".'); } }; var validateBoolean = function (fnName, argumentNumber, bool, optional) { if (optional && bool === undefined) return; if (typeof bool !== 'boolean') throw new Error(util.errorPrefix(fnName, argumentNumber, optional) + 'must be a boolean.'); }; /** * Copyright 2017 Google Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ /** * @constructor */ var OnDisconnect = /** @class */ (function () { /** * @param {!Repo} repo_ * @param {!Path} path_ */ function OnDisconnect(repo_, path_) { this.repo_ = repo_; this.path_ = path_; } /** * @param {function(?Error)=} onComplete * @return {!firebase.Promise} */ OnDisconnect.prototype.cancel = function (onComplete) { util.validateArgCount('OnDisconnect.cancel', 0, 1, arguments.length); util.validateCallback('OnDisconnect.cancel', 1, onComplete, true); var deferred = new util.Deferred(); this.repo_.onDisconnectCancel(this.path_, deferred.wrapCallback(onComplete)); return deferred.promise; }; /** * @param {function(?Error)=} onComplete * @return {!firebase.Promise} */ OnDisconnect.prototype.remove = function (onComplete) { util.validateArgCount('OnDisconnect.remove', 0, 1, arguments.length); validateWritablePath('OnDisconnect.remove', this.path_); util.validateCallback('OnDisconnect.remove', 1, onComplete, true); var deferred = new util.Deferred(); this.repo_.onDisconnectSet(this.path_, null, deferred.wrapCallback(onComplete)); return deferred.promise; }; /** * @param {*} value * @param {function(?Error)=} onComplete * @return {!firebase.Promise} */ OnDisconnect.prototype.set = function (value, onComplete) { util.validateArgCount('OnDisconnect.set', 1, 2, arguments.length); validateWritablePath('OnDisconnect.set', this.path_); validateFirebaseDataArg('OnDisconnect.set', 1, value, this.path_, false); util.validateCallback('OnDisconnect.set', 2, onComplete, true); var deferred = new util.Deferred(); this.repo_.onDisconnectSet(this.path_, value, deferred.wrapCallback(onComplete)); return deferred.promise; }; /** * @param {*} value * @param {number|string|null} priority * @param {function(?Error)=} onComplete * @return {!firebase.Promise} */ OnDisconnect.prototype.setWithPriority = function (value, priority, onComplete) { util.validateArgCount('OnDisconnect.setWithPriority', 2, 3, arguments.length); validateWritablePath('OnDisconnect.setWithPriority', this.path_); validateFirebaseDataArg('OnDisconnect.setWithPriority', 1, value, this.path_, false); validatePriority('OnDisconnect.setWithPriority', 2, priority, false); util.validateCallback('OnDisconnect.setWithPriority', 3, onComplete, true); var deferred = new util.Deferred(); this.repo_.onDisconnectSetWithPriority(this.path_, value, priority, deferred.wrapCallback(onComplete)); return deferred.promise; }; /** * @param {!Object} objectToMerge * @param {function(?Error)=} onComplete * @return {!firebase.Promise} */ OnDisconnect.prototype.update = function (objectToMerge, onComplete) { util.validateArgCount('OnDisconnect.update', 1, 2, arguments.length); validateWritablePath('OnDisconnect.update', this.path_); if (Array.isArray(objectToMerge)) { var newObjectToMerge = {}; for (var i = 0; i < objectToMerge.length; ++i) { newObjectToMerge['' + i] = objectToMerge[i]; } objectToMerge = newObjectToMerge; warn('Passing an Array to firebase.database.onDisconnect().update() is deprecated. Use set() if you want to overwrite the ' + 'existing data, or an Object with integer keys if you really do want to only update some of the children.'); } validateFirebaseMergeDataArg('OnDisconnect.update', 1, objectToMerge, this.path_, false); util.validateCallback('OnDisconnect.update', 2, onComplete, true); var deferred = new util.Deferred(); this.repo_.onDisconnectUpdate(this.path_, objectToMerge, deferred.wrapCallback(onComplete)); return deferred.promise; }; return OnDisconnect; }()); /** * Copyright 2017 Google Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ var TransactionResult = /** @class */ (function () { /** * A type for the resolve value of Firebase.transaction. * @constructor * @dict * @param {boolean} committed * @param {DataSnapshot} snapshot */ function TransactionResult(committed, snapshot) { this.committed = committed; this.snapshot = snapshot; } // Do not create public documentation. This is intended to make JSON serialization work but is otherwise unnecessary // for end-users TransactionResult.prototype.toJSON = function () { util.validateArgCount('TransactionResult.toJSON', 0, 1, arguments.length); return { committed: this.committed, snapshot: this.snapshot.toJSON() }; }; return TransactionResult; }()); /** * Copyright 2017 Google Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ /** * Fancy ID generator that creates 20-character string identifiers with the * following properties: * * 1. They're based on timestamp so that they sort *after* any existing ids. * 2. They contain 72-bits of random data after the timestamp so that IDs won't * collide with other clients' IDs. * 3. They sort *lexicographically* (so the timestamp is converted to characters * that will sort properly). * 4. They're monotonically increasing. Even if you generate more than one in * the same timestamp, the latter ones will sort after the former ones. We do * this by using the previous random bits but "incrementing" them by 1 (only * in the case of a timestamp collision). */ var nextPushId = (function () { // Modeled after base64 web-safe chars, but ordered by ASCII. var PUSH_CHARS = '-0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ_abcdefghijklmnopqrstuvwxyz'; // Timestamp of last push, used to prevent local collisions if you push twice // in one ms. var lastPushTime = 0; // We generate 72-bits of randomness which get turned into 12 characters and // appended to the timestamp to prevent collisions with other clients. We // store the last characters we generated because in the event of a collision, // we'll use those same characters except "incremented" by one. var lastRandChars = []; return function (now) { var duplicateTime = now === lastPushTime; lastPushTime = now; var i; var timeStampChars = new Array(8); for (i = 7; i >= 0; i--) { timeStampChars[i] = PUSH_CHARS.charAt(now % 64); // NOTE: Can't use << here because javascript will convert to int and lose // the upper bits. now = Math.floor(now / 64); } util.assert(now === 0, 'Cannot push at time == 0'); var id = timeStampChars.join(''); if (!duplicateTime) { for (i = 0; i < 12; i++) { lastRandChars[i] = Math.floor(Math.random() * 64); } } else { // If the timestamp hasn't changed since last push, use the same random // number, except incremented by 1. for (i = 11; i >= 0 && lastRandChars[i] === 63; i--) { lastRandChars[i] = 0; } lastRandChars[i]++; } for (i = 0; i < 12; i++) { id += PUSH_CHARS.charAt(lastRandChars[i]); } util.assert(id.length === 20, 'nextPushId: Length should be 20.'); return id; }; })(); /** * Copyright 2017 Google Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ /** * * @param {!string} name * @param {!Node} node * @constructor * @struct */ var NamedNode = /** @class */ (function () { function NamedNode(name, node) { this.name = name; this.node = node; } /** * * @param {!string} name * @param {!Node} node * @return {NamedNode} */ NamedNode.Wrap = function (name, node) { return new NamedNode(name, node); }; return NamedNode; }()); /** * Copyright 2017 Google Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ /** * * @constructor */ var Index = /** @class */ (function () { function Index() { } /** * @return {function(!NamedNode, !NamedNode):number} A standalone comparison function for * this index */ Index.prototype.getCompare = function () { return this.compare.bind(this); }; /** * Given a before and after value for a node, determine if the indexed value has changed. Even if they are different, * it's possible that the changes are isolated to parts of the snapshot that are not indexed. * * @param {!Node} oldNode * @param {!Node} newNode * @return {boolean} True if the portion of the snapshot being indexed changed between oldNode and newNode */ Index.prototype.indexedValueChanged = function (oldNode, newNode) { var oldWrapped = new NamedNode(MIN_NAME, oldNode); var newWrapped = new NamedNode(MIN_NAME, newNode); return this.compare(oldWrapped, newWrapped) !== 0; }; /** * @return {!NamedNode} a node wrapper that will sort equal to or less than * any other node wrapper, using this index */ Index.prototype.minPost = function () { return NamedNode.MIN; }; return Index; }()); /** * Copyright 2017 Google Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ var __EMPTY_NODE; var KeyIndex = /** @class */ (function (_super) { tslib_1.__extends(KeyIndex, _super); function KeyIndex() { return _super !== null && _super.apply(this, arguments) || this; } Object.defineProperty(KeyIndex, "__EMPTY_NODE", { get: function () { return __EMPTY_NODE; }, set: function (val) { __EMPTY_NODE = val; }, enumerable: true, configurable: true }); /** * @inheritDoc */ KeyIndex.prototype.compare = function (a, b) { return nameCompare(a.name, b.name); }; /** * @inheritDoc */ KeyIndex.prototype.isDefinedOn = function (node) { // We could probably return true here (since every node has a key), but it's never called // so just leaving unimplemented for now. throw util.assertionError('KeyIndex.isDefinedOn not expected to be called.'); }; /** * @inheritDoc */ KeyIndex.prototype.indexedValueChanged = function (oldNode, newNode) { return false; // The key for a node never changes. }; /** * @inheritDoc */ KeyIndex.prototype.minPost = function () { return NamedNode.MIN; }; /** * @inheritDoc */ KeyIndex.prototype.maxPost = function () { // TODO: This should really be created once and cached in a static property, but // NamedNode isn't defined yet, so I can't use it in a static. Bleh. return new NamedNode(MAX_NAME, __EMPTY_NODE); }; /** * @param {*} indexValue * @param {string} name * @return {!NamedNode} */ KeyIndex.prototype.makePost = function (indexValue, name) { util.assert(typeof indexValue === 'string', 'KeyIndex indexValue must always be a string.'); // We just use empty node, but it'll never be compared, since our comparator only looks at name. return new NamedNode(indexValue, __EMPTY_NODE); }; /** * @return {!string} String representation for inclusion in a query spec */ KeyIndex.prototype.toString = function () { return '.key'; }; return KeyIndex; }(Index)); var KEY_INDEX = new KeyIndex(); /** * Copyright 2017 Google Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ var MAX_NODE; function setMaxNode(val) { MAX_NODE = val; } /** * @param {(!string|!number)} priority * @return {!string} */ var priorityHashText = function (priority) { if (typeof priority === 'number') return 'number:' + doubleToIEEE754String(priority); else return 'string:' + priority; }; /** * Validates that a priority snapshot Node is valid. * * @param {!Node} priorityNode */ var validatePriorityNode = function (priorityNode) { if (priorityNode.isLeafNode()) { var val = priorityNode.val(); util.assert(typeof val === 'string' || typeof val === 'number' || (typeof val === 'object' && util.contains(val, '.sv')), 'Priority must be a string or number.'); } else { util.assert(priorityNode === MAX_NODE || priorityNode.isEmpty(), 'priority of unexpected type.'); } // Don't call getPriority() on MAX_NODE to avoid hitting assertion. util.assert(priorityNode === MAX_NODE || priorityNode.getPriority().isEmpty(), "Priority nodes can't have a priority of their own."); }; /** * Copyright 2017 Google Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ var __childrenNodeConstructor; /** * LeafNode is a class for storing leaf nodes in a DataSnapshot. It * implements Node and stores the value of the node (a string, * number, or boolean) accessible via getValue(). */ var LeafNode = /** @class */ (function () { /** * @implements {Node} * @param {!(string|number|boolean|Object)} value_ The value to store in this leaf node. * The object type is possible in the event of a deferred value * @param {!Node=} priorityNode_ The priority of this node. */ function LeafNode(value_, priorityNode_) { if (priorityNode_ === void 0) { priorityNode_ = LeafNode.__childrenNodeConstructor.EMPTY_NODE; } this.value_ = value_; this.priorityNode_ = priorityNode_; this.lazyHash_ = null; util.assert(this.value_ !== undefined && this.value_ !== null, "LeafNode shouldn't be created with null/undefined value."); validatePriorityNode(this.priorityNode_); } Object.defineProperty(LeafNode, "__childrenNodeConstructor", { get: function () { return __childrenNodeConstructor; }, set: function (val) { __childrenNodeConstructor = val; }, enumerable: true, configurable: true }); /** @inheritDoc */ LeafNode.prototype.isLeafNode = function () { return true; }; /** @inheritDoc */ LeafNode.prototype.getPriority = function () { return this.priorityNode_; }; /** @inheritDoc */ LeafNode.prototype.updatePriority = function (newPriorityNode) { return new LeafNode(this.value_, newPriorityNode); }; /** @inheritDoc */ LeafNode.prototype.getImmediateChild = function (childName) { // Hack to treat priority as a regular child if (childName === '.priority') { return this.priorityNode_; } else { return LeafNode.__childrenNodeConstructor.EMPTY_NODE; } }; /** @inheritDoc */ LeafNode.prototype.getChild = function (path) { if (path.isEmpty()) { return this; } else if (path.getFront() === '.priority') { return this.priorityNode_; } else { return LeafNode.__childrenNodeConstructor.EMPTY_NODE; } }; /** * @inheritDoc */ LeafNode.prototype.hasChild = function () { return false; }; /** @inheritDoc */ LeafNode.prototype.getPredecessorChildName = function (childName, childNode) { return null; }; /** @inheritDoc */ LeafNode.prototype.updateImmediateChild = function (childName, newChildNode) { if (childName === '.priority') { return this.updatePriority(newChildNode); } else if (newChildNode.isEmpty() && childName !== '.priority') { return this; } else { return LeafNode.__childrenNodeConstructor.EMPTY_NODE.updateImmediateChild(childName, newChildNode).updatePriority(this.priorityNode_); } }; /** @inheritDoc */ LeafNode.prototype.updateChild = function (path, newChildNode) { var front = path.getFront(); if (front === null) { return newChildNode; } else if (newChildNode.isEmpty() && front !== '.priority') { return this; } else { util.assert(front !== '.priority' || path.getLength() === 1, '.priority must be the last token in a path'); return this.updateImmediateChild(front, LeafNode.__childrenNodeConstructor.EMPTY_NODE.updateChild(path.popFront(), newChildNode)); } }; /** @inheritDoc */ LeafNode.prototype.isEmpty = function () { return false; }; /** @inheritDoc */ LeafNode.prototype.numChildren = function () { return 0; }; /** @inheritDoc */ LeafNode.prototype.forEachChild = function (index, action) { return false; }; /** * @inheritDoc */ LeafNode.prototype.val = function (exportFormat) { if (exportFormat && !this.getPriority().isEmpty()) return { '.value': this.getValue(), '.priority': this.getPriority().val() }; else return this.getValue(); }; /** @inheritDoc */ LeafNode.prototype.hash = function () { if (this.lazyHash_ === null) { var toHash = ''; if (!this.priorityNode_.isEmpty()) toHash += 'priority:' + priorityHashText(this.priorityNode_.val()) + ':'; var type = typeof this.value_; toHash += type + ':'; if (type === 'number') { toHash += doubleToIEEE754String(this.value_); } else { toHash += this.value_; } this.lazyHash_ = sha1(toHash); } return this.lazyHash_; }; /** * Returns the value of the leaf node. * @return {Object|string|number|boolean} The value of the node. */ LeafNode.prototype.getValue = function () { return this.value_; }; /** * @inheritDoc */ LeafNode.prototype.compareTo = function (other) { if (other === LeafNode.__childrenNodeConstructor.EMPTY_NODE) { return 1; } else if (other instanceof LeafNode.__childrenNodeConstructor) { return -1; } else { util.assert(other.isLeafNode(), 'Unknown node type'); return this.compareToLeafNode_(other); } }; /** * Comparison specifically for two leaf nodes * @param {!LeafNode} otherLeaf * @return {!number} * @private */ LeafNode.prototype.compareToLeafNode_ = function (otherLeaf) { var otherLeafType = typeof otherLeaf.value_; var thisLeafType = typeof this.value_; var otherIndex = LeafNode.VALUE_TYPE_ORDER.indexOf(otherLeafType); var thisIndex = LeafNode.VALUE_TYPE_ORDER.indexOf(thisLeafType); util.assert(otherIndex >= 0, 'Unknown leaf type: ' + otherLeafType); util.assert(thisIndex >= 0, 'Unknown leaf type: ' + thisLeafType); if (otherIndex === thisIndex) { // Same type, compare values if (thisLeafType === 'object') { // Deferred value nodes are all equal, but we should also never get to this point... return 0; } else { // Note that this works because true > false, all others are number or string comparisons if (this.value_ < otherLeaf.value_) { return -1; } else if (this.value_ === otherLeaf.value_) { return 0; } else { return 1; } } } else { return thisIndex - otherIndex; } }; /** * @inheritDoc */ LeafNode.prototype.withIndex = function () { return this; }; /** * @inheritDoc */ LeafNode.prototype.isIndexed = function () { return true; }; /** * @inheritDoc */ LeafNode.prototype.equals = function (other) { /** * @inheritDoc */ if (other === this) { return true; } else if (other.isLeafNode()) { var otherLeaf = other; return (this.value_ === otherLeaf.value_ && this.priorityNode_.equals(otherLeaf.priorityNode_)); } else { return false; } }; /** * The sort order for comparing leaf nodes of different types. If two leaf nodes have * the same type, the comparison falls back to their value * @type {Array.} * @const */ LeafNode.VALUE_TYPE_ORDER = ['object', 'boolean', 'number', 'string']; return LeafNode; }()); /** * Copyright 2017 Google Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ var nodeFromJSON; var MAX_NODE$1; function setNodeFromJSON(val) { nodeFromJSON = val; } function setMaxNode$1(val) { MAX_NODE$1 = val; } /** * @constructor * @extends {Index} * @private */ var PriorityIndex = /** @class */ (function (_super) { tslib_1.__extends(PriorityIndex, _super); function PriorityIndex() { return _super !== null && _super.apply(this, arguments) || this; } /** * @inheritDoc */ PriorityIndex.prototype.compare = function (a, b) { var aPriority = a.node.getPriority(); var bPriority = b.node.getPriority(); var indexCmp = aPriority.compareTo(bPriority); if (indexCmp === 0) { return nameCompare(a.name, b.name); } else { return indexCmp; } }; /** * @inheritDoc */ PriorityIndex.prototype.isDefinedOn = function (node) { return !node.getPriority().isEmpty(); }; /** * @inheritDoc */ PriorityIndex.prototype.indexedValueChanged = function (oldNode, newNode) { return !oldNode.getPriority().equals(newNode.getPriority()); }; /** * @inheritDoc */ PriorityIndex.prototype.minPost = function () { return NamedNode.MIN; }; /** * @inheritDoc */ PriorityIndex.prototype.maxPost = function () { return new NamedNode(MAX_NAME, new LeafNode('[PRIORITY-POST]', MAX_NODE$1)); }; /** * @param {*} indexValue * @param {string} name * @return {!NamedNode} */ PriorityIndex.prototype.makePost = function (indexValue, name) { var priorityNode = nodeFromJSON(indexValue); return new NamedNode(name, new LeafNode('[PRIORITY-POST]', priorityNode)); }; /** * @return {!string} String representation for inclusion in a query spec */ PriorityIndex.prototype.toString = function () { return '.priority'; }; return PriorityIndex; }(Index)); var PRIORITY_INDEX = new PriorityIndex(); /** * Copyright 2017 Google Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ /** * An iterator over an LLRBNode. */ var SortedMapIterator = /** @class */ (function () { /** * @template K, V, T * @param {LLRBNode|LLRBEmptyNode} node Node to iterate. * @param {?K} startKey * @param {function(K, K): number} comparator * @param {boolean} isReverse_ Whether or not to iterate in reverse * @param {(function(K, V):T)=} resultGenerator_ */ function SortedMapIterator(node, startKey, comparator, isReverse_, resultGenerator_) { if (resultGenerator_ === void 0) { resultGenerator_ = null; } this.isReverse_ = isReverse_; this.resultGenerator_ = resultGenerator_; /** @private * @type {Array.} */ this.nodeStack_ = []; var cmp = 1; while (!node.isEmpty()) { node = node; cmp = startKey ? comparator(node.key, startKey) : 1; // flip the comparison if we're going in reverse if (isReverse_) cmp *= -1; if (cmp < 0) { // This node is less than our start key. ignore it if (this.isReverse_) { node = node.left; } else { node = node.right; } } else if (cmp === 0) { // This node is exactly equal to our start key. Push it on the stack, but stop iterating; this.nodeStack_.push(node); break; } else { // This node is greater than our start key, add it to the stack and move to the next one this.nodeStack_.push(node); if (this.isReverse_) { node = node.right; } else { node = node.left; } } } } SortedMapIterator.prototype.getNext = function () { if (this.nodeStack_.length === 0) return null; var node = this.nodeStack_.pop(); var result; if (this.resultGenerator_) result = this.resultGenerator_(node.key, node.value); else result = { key: node.key, value: node.value }; if (this.isReverse_) { node = node.left; while (!node.isEmpty()) { this.nodeStack_.push(node); node = node.right; } } else { node = node.right; while (!node.isEmpty()) { this.nodeStack_.push(node); node = node.left; } } return result; }; SortedMapIterator.prototype.hasNext = function () { return this.nodeStack_.length > 0; }; SortedMapIterator.prototype.peek = function () { if (this.nodeStack_.length === 0) return null; var node = this.nodeStack_[this.nodeStack_.length - 1]; if (this.resultGenerator_) { return this.resultGenerator_(node.key, node.value); } else { return { key: node.key, value: node.value }; } }; return SortedMapIterator; }()); /** * Represents a node in a Left-leaning Red-Black tree. */ var LLRBNode = /** @class */ (function () { /** * @template K, V * @param {!K} key Key associated with this node. * @param {!V} value Value associated with this node. * @param {?boolean} color Whether this node is red. * @param {?(LLRBNode|LLRBEmptyNode)=} left Left child. * @param {?(LLRBNode|LLRBEmptyNode)=} right Right child. */ function LLRBNode(key, value, color, left, right) { this.key = key; this.value = value; this.color = color != null ? color : LLRBNode.RED; this.left = left != null ? left : SortedMap.EMPTY_NODE; this.right = right != null ? right : SortedMap.EMPTY_NODE; } /** * Returns a copy of the current node, optionally replacing pieces of it. * * @param {?K} key New key for the node, or null. * @param {?V} value New value for the node, or null. * @param {?boolean} color New color for the node, or null. * @param {?LLRBNode|LLRBEmptyNode} left New left child for the node, or null. * @param {?LLRBNode|LLRBEmptyNode} right New right child for the node, or null. * @return {!LLRBNode} The node copy. */ LLRBNode.prototype.copy = function (key, value, color, left, right) { return new LLRBNode(key != null ? key : this.key, value != null ? value : this.value, color != null ? color : this.color, left != null ? left : this.left, right != null ? right : this.right); }; /** * @return {number} The total number of nodes in the tree. */ LLRBNode.prototype.count = function () { return this.left.count() + 1 + this.right.count(); }; /** * @return {boolean} True if the tree is empty. */ LLRBNode.prototype.isEmpty = function () { return false; }; /** * Traverses the tree in key order and calls the specified action function * for each node. * * @param {function(!K, !V):*} action Callback function to be called for each * node. If it returns true, traversal is aborted. * @return {*} The first truthy value returned by action, or the last falsey * value returned by action */ LLRBNode.prototype.inorderTraversal = function (action) { return (this.left.inorderTraversal(action) || action(this.key, this.value) || this.right.inorderTraversal(action)); }; /** * Traverses the tree in reverse key order and calls the specified action function * for each node. * * @param {function(!Object, !Object)} action Callback function to be called for each * node. If it returns true, traversal is aborted. * @return {*} True if traversal was aborted. */ LLRBNode.prototype.reverseTraversal = function (action) { return (this.right.reverseTraversal(action) || action(this.key, this.value) || this.left.reverseTraversal(action)); }; /** * @return {!Object} The minimum node in the tree. * @private */ LLRBNode.prototype.min_ = function () { if (this.left.isEmpty()) { return this; } else { return this.left.min_(); } }; /** * @return {!K} The maximum key in the tree. */ LLRBNode.prototype.minKey = function () { return this.min_().key; }; /** * @return {!K} The maximum key in the tree. */ LLRBNode.prototype.maxKey = function () { if (this.right.isEmpty()) { return this.key; } else { return this.right.maxKey(); } }; /** * * @param {!Object} key Key to insert. * @param {!Object} value Value to insert. * @param {Comparator} comparator Comparator. * @return {!LLRBNode} New tree, with the key/value added. */ LLRBNode.prototype.insert = function (key, value, comparator) { var cmp, n; n = this; cmp = comparator(key, n.key); if (cmp < 0) { n = n.copy(null, null, null, n.left.insert(key, value, comparator), null); } else if (cmp === 0) { n = n.copy(null, value, null, null, null); } else { n = n.copy(null, null, null, null, n.right.insert(key, value, comparator)); } return n.fixUp_(); }; /** * @private * @return {!LLRBNode|LLRBEmptyNode} New tree, with the minimum key removed. */ LLRBNode.prototype.removeMin_ = function () { if (this.left.isEmpty()) { return SortedMap.EMPTY_NODE; } var n = this; if (!n.left.isRed_() && !n.left.left.isRed_()) n = n.moveRedLeft_(); n = n.copy(null, null, null, n.left.removeMin_(), null); return n.fixUp_(); }; /** * @param {!Object} key The key of the item to remove. * @param {Comparator} comparator Comparator. * @return {!LLRBNode|LLRBEmptyNode} New tree, with the specified item removed. */ LLRBNode.prototype.remove = function (key, comparator) { var n, smallest; n = this; if (comparator(key, n.key) < 0) { if (!n.left.isEmpty() && !n.left.isRed_() && !n.left.left.isRed_()) { n = n.moveRedLeft_(); } n = n.copy(null, null, null, n.left.remove(key, comparator), null); } else { if (n.left.isRed_()) n = n.rotateRight_(); if (!n.right.isEmpty() && !n.right.isRed_() && !n.right.left.isRed_()) { n = n.moveRedRight_(); } if (comparator(key, n.key) === 0) { if (n.right.isEmpty()) { return SortedMap.EMPTY_NODE; } else { smallest = n.right.min_(); n = n.copy(smallest.key, smallest.value, null, null, n.right.removeMin_()); } } n = n.copy(null, null, null, null, n.right.remove(key, comparator)); } return n.fixUp_(); }; /** * @private * @return {boolean} Whether this is a RED node. */ LLRBNode.prototype.isRed_ = function () { return this.color; }; /** * @private * @return {!LLRBNode} New tree after performing any needed rotations. */ LLRBNode.prototype.fixUp_ = function () { var n = this; if (n.right.isRed_() && !n.left.isRed_()) n = n.rotateLeft_(); if (n.left.isRed_() && n.left.left.isRed_()) n = n.rotateRight_(); if (n.left.isRed_() && n.right.isRed_()) n = n.colorFlip_(); return n; }; /** * @private * @return {!LLRBNode} New tree, after moveRedLeft. */ LLRBNode.prototype.moveRedLeft_ = function () { var n = this.colorFlip_(); if (n.right.left.isRed_()) { n = n.copy(null, null, null, null, n.right.rotateRight_()); n = n.rotateLeft_(); n = n.colorFlip_(); } return n; }; /** * @private * @return {!LLRBNode} New tree, after moveRedRight. */ LLRBNode.prototype.moveRedRight_ = function () { var n = this.colorFlip_(); if (n.left.left.isRed_()) { n = n.rotateRight_(); n = n.colorFlip_(); } return n; }; /** * @private * @return {!LLRBNode} New tree, after rotateLeft. */ LLRBNode.prototype.rotateLeft_ = function () { var nl = this.copy(null, null, LLRBNode.RED, null, this.right.left); return this.right.copy(null, null, this.color, nl, null); }; /** * @private * @return {!LLRBNode} New tree, after rotateRight. */ LLRBNode.prototype.rotateRight_ = function () { var nr = this.copy(null, null, LLRBNode.RED, this.left.right, null); return this.left.copy(null, null, this.color, null, nr); }; /** * @private * @return {!LLRBNode} New tree, after colorFlip. */ LLRBNode.prototype.colorFlip_ = function () { var left = this.left.copy(null, null, !this.left.color, null, null); var right = this.right.copy(null, null, !this.right.color, null, null); return this.copy(null, null, !this.color, left, right); }; /** * For testing. * * @private * @return {boolean} True if all is well. */ LLRBNode.prototype.checkMaxDepth_ = function () { var blackDepth = this.check_(); return Math.pow(2.0, blackDepth) <= this.count() + 1; }; /** * @private * @return {number} Not sure what this returns exactly. :-). */ LLRBNode.prototype.check_ = function () { var blackDepth; if (this.isRed_() && this.left.isRed_()) { throw new Error('Red node has red child(' + this.key + ',' + this.value + ')'); } if (this.right.isRed_()) { throw new Error('Right child of (' + this.key + ',' + this.value + ') is red'); } blackDepth = this.left.check_(); if (blackDepth !== this.right.check_()) { throw new Error('Black depths differ'); } else { return blackDepth + (this.isRed_() ? 0 : 1); } }; LLRBNode.RED = true; LLRBNode.BLACK = false; return LLRBNode; }()); /** * Represents an empty node (a leaf node in the Red-Black Tree). */ var LLRBEmptyNode = /** @class */ (function () { function LLRBEmptyNode() { } /** * Returns a copy of the current node. * * @return {!LLRBEmptyNode} The node copy. */ LLRBEmptyNode.prototype.copy = function (key, value, color, left, right) { return this; }; /** * Returns a copy of the tree, with the specified key/value added. * * @param {!K} key Key to be added. * @param {!V} value Value to be added. * @param {Comparator} comparator Comparator. * @return {!LLRBNode} New tree, with item added. */ LLRBEmptyNode.prototype.insert = function (key, value, comparator) { return new LLRBNode(key, value, null); }; /** * Returns a copy of the tree, with the specified key removed. * * @param {!K} key The key to remove. * @param {Comparator} comparator Comparator. * @return {!LLRBEmptyNode} New tree, with item removed. */ LLRBEmptyNode.prototype.remove = function (key, comparator) { return this; }; /** * @return {number} The total number of nodes in the tree. */ LLRBEmptyNode.prototype.count = function () { return 0; }; /** * @return {boolean} True if the tree is empty. */ LLRBEmptyNode.prototype.isEmpty = function () { return true; }; /** * Traverses the tree in key order and calls the specified action function * for each node. * * @param {function(!K, !V):*} action Callback function to be called for each * node. If it returns true, traversal is aborted. * @return {boolean} True if traversal was aborted. */ LLRBEmptyNode.prototype.inorderTraversal = function (action) { return false; }; /** * Traverses the tree in reverse key order and calls the specified action function * for each node. * * @param {function(!K, !V)} action Callback function to be called for each * node. If it returns true, traversal is aborted. * @return {boolean} True if traversal was aborted. */ LLRBEmptyNode.prototype.reverseTraversal = function (action) { return false; }; /** * @return {null} */ LLRBEmptyNode.prototype.minKey = function () { return null; }; /** * @return {null} */ LLRBEmptyNode.prototype.maxKey = function () { return null; }; /** * @private * @return {number} Not sure what this returns exactly. :-). */ LLRBEmptyNode.prototype.check_ = function () { return 0; }; /** * @private * @return {boolean} Whether this node is red. */ LLRBEmptyNode.prototype.isRed_ = function () { return false; }; return LLRBEmptyNode; }()); /** * An immutable sorted map implementation, based on a Left-leaning Red-Black * tree. */ var SortedMap = /** @class */ (function () { /** * @template K, V * @param {function(K, K):number} comparator_ Key comparator. * @param {LLRBNode=} root_ (Optional) Root node for the map. */ function SortedMap(comparator_, root_) { if (root_ === void 0) { root_ = SortedMap.EMPTY_NODE; } this.comparator_ = comparator_; this.root_ = root_; } /** * Returns a copy of the map, with the specified key/value added or replaced. * (TODO: We should perhaps rename this method to 'put') * * @param {!K} key Key to be added. * @param {!V} value Value to be added. * @return {!SortedMap.} New map, with item added. */ SortedMap.prototype.insert = function (key, value) { return new SortedMap(this.comparator_, this.root_ .insert(key, value, this.comparator_) .copy(null, null, LLRBNode.BLACK, null, null)); }; /** * Returns a copy of the map, with the specified key removed. * * @param {!K} key The key to remove. * @return {!SortedMap.} New map, with item removed. */ SortedMap.prototype.remove = function (key) { return new SortedMap(this.comparator_, this.root_ .remove(key, this.comparator_) .copy(null, null, LLRBNode.BLACK, null, null)); }; /** * Returns the value of the node with the given key, or null. * * @param {!K} key The key to look up. * @return {?V} The value of the node with the given key, or null if the * key doesn't exist. */ SortedMap.prototype.get = function (key) { var cmp; var node = this.root_; while (!node.isEmpty()) { cmp = this.comparator_(key, node.key); if (cmp === 0) { return node.value; } else if (cmp < 0) { node = node.left; } else if (cmp > 0) { node = node.right; } } return null; }; /** * Returns the key of the item *before* the specified key, or null if key is the first item. * @param {K} key The key to find the predecessor of * @return {?K} The predecessor key. */ SortedMap.prototype.getPredecessorKey = function (key) { var cmp, node = this.root_, rightParent = null; while (!node.isEmpty()) { cmp = this.comparator_(key, node.key); if (cmp === 0) { if (!node.left.isEmpty()) { node = node.left; while (!node.right.isEmpty()) node = node.right; return node.key; } else if (rightParent) { return rightParent.key; } else { return null; // first item. } } else if (cmp < 0) { node = node.left; } else if (cmp > 0) { rightParent = node; node = node.right; } } throw new Error('Attempted to find predecessor key for a nonexistent key. What gives?'); }; /** * @return {boolean} True if the map is empty. */ SortedMap.prototype.isEmpty = function () { return this.root_.isEmpty(); }; /** * @return {number} The total number of nodes in the map. */ SortedMap.prototype.count = function () { return this.root_.count(); }; /** * @return {?K} The minimum key in the map. */ SortedMap.prototype.minKey = function () { return this.root_.minKey(); }; /** * @return {?K} The maximum key in the map. */ SortedMap.prototype.maxKey = function () { return this.root_.maxKey(); }; /** * Traverses the map in key order and calls the specified action function * for each key/value pair. * * @param {function(!K, !V):*} action Callback function to be called * for each key/value pair. If action returns true, traversal is aborted. * @return {*} The first truthy value returned by action, or the last falsey * value returned by action */ SortedMap.prototype.inorderTraversal = function (action) { return this.root_.inorderTraversal(action); }; /** * Traverses the map in reverse key order and calls the specified action function * for each key/value pair. * * @param {function(!Object, !Object)} action Callback function to be called * for each key/value pair. If action returns true, traversal is aborted. * @return {*} True if the traversal was aborted. */ SortedMap.prototype.reverseTraversal = function (action) { return this.root_.reverseTraversal(action); }; /** * Returns an iterator over the SortedMap. * @template T * @param {(function(K, V):T)=} resultGenerator * @return {SortedMapIterator.} The iterator. */ SortedMap.prototype.getIterator = function (resultGenerator) { return new SortedMapIterator(this.root_, null, this.comparator_, false, resultGenerator); }; SortedMap.prototype.getIteratorFrom = function (key, resultGenerator) { return new SortedMapIterator(this.root_, key, this.comparator_, false, resultGenerator); }; SortedMap.prototype.getReverseIteratorFrom = function (key, resultGenerator) { return new SortedMapIterator(this.root_, key, this.comparator_, true, resultGenerator); }; SortedMap.prototype.getReverseIterator = function (resultGenerator) { return new SortedMapIterator(this.root_, null, this.comparator_, true, resultGenerator); }; /** * Always use the same empty node, to reduce memory. * @const */ SortedMap.EMPTY_NODE = new LLRBEmptyNode(); return SortedMap; }()); /** * Copyright 2017 Google Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ var LOG_2 = Math.log(2); /** * @constructor */ var Base12Num = /** @class */ (function () { /** * @param {number} length */ function Base12Num(length) { var logBase2 = function (num) { return parseInt((Math.log(num) / LOG_2), 10); }; var bitMask = function (bits) { return parseInt(Array(bits + 1).join('1'), 2); }; this.count = logBase2(length + 1); this.current_ = this.count - 1; var mask = bitMask(this.count); this.bits_ = (length + 1) & mask; } /** * @return {boolean} */ Base12Num.prototype.nextBitIsOne = function () { //noinspection JSBitwiseOperatorUsage var result = !(this.bits_ & (0x1 << this.current_)); this.current_--; return result; }; return Base12Num; }()); /** * Takes a list of child nodes and constructs a SortedSet using the given comparison * function * * Uses the algorithm described in the paper linked here: * http://citeseerx.ist.psu.edu/viewdoc/summary?doi=10.1.1.46.1458 * * @template K, V * @param {Array.} childList Unsorted list of children * @param {function(!NamedNode, !NamedNode):number} cmp The comparison method to be used * @param {(function(NamedNode):K)=} keyFn An optional function to extract K from a node wrapper, if K's * type is not NamedNode * @param {(function(K, K):number)=} mapSortFn An optional override for comparator used by the generated sorted map * @return {SortedMap.} */ var buildChildSet = function (childList, cmp, keyFn, mapSortFn) { childList.sort(cmp); var buildBalancedTree = function (low, high) { var length = high - low; var namedNode; var key; if (length == 0) { return null; } else if (length == 1) { namedNode = childList[low]; key = keyFn ? keyFn(namedNode) : namedNode; return new LLRBNode(key, namedNode.node, LLRBNode.BLACK, null, null); } else { var middle = parseInt((length / 2), 10) + low; var left = buildBalancedTree(low, middle); var right = buildBalancedTree(middle + 1, high); namedNode = childList[middle]; key = keyFn ? keyFn(namedNode) : namedNode; return new LLRBNode(key, namedNode.node, LLRBNode.BLACK, left, right); } }; var buildFrom12Array = function (base12) { var node = null; var root = null; var index = childList.length; var buildPennant = function (chunkSize, color) { var low = index - chunkSize; var high = index; index -= chunkSize; var childTree = buildBalancedTree(low + 1, high); var namedNode = childList[low]; var key = keyFn ? keyFn(namedNode) : namedNode; attachPennant(new LLRBNode(key, namedNode.node, color, null, childTree)); }; var attachPennant = function (pennant) { if (node) { node.left = pennant; node = pennant; } else { root = pennant; node = pennant; } }; for (var i = 0; i < base12.count; ++i) { var isOne = base12.nextBitIsOne(); // The number of nodes taken in each slice is 2^(arr.length - (i + 1)) var chunkSize = Math.pow(2, base12.count - (i + 1)); if (isOne) { buildPennant(chunkSize, LLRBNode.BLACK); } else { // current == 2 buildPennant(chunkSize, LLRBNode.BLACK); buildPennant(chunkSize, LLRBNode.RED); } } return root; }; var base12 = new Base12Num(childList.length); var root = buildFrom12Array(base12); return new SortedMap(mapSortFn || cmp, root); }; /** * Copyright 2017 Google Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ var _defaultIndexMap; var fallbackObject = {}; /** * * @param {Object.>} indexes * @param {Object.} indexSet * @constructor */ var IndexMap = /** @class */ (function () { function IndexMap(indexes_, indexSet_) { this.indexes_ = indexes_; this.indexSet_ = indexSet_; } Object.defineProperty(IndexMap, "Default", { /** * The default IndexMap for nodes without a priority * @type {!IndexMap} * @const */ get: function () { util.assert(fallbackObject && PRIORITY_INDEX, 'ChildrenNode.ts has not been loaded'); _defaultIndexMap = _defaultIndexMap || new IndexMap({ '.priority': fallbackObject }, { '.priority': PRIORITY_INDEX }); return _defaultIndexMap; }, enumerable: true, configurable: true }); /** * * @param {!string} indexKey * @return {?SortedMap.} */ IndexMap.prototype.get = function (indexKey) { var sortedMap = util.safeGet(this.indexes_, indexKey); if (!sortedMap) throw new Error('No index defined for ' + indexKey); if (sortedMap === fallbackObject) { // The index exists, but it falls back to just name comparison. Return null so that the calling code uses the // regular child map return null; } else { return sortedMap; } }; /** * @param {!Index} indexDefinition * @return {boolean} */ IndexMap.prototype.hasIndex = function (indexDefinition) { return util.contains(this.indexSet_, indexDefinition.toString()); }; /** * @param {!Index} indexDefinition * @param {!SortedMap.} existingChildren * @return {!IndexMap} */ IndexMap.prototype.addIndex = function (indexDefinition, existingChildren) { util.assert(indexDefinition !== KEY_INDEX, "KeyIndex always exists and isn't meant to be added to the IndexMap."); var childList = []; var sawIndexedValue = false; var iter = existingChildren.getIterator(NamedNode.Wrap); var next = iter.getNext(); while (next) { sawIndexedValue = sawIndexedValue || indexDefinition.isDefinedOn(next.node); childList.push(next); next = iter.getNext(); } var newIndex; if (sawIndexedValue) { newIndex = buildChildSet(childList, indexDefinition.getCompare()); } else { newIndex = fallbackObject; } var indexName = indexDefinition.toString(); var newIndexSet = util.clone(this.indexSet_); newIndexSet[indexName] = indexDefinition; var newIndexes = util.clone(this.indexes_); newIndexes[indexName] = newIndex; return new IndexMap(newIndexes, newIndexSet); }; /** * Ensure that this node is properly tracked in any indexes that we're maintaining * @param {!NamedNode} namedNode * @param {!SortedMap.} existingChildren * @return {!IndexMap} */ IndexMap.prototype.addToIndexes = function (namedNode, existingChildren) { var _this = this; var newIndexes = util.map(this.indexes_, function (indexedChildren, indexName) { var index = util.safeGet(_this.indexSet_, indexName); util.assert(index, 'Missing index implementation for ' + indexName); if (indexedChildren === fallbackObject) { // Check to see if we need to index everything if (index.isDefinedOn(namedNode.node)) { // We need to build this index var childList = []; var iter = existingChildren.getIterator(NamedNode.Wrap); var next = iter.getNext(); while (next) { if (next.name != namedNode.name) { childList.push(next); } next = iter.getNext(); } childList.push(namedNode); return buildChildSet(childList, index.getCompare()); } else { // No change, this remains a fallback return fallbackObject; } } else { var existingSnap = existingChildren.get(namedNode.name); var newChildren = indexedChildren; if (existingSnap) { newChildren = newChildren.remove(new NamedNode(namedNode.name, existingSnap)); } return newChildren.insert(namedNode, namedNode.node); } }); return new IndexMap(newIndexes, this.indexSet_); }; /** * Create a new IndexMap instance with the given value removed * @param {!NamedNode} namedNode * @param {!SortedMap.} existingChildren * @return {!IndexMap} */ IndexMap.prototype.removeFromIndexes = function (namedNode, existingChildren) { var newIndexes = util.map(this.indexes_, function (indexedChildren) { if (indexedChildren === fallbackObject) { // This is the fallback. Just return it, nothing to do in this case return indexedChildren; } else { var existingSnap = existingChildren.get(namedNode.name); if (existingSnap) { return indexedChildren.remove(new NamedNode(namedNode.name, existingSnap)); } else { // No record of this child return indexedChildren; } } }); return new IndexMap(newIndexes, this.indexSet_); }; return IndexMap; }()); /** * Copyright 2017 Google Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ function NAME_ONLY_COMPARATOR(left, right) { return nameCompare(left.name, right.name); } function NAME_COMPARATOR(left, right) { return nameCompare(left, right); } /** * Copyright 2017 Google Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ // TODO: For memory savings, don't store priorityNode_ if it's empty. var EMPTY_NODE; /** * ChildrenNode is a class for storing internal nodes in a DataSnapshot * (i.e. nodes with children). It implements Node and stores the * list of children in the children property, sorted by child name. * * @constructor * @implements {Node} */ var ChildrenNode = /** @class */ (function () { /** * * @param {!SortedMap.} children_ List of children * of this node.. * @param {?Node} priorityNode_ The priority of this node (as a snapshot node). * @param {!IndexMap} indexMap_ */ function ChildrenNode(children_, priorityNode_, indexMap_) { this.children_ = children_; this.priorityNode_ = priorityNode_; this.indexMap_ = indexMap_; this.lazyHash_ = null; /** * Note: The only reason we allow null priority is for EMPTY_NODE, since we can't use * EMPTY_NODE as the priority of EMPTY_NODE. We might want to consider making EMPTY_NODE its own * class instead of an empty ChildrenNode. */ if (this.priorityNode_) { validatePriorityNode(this.priorityNode_); } if (this.children_.isEmpty()) { util.assert(!this.priorityNode_ || this.priorityNode_.isEmpty(), 'An empty node cannot have a priority'); } } Object.defineProperty(ChildrenNode, "EMPTY_NODE", { get: function () { return (EMPTY_NODE || (EMPTY_NODE = new ChildrenNode(new SortedMap(NAME_COMPARATOR), null, IndexMap.Default))); }, enumerable: true, configurable: true }); /** @inheritDoc */ ChildrenNode.prototype.isLeafNode = function () { return false; }; /** @inheritDoc */ ChildrenNode.prototype.getPriority = function () { return this.priorityNode_ || EMPTY_NODE; }; /** @inheritDoc */ ChildrenNode.prototype.updatePriority = function (newPriorityNode) { if (this.children_.isEmpty()) { // Don't allow priorities on empty nodes return this; } else { return new ChildrenNode(this.children_, newPriorityNode, this.indexMap_); } }; /** @inheritDoc */ ChildrenNode.prototype.getImmediateChild = function (childName) { // Hack to treat priority as a regular child if (childName === '.priority') { return this.getPriority(); } else { var child = this.children_.get(childName); return child === null ? EMPTY_NODE : child; } }; /** @inheritDoc */ ChildrenNode.prototype.getChild = function (path) { var front = path.getFront(); if (front === null) return this; return this.getImmediateChild(front).getChild(path.popFront()); }; /** @inheritDoc */ ChildrenNode.prototype.hasChild = function (childName) { return this.children_.get(childName) !== null; }; /** @inheritDoc */ ChildrenNode.prototype.updateImmediateChild = function (childName, newChildNode) { util.assert(newChildNode, 'We should always be passing snapshot nodes'); if (childName === '.priority') { return this.updatePriority(newChildNode); } else { var namedNode = new NamedNode(childName, newChildNode); var newChildren = void 0, newIndexMap = void 0, newPriority = void 0; if (newChildNode.isEmpty()) { newChildren = this.children_.remove(childName); newIndexMap = this.indexMap_.removeFromIndexes(namedNode, this.children_); } else { newChildren = this.children_.insert(childName, newChildNode); newIndexMap = this.indexMap_.addToIndexes(namedNode, this.children_); } newPriority = newChildren.isEmpty() ? EMPTY_NODE : this.priorityNode_; return new ChildrenNode(newChildren, newPriority, newIndexMap); } }; /** @inheritDoc */ ChildrenNode.prototype.updateChild = function (path, newChildNode) { var front = path.getFront(); if (front === null) { return newChildNode; } else { util.assert(path.getFront() !== '.priority' || path.getLength() === 1, '.priority must be the last token in a path'); var newImmediateChild = this.getImmediateChild(front).updateChild(path.popFront(), newChildNode); return this.updateImmediateChild(front, newImmediateChild); } }; /** @inheritDoc */ ChildrenNode.prototype.isEmpty = function () { return this.children_.isEmpty(); }; /** @inheritDoc */ ChildrenNode.prototype.numChildren = function () { return this.children_.count(); }; /** @inheritDoc */ ChildrenNode.prototype.val = function (exportFormat) { if (this.isEmpty()) return null; var obj = {}; var numKeys = 0, maxKey = 0, allIntegerKeys = true; this.forEachChild(PRIORITY_INDEX, function (key, childNode) { obj[key] = childNode.val(exportFormat); numKeys++; if (allIntegerKeys && ChildrenNode.INTEGER_REGEXP_.test(key)) { maxKey = Math.max(maxKey, Number(key)); } else { allIntegerKeys = false; } }); if (!exportFormat && allIntegerKeys && maxKey < 2 * numKeys) { // convert to array. var array = []; for (var key in obj) array[key] = obj[key]; return array; } else { if (exportFormat && !this.getPriority().isEmpty()) { obj['.priority'] = this.getPriority().val(); } return obj; } }; /** @inheritDoc */ ChildrenNode.prototype.hash = function () { if (this.lazyHash_ === null) { var toHash_1 = ''; if (!this.getPriority().isEmpty()) toHash_1 += 'priority:' + priorityHashText(this.getPriority().val()) + ':'; this.forEachChild(PRIORITY_INDEX, function (key, childNode) { var childHash = childNode.hash(); if (childHash !== '') toHash_1 += ':' + key + ':' + childHash; }); this.lazyHash_ = toHash_1 === '' ? '' : sha1(toHash_1); } return this.lazyHash_; }; /** @inheritDoc */ ChildrenNode.prototype.getPredecessorChildName = function (childName, childNode, index) { var idx = this.resolveIndex_(index); if (idx) { var predecessor = idx.getPredecessorKey(new NamedNode(childName, childNode)); return predecessor ? predecessor.name : null; } else { return this.children_.getPredecessorKey(childName); } }; /** * @param {!Index} indexDefinition * @return {?string} */ ChildrenNode.prototype.getFirstChildName = function (indexDefinition) { var idx = this.resolveIndex_(indexDefinition); if (idx) { var minKey = idx.minKey(); return minKey && minKey.name; } else { return this.children_.minKey(); } }; /** * @param {!Index} indexDefinition * @return {?NamedNode} */ ChildrenNode.prototype.getFirstChild = function (indexDefinition) { var minKey = this.getFirstChildName(indexDefinition); if (minKey) { return new NamedNode(minKey, this.children_.get(minKey)); } else { return null; } }; /** * Given an index, return the key name of the largest value we have, according to that index * @param {!Index} indexDefinition * @return {?string} */ ChildrenNode.prototype.getLastChildName = function (indexDefinition) { var idx = this.resolveIndex_(indexDefinition); if (idx) { var maxKey = idx.maxKey(); return maxKey && maxKey.name; } else { return this.children_.maxKey(); } }; /** * @param {!Index} indexDefinition * @return {?NamedNode} */ ChildrenNode.prototype.getLastChild = function (indexDefinition) { var maxKey = this.getLastChildName(indexDefinition); if (maxKey) { return new NamedNode(maxKey, this.children_.get(maxKey)); } else { return null; } }; /** * @inheritDoc */ ChildrenNode.prototype.forEachChild = function (index, action) { var idx = this.resolveIndex_(index); if (idx) { return idx.inorderTraversal(function (wrappedNode) { return action(wrappedNode.name, wrappedNode.node); }); } else { return this.children_.inorderTraversal(action); } }; /** * @param {!Index} indexDefinition * @return {SortedMapIterator} */ ChildrenNode.prototype.getIterator = function (indexDefinition) { return this.getIteratorFrom(indexDefinition.minPost(), indexDefinition); }; /** * * @param {!NamedNode} startPost * @param {!Index} indexDefinition * @return {!SortedMapIterator} */ ChildrenNode.prototype.getIteratorFrom = function (startPost, indexDefinition) { var idx = this.resolveIndex_(indexDefinition); if (idx) { return idx.getIteratorFrom(startPost, function (key) { return key; }); } else { var iterator = this.children_.getIteratorFrom(startPost.name, NamedNode.Wrap); var next = iterator.peek(); while (next != null && indexDefinition.compare(next, startPost) < 0) { iterator.getNext(); next = iterator.peek(); } return iterator; } }; /** * @param {!Index} indexDefinition * @return {!SortedMapIterator} */ ChildrenNode.prototype.getReverseIterator = function (indexDefinition) { return this.getReverseIteratorFrom(indexDefinition.maxPost(), indexDefinition); }; /** * @param {!NamedNode} endPost * @param {!Index} indexDefinition * @return {!SortedMapIterator} */ ChildrenNode.prototype.getReverseIteratorFrom = function (endPost, indexDefinition) { var idx = this.resolveIndex_(indexDefinition); if (idx) { return idx.getReverseIteratorFrom(endPost, function (key) { return key; }); } else { var iterator = this.children_.getReverseIteratorFrom(endPost.name, NamedNode.Wrap); var next = iterator.peek(); while (next != null && indexDefinition.compare(next, endPost) > 0) { iterator.getNext(); next = iterator.peek(); } return iterator; } }; /** * @inheritDoc */ ChildrenNode.prototype.compareTo = function (other) { if (this.isEmpty()) { if (other.isEmpty()) { return 0; } else { return -1; } } else if (other.isLeafNode() || other.isEmpty()) { return 1; } else if (other === MAX_NODE$2) { return -1; } else { // Must be another node with children. return 0; } }; /** * @inheritDoc */ ChildrenNode.prototype.withIndex = function (indexDefinition) { if (indexDefinition === KEY_INDEX || this.indexMap_.hasIndex(indexDefinition)) { return this; } else { var newIndexMap = this.indexMap_.addIndex(indexDefinition, this.children_); return new ChildrenNode(this.children_, this.priorityNode_, newIndexMap); } }; /** * @inheritDoc */ ChildrenNode.prototype.isIndexed = function (index) { return index === KEY_INDEX || this.indexMap_.hasIndex(index); }; /** * @inheritDoc */ ChildrenNode.prototype.equals = function (other) { if (other === this) { return true; } else if (other.isLeafNode()) { return false; } else { var otherChildrenNode = other; if (!this.getPriority().equals(otherChildrenNode.getPriority())) { return false; } else if (this.children_.count() === otherChildrenNode.children_.count()) { var thisIter = this.getIterator(PRIORITY_INDEX); var otherIter = otherChildrenNode.getIterator(PRIORITY_INDEX); var thisCurrent = thisIter.getNext(); var otherCurrent = otherIter.getNext(); while (thisCurrent && otherCurrent) { if (thisCurrent.name !== otherCurrent.name || !thisCurrent.node.equals(otherCurrent.node)) { return false; } thisCurrent = thisIter.getNext(); otherCurrent = otherIter.getNext(); } return thisCurrent === null && otherCurrent === null; } else { return false; } } }; /** * Returns a SortedMap ordered by index, or null if the default (by-key) ordering can be used * instead. * * @private * @param {!Index} indexDefinition * @return {?SortedMap.} */ ChildrenNode.prototype.resolveIndex_ = function (indexDefinition) { if (indexDefinition === KEY_INDEX) { return null; } else { return this.indexMap_.get(indexDefinition.toString()); } }; /** * @private * @type {RegExp} */ ChildrenNode.INTEGER_REGEXP_ = /^(0|[1-9]\d*)$/; return ChildrenNode; }()); /** * @constructor * @extends {ChildrenNode} * @private */ var MaxNode = /** @class */ (function (_super) { tslib_1.__extends(MaxNode, _super); function MaxNode() { return _super.call(this, new SortedMap(NAME_COMPARATOR), ChildrenNode.EMPTY_NODE, IndexMap.Default) || this; } MaxNode.prototype.compareTo = function (other) { if (other === this) { return 0; } else { return 1; } }; MaxNode.prototype.equals = function (other) { // Not that we every compare it, but MAX_NODE is only ever equal to itself return other === this; }; MaxNode.prototype.getPriority = function () { return this; }; MaxNode.prototype.getImmediateChild = function (childName) { return ChildrenNode.EMPTY_NODE; }; MaxNode.prototype.isEmpty = function () { return false; }; return MaxNode; }(ChildrenNode)); /** * Marker that will sort higher than any other snapshot. * @type {!MAX_NODE} * @const */ var MAX_NODE$2 = new MaxNode(); Object.defineProperties(NamedNode, { MIN: { value: new NamedNode(MIN_NAME, ChildrenNode.EMPTY_NODE) }, MAX: { value: new NamedNode(MAX_NAME, MAX_NODE$2) } }); /** * Reference Extensions */ KeyIndex.__EMPTY_NODE = ChildrenNode.EMPTY_NODE; LeafNode.__childrenNodeConstructor = ChildrenNode; setMaxNode(MAX_NODE$2); setMaxNode$1(MAX_NODE$2); /** * Copyright 2017 Google Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ var USE_HINZE = true; /** * Constructs a snapshot node representing the passed JSON and returns it. * @param {*} json JSON to create a node for. * @param {?string|?number=} priority Optional priority to use. This will be ignored if the * passed JSON contains a .priority property. * @return {!Node} */ function nodeFromJSON$1(json, priority) { if (priority === void 0) { priority = null; } if (json === null) { return ChildrenNode.EMPTY_NODE; } if (typeof json === 'object' && '.priority' in json) { priority = json['.priority']; } util.assert(priority === null || typeof priority === 'string' || typeof priority === 'number' || (typeof priority === 'object' && '.sv' in priority), 'Invalid priority type found: ' + typeof priority); if (typeof json === 'object' && '.value' in json && json['.value'] !== null) { json = json['.value']; } // Valid leaf nodes include non-objects or server-value wrapper objects if (typeof json !== 'object' || '.sv' in json) { var jsonLeaf = json; return new LeafNode(jsonLeaf, nodeFromJSON$1(priority)); } if (!(json instanceof Array) && USE_HINZE) { var children_1 = []; var childrenHavePriority_1 = false; var hinzeJsonObj_1 = json; util.forEach(hinzeJsonObj_1, function (key, child) { if (typeof key !== 'string' || key.substring(0, 1) !== '.') { // Ignore metadata nodes var childNode = nodeFromJSON$1(hinzeJsonObj_1[key]); if (!childNode.isEmpty()) { childrenHavePriority_1 = childrenHavePriority_1 || !childNode.getPriority().isEmpty(); children_1.push(new NamedNode(key, childNode)); } } }); if (children_1.length == 0) { return ChildrenNode.EMPTY_NODE; } var childSet = buildChildSet(children_1, NAME_ONLY_COMPARATOR, function (namedNode) { return namedNode.name; }, NAME_COMPARATOR); if (childrenHavePriority_1) { var sortedChildSet = buildChildSet(children_1, PRIORITY_INDEX.getCompare()); return new ChildrenNode(childSet, nodeFromJSON$1(priority), new IndexMap({ '.priority': sortedChildSet }, { '.priority': PRIORITY_INDEX })); } else { return new ChildrenNode(childSet, nodeFromJSON$1(priority), IndexMap.Default); } } else { var node_1 = ChildrenNode.EMPTY_NODE; var jsonObj_1 = json; util.forEach(jsonObj_1, function (key, childData) { if (util.contains(jsonObj_1, key)) { if (key.substring(0, 1) !== '.') { // ignore metadata nodes. var childNode = nodeFromJSON$1(childData); if (childNode.isLeafNode() || !childNode.isEmpty()) node_1 = node_1.updateImmediateChild(key, childNode); } } }); return node_1.updatePriority(nodeFromJSON$1(priority)); } } setNodeFromJSON(nodeFromJSON$1); /** * Copyright 2017 Google Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ /** * @constructor * @extends {Index} * @private */ var ValueIndex = /** @class */ (function (_super) { tslib_1.__extends(ValueIndex, _super); function ValueIndex() { return _super !== null && _super.apply(this, arguments) || this; } /** * @inheritDoc */ ValueIndex.prototype.compare = function (a, b) { var indexCmp = a.node.compareTo(b.node); if (indexCmp === 0) { return nameCompare(a.name, b.name); } else { return indexCmp; } }; /** * @inheritDoc */ ValueIndex.prototype.isDefinedOn = function (node) { return true; }; /** * @inheritDoc */ ValueIndex.prototype.indexedValueChanged = function (oldNode, newNode) { return !oldNode.equals(newNode); }; /** * @inheritDoc */ ValueIndex.prototype.minPost = function () { return NamedNode.MIN; }; /** * @inheritDoc */ ValueIndex.prototype.maxPost = function () { return NamedNode.MAX; }; /** * @param {*} indexValue * @param {string} name * @return {!NamedNode} */ ValueIndex.prototype.makePost = function (indexValue, name) { var valueNode = nodeFromJSON$1(indexValue); return new NamedNode(name, valueNode); }; /** * @return {!string} String representation for inclusion in a query spec */ ValueIndex.prototype.toString = function () { return '.value'; }; return ValueIndex; }(Index)); var VALUE_INDEX = new ValueIndex(); /** * Copyright 2017 Google Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ /** * @param {!Path} indexPath * @constructor * @extends {Index} */ var PathIndex = /** @class */ (function (_super) { tslib_1.__extends(PathIndex, _super); function PathIndex(indexPath_) { var _this = _super.call(this) || this; _this.indexPath_ = indexPath_; util.assert(!indexPath_.isEmpty() && indexPath_.getFront() !== '.priority', "Can't create PathIndex with empty path or .priority key"); return _this; } /** * @param {!Node} snap * @return {!Node} * @protected */ PathIndex.prototype.extractChild = function (snap) { return snap.getChild(this.indexPath_); }; /** * @inheritDoc */ PathIndex.prototype.isDefinedOn = function (node) { return !node.getChild(this.indexPath_).isEmpty(); }; /** * @inheritDoc */ PathIndex.prototype.compare = function (a, b) { var aChild = this.extractChild(a.node); var bChild = this.extractChild(b.node); var indexCmp = aChild.compareTo(bChild); if (indexCmp === 0) { return nameCompare(a.name, b.name); } else { return indexCmp; } }; /** * @inheritDoc */ PathIndex.prototype.makePost = function (indexValue, name) { var valueNode = nodeFromJSON$1(indexValue); var node = ChildrenNode.EMPTY_NODE.updateChild(this.indexPath_, valueNode); return new NamedNode(name, node); }; /** * @inheritDoc */ PathIndex.prototype.maxPost = function () { var node = ChildrenNode.EMPTY_NODE.updateChild(this.indexPath_, MAX_NODE$2); return new NamedNode(MAX_NAME, node); }; /** * @inheritDoc */ PathIndex.prototype.toString = function () { return this.indexPath_.slice().join('/'); }; return PathIndex; }(Index)); /** * Copyright 2017 Google Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ /** * Class representing a firebase data snapshot. It wraps a SnapshotNode and * surfaces the public methods (val, forEach, etc.) we want to expose. */ var DataSnapshot = /** @class */ (function () { /** * @param {!Node} node_ A SnapshotNode to wrap. * @param {!Reference} ref_ The ref of the location this snapshot came from. * @param {!Index} index_ The iteration order for this snapshot */ function DataSnapshot(node_, ref_, index_) { this.node_ = node_; this.ref_ = ref_; this.index_ = index_; } /** * Retrieves the snapshot contents as JSON. Returns null if the snapshot is * empty. * * @return {*} JSON representation of the DataSnapshot contents, or null if empty. */ DataSnapshot.prototype.val = function () { util.validateArgCount('DataSnapshot.val', 0, 0, arguments.length); return this.node_.val(); }; /** * Returns the snapshot contents as JSON, including priorities of node. Suitable for exporting * the entire node contents. * @return {*} JSON representation of the DataSnapshot contents, or null if empty. */ DataSnapshot.prototype.exportVal = function () { util.validateArgCount('DataSnapshot.exportVal', 0, 0, arguments.length); return this.node_.val(true); }; // Do not create public documentation. This is intended to make JSON serialization work but is otherwise unnecessary // for end-users DataSnapshot.prototype.toJSON = function () { // Optional spacer argument is unnecessary because we're depending on recursion rather than stringifying the content util.validateArgCount('DataSnapshot.toJSON', 0, 1, arguments.length); return this.exportVal(); }; /** * Returns whether the snapshot contains a non-null value. * * @return {boolean} Whether the snapshot contains a non-null value, or is empty. */ DataSnapshot.prototype.exists = function () { util.validateArgCount('DataSnapshot.exists', 0, 0, arguments.length); return !this.node_.isEmpty(); }; /** * Returns a DataSnapshot of the specified child node's contents. * * @param {!string} childPathString Path to a child. * @return {!DataSnapshot} DataSnapshot for child node. */ DataSnapshot.prototype.child = function (childPathString) { util.validateArgCount('DataSnapshot.child', 0, 1, arguments.length); // Ensure the childPath is a string (can be a number) childPathString = String(childPathString); validatePathString('DataSnapshot.child', 1, childPathString, false); var childPath = new Path(childPathString); var childRef = this.ref_.child(childPath); return new DataSnapshot(this.node_.getChild(childPath), childRef, PRIORITY_INDEX); }; /** * Returns whether the snapshot contains a child at the specified path. * * @param {!string} childPathString Path to a child. * @return {boolean} Whether the child exists. */ DataSnapshot.prototype.hasChild = function (childPathString) { util.validateArgCount('DataSnapshot.hasChild', 1, 1, arguments.length); validatePathString('DataSnapshot.hasChild', 1, childPathString, false); var childPath = new Path(childPathString); return !this.node_.getChild(childPath).isEmpty(); }; /** * Returns the priority of the object, or null if no priority was set. * * @return {string|number|null} The priority. */ DataSnapshot.prototype.getPriority = function () { util.validateArgCount('DataSnapshot.getPriority', 0, 0, arguments.length); // typecast here because we never return deferred values or internal priorities (MAX_PRIORITY) return this.node_.getPriority().val(); }; /** * Iterates through child nodes and calls the specified action for each one. * * @param {function(!DataSnapshot)} action Callback function to be called * for each child. * @return {boolean} True if forEach was canceled by action returning true for * one of the child nodes. */ DataSnapshot.prototype.forEach = function (action) { var _this = this; util.validateArgCount('DataSnapshot.forEach', 1, 1, arguments.length); util.validateCallback('DataSnapshot.forEach', 1, action, false); if (this.node_.isLeafNode()) return false; var childrenNode = this.node_; // Sanitize the return value to a boolean. ChildrenNode.forEachChild has a weird return type... return !!childrenNode.forEachChild(this.index_, function (key, node) { return action(new DataSnapshot(node, _this.ref_.child(key), PRIORITY_INDEX)); }); }; /** * Returns whether this DataSnapshot has children. * @return {boolean} True if the DataSnapshot contains 1 or more child nodes. */ DataSnapshot.prototype.hasChildren = function () { util.validateArgCount('DataSnapshot.hasChildren', 0, 0, arguments.length); if (this.node_.isLeafNode()) return false; else return !this.node_.isEmpty(); }; Object.defineProperty(DataSnapshot.prototype, "key", { get: function () { return this.ref_.getKey(); }, enumerable: true, configurable: true }); /** * Returns the number of children for this DataSnapshot. * @return {number} The number of children that this DataSnapshot contains. */ DataSnapshot.prototype.numChildren = function () { util.validateArgCount('DataSnapshot.numChildren', 0, 0, arguments.length); return this.node_.numChildren(); }; /** * @return {Reference} The Firebase reference for the location this snapshot's data came from. */ DataSnapshot.prototype.getRef = function () { util.validateArgCount('DataSnapshot.ref', 0, 0, arguments.length); return this.ref_; }; Object.defineProperty(DataSnapshot.prototype, "ref", { get: function () { return this.getRef(); }, enumerable: true, configurable: true }); return DataSnapshot; }()); /** * Copyright 2017 Google Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ /** * Encapsulates the data needed to raise an event * @implements {Event} */ var DataEvent = /** @class */ (function () { /** * @param {!string} eventType One of: value, child_added, child_changed, child_moved, child_removed * @param {!EventRegistration} eventRegistration The function to call to with the event data. User provided * @param {!DataSnapshot} snapshot The data backing the event * @param {?string=} prevName Optional, the name of the previous child for child_* events. */ function DataEvent(eventType, eventRegistration, snapshot, prevName) { this.eventType = eventType; this.eventRegistration = eventRegistration; this.snapshot = snapshot; this.prevName = prevName; } /** * @inheritDoc */ DataEvent.prototype.getPath = function () { var ref = this.snapshot.getRef(); if (this.eventType === 'value') { return ref.path; } else { return ref.getParent().path; } }; /** * @inheritDoc */ DataEvent.prototype.getEventType = function () { return this.eventType; }; /** * @inheritDoc */ DataEvent.prototype.getEventRunner = function () { return this.eventRegistration.getEventRunner(this); }; /** * @inheritDoc */ DataEvent.prototype.toString = function () { return (this.getPath().toString() + ':' + this.eventType + ':' + util.stringify(this.snapshot.exportVal())); }; return DataEvent; }()); var CancelEvent = /** @class */ (function () { /** * @param {EventRegistration} eventRegistration * @param {Error} error * @param {!Path} path */ function CancelEvent(eventRegistration, error, path) { this.eventRegistration = eventRegistration; this.error = error; this.path = path; } /** * @inheritDoc */ CancelEvent.prototype.getPath = function () { return this.path; }; /** * @inheritDoc */ CancelEvent.prototype.getEventType = function () { return 'cancel'; }; /** * @inheritDoc */ CancelEvent.prototype.getEventRunner = function () { return this.eventRegistration.getEventRunner(this); }; /** * @inheritDoc */ CancelEvent.prototype.toString = function () { return this.path.toString() + ':cancel'; }; return CancelEvent; }()); /** * Copyright 2017 Google Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ /** * Represents registration for 'value' events. */ var ValueEventRegistration = /** @class */ (function () { /** * @param {?function(!DataSnapshot)} callback_ * @param {?function(Error)} cancelCallback_ * @param {?Object} context_ */ function ValueEventRegistration(callback_, cancelCallback_, context_) { this.callback_ = callback_; this.cancelCallback_ = cancelCallback_; this.context_ = context_; } /** * @inheritDoc */ ValueEventRegistration.prototype.respondsTo = function (eventType) { return eventType === 'value'; }; /** * @inheritDoc */ ValueEventRegistration.prototype.createEvent = function (change, query) { var index = query.getQueryParams().getIndex(); return new DataEvent('value', this, new DataSnapshot(change.snapshotNode, query.getRef(), index)); }; /** * @inheritDoc */ ValueEventRegistration.prototype.getEventRunner = function (eventData) { var ctx = this.context_; if (eventData.getEventType() === 'cancel') { util.assert(this.cancelCallback_, 'Raising a cancel event on a listener with no cancel callback'); var cancelCB_1 = this.cancelCallback_; return function () { // We know that error exists, we checked above that this is a cancel event cancelCB_1.call(ctx, eventData.error); }; } else { var cb_1 = this.callback_; return function () { cb_1.call(ctx, eventData.snapshot); }; } }; /** * @inheritDoc */ ValueEventRegistration.prototype.createCancelEvent = function (error, path) { if (this.cancelCallback_) { return new CancelEvent(this, error, path); } else { return null; } }; /** * @inheritDoc */ ValueEventRegistration.prototype.matches = function (other) { if (!(other instanceof ValueEventRegistration)) { return false; } else if (!other.callback_ || !this.callback_) { // If no callback specified, we consider it to match any callback. return true; } else { return (other.callback_ === this.callback_ && other.context_ === this.context_); } }; /** * @inheritDoc */ ValueEventRegistration.prototype.hasAnyCallback = function () { return this.callback_ !== null; }; return ValueEventRegistration; }()); /** * Represents the registration of 1 or more child_xxx events. * * Currently, it is always exactly 1 child_xxx event, but the idea is we might let you * register a group of callbacks together in the future. * * @constructor * @implements {EventRegistration} */ var ChildEventRegistration = /** @class */ (function () { /** * @param {?Object.} callbacks_ * @param {?function(Error)} cancelCallback_ * @param {Object=} context_ */ function ChildEventRegistration(callbacks_, cancelCallback_, context_) { this.callbacks_ = callbacks_; this.cancelCallback_ = cancelCallback_; this.context_ = context_; } /** * @inheritDoc */ ChildEventRegistration.prototype.respondsTo = function (eventType) { var eventToCheck = eventType === 'children_added' ? 'child_added' : eventType; eventToCheck = eventToCheck === 'children_removed' ? 'child_removed' : eventToCheck; return util.contains(this.callbacks_, eventToCheck); }; /** * @inheritDoc */ ChildEventRegistration.prototype.createCancelEvent = function (error, path) { if (this.cancelCallback_) { return new CancelEvent(this, error, path); } else { return null; } }; /** * @inheritDoc */ ChildEventRegistration.prototype.createEvent = function (change, query) { util.assert(change.childName != null, 'Child events should have a childName.'); var ref = query.getRef().child(/** @type {!string} */ (change.childName)); var index = query.getQueryParams().getIndex(); return new DataEvent(change.type, this, new DataSnapshot(change.snapshotNode, ref, index), change.prevName); }; /** * @inheritDoc */ ChildEventRegistration.prototype.getEventRunner = function (eventData) { var ctx = this.context_; if (eventData.getEventType() === 'cancel') { util.assert(this.cancelCallback_, 'Raising a cancel event on a listener with no cancel callback'); var cancelCB_2 = this.cancelCallback_; return function () { // We know that error exists, we checked above that this is a cancel event cancelCB_2.call(ctx, eventData.error); }; } else { var cb_2 = this.callbacks_[eventData.eventType]; return function () { cb_2.call(ctx, eventData.snapshot, eventData.prevName); }; } }; /** * @inheritDoc */ ChildEventRegistration.prototype.matches = function (other) { if (other instanceof ChildEventRegistration) { if (!this.callbacks_ || !other.callbacks_) { return true; } else if (this.context_ === other.context_) { var otherCount = util.getCount(other.callbacks_); var thisCount = util.getCount(this.callbacks_); if (otherCount === thisCount) { // If count is 1, do an exact match on eventType, if either is defined but null, it's a match. // If event types don't match, not a match // If count is not 1, exact match across all if (otherCount === 1) { var otherKey /** @type {!string} */ = util.getAnyKey(other.callbacks_); var thisKey /** @type {!string} */ = util.getAnyKey(this.callbacks_); return (thisKey === otherKey && (!other.callbacks_[otherKey] || !this.callbacks_[thisKey] || other.callbacks_[otherKey] === this.callbacks_[thisKey])); } else { // Exact match on each key. return util.every(this.callbacks_, function (eventType, cb) { return other.callbacks_[eventType] === cb; }); } } } } return false; }; /** * @inheritDoc */ ChildEventRegistration.prototype.hasAnyCallback = function () { return this.callbacks_ !== null; }; return ChildEventRegistration; }()); /** * Copyright 2017 Google Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ var __referenceConstructor; /** * A Query represents a filter to be applied to a firebase location. This object purely represents the * query expression (and exposes our public API to build the query). The actual query logic is in ViewBase.js. * * Since every Firebase reference is a query, Firebase inherits from this object. */ var Query = /** @class */ (function () { function Query(repo, path, queryParams_, orderByCalled_) { this.repo = repo; this.path = path; this.queryParams_ = queryParams_; this.orderByCalled_ = orderByCalled_; } Object.defineProperty(Query, "__referenceConstructor", { get: function () { util.assert(__referenceConstructor, 'Reference.ts has not been loaded'); return __referenceConstructor; }, set: function (val) { __referenceConstructor = val; }, enumerable: true, configurable: true }); /** * Validates start/end values for queries. * @param {!QueryParams} params * @private */ Query.validateQueryEndpoints_ = function (params) { var startNode = null; var endNode = null; if (params.hasStart()) { startNode = params.getIndexStartValue(); } if (params.hasEnd()) { endNode = params.getIndexEndValue(); } if (params.getIndex() === KEY_INDEX) { var tooManyArgsError = 'Query: When ordering by key, you may only pass one argument to ' + 'startAt(), endAt(), or equalTo().'; var wrongArgTypeError = 'Query: When ordering by key, the argument passed to startAt(), endAt(),' + 'or equalTo() must be a string.'; if (params.hasStart()) { var startName = params.getIndexStartName(); if (startName != MIN_NAME) { throw new Error(tooManyArgsError); } else if (typeof startNode !== 'string') { throw new Error(wrongArgTypeError); } } if (params.hasEnd()) { var endName = params.getIndexEndName(); if (endName != MAX_NAME) { throw new Error(tooManyArgsError); } else if (typeof endNode !== 'string') { throw new Error(wrongArgTypeError); } } } else if (params.getIndex() === PRIORITY_INDEX) { if ((startNode != null && !isValidPriority(startNode)) || (endNode != null && !isValidPriority(endNode))) { throw new Error('Query: When ordering by priority, the first argument passed to startAt(), ' + 'endAt(), or equalTo() must be a valid priority value (null, a number, or a string).'); } } else { util.assert(params.getIndex() instanceof PathIndex || params.getIndex() === VALUE_INDEX, 'unknown index type.'); if ((startNode != null && typeof startNode === 'object') || (endNode != null && typeof endNode === 'object')) { throw new Error('Query: First argument passed to startAt(), endAt(), or equalTo() cannot be ' + 'an object.'); } } }; /** * Validates that limit* has been called with the correct combination of parameters * @param {!QueryParams} params * @private */ Query.validateLimit_ = function (params) { if (params.hasStart() && params.hasEnd() && params.hasLimit() && !params.hasAnchoredLimit()) { throw new Error("Query: Can't combine startAt(), endAt(), and limit(). Use limitToFirst() or limitToLast() instead."); } }; /** * Validates that no other order by call has been made * @param {!string} fnName * @private */ Query.prototype.validateNoPreviousOrderByCall_ = function (fnName) { if (this.orderByCalled_ === true) { throw new Error(fnName + ": You can't combine multiple orderBy calls."); } }; /** * @return {!QueryParams} */ Query.prototype.getQueryParams = function () { return this.queryParams_; }; /** * @return {!Reference} */ Query.prototype.getRef = function () { util.validateArgCount('Query.ref', 0, 0, arguments.length); // This is a slight hack. We cannot goog.require('fb.api.Firebase'), since Firebase requires fb.api.Query. // However, we will always export 'Firebase' to the global namespace, so it's guaranteed to exist by the time this // method gets called. return new Query.__referenceConstructor(this.repo, this.path); }; /** * @param {!string} eventType * @param {!function(DataSnapshot, string=)} callback * @param {(function(Error)|Object)=} cancelCallbackOrContext * @param {Object=} context * @return {!function(DataSnapshot, string=)} */ Query.prototype.on = function (eventType, callback, cancelCallbackOrContext, context) { util.validateArgCount('Query.on', 2, 4, arguments.length); validateEventType('Query.on', 1, eventType, false); util.validateCallback('Query.on', 2, callback, false); var ret = Query.getCancelAndContextArgs_('Query.on', cancelCallbackOrContext, context); if (eventType === 'value') { this.onValueEvent(callback, ret.cancel, ret.context); } else { var callbacks = {}; callbacks[eventType] = callback; this.onChildEvent(callbacks, ret.cancel, ret.context); } return callback; }; /** * @param {!function(!DataSnapshot)} callback * @param {?function(Error)} cancelCallback * @param {?Object} context * @protected */ Query.prototype.onValueEvent = function (callback, cancelCallback, context) { var container = new ValueEventRegistration(callback, cancelCallback || null, context || null); this.repo.addEventCallbackForQuery(this, container); }; /** * @param {!Object.} callbacks * @param {?function(Error)} cancelCallback * @param {?Object} context * @protected */ Query.prototype.onChildEvent = function (callbacks, cancelCallback, context) { var container = new ChildEventRegistration(callbacks, cancelCallback, context); this.repo.addEventCallbackForQuery(this, container); }; /** * @param {string=} eventType * @param {(function(!DataSnapshot, ?string=))=} callback * @param {Object=} context */ Query.prototype.off = function (eventType, callback, context) { util.validateArgCount('Query.off', 0, 3, arguments.length); validateEventType('Query.off', 1, eventType, true); util.validateCallback('Query.off', 2, callback, true); util.validateContextObject('Query.off', 3, context, true); var container = null; var callbacks = null; if (eventType === 'value') { var valueCallback = callback || null; container = new ValueEventRegistration(valueCallback, null, context || null); } else if (eventType) { if (callback) { callbacks = {}; callbacks[eventType] = callback; } container = new ChildEventRegistration(callbacks, null, context || null); } this.repo.removeEventCallbackForQuery(this, container); }; /** * Attaches a listener, waits for the first event, and then removes the listener * @param {!string} eventType * @param {!function(!DataSnapshot, string=)} userCallback * @param cancelOrContext * @param context * @return {!firebase.Promise} */ Query.prototype.once = function (eventType, userCallback, cancelOrContext, context) { var _this = this; util.validateArgCount('Query.once', 1, 4, arguments.length); validateEventType('Query.once', 1, eventType, false); util.validateCallback('Query.once', 2, userCallback, true); var ret = Query.getCancelAndContextArgs_('Query.once', cancelOrContext, context); // TODO: Implement this more efficiently (in particular, use 'get' wire protocol for 'value' event) // TODO: consider actually wiring the callbacks into the promise. We cannot do this without a breaking change // because the API currently expects callbacks will be called synchronously if the data is cached, but this is // against the Promise specification. var firstCall = true; var deferred = new util.Deferred(); // A dummy error handler in case a user wasn't expecting promises deferred.promise.catch(function () { }); var onceCallback = function (snapshot) { // NOTE: Even though we unsubscribe, we may get called multiple times if a single action (e.g. set() with JSON) // triggers multiple events (e.g. child_added or child_changed). if (firstCall) { firstCall = false; _this.off(eventType, onceCallback); if (userCallback) { userCallback.bind(ret.context)(snapshot); } deferred.resolve(snapshot); } }; this.on(eventType, onceCallback, /*cancel=*/ function (err) { _this.off(eventType, onceCallback); if (ret.cancel) ret.cancel.bind(ret.context)(err); deferred.reject(err); }); return deferred.promise; }; /** * Set a limit and anchor it to the start of the window. * @param {!number} limit * @return {!Query} */ Query.prototype.limitToFirst = function (limit) { util.validateArgCount('Query.limitToFirst', 1, 1, arguments.length); if (typeof limit !== 'number' || Math.floor(limit) !== limit || limit <= 0) { throw new Error('Query.limitToFirst: First argument must be a positive integer.'); } if (this.queryParams_.hasLimit()) { throw new Error('Query.limitToFirst: Limit was already set (by another call to limit, ' + 'limitToFirst, or limitToLast).'); } return new Query(this.repo, this.path, this.queryParams_.limitToFirst(limit), this.orderByCalled_); }; /** * Set a limit and anchor it to the end of the window. * @param {!number} limit * @return {!Query} */ Query.prototype.limitToLast = function (limit) { util.validateArgCount('Query.limitToLast', 1, 1, arguments.length); if (typeof limit !== 'number' || Math.floor(limit) !== limit || limit <= 0) { throw new Error('Query.limitToLast: First argument must be a positive integer.'); } if (this.queryParams_.hasLimit()) { throw new Error('Query.limitToLast: Limit was already set (by another call to limit, ' + 'limitToFirst, or limitToLast).'); } return new Query(this.repo, this.path, this.queryParams_.limitToLast(limit), this.orderByCalled_); }; /** * Given a child path, return a new query ordered by the specified grandchild path. * @param {!string} path * @return {!Query} */ Query.prototype.orderByChild = function (path) { util.validateArgCount('Query.orderByChild', 1, 1, arguments.length); if (path === '$key') { throw new Error('Query.orderByChild: "$key" is invalid. Use Query.orderByKey() instead.'); } else if (path === '$priority') { throw new Error('Query.orderByChild: "$priority" is invalid. Use Query.orderByPriority() instead.'); } else if (path === '$value') { throw new Error('Query.orderByChild: "$value" is invalid. Use Query.orderByValue() instead.'); } validatePathString('Query.orderByChild', 1, path, false); this.validateNoPreviousOrderByCall_('Query.orderByChild'); var parsedPath = new Path(path); if (parsedPath.isEmpty()) { throw new Error('Query.orderByChild: cannot pass in empty path. Use Query.orderByValue() instead.'); } var index = new PathIndex(parsedPath); var newParams = this.queryParams_.orderBy(index); Query.validateQueryEndpoints_(newParams); return new Query(this.repo, this.path, newParams, /*orderByCalled=*/ true); }; /** * Return a new query ordered by the KeyIndex * @return {!Query} */ Query.prototype.orderByKey = function () { util.validateArgCount('Query.orderByKey', 0, 0, arguments.length); this.validateNoPreviousOrderByCall_('Query.orderByKey'); var newParams = this.queryParams_.orderBy(KEY_INDEX); Query.validateQueryEndpoints_(newParams); return new Query(this.repo, this.path, newParams, /*orderByCalled=*/ true); }; /** * Return a new query ordered by the PriorityIndex * @return {!Query} */ Query.prototype.orderByPriority = function () { util.validateArgCount('Query.orderByPriority', 0, 0, arguments.length); this.validateNoPreviousOrderByCall_('Query.orderByPriority'); var newParams = this.queryParams_.orderBy(PRIORITY_INDEX); Query.validateQueryEndpoints_(newParams); return new Query(this.repo, this.path, newParams, /*orderByCalled=*/ true); }; /** * Return a new query ordered by the ValueIndex * @return {!Query} */ Query.prototype.orderByValue = function () { util.validateArgCount('Query.orderByValue', 0, 0, arguments.length); this.validateNoPreviousOrderByCall_('Query.orderByValue'); var newParams = this.queryParams_.orderBy(VALUE_INDEX); Query.validateQueryEndpoints_(newParams); return new Query(this.repo, this.path, newParams, /*orderByCalled=*/ true); }; /** * @param {number|string|boolean|null} value * @param {?string=} name * @return {!Query} */ Query.prototype.startAt = function (value, name) { if (value === void 0) { value = null; } util.validateArgCount('Query.startAt', 0, 2, arguments.length); validateFirebaseDataArg('Query.startAt', 1, value, this.path, true); validateKey('Query.startAt', 2, name, true); var newParams = this.queryParams_.startAt(value, name); Query.validateLimit_(newParams); Query.validateQueryEndpoints_(newParams); if (this.queryParams_.hasStart()) { throw new Error('Query.startAt: Starting point was already set (by another call to startAt ' + 'or equalTo).'); } // Calling with no params tells us to start at the beginning. if (value === undefined) { value = null; name = null; } return new Query(this.repo, this.path, newParams, this.orderByCalled_); }; /** * @param {number|string|boolean|null} value * @param {?string=} name * @return {!Query} */ Query.prototype.endAt = function (value, name) { if (value === void 0) { value = null; } util.validateArgCount('Query.endAt', 0, 2, arguments.length); validateFirebaseDataArg('Query.endAt', 1, value, this.path, true); validateKey('Query.endAt', 2, name, true); var newParams = this.queryParams_.endAt(value, name); Query.validateLimit_(newParams); Query.validateQueryEndpoints_(newParams); if (this.queryParams_.hasEnd()) { throw new Error('Query.endAt: Ending point was already set (by another call to endAt or ' + 'equalTo).'); } return new Query(this.repo, this.path, newParams, this.orderByCalled_); }; /** * Load the selection of children with exactly the specified value, and, optionally, * the specified name. * @param {number|string|boolean|null} value * @param {string=} name * @return {!Query} */ Query.prototype.equalTo = function (value, name) { util.validateArgCount('Query.equalTo', 1, 2, arguments.length); validateFirebaseDataArg('Query.equalTo', 1, value, this.path, false); validateKey('Query.equalTo', 2, name, true); if (this.queryParams_.hasStart()) { throw new Error('Query.equalTo: Starting point was already set (by another call to startAt or ' + 'equalTo).'); } if (this.queryParams_.hasEnd()) { throw new Error('Query.equalTo: Ending point was already set (by another call to endAt or ' + 'equalTo).'); } return this.startAt(value, name).endAt(value, name); }; /** * @return {!string} URL for this location. */ Query.prototype.toString = function () { util.validateArgCount('Query.toString', 0, 0, arguments.length); return this.repo.toString() + this.path.toUrlEncodedString(); }; // Do not create public documentation. This is intended to make JSON serialization work but is otherwise unnecessary // for end-users. Query.prototype.toJSON = function () { // An optional spacer argument is unnecessary for a string. util.validateArgCount('Query.toJSON', 0, 1, arguments.length); return this.toString(); }; /** * An object representation of the query parameters used by this Query. * @return {!Object} */ Query.prototype.queryObject = function () { return this.queryParams_.getQueryObject(); }; /** * @return {!string} */ Query.prototype.queryIdentifier = function () { var obj = this.queryObject(); var id = ObjectToUniqueKey(obj); return id === '{}' ? 'default' : id; }; /** * Return true if this query and the provided query are equivalent; otherwise, return false. * @param {Query} other * @return {boolean} */ Query.prototype.isEqual = function (other) { util.validateArgCount('Query.isEqual', 1, 1, arguments.length); if (!(other instanceof Query)) { var error$$1 = 'Query.isEqual failed: First argument must be an instance of firebase.database.Query.'; throw new Error(error$$1); } var sameRepo = this.repo === other.repo; var samePath = this.path.equals(other.path); var sameQueryIdentifier = this.queryIdentifier() === other.queryIdentifier(); return sameRepo && samePath && sameQueryIdentifier; }; /** * Helper used by .on and .once to extract the context and or cancel arguments. * @param {!string} fnName The function name (on or once) * @param {(function(Error)|Object)=} cancelOrContext * @param {Object=} context * @return {{cancel: ?function(Error), context: ?Object}} * @private */ Query.getCancelAndContextArgs_ = function (fnName, cancelOrContext, context) { var ret = { cancel: null, context: null }; if (cancelOrContext && context) { ret.cancel = cancelOrContext; util.validateCallback(fnName, 3, ret.cancel, true); ret.context = context; util.validateContextObject(fnName, 4, ret.context, true); } else if (cancelOrContext) { // we have either a cancel callback or a context. if (typeof cancelOrContext === 'object' && cancelOrContext !== null) { // it's a context! ret.context = cancelOrContext; } else if (typeof cancelOrContext === 'function') { ret.cancel = cancelOrContext; } else { throw new Error(util.errorPrefix(fnName, 3, true) + ' must either be a cancel callback or a context object.'); } } return ret; }; Object.defineProperty(Query.prototype, "ref", { get: function () { return this.getRef(); }, enumerable: true, configurable: true }); return Query; }()); /** * Copyright 2017 Google Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ /** * Implements a set with a count of elements. * * @template K, V */ var CountedSet = /** @class */ (function () { function CountedSet() { this.set = {}; } /** * @param {!K} item * @param {V} val */ CountedSet.prototype.add = function (item, val) { this.set[item] = val !== null ? val : true; }; /** * @param {!K} key * @return {boolean} */ CountedSet.prototype.contains = function (key) { return util.contains(this.set, key); }; /** * @param {!K} item * @return {V} */ CountedSet.prototype.get = function (item) { return this.contains(item) ? this.set[item] : undefined; }; /** * @param {!K} item */ CountedSet.prototype.remove = function (item) { delete this.set[item]; }; /** * Deletes everything in the set */ CountedSet.prototype.clear = function () { this.set = {}; }; /** * True if there's nothing in the set * @return {boolean} */ CountedSet.prototype.isEmpty = function () { return util.isEmpty(this.set); }; /** * @return {number} The number of items in the set */ CountedSet.prototype.count = function () { return util.getCount(this.set); }; /** * Run a function on each k,v pair in the set * @param {function(K, V)} fn */ CountedSet.prototype.each = function (fn) { util.forEach(this.set, function (k, v) { return fn(k, v); }); }; /** * Mostly for debugging * @return {Array.} The keys present in this CountedSet */ CountedSet.prototype.keys = function () { var keys = []; util.forEach(this.set, function (k) { keys.push(k); }); return keys; }; return CountedSet; }()); /** * Copyright 2017 Google Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ /** * Helper class to store a sparse set of snapshots. * * @constructor */ var SparseSnapshotTree = /** @class */ (function () { function SparseSnapshotTree() { /** * @private * @type {Node} */ this.value_ = null; /** * @private * @type {CountedSet} */ this.children_ = null; } /** * Gets the node stored at the given path if one exists. * * @param {!Path} path Path to look up snapshot for. * @return {?Node} The retrieved node, or null. */ SparseSnapshotTree.prototype.find = function (path) { if (this.value_ != null) { return this.value_.getChild(path); } else if (!path.isEmpty() && this.children_ != null) { var childKey = path.getFront(); path = path.popFront(); if (this.children_.contains(childKey)) { var childTree = this.children_.get(childKey); return childTree.find(path); } else { return null; } } else { return null; } }; /** * Stores the given node at the specified path. If there is already a node * at a shallower path, it merges the new data into that snapshot node. * * @param {!Path} path Path to look up snapshot for. * @param {!Node} data The new data, or null. */ SparseSnapshotTree.prototype.remember = function (path, data) { if (path.isEmpty()) { this.value_ = data; this.children_ = null; } else if (this.value_ !== null) { this.value_ = this.value_.updateChild(path, data); } else { if (this.children_ == null) { this.children_ = new CountedSet(); } var childKey = path.getFront(); if (!this.children_.contains(childKey)) { this.children_.add(childKey, new SparseSnapshotTree()); } var child = this.children_.get(childKey); path = path.popFront(); child.remember(path, data); } }; /** * Purge the data at path from the cache. * * @param {!Path} path Path to look up snapshot for. * @return {boolean} True if this node should now be removed. */ SparseSnapshotTree.prototype.forget = function (path) { if (path.isEmpty()) { this.value_ = null; this.children_ = null; return true; } else { if (this.value_ !== null) { if (this.value_.isLeafNode()) { // We're trying to forget a node that doesn't exist return false; } else { var value = this.value_; this.value_ = null; var self_1 = this; value.forEachChild(PRIORITY_INDEX, function (key, tree) { self_1.remember(new Path(key), tree); }); return this.forget(path); } } else if (this.children_ !== null) { var childKey = path.getFront(); path = path.popFront(); if (this.children_.contains(childKey)) { var safeToRemove = this.children_.get(childKey).forget(path); if (safeToRemove) { this.children_.remove(childKey); } } if (this.children_.isEmpty()) { this.children_ = null; return true; } else { return false; } } else { return true; } } }; /** * Recursively iterates through all of the stored tree and calls the * callback on each one. * * @param {!Path} prefixPath Path to look up node for. * @param {!Function} func The function to invoke for each tree. */ SparseSnapshotTree.prototype.forEachTree = function (prefixPath, func) { if (this.value_ !== null) { func(prefixPath, this.value_); } else { this.forEachChild(function (key, tree) { var path = new Path(prefixPath.toString() + '/' + key); tree.forEachTree(path, func); }); } }; /** * Iterates through each immediate child and triggers the callback. * * @param {!Function} func The function to invoke for each child. */ SparseSnapshotTree.prototype.forEachChild = function (func) { if (this.children_ !== null) { this.children_.each(function (key, tree) { func(key, tree); }); } }; return SparseSnapshotTree; }()); /** * Copyright 2017 Google Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ /** * Generate placeholders for deferred values. * @param {?Object} values * @return {!Object} */ var generateWithValues = function (values) { values = values || {}; values['timestamp'] = values['timestamp'] || new Date().getTime(); return values; }; /** * Value to use when firing local events. When writing server values, fire * local events with an approximate value, otherwise return value as-is. * @param {(Object|string|number|boolean)} value * @param {!Object} serverValues * @return {!(string|number|boolean)} */ var resolveDeferredValue = function (value, serverValues) { if (!value || typeof value !== 'object') { return value; } else { util.assert('.sv' in value, 'Unexpected leaf node or priority contents'); return serverValues[value['.sv']]; } }; /** * Recursively replace all deferred values and priorities in the tree with the * specified generated replacement values. * @param {!SparseSnapshotTree} tree * @param {!Object} serverValues * @return {!SparseSnapshotTree} */ var resolveDeferredValueTree = function (tree, serverValues) { var resolvedTree = new SparseSnapshotTree(); tree.forEachTree(new Path(''), function (path, node) { resolvedTree.remember(path, resolveDeferredValueSnapshot(node, serverValues)); }); return resolvedTree; }; /** * Recursively replace all deferred values and priorities in the node with the * specified generated replacement values. If there are no server values in the node, * it'll be returned as-is. * @param {!Node} node * @param {!Object} serverValues * @return {!Node} */ var resolveDeferredValueSnapshot = function (node, serverValues) { var rawPri = node.getPriority().val(); var priority = resolveDeferredValue(rawPri, serverValues); var newNode; if (node.isLeafNode()) { var leafNode = node; var value = resolveDeferredValue(leafNode.getValue(), serverValues); if (value !== leafNode.getValue() || priority !== leafNode.getPriority().val()) { return new LeafNode(value, nodeFromJSON$1(priority)); } else { return node; } } else { var childrenNode = node; newNode = childrenNode; if (priority !== childrenNode.getPriority().val()) { newNode = newNode.updatePriority(new LeafNode(priority)); } childrenNode.forEachChild(PRIORITY_INDEX, function (childName, childNode) { var newChildNode = resolveDeferredValueSnapshot(childNode, serverValues); if (newChildNode !== childNode) { newNode = newNode.updateImmediateChild(childName, newChildNode); } }); return newNode; } }; /** * Copyright 2017 Google Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ /** * * @enum */ var OperationType; (function (OperationType) { OperationType[OperationType["OVERWRITE"] = 0] = "OVERWRITE"; OperationType[OperationType["MERGE"] = 1] = "MERGE"; OperationType[OperationType["ACK_USER_WRITE"] = 2] = "ACK_USER_WRITE"; OperationType[OperationType["LISTEN_COMPLETE"] = 3] = "LISTEN_COMPLETE"; })(OperationType || (OperationType = {})); /** * @param {boolean} fromUser * @param {boolean} fromServer * @param {?string} queryId * @param {boolean} tagged * @constructor */ var OperationSource = /** @class */ (function () { function OperationSource(fromUser, fromServer, queryId, tagged) { this.fromUser = fromUser; this.fromServer = fromServer; this.queryId = queryId; this.tagged = tagged; util.assert(!tagged || fromServer, 'Tagged queries must be from server.'); } /** * @const * @type {!OperationSource} */ OperationSource.User = new OperationSource( /*fromUser=*/ true, false, null, /*tagged=*/ false); /** * @const * @type {!OperationSource} */ OperationSource.Server = new OperationSource(false, /*fromServer=*/ true, null, /*tagged=*/ false); /** * @param {string} queryId * @return {!OperationSource} */ OperationSource.forServerTaggedQuery = function (queryId) { return new OperationSource(false, /*fromServer=*/ true, queryId, /*tagged=*/ true); }; return OperationSource; }()); /** * Copyright 2017 Google Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ var AckUserWrite = /** @class */ (function () { /** * * @param {!Path} path * @param {!ImmutableTree} affectedTree A tree containing true for each affected path. Affected paths can't overlap. * @param {!boolean} revert */ function AckUserWrite( /**@inheritDoc */ path, /**@inheritDoc */ affectedTree, /**@inheritDoc */ revert) { this.path = path; this.affectedTree = affectedTree; this.revert = revert; /** @inheritDoc */ this.type = OperationType.ACK_USER_WRITE; /** @inheritDoc */ this.source = OperationSource.User; } /** * @inheritDoc */ AckUserWrite.prototype.operationForChild = function (childName) { if (!this.path.isEmpty()) { util.assert(this.path.getFront() === childName, 'operationForChild called for unrelated child.'); return new AckUserWrite(this.path.popFront(), this.affectedTree, this.revert); } else if (this.affectedTree.value != null) { util.assert(this.affectedTree.children.isEmpty(), 'affectedTree should not have overlapping affected paths.'); // All child locations are affected as well; just return same operation. return this; } else { var childTree = this.affectedTree.subtree(new Path(childName)); return new AckUserWrite(Path.Empty, childTree, this.revert); } }; return AckUserWrite; }()); /** * Copyright 2017 Google Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ var emptyChildrenSingleton; /** * Singleton empty children collection. * * @const * @type {!SortedMap.>} */ var EmptyChildren = function () { if (!emptyChildrenSingleton) { emptyChildrenSingleton = new SortedMap(stringCompare); } return emptyChildrenSingleton; }; /** * A tree with immutable elements. */ var ImmutableTree = /** @class */ (function () { /** * @template T * @param {?T} value * @param {SortedMap.>=} children */ function ImmutableTree(value, children) { if (children === void 0) { children = EmptyChildren(); } this.value = value; this.children = children; } /** * @template T * @param {!Object.} obj * @return {!ImmutableTree.} */ ImmutableTree.fromObject = function (obj) { var tree = ImmutableTree.Empty; util.forEach(obj, function (childPath, childSnap) { tree = tree.set(new Path(childPath), childSnap); }); return tree; }; /** * True if the value is empty and there are no children * @return {boolean} */ ImmutableTree.prototype.isEmpty = function () { return this.value === null && this.children.isEmpty(); }; /** * Given a path and predicate, return the first node and the path to that node * where the predicate returns true. * * TODO Do a perf test -- If we're creating a bunch of {path: value:} objects * on the way back out, it may be better to pass down a pathSoFar obj. * * @param {!Path} relativePath The remainder of the path * @param {function(T):boolean} predicate The predicate to satisfy to return a * node * @return {?{path:!Path, value:!T}} */ ImmutableTree.prototype.findRootMostMatchingPathAndValue = function (relativePath, predicate) { if (this.value != null && predicate(this.value)) { return { path: Path.Empty, value: this.value }; } else { if (relativePath.isEmpty()) { return null; } else { var front = relativePath.getFront(); var child = this.children.get(front); if (child !== null) { var childExistingPathAndValue = child.findRootMostMatchingPathAndValue(relativePath.popFront(), predicate); if (childExistingPathAndValue != null) { var fullPath = new Path(front).child(childExistingPathAndValue.path); return { path: fullPath, value: childExistingPathAndValue.value }; } else { return null; } } else { return null; } } } }; /** * Find, if it exists, the shortest subpath of the given path that points a defined * value in the tree * @param {!Path} relativePath * @return {?{path: !Path, value: !T}} */ ImmutableTree.prototype.findRootMostValueAndPath = function (relativePath) { return this.findRootMostMatchingPathAndValue(relativePath, function () { return true; }); }; /** * @param {!Path} relativePath * @return {!ImmutableTree.} The subtree at the given path */ ImmutableTree.prototype.subtree = function (relativePath) { if (relativePath.isEmpty()) { return this; } else { var front = relativePath.getFront(); var childTree = this.children.get(front); if (childTree !== null) { return childTree.subtree(relativePath.popFront()); } else { return ImmutableTree.Empty; } } }; /** * Sets a value at the specified path. * * @param {!Path} relativePath Path to set value at. * @param {?T} toSet Value to set. * @return {!ImmutableTree.} Resulting tree. */ ImmutableTree.prototype.set = function (relativePath, toSet) { if (relativePath.isEmpty()) { return new ImmutableTree(toSet, this.children); } else { var front = relativePath.getFront(); var child = this.children.get(front) || ImmutableTree.Empty; var newChild = child.set(relativePath.popFront(), toSet); var newChildren = this.children.insert(front, newChild); return new ImmutableTree(this.value, newChildren); } }; /** * Removes the value at the specified path. * * @param {!Path} relativePath Path to value to remove. * @return {!ImmutableTree.} Resulting tree. */ ImmutableTree.prototype.remove = function (relativePath) { if (relativePath.isEmpty()) { if (this.children.isEmpty()) { return ImmutableTree.Empty; } else { return new ImmutableTree(null, this.children); } } else { var front = relativePath.getFront(); var child = this.children.get(front); if (child) { var newChild = child.remove(relativePath.popFront()); var newChildren = void 0; if (newChild.isEmpty()) { newChildren = this.children.remove(front); } else { newChildren = this.children.insert(front, newChild); } if (this.value === null && newChildren.isEmpty()) { return ImmutableTree.Empty; } else { return new ImmutableTree(this.value, newChildren); } } else { return this; } } }; /** * Gets a value from the tree. * * @param {!Path} relativePath Path to get value for. * @return {?T} Value at path, or null. */ ImmutableTree.prototype.get = function (relativePath) { if (relativePath.isEmpty()) { return this.value; } else { var front = relativePath.getFront(); var child = this.children.get(front); if (child) { return child.get(relativePath.popFront()); } else { return null; } } }; /** * Replace the subtree at the specified path with the given new tree. * * @param {!Path} relativePath Path to replace subtree for. * @param {!ImmutableTree} newTree New tree. * @return {!ImmutableTree} Resulting tree. */ ImmutableTree.prototype.setTree = function (relativePath, newTree) { if (relativePath.isEmpty()) { return newTree; } else { var front = relativePath.getFront(); var child = this.children.get(front) || ImmutableTree.Empty; var newChild = child.setTree(relativePath.popFront(), newTree); var newChildren = void 0; if (newChild.isEmpty()) { newChildren = this.children.remove(front); } else { newChildren = this.children.insert(front, newChild); } return new ImmutableTree(this.value, newChildren); } }; /** * Performs a depth first fold on this tree. Transforms a tree into a single * value, given a function that operates on the path to a node, an optional * current value, and a map of child names to folded subtrees * @template V * @param {function(Path, ?T, Object.):V} fn * @return {V} */ ImmutableTree.prototype.fold = function (fn) { return this.fold_(Path.Empty, fn); }; /** * Recursive helper for public-facing fold() method * @template V * @param {!Path} pathSoFar * @param {function(Path, ?T, Object.):V} fn * @return {V} * @private */ ImmutableTree.prototype.fold_ = function (pathSoFar, fn) { var accum = {}; this.children.inorderTraversal(function (childKey, childTree) { accum[childKey] = childTree.fold_(pathSoFar.child(childKey), fn); }); return fn(pathSoFar, this.value, accum); }; /** * Find the first matching value on the given path. Return the result of applying f to it. * @template V * @param {!Path} path * @param {!function(!Path, !T):?V} f * @return {?V} */ ImmutableTree.prototype.findOnPath = function (path, f) { return this.findOnPath_(path, Path.Empty, f); }; ImmutableTree.prototype.findOnPath_ = function (pathToFollow, pathSoFar, f) { var result = this.value ? f(pathSoFar, this.value) : false; if (result) { return result; } else { if (pathToFollow.isEmpty()) { return null; } else { var front = pathToFollow.getFront(); var nextChild = this.children.get(front); if (nextChild) { return nextChild.findOnPath_(pathToFollow.popFront(), pathSoFar.child(front), f); } else { return null; } } } }; /** * * @param {!Path} path * @param {!function(!Path, !T)} f * @returns {!ImmutableTree.} */ ImmutableTree.prototype.foreachOnPath = function (path, f) { return this.foreachOnPath_(path, Path.Empty, f); }; ImmutableTree.prototype.foreachOnPath_ = function (pathToFollow, currentRelativePath, f) { if (pathToFollow.isEmpty()) { return this; } else { if (this.value) { f(currentRelativePath, this.value); } var front = pathToFollow.getFront(); var nextChild = this.children.get(front); if (nextChild) { return nextChild.foreachOnPath_(pathToFollow.popFront(), currentRelativePath.child(front), f); } else { return ImmutableTree.Empty; } } }; /** * Calls the given function for each node in the tree that has a value. * * @param {function(!Path, !T)} f A function to be called with * the path from the root of the tree to a node, and the value at that node. * Called in depth-first order. */ ImmutableTree.prototype.foreach = function (f) { this.foreach_(Path.Empty, f); }; ImmutableTree.prototype.foreach_ = function (currentRelativePath, f) { this.children.inorderTraversal(function (childName, childTree) { childTree.foreach_(currentRelativePath.child(childName), f); }); if (this.value) { f(currentRelativePath, this.value); } }; /** * * @param {function(string, !T)} f */ ImmutableTree.prototype.foreachChild = function (f) { this.children.inorderTraversal(function (childName, childTree) { if (childTree.value) { f(childName, childTree.value); } }); }; ImmutableTree.Empty = new ImmutableTree(null); return ImmutableTree; }()); /** * Copyright 2017 Google Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ /** * @param {!OperationSource} source * @param {!Path} path * @constructor * @implements {Operation} */ var ListenComplete = /** @class */ (function () { function ListenComplete(source, path) { this.source = source; this.path = path; /** @inheritDoc */ this.type = OperationType.LISTEN_COMPLETE; } ListenComplete.prototype.operationForChild = function (childName) { if (this.path.isEmpty()) { return new ListenComplete(this.source, Path.Empty); } else { return new ListenComplete(this.source, this.path.popFront()); } }; return ListenComplete; }()); /** * Copyright 2017 Google Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ /** * @param {!OperationSource} source * @param {!Path} path * @param {!Node} snap * @constructor * @implements {Operation} */ var Overwrite = /** @class */ (function () { function Overwrite(source, path, snap) { this.source = source; this.path = path; this.snap = snap; /** @inheritDoc */ this.type = OperationType.OVERWRITE; } Overwrite.prototype.operationForChild = function (childName) { if (this.path.isEmpty()) { return new Overwrite(this.source, Path.Empty, this.snap.getImmediateChild(childName)); } else { return new Overwrite(this.source, this.path.popFront(), this.snap); } }; return Overwrite; }()); /** * Copyright 2017 Google Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ /** * @param {!OperationSource} source * @param {!Path} path * @param {!ImmutableTree.} children * @constructor * @implements {Operation} */ var Merge = /** @class */ (function () { function Merge( /**@inheritDoc */ source, /**@inheritDoc */ path, /**@inheritDoc */ children) { this.source = source; this.path = path; this.children = children; /** @inheritDoc */ this.type = OperationType.MERGE; } /** * @inheritDoc */ Merge.prototype.operationForChild = function (childName) { if (this.path.isEmpty()) { var childTree = this.children.subtree(new Path(childName)); if (childTree.isEmpty()) { // This child is unaffected return null; } else if (childTree.value) { // We have a snapshot for the child in question. This becomes an overwrite of the child. return new Overwrite(this.source, Path.Empty, childTree.value); } else { // This is a merge at a deeper level return new Merge(this.source, Path.Empty, childTree); } } else { util.assert(this.path.getFront() === childName, "Can't get a merge for a child not on the path of the operation"); return new Merge(this.source, this.path.popFront(), this.children); } }; /** * @inheritDoc */ Merge.prototype.toString = function () { return ('Operation(' + this.path + ': ' + this.source.toString() + ' merge: ' + this.children.toString() + ')'); }; return Merge; }()); /** * Copyright 2017 Google Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ /** * A cache node only stores complete children. Additionally it holds a flag whether the node can be considered fully * initialized in the sense that we know at one point in time this represented a valid state of the world, e.g. * initialized with data from the server, or a complete overwrite by the client. The filtered flag also tracks * whether a node potentially had children removed due to a filter. */ var CacheNode = /** @class */ (function () { /** * @param {!Node} node_ * @param {boolean} fullyInitialized_ * @param {boolean} filtered_ */ function CacheNode(node_, fullyInitialized_, filtered_) { this.node_ = node_; this.fullyInitialized_ = fullyInitialized_; this.filtered_ = filtered_; } /** * Returns whether this node was fully initialized with either server data or a complete overwrite by the client * @return {boolean} */ CacheNode.prototype.isFullyInitialized = function () { return this.fullyInitialized_; }; /** * Returns whether this node is potentially missing children due to a filter applied to the node * @return {boolean} */ CacheNode.prototype.isFiltered = function () { return this.filtered_; }; /** * @param {!Path} path * @return {boolean} */ CacheNode.prototype.isCompleteForPath = function (path) { if (path.isEmpty()) { return this.isFullyInitialized() && !this.filtered_; } var childKey = path.getFront(); return this.isCompleteForChild(childKey); }; /** * @param {!string} key * @return {boolean} */ CacheNode.prototype.isCompleteForChild = function (key) { return ((this.isFullyInitialized() && !this.filtered_) || this.node_.hasChild(key)); }; /** * @return {!Node} */ CacheNode.prototype.getNode = function () { return this.node_; }; return CacheNode; }()); /** * Copyright 2017 Google Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ /** * Stores the data we have cached for a view. * * serverSnap is the cached server data, eventSnap is the cached event data (server data plus any local writes). * * @constructor */ var ViewCache = /** @class */ (function () { /** * * @param {!CacheNode} eventCache_ * @param {!CacheNode} serverCache_ */ function ViewCache(eventCache_, serverCache_) { this.eventCache_ = eventCache_; this.serverCache_ = serverCache_; } /** * @param {!Node} eventSnap * @param {boolean} complete * @param {boolean} filtered * @return {!ViewCache} */ ViewCache.prototype.updateEventSnap = function (eventSnap, complete, filtered) { return new ViewCache(new CacheNode(eventSnap, complete, filtered), this.serverCache_); }; /** * @param {!Node} serverSnap * @param {boolean} complete * @param {boolean} filtered * @return {!ViewCache} */ ViewCache.prototype.updateServerSnap = function (serverSnap, complete, filtered) { return new ViewCache(this.eventCache_, new CacheNode(serverSnap, complete, filtered)); }; /** * @return {!CacheNode} */ ViewCache.prototype.getEventCache = function () { return this.eventCache_; }; /** * @return {?Node} */ ViewCache.prototype.getCompleteEventSnap = function () { return this.eventCache_.isFullyInitialized() ? this.eventCache_.getNode() : null; }; /** * @return {!CacheNode} */ ViewCache.prototype.getServerCache = function () { return this.serverCache_; }; /** * @return {?Node} */ ViewCache.prototype.getCompleteServerSnap = function () { return this.serverCache_.isFullyInitialized() ? this.serverCache_.getNode() : null; }; /** * @const * @type {ViewCache} */ ViewCache.Empty = new ViewCache(new CacheNode(ChildrenNode.EMPTY_NODE, /*fullyInitialized=*/ false, /*filtered=*/ false), new CacheNode(ChildrenNode.EMPTY_NODE, /*fullyInitialized=*/ false, /*filtered=*/ false)); return ViewCache; }()); /** * Copyright 2017 Google Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ /** * @constructor * @struct * @param {!string} type The event type * @param {!Node} snapshotNode The data * @param {string=} childName The name for this child, if it's a child event * @param {Node=} oldSnap Used for intermediate processing of child changed events * @param {string=} prevName The name for the previous child, if applicable */ var Change = /** @class */ (function () { function Change(type, snapshotNode, childName, oldSnap, prevName) { this.type = type; this.snapshotNode = snapshotNode; this.childName = childName; this.oldSnap = oldSnap; this.prevName = prevName; } /** * @param {!Node} snapshot * @return {!Change} */ Change.valueChange = function (snapshot) { return new Change(Change.VALUE, snapshot); }; /** * @param {string} childKey * @param {!Node} snapshot * @return {!Change} */ Change.childAddedChange = function (childKey, snapshot) { return new Change(Change.CHILD_ADDED, snapshot, childKey); }; /** * @param {string} childKey * @param {!Node} snapshot * @return {!Change} */ Change.childRemovedChange = function (childKey, snapshot) { return new Change(Change.CHILD_REMOVED, snapshot, childKey); }; /** * @param {string} childKey * @param {!Node} newSnapshot * @param {!Node} oldSnapshot * @return {!Change} */ Change.childChangedChange = function (childKey, newSnapshot, oldSnapshot) { return new Change(Change.CHILD_CHANGED, newSnapshot, childKey, oldSnapshot); }; /** * @param {string} childKey * @param {!Node} snapshot * @return {!Change} */ Change.childMovedChange = function (childKey, snapshot) { return new Change(Change.CHILD_MOVED, snapshot, childKey); }; //event types /** Event type for a child added */ Change.CHILD_ADDED = 'child_added'; /** Event type for a child removed */ Change.CHILD_REMOVED = 'child_removed'; /** Event type for a child changed */ Change.CHILD_CHANGED = 'child_changed'; /** Event type for a child moved */ Change.CHILD_MOVED = 'child_moved'; /** Event type for a value change */ Change.VALUE = 'value'; return Change; }()); /** * Copyright 2017 Google Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ /** * Doesn't really filter nodes but applies an index to the node and keeps track of any changes * * @constructor * @implements {NodeFilter} * @param {!Index} index */ var IndexedFilter = /** @class */ (function () { function IndexedFilter(index_) { this.index_ = index_; } IndexedFilter.prototype.updateChild = function (snap, key, newChild, affectedPath, source, optChangeAccumulator) { util.assert(snap.isIndexed(this.index_), 'A node must be indexed if only a child is updated'); var oldChild = snap.getImmediateChild(key); // Check if anything actually changed. if (oldChild.getChild(affectedPath).equals(newChild.getChild(affectedPath))) { // There's an edge case where a child can enter or leave the view because affectedPath was set to null. // In this case, affectedPath will appear null in both the old and new snapshots. So we need // to avoid treating these cases as "nothing changed." if (oldChild.isEmpty() == newChild.isEmpty()) { // Nothing changed. // This assert should be valid, but it's expensive (can dominate perf testing) so don't actually do it. //assert(oldChild.equals(newChild), 'Old and new snapshots should be equal.'); return snap; } } if (optChangeAccumulator != null) { if (newChild.isEmpty()) { if (snap.hasChild(key)) { optChangeAccumulator.trackChildChange(Change.childRemovedChange(key, oldChild)); } else { util.assert(snap.isLeafNode(), 'A child remove without an old child only makes sense on a leaf node'); } } else if (oldChild.isEmpty()) { optChangeAccumulator.trackChildChange(Change.childAddedChange(key, newChild)); } else { optChangeAccumulator.trackChildChange(Change.childChangedChange(key, newChild, oldChild)); } } if (snap.isLeafNode() && newChild.isEmpty()) { return snap; } else { // Make sure the node is indexed return snap.updateImmediateChild(key, newChild).withIndex(this.index_); } }; /** * @inheritDoc */ IndexedFilter.prototype.updateFullNode = function (oldSnap, newSnap, optChangeAccumulator) { if (optChangeAccumulator != null) { if (!oldSnap.isLeafNode()) { oldSnap.forEachChild(PRIORITY_INDEX, function (key, childNode) { if (!newSnap.hasChild(key)) { optChangeAccumulator.trackChildChange(Change.childRemovedChange(key, childNode)); } }); } if (!newSnap.isLeafNode()) { newSnap.forEachChild(PRIORITY_INDEX, function (key, childNode) { if (oldSnap.hasChild(key)) { var oldChild = oldSnap.getImmediateChild(key); if (!oldChild.equals(childNode)) { optChangeAccumulator.trackChildChange(Change.childChangedChange(key, childNode, oldChild)); } } else { optChangeAccumulator.trackChildChange(Change.childAddedChange(key, childNode)); } }); } } return newSnap.withIndex(this.index_); }; /** * @inheritDoc */ IndexedFilter.prototype.updatePriority = function (oldSnap, newPriority) { if (oldSnap.isEmpty()) { return ChildrenNode.EMPTY_NODE; } else { return oldSnap.updatePriority(newPriority); } }; /** * @inheritDoc */ IndexedFilter.prototype.filtersNodes = function () { return false; }; /** * @inheritDoc */ IndexedFilter.prototype.getIndexedFilter = function () { return this; }; /** * @inheritDoc */ IndexedFilter.prototype.getIndex = function () { return this.index_; }; return IndexedFilter; }()); /** * Copyright 2017 Google Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ /** * @constructor */ var ChildChangeAccumulator = /** @class */ (function () { function ChildChangeAccumulator() { this.changeMap_ = {}; } /** * @param {!Change} change */ ChildChangeAccumulator.prototype.trackChildChange = function (change) { var type = change.type; var childKey /** @type {!string} */ = change.childName; util.assert(type == Change.CHILD_ADDED || type == Change.CHILD_CHANGED || type == Change.CHILD_REMOVED, 'Only child changes supported for tracking'); util.assert(childKey !== '.priority', 'Only non-priority child changes can be tracked.'); var oldChange = util.safeGet(this.changeMap_, childKey); if (oldChange) { var oldType = oldChange.type; if (type == Change.CHILD_ADDED && oldType == Change.CHILD_REMOVED) { this.changeMap_[childKey] = Change.childChangedChange(childKey, change.snapshotNode, oldChange.snapshotNode); } else if (type == Change.CHILD_REMOVED && oldType == Change.CHILD_ADDED) { delete this.changeMap_[childKey]; } else if (type == Change.CHILD_REMOVED && oldType == Change.CHILD_CHANGED) { this.changeMap_[childKey] = Change.childRemovedChange(childKey, oldChange.oldSnap); } else if (type == Change.CHILD_CHANGED && oldType == Change.CHILD_ADDED) { this.changeMap_[childKey] = Change.childAddedChange(childKey, change.snapshotNode); } else if (type == Change.CHILD_CHANGED && oldType == Change.CHILD_CHANGED) { this.changeMap_[childKey] = Change.childChangedChange(childKey, change.snapshotNode, oldChange.oldSnap); } else { throw util.assertionError('Illegal combination of changes: ' + change + ' occurred after ' + oldChange); } } else { this.changeMap_[childKey] = change; } }; /** * @return {!Array.} */ ChildChangeAccumulator.prototype.getChanges = function () { return util.getValues(this.changeMap_); }; return ChildChangeAccumulator; }()); /** * Copyright 2017 Google Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ /** * An implementation of CompleteChildSource that never returns any additional children * * @private * @constructor * @implements CompleteChildSource */ var NoCompleteChildSource_ = /** @class */ (function () { function NoCompleteChildSource_() { } /** * @inheritDoc */ NoCompleteChildSource_.prototype.getCompleteChild = function (childKey) { return null; }; /** * @inheritDoc */ NoCompleteChildSource_.prototype.getChildAfterChild = function (index, child, reverse) { return null; }; return NoCompleteChildSource_; }()); /** * Singleton instance. * @const * @type {!CompleteChildSource} */ var NO_COMPLETE_CHILD_SOURCE = new NoCompleteChildSource_(); /** * An implementation of CompleteChildSource that uses a WriteTree in addition to any other server data or * old event caches available to calculate complete children. * * * @implements CompleteChildSource */ var WriteTreeCompleteChildSource = /** @class */ (function () { /** * @param {!WriteTreeRef} writes_ * @param {!ViewCache} viewCache_ * @param {?Node} optCompleteServerCache_ */ function WriteTreeCompleteChildSource(writes_, viewCache_, optCompleteServerCache_) { if (optCompleteServerCache_ === void 0) { optCompleteServerCache_ = null; } this.writes_ = writes_; this.viewCache_ = viewCache_; this.optCompleteServerCache_ = optCompleteServerCache_; } /** * @inheritDoc */ WriteTreeCompleteChildSource.prototype.getCompleteChild = function (childKey) { var node = this.viewCache_.getEventCache(); if (node.isCompleteForChild(childKey)) { return node.getNode().getImmediateChild(childKey); } else { var serverNode = this.optCompleteServerCache_ != null ? new CacheNode(this.optCompleteServerCache_, true, false) : this.viewCache_.getServerCache(); return this.writes_.calcCompleteChild(childKey, serverNode); } }; /** * @inheritDoc */ WriteTreeCompleteChildSource.prototype.getChildAfterChild = function (index, child, reverse) { var completeServerData = this.optCompleteServerCache_ != null ? this.optCompleteServerCache_ : this.viewCache_.getCompleteServerSnap(); var nodes = this.writes_.calcIndexedSlice(completeServerData, child, 1, reverse, index); if (nodes.length === 0) { return null; } else { return nodes[0]; } }; return WriteTreeCompleteChildSource; }()); /** * Copyright 2017 Google Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ /** * @constructor * @struct */ var ProcessorResult = /** @class */ (function () { /** * @param {!ViewCache} viewCache * @param {!Array.} changes */ function ProcessorResult(viewCache, changes) { this.viewCache = viewCache; this.changes = changes; } return ProcessorResult; }()); /** * @constructor */ var ViewProcessor = /** @class */ (function () { /** * @param {!NodeFilter} filter_ */ function ViewProcessor(filter_) { this.filter_ = filter_; } /** * @param {!ViewCache} viewCache */ ViewProcessor.prototype.assertIndexed = function (viewCache) { util.assert(viewCache .getEventCache() .getNode() .isIndexed(this.filter_.getIndex()), 'Event snap not indexed'); util.assert(viewCache .getServerCache() .getNode() .isIndexed(this.filter_.getIndex()), 'Server snap not indexed'); }; /** * @param {!ViewCache} oldViewCache * @param {!Operation} operation * @param {!WriteTreeRef} writesCache * @param {?Node} completeCache * @return {!ProcessorResult} */ ViewProcessor.prototype.applyOperation = function (oldViewCache, operation, writesCache, completeCache) { var accumulator = new ChildChangeAccumulator(); var newViewCache, filterServerNode; if (operation.type === OperationType.OVERWRITE) { var overwrite = operation; if (overwrite.source.fromUser) { newViewCache = this.applyUserOverwrite_(oldViewCache, overwrite.path, overwrite.snap, writesCache, completeCache, accumulator); } else { util.assert(overwrite.source.fromServer, 'Unknown source.'); // We filter the node if it's a tagged update or the node has been previously filtered and the // update is not at the root in which case it is ok (and necessary) to mark the node unfiltered // again filterServerNode = overwrite.source.tagged || (oldViewCache.getServerCache().isFiltered() && !overwrite.path.isEmpty()); newViewCache = this.applyServerOverwrite_(oldViewCache, overwrite.path, overwrite.snap, writesCache, completeCache, filterServerNode, accumulator); } } else if (operation.type === OperationType.MERGE) { var merge = operation; if (merge.source.fromUser) { newViewCache = this.applyUserMerge_(oldViewCache, merge.path, merge.children, writesCache, completeCache, accumulator); } else { util.assert(merge.source.fromServer, 'Unknown source.'); // We filter the node if it's a tagged update or the node has been previously filtered filterServerNode = merge.source.tagged || oldViewCache.getServerCache().isFiltered(); newViewCache = this.applyServerMerge_(oldViewCache, merge.path, merge.children, writesCache, completeCache, filterServerNode, accumulator); } } else if (operation.type === OperationType.ACK_USER_WRITE) { var ackUserWrite = operation; if (!ackUserWrite.revert) { newViewCache = this.ackUserWrite_(oldViewCache, ackUserWrite.path, ackUserWrite.affectedTree, writesCache, completeCache, accumulator); } else { newViewCache = this.revertUserWrite_(oldViewCache, ackUserWrite.path, writesCache, completeCache, accumulator); } } else if (operation.type === OperationType.LISTEN_COMPLETE) { newViewCache = this.listenComplete_(oldViewCache, operation.path, writesCache, accumulator); } else { throw util.assertionError('Unknown operation type: ' + operation.type); } var changes = accumulator.getChanges(); ViewProcessor.maybeAddValueEvent_(oldViewCache, newViewCache, changes); return new ProcessorResult(newViewCache, changes); }; /** * @param {!ViewCache} oldViewCache * @param {!ViewCache} newViewCache * @param {!Array.} accumulator * @private */ ViewProcessor.maybeAddValueEvent_ = function (oldViewCache, newViewCache, accumulator) { var eventSnap = newViewCache.getEventCache(); if (eventSnap.isFullyInitialized()) { var isLeafOrEmpty = eventSnap.getNode().isLeafNode() || eventSnap.getNode().isEmpty(); var oldCompleteSnap = oldViewCache.getCompleteEventSnap(); if (accumulator.length > 0 || !oldViewCache.getEventCache().isFullyInitialized() || (isLeafOrEmpty && !eventSnap .getNode() .equals(/** @type {!Node} */ (oldCompleteSnap))) || !eventSnap .getNode() .getPriority() .equals(oldCompleteSnap.getPriority())) { accumulator.push(Change.valueChange( /** @type {!Node} */ newViewCache.getCompleteEventSnap())); } } }; /** * @param {!ViewCache} viewCache * @param {!Path} changePath * @param {!WriteTreeRef} writesCache * @param {!CompleteChildSource} source * @param {!ChildChangeAccumulator} accumulator * @return {!ViewCache} * @private */ ViewProcessor.prototype.generateEventCacheAfterServerEvent_ = function (viewCache, changePath, writesCache, source, accumulator) { var oldEventSnap = viewCache.getEventCache(); if (writesCache.shadowingWrite(changePath) != null) { // we have a shadowing write, ignore changes return viewCache; } else { var newEventCache = void 0, serverNode = void 0; if (changePath.isEmpty()) { // TODO: figure out how this plays with "sliding ack windows" util.assert(viewCache.getServerCache().isFullyInitialized(), 'If change path is empty, we must have complete server data'); if (viewCache.getServerCache().isFiltered()) { // We need to special case this, because we need to only apply writes to complete children, or // we might end up raising events for incomplete children. If the server data is filtered deep // writes cannot be guaranteed to be complete var serverCache = viewCache.getCompleteServerSnap(); var completeChildren = serverCache instanceof ChildrenNode ? serverCache : ChildrenNode.EMPTY_NODE; var completeEventChildren = writesCache.calcCompleteEventChildren(completeChildren); newEventCache = this.filter_.updateFullNode(viewCache.getEventCache().getNode(), completeEventChildren, accumulator); } else { var completeNode = writesCache.calcCompleteEventCache(viewCache.getCompleteServerSnap()); newEventCache = this.filter_.updateFullNode(viewCache.getEventCache().getNode(), completeNode, accumulator); } } else { var childKey = changePath.getFront(); if (childKey == '.priority') { util.assert(changePath.getLength() == 1, "Can't have a priority with additional path components"); var oldEventNode = oldEventSnap.getNode(); serverNode = viewCache.getServerCache().getNode(); // we might have overwrites for this priority var updatedPriority = writesCache.calcEventCacheAfterServerOverwrite(changePath, oldEventNode, serverNode); if (updatedPriority != null) { newEventCache = this.filter_.updatePriority(oldEventNode, updatedPriority); } else { // priority didn't change, keep old node newEventCache = oldEventSnap.getNode(); } } else { var childChangePath = changePath.popFront(); // update child var newEventChild = void 0; if (oldEventSnap.isCompleteForChild(childKey)) { serverNode = viewCache.getServerCache().getNode(); var eventChildUpdate = writesCache.calcEventCacheAfterServerOverwrite(changePath, oldEventSnap.getNode(), serverNode); if (eventChildUpdate != null) { newEventChild = oldEventSnap .getNode() .getImmediateChild(childKey) .updateChild(childChangePath, eventChildUpdate); } else { // Nothing changed, just keep the old child newEventChild = oldEventSnap .getNode() .getImmediateChild(childKey); } } else { newEventChild = writesCache.calcCompleteChild(childKey, viewCache.getServerCache()); } if (newEventChild != null) { newEventCache = this.filter_.updateChild(oldEventSnap.getNode(), childKey, newEventChild, childChangePath, source, accumulator); } else { // no complete child available or no change newEventCache = oldEventSnap.getNode(); } } } return viewCache.updateEventSnap(newEventCache, oldEventSnap.isFullyInitialized() || changePath.isEmpty(), this.filter_.filtersNodes()); } }; /** * @param {!ViewCache} oldViewCache * @param {!Path} changePath * @param {!Node} changedSnap * @param {!WriteTreeRef} writesCache * @param {?Node} completeCache * @param {boolean} filterServerNode * @param {!ChildChangeAccumulator} accumulator * @return {!ViewCache} * @private */ ViewProcessor.prototype.applyServerOverwrite_ = function (oldViewCache, changePath, changedSnap, writesCache, completeCache, filterServerNode, accumulator) { var oldServerSnap = oldViewCache.getServerCache(); var newServerCache; var serverFilter = filterServerNode ? this.filter_ : this.filter_.getIndexedFilter(); if (changePath.isEmpty()) { newServerCache = serverFilter.updateFullNode(oldServerSnap.getNode(), changedSnap, null); } else if (serverFilter.filtersNodes() && !oldServerSnap.isFiltered()) { // we want to filter the server node, but we didn't filter the server node yet, so simulate a full update var newServerNode = oldServerSnap .getNode() .updateChild(changePath, changedSnap); newServerCache = serverFilter.updateFullNode(oldServerSnap.getNode(), newServerNode, null); } else { var childKey = changePath.getFront(); if (!oldServerSnap.isCompleteForPath(changePath) && changePath.getLength() > 1) { // We don't update incomplete nodes with updates intended for other listeners return oldViewCache; } var childChangePath = changePath.popFront(); var childNode = oldServerSnap.getNode().getImmediateChild(childKey); var newChildNode = childNode.updateChild(childChangePath, changedSnap); if (childKey == '.priority') { newServerCache = serverFilter.updatePriority(oldServerSnap.getNode(), newChildNode); } else { newServerCache = serverFilter.updateChild(oldServerSnap.getNode(), childKey, newChildNode, childChangePath, NO_COMPLETE_CHILD_SOURCE, null); } } var newViewCache = oldViewCache.updateServerSnap(newServerCache, oldServerSnap.isFullyInitialized() || changePath.isEmpty(), serverFilter.filtersNodes()); var source = new WriteTreeCompleteChildSource(writesCache, newViewCache, completeCache); return this.generateEventCacheAfterServerEvent_(newViewCache, changePath, writesCache, source, accumulator); }; /** * @param {!ViewCache} oldViewCache * @param {!Path} changePath * @param {!Node} changedSnap * @param {!WriteTreeRef} writesCache * @param {?Node} completeCache * @param {!ChildChangeAccumulator} accumulator * @return {!ViewCache} * @private */ ViewProcessor.prototype.applyUserOverwrite_ = function (oldViewCache, changePath, changedSnap, writesCache, completeCache, accumulator) { var oldEventSnap = oldViewCache.getEventCache(); var newViewCache, newEventCache; var source = new WriteTreeCompleteChildSource(writesCache, oldViewCache, completeCache); if (changePath.isEmpty()) { newEventCache = this.filter_.updateFullNode(oldViewCache.getEventCache().getNode(), changedSnap, accumulator); newViewCache = oldViewCache.updateEventSnap(newEventCache, true, this.filter_.filtersNodes()); } else { var childKey = changePath.getFront(); if (childKey === '.priority') { newEventCache = this.filter_.updatePriority(oldViewCache.getEventCache().getNode(), changedSnap); newViewCache = oldViewCache.updateEventSnap(newEventCache, oldEventSnap.isFullyInitialized(), oldEventSnap.isFiltered()); } else { var childChangePath = changePath.popFront(); var oldChild = oldEventSnap.getNode().getImmediateChild(childKey); var newChild = void 0; if (childChangePath.isEmpty()) { // Child overwrite, we can replace the child newChild = changedSnap; } else { var childNode = source.getCompleteChild(childKey); if (childNode != null) { if (childChangePath.getBack() === '.priority' && childNode.getChild(childChangePath.parent()).isEmpty()) { // This is a priority update on an empty node. If this node exists on the server, the // server will send down the priority in the update, so ignore for now newChild = childNode; } else { newChild = childNode.updateChild(childChangePath, changedSnap); } } else { // There is no complete child node available newChild = ChildrenNode.EMPTY_NODE; } } if (!oldChild.equals(newChild)) { var newEventSnap = this.filter_.updateChild(oldEventSnap.getNode(), childKey, newChild, childChangePath, source, accumulator); newViewCache = oldViewCache.updateEventSnap(newEventSnap, oldEventSnap.isFullyInitialized(), this.filter_.filtersNodes()); } else { newViewCache = oldViewCache; } } } return newViewCache; }; /** * @param {!ViewCache} viewCache * @param {string} childKey * @return {boolean} * @private */ ViewProcessor.cacheHasChild_ = function (viewCache, childKey) { return viewCache.getEventCache().isCompleteForChild(childKey); }; /** * @param {!ViewCache} viewCache * @param {!Path} path * @param {ImmutableTree.} changedChildren * @param {!WriteTreeRef} writesCache * @param {?Node} serverCache * @param {!ChildChangeAccumulator} accumulator * @return {!ViewCache} * @private */ ViewProcessor.prototype.applyUserMerge_ = function (viewCache, path, changedChildren, writesCache, serverCache, accumulator) { var _this = this; // HACK: In the case of a limit query, there may be some changes that bump things out of the // window leaving room for new items. It's important we process these changes first, so we // iterate the changes twice, first processing any that affect items currently in view. // TODO: I consider an item "in view" if cacheHasChild is true, which checks both the server // and event snap. I'm not sure if this will result in edge cases when a child is in one but // not the other. var curViewCache = viewCache; changedChildren.foreach(function (relativePath, childNode) { var writePath = path.child(relativePath); if (ViewProcessor.cacheHasChild_(viewCache, writePath.getFront())) { curViewCache = _this.applyUserOverwrite_(curViewCache, writePath, childNode, writesCache, serverCache, accumulator); } }); changedChildren.foreach(function (relativePath, childNode) { var writePath = path.child(relativePath); if (!ViewProcessor.cacheHasChild_(viewCache, writePath.getFront())) { curViewCache = _this.applyUserOverwrite_(curViewCache, writePath, childNode, writesCache, serverCache, accumulator); } }); return curViewCache; }; /** * @param {!Node} node * @param {ImmutableTree.} merge * @return {!Node} * @private */ ViewProcessor.prototype.applyMerge_ = function (node, merge) { merge.foreach(function (relativePath, childNode) { node = node.updateChild(relativePath, childNode); }); return node; }; /** * @param {!ViewCache} viewCache * @param {!Path} path * @param {!ImmutableTree.} changedChildren * @param {!WriteTreeRef} writesCache * @param {?Node} serverCache * @param {boolean} filterServerNode * @param {!ChildChangeAccumulator} accumulator * @return {!ViewCache} * @private */ ViewProcessor.prototype.applyServerMerge_ = function (viewCache, path, changedChildren, writesCache, serverCache, filterServerNode, accumulator) { var _this = this; // If we don't have a cache yet, this merge was intended for a previously listen in the same location. Ignore it and // wait for the complete data update coming soon. if (viewCache .getServerCache() .getNode() .isEmpty() && !viewCache.getServerCache().isFullyInitialized()) { return viewCache; } // HACK: In the case of a limit query, there may be some changes that bump things out of the // window leaving room for new items. It's important we process these changes first, so we // iterate the changes twice, first processing any that affect items currently in view. // TODO: I consider an item "in view" if cacheHasChild is true, which checks both the server // and event snap. I'm not sure if this will result in edge cases when a child is in one but // not the other. var curViewCache = viewCache; var viewMergeTree; if (path.isEmpty()) { viewMergeTree = changedChildren; } else { viewMergeTree = ImmutableTree.Empty.setTree(path, changedChildren); } var serverNode = viewCache.getServerCache().getNode(); viewMergeTree.children.inorderTraversal(function (childKey, childTree) { if (serverNode.hasChild(childKey)) { var serverChild = viewCache .getServerCache() .getNode() .getImmediateChild(childKey); var newChild = _this.applyMerge_(serverChild, childTree); curViewCache = _this.applyServerOverwrite_(curViewCache, new Path(childKey), newChild, writesCache, serverCache, filterServerNode, accumulator); } }); viewMergeTree.children.inorderTraversal(function (childKey, childMergeTree) { var isUnknownDeepMerge = !viewCache.getServerCache().isCompleteForChild(childKey) && childMergeTree.value == null; if (!serverNode.hasChild(childKey) && !isUnknownDeepMerge) { var serverChild = viewCache .getServerCache() .getNode() .getImmediateChild(childKey); var newChild = _this.applyMerge_(serverChild, childMergeTree); curViewCache = _this.applyServerOverwrite_(curViewCache, new Path(childKey), newChild, writesCache, serverCache, filterServerNode, accumulator); } }); return curViewCache; }; /** * @param {!ViewCache} viewCache * @param {!Path} ackPath * @param {!ImmutableTree} affectedTree * @param {!WriteTreeRef} writesCache * @param {?Node} completeCache * @param {!ChildChangeAccumulator} accumulator * @return {!ViewCache} * @private */ ViewProcessor.prototype.ackUserWrite_ = function (viewCache, ackPath, affectedTree, writesCache, completeCache, accumulator) { if (writesCache.shadowingWrite(ackPath) != null) { return viewCache; } // Only filter server node if it is currently filtered var filterServerNode = viewCache.getServerCache().isFiltered(); // Essentially we'll just get our existing server cache for the affected paths and re-apply it as a server update // now that it won't be shadowed. var serverCache = viewCache.getServerCache(); if (affectedTree.value != null) { // This is an overwrite. if ((ackPath.isEmpty() && serverCache.isFullyInitialized()) || serverCache.isCompleteForPath(ackPath)) { return this.applyServerOverwrite_(viewCache, ackPath, serverCache.getNode().getChild(ackPath), writesCache, completeCache, filterServerNode, accumulator); } else if (ackPath.isEmpty()) { // This is a goofy edge case where we are acking data at this location but don't have full data. We // should just re-apply whatever we have in our cache as a merge. var changedChildren_1 = ImmutableTree.Empty; serverCache.getNode().forEachChild(KEY_INDEX, function (name, node) { changedChildren_1 = changedChildren_1.set(new Path(name), node); }); return this.applyServerMerge_(viewCache, ackPath, changedChildren_1, writesCache, completeCache, filterServerNode, accumulator); } else { return viewCache; } } else { // This is a merge. var changedChildren_2 = ImmutableTree.Empty; affectedTree.foreach(function (mergePath, value) { var serverCachePath = ackPath.child(mergePath); if (serverCache.isCompleteForPath(serverCachePath)) { changedChildren_2 = changedChildren_2.set(mergePath, serverCache.getNode().getChild(serverCachePath)); } }); return this.applyServerMerge_(viewCache, ackPath, changedChildren_2, writesCache, completeCache, filterServerNode, accumulator); } }; /** * @param {!ViewCache} viewCache * @param {!Path} path * @param {!WriteTreeRef} writesCache * @param {!ChildChangeAccumulator} accumulator * @return {!ViewCache} * @private */ ViewProcessor.prototype.listenComplete_ = function (viewCache, path, writesCache, accumulator) { var oldServerNode = viewCache.getServerCache(); var newViewCache = viewCache.updateServerSnap(oldServerNode.getNode(), oldServerNode.isFullyInitialized() || path.isEmpty(), oldServerNode.isFiltered()); return this.generateEventCacheAfterServerEvent_(newViewCache, path, writesCache, NO_COMPLETE_CHILD_SOURCE, accumulator); }; /** * @param {!ViewCache} viewCache * @param {!Path} path * @param {!WriteTreeRef} writesCache * @param {?Node} completeServerCache * @param {!ChildChangeAccumulator} accumulator * @return {!ViewCache} * @private */ ViewProcessor.prototype.revertUserWrite_ = function (viewCache, path, writesCache, completeServerCache, accumulator) { var complete; if (writesCache.shadowingWrite(path) != null) { return viewCache; } else { var source = new WriteTreeCompleteChildSource(writesCache, viewCache, completeServerCache); var oldEventCache = viewCache.getEventCache().getNode(); var newEventCache = void 0; if (path.isEmpty() || path.getFront() === '.priority') { var newNode = void 0; if (viewCache.getServerCache().isFullyInitialized()) { newNode = writesCache.calcCompleteEventCache(viewCache.getCompleteServerSnap()); } else { var serverChildren = viewCache.getServerCache().getNode(); util.assert(serverChildren instanceof ChildrenNode, 'serverChildren would be complete if leaf node'); newNode = writesCache.calcCompleteEventChildren(serverChildren); } newNode = newNode; newEventCache = this.filter_.updateFullNode(oldEventCache, newNode, accumulator); } else { var childKey = path.getFront(); var newChild = writesCache.calcCompleteChild(childKey, viewCache.getServerCache()); if (newChild == null && viewCache.getServerCache().isCompleteForChild(childKey)) { newChild = oldEventCache.getImmediateChild(childKey); } if (newChild != null) { newEventCache = this.filter_.updateChild(oldEventCache, childKey, newChild, path.popFront(), source, accumulator); } else if (viewCache .getEventCache() .getNode() .hasChild(childKey)) { // No complete child available, delete the existing one, if any newEventCache = this.filter_.updateChild(oldEventCache, childKey, ChildrenNode.EMPTY_NODE, path.popFront(), source, accumulator); } else { newEventCache = oldEventCache; } if (newEventCache.isEmpty() && viewCache.getServerCache().isFullyInitialized()) { // We might have reverted all child writes. Maybe the old event was a leaf node complete = writesCache.calcCompleteEventCache(viewCache.getCompleteServerSnap()); if (complete.isLeafNode()) { newEventCache = this.filter_.updateFullNode(newEventCache, complete, accumulator); } } } complete = viewCache.getServerCache().isFullyInitialized() || writesCache.shadowingWrite(Path.Empty) != null; return viewCache.updateEventSnap(newEventCache, complete, this.filter_.filtersNodes()); } }; return ViewProcessor; }()); /** * Copyright 2017 Google Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ /** * An EventGenerator is used to convert "raw" changes (Change) as computed by the * CacheDiffer into actual events (Event) that can be raised. See generateEventsForChanges() * for details. * * @constructor */ var EventGenerator = /** @class */ (function () { /** * * @param {!Query} query_ */ function EventGenerator(query_) { this.query_ = query_; /** * @private * @type {!Index} */ this.index_ = this.query_.getQueryParams().getIndex(); } /** * Given a set of raw changes (no moved events and prevName not specified yet), and a set of * EventRegistrations that should be notified of these changes, generate the actual events to be raised. * * Notes: * - child_moved events will be synthesized at this time for any child_changed events that affect * our index. * - prevName will be calculated based on the index ordering. * * @param {!Array.} changes * @param {!Node} eventCache * @param {!Array.} eventRegistrations * @return {!Array.} */ EventGenerator.prototype.generateEventsForChanges = function (changes, eventCache, eventRegistrations) { var _this = this; var events = []; var moves = []; changes.forEach(function (change) { if (change.type === Change.CHILD_CHANGED && _this.index_.indexedValueChanged(change.oldSnap, change.snapshotNode)) { moves.push(Change.childMovedChange(change.childName, change.snapshotNode)); } }); this.generateEventsForType_(events, Change.CHILD_REMOVED, changes, eventRegistrations, eventCache); this.generateEventsForType_(events, Change.CHILD_ADDED, changes, eventRegistrations, eventCache); this.generateEventsForType_(events, Change.CHILD_MOVED, moves, eventRegistrations, eventCache); this.generateEventsForType_(events, Change.CHILD_CHANGED, changes, eventRegistrations, eventCache); this.generateEventsForType_(events, Change.VALUE, changes, eventRegistrations, eventCache); return events; }; /** * Given changes of a single change type, generate the corresponding events. * * @param {!Array.} events * @param {!string} eventType * @param {!Array.} changes * @param {!Array.} registrations * @param {!Node} eventCache * @private */ EventGenerator.prototype.generateEventsForType_ = function (events, eventType, changes, registrations, eventCache) { var _this = this; var filteredChanges = changes.filter(function (change) { return change.type === eventType; }); filteredChanges.sort(this.compareChanges_.bind(this)); filteredChanges.forEach(function (change) { var materializedChange = _this.materializeSingleChange_(change, eventCache); registrations.forEach(function (registration) { if (registration.respondsTo(change.type)) { events.push(registration.createEvent(materializedChange, _this.query_)); } }); }); }; /** * @param {!Change} change * @param {!Node} eventCache * @return {!Change} * @private */ EventGenerator.prototype.materializeSingleChange_ = function (change, eventCache) { if (change.type === 'value' || change.type === 'child_removed') { return change; } else { change.prevName = eventCache.getPredecessorChildName( /** @type {!string} */ change.childName, change.snapshotNode, this.index_); return change; } }; /** * @param {!Change} a * @param {!Change} b * @return {number} * @private */ EventGenerator.prototype.compareChanges_ = function (a, b) { if (a.childName == null || b.childName == null) { throw util.assertionError('Should only compare child_ events.'); } var aWrapped = new NamedNode(a.childName, a.snapshotNode); var bWrapped = new NamedNode(b.childName, b.snapshotNode); return this.index_.compare(aWrapped, bWrapped); }; return EventGenerator; }()); /** * Copyright 2017 Google Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ /** * A view represents a specific location and query that has 1 or more event registrations. * * It does several things: * - Maintains the list of event registrations for this location/query. * - Maintains a cache of the data visible for this location/query. * - Applies new operations (via applyOperation), updates the cache, and based on the event * registrations returns the set of events to be raised. * @constructor */ var View = /** @class */ (function () { /** * * @param {!Query} query_ * @param {!ViewCache} initialViewCache */ function View(query_, initialViewCache) { this.query_ = query_; this.eventRegistrations_ = []; var params = this.query_.getQueryParams(); var indexFilter = new IndexedFilter(params.getIndex()); var filter = params.getNodeFilter(); /** * @type {ViewProcessor} * @private */ this.processor_ = new ViewProcessor(filter); var initialServerCache = initialViewCache.getServerCache(); var initialEventCache = initialViewCache.getEventCache(); // Don't filter server node with other filter than index, wait for tagged listen var serverSnap = indexFilter.updateFullNode(ChildrenNode.EMPTY_NODE, initialServerCache.getNode(), null); var eventSnap = filter.updateFullNode(ChildrenNode.EMPTY_NODE, initialEventCache.getNode(), null); var newServerCache = new CacheNode(serverSnap, initialServerCache.isFullyInitialized(), indexFilter.filtersNodes()); var newEventCache = new CacheNode(eventSnap, initialEventCache.isFullyInitialized(), filter.filtersNodes()); /** * @type {!ViewCache} * @private */ this.viewCache_ = new ViewCache(newEventCache, newServerCache); /** * @type {!EventGenerator} * @private */ this.eventGenerator_ = new EventGenerator(this.query_); } /** * @return {!Query} */ View.prototype.getQuery = function () { return this.query_; }; /** * @return {?Node} */ View.prototype.getServerCache = function () { return this.viewCache_.getServerCache().getNode(); }; /** * @param {!Path} path * @return {?Node} */ View.prototype.getCompleteServerCache = function (path) { var cache = this.viewCache_.getCompleteServerSnap(); if (cache) { // If this isn't a "loadsAllData" view, then cache isn't actually a complete cache and // we need to see if it contains the child we're interested in. if (this.query_.getQueryParams().loadsAllData() || (!path.isEmpty() && !cache.getImmediateChild(path.getFront()).isEmpty())) { return cache.getChild(path); } } return null; }; /** * @return {boolean} */ View.prototype.isEmpty = function () { return this.eventRegistrations_.length === 0; }; /** * @param {!EventRegistration} eventRegistration */ View.prototype.addEventRegistration = function (eventRegistration) { this.eventRegistrations_.push(eventRegistration); }; /** * @param {?EventRegistration} eventRegistration If null, remove all callbacks. * @param {Error=} cancelError If a cancelError is provided, appropriate cancel events will be returned. * @return {!Array.} Cancel events, if cancelError was provided. */ View.prototype.removeEventRegistration = function (eventRegistration, cancelError) { var cancelEvents = []; if (cancelError) { util.assert(eventRegistration == null, 'A cancel should cancel all event registrations.'); var path_1 = this.query_.path; this.eventRegistrations_.forEach(function (registration) { cancelError /** @type {!Error} */ = cancelError; var maybeEvent = registration.createCancelEvent(cancelError, path_1); if (maybeEvent) { cancelEvents.push(maybeEvent); } }); } if (eventRegistration) { var remaining = []; for (var i = 0; i < this.eventRegistrations_.length; ++i) { var existing = this.eventRegistrations_[i]; if (!existing.matches(eventRegistration)) { remaining.push(existing); } else if (eventRegistration.hasAnyCallback()) { // We're removing just this one remaining = remaining.concat(this.eventRegistrations_.slice(i + 1)); break; } } this.eventRegistrations_ = remaining; } else { this.eventRegistrations_ = []; } return cancelEvents; }; /** * Applies the given Operation, updates our cache, and returns the appropriate events. * * @param {!Operation} operation * @param {!WriteTreeRef} writesCache * @param {?Node} completeServerCache * @return {!Array.} */ View.prototype.applyOperation = function (operation, writesCache, completeServerCache) { if (operation.type === OperationType.MERGE && operation.source.queryId !== null) { util.assert(this.viewCache_.getCompleteServerSnap(), 'We should always have a full cache before handling merges'); util.assert(this.viewCache_.getCompleteEventSnap(), 'Missing event cache, even though we have a server cache'); } var oldViewCache = this.viewCache_; var result = this.processor_.applyOperation(oldViewCache, operation, writesCache, completeServerCache); this.processor_.assertIndexed(result.viewCache); util.assert(result.viewCache.getServerCache().isFullyInitialized() || !oldViewCache.getServerCache().isFullyInitialized(), 'Once a server snap is complete, it should never go back'); this.viewCache_ = result.viewCache; return this.generateEventsForChanges_(result.changes, result.viewCache.getEventCache().getNode(), null); }; /** * @param {!EventRegistration} registration * @return {!Array.} */ View.prototype.getInitialEvents = function (registration) { var eventSnap = this.viewCache_.getEventCache(); var initialChanges = []; if (!eventSnap.getNode().isLeafNode()) { var eventNode = eventSnap.getNode(); eventNode.forEachChild(PRIORITY_INDEX, function (key, childNode) { initialChanges.push(Change.childAddedChange(key, childNode)); }); } if (eventSnap.isFullyInitialized()) { initialChanges.push(Change.valueChange(eventSnap.getNode())); } return this.generateEventsForChanges_(initialChanges, eventSnap.getNode(), registration); }; /** * @private * @param {!Array.} changes * @param {!Node} eventCache * @param {EventRegistration=} eventRegistration * @return {!Array.} */ View.prototype.generateEventsForChanges_ = function (changes, eventCache, eventRegistration) { var registrations = eventRegistration ? [eventRegistration] : this.eventRegistrations_; return this.eventGenerator_.generateEventsForChanges(changes, eventCache, registrations); }; return View; }()); /** * Copyright 2017 Google Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ var __referenceConstructor$1; /** * SyncPoint represents a single location in a SyncTree with 1 or more event registrations, meaning we need to * maintain 1 or more Views at this location to cache server data and raise appropriate events for server changes * and user writes (set, transaction, update). * * It's responsible for: * - Maintaining the set of 1 or more views necessary at this location (a SyncPoint with 0 views should be removed). * - Proxying user / server operations to the views as appropriate (i.e. applyServerOverwrite, * applyUserOverwrite, etc.) */ var SyncPoint = /** @class */ (function () { function SyncPoint() { /** * The Views being tracked at this location in the tree, stored as a map where the key is a * queryId and the value is the View for that query. * * NOTE: This list will be quite small (usually 1, but perhaps 2 or 3; any more is an odd use case). * * @type {!Object.} * @private */ this.views_ = {}; } Object.defineProperty(SyncPoint, "__referenceConstructor", { get: function () { util.assert(__referenceConstructor$1, 'Reference.ts has not been loaded'); return __referenceConstructor$1; }, set: function (val) { util.assert(!__referenceConstructor$1, '__referenceConstructor has already been defined'); __referenceConstructor$1 = val; }, enumerable: true, configurable: true }); /** * @return {boolean} */ SyncPoint.prototype.isEmpty = function () { return util.isEmpty(this.views_); }; /** * * @param {!Operation} operation * @param {!WriteTreeRef} writesCache * @param {?Node} optCompleteServerCache * @return {!Array.} */ SyncPoint.prototype.applyOperation = function (operation, writesCache, optCompleteServerCache) { var queryId = operation.source.queryId; if (queryId !== null) { var view = util.safeGet(this.views_, queryId); util.assert(view != null, 'SyncTree gave us an op for an invalid query.'); return view.applyOperation(operation, writesCache, optCompleteServerCache); } else { var events_1 = []; util.forEach(this.views_, function (key, view) { events_1 = events_1.concat(view.applyOperation(operation, writesCache, optCompleteServerCache)); }); return events_1; } }; /** * Add an event callback for the specified query. * * @param {!Query} query * @param {!EventRegistration} eventRegistration * @param {!WriteTreeRef} writesCache * @param {?Node} serverCache Complete server cache, if we have it. * @param {boolean} serverCacheComplete * @return {!Array.} Events to raise. */ SyncPoint.prototype.addEventRegistration = function (query, eventRegistration, writesCache, serverCache, serverCacheComplete) { var queryId = query.queryIdentifier(); var view = util.safeGet(this.views_, queryId); if (!view) { // TODO: make writesCache take flag for complete server node var eventCache = writesCache.calcCompleteEventCache(serverCacheComplete ? serverCache : null); var eventCacheComplete = false; if (eventCache) { eventCacheComplete = true; } else if (serverCache instanceof ChildrenNode) { eventCache = writesCache.calcCompleteEventChildren(serverCache); eventCacheComplete = false; } else { eventCache = ChildrenNode.EMPTY_NODE; eventCacheComplete = false; } var viewCache = new ViewCache(new CacheNode( /** @type {!Node} */ (eventCache), eventCacheComplete, false), new CacheNode( /** @type {!Node} */ (serverCache), serverCacheComplete, false)); view = new View(query, viewCache); this.views_[queryId] = view; } // This is guaranteed to exist now, we just created anything that was missing view.addEventRegistration(eventRegistration); return view.getInitialEvents(eventRegistration); }; /** * Remove event callback(s). Return cancelEvents if a cancelError is specified. * * If query is the default query, we'll check all views for the specified eventRegistration. * If eventRegistration is null, we'll remove all callbacks for the specified view(s). * * @param {!Query} query * @param {?EventRegistration} eventRegistration If null, remove all callbacks. * @param {Error=} cancelError If a cancelError is provided, appropriate cancel events will be returned. * @return {{removed:!Array., events:!Array.}} removed queries and any cancel events */ SyncPoint.prototype.removeEventRegistration = function (query, eventRegistration, cancelError) { var queryId = query.queryIdentifier(); var removed = []; var cancelEvents = []; var hadCompleteView = this.hasCompleteView(); if (queryId === 'default') { // When you do ref.off(...), we search all views for the registration to remove. var self_1 = this; util.forEach(this.views_, function (viewQueryId, view) { cancelEvents = cancelEvents.concat(view.removeEventRegistration(eventRegistration, cancelError)); if (view.isEmpty()) { delete self_1.views_[viewQueryId]; // We'll deal with complete views later. if (!view .getQuery() .getQueryParams() .loadsAllData()) { removed.push(view.getQuery()); } } }); } else { // remove the callback from the specific view. var view = util.safeGet(this.views_, queryId); if (view) { cancelEvents = cancelEvents.concat(view.removeEventRegistration(eventRegistration, cancelError)); if (view.isEmpty()) { delete this.views_[queryId]; // We'll deal with complete views later. if (!view .getQuery() .getQueryParams() .loadsAllData()) { removed.push(view.getQuery()); } } } } if (hadCompleteView && !this.hasCompleteView()) { // We removed our last complete view. removed.push(new SyncPoint.__referenceConstructor(query.repo, query.path)); } return { removed: removed, events: cancelEvents }; }; /** * @return {!Array.} */ SyncPoint.prototype.getQueryViews = function () { var _this = this; var values = Object.keys(this.views_).map(function (key) { return _this.views_[key]; }); return values.filter(function (view) { return !view .getQuery() .getQueryParams() .loadsAllData(); }); }; /** * * @param {!Path} path The path to the desired complete snapshot * @return {?Node} A complete cache, if it exists */ SyncPoint.prototype.getCompleteServerCache = function (path) { var serverCache = null; util.forEach(this.views_, function (key, view) { serverCache = serverCache || view.getCompleteServerCache(path); }); return serverCache; }; /** * @param {!Query} query * @return {?View} */ SyncPoint.prototype.viewForQuery = function (query) { var params = query.getQueryParams(); if (params.loadsAllData()) { return this.getCompleteView(); } else { var queryId = query.queryIdentifier(); return util.safeGet(this.views_, queryId); } }; /** * @param {!Query} query * @return {boolean} */ SyncPoint.prototype.viewExistsForQuery = function (query) { return this.viewForQuery(query) != null; }; /** * @return {boolean} */ SyncPoint.prototype.hasCompleteView = function () { return this.getCompleteView() != null; }; /** * @return {?View} */ SyncPoint.prototype.getCompleteView = function () { var completeView = util.findValue(this.views_, function (view) { return view .getQuery() .getQueryParams() .loadsAllData(); }); return completeView || null; }; return SyncPoint; }()); /** * Copyright 2017 Google Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ /** * This class holds a collection of writes that can be applied to nodes in unison. It abstracts away the logic with * dealing with priority writes and multiple nested writes. At any given path there is only allowed to be one write * modifying that path. Any write to an existing path or shadowing an existing path will modify that existing write * to reflect the write added. * * @constructor * @param {!ImmutableTree.} writeTree */ var CompoundWrite = /** @class */ (function () { function CompoundWrite(writeTree_) { this.writeTree_ = writeTree_; } /** * @param {!Path} path * @param {!Node} node * @return {!CompoundWrite} */ CompoundWrite.prototype.addWrite = function (path, node) { if (path.isEmpty()) { return new CompoundWrite(new ImmutableTree(node)); } else { var rootmost = this.writeTree_.findRootMostValueAndPath(path); if (rootmost != null) { var rootMostPath = rootmost.path; var value = rootmost.value; var relativePath = Path.relativePath(rootMostPath, path); value = value.updateChild(relativePath, node); return new CompoundWrite(this.writeTree_.set(rootMostPath, value)); } else { var subtree = new ImmutableTree(node); var newWriteTree = this.writeTree_.setTree(path, subtree); return new CompoundWrite(newWriteTree); } } }; /** * @param {!Path} path * @param {!Object.} updates * @return {!CompoundWrite} */ CompoundWrite.prototype.addWrites = function (path, updates) { var newWrite = this; util.forEach(updates, function (childKey, node) { newWrite = newWrite.addWrite(path.child(childKey), node); }); return newWrite; }; /** * Will remove a write at the given path and deeper paths. This will not modify a write at a higher * location, which must be removed by calling this method with that path. * * @param {!Path} path The path at which a write and all deeper writes should be removed * @return {!CompoundWrite} The new CompoundWrite with the removed path */ CompoundWrite.prototype.removeWrite = function (path) { if (path.isEmpty()) { return CompoundWrite.Empty; } else { var newWriteTree = this.writeTree_.setTree(path, ImmutableTree.Empty); return new CompoundWrite(newWriteTree); } }; /** * Returns whether this CompoundWrite will fully overwrite a node at a given location and can therefore be * considered "complete". * * @param {!Path} path The path to check for * @return {boolean} Whether there is a complete write at that path */ CompoundWrite.prototype.hasCompleteWrite = function (path) { return this.getCompleteNode(path) != null; }; /** * Returns a node for a path if and only if the node is a "complete" overwrite at that path. This will not aggregate * writes from deeper paths, but will return child nodes from a more shallow path. * * @param {!Path} path The path to get a complete write * @return {?Node} The node if complete at that path, or null otherwise. */ CompoundWrite.prototype.getCompleteNode = function (path) { var rootmost = this.writeTree_.findRootMostValueAndPath(path); if (rootmost != null) { return this.writeTree_ .get(rootmost.path) .getChild(Path.relativePath(rootmost.path, path)); } else { return null; } }; /** * Returns all children that are guaranteed to be a complete overwrite. * * @return {!Array.} A list of all complete children. */ CompoundWrite.prototype.getCompleteChildren = function () { var children = []; var node = this.writeTree_.value; if (node != null) { // If it's a leaf node, it has no children; so nothing to do. if (!node.isLeafNode()) { node.forEachChild(PRIORITY_INDEX, function (childName, childNode) { children.push(new NamedNode(childName, childNode)); }); } } else { this.writeTree_.children.inorderTraversal(function (childName, childTree) { if (childTree.value != null) { children.push(new NamedNode(childName, childTree.value)); } }); } return children; }; /** * @param {!Path} path * @return {!CompoundWrite} */ CompoundWrite.prototype.childCompoundWrite = function (path) { if (path.isEmpty()) { return this; } else { var shadowingNode = this.getCompleteNode(path); if (shadowingNode != null) { return new CompoundWrite(new ImmutableTree(shadowingNode)); } else { return new CompoundWrite(this.writeTree_.subtree(path)); } } }; /** * Returns true if this CompoundWrite is empty and therefore does not modify any nodes. * @return {boolean} Whether this CompoundWrite is empty */ CompoundWrite.prototype.isEmpty = function () { return this.writeTree_.isEmpty(); }; /** * Applies this CompoundWrite to a node. The node is returned with all writes from this CompoundWrite applied to the * node * @param {!Node} node The node to apply this CompoundWrite to * @return {!Node} The node with all writes applied */ CompoundWrite.prototype.apply = function (node) { return CompoundWrite.applySubtreeWrite_(Path.Empty, this.writeTree_, node); }; /** * @type {!CompoundWrite} */ CompoundWrite.Empty = new CompoundWrite(new ImmutableTree(null)); /** * @param {!Path} relativePath * @param {!ImmutableTree.} writeTree * @param {!Node} node * @return {!Node} * @private */ CompoundWrite.applySubtreeWrite_ = function (relativePath, writeTree, node) { if (writeTree.value != null) { // Since there a write is always a leaf, we're done here return node.updateChild(relativePath, writeTree.value); } else { var priorityWrite_1 = null; writeTree.children.inorderTraversal(function (childKey, childTree) { if (childKey === '.priority') { // Apply priorities at the end so we don't update priorities for either empty nodes or forget // to apply priorities to empty nodes that are later filled util.assert(childTree.value !== null, 'Priority writes must always be leaf nodes'); priorityWrite_1 = childTree.value; } else { node = CompoundWrite.applySubtreeWrite_(relativePath.child(childKey), childTree, node); } }); // If there was a priority write, we only apply it if the node is not empty if (!node.getChild(relativePath).isEmpty() && priorityWrite_1 !== null) { node = node.updateChild(relativePath.child('.priority'), priorityWrite_1); } return node; } }; return CompoundWrite; }()); /** * Copyright 2017 Google Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ /** * WriteTree tracks all pending user-initiated writes and has methods to calculate the result of merging them * with underlying server data (to create "event cache" data). Pending writes are added with addOverwrite() * and addMerge(), and removed with removeWrite(). * * @constructor */ var WriteTree = /** @class */ (function () { function WriteTree() { /** * A tree tracking the result of applying all visible writes. This does not include transactions with * applyLocally=false or writes that are completely shadowed by other writes. * * @type {!CompoundWrite} * @private */ this.visibleWrites_ = CompoundWrite.Empty; /** * A list of all pending writes, regardless of visibility and shadowed-ness. Used to calculate arbitrary * sets of the changed data, such as hidden writes (from transactions) or changes with certain writes excluded (also * used by transactions). * * @type {!Array.} * @private */ this.allWrites_ = []; this.lastWriteId_ = -1; } /** * Create a new WriteTreeRef for the given path. For use with a new sync point at the given path. * * @param {!Path} path * @return {!WriteTreeRef} */ WriteTree.prototype.childWrites = function (path) { return new WriteTreeRef(path, this); }; /** * Record a new overwrite from user code. * * @param {!Path} path * @param {!Node} snap * @param {!number} writeId * @param {boolean=} visible This is set to false by some transactions. It should be excluded from event caches */ WriteTree.prototype.addOverwrite = function (path, snap, writeId, visible) { util.assert(writeId > this.lastWriteId_, 'Stacking an older write on top of newer ones'); if (visible === undefined) { visible = true; } this.allWrites_.push({ path: path, snap: snap, writeId: writeId, visible: visible }); if (visible) { this.visibleWrites_ = this.visibleWrites_.addWrite(path, snap); } this.lastWriteId_ = writeId; }; /** * Record a new merge from user code. * * @param {!Path} path * @param {!Object.} changedChildren * @param {!number} writeId */ WriteTree.prototype.addMerge = function (path, changedChildren, writeId) { util.assert(writeId > this.lastWriteId_, 'Stacking an older merge on top of newer ones'); this.allWrites_.push({ path: path, children: changedChildren, writeId: writeId, visible: true }); this.visibleWrites_ = this.visibleWrites_.addWrites(path, changedChildren); this.lastWriteId_ = writeId; }; /** * @param {!number} writeId * @return {?WriteRecord} */ WriteTree.prototype.getWrite = function (writeId) { for (var i = 0; i < this.allWrites_.length; i++) { var record = this.allWrites_[i]; if (record.writeId === writeId) { return record; } } return null; }; /** * Remove a write (either an overwrite or merge) that has been successfully acknowledge by the server. Recalculates * the tree if necessary. We return true if it may have been visible, meaning views need to reevaluate. * * @param {!number} writeId * @return {boolean} true if the write may have been visible (meaning we'll need to reevaluate / raise * events as a result). */ WriteTree.prototype.removeWrite = function (writeId) { // Note: disabling this check. It could be a transaction that preempted another transaction, and thus was applied // out of order. //const validClear = revert || this.allWrites_.length === 0 || writeId <= this.allWrites_[0].writeId; //assert(validClear, "Either we don't have this write, or it's the first one in the queue"); var _this = this; var idx = this.allWrites_.findIndex(function (s) { return s.writeId === writeId; }); util.assert(idx >= 0, 'removeWrite called with nonexistent writeId.'); var writeToRemove = this.allWrites_[idx]; this.allWrites_.splice(idx, 1); var removedWriteWasVisible = writeToRemove.visible; var removedWriteOverlapsWithOtherWrites = false; var i = this.allWrites_.length - 1; while (removedWriteWasVisible && i >= 0) { var currentWrite = this.allWrites_[i]; if (currentWrite.visible) { if (i >= idx && this.recordContainsPath_(currentWrite, writeToRemove.path)) { // The removed write was completely shadowed by a subsequent write. removedWriteWasVisible = false; } else if (writeToRemove.path.contains(currentWrite.path)) { // Either we're covering some writes or they're covering part of us (depending on which came first). removedWriteOverlapsWithOtherWrites = true; } } i--; } if (!removedWriteWasVisible) { return false; } else if (removedWriteOverlapsWithOtherWrites) { // There's some shadowing going on. Just rebuild the visible writes from scratch. this.resetTree_(); return true; } else { // There's no shadowing. We can safely just remove the write(s) from visibleWrites. if (writeToRemove.snap) { this.visibleWrites_ = this.visibleWrites_.removeWrite(writeToRemove.path); } else { var children = writeToRemove.children; util.forEach(children, function (childName) { _this.visibleWrites_ = _this.visibleWrites_.removeWrite(writeToRemove.path.child(childName)); }); } return true; } }; /** * Return a complete snapshot for the given path if there's visible write data at that path, else null. * No server data is considered. * * @param {!Path} path * @return {?Node} */ WriteTree.prototype.getCompleteWriteData = function (path) { return this.visibleWrites_.getCompleteNode(path); }; /** * Given optional, underlying server data, and an optional set of constraints (exclude some sets, include hidden * writes), attempt to calculate a complete snapshot for the given path * * @param {!Path} treePath * @param {?Node} completeServerCache * @param {Array.=} writeIdsToExclude An optional set to be excluded * @param {boolean=} includeHiddenWrites Defaults to false, whether or not to layer on writes with visible set to false * @return {?Node} */ WriteTree.prototype.calcCompleteEventCache = function (treePath, completeServerCache, writeIdsToExclude, includeHiddenWrites) { if (!writeIdsToExclude && !includeHiddenWrites) { var shadowingNode = this.visibleWrites_.getCompleteNode(treePath); if (shadowingNode != null) { return shadowingNode; } else { var subMerge = this.visibleWrites_.childCompoundWrite(treePath); if (subMerge.isEmpty()) { return completeServerCache; } else if (completeServerCache == null && !subMerge.hasCompleteWrite(Path.Empty)) { // We wouldn't have a complete snapshot, since there's no underlying data and no complete shadow return null; } else { var layeredCache = completeServerCache || ChildrenNode.EMPTY_NODE; return subMerge.apply(layeredCache); } } } else { var merge = this.visibleWrites_.childCompoundWrite(treePath); if (!includeHiddenWrites && merge.isEmpty()) { return completeServerCache; } else { // If the server cache is null, and we don't have a complete cache, we need to return null if (!includeHiddenWrites && completeServerCache == null && !merge.hasCompleteWrite(Path.Empty)) { return null; } else { var filter = function (write) { return ((write.visible || includeHiddenWrites) && (!writeIdsToExclude || !~writeIdsToExclude.indexOf(write.writeId)) && (write.path.contains(treePath) || treePath.contains(write.path))); }; var mergeAtPath = WriteTree.layerTree_(this.allWrites_, filter, treePath); var layeredCache = completeServerCache || ChildrenNode.EMPTY_NODE; return mergeAtPath.apply(layeredCache); } } } }; /** * With optional, underlying server data, attempt to return a children node of children that we have complete data for. * Used when creating new views, to pre-fill their complete event children snapshot. * * @param {!Path} treePath * @param {?ChildrenNode} completeServerChildren * @return {!ChildrenNode} */ WriteTree.prototype.calcCompleteEventChildren = function (treePath, completeServerChildren) { var completeChildren = ChildrenNode.EMPTY_NODE; var topLevelSet = this.visibleWrites_.getCompleteNode(treePath); if (topLevelSet) { if (!topLevelSet.isLeafNode()) { // we're shadowing everything. Return the children. topLevelSet.forEachChild(PRIORITY_INDEX, function (childName, childSnap) { completeChildren = completeChildren.updateImmediateChild(childName, childSnap); }); } return completeChildren; } else if (completeServerChildren) { // Layer any children we have on top of this // We know we don't have a top-level set, so just enumerate existing children var merge_1 = this.visibleWrites_.childCompoundWrite(treePath); completeServerChildren.forEachChild(PRIORITY_INDEX, function (childName, childNode) { var node = merge_1 .childCompoundWrite(new Path(childName)) .apply(childNode); completeChildren = completeChildren.updateImmediateChild(childName, node); }); // Add any complete children we have from the set merge_1.getCompleteChildren().forEach(function (namedNode) { completeChildren = completeChildren.updateImmediateChild(namedNode.name, namedNode.node); }); return completeChildren; } else { // We don't have anything to layer on top of. Layer on any children we have // Note that we can return an empty snap if we have a defined delete var merge = this.visibleWrites_.childCompoundWrite(treePath); merge.getCompleteChildren().forEach(function (namedNode) { completeChildren = completeChildren.updateImmediateChild(namedNode.name, namedNode.node); }); return completeChildren; } }; /** * Given that the underlying server data has updated, determine what, if anything, needs to be * applied to the event cache. * * Possibilities: * * 1. No writes are shadowing. Events should be raised, the snap to be applied comes from the server data * * 2. Some write is completely shadowing. No events to be raised * * 3. Is partially shadowed. Events * * Either existingEventSnap or existingServerSnap must exist * * @param {!Path} treePath * @param {!Path} childPath * @param {?Node} existingEventSnap * @param {?Node} existingServerSnap * @return {?Node} */ WriteTree.prototype.calcEventCacheAfterServerOverwrite = function (treePath, childPath, existingEventSnap, existingServerSnap) { util.assert(existingEventSnap || existingServerSnap, 'Either existingEventSnap or existingServerSnap must exist'); var path = treePath.child(childPath); if (this.visibleWrites_.hasCompleteWrite(path)) { // At this point we can probably guarantee that we're in case 2, meaning no events // May need to check visibility while doing the findRootMostValueAndPath call return null; } else { // No complete shadowing. We're either partially shadowing or not shadowing at all. var childMerge = this.visibleWrites_.childCompoundWrite(path); if (childMerge.isEmpty()) { // We're not shadowing at all. Case 1 return existingServerSnap.getChild(childPath); } else { // This could be more efficient if the serverNode + updates doesn't change the eventSnap // However this is tricky to find out, since user updates don't necessary change the server // snap, e.g. priority updates on empty nodes, or deep deletes. Another special case is if the server // adds nodes, but doesn't change any existing writes. It is therefore not enough to // only check if the updates change the serverNode. // Maybe check if the merge tree contains these special cases and only do a full overwrite in that case? return childMerge.apply(existingServerSnap.getChild(childPath)); } } }; /** * Returns a complete child for a given server snap after applying all user writes or null if there is no * complete child for this ChildKey. * * @param {!Path} treePath * @param {!string} childKey * @param {!CacheNode} existingServerSnap * @return {?Node} */ WriteTree.prototype.calcCompleteChild = function (treePath, childKey, existingServerSnap) { var path = treePath.child(childKey); var shadowingNode = this.visibleWrites_.getCompleteNode(path); if (shadowingNode != null) { return shadowingNode; } else { if (existingServerSnap.isCompleteForChild(childKey)) { var childMerge = this.visibleWrites_.childCompoundWrite(path); return childMerge.apply(existingServerSnap.getNode().getImmediateChild(childKey)); } else { return null; } } }; /** * Returns a node if there is a complete overwrite for this path. More specifically, if there is a write at * a higher path, this will return the child of that write relative to the write and this path. * Returns null if there is no write at this path. * * @param {!Path} path * @return {?Node} */ WriteTree.prototype.shadowingWrite = function (path) { return this.visibleWrites_.getCompleteNode(path); }; /** * This method is used when processing child remove events on a query. If we can, we pull in children that were outside * the window, but may now be in the window. * * @param {!Path} treePath * @param {?Node} completeServerData * @param {!NamedNode} startPost * @param {!number} count * @param {boolean} reverse * @param {!Index} index * @return {!Array.} */ WriteTree.prototype.calcIndexedSlice = function (treePath, completeServerData, startPost, count, reverse, index) { var toIterate; var merge = this.visibleWrites_.childCompoundWrite(treePath); var shadowingNode = merge.getCompleteNode(Path.Empty); if (shadowingNode != null) { toIterate = shadowingNode; } else if (completeServerData != null) { toIterate = merge.apply(completeServerData); } else { // no children to iterate on return []; } toIterate = toIterate.withIndex(index); if (!toIterate.isEmpty() && !toIterate.isLeafNode()) { var nodes = []; var cmp = index.getCompare(); var iter = reverse ? toIterate.getReverseIteratorFrom(startPost, index) : toIterate.getIteratorFrom(startPost, index); var next = iter.getNext(); while (next && nodes.length < count) { if (cmp(next, startPost) !== 0) { nodes.push(next); } next = iter.getNext(); } return nodes; } else { return []; } }; /** * @param {!WriteRecord} writeRecord * @param {!Path} path * @return {boolean} * @private */ WriteTree.prototype.recordContainsPath_ = function (writeRecord, path) { if (writeRecord.snap) { return writeRecord.path.contains(path); } else { // findKey can return undefined, so use !! to coerce to boolean return !!util.findKey(writeRecord.children, function (childSnap, childName) { return writeRecord.path.child(childName).contains(path); }); } }; /** * Re-layer the writes and merges into a tree so we can efficiently calculate event snapshots * @private */ WriteTree.prototype.resetTree_ = function () { this.visibleWrites_ = WriteTree.layerTree_(this.allWrites_, WriteTree.DefaultFilter_, Path.Empty); if (this.allWrites_.length > 0) { this.lastWriteId_ = this.allWrites_[this.allWrites_.length - 1].writeId; } else { this.lastWriteId_ = -1; } }; /** * The default filter used when constructing the tree. Keep everything that's visible. * * @param {!WriteRecord} write * @return {boolean} * @private */ WriteTree.DefaultFilter_ = function (write) { return write.visible; }; /** * Static method. Given an array of WriteRecords, a filter for which ones to include, and a path, construct the tree of * event data at that path. * * @param {!Array.} writes * @param {!function(!WriteRecord):boolean} filter * @param {!Path} treeRoot * @return {!CompoundWrite} * @private */ WriteTree.layerTree_ = function (writes, filter, treeRoot) { var compoundWrite = CompoundWrite.Empty; for (var i = 0; i < writes.length; ++i) { var write = writes[i]; // Theory, a later set will either: // a) abort a relevant transaction, so no need to worry about excluding it from calculating that transaction // b) not be relevant to a transaction (separate branch), so again will not affect the data for that transaction if (filter(write)) { var writePath = write.path; var relativePath = void 0; if (write.snap) { if (treeRoot.contains(writePath)) { relativePath = Path.relativePath(treeRoot, writePath); compoundWrite = compoundWrite.addWrite(relativePath, write.snap); } else if (writePath.contains(treeRoot)) { relativePath = Path.relativePath(writePath, treeRoot); compoundWrite = compoundWrite.addWrite(Path.Empty, write.snap.getChild(relativePath)); } else { // There is no overlap between root path and write path, ignore write } } else if (write.children) { if (treeRoot.contains(writePath)) { relativePath = Path.relativePath(treeRoot, writePath); compoundWrite = compoundWrite.addWrites(relativePath, write.children); } else if (writePath.contains(treeRoot)) { relativePath = Path.relativePath(writePath, treeRoot); if (relativePath.isEmpty()) { compoundWrite = compoundWrite.addWrites(Path.Empty, write.children); } else { var child = util.safeGet(write.children, relativePath.getFront()); if (child) { // There exists a child in this node that matches the root path var deepNode = child.getChild(relativePath.popFront()); compoundWrite = compoundWrite.addWrite(Path.Empty, deepNode); } } } else { // There is no overlap between root path and write path, ignore write } } else { throw util.assertionError('WriteRecord should have .snap or .children'); } } } return compoundWrite; }; return WriteTree; }()); /** * A WriteTreeRef wraps a WriteTree and a path, for convenient access to a particular subtree. All of the methods * just proxy to the underlying WriteTree. * * @constructor */ var WriteTreeRef = /** @class */ (function () { /** * @param {!Path} path * @param {!WriteTree} writeTree */ function WriteTreeRef(path, writeTree) { this.treePath_ = path; this.writeTree_ = writeTree; } /** * If possible, returns a complete event cache, using the underlying server data if possible. In addition, can be used * to get a cache that includes hidden writes, and excludes arbitrary writes. Note that customizing the returned node * can lead to a more expensive calculation. * * @param {?Node} completeServerCache * @param {Array.=} writeIdsToExclude Optional writes to exclude. * @param {boolean=} includeHiddenWrites Defaults to false, whether or not to layer on writes with visible set to false * @return {?Node} */ WriteTreeRef.prototype.calcCompleteEventCache = function (completeServerCache, writeIdsToExclude, includeHiddenWrites) { return this.writeTree_.calcCompleteEventCache(this.treePath_, completeServerCache, writeIdsToExclude, includeHiddenWrites); }; /** * If possible, returns a children node containing all of the complete children we have data for. The returned data is a * mix of the given server data and write data. * * @param {?ChildrenNode} completeServerChildren * @return {!ChildrenNode} */ WriteTreeRef.prototype.calcCompleteEventChildren = function (completeServerChildren) { return this.writeTree_.calcCompleteEventChildren(this.treePath_, completeServerChildren); }; /** * Given that either the underlying server data has updated or the outstanding writes have updated, determine what, * if anything, needs to be applied to the event cache. * * Possibilities: * * 1. No writes are shadowing. Events should be raised, the snap to be applied comes from the server data * * 2. Some write is completely shadowing. No events to be raised * * 3. Is partially shadowed. Events should be raised * * Either existingEventSnap or existingServerSnap must exist, this is validated via an assert * * @param {!Path} path * @param {?Node} existingEventSnap * @param {?Node} existingServerSnap * @return {?Node} */ WriteTreeRef.prototype.calcEventCacheAfterServerOverwrite = function (path, existingEventSnap, existingServerSnap) { return this.writeTree_.calcEventCacheAfterServerOverwrite(this.treePath_, path, existingEventSnap, existingServerSnap); }; /** * Returns a node if there is a complete overwrite for this path. More specifically, if there is a write at * a higher path, this will return the child of that write relative to the write and this path. * Returns null if there is no write at this path. * * @param {!Path} path * @return {?Node} */ WriteTreeRef.prototype.shadowingWrite = function (path) { return this.writeTree_.shadowingWrite(this.treePath_.child(path)); }; /** * This method is used when processing child remove events on a query. If we can, we pull in children that were outside * the window, but may now be in the window * * @param {?Node} completeServerData * @param {!NamedNode} startPost * @param {!number} count * @param {boolean} reverse * @param {!Index} index * @return {!Array.} */ WriteTreeRef.prototype.calcIndexedSlice = function (completeServerData, startPost, count, reverse, index) { return this.writeTree_.calcIndexedSlice(this.treePath_, completeServerData, startPost, count, reverse, index); }; /** * Returns a complete child for a given server snap after applying all user writes or null if there is no * complete child for this ChildKey. * * @param {!string} childKey * @param {!CacheNode} existingServerCache * @return {?Node} */ WriteTreeRef.prototype.calcCompleteChild = function (childKey, existingServerCache) { return this.writeTree_.calcCompleteChild(this.treePath_, childKey, existingServerCache); }; /** * Return a WriteTreeRef for a child. * * @param {string} childName * @return {!WriteTreeRef} */ WriteTreeRef.prototype.child = function (childName) { return new WriteTreeRef(this.treePath_.child(childName), this.writeTree_); }; return WriteTreeRef; }()); /** * Copyright 2017 Google Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ /** * SyncTree is the central class for managing event callback registration, data caching, views * (query processing), and event generation. There are typically two SyncTree instances for * each Repo, one for the normal Firebase data, and one for the .info data. * * It has a number of responsibilities, including: * - Tracking all user event callbacks (registered via addEventRegistration() and removeEventRegistration()). * - Applying and caching data changes for user set(), transaction(), and update() calls * (applyUserOverwrite(), applyUserMerge()). * - Applying and caching data changes for server data changes (applyServerOverwrite(), * applyServerMerge()). * - Generating user-facing events for server and user changes (all of the apply* methods * return the set of events that need to be raised as a result). * - Maintaining the appropriate set of server listens to ensure we are always subscribed * to the correct set of paths and queries to satisfy the current set of user event * callbacks (listens are started/stopped using the provided listenProvider). * * NOTE: Although SyncTree tracks event callbacks and calculates events to raise, the actual * events are returned to the caller rather than raised synchronously. * * @constructor */ var SyncTree = /** @class */ (function () { /** * @param {!ListenProvider} listenProvider_ Used by SyncTree to start / stop listening * to server data. */ function SyncTree(listenProvider_) { this.listenProvider_ = listenProvider_; /** * Tree of SyncPoints. There's a SyncPoint at any location that has 1 or more views. * @type {!ImmutableTree.} * @private */ this.syncPointTree_ = ImmutableTree.Empty; /** * A tree of all pending user writes (user-initiated set()'s, transaction()'s, update()'s, etc.). * @type {!WriteTree} * @private */ this.pendingWriteTree_ = new WriteTree(); this.tagToQueryMap_ = {}; this.queryToTagMap_ = {}; } /** * Apply the data changes for a user-generated set() or transaction() call. * * @param {!Path} path * @param {!Node} newData * @param {number} writeId * @param {boolean=} visible * @return {!Array.} Events to raise. */ SyncTree.prototype.applyUserOverwrite = function (path, newData, writeId, visible) { // Record pending write. this.pendingWriteTree_.addOverwrite(path, newData, writeId, visible); if (!visible) { return []; } else { return this.applyOperationToSyncPoints_(new Overwrite(OperationSource.User, path, newData)); } }; /** * Apply the data from a user-generated update() call * * @param {!Path} path * @param {!Object.} changedChildren * @param {!number} writeId * @return {!Array.} Events to raise. */ SyncTree.prototype.applyUserMerge = function (path, changedChildren, writeId) { // Record pending merge. this.pendingWriteTree_.addMerge(path, changedChildren, writeId); var changeTree = ImmutableTree.fromObject(changedChildren); return this.applyOperationToSyncPoints_(new Merge(OperationSource.User, path, changeTree)); }; /** * Acknowledge a pending user write that was previously registered with applyUserOverwrite() or applyUserMerge(). * * @param {!number} writeId * @param {boolean=} revert True if the given write failed and needs to be reverted * @return {!Array.} Events to raise. */ SyncTree.prototype.ackUserWrite = function (writeId, revert) { if (revert === void 0) { revert = false; } var write = this.pendingWriteTree_.getWrite(writeId); var needToReevaluate = this.pendingWriteTree_.removeWrite(writeId); if (!needToReevaluate) { return []; } else { var affectedTree_1 = ImmutableTree.Empty; if (write.snap != null) { // overwrite affectedTree_1 = affectedTree_1.set(Path.Empty, true); } else { util.forEach(write.children, function (pathString, node) { affectedTree_1 = affectedTree_1.set(new Path(pathString), node); }); } return this.applyOperationToSyncPoints_(new AckUserWrite(write.path, affectedTree_1, revert)); } }; /** * Apply new server data for the specified path.. * * @param {!Path} path * @param {!Node} newData * @return {!Array.} Events to raise. */ SyncTree.prototype.applyServerOverwrite = function (path, newData) { return this.applyOperationToSyncPoints_(new Overwrite(OperationSource.Server, path, newData)); }; /** * Apply new server data to be merged in at the specified path. * * @param {!Path} path * @param {!Object.} changedChildren * @return {!Array.} Events to raise. */ SyncTree.prototype.applyServerMerge = function (path, changedChildren) { var changeTree = ImmutableTree.fromObject(changedChildren); return this.applyOperationToSyncPoints_(new Merge(OperationSource.Server, path, changeTree)); }; /** * Apply a listen complete for a query * * @param {!Path} path * @return {!Array.} Events to raise. */ SyncTree.prototype.applyListenComplete = function (path) { return this.applyOperationToSyncPoints_(new ListenComplete(OperationSource.Server, path)); }; /** * Apply new server data for the specified tagged query. * * @param {!Path} path * @param {!Node} snap * @param {!number} tag * @return {!Array.} Events to raise. */ SyncTree.prototype.applyTaggedQueryOverwrite = function (path, snap, tag) { var queryKey = this.queryKeyForTag_(tag); if (queryKey != null) { var r = SyncTree.parseQueryKey_(queryKey); var queryPath = r.path, queryId = r.queryId; var relativePath = Path.relativePath(queryPath, path); var op = new Overwrite(OperationSource.forServerTaggedQuery(queryId), relativePath, snap); return this.applyTaggedOperation_(queryPath, op); } else { // Query must have been removed already return []; } }; /** * Apply server data to be merged in for the specified tagged query. * * @param {!Path} path * @param {!Object.} changedChildren * @param {!number} tag * @return {!Array.} Events to raise. */ SyncTree.prototype.applyTaggedQueryMerge = function (path, changedChildren, tag) { var queryKey = this.queryKeyForTag_(tag); if (queryKey) { var r = SyncTree.parseQueryKey_(queryKey); var queryPath = r.path, queryId = r.queryId; var relativePath = Path.relativePath(queryPath, path); var changeTree = ImmutableTree.fromObject(changedChildren); var op = new Merge(OperationSource.forServerTaggedQuery(queryId), relativePath, changeTree); return this.applyTaggedOperation_(queryPath, op); } else { // We've already removed the query. No big deal, ignore the update return []; } }; /** * Apply a listen complete for a tagged query * * @param {!Path} path * @param {!number} tag * @return {!Array.} Events to raise. */ SyncTree.prototype.applyTaggedListenComplete = function (path, tag) { var queryKey = this.queryKeyForTag_(tag); if (queryKey) { var r = SyncTree.parseQueryKey_(queryKey); var queryPath = r.path, queryId = r.queryId; var relativePath = Path.relativePath(queryPath, path); var op = new ListenComplete(OperationSource.forServerTaggedQuery(queryId), relativePath); return this.applyTaggedOperation_(queryPath, op); } else { // We've already removed the query. No big deal, ignore the update return []; } }; /** * Add an event callback for the specified query. * * @param {!Query} query * @param {!EventRegistration} eventRegistration * @return {!Array.} Events to raise. */ SyncTree.prototype.addEventRegistration = function (query, eventRegistration) { var path = query.path; var serverCache = null; var foundAncestorDefaultView = false; // Any covering writes will necessarily be at the root, so really all we need to find is the server cache. // Consider optimizing this once there's a better understanding of what actual behavior will be. this.syncPointTree_.foreachOnPath(path, function (pathToSyncPoint, sp) { var relativePath = Path.relativePath(pathToSyncPoint, path); serverCache = serverCache || sp.getCompleteServerCache(relativePath); foundAncestorDefaultView = foundAncestorDefaultView || sp.hasCompleteView(); }); var syncPoint = this.syncPointTree_.get(path); if (!syncPoint) { syncPoint = new SyncPoint(); this.syncPointTree_ = this.syncPointTree_.set(path, syncPoint); } else { foundAncestorDefaultView = foundAncestorDefaultView || syncPoint.hasCompleteView(); serverCache = serverCache || syncPoint.getCompleteServerCache(Path.Empty); } var serverCacheComplete; if (serverCache != null) { serverCacheComplete = true; } else { serverCacheComplete = false; serverCache = ChildrenNode.EMPTY_NODE; var subtree = this.syncPointTree_.subtree(path); subtree.foreachChild(function (childName, childSyncPoint) { var completeCache = childSyncPoint.getCompleteServerCache(Path.Empty); if (completeCache) { serverCache = serverCache.updateImmediateChild(childName, completeCache); } }); } var viewAlreadyExists = syncPoint.viewExistsForQuery(query); if (!viewAlreadyExists && !query.getQueryParams().loadsAllData()) { // We need to track a tag for this query var queryKey = SyncTree.makeQueryKey_(query); util.assert(!(queryKey in this.queryToTagMap_), 'View does not exist, but we have a tag'); var tag = SyncTree.getNextQueryTag_(); this.queryToTagMap_[queryKey] = tag; // Coerce to string to avoid sparse arrays. this.tagToQueryMap_['_' + tag] = queryKey; } var writesCache = this.pendingWriteTree_.childWrites(path); var events = syncPoint.addEventRegistration(query, eventRegistration, writesCache, serverCache, serverCacheComplete); if (!viewAlreadyExists && !foundAncestorDefaultView) { var view /** @type !View */ = syncPoint.viewForQuery(query); events = events.concat(this.setupListener_(query, view)); } return events; }; /** * Remove event callback(s). * * If query is the default query, we'll check all queries for the specified eventRegistration. * If eventRegistration is null, we'll remove all callbacks for the specified query/queries. * * @param {!Query} query * @param {?EventRegistration} eventRegistration If null, all callbacks are removed. * @param {Error=} cancelError If a cancelError is provided, appropriate cancel events will be returned. * @return {!Array.} Cancel events, if cancelError was provided. */ SyncTree.prototype.removeEventRegistration = function (query, eventRegistration, cancelError) { var _this = this; // Find the syncPoint first. Then deal with whether or not it has matching listeners var path = query.path; var maybeSyncPoint = this.syncPointTree_.get(path); var cancelEvents = []; // A removal on a default query affects all queries at that location. A removal on an indexed query, even one without // other query constraints, does *not* affect all queries at that location. So this check must be for 'default', and // not loadsAllData(). if (maybeSyncPoint && (query.queryIdentifier() === 'default' || maybeSyncPoint.viewExistsForQuery(query))) { /** * @type {{removed: !Array., events: !Array.}} */ var removedAndEvents = maybeSyncPoint.removeEventRegistration(query, eventRegistration, cancelError); if (maybeSyncPoint.isEmpty()) { this.syncPointTree_ = this.syncPointTree_.remove(path); } var removed = removedAndEvents.removed; cancelEvents = removedAndEvents.events; // We may have just removed one of many listeners and can short-circuit this whole process // We may also not have removed a default listener, in which case all of the descendant listeners should already be // properly set up. // // Since indexed queries can shadow if they don't have other query constraints, check for loadsAllData(), instead of // queryId === 'default' var removingDefault = -1 !== removed.findIndex(function (query) { return query.getQueryParams().loadsAllData(); }); var covered = this.syncPointTree_.findOnPath(path, function (relativePath, parentSyncPoint) { return parentSyncPoint.hasCompleteView(); }); if (removingDefault && !covered) { var subtree = this.syncPointTree_.subtree(path); // There are potentially child listeners. Determine what if any listens we need to send before executing the // removal if (!subtree.isEmpty()) { // We need to fold over our subtree and collect the listeners to send var newViews = this.collectDistinctViewsForSubTree_(subtree); // Ok, we've collected all the listens we need. Set them up. for (var i = 0; i < newViews.length; ++i) { var view = newViews[i], newQuery = view.getQuery(); var listener = this.createListenerForView_(view); this.listenProvider_.startListening(SyncTree.queryForListening_(newQuery), this.tagForQuery_(newQuery), listener.hashFn, listener.onComplete); } } else { // There's nothing below us, so nothing we need to start listening on } } // If we removed anything and we're not covered by a higher up listen, we need to stop listening on this query // The above block has us covered in terms of making sure we're set up on listens lower in the tree. // Also, note that if we have a cancelError, it's already been removed at the provider level. if (!covered && removed.length > 0 && !cancelError) { // If we removed a default, then we weren't listening on any of the other queries here. Just cancel the one // default. Otherwise, we need to iterate through and cancel each individual query if (removingDefault) { // We don't tag default listeners var defaultTag = null; this.listenProvider_.stopListening(SyncTree.queryForListening_(query), defaultTag); } else { removed.forEach(function (queryToRemove) { var tagToRemove = _this.queryToTagMap_[SyncTree.makeQueryKey_(queryToRemove)]; _this.listenProvider_.stopListening(SyncTree.queryForListening_(queryToRemove), tagToRemove); }); } } // Now, clear all of the tags we're tracking for the removed listens this.removeTags_(removed); } else { // No-op, this listener must've been already removed } return cancelEvents; }; /** * Returns a complete cache, if we have one, of the data at a particular path. The location must have a listener above * it, but as this is only used by transaction code, that should always be the case anyways. * * Note: this method will *include* hidden writes from transaction with applyLocally set to false. * @param {!Path} path The path to the data we want * @param {Array.=} writeIdsToExclude A specific set to be excluded * @return {?Node} */ SyncTree.prototype.calcCompleteEventCache = function (path, writeIdsToExclude) { var includeHiddenSets = true; var writeTree = this.pendingWriteTree_; var serverCache = this.syncPointTree_.findOnPath(path, function (pathSoFar, syncPoint) { var relativePath = Path.relativePath(pathSoFar, path); var serverCache = syncPoint.getCompleteServerCache(relativePath); if (serverCache) { return serverCache; } }); return writeTree.calcCompleteEventCache(path, serverCache, writeIdsToExclude, includeHiddenSets); }; /** * This collapses multiple unfiltered views into a single view, since we only need a single * listener for them. * * @param {!ImmutableTree.} subtree * @return {!Array.} * @private */ SyncTree.prototype.collectDistinctViewsForSubTree_ = function (subtree) { return subtree.fold(function (relativePath, maybeChildSyncPoint, childMap) { if (maybeChildSyncPoint && maybeChildSyncPoint.hasCompleteView()) { var completeView = maybeChildSyncPoint.getCompleteView(); return [completeView]; } else { // No complete view here, flatten any deeper listens into an array var views_1 = []; if (maybeChildSyncPoint) { views_1 = maybeChildSyncPoint.getQueryViews(); } util.forEach(childMap, function (key, childViews) { views_1 = views_1.concat(childViews); }); return views_1; } }); }; /** * @param {!Array.} queries * @private */ SyncTree.prototype.removeTags_ = function (queries) { for (var j = 0; j < queries.length; ++j) { var removedQuery = queries[j]; if (!removedQuery.getQueryParams().loadsAllData()) { // We should have a tag for this var removedQueryKey = SyncTree.makeQueryKey_(removedQuery); var removedQueryTag = this.queryToTagMap_[removedQueryKey]; delete this.queryToTagMap_[removedQueryKey]; delete this.tagToQueryMap_['_' + removedQueryTag]; } } }; /** * Normalizes a query to a query we send the server for listening * @param {!Query} query * @return {!Query} The normalized query * @private */ SyncTree.queryForListening_ = function (query) { if (query.getQueryParams().loadsAllData() && !query.getQueryParams().isDefault()) { // We treat queries that load all data as default queries // Cast is necessary because ref() technically returns Firebase which is actually fb.api.Firebase which inherits // from Query return /** @type {!Query} */ query.getRef(); } else { return query; } }; /** * For a given new listen, manage the de-duplication of outstanding subscriptions. * * @param {!Query} query * @param {!View} view * @return {!Array.} This method can return events to support synchronous data sources * @private */ SyncTree.prototype.setupListener_ = function (query, view) { var path = query.path; var tag = this.tagForQuery_(query); var listener = this.createListenerForView_(view); var events = this.listenProvider_.startListening(SyncTree.queryForListening_(query), tag, listener.hashFn, listener.onComplete); var subtree = this.syncPointTree_.subtree(path); // The root of this subtree has our query. We're here because we definitely need to send a listen for that, but we // may need to shadow other listens as well. if (tag) { util.assert(!subtree.value.hasCompleteView(), "If we're adding a query, it shouldn't be shadowed"); } else { // Shadow everything at or below this location, this is a default listener. var queriesToStop = subtree.fold(function (relativePath, maybeChildSyncPoint, childMap) { if (!relativePath.isEmpty() && maybeChildSyncPoint && maybeChildSyncPoint.hasCompleteView()) { return [maybeChildSyncPoint.getCompleteView().getQuery()]; } else { // No default listener here, flatten any deeper queries into an array var queries_1 = []; if (maybeChildSyncPoint) { queries_1 = queries_1.concat(maybeChildSyncPoint.getQueryViews().map(function (view) { return view.getQuery(); })); } util.forEach(childMap, function (key, childQueries) { queries_1 = queries_1.concat(childQueries); }); return queries_1; } }); for (var i = 0; i < queriesToStop.length; ++i) { var queryToStop = queriesToStop[i]; this.listenProvider_.stopListening(SyncTree.queryForListening_(queryToStop), this.tagForQuery_(queryToStop)); } } return events; }; /** * * @param {!View} view * @return {{hashFn: function(), onComplete: function(!string, *)}} * @private */ SyncTree.prototype.createListenerForView_ = function (view) { var _this = this; var query = view.getQuery(); var tag = this.tagForQuery_(query); return { hashFn: function () { var cache = view.getServerCache() || ChildrenNode.EMPTY_NODE; return cache.hash(); }, onComplete: function (status) { if (status === 'ok') { if (tag) { return _this.applyTaggedListenComplete(query.path, tag); } else { return _this.applyListenComplete(query.path); } } else { // If a listen failed, kill all of the listeners here, not just the one that triggered the error. // Note that this may need to be scoped to just this listener if we change permissions on filtered children var error$$1 = errorForServerCode(status, query); return _this.removeEventRegistration(query, /*eventRegistration*/ null, error$$1); } } }; }; /** * Given a query, computes a "queryKey" suitable for use in our queryToTagMap_. * @private * @param {!Query} query * @return {string} */ SyncTree.makeQueryKey_ = function (query) { return query.path.toString() + '$' + query.queryIdentifier(); }; /** * Given a queryKey (created by makeQueryKey), parse it back into a path and queryId. * @private * @param {!string} queryKey * @return {{queryId: !string, path: !Path}} */ SyncTree.parseQueryKey_ = function (queryKey) { var splitIndex = queryKey.indexOf('$'); util.assert(splitIndex !== -1 && splitIndex < queryKey.length - 1, 'Bad queryKey.'); return { queryId: queryKey.substr(splitIndex + 1), path: new Path(queryKey.substr(0, splitIndex)) }; }; /** * Return the query associated with the given tag, if we have one * @param {!number} tag * @return {?string} * @private */ SyncTree.prototype.queryKeyForTag_ = function (tag) { return this.tagToQueryMap_['_' + tag]; }; /** * Return the tag associated with the given query. * @param {!Query} query * @return {?number} * @private */ SyncTree.prototype.tagForQuery_ = function (query) { var queryKey = SyncTree.makeQueryKey_(query); return util.safeGet(this.queryToTagMap_, queryKey); }; /** * Static accessor for query tags. * @return {number} * @private */ SyncTree.getNextQueryTag_ = function () { return SyncTree.nextQueryTag_++; }; /** * A helper method to apply tagged operations * * @param {!Path} queryPath * @param {!Operation} operation * @return {!Array.} * @private */ SyncTree.prototype.applyTaggedOperation_ = function (queryPath, operation) { var syncPoint = this.syncPointTree_.get(queryPath); util.assert(syncPoint, "Missing sync point for query tag that we're tracking"); var writesCache = this.pendingWriteTree_.childWrites(queryPath); return syncPoint.applyOperation(operation, writesCache, /*serverCache=*/ null); }; /** * A helper method that visits all descendant and ancestor SyncPoints, applying the operation. * * NOTES: * - Descendant SyncPoints will be visited first (since we raise events depth-first). * - We call applyOperation() on each SyncPoint passing three things: * 1. A version of the Operation that has been made relative to the SyncPoint location. * 2. A WriteTreeRef of any writes we have cached at the SyncPoint location. * 3. A snapshot Node with cached server data, if we have it. * - We concatenate all of the events returned by each SyncPoint and return the result. * * @param {!Operation} operation * @return {!Array.} * @private */ SyncTree.prototype.applyOperationToSyncPoints_ = function (operation) { return this.applyOperationHelper_(operation, this.syncPointTree_, /*serverCache=*/ null, this.pendingWriteTree_.childWrites(Path.Empty)); }; /** * Recursive helper for applyOperationToSyncPoints_ * * @private * @param {!Operation} operation * @param {ImmutableTree.} syncPointTree * @param {?Node} serverCache * @param {!WriteTreeRef} writesCache * @return {!Array.} */ SyncTree.prototype.applyOperationHelper_ = function (operation, syncPointTree, serverCache, writesCache) { if (operation.path.isEmpty()) { return this.applyOperationDescendantsHelper_(operation, syncPointTree, serverCache, writesCache); } else { var syncPoint = syncPointTree.get(Path.Empty); // If we don't have cached server data, see if we can get it from this SyncPoint. if (serverCache == null && syncPoint != null) { serverCache = syncPoint.getCompleteServerCache(Path.Empty); } var events = []; var childName = operation.path.getFront(); var childOperation = operation.operationForChild(childName); var childTree = syncPointTree.children.get(childName); if (childTree && childOperation) { var childServerCache = serverCache ? serverCache.getImmediateChild(childName) : null; var childWritesCache = writesCache.child(childName); events = events.concat(this.applyOperationHelper_(childOperation, childTree, childServerCache, childWritesCache)); } if (syncPoint) { events = events.concat(syncPoint.applyOperation(operation, writesCache, serverCache)); } return events; } }; /** * Recursive helper for applyOperationToSyncPoints_ * * @private * @param {!Operation} operation * @param {ImmutableTree.} syncPointTree * @param {?Node} serverCache * @param {!WriteTreeRef} writesCache * @return {!Array.} */ SyncTree.prototype.applyOperationDescendantsHelper_ = function (operation, syncPointTree, serverCache, writesCache) { var _this = this; var syncPoint = syncPointTree.get(Path.Empty); // If we don't have cached server data, see if we can get it from this SyncPoint. if (serverCache == null && syncPoint != null) { serverCache = syncPoint.getCompleteServerCache(Path.Empty); } var events = []; syncPointTree.children.inorderTraversal(function (childName, childTree) { var childServerCache = serverCache ? serverCache.getImmediateChild(childName) : null; var childWritesCache = writesCache.child(childName); var childOperation = operation.operationForChild(childName); if (childOperation) { events = events.concat(_this.applyOperationDescendantsHelper_(childOperation, childTree, childServerCache, childWritesCache)); } }); if (syncPoint) { events = events.concat(syncPoint.applyOperation(operation, writesCache, serverCache)); } return events; }; /** * Static tracker for next query tag. * @type {number} * @private */ SyncTree.nextQueryTag_ = 1; return SyncTree; }()); /** * Copyright 2017 Google Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ /** * Mutable object which basically just stores a reference to the "latest" immutable snapshot. * * @constructor */ var SnapshotHolder = /** @class */ (function () { function SnapshotHolder() { this.rootNode_ = ChildrenNode.EMPTY_NODE; } SnapshotHolder.prototype.getNode = function (path) { return this.rootNode_.getChild(path); }; SnapshotHolder.prototype.updateSnapshot = function (path, newSnapshotNode) { this.rootNode_ = this.rootNode_.updateChild(path, newSnapshotNode); }; return SnapshotHolder; }()); /** * Copyright 2017 Google Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ /** * Abstraction around FirebaseApp's token fetching capabilities. */ var AuthTokenProvider = /** @class */ (function () { /** * @param {!FirebaseApp} app_ */ function AuthTokenProvider(app_) { this.app_ = app_; } /** * @param {boolean} forceRefresh * @return {!Promise} */ AuthTokenProvider.prototype.getToken = function (forceRefresh) { return this.app_['INTERNAL']['getToken'](forceRefresh).then(null, // .catch function (error$$1) { // TODO: Need to figure out all the cases this is raised and whether // this makes sense. if (error$$1 && error$$1.code === 'auth/token-not-initialized') { log('Got auth/token-not-initialized error. Treating as null token.'); return null; } else { return Promise.reject(error$$1); } }); }; AuthTokenProvider.prototype.addTokenChangeListener = function (listener) { // TODO: We might want to wrap the listener and call it with no args to // avoid a leaky abstraction, but that makes removing the listener harder. this.app_['INTERNAL']['addAuthTokenListener'](listener); }; AuthTokenProvider.prototype.removeTokenChangeListener = function (listener) { this.app_['INTERNAL']['removeAuthTokenListener'](listener); }; AuthTokenProvider.prototype.notifyForInvalidToken = function () { var errorMessage = 'Provided authentication credentials for the app named "' + this.app_.name + '" are invalid. This usually indicates your app was not ' + 'initialized correctly. '; if ('credential' in this.app_.options) { errorMessage += 'Make sure the "credential" property provided to initializeApp() ' + 'is authorized to access the specified "databaseURL" and is from the correct ' + 'project.'; } else if ('serviceAccount' in this.app_.options) { errorMessage += 'Make sure the "serviceAccount" property provided to initializeApp() ' + 'is authorized to access the specified "databaseURL" and is from the correct ' + 'project.'; } else { errorMessage += 'Make sure the "apiKey" and "databaseURL" properties provided to ' + 'initializeApp() match the values provided for your app at ' + 'https://console.firebase.google.com/.'; } warn(errorMessage); }; return AuthTokenProvider; }()); /** * Copyright 2017 Google Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ /** * Tracks a collection of stats. * * @constructor */ var StatsCollection = /** @class */ (function () { function StatsCollection() { this.counters_ = {}; } StatsCollection.prototype.incrementCounter = function (name, amount) { if (amount === void 0) { amount = 1; } if (!util.contains(this.counters_, name)) this.counters_[name] = 0; this.counters_[name] += amount; }; StatsCollection.prototype.get = function () { return util.deepCopy(this.counters_); }; return StatsCollection; }()); /** * Copyright 2017 Google Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ var StatsManager = /** @class */ (function () { function StatsManager() { } StatsManager.getCollection = function (repoInfo) { var hashString = repoInfo.toString(); if (!this.collections_[hashString]) { this.collections_[hashString] = new StatsCollection(); } return this.collections_[hashString]; }; StatsManager.getOrCreateReporter = function (repoInfo, creatorFunction) { var hashString = repoInfo.toString(); if (!this.reporters_[hashString]) { this.reporters_[hashString] = creatorFunction(); } return this.reporters_[hashString]; }; StatsManager.collections_ = {}; StatsManager.reporters_ = {}; return StatsManager; }()); /** * Copyright 2017 Google Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ /** * Returns the delta from the previous call to get stats. * * @param collection_ The collection to "listen" to. * @constructor */ var StatsListener = /** @class */ (function () { function StatsListener(collection_) { this.collection_ = collection_; this.last_ = null; } StatsListener.prototype.get = function () { var newStats = this.collection_.get(); var delta = util.clone(newStats); if (this.last_) { util.forEach(this.last_, function (stat, value) { delta[stat] = delta[stat] - value; }); } this.last_ = newStats; return delta; }; return StatsListener; }()); /** * Copyright 2017 Google Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ // Assuming some apps may have a short amount of time on page, and a bulk of firebase operations probably // happen on page load, we try to report our first set of stats pretty quickly, but we wait at least 10 // seconds to try to ensure the Firebase connection is established / settled. var FIRST_STATS_MIN_TIME = 10 * 1000; var FIRST_STATS_MAX_TIME = 30 * 1000; // We'll continue to report stats on average every 5 minutes. var REPORT_STATS_INTERVAL = 5 * 60 * 1000; /** * @constructor */ var StatsReporter = /** @class */ (function () { /** * @param collection * @param server_ */ function StatsReporter(collection, server_) { this.server_ = server_; this.statsToReport_ = {}; this.statsListener_ = new StatsListener(collection); var timeout = FIRST_STATS_MIN_TIME + (FIRST_STATS_MAX_TIME - FIRST_STATS_MIN_TIME) * Math.random(); setTimeoutNonBlocking(this.reportStats_.bind(this), Math.floor(timeout)); } StatsReporter.prototype.includeStat = function (stat) { this.statsToReport_[stat] = true; }; StatsReporter.prototype.reportStats_ = function () { var _this = this; var stats = this.statsListener_.get(); var reportedStats = {}; var haveStatsToReport = false; util.forEach(stats, function (stat, value) { if (value > 0 && util.contains(_this.statsToReport_, stat)) { reportedStats[stat] = value; haveStatsToReport = true; } }); if (haveStatsToReport) { this.server_.reportStats(reportedStats); } // queue our next run. setTimeoutNonBlocking(this.reportStats_.bind(this), Math.floor(Math.random() * 2 * REPORT_STATS_INTERVAL)); }; return StatsReporter; }()); /** * Copyright 2017 Google Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ /** * The event queue serves a few purposes: * 1. It ensures we maintain event order in the face of event callbacks doing operations that result in more * events being queued. * 2. raiseQueuedEvents() handles being called reentrantly nicely. That is, if in the course of raising events, * raiseQueuedEvents() is called again, the "inner" call will pick up raising events where the "outer" call * left off, ensuring that the events are still raised synchronously and in order. * 3. You can use raiseEventsAtPath and raiseEventsForChangedPath to ensure only relevant previously-queued * events are raised synchronously. * * NOTE: This can all go away if/when we move to async events. * * @constructor */ var EventQueue = /** @class */ (function () { function EventQueue() { /** * @private * @type {!Array.} */ this.eventLists_ = []; /** * Tracks recursion depth of raiseQueuedEvents_, for debugging purposes. * @private * @type {!number} */ this.recursionDepth_ = 0; } /** * @param {!Array.} eventDataList The new events to queue. */ EventQueue.prototype.queueEvents = function (eventDataList) { // We group events by path, storing them in a single EventList, to make it easier to skip over them quickly. var currList = null; for (var i = 0; i < eventDataList.length; i++) { var eventData = eventDataList[i]; var eventPath = eventData.getPath(); if (currList !== null && !eventPath.equals(currList.getPath())) { this.eventLists_.push(currList); currList = null; } if (currList === null) { currList = new EventList(eventPath); } currList.add(eventData); } if (currList) { this.eventLists_.push(currList); } }; /** * Queues the specified events and synchronously raises all events (including previously queued ones) * for the specified path. * * It is assumed that the new events are all for the specified path. * * @param {!Path} path The path to raise events for. * @param {!Array.} eventDataList The new events to raise. */ EventQueue.prototype.raiseEventsAtPath = function (path, eventDataList) { this.queueEvents(eventDataList); this.raiseQueuedEventsMatchingPredicate_(function (eventPath) { return eventPath.equals(path); }); }; /** * Queues the specified events and synchronously raises all events (including previously queued ones) for * locations related to the specified change path (i.e. all ancestors and descendants). * * It is assumed that the new events are all related (ancestor or descendant) to the specified path. * * @param {!Path} changedPath The path to raise events for. * @param {!Array.} eventDataList The events to raise */ EventQueue.prototype.raiseEventsForChangedPath = function (changedPath, eventDataList) { this.queueEvents(eventDataList); this.raiseQueuedEventsMatchingPredicate_(function (eventPath) { return eventPath.contains(changedPath) || changedPath.contains(eventPath); }); }; /** * @param {!function(!Path):boolean} predicate * @private */ EventQueue.prototype.raiseQueuedEventsMatchingPredicate_ = function (predicate) { this.recursionDepth_++; var sentAll = true; for (var i = 0; i < this.eventLists_.length; i++) { var eventList = this.eventLists_[i]; if (eventList) { var eventPath = eventList.getPath(); if (predicate(eventPath)) { this.eventLists_[i].raise(); this.eventLists_[i] = null; } else { sentAll = false; } } } if (sentAll) { this.eventLists_ = []; } this.recursionDepth_--; }; return EventQueue; }()); /** * @param {!Path} path * @constructor */ var EventList = /** @class */ (function () { function EventList(path_) { this.path_ = path_; /** * @type {!Array.} * @private */ this.events_ = []; } /** * @param {!Event} eventData */ EventList.prototype.add = function (eventData) { this.events_.push(eventData); }; /** * Iterates through the list and raises each event */ EventList.prototype.raise = function () { for (var i = 0; i < this.events_.length; i++) { var eventData = this.events_[i]; if (eventData !== null) { this.events_[i] = null; var eventFn = eventData.getEventRunner(); if (logger$1) { log('event: ' + eventData.toString()); } exceptionGuard(eventFn); } } }; /** * @return {!Path} */ EventList.prototype.getPath = function () { return this.path_; }; return EventList; }()); /** * Copyright 2017 Google Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ /** * Base class to be used if you want to emit events. Call the constructor with * the set of allowed event names. */ var EventEmitter = /** @class */ (function () { /** * @param {!Array.} allowedEvents_ */ function EventEmitter(allowedEvents_) { this.allowedEvents_ = allowedEvents_; this.listeners_ = {}; util.assert(Array.isArray(allowedEvents_) && allowedEvents_.length > 0, 'Requires a non-empty array'); } /** * To be called by derived classes to trigger events. * @param {!string} eventType * @param {...*} var_args */ EventEmitter.prototype.trigger = function (eventType) { var var_args = []; for (var _i = 1; _i < arguments.length; _i++) { var_args[_i - 1] = arguments[_i]; } if (Array.isArray(this.listeners_[eventType])) { // Clone the list, since callbacks could add/remove listeners. var listeners = this.listeners_[eventType].slice(); for (var i = 0; i < listeners.length; i++) { listeners[i].callback.apply(listeners[i].context, var_args); } } }; EventEmitter.prototype.on = function (eventType, callback, context) { this.validateEventType_(eventType); this.listeners_[eventType] = this.listeners_[eventType] || []; this.listeners_[eventType].push({ callback: callback, context: context }); var eventData = this.getInitialEvent(eventType); if (eventData) { callback.apply(context, eventData); } }; EventEmitter.prototype.off = function (eventType, callback, context) { this.validateEventType_(eventType); var listeners = this.listeners_[eventType] || []; for (var i = 0; i < listeners.length; i++) { if (listeners[i].callback === callback && (!context || context === listeners[i].context)) { listeners.splice(i, 1); return; } } }; EventEmitter.prototype.validateEventType_ = function (eventType) { util.assert(this.allowedEvents_.find(function (et) { return et === eventType; }), 'Unknown event: ' + eventType); }; return EventEmitter; }()); /** * Copyright 2017 Google Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ /** * @extends {EventEmitter} */ var VisibilityMonitor = /** @class */ (function (_super) { tslib_1.__extends(VisibilityMonitor, _super); function VisibilityMonitor() { var _this = _super.call(this, ['visible']) || this; var hidden; var visibilityChange; if (typeof document !== 'undefined' && typeof document.addEventListener !== 'undefined') { if (typeof document['hidden'] !== 'undefined') { // Opera 12.10 and Firefox 18 and later support visibilityChange = 'visibilitychange'; hidden = 'hidden'; } else if (typeof document['mozHidden'] !== 'undefined') { visibilityChange = 'mozvisibilitychange'; hidden = 'mozHidden'; } else if (typeof document['msHidden'] !== 'undefined') { visibilityChange = 'msvisibilitychange'; hidden = 'msHidden'; } else if (typeof document['webkitHidden'] !== 'undefined') { visibilityChange = 'webkitvisibilitychange'; hidden = 'webkitHidden'; } } // Initially, we always assume we are visible. This ensures that in browsers // without page visibility support or in cases where we are never visible // (e.g. chrome extension), we act as if we are visible, i.e. don't delay // reconnects _this.visible_ = true; if (visibilityChange) { document.addEventListener(visibilityChange, function () { var visible = !document[hidden]; if (visible !== _this.visible_) { _this.visible_ = visible; _this.trigger('visible', visible); } }, false); } return _this; } VisibilityMonitor.getInstance = function () { return new VisibilityMonitor(); }; /** * @param {!string} eventType * @return {Array.} */ VisibilityMonitor.prototype.getInitialEvent = function (eventType) { util.assert(eventType === 'visible', 'Unknown event type: ' + eventType); return [this.visible_]; }; return VisibilityMonitor; }(EventEmitter)); /** * Copyright 2017 Google Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ /** * Monitors online state (as reported by window.online/offline events). * * The expectation is that this could have many false positives (thinks we are online * when we're not), but no false negatives. So we can safely use it to determine when * we definitely cannot reach the internet. * * @extends {EventEmitter} */ var OnlineMonitor = /** @class */ (function (_super) { tslib_1.__extends(OnlineMonitor, _super); function OnlineMonitor() { var _this = _super.call(this, ['online']) || this; _this.online_ = true; // We've had repeated complaints that Cordova apps can get stuck "offline", e.g. // https://forum.ionicframework.com/t/firebase-connection-is-lost-and-never-come-back/43810 // It would seem that the 'online' event does not always fire consistently. So we disable it // for Cordova. if (typeof window !== 'undefined' && typeof window.addEventListener !== 'undefined' && !util.isMobileCordova()) { window.addEventListener('online', function () { if (!_this.online_) { _this.online_ = true; _this.trigger('online', true); } }, false); window.addEventListener('offline', function () { if (_this.online_) { _this.online_ = false; _this.trigger('online', false); } }, false); } return _this; } OnlineMonitor.getInstance = function () { return new OnlineMonitor(); }; /** * @param {!string} eventType * @return {Array.} */ OnlineMonitor.prototype.getInitialEvent = function (eventType) { util.assert(eventType === 'online', 'Unknown event type: ' + eventType); return [this.online_]; }; /** * @return {boolean} */ OnlineMonitor.prototype.currentlyOnline = function () { return this.online_; }; return OnlineMonitor; }(EventEmitter)); /** * Copyright 2017 Google Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ /** * This class ensures the packets from the server arrive in order * This class takes data from the server and ensures it gets passed into the callbacks in order. * @constructor */ var PacketReceiver = /** @class */ (function () { /** * @param onMessage_ */ function PacketReceiver(onMessage_) { this.onMessage_ = onMessage_; this.pendingResponses = []; this.currentResponseNum = 0; this.closeAfterResponse = -1; this.onClose = null; } PacketReceiver.prototype.closeAfter = function (responseNum, callback) { this.closeAfterResponse = responseNum; this.onClose = callback; if (this.closeAfterResponse < this.currentResponseNum) { this.onClose(); this.onClose = null; } }; /** * Each message from the server comes with a response number, and an array of data. The responseNumber * allows us to ensure that we process them in the right order, since we can't be guaranteed that all * browsers will respond in the same order as the requests we sent * @param {number} requestNum * @param {Array} data */ PacketReceiver.prototype.handleResponse = function (requestNum, data) { var _this = this; this.pendingResponses[requestNum] = data; var _loop_1 = function () { var toProcess = this_1.pendingResponses[this_1.currentResponseNum]; delete this_1.pendingResponses[this_1.currentResponseNum]; var _loop_2 = function (i) { if (toProcess[i]) { exceptionGuard(function () { _this.onMessage_(toProcess[i]); }); } }; for (var i = 0; i < toProcess.length; ++i) { _loop_2(i); } if (this_1.currentResponseNum === this_1.closeAfterResponse) { if (this_1.onClose) { this_1.onClose(); this_1.onClose = null; } return "break"; } this_1.currentResponseNum++; }; var this_1 = this; while (this.pendingResponses[this.currentResponseNum]) { var state_1 = _loop_1(); if (state_1 === "break") break; } }; return PacketReceiver; }()); /** * Copyright 2017 Google Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ // URL query parameters associated with longpolling var FIREBASE_LONGPOLL_START_PARAM = 'start'; var FIREBASE_LONGPOLL_CLOSE_COMMAND = 'close'; var FIREBASE_LONGPOLL_COMMAND_CB_NAME = 'pLPCommand'; var FIREBASE_LONGPOLL_DATA_CB_NAME = 'pRTLPCB'; var FIREBASE_LONGPOLL_ID_PARAM = 'id'; var FIREBASE_LONGPOLL_PW_PARAM = 'pw'; var FIREBASE_LONGPOLL_SERIAL_PARAM = 'ser'; var FIREBASE_LONGPOLL_CALLBACK_ID_PARAM = 'cb'; var FIREBASE_LONGPOLL_SEGMENT_NUM_PARAM = 'seg'; var FIREBASE_LONGPOLL_SEGMENTS_IN_PACKET = 'ts'; var FIREBASE_LONGPOLL_DATA_PARAM = 'd'; var FIREBASE_LONGPOLL_DISCONN_FRAME_PARAM = 'disconn'; var FIREBASE_LONGPOLL_DISCONN_FRAME_REQUEST_PARAM = 'dframe'; //Data size constants. //TODO: Perf: the maximum length actually differs from browser to browser. // We should check what browser we're on and set accordingly. var MAX_URL_DATA_SIZE = 1870; var SEG_HEADER_SIZE = 30; //ie: &seg=8299234&ts=982389123&d= var MAX_PAYLOAD_SIZE = MAX_URL_DATA_SIZE - SEG_HEADER_SIZE; /** * Keepalive period * send a fresh request at minimum every 25 seconds. Opera has a maximum request * length of 30 seconds that we can't exceed. * @const * @type {number} */ var KEEPALIVE_REQUEST_INTERVAL = 25000; /** * How long to wait before aborting a long-polling connection attempt. * @const * @type {number} */ var LP_CONNECT_TIMEOUT = 30000; /** * This class manages a single long-polling connection. * * @constructor * @implements {Transport} */ var BrowserPollConnection = /** @class */ (function () { /** * @param {string} connId An identifier for this connection, used for logging * @param {RepoInfo} repoInfo The info for the endpoint to send data to. * @param {string=} transportSessionId Optional transportSessionid if we are reconnecting for an existing * transport session * @param {string=} lastSessionId Optional lastSessionId if the PersistentConnection has already created a * connection previously */ function BrowserPollConnection(connId, repoInfo, transportSessionId, lastSessionId) { this.connId = connId; this.repoInfo = repoInfo; this.transportSessionId = transportSessionId; this.lastSessionId = lastSessionId; this.bytesSent = 0; this.bytesReceived = 0; this.everConnected_ = false; this.log_ = logWrapper(connId); this.stats_ = StatsManager.getCollection(repoInfo); this.urlFn = function (params) { return repoInfo.connectionURL(LONG_POLLING, params); }; } /** * * @param {function(Object)} onMessage Callback when messages arrive * @param {function()} onDisconnect Callback with connection lost. */ BrowserPollConnection.prototype.open = function (onMessage, onDisconnect) { var _this = this; this.curSegmentNum = 0; this.onDisconnect_ = onDisconnect; this.myPacketOrderer = new PacketReceiver(onMessage); this.isClosed_ = false; this.connectTimeoutTimer_ = setTimeout(function () { _this.log_('Timed out trying to connect.'); // Make sure we clear the host cache _this.onClosed_(); _this.connectTimeoutTimer_ = null; }, Math.floor(LP_CONNECT_TIMEOUT)); // Ensure we delay the creation of the iframe until the DOM is loaded. executeWhenDOMReady(function () { if (_this.isClosed_) return; //Set up a callback that gets triggered once a connection is set up. _this.scriptTagHolder = new FirebaseIFrameScriptHolder(function () { var args = []; for (var _i = 0; _i < arguments.length; _i++) { args[_i] = arguments[_i]; } var command = args[0], arg1 = args[1], arg2 = args[2]; _this.incrementIncomingBytes_(args); if (!_this.scriptTagHolder) return; // we closed the connection. if (_this.connectTimeoutTimer_) { clearTimeout(_this.connectTimeoutTimer_); _this.connectTimeoutTimer_ = null; } _this.everConnected_ = true; if (command == FIREBASE_LONGPOLL_START_PARAM) { _this.id = arg1; _this.password = arg2; } else if (command === FIREBASE_LONGPOLL_CLOSE_COMMAND) { // Don't clear the host cache. We got a response from the server, so we know it's reachable if (arg1) { // We aren't expecting any more data (other than what the server's already in the process of sending us // through our already open polls), so don't send any more. _this.scriptTagHolder.sendNewPolls = false; // arg1 in this case is the last response number sent by the server. We should try to receive // all of the responses up to this one before closing _this.myPacketOrderer.closeAfter(arg1, function () { _this.onClosed_(); }); } else { _this.onClosed_(); } } else { throw new Error('Unrecognized command received: ' + command); } }, function () { var args = []; for (var _i = 0; _i < arguments.length; _i++) { args[_i] = arguments[_i]; } var pN = args[0], data = args[1]; _this.incrementIncomingBytes_(args); _this.myPacketOrderer.handleResponse(pN, data); }, function () { _this.onClosed_(); }, _this.urlFn); //Send the initial request to connect. The serial number is simply to keep the browser from pulling previous results //from cache. var urlParams = {}; urlParams[FIREBASE_LONGPOLL_START_PARAM] = 't'; urlParams[FIREBASE_LONGPOLL_SERIAL_PARAM] = Math.floor(Math.random() * 100000000); if (_this.scriptTagHolder.uniqueCallbackIdentifier) urlParams[FIREBASE_LONGPOLL_CALLBACK_ID_PARAM] = _this.scriptTagHolder.uniqueCallbackIdentifier; urlParams[VERSION_PARAM] = PROTOCOL_VERSION; if (_this.transportSessionId) { urlParams[TRANSPORT_SESSION_PARAM] = _this.transportSessionId; } if (_this.lastSessionId) { urlParams[LAST_SESSION_PARAM] = _this.lastSessionId; } if (!util.isNodeSdk() && typeof location !== 'undefined' && location.href && location.href.indexOf(FORGE_DOMAIN) !== -1) { urlParams[REFERER_PARAM] = FORGE_REF; } var connectURL = _this.urlFn(urlParams); _this.log_('Connecting via long-poll to ' + connectURL); _this.scriptTagHolder.addTag(connectURL, function () { /* do nothing */ }); }); }; /** * Call this when a handshake has completed successfully and we want to consider the connection established */ BrowserPollConnection.prototype.start = function () { this.scriptTagHolder.startLongPoll(this.id, this.password); this.addDisconnectPingFrame(this.id, this.password); }; /** * Forces long polling to be considered as a potential transport */ BrowserPollConnection.forceAllow = function () { BrowserPollConnection.forceAllow_ = true; }; /** * Forces longpolling to not be considered as a potential transport */ BrowserPollConnection.forceDisallow = function () { BrowserPollConnection.forceDisallow_ = true; }; // Static method, use string literal so it can be accessed in a generic way BrowserPollConnection.isAvailable = function () { // NOTE: In React-Native there's normally no 'document', but if you debug a React-Native app in // the Chrome debugger, 'document' is defined, but document.createElement is null (2015/06/08). return (BrowserPollConnection.forceAllow_ || (!BrowserPollConnection.forceDisallow_ && typeof document !== 'undefined' && document.createElement != null && !isChromeExtensionContentScript() && !isWindowsStoreApp() && !util.isNodeSdk())); }; /** * No-op for polling */ BrowserPollConnection.prototype.markConnectionHealthy = function () { }; /** * Stops polling and cleans up the iframe * @private */ BrowserPollConnection.prototype.shutdown_ = function () { this.isClosed_ = true; if (this.scriptTagHolder) { this.scriptTagHolder.close(); this.scriptTagHolder = null; } //remove the disconnect frame, which will trigger an XHR call to the server to tell it we're leaving. if (this.myDisconnFrame) { document.body.removeChild(this.myDisconnFrame); this.myDisconnFrame = null; } if (this.connectTimeoutTimer_) { clearTimeout(this.connectTimeoutTimer_); this.connectTimeoutTimer_ = null; } }; /** * Triggered when this transport is closed * @private */ BrowserPollConnection.prototype.onClosed_ = function () { if (!this.isClosed_) { this.log_('Longpoll is closing itself'); this.shutdown_(); if (this.onDisconnect_) { this.onDisconnect_(this.everConnected_); this.onDisconnect_ = null; } } }; /** * External-facing close handler. RealTime has requested we shut down. Kill our connection and tell the server * that we've left. */ BrowserPollConnection.prototype.close = function () { if (!this.isClosed_) { this.log_('Longpoll is being closed.'); this.shutdown_(); } }; /** * Send the JSON object down to the server. It will need to be stringified, base64 encoded, and then * broken into chunks (since URLs have a small maximum length). * @param {!Object} data The JSON data to transmit. */ BrowserPollConnection.prototype.send = function (data) { var dataStr = util.stringify(data); this.bytesSent += dataStr.length; this.stats_.incrementCounter('bytes_sent', dataStr.length); //first, lets get the base64-encoded data var base64data = util.base64Encode(dataStr); //We can only fit a certain amount in each URL, so we need to split this request //up into multiple pieces if it doesn't fit in one request. var dataSegs = splitStringBySize(base64data, MAX_PAYLOAD_SIZE); //Enqueue each segment for transmission. We assign each chunk a sequential ID and a total number //of segments so that we can reassemble the packet on the server. for (var i = 0; i < dataSegs.length; i++) { this.scriptTagHolder.enqueueSegment(this.curSegmentNum, dataSegs.length, dataSegs[i]); this.curSegmentNum++; } }; /** * This is how we notify the server that we're leaving. * We aren't able to send requests with DHTML on a window close event, but we can * trigger XHR requests in some browsers (everything but Opera basically). * @param {!string} id * @param {!string} pw */ BrowserPollConnection.prototype.addDisconnectPingFrame = function (id, pw) { if (util.isNodeSdk()) return; this.myDisconnFrame = document.createElement('iframe'); var urlParams = {}; urlParams[FIREBASE_LONGPOLL_DISCONN_FRAME_REQUEST_PARAM] = 't'; urlParams[FIREBASE_LONGPOLL_ID_PARAM] = id; urlParams[FIREBASE_LONGPOLL_PW_PARAM] = pw; this.myDisconnFrame.src = this.urlFn(urlParams); this.myDisconnFrame.style.display = 'none'; document.body.appendChild(this.myDisconnFrame); }; /** * Used to track the bytes received by this client * @param {*} args * @private */ BrowserPollConnection.prototype.incrementIncomingBytes_ = function (args) { // TODO: This is an annoying perf hit just to track the number of incoming bytes. Maybe it should be opt-in. var bytesReceived = util.stringify(args).length; this.bytesReceived += bytesReceived; this.stats_.incrementCounter('bytes_received', bytesReceived); }; return BrowserPollConnection; }()); /********************************************************************************************* * A wrapper around an iframe that is used as a long-polling script holder. * @constructor *********************************************************************************************/ var FirebaseIFrameScriptHolder = /** @class */ (function () { /** * @param commandCB - The callback to be called when control commands are recevied from the server. * @param onMessageCB - The callback to be triggered when responses arrive from the server. * @param onDisconnect - The callback to be triggered when this tag holder is closed * @param urlFn - A function that provides the URL of the endpoint to send data to. */ function FirebaseIFrameScriptHolder(commandCB, onMessageCB, onDisconnect, urlFn) { this.onDisconnect = onDisconnect; this.urlFn = urlFn; //We maintain a count of all of the outstanding requests, because if we have too many active at once it can cause //problems in some browsers. /** * @type {CountedSet.} */ this.outstandingRequests = new CountedSet(); //A queue of the pending segments waiting for transmission to the server. this.pendingSegs = []; //A serial number. We use this for two things: // 1) A way to ensure the browser doesn't cache responses to polls // 2) A way to make the server aware when long-polls arrive in a different order than we started them. The // server needs to release both polls in this case or it will cause problems in Opera since Opera can only execute // JSONP code in the order it was added to the iframe. this.currentSerial = Math.floor(Math.random() * 100000000); // This gets set to false when we're "closing down" the connection (e.g. we're switching transports but there's still // incoming data from the server that we're waiting for). this.sendNewPolls = true; if (!util.isNodeSdk()) { //Each script holder registers a couple of uniquely named callbacks with the window. These are called from the //iframes where we put the long-polling script tags. We have two callbacks: // 1) Command Callback - Triggered for control issues, like starting a connection. // 2) Message Callback - Triggered when new data arrives. this.uniqueCallbackIdentifier = LUIDGenerator(); window[FIREBASE_LONGPOLL_COMMAND_CB_NAME + this.uniqueCallbackIdentifier] = commandCB; window[FIREBASE_LONGPOLL_DATA_CB_NAME + this.uniqueCallbackIdentifier] = onMessageCB; //Create an iframe for us to add script tags to. this.myIFrame = FirebaseIFrameScriptHolder.createIFrame_(); // Set the iframe's contents. var script = ''; // if we set a javascript url, it's IE and we need to set the document domain. The javascript url is sufficient // for ie9, but ie8 needs to do it again in the document itself. if (this.myIFrame.src && this.myIFrame.src.substr(0, 'javascript:'.length) === 'javascript:') { var currentDomain = document.domain; script = ''; } var iframeContents = '' + script + ''; try { this.myIFrame.doc.open(); this.myIFrame.doc.write(iframeContents); this.myIFrame.doc.close(); } catch (e) { log('frame writing exception'); if (e.stack) { log(e.stack); } log(e); } } else { this.commandCB = commandCB; this.onMessageCB = onMessageCB; } } /** * Each browser has its own funny way to handle iframes. Here we mush them all together into one object that I can * actually use. * @private * @return {Element} */ FirebaseIFrameScriptHolder.createIFrame_ = function () { var iframe = document.createElement('iframe'); iframe.style.display = 'none'; // This is necessary in order to initialize the document inside the iframe if (document.body) { document.body.appendChild(iframe); try { // If document.domain has been modified in IE, this will throw an error, and we need to set the // domain of the iframe's document manually. We can do this via a javascript: url as the src attribute // Also note that we must do this *after* the iframe has been appended to the page. Otherwise it doesn't work. var a = iframe.contentWindow.document; if (!a) { // Apologies for the log-spam, I need to do something to keep closure from optimizing out the assignment above. log('No IE domain setting required'); } } catch (e) { var domain = document.domain; iframe.src = "javascript:void((function(){document.open();document.domain='" + domain + "';document.close();})())"; } } else { // LongPollConnection attempts to delay initialization until the document is ready, so hopefully this // never gets hit. throw 'Document body has not initialized. Wait to initialize Firebase until after the document is ready.'; } // Get the document of the iframe in a browser-specific way. if (iframe.contentDocument) { iframe.doc = iframe.contentDocument; // Firefox, Opera, Safari } else if (iframe.contentWindow) { iframe.doc = iframe.contentWindow.document; // Internet Explorer } else if (iframe.document) { iframe.doc = iframe.document; //others? } return iframe; }; /** * Cancel all outstanding queries and remove the frame. */ FirebaseIFrameScriptHolder.prototype.close = function () { var _this = this; //Mark this iframe as dead, so no new requests are sent. this.alive = false; if (this.myIFrame) { //We have to actually remove all of the html inside this iframe before removing it from the //window, or IE will continue loading and executing the script tags we've already added, which //can lead to some errors being thrown. Setting innerHTML seems to be the easiest way to do this. this.myIFrame.doc.body.innerHTML = ''; setTimeout(function () { if (_this.myIFrame !== null) { document.body.removeChild(_this.myIFrame); _this.myIFrame = null; } }, Math.floor(0)); } if (util.isNodeSdk() && this.myID) { var urlParams = {}; urlParams[FIREBASE_LONGPOLL_DISCONN_FRAME_PARAM] = 't'; urlParams[FIREBASE_LONGPOLL_ID_PARAM] = this.myID; urlParams[FIREBASE_LONGPOLL_PW_PARAM] = this.myPW; var theURL = this.urlFn(urlParams); FirebaseIFrameScriptHolder.nodeRestRequest(theURL); } // Protect from being called recursively. var onDisconnect = this.onDisconnect; if (onDisconnect) { this.onDisconnect = null; onDisconnect(); } }; /** * Actually start the long-polling session by adding the first script tag(s) to the iframe. * @param {!string} id - The ID of this connection * @param {!string} pw - The password for this connection */ FirebaseIFrameScriptHolder.prototype.startLongPoll = function (id, pw) { this.myID = id; this.myPW = pw; this.alive = true; //send the initial request. If there are requests queued, make sure that we transmit as many as we are currently able to. while (this.newRequest_()) { } }; /** * This is called any time someone might want a script tag to be added. It adds a script tag when there aren't * too many outstanding requests and we are still alive. * * If there are outstanding packet segments to send, it sends one. If there aren't, it sends a long-poll anyways if * needed. */ FirebaseIFrameScriptHolder.prototype.newRequest_ = function () { // We keep one outstanding request open all the time to receive data, but if we need to send data // (pendingSegs.length > 0) then we create a new request to send the data. The server will automatically // close the old request. if (this.alive && this.sendNewPolls && this.outstandingRequests.count() < (this.pendingSegs.length > 0 ? 2 : 1)) { //construct our url this.currentSerial++; var urlParams = {}; urlParams[FIREBASE_LONGPOLL_ID_PARAM] = this.myID; urlParams[FIREBASE_LONGPOLL_PW_PARAM] = this.myPW; urlParams[FIREBASE_LONGPOLL_SERIAL_PARAM] = this.currentSerial; var theURL = this.urlFn(urlParams); //Now add as much data as we can. var curDataString = ''; var i = 0; while (this.pendingSegs.length > 0) { //first, lets see if the next segment will fit. var nextSeg = this.pendingSegs[0]; if (nextSeg.d.length + SEG_HEADER_SIZE + curDataString.length <= MAX_URL_DATA_SIZE) { //great, the segment will fit. Lets append it. var theSeg = this.pendingSegs.shift(); curDataString = curDataString + '&' + FIREBASE_LONGPOLL_SEGMENT_NUM_PARAM + i + '=' + theSeg.seg + '&' + FIREBASE_LONGPOLL_SEGMENTS_IN_PACKET + i + '=' + theSeg.ts + '&' + FIREBASE_LONGPOLL_DATA_PARAM + i + '=' + theSeg.d; i++; } else { break; } } theURL = theURL + curDataString; this.addLongPollTag_(theURL, this.currentSerial); return true; } else { return false; } }; /** * Queue a packet for transmission to the server. * @param segnum - A sequential id for this packet segment used for reassembly * @param totalsegs - The total number of segments in this packet * @param data - The data for this segment. */ FirebaseIFrameScriptHolder.prototype.enqueueSegment = function (segnum, totalsegs, data) { //add this to the queue of segments to send. this.pendingSegs.push({ seg: segnum, ts: totalsegs, d: data }); //send the data immediately if there isn't already data being transmitted, unless //startLongPoll hasn't been called yet. if (this.alive) { this.newRequest_(); } }; /** * Add a script tag for a regular long-poll request. * @param {!string} url - The URL of the script tag. * @param {!number} serial - The serial number of the request. * @private */ FirebaseIFrameScriptHolder.prototype.addLongPollTag_ = function (url, serial) { var _this = this; //remember that we sent this request. this.outstandingRequests.add(serial, 1); var doNewRequest = function () { _this.outstandingRequests.remove(serial); _this.newRequest_(); }; // If this request doesn't return on its own accord (by the server sending us some data), we'll // create a new one after the KEEPALIVE interval to make sure we always keep a fresh request open. var keepaliveTimeout = setTimeout(doNewRequest, Math.floor(KEEPALIVE_REQUEST_INTERVAL)); var readyStateCB = function () { // Request completed. Cancel the keepalive. clearTimeout(keepaliveTimeout); // Trigger a new request so we can continue receiving data. doNewRequest(); }; this.addTag(url, readyStateCB); }; /** * Add an arbitrary script tag to the iframe. * @param {!string} url - The URL for the script tag source. * @param {!function()} loadCB - A callback to be triggered once the script has loaded. */ FirebaseIFrameScriptHolder.prototype.addTag = function (url, loadCB) { var _this = this; if (util.isNodeSdk()) { this.doNodeLongPoll(url, loadCB); } else { setTimeout(function () { try { // if we're already closed, don't add this poll if (!_this.sendNewPolls) return; var newScript_1 = _this.myIFrame.doc.createElement('script'); newScript_1.type = 'text/javascript'; newScript_1.async = true; newScript_1.src = url; newScript_1.onload = newScript_1.onreadystatechange = function () { var rstate = newScript_1.readyState; if (!rstate || rstate === 'loaded' || rstate === 'complete') { newScript_1.onload = newScript_1.onreadystatechange = null; if (newScript_1.parentNode) { newScript_1.parentNode.removeChild(newScript_1); } loadCB(); } }; newScript_1.onerror = function () { log('Long-poll script failed to load: ' + url); _this.sendNewPolls = false; _this.close(); }; _this.myIFrame.doc.body.appendChild(newScript_1); } catch (e) { // TODO: we should make this error visible somehow } }, Math.floor(1)); } }; return FirebaseIFrameScriptHolder; }()); /** * Copyright 2017 Google Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ var WEBSOCKET_MAX_FRAME_SIZE = 16384; var WEBSOCKET_KEEPALIVE_INTERVAL = 45000; var WebSocketImpl = null; if (typeof MozWebSocket !== 'undefined') { WebSocketImpl = MozWebSocket; } else if (typeof WebSocket !== 'undefined') { WebSocketImpl = WebSocket; } /** * Create a new websocket connection with the given callbacks. * @constructor * @implements {Transport} */ var WebSocketConnection = /** @class */ (function () { /** * @param {string} connId identifier for this transport * @param {RepoInfo} repoInfo The info for the websocket endpoint. * @param {string=} transportSessionId Optional transportSessionId if this is connecting to an existing transport * session * @param {string=} lastSessionId Optional lastSessionId if there was a previous connection */ function WebSocketConnection(connId, repoInfo, transportSessionId, lastSessionId) { this.connId = connId; this.keepaliveTimer = null; this.frames = null; this.totalFrames = 0; this.bytesSent = 0; this.bytesReceived = 0; this.log_ = logWrapper(this.connId); this.stats_ = StatsManager.getCollection(repoInfo); this.connURL = WebSocketConnection.connectionURL_(repoInfo, transportSessionId, lastSessionId); } /** * @param {RepoInfo} repoInfo The info for the websocket endpoint. * @param {string=} transportSessionId Optional transportSessionId if this is connecting to an existing transport * session * @param {string=} lastSessionId Optional lastSessionId if there was a previous connection * @return {string} connection url * @private */ WebSocketConnection.connectionURL_ = function (repoInfo, transportSessionId, lastSessionId) { var urlParams = {}; urlParams[VERSION_PARAM] = PROTOCOL_VERSION; if (!util.isNodeSdk() && typeof location !== 'undefined' && location.href && location.href.indexOf(FORGE_DOMAIN) !== -1) { urlParams[REFERER_PARAM] = FORGE_REF; } if (transportSessionId) { urlParams[TRANSPORT_SESSION_PARAM] = transportSessionId; } if (lastSessionId) { urlParams[LAST_SESSION_PARAM] = lastSessionId; } return repoInfo.connectionURL(WEBSOCKET, urlParams); }; /** * * @param onMessage Callback when messages arrive * @param onDisconnect Callback with connection lost. */ WebSocketConnection.prototype.open = function (onMessage, onDisconnect) { var _this = this; this.onDisconnect = onDisconnect; this.onMessage = onMessage; this.log_('Websocket connecting to ' + this.connURL); this.everConnected_ = false; // Assume failure until proven otherwise. PersistentStorage.set('previous_websocket_failure', true); try { if (util.isNodeSdk()) { var device = util.CONSTANTS.NODE_ADMIN ? 'AdminNode' : 'Node'; // UA Format: Firebase//// var options = { headers: { 'User-Agent': "Firebase/" + PROTOCOL_VERSION + "/" + firebase.SDK_VERSION + "/" + process.platform + "/" + device } }; // Plumb appropriate http_proxy environment variable into faye-websocket if it exists. var env = process['env']; var proxy = this.connURL.indexOf('wss://') == 0 ? env['HTTPS_PROXY'] || env['https_proxy'] : env['HTTP_PROXY'] || env['http_proxy']; if (proxy) { options['proxy'] = { origin: proxy }; } this.mySock = new WebSocketImpl(this.connURL, [], options); } else { this.mySock = new WebSocketImpl(this.connURL); } } catch (e) { this.log_('Error instantiating WebSocket.'); var error$$1 = e.message || e.data; if (error$$1) { this.log_(error$$1); } this.onClosed_(); return; } this.mySock.onopen = function () { _this.log_('Websocket connected.'); _this.everConnected_ = true; }; this.mySock.onclose = function () { _this.log_('Websocket connection was disconnected.'); _this.mySock = null; _this.onClosed_(); }; this.mySock.onmessage = function (m) { _this.handleIncomingFrame(m); }; this.mySock.onerror = function (e) { _this.log_('WebSocket error. Closing connection.'); var error$$1 = e.message || e.data; if (error$$1) { _this.log_(error$$1); } _this.onClosed_(); }; }; /** * No-op for websockets, we don't need to do anything once the connection is confirmed as open */ WebSocketConnection.prototype.start = function () { }; WebSocketConnection.forceDisallow = function () { WebSocketConnection.forceDisallow_ = true; }; WebSocketConnection.isAvailable = function () { var isOldAndroid = false; if (typeof navigator !== 'undefined' && navigator.userAgent) { var oldAndroidRegex = /Android ([0-9]{0,}\.[0-9]{0,})/; var oldAndroidMatch = navigator.userAgent.match(oldAndroidRegex); if (oldAndroidMatch && oldAndroidMatch.length > 1) { if (parseFloat(oldAndroidMatch[1]) < 4.4) { isOldAndroid = true; } } } return (!isOldAndroid && WebSocketImpl !== null && !WebSocketConnection.forceDisallow_); }; /** * Returns true if we previously failed to connect with this transport. * @return {boolean} */ WebSocketConnection.previouslyFailed = function () { // If our persistent storage is actually only in-memory storage, // we default to assuming that it previously failed to be safe. return (PersistentStorage.isInMemoryStorage || PersistentStorage.get('previous_websocket_failure') === true); }; WebSocketConnection.prototype.markConnectionHealthy = function () { PersistentStorage.remove('previous_websocket_failure'); }; WebSocketConnection.prototype.appendFrame_ = function (data) { this.frames.push(data); if (this.frames.length == this.totalFrames) { var fullMess = this.frames.join(''); this.frames = null; var jsonMess = util.jsonEval(fullMess); //handle the message this.onMessage(jsonMess); } }; /** * @param {number} frameCount The number of frames we are expecting from the server * @private */ WebSocketConnection.prototype.handleNewFrameCount_ = function (frameCount) { this.totalFrames = frameCount; this.frames = []; }; /** * Attempts to parse a frame count out of some text. If it can't, assumes a value of 1 * @param {!String} data * @return {?String} Any remaining data to be process, or null if there is none * @private */ WebSocketConnection.prototype.extractFrameCount_ = function (data) { util.assert(this.frames === null, 'We already have a frame buffer'); // TODO: The server is only supposed to send up to 9999 frames (i.e. length <= 4), but that isn't being enforced // currently. So allowing larger frame counts (length <= 6). See https://app.asana.com/0/search/8688598998380/8237608042508 if (data.length <= 6) { var frameCount = Number(data); if (!isNaN(frameCount)) { this.handleNewFrameCount_(frameCount); return null; } } this.handleNewFrameCount_(1); return data; }; /** * Process a websocket frame that has arrived from the server. * @param mess The frame data */ WebSocketConnection.prototype.handleIncomingFrame = function (mess) { if (this.mySock === null) return; // Chrome apparently delivers incoming packets even after we .close() the connection sometimes. var data = mess['data']; this.bytesReceived += data.length; this.stats_.incrementCounter('bytes_received', data.length); this.resetKeepAlive(); if (this.frames !== null) { // we're buffering this.appendFrame_(data); } else { // try to parse out a frame count, otherwise, assume 1 and process it var remainingData = this.extractFrameCount_(data); if (remainingData !== null) { this.appendFrame_(remainingData); } } }; /** * Send a message to the server * @param {Object} data The JSON object to transmit */ WebSocketConnection.prototype.send = function (data) { this.resetKeepAlive(); var dataStr = util.stringify(data); this.bytesSent += dataStr.length; this.stats_.incrementCounter('bytes_sent', dataStr.length); //We can only fit a certain amount in each websocket frame, so we need to split this request //up into multiple pieces if it doesn't fit in one request. var dataSegs = splitStringBySize(dataStr, WEBSOCKET_MAX_FRAME_SIZE); //Send the length header if (dataSegs.length > 1) { this.sendString_(String(dataSegs.length)); } //Send the actual data in segments. for (var i = 0; i < dataSegs.length; i++) { this.sendString_(dataSegs[i]); } }; WebSocketConnection.prototype.shutdown_ = function () { this.isClosed_ = true; if (this.keepaliveTimer) { clearInterval(this.keepaliveTimer); this.keepaliveTimer = null; } if (this.mySock) { this.mySock.close(); this.mySock = null; } }; WebSocketConnection.prototype.onClosed_ = function () { if (!this.isClosed_) { this.log_('WebSocket is closing itself'); this.shutdown_(); // since this is an internal close, trigger the close listener if (this.onDisconnect) { this.onDisconnect(this.everConnected_); this.onDisconnect = null; } } }; /** * External-facing close handler. * Close the websocket and kill the connection. */ WebSocketConnection.prototype.close = function () { if (!this.isClosed_) { this.log_('WebSocket is being closed'); this.shutdown_(); } }; /** * Kill the current keepalive timer and start a new one, to ensure that it always fires N seconds after * the last activity. */ WebSocketConnection.prototype.resetKeepAlive = function () { var _this = this; clearInterval(this.keepaliveTimer); this.keepaliveTimer = setInterval(function () { //If there has been no websocket activity for a while, send a no-op if (_this.mySock) { _this.sendString_('0'); } _this.resetKeepAlive(); }, Math.floor(WEBSOCKET_KEEPALIVE_INTERVAL)); }; /** * Send a string over the websocket. * * @param {string} str String to send. * @private */ WebSocketConnection.prototype.sendString_ = function (str) { // Firefox seems to sometimes throw exceptions (NS_ERROR_UNEXPECTED) from websocket .send() // calls for some unknown reason. We treat these as an error and disconnect. // See https://app.asana.com/0/58926111402292/68021340250410 try { this.mySock.send(str); } catch (e) { this.log_('Exception thrown from WebSocket.send():', e.message || e.data, 'Closing connection.'); setTimeout(this.onClosed_.bind(this), 0); } }; /** * Number of response before we consider the connection "healthy." * @type {number} */ WebSocketConnection.responsesRequiredToBeHealthy = 2; /** * Time to wait for the connection te become healthy before giving up. * @type {number} */ WebSocketConnection.healthyTimeout = 30000; return WebSocketConnection; }()); /** * Copyright 2017 Google Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ /** * Currently simplistic, this class manages what transport a Connection should use at various stages of its * lifecycle. * * It starts with longpolling in a browser, and httppolling on node. It then upgrades to websockets if * they are available. * @constructor */ var TransportManager = /** @class */ (function () { /** * @param {!RepoInfo} repoInfo Metadata around the namespace we're connecting to */ function TransportManager(repoInfo) { this.initTransports_(repoInfo); } Object.defineProperty(TransportManager, "ALL_TRANSPORTS", { /** * @const * @type {!Array.} */ get: function () { return [BrowserPollConnection, WebSocketConnection]; }, enumerable: true, configurable: true }); /** * @param {!RepoInfo} repoInfo * @private */ TransportManager.prototype.initTransports_ = function (repoInfo) { var isWebSocketsAvailable = WebSocketConnection && WebSocketConnection['isAvailable'](); var isSkipPollConnection = isWebSocketsAvailable && !WebSocketConnection.previouslyFailed(); if (repoInfo.webSocketOnly) { if (!isWebSocketsAvailable) warn("wss:// URL used, but browser isn't known to support websockets. Trying anyway."); isSkipPollConnection = true; } if (isSkipPollConnection) { this.transports_ = [WebSocketConnection]; } else { var transports_1 = (this.transports_ = []); each(TransportManager.ALL_TRANSPORTS, function (i, transport) { if (transport && transport['isAvailable']()) { transports_1.push(transport); } }); } }; /** * @return {function(new:Transport, !string, !RepoInfo, string=, string=)} The constructor for the * initial transport to use */ TransportManager.prototype.initialTransport = function () { if (this.transports_.length > 0) { return this.transports_[0]; } else { throw new Error('No transports available'); } }; /** * @return {?function(new:Transport, function(),function(), string=)} The constructor for the next * transport, or null */ TransportManager.prototype.upgradeTransport = function () { if (this.transports_.length > 1) { return this.transports_[1]; } else { return null; } }; return TransportManager; }()); /** * Copyright 2017 Google Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ // Abort upgrade attempt if it takes longer than 60s. var UPGRADE_TIMEOUT = 60000; // For some transports (WebSockets), we need to "validate" the transport by exchanging a few requests and responses. // If we haven't sent enough requests within 5s, we'll start sending noop ping requests. var DELAY_BEFORE_SENDING_EXTRA_REQUESTS = 5000; // If the initial data sent triggers a lot of bandwidth (i.e. it's a large put or a listen for a large amount of data) // then we may not be able to exchange our ping/pong requests within the healthy timeout. So if we reach the timeout // but we've sent/received enough bytes, we don't cancel the connection. var BYTES_SENT_HEALTHY_OVERRIDE = 10 * 1024; var BYTES_RECEIVED_HEALTHY_OVERRIDE = 100 * 1024; var MESSAGE_TYPE = 't'; var MESSAGE_DATA = 'd'; var CONTROL_SHUTDOWN = 's'; var CONTROL_RESET = 'r'; var CONTROL_ERROR = 'e'; var CONTROL_PONG = 'o'; var SWITCH_ACK = 'a'; var END_TRANSMISSION = 'n'; var PING = 'p'; var SERVER_HELLO = 'h'; /** * Creates a new real-time connection to the server using whichever method works * best in the current browser. * * @constructor */ var Connection = /** @class */ (function () { /** * @param {!string} id - an id for this connection * @param {!RepoInfo} repoInfo_ - the info for the endpoint to connect to * @param {function(Object)} onMessage_ - the callback to be triggered when a server-push message arrives * @param {function(number, string)} onReady_ - the callback to be triggered when this connection is ready to send messages. * @param {function()} onDisconnect_ - the callback to be triggered when a connection was lost * @param {function(string)} onKill_ - the callback to be triggered when this connection has permanently shut down. * @param {string=} lastSessionId - last session id in persistent connection. is used to clean up old session in real-time server */ function Connection(id, repoInfo_, onMessage_, onReady_, onDisconnect_, onKill_, lastSessionId) { this.id = id; this.repoInfo_ = repoInfo_; this.onMessage_ = onMessage_; this.onReady_ = onReady_; this.onDisconnect_ = onDisconnect_; this.onKill_ = onKill_; this.lastSessionId = lastSessionId; this.connectionCount = 0; this.pendingDataMessages = []; this.state_ = 0 /* CONNECTING */; this.log_ = logWrapper('c:' + this.id + ':'); this.transportManager_ = new TransportManager(repoInfo_); this.log_('Connection created'); this.start_(); } /** * Starts a connection attempt * @private */ Connection.prototype.start_ = function () { var _this = this; var conn = this.transportManager_.initialTransport(); this.conn_ = new conn(this.nextTransportId_(), this.repoInfo_, undefined, this.lastSessionId); // For certain transports (WebSockets), we need to send and receive several messages back and forth before we // can consider the transport healthy. this.primaryResponsesRequired_ = conn['responsesRequiredToBeHealthy'] || 0; var onMessageReceived = this.connReceiver_(this.conn_); var onConnectionLost = this.disconnReceiver_(this.conn_); this.tx_ = this.conn_; this.rx_ = this.conn_; this.secondaryConn_ = null; this.isHealthy_ = false; /* * Firefox doesn't like when code from one iframe tries to create another iframe by way of the parent frame. * This can occur in the case of a redirect, i.e. we guessed wrong on what server to connect to and received a reset. * Somehow, setTimeout seems to make this ok. That doesn't make sense from a security perspective, since you should * still have the context of your originating frame. */ setTimeout(function () { // this.conn_ gets set to null in some of the tests. Check to make sure it still exists before using it _this.conn_ && _this.conn_.open(onMessageReceived, onConnectionLost); }, Math.floor(0)); var healthyTimeout_ms = conn['healthyTimeout'] || 0; if (healthyTimeout_ms > 0) { this.healthyTimeout_ = setTimeoutNonBlocking(function () { _this.healthyTimeout_ = null; if (!_this.isHealthy_) { if (_this.conn_ && _this.conn_.bytesReceived > BYTES_RECEIVED_HEALTHY_OVERRIDE) { _this.log_('Connection exceeded healthy timeout but has received ' + _this.conn_.bytesReceived + ' bytes. Marking connection healthy.'); _this.isHealthy_ = true; _this.conn_.markConnectionHealthy(); } else if (_this.conn_ && _this.conn_.bytesSent > BYTES_SENT_HEALTHY_OVERRIDE) { _this.log_('Connection exceeded healthy timeout but has sent ' + _this.conn_.bytesSent + ' bytes. Leaving connection alive.'); // NOTE: We don't want to mark it healthy, since we have no guarantee that the bytes have made it to // the server. } else { _this.log_('Closing unhealthy connection after timeout.'); _this.close(); } } }, Math.floor(healthyTimeout_ms)); } }; /** * @return {!string} * @private */ Connection.prototype.nextTransportId_ = function () { return 'c:' + this.id + ':' + this.connectionCount++; }; Connection.prototype.disconnReceiver_ = function (conn) { var _this = this; return function (everConnected) { if (conn === _this.conn_) { _this.onConnectionLost_(everConnected); } else if (conn === _this.secondaryConn_) { _this.log_('Secondary connection lost.'); _this.onSecondaryConnectionLost_(); } else { _this.log_('closing an old connection'); } }; }; Connection.prototype.connReceiver_ = function (conn) { var _this = this; return function (message) { if (_this.state_ != 2 /* DISCONNECTED */) { if (conn === _this.rx_) { _this.onPrimaryMessageReceived_(message); } else if (conn === _this.secondaryConn_) { _this.onSecondaryMessageReceived_(message); } else { _this.log_('message on old connection'); } } }; }; /** * * @param {Object} dataMsg An arbitrary data message to be sent to the server */ Connection.prototype.sendRequest = function (dataMsg) { // wrap in a data message envelope and send it on var msg = { t: 'd', d: dataMsg }; this.sendData_(msg); }; Connection.prototype.tryCleanupConnection = function () { if (this.tx_ === this.secondaryConn_ && this.rx_ === this.secondaryConn_) { this.log_('cleaning up and promoting a connection: ' + this.secondaryConn_.connId); this.conn_ = this.secondaryConn_; this.secondaryConn_ = null; // the server will shutdown the old connection } }; Connection.prototype.onSecondaryControl_ = function (controlData) { if (MESSAGE_TYPE in controlData) { var cmd = controlData[MESSAGE_TYPE]; if (cmd === SWITCH_ACK) { this.upgradeIfSecondaryHealthy_(); } else if (cmd === CONTROL_RESET) { // Most likely the session wasn't valid. Abandon the switch attempt this.log_('Got a reset on secondary, closing it'); this.secondaryConn_.close(); // If we were already using this connection for something, than we need to fully close if (this.tx_ === this.secondaryConn_ || this.rx_ === this.secondaryConn_) { this.close(); } } else if (cmd === CONTROL_PONG) { this.log_('got pong on secondary.'); this.secondaryResponsesRequired_--; this.upgradeIfSecondaryHealthy_(); } } }; Connection.prototype.onSecondaryMessageReceived_ = function (parsedData) { var layer = requireKey('t', parsedData); var data = requireKey('d', parsedData); if (layer == 'c') { this.onSecondaryControl_(data); } else if (layer == 'd') { // got a data message, but we're still second connection. Need to buffer it up this.pendingDataMessages.push(data); } else { throw new Error('Unknown protocol layer: ' + layer); } }; Connection.prototype.upgradeIfSecondaryHealthy_ = function () { if (this.secondaryResponsesRequired_ <= 0) { this.log_('Secondary connection is healthy.'); this.isHealthy_ = true; this.secondaryConn_.markConnectionHealthy(); this.proceedWithUpgrade_(); } else { // Send a ping to make sure the connection is healthy. this.log_('sending ping on secondary.'); this.secondaryConn_.send({ t: 'c', d: { t: PING, d: {} } }); } }; Connection.prototype.proceedWithUpgrade_ = function () { // tell this connection to consider itself open this.secondaryConn_.start(); // send ack this.log_('sending client ack on secondary'); this.secondaryConn_.send({ t: 'c', d: { t: SWITCH_ACK, d: {} } }); // send end packet on primary transport, switch to sending on this one // can receive on this one, buffer responses until end received on primary transport this.log_('Ending transmission on primary'); this.conn_.send({ t: 'c', d: { t: END_TRANSMISSION, d: {} } }); this.tx_ = this.secondaryConn_; this.tryCleanupConnection(); }; Connection.prototype.onPrimaryMessageReceived_ = function (parsedData) { // Must refer to parsedData properties in quotes, so closure doesn't touch them. var layer = requireKey('t', parsedData); var data = requireKey('d', parsedData); if (layer == 'c') { this.onControl_(data); } else if (layer == 'd') { this.onDataMessage_(data); } }; Connection.prototype.onDataMessage_ = function (message) { this.onPrimaryResponse_(); // We don't do anything with data messages, just kick them up a level this.onMessage_(message); }; Connection.prototype.onPrimaryResponse_ = function () { if (!this.isHealthy_) { this.primaryResponsesRequired_--; if (this.primaryResponsesRequired_ <= 0) { this.log_('Primary connection is healthy.'); this.isHealthy_ = true; this.conn_.markConnectionHealthy(); } } }; Connection.prototype.onControl_ = function (controlData) { var cmd = requireKey(MESSAGE_TYPE, controlData); if (MESSAGE_DATA in controlData) { var payload = controlData[MESSAGE_DATA]; if (cmd === SERVER_HELLO) { this.onHandshake_(payload); } else if (cmd === END_TRANSMISSION) { this.log_('recvd end transmission on primary'); this.rx_ = this.secondaryConn_; for (var i = 0; i < this.pendingDataMessages.length; ++i) { this.onDataMessage_(this.pendingDataMessages[i]); } this.pendingDataMessages = []; this.tryCleanupConnection(); } else if (cmd === CONTROL_SHUTDOWN) { // This was previously the 'onKill' callback passed to the lower-level connection // payload in this case is the reason for the shutdown. Generally a human-readable error this.onConnectionShutdown_(payload); } else if (cmd === CONTROL_RESET) { // payload in this case is the host we should contact this.onReset_(payload); } else if (cmd === CONTROL_ERROR) { error('Server Error: ' + payload); } else if (cmd === CONTROL_PONG) { this.log_('got pong on primary.'); this.onPrimaryResponse_(); this.sendPingOnPrimaryIfNecessary_(); } else { error('Unknown control packet command: ' + cmd); } } }; /** * * @param {Object} handshake The handshake data returned from the server * @private */ Connection.prototype.onHandshake_ = function (handshake) { var timestamp = handshake.ts; var version = handshake.v; var host = handshake.h; this.sessionId = handshake.s; this.repoInfo_.updateHost(host); // if we've already closed the connection, then don't bother trying to progress further if (this.state_ == 0 /* CONNECTING */) { this.conn_.start(); this.onConnectionEstablished_(this.conn_, timestamp); if (PROTOCOL_VERSION !== version) { warn('Protocol version mismatch detected'); } // TODO: do we want to upgrade? when? maybe a delay? this.tryStartUpgrade_(); } }; Connection.prototype.tryStartUpgrade_ = function () { var conn = this.transportManager_.upgradeTransport(); if (conn) { this.startUpgrade_(conn); } }; Connection.prototype.startUpgrade_ = function (conn) { var _this = this; this.secondaryConn_ = new conn(this.nextTransportId_(), this.repoInfo_, this.sessionId); // For certain transports (WebSockets), we need to send and receive several messages back and forth before we // can consider the transport healthy. this.secondaryResponsesRequired_ = conn['responsesRequiredToBeHealthy'] || 0; var onMessage = this.connReceiver_(this.secondaryConn_); var onDisconnect = this.disconnReceiver_(this.secondaryConn_); this.secondaryConn_.open(onMessage, onDisconnect); // If we haven't successfully upgraded after UPGRADE_TIMEOUT, give up and kill the secondary. setTimeoutNonBlocking(function () { if (_this.secondaryConn_) { _this.log_('Timed out trying to upgrade.'); _this.secondaryConn_.close(); } }, Math.floor(UPGRADE_TIMEOUT)); }; Connection.prototype.onReset_ = function (host) { this.log_('Reset packet received. New host: ' + host); this.repoInfo_.updateHost(host); // TODO: if we're already "connected", we need to trigger a disconnect at the next layer up. // We don't currently support resets after the connection has already been established if (this.state_ === 1 /* CONNECTED */) { this.close(); } else { // Close whatever connections we have open and start again. this.closeConnections_(); this.start_(); } }; Connection.prototype.onConnectionEstablished_ = function (conn, timestamp) { var _this = this; this.log_('Realtime connection established.'); this.conn_ = conn; this.state_ = 1 /* CONNECTED */; if (this.onReady_) { this.onReady_(timestamp, this.sessionId); this.onReady_ = null; } // If after 5 seconds we haven't sent enough requests to the server to get the connection healthy, // send some pings. if (this.primaryResponsesRequired_ === 0) { this.log_('Primary connection is healthy.'); this.isHealthy_ = true; } else { setTimeoutNonBlocking(function () { _this.sendPingOnPrimaryIfNecessary_(); }, Math.floor(DELAY_BEFORE_SENDING_EXTRA_REQUESTS)); } }; Connection.prototype.sendPingOnPrimaryIfNecessary_ = function () { // If the connection isn't considered healthy yet, we'll send a noop ping packet request. if (!this.isHealthy_ && this.state_ === 1 /* CONNECTED */) { this.log_('sending ping on primary.'); this.sendData_({ t: 'c', d: { t: PING, d: {} } }); } }; Connection.prototype.onSecondaryConnectionLost_ = function () { var conn = this.secondaryConn_; this.secondaryConn_ = null; if (this.tx_ === conn || this.rx_ === conn) { // we are relying on this connection already in some capacity. Therefore, a failure is real this.close(); } }; /** * * @param {boolean} everConnected Whether or not the connection ever reached a server. Used to determine if * we should flush the host cache * @private */ Connection.prototype.onConnectionLost_ = function (everConnected) { this.conn_ = null; // NOTE: IF you're seeing a Firefox error for this line, I think it might be because it's getting // called on window close and RealtimeState.CONNECTING is no longer defined. Just a guess. if (!everConnected && this.state_ === 0 /* CONNECTING */) { this.log_('Realtime connection failed.'); // Since we failed to connect at all, clear any cached entry for this namespace in case the machine went away if (this.repoInfo_.isCacheableHost()) { PersistentStorage.remove('host:' + this.repoInfo_.host); // reset the internal host to what we would show the user, i.e. .firebaseio.com this.repoInfo_.internalHost = this.repoInfo_.host; } } else if (this.state_ === 1 /* CONNECTED */) { this.log_('Realtime connection lost.'); } this.close(); }; /** * * @param {string} reason * @private */ Connection.prototype.onConnectionShutdown_ = function (reason) { this.log_('Connection shutdown command received. Shutting down...'); if (this.onKill_) { this.onKill_(reason); this.onKill_ = null; } // We intentionally don't want to fire onDisconnect (kill is a different case), // so clear the callback. this.onDisconnect_ = null; this.close(); }; Connection.prototype.sendData_ = function (data) { if (this.state_ !== 1 /* CONNECTED */) { throw 'Connection is not connected'; } else { this.tx_.send(data); } }; /** * Cleans up this connection, calling the appropriate callbacks */ Connection.prototype.close = function () { if (this.state_ !== 2 /* DISCONNECTED */) { this.log_('Closing realtime connection.'); this.state_ = 2 /* DISCONNECTED */; this.closeConnections_(); if (this.onDisconnect_) { this.onDisconnect_(); this.onDisconnect_ = null; } } }; /** * * @private */ Connection.prototype.closeConnections_ = function () { this.log_('Shutting down all connections'); if (this.conn_) { this.conn_.close(); this.conn_ = null; } if (this.secondaryConn_) { this.secondaryConn_.close(); this.secondaryConn_ = null; } if (this.healthyTimeout_) { clearTimeout(this.healthyTimeout_); this.healthyTimeout_ = null; } }; return Connection; }()); /** * Copyright 2017 Google Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ /** * Interface defining the set of actions that can be performed against the Firebase server * (basically corresponds to our wire protocol). * * @interface */ var ServerActions = /** @class */ (function () { function ServerActions() { } /** * @param {string} pathString * @param {*} data * @param {function(string, string)=} onComplete * @param {string=} hash */ ServerActions.prototype.put = function (pathString, data, onComplete, hash) { }; /** * @param {string} pathString * @param {*} data * @param {function(string, ?string)} onComplete * @param {string=} hash */ ServerActions.prototype.merge = function (pathString, data, onComplete, hash) { }; /** * Refreshes the auth token for the current connection. * @param {string} token The authentication token */ ServerActions.prototype.refreshAuthToken = function (token) { }; /** * @param {string} pathString * @param {*} data * @param {function(string, string)=} onComplete */ ServerActions.prototype.onDisconnectPut = function (pathString, data, onComplete) { }; /** * @param {string} pathString * @param {*} data * @param {function(string, string)=} onComplete */ ServerActions.prototype.onDisconnectMerge = function (pathString, data, onComplete) { }; /** * @param {string} pathString * @param {function(string, string)=} onComplete */ ServerActions.prototype.onDisconnectCancel = function (pathString, onComplete) { }; /** * @param {Object.} stats */ ServerActions.prototype.reportStats = function (stats) { }; return ServerActions; }()); /** * Copyright 2017 Google Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ var RECONNECT_MIN_DELAY = 1000; var RECONNECT_MAX_DELAY_DEFAULT = 60 * 5 * 1000; // 5 minutes in milliseconds (Case: 1858) var RECONNECT_MAX_DELAY_FOR_ADMINS = 30 * 1000; // 30 seconds for admin clients (likely to be a backend server) var RECONNECT_DELAY_MULTIPLIER = 1.3; var RECONNECT_DELAY_RESET_TIMEOUT = 30000; // Reset delay back to MIN_DELAY after being connected for 30sec. var SERVER_KILL_INTERRUPT_REASON = 'server_kill'; // If auth fails repeatedly, we'll assume something is wrong and log a warning / back off. var INVALID_AUTH_TOKEN_THRESHOLD = 3; /** * Firebase connection. Abstracts wire protocol and handles reconnecting. * * NOTE: All JSON objects sent to the realtime connection must have property names enclosed * in quotes to make sure the closure compiler does not minify them. */ var PersistentConnection = /** @class */ (function (_super) { tslib_1.__extends(PersistentConnection, _super); /** * @implements {ServerActions} * @param {!RepoInfo} repoInfo_ Data about the namespace we are connecting to * @param {function(string, *, boolean, ?number)} onDataUpdate_ A callback for new data from the server * @param onConnectStatus_ * @param onServerInfoUpdate_ * @param authTokenProvider_ * @param authOverride_ */ function PersistentConnection(repoInfo_, onDataUpdate_, onConnectStatus_, onServerInfoUpdate_, authTokenProvider_, authOverride_) { var _this = _super.call(this) || this; _this.repoInfo_ = repoInfo_; _this.onDataUpdate_ = onDataUpdate_; _this.onConnectStatus_ = onConnectStatus_; _this.onServerInfoUpdate_ = onServerInfoUpdate_; _this.authTokenProvider_ = authTokenProvider_; _this.authOverride_ = authOverride_; // Used for diagnostic logging. _this.id = PersistentConnection.nextPersistentConnectionId_++; _this.log_ = logWrapper('p:' + _this.id + ':'); /** @private {Object} */ _this.interruptReasons_ = {}; _this.listens_ = {}; _this.outstandingPuts_ = []; _this.outstandingPutCount_ = 0; _this.onDisconnectRequestQueue_ = []; _this.connected_ = false; _this.reconnectDelay_ = RECONNECT_MIN_DELAY; _this.maxReconnectDelay_ = RECONNECT_MAX_DELAY_DEFAULT; _this.securityDebugCallback_ = null; _this.lastSessionId = null; /** @private {number|null} */ _this.establishConnectionTimer_ = null; /** @private {boolean} */ _this.visible_ = false; // Before we get connected, we keep a queue of pending messages to send. _this.requestCBHash_ = {}; _this.requestNumber_ = 0; /** @private {?{ * sendRequest(Object), * close() * }} */ _this.realtime_ = null; /** @private {string|null} */ _this.authToken_ = null; _this.forceTokenRefresh_ = false; _this.invalidAuthTokenCount_ = 0; _this.firstConnection_ = true; _this.lastConnectionAttemptTime_ = null; _this.lastConnectionEstablishedTime_ = null; if (authOverride_ && !util.isNodeSdk()) { throw new Error('Auth override specified in options, but not supported on non Node.js platforms'); } _this.scheduleConnect_(0); VisibilityMonitor.getInstance().on('visible', _this.onVisible_, _this); if (repoInfo_.host.indexOf('fblocal') === -1) { OnlineMonitor.getInstance().on('online', _this.onOnline_, _this); } return _this; } /** * @param {!string} action * @param {*} body * @param {function(*)=} onResponse * @protected */ PersistentConnection.prototype.sendRequest = function (action, body, onResponse) { var curReqNum = ++this.requestNumber_; var msg = { r: curReqNum, a: action, b: body }; this.log_(util.stringify(msg)); util.assert(this.connected_, "sendRequest call when we're not connected not allowed."); this.realtime_.sendRequest(msg); if (onResponse) { this.requestCBHash_[curReqNum] = onResponse; } }; /** * @inheritDoc */ PersistentConnection.prototype.listen = function (query, currentHashFn, tag, onComplete) { var queryId = query.queryIdentifier(); var pathString = query.path.toString(); this.log_('Listen called for ' + pathString + ' ' + queryId); this.listens_[pathString] = this.listens_[pathString] || {}; util.assert(query.getQueryParams().isDefault() || !query.getQueryParams().loadsAllData(), 'listen() called for non-default but complete query'); util.assert(!this.listens_[pathString][queryId], 'listen() called twice for same path/queryId.'); var listenSpec = { onComplete: onComplete, hashFn: currentHashFn, query: query, tag: tag }; this.listens_[pathString][queryId] = listenSpec; if (this.connected_) { this.sendListen_(listenSpec); } }; /** * @param {!{onComplete(), * hashFn():!string, * query: !Query, * tag: ?number}} listenSpec * @private */ PersistentConnection.prototype.sendListen_ = function (listenSpec) { var _this = this; var query = listenSpec.query; var pathString = query.path.toString(); var queryId = query.queryIdentifier(); this.log_('Listen on ' + pathString + ' for ' + queryId); var req = { /*path*/ p: pathString }; var action = 'q'; // Only bother to send query if it's non-default. if (listenSpec.tag) { req['q'] = query.queryObject(); req['t'] = listenSpec.tag; } req[ /*hash*/'h'] = listenSpec.hashFn(); this.sendRequest(action, req, function (message) { var payload = message[ /*data*/'d']; var status = message[ /*status*/'s']; // print warnings in any case... PersistentConnection.warnOnListenWarnings_(payload, query); var currentListenSpec = _this.listens_[pathString] && _this.listens_[pathString][queryId]; // only trigger actions if the listen hasn't been removed and readded if (currentListenSpec === listenSpec) { _this.log_('listen response', message); if (status !== 'ok') { _this.removeListen_(pathString, queryId); } if (listenSpec.onComplete) { listenSpec.onComplete(status, payload); } } }); }; /** * @param {*} payload * @param {!Query} query * @private */ PersistentConnection.warnOnListenWarnings_ = function (payload, query) { if (payload && typeof payload === 'object' && util.contains(payload, 'w')) { var warnings = util.safeGet(payload, 'w'); if (Array.isArray(warnings) && ~warnings.indexOf('no_index')) { var indexSpec = '".indexOn": "' + query .getQueryParams() .getIndex() .toString() + '"'; var indexPath = query.path.toString(); warn("Using an unspecified index. Your data will be downloaded and " + ("filtered on the client. Consider adding " + indexSpec + " at ") + (indexPath + " to your security rules for better performance.")); } } }; /** * @inheritDoc */ PersistentConnection.prototype.refreshAuthToken = function (token) { this.authToken_ = token; this.log_('Auth token refreshed'); if (this.authToken_) { this.tryAuth(); } else { //If we're connected we want to let the server know to unauthenticate us. If we're not connected, simply delete //the credential so we dont become authenticated next time we connect. if (this.connected_) { this.sendRequest('unauth', {}, function () { }); } } this.reduceReconnectDelayIfAdminCredential_(token); }; /** * @param {!string} credential * @private */ PersistentConnection.prototype.reduceReconnectDelayIfAdminCredential_ = function (credential) { // NOTE: This isn't intended to be bulletproof (a malicious developer can always just modify the client). // Additionally, we don't bother resetting the max delay back to the default if auth fails / expires. var isFirebaseSecret = credential && credential.length === 40; if (isFirebaseSecret || util.isAdmin(credential)) { this.log_('Admin auth credential detected. Reducing max reconnect time.'); this.maxReconnectDelay_ = RECONNECT_MAX_DELAY_FOR_ADMINS; } }; /** * Attempts to authenticate with the given credentials. If the authentication attempt fails, it's triggered like * a auth revoked (the connection is closed). */ PersistentConnection.prototype.tryAuth = function () { var _this = this; if (this.connected_ && this.authToken_) { var token_1 = this.authToken_; var authMethod = util.isValidFormat(token_1) ? 'auth' : 'gauth'; var requestData = { cred: token_1 }; if (this.authOverride_ === null) { requestData['noauth'] = true; } else if (typeof this.authOverride_ === 'object') { requestData['authvar'] = this.authOverride_; } this.sendRequest(authMethod, requestData, function (res) { var status = res[ /*status*/'s']; var data = res[ /*data*/'d'] || 'error'; if (_this.authToken_ === token_1) { if (status === 'ok') { _this.invalidAuthTokenCount_ = 0; } else { // Triggers reconnect and force refresh for auth token _this.onAuthRevoked_(status, data); } } }); } }; /** * @inheritDoc */ PersistentConnection.prototype.unlisten = function (query, tag) { var pathString = query.path.toString(); var queryId = query.queryIdentifier(); this.log_('Unlisten called for ' + pathString + ' ' + queryId); util.assert(query.getQueryParams().isDefault() || !query.getQueryParams().loadsAllData(), 'unlisten() called for non-default but complete query'); var listen = this.removeListen_(pathString, queryId); if (listen && this.connected_) { this.sendUnlisten_(pathString, queryId, query.queryObject(), tag); } }; PersistentConnection.prototype.sendUnlisten_ = function (pathString, queryId, queryObj, tag) { this.log_('Unlisten on ' + pathString + ' for ' + queryId); var req = { /*path*/ p: pathString }; var action = 'n'; // Only bother sending queryId if it's non-default. if (tag) { req['q'] = queryObj; req['t'] = tag; } this.sendRequest(action, req); }; /** * @inheritDoc */ PersistentConnection.prototype.onDisconnectPut = function (pathString, data, onComplete) { if (this.connected_) { this.sendOnDisconnect_('o', pathString, data, onComplete); } else { this.onDisconnectRequestQueue_.push({ pathString: pathString, action: 'o', data: data, onComplete: onComplete }); } }; /** * @inheritDoc */ PersistentConnection.prototype.onDisconnectMerge = function (pathString, data, onComplete) { if (this.connected_) { this.sendOnDisconnect_('om', pathString, data, onComplete); } else { this.onDisconnectRequestQueue_.push({ pathString: pathString, action: 'om', data: data, onComplete: onComplete }); } }; /** * @inheritDoc */ PersistentConnection.prototype.onDisconnectCancel = function (pathString, onComplete) { if (this.connected_) { this.sendOnDisconnect_('oc', pathString, null, onComplete); } else { this.onDisconnectRequestQueue_.push({ pathString: pathString, action: 'oc', data: null, onComplete: onComplete }); } }; PersistentConnection.prototype.sendOnDisconnect_ = function (action, pathString, data, onComplete) { var request = { /*path*/ p: pathString, /*data*/ d: data }; this.log_('onDisconnect ' + action, request); this.sendRequest(action, request, function (response) { if (onComplete) { setTimeout(function () { onComplete(response[ /*status*/'s'], response[ /* data */'d']); }, Math.floor(0)); } }); }; /** * @inheritDoc */ PersistentConnection.prototype.put = function (pathString, data, onComplete, hash) { this.putInternal('p', pathString, data, onComplete, hash); }; /** * @inheritDoc */ PersistentConnection.prototype.merge = function (pathString, data, onComplete, hash) { this.putInternal('m', pathString, data, onComplete, hash); }; PersistentConnection.prototype.putInternal = function (action, pathString, data, onComplete, hash) { var request = { /*path*/ p: pathString, /*data*/ d: data }; if (hash !== undefined) request[ /*hash*/'h'] = hash; // TODO: Only keep track of the most recent put for a given path? this.outstandingPuts_.push({ action: action, request: request, onComplete: onComplete }); this.outstandingPutCount_++; var index = this.outstandingPuts_.length - 1; if (this.connected_) { this.sendPut_(index); } else { this.log_('Buffering put: ' + pathString); } }; PersistentConnection.prototype.sendPut_ = function (index) { var _this = this; var action = this.outstandingPuts_[index].action; var request = this.outstandingPuts_[index].request; var onComplete = this.outstandingPuts_[index].onComplete; this.outstandingPuts_[index].queued = this.connected_; this.sendRequest(action, request, function (message) { _this.log_(action + ' response', message); delete _this.outstandingPuts_[index]; _this.outstandingPutCount_--; // Clean up array occasionally. if (_this.outstandingPutCount_ === 0) { _this.outstandingPuts_ = []; } if (onComplete) onComplete(message[ /*status*/'s'], message[ /* data */'d']); }); }; /** * @inheritDoc */ PersistentConnection.prototype.reportStats = function (stats) { var _this = this; // If we're not connected, we just drop the stats. if (this.connected_) { var request = { /*counters*/ c: stats }; this.log_('reportStats', request); this.sendRequest(/*stats*/ 's', request, function (result) { var status = result[ /*status*/'s']; if (status !== 'ok') { var errorReason = result[ /* data */'d']; _this.log_('reportStats', 'Error sending stats: ' + errorReason); } }); } }; /** * @param {*} message * @private */ PersistentConnection.prototype.onDataMessage_ = function (message) { if ('r' in message) { // this is a response this.log_('from server: ' + util.stringify(message)); var reqNum = message['r']; var onResponse = this.requestCBHash_[reqNum]; if (onResponse) { delete this.requestCBHash_[reqNum]; onResponse(message[ /*body*/'b']); } } else if ('error' in message) { throw 'A server-side error has occurred: ' + message['error']; } else if ('a' in message) { // a and b are action and body, respectively this.onDataPush_(message['a'], message['b']); } }; PersistentConnection.prototype.onDataPush_ = function (action, body) { this.log_('handleServerMessage', action, body); if (action === 'd') this.onDataUpdate_(body[ /*path*/'p'], body[ /*data*/'d'], /*isMerge*/ false, body['t']); else if (action === 'm') this.onDataUpdate_(body[ /*path*/'p'], body[ /*data*/'d'], /*isMerge=*/ true, body['t']); else if (action === 'c') this.onListenRevoked_(body[ /*path*/'p'], body[ /*query*/'q']); else if (action === 'ac') this.onAuthRevoked_(body[ /*status code*/'s'], body[ /* explanation */'d']); else if (action === 'sd') this.onSecurityDebugPacket_(body); else error('Unrecognized action received from server: ' + util.stringify(action) + '\nAre you using the latest client?'); }; PersistentConnection.prototype.onReady_ = function (timestamp, sessionId) { this.log_('connection ready'); this.connected_ = true; this.lastConnectionEstablishedTime_ = new Date().getTime(); this.handleTimestamp_(timestamp); this.lastSessionId = sessionId; if (this.firstConnection_) { this.sendConnectStats_(); } this.restoreState_(); this.firstConnection_ = false; this.onConnectStatus_(true); }; PersistentConnection.prototype.scheduleConnect_ = function (timeout) { var _this = this; util.assert(!this.realtime_, "Scheduling a connect when we're already connected/ing?"); if (this.establishConnectionTimer_) { clearTimeout(this.establishConnectionTimer_); } // NOTE: Even when timeout is 0, it's important to do a setTimeout to work around an infuriating "Security Error" in // Firefox when trying to write to our long-polling iframe in some scenarios (e.g. Forge or our unit tests). this.establishConnectionTimer_ = setTimeout(function () { _this.establishConnectionTimer_ = null; _this.establishConnection_(); }, Math.floor(timeout)); }; /** * @param {boolean} visible * @private */ PersistentConnection.prototype.onVisible_ = function (visible) { // NOTE: Tabbing away and back to a window will defeat our reconnect backoff, but I think that's fine. if (visible && !this.visible_ && this.reconnectDelay_ === this.maxReconnectDelay_) { this.log_('Window became visible. Reducing delay.'); this.reconnectDelay_ = RECONNECT_MIN_DELAY; if (!this.realtime_) { this.scheduleConnect_(0); } } this.visible_ = visible; }; PersistentConnection.prototype.onOnline_ = function (online) { if (online) { this.log_('Browser went online.'); this.reconnectDelay_ = RECONNECT_MIN_DELAY; if (!this.realtime_) { this.scheduleConnect_(0); } } else { this.log_('Browser went offline. Killing connection.'); if (this.realtime_) { this.realtime_.close(); } } }; PersistentConnection.prototype.onRealtimeDisconnect_ = function () { this.log_('data client disconnected'); this.connected_ = false; this.realtime_ = null; // Since we don't know if our sent transactions succeeded or not, we need to cancel them. this.cancelSentTransactions_(); // Clear out the pending requests. this.requestCBHash_ = {}; if (this.shouldReconnect_()) { if (!this.visible_) { this.log_("Window isn't visible. Delaying reconnect."); this.reconnectDelay_ = this.maxReconnectDelay_; this.lastConnectionAttemptTime_ = new Date().getTime(); } else if (this.lastConnectionEstablishedTime_) { // If we've been connected long enough, reset reconnect delay to minimum. var timeSinceLastConnectSucceeded = new Date().getTime() - this.lastConnectionEstablishedTime_; if (timeSinceLastConnectSucceeded > RECONNECT_DELAY_RESET_TIMEOUT) this.reconnectDelay_ = RECONNECT_MIN_DELAY; this.lastConnectionEstablishedTime_ = null; } var timeSinceLastConnectAttempt = new Date().getTime() - this.lastConnectionAttemptTime_; var reconnectDelay = Math.max(0, this.reconnectDelay_ - timeSinceLastConnectAttempt); reconnectDelay = Math.random() * reconnectDelay; this.log_('Trying to reconnect in ' + reconnectDelay + 'ms'); this.scheduleConnect_(reconnectDelay); // Adjust reconnect delay for next time. this.reconnectDelay_ = Math.min(this.maxReconnectDelay_, this.reconnectDelay_ * RECONNECT_DELAY_MULTIPLIER); } this.onConnectStatus_(false); }; PersistentConnection.prototype.establishConnection_ = function () { if (this.shouldReconnect_()) { this.log_('Making a connection attempt'); this.lastConnectionAttemptTime_ = new Date().getTime(); this.lastConnectionEstablishedTime_ = null; var onDataMessage_1 = this.onDataMessage_.bind(this); var onReady_1 = this.onReady_.bind(this); var onDisconnect_1 = this.onRealtimeDisconnect_.bind(this); var connId_1 = this.id + ':' + PersistentConnection.nextConnectionId_++; var self_1 = this; var lastSessionId_1 = this.lastSessionId; var canceled_1 = false; var connection_1 = null; var closeFn_1 = function () { if (connection_1) { connection_1.close(); } else { canceled_1 = true; onDisconnect_1(); } }; var sendRequestFn = function (msg) { util.assert(connection_1, "sendRequest call when we're not connected not allowed."); connection_1.sendRequest(msg); }; this.realtime_ = { close: closeFn_1, sendRequest: sendRequestFn }; var forceRefresh = this.forceTokenRefresh_; this.forceTokenRefresh_ = false; // First fetch auth token, and establish connection after fetching the token was successful this.authTokenProvider_ .getToken(forceRefresh) .then(function (result) { if (!canceled_1) { log('getToken() completed. Creating connection.'); self_1.authToken_ = result && result.accessToken; connection_1 = new Connection(connId_1, self_1.repoInfo_, onDataMessage_1, onReady_1, onDisconnect_1, /* onKill= */ function (reason) { warn(reason + ' (' + self_1.repoInfo_.toString() + ')'); self_1.interrupt(SERVER_KILL_INTERRUPT_REASON); }, lastSessionId_1); } else { log('getToken() completed but was canceled'); } }) .then(null, function (error$$1) { self_1.log_('Failed to get token: ' + error$$1); if (!canceled_1) { if (util.CONSTANTS.NODE_ADMIN) { // This may be a critical error for the Admin Node.js SDK, so log a warning. // But getToken() may also just have temporarily failed, so we still want to // continue retrying. warn(error$$1); } closeFn_1(); } }); } }; /** * @param {string} reason */ PersistentConnection.prototype.interrupt = function (reason) { log('Interrupting connection for reason: ' + reason); this.interruptReasons_[reason] = true; if (this.realtime_) { this.realtime_.close(); } else { if (this.establishConnectionTimer_) { clearTimeout(this.establishConnectionTimer_); this.establishConnectionTimer_ = null; } if (this.connected_) { this.onRealtimeDisconnect_(); } } }; /** * @param {string} reason */ PersistentConnection.prototype.resume = function (reason) { log('Resuming connection for reason: ' + reason); delete this.interruptReasons_[reason]; if (util.isEmpty(this.interruptReasons_)) { this.reconnectDelay_ = RECONNECT_MIN_DELAY; if (!this.realtime_) { this.scheduleConnect_(0); } } }; PersistentConnection.prototype.handleTimestamp_ = function (timestamp) { var delta = timestamp - new Date().getTime(); this.onServerInfoUpdate_({ serverTimeOffset: delta }); }; PersistentConnection.prototype.cancelSentTransactions_ = function () { for (var i = 0; i < this.outstandingPuts_.length; i++) { var put = this.outstandingPuts_[i]; if (put && /*hash*/ 'h' in put.request && put.queued) { if (put.onComplete) put.onComplete('disconnect'); delete this.outstandingPuts_[i]; this.outstandingPutCount_--; } } // Clean up array occasionally. if (this.outstandingPutCount_ === 0) this.outstandingPuts_ = []; }; /** * @param {!string} pathString * @param {Array.<*>=} query * @private */ PersistentConnection.prototype.onListenRevoked_ = function (pathString, query) { // Remove the listen and manufacture a "permission_denied" error for the failed listen. var queryId; if (!query) { queryId = 'default'; } else { queryId = query.map(function (q) { return ObjectToUniqueKey(q); }).join('$'); } var listen = this.removeListen_(pathString, queryId); if (listen && listen.onComplete) listen.onComplete('permission_denied'); }; /** * @param {!string} pathString * @param {!string} queryId * @return {{queries:Array., onComplete:function(string)}} * @private */ PersistentConnection.prototype.removeListen_ = function (pathString, queryId) { var normalizedPathString = new Path(pathString).toString(); // normalize path. var listen; if (this.listens_[normalizedPathString] !== undefined) { listen = this.listens_[normalizedPathString][queryId]; delete this.listens_[normalizedPathString][queryId]; if (util.getCount(this.listens_[normalizedPathString]) === 0) { delete this.listens_[normalizedPathString]; } } else { // all listens for this path has already been removed listen = undefined; } return listen; }; PersistentConnection.prototype.onAuthRevoked_ = function (statusCode, explanation) { log('Auth token revoked: ' + statusCode + '/' + explanation); this.authToken_ = null; this.forceTokenRefresh_ = true; this.realtime_.close(); if (statusCode === 'invalid_token' || statusCode === 'permission_denied') { // We'll wait a couple times before logging the warning / increasing the // retry period since oauth tokens will report as "invalid" if they're // just expired. Plus there may be transient issues that resolve themselves. this.invalidAuthTokenCount_++; if (this.invalidAuthTokenCount_ >= INVALID_AUTH_TOKEN_THRESHOLD) { // Set a long reconnect delay because recovery is unlikely this.reconnectDelay_ = RECONNECT_MAX_DELAY_FOR_ADMINS; // Notify the auth token provider that the token is invalid, which will log // a warning this.authTokenProvider_.notifyForInvalidToken(); } } }; PersistentConnection.prototype.onSecurityDebugPacket_ = function (body) { if (this.securityDebugCallback_) { this.securityDebugCallback_(body); } else { if ('msg' in body) { console.log('FIREBASE: ' + body['msg'].replace('\n', '\nFIREBASE: ')); } } }; PersistentConnection.prototype.restoreState_ = function () { var _this = this; //Re-authenticate ourselves if we have a credential stored. this.tryAuth(); // Puts depend on having received the corresponding data update from the server before they complete, so we must // make sure to send listens before puts. util.forEach(this.listens_, function (pathString, queries) { util.forEach(queries, function (key, listenSpec) { _this.sendListen_(listenSpec); }); }); for (var i = 0; i < this.outstandingPuts_.length; i++) { if (this.outstandingPuts_[i]) this.sendPut_(i); } while (this.onDisconnectRequestQueue_.length) { var request = this.onDisconnectRequestQueue_.shift(); this.sendOnDisconnect_(request.action, request.pathString, request.data, request.onComplete); } }; /** * Sends client stats for first connection * @private */ PersistentConnection.prototype.sendConnectStats_ = function () { var stats = {}; var clientName = 'js'; if (util.CONSTANTS.NODE_ADMIN) { clientName = 'admin_node'; } else if (util.CONSTANTS.NODE_CLIENT) { clientName = 'node'; } stats['sdk.' + clientName + '.' + firebase.SDK_VERSION.replace(/\./g, '-')] = 1; if (util.isMobileCordova()) { stats['framework.cordova'] = 1; } else if (util.isReactNative()) { stats['framework.reactnative'] = 1; } this.reportStats(stats); }; /** * @return {boolean} * @private */ PersistentConnection.prototype.shouldReconnect_ = function () { var online = OnlineMonitor.getInstance().currentlyOnline(); return util.isEmpty(this.interruptReasons_) && online; }; /** * @private */ PersistentConnection.nextPersistentConnectionId_ = 0; /** * Counter for number of connections created. Mainly used for tagging in the logs * @type {number} * @private */ PersistentConnection.nextConnectionId_ = 0; return PersistentConnection; }(ServerActions)); /** * Copyright 2017 Google Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ /** * An implementation of ServerActions that communicates with the server via REST requests. * This is mostly useful for compatibility with crawlers, where we don't want to spin up a full * persistent connection (using WebSockets or long-polling) */ var ReadonlyRestClient = /** @class */ (function (_super) { tslib_1.__extends(ReadonlyRestClient, _super); /** * @param {!RepoInfo} repoInfo_ Data about the namespace we are connecting to * @param {function(string, *, boolean, ?number)} onDataUpdate_ A callback for new data from the server * @param {AuthTokenProvider} authTokenProvider_ * @implements {ServerActions} */ function ReadonlyRestClient(repoInfo_, onDataUpdate_, authTokenProvider_) { var _this = _super.call(this) || this; _this.repoInfo_ = repoInfo_; _this.onDataUpdate_ = onDataUpdate_; _this.authTokenProvider_ = authTokenProvider_; /** @private {function(...[*])} */ _this.log_ = logWrapper('p:rest:'); /** * We don't actually need to track listens, except to prevent us calling an onComplete for a listen * that's been removed. :-/ * * @private {!Object.} */ _this.listens_ = {}; return _this; } ReadonlyRestClient.prototype.reportStats = function (stats) { throw new Error('Method not implemented.'); }; /** * @param {!Query} query * @param {?number=} tag * @return {string} * @private */ ReadonlyRestClient.getListenId_ = function (query, tag) { if (tag !== undefined) { return 'tag$' + tag; } else { util.assert(query.getQueryParams().isDefault(), "should have a tag if it's not a default query."); return query.path.toString(); } }; /** @inheritDoc */ ReadonlyRestClient.prototype.listen = function (query, currentHashFn, tag, onComplete) { var _this = this; var pathString = query.path.toString(); this.log_('Listen called for ' + pathString + ' ' + query.queryIdentifier()); // Mark this listener so we can tell if it's removed. var listenId = ReadonlyRestClient.getListenId_(query, tag); var thisListen = {}; this.listens_[listenId] = thisListen; var queryStringParameters = query .getQueryParams() .toRestQueryStringParameters(); this.restRequest_(pathString + '.json', queryStringParameters, function (error$$1, result) { var data = result; if (error$$1 === 404) { data = null; error$$1 = null; } if (error$$1 === null) { _this.onDataUpdate_(pathString, data, /*isMerge=*/ false, tag); } if (util.safeGet(_this.listens_, listenId) === thisListen) { var status_1; if (!error$$1) { status_1 = 'ok'; } else if (error$$1 == 401) { status_1 = 'permission_denied'; } else { status_1 = 'rest_error:' + error$$1; } onComplete(status_1, null); } }); }; /** @inheritDoc */ ReadonlyRestClient.prototype.unlisten = function (query, tag) { var listenId = ReadonlyRestClient.getListenId_(query, tag); delete this.listens_[listenId]; }; /** @inheritDoc */ ReadonlyRestClient.prototype.refreshAuthToken = function (token) { // no-op since we just always call getToken. }; /** * Performs a REST request to the given path, with the provided query string parameters, * and any auth credentials we have. * * @param {!string} pathString * @param {!Object.} queryStringParameters * @param {?function(?number, *=)} callback * @private */ ReadonlyRestClient.prototype.restRequest_ = function (pathString, queryStringParameters, callback) { var _this = this; if (queryStringParameters === void 0) { queryStringParameters = {}; } queryStringParameters['format'] = 'export'; this.authTokenProvider_ .getToken(/*forceRefresh=*/ false) .then(function (authTokenData) { var authToken = authTokenData && authTokenData.accessToken; if (authToken) { queryStringParameters['auth'] = authToken; } var url = (_this.repoInfo_.secure ? 'https://' : 'http://') + _this.repoInfo_.host + pathString + '?' + 'ns=' + _this.repoInfo_.namespace + util.querystring(queryStringParameters); _this.log_('Sending REST request for ' + url); var xhr = new XMLHttpRequest(); xhr.onreadystatechange = function () { if (callback && xhr.readyState === 4) { _this.log_('REST Response for ' + url + ' received. status:', xhr.status, 'response:', xhr.responseText); var res = null; if (xhr.status >= 200 && xhr.status < 300) { try { res = util.jsonEval(xhr.responseText); } catch (e) { warn('Failed to parse JSON response for ' + url + ': ' + xhr.responseText); } callback(null, res); } else { // 401 and 404 are expected. if (xhr.status !== 401 && xhr.status !== 404) { warn('Got unsuccessful REST response for ' + url + ' Status: ' + xhr.status); } callback(xhr.status); } callback = null; } }; xhr.open('GET', url, /*asynchronous=*/ true); xhr.send(); }); }; return ReadonlyRestClient; }(ServerActions)); /** * Copyright 2017 Google Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ var INTERRUPT_REASON = 'repo_interrupt'; /** * A connection to a single data repository. */ var Repo = /** @class */ (function () { /** * @param {!RepoInfo} repoInfo_ * @param {boolean} forceRestClient * @param {!FirebaseApp} app */ function Repo(repoInfo_, forceRestClient, app) { var _this = this; this.repoInfo_ = repoInfo_; this.app = app; this.dataUpdateCount = 0; this.statsListener_ = null; this.eventQueue_ = new EventQueue(); this.nextWriteId_ = 1; this.interceptServerDataCallback_ = null; // A list of data pieces and paths to be set when this client disconnects. this.onDisconnect_ = new SparseSnapshotTree(); /** * TODO: This should be @private but it's used by test_access.js and internal.js * @type {?PersistentConnection} */ this.persistentConnection_ = null; /** @type {!AuthTokenProvider} */ var authTokenProvider = new AuthTokenProvider(app); this.stats_ = StatsManager.getCollection(repoInfo_); if (forceRestClient || beingCrawled()) { this.server_ = new ReadonlyRestClient(this.repoInfo_, this.onDataUpdate_.bind(this), authTokenProvider); // Minor hack: Fire onConnect immediately, since there's no actual connection. setTimeout(this.onConnectStatus_.bind(this, true), 0); } else { var authOverride = app.options['databaseAuthVariableOverride']; // Validate authOverride if (typeof authOverride !== 'undefined' && authOverride !== null) { if (typeof authOverride !== 'object') { throw new Error('Only objects are supported for option databaseAuthVariableOverride'); } try { util.stringify(authOverride); } catch (e) { throw new Error('Invalid authOverride provided: ' + e); } } this.persistentConnection_ = new PersistentConnection(this.repoInfo_, this.onDataUpdate_.bind(this), this.onConnectStatus_.bind(this), this.onServerInfoUpdate_.bind(this), authTokenProvider, authOverride); this.server_ = this.persistentConnection_; } authTokenProvider.addTokenChangeListener(function (token) { _this.server_.refreshAuthToken(token); }); // In the case of multiple Repos for the same repoInfo (i.e. there are multiple Firebase.Contexts being used), // we only want to create one StatsReporter. As such, we'll report stats over the first Repo created. this.statsReporter_ = StatsManager.getOrCreateReporter(repoInfo_, function () { return new StatsReporter(_this.stats_, _this.server_); }); this.transactions_init_(); // Used for .info. this.infoData_ = new SnapshotHolder(); this.infoSyncTree_ = new SyncTree({ startListening: function (query, tag, currentHashFn, onComplete) { var infoEvents = []; var node = _this.infoData_.getNode(query.path); // This is possibly a hack, but we have different semantics for .info endpoints. We don't raise null events // on initial data... if (!node.isEmpty()) { infoEvents = _this.infoSyncTree_.applyServerOverwrite(query.path, node); setTimeout(function () { onComplete('ok'); }, 0); } return infoEvents; }, stopListening: function () { } }); this.updateInfo_('connected', false); this.serverSyncTree_ = new SyncTree({ startListening: function (query, tag, currentHashFn, onComplete) { _this.server_.listen(query, currentHashFn, tag, function (status, data) { var events = onComplete(status, data); _this.eventQueue_.raiseEventsForChangedPath(query.path, events); }); // No synchronous events for network-backed sync trees return []; }, stopListening: function (query, tag) { _this.server_.unlisten(query, tag); } }); } /** * @return {string} The URL corresponding to the root of this Firebase. */ Repo.prototype.toString = function () { return ((this.repoInfo_.secure ? 'https://' : 'http://') + this.repoInfo_.host); }; /** * @return {!string} The namespace represented by the repo. */ Repo.prototype.name = function () { return this.repoInfo_.namespace; }; /** * @return {!number} The time in milliseconds, taking the server offset into account if we have one. */ Repo.prototype.serverTime = function () { var offsetNode = this.infoData_.getNode(new Path('.info/serverTimeOffset')); var offset = offsetNode.val() || 0; return new Date().getTime() + offset; }; /** * Generate ServerValues using some variables from the repo object. * @return {!Object} */ Repo.prototype.generateServerValues = function () { return generateWithValues({ timestamp: this.serverTime() }); }; /** * Called by realtime when we get new messages from the server. * * @private * @param {string} pathString * @param {*} data * @param {boolean} isMerge * @param {?number} tag */ Repo.prototype.onDataUpdate_ = function (pathString, data, isMerge, tag) { // For testing. this.dataUpdateCount++; var path = new Path(pathString); data = this.interceptServerDataCallback_ ? this.interceptServerDataCallback_(pathString, data) : data; var events = []; if (tag) { if (isMerge) { var taggedChildren = util.map(data, function (raw) { return nodeFromJSON$1(raw); }); events = this.serverSyncTree_.applyTaggedQueryMerge(path, taggedChildren, tag); } else { var taggedSnap = nodeFromJSON$1(data); events = this.serverSyncTree_.applyTaggedQueryOverwrite(path, taggedSnap, tag); } } else if (isMerge) { var changedChildren = util.map(data, function (raw) { return nodeFromJSON$1(raw); }); events = this.serverSyncTree_.applyServerMerge(path, changedChildren); } else { var snap = nodeFromJSON$1(data); events = this.serverSyncTree_.applyServerOverwrite(path, snap); } var affectedPath = path; if (events.length > 0) { // Since we have a listener outstanding for each transaction, receiving any events // is a proxy for some change having occurred. affectedPath = this.rerunTransactions_(path); } this.eventQueue_.raiseEventsForChangedPath(affectedPath, events); }; /** * TODO: This should be @private but it's used by test_access.js and internal.js * @param {?function(!string, *):*} callback * @private */ Repo.prototype.interceptServerData_ = function (callback) { this.interceptServerDataCallback_ = callback; }; /** * @param {!boolean} connectStatus * @private */ Repo.prototype.onConnectStatus_ = function (connectStatus) { this.updateInfo_('connected', connectStatus); if (connectStatus === false) { this.runOnDisconnectEvents_(); } }; /** * @param {!Object} updates * @private */ Repo.prototype.onServerInfoUpdate_ = function (updates) { var _this = this; each(updates, function (value, key) { _this.updateInfo_(key, value); }); }; /** * * @param {!string} pathString * @param {*} value * @private */ Repo.prototype.updateInfo_ = function (pathString, value) { var path = new Path('/.info/' + pathString); var newNode = nodeFromJSON$1(value); this.infoData_.updateSnapshot(path, newNode); var events = this.infoSyncTree_.applyServerOverwrite(path, newNode); this.eventQueue_.raiseEventsForChangedPath(path, events); }; /** * @return {!number} * @private */ Repo.prototype.getNextWriteId_ = function () { return this.nextWriteId_++; }; /** * @param {!Path} path * @param {*} newVal * @param {number|string|null} newPriority * @param {?function(?Error, *=)} onComplete */ Repo.prototype.setWithPriority = function (path, newVal, newPriority, onComplete) { var _this = this; this.log_('set', { path: path.toString(), value: newVal, priority: newPriority }); // TODO: Optimize this behavior to either (a) store flag to skip resolving where possible and / or // (b) store unresolved paths on JSON parse var serverValues = this.generateServerValues(); var newNodeUnresolved = nodeFromJSON$1(newVal, newPriority); var newNode = resolveDeferredValueSnapshot(newNodeUnresolved, serverValues); var writeId = this.getNextWriteId_(); var events = this.serverSyncTree_.applyUserOverwrite(path, newNode, writeId, true); this.eventQueue_.queueEvents(events); this.server_.put(path.toString(), newNodeUnresolved.val(/*export=*/ true), function (status, errorReason) { var success = status === 'ok'; if (!success) { warn('set at ' + path + ' failed: ' + status); } var clearEvents = _this.serverSyncTree_.ackUserWrite(writeId, !success); _this.eventQueue_.raiseEventsForChangedPath(path, clearEvents); _this.callOnCompleteCallback(onComplete, status, errorReason); }); var affectedPath = this.abortTransactions_(path); this.rerunTransactions_(affectedPath); // We queued the events above, so just flush the queue here this.eventQueue_.raiseEventsForChangedPath(affectedPath, []); }; /** * @param {!Path} path * @param {!Object} childrenToMerge * @param {?function(?Error, *=)} onComplete */ Repo.prototype.update = function (path, childrenToMerge, onComplete) { var _this = this; this.log_('update', { path: path.toString(), value: childrenToMerge }); // Start with our existing data and merge each child into it. var empty = true; var serverValues = this.generateServerValues(); var changedChildren = {}; util.forEach(childrenToMerge, function (changedKey, changedValue) { empty = false; var newNodeUnresolved = nodeFromJSON$1(changedValue); changedChildren[changedKey] = resolveDeferredValueSnapshot(newNodeUnresolved, serverValues); }); if (!empty) { var writeId_1 = this.getNextWriteId_(); var events = this.serverSyncTree_.applyUserMerge(path, changedChildren, writeId_1); this.eventQueue_.queueEvents(events); this.server_.merge(path.toString(), childrenToMerge, function (status, errorReason) { var success = status === 'ok'; if (!success) { warn('update at ' + path + ' failed: ' + status); } var clearEvents = _this.serverSyncTree_.ackUserWrite(writeId_1, !success); var affectedPath = clearEvents.length > 0 ? _this.rerunTransactions_(path) : path; _this.eventQueue_.raiseEventsForChangedPath(affectedPath, clearEvents); _this.callOnCompleteCallback(onComplete, status, errorReason); }); util.forEach(childrenToMerge, function (changedPath) { var affectedPath = _this.abortTransactions_(path.child(changedPath)); _this.rerunTransactions_(affectedPath); }); // We queued the events above, so just flush the queue here this.eventQueue_.raiseEventsForChangedPath(path, []); } else { log("update() called with empty data. Don't do anything."); this.callOnCompleteCallback(onComplete, 'ok'); } }; /** * Applies all of the changes stored up in the onDisconnect_ tree. * @private */ Repo.prototype.runOnDisconnectEvents_ = function () { var _this = this; this.log_('onDisconnectEvents'); var serverValues = this.generateServerValues(); var resolvedOnDisconnectTree = resolveDeferredValueTree(this.onDisconnect_, serverValues); var events = []; resolvedOnDisconnectTree.forEachTree(Path.Empty, function (path, snap) { events = events.concat(_this.serverSyncTree_.applyServerOverwrite(path, snap)); var affectedPath = _this.abortTransactions_(path); _this.rerunTransactions_(affectedPath); }); this.onDisconnect_ = new SparseSnapshotTree(); this.eventQueue_.raiseEventsForChangedPath(Path.Empty, events); }; /** * @param {!Path} path * @param {?function(?Error, *=)} onComplete */ Repo.prototype.onDisconnectCancel = function (path, onComplete) { var _this = this; this.server_.onDisconnectCancel(path.toString(), function (status, errorReason) { if (status === 'ok') { _this.onDisconnect_.forget(path); } _this.callOnCompleteCallback(onComplete, status, errorReason); }); }; /** * @param {!Path} path * @param {*} value * @param {?function(?Error, *=)} onComplete */ Repo.prototype.onDisconnectSet = function (path, value, onComplete) { var _this = this; var newNode = nodeFromJSON$1(value); this.server_.onDisconnectPut(path.toString(), newNode.val(/*export=*/ true), function (status, errorReason) { if (status === 'ok') { _this.onDisconnect_.remember(path, newNode); } _this.callOnCompleteCallback(onComplete, status, errorReason); }); }; /** * @param {!Path} path * @param {*} value * @param {*} priority * @param {?function(?Error, *=)} onComplete */ Repo.prototype.onDisconnectSetWithPriority = function (path, value, priority, onComplete) { var _this = this; var newNode = nodeFromJSON$1(value, priority); this.server_.onDisconnectPut(path.toString(), newNode.val(/*export=*/ true), function (status, errorReason) { if (status === 'ok') { _this.onDisconnect_.remember(path, newNode); } _this.callOnCompleteCallback(onComplete, status, errorReason); }); }; /** * @param {!Path} path * @param {*} childrenToMerge * @param {?function(?Error, *=)} onComplete */ Repo.prototype.onDisconnectUpdate = function (path, childrenToMerge, onComplete) { var _this = this; if (util.isEmpty(childrenToMerge)) { log("onDisconnect().update() called with empty data. Don't do anything."); this.callOnCompleteCallback(onComplete, 'ok'); return; } this.server_.onDisconnectMerge(path.toString(), childrenToMerge, function (status, errorReason) { if (status === 'ok') { util.forEach(childrenToMerge, function (childName, childNode) { var newChildNode = nodeFromJSON$1(childNode); _this.onDisconnect_.remember(path.child(childName), newChildNode); }); } _this.callOnCompleteCallback(onComplete, status, errorReason); }); }; /** * @param {!Query} query * @param {!EventRegistration} eventRegistration */ Repo.prototype.addEventCallbackForQuery = function (query, eventRegistration) { var events; if (query.path.getFront() === '.info') { events = this.infoSyncTree_.addEventRegistration(query, eventRegistration); } else { events = this.serverSyncTree_.addEventRegistration(query, eventRegistration); } this.eventQueue_.raiseEventsAtPath(query.path, events); }; /** * @param {!Query} query * @param {?EventRegistration} eventRegistration */ Repo.prototype.removeEventCallbackForQuery = function (query, eventRegistration) { // These are guaranteed not to raise events, since we're not passing in a cancelError. However, we can future-proof // a little bit by handling the return values anyways. var events; if (query.path.getFront() === '.info') { events = this.infoSyncTree_.removeEventRegistration(query, eventRegistration); } else { events = this.serverSyncTree_.removeEventRegistration(query, eventRegistration); } this.eventQueue_.raiseEventsAtPath(query.path, events); }; Repo.prototype.interrupt = function () { if (this.persistentConnection_) { this.persistentConnection_.interrupt(INTERRUPT_REASON); } }; Repo.prototype.resume = function () { if (this.persistentConnection_) { this.persistentConnection_.resume(INTERRUPT_REASON); } }; Repo.prototype.stats = function (showDelta) { if (showDelta === void 0) { showDelta = false; } if (typeof console === 'undefined') return; var stats; if (showDelta) { if (!this.statsListener_) this.statsListener_ = new StatsListener(this.stats_); stats = this.statsListener_.get(); } else { stats = this.stats_.get(); } var longestName = Object.keys(stats).reduce(function (previousValue, currentValue) { return Math.max(currentValue.length, previousValue); }, 0); util.forEach(stats, function (stat, value) { // pad stat names to be the same length (plus 2 extra spaces). for (var i = stat.length; i < longestName + 2; i++) stat += ' '; console.log(stat + value); }); }; Repo.prototype.statsIncrementCounter = function (metric) { this.stats_.incrementCounter(metric); this.statsReporter_.includeStat(metric); }; /** * @param {...*} var_args * @private */ Repo.prototype.log_ = function () { var var_args = []; for (var _i = 0; _i < arguments.length; _i++) { var_args[_i] = arguments[_i]; } var prefix = ''; if (this.persistentConnection_) { prefix = this.persistentConnection_.id + ':'; } log.apply(void 0, [prefix].concat(var_args)); }; /** * @param {?function(?Error, *=)} callback * @param {!string} status * @param {?string=} errorReason */ Repo.prototype.callOnCompleteCallback = function (callback, status, errorReason) { if (callback) { exceptionGuard(function () { if (status == 'ok') { callback(null); } else { var code = (status || 'error').toUpperCase(); var message = code; if (errorReason) message += ': ' + errorReason; var error$$1 = new Error(message); error$$1.code = code; callback(error$$1); } }); } }; Object.defineProperty(Repo.prototype, "database", { get: function () { return this.__database || (this.__database = new Database(this)); }, enumerable: true, configurable: true }); return Repo; }()); /** * Copyright 2017 Google Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ /** * Filters nodes by range and uses an IndexFilter to track any changes after filtering the node * * @constructor * @implements {NodeFilter} */ var RangedFilter = /** @class */ (function () { /** * @param {!QueryParams} params */ function RangedFilter(params) { this.indexedFilter_ = new IndexedFilter(params.getIndex()); this.index_ = params.getIndex(); this.startPost_ = RangedFilter.getStartPost_(params); this.endPost_ = RangedFilter.getEndPost_(params); } /** * @return {!NamedNode} */ RangedFilter.prototype.getStartPost = function () { return this.startPost_; }; /** * @return {!NamedNode} */ RangedFilter.prototype.getEndPost = function () { return this.endPost_; }; /** * @param {!NamedNode} node * @return {boolean} */ RangedFilter.prototype.matches = function (node) { return (this.index_.compare(this.getStartPost(), node) <= 0 && this.index_.compare(node, this.getEndPost()) <= 0); }; /** * @inheritDoc */ RangedFilter.prototype.updateChild = function (snap, key, newChild, affectedPath, source, optChangeAccumulator) { if (!this.matches(new NamedNode(key, newChild))) { newChild = ChildrenNode.EMPTY_NODE; } return this.indexedFilter_.updateChild(snap, key, newChild, affectedPath, source, optChangeAccumulator); }; /** * @inheritDoc */ RangedFilter.prototype.updateFullNode = function (oldSnap, newSnap, optChangeAccumulator) { if (newSnap.isLeafNode()) { // Make sure we have a children node with the correct index, not a leaf node; newSnap = ChildrenNode.EMPTY_NODE; } var filtered = newSnap.withIndex(this.index_); // Don't support priorities on queries filtered = filtered.updatePriority(ChildrenNode.EMPTY_NODE); var self = this; newSnap.forEachChild(PRIORITY_INDEX, function (key, childNode) { if (!self.matches(new NamedNode(key, childNode))) { filtered = filtered.updateImmediateChild(key, ChildrenNode.EMPTY_NODE); } }); return this.indexedFilter_.updateFullNode(oldSnap, filtered, optChangeAccumulator); }; /** * @inheritDoc */ RangedFilter.prototype.updatePriority = function (oldSnap, newPriority) { // Don't support priorities on queries return oldSnap; }; /** * @inheritDoc */ RangedFilter.prototype.filtersNodes = function () { return true; }; /** * @inheritDoc */ RangedFilter.prototype.getIndexedFilter = function () { return this.indexedFilter_; }; /** * @inheritDoc */ RangedFilter.prototype.getIndex = function () { return this.index_; }; /** * @param {!QueryParams} params * @return {!NamedNode} * @private */ RangedFilter.getStartPost_ = function (params) { if (params.hasStart()) { var startName = params.getIndexStartName(); return params.getIndex().makePost(params.getIndexStartValue(), startName); } else { return params.getIndex().minPost(); } }; /** * @param {!QueryParams} params * @return {!NamedNode} * @private */ RangedFilter.getEndPost_ = function (params) { if (params.hasEnd()) { var endName = params.getIndexEndName(); return params.getIndex().makePost(params.getIndexEndValue(), endName); } else { return params.getIndex().maxPost(); } }; return RangedFilter; }()); /** * Copyright 2017 Google Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ /** * Applies a limit and a range to a node and uses RangedFilter to do the heavy lifting where possible * * @constructor * @implements {NodeFilter} */ var LimitedFilter = /** @class */ (function () { /** * @param {!QueryParams} params */ function LimitedFilter(params) { this.rangedFilter_ = new RangedFilter(params); this.index_ = params.getIndex(); this.limit_ = params.getLimit(); this.reverse_ = !params.isViewFromLeft(); } /** * @inheritDoc */ LimitedFilter.prototype.updateChild = function (snap, key, newChild, affectedPath, source, optChangeAccumulator) { if (!this.rangedFilter_.matches(new NamedNode(key, newChild))) { newChild = ChildrenNode.EMPTY_NODE; } if (snap.getImmediateChild(key).equals(newChild)) { // No change return snap; } else if (snap.numChildren() < this.limit_) { return this.rangedFilter_ .getIndexedFilter() .updateChild(snap, key, newChild, affectedPath, source, optChangeAccumulator); } else { return this.fullLimitUpdateChild_(snap, key, newChild, source, optChangeAccumulator); } }; /** * @inheritDoc */ LimitedFilter.prototype.updateFullNode = function (oldSnap, newSnap, optChangeAccumulator) { var filtered; if (newSnap.isLeafNode() || newSnap.isEmpty()) { // Make sure we have a children node with the correct index, not a leaf node; filtered = ChildrenNode.EMPTY_NODE.withIndex(this.index_); } else { if (this.limit_ * 2 < newSnap.numChildren() && newSnap.isIndexed(this.index_)) { // Easier to build up a snapshot, since what we're given has more than twice the elements we want filtered = ChildrenNode.EMPTY_NODE.withIndex(this.index_); // anchor to the startPost, endPost, or last element as appropriate var iterator = void 0; if (this.reverse_) { iterator = newSnap.getReverseIteratorFrom(this.rangedFilter_.getEndPost(), this.index_); } else { iterator = newSnap.getIteratorFrom(this.rangedFilter_.getStartPost(), this.index_); } var count = 0; while (iterator.hasNext() && count < this.limit_) { var next = iterator.getNext(); var inRange = void 0; if (this.reverse_) { inRange = this.index_.compare(this.rangedFilter_.getStartPost(), next) <= 0; } else { inRange = this.index_.compare(next, this.rangedFilter_.getEndPost()) <= 0; } if (inRange) { filtered = filtered.updateImmediateChild(next.name, next.node); count++; } else { // if we have reached the end post, we cannot keep adding elemments break; } } } else { // The snap contains less than twice the limit. Faster to delete from the snap than build up a new one filtered = newSnap.withIndex(this.index_); // Don't support priorities on queries filtered = filtered.updatePriority(ChildrenNode.EMPTY_NODE); var startPost = void 0; var endPost = void 0; var cmp = void 0; var iterator = void 0; if (this.reverse_) { iterator = filtered.getReverseIterator(this.index_); startPost = this.rangedFilter_.getEndPost(); endPost = this.rangedFilter_.getStartPost(); var indexCompare_1 = this.index_.getCompare(); cmp = function (a, b) { return indexCompare_1(b, a); }; } else { iterator = filtered.getIterator(this.index_); startPost = this.rangedFilter_.getStartPost(); endPost = this.rangedFilter_.getEndPost(); cmp = this.index_.getCompare(); } var count = 0; var foundStartPost = false; while (iterator.hasNext()) { var next = iterator.getNext(); if (!foundStartPost && cmp(startPost, next) <= 0) { // start adding foundStartPost = true; } var inRange = foundStartPost && count < this.limit_ && cmp(next, endPost) <= 0; if (inRange) { count++; } else { filtered = filtered.updateImmediateChild(next.name, ChildrenNode.EMPTY_NODE); } } } } return this.rangedFilter_ .getIndexedFilter() .updateFullNode(oldSnap, filtered, optChangeAccumulator); }; /** * @inheritDoc */ LimitedFilter.prototype.updatePriority = function (oldSnap, newPriority) { // Don't support priorities on queries return oldSnap; }; /** * @inheritDoc */ LimitedFilter.prototype.filtersNodes = function () { return true; }; /** * @inheritDoc */ LimitedFilter.prototype.getIndexedFilter = function () { return this.rangedFilter_.getIndexedFilter(); }; /** * @inheritDoc */ LimitedFilter.prototype.getIndex = function () { return this.index_; }; /** * @param {!Node} snap * @param {string} childKey * @param {!Node} childSnap * @param {!CompleteChildSource} source * @param {?ChildChangeAccumulator} changeAccumulator * @return {!Node} * @private */ LimitedFilter.prototype.fullLimitUpdateChild_ = function (snap, childKey, childSnap, source, changeAccumulator) { // TODO: rename all cache stuff etc to general snap terminology var cmp; if (this.reverse_) { var indexCmp_1 = this.index_.getCompare(); cmp = function (a, b) { return indexCmp_1(b, a); }; } else { cmp = this.index_.getCompare(); } var oldEventCache = snap; util.assert(oldEventCache.numChildren() == this.limit_, ''); var newChildNamedNode = new NamedNode(childKey, childSnap); var windowBoundary = this.reverse_ ? oldEventCache.getFirstChild(this.index_) : oldEventCache.getLastChild(this.index_); var inRange = this.rangedFilter_.matches(newChildNamedNode); if (oldEventCache.hasChild(childKey)) { var oldChildSnap = oldEventCache.getImmediateChild(childKey); var nextChild = source.getChildAfterChild(this.index_, windowBoundary, this.reverse_); while (nextChild != null && (nextChild.name == childKey || oldEventCache.hasChild(nextChild.name))) { // There is a weird edge case where a node is updated as part of a merge in the write tree, but hasn't // been applied to the limited filter yet. Ignore this next child which will be updated later in // the limited filter... nextChild = source.getChildAfterChild(this.index_, nextChild, this.reverse_); } var compareNext = nextChild == null ? 1 : cmp(nextChild, newChildNamedNode); var remainsInWindow = inRange && !childSnap.isEmpty() && compareNext >= 0; if (remainsInWindow) { if (changeAccumulator != null) { changeAccumulator.trackChildChange(Change.childChangedChange(childKey, childSnap, oldChildSnap)); } return oldEventCache.updateImmediateChild(childKey, childSnap); } else { if (changeAccumulator != null) { changeAccumulator.trackChildChange(Change.childRemovedChange(childKey, oldChildSnap)); } var newEventCache = oldEventCache.updateImmediateChild(childKey, ChildrenNode.EMPTY_NODE); var nextChildInRange = nextChild != null && this.rangedFilter_.matches(nextChild); if (nextChildInRange) { if (changeAccumulator != null) { changeAccumulator.trackChildChange(Change.childAddedChange(nextChild.name, nextChild.node)); } return newEventCache.updateImmediateChild(nextChild.name, nextChild.node); } else { return newEventCache; } } } else if (childSnap.isEmpty()) { // we're deleting a node, but it was not in the window, so ignore it return snap; } else if (inRange) { if (cmp(windowBoundary, newChildNamedNode) >= 0) { if (changeAccumulator != null) { changeAccumulator.trackChildChange(Change.childRemovedChange(windowBoundary.name, windowBoundary.node)); changeAccumulator.trackChildChange(Change.childAddedChange(childKey, childSnap)); } return oldEventCache .updateImmediateChild(childKey, childSnap) .updateImmediateChild(windowBoundary.name, ChildrenNode.EMPTY_NODE); } else { return snap; } } else { return snap; } }; return LimitedFilter; }()); /** * Copyright 2017 Google Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ /** * This class is an immutable-from-the-public-api struct containing a set of query parameters defining a * range to be returned for a particular location. It is assumed that validation of parameters is done at the * user-facing API level, so it is not done here. * @constructor */ var QueryParams = /** @class */ (function () { function QueryParams() { this.limitSet_ = false; this.startSet_ = false; this.startNameSet_ = false; this.endSet_ = false; this.endNameSet_ = false; this.limit_ = 0; this.viewFrom_ = ''; this.indexStartValue_ = null; this.indexStartName_ = ''; this.indexEndValue_ = null; this.indexEndName_ = ''; this.index_ = PRIORITY_INDEX; } /** * @return {boolean} */ QueryParams.prototype.hasStart = function () { return this.startSet_; }; /** * @return {boolean} True if it would return from left. */ QueryParams.prototype.isViewFromLeft = function () { if (this.viewFrom_ === '') { // limit(), rather than limitToFirst or limitToLast was called. // This means that only one of startSet_ and endSet_ is true. Use them // to calculate which side of the view to anchor to. If neither is set, // anchor to the end. return this.startSet_; } else { return (this.viewFrom_ === QueryParams.WIRE_PROTOCOL_CONSTANTS_.VIEW_FROM_LEFT); } }; /** * Only valid to call if hasStart() returns true * @return {*} */ QueryParams.prototype.getIndexStartValue = function () { util.assert(this.startSet_, 'Only valid if start has been set'); return this.indexStartValue_; }; /** * Only valid to call if hasStart() returns true. * Returns the starting key name for the range defined by these query parameters * @return {!string} */ QueryParams.prototype.getIndexStartName = function () { util.assert(this.startSet_, 'Only valid if start has been set'); if (this.startNameSet_) { return this.indexStartName_; } else { return MIN_NAME; } }; /** * @return {boolean} */ QueryParams.prototype.hasEnd = function () { return this.endSet_; }; /** * Only valid to call if hasEnd() returns true. * @return {*} */ QueryParams.prototype.getIndexEndValue = function () { util.assert(this.endSet_, 'Only valid if end has been set'); return this.indexEndValue_; }; /** * Only valid to call if hasEnd() returns true. * Returns the end key name for the range defined by these query parameters * @return {!string} */ QueryParams.prototype.getIndexEndName = function () { util.assert(this.endSet_, 'Only valid if end has been set'); if (this.endNameSet_) { return this.indexEndName_; } else { return MAX_NAME; } }; /** * @return {boolean} */ QueryParams.prototype.hasLimit = function () { return this.limitSet_; }; /** * @return {boolean} True if a limit has been set and it has been explicitly anchored */ QueryParams.prototype.hasAnchoredLimit = function () { return this.limitSet_ && this.viewFrom_ !== ''; }; /** * Only valid to call if hasLimit() returns true * @return {!number} */ QueryParams.prototype.getLimit = function () { util.assert(this.limitSet_, 'Only valid if limit has been set'); return this.limit_; }; /** * @return {!Index} */ QueryParams.prototype.getIndex = function () { return this.index_; }; /** * @return {!QueryParams} * @private */ QueryParams.prototype.copy_ = function () { var copy = new QueryParams(); copy.limitSet_ = this.limitSet_; copy.limit_ = this.limit_; copy.startSet_ = this.startSet_; copy.indexStartValue_ = this.indexStartValue_; copy.startNameSet_ = this.startNameSet_; copy.indexStartName_ = this.indexStartName_; copy.endSet_ = this.endSet_; copy.indexEndValue_ = this.indexEndValue_; copy.endNameSet_ = this.endNameSet_; copy.indexEndName_ = this.indexEndName_; copy.index_ = this.index_; copy.viewFrom_ = this.viewFrom_; return copy; }; /** * @param {!number} newLimit * @return {!QueryParams} */ QueryParams.prototype.limit = function (newLimit) { var newParams = this.copy_(); newParams.limitSet_ = true; newParams.limit_ = newLimit; newParams.viewFrom_ = ''; return newParams; }; /** * @param {!number} newLimit * @return {!QueryParams} */ QueryParams.prototype.limitToFirst = function (newLimit) { var newParams = this.copy_(); newParams.limitSet_ = true; newParams.limit_ = newLimit; newParams.viewFrom_ = QueryParams.WIRE_PROTOCOL_CONSTANTS_.VIEW_FROM_LEFT; return newParams; }; /** * @param {!number} newLimit * @return {!QueryParams} */ QueryParams.prototype.limitToLast = function (newLimit) { var newParams = this.copy_(); newParams.limitSet_ = true; newParams.limit_ = newLimit; newParams.viewFrom_ = QueryParams.WIRE_PROTOCOL_CONSTANTS_.VIEW_FROM_RIGHT; return newParams; }; /** * @param {*} indexValue * @param {?string=} key * @return {!QueryParams} */ QueryParams.prototype.startAt = function (indexValue, key) { var newParams = this.copy_(); newParams.startSet_ = true; if (!(indexValue !== undefined)) { indexValue = null; } newParams.indexStartValue_ = indexValue; if (key != null) { newParams.startNameSet_ = true; newParams.indexStartName_ = key; } else { newParams.startNameSet_ = false; newParams.indexStartName_ = ''; } return newParams; }; /** * @param {*} indexValue * @param {?string=} key * @return {!QueryParams} */ QueryParams.prototype.endAt = function (indexValue, key) { var newParams = this.copy_(); newParams.endSet_ = true; if (!(indexValue !== undefined)) { indexValue = null; } newParams.indexEndValue_ = indexValue; if (key !== undefined) { newParams.endNameSet_ = true; newParams.indexEndName_ = key; } else { newParams.endNameSet_ = false; newParams.indexEndName_ = ''; } return newParams; }; /** * @param {!Index} index * @return {!QueryParams} */ QueryParams.prototype.orderBy = function (index) { var newParams = this.copy_(); newParams.index_ = index; return newParams; }; /** * @return {!Object} */ QueryParams.prototype.getQueryObject = function () { var WIRE_PROTOCOL_CONSTANTS = QueryParams.WIRE_PROTOCOL_CONSTANTS_; var obj = {}; if (this.startSet_) { obj[WIRE_PROTOCOL_CONSTANTS.INDEX_START_VALUE] = this.indexStartValue_; if (this.startNameSet_) { obj[WIRE_PROTOCOL_CONSTANTS.INDEX_START_NAME] = this.indexStartName_; } } if (this.endSet_) { obj[WIRE_PROTOCOL_CONSTANTS.INDEX_END_VALUE] = this.indexEndValue_; if (this.endNameSet_) { obj[WIRE_PROTOCOL_CONSTANTS.INDEX_END_NAME] = this.indexEndName_; } } if (this.limitSet_) { obj[WIRE_PROTOCOL_CONSTANTS.LIMIT] = this.limit_; var viewFrom = this.viewFrom_; if (viewFrom === '') { if (this.isViewFromLeft()) { viewFrom = WIRE_PROTOCOL_CONSTANTS.VIEW_FROM_LEFT; } else { viewFrom = WIRE_PROTOCOL_CONSTANTS.VIEW_FROM_RIGHT; } } obj[WIRE_PROTOCOL_CONSTANTS.VIEW_FROM] = viewFrom; } // For now, priority index is the default, so we only specify if it's some other index if (this.index_ !== PRIORITY_INDEX) { obj[WIRE_PROTOCOL_CONSTANTS.INDEX] = this.index_.toString(); } return obj; }; /** * @return {boolean} */ QueryParams.prototype.loadsAllData = function () { return !(this.startSet_ || this.endSet_ || this.limitSet_); }; /** * @return {boolean} */ QueryParams.prototype.isDefault = function () { return this.loadsAllData() && this.index_ == PRIORITY_INDEX; }; /** * @return {!NodeFilter} */ QueryParams.prototype.getNodeFilter = function () { if (this.loadsAllData()) { return new IndexedFilter(this.getIndex()); } else if (this.hasLimit()) { return new LimitedFilter(this); } else { return new RangedFilter(this); } }; /** * Returns a set of REST query string parameters representing this query. * * @return {!Object.} query string parameters */ QueryParams.prototype.toRestQueryStringParameters = function () { var REST_CONSTANTS = QueryParams.REST_QUERY_CONSTANTS_; var qs = {}; if (this.isDefault()) { return qs; } var orderBy; if (this.index_ === PRIORITY_INDEX) { orderBy = REST_CONSTANTS.PRIORITY_INDEX; } else if (this.index_ === VALUE_INDEX) { orderBy = REST_CONSTANTS.VALUE_INDEX; } else if (this.index_ === KEY_INDEX) { orderBy = REST_CONSTANTS.KEY_INDEX; } else { util.assert(this.index_ instanceof PathIndex, 'Unrecognized index type!'); orderBy = this.index_.toString(); } qs[REST_CONSTANTS.ORDER_BY] = util.stringify(orderBy); if (this.startSet_) { qs[REST_CONSTANTS.START_AT] = util.stringify(this.indexStartValue_); if (this.startNameSet_) { qs[REST_CONSTANTS.START_AT] += ',' + util.stringify(this.indexStartName_); } } if (this.endSet_) { qs[REST_CONSTANTS.END_AT] = util.stringify(this.indexEndValue_); if (this.endNameSet_) { qs[REST_CONSTANTS.END_AT] += ',' + util.stringify(this.indexEndName_); } } if (this.limitSet_) { if (this.isViewFromLeft()) { qs[REST_CONSTANTS.LIMIT_TO_FIRST] = this.limit_; } else { qs[REST_CONSTANTS.LIMIT_TO_LAST] = this.limit_; } } return qs; }; /** * Wire Protocol Constants * @const * @enum {string} * @private */ QueryParams.WIRE_PROTOCOL_CONSTANTS_ = { INDEX_START_VALUE: 'sp', INDEX_START_NAME: 'sn', INDEX_END_VALUE: 'ep', INDEX_END_NAME: 'en', LIMIT: 'l', VIEW_FROM: 'vf', VIEW_FROM_LEFT: 'l', VIEW_FROM_RIGHT: 'r', INDEX: 'i' }; /** * REST Query Constants * @const * @enum {string} * @private */ QueryParams.REST_QUERY_CONSTANTS_ = { ORDER_BY: 'orderBy', PRIORITY_INDEX: '$priority', VALUE_INDEX: '$value', KEY_INDEX: '$key', START_AT: 'startAt', END_AT: 'endAt', LIMIT_TO_FIRST: 'limitToFirst', LIMIT_TO_LAST: 'limitToLast' }; /** * Default, empty query parameters * @type {!QueryParams} * @const */ QueryParams.DEFAULT = new QueryParams(); return QueryParams; }()); /** * Copyright 2017 Google Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ var Reference = /** @class */ (function (_super) { tslib_1.__extends(Reference, _super); /** * Call options: * new Reference(Repo, Path) or * new Reference(url: string, string|RepoManager) * * Externally - this is the firebase.database.Reference type. * * @param {!Repo} repo * @param {(!Path)} path * @extends {Query} */ function Reference(repo, path) { var _this = this; if (!(repo instanceof Repo)) { throw new Error('new Reference() no longer supported - use app.database().'); } // call Query's constructor, passing in the repo and path. _this = _super.call(this, repo, path, QueryParams.DEFAULT, false) || this; return _this; } /** @return {?string} */ Reference.prototype.getKey = function () { util.validateArgCount('Reference.key', 0, 0, arguments.length); if (this.path.isEmpty()) return null; else return this.path.getBack(); }; /** * @param {!(string|Path)} pathString * @return {!Reference} */ Reference.prototype.child = function (pathString) { util.validateArgCount('Reference.child', 1, 1, arguments.length); if (typeof pathString === 'number') { pathString = String(pathString); } else if (!(pathString instanceof Path)) { if (this.path.getFront() === null) validateRootPathString('Reference.child', 1, pathString, false); else validatePathString('Reference.child', 1, pathString, false); } return new Reference(this.repo, this.path.child(pathString)); }; /** @return {?Reference} */ Reference.prototype.getParent = function () { util.validateArgCount('Reference.parent', 0, 0, arguments.length); var parentPath = this.path.parent(); return parentPath === null ? null : new Reference(this.repo, parentPath); }; /** @return {!Reference} */ Reference.prototype.getRoot = function () { util.validateArgCount('Reference.root', 0, 0, arguments.length); var ref = this; while (ref.getParent() !== null) { ref = ref.getParent(); } return ref; }; /** @return {!Database} */ Reference.prototype.databaseProp = function () { return this.repo.database; }; /** * @param {*} newVal * @param {function(?Error)=} onComplete * @return {!Promise} */ Reference.prototype.set = function (newVal, onComplete) { util.validateArgCount('Reference.set', 1, 2, arguments.length); validateWritablePath('Reference.set', this.path); validateFirebaseDataArg('Reference.set', 1, newVal, this.path, false); util.validateCallback('Reference.set', 2, onComplete, true); var deferred = new util.Deferred(); this.repo.setWithPriority(this.path, newVal, /*priority=*/ null, deferred.wrapCallback(onComplete)); return deferred.promise; }; /** * @param {!Object} objectToMerge * @param {function(?Error)=} onComplete * @return {!Promise} */ Reference.prototype.update = function (objectToMerge, onComplete) { util.validateArgCount('Reference.update', 1, 2, arguments.length); validateWritablePath('Reference.update', this.path); if (Array.isArray(objectToMerge)) { var newObjectToMerge = {}; for (var i = 0; i < objectToMerge.length; ++i) { newObjectToMerge['' + i] = objectToMerge[i]; } objectToMerge = newObjectToMerge; warn('Passing an Array to Firebase.update() is deprecated. ' + 'Use set() if you want to overwrite the existing data, or ' + 'an Object with integer keys if you really do want to ' + 'only update some of the children.'); } validateFirebaseMergeDataArg('Reference.update', 1, objectToMerge, this.path, false); util.validateCallback('Reference.update', 2, onComplete, true); var deferred = new util.Deferred(); this.repo.update(this.path, objectToMerge, deferred.wrapCallback(onComplete)); return deferred.promise; }; /** * @param {*} newVal * @param {string|number|null} newPriority * @param {function(?Error)=} onComplete * @return {!Promise} */ Reference.prototype.setWithPriority = function (newVal, newPriority, onComplete) { util.validateArgCount('Reference.setWithPriority', 2, 3, arguments.length); validateWritablePath('Reference.setWithPriority', this.path); validateFirebaseDataArg('Reference.setWithPriority', 1, newVal, this.path, false); validatePriority('Reference.setWithPriority', 2, newPriority, false); util.validateCallback('Reference.setWithPriority', 3, onComplete, true); if (this.getKey() === '.length' || this.getKey() === '.keys') throw 'Reference.setWithPriority failed: ' + this.getKey() + ' is a read-only object.'; var deferred = new util.Deferred(); this.repo.setWithPriority(this.path, newVal, newPriority, deferred.wrapCallback(onComplete)); return deferred.promise; }; /** * @param {function(?Error)=} onComplete * @return {!Promise} */ Reference.prototype.remove = function (onComplete) { util.validateArgCount('Reference.remove', 0, 1, arguments.length); validateWritablePath('Reference.remove', this.path); util.validateCallback('Reference.remove', 1, onComplete, true); return this.set(null, onComplete); }; /** * @param {function(*):*} transactionUpdate * @param {(function(?Error, boolean, ?DataSnapshot))=} onComplete * @param {boolean=} applyLocally * @return {!Promise} */ Reference.prototype.transaction = function (transactionUpdate, onComplete, applyLocally) { util.validateArgCount('Reference.transaction', 1, 3, arguments.length); validateWritablePath('Reference.transaction', this.path); util.validateCallback('Reference.transaction', 1, transactionUpdate, false); util.validateCallback('Reference.transaction', 2, onComplete, true); // NOTE: applyLocally is an internal-only option for now. We need to decide if we want to keep it and how // to expose it. validateBoolean('Reference.transaction', 3, applyLocally, true); if (this.getKey() === '.length' || this.getKey() === '.keys') throw 'Reference.transaction failed: ' + this.getKey() + ' is a read-only object.'; if (applyLocally === undefined) applyLocally = true; var deferred = new util.Deferred(); if (typeof onComplete === 'function') { deferred.promise.catch(function () { }); } var promiseComplete = function (error$$1, committed, snapshot) { if (error$$1) { deferred.reject(error$$1); } else { deferred.resolve(new TransactionResult(committed, snapshot)); } if (typeof onComplete === 'function') { onComplete(error$$1, committed, snapshot); } }; this.repo.startTransaction(this.path, transactionUpdate, promiseComplete, applyLocally); return deferred.promise; }; /** * @param {string|number|null} priority * @param {function(?Error)=} onComplete * @return {!Promise} */ Reference.prototype.setPriority = function (priority, onComplete) { util.validateArgCount('Reference.setPriority', 1, 2, arguments.length); validateWritablePath('Reference.setPriority', this.path); validatePriority('Reference.setPriority', 1, priority, false); util.validateCallback('Reference.setPriority', 2, onComplete, true); var deferred = new util.Deferred(); this.repo.setWithPriority(this.path.child('.priority'), priority, null, deferred.wrapCallback(onComplete)); return deferred.promise; }; /** * @param {*=} value * @param {function(?Error)=} onComplete * @return {!Reference} */ Reference.prototype.push = function (value, onComplete) { util.validateArgCount('Reference.push', 0, 2, arguments.length); validateWritablePath('Reference.push', this.path); validateFirebaseDataArg('Reference.push', 1, value, this.path, true); util.validateCallback('Reference.push', 2, onComplete, true); var now = this.repo.serverTime(); var name = nextPushId(now); // push() returns a ThennableReference whose promise is fulfilled with a regular Reference. // We use child() to create handles to two different references. The first is turned into a // ThennableReference below by adding then() and catch() methods and is used as the // return value of push(). The second remains a regular Reference and is used as the fulfilled // value of the first ThennableReference. var thennablePushRef = this.child(name); var pushRef = this.child(name); var promise; if (value != null) { promise = thennablePushRef.set(value, onComplete).then(function () { return pushRef; }); } else { promise = Promise.resolve(pushRef); } thennablePushRef.then = promise.then.bind(promise); thennablePushRef.catch = promise.then.bind(promise, undefined); if (typeof onComplete === 'function') { promise.catch(function () { }); } return thennablePushRef; }; /** * @return {!OnDisconnect} */ Reference.prototype.onDisconnect = function () { validateWritablePath('Reference.onDisconnect', this.path); return new OnDisconnect(this.repo, this.path); }; Object.defineProperty(Reference.prototype, "database", { get: function () { return this.databaseProp(); }, enumerable: true, configurable: true }); Object.defineProperty(Reference.prototype, "key", { get: function () { return this.getKey(); }, enumerable: true, configurable: true }); Object.defineProperty(Reference.prototype, "parent", { get: function () { return this.getParent(); }, enumerable: true, configurable: true }); Object.defineProperty(Reference.prototype, "root", { get: function () { return this.getRoot(); }, enumerable: true, configurable: true }); return Reference; }(Query)); /** * Define reference constructor in various modules * * We are doing this here to avoid several circular * dependency issues */ Query.__referenceConstructor = Reference; SyncPoint.__referenceConstructor = Reference; /** * Copyright 2017 Google Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ /** * Node in a Tree. */ var TreeNode = /** @class */ (function () { function TreeNode() { // TODO: Consider making accessors that create children and value lazily or // separate Internal / Leaf 'types'. this.children = {}; this.childCount = 0; this.value = null; } return TreeNode; }()); /** * A light-weight tree, traversable by path. Nodes can have both values and children. * Nodes are not enumerated (by forEachChild) unless they have a value or non-empty * children. */ var Tree = /** @class */ (function () { /** * @template T * @param {string=} name_ Optional name of the node. * @param {Tree=} parent_ Optional parent node. * @param {TreeNode=} node_ Optional node to wrap. */ function Tree(name_, parent_, node_) { if (name_ === void 0) { name_ = ''; } if (parent_ === void 0) { parent_ = null; } if (node_ === void 0) { node_ = new TreeNode(); } this.name_ = name_; this.parent_ = parent_; this.node_ = node_; } /** * Returns a sub-Tree for the given path. * * @param {!(string|Path)} pathObj Path to look up. * @return {!Tree.} Tree for path. */ Tree.prototype.subTree = function (pathObj) { // TODO: Require pathObj to be Path? var path = pathObj instanceof Path ? pathObj : new Path(pathObj); var child = this, next; while ((next = path.getFront()) !== null) { var childNode = util.safeGet(child.node_.children, next) || new TreeNode(); child = new Tree(next, child, childNode); path = path.popFront(); } return child; }; /** * Returns the data associated with this tree node. * * @return {?T} The data or null if no data exists. */ Tree.prototype.getValue = function () { return this.node_.value; }; /** * Sets data to this tree node. * * @param {!T} value Value to set. */ Tree.prototype.setValue = function (value) { util.assert(typeof value !== 'undefined', 'Cannot set value to undefined'); this.node_.value = value; this.updateParents_(); }; /** * Clears the contents of the tree node (its value and all children). */ Tree.prototype.clear = function () { this.node_.value = null; this.node_.children = {}; this.node_.childCount = 0; this.updateParents_(); }; /** * @return {boolean} Whether the tree has any children. */ Tree.prototype.hasChildren = function () { return this.node_.childCount > 0; }; /** * @return {boolean} Whether the tree is empty (no value or children). */ Tree.prototype.isEmpty = function () { return this.getValue() === null && !this.hasChildren(); }; /** * Calls action for each child of this tree node. * * @param {function(!Tree.)} action Action to be called for each child. */ Tree.prototype.forEachChild = function (action) { var _this = this; util.forEach(this.node_.children, function (child, childTree) { action(new Tree(child, _this, childTree)); }); }; /** * Does a depth-first traversal of this node's descendants, calling action for each one. * * @param {function(!Tree.)} action Action to be called for each child. * @param {boolean=} includeSelf Whether to call action on this node as well. Defaults to * false. * @param {boolean=} childrenFirst Whether to call action on children before calling it on * parent. */ Tree.prototype.forEachDescendant = function (action, includeSelf, childrenFirst) { if (includeSelf && !childrenFirst) action(this); this.forEachChild(function (child) { child.forEachDescendant(action, /*includeSelf=*/ true, childrenFirst); }); if (includeSelf && childrenFirst) action(this); }; /** * Calls action on each ancestor node. * * @param {function(!Tree.)} action Action to be called on each parent; return * true to abort. * @param {boolean=} includeSelf Whether to call action on this node as well. * @return {boolean} true if the action callback returned true. */ Tree.prototype.forEachAncestor = function (action, includeSelf) { var node = includeSelf ? this : this.parent(); while (node !== null) { if (action(node)) { return true; } node = node.parent(); } return false; }; /** * Does a depth-first traversal of this node's descendants. When a descendant with a value * is found, action is called on it and traversal does not continue inside the node. * Action is *not* called on this node. * * @param {function(!Tree.)} action Action to be called for each child. */ Tree.prototype.forEachImmediateDescendantWithValue = function (action) { this.forEachChild(function (child) { if (child.getValue() !== null) action(child); else child.forEachImmediateDescendantWithValue(action); }); }; /** * @return {!Path} The path of this tree node, as a Path. */ Tree.prototype.path = function () { return new Path(this.parent_ === null ? this.name_ : this.parent_.path() + '/' + this.name_); }; /** * @return {string} The name of the tree node. */ Tree.prototype.name = function () { return this.name_; }; /** * @return {?Tree} The parent tree node, or null if this is the root of the tree. */ Tree.prototype.parent = function () { return this.parent_; }; /** * Adds or removes this child from its parent based on whether it's empty or not. * * @private */ Tree.prototype.updateParents_ = function () { if (this.parent_ !== null) this.parent_.updateChild_(this.name_, this); }; /** * Adds or removes the passed child to this tree node, depending on whether it's empty. * * @param {string} childName The name of the child to update. * @param {!Tree.} child The child to update. * @private */ Tree.prototype.updateChild_ = function (childName, child) { var childEmpty = child.isEmpty(); var childExists = util.contains(this.node_.children, childName); if (childEmpty && childExists) { delete this.node_.children[childName]; this.node_.childCount--; this.updateParents_(); } else if (!childEmpty && !childExists) { this.node_.children[childName] = child.node_; this.node_.childCount++; this.updateParents_(); } }; return Tree; }()); /** * Copyright 2017 Google Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ // TODO: This is pretty messy. Ideally, a lot of this would move into FirebaseData, or a transaction-specific // component used by FirebaseData, but it has ties to user callbacks (transaction update and onComplete) as well // as the realtime connection (to send transactions to the server). So that all needs to be decoupled first. // For now it's part of Repo, but in its own file. /** * @enum {number} */ var TransactionStatus; (function (TransactionStatus) { // We've run the transaction and updated transactionResultData_ with the result, but it isn't currently sent to the // server. A transaction will go from RUN -> SENT -> RUN if it comes back from the server as rejected due to // mismatched hash. TransactionStatus[TransactionStatus["RUN"] = 0] = "RUN"; // We've run the transaction and sent it to the server and it's currently outstanding (hasn't come back as accepted // or rejected yet). TransactionStatus[TransactionStatus["SENT"] = 1] = "SENT"; // Temporary state used to mark completed transactions (whether successful or aborted). The transaction will be // removed when we get a chance to prune completed ones. TransactionStatus[TransactionStatus["COMPLETED"] = 2] = "COMPLETED"; // Used when an already-sent transaction needs to be aborted (e.g. due to a conflicting set() call that was made). // If it comes back as unsuccessful, we'll abort it. TransactionStatus[TransactionStatus["SENT_NEEDS_ABORT"] = 3] = "SENT_NEEDS_ABORT"; // Temporary state used to mark transactions that need to be aborted. TransactionStatus[TransactionStatus["NEEDS_ABORT"] = 4] = "NEEDS_ABORT"; })(TransactionStatus || (TransactionStatus = {})); /** * If a transaction does not succeed after 25 retries, we abort it. Among other things this ensure that if there's * ever a bug causing a mismatch between client / server hashes for some data, we won't retry indefinitely. * @type {number} * @const * @private */ Repo.MAX_TRANSACTION_RETRIES_ = 25; /** * Setup the transaction data structures * @private */ Repo.prototype.transactions_init_ = function () { /** * Stores queues of outstanding transactions for Firebase locations. * * @type {!Tree.>} * @private */ this.transactionQueueTree_ = new Tree(); }; /** * Creates a new transaction, adds it to the transactions we're tracking, and sends it to the server if possible. * * @param {!Path} path Path at which to do transaction. * @param {function(*):*} transactionUpdate Update callback. * @param {?function(?Error, boolean, ?DataSnapshot)} onComplete Completion callback. * @param {boolean} applyLocally Whether or not to make intermediate results visible */ Repo.prototype.startTransaction = function (path, transactionUpdate, onComplete, applyLocally) { this.log_('transaction on ' + path); // Add a watch to make sure we get server updates. var valueCallback = function () { }; var watchRef = new Reference(this, path); watchRef.on('value', valueCallback); var unwatcher = function () { watchRef.off('value', valueCallback); }; // Initialize transaction. var transaction = { path: path, update: transactionUpdate, onComplete: onComplete, // One of TransactionStatus enums. status: null, // Used when combining transactions at different locations to figure out which one goes first. order: LUIDGenerator(), // Whether to raise local events for this transaction. applyLocally: applyLocally, // Count of how many times we've retried the transaction. retryCount: 0, // Function to call to clean up our .on() listener. unwatcher: unwatcher, // Stores why a transaction was aborted. abortReason: null, currentWriteId: null, currentInputSnapshot: null, currentOutputSnapshotRaw: null, currentOutputSnapshotResolved: null }; // Run transaction initially. var currentState = this.getLatestState_(path); transaction.currentInputSnapshot = currentState; var newVal = transaction.update(currentState.val()); if (newVal === undefined) { // Abort transaction. transaction.unwatcher(); transaction.currentOutputSnapshotRaw = null; transaction.currentOutputSnapshotResolved = null; if (transaction.onComplete) { // We just set the input snapshot, so this cast should be safe var snapshot = new DataSnapshot(transaction.currentInputSnapshot, new Reference(this, transaction.path), PRIORITY_INDEX); transaction.onComplete(null, false, snapshot); } } else { validateFirebaseData('transaction failed: Data returned ', newVal, transaction.path); // Mark as run and add to our queue. transaction.status = TransactionStatus.RUN; var queueNode = this.transactionQueueTree_.subTree(path); var nodeQueue = queueNode.getValue() || []; nodeQueue.push(transaction); queueNode.setValue(nodeQueue); // Update visibleData and raise events // Note: We intentionally raise events after updating all of our transaction state, since the user could // start new transactions from the event callbacks. var priorityForNode = void 0; if (typeof newVal === 'object' && newVal !== null && util.contains(newVal, '.priority')) { priorityForNode = util.safeGet(newVal, '.priority'); util.assert(isValidPriority(priorityForNode), 'Invalid priority returned by transaction. ' + 'Priority must be a valid string, finite number, server value, or null.'); } else { var currentNode = this.serverSyncTree_.calcCompleteEventCache(path) || ChildrenNode.EMPTY_NODE; priorityForNode = currentNode.getPriority().val(); } priorityForNode /** @type {null|number|string} */ = priorityForNode; var serverValues = this.generateServerValues(); var newNodeUnresolved = nodeFromJSON$1(newVal, priorityForNode); var newNode = resolveDeferredValueSnapshot(newNodeUnresolved, serverValues); transaction.currentOutputSnapshotRaw = newNodeUnresolved; transaction.currentOutputSnapshotResolved = newNode; transaction.currentWriteId = this.getNextWriteId_(); var events = this.serverSyncTree_.applyUserOverwrite(path, newNode, transaction.currentWriteId, transaction.applyLocally); this.eventQueue_.raiseEventsForChangedPath(path, events); this.sendReadyTransactions_(); } }; /** * @param {!Path} path * @param {Array.=} excludeSets A specific set to exclude * @return {Node} * @private */ Repo.prototype.getLatestState_ = function (path, excludeSets) { return (this.serverSyncTree_.calcCompleteEventCache(path, excludeSets) || ChildrenNode.EMPTY_NODE); }; /** * Sends any already-run transactions that aren't waiting for outstanding transactions to * complete. * * Externally it's called with no arguments, but it calls itself recursively with a particular * transactionQueueTree node to recurse through the tree. * * @param {Tree.>=} node transactionQueueTree node to start at. * @private */ Repo.prototype.sendReadyTransactions_ = function (node) { var _this = this; if (node === void 0) { node = this.transactionQueueTree_; } // Before recursing, make sure any completed transactions are removed. if (!node) { this.pruneCompletedTransactionsBelowNode_(node); } if (node.getValue() !== null) { var queue = this.buildTransactionQueue_(node); util.assert(queue.length > 0, 'Sending zero length transaction queue'); var allRun = queue.every(function (transaction) { return transaction.status === TransactionStatus.RUN; }); // If they're all run (and not sent), we can send them. Else, we must wait. if (allRun) { this.sendTransactionQueue_(node.path(), queue); } } else if (node.hasChildren()) { node.forEachChild(function (childNode) { _this.sendReadyTransactions_(childNode); }); } }; /** * Given a list of run transactions, send them to the server and then handle the result (success or failure). * * @param {!Path} path The location of the queue. * @param {!Array.} queue Queue of transactions under the specified location. * @private */ Repo.prototype.sendTransactionQueue_ = function (path, queue) { var _this = this; // Mark transactions as sent and increment retry count! var setsToIgnore = queue.map(function (txn) { return txn.currentWriteId; }); var latestState = this.getLatestState_(path, setsToIgnore); var snapToSend = latestState; var latestHash = latestState.hash(); for (var i = 0; i < queue.length; i++) { var txn = queue[i]; util.assert(txn.status === TransactionStatus.RUN, 'tryToSendTransactionQueue_: items in queue should all be run.'); txn.status = TransactionStatus.SENT; txn.retryCount++; var relativePath = Path.relativePath(path, txn.path); // If we've gotten to this point, the output snapshot must be defined. snapToSend = snapToSend.updateChild(relativePath /**@type {!Node} */, txn.currentOutputSnapshotRaw); } var dataToSend = snapToSend.val(true); var pathToSend = path; // Send the put. this.server_.put(pathToSend.toString(), dataToSend, function (status) { _this.log_('transaction put response', { path: pathToSend.toString(), status: status }); var events = []; if (status === 'ok') { // Queue up the callbacks and fire them after cleaning up all of our transaction state, since // the callback could trigger more transactions or sets. var callbacks = []; for (var i = 0; i < queue.length; i++) { queue[i].status = TransactionStatus.COMPLETED; events = events.concat(_this.serverSyncTree_.ackUserWrite(queue[i].currentWriteId)); if (queue[i].onComplete) { // We never unset the output snapshot, and given that this transaction is complete, it should be set var node = queue[i].currentOutputSnapshotResolved; var ref = new Reference(_this, queue[i].path); var snapshot = new DataSnapshot(node, ref, PRIORITY_INDEX); callbacks.push(queue[i].onComplete.bind(null, null, true, snapshot)); } queue[i].unwatcher(); } // Now remove the completed transactions. _this.pruneCompletedTransactionsBelowNode_(_this.transactionQueueTree_.subTree(path)); // There may be pending transactions that we can now send. _this.sendReadyTransactions_(); _this.eventQueue_.raiseEventsForChangedPath(path, events); // Finally, trigger onComplete callbacks. for (var i = 0; i < callbacks.length; i++) { exceptionGuard(callbacks[i]); } } else { // transactions are no longer sent. Update their status appropriately. if (status === 'datastale') { for (var i = 0; i < queue.length; i++) { if (queue[i].status === TransactionStatus.SENT_NEEDS_ABORT) queue[i].status = TransactionStatus.NEEDS_ABORT; else queue[i].status = TransactionStatus.RUN; } } else { warn('transaction at ' + pathToSend.toString() + ' failed: ' + status); for (var i = 0; i < queue.length; i++) { queue[i].status = TransactionStatus.NEEDS_ABORT; queue[i].abortReason = status; } } _this.rerunTransactions_(path); } }, latestHash); }; /** * Finds all transactions dependent on the data at changedPath and reruns them. * * Should be called any time cached data changes. * * Return the highest path that was affected by rerunning transactions. This is the path at which events need to * be raised for. * * @param {!Path} changedPath The path in mergedData that changed. * @return {!Path} The rootmost path that was affected by rerunning transactions. * @private */ Repo.prototype.rerunTransactions_ = function (changedPath) { var rootMostTransactionNode = this.getAncestorTransactionNode_(changedPath); var path = rootMostTransactionNode.path(); var queue = this.buildTransactionQueue_(rootMostTransactionNode); this.rerunTransactionQueue_(queue, path); return path; }; /** * Does all the work of rerunning transactions (as well as cleans up aborted transactions and whatnot). * * @param {Array.} queue The queue of transactions to run. * @param {!Path} path The path the queue is for. * @private */ Repo.prototype.rerunTransactionQueue_ = function (queue, path) { if (queue.length === 0) { return; // Nothing to do! } // Queue up the callbacks and fire them after cleaning up all of our transaction state, since // the callback could trigger more transactions or sets. var callbacks = []; var events = []; // Ignore all of the sets we're going to re-run. var txnsToRerun = queue.filter(function (q) { return q.status === TransactionStatus.RUN; }); var setsToIgnore = txnsToRerun.map(function (q) { return q.currentWriteId; }); for (var i = 0; i < queue.length; i++) { var transaction = queue[i]; var relativePath = Path.relativePath(path, transaction.path); var abortTransaction = false, abortReason = void 0; util.assert(relativePath !== null, 'rerunTransactionsUnderNode_: relativePath should not be null.'); if (transaction.status === TransactionStatus.NEEDS_ABORT) { abortTransaction = true; abortReason = transaction.abortReason; events = events.concat(this.serverSyncTree_.ackUserWrite(transaction.currentWriteId, true)); } else if (transaction.status === TransactionStatus.RUN) { if (transaction.retryCount >= Repo.MAX_TRANSACTION_RETRIES_) { abortTransaction = true; abortReason = 'maxretry'; events = events.concat(this.serverSyncTree_.ackUserWrite(transaction.currentWriteId, true)); } else { // This code reruns a transaction var currentNode = this.getLatestState_(transaction.path, setsToIgnore); transaction.currentInputSnapshot = currentNode; var newData = queue[i].update(currentNode.val()); if (newData !== undefined) { validateFirebaseData('transaction failed: Data returned ', newData, transaction.path); var newDataNode = nodeFromJSON$1(newData); var hasExplicitPriority = typeof newData === 'object' && newData != null && util.contains(newData, '.priority'); if (!hasExplicitPriority) { // Keep the old priority if there wasn't a priority explicitly specified. newDataNode = newDataNode.updatePriority(currentNode.getPriority()); } var oldWriteId = transaction.currentWriteId; var serverValues = this.generateServerValues(); var newNodeResolved = resolveDeferredValueSnapshot(newDataNode, serverValues); transaction.currentOutputSnapshotRaw = newDataNode; transaction.currentOutputSnapshotResolved = newNodeResolved; transaction.currentWriteId = this.getNextWriteId_(); // Mutates setsToIgnore in place setsToIgnore.splice(setsToIgnore.indexOf(oldWriteId), 1); events = events.concat(this.serverSyncTree_.applyUserOverwrite(transaction.path, newNodeResolved, transaction.currentWriteId, transaction.applyLocally)); events = events.concat(this.serverSyncTree_.ackUserWrite(oldWriteId, true)); } else { abortTransaction = true; abortReason = 'nodata'; events = events.concat(this.serverSyncTree_.ackUserWrite(transaction.currentWriteId, true)); } } } this.eventQueue_.raiseEventsForChangedPath(path, events); events = []; if (abortTransaction) { // Abort. queue[i].status = TransactionStatus.COMPLETED; // Removing a listener can trigger pruning which can muck with mergedData/visibleData (as it prunes data). // So defer the unwatcher until we're done. (function (unwatcher) { setTimeout(unwatcher, Math.floor(0)); })(queue[i].unwatcher); if (queue[i].onComplete) { if (abortReason === 'nodata') { var ref = new Reference(this, queue[i].path); // We set this field immediately, so it's safe to cast to an actual snapshot var lastInput /** @type {!Node} */ = queue[i].currentInputSnapshot; var snapshot = new DataSnapshot(lastInput, ref, PRIORITY_INDEX); callbacks.push(queue[i].onComplete.bind(null, null, false, snapshot)); } else { callbacks.push(queue[i].onComplete.bind(null, new Error(abortReason), false, null)); } } } } // Clean up completed transactions. this.pruneCompletedTransactionsBelowNode_(this.transactionQueueTree_); // Now fire callbacks, now that we're in a good, known state. for (var i = 0; i < callbacks.length; i++) { exceptionGuard(callbacks[i]); } // Try to send the transaction result to the server. this.sendReadyTransactions_(); }; /** * Returns the rootmost ancestor node of the specified path that has a pending transaction on it, or just returns * the node for the given path if there are no pending transactions on any ancestor. * * @param {!Path} path The location to start at. * @return {!Tree.>} The rootmost node with a transaction. * @private */ Repo.prototype.getAncestorTransactionNode_ = function (path) { var front; // Start at the root and walk deeper into the tree towards path until we find a node with pending transactions. var transactionNode = this.transactionQueueTree_; while ((front = path.getFront()) !== null && transactionNode.getValue() === null) { transactionNode = transactionNode.subTree(front); path = path.popFront(); } return transactionNode; }; /** * Builds the queue of all transactions at or below the specified transactionNode. * * @param {!Tree.>} transactionNode * @return {Array.} The generated queue. * @private */ Repo.prototype.buildTransactionQueue_ = function (transactionNode) { // Walk any child transaction queues and aggregate them into a single queue. var transactionQueue = []; this.aggregateTransactionQueuesForNode_(transactionNode, transactionQueue); // Sort them by the order the transactions were created. transactionQueue.sort(function (a, b) { return a.order - b.order; }); return transactionQueue; }; /** * @param {!Tree.>} node * @param {Array.} queue * @private */ Repo.prototype.aggregateTransactionQueuesForNode_ = function (node, queue) { var _this = this; var nodeQueue = node.getValue(); if (nodeQueue !== null) { for (var i = 0; i < nodeQueue.length; i++) { queue.push(nodeQueue[i]); } } node.forEachChild(function (child) { _this.aggregateTransactionQueuesForNode_(child, queue); }); }; /** * Remove COMPLETED transactions at or below this node in the transactionQueueTree_. * * @param {!Tree.>} node * @private */ Repo.prototype.pruneCompletedTransactionsBelowNode_ = function (node) { var _this = this; var queue = node.getValue(); if (queue) { var to = 0; for (var from = 0; from < queue.length; from++) { if (queue[from].status !== TransactionStatus.COMPLETED) { queue[to] = queue[from]; to++; } } queue.length = to; node.setValue(queue.length > 0 ? queue : null); } node.forEachChild(function (childNode) { _this.pruneCompletedTransactionsBelowNode_(childNode); }); }; /** * Aborts all transactions on ancestors or descendants of the specified path. Called when doing a set() or update() * since we consider them incompatible with transactions. * * @param {!Path} path Path for which we want to abort related transactions. * @return {!Path} * @private */ Repo.prototype.abortTransactions_ = function (path) { var _this = this; var affectedPath = this.getAncestorTransactionNode_(path).path(); var transactionNode = this.transactionQueueTree_.subTree(path); transactionNode.forEachAncestor(function (node) { _this.abortTransactionsOnNode_(node); }); this.abortTransactionsOnNode_(transactionNode); transactionNode.forEachDescendant(function (node) { _this.abortTransactionsOnNode_(node); }); return affectedPath; }; /** * Abort transactions stored in this transaction queue node. * * @param {!Tree.>} node Node to abort transactions for. * @private */ Repo.prototype.abortTransactionsOnNode_ = function (node) { var queue = node.getValue(); if (queue !== null) { // Queue up the callbacks and fire them after cleaning up all of our transaction state, since // the callback could trigger more transactions or sets. var callbacks = []; // Go through queue. Any already-sent transactions must be marked for abort, while the unsent ones // can be immediately aborted and removed. var events = []; var lastSent = -1; for (var i = 0; i < queue.length; i++) { if (queue[i].status === TransactionStatus.SENT_NEEDS_ABORT) { // Already marked. No action needed. } else if (queue[i].status === TransactionStatus.SENT) { util.assert(lastSent === i - 1, 'All SENT items should be at beginning of queue.'); lastSent = i; // Mark transaction for abort when it comes back. queue[i].status = TransactionStatus.SENT_NEEDS_ABORT; queue[i].abortReason = 'set'; } else { util.assert(queue[i].status === TransactionStatus.RUN, 'Unexpected transaction status in abort'); // We can abort it immediately. queue[i].unwatcher(); events = events.concat(this.serverSyncTree_.ackUserWrite(queue[i].currentWriteId, true)); if (queue[i].onComplete) { var snapshot = null; callbacks.push(queue[i].onComplete.bind(null, new Error('set'), false, snapshot)); } } } if (lastSent === -1) { // We're not waiting for any sent transactions. We can clear the queue. node.setValue(null); } else { // Remove the transactions we aborted. queue.length = lastSent + 1; } // Now fire the callbacks. this.eventQueue_.raiseEventsForChangedPath(node.path(), events); for (var i = 0; i < callbacks.length; i++) { exceptionGuard(callbacks[i]); } } }; /** * Copyright 2017 Google Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ /** @const {string} */ var DATABASE_URL_OPTION = 'databaseURL'; var _staticInstance; /** * Creates and caches Repo instances. */ var RepoManager = /** @class */ (function () { function RepoManager() { /** * @private {!Object.>} */ this.repos_ = {}; /** * If true, new Repos will be created to use ReadonlyRestClient (for testing purposes). * @private {boolean} */ this.useRestClient_ = false; } RepoManager.getInstance = function () { if (!_staticInstance) { _staticInstance = new RepoManager(); } return _staticInstance; }; // TODO(koss): Remove these functions unless used in tests? RepoManager.prototype.interrupt = function () { for (var appName in this.repos_) { for (var dbUrl in this.repos_[appName]) { this.repos_[appName][dbUrl].interrupt(); } } }; RepoManager.prototype.resume = function () { for (var appName in this.repos_) { for (var dbUrl in this.repos_[appName]) { this.repos_[appName][dbUrl].resume(); } } }; /** * This function should only ever be called to CREATE a new database instance. * * @param {!FirebaseApp} app * @return {!Database} */ RepoManager.prototype.databaseFromApp = function (app, url) { var dbUrl = url || app.options[DATABASE_URL_OPTION]; if (dbUrl === undefined) { fatal("Can't determine Firebase Database URL. Be sure to include " + DATABASE_URL_OPTION + ' option when calling firebase.initializeApp().'); } var parsedUrl = parseRepoInfo(dbUrl); var repoInfo = parsedUrl.repoInfo; validateUrl('Invalid Firebase Database URL', 1, parsedUrl); if (!parsedUrl.path.isEmpty()) { fatal('Database URL must point to the root of a Firebase Database ' + '(not including a child path).'); } var repo = this.createRepo(repoInfo, app); return repo.database; }; /** * Remove the repo and make sure it is disconnected. * * @param {!Repo} repo */ RepoManager.prototype.deleteRepo = function (repo) { var appRepos = util.safeGet(this.repos_, repo.app.name); // This should never happen... if (!appRepos || util.safeGet(appRepos, repo.repoInfo_.toURLString()) !== repo) { fatal("Database " + repo.app.name + "(" + repo.repoInfo_ + ") has already been deleted."); } repo.interrupt(); delete appRepos[repo.repoInfo_.toURLString()]; }; /** * Ensures a repo doesn't already exist and then creates one using the * provided app. * * @param {!RepoInfo} repoInfo The metadata about the Repo * @param {!FirebaseApp} app * @return {!Repo} The Repo object for the specified server / repoName. */ RepoManager.prototype.createRepo = function (repoInfo, app) { var appRepos = util.safeGet(this.repos_, app.name); if (!appRepos) { appRepos = {}; this.repos_[app.name] = appRepos; } var repo = util.safeGet(appRepos, repoInfo.toURLString()); if (repo) { fatal('Database initialized multiple times. Please make sure the format of the database URL matches with each database() call.'); } repo = new Repo(repoInfo, this.useRestClient_, app); appRepos[repoInfo.toURLString()] = repo; return repo; }; /** * Forces us to use ReadonlyRestClient instead of PersistentConnection for new Repos. * @param {boolean} forceRestClient */ RepoManager.prototype.forceRestClient = function (forceRestClient) { this.useRestClient_ = forceRestClient; }; return RepoManager; }()); /** * Copyright 2017 Google Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ /** * Class representing a firebase database. * @implements {FirebaseService} */ var Database = /** @class */ (function () { /** * The constructor should not be called by users of our public API. * @param {!Repo} repo_ */ function Database(repo_) { this.repo_ = repo_; if (!(repo_ instanceof Repo)) { fatal("Don't call new Database() directly - please use firebase.database()."); } /** @type {Reference} */ this.root_ = new Reference(repo_, Path.Empty); this.INTERNAL = new DatabaseInternals(this); } Object.defineProperty(Database.prototype, "app", { get: function () { return this.repo_.app; }, enumerable: true, configurable: true }); Database.prototype.ref = function (path) { this.checkDeleted_('ref'); util.validateArgCount('database.ref', 0, 1, arguments.length); if (path instanceof Reference) { return this.refFromURL(path.toString()); } return path !== undefined ? this.root_.child(path) : this.root_; }; /** * Returns a reference to the root or the path specified in url. * We throw a exception if the url is not in the same domain as the * current repo. * @param {string} url * @return {!Reference} Firebase reference. */ Database.prototype.refFromURL = function (url) { /** @const {string} */ var apiName = 'database.refFromURL'; this.checkDeleted_(apiName); util.validateArgCount(apiName, 1, 1, arguments.length); var parsedURL = parseRepoInfo(url); validateUrl(apiName, 1, parsedURL); var repoInfo = parsedURL.repoInfo; if (repoInfo.host !== this.repo_.repoInfo_.host) { fatal(apiName + ': Host name does not match the current database: ' + '(found ' + repoInfo.host + ' but expected ' + this.repo_.repoInfo_.host + ')'); } return this.ref(parsedURL.path.toString()); }; /** * @param {string} apiName */ Database.prototype.checkDeleted_ = function (apiName) { if (this.repo_ === null) { fatal('Cannot call ' + apiName + ' on a deleted database.'); } }; // Make individual repo go offline. Database.prototype.goOffline = function () { util.validateArgCount('database.goOffline', 0, 0, arguments.length); this.checkDeleted_('goOffline'); this.repo_.interrupt(); }; Database.prototype.goOnline = function () { util.validateArgCount('database.goOnline', 0, 0, arguments.length); this.checkDeleted_('goOnline'); this.repo_.resume(); }; Database.ServerValue = { TIMESTAMP: { '.sv': 'timestamp' } }; return Database; }()); var DatabaseInternals = /** @class */ (function () { /** @param {!Database} database */ function DatabaseInternals(database) { this.database = database; } /** @return {Promise} */ DatabaseInternals.prototype.delete = function () { return tslib_1.__awaiter(this, void 0, void 0, function () { return tslib_1.__generator(this, function (_a) { this.database.checkDeleted_('delete'); RepoManager.getInstance().deleteRepo(this.database.repo_); this.database.repo_ = null; this.database.root_ = null; this.database.INTERNAL = null; this.database = null; return [2 /*return*/]; }); }); }; return DatabaseInternals; }()); /** * Copyright 2017 Google Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ /** * INTERNAL methods for internal-use only (tests, etc.). * * Customers shouldn't use these or else should be aware that they could break at any time. * * @const */ var forceLongPolling = function () { WebSocketConnection.forceDisallow(); BrowserPollConnection.forceAllow(); }; var forceWebSockets = function () { BrowserPollConnection.forceDisallow(); }; /* Used by App Manager */ var isWebSocketsAvailable = function () { return WebSocketConnection['isAvailable'](); }; var setSecurityDebugCallback = function (ref, callback) { ref.repo.persistentConnection_.securityDebugCallback_ = callback; }; var stats = function (ref, showDelta) { ref.repo.stats(showDelta); }; var statsIncrementCounter = function (ref, metric) { ref.repo.statsIncrementCounter(metric); }; var dataUpdateCount = function (ref) { return ref.repo.dataUpdateCount; }; var interceptServerData = function (ref, callback) { return ref.repo.interceptServerData_(callback); }; var INTERNAL = /*#__PURE__*/Object.freeze({ forceLongPolling: forceLongPolling, forceWebSockets: forceWebSockets, isWebSocketsAvailable: isWebSocketsAvailable, setSecurityDebugCallback: setSecurityDebugCallback, stats: stats, statsIncrementCounter: statsIncrementCounter, dataUpdateCount: dataUpdateCount, interceptServerData: interceptServerData }); /** * Copyright 2017 Google Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ var DataConnection = PersistentConnection; /** * @param {!string} pathString * @param {function(*)} onComplete */ PersistentConnection.prototype.simpleListen = function (pathString, onComplete) { this.sendRequest('q', { p: pathString }, onComplete); }; /** * @param {*} data * @param {function(*)} onEcho */ PersistentConnection.prototype.echo = function (data, onEcho) { this.sendRequest('echo', { d: data }, onEcho); }; // RealTimeConnection properties that we use in tests. var RealTimeConnection = Connection; /** * @param {function(): string} newHash * @return {function()} */ var hijackHash = function (newHash) { var oldPut = PersistentConnection.prototype.put; PersistentConnection.prototype.put = function (pathString, data, opt_onComplete, opt_hash) { if (opt_hash !== undefined) { opt_hash = newHash(); } oldPut.call(this, pathString, data, opt_onComplete, opt_hash); }; return function () { PersistentConnection.prototype.put = oldPut; }; }; /** * @type {function(new:RepoInfo, !string, boolean, !string, boolean): undefined} */ var ConnectionTarget = RepoInfo; /** * @param {!Query} query * @return {!string} */ var queryIdentifier = function (query) { return query.queryIdentifier(); }; /** * @param {!Query} firebaseRef * @return {!Object} */ var listens = function (firebaseRef) { return firebaseRef.repo.persistentConnection_.listens_; }; /** * Forces the RepoManager to create Repos that use ReadonlyRestClient instead of PersistentConnection. * * @param {boolean} forceRestClient */ var forceRestClient = function (forceRestClient) { RepoManager.getInstance().forceRestClient(forceRestClient); }; var TEST_ACCESS = /*#__PURE__*/Object.freeze({ DataConnection: DataConnection, RealTimeConnection: RealTimeConnection, hijackHash: hijackHash, ConnectionTarget: ConnectionTarget, queryIdentifier: queryIdentifier, listens: listens, forceRestClient: forceRestClient }); /** * Copyright 2017 Google Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ var ServerValue = Database.ServerValue; function registerDatabase(instance) { // Register the Database Service with the 'firebase' namespace. var namespace = instance.INTERNAL.registerService('database', function (app, unused, url) { return RepoManager.getInstance().databaseFromApp(app, url); }, // firebase.database namespace properties { Reference: Reference, Query: Query, Database: Database, enableLogging: enableLogging, INTERNAL: INTERNAL, ServerValue: ServerValue, TEST_ACCESS: TEST_ACCESS }, null, true); if (util.isNodeSdk()) { module.exports = namespace; } } registerDatabase(firebase); exports.registerDatabase = registerDatabase; exports.Database = Database; exports.Query = Query; exports.Reference = Reference; exports.enableLogging = enableLogging; exports.ServerValue = ServerValue; exports.DataSnapshot = DataSnapshot; exports.OnDisconnect = OnDisconnect;