feat(Fix): Input issues (objects including 'url'), not just issue URLs

Author: smockle

.github/actions/fix/README.md

@@ -6,9 +6,13 @@ Attempts to fix issues with Copilot.
 
 ### Inputs
 
+#### `issues`
+
+**NOTE: This input will be unconditionally required in `v2`.** **Required if `issue_urls` is not provided** List of issues to attempt to fix—including, at a minimum, their `url`s—as stringified JSON. For example: `'[{"url":"https://github.com/github/docs/issues/123"},{"nodeId":"SXNzdWU6Mg==","url":"https://github.com/github/docs/issues/124"},{"id":4,"nodeId":"SXNzdWU6NA==","url":"https://github.com/github/docs/issues/126","title":"Accessibility issue: 4"}]'`.
+
 #### `issue_urls`
 
-**Required** List of issue URLs to attempt to fix, as stringified JSON. For example: `'["https://github.com/github/docs/issues/123","https://github.com/github/docs/issues/124","https://github.com/github/docs/issues/126","https://github.com/github/docs/issues/127"]'`.
+**DEPRECATED: This input will be removed in `v2`.** **Required if `issues` is not provided** List of issue URLs to attempt to fix, as stringified JSON. For example: `'["https://github.com/github/docs/issues/123","https://github.com/github/docs/issues/124","https://github.com/github/docs/issues/126","https://github.com/github/docs/issues/127"]'`. If both `issues` and `issue_urls` are provided, `issue_urls` will be ignored.
 
 #### `repository`
 

.github/actions/fix/action.yml

@@ -2,9 +2,12 @@ name: "Fix"
 description: "Attempts to fix issues with Copilot."
 
 inputs:
+  issues:
+    description: "List of issues to attempt to fix, as stringified JSON"
+    required: false
   issue_urls:
     description: "List of issue URLs to attempt to fix, as stringified JSON"
-    required: true
+    required: false
   repository:
     description: "Repository (with owner) containing issues"
     required: true

.github/actions/fix/src/Issue.ts

