@laserdata/laser-sdk 0.5.0 → 0.5.2

package/dist/wire/filter.js

@@ -4,7 +4,7 @@ import { CodecError, InvalidError } from "../client/errors.js";
 import { expectArray, expectBytes, expectMap, expectString, expectU32, expectU64, field, singleVariantTag } from "./cbor.js";
 import { decodeGrant, encodeGrant } from "./authz.js";
 import { FILTER_OP_VERSION } from "./codes.js";
-import { MAX_FILTER_BYTES, MAX_FILTER_DEPTH, MAX_FILTER_DESCRIPTION_BYTES, MAX_FILTER_LIST_ITEMS, MAX_FILTER_NAME_BYTES, MAX_FILTER_NODES, MAX_FILTER_PATH_BYTES, MAX_FILTER_PATH_SEGMENTS, MAX_FILTER_PREVIEW_EXAMINED, MAX_FILTER_PREVIEW_RECORDS, MAX_FILTER_SAMPLE_BYTES, MAX_FILTER_SAMPLE_HEADERS, MAX_FILTER_SOURCE_NAME_BYTES, MAX_FILTER_STRING_BYTES, MAX_FILTER_CATALOG_PAGE, MAX_FILTERED_PAGE_BYTES, MAX_FILTERED_PAGE_RECORDS } from "./limits.js";
+import { MAX_FILTER_BYTES, MAX_FILTER_DEPTH, MAX_FILTER_DESCRIPTION_BYTES, MAX_FILTER_LIST_ITEMS, MAX_FILTER_NAME_BYTES, MAX_FILTER_NODES, MAX_FILTER_PATH_BYTES, MAX_FILTER_PATH_SEGMENTS, MAX_FILTER_PREVIEW_EXAMINED, MAX_FILTER_PREVIEW_RECORDS, MAX_FILTER_SAMPLE_BYTES, MAX_FILTER_SAMPLE_HEADERS, MAX_FILTER_SOURCE_NAME_BYTES, MAX_FILTER_STRING_BYTES, MAX_FILTER_CATALOG_PAGE, MAX_FILTERED_PAGE_BYTES, MAX_FILTERED_PAGE_EXAMINED, MAX_FILTERED_PAGE_RECORDS } from "./limits.js";
 import { resultCodeFromWord, resultCodeWord } from "./result.js";
 import { decodeTypedValue } from "./schema.js";
 /** The catalog byte limit a command logged before the field existed replays with. */
@@ -873,8 +873,10 @@ export function nextFilteredStart(page, original) {
         continuation: {
             nextScanOffset: page.nextScanOffset,
             generation: page.generation,
-            digest: page.policy.digest,
+            ...(page.policy.digest === undefined ? {} : { digest: page.policy.digest }),
             readMode: page.readMode,
+            mode: page.policy.mode,
+            policyGeneration: page.policy.policyGeneration,
             ...(page.policy.groupId !== undefined ? { groupId: page.policy.groupId } : {})
         }
     };
