@homeflare/alchemy 0.33.0 → 0.35.0

package/src/grafana/dashboard-model.ts

@@ -50,62 +50,13 @@ export const normalizeModel = (model: DashboardModel, uid: string): DashboardMod
 export const modelTitle = (model: DashboardModel): string =>
   typeof model.title === 'string' ? model.title : '';
 
-const isPlainObject = (value: unknown): value is Record<string, unknown> =>
-  typeof value === 'object' && value !== null && !Array.isArray(value);
-
 /**
- * ★ `declared` NEED ONLY BE A SUBSET OF `live` — an adversarial review of this PR (2026-09-24)
- *   found that plain structural equality made an ordinary, never-edited dashboard show `update`
- *   FOREVER: Grafana's own dashboard-save schema migration rewrites any panel or target whose
- *   `datasource` is absent into an explicit `{type, uid}` reference to the resolved default
- *   datasource — documented Grafana schema-migration behavior (not re-measured against a live
- *   instance in this PR — no live calls). A declared panel that never sets `datasource` (the
- *   common case: hand-authored JSON, or anything relying on the dashboard-level default) would,
- *   after the FIRST create, read back with that field populated; plain `deepEqual` (this file used
- *   `alchemy/Diff`'s before this fix) then disagreed with the declaration on every subsequent plan,
- *   `update` sent the undecorated model back, and Grafana redecorated it again on the next read —
- *   non-convergent.
- *
- * This function instead asks only "does every field the DECLARATION mentions, at any depth, still
- * match what is live" — `live` may carry additional fields, at any depth, that `declared` never
- * mentioned (the datasource auto-decoration above, or any future Grafana-injected default,
- * `fieldConfig` defaults and `pluginVersion` included) without being compared at all. A field
- * `declared` DOES mention that is missing, or different, in `live` still fails the match — real
- * content drift is still caught exactly as before; only fields the declaration is silent about are
- * now tolerated rather than compared.
- *
- * ⚠️ THE TRADE-OFF THIS ACCEPTS, DELIBERATELY: removing a field from the declaration (rather than
- *   changing its value) can no longer force Grafana to drop it. If a panel once declared an
- *   explicit `datasource` and a later declaration deletes that key entirely (rather than setting a
- *   different one), `live` keeps whatever the last write set — the declaration is silent about that
- *   key now, so nothing compares it, so no `update` ever fires to change it. This is the same
- *   "undeclared means don't care, never means force-to-default" convention already used everywhere
- *   else in this kit for a plain optional prop (e.g. `datasource.ts`'s `matches` never treats an
- *   undeclared `access` as "must be unset"); it now also applies inside the JSON model, not just at
- *   the props level. Declare an explicit replacement value to change a field; omission never clears
- *   one that was set by a previous declaration or by Grafana itself.
- *
- * ⚠️ ARRAYS COMPARE BY LENGTH, THEN ELEMENT-WISE SUBSET — never by a looser "declared has fewer
- *   items" rule. `panels`/`targets` are position-significant (see `normalizeModel`'s header); an
- *   array Grafana pads or reorders on its own would still need normalizing here explicitly, the
- *   same as any other newly-discovered auto-decoration — this function does not paper over that.
- * ⚠️ `null` ON EITHER SIDE OF A LEAF NEVER MISMATCHES (mirrors `alchemy/Diff`'s `deepEqual` with
- *   `stripNullish: true`, which this function replaces for the dashboard model specifically).
+ * `declared` need only be a subset of `live` — dashboard.ts's `matches` runs `normalizeModel`'s
+ * output through this. Moved to `subset-match.ts` once `Grafana.ContactPoint`'s `settings` needed
+ * the identical "declaration silent about a field means don't compare it" rule; re-exported here
+ * under its original name so this file's own callers and dashboard-model.test.ts are unchanged.
+ * See subset-match.ts for the full reasoning, including the regression this exists to fix
+ * (Grafana's dashboard-save schema migration auto-decorating a panel's `datasource`) and the
+ * trade-off it accepts (an omitted field can no longer force-clear a previously-set one).
  */
