@gadgetinc/ggt 0.4.10 → 1.0.0

package/lib/services/filesync/error.js

@@ -1,7 +1,10 @@
 import { _ as _define_property } from "@swc/helpers/_/_define_property";
-import { CLIError, IsBug } from "../output/report.js";
-import { sprint } from "../output/sprint.js";
-export class YarnNotFoundError extends CLIError {
+import { ClientError } from "../app/error.js";
+import { sprintProblems } from "../output/problems.js";
+import { GGTError, IsBug } from "../output/report.js";
+import { sprint, sprintln } from "../output/sprint.js";
+import { isGraphQLErrors, isGraphQLResult, isObject, isString } from "../util/is.js";
+export class YarnNotFoundError extends GGTError {
     render() {
         return sprint`
       Yarn must be installed to sync your application. You can install it by running:
@@ -16,52 +19,118 @@ export class YarnNotFoundError extends CLIError {
         _define_property(this, "isBug", IsBug.NO);
     }
 }
-export class InvalidSyncFileError extends CLIError {
+export class UnknownDirectoryError extends GGTError {
     render() {
-        return sprint`
-      We failed to find a ".gadget/sync.json" file in this directory:
+        const cmd = this.ctx.command;
+        const dir = this.opts.directory.path;
+        switch(cmd){
+            case "open":
+            case "status":
+                return sprint`
+          A ".gadget/sync.json" file is missing in this directory:
 
-        ${this.dir}
+            ${dir}
 
-      If you're running 'ggt sync' for the first time, we recommend
-      using a gadget specific directory like this:
+          In order to use "ggt ${cmd}", you must run it within a directory
+          that has already been initialized with "ggt dev".
+        `;
+            case "dev":
+                return sprint`
+          A ".gadget/sync.json" file is missing in this directory:
 
-        ggt sync ~/gadget/${this.app} --app ${this.app}
+            ${dir}
 
-      If you're certain you want to sync the contents of that directory
-      to Gadget, run 'ggt sync' again with the {bold --force} flag:
+          If you're running "ggt dev" for the first time, we recommend
+          using a gadget specific directory like this:
 
-        ggt sync ${this.dir} --app ${this.app} --force
-    `;
+            ggt dev ~/gadget/${this.ctx.args["--app"] ?? "<name>"}
+
+          To use a non-empty directory without a ".gadget/sync.json" file,
+          run "ggt dev" again with the "--allow-unknown-directory" flag:
+
+            ggt dev ${dir} --allow-unknown-directory
+        `;
+            default:
+                return sprint`
+          A ".gadget/sync.json" file is missing in this directory:
+
+            ${dir}
+
+          If you're certain you want to use this directory, you can run
+          "ggt ${cmd}" again with the "--allow-unknown-directory" flag:
+
+            ggt ${cmd} --allow-unknown-directory
+        `;
+        }
     }
-    constructor(dir, app){
-        super("The .gadget/sync.json file was invalid or not found");
-        _define_property(this, "dir", void 0);
-        _define_property(this, "app", void 0);
+    constructor(ctx, opts){
+        super('The ".gadget/sync.json" file was invalid or not found');
+        _define_property(this, "ctx", void 0);
+        _define_property(this, "opts", void 0);
         _define_property(this, "isBug", void 0);
-        this.dir = dir;
-        this.app = app;
+        this.ctx = ctx;
+        this.opts = opts;
         this.isBug = IsBug.NO;
-        this.app ??= "<name of app>";
     }
 }
-export class TooManySyncAttemptsError extends CLIError {
+export class TooManyMergeAttemptsError extends GGTError {
     render() {
         return sprint`
-        We synced your local files with Gadget ${this.attempts} times, but
-        your local filesystem is still out of sync.
+      We merged your local files with your environment's files ${this.attempts} times,
+      but your local and environment's files still don't match.
 
-        Make sure no one else is editing files in the Gadget editor
-        and try again.
+      Make sure no one else is editing files on your environment, and try again.
     `;
     }
     constructor(attempts){
-        super(`Failed to sync files after ${attempts} attempts.`);
+        super(`Failed to synchronize files after ${attempts} attempts.`);
         _define_property(this, "attempts", void 0);
         _define_property(this, "isBug", void 0);
         this.attempts = attempts;
         this.isBug = IsBug.MAYBE;
     }
 }
+export class DeployDisallowedError extends GGTError {
+    render() {
+        let output = sprintln`{red Gadget has detected the following fatal errors with your files:}`;
+        output += sprintProblems({
+            ensureEmptyLineAbove: true,
+            problems: this.fatalErrors,
+            showFileTypes: false
+        });
+        output += sprintln({
+            ensureEmptyLineAbove: true
+        })`{red Please fix these errors and try again.}`;
+        return output;
+    }
+    constructor(fatalErrors){
+        super("This application is not allowed to be deployed due to fatal errors.");
+        _define_property(this, "fatalErrors", void 0);
+        _define_property(this, "isBug", void 0);
+        this.fatalErrors = fatalErrors;
+        this.isBug = IsBug.MAYBE;
+    }
+}
+export const isFilesVersionMismatchError = (error)=>{
+    if (error instanceof ClientError) {
+        error = error.cause;
+    }
+    if (isGraphQLResult(error)) {
+        error = error.errors;
+    }
+    if (isGraphQLErrors(error)) {
+        error = error[0];
+    }
+    return isObject(error) && "message" in error && isString(error.message) && error.message.includes("Files version mismatch");
+};
+export const swallowFilesVersionMismatch = (ctx, error)=>{
+    if (isFilesVersionMismatchError(error)) {
+        ctx.log.debug("swallowing files version mismatch", {
+            error
+        });
+        return;
+    }
+    throw error;
+};
 
 //# sourceMappingURL=error.js.map

package/lib/services/filesync/error.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../../src/services/filesync/error.ts"],"sourcesContent":["import { CLIError, IsBug } from \"../output/report.js\";\nimport { sprint } from \"../output/sprint.js\";\n\nexport class YarnNotFoundError extends CLIError {\n  isBug = IsBug.NO;\n\n  constructor() {\n    super(\"Yarn not found\");\n  }\n\n  protected render(): string {\n    return sprint`\n      Yarn must be installed to sync your application. You can install it by running:\n\n        $ npm install --global yarn\n\n      For more information, see: https://classic.yarnpkg.com/en/docs/install\n    `;\n  }\n}\n\nexport class InvalidSyncFileError extends CLIError {\n  isBug = IsBug.NO;\n\n  constructor(\n    readonly dir: string,\n    readonly app: string | undefined,\n  ) {\n    super(\"The .gadget/sync.json file was invalid or not found\");\n    this.app ??= \"<name of app>\";\n  }\n\n  protected render(): string {\n    return sprint`\n      We failed to find a \".gadget/sync.json\" file in this directory:\n\n        ${this.dir}\n\n      If you're running 'ggt sync' for the first time, we recommend\n      using a gadget specific directory like this:\n\n        ggt sync ~/gadget/${this.app} --app ${this.app}\n\n      If you're certain you want to sync the contents of that directory\n      to Gadget, run 'ggt sync' again with the {bold --force} flag:\n\n        ggt sync ${this.dir} --app ${this.app} --force\n    `;\n  }\n}\n\nexport class TooManySyncAttemptsError extends CLIError {\n  isBug = IsBug.MAYBE;\n\n  constructor(readonly attempts: number) {\n    super(`Failed to sync files after ${attempts} attempts.`);\n  }\n\n  protected render(): string {\n    return sprint`\n        We synced your local files with Gadget ${this.attempts} times, but\n        your local filesystem is still out of sync.\n\n        Make sure no one else is editing files in the Gadget editor\n        and try again.\n    `;\n  }\n}\n"],"names":["CLIError","IsBug","sprint","YarnNotFoundError","render","constructor","isBug","NO","InvalidSyncFileError","dir","app","TooManySyncAttemptsError","attempts","MAYBE"],"mappings":";AAAA,SAASA,QAAQ,EAAEC,KAAK,QAAQ,sBAAsB;AACtD,SAASC,MAAM,QAAQ,sBAAsB;AAE7C,OAAO,MAAMC,0BAA0BH;IAO3BI,SAAiB;QACzB,OAAOF,MAAM,CAAC;;;;;;IAMd,CAAC;IACH;IAZAG,aAAc;QACZ,KAAK,CAAC;QAHRC,uBAAAA,SAAQL,MAAMM,EAAE;IAIhB;AAWF;AAEA,OAAO,MAAMC,6BAA6BR;IAW9BI,SAAiB;QACzB,OAAOF,MAAM,CAAC;;;QAGV,EAAE,IAAI,CAACO,GAAG,CAAC;;;;;0BAKO,EAAE,IAAI,CAACC,GAAG,CAAC,OAAO,EAAE,IAAI,CAACA,GAAG,CAAC;;;;;iBAKtC,EAAE,IAAI,CAACD,GAAG,CAAC,OAAO,EAAE,IAAI,CAACC,GAAG,CAAC;IAC1C,CAAC;IACH;IAxBAL,YACE,AAASI,GAAW,EACpB,AAASC,GAAuB,CAChC;QACA,KAAK,CAAC;;;QANRJ,uBAAAA,SAAAA,KAAAA;aAGWG,MAAAA;aACAC,MAAAA;aAJXJ,QAAQL,MAAMM,EAAE;QAOd,IAAI,CAACG,GAAG,KAAK;IACf;AAmBF;AAEA,OAAO,MAAMC,iCAAiCX;IAOlCI,SAAiB;QACzB,OAAOF,MAAM,CAAC;+CAC6B,EAAE,IAAI,CAACU,QAAQ,CAAC;;;;;IAK3D,CAAC;IACH;IAZAP,YAAY,AAASO,QAAgB,CAAE;QACrC,KAAK,CAAC,CAAC,2BAA2B,EAAEA,SAAS,UAAU,CAAC;;QAH1DN,uBAAAA,SAAAA,KAAAA;aAEqBM,WAAAA;aAFrBN,QAAQL,MAAMY,KAAK;IAInB;AAWF"}
+{"version":3,"sources":["../../../src/services/filesync/error.ts"],"sourcesContent":["import { ClientError } from \"../app/error.js\";\nimport type { Context } from \"../command/context.js\";\nimport { sprintProblems, type Problems } from \"../output/problems.js\";\nimport { GGTError, IsBug } from \"../output/report.js\";\nimport { sprint, sprintln } from \"../output/sprint.js\";\nimport { isGraphQLErrors, isGraphQLResult, isObject, isString } from \"../util/is.js\";\nimport type { Directory } from \"./directory.js\";\nimport type { SyncJsonArgs } from \"./sync-json.js\";\n\nexport class YarnNotFoundError extends GGTError {\n  isBug = IsBug.NO;\n\n  constructor() {\n    super(\"Yarn not found\");\n  }\n\n  protected render(): string {\n    return sprint`\n      Yarn must be installed to sync your application. You can install it by running:\n\n        $ npm install --global yarn\n\n      For more information, see: https://classic.yarnpkg.com/en/docs/install\n    `;\n  }\n}\n\nexport class UnknownDirectoryError extends GGTError {\n  isBug = IsBug.NO;\n\n  constructor(\n    readonly ctx: Context<SyncJsonArgs>,\n    readonly opts: { directory: Directory },\n  ) {\n    super('The \".gadget/sync.json\" file was invalid or not found');\n  }\n\n  protected render(): string {\n    const cmd = this.ctx.command;\n    const dir = this.opts.directory.path;\n\n    switch (cmd) {\n      case \"open\":\n      case \"status\":\n        return sprint`\n          A \".gadget/sync.json\" file is missing in this directory:\n\n            ${dir}\n\n          In order to use \"ggt ${cmd}\", you must run it within a directory\n          that has already been initialized with \"ggt dev\".\n        `;\n      case \"dev\":\n        return sprint`\n          A \".gadget/sync.json\" file is missing in this directory:\n\n            ${dir}\n\n          If you're running \"ggt dev\" for the first time, we recommend\n          using a gadget specific directory like this:\n\n            ggt dev ~/gadget/${this.ctx.args[\"--app\"] ?? \"<name>\"}\n\n          To use a non-empty directory without a \".gadget/sync.json\" file,\n          run \"ggt dev\" again with the \"--allow-unknown-directory\" flag:\n\n            ggt dev ${dir} --allow-unknown-directory\n        `;\n      default:\n        return sprint`\n          A \".gadget/sync.json\" file is missing in this directory:\n\n            ${dir}\n\n          If you're certain you want to use this directory, you can run\n          \"ggt ${cmd}\" again with the \"--allow-unknown-directory\" flag:\n\n            ggt ${cmd} --allow-unknown-directory\n        `;\n    }\n  }\n}\n\nexport class TooManyMergeAttemptsError extends GGTError {\n  isBug = IsBug.MAYBE;\n\n  constructor(readonly attempts: number) {\n    super(`Failed to synchronize files after ${attempts} attempts.`);\n  }\n\n  protected render(): string {\n    return sprint`\n      We merged your local files with your environment's files ${this.attempts} times,\n      but your local and environment's files still don't match.\n\n      Make sure no one else is editing files on your environment, and try again.\n    `;\n  }\n}\n\nexport class DeployDisallowedError extends GGTError {\n  isBug = IsBug.MAYBE;\n\n  constructor(readonly fatalErrors: Problems) {\n    super(\"This application is not allowed to be deployed due to fatal errors.\");\n  }\n\n  protected render(): string {\n    let output = sprintln`{red Gadget has detected the following fatal errors with your files:}`;\n    output += sprintProblems({ ensureEmptyLineAbove: true, problems: this.fatalErrors, showFileTypes: false });\n    output += sprintln({ ensureEmptyLineAbove: true })`{red Please fix these errors and try again.}`;\n    return output;\n  }\n}\n\nexport const isFilesVersionMismatchError = (error: unknown): boolean => {\n  if (error instanceof ClientError) {\n    error = error.cause;\n  }\n  if (isGraphQLResult(error)) {\n    error = error.errors;\n  }\n  if (isGraphQLErrors(error)) {\n    error = error[0];\n  }\n  return isObject(error) && \"message\" in error && isString(error.message) && error.message.includes(\"Files version mismatch\");\n};\n\nexport const swallowFilesVersionMismatch = (ctx: Context, error: unknown): void => {\n  if (isFilesVersionMismatchError(error)) {\n    ctx.log.debug(\"swallowing files version mismatch\", { error });\n    return;\n  }\n  throw error;\n};\n"],"names":["ClientError","sprintProblems","GGTError","IsBug","sprint","sprintln","isGraphQLErrors","isGraphQLResult","isObject","isString","YarnNotFoundError","render","constructor","isBug","NO","UnknownDirectoryError","cmd","ctx","command","dir","opts","directory","path","args","TooManyMergeAttemptsError","attempts","MAYBE","DeployDisallowedError","output","ensureEmptyLineAbove","problems","fatalErrors","showFileTypes","isFilesVersionMismatchError","error","cause","errors","message","includes","swallowFilesVersionMismatch","log","debug"],"mappings":";AAAA,SAASA,WAAW,QAAQ,kBAAkB;AAE9C,SAASC,cAAc,QAAuB,wBAAwB;AACtE,SAASC,QAAQ,EAAEC,KAAK,QAAQ,sBAAsB;AACtD,SAASC,MAAM,EAAEC,QAAQ,QAAQ,sBAAsB;AACvD,SAASC,eAAe,EAAEC,eAAe,EAAEC,QAAQ,EAAEC,QAAQ,QAAQ,gBAAgB;AAIrF,OAAO,MAAMC,0BAA0BR;IAO3BS,SAAiB;QACzB,OAAOP,MAAM,CAAC;;;;;;IAMd,CAAC;IACH;IAZAQ,aAAc;QACZ,KAAK,CAAC;QAHRC,uBAAAA,SAAQV,MAAMW,EAAE;IAIhB;AAWF;AAEA,OAAO,MAAMC,8BAA8Bb;IAU/BS,SAAiB;QACzB,MAAMK,MAAM,IAAI,CAACC,GAAG,CAACC,OAAO;QAC5B,MAAMC,MAAM,IAAI,CAACC,IAAI,CAACC,SAAS,CAACC,IAAI;QAEpC,OAAQN;YACN,KAAK;YACL,KAAK;gBACH,OAAOZ,MAAM,CAAC;;;YAGV,EAAEe,IAAI;;+BAEa,EAAEH,IAAI;;QAE7B,CAAC;YACH,KAAK;gBACH,OAAOZ,MAAM,CAAC;;;YAGV,EAAEe,IAAI;;;;;6BAKW,EAAE,IAAI,CAACF,GAAG,CAACM,IAAI,CAAC,QAAQ,IAAI,SAAS;;;;;oBAK9C,EAAEJ,IAAI;QAClB,CAAC;YACH;gBACE,OAAOf,MAAM,CAAC;;;YAGV,EAAEe,IAAI;;;eAGH,EAAEH,IAAI;;gBAEL,EAAEA,IAAI;QACd,CAAC;QACL;IACF;IAlDAJ,YACE,AAASK,GAA0B,EACnC,AAASG,IAA8B,CACvC;QACA,KAAK,CAAC;;;QANRP,uBAAAA,SAAAA,KAAAA;aAGWI,MAAAA;aACAG,OAAAA;aAJXP,QAAQV,MAAMW,EAAE;IAOhB;AA8CF;AAEA,OAAO,MAAMU,kCAAkCtB;IAOnCS,SAAiB;QACzB,OAAOP,MAAM,CAAC;+DAC6C,EAAE,IAAI,CAACqB,QAAQ,CAAC;;;;IAI3E,CAAC;IACH;IAXAb,YAAY,AAASa,QAAgB,CAAE;QACrC,KAAK,CAAC,CAAC,kCAAkC,EAAEA,SAAS,UAAU,CAAC;;QAHjEZ,uBAAAA,SAAAA,KAAAA;aAEqBY,WAAAA;aAFrBZ,QAAQV,MAAMuB,KAAK;IAInB;AAUF;AAEA,OAAO,MAAMC,8BAA8BzB;IAO/BS,SAAiB;QACzB,IAAIiB,SAASvB,QAAQ,CAAC,qEAAqE,CAAC;QAC5FuB,UAAU3B,eAAe;YAAE4B,sBAAsB;YAAMC,UAAU,IAAI,CAACC,WAAW;YAAEC,eAAe;QAAM;QACxGJ,UAAUvB,SAAS;YAAEwB,sBAAsB;QAAK,EAAE,CAAC,4CAA4C,CAAC;QAChG,OAAOD;IACT;IATAhB,YAAY,AAASmB,WAAqB,CAAE;QAC1C,KAAK,CAAC;;QAHRlB,uBAAAA,SAAAA,KAAAA;aAEqBkB,cAAAA;aAFrBlB,QAAQV,MAAMuB,KAAK;IAInB;AAQF;AAEA,OAAO,MAAMO,8BAA8B,CAACC;IAC1C,IAAIA,iBAAiBlC,aAAa;QAChCkC,QAAQA,MAAMC,KAAK;IACrB;IACA,IAAI5B,gBAAgB2B,QAAQ;QAC1BA,QAAQA,MAAME,MAAM;IACtB;IACA,IAAI9B,gBAAgB4B,QAAQ;QAC1BA,QAAQA,KAAK,CAAC,EAAE;IAClB;IACA,OAAO1B,SAAS0B,UAAU,aAAaA,SAASzB,SAASyB,MAAMG,OAAO,KAAKH,MAAMG,OAAO,CAACC,QAAQ,CAAC;AACpG,EAAE;AAEF,OAAO,MAAMC,8BAA8B,CAACtB,KAAciB;IACxD,IAAID,4BAA4BC,QAAQ;QACtCjB,IAAIuB,GAAG,CAACC,KAAK,CAAC,qCAAqC;YAAEP;QAAM;QAC3D;IACF;IACA,MAAMA;AACR,EAAE"}