@pygmalionjs/pygmalion 0.5.16 → 0.5.18

package/dist-lib/types/editor/routePreview.d.ts

@@ -77,7 +77,7 @@ export type RoutePreviewArtifactResolution = {
     status: 'generating';
 } | {
     status: 'error';
-    reason: 'unavailable' | 'rejected';
+    reason: 'unavailable' | 'rejected' | 'not-prepared';
     message: string;
 } | {
     status: 'exact';
@@ -87,6 +87,7 @@ export type RoutePreviewArtifactFrameRequestResult = {
 } | {
     status: 'unavailable';
     message?: string;
+    notPrepared?: boolean;
 } | {
     status: 'rejected';
     message: string;

package/node/preview-artifact-plugin.mjs

@@ -207,6 +207,43 @@ export function pygmalionPreviewArtifactPlugin({
     return current;
   }
 
+  /**
+   * Answers a generation failure as what it is.
+   *
+   * A defective generator is a 500 the consumer must surface. A capture that
+   * could not run is a 503 it should wait out — the frame keeps whatever it has
+   * and says "not prepared yet" instead of painting a red failure over a screen
+   * whose only problem is that no runtime was asked for.
+   */
+  function sendGenerationFailure(response, error) {
+    if (error?.pygmalionBadGeneratorOutput) {
+      sendJson(response, 500, { ok: false, error: 'artifact_generation_failed' });
+      return;
+    }
+    sendJson(response, 503, {
+      ok: false,
+      error: 'artifact_generation_unavailable',
+      retryable: true,
+      details: [
+        error instanceof Error ? error.message.split('\n')[0] : String(error),
+      ],
+    });
+  }
+
+  /**
+   * A generator that ran and produced the wrong thing.
+   *
+   * Two very different failures reach the same catch: the capture could not run
+   * at all — the editor no longer prepares a checkout just because it started,
+   * so asking for a frame before anyone asked for the runtime is ordinary — and
+   * the capture ran but handed back something invalid or belonging to another
+   * revision. Only the second is a defect. Reporting both as one made the first
+   * shout, and quieting both would have hushed the second.
+   */
+  function badGeneratorOutput(message) {
+    return Object.assign(new Error(message), { pygmalionBadGeneratorOutput: true });
+  }
+
   async function withCaptureLease(sourceRevision, task) {
     // A capture reads the dev mirror for minutes. Hold a lease for that whole
     // window so a sync on another server cannot switch the checkout the frames
@@ -241,10 +278,10 @@ export function pygmalionPreviewArtifactPlugin({
         );
         const validation = validateRoutePreviewArtifactBundle(generated);
         if (!validation.valid) {
-          throw new Error('Generated preview artifact is invalid.');
+          throw badGeneratorOutput('Generated preview artifact is invalid.');
         }
         if (!exactArtifact(generated, namespace, sourceRevision)) {
-          throw new Error(
+          throw badGeneratorOutput(
             'Generated preview artifact identity does not match the request.',
           );
         }
@@ -426,11 +463,8 @@ export function pygmalionPreviewArtifactPlugin({
                 sourceRevision,
                 wanted,
               );
-            } catch {
-              sendJson(response, 500, {
-                ok: false,
-                error: 'artifact_generation_failed',
-              });
+            } catch (error) {
+              sendGenerationFailure(response, error);
               return;
             }
           }
@@ -458,11 +492,8 @@ export function pygmalionPreviewArtifactPlugin({
               sourceRevision,
               captureBaseUrl,
             );
-          } catch {
-            sendJson(response, 500, {
-              ok: false,
-              error: 'artifact_generation_failed',
-            });
+          } catch (error) {
+            sendGenerationFailure(response, error);
             return;
           }
         }
@@ -498,11 +529,8 @@ export function pygmalionPreviewArtifactPlugin({
                 sourceRevision,
                 captureBaseUrl,
               );
-            } catch {
-              sendJson(response, 500, {
-                ok: false,
-                error: 'artifact_generation_failed',
-              });
+            } catch (error) {
+              sendGenerationFailure(response, error);
               return;
             }
           } else {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pygmalionjs/pygmalion",
-  "version": "0.5.16",
+  "version": "0.5.18",
   "description": "Code-backed DOM design sandbox and visual QA editor",
   "license": "UNLICENSED",
   "publishConfig": {