XS✔ ◾ [Autogenerated] Release v1.6.3 (#540)

Autogenerated release for PR Metrics v1.6.3. This includes the latest
dependency updates.

This also includes a fix for the previous release where the type
definitions were improperly defined, resulting in failures in certain
cases.

---------

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>

Author: muiriswoulfe

.github/workflows/release-phase-1.yml

@@ -21,4 +21,4 @@ jobs:
     with:
       major: 1
       minor: 6
-      patch: 3
+      patch: 4

.github/workflows/support/release-trigger.txt

@@ -1 +1 @@
-1.6.2
+1.6.3

README.md

@@ -113,7 +113,7 @@ The default input values are expected to be appropriate for most builds.
 Therefore, the following YAML definition is recommended:
 
 ```YAML
-uses: microsoft/PR-Metrics@v1.6.2
+uses: microsoft/PR-Metrics@v1.6.3
 name: PR Metrics
 env:
   PR_METRICS_ACCESS_TOKEN: ${{ secrets.GITHUB_TOKEN }}
@@ -123,7 +123,7 @@ continue-on-error: true
 If you wish to modify the inputs, YAML akin the to the following can be used:
 
 ```YAML
-uses: microsoft/PR-Metrics@v1.6.2
+uses: microsoft/PR-Metrics@v1.6.3
 name: PR Metrics
 env:
   PR_METRICS_ACCESS_TOKEN: ${{ secrets.GITHUB_TOKEN }}

dist/index.js

@@ -2,7 +2,7 @@
   "$schema": "https://json.schemastore.org/resjson.json",
   "loc.description": "Augments pull request titles to let reviewers quickly determine PR size and test coverage.",
   "loc.description.comment": "The description of the task.",
-  "loc.friendlyName": "PR Metrics v1.6.2",
+  "loc.friendlyName": "PR Metrics v1.6.3",
   "loc.friendlyName.comment": "The name of the task.",
   "loc.helpMarkDown": "[More information](https://aka.ms/PRMetrics/README)",
   "loc.helpMarkDown.comment": "The Markdown-formatted help text of the task.",

dist/resources.resjson

@@ -2,7 +2,7 @@
   "$schema": "https://json.schemastore.org/package.json",
   "name": "prmetrics",
   "publisher": "ms-omex",
-  "version": "1.6.2",
+  "version": "1.6.3",
   "description": "Augments pull request titles to let reviewers quickly determine PR size and test coverage.",
   "main": "dist/index.js",
   "scripts": {

package-lock.json

@@ -2,7 +2,7 @@
   "$schema": "https://json.schemastore.org/resjson.json",
   "loc.description": "Augments pull request titles to let reviewers quickly determine PR size and test coverage.",
   "loc.description.comment": "The description of the task.",
-  "loc.friendlyName": "PR Metrics v1.6.2",
+  "loc.friendlyName": "PR Metrics v1.6.3",
   "loc.friendlyName.comment": "The name of the task.",
   "loc.helpMarkDown": "[More information](https://aka.ms/PRMetrics/README)",
   "loc.helpMarkDown.comment": "The Markdown-formatted help text of the task.",

package.json

@@ -92,7 +92,11 @@ export default class AzureReposInvoker extends BaseReposInvoker {
       const status: CommentThreadStatus =
         value.status ?? CommentThreadStatus.Unknown;
 
-      if (typeof value.threadContext === "undefined") {
+      if (
+        // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition -- The type definition is incorrect.
+        value.threadContext === null ||
+        typeof value.threadContext === "undefined"
+      ) {
         result.pullRequestComments.push(
           new PullRequestCommentData(id, content, status),
         );

src/task/Strings/resources.resjson/en-US/resources.resjson

@@ -288,7 +288,7 @@ export default class GitHubReposInvoker extends BaseReposInvoker {
           this._logger.logWarning(`Octokit – ${message}`);
         },
       },
-      userAgent: "PRMetrics/v1.6.2",
+      userAgent: "PRMetrics/v1.6.3",
     };
 
     if (RunnerInvoker.isGitHub) {

src/task/src/repos/azureReposInvoker.ts

@@ -2,7 +2,7 @@
   "$schema": "https://raw.githubusercontent.com/microsoft/azure-pipelines-task-lib/master/tasks.schema.json",
   "id": "907d3b28-6b37-4ac7-ac75-9631ee53e512",
   "name": "PRMetrics",
-  "friendlyName": "PR Metrics v1.6.2",
+  "friendlyName": "PR Metrics v1.6.3",
   "description": "Augments pull request titles to let reviewers quickly determine PR size and test coverage.",
   "helpUrl": "https://aka.ms/PRMetrics/README",
   "helpMarkDown": "[More information](https://aka.ms/PRMetrics/README)",
@@ -13,7 +13,7 @@
   "version": {
     "Major": 1,
     "Minor": 6,
-    "Patch": 2
+    "Patch": 3
   },
   "instanceNameFormat": "PR Metrics",
   "showEnvironmentVariables": true,

src/task/src/repos/gitHubReposInvoker.ts

@@ -13,7 +13,7 @@
   "version": {
     "Major": 1,
     "Minor": 6,
-    "Patch": 2
+    "Patch": 3
   },
   "instanceNameFormat": "ms-resource:loc.instanceNameFormat",
   "showEnvironmentVariables": true,

src/task/task.json

@@ -558,7 +558,7 @@ describe("azureReposInvoker.ts", (): void => {
       });
     }
 
-    it("should return the result when called with a pull request comment", async (): Promise<void> => {
+    it("should return the result when called with a pull request comment whose thread context is undefined", async (): Promise<void> => {
       // Arrange
       when(gitApi.getThreads("RepoID", 10, "Project")).thenResolve([
         { comments: [{ content: "Content" }], id: 1, status: 1 },
@@ -600,6 +600,53 @@ describe("azureReposInvoker.ts", (): void => {
       ).once();
     });
 
+    it("should return the result when called with a pull request comment whose thread context is null", async (): Promise<void> => {
+      // Arrange
+      when(gitApi.getThreads("RepoID", 10, "Project")).thenResolve([
+        {
+          comments: [{ content: "Content" }],
+          id: 1,
+          status: 1,
+          threadContext: null as unknown as undefined,
+        },
+      ]);
+      const azureReposInvoker: AzureReposInvoker = new AzureReposInvoker(
+        instance(azureDevOpsApiWrapper),
+        instance(gitInvoker),
+        instance(logger),
+        instance(runnerInvoker),
+        instance(tokenManager),
+      );
+
+      // Act
+      const result: CommentData = await azureReposInvoker.getComments();
+
+      // Assert
+      assert.equal(result.pullRequestComments.length, 1);
+      assert.equal(result.pullRequestComments[0]?.id, 1);
+      assert.equal(result.pullRequestComments[0]?.content, "Content");
+      assert.equal(
+        result.pullRequestComments[0]?.status,
+        CommentThreadStatus.Active,
+      );
+      assert.equal(result.fileComments.length, 0);
+      verify(azureDevOpsApiWrapper.getPersonalAccessTokenHandler("PAT")).once();
+      verify(
+        azureDevOpsApiWrapper.getWebApiInstance(
+          "https://dev.azure.com/organization",
+          any(),
+        ),
+      ).once();
+      verify(gitApi.getThreads("RepoID", 10, "Project")).once();
+      verify(logger.logDebug("* AzureReposInvoker.getComments()")).once();
+      verify(logger.logDebug("* AzureReposInvoker.getGitApi()")).once();
+      verify(
+        logger.logDebug(
+          '[{"comments":[{"content":"Content"}],"id":1,"status":1,"threadContext":null}]',
+        ),
+      ).once();
+    });
+
     it("should return the result when called with a file comment", async (): Promise<void> => {
       // Arrange
       when(gitApi.getThreads("RepoID", 10, "Project")).thenResolve([

src/task/task.loc.json

@@ -34,7 +34,7 @@ describe("gitHubReposInvoker.ts", (): void => {
   let octokitWrapper: OctokitWrapper;
   let runnerInvoker: RunnerInvoker;
 
-  const expectedUserAgent = "PRMetrics/v1.6.2";
+  const expectedUserAgent = "PRMetrics/v1.6.3";
 
   beforeEach((): void => {
     process.env.PR_METRICS_ACCESS_TOKEN = "PAT";

src/task/tests/repos/azureReposInvoker.spec.ts

@@ -3,7 +3,7 @@
   "manifestVersion": 1,
   "id": "PRMetrics",
   "name": "PR Metrics",
-  "version": "1.6.2",
+  "version": "1.6.3",
   "publisher": "ms-omex",
   "description": "Augments pull request titles to let reviewers quickly determine PR size and test coverage.",
   "public": true,