diff --git a/src/components/catalog/apis/artifactHub.ts b/src/components/catalog/apis/artifactHub.ts index 67993887..3dd26247 100644 --- a/src/components/catalog/apis/artifactHub.ts +++ b/src/components/catalog/apis/artifactHub.ts @@ -6,60 +6,19 @@ import { } from '@openshift-console/dynamic-plugin-sdk'; import * as _ from 'lodash'; import * as React from 'react'; +import { GITHUB_BASE_URL } from '../../../consts'; import { TaskModel, TaskModelV1Beta1 } from '../../../models'; +import { ArtifactHubTask, ArtifactHubTaskDetails } from '../../../types'; import { TektonTaskAnnotation } from '../../task-quicksearch/pipeline-quicksearch-utils'; -import { consoleProxyFetchJSON } from '../../utils/proxy'; import { ApiResult } from '../hooks/useApiResponse'; +import { getTaskDetails, getTaskYAMLFromGithub, searchTasks } from './utils'; -export const ARTIFACTHUB_API_BASE_URL = 'https://artifacthub.io/api/v1'; export const ARTIFACTHUB = 'ArtifactHub'; -export type ArtifactHubRepository = { - name: string; - kind: number; - url: string; - display_name: string; - repository_id: string; - organization_name: string; - organization_display_name: string; -}; - -export type ArtifactHubVersion = { - version: string; - contains_security_update: boolean; - prerelease: boolean; - ts: number; -}; - -export type ArtifactHubTask = { - package_id: string; - name: string; - description: string; - version: string; - display_name: string; - repository: ArtifactHubRepository; -}; - -export type ArtifactHubTaskDetails = { - package_id: string; - name: string; - description: string; - display_name: string; - keywords: string[]; - platforms: string[]; - version: ArtifactHubVersion[]; - available_versions: []; - content_url: string; - repository: ArtifactHubRepository; -}; - -const ARTIFACRHUB_TASKS_SEARCH_URL = `${ARTIFACTHUB_API_BASE_URL}/packages/search?offset=0&limit=60&facets=false&kind=7&deprecated=false&sort=relevance`; - export const getArtifactHubTaskDetails = async ( item: CatalogItem, v?: string, ): Promise => { - const API_BASE_URL = `${ARTIFACTHUB_API_BASE_URL}/packages/tekton-task`; const { name, data } = item; const { task: { @@ -67,8 +26,11 @@ export const getArtifactHubTaskDetails = async ( repository: { name: repoName }, }, } = data; - const url = `${API_BASE_URL}/${repoName}/${name}/${v || version}`; - return consoleProxyFetchJSON({ url, method: 'GET' }); + return getTaskDetails({ + repoName, + name, + version: v || version, + }); }; export const useGetArtifactHubTasks = ( @@ -81,11 +43,8 @@ export const useGetArtifactHubTasks = ( React.useEffect(() => { let mounted = true; if (hasPermission) { - consoleProxyFetchJSON<{ packages: ArtifactHubTask[] }>({ - url: ARTIFACRHUB_TASKS_SEARCH_URL, - method: 'GET', - }) - .then(({ packages }) => { + searchTasks() + .then((packages) => { if (mounted) { setLoaded(true); setResult(packages); @@ -112,7 +71,16 @@ export const createArtifactHubTask = ( namespace: string, version: string, ) => { - return consoleProxyFetchJSON({ url, method: 'GET' }) + const yamlPath = url.startsWith(GITHUB_BASE_URL) + ? url.slice(GITHUB_BASE_URL.length) + : null; + if (!yamlPath) { + throw new Error('Not a valid GitHub URL'); + } + + return getTaskYAMLFromGithub({ + yamlPath, + }) .then((task: K8sResourceKind) => { task.metadata.namespace = namespace; task.metadata.annotations = { @@ -140,7 +108,16 @@ export const updateArtifactHubTask = async ( name: string, version: string, ) => { - return consoleProxyFetchJSON({ url, method: 'GET' }) + const yamlPath = url.startsWith(GITHUB_BASE_URL) + ? url.slice(GITHUB_BASE_URL.length) + : null; + if (!yamlPath) { + throw new Error('Not a valid GitHub raw URL'); + } + + return getTaskYAMLFromGithub({ + yamlPath, + }) .then((task: K8sResourceKind) => { task.metadata.namespace = namespace; task.metadata.annotations = { diff --git a/src/components/catalog/apis/utils.ts b/src/components/catalog/apis/utils.ts new file mode 100644 index 00000000..1ab1a74b --- /dev/null +++ b/src/components/catalog/apis/utils.ts @@ -0,0 +1,118 @@ +import { + consoleFetchJSON, + K8sResourceKind, +} from '@openshift-console/dynamic-plugin-sdk'; +import { HttpError } from '@openshift-console/dynamic-plugin-sdk/lib/utils/error/http-error'; +import { load } from 'js-yaml'; +import { + ARTIFACTHUB_SEARCH_URL, + ARTIFACTHUB_TASK_DETAILS_URL, + GITHUB_ARTIFACTHUB_TASK_YAML_URL, +} from '../../../consts'; +import { + ArtifactHubTask, + ArtifactHubTaskDetails, + DevConsoleEndpointResponse, + TaskDetailsRequest, + TaskSearchRequest, + TaskYAMLRequest, +} from '../../../types'; + +/** + * Fetches the YAML content of a task from GitHub. + * @param taskYAMLRequest The request object containing the path to the task YAML file. + * @returns The parsed YAML content of the task. + */ +export const getTaskYAMLFromGithub = async ( + taskYAMLRequest: TaskYAMLRequest, +): Promise => { + const taskYAMLResponse: DevConsoleEndpointResponse = + await consoleFetchJSON.post( + GITHUB_ARTIFACTHUB_TASK_YAML_URL, + taskYAMLRequest, + ); + + if (!taskYAMLResponse.statusCode) { + throw new Error('Unexpected proxy response: Status code is missing!'); + } + + if (taskYAMLResponse.statusCode < 200 || taskYAMLResponse.statusCode >= 300) { + throw new HttpError( + `Unexpected status code: ${taskYAMLResponse.statusCode}`, + taskYAMLResponse.statusCode, + null, + taskYAMLResponse, + ); + } + + try { + // Parse the YAML response body + return load(taskYAMLResponse.body); + } catch (e) { + throw new Error('Failed to parse task YAML response body as YAML'); + } +}; + +/** + * Fetches the details of a task from ArtifactHub. + * @param taskDetailsRequest The request object containing the task details. + * @returns The details of the task. + */ +export const getTaskDetails = async ( + taskDetailsRequest: TaskDetailsRequest, +): Promise => { + const taskDetailsResponse: DevConsoleEndpointResponse = + await consoleFetchJSON.post( + ARTIFACTHUB_TASK_DETAILS_URL, + taskDetailsRequest, + ); + if (!taskDetailsResponse.statusCode) { + throw new Error('Unexpected proxy response: Status code is missing!'); + } + if ( + taskDetailsResponse.statusCode < 200 || + taskDetailsResponse.statusCode >= 300 + ) { + throw new HttpError( + `Unexpected status code: ${taskDetailsResponse.statusCode}`, + taskDetailsResponse.statusCode, + null, + taskDetailsResponse, + ); + } + + try { + return JSON.parse(taskDetailsResponse.body) as ArtifactHubTaskDetails; + } catch (e) { + throw new Error('Failed to parse task details response body as JSON'); + } +}; + +/** + * Fetches the tasks from ArtifactHub. + * @param (optional) searchrequest The search request object. + * @returns The array of tasks matching the search request. + */ +export const searchTasks = async ( + searchrequest?: TaskSearchRequest, +): Promise => { + const searchResponse: DevConsoleEndpointResponse = + await consoleFetchJSON.post(ARTIFACTHUB_SEARCH_URL, searchrequest || {}); + if (!searchResponse.statusCode) { + throw new Error('Unexpected proxy response: Status code is missing!'); + } + if (searchResponse.statusCode < 200 || searchResponse.statusCode >= 300) { + throw new HttpError( + `Unexpected status code: ${searchResponse.statusCode}`, + searchResponse.statusCode, + null, + searchResponse, + ); + } + + try { + return JSON.parse(searchResponse.body).packages as ArtifactHubTask[]; + } catch (e) { + throw new Error('Failed to parse search response body as JSON'); + } +}; diff --git a/src/components/catalog/providers/useArtifactHubTasksProvider.tsx b/src/components/catalog/providers/useArtifactHubTasksProvider.tsx index 1b98ef07..cc7724ba 100644 --- a/src/components/catalog/providers/useArtifactHubTasksProvider.tsx +++ b/src/components/catalog/providers/useArtifactHubTasksProvider.tsx @@ -1,9 +1,5 @@ import * as React from 'react'; -import { - ARTIFACTHUB, - ArtifactHubTask, - useGetArtifactHubTasks, -} from '../apis/artifactHub'; +import { ARTIFACTHUB, useGetArtifactHubTasks } from '../apis/artifactHub'; import { TektonHubTask } from '../apis/tektonHub'; import { CatalogItem, @@ -16,6 +12,7 @@ import { TaskModel } from '../../../models'; import { getReferenceForModel } from '../../pipelines-overview/utils'; import { useTektonHubIntegration } from '../catalog-utils'; import { t } from '../../utils/common-utils'; +import { ArtifactHubTask } from '../../../types'; const normalizeArtifactHubTasks = ( artifactHubTasks: ArtifactHubTask[], diff --git a/src/components/hooks/useTektonResult.ts b/src/components/hooks/useTektonResult.ts index 3d693fb3..419cb889 100644 --- a/src/components/hooks/useTektonResult.ts +++ b/src/components/hooks/useTektonResult.ts @@ -11,10 +11,13 @@ import { RepositoryLabels, TektonResourceLabel, } from '../../consts'; -import { PipelineRunKind, TaskRunKind } from '../../types'; import { + PipelineRunKind, RecordsList, + TaskRunKind, TektonResultsOptions, +} from '../../types'; +import { getPipelineRuns, getTaskRunLog, getTaskRuns, diff --git a/src/components/hooks/useTektonResults.ts b/src/components/hooks/useTektonResults.ts index ae678107..5889900e 100644 --- a/src/components/hooks/useTektonResults.ts +++ b/src/components/hooks/useTektonResults.ts @@ -1,12 +1,12 @@ import { K8sResourceCommon } from '@openshift-console/dynamic-plugin-sdk'; import * as React from 'react'; -import { PipelineRunKind, TaskRunKind } from '../../types'; import { + PipelineRunKind, RecordsList, + TaskRunKind, TektonResultsOptions, - getPipelineRuns, - getTaskRuns, -} from '../utils/tekton-results'; +} from '../../types'; +import { getPipelineRuns, getTaskRuns } from '../utils/tekton-results'; export type GetNextPage = () => void | undefined; diff --git a/src/components/pipelines-metrics/PipelinesAverageDuration.tsx b/src/components/pipelines-metrics/PipelinesAverageDuration.tsx index 54ebe285..3e2a3177 100644 --- a/src/components/pipelines-metrics/PipelinesAverageDuration.tsx +++ b/src/components/pipelines-metrics/PipelinesAverageDuration.tsx @@ -23,9 +23,9 @@ import { timeToMinutes, } from '../pipelines-overview/dateTime'; import { ALL_NAMESPACES_KEY } from '../../consts'; -import { DataType } from '../utils/tekton-results'; -import { SummaryResponse, getResultsSummary } from '../utils/summary-api'; +import { getResultsSummary } from '../utils/summary-api'; import { getFilter, useInterval } from '../pipelines-overview/utils'; +import { DataType, SummaryResponse } from '../../types'; interface PipelinesAverageDurationProps { timespan?: number; diff --git a/src/components/pipelines-overview/PipelineRunsDurationCard.tsx b/src/components/pipelines-overview/PipelineRunsDurationCard.tsx index 8802e23c..bfaf1523 100644 --- a/src/components/pipelines-overview/PipelineRunsDurationCard.tsx +++ b/src/components/pipelines-overview/PipelineRunsDurationCard.tsx @@ -16,7 +16,7 @@ import { } from '@patternfly/react-core'; import { SummaryProps, getFilter, useInterval } from './utils'; import { getResultsSummary } from '../utils/summary-api'; -import { DataType } from '../utils/tekton-results'; +import { DataType } from '../../types'; import { ALL_NAMESPACES_KEY } from '../../consts'; import { formatTime, getDropDownDate } from './dateTime'; import { LoadingInline } from '../Loading'; diff --git a/src/components/pipelines-overview/PipelineRunsNumbersChart.tsx b/src/components/pipelines-overview/PipelineRunsNumbersChart.tsx index 7df7472b..8caaf76b 100644 --- a/src/components/pipelines-overview/PipelineRunsNumbersChart.tsx +++ b/src/components/pipelines-overview/PipelineRunsNumbersChart.tsx @@ -21,8 +21,8 @@ import { parsePrometheusDuration, monthYear, } from './dateTime'; -import { DataType } from '../utils/tekton-results'; -import { SummaryResponse, getResultsSummary } from '../utils/summary-api'; +import { getResultsSummary } from '../utils/summary-api'; +import { DataType, SummaryResponse } from '../../types'; import { ALL_NAMESPACES_KEY } from '../../consts'; import { getFilter, useInterval } from './utils'; import { LoadingInline } from '../Loading'; diff --git a/src/components/pipelines-overview/PipelineRunsStatusCard.tsx b/src/components/pipelines-overview/PipelineRunsStatusCard.tsx index a91114ee..037aa781 100644 --- a/src/components/pipelines-overview/PipelineRunsStatusCard.tsx +++ b/src/components/pipelines-overview/PipelineRunsStatusCard.tsx @@ -35,11 +35,11 @@ import { monthYear, } from './dateTime'; import { getFilter, useInterval } from './utils'; -import { SummaryResponse, getResultsSummary } from '../utils/summary-api'; -import { DataType } from '../utils/tekton-results'; +import { getResultsSummary } from '../utils/summary-api'; import './PipelinesOverview.scss'; import { LoadingInline } from '../Loading'; import { ALL_NAMESPACES_KEY } from '../../consts'; +import { DataType, SummaryResponse } from '../../types'; import { OutlinedQuestionCircleIcon } from '@patternfly/react-icons'; interface PipelinesRunsStatusCardProps { diff --git a/src/components/pipelines-overview/PipelineRunsTotalCard.tsx b/src/components/pipelines-overview/PipelineRunsTotalCard.tsx index 430b88db..5ca0956b 100644 --- a/src/components/pipelines-overview/PipelineRunsTotalCard.tsx +++ b/src/components/pipelines-overview/PipelineRunsTotalCard.tsx @@ -14,10 +14,10 @@ import { import { SummaryProps, useInterval } from './utils'; import { PipelineModel, RepositoryModel } from '../../models'; import { getResultsSummary } from '../utils/summary-api'; -import { DataType } from '../utils/tekton-results'; import { ALL_NAMESPACES_KEY } from '../../consts'; import { getDropDownDate } from './dateTime'; import { LoadingInline } from '../Loading'; +import { DataType } from '../../types'; import './PipelineRunsTotalCard.scss'; diff --git a/src/components/pipelines-overview/list-pages/PipelineRunsListPage.tsx b/src/components/pipelines-overview/list-pages/PipelineRunsListPage.tsx index acdf2cd5..0908d457 100644 --- a/src/components/pipelines-overview/list-pages/PipelineRunsListPage.tsx +++ b/src/components/pipelines-overview/list-pages/PipelineRunsListPage.tsx @@ -14,7 +14,7 @@ import PipelineRunsForPipelinesList from './PipelineRunsForPipelinesList'; import SearchInputField from '../SearchInput'; import { SummaryProps, useInterval, useQueryParams } from '../utils'; import { getResultsSummary } from '../../../components/utils/summary-api'; -import { DataType } from '../../../components/utils/tekton-results'; +import { DataType } from '../../../types'; import { getDropDownDate } from '../dateTime'; import { ALL_NAMESPACES_KEY } from '../../../consts'; diff --git a/src/components/utils/proxy.ts b/src/components/utils/proxy.ts deleted file mode 100644 index f0245dc9..00000000 --- a/src/components/utils/proxy.ts +++ /dev/null @@ -1,65 +0,0 @@ -import { consoleFetchJSON } from '@openshift-console/dynamic-plugin-sdk'; -import { load } from 'js-yaml'; - -export const API_PROXY_URL = '/api/dev-console/proxy/internet'; - -export type ProxyRequest = { - allowAuthHeader?: boolean; - allowInsecure?: boolean; - method: string; - url: string; - headers?: Record; - queryparams?: Record; - body?: string; -}; - -export type ProxyResponse = { - statusCode: number; - headers: Record; - body: string; -}; - -const isJSONString = (str: string): boolean => { - try { - JSON.parse(str); - } catch (e) { - return false; - } - return true; -}; - -export const convertHeaders = (headers): Record => { - return Object.keys(headers).reduce((output, key) => { - output[key] = [headers[key]]; - return output; - }, {}); -}; - -/** - * Calls the proxy in our backend to bypass CORS headers. - */ -export const consoleProxyFetch = async ( - proxyRequest: ProxyRequest, -): Promise => { - const proxyResponse: ProxyResponse = await consoleFetchJSON.post( - API_PROXY_URL, - proxyRequest, - ); - if (!proxyResponse.statusCode) { - throw new Error('Unexpected proxy response: Status code is missing!'); - } - if (proxyResponse.statusCode < 200 || proxyResponse.statusCode >= 300) { - throw new Error(`Unexpected status code: ${proxyResponse.statusCode}`); - } - return proxyResponse; -}; - -export const consoleProxyFetchJSON = ( - proxyRequest: ProxyRequest, -): Promise => { - return consoleProxyFetch(proxyRequest).then((response) => { - return isJSONString(response.body) - ? JSON.parse(response.body) - : load(response.body); - }); -}; diff --git a/src/components/utils/summary-api.ts b/src/components/utils/summary-api.ts index aa1f2bd4..52b8660b 100644 --- a/src/components/utils/summary-api.ts +++ b/src/components/utils/summary-api.ts @@ -1,12 +1,79 @@ -import { SummaryProps } from '../pipelines-overview/utils'; -import { consoleProxyFetchJSON } from './proxy'; +import { consoleFetchJSON } from '@openshift-console/dynamic-plugin-sdk'; +import { HttpError } from '@openshift-console/dynamic-plugin-sdk/lib/utils/error/http-error'; +import { ALL_NAMESPACES_KEY, SUMMARY_FETCH_URL } from '../../consts'; import { + DevConsoleEndpointResponse, + SummaryRequest, + SummaryResponse, TektonResultsOptions, - createTektonResultsSummaryUrl, +} from '../../types'; +import { + AND, + EQ, + MAXIMUM_PAGE_SIZE, + MINIMUM_PAGE_SIZE, + selectorToFilter, } from './tekton-results'; -export type SummaryResponse = { - summary: SummaryProps[]; +export const fetchSummaryURLConfig = async ( + namespace: string, + options?: TektonResultsOptions, + nextPageToken?: string, +): Promise => { + const searchNamespace = + namespace && namespace !== ALL_NAMESPACES_KEY ? namespace : '-'; + const searchParams = `${new URLSearchParams({ + summary: `${options?.summary}`, + ...(options?.groupBy ? { group_by: `${options.groupBy}` } : {}), + // default sort should always be by `create_time desc` + // order_by: 'create_time desc', not supported yet + page_size: `${Math.max( + MINIMUM_PAGE_SIZE, + Math.min( + MAXIMUM_PAGE_SIZE, + options?.limit >= 0 ? options.limit : options?.pageSize ?? 30, + ), + )}`, + ...(nextPageToken ? { page_token: nextPageToken } : {}), + filter: AND( + EQ('data_type', options.data_type?.toString()), + options.filter, + selectorToFilter(options?.selector), + ), + }).toString()}`; + return { searchNamespace, searchParams }; +}; + +/** + * Fetches the Tekton Results Summary data from the backend API + * @param summaryRequest The request object containing the search namespace and search parameters + * @returns The parsed summary response object + */ +const fetchResultsSummary = async ( + summaryRequest: SummaryRequest, +): Promise => { + const resultListResponse: DevConsoleEndpointResponse = + await consoleFetchJSON.post(SUMMARY_FETCH_URL, summaryRequest); + + if (!resultListResponse.statusCode) { + throw new Error('Unexpected proxy response: Status code is missing!'); + } + if ( + resultListResponse.statusCode < 200 || + resultListResponse.statusCode >= 300 + ) { + throw new HttpError( + `Unexpected status code: ${resultListResponse.statusCode}`, + resultListResponse.statusCode, + null, + resultListResponse, + ); + } + try { + return JSON.parse(resultListResponse.body) as SummaryResponse; + } catch (e) { + throw new Error('Failed to parse task details response body as JSON'); + } }; export const getResultsSummary = async ( @@ -14,17 +81,16 @@ export const getResultsSummary = async ( options?: TektonResultsOptions, nextPageToken?: string, ) => { - const url = await createTektonResultsSummaryUrl( - namespace, - options, - nextPageToken, - ); try { - const sData: SummaryResponse = await consoleProxyFetchJSON({ - url, - method: 'GET', - allowInsecure: true, - allowAuthHeader: true, + const { searchNamespace, searchParams } = await fetchSummaryURLConfig( + namespace, + options, + nextPageToken, + ); + + let sData: SummaryResponse = await fetchResultsSummary({ + searchNamespace, + searchParams, }); return sData; diff --git a/src/components/utils/tekton-results.ts b/src/components/utils/tekton-results.ts index c25209b7..649a4bae 100644 --- a/src/components/utils/tekton-results.ts +++ b/src/components/utils/tekton-results.ts @@ -1,72 +1,38 @@ /* eslint-disable @typescript-eslint/no-explicit-any */ import { - k8sGet, + consoleFetchJSON, K8sResourceCommon, MatchExpression, MatchLabels, - Selector, } from '@openshift-console/dynamic-plugin-sdk'; +import { HttpError } from '@openshift-console/dynamic-plugin-sdk/lib/utils/error/http-error'; import _ from 'lodash'; import { RefObject, useEffect } from 'react'; import { ALL_NAMESPACES_KEY, DELETED_RESOURCE_IN_K8S_ANNOTATION, RESOURCE_LOADED_FROM_RESULTS_ANNOTATION, + TEKTON_RESULTS_FETCH_URL, + TEKTON_RESULTS_TASKRUN_LOGS_URL, } from '../../consts'; -import { RouteModel, TektonResultModel } from '../../models'; -import { PipelineRunKind, TaskRunKind } from '../../types'; -import { K8sResourceKind } from '../../types/openshift'; import { - consoleProxyFetch, - consoleProxyFetchJSON, - ProxyRequest, -} from './proxy'; + DataType, + DevConsoleEndpointResponse, + PipelineRunKind, + RecordsList, + TaskRunKind, + TaskRunLogRequest, + TektonResultsOptions, + TRRequest, +} from '../../types'; // REST API spec // https://github.com/tektoncd/results/blob/main/docs/api/rest-api-spec.md // const URL_PREFIX = `/apis/results.tekton.dev/v1alpha2/parents/`; -const MINIMUM_PAGE_SIZE = 5; -const MAXIMUM_PAGE_SIZE = 10000; - -let cachedTektonResultsAPI: string = null; - -export type ResultRecord = { - name: string; - uid: string; - createTime: string; - updateTime: string; - etag: string; - data: { - // tekton.dev/v1.PipelineRun | tekton.dev/v1.TaskRun | results.tekton.dev/v1alpha2.Log - type: string; - value: string; - }; -}; - -export type Log = { - result: { - name: string; - data: string; - }; -}; - -export type RecordsList = { - nextPageToken?: string; - records: ResultRecord[]; -}; - -export type TektonResultsOptions = { - pageSize?: number; - selector?: Selector; - // limit cannot be used in conjuction with pageSize and takes precedence - limit?: number; - filter?: string; - summary?: string; - data_type?: DataType; - groupBy?: string; -}; +export const MINIMUM_PAGE_SIZE = 5; +export const MAXIMUM_PAGE_SIZE = 10000; const throw404 = () => { // eslint-disable-next-line no-throw-literal @@ -117,11 +83,6 @@ export const EQ = (left: string, right: string) => export const NEQ = (left: string, right: string) => EXP(left, `"${right}"`, '!='); -export enum DataType { - PipelineRun = 'tekton.dev/v1.PipelineRun', - TaskRun = 'tekton.dev/v1.TaskRun', -} - export const labelsToFilter = (labels?: MatchLabels): string => labels ? AND( @@ -234,62 +195,66 @@ export const clearCache = () => { }; const InFlightStore: { [key: string]: boolean } = {}; -// const getTRUrlPrefix = (): string => URL_PREFIX; - -export const getTektonResultsAPIUrl = async () => { - if (cachedTektonResultsAPI) { - return cachedTektonResultsAPI; - } else { - const cachedTektonResult: K8sResourceKind = await k8sGet({ - model: TektonResultModel, - name: 'result', - }); - const targetNamespace = cachedTektonResult?.spec?.targetNamespace; - const serverPort = cachedTektonResult?.spec?.server_port ?? '8080'; - const tlsHostname = cachedTektonResult?.spec?.tls_hostname_override; - if (tlsHostname) { - cachedTektonResultsAPI = `${tlsHostname}:${serverPort}`; - } else if (targetNamespace && serverPort) { - cachedTektonResultsAPI = `tekton-results-api-service.${targetNamespace}.svc.cluster.local:${serverPort}`; - } else { - cachedTektonResultsAPI = `tekton-results-api-service.openshift-pipelines.svc.cluster.local:${serverPort}`; - } - return cachedTektonResultsAPI; - } -}; - -export const createTektonResultsUrl = async ( +export const fetchTektonResultsURLConfig = async ( namespace: string, - dataType: DataType, + dataType?: DataType, filter?: string, options?: TektonResultsOptions, nextPageToken?: string, -): Promise => { - const tektonResultsAPI = await getTektonResultsAPIUrl(); - - const namespaceToSearch = +): Promise => { + const searchNamespace = namespace && namespace !== ALL_NAMESPACES_KEY ? namespace : '-'; - const URL = `https://${tektonResultsAPI}/apis/results.tekton.dev/v1alpha2/parents/${namespaceToSearch}/results/-/records?${new URLSearchParams( - { - // default sort should always be by `create_time desc` - // order_by: 'create_time desc', not supported yet - page_size: `${Math.max( - MINIMUM_PAGE_SIZE, - Math.min( - MAXIMUM_PAGE_SIZE, - options?.limit >= 0 ? options.limit : options?.pageSize ?? 50, - ), - )}`, - ...(nextPageToken ? { page_token: nextPageToken } : {}), - filter: AND( - EQ('data_type', dataType.toString()), - filter, - selectorToFilter(options?.selector), - options?.filter, + const searchParams = `${new URLSearchParams({ + // default sort should always be by `create_time desc` + // order_by: 'create_time desc', not supported yet + page_size: `${Math.max( + MINIMUM_PAGE_SIZE, + Math.min( + MAXIMUM_PAGE_SIZE, + options?.limit >= 0 ? options.limit : options?.pageSize ?? 50, ), - }, - ).toString()}`; - return URL; + )}`, + ...(nextPageToken ? { page_token: nextPageToken } : {}), + filter: AND( + EQ('data_type', dataType.toString()), + filter, + selectorToFilter(options?.selector), + options?.filter, + ), + }).toString()}`; + return { searchNamespace, searchParams }; +}; + +/** + * Fetches the Tekton results from the Tekton Results API. + * @param tRRequest The request object containing the search namespace and search parameters + * @returns The parsed results list + */ +const fetchTektonResults = async ( + tRRequest: TRRequest, +): Promise => { + const resultListResponse: DevConsoleEndpointResponse = + await consoleFetchJSON.post(TEKTON_RESULTS_FETCH_URL, tRRequest); + + if (!resultListResponse.statusCode) { + throw new Error('Unexpected proxy response: Status code is missing!'); + } + if ( + resultListResponse.statusCode < 200 || + resultListResponse.statusCode >= 300 + ) { + throw new HttpError( + `Unexpected status code: ${resultListResponse.statusCode}`, + resultListResponse.statusCode, + null, + resultListResponse, + ); + } + try { + return JSON.parse(resultListResponse.body) as RecordsList; + } catch (e) { + throw new Error('Failed to parse task details response body as JSON'); + } }; export const getFilteredRecord = async ( @@ -319,18 +284,18 @@ export const getFilteredRecord = async ( InFlightStore[cacheKey] = true; const value = await (async (): Promise<[R[], RecordsList]> => { try { - const url = await createTektonResultsUrl( - namespace, - dataType, - filter, - options, - nextPageToken, - ); - let list: RecordsList = await consoleProxyFetchJSON({ - url, - method: 'GET', - allowInsecure: true, - allowAuthHeader: true, + const { searchNamespace, searchParams } = + await fetchTektonResultsURLConfig( + namespace, + dataType, + filter, + options, + nextPageToken, + ); + + let list: RecordsList = await fetchTektonResults({ + searchNamespace, + searchParams, }); if (options?.limit >= 0) { list = { @@ -412,38 +377,6 @@ export const getTaskRuns = ( cacheKey?: string, ) => getFilteredTaskRuns(namespace, '', options, nextPageToken, cacheKey); -export const createTektonResultsSummaryUrl = async ( - namespace: string, - options?: TektonResultsOptions, - nextPageToken?: string, -): Promise => { - const tektonResultsAPI = await getTektonResultsAPIUrl(); - const namespaceToSearch = - namespace && namespace !== ALL_NAMESPACES_KEY ? namespace : '-'; - const URL = `https://${tektonResultsAPI}/apis/results.tekton.dev/v1alpha2/parents/${namespaceToSearch}/results/-/records/summary?${new URLSearchParams( - { - summary: `${options?.summary}`, - ...(options?.groupBy ? { group_by: `${options.groupBy}` } : {}), - // default sort should always be by `create_time desc` - // order_by: 'create_time desc', not supported yet - page_size: `${Math.max( - MINIMUM_PAGE_SIZE, - Math.min( - MAXIMUM_PAGE_SIZE, - options?.limit >= 0 ? options.limit : options?.pageSize ?? 30, - ), - )}`, - ...(nextPageToken ? { page_token: nextPageToken } : {}), - filter: AND( - EQ('data_type', options.data_type?.toString()), - options.filter, - selectorToFilter(options?.selector), - ), - }, - ).toString()}`; - return URL; -}; - const isJSONString = (str: string): boolean => { try { JSON.parse(str); @@ -453,44 +386,45 @@ const isJSONString = (str: string): boolean => { return true; }; -export const consoleProxyFetchLog = ( - proxyRequest: ProxyRequest, +/** + * Fetches the task run logs from the Tekton Results API. + * @param taskRunLogRequest The request object containing the task run path. + * @returns The task run logs. + */ +const fetchTaskRunLogs = async ( + taskRunLogRequest: TaskRunLogRequest, ): Promise => { - return consoleProxyFetch(proxyRequest).then((response) => { - return isJSONString(response.body) - ? JSON.parse(response.body) - : response.body; - }); -}; - -export const getTRURLHost = async () => { - const tektonResult: K8sResourceKind = await k8sGet({ - model: TektonResultModel, - name: 'result', - }); - const targetNamespace = tektonResult?.spec?.targetNamespace; - const route: K8sResourceKind = await k8sGet({ - model: RouteModel, - name: 'tekton-results-api-service', - ns: targetNamespace, - }); - return route?.spec.host; + const taskRunLogResponse: DevConsoleEndpointResponse = + await consoleFetchJSON.post( + TEKTON_RESULTS_TASKRUN_LOGS_URL, + taskRunLogRequest, + ); + + if (!taskRunLogResponse.statusCode) { + throw new Error('Unexpected proxy response: Status code is missing!'); + } + if ( + taskRunLogResponse.statusCode < 200 || + taskRunLogResponse.statusCode >= 300 + ) { + throw new HttpError( + `Unexpected status code: ${taskRunLogResponse.statusCode}`, + taskRunLogResponse.statusCode, + null, + taskRunLogResponse, + ); + } + return isJSONString(taskRunLogResponse.body) + ? JSON.parse(taskRunLogResponse.body) + : taskRunLogResponse.body; }; export const getTaskRunLog = async (taskRunPath: string): Promise => { if (!taskRunPath) { throw404(); } - const tektonResultsAPI = await getTektonResultsAPIUrl(); - const url = `https://${tektonResultsAPI}/apis/results.tekton.dev/v1alpha2/parents/${taskRunPath.replace( - '/records/', - '/logs/', - )}`; - return consoleProxyFetchLog({ - url, - method: 'GET', - allowInsecure: true, - allowAuthHeader: true, + return fetchTaskRunLogs({ + taskRunPath: taskRunPath.replace('/records/', '/logs/'), }); }; diff --git a/src/consts.ts b/src/consts.ts index 3588ca73..30896676 100644 --- a/src/consts.ts +++ b/src/consts.ts @@ -160,3 +160,16 @@ export enum StartedByLabel { } export const TRIGGER_BINDING_EMPTY = '#empty-trigger-binding#'; + +export const GITHUB_BASE_URL = 'https://github.com'; + +/* Backend API Endpoints */ +export const TEKTON_RESULTS_TASKRUN_LOGS_URL = + '/api/dev-console/tekton-results/logs'; +export const TEKTON_RESULTS_FETCH_URL = '/api/dev-console/tekton-results/get'; +export const SUMMARY_FETCH_URL = '/api/dev-console/tekton-results/summary'; + +export const ARTIFACTHUB_SEARCH_URL = '/api/dev-console/artifacthub/search'; +export const ARTIFACTHUB_TASK_DETAILS_URL = '/api/dev-console/artifacthub/get'; +export const GITHUB_ARTIFACTHUB_TASK_YAML_URL = + '/api/dev-console/artifacthub/yaml'; diff --git a/src/types/artifacthub.ts b/src/types/artifacthub.ts new file mode 100644 index 00000000..612e3f23 --- /dev/null +++ b/src/types/artifacthub.ts @@ -0,0 +1,52 @@ +export type ArtifactHubRepository = { + name: string; + kind: number; + url: string; + display_name: string; + repository_id: string; + organization_name: string; + organization_display_name: string; +}; + +export type ArtifactHubVersion = { + version: string; + contains_security_update: boolean; + prerelease: boolean; + ts: number; +}; + +export type ArtifactHubTask = { + package_id: string; + name: string; + description: string; + version: string; + display_name: string; + repository: ArtifactHubRepository; +}; + +export type ArtifactHubTaskDetails = { + package_id: string; + name: string; + description: string; + display_name: string; + keywords: string[]; + platforms: string[]; + version: ArtifactHubVersion[]; + available_versions: []; + content_url: string; + repository: ArtifactHubRepository; +}; + +export type TaskSearchRequest = { + searchQuery?: string; +}; + +export type TaskDetailsRequest = { + repoName: string; + name: string; + version: string; +}; + +export type TaskYAMLRequest = { + yamlPath: string; +}; diff --git a/src/types/backendAPI.ts b/src/types/backendAPI.ts new file mode 100644 index 00000000..cc8e049c --- /dev/null +++ b/src/types/backendAPI.ts @@ -0,0 +1,5 @@ +export type DevConsoleEndpointResponse = { + statusCode: number; + headers: Record; + body: string; +}; diff --git a/src/types/index.ts b/src/types/index.ts index 64c04634..a37a6d33 100644 --- a/src/types/index.ts +++ b/src/types/index.ts @@ -15,6 +15,8 @@ export type Status = components['schemas']['Status']; export type RecordType = components['schemas']['RecordType']; export * from './approvals'; +export * from './artifacthub'; +export * from './backendAPI'; export * from './common'; export * from './coreTekton'; export * from './openshift'; @@ -22,6 +24,7 @@ export * from './pipeline'; export * from './pipelineResource'; export * from './pipelineRun'; export * from './repository'; +export * from './resultsSummary'; export * from './task'; export * from './taskRun'; export * from './triggers'; diff --git a/src/types/resultsSummary.ts b/src/types/resultsSummary.ts new file mode 100644 index 00000000..bcaf32f2 --- /dev/null +++ b/src/types/resultsSummary.ts @@ -0,0 +1,61 @@ +import { Selector } from '@openshift-console/dynamic-plugin-sdk'; +import { SummaryProps } from 'src/components/pipelines-overview/utils'; + +export enum DataType { + PipelineRun = 'tekton.dev/v1.PipelineRun', + TaskRun = 'tekton.dev/v1.TaskRun', +} + +export type ResultRecord = { + name: string; + uid: string; + createTime: string; + updateTime: string; + etag: string; + data: { + // tekton.dev/v1.PipelineRun | tekton.dev/v1.TaskRun | results.tekton.dev/v1alpha2.Log + type: string; + value: string; + }; +}; + +export type TRRequest = { + searchNamespace: string; + searchParams: string; +}; + +export type TaskRunLogRequest = { + taskRunPath: string; +}; + +export type Log = { + result: { + name: string; + data: string; + }; +}; + +export type RecordsList = { + nextPageToken?: string; + records: ResultRecord[]; +}; + +export type TektonResultsOptions = { + pageSize?: number; + selector?: Selector; + // limit cannot be used in conjuction with pageSize and takes precedence + limit?: number; + filter?: string; + summary?: string; + data_type?: DataType; + groupBy?: string; +}; + +export type SummaryRequest = { + searchNamespace: string; + searchParams: string; +}; + +export type SummaryResponse = { + summary: SummaryProps[]; +};