Improvement around type assersion and the error message

yasaichi-sandbox · Mar 21, 2024 · 414acc8 · 414acc8
1 parent dc62c40
commit 414acc8
Show file tree

Hide file tree

Showing 5 changed files with 51 additions and 39 deletions.
diff --git a/libs/nestjs-kiota/src/NestRequestAdapter.test.ts b/libs/nestjs-kiota/src/NestRequestAdapter.test.ts
@@ -26,7 +26,7 @@ describe(NestRequestAdapter.name, () => {
     bar: 'bar',
   };
   const baseUrl = 'https://example.com';
-  const defaultApiError = new DefaultApiError();
+  const defaultApiError = new DefaultApiError('unexpected error type');
   defaultApiError.responseStatusCode = 401;
   const primitiveResponseModel = 42;
   const responseModel = { foo: 'foo' };
@@ -130,7 +130,7 @@ describe(NestRequestAdapter.name, () => {
               error.getStatus(),
               defaultApiError.responseStatusCode,
             );
-            assert.deepEqual(error.getResponse(), {});
+            assert.deepEqual(error.getResponse(), defaultApiError.message);
 
             return true;
           },
@@ -223,7 +223,7 @@ describe(NestRequestAdapter.name, () => {
               error.getStatus(),
               defaultApiError.responseStatusCode,
             );
-            assert.deepEqual(error.getResponse(), {});
+            assert.deepEqual(error.getResponse(), defaultApiError.message);
 
             return true;
           },

diff --git a/libs/nestjs-kiota/src/NestRequestAdapter.ts b/libs/nestjs-kiota/src/NestRequestAdapter.ts
@@ -12,12 +12,16 @@ import {
   type RequestInformation,
 } from '@microsoft/kiota-abstractions';
 import { HttpException } from '@nestjs/common';
-import { identity, Match } from 'effect';
+import { Data, identity, Match, Predicate } from 'effect';
+import type { SetNonNullable } from 'type-fest';
 
+// NOTE: Deserialized and thrown error actually has only `additionalData`, `responseHeaders`,
+// `responseStatusCode`, and the response body. For further details, see the following lines:
+// https://github.com/microsoft/kiota-typescript/blob/5ce4f291d27a8142a6df0716a38e06a765fb6563/packages/http/fetch/src/fetchRequestAdapter.ts#L343-L357
 export type DeserializedApiError =
-  & Pick<ApiError, 'responseHeaders' | 'responseStatusCode'>
   & AdditionalDataHolder
-  & { [key: string]: unknown };
+  & SetNonNullable<Pick<ApiError, 'responseHeaders' | 'responseStatusCode'>>
+  & Record<string, unknown>;
 
 export class NestRequestAdapter implements RequestAdapter {
   constructor(private readonly requestAdapter: RequestAdapter) {}
@@ -125,42 +129,41 @@ export class NestRequestAdapter implements RequestAdapter {
     } catch (error) {
       throw Match.value(error).pipe(
         Match.when(
-          Match.instanceOf(DefaultApiError),
-          (
-            {
-              name: _name,
-              message: _message,
-              stack: _stack,
-              cause: _cause,
-              ...apiError
-            },
-          ) => this.convertToNestHttpException(apiError),
-        ),
-        Match.when(
-          {
-            responseStatusCode: Match.number,
-            responseHeaders: Match.any,
-          },
-          (apiError) =>
-            this.convertToNestHttpException({
-              ...apiError,
-              // NOTE: The following line is only for passing the type check
-              responseHeaders: undefined,
-            }),
+          this.isApiError,
+          (apiError) => this.convertToNestHttpException(apiError),
         ),
         Match.orElse(identity),
       );
     }
   }
 
   private convertToNestHttpException(apiError: DeserializedApiError) {
-    const {
-      additionalData: _additionalData,
-      responseHeaders: _responseHeaders,
-      responseStatusCode = 500,
-      ...body
-    } = apiError;
-
-    return new HttpException(body, responseStatusCode, { cause: apiError });
+    const [response, status] = Match.value(apiError).pipe(
+      Match.when(
+        Match.instanceOf(DefaultApiError),
+        ({ message, responseStatusCode }) =>
+          Data.tuple(message, responseStatusCode!),
+      ),
+      Match.orElse(
+        (
+          {
+            additionalData: _additionalData,
+            responseHeaders: _responseHeaders,
+            responseStatusCode,
+            ...responseBody
+          },
+        ) => Data.tuple(responseBody, responseStatusCode),
+      ),
+    );
+
+    return new HttpException(response, status, { cause: apiError });
+  }
+
+  private isApiError(input: unknown): input is DeserializedApiError {
+    return Predicate.isRecord(input) &&
+      Predicate.hasProperty(input, 'responseHeaders') &&
+      Predicate.isRecord(input.responseHeaders) &&
+      Predicate.hasProperty(input, 'responseStatusCode') &&
+      Predicate.isNumber(input.responseStatusCode);
   }
 }
diff --git a/package.json b/package.json
@@ -31,7 +31,8 @@
     "@nestjs/platform-express": "^10.0.0",
     "effect": "^2.4.0",
     "reflect-metadata": "^0.2.0",
-    "rxjs": "^7.8.1"
+    "rxjs": "^7.8.1",
+    "type-fest": "^4.13.1"
   },
   "devDependencies": {
     "@nestjs/cli": "^10.0.0",

diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml
diff --git a/src/effective-users/effective-users.service.ts b/src/effective-users/effective-users.service.ts
@@ -8,7 +8,7 @@ import {
   Injectable,
   NotFoundException,
 } from '@nestjs/common';
-import { Effect, Match, Schedule } from 'effect';
+import { Data, Effect, Match, Schedule } from 'effect';
 
 @Injectable()
 export class EffectiveUsersService {
@@ -49,7 +49,7 @@ export class EffectiveUsersService {
       Effect.flatMap(([user, posts]) =>
         !user || !posts
           ? Effect.die('Something went wrong!')
-          : Effect.succeed([user, posts] as const)
+          : Effect.succeed(Data.tuple(user, posts))
       ),
       Effect.map(([user, posts]) => ({
         id: user.id,