Ban Effect escape hatches

Rhys Sullivan committed 6 months ago

Commit 427d4e21 parent 10d34f84 files · +57 −0Browse files

Unified · Split

4 files

@@ -152,6 +152,25 @@ Effect.ignore( · 151 unmodified lines
152	);	152	);
153	```	153	```
154		154
		155	### Effect die / orDie escape hatches
		156
		157	Bad in domain code:
		158
		159	```ts
		160	program.pipe(Effect.orDie)
		161	Effect.die(error)
		162	```
		163
		164	Good:
		165
		166	```ts
		167	program.pipe(
		168	Effect.mapError((cause) => new DomainError({ message: "Operation failed", cause })),
		169	)
		170	```
		171
		172	`Effect.die`, `Effect.dieMessage`, `Effect.orDie`, and `Effect.orDieWith` turn typed failures into defects. Use them only at a true runtime boundary where the host cannot represent typed failures, and keep that usage behind a narrow lint suppression with a `boundary:` reason. Do not use `orDie` to avoid threading an error type through normal Effect code.
		173
155	### try/catch	174	### try/catch
156		175
157	Bad:	176	Bad:

     "executor/no-double-cast": "error",
     "executor/no-cross-package-relative-imports": "error",
     "executor/require-reactivity-keys": "error",
+    "executor/no-effect-escape-hatch": "error",
     "executor/no-effect-internal-tags": "error",
     "executor/no-error-constructor": "error",
     "executor/no-instanceof-error": "error",
         "packages/kernel/runtime-*/src/**/*.{ts,tsx,js,mjs}",
       ],
       "rules": {
+        "executor/no-effect-escape-hatch": "off",
         "executor/no-error-constructor": "off",
         "executor/no-instanceof-error": "off",
         "executor/no-json-parse": "off",
     {
       "files": ["apps/marketing/src/**/*.astro"],
       "rules": {
+        "executor/no-effect-escape-hatch": "off",
         "executor/no-error-constructor": "off",
         "executor/no-instanceof-error": "off",
         "executor/no-json-parse": "off",

 import noConditionalTests from "./oxlint-plugin-executor/rules/no-conditional-tests.js";
 import noCrossPackageRelativeImports from "./oxlint-plugin-executor/rules/no-cross-package-relative-imports.js";
 import noDoubleCast from "./oxlint-plugin-executor/rules/no-double-cast.js";
+import noEffectEscapeHatch from "./oxlint-plugin-executor/rules/no-effect-escape-hatch.js";
 import noEffectInternalTags from "./oxlint-plugin-executor/rules/no-effect-internal-tags.js";
 import noErrorConstructor from "./oxlint-plugin-executor/rules/no-error-constructor.js";
 import noInlineObjectTypeAssertion from "./oxlint-plugin-executor/rules/no-inline-object-type-assertion.js";
     "no-double-cast": noDoubleCast,
     "no-cross-package-relative-imports": noCrossPackageRelativeImports,
     "require-reactivity-keys": requireReactivityKeys,
+    "no-effect-escape-hatch": noEffectEscapeHatch,
     "no-effect-internal-tags": noEffectInternalTags,
     "no-error-constructor": noErrorConstructor,
     "no-ts-nocheck": noTsNocheck,

@@ -0,0 +1,33 @@
	1	import { getPropertyName, isTestLike, unwrapExpression } from "../utils.js";
	2
	3	const escapeHatches = new Set(["die", "dieMessage", "orDie", "orDieWith"]);
	4
	5	const message =
	6	"Do not collapse Effect failures with die/orDie escape hatches. Keep typed errors in the Effect error channel; at true runtime edges use a narrow boundary suppression. Skill: wrdn-effect-typed-errors.";
	7
	8	const isEffectEscapeHatch = (node) => {
	9	const expression = unwrapExpression(node);
	10	if (expression?.type !== "MemberExpression") return false;
	11	const property = getPropertyName(expression.property);
	12	return escapeHatches.has(property);
	13	};
	14
	15	export default {
	16	meta: {
	17	type: "problem",
	18	docs: {
	19	description: "Disallow Effect die/orDie escape hatches outside test code.",
	20	},
	21	},
	22	create(context) {
	23	if (isTestLike(context.filename)) return {};
	24
	25	return {
	26	MemberExpression(node) {
	27	if (isEffectEscapeHatch(node)) {
	28	context.report({ node, message });
	29	}
	30	},
	31	};
	32	},
	33	};