refactor: error handling

Author: CurryYangxx

packages/insomnia-api/src/project.ts

@@ -40,7 +40,7 @@ export const createTeamProject = ({
   organizationId: string;
   name: string;
 }) => {
-  return fetch<{ id: string; name: string } | { error: string; message?: string }>({
+  return fetch<{ id: string; name: string }>({
     method: 'POST',
     path: `/v1/organizations/${organizationId}/team-projects`,
     data: {

packages/insomnia/src/routes/organization.$organizationId.project.$projectId.delete.tsx

@@ -5,6 +5,7 @@ import { database } from '~/common/database';
 import { projectLock } from '~/common/project';
 import * as models from '~/models';
 import { reportGitProjectCount } from '~/routes/organization.$organizationId.project.new';
+import { parseInsomniaFetchError } from '~/ui/insomnia-fetch';
 import { invariant } from '~/utils/invariant';
 import { createFetcherSubmitHook, getInitialRouteForOrganization } from '~/utils/router';
 
@@ -25,20 +26,11 @@ export async function clientAction({ params }: Route.ClientActionArgs) {
     await projectLock.lock();
     const bufferId = await database.bufferChanges();
     if (project.remoteId) {
-      const response = await deleteTeamProject({
+      await deleteTeamProject({
         organizationId,
         projectRemoteId: project.remoteId,
         sessionId,
       });
-
-      if (response && 'error' in response) {
-        return {
-          error:
-            response.error === 'FORBIDDEN'
-              ? 'You do not have permission to delete this project.'
-              : 'An unexpected error occurred while deleting the project. Please try again.',
-        };
-      }
     }
 
     if (project.gitRepositoryId) {
@@ -56,13 +48,16 @@ export async function clientAction({ params }: Route.ClientActionArgs) {
     // When redirect to `/organizations/:organizationId`, it sometimes doesn't reload the index loader, so manually redirect to the initial route for the organization
     const initialOrganizationRoute = await getInitialRouteForOrganization({ organizationId });
     return redirect(initialOrganizationRoute);
-  } catch (err) {
-    console.log(err);
+  } catch (err: unknown) {
+    const parsedError = parseInsomniaFetchError(err);
+    console.log(parsedError);
+    let errorMessage = '';
+    errorMessage =
+      parsedError.name === 'FORBIDDEN'
+        ? 'You do not have permission to delete this project.'
+        : `An unexpected error occurred while deleting the project. Please try again.${parsedError?.message}`;
     return {
-      error:
-        err instanceof Error
-          ? err.message
-          : `An unexpected error occurred while deleting the project. Please try again. ${err}`,
+      error: errorMessage,
     };
   } finally {
     await projectLock.unlock();

packages/insomnia/src/routes/organization.$organizationId.project.$projectId.update.tsx

@@ -9,6 +9,7 @@ import type { WorkspaceMeta } from '~/models/workspace-meta';
 import { reportGitProjectCount } from '~/routes/organization.$organizationId.project.new';
 import { SegmentEvent } from '~/ui/analytics';
 import { showToast } from '~/ui/components/toast-notification';
+import { parseInsomniaFetchError } from '~/ui/insomnia-fetch';
 import { invariant } from '~/utils/invariant';
 import { createFetcherSubmitHook } from '~/utils/router';
 
@@ -43,36 +44,37 @@ export async function clientAction({ request, params }: Route.ClientActionArgs)
     await projectLock.lock();
     // If its a cloud project, and we are renaming, then patch
     if (sessionId && project.remoteId && storageType === 'remote' && name !== project.name) {
-      const response = await updateTeamProject({
-        organizationId: project.parentId,
-        projectRemoteId: project.remoteId,
-        sessionId,
-        name,
-      });
-
-      if (response && 'error' in response) {
-        let error = 'An unexpected error occurred while updating your project. Please try again.';
-        if (response.error === 'FORBIDDEN') {
-          error = 'You do not have permission to create a cloud project in this organization.';
+      try {
+        await updateTeamProject({
+          organizationId: project.parentId,
+          projectRemoteId: project.remoteId,
+          sessionId,
+          name,
+        });
+      } catch (error: unknown) {
+        const parsedError = parseInsomniaFetchError(error);
+        let errorMessage = 'An unexpected error occurred while updating your project. Please try again.';
+        if (parsedError.name === 'FORBIDDEN') {
+          errorMessage = 'You do not have permission to create a cloud project in this organization.';
         }
 
-        if (response.error === 'NEEDS_TO_UPGRADE') {
-          error = 'Upgrade your account in order to create new Cloud Projects.';
+        if (parsedError.name === 'NEEDS_TO_UPGRADE') {
+          errorMessage = 'Upgrade your account in order to create new Cloud Projects.';
         }
 
-        if (response.error === 'PROJECT_STORAGE_RESTRICTION') {
-          error = 'The owner of the organization allows only Local Vault project creation, please try again.';
+        if (parsedError.name === 'PROJECT_STORAGE_RESTRICTION') {
+          errorMessage = 'The owner of the organization allows only Local Vault project creation, please try again.';
         }
 
         showToast({
           title: 'Error updating project',
-          description: error,
+          description: errorMessage,
           icon: 'warning',
           status: 'error',
         });
 
         return {
-          error,
+          error: errorMessage,
         };
       }
 
@@ -90,41 +92,40 @@ export async function clientAction({ request, params }: Route.ClientActionArgs)
 
     // convert from cloud to local
     if (storageType === 'local' && project.remoteId) {
-      const response = await deleteTeamProject({
-        organizationId,
-        projectRemoteId: project.remoteId,
-        sessionId,
-      });
+      try {
+        await deleteTeamProject({
+          organizationId,
+          projectRemoteId: project.remoteId,
+          sessionId,
+        });
 
-      if (response && !response.error) {
         window.main.trackSegmentEvent({
           event: SegmentEvent.projectUpdated,
           properties: {
             storage: 'local',
           },
         });
-      }
-
-      if (response && 'error' in response) {
-        let error = 'An unexpected error occurred while updating your project. Please try again.';
+      } catch (error: unknown) {
+        const parsedError = parseInsomniaFetchError(error);
+        let errorMessage = 'An unexpected error occurred while updating your project. Please try again.';
 
-        if (response.error === 'FORBIDDEN') {
-          error = 'You do not have permission to change this project.';
+        if (parsedError.name === 'FORBIDDEN') {
+          errorMessage = 'You do not have permission to change this project.';
         }
 
-        if (response.error === 'PROJECT_STORAGE_RESTRICTION') {
-          error = 'The owner of the organization allows only Cloud Sync project creation, please try again.';
+        if (parsedError.name === 'PROJECT_STORAGE_RESTRICTION') {
+          errorMessage = 'The owner of the organization allows only Cloud Sync project creation, please try again.';
         }
 
         showToast({
           title: 'Error updating project',
-          description: error,
+          description: errorMessage,
           icon: 'warning',
           status: 'error',
         });
 
         return {
-          error,
+          error: errorMessage,
         };
       }
 
@@ -141,105 +142,101 @@ export async function clientAction({ request, params }: Route.ClientActionArgs)
     }
     // convert from local/git to cloud
     if (storageType === 'remote' && !project.remoteId) {
-      const newCloudProject = await createTeamProject({
-        sessionId,
-        organizationId,
-        name,
-      });
+      try {
+        const newCloudProject = await createTeamProject({
+          sessionId,
+          organizationId,
+          name,
+        });
 
-      if (newCloudProject && !('error' in newCloudProject)) {
         window.main.trackSegmentEvent({
           event: SegmentEvent.projectUpdated,
           properties: {
             storage: 'remote',
           },
         });
-      }
 
-      if (!newCloudProject || 'error' in newCloudProject) {
-        let error = 'An unexpected error occurred while updating your project. Please try again.';
-        if (newCloudProject.error === 'FORBIDDEN') {
-          error = newCloudProject.error;
+        if (project.gitRepositoryId) {
+          const gitRepository = await models.gitRepository.getById(project.gitRepositoryId);
+
+          gitRepository && (await models.gitRepository.remove(gitRepository));
         }
 
-        if (newCloudProject.error === 'NEEDS_TO_UPGRADE') {
-          error = 'Upgrade your account in order to create new Cloud Projects.';
+        await models.project.update(project, { name, remoteId: newCloudProject.id, gitRepositoryId: null });
+
+        project.gitRepositoryId && reportGitProjectCount(organizationId, sessionId);
+
+        showToast({
+          title: 'Project updated',
+          status: 'success',
+        });
+
+        return {
+          success: true,
+        };
+      } catch (error: unknown) {
+        const parsedError = parseInsomniaFetchError(error);
+        let errorMessage = 'An unexpected error occurred while updating your project. Please try again.';
+        if (parsedError.name === 'FORBIDDEN') {
+          errorMessage = parsedError.message;
         }
 
-        if (newCloudProject.error === 'PROJECT_STORAGE_RESTRICTION') {
-          error = 'The owner of the organization allows only Local Vault project creation, please try again.';
+        if (parsedError.name === 'NEEDS_TO_UPGRADE') {
+          errorMessage = 'Upgrade your account in order to create new Cloud Projects.';
+        }
+        if (parsedError.name === 'PROJECT_STORAGE_RESTRICTION') {
+          errorMessage = 'The owner of the organization allows only Local Vault project creation, please try again.';
         }
 
         showToast({
           title: 'Error updating project',
-          description: error,
+          description: errorMessage,
           icon: 'warning',
           status: 'error',
         });
 
         return {
-          error,
+          error: errorMessage,
         };
       }
-
-      if (project.gitRepositoryId) {
-        const gitRepository = await models.gitRepository.getById(project.gitRepositoryId);
-
-        gitRepository && (await models.gitRepository.remove(gitRepository));
-      }
-
-      await models.project.update(project, { name, remoteId: newCloudProject.id, gitRepositoryId: null });
-
-      project.gitRepositoryId && reportGitProjectCount(organizationId, sessionId);
-
-      showToast({
-        title: 'Project updated',
-        status: 'success',
-      });
-
-      return {
-        success: true,
-      };
     }
 
     // convert to git
     if (storageType === 'git' && !project.gitRepositoryId) {
       if (project.remoteId) {
-        const response = await deleteTeamProject({
-          organizationId,
-          projectRemoteId: project.remoteId,
-          sessionId,
-        });
+        try {
+          await deleteTeamProject({
+            organizationId,
+            projectRemoteId: project.remoteId,
+            sessionId,
+          });
 
-        if (response && !response.error) {
           window.main.trackSegmentEvent({
             event: SegmentEvent.projectUpdated,
             properties: {
               storage: 'git',
             },
           });
-        }
-
-        if (response && 'error' in response) {
-          let error = 'An unexpected error occurred while updating your project. Please try again.';
-
-          if (response.error === 'FORBIDDEN') {
-            error = 'You do not have permission to change this project.';
+        } catch (error: unknown) {
+          let errorMessage = 'An unexpected error occurred while updating your project. Please try again.';
+          const parsedError = parseInsomniaFetchError(error);
+          if (parsedError.name === 'FORBIDDEN') {
+            errorMessage = 'You do not have permission to change this project.';
           }
 
-          if (response.error === 'PROJECT_STORAGE_RESTRICTION') {
-            error = 'The owner of the organization allows only Cloud Sync project creation, please try again.';
+          if (parsedError.name === 'PROJECT_STORAGE_RESTRICTION') {
+            errorMessage = 'The owner of the organization allows only Cloud Sync project creation, please try again.';
           }
 
           showToast({
             title: 'Error updating project',
-            description: error,
+            description: errorMessage,
             icon: 'warning',
             status: 'error',
           });
 
           return {
-            error,
+            error: errorMessage,
           };
         }
       }