@goodfellow-cms/gitlab 0.5.0 → 0.6.0

package/README.md

@@ -8,7 +8,7 @@ import { gitlab } from "@goodfellow-cms/gitlab";
 export default defineConfig({ blocks, backend: gitlab({ project: "your-name/your-site" }) });
 ```
 
-[Goodfellow](https://github.com/goodfellow-cms/goodfellow-cms) is a website builder for people who aren't developers, with no server or database: pages are files in your own GitHub or GitLab repository, edited in a visual editor built on [Puck](https://puckeditor.com). To start a new site, run `npm create goodfellow@latest my-site`. See the [documentation](https://goodfellow-cms.github.io/goodfellow-cms/) for everything else.
+[Goodfellow](https://github.com/goodfellow-cms/goodfellow-cms) is a website builder for people who aren't developers, with no server or database: pages are files in your own GitHub, GitLab or Bitbucket repository, edited in a visual editor built on [Puck](https://puckeditor.com). To start a new site, run `npm create goodfellow@latest my-site`. See the [documentation](https://goodfellow-cms.github.io/goodfellow-cms/) for everything else.
 
 More in the docs: [Hosts and business sites](https://goodfellow-cms.github.io/goodfellow-cms/docs/hosts).
 

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-import { ConnectDomainOptions, DeployStatus, DnsRecord, FileChange, FileVersion, GitBackend, GitHost, GitUser, HistoryOptions, PagesDomains, RepositoryVisibility, RevisionFiles, ScheduledBuilds, SetupHost, SiteDrafts, SiteEditors, SiteUpdates, StorageLike, WriteOptions } from "@goodfellow-cms/core";
+import { ConnectDomainOptions, DeployStatus, DnsRecord, FileChange, FileVersion, GitBackend, GitHost, GitUser, HistoryOptions, PagesDomains, PluginTasks, RepositoryVisibility, RevisionFiles, ScheduledBuilds, SetupHost, SiteDrafts, SiteEditors, SiteUpdates, StorageLike, WriteOptions } from "@goodfellow-cms/core";
 //#region src/api.d.ts
 interface ApiOptions {
   /** The API root, such as `https://gitlab.com/api/v4`. */
@@ -12,6 +12,15 @@ interface ApiOptions {
   fetch: typeof fetch;
 }
 //#endregion
