description: "find-comment"

schemaVersion: "1.0"

createEntities:
  - client:
      id: &client0 client0
      observeEvents: [ commandStartedEvent ]
  - database:
      id: &database0 database0
      client: *client0
      databaseName: &database0Name crud-tests
  - collection:
      id: &collection0 collection0
      database: *database0
      collectionName: &collection0Name coll0

initialData: &initialData
  - collectionName: *collection0Name
    databaseName: *database0Name
    documents:
      - { _id: 1, x: 11 }
      - { _id: 2, x: 22 }
      - { _id: 3, x: 33 }
      - { _id: 4, x: 44 }
      - { _id: 5, x: 55 }
      - { _id: 6, x: 66 }

tests:
  - description: "find with string comment"
    runOnRequirements:
      - minServerVersion: "3.6"
    operations:
      - name: find
        object: *collection0
        arguments:
          filter: &filter
            _id: 1
          comment: "comment"
        expectResult: &expect_result
          - { _id: 1 }
    expectEvents:
      - client: *client0
        events:
          - commandStartedEvent:
              command:
                find: *collection0Name
                filter: *filter
                comment: "comment"

  - description: "find with document comment"
    runOnRequirements:
      - minServerVersion: "4.4"
    operations:
      - name: find
        object: *collection0
        arguments:
          filter: *filter
          comment: &comment { key: "value"}
        expectResult: *expect_result
    expectEvents:
      - client: *client0
        events:
          - commandStartedEvent:
              command:
                find: *collection0Name
                filter: *filter
                comment: *comment

  - description: "find with document comment - pre 4.4"
    runOnRequirements:
      - maxServerVersion: "4.2.99"
        minServerVersion: "3.6"
    operations:
      - name: find
        object: *collection0
        arguments:
          filter: *filter
          comment: *comment
        expectError:
          isClientError: false
    expectEvents:
      - client: *client0
        events:
          - commandStartedEvent:
              command:
                find: *collection0Name
                filter: *filter
                comment: *comment

  - description: "find with comment sets comment on getMore"
    runOnRequirements:
      - minServerVersion: "4.4.0"
    operations:
      - name: find
        object: *collection0
        arguments:
          filter: &filter_get_more { _id: { $gt: 1 } }
          batchSize: 2
          comment: *comment
        expectResult:
          - { _id: 2, x: 22 }
          - { _id: 3, x: 33 }
          - { _id: 4, x: 44 }
          - { _id: 5, x: 55 }
          - { _id: 6, x: 66 }
    expectEvents:
      - client: *client0
        events:
          - commandStartedEvent:
              command:
                find: *collection0Name
                filter: { _id: { $gt: 1 } }
                batchSize: 2
                comment: *comment
          - commandStartedEvent:
              command:
                getMore: { $$type: [ int, long ] }
                collection: *collection0Name
                batchSize: 2
                comment: *comment
          - commandStartedEvent:
              command:
                getMore: { $$type: [ int, long ] }
                collection: *collection0Name
                batchSize: 2
                comment: *comment

  - description: "find with comment does not set comment on getMore - pre 4.4"
    runOnRequirements:
      - minServerVersion: "3.6.0"
        maxServerVersion: "4.3.99"
    operations:
      - name: find
        object: *collection0
        arguments:
          filter: &filter_get_more { _id: { $gt: 1 } }
          batchSize: 2
          comment: "comment"
        expectResult:
          - { _id: 2, x: 22 }
          - { _id: 3, x: 33 }
          - { _id: 4, x: 44 }
          - { _id: 5, x: 55 }
          - { _id: 6, x: 66 }
    expectEvents:
      - client: *client0
        events:
          - commandStartedEvent:
              command:
                find: *collection0Name
                filter: { _id: { $gt: 1 } }
                batchSize: 2
                comment: "comment"
          - commandStartedEvent:
              command:
                getMore: { $$type: [ int, long ] }
                collection: *collection0Name
                batchSize: 2
                comment: { $$exists: false }
          - commandStartedEvent:
              command:
                getMore: { $$type: [ int, long ] }
                collection: *collection0Name
                batchSize: 2
                comment: { $$exists: false }