@learnpack/learnpack 5.0.362 → 5.0.364

package/src/utils/interactivity/interactivityPlan.ts

@@ -0,0 +1,57 @@
+// Which interactivity template a lesson uses, and what happens when it fails.
+//
+// v2 (structured) returns component data that the CLI renders; v1 is the
+// original template, which writes the component markdown itself. The webhook
+// URL carries the template, because rigobot posts back to that exact URL and
+// its error payload does not say it. How many retries a lesson gets is decided
+// by utils/generationRetry.ts, as for the other generation phases.
+
+export const INTERACTIVITY_V1_SLUG = "add-lesson-interactivy"
+export const INTERACTIVITY_V2_SLUG = "add-lesson-interactivity-v2"
+
+export type InteractivityTemplate = "v1" | "v2";
+
+export const isInteractivityV2Enabled = (
+  env: Record<string, string | undefined> = process.env
+): boolean => env.INTERACTIVITY_V2 === "true"
+
+export interface InteractivityRequest {
+  tpl: InteractivityTemplate;
+  slug: string;
+  webhookQuery: string;
+}
+
+export const planInteractivityRequest = ({
+  v2Enabled,
+  forceV1 = false,
+}: {
+  v2Enabled: boolean;
+  forceV1?: boolean;
+}): InteractivityRequest => {
+  const tpl: InteractivityTemplate = v2Enabled && !forceV1 ? "v2" : "v1"
+  return {
+    tpl,
+    slug: tpl === "v2" ? INTERACTIVITY_V2_SLUG : INTERACTIVITY_V1_SLUG,
+    webhookQuery: `?tpl=${tpl}`,
+  }
+}
+
+export interface InteractivityFailure {
+  // The failed job used the structured template.
+  fromV2: boolean;
+  // The error text that decides whether the lesson is retried.
+  retryStatusText: unknown;
+}
+
+// After a failed job. Every retry uses v1, so a problem of the new template
+// never blocks a lesson. An error that would repeat normally stops the retries,
+// but when the v2 template fails that says nothing about v1, so the error is
+// not passed on and v1 gets its retry within the usual cap. Jobs started
+// before this change have no query and count as v1.
+export const describeInteractivityFailure = (
+  query: { tpl?: unknown },
+  statusText: unknown
+): InteractivityFailure => {
+  const fromV2 = query.tpl === "v2"
+  return { fromV2, retryStatusText: fromV2 ? undefined : statusText }
+}