Merge pull request #628 from devtron-labs/feat/license-manager-dto

feat: license manager DTO

Author: arunjaindev

src/Assets/IconV2/ic-devtron-header-logo.svg

@@ -400,6 +400,7 @@ export const DATE_TIME_FORMATS = {
     TWELVE_HOURS_EXPORT_FORMAT: 'DD-MMM-YYYY hh.mm A',
     DD_MMM_YYYY_HH_MM: 'DD MMM YYYY, hh:mm',
     DD_MMM_YYYY: 'DD MMM YYYY',
+    'DD/MM/YYYY': 'DD/MM/YYYY',
 }
 
 export const SEMANTIC_VERSION_DOCUMENTATION_LINK = 'https://semver.org/'

src/Assets/IconV2/ic-devtron.svg

@@ -19,6 +19,7 @@ import { ReactComponent as ICCode } from '@IconsV2/ic-code.svg'
 import { ReactComponent as ICContainer } from '@IconsV2/ic-container.svg'
 import { ReactComponent as ICCrown } from '@IconsV2/ic-crown.svg'
 import { ReactComponent as ICCube } from '@IconsV2/ic-cube.svg'
+import { ReactComponent as ICDevtronHeaderLogo } from '@IconsV2/ic-devtron-header-logo.svg'
 import { ReactComponent as ICDevtron } from '@IconsV2/ic-devtron.svg'
 import { ReactComponent as ICDockerhub } from '@IconsV2/ic-dockerhub.svg'
 import { ReactComponent as ICEcr } from '@IconsV2/ic-ecr.svg'
@@ -94,6 +95,7 @@ export const iconMap = {
     'ic-container': ICContainer,
     'ic-crown': ICCrown,
     'ic-cube': ICCube,
+    'ic-devtron-header-logo': ICDevtronHeaderLogo,
     'ic-devtron': ICDevtron,
     'ic-dockerhub': ICDockerhub,
     'ic-ecr': ICEcr,

src/Common/Constants.ts

@@ -46,6 +46,7 @@ export const DevtronLicenseCard = ({
     expiryDate,
     licenseStatus,
     isTrial,
+    // eslint-disable-next-line @typescript-eslint/no-unused-vars
     ttl,
 }: DevtronLicenseCardProps) => {
     const colorValue = getColorAccordingToStatus(licenseStatus)

src/Shared/Components/Icon/Icon.tsx

@@ -50,6 +50,7 @@ import {
 import {
     AggregationKeys,
     BorderConfigType,
+    DevtronLicenseDTO,
     GitTriggers,
     IntersectionChangeHandler,
     IntersectionOptions,
@@ -67,6 +68,7 @@ import {
     PodMetadatum,
 } from './Components'
 import { getAggregator } from '../Pages'
+import { DevtronLicenseCardProps, LicenseStatus } from './Components/LicenseInfoDialog/LicenseInfoDialog.components'
 
 interface HighlightSearchTextProps {
     /**
@@ -1065,3 +1067,35 @@ export const deriveBorderRadiusAndBorderClassFromConfig = ({
 
 export const getClassNameForStickyHeaderWithShadow = (isStuck: boolean, topClassName = 'dc__top-0') =>
     `dc__position-sticky ${topClassName} dc__transition--box-shadow ${isStuck ? 'dc__box-shadow--header' : ''}`
+
+const getDevtronLicenseStatus = ({
+    ttl,
+    reminderThreshold,
+}: Pick<DevtronLicenseDTO, 'ttl' | 'reminderThreshold'>): DevtronLicenseCardProps['licenseStatus'] => {
+    if (ttl < 0) {
+        return LicenseStatus.EXPIRED
+    }
+
+    if (ttl < reminderThreshold * 24 * 60 * 60) {
+        return LicenseStatus.REMINDER_THRESHOLD_REACHED
+    }
+
+    return LicenseStatus.ACTIVE
+}
+
+export const parseDevtronLicenseDTOIntoLicenseCardData = <isCentralDashboard extends boolean = false>(
+    licenseDTO: DevtronLicenseDTO<isCentralDashboard>,
+    currentUserEmail?: isCentralDashboard extends true ? string : never,
+): DevtronLicenseCardProps => {
+    const { isTrial, expiry, ttl, reminderThreshold, organisationMetadata, license, claimedByUserDetails } =
+        licenseDTO || {}
+
+    return {
+        enterpriseName: organisationMetadata?.name || '',
+        expiryDate: expiry ? moment(expiry).format(DATE_TIME_FORMATS['DD/MM/YYYY']) : '',
+        ttl,
+        licenseStatus: getDevtronLicenseStatus({ ttl, reminderThreshold }),
+        isTrial,
+        ...(currentUserEmail === claimedByUserDetails?.email ? { licenseKey: license } : { licenseSuffix: license }),
+    }
+}

src/Shared/Components/LicenseInfoDialog/LicenseInfoDialog.components.tsx

@@ -515,3 +515,5 @@ export const DC_DELETE_SUBTITLES = {
     DELETE_ENVIRONMENT_SUBTITLE: 'Are you sure you want to delete this environment?',
     DELETE_CLUSTER_SUBTITLES: 'Are you sure you want to delete this cluster?',
 }
+
+export const EULA_LINK = 'https://devtron.ai/end-user-license-agreement-eula'

src/Shared/Helpers.tsx

@@ -1031,3 +1031,39 @@ export interface AppEnvIdType {
     appId: number
     envId: number
 }
+
+export interface DevtronLicenseBaseDTO {
+    fingerprint: string | null
+    isTrial: boolean | null
+    /**
+     * In timestamp format
+     */
+    expiry: string | null
+    /**
+     * Can be negative, depicts time left in seconds for license to expire
+     */
+    ttl: number | null
+    /**
+     * Show a reminder after these many DAYS left for license to expire, i.e,
+     * Show if `ttl` is less than `reminderThreshold` [converted to seconds]
+     */
+    reminderThreshold: number | null
+    organisationMetadata: {
+        name: string | null
+        domain: string | null
+    } | null
+    license: string | null
+}
+
+export type DevtronLicenseDTO<isCentralDashboard extends boolean = false> = DevtronLicenseBaseDTO &
+    (isCentralDashboard extends true
+        ? {
+              claimedByUserDetails: {
+                  firstName: string | null
+                  lastName: string | null
+                  email: string | null
+              } | null
+          }
+        : {
+              claimedByUserDetails?: never
+          })