Skip to content

Commit 30a7330

Browse files
fix(gitlab): follow the repository default merge request template (#19813)
Co-authored-by: Julius Marminge <[email protected]>
1 parent 6bcbb95 commit 30a7330

4 files changed

Lines changed: 202 additions & 2 deletions

File tree

‎apps/server/src/git/GitManager.test.ts‎

Lines changed: 140 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -282,6 +282,18 @@ function initRepo(
282282
});
283283
}
284284

285+
const makeGitLabTemplateProvider = Effect.fnUntraced(function* () {
286+
const git = yield* GitVcsDriver.GitVcsDriver;
287+
return yield* GitLabSourceControlProvider.make.pipe(
288+
Effect.provide(
289+
Layer.mergeAll(
290+
Layer.mock(GitLabCli.GitLabCli)({}),
291+
TestSourceControlHost.layer({ git: { execute: git.execute } }),
292+
),
293+
),
294+
);
295+
});
296+
285297
function createBareRemote(): Effect.Effect<
286298
string,
287299
PlatformError.PlatformError | GitCommandError,
@@ -2587,7 +2599,7 @@ it.layer(layerGitManagerTest)("GitManager", (it) => {
25872599
const provider = yield* GitLabSourceControlProvider.make.pipe(
25882600
Effect.provide(
25892601
GitLabCli.layer.pipe(
2590-
Layer.provide(
2602+
Layer.provideMerge(
25912603
TestSourceControlHost.layer({
25922604
process: {
25932605
run: (input) =>
@@ -5292,6 +5304,133 @@ it.layer(layerGitManagerTest)("GitManager", (it) => {
52925304
}),
52935305
);
52945306

5307+
it.effect.each([true, false])(
5308+
"generates GitLab MR content with followChangeRequestTemplates=%s",
5309+
(followChangeRequestTemplates) =>
5310+
Effect.gen(function* () {
5311+
const repoDir = yield* makeTempDir("t3code-git-manager-");
5312+
yield* initRepo(repoDir);
5313+
const templateDir = NodePath.join(repoDir, ".gitlab", "merge_request_templates");
5314+
NodeFS.mkdirSync(templateDir, { recursive: true });
5315+
NodeFS.writeFileSync(
5316+
NodePath.join(templateDir, "dEfAuLt.MD"),
5317+
" ## Summary\n\n## Testing\n",
5318+
);
5319+
NodeFS.writeFileSync(NodePath.join(templateDir, "Bugfix.md"), "Wrong sibling template");
5320+
yield* runGit(repoDir, ["add", ".gitlab"]);
5321+
yield* runGit(repoDir, ["commit", "-m", "Add merge request template"]);
5322+
yield* runGit(repoDir, ["checkout", "-b", "feature-gitlab-template"]);
5323+
const remoteDir = yield* createBareRemote();
5324+
yield* runGit(repoDir, ["remote", "add", "origin", remoteDir]);
5325+
NodeFS.writeFileSync(NodePath.join(templateDir, "dEfAuLt.MD"), "Wrong feature template");
5326+
yield* runGit(repoDir, ["add", ".gitlab"]);
5327+
yield* runGit(repoDir, ["commit", "-m", "Feature commit"]);
5328+
yield* runGit(repoDir, ["push", "-u", "origin", "feature-gitlab-template"]);
5329+
yield* runGit(repoDir, ["config", "branch.feature-gitlab-template.gh-merge-base", "main"]);
5330+
NodeFS.writeFileSync(
5331+
NodePath.join(templateDir, "dEfAuLt.MD"),
5332+
"Wrong uncommitted template",
5333+
);
5334+
const gitlab = yield* makeGitLabTemplateProvider();
5335+
const { service: fakeProvider } = createGitHubProviderWithFakeGh({
5336+
prListSequence: [
5337+
"[]",
5338+
JSON.stringify([
5339+
{
5340+
number: 7,
5341+
title: "Follow the GitLab template",
5342+
url: "https://gitlab.com/group/project/-/merge_requests/7",
5343+
baseRefName: "main",
5344+
headRefName: "feature-gitlab-template",
5345+
},
5346+
]),
5347+
],
5348+
});
5349+
let generatedChangeRequestTemplate: string | undefined;
5350+
5351+
const { manager } = yield* makeManager({
5352+
serverSettings: { sourceControlWritingStyle: { followChangeRequestTemplates } },
5353+
sourceControlProvider: {
5354+
...fakeProvider,
5355+
kind: SourceControlProviderKind.make("gitlab"),
5356+
readChangeRequestTemplate: gitlab.readChangeRequestTemplate!,
5357+
},
5358+
textGeneration: {
5359+
generatePrContent: (input) => {
5360+
generatedChangeRequestTemplate = input.changeRequestTemplate;
5361+
return Effect.succeed({ title: "Follow the GitLab template", body: "Body" });
5362+
},
5363+
},
5364+
});
5365+
const result = yield* runStackedAction(manager, { cwd: repoDir, action: "create_pr" });
5366+
5367+
expect(result.pr.status).toBe("created");
5368+
expect(generatedChangeRequestTemplate).toBe(
5369+
followChangeRequestTemplates ? "## Summary\n\n## Testing" : undefined,
5370+
);
5371+
}),
5372+
);
5373+
5374+
it.effect("ignores unavailable or non-regular GitLab default templates", () =>
5375+
Effect.gen(function* () {
5376+
const repoDir = yield* makeTempDir("t3code-git-manager-");
5377+
yield* initRepo(repoDir);
5378+
const provider = yield* makeGitLabTemplateProvider();
5379+
const readTemplate = (treeish = "HEAD") =>
5380+
provider.readChangeRequestTemplate!({ cwd: repoDir, treeish });
5381+
expect(yield* readTemplate()).toEqual(Option.none());
5382+
5383+
const templateDir = NodePath.join(repoDir, ".gitlab", "merge_request_templates");
5384+
const templatePath = ".gitlab/merge_request_templates/Default.md";
5385+
NodeFS.mkdirSync(templateDir, { recursive: true });
5386+
NodeFS.writeFileSync(NodePath.join(templateDir, "Bugfix.md"), "Not the default");
5387+
yield* runGit(repoDir, ["add", ".gitlab"]);
5388+
yield* runGit(repoDir, ["commit", "-m", "Add a selectable template"]);
5389+
expect(yield* readTemplate()).toEqual(Option.none());
5390+
5391+
NodeFS.writeFileSync(NodePath.join(repoDir, templatePath), " \n\n");
5392+
yield* runGit(repoDir, ["add", ".gitlab"]);
5393+
yield* runGit(repoDir, ["commit", "-m", "Add a blank default"]);
5394+
expect(yield* readTemplate()).toEqual(Option.none());
5395+
5396+
// Index modes exercise committed symlinks and submodules even on hosts without symlinks.
5397+
const { stdout: blob } = yield* runGit(repoDir, ["rev-parse", "HEAD:README.md"]);
5398+
yield* runGit(repoDir, ["update-index", "--cacheinfo", "120000", blob.trim(), templatePath]);
5399+
yield* runGit(repoDir, ["commit", "-m", "Replace default with a symlink"]);
5400+
expect(yield* readTemplate()).toEqual(Option.none());
5401+
5402+
const { stdout: commit } = yield* runGit(repoDir, ["rev-parse", "HEAD"]);
5403+
yield* runGit(repoDir, [
5404+
"update-index",
5405+
"--cacheinfo",
5406+
"160000",
5407+
commit.trim(),
5408+
templatePath,
5409+
]);
5410+
yield* runGit(repoDir, ["commit", "-m", "Replace default with a submodule"]);
5411+
expect(yield* readTemplate()).toEqual(Option.none());
5412+
expect(yield* readTemplate("missing-base")).toEqual(Option.none());
5413+
}),
5414+
);
5415+
5416+
it.effect("bounds GitLab template content and marks truncation", () =>
5417+
Effect.gen(function* () {
5418+
const repoDir = yield* makeTempDir("t3code-git-manager-");
5419+
yield* initRepo(repoDir);
5420+
const templateDir = NodePath.join(repoDir, ".gitlab", "merge_request_templates");
5421+
const prefix = "a".repeat(8_000);
5422+
NodeFS.mkdirSync(templateDir, { recursive: true });
5423+
NodeFS.writeFileSync(NodePath.join(templateDir, "Default.md"), prefix + "EXCLUDED_SUFFIX");
5424+
yield* runGit(repoDir, ["add", ".gitlab"]);
5425+
yield* runGit(repoDir, ["commit", "-m", "Add a large template"]);
5426+
const provider = yield* makeGitLabTemplateProvider();
5427+
5428+
expect(yield* provider.readChangeRequestTemplate!({ cwd: repoDir, treeish: "HEAD" })).toEqual(
5429+
Option.some(prefix + "\n\n[truncated]"),
5430+
);
5431+
}),
5432+
);
5433+
52955434
it.effect.each(["commit", "short-commit", "tag", "revision"] as const)(
52965435
"creates a PR against the default branch with a legacy %s base setting",
52975436
(kind) =>

‎packages/source-control-gitlab/src/server/GitLabSourceControlProvider.test.ts‎

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,13 +12,16 @@ import * as Layer from "effect/Layer";
1212
import * as Option from "effect/Option";
1313
import { ChildProcessSpawner } from "effect/process";
1414

15+
import * as TestSourceControlHost from "@t3tools/source-control-testing/TestSourceControlHost";
1516
import * as GitLabCli from "./GitLabCli.ts";
1617
import { parseGitLabAuthStatusHosts } from "./gitLabAuthStatus.ts";
1718
import * as GitLabSourceControlProvider from "./GitLabSourceControlProvider.ts";
1819

1920
function makeProvider(gitlab: Partial<GitLabCli.GitLabCli["Service"]>) {
2021
return GitLabSourceControlProvider.make.pipe(
21-
Effect.provide(Layer.mock(GitLabCli.GitLabCli)(gitlab)),
22+
Effect.provide(
23+
Layer.mergeAll(Layer.mock(GitLabCli.GitLabCli)(gitlab), TestSourceControlHost.layer()),
24+
),
2225
);
2326
}
2427

‎packages/source-control-gitlab/src/server/GitLabSourceControlProvider.ts‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,8 @@ import { SourceControlProviderError, type ChangeRequest } from "@t3tools/contrac
66
import { detectSourceControlProviderFromRemoteUrl } from "@t3tools/shared/sourceControl";
77

88
import * as GitLabCli from "./GitLabCli.ts";
9+
import * as GitLabChangeRequestTemplate from "./gitLabChangeRequestTemplate.ts";
10+
import * as SourceControlHost from "@t3tools/source-control-core/server/SourceControlHost";
911
import * as SourceControlProvider from "@t3tools/source-control-core/server/SourceControlProvider";
1012
import {
1113
combinedAuthOutput,
@@ -161,6 +163,7 @@ export const discovery = {
161163

162164
export const make = Effect.gen(function* () {
163165
const gitlab = yield* GitLabCli.GitLabCli;
166+
const { git } = yield* SourceControlHost.SourceControlHost;
164167

165168
const readLinkSubject = Effect.fn("GitLabSourceControlProvider.readLinkSubject")(function* (
166169
input: { readonly cwd: string; readonly url: URL },
@@ -202,6 +205,8 @@ export const make = Effect.gen(function* () {
202205

203206
return SourceControlProvider.SourceControlProvider.of({
204207
kind: SourceControlProviderKind.make("gitlab"),
208+
readChangeRequestTemplate: ({ cwd, treeish }) =>
209+
GitLabChangeRequestTemplate.detect(cwd, treeish, git.execute),
205210
refineRepositoryIdentity,
206211
resolveLink: (input) => {
207212
// Automatic enrichment must not send ambient CLI credentials to a host from message text.
Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
import * as Effect from "effect/Effect";
2+
import * as Option from "effect/Option";
3+
4+
import type * as SourceControlHost from "@t3tools/source-control-core/server/SourceControlHost";
5+
6+
const TEMPLATE_DIRECTORY = ".gitlab/merge_request_templates";
7+
const TEMPLATE_MAX_BYTES = 8_000;
8+
const TREE_LIST_MAX_BYTES = 100_000;
9+
const TRUNCATION_MARKER = "[truncated]";
10+
11+
type ExecuteGit = SourceControlHost.SourceControlHost["Service"]["git"]["execute"];
12+
13+
export const detect = Effect.fn("gitLabChangeRequestTemplate.detect")(
14+
function* (cwd: string, treeish: string, executeGit: ExecuteGit) {
15+
// Read committed regular blobs so symlinks never reach the host filesystem.
16+
const listing = yield* executeGit({
17+
operation: "gitLabChangeRequestTemplate.listTemplates",
18+
cwd,
19+
args: ["ls-tree", "-z", "--full-tree", treeish, "--", `${TEMPLATE_DIRECTORY}/`],
20+
maxOutputBytes: TREE_LIST_MAX_BYTES,
21+
appendTruncationMarker: true,
22+
});
23+
if (listing.stdoutTruncated) {
24+
return Option.none();
25+
}
26+
27+
const objectId = listing.stdout
28+
.split("\0")
29+
.map((record) => /^100(?:644|755) blob ([0-9a-f]{40,64})\t(.+)$/.exec(record))
30+
.find((entry) => entry?.[2]?.toLowerCase() === `${TEMPLATE_DIRECTORY}/default.md`)?.[1];
31+
if (!objectId) {
32+
return Option.none();
33+
}
34+
35+
const blob = yield* executeGit({
36+
operation: "gitLabChangeRequestTemplate.readTemplate",
37+
cwd,
38+
args: ["cat-file", "blob", objectId],
39+
maxOutputBytes: TEMPLATE_MAX_BYTES,
40+
appendTruncationMarker: true,
41+
});
42+
const template = blob.stdout.trim();
43+
if (template.length === 0) {
44+
return Option.none();
45+
}
46+
return Option.some(
47+
blob.stdoutTruncated && !template.endsWith(TRUNCATION_MARKER)
48+
? `${template}\n\n${TRUNCATION_MARKER}`
49+
: template,
50+
);
51+
},
52+
Effect.orElseSucceed(() => Option.none()),
53+
);

0 commit comments

Comments
 (0)