# All files / local memory_query_cache.ts

100% Statements 65/65
100% Branches 4/4
100% Functions 18/18
100% Lines 63/63

    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    19
    20
    21
    22
    23
    24
    25
    26
    27
    28
    29
    30
    31
    32
    33
    34
    35
    36
    37
    38
    39
    40
    41
    42
    43
    44
    45
    46
    47
    48
    49
    50
    51
    52
    53
    54
    55
    56
    57
    58
    59
    60
    61
    62
    63
    64
    65
    66
    67
    68
    69
    70
    71
    72
    73
    74
    75
    76
    77
    78
    79
    80
    81
    82
    83
    84
    85
    86
    87
    88
    89
    90
    91
    92
    93
    94
    95
    96
    97
    98
    99
    100
    101
    102
    103
    104
    105
    106
    107
    108
    109
    110
    111
    112
    113
    114
    115
    116
    117
    118
    119
    120
    121
    122
    123
    124
    125
    126
    127
    128
    129
    130
    131
    132
    133
    134
    135
    136
    137
    138
    139
    140
    141
    142
    143
    144
    145
    146
    147
    148
    149
    150
    151
    152
    153
    154
    155
    156
    157
    158
    159
    160
    161
    162
    163
    164
    165
    166
    167
    168
    169
    170
    171
    172
    173
    174

    2x

    2x

    2x

    2x
    2x

    2x

    2015x

    366x

    366x

    366x

    366x

    2x

    354x

    2x
    1158x

    2x
    347x

    2x

    419x
    419x

    2x
    464x
    464x
    464x
    232x

    2x

    232x

    232x
    232x
    232x

    2x

    232x
    232x
    232x

    2x

    144x
    144x

    144x
    144x
    144x
    144x

    2x
    4x

    2x

    799x
    799x

    2x

    304x
    304x

    2x

    284x
    284x

    2x

    13x
    13x

    2x

    233x
    233x

    2x
    329x

    2x

    492x

    2x
     /**
     * 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.
     */

    import { Query } from '../core/query';
    import { SnapshotVersion } from '../core/snapshot_version';
    import { TargetId } from '../core/types';
    import { DocumentKeySet } from '../model/collections';
    import { DocumentKey } from '../model/document_key';
    import { ObjectMap } from '../util/obj_map';

    import { GarbageCollector } from './garbage_collector';
    import { PersistenceTransaction } from './persistence';
    import { PersistencePromise } from './persistence_promise';
    import { QueryCache } from './query_cache';
    import { QueryData } from './query_data';
    import { ReferenceSet } from './reference_set';
    import { assert } from '../util/assert';

    export class MemoryQueryCache implements QueryCache {
      /**
       * Maps a query to the data about that query
       */
      private queries = new ObjectMap<Query, QueryData>(q => q.canonicalId());

      /** The last received snapshot version. */
      private lastRemoteSnapshotVersion = SnapshotVersion.MIN;
      /** The highest numbered target ID encountered. */
      private highestTargetId: TargetId = 0;
      /**
       * A ordered bidirectional mapping between documents and the remote target
       * IDs.
       */
      private references = new ReferenceSet();

      private targetCount = 0;

      start(transaction: PersistenceTransaction): PersistencePromise<void> {
        // Nothing to do.
        return PersistencePromise.resolve();
      }

      getLastRemoteSnapshotVersion(): SnapshotVersion {
        return this.lastRemoteSnapshotVersion;
      }

      getHighestTargetId(): TargetId {
        return this.highestTargetId;
      }

      setLastRemoteSnapshotVersion(
        transaction: PersistenceTransaction,
        snapshotVersion: SnapshotVersion
      ): PersistencePromise<void> {
        this.lastRemoteSnapshotVersion = snapshotVersion;
        return PersistencePromise.resolve();
      }

      private saveQueryData(queryData: QueryData) {
        this.queries.set(queryData.query, queryData);
        const targetId = queryData.targetId;
        if (targetId > this.highestTargetId) {
          this.highestTargetId = targetId;
        }
        // TODO(GC): track sequence number
      }

      addQueryData(
        transaction: PersistenceTransaction,
        queryData: QueryData
      ): PersistencePromise<void> {
        assert(
          !this.queries.has(queryData.query),
          'Adding a query that already exists'
        );
        this.saveQueryData(queryData);
        this.targetCount += 1;
        return PersistencePromise.resolve();
      }

      updateQueryData(
        transaction: PersistenceTransaction,
        queryData: QueryData
      ): PersistencePromise<void> {
        assert(this.queries.has(queryData.query), 'Updating a non-existent query');
        this.saveQueryData(queryData);
        return PersistencePromise.resolve();
      }

      removeQueryData(
        transaction: PersistenceTransaction,
        queryData: QueryData
      ): PersistencePromise<void> {
        assert(this.targetCount > 0, 'Removing a target from an empty cache');
        assert(
          this.queries.has(queryData.query),
          'Removing a non-existent target from the cache'
        );
        this.queries.delete(queryData.query);
        this.references.removeReferencesForId(queryData.targetId);
        this.targetCount -= 1;
        return PersistencePromise.resolve();
      }

      get count(): number {
        return this.targetCount;
      }

      getQueryData(
        transaction: PersistenceTransaction,
        query: Query
      ): PersistencePromise<QueryData | null> {
        const queryData = this.queries.get(query) || null;
        return PersistencePromise.resolve(queryData);
      }

      addMatchingKeys(
        txn: PersistenceTransaction,
        keys: DocumentKeySet,
        targetId: TargetId
      ): PersistencePromise<void> {
        this.references.addReferences(keys, targetId);
        return PersistencePromise.resolve();
      }

      removeMatchingKeys(
        txn: PersistenceTransaction,
        keys: DocumentKeySet,
        targetId: TargetId
      ): PersistencePromise<void> {
        this.references.removeReferences(keys, targetId);
        return PersistencePromise.resolve();
      }

      removeMatchingKeysForTargetId(
        txn: PersistenceTransaction,
        targetId: TargetId
      ): PersistencePromise<void> {
        this.references.removeReferencesForId(targetId);
        return PersistencePromise.resolve();
      }

      getMatchingKeysForTargetId(
        txn: PersistenceTransaction,
        targetId: TargetId
      ): PersistencePromise<DocumentKeySet> {
        const matchingKeys = this.references.referencesForId(targetId);
        return PersistencePromise.resolve(matchingKeys);
      }

      setGarbageCollector(gc: GarbageCollector | null): void {
        this.references.setGarbageCollector(gc);
      }

      containsKey(
        txn: PersistenceTransaction | null,
        key: DocumentKey
      ): PersistencePromise<boolean> {
        return this.references.containsKey(txn, key);
      }
    }