firebase-js-sdk/packages/firestore/test/unit/specs/resume_token_spec.test.ts

/**
 * @license
 * 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.
 * 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 { Code } from '../../../src/util/error';
import { doc, query } from '../../util/helpers';

import { describeSpec, specTest } from './describe_spec';
import { spec } from './spec_builder';

describeSpec('Resume tokens:', [], () => {
  specTest('Resume tokens are sent after watch stream restarts', [], () => {
    const query1 = query('collection');
    const doc1 = doc('collection/a', 1000, { key: 'a' });
    return spec()
      .userListens(query1)
      .watchAcks(query1)
      .watchSends({ affects: [query1] }, doc1)
      .watchCurrents(query1, 'custom-query-resume-token')
      .watchSnapshots(1000)
      .expectEvents(query1, { added: [doc1] })
      .watchStreamCloses(Code.UNAVAILABLE)
      .expectActiveTargets({
        query: query1,
        resumeToken: 'custom-query-resume-token'
      });
  });

  specTest('Resume tokens are used across new listens', [], () => {
    const query1 = query('collection');
    const doc1 = doc('collection/a', 1000, { key: 'a' });
    return spec()
      .ensureManualLruGC()
      .userListens(query1)
      .watchAcks(query1)
      .watchSends({ affects: [query1] }, doc1)
      .watchCurrents(query1, 'custom-query-resume-token')
      .watchSnapshots(1000)
      .expectEvents(query1, { added: [doc1] })
      .userUnlistens(query1)
      .userListens(query1, { resumeToken: 'custom-query-resume-token' })
      .expectEvents(query1, { fromCache: true, added: [doc1] })
      .watchAcks(query1)
      .watchSnapshots(1001);
  });
});