refactor(shared): Split errors into modules (#6838)

Author: nikosdouvlis

.changeset/wild-fans-love.md

@@ -0,0 +1,2 @@
+---
+---

packages/clerk-js/src/core/clerk.ts

@@ -2368,6 +2368,7 @@ export class Clerk implements ClerkInterface {
     this.#fapiClient.onAfterResponse(callback);
   };
 
+  // TODO @userland-errors:
   __unstable__updateProps = (_props: any) => {
     // We need to re-init the options here in order to keep the options passed to ClerkProvider
     // in sync with the state of clerk-js. If we don't init the options here again, the following scenario is possible:

packages/clerk-js/src/core/fapiClient.ts

@@ -104,6 +104,7 @@ export function createFapiClient(options: FapiClientOptions): FapiClient {
     return true;
   }
 
+  // TODO @userland-errors:
   function buildQueryString({ method, path, sessionId, search, rotatingTokenNonce }: FapiRequestInit): string {
     const searchParams = new URLSearchParams(search as any);
     // the above will parse {key: ['val1','val2']} as key: 'val1,val2' and we need to recreate the array bellow
@@ -148,6 +149,7 @@ export function createFapiClient(options: FapiClientOptions): FapiClient {
     const { path, pathPrefix = 'v1' } = requestInit;
 
     if (options.proxyUrl) {
+      // TODO @userland-errors:
       const proxyBase = new URL(options.proxyUrl);
       let proxyPath = proxyBase.pathname.slice(1);
       if (proxyPath.endsWith('/')) {
@@ -185,6 +187,7 @@ export function createFapiClient(options: FapiClientOptions): FapiClient {
     });
   }
 
+  // TODO @userland-errors:
   async function request<T>(
     _requestInit: FapiRequestInit,
     requestOptions?: FapiRequestOptions,
@@ -221,6 +224,7 @@ export function createFapiClient(options: FapiClientOptions): FapiClient {
         : body;
     }
 
+    // TODO @userland-errors:
     const beforeRequestCallbacksResult = await runBeforeRequestCallbacks(requestInit);
     // Due to a known Safari bug regarding CORS requests, we are forced to always use GET or POST method.
     // The original HTTP method is used as a query string parameter instead of as an actual method to
@@ -237,6 +241,7 @@ export function createFapiClient(options: FapiClientOptions): FapiClient {
     try {
       if (beforeRequestCallbacksResult) {
         const maxTries = requestOptions?.fetchMaxTries ?? (isBrowserOnline() ? 4 : 11);
+        // TODO @userland-errors:
         response = await retry(() => fetch(url, fetchOpts), {
           // This retry handles only network errors, not 4xx or 5xx responses,
           // so we want to try once immediately to handle simple network blips.
@@ -271,6 +276,7 @@ export function createFapiClient(options: FapiClientOptions): FapiClient {
     if (!response.ok) {
       debugLogger.error('request failed', { method, path: requestInit.path, status: response.status }, 'fapiClient');
     }
+    // TODO @userland-errors:
     await runAfterResponseCallbacks(requestInit, fapiResponse);
     return fapiResponse;
   }

packages/clerk-js/src/core/fraudProtection.ts

@@ -22,7 +22,9 @@ export class FraudProtection {
     private CaptchaChallengeImpl: typeof CaptchaChallenge,
   ) {}
 
+  // TODO @userland-errors:
   public async execute<T extends () => Promise<any>, R = Awaited<ReturnType<T>>>(clerk: Clerk, cb: T): Promise<R> {
+    // TODO @userland-errors:
     if (this.captchaAttemptsExceeded()) {
       throw new ClerkRuntimeError(
         'Security verification failed. Please try again by refreshing the page, clearing your browser cookies, or using a different web browser.',

packages/clerk-js/src/core/resources/Base.ts

@@ -62,13 +62,15 @@ export abstract class BaseResource {
     return !this.id;
   }
 
+  // TODO @userland-errors:
   static async _fetch<J extends ClerkResourceJSON | DeletedObjectJSON | null>(
     requestInit: FapiRequestInit,
     opts: BaseFetchOptions = {},
   ): Promise<FapiResponseJSON<J> | null> {
     return FraudProtection.getInstance().execute(this.clerk, () => this._baseFetch<J>(requestInit, opts));
   }
 
+  // TODO @userland-errors:
   protected static async _baseFetch<J extends ClerkResourceJSON | DeletedObjectJSON | null>(
     requestInit: FapiRequestInit,
     opts: BaseFetchOptions = {},
@@ -85,6 +87,7 @@ export abstract class BaseResource {
     } catch (e) {
       // TODO: This should be the default behavior in the next major version, as long as we have a way to handle the requests more gracefully when offline
       if (this.shouldRethrowOfflineNetworkErrors()) {
+        // TODO @userland-errors:
         throw new ClerkRuntimeError(e?.message || e, {
           code: 'network_error',
         });
@@ -201,6 +204,7 @@ export abstract class BaseResource {
 
   protected async _baseMutate<J extends ClerkResourceJSON | null>(params: BaseMutateParams): Promise<this> {
     const { action, body, method, path } = params;
+    // TODO @userland-errors:
     const json = await BaseResource._fetch<J>({ method, path: path || this.path(action), body });
     return this.fromJSON((json?.response || json) as J);
   }

packages/clerk-js/src/core/resources/SignIn.ts

@@ -692,6 +692,7 @@ class SignInFuture implements SignInFutureResource {
     }
 
     return runAsyncResourceTask(this.resource, async () => {
+      // TODO @userland-errors:
       const identifier = params.identifier || params.email || params.phoneNumber;
       const previousIdentifier = this.resource.identifier;
       await this.resource.__internal_basePost({

packages/clerk-js/src/utils/querystring.ts

@@ -21,6 +21,7 @@ type StringifyQueryParamsOptions = {
   keyEncoder?: (key: string) => string;
 };
 
+// TODO @userland-errors:
 export const stringifyQueryParams = (
   params:
     | Record<string, string | undefined | null | object | boolean | Array<string | undefined | null>>

packages/clerk-js/src/utils/runAsyncResourceTask.ts

@@ -20,6 +20,7 @@ export async function runAsyncResourceTask<T>(
     return { result, error: null };
   } catch (err) {
     eventBus.emit('resource:error', { resource, error: err });
+    // TODO @userland-errors:
     return { error: err };
   } finally {
     eventBus.emit('resource:fetch', {

packages/react/src/isomorphicClerk.ts

@@ -746,6 +746,7 @@ export class IsomorphicClerk implements IsomorphicLoadedClerk {
     }
   }
 
+  // TODO @userland-errors:
   __unstable__updateProps = async (props: any): Promise<void> => {
     const clerkjs = await this.#waitForClerkJS();
     // Handle case where accounts has clerk-react@4 installed, but clerk-js@3 is manually loaded