as suspected, autoSquash was meant only for the actual rebase operation

see next commit on how we realized this (hint: current impl is still broken)

Signed-off-by: Kipras Melnikovas <[email protected]>

Author: kiprasmel

apply.ts

@@ -26,14 +26,6 @@ export const apply: BranchSequencerBase = (args) =>
 		delayMsBetweenCheckouts: 0,
 		behaviorOfGetBranchBoundaries: BehaviorOfGetBranchBoundaries["parse-from-not-yet-applied-state"],
 		reverseCheckoutOrder: false,
-
-		/**
-		 * `apply` does not perform the rebase operation
-		 * and thus cannot fully modify local commit history,
-		 * thus `autoSquash` is disabled
-		 * (it would produce incorrect results otherwise).
-		 */
-		autoSquash: false,
 	}).then(
 		(ret) => (markThatApplied(args.pathToStackedRebaseDirInsideDotGit), ret) //
 	);

branchSequencer.ts

@@ -3,7 +3,7 @@ import assert from "assert";
 
 import Git from "nodegit";
 
-import { AutoSquash, getWantedCommitsWithBranchBoundariesOurCustomImpl } from "./git-stacked-rebase";
+import { getWantedCommitsWithBranchBoundariesOurCustomImpl } from "./git-stacked-rebase";
 
 import { createExecSyncInRepo } from "./util/execSyncInRepo";
 import { Termination } from "./util/error";
@@ -23,7 +23,6 @@ export type GetBranchesCtx = BranchRefs & {
 	rootLevelCommandName: string;
 	repo: Git.Repository;
 	pathToStackedRebaseTodoFile: string;
-	autoSquash: boolean;
 };
 export type SimpleBranchAndCommit = {
 	commitSHA: string | null;
@@ -118,8 +117,7 @@ const getBoundariesInclInitialWithSipleBranchTraversal: GetBoundariesInclInitial
 	getWantedCommitsWithBranchBoundariesOurCustomImpl(
 		argsBase.repo, //
 		argsBase.initialBranch,
-		argsBase.currentBranch,
-		argsBase.autoSquash
+		argsBase.currentBranch
 	).then((boundaries) =>
 		boundaries
 			.filter((b) => !!b.branchEnd?.length)
@@ -242,14 +240,6 @@ export type BranchSequencerArgs = BranchSequencerArgsBase & {
 	 *
 	 */
 	reverseCheckoutOrder: boolean;
-
-	/**
-	 * almost feels like it should default to `false`,
-	 * or even shouldn't be selectable here & always be `false`.
-	 *
-	 * TODO further investigation
-	 */
-	autoSquash: AutoSquash;
 };
 
 export type BranchSequencerBase = (args: BranchSequencerArgsBase) => Promise<void>;
@@ -270,8 +260,6 @@ export const branchSequencer: BranchSequencer = async ({
 	currentBranch,
 	//
 	reverseCheckoutOrder = false,
-	//
-	autoSquash,
 }) => {
 	const execSyncInRepo = createExecSyncInRepo(repo);
 
@@ -288,7 +276,6 @@ export const branchSequencer: BranchSequencer = async ({
 			rootLevelCommandName,
 			initialBranch,
 			currentBranch,
-			autoSquash,
 		})
 	).map((boundary) => {
 		boundary.branchEndFullName = boundary.branchEndFullName.map((x) => x.replace("refs/heads/", ""));

forcePush.ts

@@ -133,12 +133,4 @@ export const forcePush: BranchSequencerBase = (argsBase) =>
 		 * would solve this.
 		 */
 		reverseCheckoutOrder: true,
-
-		/**
-		 * `forcePush` does not perform the rebase operation
-		 * and thus cannot fully modify local commit history,
-		 * thus `autoSquash` is disabled
-		 * (it would produce incorrect results otherwise).
-		 */
-		autoSquash: false,
 	});

git-stacked-rebase.ts

@@ -307,17 +307,6 @@ export const gitStackedRebase = async (
 							"if-stacked-rebase-in-progress-then-parse-not-applied-state-otherwise-simple-branch-traverse"
 						],
 					reverseCheckoutOrder: false,
-
-					/**
-					 * `branchSequencer` does not perform the rebase operation
-					 * and thus cannot fully modify local commit history,
-					 * thus `autoSquash` is disabled
-					 * (it would produce incorrect results otherwise).
-					 *
-					 * TODO further investigation
-					 *
-					 */
-					autoSquash: false,
 				});
 			} else {
 				/**
@@ -862,31 +851,17 @@ export function removeUndefinedProperties<T, K extends keyof Partial<T>>(
 	);
 }
 
-/**
- * should commits with "squash!" and "fixup!" subjects be autosquashed.
- *
- * if an actual rebase operation is NOT being performed
- * (i.e. commits are not being rewritten),
- * then SHALL BE set to `false`.
- *
- * otherwise, should be configured in some way -- most likely
- * via the git config, and/or the CLI.
- *
- */
-export type AutoSquash = boolean;
-
 async function createInitialEditTodoOfGitStackedRebase(
 	repo: Git.Repository, //
 	initialBranch: Git.Reference,
 	currentBranch: Git.Reference,
 	pathToRebaseTodoFile: string,
-	autoSquash: AutoSquash,
+	autoSquash: boolean,
 	getCommitsWithBranchBoundaries: () => Promise<CommitAndBranchBoundary[]> = () =>
 		getWantedCommitsWithBranchBoundariesOurCustomImpl(
 			repo, //
 			initialBranch,
-			currentBranch,
-			autoSquash
+			currentBranch
 		)
 ): Promise<void> {
 	// .catch(logErr);
@@ -913,6 +888,10 @@ async function createInitialEditTodoOfGitStackedRebase(
 
 	noop(commitsWithBranchBoundaries);
 
+	if (autoSquash) {
+		await autosquash(repo, commitsWithBranchBoundaries);
+	}
+
 	const rebaseTodo = commitsWithBranchBoundaries
 		.map(({ commit, commitCommand, branchEnd }, i) => {
 			if (i === 0) {
@@ -1033,8 +1012,7 @@ export async function getWantedCommitsWithBranchBoundariesOurCustomImpl(
 	repo: Git.Repository, //
 	/** beginningBranch */
 	bb: Git.Reference,
-	currentBranch: Git.Reference,
-	autoSquash: boolean
+	currentBranch: Git.Reference
 ): Promise<CommitAndBranchBoundary[]> {
 	/**
 	 * BEGIN check e.g. fork & origin/fork
@@ -1101,20 +1079,7 @@ export async function getWantedCommitsWithBranchBoundariesOurCustomImpl(
 		)
 	);
 
-	const extended: CommitAndBranchBoundary[] = await extendCommitsWithBranchEnds(
-		repo,
-		bb,
-		currentBranch,
-		wantedCommits
-	);
-
-	if (!autoSquash) {
-		return extended;
-	}
-
-	await autosquash(repo, extended);
-
-	return extended;
+	return extendCommitsWithBranchEnds(repo, bb, currentBranch, wantedCommits);
 }
 
 noop(getWantedCommitsWithBranchBoundariesUsingNativeGitRebase);