mhutchie#390 Display a new dialog when adding a tag with a name that already exists, allowing the user to force-add the tag.

Author: mhutchie

src/config.ts

@@ -24,7 +24,8 @@ import {
 	ReferenceLabelsConfig,
 	RepoDropdownOrder,
 	SquashMessageFormat,
-	TabIconColourTheme
+	TabIconColourTheme,
+	TagType
 } from './types';
 
 const VIEW_COLUMN_MAPPING: { [column: string]: vscode.ViewColumn } = {
@@ -176,7 +177,7 @@ class Config {
 		return {
 			addTag: {
 				pushToRemote: !!this.config.get('dialog.addTag.pushToRemote', false),
-				type: this.config.get<string>('dialog.addTag.type', 'Annotated') === 'Lightweight' ? 'lightweight' : 'annotated'
+				type: this.config.get<string>('dialog.addTag.type', 'Annotated') === 'Lightweight' ? TagType.Lightweight : TagType.Annotated
 			},
 			applyStash: {
 				reinstateIndex: !!this.config.get('dialog.applyStash.reinstateIndex', false)

src/dataSource.ts

@@ -6,7 +6,7 @@ import * as vscode from 'vscode';
 import { AskpassEnvironment, AskpassManager } from './askpass/askpassManager';
 import { getConfig } from './config';
 import { Logger } from './logger';
-import { CommitOrdering, DateType, DeepWriteable, ErrorInfo, GitCommit, GitCommitDetails, GitCommitStash, GitConfigLocation, GitFileChange, GitFileStatus, GitPushBranchMode, GitRepoConfig, GitRepoConfigBranches, GitResetMode, GitSignatureStatus, GitStash, MergeActionOn, RebaseActionOn, SquashMessageFormat, Writeable } from './types';
+import { CommitOrdering, DateType, DeepWriteable, ErrorInfo, GitCommit, GitCommitDetails, GitCommitStash, GitConfigLocation, GitFileChange, GitFileStatus, GitPushBranchMode, GitRepoConfig, GitRepoConfigBranches, GitResetMode, GitSignatureStatus, GitStash, MergeActionOn, RebaseActionOn, SquashMessageFormat, TagType, Writeable } from './types';
 import { GitExecutable, UNABLE_TO_FIND_GIT_MSG, UNCOMMITTED, abbrevCommit, constructIncompatibleGitVersionMessage, getPathFromStr, getPathFromUri, isGitAtLeastVersion, openGitTerminal, pathWithTrailingSlash, realpath, resolveSpawnOutput } from './utils';
 import { Disposable } from './utils/disposable';
 import { Event } from './utils/event';
@@ -257,9 +257,15 @@ export class DataSource extends Disposable {
 				}
 			}
 
-			return { commits: commitNodes, head: refData.head, moreCommitsAvailable: moreCommitsAvailable, error: null };
+			return {
+				commits: commitNodes,
+				head: refData.head,
+				tags: unique(refData.tags.map((tag) => tag.name)),
+				moreCommitsAvailable: moreCommitsAvailable,
+				error: null
+			};
 		}).catch((errorMessage) => {
-			return { commits: [], head: null, moreCommitsAvailable: false, error: errorMessage };
+			return { commits: [], head: null, tags: [], moreCommitsAvailable: false, error: errorMessage };
 		});
 	}
 
