chore: Create a custom error for resource fetcher adapter initialization

Author: msluszniak

packages/react-native-executorch/common/rnexecutorch/ErrorCodes.h

@@ -9,51 +9,60 @@ namespace rnexecutorch {
 
 enum class RnExecutorchErrorCode : int32_t {
   /**
-   * An umbrella-error that is thrown usually when something unexpected happens, for example a 3rd-party library error.
+   * An umbrella-error that is thrown usually when something unexpected happens,
+   * for example a 3rd-party library error.
    */
   UnknownError = 101,
   /**
-   * Thrown when a user tries to run a model that is not yet downloaded or loaded into memory.
+   * Thrown when a user tries to run a model that is not yet downloaded or
+   * loaded into memory.
    */
   ModuleNotLoaded = 102,
   /**
-   * An error ocurred when saving a file. This could be, for instance a result image from an image model.
+   * An error ocurred when saving a file. This could be, for instance a result
+   * image from an image model.
    */
   FileWriteFailed = 103,
   /**
-   * Thrown when a user tries to run a model that is currently processing. It is only allowed to run a single model prediction at a time.
+   * Thrown when a user tries to run a model that is currently processing. It is
+   * only allowed to run a single model prediction at a time.
    */
   ModelGenerating = 104,
   /**
-   * Thrown when a language is passed to a multi-language model that is not supported. For example OCR or Speech To Text.
+   * Thrown when a language is passed to a multi-language model that is not
+   * supported. For example OCR or Speech To Text.
    */
   LanguageNotSupported = 105,
   /**
-   * Thrown when config parameters passed to a model are invalid. For example, when LLM's topp is outside of range [0, 1].
+   * Thrown when config parameters passed to a model are invalid. For example,
+   * when LLM's topp is outside of range [0, 1].
    */
   InvalidConfig = 112,
   /**
    * Thrown when the type of model source passed by the user is invalid.
    */
   InvalidModelSource = 255,
   /**
-   * Thrown when the number of passed inputs to the model is different than the model metadata specifies.
+   * Thrown when the number of passed inputs to the model is different than the
+   * model metadata specifies.
    */
   UnexpectedNumInputs = 97,
   /**
    * Thrown when React Native ExecuTorch threadpool problem occurs.
    */
   ThreadPoolError = 113,
   /**
-   * Thrown when a file read operation failed. This could be invalid image url passed to image models, or unsupported format.
+   * Thrown when a file read operation failed. This could be invalid image url
+   * passed to image models, or unsupported format.
    */
   FileReadFailed = 114,
   /**
    * Thrown when the size of model output is unexpected.
    */
   InvalidModelOutput = 115,
   /**
-   * Thrown when the dimensions of input tensors don't match the model's expected dimensions.
+   * Thrown when the dimensions of input tensors don't match the model's
+   * expected dimensions.
    */
   WrongDimensions = 116,
   /**
@@ -62,7 +71,8 @@ enum class RnExecutorchErrorCode : int32_t {
    */
   InvalidUserInput = 117,
   /**
-   * Thrown when the number of downloaded files is unexpected, due to download interruptions.
+   * Thrown when the number of downloaded files is unexpected, due to download
+   * interruptions.
    */
   DownloadInterrupted = 118,
   /**
@@ -75,19 +85,23 @@ enum class RnExecutorchErrorCode : int32_t {
    */
   MultilingualConfiguration = 160,
   /**
-   * Thrown when streaming transcription is attempted but audio data chunk is missing.
+   * Thrown when streaming transcription is attempted but audio data chunk is
+   * missing.
    */
   MissingDataChunk = 161,
   /**
-   * Thrown when trying to stop or insert data into a stream that hasn't been started.
+   * Thrown when trying to stop or insert data into a stream that hasn't been
+   * started.
    */
   StreamingNotStarted = 162,
   /**
-   * Thrown when trying to start a new streaming session while another is already in progress.
+   * Thrown when trying to start a new streaming session while another is
+   * already in progress.
    */
   StreamingInProgress = 163,
   /**
-   * Thrown when a resource fails to download. This could be due to invalid URL, or for example a network problem.
+   * Thrown when a resource fails to download. This could be due to invalid URL,
+   * or for example a network problem.
    */
   ResourceFetcherDownloadFailed = 180,
   /**
@@ -103,13 +117,18 @@ enum class RnExecutorchErrorCode : int32_t {
    */
   ResourceFetcherAlreadyOngoing = 183,
   /**
-   * Thrown when trying to pause, resume, or cancel a download that is not active.
+   * Thrown when trying to pause, resume, or cancel a download that is not
+   * active.
    */
   ResourceFetcherNotActive = 184,
   /**
    * Thrown when required URI information is missing for a download operation.
    */
   ResourceFetcherMissingUri = 185,
+  /**
+   * Thrown when trying to load resources without fetcher initialization.
+   */
+  ResourceFetcherAdapterNotInitialized = 186,
 };
 
 } // namespace rnexecutorch

packages/react-native-executorch/src/controllers/BaseOCRController.ts

@@ -76,7 +76,7 @@ export abstract class BaseOCRController {
         e &&
         typeof e === 'object' &&
         'code' in e &&
-        e.code === RnExecutorchErrorCode.NotImplemented
+        e.code === RnExecutorchErrorCode.ResourceFetcherAdapterNotInitialized
       ) {
         Logger.error('Load failed:', e);
       } else if (this.errorCallback) {

packages/react-native-executorch/src/errors/ErrorCodes.ts

@@ -102,6 +102,10 @@ export enum RnExecutorchErrorCode {
    * Thrown when required URI information is missing for a download operation.
    */
   ResourceFetcherMissingUri = 185,
+  /**
+   * Thrown when trying to load resources without fetcher initialization.
+   */
+  ResourceFetcherAdapterNotInitialized = 186,
   /**
    * Status indicating a successful operation.
    */

packages/react-native-executorch/src/utils/ResourceFetcher.ts

@@ -86,7 +86,7 @@ export class ResourceFetcher {
   static getAdapter(): ResourceFetcherAdapter {
     if (!this.adapter) {
       throw new RnExecutorchError(
-        RnExecutorchErrorCode.NotImplemented,
+        RnExecutorchErrorCode.ResourceFetcherAdapterNotInitialized,
         'ResourceFetcher adapter is not initialized. Please call initExecutorch({ resourceFetcher: ... }) with a valid adapter, e.g., from @react-native-executorch/expo-resource-fetcher or @react-native-executorch/bare-resource-fetcher. For more details please refer: https://docs.swmansion.com/react-native-executorch/docs/next/fundamentals/loading-models'
       );
     }

scripts/errors.config.ts

@@ -107,6 +107,10 @@ export const errorDefinitions = {
    * Thrown when required URI information is missing for a download operation.
    */
   ResourceFetcherMissingUri: 0xb9,
+  /**
+   * Thrown when trying to load resources without fetcher initialization.
+   */
+  ResourceFetcherAdapterNotInitialized: 0xba,
 
   // ExecuTorch mapped errors
   // Based on: https://github.com/pytorch/executorch/blob/main/runtime/core/error.h