@durable-streams/client-conformance-tests 0.1.5 → 0.1.7

package/test-cases/producer/idempotent/batching.yaml

@@ -0,0 +1,98 @@
+id: idempotent-batching
+name: Idempotent Producer - Batching
+description: |
+  Tests for producer batching behavior and header interactions.
+  Batches are atomic - the entire batch shares a single sequence number.
+category: producer
+tags:
+  - idempotent
+  - batching
+
+tests:
+  - id: batch-retry-deduplication
+    name: Retrying entire batch returns 204 for all
+    description: If client retries an entire JSON batch, server should deduplicate
+    setup:
+      - action: create
+        as: streamPath
+        contentType: application/json
+    operations:
+      # Send a batch of 3 items
+      - action: server-append
+        path: ${streamPath}
+        data: '[{"id":1},{"id":2},{"id":3}]'
+        producerId: batch-retry-producer
+        producerEpoch: 0
+        producerSeq: 0
+        expect:
+          status: 200
+      # Retry the exact same batch - should get 204
+      - action: server-append
+        path: ${streamPath}
+        data: '[{"id":1},{"id":2},{"id":3}]'
+        producerId: batch-retry-producer
+        producerEpoch: 0
+        producerSeq: 0
+        expect:
+          status: 204
+          duplicate: true
+      # Verify only 3 items in stream (not 6)
+      - action: read
+        path: ${streamPath}
+        expect:
+          upToDate: true
+      # Next seq should still work
+      - action: server-append
+        path: ${streamPath}
+        data: '[{"id":4}]'
+        producerId: batch-retry-producer
+        producerEpoch: 0
+        producerSeq: 1
+        expect:
+          status: 200
+
+  - id: producer-with-stream-seq
+    name: Producer headers work with Stream-Seq header
+    description: Both producer deduplication and writer coordination should work together
+    setup:
+      - action: create
+        as: streamPath
+        contentType: text/plain
+    operations:
+      - action: server-append
+        path: ${streamPath}
+        data: "msg"
+        producerId: test-producer
+        producerEpoch: 0
+        producerSeq: 0
+        headers:
+          Stream-Seq: "app-seq-001"
+        expect:
+          status: 200
+
+  - id: duplicate-json-different-payload
+    name: Duplicate JSON with different payload returns 204
+    description: Same test for JSON content type - dedup is by headers only
+    setup:
+      - action: create
+        as: streamPath
+        contentType: application/json
+    operations:
+      - action: server-append
+        path: ${streamPath}
+        data: '{"key": "original"}'
+        producerId: test-producer
+        producerEpoch: 0
+        producerSeq: 0
+        expect:
+          status: 200
+      # Retry with different JSON payload
+      - action: server-append
+        path: ${streamPath}
+        data: '{"key": "different", "extra": true}'
+        producerId: test-producer
+        producerEpoch: 0
+        producerSeq: 0
+        expect:
+          status: 204
+          duplicate: true

package/test-cases/producer/idempotent/concurrent-requests.yaml

@@ -0,0 +1,100 @@
+id: idempotent-concurrent-requests
+name: Idempotent Producer - Concurrent Requests
+description: |
+  Tests for client handling of concurrent HTTP requests (pipelining).
+  When maxInFlight > 1, requests may arrive out of order causing 409 errors.
+  The client must retry and ensure all messages are delivered.
+category: producer
+tags:
+  - idempotent
+  - concurrent
+  - pipelining
+  - retry
+
+tests:
+  - id: concurrent-batches-all-delivered
+    name: All messages delivered with high concurrency
+    description: |
+      When using maxInFlight > 1, HTTP requests may arrive out of order causing 409 errors.
+      The client should retry and ensure all messages are delivered.
+    setup:
+      - action: create
+        as: streamPath
+        contentType: text/plain
+    operations:
+      # Send 20 messages with maxInFlight=5
+      # This forces concurrent batches that may arrive out of order
+      - action: idempotent-append-batch
+        path: ${streamPath}
+        producerId: test-producer
+        epoch: 0
+        maxInFlight: 5
+        items:
+          - data: "msg-00"
+          - data: "msg-01"
+          - data: "msg-02"
+          - data: "msg-03"
+          - data: "msg-04"
+          - data: "msg-05"
+          - data: "msg-06"
+          - data: "msg-07"
+          - data: "msg-08"
+          - data: "msg-09"
+          - data: "msg-10"
+          - data: "msg-11"
+          - data: "msg-12"
+          - data: "msg-13"
+          - data: "msg-14"
+          - data: "msg-15"
+          - data: "msg-16"
+          - data: "msg-17"
+          - data: "msg-18"
+          - data: "msg-19"
+        expect:
+          allSucceed: true
+      # Verify all messages are in the stream
+      - action: read
+        path: ${streamPath}
+        expect:
+          dataContainsAll:
+            - "msg-00"
+            - "msg-05"
+            - "msg-10"
+            - "msg-15"
+            - "msg-19"
+          upToDate: true
+
+  - id: concurrent-json-batches-all-delivered
+    name: All JSON messages delivered with high concurrency
+    description: Same test with JSON content type to verify JSON batching works with concurrency
+    setup:
+      - action: create
+        as: streamPath
+        contentType: application/json
+    operations:
+      - action: idempotent-append-batch
+        path: ${streamPath}
+        producerId: test-producer
+        epoch: 0
+        maxInFlight: 5
+        items:
+          - data: '{"id": 0}'
+          - data: '{"id": 1}'
+          - data: '{"id": 2}'
+          - data: '{"id": 3}'
+          - data: '{"id": 4}'
+          - data: '{"id": 5}'
+          - data: '{"id": 6}'
+          - data: '{"id": 7}'
+          - data: '{"id": 8}'
+          - data: '{"id": 9}'
+        expect:
+          allSucceed: true
+      - action: read
+        path: ${streamPath}
+        expect:
+          dataContainsAll:
+            - '"id":0'
+            - '"id":5'
+            - '"id":9'
+          upToDate: true

