Add context to the created comment thread

* The `fileGlob` is now matched against all files in the PR instead of
  stopping at the first match.
* If the `fileGlob` only matches one file the comment thread is created
  with a context for that file so that it shows up within that file in
  the Azure DevOps UI.
* If more files match the glob, no context is added.
* Moved error handling in `index.ts` outside the `TaskRunner` to catch
  all errors and mark the task as failed.
* Added logging of matches files

Author: Xerillio

src/commentator.ts

@@ -2,22 +2,23 @@ import { type IGitApi } from "azure-devops-node-api/GitApi";
 import * as GitInterfaces from "azure-devops-node-api/interfaces/GitInterfaces";
 import { type IInputs } from "./inputs";
 import { isAutoCommentThread } from "./type-guards";
+import { type IResultContext } from "./validators/validator";
 
 export class Commentator {
     constructor(
         private readonly inputs: IInputs,
         private readonly client: IGitApi
     ) {}
 
-    public readonly createComment = async(repositoryId: string, prId: number): Promise<string> => {
+    public readonly createComment = async(repositoryId: string, prId: number, context?: IResultContext): Promise<string> => {
         const commentHash = this.inputs.hashedConditions;
 
         const prThreads = await this.client.getThreads(repositoryId, prId);
         const existingThread = prThreads.filter(isAutoCommentThread)
             .find(thread => thread.properties.hash.$value === commentHash);
 
         if (existingThread === undefined) {
-            await this.createNewThread(commentHash, repositoryId, prId);
+            await this.createNewThread(commentHash, repositoryId, prId, context);
             console.log(`New comment created with the hash: ${commentHash}`);
         } else {
             console.log(`A comment already exists with the hash: ${commentHash}`);
@@ -29,7 +30,8 @@ export class Commentator {
     private readonly createNewThread = async(
         commentHash: string,
         repositoryId: string,
-        prId: number
+        prId: number,
+        context?: IResultContext
     ): Promise<GitInterfaces.GitPullRequestCommentThread> => {
         const thread: GitInterfaces.GitPullRequestCommentThread = {
             properties: {
@@ -39,9 +41,18 @@ export class Commentator {
                 content: this.inputs.comment,
                 commentType: GitInterfaces.CommentType.Text
             }],
-            status: GitInterfaces.CommentThreadStatus.Active
+            status: GitInterfaces.CommentThreadStatus.Active,
+            threadContext: this.getThreadContext(context)
         };
 
         return await this.client.createThread(thread, repositoryId, prId);
     };
+
+    private readonly getThreadContext = (context?: IResultContext): GitInterfaces.CommentThreadContext | undefined => {
+        if (context?.files === undefined || context.files.length !== 1) {
+            return undefined;
+        }
+
+        return { filePath: context.files[0] };
+    };
 }

src/index.ts

@@ -21,21 +21,16 @@ class TaskRunner {
     }
 
     public run = async(): Promise<void> => {
-        try {
-            let resultMessage = "One or more conditions were not met";
+        let resultMessage = "One or more conditions were not met";
 
-            const result = await validateAll(this.client, this.inputs, this.repoId, this.prId);
+        const result = await validateAll(this.client, this.inputs, this.repoId, this.prId);
 
-            if (result.conditionMet) {
-                const commentHash = await this.commentator.createComment(this.repoId, this.prId);
-                resultMessage = `Conditions succesfully met. Comment hash: ${commentHash}`;
-            }
-
-            setResult(TaskResult.Succeeded, resultMessage);
-        } catch (err: any) {
-            console.error(err, err.stack);
-            setResult(TaskResult.Failed, err.message);
+        if (result.conditionMet) {
+            const commentHash = await this.commentator.createComment(this.repoId, this.prId, result.context);
+            resultMessage = `Conditions successfully met. Comment hash: ${commentHash}`;
         }
+
+        setResult(TaskResult.Succeeded, resultMessage);
     };
 }
 
@@ -49,5 +44,6 @@ class TaskRunner {
         await runner.run();
     } catch (err: any) {
         console.error(err, err.stack);
+        setResult(TaskResult.Failed, err.message);
     }
 })();

src/validators/file-glob-validator.ts

@@ -16,13 +16,14 @@ export class FileGlobValidator implements IValidator {
             return { conditionMet: true };
         }
 
-        const matchingChange = await this.getFirstMatchingChange(repositoryId, prId, this.inputs.fileGlob);
-        if (matchingChange !== undefined) {
-            console.log("Found one or more matches for the glob expression");
+        const matchingChanges = await this.getMatchingChanges(repositoryId, prId, this.inputs.fileGlob);
+        if (matchingChanges.length > 0) {
+            console.log("Found the following matches for the glob expression:\n    " +
+                matchingChanges.map(c => c.item?.path).join("\n    "));
             return {
                 conditionMet: true,
                 context: {
-                    files: [matchingChange.item?.path ?? ""]
+                    files: matchingChanges.map(change => change.item?.path ?? "")
                 }
             };
         }
@@ -31,16 +32,27 @@ export class FileGlobValidator implements IValidator {
         return { conditionMet: false };
     };
 
-    private readonly getFirstMatchingChange = async(repositoryId: string, prId: number, fileGlob: string): Promise<GitInterfaces.GitPullRequestChange | undefined> => {
+    private readonly getMatchingChanges = async(repositoryId: string, prId: number, fileGlob: string): Promise<GitInterfaces.GitPullRequestChange[]> => {
         const lastIterationId = await this.getLastIterationId(repositoryId, prId);
-        let changes: GitInterfaces.GitPullRequestIterationChanges;
-        let matchingChange: GitInterfaces.GitPullRequestChange | undefined;
+        let changes: GitInterfaces.GitPullRequestIterationChanges | undefined;
+        const matchingChanges: GitInterfaces.GitPullRequestChange[] = [];
+        const matchesGlob = (changeEntry: GitInterfaces.GitPullRequestChange): boolean =>
+            minimatch(changeEntry.item?.path ?? "", fileGlob);
+
         do {
-            changes = await this.client.getPullRequestIterationChanges(repositoryId, prId, lastIterationId);
-            matchingChange = changes.changeEntries?.find(
-                entry => minimatch(entry.item?.path ?? "", fileGlob));
-        } while (matchingChange === undefined && changes.nextTop !== undefined && changes.nextTop > 0);
-        return matchingChange;
+            changes = await this.client.getPullRequestIterationChanges(
+                repositoryId,
+                prId,
+                lastIterationId,
+                undefined,
+                changes?.nextTop,
+                changes?.nextSkip);
+
+            const matches = changes.changeEntries?.filter(matchesGlob) ?? [];
+            matchingChanges.push(...matches);
+        } while (changes.nextTop !== undefined && changes.nextTop > 0);
+
+        return matchingChanges;
     };
 
     private readonly getLastIterationId = async(repositoryId: string, prId: number): Promise<number> => {

tests/validators/file-glob-validator.test.ts

@@ -63,6 +63,24 @@ describe("FileGlobValidator", () => {
             sinon.assert.calledTwice(stubApiClient.getPullRequestIterationChanges);
         });
 
+        it("should succeed when fileGlob matches multiple files on multiple pages", async() => {
+            const fileGlob = "/**/*";
+            const stubInputs = createStubInputs({ fileGlob });
+            const stubApiClient = createStubGitApi();
+            stubApiClient.getPullRequestIterationChanges
+                .onSecondCall().resolves(pageTwoIterationChanges());
+            const minimatchStub = sinon.stub<[string, string], boolean>()
+                .callsFake((_: string, __: string) => true);
+            setMinimatchStub(minimatchStub);
+            const sut = await createSut(stubApiClient, stubInputs);
+
+            const result = await sut.check("foo", 7357);
+
+            expect(result.conditionMet).is.true;
+            expect(result.context?.files).to.have.members(["/foo/bar.txt", "/baz/qux.txt"]);
+            sinon.assert.calledTwice(stubApiClient.getPullRequestIterationChanges);
+        });
+
         it("should fail when fileGlob matches no files", async() => {
             const fileGlob = "/match/nothing";
             const stubInputs = createStubInputs({ fileGlob });
@@ -86,7 +104,7 @@ function createStubGitApi(): StubbedInstance<IGitApi> {
         .resolves([{ id: 1 }]);
     stubGitApi.getPullRequestIterationChanges
         .onFirstCall().resolves(pageOneIterationChanges())
-        .onSecondCall().throws("The test was not supposed to get second page");
+        .onSecondCall().resolves({});
     return stubGitApi;
 }