refactor(http-recorder): use Schema.TaggedErrorClass for cassette errors (#26729)

This commit is contained in:
Kit Langton
2026-05-10 12:43:33 -04:00
committed by GitHub
parent b616543ac2
commit e45b6ef1de
3 changed files with 18 additions and 14 deletions

View File

@@ -1,4 +1,4 @@
import { Context, Data, Effect, FileSystem, Layer } from "effect"
import { Context, Effect, FileSystem, Layer, Schema } from "effect"
import * as fs from "node:fs"
import * as path from "node:path"
import { secretFindings, type SecretFinding } from "./redaction"
@@ -6,9 +6,10 @@ import { decodeCassette, encodeCassette, type Cassette, type CassetteMetadata, t
const DEFAULT_RECORDINGS_DIR = path.resolve(process.cwd(), "test", "fixtures", "recordings")
export class CassetteNotFoundError extends Data.TaggedError("CassetteNotFoundError")<{
readonly cassetteName: string
}> {
export class CassetteNotFoundError extends Schema.TaggedErrorClass<CassetteNotFoundError>()(
"CassetteNotFoundError",
{ cassetteName: Schema.String },
) {
override get message() {
return `Cassette "${this.cassetteName}" not found`
}

View File

@@ -1,13 +1,13 @@
import { Data, Effect, Ref, Scope } from "effect"
import { Effect, Ref, Schema, Scope } from "effect"
import type * as CassetteService from "./cassette"
import type { CassetteNotFoundError } from "./cassette"
import type { SecretFinding } from "./redaction"
import { SecretFindingSchema } from "./redaction"
import type { CassetteMetadata, Interaction } from "./schema"
export class UnsafeCassetteError extends Data.TaggedError("UnsafeCassetteError")<{
readonly cassetteName: string
readonly findings: ReadonlyArray<SecretFinding>
}> {
export class UnsafeCassetteError extends Schema.TaggedErrorClass<UnsafeCassetteError>()("UnsafeCassetteError", {
cassetteName: Schema.String,
findings: Schema.Array(SecretFindingSchema),
}) {
override get message() {
return `Refusing to write cassette "${this.cassetteName}" because it contains possible secrets: ${this.findings
.map((finding) => `${finding.path} (${finding.reason})`)

View File

@@ -95,10 +95,13 @@ export const redactHeaders = (
)
}
export type SecretFinding = {
readonly path: string
readonly reason: string
}
import { Schema } from "effect"
export const SecretFindingSchema = Schema.Struct({
path: Schema.String,
reason: Schema.String,
})
export type SecretFinding = Schema.Schema.Type<typeof SecretFindingSchema>
export const secretFindings = (value: unknown): ReadonlyArray<SecretFinding> =>
stringEntries(value).flatMap((entry) => [