@goodfellow-cms/gitlab 0.2.0 → 0.3.0

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-import { ConnectDomainOptions, DeployStatus, DnsRecord, FileChange, FileVersion, GitBackend, GitHost, GitUser, HistoryOptions, PagesDomains, SetupHost, SiteEditors, SiteUpdates, StorageLike, WriteOptions } from "@goodfellow-cms/core";
+import { ConnectDomainOptions, DeployStatus, DnsRecord, FileChange, FileVersion, GitBackend, GitHost, GitUser, HistoryOptions, PagesDomains, 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`. */
@@ -30,6 +30,8 @@ export declare class GitLabBackend implements GitBackend {
   readonly pages: PagesDomains;
   readonly editors: SiteEditors;
   readonly updates: SiteUpdates;
+  readonly drafts: SiteDrafts;
+  private readonly options;
   private readonly api;
   private readonly project;
   private readonly branch;
@@ -38,6 +40,8 @@ export declare class GitLabBackend implements GitBackend {
   private readonly trees;
   private readonly blobs;
   constructor(options: GitLabBackendOptions);
+  /** Drafts on branches of the project, with merge requests for review. */
+  private draftHost;
   private repo;
   revision(): Promise<string>;
   /** Every file in one folder at a commit, page by page. */
@@ -46,8 +50,12 @@ export declare class GitLabBackend implements GitBackend {
   private tree;
   private currentTree;
   read(path: string): Promise<string | undefined>;
+  /** Reads many text files in a few GraphQL requests rather than one request each. */
+  readFiles(paths: string[]): Promise<Map<string, string>>;
   readBytes(path: string): Promise<Uint8Array | undefined>;
   list(dir: string): Promise<string[]>;
+  /** GitLab's tree doesn't say how large files are, so they're asked for with GraphQL, in batches. */
+  fileSizes(dir: string): Promise<Map<string, number>>;
   private lastCommitFor;
   write(changes: FileChange[], { message, expectedRevision }: WriteOptions): Promise<{
     revision: string;

package/dist/index.js

@@ -1,4 +1,4 @@
-import { ConflictError, DomainError, EDITABLE_FOLDERS, EditorsError, GitApiError, SetupError, SignInError, UpdatesError, buildStepFor, credentialStorage, encodeBase64Bytes, findBuildCause, findUpdateResult } from "@goodfellow-cms/core";
+import { ConflictError, DomainError, DraftError, EDITABLE_FOLDERS, EditorsError, GitApiError, SetupError, SignInError, UpdatesError, branchDrafts, buildStepFor, credentialStorage, encodeBase64Bytes, findBuildCause, findUpdateResult } 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 = {}) {
@@ -427,6 +427,8 @@ function gitlabUpdates(api, project, branch, readAt) {
 //#endregion
 //#region src/backend.ts
 const PAGE_SIZE = 100;
+/** How many files one GraphQL request reads. */
+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");
 /**
@@ -434,11 +436,13 @@ const ANSI_CODES = new RegExp(`${String.fromCharCode(27)}\\[[\\d;]*[A-Za-z]`, "g
 * returned. Saves are single commits; each changed file carries the commit it
 * was last changed in, so GitLab refuses to overwrite anyone else's edits.
 */
-var GitLabBackend = class {
+var GitLabBackend = class GitLabBackend {
 	user;
 	pages;
 	editors;
 	updates;
+	drafts;
+	options;
 	api;
 	project;
 	branch;
@@ -447,6 +451,7 @@ var GitLabBackend = class {
 	trees = /* @__PURE__ */ new Map();
 	blobs = /* @__PURE__ */ new Map();
 	constructor(options) {
+		this.options = options;
 		this.api = options.api;
 		this.project = encodeURIComponent(options.project);
 		this.branch = options.branch;
@@ -455,6 +460,67 @@ var GitLabBackend = class {
 		this.pages = gitlabPages(this.api, options.project);
 		this.editors = gitlabEditors(this.api, options.project, this.branch, this.user.login);
 		this.updates = gitlabUpdates(this.api, options.project, this.branch, async (path) => this.readAt(path, this.pinned ?? await this.revision()));
+		this.drafts = branchDrafts(this, this.draftHost());
+	}
+	/** Drafts on branches of the project, with merge requests for review. */
+	draftHost() {
+		const project = `/projects/${this.project}`;
+		return {
+			liveBranch: this.branch,
+			branchStore: (branch) => new GitLabBackend({
+				...this.options,
+				branch
+			}),
+			createBranch: async (branch, revision) => {
+				if ((await gitlabRequest(this.api, this.repo(`/branches?${new URLSearchParams({
+					branch,
+					ref: revision
+				})}`), {
+					method: "POST",
+					allow: [400]
+				})).status === 400) throw new DraftError("exists", `There's already a draft called ${branch}.`);
+			},
+			deleteBranch: async (branch) => {
+				await gitlabRequest(this.api, this.repo(`/branches/${encodeURIComponent(branch)}`), {
+					method: "DELETE",
+					allow: [404]
+				});
+			},
+			mergeBase: async (branch) => {
+				const query = new URLSearchParams();
+				query.append("refs[]", this.branch);
+				query.append("refs[]", branch);
+				const response = await gitlabRequest(this.api, this.repo(`/merge_base?${query}`), { allow: [400, 404] });
+				if (!response.ok) throw new DraftError("not-found", `There's no draft ${branch}.`);
+				return (await response.json()).id;
+			},
+			openReview: async ({ branch, title, description }) => {
+				const response = await gitlabRequest(this.api, `${project}/merge_requests`, {
+					method: "POST",
+					body: {
+						source_branch: branch,
+						target_branch: this.branch,
+						title,
+						description,
+						remove_source_branch: true
+					},
+					allow: [
+						403,
+						404,
+						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.");
+				const query = new URLSearchParams({
+					source_branch: branch,
+					state: "opened"
+				});
+				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 };
+			}
+		};
 	}
 	repo(path) {
 		return `/projects/${this.project}/repository${path}`;
@@ -506,6 +572,39 @@ var GitLabBackend = class {
 		}
 		return blob;
 	}
+	/** Reads many text files in a few GraphQL requests rather than one request each. */
+	async readFiles(paths) {
+		const tree = await this.currentTree();
+		const wanted = paths.filter((path) => tree.has(path));
+		const fetch = wanted.filter((path) => !this.blobs.has(tree.get(path) ?? ""));
+		const ref = this.pinned ?? await this.revision();
+		for (let start = 0; start < fetch.length; start += GRAPHQL_BATCH) {
+			const batch = fetch.slice(start, start + GRAPHQL_BATCH);
+			const response = await gitlabJson(this.api, "/../graphql", {
+				method: "POST",
+				body: {
+					query: `query ($project: ID!, $ref: String!, $paths: [String!]!) {
+  project(fullPath: $project) { repository { blobs(ref: $ref, paths: $paths) { nodes { path rawTextBlob } } } }
+}`,
+					variables: {
+						project: decodeURIComponent(this.project),
+						ref,
+						paths: batch
+					}
+				}
+			});
+			for (const node of response.data?.project?.repository?.blobs?.nodes ?? []) {
+				const sha = tree.get(node.path);
+				if (sha && typeof node.rawTextBlob === "string") this.blobs.set(sha, Promise.resolve(node.rawTextBlob));
+			}
+		}
+		const result = /* @__PURE__ */ new Map();
+		for (const path of wanted) {
+			const text = await this.read(path);
+			if (text !== void 0) result.set(path, text);
+		}
+		return result;
+	}
 	async readBytes(path) {
 		const sha = (await this.currentTree()).get(path);
 		if (!sha) return void 0;
@@ -516,6 +615,32 @@ var GitLabBackend = class {
 		const prefix = `${dir}/`;
 		return [...(await this.currentTree()).keys()].filter((path) => path.startsWith(prefix)).sort();
 	}
+	/** GitLab's tree doesn't say how large files are, so they're asked for with GraphQL, in batches. */
+	async fileSizes(dir) {
+		const paths = await this.list(dir);
+		const ref = this.pinned ?? await this.revision();
+		const sizes = /* @__PURE__ */ new Map();
+		for (let start = 0; start < paths.length; start += GRAPHQL_BATCH) {
+			const response = await gitlabJson(this.api, "/../graphql", {
+				method: "POST",
+				body: {
+					query: `query ($project: ID!, $ref: String!, $paths: [String!]!) {
+  project(fullPath: $project) { repository { blobs(ref: $ref, paths: $paths) { nodes { path size } } } }
+}`,
+					variables: {
+						project: decodeURIComponent(this.project),
+						ref,
+						paths: paths.slice(start, start + GRAPHQL_BATCH)
+					}
+				}
+			});
+			for (const node of response.data?.project?.repository?.blobs?.nodes ?? []) {
+				const size = Number(node.size);
+				if (Number.isFinite(size)) sizes.set(node.path, size);
+			}
+		}
+		return sizes;
+	}
 	async lastCommitFor(path, ref) {
 		return (await gitlabJson(this.api, this.repo(`/files/${encodeURIComponent(path)}?ref=${ref}`))).last_commit_id;
 	}
@@ -970,6 +1095,7 @@ function gitlab(options) {
 	return {
 		name: "GitLab",
 		canRedirect: Boolean(options.clientId),
+		redirectAddressesListed: Boolean(options.clientId),
 		tokenLinks: [{
 			url: `${webUrl}/-/user_settings/personal_access_tokens?${new URLSearchParams({
 				name: "Goodfellow admin",

package/dist/testing.d.ts

@@ -65,6 +65,8 @@ export interface FakeCreatedProject {
   repo: FakeRepo;
 }
 export declare function fakeGitLab(options: FakeGitLabOptions): {
+  /** How many GraphQL requests read files, as `readFiles()` makes. */
+  readonly graphqlReads: number;
   /** The project's members by user id, invitations by email, and protected branches, which tests can change. */
   members: Map<number, FakeMember>;
   invitations: Map<string, number>;
@@ -122,7 +124,7 @@ export declare function fakeGitLab(options: FakeGitLabOptions): {
   /** The site's GitLab Pages, if it has them, which tests can change. */
   pages: FakeGitLabPages | undefined;
   requests: Request[];
-  commit: (changes: FileChange[], message: string, author?: string) => string;
+  commit: (changes: FileChange[], message: string, author?: string, branch?: string) => string;
   authorize: (authorizeUrl: string) => string;
   handle: (request: Request) => Promise<Response>;
   fetch: typeof fetch;

package/dist/testing.js

@@ -187,6 +187,7 @@ function fakeGitLab(options) {
 	const pipelineId = (sha) => [...pipelines.keys()].indexOf(sha) + 1;
 	const requests = [];
 	let counter = 0;
+	let graphqlReads = 0;
 	const created = /* @__PURE__ */ new Map();
 	const pages = options.pages ? {
 		uniqueDomain: options.pages.uniqueDomain ?? true,
@@ -330,9 +331,12 @@ function fakeGitLab(options) {
 		}
 		return json({ message: "404 Not Found" }, 404);
 	}
-	function commit(changes, message, author) {
-		const sha = repo.commit(changes, message, { author });
-		if (options.deployAfterChecks !== void 0) pipelines.set(sha, { checks: 0 });
+	function commit(changes, message, author, branch = repo.defaultBranch) {
+		const sha = repo.commit(changes, message, {
+			author,
+			branch
+		});
+		if (options.deployAfterChecks !== void 0 && branch === repo.defaultBranch) pipelines.set(sha, { checks: 0 });
 		return sha;
 	}
 	function issueTokens(user) {
@@ -390,6 +394,22 @@ function fakeGitLab(options) {
 			}
 			return json({ error: "unsupported_grant_type" }, 400);
 		}
+		if (url.pathname === "/api/graphql" && request.method === "POST") {
+			if (!tokens.has(request.headers.get("authorization")?.replace(/^Bearer /, "") ?? "")) return json({ message: "401 Unauthorized" }, 401);
+			const { variables } = await request.json();
+			if (variables.project !== options.project) return json({ data: { project: null } });
+			graphqlReads += 1;
+			const files = repo.files(variables.ref);
+			return json({ data: { project: { repository: { blobs: { nodes: variables.paths.flatMap((path) => {
+				const content = files.get(path);
+				if (content === void 0) return [];
+				return [{
+					path,
+					rawTextBlob: typeof content === "string" ? content : null,
+					size: String(fakeFileBytes(content).length)
+				}];
+			}) } } } } });
+		}
 		if (!url.pathname.startsWith("/api/v4/")) return json({ message: "404 Not Found" }, 404);
 		const user = tokens.get(request.headers.get("authorization")?.replace(/^Bearer /, "") ?? "");
 		if (!user) return json({ message: "401 Unauthorized" }, 401);
@@ -401,6 +421,14 @@ function fakeGitLab(options) {
 		});
 		const setup = await handleCreated(request, path, user);
 		if (setup) return setup;
+		if (path === "/projects" && request.method === "GET") {
+			const level = members.get(accounts.get(user.username) ?? 0)?.accessLevel ?? 0;
+			const min = Number(url.searchParams.get("min_access_level") ?? "0");
+			return json(level > 0 && level >= min ? [{
+				path_with_namespace: options.project,
+				default_branch: repo.defaultBranch
+			}] : []);
+		}
 		if (path === "/users") {
 			const name = url.searchParams.get("username") ?? "";
 			const id = [...accounts].find(([username]) => username.toLowerCase() === name.toLowerCase())?.[1];
@@ -425,11 +453,55 @@ function fakeGitLab(options) {
 			},
 			ci_push_repository_for_job_token_allowed: updateSettings.jobTokenPush
 		});
+		if (rest === "/repository/branches" && request.method === "POST") {
+			if (accessLevel < 30) return json({ message: "403 Forbidden" }, 403);
+			const name = url.searchParams.get("branch") ?? "";
+			const ref = url.searchParams.get("ref") ?? "";
+			if (repo.branches.has(name)) return json({ message: "Branch already exists" }, 400);
+			const sha = repo.branches.get(ref) ?? (repo.commitAt(ref) ? ref : void 0);
+			if (!sha) return json({ message: "Invalid reference name" }, 400);
+			repo.branches.set(name, sha);
+			return json({
+				name,
+				commit: { id: sha }
+			}, 201);
+		}
 		const branch = rest.match(/^\/repository\/branches\/(.+)$/);
+		if (branch && request.method === "DELETE") {
+			if (accessLevel < 30) return json({ message: "403 Forbidden" }, 403);
+			const name = decodeURIComponent(branch[1] ?? "");
+			if (!repo.branches.has(name)) return json({ message: "404 Branch Not Found" }, 404);
+			repo.branches.delete(name);
+			return new Response(null, { status: 204 });
+		}
 		if (branch) {
 			const sha = repo.branches.get(decodeURIComponent(branch[1] ?? ""));
 			return sha ? json({ commit: { id: sha } }) : json({ message: "404 Branch Not Found" }, 404);
 		}
+		if (rest === "/repository/merge_base") {
+			const refs = url.searchParams.getAll("refs[]").map((ref) => repo.branches.get(ref) ?? ref);
+			if (refs.length !== 2 || refs.some((ref) => !repo.commitAt(ref))) return json({ message: "Could not find ref" }, 400);
+			const base = repo.mergeBase(refs[0] ?? "", refs[1] ?? "");
+			return base ? json({ id: base }) : json({ message: "404 Not Found" }, 404);
+		}
+		if (rest === "/merge_requests" && request.method === "POST") {
+			if (accessLevel < 30) return json({ message: "403 Forbidden" }, 403);
+			const body = await request.json();
+			if (!repo.branches.has(body.source_branch) || !repo.branches.has(body.target_branch)) return json({ message: ["Source branch does not exist"] }, 422);
+			if (repo.reviews.some((review) => review.branch === body.source_branch && review.state === "open")) return json({ message: ["Another open merge request already exists for this source branch"] }, 409);
+			const review = repo.openReview(body.source_branch, body.title, body.description ?? "", body.target_branch);
+			return json({
+				iid: review.number,
+				web_url: `${webUrl}/${options.project}/-/merge_requests/${review.number}`
+			}, 201);
+		}
+		if (rest === "/merge_requests" && request.method === "GET") {
+			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,
+				web_url: `${webUrl}/${options.project}/-/merge_requests/${review.number}`
+			})));
+		}
 		if (rest === "/repository/tree") {
 			const ref = url.searchParams.get("ref") ?? repo.defaultBranch;
 			const dir = url.searchParams.get("path") ?? "";
@@ -487,7 +559,7 @@ function fakeGitLab(options) {
 				} : {
 					path: action.file_path,
 					content: action.content ?? ""
-				}), body.commit_message, user.name ?? user.username),
+				}), body.commit_message, user.name ?? user.username, body.branch),
 				message: body.commit_message
 			}, 201);
 		}
@@ -617,6 +689,10 @@ function fakeGitLab(options) {
 		return json({ message: "404 Not Found" }, 404);
 	}
 	return {
+		/** How many GraphQL requests read files, as `readFiles()` makes. */
+		get graphqlReads() {
+			return graphqlReads;
+		},
 		/** The project's members by user id, invitations by email, and protected branches, which tests can change. */
 		members,
 		invitations,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@goodfellow-cms/gitlab",
-  "version": "0.2.0",
+  "version": "0.3.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.2.0"
+    "@goodfellow-cms/core": "0.3.0"
   },
   "devDependencies": {
     "@puckeditor/core": "0.23.0"