fixdiscover 1.1.0 → 1.2.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "fixdiscover",
-  "version": "1.1.0",
+  "version": "1.2.0",
   "description": "Small CLI tool to search for Jira issues with linked PRs and Issues that are fixed in an upstream projects.",
   "main": "src/main.ts",
   "type": "commonjs",
@@ -37,8 +37,9 @@
     "@actions/core": "^1.11.1",
     "@octokit/core": "^6.1.2",
     "@octokit/plugin-throttling": "^9.3.2",
-    "@octokit/types": "^13.6.1",
+    "@octokit/types": "^13.6.2",
     "@total-typescript/ts-reset": "0.6.1",
+    "bugzilla": "^3.1.4",
     "chalk": "5.3.0",
     "commander": "12.1.0",
     "dotenv": "16.4.5",
@@ -46,12 +47,12 @@
     "zod": "3.23.8"
   },
   "devDependencies": {
-    "@types/node": "22.9.0",
+    "@types/node": "22.10.0",
     "@vitest/coverage-v8": "2.1.5",
     "esbuild": "0.24.0",
-    "prettier": "3.3.3",
+    "prettier": "3.4.0",
     "ts-node": "10.9.2",
-    "typescript": "5.6.3",
+    "typescript": "5.7.2",
     "vitest": "2.1.5"
   }
 }

package/src/bugzilla.ts

@@ -0,0 +1,42 @@
+import BugzillaAPI from 'bugzilla';
+import { execSync } from 'node:child_process';
+
+import { Bugs, bugsSchema } from './schema/bugzilla';
+
+export class Bugzilla {
+  readonly api: BugzillaAPI;
+
+  readonly tips = {
+    approval: 'Bugzilla is approved if it has `release` flag set to `+`',
+  };
+
+  constructor(
+    readonly instance: string,
+    private readonly apiToken: string
+  ) {
+    this.api = new BugzillaAPI(instance, apiToken);
+  }
+
+  async getVersion(): Promise<string> {
+    return this.api.version();
+  }
+
+  async getBugs(bugId: number): Promise<Bugs['bugs']> {
+    const command = `bugzilla --bugzilla ${this.instance}/xmlrpc.cgi query --json --bug_id ${bugId}`;
+
+    let stdout = '';
+    try {
+      stdout = execSync(command).toString();
+    } catch (error) {
+      console.error(error);
+      return [];
+    }
+
+    const raw = bugsSchema.safeParse(JSON.parse(stdout));
+    return raw.success ? raw.data.bugs : [];
+  }
+
+  getIssueURL(bug: number): string {
+    return `${this.instance}/show_bug.cgi?id=${bug}`;
+  }
+}

package/src/cli.ts

@@ -1,13 +1,14 @@
 import { Command } from 'commander';
 import { Comment } from 'jira.js/out/version2/models';
 
+import { Bugzilla } from './bugzilla';
 import { Jira } from './jira';
 import { Logger } from './logger';
 import { getOctokit } from './octokit';
 import { getDefaultValue, getOptions, tokenUnavailable } from './util';
-import { LinkFinder, LinkObject } from './linkfinder';
+import { LinkFinder } from './linkfinder';
 