@@ -915,8 +917,9 @@ export function validateFilteredPollRequest(request) {
     validateSource(request.source);
     validateConsumer(request.consumer);
     validateFilterRef(request.filter);
-    if (request.filter.kind === "bound" && request.consumer.kind === "consumer") {
-        throw new InvalidError("a `bound` filter needs a consumer group");
+    if ((request.filter.kind === "bound" || request.filter.kind === "group") &&
+        request.consumer.kind === "consumer") {
+        throw new InvalidError("a `bound` or `group` filter needs a consumer group");
     }
     if (!Number.isInteger(request.count) ||
         request.count < 1 ||
@@ -928,8 +931,16 @@ export function validateFilteredPollRequest(request) {
         request.maxReplyBytes > MAX_FILTERED_PAGE_BYTES) {
         throw new InvalidError(`max_reply_bytes must be 1..=${String(MAX_FILTERED_PAGE_BYTES)}`);
     }
+    if (request.maxExamined !== undefined &&
+        (!Number.isInteger(request.maxExamined) ||
+            request.maxExamined < 1 ||
+            request.maxExamined > MAX_FILTERED_PAGE_EXAMINED)) {
+        throw new InvalidError(`max_examined must be 1..=${String(MAX_FILTERED_PAGE_EXAMINED)}`);
+    }
     if (request.start.kind === "continue") {
-        validateDigest(request.start.continuation.digest);
+        validatePolicyIdentity(request.start.continuation.mode, request.start.continuation.digest);
+        if (request.start.continuation.mode === "unfiltered" && request.consumer.kind === "consumer")
+            throw new InvalidError("only a consumer group runs unfiltered");
         if ((request.consumer.kind !== "consumer") !==
             (request.start.continuation.groupId !== undefined))
             throw new InvalidError("a group continuation must retain its group identity");
@@ -938,11 +949,24 @@ export function validateFilteredPollRequest(request) {
         }
     }
 }
+/** A filtered policy names its digest and an unfiltered one has none. */
+export function validatePolicyIdentity(mode, digest) {
+    if (mode === "filtered") {
+        if (digest === undefined)
+            throw new InvalidError("a filtered policy names its digest");
+        validateDigest(digest);
+    }
+    else if (digest !== undefined) {
+        throw new InvalidError("an unfiltered policy carries no digest");
+    }
+}
 export function validateFilteredAck(ack) {
     validateVersion(ack.v);
     validateSource(ack.source);
     validateConsumer(ack.consumer);
-    validateDigest(ack.digest);
+    validatePolicyIdentity(ack.mode, ack.digest);
+    if (ack.mode === "unfiltered" && ack.consumer.kind === "consumer")
+        throw new InvalidError("only a consumer group runs unfiltered");
     if ((ack.consumer.kind !== "consumer") !== (ack.groupId !== undefined))
         throw new InvalidError("a group acknowledgment must retain its group identity");
     if (ack.generation.partitionId !== ack.partitionId) {
@@ -953,7 +977,7 @@ export function validateFilterPreviewRequest(request) {
     validateVersion(request.v);
     validateSource(request.source);
     validateFilterRef(request.filter);
-    if (request.filter.kind === "bound") {
+    if (request.filter.kind === "bound" || request.filter.kind === "group") {
         throw new InvalidError("a preview executes an inline filter or a saved revision");
     }
     if (request.maxExamined === 0 || request.maxExamined > MAX_FILTER_PREVIEW_EXAMINED) {
@@ -966,7 +990,7 @@ export function validateFilterPreviewRequest(request) {
 export function validateFilterTestRequest(request) {
     validateVersion(request.v);
     validateFilterRef(request.filter);
-    if (request.filter.kind === "bound") {
+    if (request.filter.kind === "bound" || request.filter.kind === "group") {
         throw new InvalidError("a sample test executes an inline filter or a saved revision");
     }
     if (request.payload.byteLength > MAX_FILTER_SAMPLE_BYTES) {
@@ -1019,6 +1043,11 @@ export function validateFilterMutation(mutation) {
         case "unbind":
             validateFilterGroupRef(mutation.group);
             validateDigest(mutation.expectedDigest);
+            return;
+        case "configure_group":
+            validateFilterGroupRef(mutation.group);
+            if (mutation.policy.kind === "definition")
+                validateConsumerFilter(mutation.policy.filter);
     }
 }
 function validateFilterName(name) {
@@ -1209,8 +1238,29 @@ export function encodeFilterRef(filter) {
             ]);
         case "bound":
             return "bound";
+        case "group":
+            return "group";
     }
 }
+export function encodeCatalogPosition(position) {
+    return mapOf([
+        ["partition_id", position.partitionId],
+        ["offset", position.offset],
+        ...(position.operationId === undefined ? [] : [["operation_id", position.operationId]])
+    ]);
+}
+export function decodeCatalogPosition(value, context) {
+    const map = expectMap(value, context);
+    return {
+        partitionId: requiredU32(map, "partition_id", context),
+        offset: field.requiredU64(map, "offset", context),
+        ...(map.has("operation_id") ? { operationId: operationIdOf(map, context) } : {})
+    };
+}
+const EXECUTION_MODES = new Set(["filtered", "unfiltered"]);
+function decodeExecutionMode(value, context) {
+    return oneOf(value, EXECUTION_MODES, context);
+}
 export function encodeSourceGeneration(generation) {
     return mapOf([
         ["stream_id", generation.streamId],
@@ -1242,10 +1292,14 @@ export function encodeFilteredStart(start) {
                             : [["group_id", start.continuation.groupId]]),
                         ["next_scan_offset", start.continuation.nextScanOffset],
                         ["generation", encodeSourceGeneration(start.continuation.generation)],
-                        ["digest", start.continuation.digest],
+                        ...(start.continuation.digest === undefined
+                            ? []
+                            : [["digest", start.continuation.digest]]),
                         ...(start.continuation.readMode === "primary"
                             ? []
-                            : [["read_mode", start.continuation.readMode]])
+                            : [["read_mode", start.continuation.readMode]]),
+                        ["mode", start.continuation.mode],
+                        ["policy_generation", start.continuation.policyGeneration]
                     ])
                 ]
             ]);
@@ -1261,7 +1315,11 @@ export function encodeFilteredPollRequest(request) {
         ["start", encodeFilteredStart(request.start)],
         ["count", request.count],
         ["max_reply_bytes", request.maxReplyBytes],
-        ["read_mode", request.readMode]
+        ["read_mode", request.readMode],
+        ...(request.maxExamined === undefined ? [] : [["max_examined", request.maxExamined]]),
+        ...(request.minCatalogPosition === undefined
+            ? []
+            : [["min_catalog_position", encodeCatalogPosition(request.minCatalogPosition)]])
     ]);
 }
 export function encodeFilteredAck(ack) {
@@ -1272,8 +1330,10 @@ export function encodeFilteredAck(ack) {
         ["partition_id", ack.partitionId],
         ["consumer", encodeFilterConsumer(ack.consumer)],
         ["generation", encodeSourceGeneration(ack.generation)],
-        ["digest", ack.digest],
-        ["offset", ack.offset]
+        ...(ack.digest === undefined ? [] : [["digest", ack.digest]]),
+        ["offset", ack.offset],
+        ["mode", ack.mode],
+        ["policy_generation", ack.policyGeneration]
     ]);
 }
 export function encodeFilterPreviewRequest(request) {
@@ -1311,9 +1371,11 @@ export function encodeFilterTestRequest(request) {
 function encodeAppliedPolicy(policy) {
     const map = mapOf([]);
     setIf(map, "group_id", policy.groupId);
-    map.set("digest", policy.digest);
+    setIf(map, "digest", policy.digest);
     setIf(map, "filter_id", policy.filterId);
     setIf(map, "revision", policy.revision);
+    map.set("mode", policy.mode);
+    map.set("policy_generation", policy.policyGeneration);
     return map;
 }
 export function encodeFilteredPage(page) {
@@ -1533,7 +1595,56 @@ export function encodeFilterMutation(mutation) {
                     ])
                 ]
             ]);
+        case "configure_group":
+            return mapOf([
+                [
+                    "configure_group",
+                    mapOf([
+                        ["group", encodeFilterGroupRef(mutation.group)],
+                        ["policy", encodeGroupFilterSpec(mutation.policy)],
+                        ...(mutation.expectedIdentity === undefined
+                            ? []
+                            : [
+                                [
+                                    "expected_identity",
+                                    encodeFilterGroupIdentity(mutation.expectedIdentity)
+                                ]
+                            ])
+                    ])
+                ]
+            ]);
+    }
+}
+function encodeGroupFilterSpec(spec) {
+    switch (spec.kind) {
+        case "definition":
+            return mapOf([["definition", encodeConsumerFilter(spec.filter)]]);
+        case "revision":
+            return mapOf([
+                [
+                    "revision",
+                    mapOf([
+                        ["filter_id", spec.filterId],
+                        ["revision", spec.revision]
+                    ])
+                ]
+            ]);
+    }
+}
+function decodeGroupFilterSpec(value, context) {
+    const [tag, inner] = singleVariantTag(value, context);
+    if (tag === "definition") {
+        return { kind: "definition", filter: decodeConsumerFilter(inner, `${context}.definition`) };
+    }
+    if (tag === "revision") {
+        const map = expectMap(inner, `${context}.revision`);
+        return {
+            kind: "revision",
+            filterId: requiredU32(map, "filter_id", context),
+            revision: requiredU32(map, "revision", context)
+        };
     }
+    throw new CodecError(`\`${tag}\` is not a recognized group filter policy`, context, "policy");
 }
 export function encodeFilterMutationRequest(request) {
     return mapOf([
@@ -1628,7 +1739,8 @@ function encodeFilterBinding(binding) {
         ["filter_id", binding.filterId],
         ["revision", binding.revision],
         ["digest", binding.digest],
-        ["bound_at_micros", binding.boundAtMicros]
+        ["bound_at_micros", binding.boundAtMicros],
+        ["policy_generation", binding.policyGeneration]
     ]);
 }
 function encodeMutationResult(result) {
@@ -1665,7 +1777,10 @@ function encodeMutationOutcome(outcome) {
     return mapOf([
         ["v", outcome.v],
         ["operation_id", outcome.operationId],
-        ["status", status]
+        ["status", status],
+        ...(outcome.catalogPosition === undefined
+            ? []
+            : [["catalog_position", encodeCatalogPosition(outcome.catalogPosition)]])
     ]);
 }
 function encodeRevisionInfo(info) {
@@ -1754,7 +1869,18 @@ function encodeCatalogOutcome(outcome) {
                         ["revision", outcome.policy.revision],
                         ["digest", outcome.policy.digest],
                         ["state", outcome.policy.state],
-                        ["filter", encodeConsumerFilter(outcome.policy.filter)]
+                        ["filter", encodeConsumerFilter(outcome.policy.filter)],
+                        ["policy_generation", outcome.policy.policyGeneration]
+                    ])
+                ]
+            ]);
+        case "unbound":
+            return mapOf([
+                [
+                    "unbound",
+                    mapOf([
+                        ["identity", encodeFilterGroupIdentity(outcome.unbound.identity)],
+                        ["policy_generation", outcome.unbound.policyGeneration]
                     ])
                 ]
             ]);
