chore: misc comments

Author: arunjaindev

src/Shared/Components/DevtronLicenseCard/types.ts

@@ -1,4 +1,4 @@
-import { DevtronLicenseBaseDTO, LicenseErrorStruct } from '@Shared/index'
+import { DevtronLicenseBaseDTO, DevtronLicenseDTO } from '@Shared/index'
 
 export enum LicenseStatus {
     ACTIVE = 'ACTIVE',
@@ -23,11 +23,8 @@ export type DevtronLicenseCardProps = {
       }
 )
 
-export type DevtronLicenseInfo = DevtronLicenseCardProps & {
-    fingerprint: string
-    showLicenseData: boolean
-    licenseStatusError?: LicenseErrorStruct
-}
+export type DevtronLicenseInfo = DevtronLicenseCardProps &
+    Pick<DevtronLicenseDTO, 'fingerprint' | 'showLicenseData' | 'licenseStatusError'>
 
 export interface InstallFingerprintInfoProps extends Pick<DevtronLicenseBaseDTO, 'fingerprint'> {
     showHelpTooltip?: boolean

src/Shared/Components/Header/HeaderWithCreateButton/HeaderWithCreateButon.tsx

@@ -21,12 +21,12 @@ import { ReactComponent as DropDown } from '@Icons/ic-caret-down-small.svg'
 import { ReactComponent as ChartIcon } from '@Icons/ic-charts.svg'
 import { ReactComponent as AddIcon } from '@Icons/ic-add.svg'
 import { ReactComponent as JobIcon } from '@Icons/ic-k8s-job.svg'
-import { LicenseStatus } from '@Shared/Components/DevtronLicenseCard'
 import PageHeader from '../PageHeader'
 import { Modal, SERVER_MODE, URLS } from '../../../../Common'
 import { AppListConstants, ComponentSizeType } from '../../../constants'
 import './HeaderWithCreateButton.scss'
 import { useMainContext } from '../../../Providers'
+import { getIsShowingLicenseData } from '../utils'
 
 export interface HeaderWithCreateButtonProps {
     headerName: string
@@ -39,8 +39,7 @@ export const HeaderWithCreateButton = ({ headerName }: HeaderWithCreateButtonPro
     const { serverMode, licenseData } = useMainContext()
     const [showCreateSelectionModal, setShowCreateSelectionModal] = useState(false)
 
-    const showingLicenseBar =
-        licenseData && licenseData && (licenseData.licenseStatus !== LicenseStatus.ACTIVE || licenseData.isTrial)
+    const showingLicenseBar = getIsShowingLicenseData(licenseData)
 
     const handleCreateButton = () => {
         setShowCreateSelectionModal((prevState) => !prevState)

src/Shared/Components/Header/PageHeader.tsx

@@ -16,15 +16,14 @@
 
 import { useEffect, useState } from 'react'
 import Tippy from '@tippyjs/react'
-import './pageHeader.css'
 import ReactGA from 'react-ga4'
 import { ReactComponent as ICMediumPaintBucket } from '@IconsV2/ic-medium-paintbucket.svg'
 import { ReactComponent as ICCaretDownSmall } from '@Icons/ic-caret-down-small.svg'
 import { ReactComponent as Close } from '@Icons/ic-close.svg'
 import { ReactComponent as Question } from '@Icons/ic-help-outline.svg'
 import { getAlphabetIcon, TippyCustomized, TippyTheme } from '../../../Common'
 import LogoutCard from '../LogoutCard'
-import { setActionWithExpiry, handlePostHogEventUpdate } from './utils'
+import { setActionWithExpiry, handlePostHogEventUpdate, getIsShowingLicenseData } from './utils'
 import { InstallationType, ServerInfo, PageHeaderType } from './types'
 import { getServerInfo } from './service'
 import GettingStartedCard from '../GettingStartedCard/GettingStarted'
@@ -34,7 +33,7 @@ import AnnouncementBanner from '../AnnouncementBanner/AnnouncementBanner'
 import { useMainContext, useTheme, useUserEmail } from '../../Providers'
 import { InfoIconTippy } from '../InfoIconTippy'
 import { IframePromoButton } from './IframePromoButton'
-import { LicenseStatus } from '../DevtronLicenseCard'
+import './pageHeader.scss'
 
 const PageHeader = ({
     headerName,
@@ -198,7 +197,7 @@ const PageHeader = ({
         <span className="fs-12 fw-4 lh-18 pt-1 pb-1 pl-6 pr-6 ml-8 cn-9 bcy-5 br-4">Beta</span>
     )
 
-    const showingLicenseBar = licenseData && (licenseData.licenseStatus !== LicenseStatus.ACTIVE || licenseData.isTrial)
+    const showingLicenseBar = getIsShowingLicenseData(licenseData)
 
     const renderIframeButton = () => <IframePromoButton />
 

src/Shared/Components/Header/pageHeader.css renamed to src/Shared/Components/Header/pageHeader.scss

@@ -16,6 +16,7 @@
 
 import { updatePostHogEvent } from './service'
 import { LOGIN_COUNT } from '../../../Common'
+import { DevtronLicenseInfo, LicenseStatus } from '../DevtronLicenseCard'
 
 const millisecondsInDay = 86400000
 export const getDateInMilliseconds = (days) => 1 + new Date().valueOf() + (days ?? 0) * millisecondsInDay
@@ -33,3 +34,6 @@ export const handlePostHogEventUpdate = async (eventName: string): Promise<void>
 export const setActionWithExpiry = (key: string, days: number): void => {
     localStorage.setItem(key, `${getDateInMilliseconds(days)}`)
 }
+
+export const getIsShowingLicenseData = (licenseData: DevtronLicenseInfo) =>
+    licenseData && (licenseData.licenseStatus !== LicenseStatus.ACTIVE || licenseData.isTrial)

src/Shared/Components/Header/utils.ts

@@ -62,7 +62,7 @@ import {
     WebhookEventNameType,
 } from './types'
 import {
-    CENTRAL_API_CONNECTIVITY_KEY,
+    CENTRAL_API_LOCAL_STORAGE_KEY,
     DEPLOYMENT_STATUS,
     TIMELINE_STATUS,
     UNSAVED_CHANGES_PROMPT_MESSAGE,
@@ -1079,7 +1079,7 @@ export const clearCookieOnLogout = () => {
 
 export const getCentralAPIHealthObjectFromLocalStorage = (): CentralAPILocalConfig => {
     try {
-        const localStorageString = localStorage.getItem(CENTRAL_API_CONNECTIVITY_KEY)
+        const localStorageString = localStorage.getItem(CENTRAL_API_LOCAL_STORAGE_KEY)
         const healthObj: CentralAPILocalConfig = JSON.parse(localStorageString)
 
         const { lastUpdatedDate, isConnected, updateCount } = healthObj
@@ -1090,7 +1090,7 @@ export const getCentralAPIHealthObjectFromLocalStorage = (): CentralAPILocalConf
             isConnected: isConnected || null,
         }
     } catch {
-        localStorage.removeItem(CENTRAL_API_CONNECTIVITY_KEY)
+        localStorage.removeItem(CENTRAL_API_LOCAL_STORAGE_KEY)
         return {
             lastUpdatedDate: '',
             updateCount: 0,

src/Shared/Helpers.tsx

@@ -536,4 +536,4 @@ export const Routes = {
 
 export const ENTERPRISE_SUPPORT_LINK = 'enterprise@devtron.ai'
 
-export const CENTRAL_API_CONNECTIVITY_KEY = 'centralAPIConfig'
+export const CENTRAL_API_LOCAL_STORAGE_KEY = 'centralAPIConfig'

src/Shared/constants.tsx

@@ -1098,7 +1098,7 @@ export type DevtronLicenseDTO<isCentralDashboard extends boolean = false> = Devt
 export type CountryISO2Type = ParsedCountry['iso2']
 
 export interface CentralAPILocalConfig {
-    lastUpdatedDate: string
-    isConnected: boolean | null
-    updateCount: number
+    lastUpdatedDate: string // date on which local storage is updated
+    isConnected: boolean | null // true/false acc to connection, null for first time
+    updateCount: number // number of times it has been updated, max 3
 }

src/Shared/types.ts

@@ -63,7 +63,6 @@ export interface customEnv {
     NODE_REACT_APP_GIT_SHA?: string
     REACT_APP_GIT_SHA?: string
     NODE_ENV?: string
-    LOGIN_DT_LOGO?: string
     SIDEBAR_DT_LOGO?: string
     ENABLE_EXTERNAL_ARGO_CD: boolean
     API_BATCH_SIZE: number