package/test-cases/producer/idempotent/epoch-management.yaml

@@ -0,0 +1,333 @@
+id: idempotent-epoch-management
+name: Idempotent Producer - Epoch Management
+description: |
+  Tests for producer epoch validation and zombie fencing.
+  Epochs enable split-brain protection - only the latest instance can write.
+category: producer
+tags:
+  - idempotent
+  - epoch
+  - fencing
+
+tests:
+  - id: epoch-upgrade-accepted
+    name: Epoch upgrade resets sequence to 0
+    description: New epoch must start at seq=0 and should be accepted
+    setup:
+      - action: create
+        as: streamPath
+        contentType: text/plain
+    operations:
+      - action: server-append
+        path: ${streamPath}
+        data: "epoch0-msg0"
+        producerId: test-producer
+        producerEpoch: 0
+        producerSeq: 0
+        expect:
+          status: 200
+      - action: server-append
+        path: ${streamPath}
+        data: "epoch0-msg1"
+        producerId: test-producer
+        producerEpoch: 0
+        producerSeq: 1
+        expect:
+          status: 200
+      # Upgrade to epoch=1
+      - action: server-append
+        path: ${streamPath}
+        data: "epoch1-msg0"
+        producerId: test-producer
+        producerEpoch: 1
+        producerSeq: 0
+        expect:
+          status: 200
+          producerEpoch: 1
+
+  - id: stale-epoch-rejected
+    name: Stale epoch returns 403 (zombie fencing)
+    description: Old epoch should be rejected with 403 and current epoch in response
+    setup:
+      - action: create
+        as: streamPath
+        contentType: text/plain
+    operations:
+      # Establish epoch=1
+      - action: server-append
+        path: ${streamPath}
+        data: "msg"
+        producerId: test-producer
+        producerEpoch: 1
+        producerSeq: 0
+        expect:
+          status: 200
+      # Try to write with stale epoch=0
+      - action: server-append
+        path: ${streamPath}
+        data: "zombie"
+        producerId: test-producer
+        producerEpoch: 0
+        producerSeq: 0
+        expect:
+          status: 403
+          producerEpoch: 1
+
+  - id: epoch-rollback-rejected
+    name: Epoch rollback is rejected
+    description: Cannot go back to a lower epoch
+    setup:
+      - action: create
+        as: streamPath
+        contentType: text/plain
+    operations:
+      # Establish epoch=2
+      - action: server-append
+        path: ${streamPath}
+        data: "msg"
+        producerId: test-producer
+        producerEpoch: 2
+        producerSeq: 0
+        expect:
+          status: 200
+      # Try epoch=1 (rollback)
+      - action: server-append
+        path: ${streamPath}
+        data: "rollback"
+        producerId: test-producer
+        producerEpoch: 1
+        producerSeq: 0
+        expect:
+          status: 403
+
+  - id: epoch-increase-requires-seq-zero
+    name: Epoch increase with seq != 0 is rejected
+    description: New epoch must start at seq=0
+    setup:
+      - action: create
+        as: streamPath
+        contentType: text/plain
+    operations:
+      - action: server-append
+        path: ${streamPath}
+        data: "msg"
+        producerId: test-producer
+        producerEpoch: 0
+        producerSeq: 0
+        expect:
+          status: 200
+      # Try epoch=1 with seq=5
+      - action: server-append
+        path: ${streamPath}
+        data: "bad"
+        producerId: test-producer
+        producerEpoch: 1
+        producerSeq: 5
+        expect:
+          status: 400
+
+  - id: epoch-gap-allowed
+    name: Epoch can skip values (gap allowed)
+    description: |
+      Epochs don't need to be sequential. Jumping from epoch=0 to epoch=10
+      should be allowed (unlike sequences which must be sequential).
+    setup:
+      - action: create
+        as: streamPath
+        contentType: text/plain
+    operations:
+      - action: server-append
+        path: ${streamPath}
+        data: "epoch0"
+        producerId: test-producer
+        producerEpoch: 0
+        producerSeq: 0
+        expect:
+          status: 200
+      # Jump to epoch=10 (skipping 1-9)
+      - action: server-append
+        path: ${streamPath}
+        data: "epoch10"
+        producerId: test-producer
+        producerEpoch: 10
+        producerSeq: 0
+        expect:
+          status: 200
+      # Previous epochs now fenced
+      - action: server-append
+        path: ${streamPath}
+        data: "epoch5"
+        producerId: test-producer
+        producerEpoch: 5
+        producerSeq: 0
+        expect:
+          status: 403
+          producerEpoch: 10
+
+  - id: epoch-zero-after-higher-epoch
+    name: Epoch 0 rejected after higher epoch established
+    description: |
+      Once a higher epoch is established, epoch=0 should be rejected.
+      This is critical for zombie fencing.
+    setup:
+      - action: create
+        as: streamPath
+        contentType: text/plain
+    operations:
+      # Establish epoch=5
+      - action: server-append
+        path: ${streamPath}
+        data: "epoch5"
+        producerId: test-producer
+        producerEpoch: 5
+        producerSeq: 0
+        expect:
+          status: 200
+      # Epoch 0 should be fenced
+      - action: server-append
+        path: ${streamPath}
+        data: "epoch0-zombie"
+        producerId: test-producer
+        producerEpoch: 0
+        producerSeq: 0
+        expect:
+          status: 403
+          producerEpoch: 5
+      # Epoch 4 should also be fenced
+      - action: server-append
+        path: ${streamPath}
+        data: "epoch4-zombie"
+        producerId: test-producer
+        producerEpoch: 4
+        producerSeq: 0
+        expect:
+          status: 403
+          producerEpoch: 5
+
+  - id: split-brain-fencing
+    name: Split-brain fencing scenario
+    description: Old producer instance (zombie) should be fenced when new instance claims higher epoch
+    setup:
+      - action: create
+        as: streamPath
+        contentType: text/plain
+    operations:
+      # Producer A (original): epoch=0
+      - action: server-append
+        path: ${streamPath}
+        data: "A0"
+        producerId: shared-producer
+        producerEpoch: 0
+        producerSeq: 0
+        expect:
+          status: 200
+      # Producer B (new instance): claims epoch=1
+      - action: server-append
+        path: ${streamPath}
+        data: "B0"
+        producerId: shared-producer
+        producerEpoch: 1
+        producerSeq: 0
+        expect:
+          status: 200
+      # Producer A (zombie): tries epoch=0, seq=1 - should be fenced
+      - action: server-append
+        path: ${streamPath}
+        data: "A1"
+        producerId: shared-producer
+        producerEpoch: 0
+        producerSeq: 1
+        expect:
+          status: 403
+          producerEpoch: 1
+
+  - id: large-epoch-numbers
+    name: Large epoch numbers handled correctly
+    description: Test that large epoch values work correctly
+    setup:
+      - action: create
+        as: streamPath
+        contentType: text/plain
+    operations:
+      - action: server-append
+        path: ${streamPath}
+        data: "large-epoch"
+        producerId: test-producer
+        producerEpoch: 2147483640
+        producerSeq: 0
+        expect:
+          status: 200
+      # Stale epoch should still be rejected
+      - action: server-append
+        path: ${streamPath}
+        data: "stale"
+        producerId: test-producer
+        producerEpoch: 100
+        producerSeq: 0
+        expect:
+          status: 403
+          producerEpoch: 2147483640
+
+  - id: sequence-resets-on-epoch-upgrade
+    name: Each epoch has independent sequence space
+    description: |
+      Sequence numbers reset to 0 with each epoch upgrade.
+      The old epoch's sequences don't affect the new epoch.
+    setup:
+      - action: create
+        as: streamPath
+        contentType: text/plain
+    operations:
+      # Epoch 0: sequences 0, 1, 2
+      - action: server-append
+        path: ${streamPath}
+        data: "e0s0"
+        producerId: test-producer
+        producerEpoch: 0
+        producerSeq: 0
+        expect:
+          status: 200
+      - action: server-append
+        path: ${streamPath}
+        data: "e0s1"
+        producerId: test-producer
+        producerEpoch: 0
+        producerSeq: 1
+        expect:
+          status: 200
+      - action: server-append
+        path: ${streamPath}
+        data: "e0s2"
+        producerId: test-producer
+        producerEpoch: 0
+        producerSeq: 2
+        expect:
+          status: 200
+      # Epoch 1: starts fresh at seq=0
+      - action: server-append
+        path: ${streamPath}
+        data: "e1s0"
+        producerId: test-producer
+        producerEpoch: 1
+        producerSeq: 0
+        expect:
+          status: 200
+      - action: server-append
+        path: ${streamPath}
+        data: "e1s1"
+        producerId: test-producer
+        producerEpoch: 1
+        producerSeq: 1
+        expect:
+          status: 200
+      # Verify all 5 messages present
+      - action: read
+        path: ${streamPath}
+        expect:
+          dataContainsAll:
+            - "e0s0"
+            - "e0s1"
+            - "e0s2"
+            - "e1s0"
+            - "e1s1"
+          upToDate: true