fix(expo-offline-support): Add `Handling network errors` section #1806

anagstef · 2024-12-13T19:16:46Z

Important

🔎 Previews:

https://clerk.com/docs/pr/1806/references/expo/offline-support

Explanation:

We need to showcase how you can catch the network errors when trying a Clerk operation.

This PR:

Adds a new section in the Offline Support page with an example snippet

Checklist

I have clicked on "Files changed" and performed a thorough self-review
I have added the "deploy-preview" label and added the preview link(s) to this PR description
All existing checks pass

github-actions · 2024-12-13T19:17:05Z

Hey, here’s your docs preview: https://clerk.com/docs/pr/1806

…ne-support

royanger

I added a couple of minor suggestions, but mostly dropped a couple of questions about this PR.

royanger · 2024-12-13T19:34:43Z

docs/references/expo/offline-support.mdx

@@ -71,3 +71,45 @@ To enable offline support in your Expo app, follow these steps:
  }
  ```
 </Steps>
+
+## Handling network errors


There is already an error handling section. Any reason this is not included in that doc?

Hmm, this is specific to network errors.
Until now, in non-standard browsers we used to mute these errors and Expo users could not handle them. Using this new experimental property prevents the muting and throws these network errors, so that the developers can handle them. So, it's somewhat specific to this feature.

Got it. I see there is a mention of this above. When I reviewed I just looked at the PR and not the whole page. Maybe this information should be added to the 'How to handle network errors' section. I can definitely see some developers missing the line in the first section.

royanger · 2024-12-13T19:35:04Z

docs/references/expo/offline-support.mdx

+
+## Handling network errors
+
+To handle network errors in your Expo app, you can use the `isClerkRuntimeError` function alongside the `code` property to identify the specific error. Here's an example of how you can handle network errors:


Suggested change

To handle network errors in your Expo app, you can use the `isClerkRuntimeError` function alongside the `code` property to identify the specific error. Here's an example of how you can handle network errors:

To handle network errors in your Expo app, you can use the `isClerkRuntimeError` function and check the `code` property to identify the specific error. Here's an example of how you can handle network errors:

Why is this showing a network_error error when its for offline support? This seems counter intuitive.

Clerk custom flows should throw errors if there is no internet connection, e.g. signIn.create(). This error was muted until now and developers could not handle these.

Please see the above about adding context to this section.

docs/references/expo/offline-support.mdx

alexisintech · 2024-12-16T16:17:08Z

docs/references/expo/offline-support.mdx

+
+## How to handle network errors
+
+To handle network errors in your Expo app, you can use the `isClerkRuntimeError()` function to check if the error is a Clerk-related error. Clerk-related errors are returned as an array of [`ClerkAPIError`](/docs/references/javascript/types/clerk-api-error) objects. These errors contain a `code` property that you can use to identify the specific error. See the following example.


I'm curious, what's the difference between isClerkRuntimeError and isClerkAPIResponseError
in our error handling guide, we use isClerkAPIResponseError

@anagstef can confirm, but from a quick look at the code plus the name I think these are errors related to Clerk actually running in the app, versus Clerk interacting with the API. The network error would be runtime as its the app running but not being able to make a request to FAPI. ClerkAPIError would be an error returned from FAPI.

ahh makes sense! thank you for the explanation ❤️

Yes, this is what @royanger said.
isClerkAPIResponseError returns true for FAPI errors, while isClerkRuntimeError returns true for ClerkJS errors.

Thanks for confirming!

…ne-support

alexisintech · 2024-12-19T18:20:38Z

docs/references/expo/offline-support.mdx

@@ -74,6 +74,8 @@ To enable offline support in your Expo app, follow these steps:

 ## How to handle network errors

+Until now, in Expo we used to mute these errors and developers could not handle them. This new experimental property prevents the muting and throws these network errors, allowing you to catch and handle them in your custom flows.


This isn't necessary! We can remove this

🤔 I added this because @royanger said we should add this context, if I understood correctly. ref: #1806 (comment)

I see! I think he meant adding the context about "Clerk custom flows should throw errors if there is no internet connection". Let me rewrite it and get back to you

take a look here - aa9af7a
I think is the context @royanger wanted to see added! and it makes sense, I like it :)

Thanks! Looks really great!

alexisintech

remove that one section, and you should be good to merge! 😸💖 thank youuuu

addressed adding more context

fix(expo-offline-support): Add Handling network errors section

b9ed5a8

anagstef added the deploy-preview label Dec 13, 2024

anagstef marked this pull request as ready for review December 13, 2024 19:19

anagstef requested a review from a team as a code owner December 13, 2024 19:19

Merge branch 'main' into stefanos/add-network-errors-example-on-offli…

73523ce

…ne-support

anagstef requested review from victoriaxyz, royanger and alexisintech December 13, 2024 19:19

royanger previously requested changes Dec 13, 2024

View reviewed changes

code review

aa6997d

alexisintech reviewed Dec 16, 2024

View reviewed changes

anagstef and others added 3 commits December 19, 2024 18:39

Merge branch 'main' into stefanos/add-network-errors-example-on-offli…

51633e9

…ne-support

add context

7c6607c

update code example

8e113b7

alexisintech reviewed Dec 19, 2024

View reviewed changes

alexisintech approved these changes Dec 19, 2024

View reviewed changes

update context

aa9af7a

alexisintech merged commit d27b673 into main Dec 20, 2024
4 checks passed

alexisintech deleted the stefanos/add-network-errors-example-on-offline-support branch December 20, 2024 22:52

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix(expo-offline-support): Add `Handling network errors` section #1806

fix(expo-offline-support): Add `Handling network errors` section #1806

anagstef commented Dec 13, 2024 •

edited

Loading

github-actions bot commented Dec 13, 2024

royanger left a comment

royanger Dec 13, 2024

anagstef Dec 13, 2024

royanger Dec 16, 2024

royanger Dec 13, 2024

royanger Dec 13, 2024

anagstef Dec 13, 2024

royanger Dec 16, 2024

alexisintech Dec 16, 2024

royanger Dec 16, 2024

alexisintech Dec 17, 2024

anagstef Dec 19, 2024

royanger Dec 19, 2024

alexisintech Dec 19, 2024

anagstef Dec 20, 2024

alexisintech Dec 20, 2024

alexisintech Dec 20, 2024 •

edited

Loading

anagstef Dec 20, 2024

alexisintech left a comment


		## Handling network errors

		To handle network errors in your Expo app, you can use the `isClerkRuntimeError` function alongside the `code` property to identify the specific error. Here's an example of how you can handle network errors:


		## How to handle network errors

		To handle network errors in your Expo app, you can use the `isClerkRuntimeError()` function to check if the error is a Clerk-related error. Clerk-related errors are returned as an array of [`ClerkAPIError`](/docs/references/javascript/types/clerk-api-error) objects. These errors contain a `code` property that you can use to identify the specific error. See the following example.

		@@ -74,6 +74,8 @@ To enable offline support in your Expo app, follow these steps:

		## How to handle network errors

		Until now, in Expo we used to mute these errors and developers could not handle them. This new experimental property prevents the muting and throws these network errors, allowing you to catch and handle them in your custom flows.

fix(expo-offline-support): Add Handling network errors section #1806

fix(expo-offline-support): Add Handling network errors section #1806

Conversation

anagstef commented Dec 13, 2024 • edited Loading

Explanation:

This PR:

Checklist

github-actions bot commented Dec 13, 2024

royanger left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

alexisintech Dec 20, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

alexisintech left a comment

Choose a reason for hiding this comment

fix(expo-offline-support): Add `Handling network errors` section #1806

fix(expo-offline-support): Add `Handling network errors` section #1806

anagstef commented Dec 13, 2024 •

edited

Loading

alexisintech Dec 20, 2024 •

edited

Loading