@@ -659,13 +665,17 @@ export class DataSource extends Disposable {
 	 * @param repo The path of the repository.
 	 * @param tagName The name of the tag.
 	 * @param commitHash The hash of the commit the tag should be added to.
-	 * @param lightweight Is the tag lightweight.
+	 * @param type Is the tag annotated or lightweight.
 	 * @param message The message of the tag (if it is an annotated tag).
+	 * @param force Force add the tag, replacing an existing tag with the same name (if it exists).
 	 * @returns The ErrorInfo from the executed command.
 	 */
-	public addTag(repo: string, tagName: string, commitHash: string, lightweight: boolean, message: string) {
+	public addTag(repo: string, tagName: string, commitHash: string, type: TagType, message: string, force: boolean) {
 		const args = ['tag'];
-		if (lightweight) {
+		if (force) {
+			args.push('-f');
+		}
+		if (type === TagType.Lightweight) {
 			args.push(tagName);
 		} else {
 			args.push(getConfig().signTags ? '-s' : '-a', tagName, '-m', message);
@@ -1783,6 +1793,12 @@ function removeTrailingBlankLines(lines: string[]) {
 	return lines;
 }
 
+function unique(items: ReadonlyArray<string>) {
+	const uniqueItems: { [item: string]: true } = {};
+	items.forEach((item) => uniqueItems[item] = true);
+	return Object.keys(uniqueItems);
+}
+
 
 /* Types */
 
@@ -1816,6 +1832,7 @@ interface GitCommitRecord {
 interface GitCommitData {
 	commits: GitCommit[];
 	head: string | null;
+	tags: string[];
 	moreCommitsAvailable: boolean;
 	error: ErrorInfo;
 }

src/gitGraphView.ts

@@ -179,7 +179,7 @@ export class GitGraphView extends Disposable {
 				});
 				break;
 			case 'addTag':
-				errorInfos = [await this.dataSource.addTag(msg.repo, msg.tagName, msg.commitHash, msg.lightweight, msg.message)];
+				errorInfos = [await this.dataSource.addTag(msg.repo, msg.tagName, msg.commitHash, msg.type, msg.message, msg.force)];
 				if (errorInfos[0] === null && msg.pushToRemote !== null) {
 					errorInfos.push(await this.dataSource.pushTag(msg.repo, msg.tagName, msg.pushToRemote));
 				}

src/types.ts

@@ -428,7 +428,7 @@ export interface DefaultColumnVisibility {
 export interface DialogDefaults {
 	readonly addTag: {
 		readonly pushToRemote: boolean,
-		readonly type: 'annotated' | 'lightweight'
+		readonly type: TagType
 	};
 	readonly applyStash: {
 		readonly reinstateIndex: boolean
@@ -518,6 +518,11 @@ export const enum TabIconColourTheme {
 	Grey
 }
 
+export const enum TagType {
+	Annotated,
+	Lightweight
+}
+
 
 /* Base Interfaces for Request / Response Messages */
 
@@ -557,9 +562,10 @@ export interface RequestAddTag extends RepoRequest {
 	readonly command: 'addTag';
 	readonly commitHash: string;
 	readonly tagName: string;
-	readonly lightweight: boolean;
+	readonly type: TagType;
 	readonly message: string;
 	readonly pushToRemote: string | null; // string => name of the remote to push the tag to, null => don't push to a remote
+	readonly force: boolean;
 }
 export interface ResponseAddTag extends ResponseWithMultiErrorInfo {
 	readonly command: 'addTag';
@@ -872,6 +878,7 @@ export interface ResponseLoadCommits extends ResponseWithErrorInfo {
 	readonly refreshId: number;
 	readonly commits: GitCommit[];
 	readonly head: string | null;
+	readonly tags: string[];
 	readonly moreCommitsAvailable: boolean;
 	readonly onlyFollowFirstParent: boolean;
 }

tests/config.test.ts

@@ -4,7 +4,7 @@ import * as vscode from './mocks/vscode';
 jest.mock('vscode', () => vscode, { virtual: true });
 
 import { getConfig } from '../src/config';
-import { CommitDetailsViewLocation, CommitOrdering, DateFormatType, DateType, FileViewType, GitResetMode, GraphStyle, GraphUncommittedChangesStyle, RepoDropdownOrder, SquashMessageFormat, TabIconColourTheme } from '../src/types';
+import { CommitDetailsViewLocation, CommitOrdering, DateFormatType, DateType, FileViewType, GitResetMode, GraphStyle, GraphUncommittedChangesStyle, RepoDropdownOrder, SquashMessageFormat, TabIconColourTheme, TagType } from '../src/types';
 
 const workspaceConfiguration = vscode.mocks.workspaceConfiguration;
 
@@ -838,7 +838,7 @@ describe('Config', () => {
 			expect(value).toStrictEqual({
 				addTag: {
 					pushToRemote: true,
-					type: 'annotated'
+					type: TagType.Annotated
 				},
 				applyStash: {
 					reinstateIndex: true
@@ -934,7 +934,7 @@ describe('Config', () => {
 			expect(value).toStrictEqual({
 				addTag: {
 					pushToRemote: false,
-					type: 'annotated'
+					type: TagType.Annotated
 				},
 				applyStash: {
 					reinstateIndex: false
@@ -1030,7 +1030,7 @@ describe('Config', () => {
 			expect(value).toStrictEqual({
 				addTag: {
 					pushToRemote: true,
-					type: 'annotated'
+					type: TagType.Annotated
 				},
 				applyStash: {
 					reinstateIndex: true
@@ -1126,7 +1126,7 @@ describe('Config', () => {
 			expect(value).toStrictEqual({
 				addTag: {
 					pushToRemote: false,
-					type: 'annotated'
+					type: TagType.Annotated
 				},
 				applyStash: {
 					reinstateIndex: false
@@ -1208,7 +1208,7 @@ describe('Config', () => {
 			expect(value).toStrictEqual({
 				addTag: {
 					pushToRemote: false,
-					type: 'annotated'
+					type: TagType.Annotated
 				},
 				applyStash: {
 					reinstateIndex: false
@@ -1283,7 +1283,7 @@ describe('Config', () => {
 			expect(value).toStrictEqual({
 				addTag: {
 					pushToRemote: false,
-					type: 'annotated'
+					type: TagType.Annotated
 				},
 				applyStash: {
 					reinstateIndex: false
@@ -1339,7 +1339,7 @@ describe('Config', () => {
 				const value = config.dialogDefaults;
 
 				// Assert
-				expect(value.addTag.type).toBe('annotated');
+				expect(value.addTag.type).toBe(TagType.Annotated);
 			});
 
 			it('Should return "lightweight" the configuration value is "Annotated"', () => {
@@ -1350,7 +1350,7 @@ describe('Config', () => {
 				const value = config.dialogDefaults;
 
 				// Assert
-				expect(value.addTag.type).toBe('lightweight');
+				expect(value.addTag.type).toBe(TagType.Lightweight);
 			});
 		});