fix: finally retrying generate manifest until it succeds

Instead of trying different hacks to defer `executeInstructions` and
`generateManifest` calls. We now retry the `generateManifest` for
multiple times only when the error points to a malformed JSON.

Author: thetutlage

commands/Invoke.ts

@@ -7,12 +7,10 @@
 * file that was distributed with this source code.
 */
 
-import { open } from 'fs-extra'
-import { join } from 'path'
 import { BaseCommand, args } from '@adonisjs/ace'
 
 import { Manifest } from '../src/Manifest'
-import { ADONIS_ACE_CWD, ADONIS_BUILD_DIR } from '../config/env'
+import { ADONIS_ACE_CWD } from '../config/env'
 
 /**
  * Invoke post install instructions
@@ -27,33 +25,6 @@ export default class Invoke extends BaseCommand {
   @args.string({ description: 'Name of the package for which to invoke post install instructions' })
   public name: string
 
-  /**
-   * Attempts to access the rc file handling the race condition of
-   * it's being accessed by another process.
-   */
-  private async accessRcFile (counter = 0) {
-    const buildDir = ADONIS_BUILD_DIR()
-    const cwd = ADONIS_ACE_CWD()!
-
-    /**
-     * Return early when we are unaware of the build
-     * directory
-     */
-    if (!buildDir) {
-      return
-    }
-
-    try {
-      await open(join(cwd, buildDir, '.adonisrc.json'), 'r+')
-    } catch (error) {
-      if (error.code === 'EBUSY' && counter < 3) {
-        await this.accessRcFile(counter + 1)
-      } else {
-        throw error
-      }
-    }
-  }
-
   /**
    * Invoked automatically by ace
    */
@@ -73,12 +44,6 @@ export default class Invoke extends BaseCommand {
 
     const { executeInstructions } = await import('@adonisjs/sink')
     await executeInstructions(this.name, cwd, this.application)
-
-    try {
-      await this.accessRcFile()
-    } catch (error) {
-    }
-
     await new Manifest(cwd, this.logger).generate()
   }
 }

src/Manifest/index.ts

@@ -19,9 +19,30 @@ const WARN_MESSAGE = [
  * Exposes the API to execute generate manifest file
  */
 export class Manifest {
+  /**
+   * The maximum number of times we should attempt to generate
+   * the manifest file before giving up.
+   *
+   * This number make sound too big, but in real world scanerio, we
+   * have seen encountered malformed JSON between 10-12 times.
+   *
+   * The JSON gets malformed, when a parallel process (node ace serve --watch)
+   * is trying to update it.
+   */
+  private maxAttempts = 15
+  private attempts = 0
+
   constructor (private appRoot: string, private logger: Logger) {
   }
 
+  /**
+   * Returns a boolean telling if the error message is pointing
+   * towards invalid or empty JSON file read attempt.
+   */
+  private isMalformedJSONError (error: string) {
+    return error.includes('Unexpected end of JSON input')
+  }
+
   /**
    * Generates the manifest file. We ignore `generate:manifest` errors for
    * now, since it's a secondary task for us and one should run it
@@ -41,6 +62,12 @@ export class Manifest {
        * Print warning when `stderr` exists
        */
       if (response.stderr) {
+        if (this.isMalformedJSONError(response.stderr) && this.attempts < this.maxAttempts) {
+          this.attempts++
+          await this.generate()
+          return
+        }
+
         this.logger.warn(WARN_MESSAGE)
         this.logger.fatal({
           message: response.stderr,
@@ -56,6 +83,12 @@ export class Manifest {
         console.log(response.stdout)
       }
     } catch (error) {
+      if (this.isMalformedJSONError(error.stderr) && this.attempts < this.maxAttempts) {
+        this.attempts++
+        await this.generate()
+        return
+      }
+
       /**
        * Print warning on error
        */