Show reviewed-status of files and allow marking as reviewed/unreviewed (fixes #103)

Author: Sander Ronde

.vscode/tasks.json

@@ -4,7 +4,7 @@
 	"version": "2.0.0",
 	"tasks": [
 		{
-			"type": "npm",
+			"type": "bun",
 			"script": "compile:debug",
 			"problemMatcher": "$tsc-watch",
 			"isBackground": true,
@@ -17,4 +17,4 @@
 			}
 		}
 	]
-}
+}

package.json

@@ -161,6 +161,14 @@
 				"command": "gerrit.openModified",
 				"title": "Open Modified File"
 			},
+			{
+				"command": "gerrit.markReviewed",
+				"title": "Mark file as reviewed"
+			},
+			{
+				"command": "gerrit.markUnreviewed",
+				"title": "Mark file as unreviewed"
+			},
 			{
 				"command": "gerrit.openOnline",
 				"title": "Open file on Gerrit"
@@ -483,6 +491,14 @@
 					"command": "gerrit.openModified",
 					"when": "false"
 				},
+				{
+					"command": "gerrit.markReviewed",
+					"when": "false"
+				},
+				{
+					"command": "gerrit.markUnreviewed",
+					"when": "false"
+				},
 				{
 					"command": "gerrit.openOnline",
 					"when": "false"
@@ -785,6 +801,16 @@
 					"when": "view == gerrit:changeExplorer && viewItem =~ /filechange/ && viewItem =~ /modified/",
 					"group": "openFile@3"
 				},
+				{
+					"command": "gerrit.markReviewed",
+					"when": "view == gerrit:changeExplorer && viewItem =~ /filechange/",
+					"group": "openFile@4"
+				},
+				{
+					"command": "gerrit.markUnreviewed",
+					"when": "view == gerrit:changeExplorer && viewItem =~ /filechange/",
+					"group": "openFile@5"
+				},
 				{
 					"command": "gerrit.openInReview",
 					"when": "view == gerrit:changeExplorer && viewItem =~ /gerritchange/",

src/commands/command-names.ts

@@ -13,6 +13,8 @@ export enum GerritExtensionCommands {
 	FILE_OPEN_ONLINE = 'gerrit.openOnline',
 	FILE_OPEN_MODIFIED = 'gerrit.openModified',
 	FILE_OPEN_ORIGINAL = 'gerrit.openOriginal',
+	FILE_MARK_REVIEWED = 'gerrit.markReviewed',
+	FILE_MARK_UNREVIEWED = 'gerrit.markUnreviewed',
 	FETCH_MORE = 'gerrit.fetchMore',
 	OPEN_CHANGE_SELECTOR = 'gerrit.openChangeSelector',
 	// Duplicate so we can have multiple names in the command palette

src/commands/commands.ts

@@ -56,6 +56,7 @@ import { createAutoRegisterCommand } from 'vscode-generate-package-json';
 import { enterCredentials } from '../lib/credentials/enterCredentials';
 import { rebaseOntoParent, recursiveRebase } from '../lib/git/rebase';
 import { CommentThread, ExtensionContext, Uri, window } from 'vscode';
+import { GerritChange } from '../lib/gerrit/gerritAPI/gerritChange';
 import { focusChange } from '../lib/commandHandlers/focusChange';
 import { Repository } from '../types/vscode-extension-git';
 import { checkConnection } from '../lib/gerrit/gerritAPI';
@@ -193,6 +194,52 @@ export function registerCommands(
 			(treeView: FileTreeView) => openModified(treeView)
 		)
 	);
+	context.subscriptions.push(
+		registerCommand(
+			GerritExtensionCommands.FILE_MARK_REVIEWED,
+			async (treeView: FileTreeView) => {
+				const change = await GerritChange.getChangeOnce(
+					treeView.file.changeID
+				);
+				if (!change) {
+					return;
+				}
+				const currentRevisions = await change.currentRevisions();
+				if (!currentRevisions) {
+					return;
+				}
+				const revision =
+					currentRevisions[treeView.file.currentRevision.id];
+				if (!revision) {
+					return;
+				}
+				await revision.setFileReviewed(treeView.file.filePath, true);
+			}
+		)
+	);
+	context.subscriptions.push(
+		registerCommand(
+			GerritExtensionCommands.FILE_MARK_UNREVIEWED,
+			async (treeView: FileTreeView) => {
+				const change = await GerritChange.getChangeOnce(
+					treeView.file.changeID
+				);
+				if (!change) {
+					return;
+				}
+				const currentRevisions = await change.currentRevisions();
+				if (!currentRevisions) {
+					return;
+				}
+				const revision =
+					currentRevisions[treeView.file.currentRevision.id];
+				if (!revision) {
+					return;
+				}
+				await revision.setFileReviewed(treeView.file.filePath, false);
+			}
+		)
+	);
 	context.subscriptions.push(
 		registerCommand(
 			GerritExtensionCommands.FILE_OPEN_ORIGINAL,
@@ -218,6 +265,25 @@ export function registerCommands(
 						...(diffCommand.arguments ?? [])
 					);
 				}
+
+				await (async () => {
+					const change = await GerritChange.getChangeOnce(
+						args.file.changeID
+					);
+					if (!change) {
+						return;
+					}
+					const currentRevisions = await change.currentRevisions();
+					if (!currentRevisions) {
+						return;
+					}
+					const revision =
+						currentRevisions[args.file.currentRevision.id];
+					if (!revision) {
+						return;
+					}
+					await revision.setFileReviewed(args.file.filePath, true);
+				})();
 			}
 		)
 	);

