feat: Marshal and unmarshal @ocap/errors

[sirtimid]

closes #150

Following #149, this PR modifies the marshaling functions in @ocap/streams such that errors from @ocap/errors are unmarshaled into their respective classes, based on the error code. It also extends the stringify utility to support ocap errors.

[socket-security]

New and removed dependencies detected. Learn more about Socket for GitHub ↗︎

Package	New capabilities	Transitives	Size	Publisher
npm/@typescript-eslint/eslint-plugin@8.9.0	None	0	2.67 MB	bradzacher, jameshenry
npm/@typescript-eslint/parser@8.9.0	None	0	18.7 kB	bradzacher, jameshenry
npm/@typescript-eslint/scope-manager@8.9.0	None	0	602 kB	bradzacher, jameshenry
npm/@typescript-eslint/type-utils@8.9.0	None	0	122 kB	bradzacher, jameshenry
npm/@typescript-eslint/types@8.9.0	None	0	172 kB	bradzacher, jameshenry
npm/@typescript-eslint/typescript-estree@8.9.0	None	0	590 kB	bradzacher, jameshenry
npm/@typescript-eslint/utils@8.9.0	None	0	283 kB	bradzacher, jameshenry
npm/@typescript-eslint/visitor-keys@8.9.0	None	0	19.3 kB	bradzacher, jameshenry
npm/eslint-plugin-jsdoc@50.4.1	None	+2	2.1 MB	gajus
npm/typescript-eslint@8.9.0	None	0	99.5 kB	jameshenry

🚮 Removed packages: npm/@typescript-eslint/eslint-plugin@8.8.1, npm/@typescript-eslint/parser@8.8.1, npm/@typescript-eslint/scope-manager@8.8.1, npm/@typescript-eslint/type-utils@8.8.1, npm/@typescript-eslint/types@8.8.1, npm/@typescript-eslint/typescript-estree@8.8.1, npm/@typescript-eslint/utils@8.8.1, npm/@typescript-eslint/visitor-keys@8.8.1, npm/eslint-plugin-jsdoc@50.4.0, npm/typescript-eslint@8.8.1

View full report↗︎

[rekmarks]

Nice! I have various questions and suggestions. For all of the errors, I left a number of suggestions on VatNotFoundError that are generally applicable.

Two big changes are harden:ing the error prototypes, error instances, and marshaled errors. You may want to do that after any changes I propose about e.g. reorganizing the types / utils.

[rekmarks]

Just a couple more things.

[rekmarks]

See comment in isMarshaledOcapError.ts.

Suggested change

	/**
	* Struct to validate marshaled errors.
	*/
	export const MarshaledErrorStruct = object({
	[ErrorSentinel]: literal(true),
	message: string(),
	code: optional(ErrorCodeStruct),
	data: optional(JsonStruct),
	stack: optional(string()),
	cause: optional(union([string(), lazy(() => MarshaledErrorStruct)])),
	}) as Struct<MarshaledError>;
	/**
	* Base schema for validating Ocap error classes during error marshaling.
	*/
	export const baseErrorStructSchema = {
	[ErrorSentinel]: literal(true),
	message: string(),
	code: ErrorCodeStruct,
	data: JsonStruct,
	stack: optional(string()),
	cause: optional(union([string(), lazy(() => MarshaledErrorStruct)])),
	};
	const marshaledErrorSchema = {
	[ErrorSentinel]: literal(true),
	message: string(),
	data: optional(JsonStruct),
	stack: optional(string()),
	};
	/**
	* Struct to validate marshaled errors.
	*/
	export const MarshaledErrorStruct = object({
	...marshaledErrorSchema,
	cause: optional(union([string(), lazy(() => MarshaledErrorStruct)])),
	}) as Struct<MarshaledError>;
	/**
	* Struct to validate marshaled ocap errors.
	*/
	export const MarshaledOcapErrorStruct = object({
	...marshaledErrorSchema,
	code: ErrorCodeStruct,
	data: JsonStruct,
	cause: optional(union([string(), lazy(() => MarshaledOcapErrorStruct)])),
	}) as Struct<MarshaledOcapError>;
	/**
	* Base schema for validating Ocap error classes during error marshaling.
	*/
	export const baseErrorStructSchema = {
	[ErrorSentinel]: literal(true),
	message: string(),
	code: ErrorCodeStruct,
	data: JsonStruct,
	stack: optional(string()),
	cause: optional(union([string(), lazy(() => MarshaledErrorStruct)])),
	};

[rekmarks]

LGTM!