@effected/github-actions 0.13.0 → 0.13.2

package/DetachedProcess.js

@@ -1,4 +1,5 @@
-import { Effect, Schema } from "effect";
+import { unstubbed } from "./internal/unstubbed.js";
+import { Effect, Schedule, Schema } from "effect";
 import { HttpClient } from "effect/unstable/http";
 import { ChildProcessSpawner } from "effect/unstable/process";
 import { spawn } from "node:child_process";
@@ -116,9 +117,7 @@ const ProcessId = Schema.Number.pipe(Schema.check(Schema.makeFilter((value) => N
 /** Whether a thrown value is a Node errno error with the given code. */
 const isErrno = (cause, code) => typeof cause === "object" && cause !== null && cause.code === code;
 /** See {@link DetachedProcess.makeTestOps}: an unstubbed member dies naming itself. */
-const unimplemented = (member) => {
-	throw new Error(`DetachedProcess.makeTestOps: ${member}() was called but not stubbed — pass a \`${member}\` override.`);
-};
+const dies = unstubbed("DetachedProcess.makeTestOps");
 /**
 * A long-lived child that outlives the phase that started it.
 *
@@ -213,14 +212,11 @@ var DetachedProcess = class DetachedProcess {
 	* timeout six seconds later with nothing to show for it.
 	*/
 	static awaitReady = Effect.fn("DetachedProcess.awaitReady")(function* (probe, options) {
-		const interval = options?.interval ?? "150 millis";
-		const attempts = options?.attempts ?? 40;
-		const poll = (remaining) => Effect.flatMap(probe, (ready) => {
-			if (ready) return Effect.void;
-			if (remaining <= 0) return Effect.fail(new DetachedNotReadyError({}));
-			return Effect.flatMap(Effect.sleep(interval), () => poll(remaining - 1));
-		});
-		return yield* poll(attempts);
+		if (!(yield* Effect.repeat(probe, {
+			schedule: Schedule.spaced(options?.interval ?? "150 millis"),
+			times: options?.attempts ?? 40,
+			until: (answer) => answer
+		}))) return yield* Effect.fail(new DetachedNotReadyError({}));
 	});
 	/**
 	* A readiness probe over HTTP: `true` when a `GET` answers 2xx.
@@ -310,9 +306,9 @@ var DetachedProcess = class DetachedProcess {
 	* production form signals a real pid.
 	*/
 	static makeTestOps = (overrides = {}) => ({
-		spawn: () => Effect.sync(() => unimplemented("spawn")),
-		awaitReady: () => Effect.sync(() => unimplemented("awaitReady")),
-		reap: () => Effect.sync(() => unimplemented("reap")),
+		spawn: () => dies("spawn"),
+		awaitReady: () => dies("awaitReady"),
+		reap: () => dies("reap"),
 		...overrides
 	});
 };

package/DryRun.js

@@ -32,15 +32,6 @@ const make = (enabled) => ({
 * @public
 */
 var DryRun = class DryRun extends Context.Service()("@effected/github-actions/DryRun") {
-	/**
-	* Driven by the `dry-run` action input, defaulting to a real run.
-	*
-	* @remarks
-	* Fails with a `ConfigError` when the input is present but is not a YAML 1.2
-	* core-schema boolean — a workflow that writes `dry-run: yes` should stop,
-	* not quietly perform the mutations it meant to rehearse.
-	*/
-	static layer = Layer.effect(this, Effect.map(ActionInput.boolean(DEFAULT_INPUT).pipe(Config.withDefault(false)), make));
 	/**
 	* Driven by a named input.
 	*
@@ -50,6 +41,15 @@ var DryRun = class DryRun extends Context.Service()("@effected/github-actions/Dr
 	* composition site.
 	*/
 	static layerFromInput = (name) => Layer.effect(DryRun, Effect.map(ActionInput.boolean(name).pipe(Config.withDefault(false)), make));
+	/**
+	* Driven by the `dry-run` action input, defaulting to a real run.
+	*
+	* @remarks
+	* Fails with a `ConfigError` when the input is present but is not a YAML 1.2
+	* core-schema boolean — a workflow that writes `dry-run: yes` should stop,
+	* not quietly perform the mutations it meant to rehearse.
+	*/
+	static layer = DryRun.layerFromInput(DEFAULT_INPUT);
 	/** Driven by an explicit decision the caller has already made. */
 	static layerFrom = (enabled) => Layer.succeed(DryRun, make(enabled));
 	/**

package/GitHubMarkdown.js

@@ -159,12 +159,12 @@ var GitHubMarkdown = class GitHubMarkdown {
 		const columns = Object.keys(schema.fields).map((key) => {
 			const field = schema.fields[key];
 			const column = overrides[key];
-			const format = column?.format;
-			const encode = format === void 0 ? Schema.encodeSync(field) : void 0;
+			const encode = Schema.encodeSync(field);
+			const project = column?.format ?? ((value) => encode(value) ?? "");
 			return {
 				key,
 				header: column?.header ?? SchemaAST.resolveTitle(field.ast) ?? key,
-				cell: (value) => value === void 0 ? "" : format !== void 0 ? format(value) : encode?.(value) ?? ""
+				cell: (value) => value === void 0 ? "" : project(value)
 			};
 		});
 		const headers = columns.map((column) => column.header);

package/GitHubToken.js

@@ -160,7 +160,7 @@ var GitHubToken = class GitHubToken {
 	static read = Effect.fn("GitHubToken.read")(function* (options = {}) {
 		const token = yield* (yield* ActionState).get(options.stateKey ?? DEFAULT_KEY, InstallationToken);
 		const now = yield* DateTime.now;
-		if (options.skew === void 0 ? token.isExpired(DateTime.toEpochMillis(now)) : token.isExpired(DateTime.toEpochMillis(now), options.skew)) return yield* Effect.fail(new GitHubTokenError({
+		if (token.isExpired(DateTime.toEpochMillis(now), options.skew)) return yield* Effect.fail(new GitHubTokenError({
 			reason: "expired",
 			expiresAt: DateTime.formatIso(token.expiresAt)
 		}));

package/ManagedDocument.js

@@ -83,6 +83,12 @@ const STRUCTURAL_KIND = {
 	overlappingSections: "overlappingRegions",
 	duplicateSection: "duplicateRegion"
 };
+/** A structurally corrupt region layout, in this surface's vocabulary. */
+const structural = (failure) => new ManagedDocumentError({
+	kind: STRUCTURAL_KIND[failure.reason],
+	line: failure.line,
+	...failure.key === void 0 ? {} : { key: failure.key }
+});
 /**
 * A marker-delimited document: named regions a tool owns, inside text a human
 * may also edit.
@@ -145,21 +151,12 @@ var ManagedDocument = class ManagedDocument extends Schema.Class("ManagedDocumen
 	* a silent choice would destroy content a human wrote.
 	*/
 	static parseResult(source) {
-		const text = source.text ?? "";
-		const scanned = SectionDocument.parseResult(text, REGION_DIALECT);
-		if (Result.isFailure(scanned)) {
-			const failure = scanned.failure;
-			return Result.fail(new ManagedDocumentError({
-				kind: STRUCTURAL_KIND[failure.reason],
-				line: failure.line,
-				...failure.key === void 0 ? {} : { key: failure.key }
-			}));
-		}
-		return Result.succeed(ManagedDocument.make({
+		const document = ManagedDocument.make({
 			namespace: source.namespace,
 			key: source.key,
-			text
-		}));
+			text: source.text ?? ""
+		});
+		return Result.map(Result.mapError(document.scan(), structural), () => document);
 	}
 	/**
 	* Read a document out of existing text, in `Effect`.
@@ -179,8 +176,7 @@ var ManagedDocument = class ManagedDocument extends Schema.Class("ManagedDocumen
 	}
 	/** The content of one region, if the document carries it. */
 	region(key) {
-		const found = this.ownRegions().find((entry) => entry.key === key);
-		return found === void 0 ? Option.none() : Option.some(found.content);
+		return Option.map(this.entry(key), (found) => found.content);
 	}
 	/**
 	* One region's content and metadata together, if the document carries it.
@@ -235,15 +231,8 @@ var ManagedDocument = class ManagedDocument extends Schema.Class("ManagedDocumen
 	* surfacing in the typed channel.
 	*/
 	withRegionsResult(entries) {
-		const parsed = SectionDocument.parseResult(this.text, REGION_DIALECT);
-		if (Result.isFailure(parsed)) {
-			const failure = parsed.failure;
-			return Result.fail(new ManagedDocumentError({
-				kind: STRUCTURAL_KIND[failure.reason],
-				line: failure.line,
-				...failure.key === void 0 ? {} : { key: failure.key }
-			}));
-		}
+		const parsed = this.scan();
+		if (Result.isFailure(parsed)) return Result.fail(structural(parsed.failure));
 		const declared = entries.map(([key, content, meta]) => SectionId.make({
 			key: this.wireKey(key),
 			commentStyle: CommentStyle.html
@@ -275,14 +264,22 @@ var ManagedDocument = class ManagedDocument extends Schema.Class("ManagedDocumen
 	withRegions(entries) {
 		return Effect.fromResult(this.withRegionsResult(entries));
 	}
+	#scanned;
+	scan() {
+		this.#scanned ??= SectionDocument.parseResult(this.text, REGION_DIALECT);
+		return this.#scanned;
+	}
+	/** What every wire key of this document's regions begins with. */
+	get wirePrefix() {
+		return `${this.namespace}.${this.key}.`;
+	}
 	/** The marker key a region is written under: `namespace.key.region`. */
 	wireKey(region) {
-		return `${this.namespace}.${this.key}.${region}`;
+		return `${this.wirePrefix}${region}`;
 	}
 	/** The region key back out of a wire key, for error reporting. */
 	regionKeyOf(wireKey) {
-		const prefix = `${this.namespace}.${this.key}.`;
-		return wireKey.startsWith(prefix) ? wireKey.slice(prefix.length) : wireKey;
+		return wireKey.startsWith(this.wirePrefix) ? wireKey.slice(this.wirePrefix.length) : wireKey;
 	}
 	/**
 	* This document's own regions, in document order.
@@ -296,9 +293,9 @@ var ManagedDocument = class ManagedDocument extends Schema.Class("ManagedDocumen
 	* never reported.
 	*/
 	ownRegions() {
-		const parsed = SectionDocument.parseResult(this.text, REGION_DIALECT);
+		const parsed = this.scan();
 		if (Result.isFailure(parsed)) return [];
-		const prefix = `${this.namespace}.${this.key}.`;
+		const prefix = this.wirePrefix;
 		return parsed.success.sections.filter((placed) => placed.section.key.startsWith(prefix)).map((placed) => ({
 			key: placed.section.key.slice(prefix.length),
 			content: placed.section.content,

package/OidcTokenIssuer.js

@@ -1,6 +1,8 @@
 import { ActionEnvironment } from "./ActionEnvironment.js";
+import { unstubbed } from "./internal/unstubbed.js";
+import { payloadOf, unsignedJwt } from "./internal/jwt.js";
 import { Context, Effect, Layer, Redacted, Schema } from "effect";
-import { HttpClient } from "effect/unstable/http";
+import { HttpClient, HttpClientRequest } from "effect/unstable/http";
 import * as HttpClientResponse from "effect/unstable/http/HttpClientResponse";
 
 //#region src/OidcTokenIssuer.ts
@@ -89,18 +91,6 @@ const TokenEnvelope = Schema.Struct({
 const REQUEST_TOKEN = "ACTIONS_ID_TOKEN_REQUEST_TOKEN";
 const REQUEST_URL = "ACTIONS_ID_TOKEN_REQUEST_URL";
 /**
-* Decode a JWT payload segment.
-*
-* @remarks
-* `base64url` states the intent, though it is not what makes this work: Node's
-* plain `base64` decoder happens to accept the url alphabet and unpadded input
-* too (probed at beta.101), so the two are interchangeable *here*. They are not
-* interchangeable everywhere — `atob` is not forgiving — which is why the
-* declaration is the strict one and there is a test whose payload actually
-* contains `-` and `_`.
-*/
-const decodeSegment = (segment) => JSON.parse(Buffer.from(segment, "base64url").toString("utf8"));
-/**
 * Read the claims out of a JWT **without verifying its signature**.
 *
 * @remarks
@@ -108,20 +98,14 @@ const decodeSegment = (segment) => JSON.parse(Buffer.from(segment, "base64url").
 * {@link OidcTokenIssuerShape.claims}; do not "fix" it here.
 */
 const readClaims = (token) => Effect.gen(function* () {
-	const parts = token.split(".");
-	const payload = parts[1];
-	if (parts.length !== 3 || payload === void 0 || payload === "") return yield* Effect.fail(new OidcTokenError({
+	const decoded = yield* Effect.fromResult(payloadOf(token)).pipe(Effect.mapError((failure) => failure.kind === "segments" ? new OidcTokenError({
 		reason: "malformedToken",
-		detail: `expected three segments, got ${parts.length}`
-	}));
-	const decoded = yield* Effect.try({
-		try: () => decodeSegment(payload),
-		catch: (cause) => new OidcTokenError({
-			reason: "malformedToken",
-			detail: "the payload is not base64url JSON",
-			cause
-		})
-	});
+		detail: failure.detail
+	}) : new OidcTokenError({
+		reason: "malformedToken",
+		detail: failure.detail,
+		cause: failure.cause
+	})));
 	return yield* Schema.decodeUnknownEffect(OidcClaims)(decoded).pipe(Effect.mapError((cause) => new OidcTokenError({
 		reason: "missingClaims",
 		cause
@@ -150,10 +134,7 @@ const make = Effect.gen(function* () {
 		const bearer = yield* required(REQUEST_TOKEN);
 		const base = yield* required(REQUEST_URL);
 		const url = audience === void 0 ? base : `${base}&audience=${encodeURIComponent(audience)}`;
-		const response = yield* http.get(url, { headers: {
-			authorization: `Bearer ${bearer}`,
-			accept: "application/json"
-		} }).pipe(Effect.mapError((cause) => new OidcTokenError({
+		const response = yield* http.execute(HttpClientRequest.get(url).pipe(HttpClientRequest.bearerToken(bearer), HttpClientRequest.acceptJson)).pipe(Effect.mapError((cause) => new OidcTokenError({
 			reason: "requestFailed",
 			cause
 		})));
@@ -173,9 +154,7 @@ const make = Effect.gen(function* () {
 		})
 	};
 });
-const unimplemented = (member) => {
-	throw new Error(`OidcTokenIssuer.makeTest: ${member}() was called but not stubbed — pass a \`${member}\` override.`);
-};
+const dies = unstubbed("OidcTokenIssuer.makeTest");
 /**
 * The runner's OIDC token service.
 *
@@ -211,17 +190,14 @@ var OidcTokenIssuer = class OidcTokenIssuer extends Context.Service()("@effected
 	* provenance path structurally unreachable in the source package, drawing
 	* four separate apologetic comments from one consumer.
 	*/
-	static unsignedTokenFor = (claims) => {
-		const segment = (value) => Buffer.from(JSON.stringify(value), "utf8").toString("base64url");
-		return Redacted.make(`${segment({
-			alg: "RS256",
-			typ: "JWT"
-		})}.${segment(Schema.encodeUnknownSync(OidcClaims)(claims))}.unsigned`);
-	};
+	static unsignedTokenFor = (claims) => Redacted.make(unsignedJwt({
+		alg: "RS256",
+		typ: "JWT"
+	}, Schema.encodeUnknownSync(OidcClaims)(claims)));
 	/** A test double. Unstubbed members die rather than answering with a non-token. */
 	static makeTest = (overrides = {}) => ({
-		token: () => Effect.sync(() => unimplemented("token")),
-		claims: () => Effect.sync(() => unimplemented("claims")),
+		token: () => dies("token"),
+		claims: () => dies("claims"),
 		...overrides
 	});
 	/** {@link OidcTokenIssuer.makeTest} behind `Layer.succeed`. */