@@ -1978,6 +2104,8 @@ export function decodeFilterConsumer(value, context) {
 export function decodeFilterRef(value, context) {
     if (value === "bound")
         return { kind: "bound" };
+    if (value === "group")
+        return { kind: "group" };
     const [tag, inner] = singleVariantTag(value, context);
     if (tag === "inline") {
         return { kind: "inline", filter: decodeConsumerFilter(inner, `${context}.inline`) };
@@ -2028,10 +2156,14 @@ export function decodeFilteredStart(value, context) {
                     ...(groupId !== undefined ? { groupId } : {}),
                     nextScanOffset: field.requiredU64(map, "next_scan_offset", context),
                     generation: decodeSourceGeneration(map.get("generation"), `${context}.generation`),
-                    digest: requiredBytes(map, "digest", context),
+                    ...(map.has("digest") ? { digest: requiredBytes(map, "digest", context) } : {}),
                     readMode: map.has("read_mode")
                         ? decodeReadMode(map.get("read_mode"), `${context}.read_mode`)
-                        : "primary"
+                        : "primary",
+                    mode: map.has("mode")
+                        ? decodeExecutionMode(map.get("mode"), `${context}.mode`)
+                        : "filtered",
+                    policyGeneration: field.optionalU64(map, "policy_generation", context) ?? 0n
                 }
             };
         }
@@ -2055,7 +2187,13 @@ export function decodeFilteredPollRequest(value, context) {
         maxReplyBytes: requiredU32(map, "max_reply_bytes", context),
         readMode: map.has("read_mode")
             ? decodeReadMode(map.get("read_mode"), `${context}.read_mode`)
-            : "primary"
+            : "primary",
+        ...(map.has("max_examined") ? { maxExamined: requiredU32(map, "max_examined", context) } : {}),
+        ...(map.has("min_catalog_position")
+            ? {
+                minCatalogPosition: decodeCatalogPosition(map.get("min_catalog_position"), `${context}.min_catalog_position`)
+            }
+            : {})
     };
 }
 export function decodeFilteredAck(value, context) {
@@ -2068,8 +2206,10 @@ export function decodeFilteredAck(value, context) {
         partitionId: requiredU32(map, "partition_id", context),
         consumer: decodeFilterConsumer(map.get("consumer"), `${context}.consumer`),
         generation: decodeSourceGeneration(map.get("generation"), `${context}.generation`),
-        digest: requiredBytes(map, "digest", context),
-        offset: field.requiredU64(map, "offset", context)
+        ...(map.has("digest") ? { digest: requiredBytes(map, "digest", context) } : {}),
+        offset: field.requiredU64(map, "offset", context),
+        mode: map.has("mode") ? decodeExecutionMode(map.get("mode"), `${context}.mode`) : "filtered",
+        policyGeneration: field.optionalU64(map, "policy_generation", context) ?? 0n
     };
 }
 function decodeAppliedPolicy(value, context) {
@@ -2079,9 +2219,11 @@ function decodeAppliedPolicy(value, context) {
     const groupId = field.optionalU64(map, "group_id", context);
     return {
         ...(groupId !== undefined ? { groupId } : {}),
-        digest: requiredBytes(map, "digest", context),
+        ...(map.has("digest") ? { digest: requiredBytes(map, "digest", context) } : {}),
         ...(filterId !== undefined ? { filterId } : {}),
-        ...(revision !== undefined ? { revision } : {})
+        ...(revision !== undefined ? { revision } : {}),
+        mode: map.has("mode") ? decodeExecutionMode(map.get("mode"), `${context}.mode`) : "filtered",
+        policyGeneration: field.optionalU64(map, "policy_generation", context) ?? 0n
     };
 }
 function decodeFaultReason(value, context) {
@@ -2351,6 +2493,17 @@ export function decodeFilterMutation(value, context) {
                     }
                     : {})
             };
