Merge pull request #132 from eglavin/git-log-consistency

refactor: set no-color and date-order opts when getting commits

Author: eglavin

src/services/__tests__/git.test.ts

@@ -1,4 +1,6 @@
 import { setupTest } from "../../../tests/setup-tests";
+import { IS_E2E } from "../../../tests/options";
+import { CommitParser } from "../../commit-parser/commit-parser";
 import { Git } from "../git";
 
 describe("git", () => {
@@ -402,7 +404,7 @@ system so we'll see what happens.`,
 		expect(email).toBe("");
 	});
 
-	it("should read commits with and any tags", async () => {
+	it("should read commits and tags", async () => {
 		const { config, create } = await setupTest("execute-file");
 		const git = new Git(config);
 
@@ -450,4 +452,95 @@ system so we'll see what happens.`,
 			expect(ref).toBe(" (tag: v1.0.0)");
 		}
 	});
+
+	it("should handle out of order commits", { timeout: 10_000, skip: !IS_E2E }, async () => {
+		const { config, create, execGit, sleep } = await setupTest("execute-file");
+		const git = new Git(config);
+
+		create.directory("src");
+		create.file("File 1 content", "src", "file1.txt").add();
+		await git.commit("-m", "feat: initial commit");
+		await git.tag("v1.0.0");
+
+		await sleep(1000);
+
+		// Create a long lived branch and commit to it, but don't merge it yet so that the commit is out of order in the git log
+		await execGit.raw("checkout", "-b", "long-lived-feature-branch");
+		create.file("File 2 content", "src", "file2.txt").add();
+		await git.commit("-m", "feat: add file2");
+		await execGit.raw("checkout", "main");
+
+		await sleep(1000);
+
+		// Create two short lived branches and merge them in quick succession to create out of order commits in the git log
+		await execGit.raw("checkout", "-b", "quick-feature-branch");
+		create.file("File 3 content", "src", "file3.txt").add();
+		await git.commit("-m", "feat: add file3");
+		await execGit.raw("checkout", "main");
+
+		await sleep(1000);
+
+		await execGit.raw("merge", "quick-feature-branch", "--no-ff");
+		await git.tag("v1.1.0");
+
+		await sleep(1000);
+
+		await execGit.raw("checkout", "-b", "quick-bugfix-branch");
+		create.file("File 4 content", "src", "file4.txt").add();
+		await git.commit("-m", "fix: add file4");
+		await execGit.raw("checkout", "main");
+
+		await sleep(1000);
+
+		await execGit.raw("merge", "quick-bugfix-branch", "--no-ff");
+		await git.tag("v1.1.1");
+
+		await sleep(1000);
+
+		// Merge the long lived branch last so that its commit is out of order in the git log
+		await execGit.raw("merge", "long-lived-feature-branch", "--no-ff");
+		await git.tag("v1.2.0");
+
+		const commits = await git.getCommits();
+
+		const commitParser = new CommitParser();
+		const parsedCommits = commits.map(commitParser.parseRawCommit);
+
+		expect(parsedCommits.length).toBe(7);
+		{
+			const { subject, refNames } = parsedCommits[0];
+			expect(subject).toBe("Merge branch 'long-lived-feature-branch'");
+			expect(refNames).toBe("(HEAD -> main, tag: v1.2.0)");
+		}
+		{
+			const { subject, refNames } = parsedCommits[1];
+			expect(subject).toBe("Merge branch 'quick-bugfix-branch'");
+			expect(refNames).toBe("(tag: v1.1.1)");
+		}
+		{
+			const { subject, refNames } = parsedCommits[2];
+			expect(subject).toBe("fix: add file4");
+			expect(refNames).toBe("(quick-bugfix-branch)");
+		}
+		{
+			const { subject, refNames } = parsedCommits[3];
+			expect(subject).toBe("Merge branch 'quick-feature-branch'");
+			expect(refNames).toBe("(tag: v1.1.0)");
+		}
+		{
+			const { subject, refNames } = parsedCommits[4];
+			expect(subject).toBe("feat: add file3");
+			expect(refNames).toBe("(quick-feature-branch)");
+		}
+		{
+			const { subject, refNames } = parsedCommits[5];
+			expect(subject).toBe("feat: add file2");
+			expect(refNames).toBe("(long-lived-feature-branch)");
+		}
+		{
+			const { subject, refNames } = parsedCommits[6];
+			expect(subject).toBe("feat: initial commit");
+			expect(refNames).toBe("(tag: v1.0.0)");
+		}
+	});
 });

src/services/git.ts