@@ -0,0 +1,43 @@
+import { IssueInput } from "./types.d.js";
+
+interface IIssue extends IssueInput{
+  owner: string;
+  repository: string;
+  issueNumber: number;
+}
+
+export class Issue implements IIssue {
+  /**
+   * Extracts owner, repository, and issue number from a GitHub issue URL.
+   * @param issueUrl A GitHub issue URL (e.g. `https://github.com/owner/repo/issues/42`).
+   * @returns An object with `owner`, `repository`, and `issueNumber` keys.
+   * @throws The provided URL is unparseable due to its unexpected format.
+   */
+  static parseIssueUrl(issueUrl: string): { owner: string; repository: string; issueNumber: number } {
+    const { owner, repository, issueNumber } = /\/(?<owner>[^/]+)\/(?<repository>[^/]+)\/issues\/(?<issueNumber>\d+)(?:[/?#]|$)/.exec(issueUrl)?.groups || {};
+    if (!owner || !repository || !issueNumber) {
+      throw new Error(`Could not parse issue URL: ${issueUrl}`);
+    }
+    return { owner, repository, issueNumber: Number(issueNumber) }
+  }
+
+  url: string;
+  nodeId?: string;
+
+  get owner(): string {
+    return Issue.parseIssueUrl(this.url).owner;
+  }
+
+  get repository(): string {
+    return Issue.parseIssueUrl(this.url).repository;
+  }
+
+  get issueNumber(): number {
+    return Issue.parseIssueUrl(this.url).issueNumber;
+  }
+
+  constructor({url, nodeId}: IssueInput) {
+    this.url = url;
+    this.nodeId = nodeId;
+  }
+}

.github/actions/fix/src/fixIssue.ts

@@ -1,10 +1,8 @@
 import type { Octokit } from '@octokit/core';
+import { Issue } from './Issue.js';
 
 // https://docs.github.com/en/enterprise-cloud@latest/copilot/how-tos/use-copilot-agents/coding-agent/assign-copilot-to-an-issue#assigning-an-existing-issue
-export async function fixIssue(octokit: Octokit, repoWithOwner: string, issueUrl: string) {
-  const owner = repoWithOwner.split('/')[0];
-  const repo = repoWithOwner.split('/')[1];
-  const issueNumber = Number(issueUrl.split('/').pop());
+export async function fixIssue(octokit: Octokit, { owner, repository, issueNumber, nodeId }: Issue) {
   // Check whether issues can be assigned to Copilot
   const suggestedActorsResponse = await octokit.graphql<{
     repository: {
@@ -13,8 +11,8 @@ export async function fixIssue(octokit: Octokit, repoWithOwner: string, issueUrl
       }
     }
   }>(
-    `query ($owner: String!, $repo: String!) {
-      repository(owner: $owner, name: $repo) {
+    `query ($owner: String!, $repository: String!) {
+      repository(owner: $owner, name: $repository) {
         suggestedActors(capabilities: [CAN_BE_ASSIGNED], first: 1) {
           nodes {
             login
@@ -25,30 +23,44 @@ export async function fixIssue(octokit: Octokit, repoWithOwner: string, issueUrl
         }
       }
     }`,
-    { owner, repo },
+    { owner, repository },
   );
   if (suggestedActorsResponse?.repository?.suggestedActors?.nodes[0]?.login !== "copilot-swe-agent") {
     return;
   }
-  // Get GraphQL identifier for issue
-  const issueResponse = await octokit.graphql<{
-    repository: {
-      issue: { id: string }
-    }
-  }>(
-    `query($owner: String!, $repo: String!, $issueNumber: Int!) {
-      repository(owner: $owner, name: $repo) {
-        issue(number: $issueNumber) { id }
+  // Get GraphQL identifier for issue (unless already provided)
+  let issueId = nodeId;
+  if (!issueId) {
+    const issueResponse = await octokit.graphql<{
+      repository: {
+        issue: { id: string }
       }
-    }`,
-    { owner, repo, issueNumber }
-  );
-  const issueId = issueResponse?.repository?.issue?.id;
+    }>(
+      `query($owner: String!, $repository: String!, $issueNumber: Int!) {
+        repository(owner: $owner, name: $repository) {
+          issue(number: $issueNumber) { id }
+        }
+      }`,
+      { owner, repository, issueNumber }
+    );
+    issueId = issueResponse?.repository?.issue?.id;
+  }
   if (!issueId) {
     return;
   }
   // Assign issue to Copilot
-  return octokit.graphql(
+  await octokit.graphql<{
+    replaceActorsForAssignable: {
+      assignable: {
+        id: string;
+        url: string;
+        title: string;
+        assignees: {
+          nodes: { login: string }[]
+        }
+      }
+    }
+  }>(
     `mutation($issueId: ID!, $assigneeId: ID!) {
       replaceActorsForAssignable(input: {assignableId: $issueId, actorIds: [$assigneeId]}) {
         assignable {

.github/actions/fix/src/index.ts

@@ -1,15 +1,28 @@
+import type { IssueInput } from "./types.d.js";
 import process from "node:process";
 import core from "@actions/core";
 import { Octokit } from "@octokit/core";
 import { throttling } from "@octokit/plugin-throttling";
 import { fixIssue } from "./fixIssue.js";
+import { Issue } from "./Issue.js";
 const OctokitWithThrottling = Octokit.plugin(throttling);
 
 export default async function () {
   core.info("Started 'fix' action");
-  const issueUrls = JSON.parse(core.getInput('issue_urls', { required: true }));
+  /** @deprecated Use `issues` instead. */
+  const issueUrls: string[] = JSON.parse(
+    core.getInput('issue_urls', { required: false }) || "[]"
+  );
+  const issues: IssueInput[] = JSON.parse(
+    core.getInput('issues', { required: false }) || JSON.stringify(issueUrls.map(url => ({ url })))
+  );
+  if (issues.length === 0) {
+    core.setFailed("Neither 'issues' nor 'issue_urls' was provided, but one is required.");
+    process.exit(1);
+  }
   const repoWithOwner = core.getInput('repository', { required: true });
   const token = core.getInput('token', { required: true });
+  core.debug(`Input: 'issues: ${JSON.stringify(issues)}'`);
   core.debug(`Input: 'issue_urls: ${JSON.stringify(issueUrls)}'`);
   core.debug(`Input: 'repository: ${repoWithOwner}'`);
 
@@ -32,12 +45,13 @@ export default async function () {
       },
     }
   });
-  for (const issueUrl of issueUrls) {
+  for (const issueInput of issues) {
     try {
-      await fixIssue(octokit, repoWithOwner, issueUrl);
-      core.info(`Assigned ${repoWithOwner}#${issueUrl.split('/').pop()} to Copilot!`);
+      const issue = new Issue(issueInput);
+      await fixIssue(octokit, issue);
+      core.info(`Assigned ${issue.owner}/${issue.repository}#${issue.issueNumber} to Copilot!`);
     } catch (error) {
-      core.setFailed(`Failed to assign ${repoWithOwner}#${issueUrl.split('/').pop()} to Copilot: ${error}`);
+      core.setFailed(`Failed to assign ${issueInput.url} to Copilot: ${error}`);
       process.exit(1);
     }
   }

.github/actions/fix/src/types.d.ts

@@ -0,0 +1,4 @@
+export type IssueInput = {
+  url: string;
+  nodeId?: string;
+};