+        case "configure_group":
+            return {
+                kind: "configure_group",
+                group: decodeFilterGroupRef(map.get("group"), `${context}.configure_group.group`),
+                policy: decodeGroupFilterSpec(map.get("policy"), `${context}.configure_group.policy`),
+                ...(map.has("expected_identity") && map.get("expected_identity") !== null
+                    ? {
+                        expectedIdentity: decodeFilterGroupIdentity(map.get("expected_identity"), `${context}.configure_group.expected_identity`)
+                    }
+                    : {})
+            };
         default:
             throw new CodecError(`\`${tag}\` is not a recognized filter mutation`, context, "mutation");
     }
@@ -2409,7 +2562,8 @@ function decodeFilterBinding(value, context) {
         filterId: requiredU32(map, "filter_id", context),
         revision: requiredU32(map, "revision", context),
         digest: requiredBytes(map, "digest", context),
-        boundAtMicros: field.requiredU64(map, "bound_at_micros", context)
+        boundAtMicros: field.requiredU64(map, "bound_at_micros", context),
+        policyGeneration: field.optionalU64(map, "policy_generation", context) ?? 0n
     };
 }
 function decodeMutationResult(value, context) {
@@ -2458,7 +2612,12 @@ export function decodeFilterMutationOutcome(value, context) {
     return {
         v: requiredU32(map, "v", context),
         operationId: operationIdOf(map, context),
-        status: decodeMutationStatus(map.get("status"), `${context}.status`)
+        status: decodeMutationStatus(map.get("status"), `${context}.status`),
+        ...(map.has("catalog_position")
+            ? {
+                catalogPosition: decodeCatalogPosition(map.get("catalog_position"), `${context}.catalog_position`)
+            }
+            : {})
     };
 }
 function decodeRevisionInfo(value, context) {
@@ -2530,7 +2689,16 @@ function decodeCatalogOutcome(value, context) {
                     revision: requiredU32(map, "revision", innerContext),
                     digest: requiredBytes(map, "digest", innerContext),
                     state: oneOf(map.get("state"), FILTER_STATES, `${innerContext}.state`),
-                    filter: decodeConsumerFilter(map.get("filter"), `${innerContext}.filter`)
+                    filter: decodeConsumerFilter(map.get("filter"), `${innerContext}.filter`),
+                    policyGeneration: field.optionalU64(map, "policy_generation", innerContext) ?? 0n
+                }
+            };
+        case "unbound":
+            return {
+                kind: "unbound",
+                unbound: {
+                    identity: decodeFilterGroupIdentity(map.get("identity"), `${innerContext}.identity`),
+                    policyGeneration: field.requiredU64(map, "policy_generation", innerContext)
                 }
             };
         default: