@devtron-labs/devtron-fe-common-lib 0.0.37 → 0.0.39-beta-1

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@devtron-labs/devtron-fe-common-lib",
-    "version": "0.0.37",
+    "version": "0.0.39-beta-1",
     "description": "Supporting common component library",
     "main": "dist/index.js",
     "scripts": {
@@ -41,6 +41,9 @@
         "@sentry/browser": "^7.31.1"
     },
     "peerDependencies": {
+        "@rjsf/core": "^5.13.3",
+        "@rjsf/utils": "^5.13.3",
+        "@rjsf/validator-ajv8": "^5.13.3",
         "react": "^17.0.2",
         "react-dom": "^17.0.2",
         "react-router": "^5.3.0",

package/src/Assets/Icon/ic-chevron-down.svg

@@ -0,0 +1,5 @@
+<svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24">
+    <g fill="none" fill-rule="evenodd">
+        <path fill="#999" class="fill-color" fill-rule="nonzero" d="M7.41 8.59L12 13.17l4.59-4.58L18 10l-6 6-6-6z"/>
+    </g>
+</svg>

package/src/Common/AppStatus/AppStatus.tsx

@@ -0,0 +1,64 @@
+import Tippy from '@tippyjs/react'
+import { ReactComponent as InfoIcon } from '../../Assets/Icon/ic-info-outlined.svg'
+import { StatusConstants, YET_TO_RUN } from './constants'
+import { AppStatusType } from './types'
+import { triggerStatus } from './utils'
+
+export default function AppStatus({
+    appStatus,
+    isDeploymentStatus = false,
+    isJobView = false,
+    isVirtualEnv,
+    hideStatusMessage = false,
+}: AppStatusType) {
+    let status = appStatus
+    if (isDeploymentStatus) {
+        status = triggerStatus(appStatus)
+    }
+    const appStatusLowerCase = status?.toLowerCase()
+    const isNotDeployed = appStatusLowerCase === StatusConstants.NOT_DEPLOYED.noSpaceLower
+    const iconClass = isNotDeployed ? StatusConstants.NOT_DEPLOYED.lowerCase : appStatusLowerCase
+    const statusMessage = status || (isVirtualEnv ? StatusConstants.NOT_AVILABLE.normalCase : '-')
+    const notDeployed = isJobView ? YET_TO_RUN : StatusConstants.NOT_DEPLOYED.normalCase
+    const textContent = isNotDeployed ? notDeployed : statusMessage
+
+    const renderIcon = () => {
+        if (iconClass) {
+            return <span className={`dc__app-summary__icon icon-dim-16 ${iconClass} ${iconClass}--node`} />
+        } else if (isVirtualEnv) {
+            return (
+                <span
+                    className={`dc__app-summary__icon icon-dim-16 ${StatusConstants.NOT_DEPLOYED.lowerCase} ${StatusConstants.NOT_DEPLOYED.lowerCase}--node`}
+                />
+            )
+        } else {
+            return (
+                <Tippy
+                    className="default-tt w-200"
+                    arrow={false}
+                    placement="top"
+                    content="To fetch app status for GitOps based deployments open the app detail page"
+                >
+                    <InfoIcon className="icon-dim-16 fcn-6" />
+                </Tippy>
+            )
+        }
+    }
+
+    return hideStatusMessage ? (
+        iconClass || isVirtualEnv ? (
+            <Tippy className="default-tt" arrow={false} placement="top" content={textContent}>
+                <div className="flex">{renderIcon()}</div>
+            </Tippy>
+        ) : (
+            renderIcon()
+        )
+    ) : (
+        <div className="flex left">
+            <div className="flex mr-6">{renderIcon()}</div>
+            <p data-testid={`${status}-app-status`} className="dc__truncate-text dc__first-letter-capitalize cn-6 m-0">
+                {textContent}
+            </p>
+        </div>
+    )
+}

package/src/Common/AppStatus/constants.ts

@@ -0,0 +1,53 @@
+export const StatusConstants = {
+    NOT_DEPLOYED: {
+        noSpaceLower: 'notdeployed',
+        normalCase: 'Not deployed',
+        lowerCase: 'not-deployed',
+    },
+    APP_STATUS: {
+        noSpaceLower: 'appStatus',
+        normalText: 'App status',
+    },
+    PROJECT: {
+        pluralLower: 'projects',
+        lowerCase: 'project',
+    },
+    CLUSTER: {
+        pluralLower: 'clusters',
+        lowerCase: 'cluster',
+    },
+    NAMESPACE: {
+        pluralLower: 'namespaces',
+        lowerCase: 'namespace',
+    },
+    ENVIRONMENT: {
+        pluralLower: 'environments',
+        lowerCase: 'environment',
+    },
+    NOT_AVILABLE: {
+        normalCase: 'Not available',
+    },
+}
+
+export enum TIMELINE_STATUS {
+    DEPLOYMENT_INITIATED = 'DEPLOYMENT_INITIATED',
+    GIT_COMMIT = 'GIT_COMMIT',
+    GIT_COMMIT_FAILED = 'GIT_COMMIT_FAILED',
+    KUBECTL_APPLY = 'KUBECTL_APPLY',
+    KUBECTL_APPLY_STARTED = 'KUBECTL_APPLY_STARTED',
+    KUBECTL_APPLY_SYNCED = 'KUBECTL_APPLY_SYNCED',
+    HEALTHY = 'HEALTHY',
+    APP_HEALTH = 'APP_HEALTH',
+    DEPLOYMENT_FAILED = 'FAILED',
+    FETCH_TIMED_OUT = 'TIMED_OUT',
+    UNABLE_TO_FETCH_STATUS = 'UNABLE_TO_FETCH_STATUS',
+    DEGRADED = 'DEGRADED',
+    DEPLOYMENT_SUPERSEDED = 'DEPLOYMENT_SUPERSEDED',
+    ABORTED = 'ABORTED',
+    INPROGRESS = 'INPROGRESS',
+    HELM_PACKAGE_GENERATED = 'HELM_PACKAGE_GENERATED',
+    HELM_MANIFEST_PUSHED_TO_HELM_REPO = 'HELM_MANIFEST_PUSHED_TO_HELM_REPO',
+    HELM_MANIFEST_PUSHED_TO_HELM_REPO_FAILED = 'HELM_MANIFEST_PUSHED_TO_HELM_REPO_FAILED',
+}
+
+export const YET_TO_RUN = 'Yet to run'

package/src/Common/AppStatus/index.ts

@@ -0,0 +1 @@
+export { default as AppStatus } from './AppStatus'

package/src/Common/AppStatus/types.ts

@@ -0,0 +1,12 @@
+export interface AppStatusType {
+    appStatus: string
+    isDeploymentStatus?: boolean
+    isJobView?: boolean
+    isVirtualEnv?: boolean
+    /**
+     * Hide the status message if true and show status message in tooltip
+     *
+     * @default false
+     */
+    hideStatusMessage?: boolean
+}

package/src/Common/AppStatus/utils.ts

@@ -0,0 +1,14 @@
+import { TIMELINE_STATUS } from './constants'
+
+export const triggerStatus = (triggerDetailStatus: string): string => {
+    let triggerStatus = triggerDetailStatus?.toUpperCase()
+    if (triggerStatus === TIMELINE_STATUS.ABORTED || triggerStatus === TIMELINE_STATUS.DEGRADED) {
+        return 'Failed'
+    } else if (triggerStatus === TIMELINE_STATUS.HEALTHY) {
+        return 'Succeeded'
+    } else if (triggerStatus === TIMELINE_STATUS.INPROGRESS) {
+        return 'Inprogress'
+    } else {
+        return triggerDetailStatus
+    }
+}

package/src/Common/Helper.tsx

@@ -487,3 +487,11 @@ export function useAsync<T>(
 
     return [state.loading, state.result, state.error, reload, setResult, state.dependencies]
 }
+
+export const processDeployedTime = (lastDeployed, isArgoInstalled) => {
+    if (lastDeployed) {
+        return handleUTCTime(lastDeployed, true)
+    } else {
+        return isArgoInstalled ? '' : 'Not deployed'
+    }
+}

package/src/Common/Hooks/UseClickOutside/UseClickOutside.tsx

@@ -0,0 +1,15 @@
+import React, { useEffect } from 'react'
+
+export const useClickOutside = (ref: any, callback: () => void) => {
+    useEffect(() => {
+        const handleClickOutside = (e: any) => {
+            if (ref?.current && !ref.current.contains(e.target)) {
+                callback()
+            }
+        }
+        document.addEventListener('click', handleClickOutside)
+        return () => {
+            document.removeEventListener('click', handleClickOutside)
+        }
+    }, [ref, callback])
+}

package/src/Common/Hooks/index.ts

@@ -1 +1,2 @@
 export { useSuperAdmin } from './UseSuperAdmin/UseSuperAdmin'
+export { useClickOutside } from './UseClickOutside/UseClickOutside'

package/src/Common/RJSF/Form.tsx

@@ -0,0 +1,28 @@
+import React from 'react'
+import RJSF from '@rjsf/core'
+import validator from '@rjsf/validator-ajv8'
+
+import { templates, widgets } from './config'
+import { FormProps } from './types'
+import { translateString } from './utils'
+import './rjsfForm.scss'
+
+// Need to use this way because the default import was not working as expected
+// The default import resolves to an object intead of a function
+const Form = (RJSF as any).default as typeof RJSF
+
+export const RJSFForm = (props: FormProps) => (
+    <Form
+        noHtml5Validate
+        showErrorList={false}
+        autoComplete="off"
+        {...props}
+        validator={validator}
+        templates={{
+            ...templates,
+            ...props.templates,
+        }}
+        widgets={{ ...widgets, ...props.widgets }}
+        translateString={translateString}
+    />
+)

package/src/Common/RJSF/common/FieldRow.tsx

@@ -0,0 +1,31 @@
+import React from 'react'
+import { FieldRowProps } from './types'
+
+export const FieldRowWithLabel = ({
+    showLabel,
+    label,
+    required,
+    children,
+    id,
+    shouldAlignCenter = true,
+}: FieldRowProps) => (
+    <div
+        className={
+            showLabel
+                ? `display-grid dc__gap-12 rjsf-form-template__field ${shouldAlignCenter ? 'flex-align-center' : ''}`
+                : ''
+        }
+    >
+        {showLabel && (
+            <label className="cn-7 fs-13 lh-32 fw-4 flexbox mb-0" htmlFor={id}>
+                {!!label && (
+                    <>
+                        <span className="dc__ellipsis-right">{label}</span>
+                        {required && <span className="cr-5">&nbsp;*</span>}
+                    </>
+                )}
+            </label>
+        )}
+        {children}
+    </div>
+)

package/src/Common/RJSF/common/types.ts

@@ -0,0 +1,9 @@
+import { FieldTemplateProps } from '@rjsf/utils'
+
+export interface FieldRowProps extends Pick<FieldTemplateProps, 'children' | 'label' | 'required' | 'id'> {
+    showLabel?: boolean
+    /**
+     * @default true
+     */
+    shouldAlignCenter?: boolean
+}

package/src/Common/RJSF/config.ts

@@ -0,0 +1,37 @@
+import React from 'react'
+import { RegistryWidgetsType } from '@rjsf/utils'
+
+import {
+    AddButton,
+    ArrayFieldItemTemplate,
+    ArrayFieldTemplate,
+    BaseInputTemplate,
+    DescriptionFieldTemplate,
+    FieldTemplate,
+    FieldErrorTemplate,
+    ObjectFieldTemplate,
+    RemoveButton,
+    SubmitButton,
+    TitleFieldTemplate,
+    WrapIfAdditionalTemplate,
+} from './templates'
+import { CheckboxWidget, SelectWidget } from './widgets'
+import { FormProps } from './types'
+
+export const widgets: RegistryWidgetsType = {
+    CheckboxWidget,
+    SelectWidget,
+}
+
+export const templates: FormProps['templates'] = {
+    ArrayFieldItemTemplate,
+    ArrayFieldTemplate,
+    BaseInputTemplate,
+    ButtonTemplates: { AddButton, RemoveButton, SubmitButton },
+    DescriptionFieldTemplate,
+    FieldTemplate,
+    FieldErrorTemplate,
+    ObjectFieldTemplate,
+    TitleFieldTemplate,
+    WrapIfAdditionalTemplate,
+}

package/src/Common/RJSF/constants.ts

@@ -0,0 +1,5 @@
+export const PLACEHOLDERS = {
+    SELECT: 'Please select an option',
+    INPUT: 'Please enter an input',
+    OBJECT_KEY: 'Please enter a value for the key',
+}

package/src/Common/RJSF/index.ts

@@ -0,0 +1,2 @@
+export { RJSFForm } from './Form'
+export * from './types'

package/src/Common/RJSF/rjsfForm.scss

@@ -0,0 +1,17 @@
+.rjsf-form-template {
+    &__field {
+        grid-template-columns: 250px 1fr;
+    }
+
+    &__additional-fields {
+        grid-template-columns: 1fr 1fr minmax(20px, auto);
+    }
+
+    &__array-field-item {
+        grid-template-columns: 1fr auto;
+
+        & :first-child {
+            margin: 0;
+        }
+    }
+}

package/src/Common/RJSF/templates/ArrayFieldItemTemplate.tsx

@@ -0,0 +1,33 @@
+import React, { CSSProperties } from 'react'
+import { ArrayFieldTemplateItemType } from '@rjsf/utils'
+
+export const ArrayFieldItemTemplate = ({
+    children,
+    className,
+    disabled,
+    hasToolbar,
+    hasRemove,
+    index,
+    onDropIndexClick,
+    readonly,
+    registry,
+    uiSchema,
+}: ArrayFieldTemplateItemType) => {
+    const { RemoveButton } = registry.templates.ButtonTemplates
+
+    return (
+        <div className="display-grid rjsf-form-template__array-field-item flex-align-center dc__gap-8 mb-12">
+            {children}
+            {hasToolbar && hasRemove && (
+                <div>
+                    <RemoveButton
+                        disabled={disabled || readonly}
+                        onClick={onDropIndexClick(index)}
+                        uiSchema={uiSchema}
+                        registry={registry}
+                    />
+                </div>
+            )}
+        </div>
+    )
+}

package/src/Common/RJSF/templates/ArrayFieldTemplate.tsx

@@ -0,0 +1,77 @@
+import React from 'react'
+import { getTemplate, getUiOptions, ArrayFieldTemplateProps, ArrayFieldTemplateItemType } from '@rjsf/utils'
+import { FieldRowWithLabel } from '../common/FieldRow'
+
+const ActionButton = ({ canAdd, onAddClick, disabled, readonly, uiSchema, registry }) => {
+    const {
+        ButtonTemplates: { AddButton },
+    } = registry.templates
+
+    return (
+        canAdd && (
+            <AddButton onClick={onAddClick} disabled={disabled || readonly} uiSchema={uiSchema} registry={registry} />
+        )
+    )
+}
+
+export const ArrayFieldTemplate = ({
+    canAdd,
+    className,
+    disabled,
+    idSchema,
+    uiSchema,
+    items,
+    onAddClick,
+    readonly,
+    registry,
+    required,
+    title,
+}: ArrayFieldTemplateProps) => {
+    const uiOptions = getUiOptions(uiSchema)
+    const ArrayFieldItemTemplate = getTemplate<'ArrayFieldItemTemplate'>('ArrayFieldItemTemplate', registry, uiOptions)
+    const label = uiOptions.title || title
+
+    return (
+        <fieldset className={className} id={idSchema.$id}>
+            {/* Show the label here in case there are no items, otherwise handled by Field Template */}
+            {items.length ? (
+                <>
+                    {items.map(({ key, ...itemProps }: ArrayFieldTemplateItemType, index) => {
+                        // Show the title as the label for the first field
+                        const children = {
+                            ...itemProps.children,
+                            props: {
+                                ...itemProps.children.props,
+                                name: index === 0 ? label : '',
+                            },
+                        }
+                        return (
+                            <ArrayFieldItemTemplate key={key} {...itemProps}>
+                                {children}
+                            </ArrayFieldItemTemplate>
+                        )
+                    })}
+                    <ActionButton
+                        canAdd={canAdd}
+                        onAddClick={onAddClick}
+                        disabled={disabled}
+                        readonly={readonly}
+                        uiSchema={uiSchema}
+                        registry={registry}
+                    />
+                </>
+            ) : (
+                <FieldRowWithLabel label={label} required={required} showLabel id={idSchema.$id}>
+                    <ActionButton
+                        canAdd={canAdd}
+                        onAddClick={onAddClick}
+                        disabled={disabled}
+                        readonly={readonly}
+                        uiSchema={uiSchema}
+                        registry={registry}
+                    />
+                </FieldRowWithLabel>
+            )}
+        </fieldset>
+    )
+}

package/src/Common/RJSF/templates/BaseInput.tsx

@@ -0,0 +1,16 @@
+import React from 'react'
+import { getDefaultRegistry } from '@rjsf/core'
+import { BaseInputTemplateProps } from '@rjsf/utils'
+import { PLACEHOLDERS } from '../constants'
+
+const {
+    templates: { BaseInputTemplate },
+} = getDefaultRegistry()
+
+export const BaseInput = ({ placeholder, ...props }: BaseInputTemplateProps) => (
+    <BaseInputTemplate
+        placeholder={placeholder || PLACEHOLDERS.INPUT}
+        {...props}
+        className="form__input cn-9 fs-13 lh-20 fw-4"
+    />
+)

package/src/Common/RJSF/templates/ButtonTemplates/AddButton.tsx

@@ -0,0 +1,18 @@
+import React from 'react'
+import { IconButtonProps } from '@rjsf/utils'
+
+import { ReactComponent as PlusIcon } from '../../../../Assets/Icon/ic-add.svg'
+
+export const AddButton = ({ icon, iconType, registry, uiSchema, ...props }: IconButtonProps) => (
+    <div className="flexbox flex-justify-end">
+        <button
+            {...props}
+            type="button"
+            className="dc__outline-none-imp p-0 dc__transparent flex dc__gap-4 cursor"
+            title="Add"
+        >
+            <PlusIcon className="icon-dim-16 fcb-5" />
+            <span className="cb-5 fs-13 lh-20">Add</span>
+        </button>
+    </div>
+)

package/src/Common/RJSF/templates/ButtonTemplates/RemoveButton.tsx

@@ -0,0 +1,10 @@
+import React from 'react'
+import { IconButtonProps } from '@rjsf/utils'
+
+import { ReactComponent as CrossIcon } from '../../../../Assets/Icon/ic-cross.svg'
+
+export const RemoveButton = ({ icon, iconType, registry, uiSchema, ...props }: IconButtonProps) => (
+    <button {...props} type="button" className="dc__outline-none-imp p-0 dc__transparent flex cursor" title="Remove">
+        <CrossIcon className="icon-dim-16 fcr-5" />
+    </button>
+)

package/src/Common/RJSF/templates/ButtonTemplates/SubmitButton.tsx

@@ -0,0 +1,18 @@
+import React from 'react'
+import { getSubmitButtonOptions, SubmitButtonProps } from '@rjsf/utils'
+
+export const SubmitButton = ({ uiSchema }: SubmitButtonProps) => {
+    const { submitText, norender, props: submitButtonProps = {} } = getSubmitButtonOptions(uiSchema)
+
+    return norender ? null : (
+        <div className="flexbox flex-justify-end">
+            <button
+                type="submit"
+                {...submitButtonProps}
+                className={`cta ${submitButtonProps.className || ''}`}
+            >
+                {submitText}
+            </button>
+        </div>
+    )
+}

package/src/Common/RJSF/templates/ButtonTemplates/index.ts

@@ -0,0 +1,3 @@
+export { AddButton } from './AddButton'
+export { RemoveButton } from './RemoveButton'
+export { SubmitButton } from './SubmitButton'

package/src/Common/RJSF/templates/Description.tsx

@@ -0,0 +1,12 @@
+import React from 'react'
+import { DescriptionFieldProps } from '@rjsf/utils'
+
+import { ReactComponent as Info } from '../../../Assets/Icon/ic-info-filled.svg'
+
+export const Description = ({ id, description }: DescriptionFieldProps) =>
+    description && (
+        <div id={id} className="flex left flex-align-center mt-4 dc__gap-4">
+            <Info className="icon-dim-16 mw-16 info-icon-n5" />
+            <span className="cn-7 fs-11 fw-4 dc__ellipsis-right">{description}</span>
+        </div>
+    )

package/src/Common/RJSF/templates/Field.tsx

@@ -0,0 +1,30 @@
+import React from 'react'
+import { FieldTemplateProps, getUiOptions, getTemplate, ADDITIONAL_PROPERTY_FLAG } from '@rjsf/utils'
+import { FieldRowWithLabel } from '../common/FieldRow'
+
+export const Field = (props: FieldTemplateProps) => {
+    const { id, label, children, errors, hidden, required, displayLabel, registry, uiSchema, classNames, schema, description } =
+        props
+    const uiOptions = getUiOptions(uiSchema)
+    const WrapIfAdditionalTemplate = getTemplate<'WrapIfAdditionalTemplate'>(
+        'WrapIfAdditionalTemplate',
+        registry,
+        uiOptions,
+    )
+    // Object type fields have additional properties for key/value pairs
+    const hasAdditionalProperties = ADDITIONAL_PROPERTY_FLAG in schema
+    // Label is not displayed for boolean fields by default and hide for object type fields
+    const showLabel = (displayLabel || schema.type === 'boolean') && !hasAdditionalProperties
+
+    return hidden ? (
+        <div className="hidden">{children}</div>
+    ) : (
+        <div className={`${classNames} mb-12`}>
+            <FieldRowWithLabel label={label} showLabel={showLabel} id={id} required={required}>
+                <WrapIfAdditionalTemplate {...props}>{children}</WrapIfAdditionalTemplate>
+            </FieldRowWithLabel>
+            {description}
+            {errors}
+        </div>
+    )
+}

package/src/Common/RJSF/templates/FieldErrorTemplate.tsx

@@ -0,0 +1,25 @@
+import React from 'react'
+import { errorId, FieldErrorProps } from '@rjsf/utils'
+
+import { ReactComponent as Error } from '../../../Assets/Icon/ic-warning.svg'
+
+export const FieldErrorTemplate = ({ errors = [], idSchema }: FieldErrorProps) => {
+    const id = errorId(idSchema)
+
+    return (
+        errors.length > 0 && (
+            <span id={id}>
+                {errors
+                    .filter((elem) => !!elem)
+                    .map((error, index: number) => {
+                        return (
+                            <span className="form__error" key={index}>
+                                <Error className="form__icon form__icon--error" />
+                                {error}
+                            </span>
+                        )
+                    })}
+            </span>
+        )
+    )
+}