src/commands/defs.ts

@@ -177,6 +177,14 @@ export const commands: {
 		title: 'Open Modified File',
 		inCommandPalette: false,
 	},
+	'gerrit.markReviewed': {
+		title: 'Mark file as reviewed',
+		inCommandPalette: false,
+	},
+	'gerrit.markUnreviewed': {
+		title: 'Mark file as unreviewed',
+		inCommandPalette: false,
+	},
 	'gerrit.openOnline': {
 		title: 'Open file on Gerrit',
 		inCommandPalette: false,
@@ -468,6 +476,20 @@ export const views: {
 					viewItemContains(TREE_ITEM_WAS_MODIFIED)
 				),
 			},
+			{
+				command: GerritExtensionCommands.FILE_MARK_REVIEWED,
+				when: and(
+					IS_GERRIT_CHANGE_EXPLORER_VIEW,
+					viewItemContains(TREE_ITEM_TYPE_FILE)
+				),
+			},
+			{
+				command: GerritExtensionCommands.FILE_MARK_UNREVIEWED,
+				when: and(
+					IS_GERRIT_CHANGE_EXPLORER_VIEW,
+					viewItemContains(TREE_ITEM_TYPE_FILE)
+				),
+			},
 		],
 		change: [
 			{

src/extension.ts

@@ -6,6 +6,7 @@ import {
 	startListeningForStreamEvents,
 	testEnableStreamEvents,
 } from './lib/stream-events/stream-events';
+import { getReviewedStatusDecorationProvider } from './providers/reviewedStatusDecorationProvider';
 import { FileModificationStatusProvider } from './providers/fileModificationStatusProvider';
 import { showQuickCheckoutStatusBarIcons } from './views/statusBar/quickCheckoutStatusBar';
 import { getOrCreateQuickCheckoutTreeProvider } from './views/activityBar/quickCheckout';
@@ -170,6 +171,13 @@ export async function activate(context: ExtensionContext): Promise<void> {
 		window.registerFileDecorationProvider(getCommentDecorationProvider())
 	);
 
+	// Register reviewed status decoration provider (eye icons)
+	context.subscriptions.push(
+		window.registerFileDecorationProvider(
+			getReviewedStatusDecorationProvider()
+		)
+	);
+
 	// Register filetype decoration provider
 	context.subscriptions.push(
 		window.registerFileDecorationProvider(

src/lib/gerrit/gerritAPI/api.ts

@@ -340,6 +340,7 @@ export class GerritAPI {
 		// Non-get requests perform some remote action, we can't
 		// just assume that that action only needs to happen once
 		if (body && body.method !== 'GET') {
+			log(`${body.method ?? 'GET'} request to "${url}"`);
 			return GerritAPI.performRequest(url, body);
 		}
 
@@ -949,6 +950,69 @@ export class GerritAPI {
 		);
 	}
 
+	public getFileReviewStatus(
+		changeID: string,
+		revision: PatchsetDescription
+	): Subscribable<Record<string, boolean>> {
+		return APISubscriptionManager.fileReviewStatusSubscriptions.createFetcher(
+			{
+				changeID: changeID,
+				revision,
+				baseRevision: null,
+			},
+			async () => {
+				const response = await this._tryRequest({
+					path: `changes/${changeID}/revisions/${revision.id}/files`,
+					method: 'GET',
+					searchParams: {
+						// Mutually exclusive with baseRevision and others so this needs
+						// its own request
+						reviewed: 'true',
+					},
+				});
+
+				const json = this._handleResponse<string[]>(response);
+				if (!json) {
+					return {};
+				}
+
+				const byPath: Record<string, boolean> = {};
+				for (const path of json) {
+					byPath[path] = true;
+				}
+
+				return byPath;
+			}
+		);
+	}
+
+	public async setFileReviewed(
+		changeID: string,
+		revision: PatchsetDescription,
+		path: string,
+		reviewed: boolean
+	): Promise<void> {
+		if (reviewed) {
+			await this._tryRequest({
+				method: 'PUT',
+				path: `changes/${changeID}/revisions/${revision.id}/files/${encodeURIComponent(path)}/reviewed`,
+				body: JSON.stringify({
+					reviewed,
+				}),
+			});
+		} else {
+			await this._tryRequest({
+				method: 'DELETE',
+				path: `changes/${changeID}/revisions/${revision.id}/files/${encodeURIComponent(path)}/reviewed`,
+			});
+		}
+		await APISubscriptionManager.fileReviewStatusSubscriptions.invalidate({
+			changeID: changeID,
+			revision,
+			baseRevision: null,
+		});
+	}
+
 	public getFiles(
 		changeID: string,
 		changeProject: string,

src/lib/gerrit/gerritAPI/gerritRevision.ts

@@ -139,6 +139,32 @@ export class GerritRevision extends DynamicallyFetchable {
 		}
 	}
 
+	public async setFileReviewed(
+		path: string,
+		reviewed: boolean
+	): Promise<void> {
+		const api = await getAPIForSubscription();
+		await api.setFileReviewed(
+			this.changeID,
+			{
+				id: this.revisionID,
+				number: this.number,
+			},
+			path,
+			reviewed
+		);
+	}
+
+	public async getFileReviewStatus(): Promise<
+		Subscribable<Record<string, boolean>>
+	> {
+		const api = await getAPIForSubscription();
+		return api.getFileReviewStatus(this.changeID, {
+			id: this.revisionID,
+			number: this.number,
+		});
+	}
+
 	public detailedUploader(
 		...additionalWith: GerritAPIWith[]
 	): Promise<GerritDetailedUserResponse | null> {

src/lib/subscriptions/filesSubscription.ts

@@ -5,25 +5,21 @@ import {
 	WithMatchAny,
 } from './baseSubscriptions';
 import { PatchsetDescription } from '../../views/activityBar/changes/changeTreeView';
-import { GerritFile } from '../gerrit/gerritAPI/gerritFile';
 
 interface ChangeSubscriptionsManagerConfig {
 	changeID: string;
 	revision: PatchsetDescription;
 	baseRevision: PatchsetDescription | null;
 }
 
-export class FilesSubscriptionsManager extends APISubSubscriptionManagerBase<
-	Record<string, GerritFile>,
+export class FilesSubscriptionsManager<V> extends APISubSubscriptionManagerBase<
+	V,
 	ChangeSubscriptionsManagerConfig
 > {
 	protected override refetchIntervalOnNull = null;
 	protected override _getMatches(
 		config: WithMatchAny<ChangeSubscriptionsManagerConfig>
-	): APISubscriptionManagerEntry<
-		ChangeSubscriptionsManagerConfig,
-		Record<string, GerritFile>
-	>[] {
+	): APISubscriptionManagerEntry<ChangeSubscriptionsManagerConfig, V>[] {
 		const allEntries = this._subscriptions.entries();
 		if (config === MATCH_ANY) {
 			return allEntries.map((e) => e[1]);

src/lib/subscriptions/subscriptions.ts

@@ -8,6 +8,7 @@ import { ChangesSubscriptionsManager } from './changesSubscriptions';
 import { APISubSubscriptionManagerBase } from './baseSubscriptions';
 import { GerritChange } from '../gerrit/gerritAPI/gerritChange';
 import { FilesSubscriptionsManager } from './filesSubscription';
+import { GerritFile } from '../gerrit/gerritAPI/gerritFile';
 import { Disposable } from 'vscode';
 
 interface SubscriptionOptions {
@@ -48,7 +49,12 @@ export class APISubscriptionManager {
 			Map<string, GerritDraftComment[]>
 		>();
 	public static changesSubscriptions = new ChangesSubscriptionsManager();
-	public static filesSubscriptions = new FilesSubscriptionsManager();
+	public static filesSubscriptions = new FilesSubscriptionsManager<
+		Record<string, GerritFile>
+	>();
+	public static fileReviewStatusSubscriptions = new FilesSubscriptionsManager<
+		Record<string, boolean>
+	>();
 	public static quickCheckoutSubscriptions =
 		new QuickCheckoutSubscriptionsManager();
 	public static readonly NO_OP = (): void => {};