From ab65a96643e44cec71bbdffe03a9179f88bfadca Mon Sep 17 00:00:00 2001 From: morluto <76467478+morluto@users.noreply.github.com> Date: Mon, 16 Nov 2026 04:41:46 +0800 Subject: [PATCH] refactor(domain): name the managed metadata status and complete-or-unknown coverage once (#11459) --- .../verify/baselines/local-completeness-enum.json | 8 +------- src/domain/analysisView/rustBinaryView.ts | 3 ++- src/domain/artifactFormatMetadata.ts | 3 ++- src/domain/artifactGraph.ts | 5 +++-- src/domain/coverage.ts | 9 +++++++++ src/domain/managed/managedArtifact.ts | 14 ++++++++++++-- src/domain/managed/managedMemberComparison.ts | 3 ++- .../managed/managedNativeVerificationSchemas.ts | 3 ++- src/domain/managed/managedReconstruction.ts | 3 ++- 9 files changed, 35 insertions(+), 16 deletions(-) diff --git a/scripts/verify/baselines/local-completeness-enum.json b/scripts/verify/baselines/local-completeness-enum.json index 06a1f7e840..eea85cabdb 100644 --- a/scripts/verify/baselines/local-completeness-enum.json +++ b/scripts/verify/baselines/local-completeness-enum.json @@ -4,10 +4,8 @@ "src/cutter/CutterBridgeClient.ts": 2, "src/domain/analysisView/browserScenarioViewSchemas.ts": 1, "src/domain/analysisView/goBinaryView.ts": 1, - "src/domain/analysisView/rustBinaryView.ts": 1, "src/domain/analysisView/webNetworkCaptureView.ts": 1, - "src/domain/artifactFormatMetadata.ts": 3, - "src/domain/artifactGraph.ts": 2, + "src/domain/artifactFormatMetadata.ts": 2, "src/domain/commandObservation.ts": 2, "src/domain/evidenceRecordSummary.ts": 1, "src/domain/gpu/gpuCodeObjects.ts": 1, @@ -15,10 +13,6 @@ "src/domain/javascript/javascriptExportShapeComparisonSchemas.ts": 1, "src/domain/javascript/javascriptRouteInventory.ts": 1, "src/domain/javascript/javascriptStaticCoverage.ts": 1, - "src/domain/managed/managedArtifact.ts": 2, - "src/domain/managed/managedMemberComparison.ts": 1, - "src/domain/managed/managedNativeVerificationSchemas.ts": 1, - "src/domain/managed/managedReconstruction.ts": 1, "src/domain/model/modelArtifact.ts": 1, "src/domain/native/kernelBuildConfig.ts": 1, "src/domain/native/nativeInitializers.ts": 1, diff --git a/src/domain/analysisView/rustBinaryView.ts b/src/domain/analysisView/rustBinaryView.ts index 78550b5257..e0d8d6dd06 100644 --- a/src/domain/analysisView/rustBinaryView.ts +++ b/src/domain/analysisView/rustBinaryView.ts @@ -1,3 +1,4 @@ +import { completeOrUnknownCoverageSchema } from "../coverage.js"; import { binaryMetadataArchitecture } from "../binaryMetadataArchitecture.js"; import { metadataReportSubjectFormat } from "../apple/machoTargetSelection.js"; import { z } from "zod"; @@ -57,7 +58,7 @@ export const rustBinarySummarySchema = z.strictObject({ export const rustBinaryViewContextSchema = z.strictObject({ source_coverage: z.strictObject({ auditable_metadata_available: z.boolean(), - embedded_records: z.enum(["complete", "unknown"]), + embedded_records: completeOrUnknownCoverageSchema, runtime_dependencies: z.literal("unknown"), }), }); diff --git a/src/domain/artifactFormatMetadata.ts b/src/domain/artifactFormatMetadata.ts index 61e83f863d..f23fce1bd3 100644 --- a/src/domain/artifactFormatMetadata.ts +++ b/src/domain/artifactFormatMetadata.ts @@ -1,3 +1,4 @@ +import { completeOrUnknownCoverageSchema } from "./coverage.js"; import { ntfsFileReferenceSchema, ntfsFileNameSchema, @@ -637,7 +638,7 @@ export const espFlashImageFactsSchema = z.strictObject({ image: espImageMetadataSchema.nullable(), segments: z.array(espImageSegmentMetadataSchema), signature_blocks: z.array(espImageSignatureBlockMetadataSchema), - coverage: z.enum(["complete", "unknown"]).nullable(), + coverage: completeOrUnknownCoverageSchema.nullable(), limitations: z.array(z.string()), }); diff --git a/src/domain/artifactGraph.ts b/src/domain/artifactGraph.ts index 5205687bb0..1a70bcecee 100644 --- a/src/domain/artifactGraph.ts +++ b/src/domain/artifactGraph.ts @@ -1,3 +1,4 @@ +import { completeOrUnknownCoverageSchema } from "./coverage.js"; import { artifactDfuCrc32PairSchema, artifactIntegrityClaimSchema, @@ -174,7 +175,7 @@ export const artifactOccurrenceSchema = z.object({ artifact_id: artifactIdSchema.nullable(), parent_occurrence_id: occurrenceIdSchema.nullable(), /** Producer coverage of this occurrence's modeled relationships. Historical omission is unknown. */ - relationship_coverage: z.enum(["complete", "unknown"]).exactOptional(), + relationship_coverage: completeOrUnknownCoverageSchema.exactOptional(), logical_path: boundedRelativePathSchema, entry_kind: z.enum(["file", "directory", "symlink", "slice", "metadata"]), artifact_kind: artifactKindSchema, @@ -250,7 +251,7 @@ export const artifactGraphManifestSchema = z.object({ /** Producer-owned traversal coverage; content certainty remains on each occurrence. */ export const artifactInventoryCoverageSchema = z.strictObject({ scope: z.enum(["root", "container-entries"]), - status: z.enum(["complete", "unknown"]), + status: completeOrUnknownCoverageSchema, }); export type ArtifactInventoryCoverage = z.infer< typeof artifactInventoryCoverageSchema diff --git a/src/domain/coverage.ts b/src/domain/coverage.ts index ea1520ff86..cd4dcddffa 100644 --- a/src/domain/coverage.ts +++ b/src/domain/coverage.ts @@ -18,6 +18,15 @@ export const knownCoverageStatusSchema = coverageStatusSchema.exclude([ ]); export type KnownCoverageStatus = z.infer; +/** + * Coverage of a producer that either covered its whole universe or cannot + * tell how much it covered; it never measures a known gap, so it never + * reports `partial`. + */ +export const completeOrUnknownCoverageSchema = coverageStatusSchema.exclude([ + "partial", +]); + /** * Fold the coverage of the inputs a result depends on. Unknown wins: one input * that cannot tell makes the whole unknown, even beside a known gap. Otherwise diff --git a/src/domain/managed/managedArtifact.ts b/src/domain/managed/managedArtifact.ts index 65aecc62bf..21f2badf54 100644 --- a/src/domain/managed/managedArtifact.ts +++ b/src/domain/managed/managedArtifact.ts @@ -65,6 +65,16 @@ const moduleIdentitySchema = z.object({ row_offset: offsetSchema, }); +/** + * What a managed inspection established about the CLI metadata: none present, + * read in full or in part, or present but unreadable. + */ +export const managedMetadataStatusSchema = z.enum([ + "absent", + ...knownCoverageStatusSchema.options, + "malformed", +]); + const managedArtifactReferenceSchema = z.object({ path: z.string().min(1), sha256: digestSchema, @@ -73,7 +83,7 @@ const managedArtifactReferenceSchema = z.object({ }); const managedMetadataSummarySchema = z.object({ - status: z.enum(["absent", "complete", "partial", "malformed"]), + status: managedMetadataStatusSchema, version: z.string().nullable(), table_row_counts: z.record(z.string(), z.int().min(0).max(0xffff_ffff)), }); @@ -520,7 +530,7 @@ export const managedArtifactInspectionSchema = z.object({ ), }), metadata: z.object({ - status: z.enum(["absent", "complete", "partial", "malformed"]), + status: managedMetadataStatusSchema, version: z.string().nullable(), stream_names: z.array(z.string()), table_row_counts: z.record(z.string(), z.int().min(0).max(0xffff_ffff)), diff --git a/src/domain/managed/managedMemberComparison.ts b/src/domain/managed/managedMemberComparison.ts index 22f83a3c6d..b1bde592b8 100644 --- a/src/domain/managed/managedMemberComparison.ts +++ b/src/domain/managed/managedMemberComparison.ts @@ -6,6 +6,7 @@ import { evidenceInputSchema } from "../evidenceReference.js"; import { managedInspectionStateSchema, cliMetadataGuidSchema, + managedMetadataStatusSchema, managedMetadataTokenSchema, managedMemberInspectionSchema, type ManagedMemberInspection, @@ -173,7 +174,7 @@ const comparisonSideSchema = z.strictObject({ artifact_sha256: digestSchema, mvid: cliMetadataGuidSchema.nullable(), module_name: z.string().nullable(), - metadata_status: z.enum(["absent", "complete", "partial", "malformed"]), + metadata_status: managedMetadataStatusSchema, methods_total: z.int().min(0), fields_total: z.int().min(0), resource_limits: z diff --git a/src/domain/managed/managedNativeVerificationSchemas.ts b/src/domain/managed/managedNativeVerificationSchemas.ts index 840e13872f..4513061efd 100644 --- a/src/domain/managed/managedNativeVerificationSchemas.ts +++ b/src/domain/managed/managedNativeVerificationSchemas.ts @@ -5,6 +5,7 @@ import { evidenceInputSchema } from "../evidenceReference.js"; import { managedInspectionStateSchema, cliMetadataGuidSchema, + managedMetadataStatusSchema, managedNativeImportSchema, } from "./managedArtifact.js"; import { digestSchema, prefixedDigestSchema } from "../digests.js"; @@ -165,7 +166,7 @@ export const managedNativeVerificationResultSchema = z artifact_sha256: digestSchema, artifact_path: z.string().min(1), mvid: cliMetadataGuidSchema.nullable(), - metadata_status: z.enum(["absent", "complete", "partial", "malformed"]), + metadata_status: managedMetadataStatusSchema, pinvoke_imports_total: z.int().min(0), native_implementations_total: z.int().min(0), coverage_state: managedInspectionStateSchema, diff --git a/src/domain/managed/managedReconstruction.ts b/src/domain/managed/managedReconstruction.ts index 5b31d79952..cb7cb2b951 100644 --- a/src/domain/managed/managedReconstruction.ts +++ b/src/domain/managed/managedReconstruction.ts @@ -8,6 +8,7 @@ import type { EvidenceRequestFrameInput } from "../evidenceInputContract.js"; import { cliMetadataGuidSchema, managedMetadataTokenSchema, + managedMetadataStatusSchema, managedMemberInspectionSchema, type ManagedMemberInspection, } from "./managedArtifact.js"; @@ -106,7 +107,7 @@ export const managedReconstructionImportResultSchema = z.strictObject({ byte_length: z.int().min(0), module_name: z.string().nullable(), mvid: cliMetadataGuidSchema.nullable(), - metadata_status: z.enum(["absent", "complete", "partial", "malformed"]), + metadata_status: managedMetadataStatusSchema, }), decompiler: decompilerSchema.extend({ options_sha256: digestSchema,