move timeAgo into string.ts so it can be reused

Author: jordanverasamy

packages/app/src/cli/services/bulk-operations/bulk-operation-status.test.ts

@@ -115,28 +115,6 @@ describe('getBulkOperationStatus', () => {
   })
 
   describe('time formatting', () => {
-    test('does not pluralize time unit when it is 1', async () => {
-      vi.mocked(adminRequestDoc).mockResolvedValue(
-        mockBulkOperation({completedAt: new Date(Date.now() - 60000).toISOString()}),
-      )
-
-      const output = mockAndCaptureOutput()
-      await getBulkOperationStatus({storeFqdn, operationId})
-
-      expect(output.output()).toMatch(/1 minute ago/)
-    })
-
-    test('pluralizes time unit when it is greater than 1', async () => {
-      vi.mocked(adminRequestDoc).mockResolvedValue(
-        mockBulkOperation({createdAt: new Date(Date.now() - 180000).toISOString()}),
-      )
-
-      const output = mockAndCaptureOutput()
-      await getBulkOperationStatus({storeFqdn, operationId})
-
-      expect(output.output()).toMatch(/3 minutes ago/)
-    })
-
     test('uses "Started" for running operations', async () => {
       vi.mocked(adminRequestDoc).mockResolvedValue(mockBulkOperation({status: 'RUNNING'}))
 

packages/app/src/cli/services/bulk-operations/bulk-operation-status.ts

@@ -8,6 +8,7 @@ import {renderInfo, renderSuccess, renderError} from '@shopify/cli-kit/node/ui'
 import {outputContent, outputToken} from '@shopify/cli-kit/node/output'
 import {ensureAuthenticatedAdmin} from '@shopify/cli-kit/node/session'
 import {adminRequestDoc} from '@shopify/cli-kit/node/api/admin'
+import {timeAgo} from '@shopify/cli-kit/common/string'
 
 const API_VERSION = '2026-01'
 
@@ -64,21 +65,3 @@ function formatTimeDifference(createdAt: unknown, completedAt?: unknown): string
     return `Started ${timeAgo(new Date(String(createdAt)), now)}`
   }
 }
-
-function timeAgo(from: Date, to: Date): string {
-  const seconds = Math.floor((to.getTime() - from.getTime()) / 1000)
-  if (seconds < 60) return `${formatTimeUnit(seconds, 'second')} ago`
-
-  const minutes = Math.floor(seconds / 60)
-  if (minutes < 60) return `${formatTimeUnit(minutes, 'minute')} ago`
-
-  const hours = Math.floor(minutes / 60)
-  if (hours < 24) return `${formatTimeUnit(hours, 'hour')} ago`
-
-  const days = Math.floor(hours / 24)
-  return `${formatTimeUnit(days, 'day')} ago`
-}
-
-function formatTimeUnit(count: number, unit: string): string {
-  return `${count} ${unit}${count === 1 ? '' : 's'}`
-}

packages/cli-kit/src/public/common/string.test.ts

@@ -6,6 +6,7 @@ import {
   linesToColumns,
   normalizeDelimitedString,
   pluralize,
+  timeAgo,
   tryParseInt,
 } from './string.js'
 import {describe, expect, test} from 'vitest'
@@ -200,3 +201,43 @@ describe('normalizeDelimitedString', () => {
     expect(result).toEqual('read_products,write_products')
   })
 })
+
+describe('timeAgo', () => {
+  const second = 1000
+  const minute = 60 * second
+  const hour = 60 * minute
+  const day = 24 * hour
+  const now = new Date(0)
+
+  test('formats seconds (singular)', () => {
+    expect(timeAgo(new Date(now.getTime() - second), now)).toBe('1 second ago')
+  })
+
+  test('formats seconds (plural)', () => {
+    expect(timeAgo(new Date(now.getTime() - 30 * second), now)).toBe('30 seconds ago')
+  })
+
+  test('formats minutes (singular)', () => {
+    expect(timeAgo(new Date(now.getTime() - minute), now)).toBe('1 minute ago')
+  })
+
+  test('formats minutes (plural)', () => {
+    expect(timeAgo(new Date(now.getTime() - 3 * minute), now)).toBe('3 minutes ago')
+  })
+
+  test('formats hours (singular)', () => {
+    expect(timeAgo(new Date(now.getTime() - hour), now)).toBe('1 hour ago')
+  })
+
+  test('formats hours (plural)', () => {
+    expect(timeAgo(new Date(now.getTime() - 5 * hour), now)).toBe('5 hours ago')
+  })
+
+  test('formats days (singular)', () => {
+    expect(timeAgo(new Date(now.getTime() - day), now)).toBe('1 day ago')
+  })
+
+  test('formats days (plural)', () => {
+    expect(timeAgo(new Date(now.getTime() - 7 * day), now)).toBe('7 days ago')
+  })
+})

packages/cli-kit/src/public/common/string.ts

@@ -418,3 +418,28 @@ export function normalizeDelimitedString(delimitedString?: string, delimiter = '
 
   return uniqueSortedItems.join(delimiter)
 }
+
+/**
+ * Given two dates, it returns a human-readable string representing the time elapsed between them.
+ *
+ * @param from - Start date.
+ * @param to - End date.
+ * @returns A string like "5 minutes ago" or "2 days ago".
+ */
+export function timeAgo(from: Date, to: Date): string {
+  const seconds = Math.floor((to.getTime() - from.getTime()) / 1000)
+  if (seconds < 60) return `${formatTimeUnit(seconds, 'second')} ago`
+
+  const minutes = Math.floor(seconds / 60)
+  if (minutes < 60) return `${formatTimeUnit(minutes, 'minute')} ago`
+
+  const hours = Math.floor(minutes / 60)
+  if (hours < 24) return `${formatTimeUnit(hours, 'hour')} ago`
+
+  const days = Math.floor(hours / 24)
+  return `${formatTimeUnit(days, 'day')} ago`
+}
+
+function formatTimeUnit(count: number, unit: string): string {
+  return `${count} ${unit}${count === 1 ? '' : 's'}`
+}