@goodfellow-cms/gitlab 0.6.0 → 0.7.0

package/dist/index.d.ts

@@ -44,6 +44,13 @@ interface GitLabBackendOptions {
     project: string;
     webUrl: string;
   };
+  /** What's read at each commit, shared with the backends of the project's other branches (drafts), since commits never change. */
+  caches?: GitLabCaches;
+}
+/** Path → blob id for the editable files at each commit, and each blob's text, by id. */
+interface GitLabCaches {
+  trees: Map<string, Promise<Map<string, string>>>;
+  blobs: Map<string, Promise<string>>;
 }
 /**
  * The site's files on GitLab. Reads come from the commit `revision()` last
@@ -66,6 +73,7 @@ export declare class GitLabBackend implements GitBackend {
   private readonly branch;
   private readonly onSignOut;
   private pinned?;
+  private readonly caches;
   private readonly trees;
   private readonly blobs;
   constructor(options: GitLabBackendOptions);
@@ -98,6 +106,8 @@ export declare class GitLabBackend implements GitBackend {
   write(changes: FileChange[], { message, expectedRevision }: WriteOptions): Promise<{
     revision: string;
   }>;
+  /** Lists `revision`'s editable files as `before`'s with `changes` made, keeping the text written. */
+  private carryTree;
   history(path: string, { page, perPage }?: HistoryOptions): Promise<FileVersion[]>;
   readAt(path: string, revision: string): Promise<string | undefined>;
   changedPaths(from: string, to: string): Promise<string[]>;

package/dist/index.js

