fixdiscover 1.0.0 → 1.1.0

package/README.md

@@ -71,6 +71,7 @@ Options:
   -c, --component [component]  issue component
   -u, --upstream [upstream]    upstream project
   -n, --nocolor                disable color output (default: false)
+  -x, --dry                    dry run (default: false)
   -h, --help                   display help for command
 ```
 
@@ -81,6 +82,8 @@ Options:
 > ```bash
 > NOCOLOR=true npx fixdiscover
 > ```
+>
+> Similarly, you can enable dry run by setting the `DRY` environment variable to `true`.
 
 ### Examples
 

package/dist/main.js

@@ -78763,7 +78763,7 @@ function getDefaultValue(envName) {
     return void 0;
   }
   const value = process.env[envName];
-  if (envName === "NOCOLOR" && !value) {
+  if ((envName === "NOCOLOR" || envName === "DRY") && !value) {
     return false;
   }
   return value;
@@ -78775,16 +78775,15 @@ function getOptions(inputs) {
     upstream: inputs.upstream || getDefaultValue("UPSTREAM")
   };
 }
+function escapeRegex(regex2) {
+  return regex2.replace(/[/\-\\^$*+?.()|[\]{}]/g, "\\$&");
+}
 
 // src/jira.ts
 var Jira = class {
-  constructor(instance, apiToken) {
+  constructor(instance, apiToken, dry) {
     this.instance = instance;
-    this.fields = {
-      storyPoints: "customfield_12310243",
-      priority: "priority",
-      severity: "customfield_12316142"
-    };
+    this.dry = dry;
     this.baseJQL = 'Project = RHEL AND statusCategory = "To Do"';
     this.JQL = "";
     this.api = new import_jira.Version2Client({
@@ -78804,7 +78803,9 @@ var Jira = class {
     this.JQL += " ORDER BY id DESC";
     const response = await this.api.issueSearch.searchForIssuesUsingJqlPost({
       jql: this.JQL,
-      fields: ["id", "issuetype", "summary", "assignee", "comment"]
+      fields: ["id", "issuetype", "summary", "assignee", "comment"],
+      // We should paginate this, let's set 300 for now.
+      maxResults: 300
     });
     return response.issues ?? raise("Jira.getIssues(): missing issues.");
   }
@@ -78814,9 +78815,13 @@ var Jira = class {
     });
     return response ?? [];
   }
-  async setLabels(issue, labels) {
+  async setLabels(key, labels) {
+    if (this.dry) {
+      console.debug(`DRY: setLabels(${key}, ${labels})`);
+      return;
+    }
     await this.api.issues.editIssue({
-      issueIdOrKey: issue,
+      issueIdOrKey: key,
       update: {
         labels: labels.map((label) => ({ add: label }))
       }
@@ -84419,9 +84424,9 @@ var LinkFinder = class {
   constructor(upstreamStr) {
     const [org, repo] = upstreamStr.split("/");
     this.upstream = { org, repo };
-    const upstreamEscaped = `${org}\\/${repo}`;
+    const upstreamEscaped = escapeRegex(`${org}/${repo}`);
     this.regex = new RegExp(
-      `https://github.com/${upstreamEscaped}/((pull|issues|commit)/([a-z\\d]+))`,
+      `https://github\\.com/${upstreamEscaped}/((pull|issues|commit)/([a-z\\d]+))`,
       "g"
     );
   }
@@ -84507,7 +84512,7 @@ function cli() {
   const program2 = new Command();
   program2.name("fixdiscover").description(
     "\u{1F50D} A small CLI tool is used to search for Jira issues with linked PRs and issues that are fixed in upstream projects"
-  ).version("1.0.0");
+  ).version("1.1.0");
   program2.requiredOption(
     "-c, --component [component]",
     "issue component",
@@ -84516,11 +84521,7 @@ function cli() {
     "-u, --upstream [upstream]",
     "upstream project",
     getDefaultValue("UPSTREAM")
-  ).option(
-    "-n, --nocolor",
-    "disable color output",
-    getDefaultValue("NOCOLOR")
-  );
+  ).option("-n, --nocolor", "disable color output", getDefaultValue("NOCOLOR")).option("-x, --dry", "dry run", getDefaultValue("DRY"));
   return program2;
 }
 var runProgram = async () => {
@@ -84529,7 +84530,7 @@ var runProgram = async () => {
   const options = getOptions(program2.opts());
   const logger = new Logger(!!options.nocolor);
   const jiraToken = process.env.JIRA_API_TOKEN ?? tokenUnavailable("jira");
-  const jira = new Jira("https://issues.redhat.com", jiraToken);
+  const jira = new Jira("https://issues.redhat.com", jiraToken, options.dry);
   const githubToken = process.env.GITHUB_API_TOKEN ?? tokenUnavailable("github");
   const octokit = getOctokit(githubToken);
   const upstream = options.upstream ?? `${options.component}/${options.component}`;
@@ -84555,7 +84556,7 @@ var runProgram = async () => {
       }
     }
     if (links.length > 0) {
-      await jira.setLabels(issue.id, ["backport"]);
+      await jira.setLabels(issue.key, ["backport"]);
       data.push({ key: jira.getIssueURL(issue.key), links });
     }
   }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "fixdiscover",
