chore: Add unit tests for utils

apps/gitness/config/vitest-setup.ts

@@ -0,0 +1,8 @@
+import { vi } from 'vitest'
+
+Object.defineProperty(document, 'queryCommandSupported', {
+  value: vi.fn().mockImplementation((command: string) => {
+    return command === 'copy' || command === 'cut'
+  }),
+  writable: true
+})

apps/gitness/src/components/GitBlame.tsx

@@ -1,13 +1,13 @@
 import { useEffect, useState } from 'react'
 
 import { useGetBlameQuery } from '@harnessio/code-service-client'
+import { getInitials } from '@harnessio/ui/utils'
 import { BlameEditor, BlameEditorProps, ThemeDefinition } from '@harnessio/yaml-editor'
 import { BlameItem } from '@harnessio/yaml-editor/dist/types/blame'
 
 import { useGetRepoRef } from '../framework/hooks/useGetRepoPath'
 import useCodePathDetails from '../hooks/useCodePathDetails'
 import { timeAgoFromISOTime } from '../pages/pipeline-edit/utils/time-utils'
-import { getInitials } from '../utils/common-utils'
 import { normalizeGitRef } from '../utils/git-utils'
 
 interface GitBlameProps {

apps/gitness/src/utils/__tests__/common-utils.test.ts

@@ -0,0 +1,151 @@
+import { describe, expect, it } from 'vitest'
+
+import { RepoFile, SummaryItemType } from '@harnessio/ui/views'
+
+import { getLogsText, sortFilesByType } from '../common-utils'
+
+// Mock data for testing
+const mockLogs = [{ out: 'Log line 1\n' }, { out: 'Log line 2\n' }, { out: 'Log line 3\n' }]
+
+const mockFiles: RepoFile[] = [
+  {
+    name: 'file1.txt',
+    type: SummaryItemType.File,
+    id: '1',
+    path: 'file1.txt',
+    lastCommitMessage: 'file1 commit',
+    timestamp: '2021-09-01T00:00:00Z'
+  },
+  {
+    name: 'folder1',
+    type: SummaryItemType.Folder,
+    id: '2',
+    path: 'folder1',
+    lastCommitMessage: 'folder1 commit',
+    timestamp: '2021-09-01T00:00:00Z'
+  },
+  {
+    name: 'file2.txt',
+    type: SummaryItemType.File,
+    id: '3',
+    path: 'file2.txt',
+    lastCommitMessage: 'file2 commit',
+    timestamp: '2021-09-01T00:00:00Z'
+  },
+  {
+    name: 'folder2',
+    type: SummaryItemType.Folder,
+    id: '4',
+    path: 'folder2',
+    lastCommitMessage: 'folder2 commit',
+    timestamp: '2021-09-01T00:00:00Z'
+  }
+]
+
+describe('getLogsText', () => {
+  Object.defineProperty(document, 'queryCommandSupported', {
+    value: vi.fn().mockReturnValue(true),
+    writable: true // Ensure it can be reassigned
+  })
+
+  it('should concatenate log lines into a single string', () => {
+    const result = getLogsText(mockLogs)
+    expect(result).toBe('Log line 1\nLog line 2\nLog line 3\n')
+  })
+
+  it('should return an empty string if logs array is empty', () => {
+    const result = getLogsText([])
+    expect(result).toBe('')
+  })
+})
+
+describe('sortFilesByType', () => {
+  it('should sort files by type, with folders first', () => {
+    const result = sortFilesByType(mockFiles)
+    expect(result).toEqual([
+      {
+        name: 'folder1',
+        type: SummaryItemType.Folder,
+        id: '2',
+        path: 'folder1',
+        lastCommitMessage: 'folder1 commit',
+        timestamp: '2021-09-01T00:00:00Z'
+      },
+      {
+        name: 'folder2',
+        type: SummaryItemType.Folder,
+        id: '4',
+        path: 'folder2',
+        lastCommitMessage: 'folder2 commit',
+        timestamp: '2021-09-01T00:00:00Z'
+      },
+      {
+        name: 'file1.txt',
+        type: SummaryItemType.File,
+        id: '1',
+        path: 'file1.txt',
+        lastCommitMessage: 'file1 commit',
+        timestamp: '2021-09-01T00:00:00Z'
+      },
+      {
+        name: 'file2.txt',
+        type: SummaryItemType.File,
+        id: '3',
+        path: 'file2.txt',
+        lastCommitMessage: 'file2 commit',
+        timestamp: '2021-09-01T00:00:00Z'
+      }
+    ])
+  })
+
+  it('should handle an empty array', () => {
+    const result = sortFilesByType([])
+    expect(result).toEqual([])
+  })
+
+  it('should handle an array with only files', () => {
+    const filesOnly = [
+      {
+        name: 'file1.txt',
+        type: SummaryItemType.File,
+        id: '1',
+        path: 'file1.txt',
+        lastCommitMessage: 'file1 commit',
+        timestamp: '2021-09-01T00:00:00Z'
+      },
+      {
+        name: 'file2.txt',
+        type: SummaryItemType.File,
+        id: '2',
+        path: 'file2.txt',
+        lastCommitMessage: 'file2 commit',
+        timestamp: '2021-10-01T00:00:00Z'
+      }
+    ]
+    const result = sortFilesByType(filesOnly)
+    expect(result).toEqual(filesOnly)
+  })
+
+  it('should handle an array with only folders', () => {
+    const foldersOnly = [
+      {
+        name: 'folder1',
+        type: SummaryItemType.Folder,
+        id: '2',
+        path: 'folder1',
+        lastCommitMessage: 'folder1 commit',
+        timestamp: '2021-09-01T00:00:00Z'
+      },
+      {
+        name: 'folder2',
+        type: SummaryItemType.Folder,
+        id: '2',
+        path: 'folder2',
+        lastCommitMessage: 'folder2 commit',
+        timestamp: '2021-10-01T00:00:00Z'
+      }
+    ]
+    const result = sortFilesByType(foldersOnly)
+    expect(result).toEqual(foldersOnly)
+  })
+})

apps/gitness/src/utils/common-utils.ts

@@ -22,19 +22,6 @@ export const getLogsText = (logs: LivelogLine[]) => {
   return output
 }
 
-export const getInitials = (name: string, length = 2) => {
-  // Split the name into an array of words, ignoring empty strings
-  const words = name.split(' ').filter(Boolean)
-
-  // Get the initials from the words
-  const initials = words
-    .map(word => word[0].toUpperCase()) // Get the first letter of each word
-    .join('')
-
-  // If length is provided, truncate the initials to the desired length
-  return length ? initials.slice(0, length) : initials
-}
-
 export const sortFilesByType = (entries: RepoFile[]): RepoFile[] => {
   return entries.sort((a, b) => {
     if (a.type === SummaryItemType.Folder && b.type === SummaryItemType.File) {

apps/gitness/vitest.config.ts

@@ -4,6 +4,8 @@ import viteConfig from './vite.config'
 
 export default mergeConfig(viteConfig, {
   test: {
+    environment: 'jsdom',
+    setupFiles: ['./config/vitest-setup.ts'],
     include: ['**/*.test.{ts,tsx}'],
     globals: true,
     coverage: {

packages/ui/src/utils/__tests__/TimeUtils.test.ts

@@ -0,0 +1,84 @@
+import { describe, expect, it } from 'vitest'
+
+import { formatDuration, formatTimestamp, getFormattedDuration } from '../TimeUtils'
+
+describe('getFormattedDuration', () => {
+  it('should return "0s" if startTs is greater than or equal to endTs', () => {
+    expect(getFormattedDuration(1000, 500)).toBe('0s')
+    expect(getFormattedDuration(1000, 1000)).toBe('0s')
+  })
+
+  it('should return formatted duration in "1h 2m 3s" format', () => {
+    expect(getFormattedDuration(0, 3723000)).toBe('1h 2m 3s')
+    expect(getFormattedDuration(0, 7200000)).toBe('2h')
+    expect(getFormattedDuration(0, 60000)).toBe('1m')
+    expect(getFormattedDuration(0, 1000)).toBe('1s')
+  })
+
+  it('should handle durations with only seconds', () => {
+    expect(getFormattedDuration(0, 5000)).toBe('5s')
+  })
+
+  it('should handle durations with hours, minutes, and seconds', () => {
+    expect(getFormattedDuration(0, 3661000)).toBe('1h 1m 1s')
+  })
+})
+
+describe('formatDuration', () => {
+  it('should return "0s" if duration is 0', () => {
+    expect(formatDuration(0)).toBe('0s')
+  })
+
+  it('should return formatted duration in "1h 2m 3s" format for milliseconds', () => {
+    expect(formatDuration(3723000, 'ms')).toBe('1h 2m 3s')
+  })
+
+  it('should return formatted duration in "1h 2m 3s" format for nanoseconds', () => {
+    expect(formatDuration(3723000000000, 'ns')).toBe('1h 2m 3s')
+  })
+
+  it('should handle durations with only milliseconds', () => {
+    expect(formatDuration(500, 'ms')).toBe('500ms')
+  })
+
+  it('should handle durations with only nanoseconds', () => {
+    expect(formatDuration(500000000, 'ns')).toBe('500ms')
+  })
+
+  it('should handle durations with hours, minutes, and seconds', () => {
+    expect(formatDuration(3661000, 'ms')).toBe('1h 1m 1s')
+  })
+})
+
+describe('formatTimestamp', () => {
+  const fixedDate = new Date('2023-01-01T12:34:56.789Z')
+
+  beforeAll(() => {
+    vi.useFakeTimers()
+    vi.setSystemTime(fixedDate)
+
+    vi.spyOn(Intl, 'DateTimeFormat').mockImplementation(
+      () =>
+        ({
+          format: () => '12:34:56.789'
+        }) as any
+    )
+  })
+
+  afterAll(() => {
+    vi.useRealTimers()
+    vi.restoreAllMocks()
+  })
+
+  it('should format epoch timestamp into "HH:mm:ss.SSS" format', () => {
+    const timestamp = fixedDate.getTime()
+    expect(formatTimestamp(timestamp)).toBe('12:34:56.789')
+  })
+
+  it('should handle different times of the day', () => {
+    const morningTimestamp = new Date('2023-01-01T08:00:00.000Z').getTime()
+    const eveningTimestamp = new Date('2023-01-01T20:00:00.000Z').getTime()
+    expect(formatTimestamp(morningTimestamp)).toBe('12:34:56.789')
+    expect(formatTimestamp(eveningTimestamp)).toBe('12:34:56.789')
+  })
+})

packages/ui/src/utils/__tests__/stringUtils.test.ts

@@ -0,0 +1,36 @@
+import { describe, expect, it } from 'vitest'
+
+import { getInitials } from '../stringUtils'
+
+describe('getInitials', () => {
+  it('should return the initials of a single word', () => {
+    expect(getInitials('John')).toBe('J')
+  })
+
+  it('should return the initials of multiple words', () => {
+    expect(getInitials('John Doe')).toBe('JD')
+  })
+
+  it('should return the initials truncated to the specified length', () => {
+    expect(getInitials('John Doe', 1)).toBe('J')
+    expect(getInitials('John Doe', 2)).toBe('JD')
+    expect(getInitials('John Doe', 3)).toBe('JD')
+  })
+
+  it('should ignore extra spaces between words', () => {
+    expect(getInitials('  John   Doe  ')).toBe('JD')
+  })
+
+  it('should handle empty strings', () => {
+    expect(getInitials('')).toBe('')
+  })
+
+  it('should handle names with more than two words', () => {
+    expect(getInitials('John Michael Doe')).toBe('JM')
+    expect(getInitials('John Michael Doe', 2)).toBe('JM')
+  })
+
+  it('should handle names with special characters', () => {
+    expect(getInitials('John-Michael Doe')).toBe('JD')
+  })
+})

packages/ui/src/utils/index.ts

@@ -1 +1,2 @@
 export * from './utils'
+export * from './stringUtils'

packages/ui/src/utils/utils.ts

@@ -3,18 +3,6 @@ import { createElement, ReactNode } from 'react'
 import { TimeAgoHoverCard } from '@views/repo/components/time-ago-hover-card'
 import { formatDistance, formatDistanceToNow } from 'date-fns'
 
-export const getInitials = (name: string, length = 2) => {
-  // Split the name into an array of words, ignoring empty strings
-  const words = name.split(' ').filter(Boolean)
-
-  // Get the initials from the words
-  const initials = words
-    .map(word => word[0].toUpperCase()) // Get the first letter of each word
-    .join('')
-
-  // If length is provided, truncate the initials to the desired length
-  return length ? initials.slice(0, length) : initials
-}
 export const INITIAL_ZOOM_LEVEL = 1
 export const ZOOM_INC_DEC_LEVEL = 0.1
 
@@ -110,19 +98,6 @@ export const timeAgo = (timestamp?: number | null, cutoffDays: number = 3): Reac
   }
 }
 
-//generate random password
-export function generateAlphaNumericHash(length: number) {
-  let result = ''
-  const characters = 'ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789'
-  const charactersLength = characters.length
-
-  for (let i = 0; i < length; i++) {
-    result += characters.charAt(Math.floor(Math.random() * charactersLength))
-  }
-
-  return result
-}
-
 /**
  * Format a number with current locale.
  * @param num number
@@ -131,6 +106,7 @@ export function generateAlphaNumericHash(length: number) {
 export function formatNumber(num: number | bigint): string {
   return num ? new Intl.NumberFormat(LOCALE).format(num) : ''
 }
+
 export interface Violation {
   violation: string
 }

packages/ui/src/views/repo/components/commits-list.tsx

@@ -2,8 +2,9 @@ import { FC, useMemo } from 'react'
 import { Link, useNavigate } from 'react-router-dom'
 
 import { Avatar, Button, CommitCopyActions, Icon, NodeGroup, StackedList } from '@/components'
-import { formatDate, getInitials } from '@/utils/utils'
+import { formatDate } from '@/utils/utils'
 import { TypesCommit } from '@/views'
+import { getInitials } from '@utils/stringUtils'
 
 type CommitsGroupedByDate = Record<string, TypesCommit[]>
 

packages/ui/src/views/repo/pull-request/components/pull-request-diff-viewer.tsx

@@ -13,7 +13,8 @@ import {
 import { DiffFile, DiffModeEnum, DiffView, DiffViewProps, SplitSide } from '@git-diff-view/react'
 import { useCustomEventListener } from '@hooks/use-event-listener'
 import { useMemoryCleanup } from '@hooks/use-memory-cleanup'
-import { getInitials, timeAgo } from '@utils/utils'
+import { getInitials } from '@utils/stringUtils'
+import { timeAgo } from '@utils/utils'
 import { DiffBlock } from 'diff2html/lib/types'
 import { debounce, get } from 'lodash-es'
 import { OverlayScrollbars } from 'overlayscrollbars'