Remove namespace import for objUtils (#2807)

Author: schmidt-sebastian

packages/firestore/src/api/database.ts

@@ -70,7 +70,6 @@ import {
 } from '../util/input_validation';
 import { logError, setLogLevel, LogLevel, getLogLevel } from '../util/log';
 import { AutoId } from '../util/misc';
-import * as objUtils from '../util/obj';
 import { Deferred, Rejecter, Resolver } from '../util/promise';
 import { FieldPath as ExternalFieldPath } from './field_path';
 
@@ -166,7 +165,7 @@ class FirestoreSettings {
       this.host = settings.host;
 
       validateNamedOptionalType('settings', 'boolean', 'ssl', settings.ssl);
-      this.ssl = objUtils.defaulted(settings.ssl, DEFAULT_SSL);
+      this.ssl = settings.ssl ?? DEFAULT_SSL;
     }
     validateOptionNames('settings', settings, [
       'host',
@@ -222,10 +221,8 @@ class FirestoreSettings {
   Please audit all existing usages of Date when you enable the new
   behavior.`);
     }
-    this.timestampsInSnapshots = objUtils.defaulted(
-      settings.timestampsInSnapshots,
-      DEFAULT_TIMESTAMPS_IN_SNAPSHOTS
-    );
+    this.timestampsInSnapshots =
+      settings.timestampsInSnapshots ?? DEFAULT_TIMESTAMPS_IN_SNAPSHOTS;
 
     validateNamedOptionalType(
       'settings',
@@ -341,9 +338,7 @@ export class Firestore implements firestore.FirebaseFirestore, FirebaseService {
     validateExactNumberOfArgs('Firestore.settings', arguments, 1);
     validateArgType('Firestore.settings', 'object', 1, settingsLiteral);
 
-    if (
-      objUtils.contains(settingsLiteral as objUtils.Dict<{}>, 'persistence')
-    ) {
+    if (contains(settingsLiteral, 'persistence')) {
       throw new FirestoreError(
         Code.INVALID_ARGUMENT,
         '"persistence" is now specified with a separate call to ' +
@@ -398,12 +393,10 @@ export class Firestore implements firestore.FirebaseFirestore, FirebaseService {
             "firestore.enablePersistence() call to use 'synchronizeTabs'."
         );
       }
-      synchronizeTabs = objUtils.defaulted(
-        settings.synchronizeTabs !== undefined
-          ? settings.synchronizeTabs
-          : settings.experimentalTabSynchronization,
-        DEFAULT_SYNCHRONIZE_TABS
-      );
+      synchronizeTabs =
+        settings.synchronizeTabs ??
+        settings.experimentalTabSynchronization ??
+        DEFAULT_SYNCHRONIZE_TABS;
     }
 
     return this.configureClient(this._persistenceProvider, {
@@ -558,15 +551,14 @@ export class Firestore implements firestore.FirebaseFirestore, FirebaseService {
   }
 
   private static databaseIdFromApp(app: FirebaseApp): DatabaseId {
-    const options = app.options as objUtils.Dict<{}>;
-    if (!objUtils.contains(options, 'projectId')) {
+    if (!contains(app.options, 'projectId')) {
       throw new FirestoreError(
         Code.INVALID_ARGUMENT,
         '"projectId" not provided in firebase.initializeApp.'
       );
     }
 
-    const projectId = options['projectId'];
+    const projectId = app.options.projectId;
     if (!projectId || typeof projectId !== 'string') {
       throw new FirestoreError(
         Code.INVALID_ARGUMENT,
@@ -2628,6 +2620,10 @@ function applyFirestoreDataConverter<T>(
   return [convertedValue, functionName];
 }
 
+function contains(obj: object, key: string): obj is { key : unknown } {
+  return Object.prototype.hasOwnProperty.call(obj, key);
+}
+
 // Export the classes with a private constructor (it will fail if invoked
 // at runtime). Note that this still allows instanceof checks.
 

packages/firestore/src/core/sync_engine.ts

@@ -45,7 +45,6 @@ import {
   QueryTargetState,
   SharedClientStateSyncer
 } from '../local/shared_client_state_syncer';
-import * as objUtils from '../util/obj';
 import { SortedSet } from '../util/sorted_set';
 import { ListenSequence } from './listen_sequence';
 import { Query, LimitType } from './query';
@@ -147,7 +146,7 @@ export class SyncEngine implements RemoteSyncer, SharedClientStateSyncer {
   private queryViewsByQuery = new ObjectMap<Query, QueryView>(q =>
     q.canonicalId()
   );
-  private queriesByTarget: { [targetId: number]: Query[] } = {};
+  private queriesByTarget = new Map<TargetId, Query[]>();
   /**
    * The keys of documents that are in limbo for which we haven't yet started a
    * limbo resolution query.
@@ -164,9 +163,7 @@ export class SyncEngine implements RemoteSyncer, SharedClientStateSyncer {
    * Keeps track of the information about an active limbo resolution for each
    * active target ID that was started for the purpose of limbo resolution.
    */
-  private activeLimboResolutionsByTarget: {
-    [targetId: number]: LimboResolution;
-  } = {};
+  private activeLimboResolutionsByTarget = new Map<TargetId, LimboResolution>();
   private limboDocumentRefs = new ReferenceSet();
   /** Stores user completion handlers, indexed by User and BatchId. */
   private mutationUserCallbacks = {} as {
@@ -285,10 +282,11 @@ export class SyncEngine implements RemoteSyncer, SharedClientStateSyncer {
 
     const data = new QueryView(query, targetId, view);
     this.queryViewsByQuery.set(query, data);
-    if (!this.queriesByTarget[targetId]) {
-      this.queriesByTarget[targetId] = [];
+    if (this.queriesByTarget.has(targetId)) {
+      this.queriesByTarget.get(targetId)!.push(query);
+    } else {
+      this.queriesByTarget.set(targetId, [query]);
     }
-    this.queriesByTarget[targetId].push(query);
     return viewChange.snapshot!;
   }
 
@@ -322,10 +320,11 @@ export class SyncEngine implements RemoteSyncer, SharedClientStateSyncer {
 
     // Only clean up the query view and target if this is the only query mapped
     // to the target.
-    const queries = this.queriesByTarget[queryView.targetId];
+    const queries = this.queriesByTarget.get(queryView.targetId)!;
     if (queries.length > 1) {
-      this.queriesByTarget[queryView.targetId] = queries.filter(
-        q => !q.isEqual(query)
+      this.queriesByTarget.set(
+        queryView.targetId,
+        queries.filter(q => !q.isEqual(query))
       );
       this.queryViewsByQuery.delete(query);
       return;
@@ -413,10 +412,10 @@ export class SyncEngine implements RemoteSyncer, SharedClientStateSyncer {
     try {
       const changes = await this.localStore.applyRemoteEvent(remoteEvent);
       // Update `receivedDocument` as appropriate for any limbo targets.
-      objUtils.forEach(remoteEvent.targetChanges, (targetId, targetChange) => {
-        const limboResolution = this.activeLimboResolutionsByTarget[
-          Number(targetId)
-        ];
+      remoteEvent.targetChanges.forEach((targetChange, targetId) => {
+        const limboResolution = this.activeLimboResolutionsByTarget.get(
+          targetId
+        );
         if (limboResolution) {
           // Since this is a limbo resolution lookup, it's for a single document
           // and it could be added, modified, or removed, but not a combination.
@@ -495,15 +494,15 @@ export class SyncEngine implements RemoteSyncer, SharedClientStateSyncer {
     // PORTING NOTE: Multi-tab only.
     this.sharedClientState.updateQueryState(targetId, 'rejected', err);
 
-    const limboResolution = this.activeLimboResolutionsByTarget[targetId];
+    const limboResolution = this.activeLimboResolutionsByTarget.get(targetId);
     const limboKey = limboResolution && limboResolution.key;
     if (limboKey) {
       // Since this query failed, we won't want to manually unlisten to it.
       // So go ahead and remove it from bookkeeping.
       this.activeLimboTargetsByKey = this.activeLimboTargetsByKey.remove(
         limboKey
       );
-      delete this.activeLimboResolutionsByTarget[targetId];
+      this.activeLimboResolutionsByTarget.delete(targetId);
       this.pumpEnqueuedLimboResolutions();
 
       // TODO(klimt): We really only should do the following on permission
@@ -523,7 +522,7 @@ export class SyncEngine implements RemoteSyncer, SharedClientStateSyncer {
       const resolvedLimboDocuments = documentKeySet().add(limboKey);
       const event = new RemoteEvent(
         SnapshotVersion.MIN,
-        /* targetChanges= */ {},
+        /* targetChanges= */ new Map<TargetId, TargetChange>(),
         /* targetMismatches= */ new SortedSet<TargetId>(primitiveComparator),
         documentUpdates,
         resolvedLimboDocuments
@@ -720,19 +719,19 @@ export class SyncEngine implements RemoteSyncer, SharedClientStateSyncer {
     this.sharedClientState.removeLocalQueryTarget(targetId);
 
     assert(
-      this.queriesByTarget[targetId] &&
-        this.queriesByTarget[targetId].length !== 0,
+      this.queriesByTarget.has(targetId) &&
+        this.queriesByTarget.get(targetId)!.length !== 0,
       `There are no queries mapped to target id ${targetId}`
     );
 
-    for (const query of this.queriesByTarget[targetId]) {
+    for (const query of this.queriesByTarget.get(targetId)!) {
       this.queryViewsByQuery.delete(query);
       if (error) {
         this.syncEngineListener!.onWatchError(query, error);
       }
     }
 
-    delete this.queriesByTarget[targetId];
+    this.queriesByTarget.delete(targetId);
 
     if (this.isPrimary) {
       const limboKeys = this.limboDocumentRefs.referencesForId(targetId);
@@ -758,7 +757,7 @@ export class SyncEngine implements RemoteSyncer, SharedClientStateSyncer {
 
     this.remoteStore.unlisten(limboTargetId);
     this.activeLimboTargetsByKey = this.activeLimboTargetsByKey.remove(key);
-    delete this.activeLimboResolutionsByTarget[limboTargetId];
+    this.activeLimboResolutionsByTarget.delete(limboTargetId);
     this.pumpEnqueuedLimboResolutions();
   }
 
@@ -810,8 +809,9 @@ export class SyncEngine implements RemoteSyncer, SharedClientStateSyncer {
     ) {
       const key = this.enqueuedLimboResolutions.shift()!;
       const limboTargetId = this.limboTargetIdGenerator.next();
-      this.activeLimboResolutionsByTarget[limboTargetId] = new LimboResolution(
-        key
+      this.activeLimboResolutionsByTarget.set(
+        limboTargetId,
+        new LimboResolution(key)
       );
       this.activeLimboTargetsByKey = this.activeLimboTargetsByKey.insert(
         key,
@@ -868,7 +868,7 @@ export class SyncEngine implements RemoteSyncer, SharedClientStateSyncer {
           })
           .then((viewDocChanges: ViewDocumentChanges) => {
             const targetChange =
-              remoteEvent && remoteEvent.targetChanges[queryView.targetId];
+              remoteEvent && remoteEvent.targetChanges.get(queryView.targetId);
             const viewChange = queryView.view.applyChanges(
               viewDocChanges,
               /* updateLimboDocuments= */ this.isPrimary === true,
@@ -957,7 +957,7 @@ export class SyncEngine implements RemoteSyncer, SharedClientStateSyncer {
       const activeTargets: TargetId[] = [];
 
       let p = Promise.resolve();
-      objUtils.forEachNumber(this.queriesByTarget, (targetId, _) => {
+      this.queriesByTarget.forEach((_, targetId) => {
         if (this.sharedClientState.isLocalQueryTarget(targetId)) {
           activeTargets.push(targetId);
         } else {
@@ -981,11 +981,11 @@ export class SyncEngine implements RemoteSyncer, SharedClientStateSyncer {
 
   // PORTING NOTE: Multi-tab only.
   private resetLimboDocuments(): void {
-    objUtils.forEachNumber(this.activeLimboResolutionsByTarget, targetId => {
+    this.activeLimboResolutionsByTarget.forEach((_, targetId) => {
       this.remoteStore.unlisten(targetId);
     });
     this.limboDocumentRefs.removeAllReferences();
-    this.activeLimboResolutionsByTarget = [];
+    this.activeLimboResolutionsByTarget = new Map<TargetId, LimboResolution>();
     this.activeLimboTargetsByKey = new SortedMap<DocumentKey, TargetId>(
       DocumentKey.comparator
     );
@@ -1004,7 +1004,7 @@ export class SyncEngine implements RemoteSyncer, SharedClientStateSyncer {
     const newViewSnapshots: ViewSnapshot[] = [];
     for (const targetId of targets) {
       let targetData: TargetData;
-      const queries = this.queriesByTarget[targetId];
+      const queries = this.queriesByTarget.get(targetId);
 
       if (queries && queries.length !== 0) {
         // For queries that have a local View, we need to update their state
@@ -1096,7 +1096,7 @@ export class SyncEngine implements RemoteSyncer, SharedClientStateSyncer {
       return;
     }
 
-    if (this.queriesByTarget[targetId]) {
+    if (this.queriesByTarget.has(targetId)) {
       switch (state) {
         case 'current':
         case 'not-current': {
@@ -1136,7 +1136,7 @@ export class SyncEngine implements RemoteSyncer, SharedClientStateSyncer {
 
     for (const targetId of added) {
       assert(
-        !this.queriesByTarget[targetId],
+        !this.queriesByTarget.has(targetId),
         'Trying to add an already active target'
       );
       const target = await this.localStore.getTarget(targetId);
@@ -1153,7 +1153,7 @@ export class SyncEngine implements RemoteSyncer, SharedClientStateSyncer {
     for (const targetId of removed) {
       // Check that the target is still active since the target might have been
       // removed if it has been rejected by the backend.
-      if (!this.queriesByTarget[targetId]) {
+      if (!this.queriesByTarget.has(targetId)) {
         continue;
       }
 
@@ -1183,12 +1183,12 @@ export class SyncEngine implements RemoteSyncer, SharedClientStateSyncer {
   }
 
   getRemoteKeysForTarget(targetId: TargetId): DocumentKeySet {
-    const limboResolution = this.activeLimboResolutionsByTarget[targetId];
+    const limboResolution = this.activeLimboResolutionsByTarget.get(targetId);
     if (limboResolution && limboResolution.receivedDocument) {
       return documentKeySet().add(limboResolution.key);
     } else {
       let keySet = documentKeySet();
-      const queries = this.queriesByTarget[targetId];
+      const queries = this.queriesByTarget.get(targetId);
       if (!queries) {
         return keySet;
       }

packages/firestore/src/local/encoded_resource_path.ts

@@ -1,6 +1,6 @@
 /**
  * @license
- * Copyright 2017 Google Inc.
+ * Copyright 2017 Google LLC
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -72,7 +72,7 @@ const encodedEscape = '\u0011';
 /**
  * Encodes a resource path into a IndexedDb-compatible string form.
  */
-export function encode(path: ResourcePath): EncodedResourcePath {
+export function encodeResourcePath(path: ResourcePath): EncodedResourcePath {
   let result = '';
   for (let i = 0; i < path.length; i++) {
     if (result.length > 0) {
@@ -114,7 +114,7 @@ function encodeSeparator(result: string): string {
  * decoding resource names from the server; those are One Platform format
  * strings.
  */
-export function decode(path: EncodedResourcePath): ResourcePath {
+export function decodeResourcePath(path: EncodedResourcePath): ResourcePath {
   // Event the empty path must encode as a path of at least length 2. A path
   // with exactly 2 must be the empty path.
   const length = path.length;

packages/firestore/src/local/indexeddb_index_manager.ts

@@ -1,6 +1,6 @@
 /**
  * @license
- * Copyright 2019 Google Inc.
+ * Copyright 2019 Google LLC
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -18,7 +18,10 @@
 import { ResourcePath } from '../model/path';
 import { assert } from '../util/assert';
 import { immediateSuccessor } from '../util/misc';
-import { decode, encode } from './encoded_resource_path';
+import {
+  decodeResourcePath,
+  encodeResourcePath
+} from './encoded_resource_path';
 import { IndexManager } from './index_manager';
 import { IndexedDbPersistence } from './indexeddb_persistence';
 import { DbCollectionParent, DbCollectionParentKey } from './indexeddb_schema';
@@ -64,7 +67,7 @@ export class IndexedDbIndexManager implements IndexManager {
 
       const collectionParent: DbCollectionParent = {
         collectionId,
-        parent: encode(parentPath)
+        parent: encodeResourcePath(parentPath)
       };
       return collectionParentsStore(transaction).put(collectionParent);
     }
@@ -93,7 +96,7 @@ export class IndexedDbIndexManager implements IndexManager {
           if (entry.collectionId !== collectionId) {
             break;
           }
-          parentPaths.push(decode(entry.parent));
+          parentPaths.push(decodeResourcePath(entry.parent));
         }
         return parentPaths;
       });