add FailAsProcessed

vladbasin · Jul 2, 2024 · 3c873f1 · 3c873f1
1 parent 98caaa3
commit 3c873f1
Show file tree

Hide file tree

Showing 3 changed files with 52 additions and 10 deletions.
diff --git a/src/Result.ts b/src/Result.ts
@@ -325,7 +325,7 @@ export class Result<T> {
     }
 
     /**
-     * Processes error
+     * Processes error. Ensures that subsequent errors are not overridden
      * @param factory Function which accepts error and transforms into a new one
      * @returns New failed Result object, which contains processed error
      */
@@ -338,7 +338,7 @@ export class Result<T> {
     }
 
     /**
-     * Processes error
+     * Processes error. Ensures that subsequent errors are not overridden
      * @param factory Function which accepts error and transforms into a new one
      * @returns New failed Result object, which contains processed error
      */
@@ -387,7 +387,6 @@ export class Result<T> {
 
     /**
      * Creates Result with optional context
-     * @param context Context to execute actions in
      * @returns New Promise with true value
      */
     static Start(): Result<boolean> {
@@ -397,7 +396,6 @@ export class Result<T> {
     /**
      * Creates Result with value and optional context
      * @param value Value to store in Result
-     * @param context Context to execute actions in
      * @returns New Promise with stored value
      */
     static Ok<T>(value: T): Result<T> {
@@ -424,7 +422,6 @@ export class Result<T> {
     /**
      * Creates Result with failure
      * @param error Error message of the failure
-     * @param context Context to execute actions in
      * @returns New Result object with failure
      */
     static Fail<T>(error: string): Result<T> {
@@ -434,17 +431,33 @@ export class Result<T> {
     /**
      * Creates Result with failure
      * @param error Error of the failure
-     * @param context Context to execute actions in
      * @returns New Result object with failure
      */
     static FailWithError<T>(error: Error): Result<T> {
         return new Result(Promise.reject(error));
     }
 
+    /**
+     * Creates Result with failure. Ensures that processing methods don't override this error
+     * @param error Error of the failure
+     * @returns New Result object with failure
+     */
+    static FailAsProcessed<T>(error: string): Result<T> {
+        return Result.FailAsProcessedWithError(new Error(error));
+    }
+
+    /**
+     * Creates Result with failure. Ensures that processing methods don't override this error
+     * @param error Error of the failure
+     * @returns New Result object with failure
+     */
+    static FailAsProcessedWithError<T>(error: Error): Result<T> {
+        return new Result(Promise.reject(new ProcessedError(error.message, error)));
+    }
+
     /**
      * Creates Result from promise
      * @param promise Promise to track
-     * @param context Context to execute actions in
      * @returns New Result object from Promise
      */
     static FromPromise<T>(promise: Promise<T>): Result<T> {
@@ -482,7 +495,6 @@ export class Result<T> {
      * Creates Result
      * @param isSuccess Indicates whether the Result is failure or success
      * @param error Error in for new Result in case it is failure
-     * @param context Context to execute actions in
      * @returns New Result with true or false value
      */
     static Create(isSuccess: boolean, error: string): Result<boolean> {
@@ -493,7 +505,6 @@ export class Result<T> {
      * Creates Result
      * @param isSuccess Indicates whether the Result is failure or success
      * @param error Error in for new Result in case it is failure
-     * @param context Context to execute actions in
      * @returns New Result with true or false value
      */
     static CreateWithError(isSuccess: boolean, error: Error): Result<boolean> {
@@ -505,7 +516,6 @@ export class Result<T> {
      * @param times Number of attempts
      * @param delay Delay between attempts
      * @param retryResultAction Action to execute and retry
-     * @param context  Context to execute actions in
      * @returns New Result which represents either failure or success
      */
     static Retry<T>(times: number, delay: number, retryResultAction: () => Result<T>): Result<T> {

diff --git a/tests/Result.FailAsProcessed.test.ts b/tests/Result.FailAsProcessed.test.ts
@@ -0,0 +1,16 @@
+import { Result } from '../src/Result';
+import { executeResult } from './executeResult';
+
+describe('.FailAsProcessed()', () => {
+    test('produces fail that is not overridden', done => {
+        executeResult(
+            done,
+            Result.FailAsProcessed('original')
+                .onSuccess(_ => done('No success expected'))
+                .withProcessedFail(() => 'overridden')
+                .onFailure(error => {
+                    expect(error).toBe('original');
+                })
+        );
+    });
+});
diff --git a/tests/Result.FailAsProcessedWithError.test.ts b/tests/Result.FailAsProcessedWithError.test.ts
@@ -0,0 +1,16 @@
+import { Result } from '../src/Result';
+import { executeResult } from './executeResult';
+
+describe('.FailAsProcessedWithError()', () => {
+    test('produces fail that is not overridden', done => {
+        executeResult(
+            done,
+            Result.FailAsProcessedWithError(new Error('original'))
+                .onSuccess(_ => done('No success expected'))
+                .withProcessedFail(() => 'overridden')
+                .onFailure(error => {
+                    expect(error).toBe('original');
+                })
+        );
+    });
+});