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

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

@@ -0,0 +1,322 @@
+id: idempotent-multi-producer
+name: Idempotent Producer - Multi-Producer Scenarios
+description: |
+  Tests for multiple producers on the same stream and producer isolation.
+  Each (stream, producerId) has independent epoch/sequence state.
+category: producer
+tags:
+  - idempotent
+  - multi-producer
+  - isolation
+
+tests:
+  - id: multiple-producers-independent
+    name: Multiple producers have independent state
+    description: Different producer IDs should have separate epoch/seq tracking
+    setup:
+      - action: create
+        as: streamPath
+        contentType: text/plain
+    operations:
+      # Producer A: seq=0
+      - action: server-append
+        path: ${streamPath}
+        data: "A0"
+        producerId: producer-A
+        producerEpoch: 0
+        producerSeq: 0
+        expect:
+          status: 200
+      # Producer B: seq=0 (independent)
+      - action: server-append
+        path: ${streamPath}
+        data: "B0"
+        producerId: producer-B
+        producerEpoch: 0
+        producerSeq: 0
+        expect:
+          status: 200
+      # Producer A: seq=1
+      - action: server-append
+        path: ${streamPath}
+        data: "A1"
+        producerId: producer-A
+        producerEpoch: 0
+        producerSeq: 1
+        expect:
+          status: 200
+      # Producer B: seq=1
+      - action: server-append
+        path: ${streamPath}
+        data: "B1"
+        producerId: producer-B
+        producerEpoch: 0
+        producerSeq: 1
+        expect:
+          status: 200
+
+  - id: producer-scope-per-stream
+    name: Same producer ID works independently on different streams
+    description: |
+      Producer state must be scoped per (stream, producerId), not globally
+      by producerId alone. A common implementation bug is to key producer
+      state only by producer ID, causing cross-stream interference.
+    setup:
+      - action: create
+        as: streamA
+        contentType: text/plain
+      - action: create
+        as: streamB
+        contentType: text/plain
+    operations:
+      # Same producer, epoch=0, seq=0 on stream A
+      - action: server-append
+        path: ${streamA}
+        data: "streamA-msg"
+        producerId: shared-producer
+        producerEpoch: 0
+        producerSeq: 0
+        expect:
+          status: 200
+      # Same producer, epoch=0, seq=0 on stream B - must be 200, not 204/403
+      - action: server-append
+        path: ${streamB}
+        data: "streamB-msg"
+        producerId: shared-producer
+        producerEpoch: 0
+        producerSeq: 0
+        expect:
+          status: 200
+      # Verify each stream has its own message
+      - action: read
+        path: ${streamA}
+        expect:
+          data: "streamA-msg"
+          upToDate: true
+      - action: read
+        path: ${streamB}
+        expect:
+          data: "streamB-msg"
+          upToDate: true
+
+  - id: producer-epoch-per-stream
+    name: Producer epochs are independent per stream
+    description: |
+      Epoch fencing on one stream must not affect the same producer on
+      another stream. Each (stream, producerId) has independent epoch state.
+    setup:
+      - action: create
+        as: streamA
+        contentType: text/plain
+      - action: create
+        as: streamB
+        contentType: text/plain
+    operations:
+      # Establish epoch=5 on stream A
+      - action: server-append
+        path: ${streamA}
+        data: "A-epoch5"
+        producerId: shared-producer
+        producerEpoch: 5
+        producerSeq: 0
+        expect:
+          status: 200
+      # epoch=0 on stream B should still work (different stream)
+      - action: server-append
+        path: ${streamB}
+        data: "B-epoch0"
+        producerId: shared-producer
+        producerEpoch: 0
+        producerSeq: 0
+        expect:
+          status: 200
+      # epoch=0 on stream A should be fenced
+      - action: server-append
+        path: ${streamA}
+        data: "A-epoch0-zombie"
+        producerId: shared-producer
+        producerEpoch: 0
+        producerSeq: 1
+        expect:
+          status: 403
+          producerEpoch: 5
+
+  - id: interleaved-producers-ordering
+    name: Interleaved producers maintain per-producer ordering
+    description: |
+      When multiple producers write interleaved, each producer's messages
+      should appear in their sequence order relative to each other.
+    setup:
+      - action: create
+        as: streamPath
+        contentType: text/plain
+    operations:
+      # Interleave writes from two producers
+      - action: server-append
+        path: ${streamPath}
+        data: "A0"
+        producerId: producer-A
+        producerEpoch: 0
+        producerSeq: 0
+        expect:
+          status: 200
+      - action: server-append
+        path: ${streamPath}
+        data: "B0"
+        producerId: producer-B
+        producerEpoch: 0
+        producerSeq: 0
+        expect:
+          status: 200
+      - action: server-append
+        path: ${streamPath}
+        data: "A1"
+        producerId: producer-A
+        producerEpoch: 0
+        producerSeq: 1
+        expect:
+          status: 200
+      - action: server-append
+        path: ${streamPath}
+        data: "B1"
+        producerId: producer-B
+        producerEpoch: 0
+        producerSeq: 1
+        expect:
+          status: 200
+      - action: server-append
+        path: ${streamPath}
+        data: "A2"
+        producerId: producer-A
+        producerEpoch: 0
+        producerSeq: 2
+        expect:
+          status: 200
+      # Read and verify A0 comes before A1 comes before A2
+      # and B0 comes before B1
+      - action: read
+        path: ${streamPath}
+        expect:
+          dataContainsAll:
+            - "A0"
+            - "A1"
+            - "A2"
+            - "B0"
+            - "B1"
+          upToDate: true
+
+  - id: delete-recreate-resets-producer-state
+    name: Deleting and recreating stream resets producer state
+    description: |
+      When a stream is deleted and recreated, producer state must be reset.
+      The new stream is a fresh log, so (epoch=0, seq=0) must be accepted
+      even if the same producer previously wrote to the old stream.
+    setup:
+      - action: create
+        as: streamPath
+        contentType: text/plain
+    operations:
+      # Write to original stream
+      - action: server-append
+        path: ${streamPath}
+        data: "original-msg"
+        producerId: test-producer
+        producerEpoch: 0
+        producerSeq: 0
+        expect:
+          status: 200
+      # Advance sequence
+      - action: server-append
+        path: ${streamPath}
+        data: "original-msg2"
+        producerId: test-producer
+        producerEpoch: 0
+        producerSeq: 1
+        expect:
+          status: 200
+      # Delete the stream
+      - action: delete
+        path: ${streamPath}
+        expect:
+          status: 200
+      # Recreate at same path
+      - action: create
+        path: ${streamPath}
+        contentType: text/plain
+      # Same producer, epoch=0, seq=0 must work (new stream)
+      - action: server-append
+        path: ${streamPath}
+        data: "recreated-msg"
+        producerId: test-producer
+        producerEpoch: 0
+        producerSeq: 0
+        expect:
+          status: 200
+      # Verify only the new message exists
+      - action: read
+        path: ${streamPath}
+        expect:
+          data: "recreated-msg"
+          upToDate: true
+
+  - id: producer-id-long
+    name: Long producer ID works
+    description: Very long producer IDs should be accepted
+    setup:
+      - action: create
+        as: streamPath
+        contentType: text/plain
+    operations:
+      - action: server-append
+        path: ${streamPath}
+        data: "long-id"
+        producerId: "very-long-producer-id-that-goes-on-for-quite-a-while-to-test-string-handling-in-the-server-implementation-and-make-sure-it-doesnt-truncate"
+        producerEpoch: 0
+        producerSeq: 0
+        expect:
+          status: 200
+      # Duplicate detection works with long ID
+      - action: server-append
+        path: ${streamPath}
+        data: "long-id"
+        producerId: "very-long-producer-id-that-goes-on-for-quite-a-while-to-test-string-handling-in-the-server-implementation-and-make-sure-it-doesnt-truncate"
+        producerEpoch: 0
+        producerSeq: 0
+        expect:
+          status: 204
+
+  - id: producer-id-with-special-chars
+    name: Producer ID with special characters works
+    description: Producer IDs can contain colons, slashes, and other special chars
+    setup:
+      - action: create
+        as: streamPath
+        contentType: text/plain
+    operations:
+      # Colon-separated ID (common pattern)
+      - action: server-append
+        path: ${streamPath}
+        data: "msg1"
+        producerId: "service:instance:123"
+        producerEpoch: 0
+        producerSeq: 0
+        expect:
+          status: 200
+      # Slash-separated ID (path-like)
+      - action: server-append
+        path: ${streamPath}
+        data: "msg2"
+        producerId: "region/zone/host"
+        producerEpoch: 0
+        producerSeq: 0
+        expect:
+          status: 200
+      # UUID format
+      - action: server-append
+        path: ${streamPath}
+        data: "msg3"
+        producerId: "550e8400-e29b-41d4-a716-446655440000"
+        producerEpoch: 0
+        producerSeq: 0
+        expect:
+          status: 200

