feat(2.1.0): match, keyword configs, discrimination improvements (#1314)

Author: ssalbdivad

.npmrc

@@ -1,5 +1,20 @@
 # @ark/attest
 
+NOTE: This changelog is incomplete, but will include notable attest-specific changes (many updates consist almost entirely of bumped `arktype` versions for assertions).
+
+## 0.42.0
+
+### Bail early for obviously incorrect `equals` comparisons
+
+This is the short-term solution to #1287, where some comparisons with Node's `deepStrictEqual` and object with recursive properties like Type resulted in OOM crashes.
+
+We will eventually add new string-diffing logic, but for now we just make some shallow comparisons between constructors and types to avoid common problematic comparisons, e.g. between Type instances:
+
+```ts
+// previously resulted in OOM exception, now shallowly fails with simple error
+attest(type.string).equals(type.boolean)
+```
+
 ## 0.11.0
 
 - Fix a bug causing certain serialized types with backticks and template literals to be incorrectly formatted on inline snapshot

ark/attest/CHANGELOG.md

@@ -1,4 +1,5 @@
 import { attest } from "@ark/attest"
+import { type } from "arktype"
 import * as assert from "node:assert/strict"
 
 const o = { ark: "type" }
@@ -163,4 +164,20 @@ describe("type assertions", () => {
 			"specific"
 		)
 	})
+
+	it("does not boom on Type comparison", () => {
+		// @ts-expect-error
+		attest(() => attest(type.string).equals(type.number)).throws
+			.snap(`AssertionError [ERR_ASSERTION]: Assertion including at least one function or object was not between reference eqaul items
+Expected: number
+Actual: string`)
+	})
+
+	it("doesn't boom on ArkErrors vs plain object", () => {
+		attest(() => attest(type({ a: "string" })({ a: 5 })).equals({ a: "five" }))
+			.throws
+			.snap(`AssertionError [ERR_ASSERTION]: Objects did not have the same constructor:
+Expected: {"a":"five"}
+Actual: ArkErrors`)
+	})
 })

ark/attest/__tests__/assertions.test.ts

@@ -4,7 +4,7 @@ import { it } from "mocha"
 
 contextualize(() => {
 	it("inline", () => {
-		attest.instantiations([7574, "instantiations"])
+		attest.instantiations([23731, "instantiations"])
 		return type({
 			kind: "'admin'",
 			"powers?": "string[]"

ark/attest/__tests__/instantiations.test.ts

@@ -80,21 +80,47 @@ export const versionableAssertion =
 const unversionedAssertEquals: AssertFn = (expected, actual, ctx) => {
 	if (expected === actual) return
 
-	if (typeof expected === "object" && typeof actual === "object") {
-		try {
-			assert.deepStrictEqual(actual, expected)
-		} catch (e: any) {
-			e.stack = ctx.assertionStack
-			throw e
-		}
-	} else {
+	try {
+		if (
+			typeof expected === "object" &&
+			expected !== null &&
+			typeof actual === "object" &&
+			actual !== null
+		) {
+			if (expected.constructor === actual.constructor)
+				assert.deepStrictEqual(actual, expected)
+			else {
+				const serializedExpected = printable(expected)
+				const serializedActual = printable(actual)
+				throw new assert.AssertionError({
+					message: `Objects did not have the same constructor:
+Expected: ${serializedExpected}
+Actual: ${serializedActual}`,
+					expected: serializedExpected,
+					actual: serializedActual
+				})
+			}
+		} else if (
+			typeof expected === "object" ||
+			typeof expected === "function" ||
+			typeof actual === "function" ||
+			typeof actual === "function"
+		) {
+			const serializedExpected = printable(expected)
+			const serializedActual = printable(actual)
+			throw new assert.AssertionError({
+				message: `Assertion including at least one function or object was not between reference eqaul items
+Expected: ${serializedExpected}
+Actual: ${serializedActual}`,
+				expected: serializedExpected,
+				actual: serializedActual
+			})
+			// guaranteed to be two primitives at this point
+		} else assert.equal(actual, expected)
+	} catch (e: any) {
 		// some nonsense to get a good stack trace
-		try {
-			assert.strictEqual(actual, expected)
-		} catch (e: any) {
-			e.stack = ctx.assertionStack
-			throw e
-		}
+		e.stack = ctx.assertionStack
+		throw e
 	}
 }
 

ark/attest/assert/assertions.ts

@@ -39,7 +39,7 @@ export const queueBaselineUpdateIfNeeded = (
 		baselinePath: ctx.qualifiedPath
 	})
 
-	if (ctx.lastSnapFunctionName === "types") writeSnapshotUpdatesOnExit()
+	if (ctx.benchCallPosition) writeSnapshotUpdatesOnExit()
 }
 
 /** Pretty print comparison and set the process.exitCode to 1 if delta threshold is exceeded */
@@ -66,7 +66,14 @@ export const compareToBaseline = (
 const handlePositiveDelta = (formattedDelta: string, ctx: BenchContext) => {
 	const message = `'${ctx.qualifiedName}' exceeded baseline by ${formattedDelta} (threshold is ${ctx.cfg.benchPercentThreshold}%).`
 	console.error(`📈 ${message}`)
-	if (ctx.cfg.benchErrorOnThresholdExceeded) {
+	const benchErrorConfig = ctx.cfg.benchErrorOnThresholdExceeded
+	const isTypeBench = ctx.lastSnapFunctionName === "instantiations"
+	const shouldError =
+		benchErrorConfig === true ||
+		(isTypeBench ?
+			benchErrorConfig === "types"
+		:	benchErrorConfig === "runtime")
+	if (shouldError) {
 		const errorSummary = `❌ ${message}`
 		if (ctx.lastSnapFunctionName === "instantiations")
 			throwAssertionError({ stack: ctx.assertionStack, message: errorSummary })

ark/attest/bench/baseline.ts

@@ -16,6 +16,8 @@ import {
 
 export type TsVersionAliases = autocomplete<"*"> | string[]
 
+export type BenchErrorConfig = "runtime" | "types" | boolean
+
 type BaseAttestConfig = {
 	tsconfig: string | null | undefined
 	compilerOptions: ts.CompilerOptions
@@ -38,7 +40,7 @@ type BaseAttestConfig = {
 	skipInlineInstantiations: boolean
 	attestAliases: string[]
 	benchPercentThreshold: number
-	benchErrorOnThresholdExceeded: boolean
+	benchErrorOnThresholdExceeded: BenchErrorConfig
 	filter: string | undefined
 	testDeclarationAliases: string[]
 	formatCmd: string

ark/attest/config.ts

@@ -1,6 +1,6 @@
 {
 	"name": "@ark/attest",
-	"version": "0.41.2",
+	"version": "0.41.3",
 	"license": "MIT",
 	"author": {
 		"name": "David Blass",

ark/attest/package.json

@@ -52,7 +52,7 @@
 			}
 		},
 		{
-			"name": "this, primitives, built-in types, quotes",
+			"name": "this, primitives, builtin types, quotes",
 			"scope": [
 				"variable.language",
 				"constant",

ark/dark/arkdark.json

@@ -62,7 +62,7 @@
 			}
 		},
 		{
-			"name": "this, primitives, built-in types, quotes",
+			"name": "this, primitives, builtin types, quotes",
 			"scope": [
 				"variable.language",
 				"constant",