effect-errors 1.0.3

package/README.md

@@ -0,0 +1,53 @@
+# effect-errors
+
+<!-- readme-package-icons start -->
+
+<p align="left"><a href="https://docs.github.com/en/actions" target="_blank"><img height="50" src="https://raw.githubusercontent.com/jpb06/jpb06/master/icons/GithubActions-Dark.svg" /></a>&nbsp;<a href="https://www.typescriptlang.org/docs/" target="_blank"><img height="50" src="https://raw.githubusercontent.com/jpb06/jpb06/master/icons/TypeScript.svg" /></a>&nbsp;<a href="https://nodejs.org/en/docs/" target="_blank"><img height="50" src="https://raw.githubusercontent.com/jpb06/jpb06/master/icons/NodeJS-Dark.svg" /></a>&nbsp;<a href="https://bun.sh/docs" target="_blank"><img height="50" src="https://raw.githubusercontent.com/jpb06/jpb06/master/icons/Bun-Dark.svg" /></a>&nbsp;<a href="https://github.com/motdotla/dotenv#readme" target="_blank"><img height="50" src="https://raw.githubusercontent.com/jpb06/jpb06/master/icons/Dotenv-Dark.svg" /></a>&nbsp;<a href="https://eslint.org/docs/latest/" target="_blank"><img height="50" src="https://raw.githubusercontent.com/jpb06/jpb06/master/icons/Eslint-Dark.svg" /></a>&nbsp;<a href="https://prettier.io/docs/en/index.html" target="_blank"><img height="50" src="https://raw.githubusercontent.com/jpb06/jpb06/master/icons/Prettier-Dark.svg" /></a>&nbsp;<a href="https://www.effect.website/docs/quickstart" target="_blank"><img height="50" src="https://raw.githubusercontent.com/jpb06/jpb06/master/icons/Effect-Dark.svg" /></a></p>
+
+<!-- readme-package-icons end -->
+
+Some sort of POC to improve the way [Effect](https://effect.website/) reports errors in a dev env 🤔
+
+![example](./docs/parallel-errors-example.png)
+
+## ⚡ So how does it work?
+
+Had to re-export `runSync` and `runPromise` to apply `prettyPrint` function on the cause returned by a `catchAll`.
+
+So using it would look like this :
+
+```typescript
+import { runPromise } from 'effect-errors';
+
+(async () => {
+  await runPromise(
+    Effect.gen(function* (_) {
+      // ...
+    }),
+  );
+})();
+```
+
+The fancy logging behavior is enabled if your node env is `development` or if you set `EFFECT_PRETTY_PRINT` env var to `true`.
+
+You can also directly import the `prettyPrint` function to do whatever you want with it if you want 🤷:
+
+```typescript
+import { prettyPrint } from 'effect-errors';
+
+// ...
+```
+
+Signature is the following:
+
+```typescript
+const prettyPrint: <E>(cause: Cause<E>) => string;
+```
+
+## ⚡ examples
+
+I wrote some examples for fun and giggles. You can run them using:
+
+```bash
+bun run-examples
+```

package/config/pretty-print-enabled.d.ts

@@ -0,0 +1 @@
+export declare const prettyPrintEnabled: boolean;

package/config/pretty-print-enabled.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.prettyPrintEnabled = void 0;
+var dotenv_flow_1 = require("dotenv-flow");
+(0, dotenv_flow_1.config)();
+exports.prettyPrintEnabled = process.env.NODE_ENV === 'development' ||
+    process.env.EFFECT_PRETTY_PRINT === 'true';

package/index.d.ts

@@ -0,0 +1,3 @@
+export * from './pretty-print';
+export * from './runners/run-promise';
+export * from './runners/run-sync';

package/index.js

@@ -0,0 +1,19 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./pretty-print"), exports);
+__exportStar(require("./runners/run-promise"), exports);
+__exportStar(require("./runners/run-sync"), exports);

package/logic/default-render-error.d.ts

@@ -0,0 +1,2 @@
+import { PrettyError } from '../types/pretty-error.type';
+export declare const defaultRenderError: (error: unknown) => PrettyError;

package/logic/default-render-error.js

@@ -0,0 +1,16 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.defaultRenderError = void 0;
+var Predicate_1 = require("effect/Predicate");
+var pretty_error_type_1 = require("../types/pretty-error.type");
+var pretty_error_message_1 = require("./pretty-error-message");
+var spanSymbol = Symbol.for('effect/SpanAnnotation');
+var defaultRenderError = function (error) {
+    var _a;
+    var span = ((0, Predicate_1.hasProperty)(error, spanSymbol) && error[spanSymbol]);
+    if (error instanceof Error) {
+        return new pretty_error_type_1.PrettyError((0, pretty_error_message_1.prettyErrorMessage)(error), (_a = error.stack) === null || _a === void 0 ? void 0 : _a.split('\n').filter(function (el) { return el.match(/at (.*)/); }).join('\n'), span);
+    }
+    return new pretty_error_type_1.PrettyError((0, pretty_error_message_1.prettyErrorMessage)(error), void 0, span);
+};
+exports.defaultRenderError = defaultRenderError;

package/logic/filter-stack.d.ts

@@ -0,0 +1 @@
+export declare const filterStack: (stack: string) => string;

package/logic/filter-stack.js

@@ -0,0 +1,37 @@
+"use strict";
+var __values = (this && this.__values) || function(o) {
+    var s = typeof Symbol === "function" && Symbol.iterator, m = s && o[s], i = 0;
+    if (m) return m.call(o);
+    if (o && typeof o.length === "number") return {
+        next: function () {
+            if (o && i >= o.length) o = void 0;
+            return { value: o && o[i++], done: !o };
+        }
+    };
+    throw new TypeError(s ? "Object is not iterable." : "Symbol.iterator is not defined.");
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.filterStack = void 0;
+var filterStack = function (stack) {
+    var e_1, _a;
+    var lines = stack.split('\n');
+    var out = [];
+    try {
+        for (var lines_1 = __values(lines), lines_1_1 = lines_1.next(); !lines_1_1.done; lines_1_1 = lines_1.next()) {
+            var line = lines_1_1.value;
+            out.push(line.replace(/at .*effect_cutpoint.*\((.*)\)/, 'at $1'));
+            if (line.includes('effect_cutpoint')) {
+                return out.join('\n');
+            }
+        }
+    }
+    catch (e_1_1) { e_1 = { error: e_1_1 }; }
+    finally {
+        try {
+            if (lines_1_1 && !lines_1_1.done && (_a = lines_1.return)) _a.call(lines_1);
+        }
+        finally { if (e_1) throw e_1.error; }
+    }
+    return out.join('\n');
+};
+exports.filterStack = filterStack;

package/logic/get-span-attributes.d.ts

@@ -0,0 +1 @@
+export declare const getSpanAttributes: (attributes: ReadonlyMap<string, unknown>, isLastEntry: boolean) => string;

package/logic/get-span-attributes.js

@@ -0,0 +1,35 @@
+"use strict";
+var __read = (this && this.__read) || function (o, n) {
+    var m = typeof Symbol === "function" && o[Symbol.iterator];
+    if (!m) return o;
+    var i = m.call(o), r, ar = [], e;
+    try {
+        while ((n === void 0 || n-- > 0) && !(r = i.next()).done) ar.push(r.value);
+    }
+    catch (error) { e = { error: error }; }
+    finally {
+        try {
+            if (r && !r.done && (m = i["return"])) m.call(i);
+        }
+        finally { if (e) throw e.error; }
+    }
+    return ar;
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getSpanAttributes = void 0;
+var chalk_1 = __importDefault(require("chalk"));
+var getSpanAttributes = function (attributes, isLastEntry) {
+    if (attributes.size === 0) {
+        return '';
+    }
+    return "".concat("\r\n".concat(Array.from(attributes.entries())
+        .map(function (_a) {
+        var _b = __read(_a, 2), key = _b[0], value = _b[1];
+        return "".concat(isLastEntry ? ' ' : chalk_1.default.gray('│'), "     ").concat(chalk_1.default.blue(key)).concat(chalk_1.default.gray(':'), " ").concat(value);
+    })
+        .join('\r\n')));
+};
+exports.getSpanAttributes = getSpanAttributes;

package/logic/get-span-duration.d.ts

@@ -0,0 +1,2 @@
+import { SpanStatus } from 'effect/Tracer';
+export declare const getSpanDuration: (status: SpanStatus, isLastEntry: boolean) => string;

package/logic/get-span-duration.js

@@ -0,0 +1,14 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getSpanDuration = void 0;
+var chalk_1 = __importDefault(require("chalk"));
+var getSpanDuration = function (status, isLastEntry) {
+    if (status._tag !== 'Ended') {
+        return '';
+    }
+    return "\r\n".concat(isLastEntry ? ' ' : chalk_1.default.gray('│'), "     ~ ").concat((status.endTime - status.startTime) / BigInt(100000), "ms");
+};
+exports.getSpanDuration = getSpanDuration;

package/logic/pretty-error-message.d.ts

@@ -0,0 +1 @@
+export declare const prettyErrorMessage: (u: unknown) => string;

package/logic/pretty-error-message.js

@@ -0,0 +1,31 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.prettyErrorMessage = void 0;
+var chalk_1 = __importDefault(require("chalk"));
+var Function_1 = require("effect/Function");
+var Predicate_1 = require("effect/Predicate");
+var cwdRegex = new RegExp("".concat(process.cwd()), 'g');
+var prettyErrorMessage = function (u) {
+    if (typeof u === 'string') {
+        return "Error: ".concat(u);
+    }
+    if ((0, Predicate_1.hasProperty)(u, 'toString') &&
+        (0, Function_1.isFunction)(u['toString']) &&
+        u['toString'] !== Object.prototype.toString &&
+        u['toString'] !== Array.prototype.toString) {
+        return u['toString']();
+    }
+    if ((0, Predicate_1.hasProperty)(u, '_tag') && (0, Predicate_1.hasProperty)(u, 'message')) {
+        var message = u.message
+            ? chalk_1.default
+                .hex('#c25c30')(u.message)
+                .replace(cwdRegex, '.')
+            : undefined;
+        return "\uD83D\uDCA5 ".concat(chalk_1.default.bgRed(" ".concat(u._tag, " ")), " ").concat(message ? "\u2022 ".concat(message) : '', "\r\n");
+    }
+    return "Error: ".concat(JSON.stringify(u));
+};
+exports.prettyErrorMessage = prettyErrorMessage;

package/logic/pretty-errors.d.ts

@@ -0,0 +1,3 @@
+import { Cause } from 'effect/Cause';
+import { PrettyError } from '../types/pretty-error.type';
+export declare const prettyErrors: <E>(cause: Cause<E>) => readonly PrettyError[];

package/logic/pretty-errors.js

@@ -0,0 +1,41 @@
+"use strict";
+var __read = (this && this.__read) || function (o, n) {
+    var m = typeof Symbol === "function" && o[Symbol.iterator];
+    if (!m) return o;
+    var i = m.call(o), r, ar = [], e;
+    try {
+        while ((n === void 0 || n-- > 0) && !(r = i.next()).done) ar.push(r.value);
+    }
+    catch (error) { e = { error: error }; }
+    finally {
+        try {
+            if (r && !r.done && (m = i["return"])) m.call(i);
+        }
+        finally { if (e) throw e.error; }
+    }
+    return ar;
+};
+var __spreadArray = (this && this.__spreadArray) || function (to, from, pack) {
+    if (pack || arguments.length === 2) for (var i = 0, l = from.length, ar; i < l; i++) {
+        if (ar || !(i in from)) {
+            if (!ar) ar = Array.prototype.slice.call(from, 0, i);
+            ar[i] = from[i];
+        }
+    }
+    return to.concat(ar || Array.prototype.slice.call(from));
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.prettyErrors = void 0;
+var Cause_1 = require("effect/Cause");
+var default_render_error_1 = require("./default-render-error");
+var prettyErrors = function (cause) {
+    return (0, Cause_1.reduceWithContext)(cause, void 0, {
+        emptyCase: function () { return []; },
+        dieCase: function (_, unknownError) { return [(0, default_render_error_1.defaultRenderError)(unknownError)]; },
+        failCase: function (_, error) { return [(0, default_render_error_1.defaultRenderError)(error)]; },
+        interruptCase: function () { return []; },
+        parallelCase: function (_, l, r) { return __spreadArray(__spreadArray([], __read(l), false), __read(r), false); },
+        sequentialCase: function (_, l, r) { return __spreadArray(__spreadArray([], __read(l), false), __read(r), false); },
+    });
+};
+exports.prettyErrors = prettyErrors;

package/logic/spans-stack-trailing-char.d.ts

@@ -0,0 +1 @@
+export declare const spanStackTrailingChar: (isLastEntry: boolean) => string;

package/logic/spans-stack-trailing-char.js

@@ -0,0 +1,11 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.spanStackTrailingChar = void 0;
+var chalk_1 = __importDefault(require("chalk"));
+var spanStackTrailingChar = function (isLastEntry) {
+    return isLastEntry ? chalk_1.default.gray('╰') : chalk_1.default.gray('├');
+};
+exports.spanStackTrailingChar = spanStackTrailingChar;

package/package.json

@@ -0,0 +1,49 @@
+{
+  "repository": "https://github.com/jpb06/effect-errors.git",
+  "main": "dist/index.js",
+  "name": "effect-errors",
+  "version": "1.0.3",
+  "author": "jpb06 <jp.bois.06@outlook.fr>",
+  "description": "Getting user stats from github",
+  "keywords": [],
+  "license": "MIT",
+  "engines": {
+    "node": "20.x"
+  },
+  "scripts": {
+    "update-deps": "bunx npm-check-updates --root --format group -i",
+    "copy-package": "copyfiles package.json ./dist/",
+    "copy-readme": "copyfiles README.md ./dist/",
+    "build": "del-cli ./dist && tsc --project tsconfig-prod.json",
+    "postbuild": "bun run copy-package && bun run copy-readme",
+    "lint": "eslint ./src",
+    "type-check": "tsc --noEmit",
+    "sync-icons": "bun generateReadmeIcons -h 50",
+    "run-examples": "for i in ./src/examples/*.ts; do bun run $i; done"
+  },
+  "dependencies": {
+    "chalk": "^5.3.0",
+    "dotenv-flow": "^4.1.0",
+    "effect": "^2.4.1"
+  },
+  "devDependencies": {
+    "@stylistic/eslint-plugin": "^1.6.3",
+    "@types/eslint": "^8.56.5",
+    "@types/fs-extra": "^11.0.4",
+    "@types/node": "^20.11.24",
+    "@typescript-eslint/eslint-plugin": "^7.1.1",
+    "@typescript-eslint/parser": "^7.1.1",
+    "copyfiles": "^2.4.1",
+    "del-cli": "^5.1.0",
+    "eslint": "^8.57.0",
+    "eslint-config-prettier": "^9.1.0",
+    "eslint-import-resolver-typescript": "^3.6.1",
+    "eslint-plugin-import": "^2.29.1",
+    "eslint-plugin-markdown": "^3.0.1",
+    "eslint-plugin-prettier": "^5.1.3",
+    "fs-extra": "^11.2.0",
+    "prettier": "^3.2.5",
+    "readme-package-icons": "^1.1.14",
+    "typescript": "^5.0.0"
+  }
+}

package/pretty-print.d.ts

@@ -0,0 +1,2 @@
+import { Cause } from 'effect/Cause';
+export declare const prettyPrint: <E>(cause: Cause<E>) => string;

package/pretty-print.js

@@ -0,0 +1,54 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.prettyPrint = void 0;
+var chalk_1 = __importDefault(require("chalk"));
+var effect_1 = require("effect");
+var Cause_1 = require("effect/Cause");
+var filter_stack_1 = require("./logic/filter-stack");
+var get_span_attributes_1 = require("./logic/get-span-attributes");
+var get_span_duration_1 = require("./logic/get-span-duration");
+var pretty_errors_1 = require("./logic/pretty-errors");
+var spans_stack_trailing_char_1 = require("./logic/spans-stack-trailing-char");
+var prettyPrint = function (cause) {
+    if ((0, Cause_1.isInterruptedOnly)(cause)) {
+        return 'All fibers interrupted without errors.';
+    }
+    var failures = (0, pretty_errors_1.prettyErrors)(cause);
+    console.error("\r\n\uD83E\uDEE0  ".concat(chalk_1.default.bold.yellowBright.underline("".concat(failures.length, " error").concat(failures.length > 1 ? 's' : '', " occurred\n"))));
+    return failures
+        .map(function (_a) {
+        var message = _a.message, stack = _a.stack, span = _a.span;
+        if (stack) {
+            message += "\r\n".concat((0, filter_stack_1.filterStack)(stack));
+        }
+        if (span) {
+            var current = span;
+            var spans_1 = [];
+            while (current && current._tag === 'Span') {
+                spans_1.push(current);
+                current = effect_1.Option.getOrUndefined(current.parent);
+            }
+            message += spans_1
+                .map(function (_a, index) {
+                var name = _a.name, attributes = _a.attributes, status = _a.status;
+                var isFirstEntry = index === 0;
+                var isLastEntry = index === spans_1.length - 1;
+                var filePath = " at ".concat(name.replace(new RegExp(process.cwd()), '.'));
+                return chalk_1.default.whiteBright((isFirstEntry ? "\r\n".concat(chalk_1.default.gray('◯')) : '') +
+                    '\r\n' +
+                    (0, spans_stack_trailing_char_1.spanStackTrailingChar)(isLastEntry) +
+                    chalk_1.default.gray('─') +
+                    filePath +
+                    (0, get_span_duration_1.getSpanDuration)(status, isLastEntry) +
+                    (0, get_span_attributes_1.getSpanAttributes)(attributes, isLastEntry));
+            })
+                .join('');
+        }
+        return message + '\r\n';
+    })
+        .join('\r\n');
+};
+exports.prettyPrint = prettyPrint;

package/runners/run-promise.d.ts

@@ -0,0 +1,2 @@
+import { Effect } from 'effect';
+export declare const runPromise: <A, E>(effect: Effect.Effect<A, E, never>) => Promise<A>;

package/runners/run-promise.js

@@ -0,0 +1,16 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.runPromise = void 0;
+var effect_1 = require("effect");
+var __1 = require("..");
+var pretty_print_enabled_1 = require("../config/pretty-print-enabled");
+var runPromise = function (effect) {
+    return effect_1.Effect.runPromise((0, effect_1.pipe)(effect, effect_1.Effect.sandbox, effect_1.Effect.catchAll(function (e) {
+        if (pretty_print_enabled_1.prettyPrintEnabled) {
+            console.error((0, __1.prettyPrint)(e));
+            return effect_1.Effect.fail('❌ runPromise failure');
+        }
+        return effect_1.Effect.fail(e);
+    })));
+};
+exports.runPromise = runPromise;

package/runners/run-sync.d.ts

@@ -0,0 +1,2 @@
+import { Effect } from 'effect';
+export declare const runSync: <A, E>(effect: Effect.Effect<A, E, never>) => A;

package/runners/run-sync.js

@@ -0,0 +1,16 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.runSync = void 0;
+var effect_1 = require("effect");
+var __1 = require("..");
+var pretty_print_enabled_1 = require("../config/pretty-print-enabled");
+var runSync = function (effect) {
+    return effect_1.Effect.runSync((0, effect_1.pipe)(effect, effect_1.Effect.sandbox, effect_1.Effect.catchAll(function (e) {
+        if (pretty_print_enabled_1.prettyPrintEnabled) {
+            console.error((0, __1.prettyPrint)(e));
+            return effect_1.Effect.fail('❌ runSync failure');
+        }
+        return effect_1.Effect.fail(e);
+    })));
+};
+exports.runSync = runSync;

package/types/pretty-error.type.d.ts

@@ -0,0 +1,14 @@
+import { Span } from 'effect/Tracer';
+interface Error {
+    message: string;
+    stack?: string;
+    span?: Span;
+}
+export declare class PrettyError {
+    readonly message: string;
+    readonly stack: string | undefined;
+    readonly span: Span | undefined;
+    constructor(message: string, stack: string | undefined, span: Span | undefined);
+    toJSON(): Error;
+}
+export {};

package/types/pretty-error.type.js

@@ -0,0 +1,22 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PrettyError = void 0;
+var PrettyError = /** @class */ (function () {
+    function PrettyError(message, stack, span) {
+        this.message = message;
+        this.stack = stack;
+        this.span = span;
+    }
+    PrettyError.prototype.toJSON = function () {
+        var out = { message: this.message };
+        if (this.stack) {
+            out.stack = this.stack;
+        }
+        if (this.span) {
+            out.span = this.span;
+        }
+        return out;
+    };
+    return PrettyError;
+}());
+exports.PrettyError = PrettyError;