@wpkernel/pipeline 0.12.1-beta.0 → 0.12.1-beta.3

package/dist/createPipeline.js

@@ -1,447 +1,126 @@
-import { maybeThen as M, maybeTry as Q } from "./async-utils.js";
-import { createDependencyGraph as X } from "./dependency-graph.js";
-import { runExtensionHooks as ie, rollbackExtensionResults as ce, commitExtensionResults as ae, createRollbackErrorMetadata as Y } from "./extensions.js";
-import { executeHelpers as Z } from "./executor.js";
-import { registerHelper as _, handleExtensionRegisterResult as ue } from "./registration.js";
+import { maybeThen as E, isPromiseLike as h } from "./async-utils.js";
+import { registerHelper as v, handleExtensionRegisterResult as w } from "./registration.js";
+import { initDiagnosticManager as V } from "./internal/diagnostic-manager.js";
+import { initPipelineRunner as $ } from "./internal/pipeline-runner.js";
 /**
  * @wpkernel/pipeline
  * @license EUPL-1.2
  */
-function ye(c) {
-  const b = c.fragmentKind ?? "fragment", m = c.builderKind ?? "builder", h = c.createError ?? ((e, n) => new Error(`[${e}] ${n}`)), E = [], y = [], S = [], G = /* @__PURE__ */ new WeakMap();
-  let H;
-  const v = [], l = b, p = m;
-  function C(e, n) {
-    return e === l ? `Fragment helper "${n.key}"` : e === p ? `Builder helper "${n.key}"` : `Helper "${n.key}"`;
-  }
-  function P(e, n, t, r) {
-    const a = c.createConflictDiagnostic?.({
-      helper: e,
-      existing: n,
-      message: r
-    }) ?? {
-      type: "conflict",
-      key: e.key,
-      mode: e.mode,
-      helpers: [
-        n.origin ?? n.key,
-        e.origin ?? e.key
-      ],
-      message: r,
-      kind: t
-    };
-    O(a);
-  }
-  function q(e, n, t) {
-    const r = `${C(t, e)} depends on unknown helper "${n}".`, a = c.createMissingDependencyDiagnostic?.({
-      helper: e,
-      dependency: n,
-      message: r
-    }) ?? {
-      type: "missing-dependency",
-      key: e.key,
-      dependency: n,
-      message: r,
-      kind: t,
-      helper: e.origin ?? e.key
-    };
-    O(a);
-  }
-  function D(e, n, t, r) {
-    const a = `${C(n, e)} ${t}.`, u = c.createUnusedHelperDiagnostic?.({
-      helper: e,
-      message: a
-    }) ?? {
-      type: "unused-helper",
-      key: e.key,
-      message: a,
-      kind: n,
-      helper: e.origin ?? e.key,
-      dependsOn: r
-    };
-    O(u);
-  }
-  function T(e) {
-    if (!H || !c.onDiagnostic)
-      return;
-    const n = G.get(H);
-    if (n?.has(e))
-      return;
-    const t = n ?? /* @__PURE__ */ new Set();
-    c.onDiagnostic({
-      reporter: H,
-      diagnostic: e
-    }), t.add(e), n || G.set(H, t);
-  }
-  function O(e) {
-    S.push(e), T(e);
-  }
-  function W(e, n, t) {
-    for (const r of e)
-      n.has(r.id) || D(
-        r.helper,
-        t,
-        "was registered but never executed",
-        r.helper.dependsOn
-      );
-  }
-  function A(e, n, t) {
-    const r = [], a = [], u = [];
-    for (const k of e) {
-      const f = k.helper.key;
-      r.push(f), n.has(k.id) ? a.push(f) : u.push(f);
-    }
-    return {
-      kind: t,
-      registered: r,
-      executed: a,
-      missing: u
-    };
-  }
-  function j(e, n, t) {
-    if (n.missing.length === 0)
-      return;
-    const r = e.filter(
-      (u) => n.missing.includes(u.helper.key) && !u.helper.optional
-    );
-    if (r.length === 0)
-      return;
-    const a = r.map(
-      (u) => C(t, u.helper)
-    );
-    throw h(
-      "ValidationError",
-      `Pipeline finalisation aborted because ${a.join(", ")} did not execute.`
-    );
-  }
-  const N = (e) => _(
+function L(r) {
+  const i = r.fragmentKind ?? "fragment", s = r.builderKind ?? "builder", a = r.createError ?? ((e, n) => new Error(`[${e}] ${n}`)), l = [], d = [], f = [], o = [], u = V({
+    options: r,
+    fragmentKind: i,
+    builderKind: s
+  }), k = r.createRunResult ?? ((e) => ({
+    artifact: e.artifact,
+    diagnostics: e.diagnostics,
+    steps: e.steps
+  })), { prepareContext: K, executeRun: P } = $({
+    options: r,
+    fragmentEntries: l,
+    builderEntries: d,
+    fragmentKind: i,
+    builderKind: s,
+    diagnosticManager: u,
+    createError: a,
+    resolveRunResult: k,
+    extensionHooks: f
+  }), g = i, m = s, p = (e) => v(
     e,
-    b,
-    E,
+    i,
     l,
-    (n, t, r) => P(
+    g,
+    (n, t, c) => u.flagConflict(
       n,
       t,
-      l,
-      r
+      g,
+      c
     ),
-    h
-  ), I = (e) => _(
+    a
+  ), R = (e) => v(
     e,
+    s,
+    d,
     m,
-    y,
-    p,
-    (n, t, r) => P(
+    (n, t, c) => u.flagConflict(
       n,
       t,
-      p,
-      r
+      m,
+      c
     ),
-    h
-  ), J = (e, n) => ue(e, n, v);
-  function ee(e) {
-    const n = c.createBuildOptions(e), t = c.createContext(e);
-    H = t.reporter;
-    for (const o of S)
-      T(o);
-    const r = c.createFragmentState({
-      options: e,
-      context: t,
-      buildOptions: n
-    }), a = X(
-      E,
-      {
-        onMissingDependency: ({ dependant: o, dependencyKey: i }) => {
-          const s = o.helper;
-          q(
-            s,
-            i,
-            l
-          ), D(
-            s,
-            l,
-            `could not execute because dependency "${i}" was not found`,
-            s.dependsOn
-          );
-        },
-        onUnresolvedHelpers: ({ unresolved: o }) => {
-          for (const i of o) {
-            const s = i.helper;
-            D(
-              s,
-              l,
-              "could not execute because its dependencies never resolved",
-              s.dependsOn
-            );
-          }
-        }
-      },
-      h
-    ).order, u = [], k = (o) => {
-      const i = o.helper;
-      u.push({
-        id: o.id,
-        index: u.length,
-        key: i.key,
-        kind: i.kind,
-        mode: i.mode,
-        priority: i.priority,
-        dependsOn: i.dependsOn,
-        origin: i.origin
+    a
+  ), C = (e, n) => w(e, n, f), H = (e) => {
+    if (e && h(e)) {
+      Promise.resolve(e).catch(() => {
       });
-    }, f = {
-      onMissingDependency: ({ dependant: o, dependencyKey: i }) => {
-        const s = o.helper;
-        q(
-          s,
-          i,
-          p
-        ), D(
-          s,
-          p,
-          `could not execute because dependency "${i}" was not found`,
-          s.dependsOn
-        );
-      },
-      onUnresolvedHelpers: ({ unresolved: o }) => {
-        for (const i of o) {
-          const s = i.helper;
-          D(
-            s,
-            p,
-            "could not execute because its dependencies never resolved",
-            s.dependsOn
-          );
-        }
-      }
-    }, K = c.createExtensionHookOptions ?? ((o) => ({
-      context: o.context,
-      options: o.options,
-      artifact: o.artifact
-    })), U = (o) => K({
-      context: t,
-      options: e,
-      buildOptions: n,
-      artifact: o
-    }), $ = c.onExtensionRollbackError ?? ((o) => {
-      const { reporter: i } = o.context, s = i.warn;
-      typeof s == "function" && s.call(i, "Pipeline extension rollback failed.", {
-        error: o.error,
-        errorName: o.errorMetadata.name,
-        errorMessage: o.errorMetadata.message,
-        errorStack: o.errorMetadata.stack,
-        errorCause: o.errorMetadata.cause,
-        extensions: o.extensionKeys,
-        hookKeys: o.hookSequence
+      const n = Promise.resolve(e).then(() => {
       });
-    });
-    return {
-      runOptions: e,
-      buildOptions: n,
-      context: t,
-      draft: r,
-      fragmentOrder: a,
-      steps: u,
-      pushStep: k,
-      builderGraphOptions: f,
-      createHookOptions: U,
-      handleRollbackError: $
-    };
-  }
-  const ne = c.createRunResult ?? ((e) => ({
-    artifact: e.artifact,
-    diagnostics: e.diagnostics,
-    steps: e.steps
-  }));
-  function te(e) {
-    const {
-      runOptions: n,
-      buildOptions: t,
-      context: r,
-      draft: a,
-      fragmentOrder: u,
-      steps: k,
-      pushStep: f,
-      builderGraphOptions: K,
-      createHookOptions: U,
-      handleRollbackError: $
-    } = e;
-    let o = A(
-      y,
-      /* @__PURE__ */ new Set(),
-      m
-    );
-    const i = Z(
-      u,
-      (s) => c.createFragmentArgs({
-        helper: s.helper,
-        options: n,
-        context: r,
-        buildOptions: t,
-        draft: a
-      }),
-      (s, F, x) => s.apply(F, x),
-      (s) => f(s)
-    );
-    return M(i, (s) => {
-      W(
-        E,
-        s,
-        l
-      );
-      const F = A(
-        E,
-        s,
-        b
-      );
-      j(
-        E,
-        F,
-        l
-      );
-      let x = c.finalizeFragmentState({
-        draft: a,
-        options: n,
-        context: r,
-        buildOptions: t,
-        helpers: { fragments: F }
+      n.catch(() => {
+      }), o.push(n), n.finally(() => {
+        const t = o.indexOf(n);
+        t !== -1 && o.splice(t, 1);
+      }).catch(() => {
       });
-      const re = X(
-        y,
-        K,
-        h
-      ).order, oe = ie(
-        v,
-        U(x),
-        ({ error: R, extensionKeys: B, hookSequence: z }) => $({
-          error: R,
-          extensionKeys: B,
-          hookSequence: z,
-          errorMetadata: Y(R),
-          context: r
-        })
+    }
+    return e;
+  }, b = () => {
+    if (o.length !== 0)
+      return Promise.all([...o]).then(
+        () => {
+        }
       );
-      return M(oe, (R) => {
-        x = R.artifact;
-        const B = () => (d) => M(
-          ce(
-            R.results,
-            v,
-            ({
-              error: g,
-              extensionKeys: w,
-              hookSequence: V
-            }) => $({
-              error: g,
-              extensionKeys: w,
-              hookSequence: V,
-              errorMetadata: Y(
-                g
-              ),
-              context: r
-            })
-          ),
-          () => {
-            throw d;
-          }
-        ), z = B(), se = (d) => {
-          W(
-            y,
-            d,
-            p
-          );
-          const g = A(
-            y,
-            d,
-            m
-          );
-          j(
-            y,
-            g,
-            p
-          ), o = g;
-          const w = () => ne({
-            artifact: x,
-            diagnostics: S.slice(),
-            steps: k,
-            context: r,
-            buildOptions: t,
-            options: n,
-            helpers: {
-              fragments: F,
-              builders: o
-            }
-          }), V = B();
-          return M(
-            Q(
-              () => ae(
-                R.results
-              ),
-              V
-            ),
-            w
-          );
-        };
-        return Q(() => M(
-          Z(
-            re,
-            (d) => c.createBuilderArgs({
-              helper: d.helper,
-              options: n,
-              context: r,
-              buildOptions: t,
-              artifact: x
-            }),
-            (d, g, w) => d.apply(g, w),
-            (d) => f(d)
-          ),
-          se
-        ), z);
-      });
-    });
-  }
-  const L = {
-    fragmentKind: b,
-    builderKind: m,
+  }, x = {
+    fragmentKind: i,
+    builderKind: s,
     ir: {
       use(e) {
-        N(e);
+        p(e);
       }
     },
     builders: {
       use(e) {
-        I(e);
+        R(e);
       }
     },
     extensions: {
       use(e) {
-        const n = e.register(L);
-        return n && typeof n?.then == "function" ? n.then(
-          (t) => J(e.key, t)
-        ) : J(e.key, n);
+        const n = e.register(x);
+        n && h(n) && Promise.resolve(n).catch(() => {
+        });
+        const t = E(
+          n,
+          (c) => C(e.key, c)
+        );
+        return H(t);
       }
     },
     use(e) {
-      if (e.kind === b) {
-        N(e);
+      if (e.kind === i) {
+        p(e);
         return;
       }
-      if (e.kind === m) {
-        I(e);
+      if (e.kind === s) {
+        R(e);
         return;
       }
-      throw h(
+      throw a(
         "ValidationError",
         `Unsupported helper kind "${e.kind}".`
       );
     },
     run(e) {
-      const n = ee(e);
-      return te(n);
+      const n = () => {
+        const t = K(e);
+        return P(t);
+      };
+      return E(
+        b(),
+        () => n()
+      );
     }
   };
-  return L;
+  return x;
 }
 export {
-  ye as createPipeline
+  L as createPipeline
 };

package/dist/extensions/index.d.ts

@@ -0,0 +1,3 @@
+export { OFFICIAL_EXTENSION_BLUEPRINTS } from './official';
+export type { OfficialExtensionBlueprint, ExtensionBlueprint, ExtensionBehaviour, ExtensionFactorySignature, } from './official';
+//# sourceMappingURL=index.d.ts.map

package/dist/extensions/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/extensions/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,6BAA6B,EAAE,MAAM,YAAY,CAAC;AAC3D,YAAY,EACX,0BAA0B,EAC1B,kBAAkB,EAClB,kBAAkB,EAClB,yBAAyB,GACzB,MAAM,YAAY,CAAC"}

package/dist/extensions/index.js

@@ -0,0 +1,8 @@
+import { OFFICIAL_EXTENSION_BLUEPRINTS as N } from "./official.js";
+/**
+ * @wpkernel/pipeline
+ * @license EUPL-1.2
+ */
+export {
+  N as OFFICIAL_EXTENSION_BLUEPRINTS
+};

package/dist/extensions/official.d.ts

@@ -0,0 +1,73 @@
+import { PipelineExtension } from '../types';
+/**
+ * Identifier for a pipeline extension factory.
+ *
+ * @category Pipeline
+ */
+export interface ExtensionFactorySignature<TOptions = unknown> {
+    /**
+     * Human readable name for documentation and diagnostics.
+     */
+    readonly name: string;
+    /**
+     * Suffix appended to the canonical pipeline extension namespace.
+     */
+    readonly slug: string;
+    /**
+     * Shape of the options object accepted by the factory.
+     */
+    readonly options: TOptions;
+}
+/**
+ * Individual behaviour exposed by an extension blueprint.
+ *
+ * @category Pipeline
+ */
+export interface ExtensionBehaviour {
+    readonly name: string;
+    readonly description: string;
+    readonly helperAnnotations?: readonly string[];
+    readonly reporterEvents?: readonly string[];
+    readonly integrations?: readonly string[];
+}
+/**
+ * Documentation-first blueprint for an extension incubated in this package.
+ *
+ * @category Pipeline
+ */
+export interface ExtensionBlueprint {
+    readonly id: string;
+    readonly status: 'planned' | 'in-development';
+    readonly summary: string;
+    readonly factory?: ExtensionFactorySignature;
+    readonly behaviours: readonly ExtensionBehaviour[];
+    readonly pipelineTouchPoints: readonly string[];
+    readonly rolloutNotes: readonly string[];
+}
+/**
+ * Pipeline extension factory type used throughout the blueprints.
+ *
+ * @category Pipeline
+ */
+export type AnyPipelineExtensionFactory = (options?: unknown) => PipelineExtension<unknown, unknown, unknown, unknown>;
+/**
+ * Blueprint catalogue for official extensions that the pipeline team will own.
+ *
+ * @example
+ * ```ts
+ * import { OFFICIAL_EXTENSION_BLUEPRINTS } from '@wpkernel/pipeline/extensions';
+ *
+ * const liveRunner = OFFICIAL_EXTENSION_BLUEPRINTS.find(
+ * 	(entry) => entry.id === 'live-runner'
+ * );
+ *
+ * if (liveRunner?.factory) {
+ * 	console.log(`Factory slug: ${liveRunner.factory.slug}`);
+ * }
+ * ```
+ *
+ * @category Pipeline
+ */
+export declare const OFFICIAL_EXTENSION_BLUEPRINTS: readonly ExtensionBlueprint[];
+export type { ExtensionBlueprint as OfficialExtensionBlueprint };
+//# sourceMappingURL=official.d.ts.map

package/dist/extensions/official.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"official.d.ts","sourceRoot":"","sources":["../../src/extensions/official.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,UAAU,CAAC;AAElD;;;;GAIG;AACH,MAAM,WAAW,yBAAyB,CAAC,QAAQ,GAAG,OAAO;IAC5D;;OAEG;IACH,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB;;OAEG;IACH,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB;;OAEG;IACH,QAAQ,CAAC,OAAO,EAAE,QAAQ,CAAC;CAC3B;AAED;;;;GAIG;AACH,MAAM,WAAW,kBAAkB;IAClC,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAC;IAC7B,QAAQ,CAAC,iBAAiB,CAAC,EAAE,SAAS,MAAM,EAAE,CAAC;IAC/C,QAAQ,CAAC,cAAc,CAAC,EAAE,SAAS,MAAM,EAAE,CAAC;IAC5C,QAAQ,CAAC,YAAY,CAAC,EAAE,SAAS,MAAM,EAAE,CAAC;CAC1C;AAED;;;;GAIG;AACH,MAAM,WAAW,kBAAkB;IAClC,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAC;IACpB,QAAQ,CAAC,MAAM,EAAE,SAAS,GAAG,gBAAgB,CAAC;IAC9C,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IACzB,QAAQ,CAAC,OAAO,CAAC,EAAE,yBAAyB,CAAC;IAC7C,QAAQ,CAAC,UAAU,EAAE,SAAS,kBAAkB,EAAE,CAAC;IACnD,QAAQ,CAAC,mBAAmB,EAAE,SAAS,MAAM,EAAE,CAAC;IAChD,QAAQ,CAAC,YAAY,EAAE,SAAS,MAAM,EAAE,CAAC;CACzC;AAED;;;;GAIG;AACH,MAAM,MAAM,2BAA2B,GAAG,CACzC,OAAO,CAAC,EAAE,OAAO,KACb,iBAAiB,CAAC,OAAO,EAAE,OAAO,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;AAE3D;;;;;;;;;;;;;;;;;GAiBG;AACH,eAAO,MAAM,6BAA6B,EAAE,SAAS,kBAAkB,EA+GtE,CAAC;AAEF,YAAY,EAAE,kBAAkB,IAAI,0BAA0B,EAAE,CAAC"}