wrap inotify errors in AmplifyUserError (#2575)

* wrap inotify errors in AmplifyUserError

* fix lint

Author: rtpascual

.changeset/mighty-kids-thank.md

@@ -0,0 +1,5 @@
+---
+'@aws-amplify/platform-core': patch
+---
+
+wrap inotify errors in AmplifyUserError

.eslint_dictionary.json

@@ -88,6 +88,7 @@
   "idps",
   "implementors",
   "inheritdoc",
+  "inotify",
   "instanceof",
   "interop",
   "invokable",

packages/platform-core/src/errors/amplify_error.test.ts

@@ -316,4 +316,15 @@ void describe('AmplifyError.fromError', async () => {
       `Failed the test for error ${error.message}`
     );
   });
+  void it('wraps InsufficientInotifyWatchersError in AmplifyUserError when system has reached the limit of inotify watchers', () => {
+    const error = new Error(
+      `Error: inotify_add_watch on '/some/path' failed: No space left on device`
+    );
+    const actual = AmplifyError.fromError(error);
+    assert.ok(
+      AmplifyError.isAmplifyError(actual) &&
+        actual.name === 'InsufficientInotifyWatchersError',
+      `Failed the test for error ${error.message}`
+    );
+  });
 });

packages/platform-core/src/errors/amplify_error.ts

@@ -194,6 +194,17 @@ export abstract class AmplifyError<T extends string = string> extends Error {
         error
       );
     }
+    if (error instanceof Error && isInotifyError(error)) {
+      return new AmplifyUserError(
+        'InsufficientInotifyWatchersError',
+        {
+          message: error.message,
+          resolution:
+            'There appears to be an insufficient number of inotify watchers. To increase the amount of inotify watchers, change the `fs.inotify.max_user_watches` setting in your system config files to a higher value.',
+        },
+        error
+      );
+    }
     return new AmplifyFault(
       'UnknownFault',
       {
@@ -330,6 +341,10 @@ const isOutOfMemoryError = (err?: Error): boolean => {
   );
 };
 
+const isInotifyError = (err?: Error): boolean => {
+  return !!err && err.message.includes('inotify_add_watch');
+};
+
 /**
  * Amplify exception classifications
  */