description: "findOneAndReplace-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 }
      - { _id: 2 }

tests:
  - description: "findOneAndReplace with string comment"
    runOnRequirements:
      - minServerVersion: "4.4"
    operations:
      - name: findOneAndReplace
        object: *collection0
        arguments:
          filter: &filter
            _id: 1
          replacement: &replacement
            x: 5
          comment: "comment"
        expectResult:
          _id: 1
    expectEvents:
      - client: *client0
        events:
          - commandStartedEvent:
              command:
                findAndModify: *collection0Name
                query: *filter
                update: *replacement
                comment: "comment"
    outcome: &outcome
      - collectionName: *collection0Name
        databaseName: *database0Name
        documents:
          - { _id: 1, x: 5 }
          - { _id: 2 }

  - description: "findOneAndReplace with document comment"
    runOnRequirements:
      - minServerVersion: "4.4"
    operations:
      - name: findOneAndReplace
        object: *collection0
        arguments:
          filter: *filter
          replacement: *replacement
          comment: &comment { key: "value"}
        expectResult:
          _id: 1
    expectEvents:
      - client: *client0
        events:
          - commandStartedEvent:
              command:
                findAndModify: *collection0Name
                query: *filter
                update: *replacement
                comment: *comment
    outcome: *outcome


  - description: "findOneAndReplace with comment - pre 4.4"
    runOnRequirements:
      - minServerVersion: "4.2.0" # findAndModify option validation was introduced in 4.2
        maxServerVersion: "4.2.99"
    operations:
      - name: findOneAndReplace
        object: *collection0
        arguments:
          filter: *filter
          replacement: *replacement
          comment: "comment"
        expectError:
          isClientError: false
    expectEvents:
      - client: *client0
        events:
          - commandStartedEvent:
              command:
                findAndModify: *collection0Name
                query: *filter
                update: *replacement
                comment: "comment"
    outcome: *initialData