Signed-off-by: enaysaa [email protected]

Introduced TypeScript type definitions SearchJiraResponse and JiraQueryResults to represent Jira search responses and pagination details.
Updated the searchJira function to return search results as a SearchJiraResponse, incorporating the new types.
Enhanced error handling in the searchJira function by handling HTTP response errors and logging them appropriately.
The JiraQueryResults type outlines the structure of a paginated Jira search response, facilitating better data handling.
These changes streamline the Jira Dashboard plugin's codebase, improving error resilience and clarity in handling search operations.

.changeset/witty-jokes-hammer.md

@@ -0,0 +1,10 @@
+---
+'@axis-backstage/plugin-jira-dashboard-backend': minor
+'@axis-backstage/plugin-jira-dashboard-common': minor
+---
+
+Introduced TypeScript type definitions SearchJiraResponse and JiraQueryResults to represent Jira search responses and pagination details.
+Updated the searchJira function to return search results as a SearchJiraResponse, incorporating the new types.
+Enhanced error handling in the searchJira function by handling HTTP response errors and logging them appropriately.
+The JiraQueryResults type outlines the structure of a paginated Jira search response, facilitating better data handling.
+These changes streamline the Jira Dashboard plugin's codebase, improving error resilience and clarity in handling search operations.

plugins/jira-dashboard-backend/api-report.md

@@ -10,8 +10,8 @@ import { DiscoveryService } from '@backstage/backend-plugin-api';
 import express from 'express';
 import { HttpAuthService } from '@backstage/backend-plugin-api';
 import { IdentityApi } from '@backstage/plugin-auth-node';
-import { Issue } from '@axis-backstage/plugin-jira-dashboard-common';
 import { Logger } from 'winston';
+import { SearchJiraResponse } from '@axis-backstage/plugin-jira-dashboard-common';
 import { TokenManager } from '@backstage/backend-common';
 
 // @public
@@ -51,7 +51,8 @@ export const searchJira: (
   config: Config,
   jqlQuery: string,
   options: SearchOptions,
-) => Promise<Issue[]>;
+  logger: Logger,
+) => Promise<SearchJiraResponse>;
 
 // @public
 export type SearchOptions = {

plugins/jira-dashboard-backend/src/api.ts

@@ -3,10 +3,13 @@ import fetch from 'node-fetch';
 import {
   Filter,
   Issue,
+  JiraQueryResults,
   Project,
+  SearchJiraResponse,
 } from '@axis-backstage/plugin-jira-dashboard-common';
 import { resolveJiraBaseUrl, resolveJiraToken } from './config';
 import { jqlQueryBuilder } from './queries';
+import { Logger } from 'winston';
 
 export const getProjectInfo = async (
   projectKey: string,
@@ -91,26 +94,53 @@ export type SearchOptions = {
  * @param config - A Backstage config
  * @param jqlQuery - A string containing the jql query.
  * @param options - Query options that will be passed on to the POST request.
- *
+ * @param logger - An optional logger for error handling and debugging purposes.
+ * @returns A promise that resolves with the search results and status code.
+ * @throws If an error occurs during the search process.
  * @public
  */
 export const searchJira = async (
   config: Config,
   jqlQuery: string,
   options: SearchOptions,
-): Promise<Issue[]> => {
-  const response = await fetch(`${resolveJiraBaseUrl(config)}search`, {
-    method: 'POST',
-    body: JSON.stringify({ jql: jqlQuery, ...options }),
-    headers: {
-      Authorization: resolveJiraToken(config),
-      Accept: 'application/json',
-      'Content-Type': 'application/json',
-    },
-  }).then(resp => resp.json());
-  return response.issues;
+  logger: Logger,
+): Promise<SearchJiraResponse> => {
+  try {
+    const response = await fetch(`${resolveJiraBaseUrl(config)}search`, {
+      method: 'POST',
+      body: JSON.stringify({ jql: jqlQuery, ...options }),
+      headers: {
+        Authorization: resolveJiraToken(config),
+        Accept: 'application/json',
+        'Content-Type': 'application/json',
+      },
+    });
+    const jsonResponse = await response.json();
+
+    return {
+      results: toPaginatedResponse(jsonResponse),
+      statusCode: response.status,
+    } as SearchJiraResponse;
+  } catch (error) {
+    logger.error(error);
+    throw error;
+  }
 };
 
+function toPaginatedResponse(response: any): JiraQueryResults {
+  return {
+    expand: response.expand,
+    names: response.names,
+    schema: response.schema,
+    issues: response.issues,
+    total: response.total,
+    startAt: response.startAt,
+    maxResults: response.maxResults,
+    warningMessages: response.warningMessages,
+    errorMessages: response.errorMessages,
+  };
+}
+
 export const getIssuesByComponent = async (
   projectKey: string,
   componentKey: string,

plugins/jira-dashboard-common/api-report.md

@@ -48,6 +48,19 @@ export type JiraDataResponse = {
   issues: Issue[];
 };
 
+// @public
+export type JiraQueryResults = {
+  expand: string;
+  names: object;
+  schema: object;
+  issues: Issue[];
+  total: number;
+  startAt: number;
+  maxResults: number;
+  warningMessages?: string[];
+  errorMessages?: string[];
+};
+
 // @public
 export type JiraResponse = {
   project: Project;
@@ -75,4 +88,10 @@ export type Project = {
 
 // @public
 export const PROJECT_KEY_NAME = 'project-key';
+
+// @public
+export type SearchJiraResponse = {
+  results: JiraQueryResults;
+  statusCode: number;
+};
 ```

plugins/jira-dashboard-common/src/types.ts

@@ -72,3 +72,28 @@ export type JiraResponse = {
   project: Project;
   data: JiraDataResponse[];
 };
+
+/**
+ * Type definition for a Jira search result & the recieved HTTP status code
+ * @public
+ */
+export type SearchJiraResponse = {
+  results: JiraQueryResults;
+  statusCode: number;
+};
+
+/**
+ * Type definition for a paginated Jira search response
+ * @public
+ */
+export type JiraQueryResults = {
+  expand: string;
+  names: object;
+  schema: object;
+  issues: Issue[];
+  total: number;
+  startAt: number;
+  maxResults: number;
+  warningMessages?: string[];
+  errorMessages?: string[];
+};