@@ -1,4 +1,4 @@
-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";
+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, withRateLimits } 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 = {}) {
@@ -699,6 +699,14 @@ const PAGE_SIZE = 100;
 const GRAPHQL_BATCH = 50;
 /** The color and section codes in GitLab's job logs. */
 const ANSI_CODES = new RegExp(`${String.fromCharCode(27)}\\[[\\d;]*[A-Za-z]`, "g");
+/** Git's id for a file's contents (the SHA-1 of `blob <size>\0` and them), as GitLab's tree lists it. */
+async function gitBlobId(bytes) {
+	const header = new TextEncoder().encode(`blob ${bytes.length}\0`);
+	const data = new Uint8Array(header.length + bytes.length);
+	data.set(header);
+	data.set(bytes, header.length);
+	return [...new Uint8Array(await crypto.subtle.digest("SHA-1", data))].map((byte) => byte.toString(16).padStart(2, "0")).join("");
+}
 /**
 * Whether a status says when the site is live. A job that only asks another
 * host to rebuild the site doesn't, and nor do the nightly update and the
@@ -733,8 +741,9 @@ var GitLabBackend = class GitLabBackend {
 	branch;
 	onSignOut;
 	pinned;
-	trees = /* @__PURE__ */ new Map();
-	blobs = /* @__PURE__ */ new Map();
+	caches;
+	trees;
+	blobs;
 	constructor(options) {
 		this.options = options;
 		this.api = options.api;
@@ -743,6 +752,12 @@ var GitLabBackend = class GitLabBackend {
 		this.user = options.user;
 		this.onSignOut = options.onSignOut;
 		this.pinned = options.revision;
+		this.caches = options.caches ?? {
+			trees: /* @__PURE__ */ new Map(),
+			blobs: /* @__PURE__ */ new Map()
+		};
+		this.trees = this.caches.trees;
+		this.blobs = this.caches.blobs;
 		this.pages = gitlabPages(this.api, options.project);
 		this.editors = gitlabEditors(this.api, options.project, this.branch, this.user.login);
 		this.contentOnly = options.contentOnly === true;
@@ -773,11 +788,40 @@ var GitLabBackend = class GitLabBackend {
 	/** Drafts on branches of the project, with merge requests for review. */
 	draftHost() {
 		const project = `/projects/${this.project}`;
+		const openRequests = (branch) => gitlabJson(this.api, `${project}/merge_requests?${new URLSearchParams({
+			source_branch: branch,
+			state: "opened"
+		})}`);
+		/**
+		* Asks people to review a merge request, by their usernames. GitLab's free
+		* plan takes one reviewer, so where it refuses them all, the first is asked.
+		*/
+		const askReviewers = async (iid, usernames) => {
+			const ids = [];
+			for (const username of usernames) {
+				const [found] = await gitlabJson(this.api, `/users?${new URLSearchParams({ username })}`).catch(() => []);
+				if (found) ids.push(found.id);
+			}
+			for (const reviewerIds of ids.length > 1 ? [ids, ids.slice(0, 1)] : [ids]) {
+				if (reviewerIds.length === 0) return;
+				if ((await gitlabRequest(this.api, `${project}/merge_requests/${iid}`, {
+					method: "PUT",
+					body: { reviewer_ids: reviewerIds },
+					allow: [
+						400,
+						403,
+						404,
+						422
+					]
+				})).ok) return;
+			}
+		};
 		return {
 			liveBranch: this.branch,
 			branchStore: (branch) => new GitLabBackend({
 				...this.options,
-				branch
+				branch,
+				caches: this.caches
 			}),
 			createBranch: async (branch, revision) => {
 				if ((await gitlabRequest(this.api, this.repo(`/branches?${new URLSearchParams({
@@ -809,7 +853,7 @@ var GitLabBackend = class GitLabBackend {
 				});
 				return (await gitlabJson(this.api, this.repo(`/branches?${query}`))).map((found) => found.name).filter((name) => name.startsWith(prefix));
 			},
-			openReview: async ({ branch, title, description }) => {
+			openReview: async ({ branch, title, description, reviewers = [] }) => {
 				const response = await gitlabRequest(this.api, `${project}/merge_requests`, {
 					method: "POST",
 					body: {
@@ -825,15 +869,33 @@ var GitLabBackend = class GitLabBackend {
 						409
 					]
 				});
-				if (response.ok) return { url: (await response.json()).web_url };
-				if (response.status !== 409) throw new DraftError("no-reviews", "This sign-in can't open merge requests on the site's project.");
+				let review;
+				if (response.ok) review = await response.json();
+				else if (response.status !== 409) throw new DraftError("no-reviews", "This sign-in can't open merge requests on the site's project.");
+				else {
+					[review] = await openRequests(branch);
+					if (!review) throw new GitApiError(409, "GitLab couldn't open the merge request.");
+				}
+				await askReviewers(review.iid, reviewers);
+				return { url: review.web_url };
+			},
+			listReviews: async (prefix) => {
 				const query = new URLSearchParams({
-					source_branch: branch,
-					state: "opened"
+					state: "opened",
+					per_page: "100"
+				});
+				return (await gitlabJson(this.api, `${project}/merge_requests?${query}`)).filter((request) => request.source_branch.startsWith(prefix)).map((request) => ({
+					branch: request.source_branch,
+					url: request.web_url,
+					title: request.title
+				}));
+			},
+			closeReview: async (branch) => {
+				for (const request of await openRequests(branch)) await gitlabRequest(this.api, `${project}/merge_requests/${request.iid}`, {
+					method: "PUT",
+					body: { state_event: "close" },
+					allow: [403, 404]
 				});
-				const [open] = await gitlabJson(this.api, `${project}/merge_requests?${query}`);
-				if (!open) throw new GitApiError(409, "GitLab couldn't open the merge request.");
-				return { url: open.web_url };
 			}
 		};
 	}
@@ -1026,6 +1088,7 @@ var GitLabBackend = class GitLabBackend {
 				}
 			});
 			this.pinned = commit.id;
+			if (commit.parent_ids?.length === 1 && commit.parent_ids[0] === expectedRevision) await this.carryTree(existing, commit.id, changes).catch(() => {});
 			return { revision: commit.id };
 		} catch (error) {
 			if (!(error instanceof GitApiError)) throw error;
@@ -1034,6 +1097,22 @@ var GitLabBackend = class GitLabBackend {
 			throw error;
 		}
 	}
+	/** Lists `revision`'s editable files as `before`'s with `changes` made, keeping the text written. */
+	async carryTree(before, revision, changes) {
+		if (this.trees.has(revision) || !globalThis.crypto?.subtle) return;
+		const tree = new Map(before);
+		for (const change of changes) {
+			if (!EDITABLE_FOLDERS.some((folder) => change.path.startsWith(`${folder}/`))) continue;
+			if ("delete" in change) {
+				tree.delete(change.path);
+				continue;
+			}
+			const id = await gitBlobId("bytes" in change ? change.bytes : new TextEncoder().encode(change.content));
+			tree.set(change.path, id);
+			if ("content" in change && !this.blobs.has(id)) this.blobs.set(id, Promise.resolve(change.content));
+		}
+		this.trees.set(revision, Promise.resolve(tree));
+	}
 	async history(path, { page = 1, perPage = 20 } = {}) {
 		const query = new URLSearchParams({
 			ref_name: this.pinned ?? await this.revision(),
@@ -1435,7 +1514,7 @@ function browserLocation() {
 function gitlab(options) {
 	const webUrl = (options.url ?? "https://gitlab.com").replace(/\/$/, "");
 	const apiUrl = `${webUrl}/api/v4`;
-	const fetcher = options.fetch ?? ((input, init) => globalThis.fetch(input, init));
+	const fetcher = withRateLimits(options.fetch ?? ((input, init) => globalThis.fetch(input, init)), { host: "GitLab" });
 	const storage = credentialStorage(`goodfellow:gitlab:${webUrl}:${options.project}`, options.storage);
 	const pending = credentialStorage(`goodfellow:gitlab:pending:${options.project}`, options.storage);
 	const location = () => options.location ?? browserLocation();

package/dist/testing.d.ts

@@ -28,6 +28,8 @@ export interface FakeGitLabOptions {
    * Pages: a commit status with no pipeline the project lists.
    */
   external?: boolean;
+  /** A paid plan, whose merge requests take several reviewers; the free plan takes one. */
+  premium?: boolean;
   /** The job the update runs in, which `addUpdateRun()` logs: `pages` by default, as in the starters, or a code project's `update`. */
   updateJob?: string;
   /** Groups the users belong to, which new projects can be created in. */

package/dist/testing.js

@@ -566,9 +566,28 @@ function fakeGitLab(options) {
 			const source = url.searchParams.get("source_branch");
 			return json(repo.reviews.filter((review) => review.state === "open" && (!source || review.branch === source)).map((review) => ({
 				iid: review.number,
+				title: review.title,
+				source_branch: review.branch,
 				web_url: `${webUrl}/${options.project}/-/merge_requests/${review.number}`
 			})));
 		}
+		const mergeRequest = rest.match(/^\/merge_requests\/(\d+)$/);
+		if (mergeRequest && request.method === "PUT") {
+			if (accessLevel < 30) return json({ message: "403 Forbidden" }, 403);
+			const review = repo.reviews.find((found) => found.number === Number(mergeRequest[1]));
+			if (!review) return json({ message: "404 Not found" }, 404);
+			const body = await request.json();
+			if (body.reviewer_ids) {
+				if (body.reviewer_ids.length > 1 && !options.premium) return json({ message: "Too many reviewers" }, 400);
+				const names = new Map([...accounts].map(([username, id]) => [id, username]));
+				review.reviewers = body.reviewer_ids.flatMap((id) => names.get(id) ?? []);
+			}
+			if (body.state_event === "close") review.state = "closed";
+			return json({
+				iid: review.number,
+				state: review.state === "open" ? "opened" : review.state
+			});
+		}
 		if (rest === "/repository/tree") {
 			const ref = url.searchParams.get("ref") ?? repo.defaultBranch;
 			const dir = url.searchParams.get("path") ?? "";
@@ -630,9 +649,11 @@ function fakeGitLab(options) {
 				name: body.author_name,
 				email: body.author_email
 			});
+			const parent = repo.commitAt(sha)?.parent;
 			return json({
 				id: sha,
-				message: body.commit_message
+				message: body.commit_message,
+				parent_ids: parent ? [parent] : []
 			}, 201);
 		}
 		if (rest === "/repository/commits" && request.method === "GET") {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@goodfellow-cms/gitlab",
-  "version": "0.6.0",
+  "version": "0.7.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.6.0"
+    "@goodfellow-cms/core": "0.7.0"
   },
   "devDependencies": {
     "@puckeditor/core": "0.23.0"