firebase-ios-sdk/Firestore/Example/Tests/SpecTests/json/resume_token_spec_test.json

{
  "Resume tokens are sent after watch stream restarts": {
    "describeName": "Resume tokens:",
    "itName": "Resume tokens are sent after watch stream restarts",
    "tags": [],
    "config": {
      "useGarbageCollection": true,
      "numClients": 1
    },
    "steps": [
      {
        "userListen": [
          2,
          {
            "path": "collection",
            "filters": [],
            "orderBys": []
          }
        ],
        "expectedState": {
          "activeTargets": {
            "2": {
              "queries": [
                {
                  "path": "collection",
                  "filters": [],
                  "orderBys": []
                }
              ],
              "resumeToken": ""
            }
          }
        }
      },
      {
        "watchAck": [
          2
        ]
      },
      {
        "watchEntity": {
          "docs": [
            {
              "key": "collection/a",
              "version": 1000,
              "value": {
                "key": "a"
              },
              "options": {
                "hasLocalMutations": false,
                "hasCommittedMutations": false
              }
            }
          ],
          "targets": [
            2
          ]
        }
      },
      {
        "watchCurrent": [
          [
            2
          ],
          "custom-query-resume-token"
        ]
      },
      {
        "watchSnapshot": {
          "version": 1000,
          "targetIds": []
        },
        "expectedSnapshotEvents": [
          {
            "query": {
              "path": "collection",
              "filters": [],
              "orderBys": []
            },
            "added": [
              {
                "key": "collection/a",
                "version": 1000,
                "value": {
                  "key": "a"
                },
                "options": {
                  "hasLocalMutations": false,
                  "hasCommittedMutations": false
                }
              }
            ],
            "errorCode": 0,
            "fromCache": false,
            "hasPendingWrites": false
          }
        ]
      },
      {
        "watchStreamClose": {
          "error": {
            "code": 14,
            "message": "Simulated Backend Error"
          },
          "runBackoffTimer": true
        },
        "expectedState": {
          "activeTargets": {
            "2": {
              "queries": [
                {
                  "path": "collection",
                  "filters": [],
                  "orderBys": []
                }
              ],
              "resumeToken": "custom-query-resume-token"
            }
          }
        }
      }
    ]
  },
  "Resume tokens are used across new listens": {
    "describeName": "Resume tokens:",
    "itName": "Resume tokens are used across new listens",
    "tags": [],
    "config": {
      "useGarbageCollection": false,
      "numClients": 1
    },
    "steps": [
      {
        "userListen": [
          2,
          {
            "path": "collection",
            "filters": [],
            "orderBys": []
          }
        ],
        "expectedState": {
          "activeTargets": {
            "2": {
              "queries": [
                {
                  "path": "collection",
                  "filters": [],
                  "orderBys": []
                }
              ],
              "resumeToken": ""
            }
          }
        }
      },
      {
        "watchAck": [
          2
        ]
      },
      {
        "watchEntity": {
          "docs": [
            {
              "key": "collection/a",
              "version": 1000,
              "value": {
                "key": "a"
              },
              "options": {
                "hasLocalMutations": false,
                "hasCommittedMutations": false
              }
            }
          ],
          "targets": [
            2
          ]
        }
      },
      {
        "watchCurrent": [
          [
            2
          ],
          "custom-query-resume-token"
        ]
      },
      {
        "watchSnapshot": {
          "version": 1000,
          "targetIds": []
        },
        "expectedSnapshotEvents": [
          {
            "query": {
              "path": "collection",
              "filters": [],
              "orderBys": []
            },
            "added": [
              {
                "key": "collection/a",
                "version": 1000,
                "value": {
                  "key": "a"
                },
                "options": {
                  "hasLocalMutations": false,
                  "hasCommittedMutations": false
                }
              }
            ],
            "errorCode": 0,
            "fromCache": false,
            "hasPendingWrites": false
          }
        ]
      },
      {
        "userUnlisten": [
          2,
          {
            "path": "collection",
            "filters": [],
            "orderBys": []
          }
        ],
        "expectedState": {
          "activeTargets": {}
        }
      },
      {
        "userListen": [
          2,
          {
            "path": "collection",
            "filters": [],
            "orderBys": []
          }
        ],
        "expectedState": {
          "activeTargets": {
            "2": {
              "queries": [
                {
                  "path": "collection",
                  "filters": [],
                  "orderBys": []
                }
              ],
              "resumeToken": "custom-query-resume-token"
            }
          }
        },
        "expectedSnapshotEvents": [
          {
            "query": {
              "path": "collection",
              "filters": [],
              "orderBys": []
            },
            "added": [
              {
                "key": "collection/a",
                "version": 1000,
                "value": {
                  "key": "a"
                },
                "options": {
                  "hasLocalMutations": false,
                  "hasCommittedMutations": false
                }
              }
            ],
            "errorCode": 0,
            "fromCache": true,
            "hasPendingWrites": false
          }
        ]
      },
      {
        "watchAck": [
          2
        ]
      },
      {
        "watchSnapshot": {
          "version": 1001,
          "targetIds": []
        }
      }
    ]
  }
}