-export type Data = { key: string; links: LinkObject[] }[];
+import { IssueLinks, LinkObject } from './schema/link';
 
 export function cli(): Command {
   const program = new Command();
@@ -17,7 +18,7 @@ export function cli(): Command {
     .description(
       '🔍 A small CLI tool is used to search for Jira issues with linked PRs and issues that are fixed in upstream projects'
     )
-    .version('1.1.0');
+    .version('1.2.0');
 
   program
     .requiredOption(
@@ -30,6 +31,7 @@ export function cli(): Command {
       'upstream project',
       getDefaultValue('UPSTREAM')
     )
+    .option('--migrate', 'migrate links from Bugzilla to Jira')
     .option('-n, --nocolor', 'disable color output', getDefaultValue('NOCOLOR'))
     .option('-x, --dry', 'dry run', getDefaultValue('DRY'));
 
@@ -46,6 +48,11 @@ const runProgram = async () => {
   const jiraToken = process.env.JIRA_API_TOKEN ?? tokenUnavailable('jira');
   const jira = new Jira('https://issues.redhat.com', jiraToken, options.dry);
 
+  const bugzillaToken = options.migrate
+    ? (process.env.BUGZILLA_API_TOKEN ?? tokenUnavailable('bugzilla'))
+    : '';
+  const bugzilla = new Bugzilla('https://bugzilla.redhat.com', bugzillaToken);
+
   const githubToken =
     process.env.GITHUB_API_TOKEN ?? tokenUnavailable('github');
   const octokit = getOctokit(githubToken);
@@ -56,10 +63,14 @@ const runProgram = async () => {
 
   const issues = await jira.getIssues(options.component);
 
-  let data: Data = [];
+  let data: IssueLinks = [];
 
   for (const issue of issues) {
     let links: LinkObject[] = [];
+
+    const bugzillaBug: { bugid: number } | null =
+      issue.fields[jira.fields.bugzillaBug];
+
     const externalLinks = await jira.getLinks(issue.id);
 
     for (const comment of issue.fields.comment.comments as (Comment & {
@@ -84,9 +95,52 @@ const runProgram = async () => {
       }
     }
 
+    if (options.migrate && bugzillaBug !== null) {
+      const bug = (await bugzilla.getBugs(bugzillaBug.bugid))[0];
+
+      let linksForMigration: LinkObject[] = [];
+
+      for (const comment of bug.comments) {
+        const commentLinks = linkFinder.getLinks(
+          comment.text,
+          `Bugzilla comment #${comment.count}`
+        );
+
+        if (commentLinks.length > 0) {
+          linksForMigration.push(
+            ...(await linkFinder.checkUpstream(commentLinks, octokit))
+          );
+        }
+      }
+
+      for (const link of bug.external_bugs) {
+        const upstreamLink = linkFinder.getLinks(link.url, link.description);
+
+        if (upstreamLink.length > 0) {
+          linksForMigration.push(
+            ...(await linkFinder.checkUpstream(upstreamLink, octokit))
+          );
+        }
+      }
+
+      linksForMigration.forEach(async link => {
+        await jira.addLink(
+          issue.key,
+          link.url,
+          `Bugzilla upstream link${link.description ? ` - ${link.description}` : ''}`
+        );
+      });
+
+      links.push(...linksForMigration);
+    }
+
     if (links.length > 0) {
       await jira.setLabels(issue.key, ['backport']);
-      data.push({ key: jira.getIssueURL(issue.key), links });
+      data.push({
+        key: jira.getIssueURL(issue.key),
+        bz: bugzillaBug ? bugzilla.getIssueURL(bugzillaBug.bugid) : undefined,
+        links,
+      });
     }
   }
 

package/src/jira.ts

@@ -4,6 +4,10 @@ import { raise } from './util';
 
 export class Jira {
   readonly api: Version2Client;
+  readonly fields = {
+    bugzillaBug: 'customfield_12316840',
+  };
+
   readonly baseJQL = 'Project = RHEL AND statusCategory = "To Do"';
   JQL = '';
 
@@ -32,7 +36,14 @@ export class Jira {
 
     const response = await this.api.issueSearch.searchForIssuesUsingJqlPost({
       jql: this.JQL,
-      fields: ['id', 'issuetype', 'summary', 'assignee', 'comment'],
+      fields: [
+        'id',
+        'issuetype',
+        'summary',
+        'assignee',
+        'comment',
+        this.fields.bugzillaBug,
+      ],
       // We should paginate this, let's set 300 for now.
       maxResults: 300,
     });
@@ -50,7 +61,7 @@ export class Jira {
 
   async setLabels(key: string, labels: string[]) {
     if (this.dry) {
-      console.debug(`DRY: setLabels(${key}, ${labels})`);
+      //console.debug(`DRY: setLabels(${key}, ${labels})`);
       return;
     }
 
@@ -65,4 +76,40 @@ export class Jira {
   getIssueURL(issue: string) {
     return `${this.instance}/browse/${issue}`;
   }
+
+  async addLink(issue: string, url: string, title: string) {
+    const links = await this.api.issueRemoteLinks.getRemoteIssueLinks({
+      issueIdOrKey: issue,
+    });
+
+    for (const link of links) {
+      if (link.object === undefined) {
+        continue;
+      }
+
+      if (link.object.url === url) {
+        console.debug(
+          `Link ${url} is already linked with Jira issue ${issue}.`
+        );
+        return;
+      }
+    }
+
+    if (this.dry) {
+      console.debug(`DRY: addLink(${issue}, ${url}, ${title})`);
+      return;
+    }
+
+    await this.api.issueRemoteLinks.createOrUpdateRemoteIssueLink({
+      issueIdOrKey: issue,
+      object: {
+        title,
+        url,
+        icon: {
+          title: 'GitHub',
+          url16x16: 'https://github.githubassets.com/favicon.ico',
+        },
+      },
+    });
+  }
 }

package/src/linkfinder.ts

@@ -4,13 +4,7 @@ import { z } from 'zod';
 import { CustomOctokit } from './octokit';
 import { escapeRegex } from './util';
 
-const linkObjectSchema = z.object({
-  url: z.string(),
-  type: z.enum(['pull', 'issues', 'commit']),
-  id: z.string(),
-});
-
-export type LinkObject = z.infer<typeof linkObjectSchema>;
+import { LinkObject, linkObjectSchema } from './schema/link';
 
 export class LinkFinder {
   readonly upstream: { org: string; repo: string };
@@ -33,16 +27,21 @@ export class LinkFinder {
     );
   }
 
-  getLinks(message: string): LinkObject[] {
-    return z.array(linkObjectSchema).parse(
+  getLinks(message: string, description?: string): LinkObject[] {
+    const links = z.array(linkObjectSchema).parse(
       [...message.matchAll(this.regex)].map(match => {
         return {
           url: match[0],
+          description,
           type: match[2],
           id: match[3],
         };
       })
     );
+
+    return links.filter(
+      (link, index, self) => index === self.findIndex(el => el.url === link.url)
+    );
   }
 
   async checkUpstream(links: LinkObject[], octokit: CustomOctokit) {

package/src/logger.ts

@@ -1,6 +1,6 @@
 import chalk from 'chalk';
 
-import { Data } from './cli';
+import { IssueLinks } from './schema/link';
 
 export class Logger {
   static readonly colorRegex = /\[\d+m/gm;
@@ -16,7 +16,7 @@ export class Logger {
     console.log(message.replace(Logger.colorRegex, ''));
   }
 
-  logResult(data: Data): void {
+  logResult(data: IssueLinks): void {
     if (data.length === 0) {
       this.log(chalk.greenBright('No links found'));
       return;
@@ -25,8 +25,8 @@ export class Logger {
     let issueData = '';
     const result: string[] = [];
 
-    for (const { key, links } of data) {
-      issueData = `${chalk.green(key)}\n`;
+    for (const { key, bz, links } of data) {
+      issueData = `${chalk.green(key)}\n${bz ? `${chalk.red(bz)}\n` : ''}`;
 
       for (const link of links) {
         issueData = issueData.concat(`  - ${link.type}: ${link.url}\n`);

package/src/schema/bugzilla.ts

@@ -0,0 +1,36 @@
+import { z } from 'zod';
+
+export const externalLinkSchema = z.array(
+  z.object({
+    ext_description: z.string(),
+    ext_bz_bug_id: z.string(),
+    type: z.object({ url: z.string(), type: z.string() }),
+  })
+);
+
+export type ExternalLink = z.infer<typeof externalLinkSchema>;
+
+export const linkTransform = (link: ExternalLink[number]) => {
+  return {
+    description: link.ext_description,
+    url: `${link.type.url}${link.ext_bz_bug_id}`,
+  };
+};
+
+export const bugsSchema = z.object({
+  bugs: z.array(
+    z.object({
+      id: z.number(),
+      summary: z.string(),
+      comments: z.array(z.object({ text: z.string(), count: z.number() })),
+      external_bugs: externalLinkSchema.transform(links => {
+        return Array.from(
+          links.filter(link => link.type.type === 'GitHub'),
+          linkTransform
+        );
+      }),
+    })
+  ),
+});
+
+export type Bugs = z.infer<typeof bugsSchema>;

package/src/schema/link.ts

@@ -0,0 +1,12 @@
+import { z } from 'zod';
+
+export const linkObjectSchema = z.object({
+  url: z.string(),
+  description: z.string().optional(),
+  type: z.enum(['pull', 'issues', 'commit']),
+  id: z.string(),
+});
+
+export type LinkObject = z.infer<typeof linkObjectSchema>;
+
+export type IssueLinks = { key: string; bz?: string; links: LinkObject[] }[];

package/src/util.ts

@@ -4,13 +4,19 @@ export function raise(error: string): never {
   throw new Error(error);
 }
 
-export function tokenUnavailable(type: 'jira' | 'github'): never {
-  const tokenType =
-    type === 'jira'
-      ? 'JIRA_API_TOKEN'
-      : type === 'github'
-        ? 'GITHUB_API_TOKEN'
-        : undefined;
+export function tokenUnavailable(type: 'jira' | 'bugzilla' | 'github'): never {
+  let tokenType: string;
+  switch (type) {
+    case 'jira':
+      tokenType = 'JIRA_API_TOKEN';
+      break;
+    case 'bugzilla':
+      tokenType = 'BUGZILLA_API_TOKEN';
+      break;
+    case 'github':
+      tokenType = 'GITHUB_API_TOKEN';
+      break;
+  }
 
   return raise(
     `${tokenType} not set.\nPlease set the ${tokenType} environment variable in '~/.config/fixdiscover/.env' or '~/.env.fixdiscover' or '~/.env.'`