+//#region src/tasks.d.ts
+interface GitLabTasksOptions {
+  /** How often to look for the answer, and how long to wait for it. */
+  pollMs?: number;
+  timeoutMs?: number;
+  /** Waits between looks; tests pass one that doesn't. */
+  wait?: (ms: number) => Promise<void>;
+}
+//#endregion
 //#region src/backend.d.ts
 interface GitLabBackendOptions {
   api: ApiOptions;
@@ -26,6 +35,8 @@ interface GitLabBackendOptions {
   };
   /** The commit reads see until `revision()` is next called, as a full-stack site's server reads what a browser loaded. */
   revision?: string;
+  /** How plugins' tasks wait for their answers; tests pass short waits. */
+  tasks?: GitLabTasksOptions;
   /** The project holds only the site's content, with its code in a project of its own (`GitBackend.contentOnly`). */
   contentOnly?: boolean;
   /** The code project, for a project that holds only content, where the site's updates run. */
@@ -47,6 +58,7 @@ export declare class GitLabBackend implements GitBackend {
   readonly updates?: SiteUpdates;
   readonly drafts: SiteDrafts;
   readonly scheduledBuilds: ScheduledBuilds;
+  readonly tasks: PluginTasks;
   readonly contentOnly: boolean;
   private readonly options;
   private readonly api;

package/dist/index.js

@@ -1,4 +1,4 @@
-import { ConflictError, DomainError, DraftError, EDITABLE_FOLDERS, EditorsError, GitApiError, NIGHTLY_VARIABLE, REBUILD_JOB, ScheduledBuildsError, SetupError, SignInError, UpdatesError, assertContentChanges, branchDrafts, buildStepFor, credentialStorage, encodeBase64Bytes, findBuildCause, findUpdateResult, hostSource } from "@goodfellow-cms/core";
+import { ConflictError, DomainError, DraftError, EDITABLE_FOLDERS, EditorsError, GitApiError, LOCKFILE_JOB, NIGHTLY_VARIABLE, PluginTaskError, REBUILD_JOB, ScheduledBuildsError, SetupError, SignInError, TASK_JOB, TASK_POLL_MS, TASK_RESULT_FILE, TASK_TIMEOUT_MS, UpdatesError, assertContentChanges, branchDrafts, buildStepFor, credentialStorage, encodeBase64Bytes, findBuildCause, findUpdateResult, hostSource, taskRequestProblem } from "@goodfellow-cms/core";
 //#region src/api.ts
 /** Calls the GitLab API. A 401 refreshes the token once; after that it means the sign-in has expired. */
 async function gitlabRequest(api, path, init = {}) {
@@ -411,6 +411,72 @@ function gitlabScheduledBuilds(api, project, branch, readCi, now = () => /* @__P
 	};
 }
 //#endregion
+//#region src/tasks.ts
+/**
+* Plugins' tasks on GitLab, through the starters' `plugin-task` job: a
+* pipeline started with the request's variables (`GOODFELLOW_TASK_PLUGIN` and
+* the rest), whose job leaves the sealed answer as its artifact, read here.
+* Starting pipelines on the main branch needs Developer access, which
+* editors have once `letEditorsPublish()` lets them publish.
+*/
+function gitlabTasks(api, project, branch, readSetup, options = {}) {
+	const base = `/projects/${encodeURIComponent(project)}`;
+	const wait = options.wait ?? ((ms) => new Promise((done) => setTimeout(done, ms)));
+	const supported = async () => (await readSetup().catch(() => void 0) ?? "").includes("$GOODFELLOW_TASK_PLUGIN");
+	return {
+		supported,
+		secretsPlace: async () => ({
+			kind: "gitlab",
+			url: `${api.apiUrl.replace(/\/api\/v4\/?$/, "")}/${project}/-/settings/ci_cd#js-cicd-variables-settings`
+		}),
+		async run(request) {
+			const problem = taskRequestProblem(request);
+			if (problem) throw new PluginTaskError("failed", problem);
+			if (!await supported()) throw new PluginTaskError("missing", "The site's setup files don't run plugins' tasks: .gitlab-ci.yml needs the plugin-task job.");
+			const variable = (key, value) => ({
+				key,
+				variable_type: "env_var",
+				value
+			});
+			let pipeline;
+			try {
+				pipeline = await gitlabJson(api, `${base}/pipeline`, {
+					method: "POST",
+					body: {
+						ref: branch,
+						variables: [
+							variable("GOODFELLOW_TASK_REQUEST", request.id),
+							variable("GOODFELLOW_TASK_PLUGIN", request.plugin),
+							variable("GOODFELLOW_TASK_NAME", request.task),
+							variable("GOODFELLOW_TASK_INPUT", request.input),
+							variable("GOODFELLOW_TASK_KEY", request.key)
+						]
+					}
+				});
+			} catch (error) {
+				if (error instanceof GitApiError && (error.status === 403 || error.status === 401)) throw new PluginTaskError("not-allowed", "Running plugins' tasks needs a sign-in that can publish to the site.");
+				throw error;
+			}
+			const deadline = Date.now() + (options.timeoutMs ?? TASK_TIMEOUT_MS);
+			for (;;) {
+				const job = (await gitlabJson(api, `${base}/pipelines/${pipeline.id}/jobs?per_page=100`)).find((candidate) => candidate.name === TASK_JOB);
+				if (job?.status === "success") {
+					const answer = await gitlabRequest(api, `${base}/jobs/${job.id}/artifacts/${TASK_RESULT_FILE}`, { allow: [404] });
+					if (answer.ok) return await answer.text();
+					throw new PluginTaskError("failed", "The site's build service ran the task but left no answer.");
+				}
+				if (job && [
+					"failed",
+					"canceled",
+					"skipped"
+				].includes(job.status)) throw new PluginTaskError("failed", "The site's build service couldn't run the task.");
+				if (Date.now() >= deadline) throw new PluginTaskError("timeout", "The site's build service didn't answer in time.");
+				await wait(options.pollMs ?? TASK_POLL_MS);
+			}
+		}
+	};
+}
+//#endregion
 //#region src/updates.ts
 const CI_FILE = ".gitlab-ci.yml";
 /** When the nightly schedule the Updates screen adds runs, in UTC, as the GitHub Pages workflow's does. */
@@ -635,11 +701,12 @@ const GRAPHQL_BATCH = 50;
 const ANSI_CODES = new RegExp(`${String.fromCharCode(27)}\\[[\\d;]*[A-Za-z]`, "g");
 /**
 * Whether a status says when the site is live. A job that only asks another
-* host to rebuild the site doesn't, and nor does the nightly update where
-* Cloudflare builds the site, which runs on the newest commit too.
+* host to rebuild the site doesn't, and nor do the nightly update and the
+* job that writes the lockfile where Cloudflare builds the site, which run
+* on the newest commit too.
 */
 function builds(status) {
-	return status.name !== REBUILD_JOB && status.name !== "update";
+	return status.name !== REBUILD_JOB && status.name !== "update" && status.name !== LOCKFILE_JOB;
 }
 function listFrom(tree, dir) {
 	const prefix = `${dir}/`;
@@ -658,6 +725,7 @@ var GitLabBackend = class GitLabBackend {
 	updates;
 	drafts;
 	scheduledBuilds;
+	tasks;
 	contentOnly;
 	options;
 	api;
@@ -696,6 +764,7 @@ var GitLabBackend = class GitLabBackend {
 		}
 		this.drafts = branchDrafts(this, this.draftHost());
 		this.scheduledBuilds = gitlabScheduledBuilds(this.api, options.project, this.branch, async () => this.readAt(".gitlab-ci.yml", this.pinned ?? await this.revision()));
+		this.tasks = gitlabTasks(this.api, options.project, this.branch, async () => this.readAt(".gitlab-ci.yml", this.pinned ?? await this.revision()), options.tasks);
 	}
 	async repositoryVisibility() {
 		const { visibility } = await gitlabJson(this.api, `/projects/${this.project}`);

package/dist/testing.d.ts

@@ -42,6 +42,12 @@ export interface FakeGitLabOptions {
   accounts?: string[];
   /** Who can see the project. Private by default. */
   visibility?: "public" | "internal" | "private";
+  /**
+   * Answers plugins' tasks, as the site's `plugin-task` job would: given each
+   * pipeline's task variables, it gives the text the job leaves as its
+   * artifact, or nothing for a job that fails. Without it, task pipelines fail.
+   */
+  tasks?: (variables: Record<string, string>) => string | undefined | Promise<string | undefined>;
 }
 /** A pipeline schedule, such as the nightly one or one the admin panel adds for a scheduled change. */
 export interface FakeSchedule {

package/dist/testing.js

@@ -173,6 +173,8 @@ function fakeGitLab(options) {
 		updateRuns.push(added);
 		return added;
 	}
+	/** Pipelines started for plugins' tasks, with their `plugin-task` job's artifact. */
+	const taskRuns = [];
 	/** Failed jobs, by commit, which tests add with `failBuild()` and `cancelBuild()`. */
 	const failures = /* @__PURE__ */ new Map();
 	/**
@@ -691,10 +693,25 @@ function fakeGitLab(options) {
 		})));
 		if (rest === "/pipeline" && request.method === "POST") {
 			if (accessLevel < 30) return json({ message: "403 Forbidden" }, 403);
+			const body = await request.json();
+			const variables = Object.fromEntries((body.variables ?? []).map(({ key, value }) => [key, value]));
+			if (variables.GOODFELLOW_TASK_PLUGIN) {
+				const id = 9e4 + taskRuns.length;
+				taskRuns.push({
+					id,
+					job: id + 5e4,
+					variables,
+					answer: await options.tasks?.(variables)
+				});
+				return json({
+					id,
+					status: "created"
+				}, 201);
+			}
 			const run = addUpdateRun({
 				source: "api",
 				status: "created",
-				variables: (await request.json()).variables
+				variables: body.variables
 			});
 			return json({
 				id: run.id,
@@ -787,6 +804,18 @@ function fakeGitLab(options) {
 			if (body.ci_push_repository_for_job_token_allowed !== void 0) updateSettings.jobTokenPush = body.ci_push_repository_for_job_token_allowed;
 			return json({ ci_push_repository_for_job_token_allowed: updateSettings.jobTokenPush });
 		}
+		const taskJobs = rest.match(/^\/pipelines\/(\d+)\/jobs$/);
+		const taskRun = taskJobs && taskRuns.find((candidate) => candidate.id === Number(taskJobs[1]));
+		if (taskRun) return json([{
+			id: taskRun.job,
+			name: "plugin-task",
+			status: taskRun.answer === void 0 ? "failed" : "success"
+		}]);
+		const artifact = rest.match(/^\/jobs\/(\d+)\/artifacts\/(.+)$/);
+		if (artifact) {
+			const run = taskRuns.find((candidate) => candidate.job === Number(artifact[1]));
+			return run?.answer !== void 0 && artifact[2] === "goodfellow-task-result.json" ? new Response(`${run.answer}\n`) : json({ message: "404 Not Found" }, 404);
+		}
 		const updateJobs = rest.match(/^\/pipelines\/(\d{4,})\/jobs$/);
 		if (updateJobs) {
 			const run = updateRuns.find((candidate) => candidate.id === Number(updateJobs[1]));

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@goodfellow-cms/gitlab",
-  "version": "0.5.0",
+  "version": "0.6.0",
   "description": "Edit a Goodfellow site stored on GitLab, straight from the browser.",
   "keywords": [
     "goodfellow",
@@ -35,7 +35,7 @@
     "dist"
   ],
   "dependencies": {
-    "@goodfellow-cms/core": "0.5.0"
+    "@goodfellow-cms/core": "0.6.0"
   },
   "devDependencies": {
     "@puckeditor/core": "0.23.0"