-export const declaredContentMatches = (declared: unknown, live: unknown): boolean => {
-  if (declared == null) return true;
-  if (Array.isArray(declared)) {
-    return (
-      Array.isArray(live) &&
-      declared.length === live.length &&
-      declared.every((item, index) => declaredContentMatches(item, live[index]))
-    );
-  }
-  if (isPlainObject(declared)) {
-    return (
-      isPlainObject(live) &&
-      Object.entries(declared).every(([key, value]) => declaredContentMatches(value, live[key]))
-    );
-  }
-  return declared === live;
-};
+export { declaredContentMatches } from './subset-match.ts';

package/src/grafana/datasource.ts

@@ -20,9 +20,11 @@
 import { Resource } from 'alchemy';
 import * as Provider from 'alchemy/Provider';
 import * as grafana from '@distilled.cloud/grafana';
-import * as Data from 'effect/Data';
 import * as Effect from 'effect/Effect';
 import { type GrafanaSpec, grafanaHandlers } from './resource.ts';
+import { GrafanaSecretRefUnsetError, resolveSecretRefs } from './secret-refs.ts';
+
+export { GrafanaSecretRefUnsetError };
 
 export interface DatasourceProps {
   uid: string;
@@ -64,33 +66,9 @@ export interface GrafanaDatasource extends Resource<
 
 export const GrafanaDatasource = Resource<GrafanaDatasource>('Grafana.Datasource');
 
-/** A named secure-field env var is unset — a domain refusal, not a distilled error. */
-export class GrafanaSecretRefUnsetError extends Data.TaggedError('GrafanaSecretRefUnsetError')<{
-  readonly message: string;
-}> {}
-
 /** Reads every named env var fresh, inside the caller's effect (S24) — never at plan time. */
-const resolveSecureJsonData = (
-  refs: Record<string, string> | undefined,
-): Effect.Effect<Record<string, string> | undefined, GrafanaSecretRefUnsetError> =>
-  Effect.gen(function* () {
-    if (refs === undefined) return undefined;
-    const out: Record<string, string> = {};
-    for (const [field, envVar] of Object.entries(refs)) {
-      const raw = process.env[envVar];
-      if (raw === undefined || raw.trim() === '') {
-        return yield* Effect.fail(
-          new GrafanaSecretRefUnsetError({
-            message:
-              `${envVar} is unset. Export the value of secureJsonData.${field} there — ` +
-              'never as an Alchemy prop.',
-          }),
-        );
-      }
-      out[field] = raw.trim();
-    }
-    return out;
-  });
+const resolveSecureJsonData = (refs: Record<string, string> | undefined) =>
+  resolveSecretRefs(refs, (field) => `secureJsonData.${field}`);
 
 /** `exactOptionalPropertyTypes` means an undeclared field must be OMITTED, never sent as `undefined`. */
 const fields = (props: DatasourceProps) => ({

package/src/grafana/index.ts

@@ -6,16 +6,24 @@
  *   dashboard-model.ts, fake-grafana.ts) are internals a provider needs but a consumer should not
  *   depend on.
  *
- * `Grafana.Datasource`, `Grafana.Folder` and `Grafana.Dashboard` ship here. `Grafana.AlertRule`
- * and friends are still follow-up work on the same now-available SDK operations — see
- * docs/grafana.md and docs/grafana-folder-dashboard.md for what shipped and what is still open.
+ * `Grafana.Datasource`, `Grafana.Folder`, `Grafana.Dashboard`, `Grafana.ContactPoint`,
+ * `Grafana.MuteTiming`, `Grafana.MessageTemplate` and `Grafana.AlertRuleGroup` ship here.
+ * `Grafana.NotificationPolicy` — the singleton policy tree — is a stacked follow-up PR on the same
+ * SDK operations — see docs/grafana.md, docs/grafana-folder-dashboard.md and
+ * docs/grafana-alerting.md for what shipped and what is still open.
  */
+export {
+  type AlertRuleGroupAttributes,
+  type AlertRuleGroupProps,
+  type AlertRuleInput,
+  GrafanaAlertRuleGroup,
+  GrafanaAlertRuleGroupProvider,
+} from './alert-rule-group.ts';
 export {
   type DatasourceAttributes,
   type DatasourceProps,
   GrafanaDatasource,
   GrafanaDatasourceProvider,
-  GrafanaSecretRefUnsetError,
 } from './datasource.ts';
 export {
   type DashboardAttributes,
@@ -31,6 +39,25 @@ export {
   GrafanaFolderProvider,
   GrafanaFolderReparentError,
 } from './folder.ts';
+export {
+  type ContactPointAttributes,
+  type ContactPointProps,
+  GrafanaContactPoint,
+  GrafanaContactPointProvider,
+} from './contact-point.ts';
+export {
+  type MessageTemplateAttributes,
+  type MessageTemplateProps,
+  GrafanaMessageTemplate,
+  GrafanaMessageTemplateProvider,
+} from './message-template.ts';
+export {
+  type MuteTimingAttributes,
+  type MuteTimingProps,
+  GrafanaMuteTiming,
+  GrafanaMuteTimingProvider,
+} from './mute-timing.ts';
 export { GrafanaProvisionedObjectError } from './provisioned.ts';
+export { GrafanaSecretRefUnsetError } from './secret-refs.ts';
 export { type GrafanaTarget, grafanaCredentials } from './credentials.ts';
 export { grafanaProviders } from './providers.ts';

package/src/grafana/message-template.test.ts

@@ -0,0 +1,212 @@
+/**
+ * `Grafana.MessageTemplate` against a fake Grafana — the PUT-is-both-create-and-update route (no
+ * `routePostTemplate` exists), the foreign-provenance refusal, and version-carrying updates.
+ * Mirrors `message-template.ts`'s own file header.
+ */
+import { describe, expect, test } from 'bun:test';
+import * as Effect from 'effect/Effect';
+import { GrafanaProvisionedObjectError } from './alerting-provenance.ts';
+import { fakeFailure, fakeGrafana, fakeGrafanaLayer } from './fake-grafana.ts';
+import { spec } from './message-template.ts';
+import { grafanaOperations } from './resource.ts';
+
+const PATH = '/api/v1/provisioning/templates/slack-body';
+
+const liveJson = {
+  name: 'slack-body',
+  provenance: 'api',
+  template: '{{ define "slack-body" }}…{{ end }}',
+  version: '3',
+};
+const props = { name: 'slack-body', template: '{{ define "slack-body" }}…{{ end }}' };
+
+describe('spec.fetchLive', () => {
+  test('a live template decodes into typed attributes', async () => {
+    const fake = fakeGrafana((method, url) =>
+      method === 'GET' && url.pathname === PATH ? Response.json(liveJson) : fakeFailure(404, 'x'),
+    );
+    const live = await Effect.runPromise(
+      spec.fetchLive(props).pipe(Effect.provide(fakeGrafanaLayer(fake.fetch))),
+    );
+    expect(live !== undefined && spec.attributes(live, props)).toEqual({
+      name: 'slack-body',
+      provenance: 'api',
+      template: '{{ define "slack-body" }}…{{ end }}',
+    });
+    expect(fake.bodies[0]).toBeUndefined();
+  });
+
+  test('a 404 folds to undefined', async () => {
+    const fake = fakeGrafana(() => fakeFailure(404, 'template not found'));
+    const result = await Effect.runPromise(
+      spec.fetchLive(props).pipe(Effect.provide(fakeGrafanaLayer(fake.fetch))),
+    );
+    expect(result).toBeUndefined();
+  });
+
+  test('a 401 propagates — never folded to absent', async () => {
+    const fake = fakeGrafana(() => fakeFailure(401, 'bad token'));
+    const failure = await Effect.runPromise(
+      Effect.flip(spec.fetchLive(props).pipe(Effect.provide(fakeGrafanaLayer(fake.fetch)))),
+    );
+    expect(failure._tag).toBe('Unauthorized');
+  });
+});
+
+describe('create and update — the same PUT route', () => {
+  test('create sends no version — nothing has been read yet', async () => {
+    const fake = fakeGrafana((method, url) =>
+      method === 'PUT' && url.pathname === PATH ? Response.json(liveJson) : fakeFailure(404, 'x'),
+    );
+    await Effect.runPromise(spec.create(props).pipe(Effect.provide(fakeGrafanaLayer(fake.fetch))));
+    // ⛔ `name` is a URL path label (`/templates/{name}`), never part of the body — only
+    //   `template` (and, on update, `version`) travel in the JSON payload.
+    expect(fake.bodies[0]).toEqual({ template: props.template });
+  });
+
+  test('an api-provenance template updates and sends the live version for concurrency', async () => {
+    const changed = { name: 'slack-body', template: 'v2' };
+    const fake = fakeGrafana((method, url) => {
+      if (method === 'GET' && url.pathname === PATH) return Response.json(liveJson);
+      if (method === 'PUT' && url.pathname === PATH)
+        return Response.json({ ...liveJson, template: 'v2' });
+      return fakeFailure(500, 'unexpected request');
+    });
+    await Effect.runPromise(
+      grafanaOperations(spec)
+        .reconcile(changed)
+        .pipe(Effect.provide(fakeGrafanaLayer(fake.fetch))),
+    );
+    const put = fake.seen.findIndex((s) => s.method === 'PUT');
+    expect(fake.bodies[put]).toEqual({ template: 'v2', version: '3' });
+  });
+
+  test('reconcile is a noop when the declared template already matches what is live', async () => {
+    const fake = fakeGrafana((method, url) =>
+      method === 'GET' && url.pathname === PATH
+        ? Response.json(liveJson)
+        : fakeFailure(500, 'reconcile should not write when nothing changed'),
+    );
+    const after = await Effect.runPromise(
+      grafanaOperations(spec)
+        .reconcile(props)
+        .pipe(Effect.provide(fakeGrafanaLayer(fake.fetch))),
+    );
+    expect(after.name).toBe('slack-body');
+    expect(fake.seen.every((s) => s.method === 'GET')).toBe(true);
+  });
+});
+
+describe('foreign provenance refuses update and destroy', () => {
+  test('a file-provisioned template refuses update and sends no PUT', async () => {
+    const fileProvisioned = { ...liveJson, provenance: 'file' };
+    const fake = fakeGrafana((method, url) =>
+      method === 'GET' && url.pathname === PATH
+        ? Response.json(fileProvisioned)
+        : fakeFailure(500, 'no write should be attempted'),
+    );
+    const failure = await Effect.runPromise(
+      Effect.flip(
+        grafanaOperations(spec)
+          .reconcile({ name: 'slack-body', template: 'v2' })
+          .pipe(Effect.provide(fakeGrafanaLayer(fake.fetch))),
+      ),
+    );
+    expect(failure).toBeInstanceOf(GrafanaProvisionedObjectError);
+    expect(fake.seen.every((s) => s.method === 'GET')).toBe(true);
+  });
+
+  test('a file-provisioned template refuses destroy and sends no DELETE', async () => {
+    const fileProvisioned = { ...liveJson, provenance: 'file' };
+    const fake = fakeGrafana((method, url) =>
+      method === 'GET' && url.pathname === PATH
+        ? Response.json(fileProvisioned)
+        : fakeFailure(500, 'no DELETE should be attempted'),
+    );
+    const failure = await Effect.runPromise(
+      Effect.flip(
+        grafanaOperations(spec)
+          .destroy(props)
+          .pipe(Effect.provide(fakeGrafanaLayer(fake.fetch))),
+      ),
+    );
+    expect(failure).toBeInstanceOf(GrafanaProvisionedObjectError);
+    expect(fake.seen).toEqual([{ method: 'GET', path: PATH }]);
+  });
+
+  test('deletes a live, api-provenance template', async () => {
+    const fake = fakeGrafana((method, url) => {
+      if (method === 'GET' && url.pathname === PATH) return Response.json(liveJson);
+      if (method === 'DELETE' && url.pathname === PATH) return Response.json({});
+      return fakeFailure(500, 'unexpected request');
+    });
+    await Effect.runPromise(
+      grafanaOperations(spec)
+        .destroy(props)
+        .pipe(Effect.provide(fakeGrafanaLayer(fake.fetch))),
+    );
+    expect(fake.seen).toEqual([
+      { method: 'GET', path: PATH },
+      { method: 'DELETE', path: PATH },
+    ]);
+  });
+});
+
+describe('missing provenance fails closed', () => {
+  // ⛔ THE REGRESSION AN ADVERSARIAL REVIEW OF THIS PR FOUND — see contact-point.test.ts's own
+  //   copy of this block for the full account.
+  const noProvenanceField: Record<string, unknown> = { ...liveJson };
+  delete noProvenanceField.provenance;
+
+  test('a response with no provenance field at all refuses update', async () => {
+    const fake = fakeGrafana((method, url) =>
+      method === 'GET' && url.pathname === PATH
+        ? Response.json(noProvenanceField)
+        : fakeFailure(500, 'no write should be attempted'),
+    );
+    const failure = await Effect.runPromise(
+      Effect.flip(
+        grafanaOperations(spec)
+          .reconcile({ name: 'slack-body', template: 'v2' })
+          .pipe(Effect.provide(fakeGrafanaLayer(fake.fetch))),
+      ),
+    );
+    expect(failure).toBeInstanceOf(GrafanaProvisionedObjectError);
+    expect(failure.message).toContain('did not report a provenance');
+    expect(fake.seen.every((s) => s.method === 'GET')).toBe(true);
+  });
+
+  test('a response with no provenance field at all refuses destroy', async () => {
+    const fake = fakeGrafana((method, url) =>
+      method === 'GET' && url.pathname === PATH
+        ? Response.json(noProvenanceField)
+        : fakeFailure(500, 'no DELETE should be attempted'),
+    );
+    const failure = await Effect.runPromise(
+      Effect.flip(
+        grafanaOperations(spec)
+          .destroy(props)
+          .pipe(Effect.provide(fakeGrafanaLayer(fake.fetch))),
+      ),
+    );
+    expect(failure).toBeInstanceOf(GrafanaProvisionedObjectError);
+    expect(fake.seen).toEqual([{ method: 'GET', path: PATH }]);
+  });
+
+  test('an EXPLICIT empty-string provenance (ProvenanceNone) is writable', async () => {
+    const explicitlyNone = { ...liveJson, provenance: '' };
+    const fake = fakeGrafana((method, url) => {
+      if (method === 'GET' && url.pathname === PATH) return Response.json(explicitlyNone);
+      if (method === 'PUT' && url.pathname === PATH) {
+        return Response.json({ ...explicitlyNone, template: 'v2' });
+      }
+      return fakeFailure(500, 'unexpected request');
+    });
+    await Effect.runPromise(
+      grafanaOperations(spec)
+        .reconcile({ name: 'slack-body', template: 'v2' })
+        .pipe(Effect.provide(fakeGrafanaLayer(fake.fetch))),
+    );
+    expect(fake.seen.some((s) => s.method === 'PUT')).toBe(true);
+  });
+});

package/src/grafana/message-template.ts

@@ -0,0 +1,114 @@
+/**
+ * `Grafana.MessageTemplate` — one Grafana notification-template group, keyed by `name`.
+ *
+ * ⚠️ CREATE AND UPDATE ARE THE SAME WIRE CALL — MEASURED: `services/grafana.ts` has no
+ *   `routePostTemplate` at all, only `routePutTemplate` (`PUT /v1/provisioning/templates/{name}`,
+ *   upsert by name), `routeGetTemplate`/`routeGetTemplates` and `routeDeleteTemplate`. `spec.create`
+ *   and `spec.update` both call it — kept as two separate functions anyway (rather than omitting
+ *   `update` and letting them collapse into one) so the shared engine's `diff` reports a content
+ *   change as `update`, not the `replace` it would show for any resource whose `spec.update` is
+ *   undefined (`resource.ts`).
+ *
+ * ⛔ A FOREIGN-PROVENANCE TEMPLATE REFUSES EVERY UPDATE AND DESTROY — `alerting-provenance.ts`,
+ *   shared with `Grafana.ContactPoint`/`AlertRuleGroup`/`NotificationPolicy`; see that file's
+ *   header. `create` is never at risk: it only runs when `fetchLive` already found nothing.
+ *
+ * ⚠️ `version` IS SENT FOR OPTIMISTIC CONCURRENCY WHEN GRAFANA REPORTS ONE — `RoutePutTemplateRequest.
+ *   version`'s own doc comment: "Version of template to use for optimistic concurrency. Leave empty
+ *   to disable validation." Unlike `Grafana.Dashboard`'s 412, no live call confirms what error this
+ *   produces on a genuine mismatch (no live calls in this PR) — whatever typed error the SDK
+ *   declares for `routePutTemplate` is left uncaught either way, per the house rule against
+ *   folding a non-not-found error into absent.
+ *
+ * ⚠️ `X-Disable-Provenance` IS NEVER SET — same reasoning as `contact-point.ts`'s file header.
+ */
+import { Resource } from 'alchemy';
+import * as Provider from 'alchemy/Provider';
+import * as grafana from '@distilled.cloud/grafana';
+import * as Effect from 'effect/Effect';
+import {
+  type GrafanaProvisionedObjectError,
+  isForeignProvenance,
+  refuseIfForeignProvenance,
+} from './alerting-provenance.ts';
+import { type GrafanaSpec, grafanaHandlers } from './resource.ts';
+
+export interface MessageTemplateProps {
+  name: string;
+  /** The Go-template body, e.g. Grafana's own "Export as JSON/YAML" template text. */
+  template: string;
+}
+
+export interface MessageTemplateAttributes {
+  name: string;
+  template: string;
+  /** `""`/`"api"` (this family may write); anything else, INCLUDING `undefined` (Grafana didn't
+   *  report the field), refuses — see alerting-provenance.ts's "fails open" note. */
+  provenance: string | undefined;
+}
+
+export interface GrafanaMessageTemplate extends Resource<
+  'Grafana.MessageTemplate',
+  MessageTemplateProps,
+  MessageTemplateAttributes,
+  never
+> {}
+
+export const GrafanaMessageTemplate = Resource<GrafanaMessageTemplate>('Grafana.MessageTemplate');
+
+export const spec: GrafanaSpec<
+  MessageTemplateProps,
+  grafana.NotificationTemplate,
+  MessageTemplateAttributes,
+  | grafana.RouteGetTemplateError
+  | grafana.RoutePutTemplateError
+  | grafana.RouteDeleteTemplateError
+  | GrafanaProvisionedObjectError
+> = {
+  attributes: (live) => ({
+    name: live.name ?? '',
+    // ⛔ NEVER `?? ''` — see alerting-provenance.ts's "fails open" note.
+    provenance: live.provenance,
+    template: live.template ?? '',
+  }),
+  create: (props) => grafana.routePutTemplate({ name: props.name, template: props.template }),
+  destroy: (props, live) =>
+    Effect.gen(function* () {
+      if (isForeignProvenance(live.provenance)) {
+        return yield* refuseIfForeignProvenance(
+          'Grafana.MessageTemplate',
+          props.name,
+          live.provenance,
+        );
+      }
+      yield* grafana.routeDeleteTemplate({ name: props.name });
+    }),
+  fetchLive: (props) =>
+    grafana
+      .routeGetTemplate({ name: props.name })
+      .pipe(Effect.catchTag('NotFound', () => Effect.succeed(undefined))),
+  matches: (attributes, props) => attributes.template === props.template,
+  update: (props, live) =>
+    Effect.gen(function* () {
+      if (isForeignProvenance(live.provenance)) {
+        return yield* refuseIfForeignProvenance(
+          'Grafana.MessageTemplate',
+          props.name,
+          live.provenance,
+        );
+      }
+      yield* grafana.routePutTemplate({
+        name: props.name,
+        template: props.template,
+        ...(live.version === undefined ? {} : { version: live.version }),
+      });
+    }),
+};
+
+export const handlers = grafanaHandlers(spec);
+
+export const GrafanaMessageTemplateProvider = () =>
+  Provider.effect(
+    GrafanaMessageTemplate,
+    Effect.succeed(GrafanaMessageTemplate.Provider.of(handlers)),
+  );