-  "version": "1.0.0",
+  "version": "1.1.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",

package/src/cli.ts

@@ -17,7 +17,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.0.0');
+    .version('1.1.0');
 
   program
     .requiredOption(
@@ -30,11 +30,8 @@ export function cli(): Command {
       'upstream project',
       getDefaultValue('UPSTREAM')
     )
-    .option(
-      '-n, --nocolor',
-      'disable color output',
-      getDefaultValue('NOCOLOR')
-    );
+    .option('-n, --nocolor', 'disable color output', getDefaultValue('NOCOLOR'))
+    .option('-x, --dry', 'dry run', getDefaultValue('DRY'));
 
   return program;
 }
@@ -47,7 +44,7 @@ const runProgram = async () => {
   const logger = new Logger(!!options.nocolor);
 
   const jiraToken = process.env.JIRA_API_TOKEN ?? tokenUnavailable('jira');
-  const jira = new Jira('https://issues.redhat.com', jiraToken);
+  const jira = new Jira('https://issues.redhat.com', jiraToken, options.dry);
 
   const githubToken =
     process.env.GITHUB_API_TOKEN ?? tokenUnavailable('github');
@@ -88,7 +85,7 @@ const runProgram = async () => {
     }
 
     if (links.length > 0) {
-      await jira.setLabels(issue.id, ['backport']);
+      await jira.setLabels(issue.key, ['backport']);
       data.push({ key: jira.getIssueURL(issue.key), links });
     }
   }

package/src/jira.ts

@@ -4,17 +4,13 @@ import { raise } from './util';
 
 export class Jira {
   readonly api: Version2Client;
-  readonly fields = {
-    storyPoints: 'customfield_12310243',
-    priority: 'priority',
-    severity: 'customfield_12316142',
-  };
   readonly baseJQL = 'Project = RHEL AND statusCategory = "To Do"';
   JQL = '';
 
   constructor(
     readonly instance: string,
-    apiToken: string
+    apiToken: string,
+    readonly dry: boolean
   ) {
     this.api = new Version2Client({
       host: instance,
@@ -37,6 +33,8 @@ export class Jira {
     const response = await this.api.issueSearch.searchForIssuesUsingJqlPost({
       jql: this.JQL,
       fields: ['id', 'issuetype', 'summary', 'assignee', 'comment'],
+      // We should paginate this, let's set 300 for now.
+      maxResults: 300,
     });
 
     return response.issues ?? raise('Jira.getIssues(): missing issues.');
@@ -50,9 +48,14 @@ export class Jira {
     return response ?? [];
   }
 
-  async setLabels(issue: string, labels: string[]) {
+  async setLabels(key: string, labels: string[]) {
+    if (this.dry) {
+      console.debug(`DRY: setLabels(${key}, ${labels})`);
+      return;
+    }
+
     await this.api.issues.editIssue({
-      issueIdOrKey: issue,
+      issueIdOrKey: key,
       update: {
         labels: labels.map(label => ({ add: label })),
       },

package/src/linkfinder.ts

@@ -2,6 +2,7 @@ import { Endpoints } from '@octokit/types';
 import { z } from 'zod';
 
 import { CustomOctokit } from './octokit';
+import { escapeRegex } from './util';
 
 const linkObjectSchema = z.object({
   url: z.string(),
@@ -18,7 +19,7 @@ export class LinkFinder {
     const [org, repo] = upstreamStr.split('/');
     this.upstream = { org, repo };
 
-    const upstreamEscaped = `${org}\\/${repo}`;
+    const upstreamEscaped = escapeRegex(`${org}/${repo}`);
 
     // Match any GitHub link to issue, PR or commit to the upstream project
     // Groups:
@@ -27,7 +28,7 @@ export class LinkFinder {
     // 2 - type of link (pull, issues, commit)
     // 3 - id or sha
     this.regex = new RegExp(
-      `https:\/\/github\.com\/${upstreamEscaped}\/((pull|issues|commit)\/([a-z\\d]+))`,
+      `https:\/\/github\\.com\/${upstreamEscaped}\/((pull|issues|commit)\/([a-z\\d]+))`,
       'g'
     );
   }

package/src/util.ts

@@ -21,14 +21,16 @@ export function isDefaultValuesDisabled(): boolean {
   return process.env['NODEFAULTS'] ? true : false;
 }
 
-export function getDefaultValue(envName: 'COMPONENT' | 'UPSTREAM' | 'NOCOLOR') {
+export function getDefaultValue(
+  envName: 'COMPONENT' | 'UPSTREAM' | 'NOCOLOR' | 'DRY'
+) {
   if (isDefaultValuesDisabled()) {
     return undefined;
   }
 
   const value = process.env[envName];
 
-  if (envName === 'NOCOLOR' && !value) {
+  if ((envName === 'NOCOLOR' || envName === 'DRY') && !value) {
     return false;
   }
 
@@ -42,3 +44,7 @@ export function getOptions(inputs: OptionValues): OptionValues {
     upstream: inputs.upstream || getDefaultValue('UPSTREAM'),
   };
 }
+
+export function escapeRegex(regex: string): string {
+  return regex.replace(/[/\-\\^$*+?.()|[\]{}]/g, '\\$&');
+}