Press n or j to go to the next uncovered block, b, p or k for the previous block.
| 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 | 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 1x 1x 4x 4x 1x 2x 1x 4x 2x 1x 2x 1x 2x 1x 2x 2x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x | /*
* Copyright 2021 Harness Inc. All rights reserved.
* Use of this source code is governed by the PolyForm Shield 1.0.0 license
* that can be found in the licenses directory at the root of this repository, also available at
* https://polyformproject.org/wp-content/uploads/2020/06/PolyForm-Shield-1.0.0.txt.
*/
import {
Button,
ButtonVariation,
Container,
Icon,
Layout,
Switch,
Text,
tagsType,
VisualYamlSelectedView as SelectedView,
VisualYamlToggle,
HarnessDocTooltip
} from '@wings-software/uicore'
import { Color } from '@harness/design-system'
import React, { ReactNode } from 'react'
import { useHistory, useParams } from 'react-router-dom'
import { isEmpty } from 'lodash-es'
import { parse } from 'yaml'
import type { MutateMethod } from 'restful-react'
import { Page, useToaster } from '@common/exports'
import {
NGTriggerConfigV2,
useGetTriggerDetails,
ResponseNGTriggerDetailsResponse,
ResponseNGTriggerResponse,
UpdateTriggerQueryParams,
UpdateTriggerPathParams,
useUpdateTrigger,
useGetSchemaYaml,
useGetPipelineSummary
} from 'services/pipeline-ng'
import { useStrings, UseStringsReturn } from 'framework/strings'
import { TagsPopover, PageSpinner } from '@common/components'
import { usePermission } from '@rbac/hooks/usePermission'
import { PermissionIdentifier } from '@rbac/interfaces/PermissionIdentifier'
import { ResourceType } from '@rbac/interfaces/ResourceType'
import { getScopeFromDTO } from '@common/components/EntityReference/EntityReference'
import DetailPageCard, { ContentType, Content } from '@common/components/DetailPageCard/DetailPageCard'
import routes from '@common/RouteDefinitions'
import type { GitQueryParams, PipelineType } from '@common/interfaces/RouteInterfaces'
import YAMLBuilder from '@common/components/YAMLBuilder/YamlBuilder'
import type { YamlBuilderProps } from '@common/interfaces/YAMLBuilderProps'
import { useDocumentTitle } from '@common/hooks/useDocumentTitle'
import { useQueryParams } from '@common/hooks'
import { yamlStringify } from '@common/utils/YamlHelperMethods'
import { TriggerBreadcrumbs } from '../trigger-details/TriggerDetails'
import { getTriggerIcon, getEnabledStatusTriggerValues } from './utils/TriggersListUtils'
import { clearNullUndefined, ResponseStatus } from './utils/TriggersWizardPageUtils'
import css from './TriggersDetailPage.module.scss'
const loadingHeaderHeight = 43
export interface ConditionInterface {
key: string
operator: string
value: string
}
const getTriggerConditionsStr = (payloadConditions: ConditionInterface[]): string[] => {
const arr: string[] = []
payloadConditions.forEach(condition => {
const { key, operator, value } = condition
arr.push(`${key} ${operator} ${value}`)
})
return arr
}
const renderConditions = ({
conditionsArr,
jexlCondition,
cronExpression,
getString
}: {
conditionsArr: string[]
jexlCondition?: string
cronExpression?: string
getString: UseStringsReturn['getString']
}): JSX.Element => (
<Layout.Vertical style={{ overflowX: 'hidden' }} spacing="medium">
{conditionsArr.length ? (
<>
<Text style={{ fontSize: '12px' }}>{getString('conditions')}</Text>
{conditionsArr.map(conditionStr => (
<Text color={Color.BLACK} key={conditionStr} width="424px" lineClamp={1}>
{conditionStr}
</Text>
))}
</>
) : null}
{jexlCondition ? (
<>
<Text style={{ fontSize: '12px' }}>{getString('triggers.conditionsPanel.jexlCondition')}</Text>
<Text color={Color.BLACK} width="424px" lineClamp={1}>
{jexlCondition}
</Text>
</>
) : null}
{cronExpression ? (
<>
<Text style={{ fontSize: '12px' }}>{getString('triggers.schedulePanel.cronExpression')}</Text>
<Text color={Color.BLACK} width="424px" lineClamp={1}>
{cronExpression}
</Text>
</>
) : null}
</Layout.Vertical>
)
const getOverviewContent = ({
getString,
name,
description,
identifier,
tags
}: {
getString: UseStringsReturn['getString']
name?: string
description?: string
identifier?: string
tags?: tagsType
}): Content[] => [
{
label: getString('triggers.triggerConfigurationPanel.triggerName'),
value: name
},
{
label: getString('description'),
value: description || '-'
},
{
label: getString('identifier'),
value: identifier
},
{
label: getString('tagsLabel'),
value: !isEmpty(tags) ? <TagsPopover tags={tags as tagsType} /> : undefined
}
]
const getDetailsContent = ({
getString,
conditionsExist,
conditionsArr,
jexlCondition,
cronExpression,
pipelineInputSet
}: {
getString: UseStringsReturn['getString']
conditionsExist: boolean
conditionsArr: string[]
jexlCondition?: string
cronExpression?: string
pipelineInputSet?: string
}): Content[] => [
{
label: '',
value: conditionsExist ? renderConditions({ conditionsArr, jexlCondition, cronExpression, getString }) : undefined,
hideOnUndefinedValue: true,
type: ContentType.CUSTOM
},
{
label: getString('triggers.pipelineExecutionInput'),
value: !isEmpty(pipelineInputSet) ? <pre>{pipelineInputSet}</pre> : undefined,
type: ContentType.CUSTOM
}
]
const renderSwitch = ({
getString,
isTriggerRbacDisabled,
triggerResponse,
updateTrigger,
showSuccess,
showError,
refetchTrigger
}: {
getString: UseStringsReturn['getString']
isTriggerRbacDisabled: boolean
triggerResponse: ResponseNGTriggerDetailsResponse
// triggerResponse: ResponseNGTriggerDetailsResponse
updateTrigger: MutateMethod<
ResponseNGTriggerResponse,
NGTriggerConfigV2,
UpdateTriggerQueryParams,
UpdateTriggerPathParams
>
showSuccess: (message: string | ReactNode, timeout?: number, key?: string) => void
showError: (message: string | ReactNode, timeout?: number, key?: string) => void
refetchTrigger: () => void
}): JSX.Element => (
<Switch
style={{ paddingLeft: '46px' }}
label={getString('enabledLabel')}
disabled={isTriggerRbacDisabled}
checked={triggerResponse.data?.enabled ?? false}
onChange={async () => {
const { values, error } = getEnabledStatusTriggerValues({
data: triggerResponse.data,
enabled: !!(triggerResponse.data && !triggerResponse.data.enabled),
getString
})
if (error) {
showError(error, undefined, 'pipeline.enable.status.error')
return
}
try {
const { status, data } = await updateTrigger(yamlStringify({ trigger: clearNullUndefined(values) }) as any)
const dataEnabled = data?.enabled ? 'enabled' : 'disabled'
if (data?.errors && !isEmpty(data?.errors)) {
showError(getString('triggers.toast.existingTriggerError'))
return
} else if (status === ResponseStatus.SUCCESS) {
showSuccess(
getString('triggers.toast.toggleEnable', {
enabled: dataEnabled,
name: data?.name
})
)
refetchTrigger()
}
} catch (err) {
showError(err?.data?.message, undefined, 'pipeline.common.trigger.error')
}
}}
/>
)
export default function TriggersDetailPage(): JSX.Element {
const { repoIdentifier, branch } = useQueryParams<GitQueryParams>()
const [selectedView, setSelectedView] = React.useState<SelectedView>(SelectedView.VISUAL)
const { orgIdentifier, projectIdentifier, pipelineIdentifier, accountId, triggerIdentifier, module } = useParams<
PipelineType<{
projectIdentifier: string
orgIdentifier: string
accountId: string
pipelineIdentifier: string
triggerIdentifier: string
}>
>()
const {
data: triggerResponse,
refetch: refetchTrigger,
loading: loadingTrigger
} = useGetTriggerDetails({
triggerIdentifier,
queryParams: {
accountIdentifier: accountId,
orgIdentifier,
projectIdentifier,
targetIdentifier: pipelineIdentifier
}
})
const { mutate: updateTrigger, loading: updateTriggerLoading } = useUpdateTrigger({
triggerIdentifier,
queryParams: {
accountIdentifier: accountId,
orgIdentifier,
projectIdentifier,
targetIdentifier: pipelineIdentifier
},
requestOptions: { headers: { 'content-type': 'application/yaml' } }
})
const [isExecutable] = usePermission(
{
resourceScope: {
projectIdentifier: projectIdentifier,
orgIdentifier: orgIdentifier,
accountIdentifier: accountId
},
resource: {
resourceType: ResourceType.PIPELINE,
resourceIdentifier: pipelineIdentifier
},
permissions: [PermissionIdentifier.EXECUTE_PIPELINE],
options: {
skipCache: true
}
},
[projectIdentifier, orgIdentifier, accountId, pipelineIdentifier]
)
const history = useHistory()
const goToEditWizard = (): void => {
history.push(
routes.toTriggersWizardPage({
accountId,
orgIdentifier,
projectIdentifier,
pipelineIdentifier,
triggerIdentifier,
triggerType: triggerResponse?.data?.type,
module,
repoIdentifier,
branch
})
)
}
const { loading, data: pipelineSchema } = useGetSchemaYaml({
queryParams: {
entityType: 'Triggers',
projectIdentifier,
orgIdentifier,
accountIdentifier: accountId,
scope: getScopeFromDTO({ accountIdentifier: accountId, orgIdentifier, projectIdentifier })
}
})
let triggerJSON
const triggerResponseYaml = triggerResponse?.data?.yaml || ''
try {
triggerJSON = parse(triggerResponseYaml)
} catch (e) {
// ignore error
}
const yamlBuilderReadOnlyModeProps: YamlBuilderProps = {
fileName: `${triggerResponse?.data?.identifier ?? 'Trigger'}.yaml`,
entityType: 'Triggers',
existingJSON: triggerJSON,
width: 900
}
const { showSuccess, showError } = useToaster()
const { getString } = useStrings()
const triggerObj = parse(triggerResponseYaml)?.trigger as NGTriggerConfigV2
const pipelineInputSet = triggerObj?.inputYaml
let conditionsArr: string[] = []
const headerConditionsArr: string[] = triggerObj?.source?.spec?.spec?.headerConditions?.length
? getTriggerConditionsStr(triggerObj.source.spec.spec.headerConditions)
: []
const payloadConditionsArr: string[] = triggerObj?.source?.spec?.spec?.payloadConditions?.length
? getTriggerConditionsStr(triggerObj.source.spec.spec.payloadConditions)
: []
const eventConditionsArr: string[] = triggerObj?.source?.spec?.spec?.eventConditions?.length
? getTriggerConditionsStr(triggerObj.source.spec.spec.eventConditions)
: []
conditionsArr = conditionsArr.concat(headerConditionsArr)
conditionsArr = conditionsArr.concat(payloadConditionsArr)
conditionsArr = conditionsArr.concat(eventConditionsArr)
const jexlCondition = triggerObj?.source?.spec?.spec?.jexlCondition
const cronExpression = triggerObj?.source?.spec?.spec?.expression
const conditionsExist = [...conditionsArr, jexlCondition, cronExpression].some(x => !!x)
const { data: pipeline } = useGetPipelineSummary({
pipelineIdentifier,
queryParams: {
accountIdentifier: accountId,
orgIdentifier,
projectIdentifier,
repoIdentifier,
branch
}
})
useDocumentTitle([
pipeline?.data?.name || getString('pipelines'),
triggerResponse?.data?.name || getString('common.triggersLabel')
])
const isPipelineInvalid = pipeline?.data?.entityValidityDetails?.valid === false
const isTriggerRbacDisabled = !isExecutable || isPipelineInvalid
return (
<>
<Container
style={{ borderBottom: '1px solid var(--grey-200)', padding: '12px 24px 10px 24px' }}
padding={{ top: 'xlarge', left: 'xlarge', bottom: 'medium', right: 'xlarge' }}
background={Color.PRIMARY_1}
>
<Layout.Vertical spacing="medium">
<TriggerBreadcrumbs pipelineResponse={pipeline} />
{loadingTrigger && <Container height={loadingHeaderHeight} />}
{triggerResponse && !loadingTrigger && (
<Layout.Horizontal spacing="medium" style={{ alignItems: 'center' }}>
<Icon
name={
triggerResponse.data?.type
? getTriggerIcon({
type: triggerResponse.data.type,
webhookSourceRepo: triggerResponse.data.webhookDetails?.webhookSourceRepo,
buildType: triggerResponse.data.buildDetails?.buildType
})
: 'yaml-builder-trigger'
}
size={35}
/>
<Layout.Horizontal spacing="small" data-testid={triggerResponse.data?.identifier}>
<Layout.Vertical padding={{ left: 'small' }}>
<Layout.Horizontal spacing="medium" style={{ alignItems: 'center' }}>
<Text style={{ fontSize: 20, fontWeight: 600 }} color={Color.GREY_700}>
{triggerResponse.data?.name}
</Text>
{renderSwitch({
getString,
isTriggerRbacDisabled,
triggerResponse,
updateTrigger,
showSuccess,
refetchTrigger,
showError
})}
</Layout.Horizontal>
<Text>
{getString('common.ID')}: {triggerResponse.data?.identifier}
</Text>
</Layout.Vertical>
</Layout.Horizontal>
</Layout.Horizontal>
)}
</Layout.Vertical>
</Container>
<Page.Body loading={loadingTrigger || updateTriggerLoading} className={css.main}>
<Layout.Horizontal className={css.panel}>
<Layout.Vertical spacing="medium" className={css.information}>
<Layout.Horizontal flex={{ distribution: 'space-between' }}>
<VisualYamlToggle
selectedView={selectedView}
onChange={nextMode => {
setSelectedView(nextMode)
}}
/>
<Button
variation={ButtonVariation.SECONDARY}
icon="edit"
onClick={goToEditWizard}
minimal
disabled={isTriggerRbacDisabled}
tooltip={isPipelineInvalid ? getString('pipeline.cannotEditTriggerInvalidPipeline') : ''}
text={getString('edit')}
></Button>
</Layout.Horizontal>
{selectedView === SelectedView.VISUAL ? (
<Layout.Horizontal spacing="medium">
<DetailPageCard
title={getString('overview')}
content={getOverviewContent({
getString,
name: triggerResponse?.data?.name,
description: triggerResponse?.data?.description,
identifier: triggerResponse?.data?.identifier,
tags: triggerResponse?.data?.tags
})}
/>
<DetailPageCard
classname={css.inputSet}
title={getString('details')}
content={getDetailsContent({
getString,
conditionsExist,
conditionsArr,
jexlCondition,
cronExpression,
pipelineInputSet
})}
/>
</Layout.Horizontal>
) : (
<div className={css.editor}>
{loading ? (
<PageSpinner />
) : (
<YAMLBuilder
{...yamlBuilderReadOnlyModeProps}
isReadOnlyMode={true}
showSnippetSection={false}
schema={pipelineSchema?.data}
onEnableEditMode={goToEditWizard}
isEditModeSupported={!isPipelineInvalid}
// isEditModeSupported={!isTriggerRbacDisabled}
/>
)}
</div>
)}
</Layout.Vertical>
<Layout.Vertical style={{ flex: 1 }}>
<Layout.Horizontal spacing="xxlarge">
<Text font={{ size: 'medium', weight: 'bold' }} inline={true} color={Color.GREY_800}>
{getString('triggers.lastActivationDetails')}
<HarnessDocTooltip tooltipId="lastActivationDetails" useStandAlone={true} />
</Text>
{triggerResponse?.data?.lastTriggerExecutionDetails?.lastExecutionSuccessful === false ? (
<Text
tooltip={triggerResponse?.data?.lastTriggerExecutionDetails?.message}
icon="warning-sign"
iconProps={{ color: Color.RED_500 }}
color={Color.RED_500}
font={{ size: 'medium' }}
inline={true}
>
{getString('failed')}
</Text>
) : (
triggerResponse?.data?.lastTriggerExecutionDetails?.lastExecutionSuccessful === true && (
<Text
tooltip={triggerResponse?.data?.lastTriggerExecutionDetails?.message}
icon="execution-success"
color={Color.GREEN_500}
iconProps={{ color: Color.GREEN_500 }}
font={{ size: 'medium' }}
inline={true}
>
{getString('passed')}
</Text>
)
)}
</Layout.Horizontal>
<Layout.Vertical spacing="small" margin={{ top: 'small' }}>
<div>
{triggerResponse?.data?.lastTriggerExecutionDetails?.lastExecutionTime ? (
<Text>
{`${getString('triggers.lastActivationAt')}: ${new Date(
triggerResponse.data.lastTriggerExecutionDetails.lastExecutionTime
).toLocaleDateString()} ${new Date(
triggerResponse.data.lastTriggerExecutionDetails.lastExecutionTime
).toLocaleTimeString()}`}
</Text>
) : (
<Text>{`${getString('triggers.lastActivationAt')}: -`}</Text>
)}
</div>
<hr />
</Layout.Vertical>
</Layout.Vertical>
</Layout.Horizontal>
</Page.Body>
</>
)
}
|