@@ -240,28 +240,25 @@ export class Git {
 	}
 
 	/**
-	 * `getTags` returns valid semver version tags in order of the commit history
+	 * Returns an array of tags from the git log, filtered by an optional tag prefix and pre-release configuration.
 	 *
-	 * Using `git log` to get the commit history, we then parse the tags from the
-	 * commit details which is expected to be in the following format:
-	 * ```txt
-	 * commit 3841b1d05750d42197fe958e3d8e06df378a842d (HEAD -> main, tag: v1.0.2, tag: v1.0.1, tag: v1.0.0)
-	 * Author: Username <username@example.com>
-	 * Date:   Sat Nov 9 15:00:00 2024 +0000
+	 * @example
+	 * ```ts
+	 * // Given the following git log: (HEAD -> main, tag: v1.0.2, tag: v1.0.1, tag: v1.0.0)
+	 * await git.getTags("v"); // ["v1.0.2", "v1.0.1", "v1.0.0"]
+	 *
+	 * // Given the following git log: (HEAD -> main, tag: v1.0.2-0, tag: v1.0.1-0, tag: v1.0.0)
+	 * await git.getTags("v", true); // ["v1.0.2-0", "v1.0.1-0", "v1.0.0"]
 	 *
-	 *     chore(release): v1.0.0
+	 * // Given the following git log: (HEAD -> main, tag: v1.0.2-alpha.0, tag: v1.0.1-alpha.0, tag: v1.0.0)
+	 * await git.getTags("v", "alpha"); // ["v1.0.2-alpha.0", "v1.0.1-alpha.0", "v1.0.0"]
 	 * ```
 	 *
 	 * - [Functionality extracted from the conventional-changelog - git-semver-tags project](https://github.com/conventional-changelog/conventional-changelog/blob/fac8045242099c016f5f3905e54e02b7d466bd7b/packages/git-semver-tags/index.js)
 	 * - [conventional-changelog git-semver-tags MIT Licence](https://github.com/conventional-changelog/conventional-changelog/blob/fac8045242099c016f5f3905e54e02b7d466bd7b/packages/git-semver-tags/LICENSE.md)
-	 *
-	 * @example
-	 * ```ts
-	 * await git.getTags("v"); // ["v1.0.2", "v1.0.1", "v1.0.0"]
-	 * ```
 	 */
 	async getTags(tagPrefix?: string, preRelease?: string | boolean): Promise<string[]> {
-		const logOutput = await this.log("--decorate", "--no-color", "--date-order");
+		const logOutput = await this.log("--format=%d", "--no-color", "--date-order");
 
 		/**
 		 * Search for tags in the following formats:
@@ -292,20 +289,22 @@ export class Git {
 	}
 
 	/**
-	 * Get commit history in a parsable format
+	 * Returns an array of commits between two git references (e.g., tags, branches, or commits), optionally filtered by file paths.
 	 *
-	 * An array of strings with commit details is returned in the following format:
+	 * Each commit in the returned array is a string containing the following information, separated by newlines:
 	 * ```txt
 	 * subject
 	 * body
 	 * hash
+	 * ref names
 	 * committer date
 	 * committer name
 	 * committer email
 	 * ```
 	 *
 	 * @example
 	 * ```ts
+	 * await git.getCommits("v1.0.0", "HEAD");
 	 * await git.getCommits("v1.0.0", "HEAD", "src/utils");
 	 * ```
 	 */
@@ -323,14 +322,16 @@ export class Git {
 			SCISSOR,
 		].join("%n");
 
-		const commits = await this.log(
+		const logOutput = await this.log(
 			`--format=${LOG_FORMAT}`,
+			"--no-color",
+			"--date-order",
 			[from, to].filter(Boolean).join(".."),
 			paths.length ? "--" : "",
 			...paths,
 		);
 
-		const splitCommits = commits.split(`\n${SCISSOR}\n`);
+		const splitCommits = logOutput.split(`\n${SCISSOR}\n`);
 
 		if (splitCommits.length === 0) {
 			return splitCommits;

tests/options.ts

@@ -0,0 +1,16 @@
+/**
+ * Environment option to disable brittle tests that may rely on timing, such as those that check commit order.
+ *
+ * To enable, set the environment variable `e2e` to "true" when running tests.
+ *
+ * @example
+ * ```bash
+ * e2e=true pnpm test
+ * ```
+ *
+ * @example
+ * ```pwsh
+ * $env:e2e="true"; pnpm test
+ * ```
+ */
+export const IS_E2E = process.env.e2e === "true";

tests/setup-tests.ts

@@ -239,5 +239,16 @@ export async function setupTest(testName: string, options?: Partial<ISetupTestOp
 				execSync(`git tag --annotate "${tag}" --message "${message}"`, execSyncOptions);
 			},
 		},
+
+		/**
+		 * Sleep for a specified number of milliseconds.
+		 * @example
+		 * ```js
+		 * await sleep(1000); // Sleep for 1 second
+		 * ```
+		 */
+		sleep: function _sleep(ms: number) {
+			return new Promise((resolve) => setTimeout(resolve, ms));
+		},
 	};
 }