effect-errors 1.2.24 → 1.3.0

package/README.md

@@ -137,6 +137,50 @@ Alternatively, you _can_ use a plain object with a `_tag` and `message` attribut
 Effect.fail({ _tag: 'SucksToBeMe', message: 'Yeah...' });
 ```
 
+## ⚡ Capturing errors data
+
+You might want to apply your own logic to reported errors data; for example if you want to display errors in html. You can do so using `captureErrors`. The function has the following signature:
+
+```typescript
+export interface ErrorSpan {
+  name: string;
+  attributes: ReadonlyMap<string, unknown>;
+  status: SpanStatus;
+}
+
+export interface ErrorData {
+  errorType: unknown;
+  message: unknown;
+  stack?: string;
+  spans?: ErrorSpan[];
+  isPlainString?: boolean;
+}
+
+export interface CapturedErrors {
+  interrupted: boolean;
+  errors: ErrorData[];
+}
+
+type captureErrorsFunction: <E>(cause: Cause<E>) => CapturedErrors
+```
+
+You can use `captureErrors` like so:
+
+```typescript
+import { captureErrors } from 'effect-errors';
+
+await Effect.runPromise(
+  pipe(
+    effect,
+    Effect.catchAll((e) => {
+      const data = captureErrors(e);
+
+      // ...
+    }),
+  ),
+);
+```
+
 ## ⚡ examples
 
 I wrote some examples for fun and giggles. You can run them using:

package/capture-errors.d.ts

@@ -0,0 +1,19 @@
+import { Cause } from 'effect/Cause';
+import { SpanStatus } from 'effect/Tracer';
+export interface ErrorSpan {
+    name: string;
+    attributes: ReadonlyMap<string, unknown>;
+    status: SpanStatus;
+}
+export interface ErrorData {
+    errorType: unknown;
+    message: unknown;
+    stack?: string;
+    spans?: ErrorSpan[];
+    isPlainString?: boolean;
+}
+export interface CapturedErrors {
+    interrupted: boolean;
+    errors: ErrorData[];
+}
+export declare const captureErrors: <E>(cause: Cause<E>) => CapturedErrors;

package/capture-errors.js

@@ -0,0 +1,42 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.captureErrors = void 0;
+var effect_1 = require("effect");
+var Cause_1 = require("effect/Cause");
+var capture_errors_from_cause_1 = require("./logic/errors/capture-errors-from-cause");
+var captureErrors = function (cause) {
+    if ((0, Cause_1.isInterruptedOnly)(cause)) {
+        return {
+            interrupted: true,
+            errors: [],
+        };
+    }
+    var errors = (0, capture_errors_from_cause_1.captureErrorsFrom)(cause).map(function (_a) {
+        var message = _a.message, stack = _a.stack, span = _a.span, errorType = _a.errorType, isPlainString = _a.isPlainString;
+        var spans = [];
+        if (span) {
+            var current = span;
+            while (current && current._tag === 'Span') {
+                var name_1 = current.name, attributes = current.attributes, status_1 = current.status;
+                spans.push({
+                    name: name_1,
+                    attributes: attributes,
+                    status: status_1,
+                });
+                current = effect_1.Option.getOrUndefined(current.parent);
+            }
+        }
+        return {
+            errorType: errorType,
+            message: message,
+            stack: stack,
+            spans: spans,
+            isPlainString: isPlainString,
+        };
+    });
+    return {
+        interrupted: false,
+        errors: errors,
+    };
+};
+exports.captureErrors = captureErrors;

package/caputre-errors.test.d.ts

@@ -0,0 +1 @@
+export {};

package/caputre-errors.test.js

@@ -0,0 +1,154 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __generator = (this && this.__generator) || function (thisArg, body) {
+    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
+    return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
+    function verb(n) { return function (v) { return step([n, v]); }; }
+    function step(op) {
+        if (f) throw new TypeError("Generator is already executing.");
+        while (g && (g = 0, op[0] && (_ = 0)), _) try {
+            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
+            if (y = 0, t) op = [op[0] & 2, t.value];
+            switch (op[0]) {
+                case 0: case 1: t = op; break;
+                case 4: _.label++; return { value: op[1], done: false };
+                case 5: _.label++; y = op[1]; op = [0]; continue;
+                case 7: op = _.ops.pop(); _.trys.pop(); continue;
+                default:
+                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
+                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
+                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
+                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
+                    if (t[2]) _.ops.pop();
+                    _.trys.pop(); continue;
+            }
+            op = body.call(thisArg, _);
+        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
+        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
+    }
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+var vitest_1 = require("vitest");
+var capture_errors_1 = require("./capture-errors");
+var from_promise_1 = require("./examples/from-promise");
+var parallel_errors_1 = require("./examples/parallel-errors");
+var console_mock_1 = require("./tests/mocks/console.mock");
+var effect_cause_1 = require("./tests/runners/effect-cause");
+(0, console_mock_1.mockConsole)({
+    info: vitest_1.vi.fn(),
+});
+(0, vitest_1.describe)('captureErrors function', function () {
+    (0, vitest_1.it)('should capture errors from promises', function () { return __awaiter(void 0, void 0, void 0, function () {
+        var cause, result, _a, errorType, isPlainString, message, spans, stack;
+        return __generator(this, function (_b) {
+            switch (_b.label) {
+                case 0: return [4 /*yield*/, (0, effect_cause_1.effectCause)(from_promise_1.fromPromiseTask)];
+                case 1:
+                    cause = _b.sent();
+                    result = (0, capture_errors_1.captureErrors)(cause);
+                    (0, vitest_1.expect)(result.interrupted).toBe(false);
+                    (0, vitest_1.expect)(result.errors).toHaveLength(1);
+                    _a = result.errors[0], errorType = _a.errorType, isPlainString = _a.isPlainString, message = _a.message, spans = _a.spans, stack = _a.stack;
+                    (0, vitest_1.expect)(errorType).toBe('FetchError');
+                    (0, vitest_1.expect)(isPlainString).toBeUndefined();
+                    (0, vitest_1.expect)(message.toString()).toStrictEqual('TypeError: fetch failed');
+                    (0, vitest_1.expect)(spans).toHaveLength(2);
+                    (0, vitest_1.expect)(spans[0].name).toBe('fetchUser');
+                    (0, vitest_1.expect)(spans[0].attributes).toHaveAttributes([
+                        {
+                            key: 'userId',
+                            value: '123',
+                        },
+                    ]);
+                    (0, vitest_1.expect)(spans[1].attributes).toHaveAttributes([]);
+                    (0, vitest_1.expect)(stack).not.toHaveLength(0);
+                    return [2 /*return*/];
+            }
+        });
+    }); });
+    (0, vitest_1.it)('should capture parallel errors', function () { return __awaiter(void 0, void 0, void 0, function () {
+        var cause, result, firstError, secondError, thirdError;
+        return __generator(this, function (_a) {
+            switch (_a.label) {
+                case 0: return [4 /*yield*/, (0, effect_cause_1.effectCause)(parallel_errors_1.withParallelErrorsTask)];
+                case 1:
+                    cause = _a.sent();
+                    result = (0, capture_errors_1.captureErrors)(cause);
+                    (0, vitest_1.expect)(result.interrupted).toBe(false);
+                    (0, vitest_1.expect)(result.errors).toHaveLength(3);
+                    firstError = result.errors[0];
+                    (0, vitest_1.expect)(firstError.errorType).toBe('UserNotFound');
+                    (0, vitest_1.expect)(firstError.isPlainString).toBeUndefined();
+                    (0, vitest_1.expect)(firstError.message).toStrictEqual('Oh no, this user does no exist!');
+                    (0, vitest_1.expect)(firstError.spans).toHaveLength(3);
+                    (0, vitest_1.expect)(firstError.spans[0].name).toBe('readUser');
+                    (0, vitest_1.expect)(firstError.spans[0].attributes).toHaveAttributes([
+                        {
+                            key: 'name',
+                            value: 'yolo',
+                        },
+                    ]);
+                    (0, vitest_1.expect)(firstError.spans[1].name).toBe('parallelGet');
+                    (0, vitest_1.expect)(firstError.spans[1].attributes).toHaveAttributes([
+                        {
+                            key: 'names',
+                            value: ['yolo', 'bro', 'cool'],
+                        },
+                    ]);
+                    (0, vitest_1.expect)(firstError.spans[2].name).toBe('withParallelErrorsTask');
+                    (0, vitest_1.expect)(firstError.spans[2].attributes).toHaveAttributes([]);
+                    secondError = result.errors[1];
+                    (0, vitest_1.expect)(secondError.errorType).toBe('UserNotFound');
+                    (0, vitest_1.expect)(secondError.isPlainString).toBeUndefined();
+                    (0, vitest_1.expect)(secondError.message).toStrictEqual('Oh no, this user does no exist!');
+                    (0, vitest_1.expect)(secondError.spans).toHaveLength(3);
+                    (0, vitest_1.expect)(secondError.spans[0].name).toBe('readUser');
+                    (0, vitest_1.expect)(secondError.spans[0].attributes).toHaveAttributes([
+                        {
+                            key: 'name',
+                            value: 'bro',
+                        },
+                    ]);
+                    (0, vitest_1.expect)(secondError.spans[1].name).toBe('parallelGet');
+                    (0, vitest_1.expect)(secondError.spans[1].attributes).toHaveAttributes([
+                        {
+                            key: 'names',
+                            value: ['yolo', 'bro', 'cool'],
+                        },
+                    ]);
+                    (0, vitest_1.expect)(secondError.spans[2].name).toBe('withParallelErrorsTask');
+                    (0, vitest_1.expect)(secondError.spans[2].attributes).toHaveAttributes([]);
+                    thirdError = result.errors[2];
+                    (0, vitest_1.expect)(thirdError.errorType).toBe('UserNotFound');
+                    (0, vitest_1.expect)(thirdError.isPlainString).toBeUndefined();
+                    (0, vitest_1.expect)(thirdError.message).toStrictEqual('Oh no, this user does no exist!');
+                    (0, vitest_1.expect)(thirdError.spans).toHaveLength(3);
+                    (0, vitest_1.expect)(thirdError.spans[0].name).toBe('readUser');
+                    (0, vitest_1.expect)(thirdError.spans[0].attributes).toHaveAttributes([
+                        {
+                            key: 'name',
+                            value: 'cool',
+                        },
+                    ]);
+                    (0, vitest_1.expect)(thirdError.spans[1].name).toBe('parallelGet');
+                    (0, vitest_1.expect)(thirdError.spans[1].attributes).toHaveAttributes([
+                        {
+                            key: 'names',
+                            value: ['yolo', 'bro', 'cool'],
+                        },
+                    ]);
+                    (0, vitest_1.expect)(thirdError.spans[2].name).toBe('withParallelErrorsTask');
+                    (0, vitest_1.expect)(thirdError.spans[2].attributes).toHaveAttributes([]);
+                    return [2 /*return*/];
+            }
+        });
+    }); });
+});

package/examples/errors/fetch-error.d.ts

@@ -0,0 +1,9 @@
+declare const FetchError_base: new <A extends Record<string, any> = {}>(args: import("effect/Types").Equals<A, {}> extends true ? void : { readonly [P in keyof A as P extends "_tag" ? never : P]: A[P]; }) => import("effect/Cause").YieldableError & {
+    readonly _tag: "FetchError";
+} & Readonly<A>;
+export declare class FetchError extends FetchError_base<{
+    cause?: unknown;
+    message?: string;
+}> {
+}
+export {};

package/examples/errors/fetch-error.js

@@ -0,0 +1,27 @@
+"use strict";
+var __extends = (this && this.__extends) || (function () {
+    var extendStatics = function (d, b) {
+        extendStatics = Object.setPrototypeOf ||
+            ({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||
+            function (d, b) { for (var p in b) if (Object.prototype.hasOwnProperty.call(b, p)) d[p] = b[p]; };
+        return extendStatics(d, b);
+    };
+    return function (d, b) {
+        if (typeof b !== "function" && b !== null)
+            throw new TypeError("Class extends value " + String(b) + " is not a constructor or null");
+        extendStatics(d, b);
+        function __() { this.constructor = d; }
+        d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.FetchError = void 0;
+var Data_1 = require("effect/Data");
+var FetchError = /** @class */ (function (_super) {
+    __extends(FetchError, _super);
+    function FetchError() {
+        return _super !== null && _super.apply(this, arguments) || this;
+    }
+    return FetchError;
+}((0, Data_1.TaggedError)('FetchError')));
+exports.FetchError = FetchError;

package/examples/errors/file-error.d.ts

@@ -0,0 +1,9 @@
+declare const FileError_base: new <A extends Record<string, any> = {}>(args: import("effect/Types").Equals<A, {}> extends true ? void : { readonly [P in keyof A as P extends "_tag" ? never : P]: A[P]; }) => import("effect/Cause").YieldableError & {
+    readonly _tag: "FileError";
+} & Readonly<A>;
+export declare class FileError extends FileError_base<{
+    cause?: unknown;
+    message?: string;
+}> {
+}
+export {};

package/examples/errors/file-error.js

@@ -0,0 +1,27 @@
+"use strict";
+var __extends = (this && this.__extends) || (function () {
+    var extendStatics = function (d, b) {
+        extendStatics = Object.setPrototypeOf ||
+            ({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||
+            function (d, b) { for (var p in b) if (Object.prototype.hasOwnProperty.call(b, p)) d[p] = b[p]; };
+        return extendStatics(d, b);
+    };
+    return function (d, b) {
+        if (typeof b !== "function" && b !== null)
+            throw new TypeError("Class extends value " + String(b) + " is not a constructor or null");
+        extendStatics(d, b);
+        function __() { this.constructor = d; }
+        d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.FileError = void 0;
+var Data_1 = require("effect/Data");
+var FileError = /** @class */ (function (_super) {
+    __extends(FileError, _super);
+    function FileError() {
+        return _super !== null && _super.apply(this, arguments) || this;
+    }
+    return FileError;
+}((0, Data_1.TaggedError)('FileError')));
+exports.FileError = FileError;

package/examples/errors/user-not-found.error.d.ts

@@ -0,0 +1,9 @@
+declare const UserNotFoundError_base: new <A extends Record<string, any> = {}>(args: import("effect/Types").Equals<A, {}> extends true ? void : { readonly [P in keyof A as P extends "_tag" ? never : P]: A[P]; }) => import("effect/Cause").YieldableError & {
+    readonly _tag: "UserNotFound";
+} & Readonly<A>;
+export declare class UserNotFoundError extends UserNotFoundError_base<{
+    cause?: unknown;
+    message?: string;
+}> {
+}
+export {};

package/examples/errors/user-not-found.error.js

@@ -0,0 +1,27 @@
+"use strict";
+var __extends = (this && this.__extends) || (function () {
+    var extendStatics = function (d, b) {
+        extendStatics = Object.setPrototypeOf ||
+            ({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||
+            function (d, b) { for (var p in b) if (Object.prototype.hasOwnProperty.call(b, p)) d[p] = b[p]; };
+        return extendStatics(d, b);
+    };
+    return function (d, b) {
+        if (typeof b !== "function" && b !== null)
+            throw new TypeError("Class extends value " + String(b) + " is not a constructor or null");
+        extendStatics(d, b);
+        function __() { this.constructor = d; }
+        d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.UserNotFoundError = void 0;
+var Data_1 = require("effect/Data");
+var UserNotFoundError = /** @class */ (function (_super) {
+    __extends(UserNotFoundError, _super);
+    function UserNotFoundError() {
+        return _super !== null && _super.apply(this, arguments) || this;
+    }
+    return UserNotFoundError;
+}((0, Data_1.TaggedError)('UserNotFound')));
+exports.UserNotFoundError = UserNotFoundError;

package/examples/from-promise.d.ts

@@ -0,0 +1,5 @@
+import { Effect } from 'effect';
+import { FetchError } from './errors/fetch-error';
+import { FileError } from './errors/file-error';
+export declare const fromPromiseTask: Effect.Effect<any, FetchError | FileError, never>;
+export default fromPromiseTask;

package/examples/from-promise.js

@@ -0,0 +1,89 @@
+"use strict";
+var __generator = (this && this.__generator) || function (thisArg, body) {
+    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
+    return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
+    function verb(n) { return function (v) { return step([n, v]); }; }
+    function step(op) {
+        if (f) throw new TypeError("Generator is already executing.");
+        while (g && (g = 0, op[0] && (_ = 0)), _) try {
+            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
+            if (y = 0, t) op = [op[0] & 2, t.value];
+            switch (op[0]) {
+                case 0: case 1: t = op; break;
+                case 4: _.label++; return { value: op[1], done: false };
+                case 5: _.label++; y = op[1]; op = [0]; continue;
+                case 7: op = _.ops.pop(); _.trys.pop(); continue;
+                default:
+                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
+                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
+                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
+                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
+                    if (t[2]) _.ops.pop();
+                    _.trys.pop(); continue;
+            }
+            op = body.call(thisArg, _);
+        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
+        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
+    }
+};
+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.fromPromiseTask = void 0;
+var effect_1 = require("effect");
+var fs_extra_1 = require("fs-extra");
+var fetch_error_1 = require("./errors/fetch-error");
+var file_error_1 = require("./errors/file-error");
+var filename_effect_1 = require("./util/filename.effect");
+var readUser = effect_1.Effect.withSpan('readUser')(effect_1.Effect.tryPromise({
+    try: function () { return (0, fs_extra_1.readJson)('./src/examples/data/user.json'); },
+    catch: function (e) { return new file_error_1.FileError({ cause: e }); },
+}));
+var fetchTask = function (userId) {
+    return effect_1.Effect.withSpan('fetchUser', {
+        attributes: {
+            userId: userId,
+        },
+    })(effect_1.Effect.tryPromise({
+        try: function () { return fetch("https://yolo-bro-oh-no.org/users/".concat(userId)); },
+        catch: function (e) {
+            return new fetch_error_1.FetchError({
+                cause: e,
+            });
+        },
+    }));
+};
+var unwrapResponseTask = function (response) {
+    return effect_1.Effect.withSpan('unwrapFetchUserResponse')(effect_1.Effect.tryPromise({
+        try: function () { return response.json(); },
+        catch: function (e) { return new fetch_error_1.FetchError({ cause: e }); },
+    }));
+};
+exports.fromPromiseTask = effect_1.Effect.withSpan('fromPromiseTask')(effect_1.Effect.gen(function (_) {
+    var id, response;
+    return __generator(this, function (_a) {
+        switch (_a.label) {
+            case 0: return [5 /*yield**/, __values(_((0, filename_effect_1.filename)(__filename)))];
+            case 1:
+                _a.sent();
+                return [5 /*yield**/, __values(_(readUser))];
+            case 2:
+                id = (_a.sent()).id;
+                return [5 /*yield**/, __values(_(fetchTask(id)))];
+            case 3:
+                response = _a.sent();
+                return [5 /*yield**/, __values(_(unwrapResponseTask(response)))];
+            case 4: return [2 /*return*/, _a.sent()];
+        }
+    });
+}));
+exports.default = exports.fromPromiseTask;

package/examples/parallel-errors.d.ts

@@ -0,0 +1,4 @@
+import { Effect } from 'effect';
+import { UserNotFoundError } from './errors/user-not-found.error';
+export declare const withParallelErrorsTask: Effect.Effect<[void, never[]], UserNotFoundError, never>;
+export default withParallelErrorsTask;

package/examples/parallel-errors.js

@@ -0,0 +1,27 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.withParallelErrorsTask = void 0;
+var effect_1 = require("effect");
+var user_not_found_error_1 = require("./errors/user-not-found.error");
+var filename_effect_1 = require("./util/filename.effect");
+var readUser = function (name) {
+    return effect_1.Effect.withSpan('readUser', {
+        attributes: {
+            name: name,
+        },
+    })(effect_1.Effect.tryPromise({
+        try: function () { return Promise.reject('Oh no, this user does no exist!'); },
+        catch: function (e) { return new user_not_found_error_1.UserNotFoundError({ cause: e }); },
+    }));
+};
+var parallelGet = function (names) {
+    return effect_1.Effect.withSpan('parallelGet', {
+        attributes: {
+            names: names,
+        },
+    })(effect_1.Effect.all(names.map(readUser), {
+        concurrency: 'unbounded',
+    }));
+};
+exports.withParallelErrorsTask = effect_1.Effect.withSpan('withParallelErrorsTask')(effect_1.Effect.all([(0, filename_effect_1.filename)(__filename), parallelGet(['yolo', 'bro', 'cool'])]));
+exports.default = exports.withParallelErrorsTask;

package/examples/util/filename.effect.d.ts

@@ -0,0 +1,2 @@
+import { Effect } from 'effect';
+export declare const filename: (path: string) => Effect.Effect<void, never, never>;

package/examples/util/filename.effect.js

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.filename = void 0;
+var effect_1 = require("effect");
+var cwdRegex = new RegExp(process.cwd(), 'g');
+var filename = function (path) {
+    return effect_1.Effect.sync(function () {
+        console.info("\r\n\uD83D\uDCC1 ".concat(path.replace(cwdRegex, '.')));
+    });
+};
+exports.filename = filename;

package/index.d.ts

@@ -2,3 +2,4 @@ export * from './pretty-print';
 export * from './runners/run-promise';
 export * from './runners/run-sync';
 export * from './types/pretty-print-options.type';
+export * from './capture-errors';

package/index.js

@@ -18,3 +18,4 @@ __exportStar(require("./pretty-print"), exports);
 __exportStar(require("./runners/run-promise"), exports);
 __exportStar(require("./runners/run-sync"), exports);
 __exportStar(require("./types/pretty-print-options.type"), exports);
+__exportStar(require("./capture-errors"), exports);

package/logic/errors/extract-error-details.d.ts

@@ -0,0 +1,7 @@
+interface ErrorDetails {
+    isPlainString?: boolean;
+    type?: unknown;
+    message: unknown;
+}
+export declare const extractErrorDetails: (error: unknown) => ErrorDetails;
+export {};

package/logic/errors/extract-error-details.js

@@ -0,0 +1,70 @@
+"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;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.extractErrorDetails = void 0;
+var Function_1 = require("effect/Function");
+var Predicate_1 = require("effect/Predicate");
+var extractErrorDetails = function (error) {
+    if (typeof error === 'string') {
+        return {
+            isPlainString: true,
+            message: error,
+        };
+    }
+    // TaggedError with cause
+    if (error instanceof Error &&
+        (0, Predicate_1.hasProperty)(error, 'cause') &&
+        (0, Predicate_1.hasProperty)(error, '_tag')) {
+        return {
+            type: error._tag,
+            message: error.cause,
+        };
+    }
+    // TaggedError with error ctor
+    if (error instanceof Error && (0, Predicate_1.hasProperty)(error, 'error')) {
+        return {
+            type: error.name,
+            message: error.error,
+        };
+    }
+    // Plain objects with tag attribute
+    if ((0, Predicate_1.hasProperty)(error, '_tag') && (0, Predicate_1.hasProperty)(error, 'message')) {
+        return {
+            type: error._tag,
+            message: error.message,
+        };
+    }
+    // Plain objects with toString impl
+    if ((0, Predicate_1.hasProperty)(error, 'toString') &&
+        (0, Function_1.isFunction)(error['toString']) &&
+        error['toString'] !== Object.prototype.toString &&
+        error['toString'] !== Array.prototype.toString) {
+        var message = error.toString();
+        var maybeWithUnderlyingType = message.split(': ');
+        if (maybeWithUnderlyingType.length > 1) {
+            var _a = __read(maybeWithUnderlyingType), type = _a[0], message_1 = _a.slice(1);
+            return {
+                type: type,
+                message: message_1,
+            };
+        }
+        return { message: message };
+    }
+    return { message: "Error: ".concat(JSON.stringify(error)) };
+};
+exports.extractErrorDetails = extractErrorDetails;

package/logic/errors/parse-error.js

@@ -3,14 +3,15 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.parseError = 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 extract_error_details_1 = require("./extract-error-details");
 var spanSymbol = Symbol.for('effect/SpanAnnotation');
 var parseError = function (error) {
     var _a;
     var span = ((0, Predicate_1.hasProperty)(error, spanSymbol) && error[spanSymbol]);
+    var _b = (0, extract_error_details_1.extractErrorDetails)(error), message = _b.message, type = _b.type, isPlainString = _b.isPlainString;
     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 /at (.*)/.exec(el); }).join('\r\n'), span);
+        return new pretty_error_type_1.PrettyError(message, (_a = error.stack) === null || _a === void 0 ? void 0 : _a.split('\n').filter(function (el) { return /at (.*)/.exec(el); }).join('\r\n'), span, type);
     }
-    return new pretty_error_type_1.PrettyError((0, pretty_error_message_1.prettyErrorMessage)(error), void 0, span);
+    return new pretty_error_type_1.PrettyError(message, void 0, span, type, isPlainString);
 };
 exports.parseError = parseError;

package/package.json

@@ -2,7 +2,7 @@
   "repository": "https://github.com/jpb06/effect-errors.git",
   "main": "index.js",
   "name": "effect-errors",
-  "version": "1.2.24",
+  "version": "1.3.0",
   "author": "jpb06 <jp.bois.06@outlook.fr>",
   "description": "A POC for errors reporting in Effect",
   "keywords": [],
@@ -27,17 +27,17 @@
     "run-examples": "bun run ./src/examples/util/run-all"
   },
   "dependencies": {
-    "@effect/schema": "^0.64.11",
+    "@effect/schema": "^0.64.19",
     "chalk": "<5",
-    "effect": "^2.4.11"
+    "effect": "^2.4.18"
   },
   "devDependencies": {
     "@stylistic/eslint-plugin": "^1.7.0",
-    "@types/eslint": "^8.56.6",
+    "@types/eslint": "^8.56.7",
     "@types/fs-extra": "^11.0.4",
-    "@types/node": "^20.11.30",
-    "@typescript-eslint/eslint-plugin": "^7.3.1",
-    "@typescript-eslint/parser": "^7.3.1",
+    "@types/node": "^20.12.5",
+    "@typescript-eslint/eslint-plugin": "^7.5.0",
+    "@typescript-eslint/parser": "^7.5.0",
     "@vitest/coverage-v8": "^1.4.0",
     "copyfiles": "^2.4.1",
     "del-cli": "^5.1.0",
@@ -47,11 +47,11 @@
     "eslint-plugin-import": "^2.29.1",
     "eslint-plugin-markdown": "^4.0.1",
     "eslint-plugin-prettier": "^5.1.3",
-    "eslint-plugin-vitest": "^0.3.26",
+    "eslint-plugin-vitest": "^0.4.1",
     "fs-extra": "^11.2.0",
     "prettier": "^3.2.5",
     "readme-package-icons": "^1.1.14",
-    "typescript": "^5.4.3",
+    "typescript": "^5.4.4",
     "vitest": "^1.4.0",
     "vitest-mock-extended": "^1.3.1"
   }

package/pretty-print.js

@@ -23,7 +23,17 @@ var prettyPrint = function (cause, _a) {
     console.error("\r\n\uD83E\uDEE0  ".concat(chalk_1.default.bold.yellowBright.underline("".concat(failures.length, " error").concat(failures.length > 1 ? 's' : '', " occurred\r\n"))));
     return failures
         .map(function (_a, failuresIndex) {
-        var message = _a.message, stack = _a.stack, span = _a.span;
+        var errorType = _a.errorType, errorMessage = _a.message, stack = _a.stack, span = _a.span, isPlainString = _a.isPlainString;
+        var message = '💥 ' +
+            (failures.length > 1
+                ? chalk_1.default.bgRed.whiteBright(" #".concat(failuresIndex + 1, " -"))
+                : '') +
+            chalk_1.default.bgRed.whiteBright(" ".concat(errorType !== null && errorType !== void 0 ? errorType : 'Unknown error', " ")) +
+            chalk_1.default.bold.whiteBright(" \u2022 ".concat(errorMessage)) +
+            '\r\n';
+        if (isPlainString === true) {
+            message += "\r\n".concat(chalk_1.default.gray('ℹ️  You used a plain string to represent a failure in the error channel (E). You should consider using tagged objects (with a _tag field), or yieldable errors such as Data.TaggedError and Schema.TaggedError for better handling experience.'));
+        }
         if (span) {
             var current = span;
             var spans_1 = [];
@@ -31,32 +41,32 @@ var prettyPrint = function (cause, _a) {
                 spans_1.push(current);
                 current = effect_1.Option.getOrUndefined(current.parent);
             }
-            message =
-                '💥 ' +
-                    (failures.length > 1
-                        ? chalk_1.default.bgRed.whiteBright(" #".concat(failuresIndex + 1, " -"))
-                        : '') +
-                    message +
-                    spans_1
-                        .toReversed()
-                        .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(stripCwd ? (0, strip_cwd_path_1.stripCwdPath)(name) : name);
-                        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('');
+            message += spans_1
+                .toReversed()
+                .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(stripCwd ? (0, strip_cwd_path_1.stripCwdPath)(name) : name);
+                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('');
+        }
+        else if (!isPlainString) {
+            message += "\r\n".concat(chalk_1.default.gray('ℹ️  Consider using spans to improve errors reporting.\r\n'));
         }
         if (stack) {
             message += "\r\n".concat(span ? '\r\n' : '', "\uD83D\uDEA8 Stacktrace\r\n").concat(chalk_1.default.red((0, filter_stack_1.filterStack)(stack, stripCwd === true)));
         }
+        else if (!isPlainString) {
+            message += "\r\n\r\n".concat(chalk_1.default.gray('ℹ️  Consider using a yieldable error such as Data.TaggedError and Schema.TaggedError to get a stacktrace.'));
+        }
         return message + '\r\n';
     })
         .join('\r\n');

package/tests/mocks/console.mock.d.ts

@@ -0,0 +1,9 @@
+import { Mock } from 'vitest';
+interface ConsoleMockingArgs {
+    error?: Mock;
+    info?: Mock;
+    log?: Mock;
+    warn?: Mock;
+}
+export declare const mockConsole: (args: ConsoleMockingArgs) => Promise<void>;
+export {};

package/tests/mocks/console.mock.js

@@ -0,0 +1,66 @@
+"use strict";
+var __assign = (this && this.__assign) || function () {
+    __assign = Object.assign || function(t) {
+        for (var s, i = 1, n = arguments.length; i < n; i++) {
+            s = arguments[i];
+            for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
+                t[p] = s[p];
+        }
+        return t;
+    };
+    return __assign.apply(this, arguments);
+};
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __generator = (this && this.__generator) || function (thisArg, body) {
+    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
+    return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
+    function verb(n) { return function (v) { return step([n, v]); }; }
+    function step(op) {
+        if (f) throw new TypeError("Generator is already executing.");
+        while (g && (g = 0, op[0] && (_ = 0)), _) try {
+            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
+            if (y = 0, t) op = [op[0] & 2, t.value];
+            switch (op[0]) {
+                case 0: case 1: t = op; break;
+                case 4: _.label++; return { value: op[1], done: false };
+                case 5: _.label++; y = op[1]; op = [0]; continue;
+                case 7: op = _.ops.pop(); _.trys.pop(); continue;
+                default:
+                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
+                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
+                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
+                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
+                    if (t[2]) _.ops.pop();
+                    _.trys.pop(); continue;
+            }
+            op = body.call(thisArg, _);
+        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
+        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
+    }
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.mockConsole = void 0;
+var vitest_1 = require("vitest");
+var mockConsole = function (args) { return __awaiter(void 0, void 0, void 0, function () {
+    var _a, _b;
+    return __generator(this, function (_c) {
+        switch (_c.label) {
+            case 0:
+                _a = global;
+                _b = [{}];
+                return [4 /*yield*/, vitest_1.vi.importActual('node:console')];
+            case 1:
+                _a.console = __assign.apply(void 0, [__assign.apply(void 0, _b.concat([(_c.sent())])), args]);
+                return [2 /*return*/];
+        }
+    });
+}); };
+exports.mockConsole = mockConsole;

package/tests/runners/effect-cause.d.ts

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

package/tests/runners/effect-cause.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.effectCause = void 0;
+var effect_1 = require("effect");
+var effectCause = function (effect) {
+    return effect_1.Effect.runPromise((0, effect_1.pipe)(effect, effect_1.Effect.catchAllCause(function (e) { return effect_1.Effect.fail(e); }), effect_1.Effect.flip));
+};
+exports.effectCause = effectCause;

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

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

package/types/pretty-error.type.js

@@ -2,21 +2,13 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.PrettyError = void 0;
 var PrettyError = /** @class */ (function () {
-    function PrettyError(message, stack, span) {
+    function PrettyError(message, stack, span, errorType, isPlainString) {
         this.message = message;
         this.stack = stack;
         this.span = span;
+        this.errorType = errorType;
+        this.isPlainString = isPlainString;
     }
-    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;

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

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

package/logic/errors/pretty-error-message.js

@@ -1,59 +0,0 @@
-"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.prettyErrorMessage = void 0;
-var chalk_1 = __importDefault(require("chalk"));
-var Function_1 = require("effect/Function");
-var Predicate_1 = require("effect/Predicate");
-var redBackground = function (text) { return chalk_1.default.bgRed(" ".concat(text, " ")); };
-var whiteBright = function (text) { return chalk_1.default.bold.whiteBright("\u2022 ".concat(text)); };
-var prettyErrorMessage = function (u) {
-    if (typeof u === 'string') {
-        return "".concat(u, "\r\n\r\n\u2139\uFE0F  ").concat(chalk_1.default.gray('You used a plain string to represent a failure in the error channel (E). You should consider using tagged objects (with a _tag field), or yieldable errors such as Data.TaggedError and Schema.TaggedError for better handling experience.'));
-    }
-    // TaggedError with cause
-    if (u instanceof Error && (0, Predicate_1.hasProperty)(u, 'cause') && (0, Predicate_1.hasProperty)(u, '_tag')) {
-        return "".concat(redBackground(u._tag), " ").concat(whiteBright(u.cause), "\r\n");
-    }
-    // TaggedError with error ctor
-    if (u instanceof Error && (0, Predicate_1.hasProperty)(u, 'error')) {
-        return "".concat(redBackground(u.name), " ").concat(whiteBright(u.error), "\r\n");
-    }
-    // Plain objects with tag attribute
-    if ((0, Predicate_1.hasProperty)(u, '_tag') && (0, Predicate_1.hasProperty)(u, 'message')) {
-        return "".concat(redBackground(u._tag), " ").concat(whiteBright(u.message), "\r\n");
-    }
-    // Plain objects with toString impl
-    if ((0, Predicate_1.hasProperty)(u, 'toString') &&
-        (0, Function_1.isFunction)(u['toString']) &&
-        u['toString'] !== Object.prototype.toString &&
-        u['toString'] !== Array.prototype.toString) {
-        var message = u['toString']();
-        var maybeWithUnderlyingType = message.split(': ');
-        if (maybeWithUnderlyingType.length > 1) {
-            var _a = __read(maybeWithUnderlyingType), type = _a[0], message_1 = _a.slice(1);
-            return "".concat(redBackground(type), " ").concat(whiteBright(message_1));
-        }
-        return "".concat(message);
-    }
-    return "Error: ".concat(JSON.stringify(u));
-};
-exports.prettyErrorMessage = prettyErrorMessage;