package/test-cases/producer/idempotent/sequence-validation.yaml

@@ -0,0 +1,339 @@
+id: idempotent-sequence-validation
+name: Idempotent Producer - Sequence Validation
+description: |
+  Tests for producer sequence number validation.
+  Sequences must start at 0 and increment monotonically within an epoch.
+category: producer
+tags:
+  - idempotent
+  - sequence
+
+tests:
+  - id: first-append-accepted
+    name: First append with producer headers is accepted
+    description: Server should accept first append with epoch=0, seq=0
+    setup:
+      - action: create
+        as: streamPath
+        contentType: text/plain
+    operations:
+      - action: server-append
+        path: ${streamPath}
+        data: "hello"
+        producerId: test-producer
+        producerEpoch: 0
+        producerSeq: 0
+        expect:
+          status: 200
+          producerEpoch: 0
+
+  - id: sequential-sequences
+    name: Sequential producer sequences accepted
+    description: Server should accept monotonically increasing sequences
+    setup:
+      - action: create
+        as: streamPath
+        contentType: text/plain
+    operations:
+      - action: server-append
+        path: ${streamPath}
+        data: "msg0"
+        producerId: test-producer
+        producerEpoch: 0
+        producerSeq: 0
+        expect:
+          status: 200
+      - action: server-append
+        path: ${streamPath}
+        data: "msg1"
+        producerId: test-producer
+        producerEpoch: 0
+        producerSeq: 1
+        expect:
+          status: 200
+      - action: server-append
+        path: ${streamPath}
+        data: "msg2"
+        producerId: test-producer
+        producerEpoch: 0
+        producerSeq: 2
+        expect:
+          status: 200
+
+  - id: sequence-gap-rejected
+    name: Sequence gap returns 409
+    description: Skipping a sequence number should return 409 with expected/received seq
+    setup:
+      - action: create
+        as: streamPath
+        contentType: text/plain
+    operations:
+      - action: server-append
+        path: ${streamPath}
+        data: "msg0"
+        producerId: test-producer
+        producerEpoch: 0
+        producerSeq: 0
+        expect:
+          status: 200
+      # Skip seq=1, try seq=2
+      - action: server-append
+        path: ${streamPath}
+        data: "msg2"
+        producerId: test-producer
+        producerEpoch: 0
+        producerSeq: 2
+        expect:
+          status: 409
+          producerExpectedSeq: 1
+          producerReceivedSeq: 2
+
+  - id: new-producer-seq-not-zero
+    name: New producer starting with seq > 0 returns 409
+    description: A never-seen producer sending seq > 0 should get 409 (gap), not 400
+    setup:
+      - action: create
+        as: streamPath
+        contentType: text/plain
+    operations:
+      - action: server-append
+        path: ${streamPath}
+        data: "msg"
+        producerId: brand-new-producer
+        producerEpoch: 0
+        producerSeq: 5
+        expect:
+          status: 409
+          producerExpectedSeq: 0
+          producerReceivedSeq: 5
+
+  - id: duplicate-returns-204
+    name: Duplicate sequence returns 204 (idempotent success)
+    description: Retrying the same seq should return 204 without duplicating data
+    setup:
+      - action: create
+        as: streamPath
+        contentType: text/plain
+    operations:
+      - action: server-append
+        path: ${streamPath}
+        data: "hello"
+        producerId: test-producer
+        producerEpoch: 0
+        producerSeq: 0
+        expect:
+          status: 200
+      - action: server-append
+        path: ${streamPath}
+        data: "hello"
+        producerId: test-producer
+        producerEpoch: 0
+        producerSeq: 0
+        expect:
+          status: 204
+          duplicate: true
+      # Verify only one message in stream
+      - action: read
+        path: ${streamPath}
+        expect:
+          data: "hello"
+          upToDate: true
+
+  - id: duplicate-seq-zero-preserves-state
+    name: Duplicate of seq=0 does not corrupt state
+    description: Retrying seq=0 should not affect subsequent sequence tracking
+    setup:
+      - action: create
+        as: streamPath
+        contentType: text/plain
+    operations:
+      - action: server-append
+        path: ${streamPath}
+        data: "first"
+        producerId: test-producer
+        producerEpoch: 0
+        producerSeq: 0
+        expect:
+          status: 200
+      # Retry seq=0
+      - action: server-append
+        path: ${streamPath}
+        data: "first"
+        producerId: test-producer
+        producerEpoch: 0
+        producerSeq: 0
+        expect:
+          status: 204
+      # seq=1 should still work
+      - action: server-append
+        path: ${streamPath}
+        data: "second"
+        producerId: test-producer
+        producerEpoch: 0
+        producerSeq: 1
+        expect:
+          status: 200
+
+  - id: duplicate-ignores-different-data
+    name: Duplicate seq ignores payload differences
+    description: Same (producer, epoch, seq) returns 204 even with different data - dedup is by headers only
+    setup:
+      - action: create
+        as: streamPath
+        contentType: text/plain
+    operations:
+      - action: server-append
+        path: ${streamPath}
+        data: "original payload"
+        producerId: test-producer
+        producerEpoch: 0
+        producerSeq: 0
+        expect:
+          status: 200
+      # Retry with different data - should still be 204 (idempotent)
+      - action: server-append
+        path: ${streamPath}
+        data: "different payload"
+        producerId: test-producer
+        producerEpoch: 0
+        producerSeq: 0
+        expect:
+          status: 204
+          duplicate: true
+      # Verify only original data is in stream
+      - action: read
+        path: ${streamPath}
+        expect:
+          data: "original payload"
+          upToDate: true
+
+  - id: ordering-preserved-in-stream
+    name: Message ordering preserved in stream
+    description: Messages from idempotent producer maintain sequence order
+    setup:
+      - action: create
+        as: streamPath
+        contentType: application/json
+    operations:
+      - action: server-append
+        path: ${streamPath}
+        data: '{"seq": 0}'
+        producerId: order-test
+        producerEpoch: 0
+        producerSeq: 0
+        expect:
+          status: 200
+      - action: server-append
+        path: ${streamPath}
+        data: '{"seq": 1}'
+        producerId: order-test
+        producerEpoch: 0
+        producerSeq: 1
+        expect:
+          status: 200
+      - action: server-append
+        path: ${streamPath}
+        data: '{"seq": 2}'
+        producerId: order-test
+        producerEpoch: 0
+        producerSeq: 2
+        expect:
+          status: 200
+      - action: read
+        path: ${streamPath}
+        expect:
+          dataContainsAll:
+            - '"seq":0'
+            - '"seq":1'
+            - '"seq":2'
+          upToDate: true
+
+  - id: duplicate-old-sequence
+    name: Duplicate of old (non-tail) sequence returns 204
+    description: |
+      Retrying a sequence far back in history should still return 204.
+      This tests that the server tracks more than just the last sequence.
+      (Kafka distinguishes DuplicateSequenceException vs OutOfOrderSequenceException)
+    setup:
+      - action: create
+        as: streamPath
+        contentType: text/plain
+    operations:
+      # Send sequences 0-5
+      - action: server-append
+        path: ${streamPath}
+        data: "msg0"
+        producerId: test-producer
+        producerEpoch: 0
+        producerSeq: 0
+        expect:
+          status: 200
+      - action: server-append
+        path: ${streamPath}
+        data: "msg1"
+        producerId: test-producer
+        producerEpoch: 0
+        producerSeq: 1
+        expect:
+          status: 200
+      - action: server-append
+        path: ${streamPath}
+        data: "msg2"
+        producerId: test-producer
+        producerEpoch: 0
+        producerSeq: 2
+        expect:
+          status: 200
+      - action: server-append
+        path: ${streamPath}
+        data: "msg3"
+        producerId: test-producer
+        producerEpoch: 0
+        producerSeq: 3
+        expect:
+          status: 200
+      - action: server-append
+        path: ${streamPath}
+        data: "msg4"
+        producerId: test-producer
+        producerEpoch: 0
+        producerSeq: 4
+        expect:
+          status: 200
+      - action: server-append
+        path: ${streamPath}
+        data: "msg5"
+        producerId: test-producer
+        producerEpoch: 0
+        producerSeq: 5
+        expect:
+          status: 200
+      # Retry seq=1 (old, non-tail sequence)
+      - action: server-append
+        path: ${streamPath}
+        data: "msg1"
+        producerId: test-producer
+        producerEpoch: 0
+        producerSeq: 1
+        expect:
+          status: 204
+          duplicate: true
+      # Retry seq=0 (first sequence)
+      - action: server-append
+        path: ${streamPath}
+        data: "msg0"
+        producerId: test-producer
+        producerEpoch: 0
+        producerSeq: 0
+        expect:
+          status: 204
+          duplicate: true
+      # New sequence should still work
+      - action: server-append
+        path: ${streamPath}
+        data: "msg6"
+        producerId: test-producer
+        producerEpoch: 0
+        producerSeq: 6
+        expect:
+          status: 200