# All files / core view_snapshot.ts

88.71% Statements 55/62
79.17% Branches 38/48
100% Functions 10/10
88.33% Lines 53/60

    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
    175
    176
    177
    178

    2x

    2x
    2x

    2x
    2x
    2x
    2x
    2x

    2x
    2x
    2x

    2x
    1995x

    2x
    4650x
    4650x
    4650x
    4611x
    4611x

    39x

    39x

    39x

    39x

    39x

    35x
    4x

    3x

    1x

    1x

    2x
    2009x
    2009x

    4594x

    2009x

    2x

    2x

    2375x
    2375x
    2375x
    2375x
    2375x
    2375x
    2375x

    2x
    36x

    10x

    26x
    26x
    26x

    26x
    28x

    26x

    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 { Document } from '../model/document';
    import { DocumentKey } from '../model/document_key';
    import { DocumentSet } from '../model/document_set';
    import { fail } from '../util/assert';
    import { SortedMap } from '../util/sorted_map';

    import { Query } from './query';

    export enum ChangeType {
      Added,
      Removed,
      Modified,
      Metadata
    }

    export interface DocumentViewChange {
      type: ChangeType;
      doc: Document;
    }

    export enum SyncState {
      Local,
      Synced
    }

    /**
     * DocumentChangeSet keeps track of a set of changes to docs in a query, merging
     * duplicate events for the same doc.
     */
    export class DocumentChangeSet {
      private changeMap = new SortedMap<DocumentKey, DocumentViewChange>(
        DocumentKey.comparator
      );

      constructor() {}

      track(change: DocumentViewChange) {
        const key = change.doc.key;
        const oldChange = this.changeMap.get(key);
        if (!oldChange) {
          this.changeMap = this.changeMap.insert(key, change);
          return;
        }

        // Merge the new change with the existing change.
        Iif (
          change.type !== ChangeType.Added &&
          oldChange.type === ChangeType.Metadata
        ) {
          this.changeMap = this.changeMap.insert(key, change);
        } else Iif (
          change.type === ChangeType.Metadata &&
          oldChange.type !== ChangeType.Removed
        ) {
          this.changeMap = this.changeMap.insert(key, {
            type: oldChange.type,
            doc: change.doc
          });
        } else Iif (
          change.type === ChangeType.Modified &&
          oldChange.type === ChangeType.Modified
        ) {
          this.changeMap = this.changeMap.insert(key, {
            type: ChangeType.Modified,
            doc: change.doc
          });
        } else Iif (
          change.type === ChangeType.Modified &&
          oldChange.type === ChangeType.Added
        ) {
          this.changeMap = this.changeMap.insert(key, {
            type: ChangeType.Added,
            doc: change.doc
          });
        } else if (
          change.type === ChangeType.Removed &&
          oldChange.type === ChangeType.Added
        ) {
          this.changeMap = this.changeMap.remove(key);
        } else if (
          change.type === ChangeType.Removed &&
          oldChange.type === ChangeType.Modified
        ) {
          this.changeMap = this.changeMap.insert(key, {
            type: ChangeType.Removed,
            doc: oldChange.doc
          });
        } else Eif (
          change.type === ChangeType.Added &&
          oldChange.type === ChangeType.Removed
        ) {
          this.changeMap = this.changeMap.insert(key, {
            type: ChangeType.Modified,
            doc: change.doc
          });
        } else {
          // This includes these cases, which don't make sense:
          // Added->Added
          // Removed->Removed
          // Modified->Added
          // Removed->Modified
          // Metadata->Added
          // Removed->Metadata
          fail(
            'unsupported combination of changes: ' +
              JSON.stringify(change) +
              ' after ' +
              JSON.stringify(oldChange)
          );
        }
      }

      getChanges(): DocumentViewChange[] {
        const changes: DocumentViewChange[] = [];
        this.changeMap.inorderTraversal(
          (key: DocumentKey, change: DocumentViewChange) => {
            changes.push(change);
          }
        );
        return changes;
      }
    }

    export class ViewSnapshot {
      constructor(
        readonly query: Query,
        readonly docs: DocumentSet,
        readonly oldDocs: DocumentSet,
        readonly docChanges: DocumentViewChange[],
        readonly fromCache: boolean,
        readonly hasPendingWrites: boolean,
        readonly syncStateChanged: boolean
      ) {}

      isEqual(other: ViewSnapshot): boolean {
        if (
          this.fromCache !== other.fromCache ||
          this.hasPendingWrites !== other.hasPendingWrites ||
          this.syncStateChanged !== other.syncStateChanged ||
          !this.query.isEqual(other.query) ||
          !this.docs.isEqual(other.docs) ||
          !this.oldDocs.isEqual(other.oldDocs)
        ) {
          return false;
        }
        const changes: DocumentViewChange[] = this.docChanges;
        const otherChanges: DocumentViewChange[] = other.docChanges;
        Iif (changes.length !== otherChanges.length) {
          return false;
        }
        for (let i = 0; i < changes.length; i++) {
          Iif (
            changes[i].type !== otherChanges[i].type ||
            !changes[i].doc.isEqual(otherChanges[i].doc)
          ) {
            return false;
          }
        }
        return true;
      }
    }