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 | 8x 8x 8x 8x 8x 8x 8x 8x 8x 8x 8x 8x 8x 8x 8x 8x 8x 8x 8x 8x 8x 8x 8x 8x 8x 8x 8x 8x 8x 8x 8x 58x 58x 58x 58x 58x 58x 58x 58x 58x 58x 58x 58x 58x 58x 58x 58x 58x 58x 58x 58x 58x 58x 58x 1x 58x 58x 58x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 2x 1x 1x 1x 3x 1x 1x 1x 1x 58x 4x 4x 4x 58x 4x 58x 5x 5x 5x 5x 5x 5x 4x 4x 4x 4x 4x 1x 58x 58x 9x 49x 49x 48x 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 React from 'react'
import { Menu, Position } from '@blueprintjs/core'
import {
Button,
ButtonVariation,
Icon,
IconName,
Popover,
Text,
VisualYamlSelectedView as SelectedView,
useToaster
} from '@wings-software/uicore'
import { useHistory, useParams } from 'react-router-dom'
import { get, isEmpty, noop, omit } from 'lodash-es'
import cx from 'classnames'
import type { PopoverProps } from '@wings-software/uicore/dist/components/Popover/Popover'
import { parse } from 'yaml'
import { useModalHook } from '@harness/use-modal'
import { useStrings } from 'framework/strings'
import { PermissionIdentifier } from '@rbac/interfaces/PermissionIdentifier'
import { ResourceType } from '@rbac/interfaces/ResourceType'
import { usePermission } from '@rbac/hooks/usePermission'
import { useFeatureFlag, useFeatureFlags } from '@common/hooks/useFeatureFlag'
import { FeatureFlag } from '@common/featureFlags'
import { useFeature } from '@common/hooks/useFeatures'
import { savePipeline, usePipelineContext } from '@pipeline/components/PipelineStudio/PipelineContext/PipelineContext'
import type { SaveToGitFormInterface } from '@common/components/SaveToGitForm/SaveToGitForm'
import { UseSaveSuccessResponse, useSaveToGitDialog } from '@common/modals/SaveToGitDialog/useSaveToGitDialog'
import {
DefaultNewPipelineId,
SplitViewTypes
} from '@pipeline/components/PipelineStudio/PipelineContext/PipelineActions'
import { PipelineActions } from '@common/constants/TrackingConstants'
import { validateCICodebaseConfiguration } from '@pipeline/components/PipelineStudio/StepUtil'
import { validateJSONWithSchema } from '@common/utils/YamlUtils'
import { useQueryParams } from '@common/hooks'
import type {
GitQueryParams,
PathFn,
PipelinePathProps,
PipelineStudioQueryParams,
PipelineType
} from '@common/interfaces/RouteInterfaces'
import { useTelemetry } from '@common/hooks/useTelemetry'
import { usePipelineSchema } from '@pipeline/components/PipelineStudio/PipelineSchema/PipelineSchemaContext'
import { useSaveAsTemplate } from '@pipeline/components/PipelineStudio/SaveTemplateButton/useSaveAsTemplate'
import { AppStoreContext } from 'framework/AppStore/AppStoreContext'
import type { PipelineInfoConfig } from 'services/cd-ng'
import { FeatureIdentifier } from 'framework/featureStore/FeatureIdentifier'
import type { GovernanceMetadata } from 'services/pipeline-ng'
import PipelineErrors from '@pipeline/components/PipelineStudio/PipelineCanvas/PipelineErrors/PipelineErrors'
import type { AccessControlCheckError } from 'services/rbac'
import useRBACError from '@rbac/utils/useRBACError/useRBACError'
import css from './SavePipelinePopover.module.scss'
export interface SavePipelinePopoverProps extends PopoverProps {
className?: string
toPipelineStudio: PathFn<PipelineType<PipelinePathProps> & PipelineStudioQueryParams>
setGovernanceMetadata: (data: GovernanceMetadata | undefined) => void
isValidYaml: () => boolean
}
interface SavePipelineObj {
pipeline: PipelineInfoConfig
}
interface SavePipelineMenuItem {
icon?: IconName
label: string
onClick: () => void
disabled?: boolean
}
export function SavePipelinePopover({
toPipelineStudio,
setGovernanceMetadata,
isValidYaml,
className = '',
portalClassName,
...popoverProps
}: SavePipelinePopoverProps): React.ReactElement {
const { isGitSyncEnabled } = React.useContext(AppStoreContext)
const {
state: { pipeline, yamlHandler, gitDetails, pipelineView, isUpdated },
deletePipelineCache,
fetchPipeline,
view,
setSchemaErrorView,
setSelection,
isReadonly,
updatePipelineView
} = usePipelineContext()
const [loading, setLoading] = React.useState<boolean>()
const { branch } = useQueryParams<GitQueryParams>()
const { trackEvent } = useTelemetry()
const { pipelineSchema } = usePipelineSchema()
const { showSuccess, showError, clear } = useToaster()
const { getRBACErrorMessage } = useRBACError()
const { getString } = useStrings()
const { OPA_PIPELINE_GOVERNANCE } = useFeatureFlags()
const history = useHistory()
const { projectIdentifier, orgIdentifier, accountId, pipelineIdentifier, module } =
useParams<PipelineType<PipelinePathProps>>()
const isYaml = view === SelectedView.YAML
const [menuOpen, setMenuOpen] = React.useState(false)
const templatesFeatureFlagEnabled = useFeatureFlag(FeatureFlag.NG_TEMPLATES)
const pipelineTemplatesFeatureFlagEnabled = useFeatureFlag(FeatureFlag.NG_PIPELINE_TEMPLATE)
const [updatePipelineAPIResponse, setUpdatePipelineAPIResponse] = React.useState<any>()
const { enabled: templatesFeatureEnabled } = useFeature({
featureRequest: {
featureName: FeatureIdentifier.TEMPLATE_SERVICE
}
})
const [canEdit] = usePermission({
resource: {
resourceType: ResourceType.TEMPLATE
},
permissions: [PermissionIdentifier.EDIT_TEMPLATE]
})
const isTemplatesEnabled =
templatesFeatureEnabled &&
templatesFeatureFlagEnabled &&
pipelineTemplatesFeatureFlagEnabled &&
canEdit &&
!pipeline.template
const isSaveEnabled = !isReadonly && isUpdated
const { save } = useSaveAsTemplate({ data: pipeline, type: 'Pipeline' })
const navigateToLocation = (newPipelineId: string, updatedGitDetails?: SaveToGitFormInterface): void => {
history.replace(
toPipelineStudio({
projectIdentifier,
orgIdentifier,
pipelineIdentifier: newPipelineId,
accountId,
module,
repoIdentifier: updatedGitDetails?.repoIdentifier,
branch: updatedGitDetails?.branch
})
)
}
const gotoViewWithDetails = React.useCallback(
({ stageId, stepId }: { stageId?: string; stepId?: string } = {}): void => {
hideErrorModal()
// If Yaml mode, or if pipeline error - stay on yaml mode
if (isYaml || (!stageId && !stepId)) {
return
}
setSelection({ stageId, stepId })
updatePipelineView({
...pipelineView,
isSplitViewOpen: true,
splitViewData: { type: SplitViewTypes.StageView }
})
},
[isYaml, pipelineView]
)
const [showErrorModal, hideErrorModal] = useModalHook(
() => (
<PipelineErrors
errors={updatePipelineAPIResponse?.metadata?.schemaErrors}
gotoViewWithDetails={gotoViewWithDetails}
onClose={hideErrorModal}
/>
),
[updatePipelineAPIResponse]
)
const saveAndPublishPipeline = async (
latestPipeline: PipelineInfoConfig,
updatedGitDetails?: SaveToGitFormInterface,
lastObject?: { lastObjectId?: string }
): Promise<UseSaveSuccessResponse> => {
setLoading(true)
setSchemaErrorView(false)
const isEdit = pipelineIdentifier !== DefaultNewPipelineId
const response = await savePipeline(
{
accountIdentifier: accountId,
projectIdentifier,
orgIdentifier,
...(updatedGitDetails ?? {}),
...(lastObject ?? {}),
...(updatedGitDetails && updatedGitDetails.isNewBranch ? { baseBranch: branch } : {})
},
omit(latestPipeline, 'repo', 'branch'),
isEdit,
!!OPA_PIPELINE_GOVERNANCE
)
setLoading(false)
const newPipelineId = latestPipeline?.identifier
Eif (response && response.status === 'SUCCESS') {
const governanceData: GovernanceMetadata | undefined = get(response, 'data.governanceMetadata')
setGovernanceMetadata(governanceData)
// Handling cache and page navigation only when Governance is disabled, or Governance Evaluation is successful
// Otherwise, keep current pipeline editing states, and show Governance evaluation error
Eif (governanceData?.status !== 'error') {
if (pipelineIdentifier === DefaultNewPipelineId) {
await deletePipelineCache(gitDetails)
showSuccess(getString('pipelines-studio.publishPipeline'))
navigateToLocation(newPipelineId, updatedGitDetails)
// note: without setTimeout does not redirect properly after save
await fetchPipeline({ forceFetch: true, forceUpdate: true, newPipelineId })
} else {
await fetchPipeline({ forceFetch: true, forceUpdate: true })
}
Iif (updatedGitDetails?.isNewBranch) {
navigateToLocation(newPipelineId, updatedGitDetails)
location.reload()
}
}
Iif (isEdit) {
trackEvent(isYaml ? PipelineActions.PipelineUpdatedViaYAML : PipelineActions.PipelineUpdatedViaVisual, {})
} else {
trackEvent(isYaml ? PipelineActions.PipelineCreatedViaYAML : PipelineActions.PipelineCreatedViaVisual, {})
}
} else {
clear()
setSchemaErrorView(true)
// This is done because when git sync is enabled, errors are displayed in a modal
if (!isGitSyncEnabled) {
// eslint-disable-next-line
// @ts-ignore
if (response?.metadata?.schemaErrors?.length) {
setUpdatePipelineAPIResponse(response)
showErrorModal()
} else {
showError(
getRBACErrorMessage({ data: response as AccessControlCheckError }) || getString('errorWhileSaving'),
undefined,
'pipeline.save.pipeline.error'
)
}
} else {
// isGitSyncEnabled true
throw response
}
}
return { status: response?.status }
}
const saveAngPublishWithGitInfo = async (
updatedGitDetails: SaveToGitFormInterface,
payload?: SavePipelineObj,
objectId?: string
): Promise<UseSaveSuccessResponse> => {
let latestPipeline: PipelineInfoConfig = payload?.pipeline || pipeline
Iif (isYaml && yamlHandler) {
try {
latestPipeline = payload?.pipeline || (parse(yamlHandler.getLatestYaml()).pipeline as PipelineInfoConfig)
} /* istanbul ignore next */ catch (err) {
showError(err.message || err, undefined, 'pipeline.save.gitinfo.error')
}
}
const response = await saveAndPublishPipeline(
latestPipeline,
omit(updatedGitDetails, 'name', 'identifier'),
pipelineIdentifier !== DefaultNewPipelineId ? { lastObjectId: objectId } : {}
)
return {
status: response?.status
}
}
const { openSaveToGitDialog } = useSaveToGitDialog<SavePipelineObj>({
onSuccess: (
gitData: SaveToGitFormInterface,
payload?: SavePipelineObj,
objectId?: string
): Promise<UseSaveSuccessResponse> =>
saveAngPublishWithGitInfo(gitData, payload, objectId || gitDetails?.objectId || '')
})
const saveAndPublish = React.useCallback(async () => {
window.dispatchEvent(new CustomEvent('SAVE_PIPELINE_CLICKED'))
let latestPipeline: PipelineInfoConfig = pipeline
Iif (isYaml && yamlHandler) {
if (!parse(yamlHandler.getLatestYaml())) {
clear()
showError(getString('invalidYamlText'))
return
}
try {
latestPipeline = parse(yamlHandler.getLatestYaml()).pipeline as PipelineInfoConfig
} /* istanbul ignore next */ catch (err) {
showError(err.message || err, undefined, 'pipeline.save.pipeline.error')
}
}
const ciCodeBaseConfigurationError = validateCICodebaseConfiguration({ pipeline: latestPipeline, getString })
Iif (ciCodeBaseConfigurationError) {
clear()
showError(ciCodeBaseConfigurationError)
return
}
// if Git sync enabled then display modal
if (isGitSyncEnabled) {
Iif (isEmpty(gitDetails.repoIdentifier) || isEmpty(gitDetails.branch)) {
clear()
showError(getString('pipeline.gitExperience.selectRepoBranch'))
return
}
// When git sync enabled, do not irritate user by taking all git info then at the end showing BE errors related to schema
const error = await validateJSONWithSchema({ pipeline: latestPipeline }, pipelineSchema?.data as any)
Iif (error.size > 0) {
clear()
showError(error)
return
}
Iif (isYaml && yamlHandler && !isValidYaml()) {
return
}
openSaveToGitDialog({
isEditing: pipelineIdentifier !== DefaultNewPipelineId,
resource: {
type: 'Pipelines',
name: latestPipeline.name,
identifier: latestPipeline.identifier,
gitDetails: gitDetails ?? {}
},
payload: { pipeline: omit(latestPipeline, 'repo', 'branch') }
})
} else {
await saveAndPublishPipeline(latestPipeline)
}
// eslint-disable-next-line react-hooks/exhaustive-deps
}, [
deletePipelineCache,
accountId,
history,
toPipelineStudio,
projectIdentifier,
orgIdentifier,
pipeline,
fetchPipeline,
showError,
pipelineIdentifier,
isYaml,
yamlHandler
])
const menuItems = (): SavePipelineMenuItem[] => {
return [
{
label: 'Save Pipeline',
onClick: saveAndPublish,
disabled: !isSaveEnabled
},
{
label: 'Save as Template',
onClick: save
}
]
}
if (loading) {
return (
<Button
variation={ButtonVariation.PRIMARY}
rightIcon="chevron-down"
text={getString('save')}
onClick={noop}
loading={true}
className={css.saveButton}
/>
)
}
Eif (!isTemplatesEnabled) {
if (!isReadonly) {
return (
<Button
variation={ButtonVariation.PRIMARY}
text={getString('save')}
onClick={saveAndPublish}
icon="send-data"
className={css.saveButton}
disabled={!isUpdated}
/>
)
} else {
return <></>
}
}
return (
<Popover
isOpen={menuOpen}
onInteraction={nextOpenState => {
setMenuOpen(nextOpenState)
}}
position={Position.BOTTOM}
className={cx(css.main, className)}
portalClassName={cx(css.popover, portalClassName)}
usePortal={false}
minimal={true}
disabled={!isSaveEnabled && !isTemplatesEnabled}
{...popoverProps}
>
<Button
variation={ButtonVariation.PRIMARY}
rightIcon="chevron-down"
text={getString('save')}
onClick={noop}
loading={loading}
className={css.saveButton}
disabled={!isSaveEnabled && !isTemplatesEnabled}
/>
<Menu>
{menuItems().map(item => {
return (
<li
key={item.label}
className={cx(css.menuItem, { [css.disabled]: item.disabled })}
onClick={e => {
e.stopPropagation()
item.onClick()
setMenuOpen(false)
}}
>
{item.icon && <Icon name={item.icon} size={12} />}
<Text lineClamp={1}>{item.label}</Text>
</li>
)
})}
</Menu>
</Popover>
)
}
|