If --id is not provided to shopify app bulk status, show all bulk operations

jordanverasamy · jordanverasamy · commit 168f42f1cb68 · 2025-11-26T19:00:32.000-08:00
diff --git a/packages/app/src/cli/api/graphql/bulk-operations/generated/list-bulk-operations.ts b/packages/app/src/cli/api/graphql/bulk-operations/generated/list-bulk-operations.ts
@@ -0,0 +1,88 @@
+/* eslint-disable @typescript-eslint/consistent-type-definitions, @typescript-eslint/no-redundant-type-constituents */
+import * as Types from './types.js'
+
+import {TypedDocumentNode as DocumentNode} from '@graphql-typed-document-node/core'
+
+export type ListBulkOperationsQueryVariables = Types.Exact<{
+  query?: Types.InputMaybe<Types.Scalars['String']['input']>
+}>
+
+export type ListBulkOperationsQuery = {
+  bulkOperations: {
+    nodes: {
+      id: string
+      status: Types.BulkOperationStatus
+      errorCode?: Types.BulkOperationErrorCode | null
+      objectCount: unknown
+      createdAt: unknown
+      completedAt?: unknown | null
+      url?: string | null
+      partialDataUrl?: string | null
+    }[]
+  }
+}
+
+export const ListBulkOperations = {
+  kind: 'Document',
+  definitions: [
+    {
+      kind: 'OperationDefinition',
+      operation: 'query',
+      name: {kind: 'Name', value: 'ListBulkOperations'},
+      variableDefinitions: [
+        {
+          kind: 'VariableDefinition',
+          variable: {kind: 'Variable', name: {kind: 'Name', value: 'query'}},
+          type: {kind: 'NamedType', name: {kind: 'Name', value: 'String'}},
+        },
+      ],
+      selectionSet: {
+        kind: 'SelectionSet',
+        selections: [
+          {
+            kind: 'Field',
+            name: {kind: 'Name', value: 'bulkOperations'},
+            arguments: [
+              {kind: 'Argument', name: {kind: 'Name', value: 'first'}, value: {kind: 'IntValue', value: '100'}},
+              {
+                kind: 'Argument',
+                name: {kind: 'Name', value: 'query'},
+                value: {kind: 'Variable', name: {kind: 'Name', value: 'query'}},
+              },
+              {
+                kind: 'Argument',
+                name: {kind: 'Name', value: 'sortKey'},
+                value: {kind: 'EnumValue', value: 'CREATED_AT'},
+              },
+              {kind: 'Argument', name: {kind: 'Name', value: 'reverse'}, value: {kind: 'BooleanValue', value: true}},
+            ],
+            selectionSet: {
+              kind: 'SelectionSet',
+              selections: [
+                {
+                  kind: 'Field',
+                  name: {kind: 'Name', value: 'nodes'},
+                  selectionSet: {
+                    kind: 'SelectionSet',
+                    selections: [
+                      {kind: 'Field', name: {kind: 'Name', value: 'id'}},
+                      {kind: 'Field', name: {kind: 'Name', value: 'status'}},
+                      {kind: 'Field', name: {kind: 'Name', value: 'errorCode'}},
+                      {kind: 'Field', name: {kind: 'Name', value: 'objectCount'}},
+                      {kind: 'Field', name: {kind: 'Name', value: 'createdAt'}},
+                      {kind: 'Field', name: {kind: 'Name', value: 'completedAt'}},
+                      {kind: 'Field', name: {kind: 'Name', value: 'url'}},
+                      {kind: 'Field', name: {kind: 'Name', value: 'partialDataUrl'}},
+                      {kind: 'Field', name: {kind: 'Name', value: '__typename'}},
+                    ],
+                  },
+                },
+                {kind: 'Field', name: {kind: 'Name', value: '__typename'}},
+              ],
+            },
+          },
+        ],
+      },
+    },
+  ],
+} as unknown as DocumentNode<ListBulkOperationsQuery, ListBulkOperationsQueryVariables>
diff --git a/packages/app/src/cli/api/graphql/bulk-operations/queries/list-bulk-operations.graphql b/packages/app/src/cli/api/graphql/bulk-operations/queries/list-bulk-operations.graphql
@@ -0,0 +1,14 @@
+query ListBulkOperations($query: String) {
+  bulkOperations(first: 100, query: $query, sortKey: CREATED_AT, reverse: true) {
+    nodes {
+      id
+      status
+      errorCode
+      objectCount
+      createdAt
+      completedAt
+      url
+      partialDataUrl
+    }
+  }
+}
diff --git a/packages/app/src/cli/api/graphql/business-platform-organizations/generated/types.d.ts b/packages/app/src/cli/api/graphql/business-platform-organizations/generated/types.d.ts
@@ -1,6 +1,4 @@
 /* eslint-disable @typescript-eslint/consistent-type-definitions, @typescript-eslint/naming-convention, @typescript-eslint/no-explicit-any  */
-import {JsonMapType} from '@shopify/cli-kit/node/toml'
-
 export type Maybe<T> = T | null
 export type InputMaybe<T> = Maybe<T>
 export type Exact<T extends {[key: string]: unknown}> = {[K in keyof T]: T[K]}
@@ -42,8 +40,6 @@ export type Scalars = {
   ISO8601Date: {input: any; output: any}
   /** An ISO 8601-encoded datetime */
   ISO8601DateTime: {input: any; output: any}
-  /** Represents untyped JSON */
-  JSON: {input: JsonMapType | string; output: JsonMapType}
   /** The ID for a LegalEntity. */
   LegalEntityID: {input: any; output: any}
   /** The ID for a OrganizationDomain. */
diff --git a/packages/app/src/cli/commands/app/bulk/status.ts b/packages/app/src/cli/commands/app/bulk/status.ts
@@ -2,7 +2,7 @@ import {appFlags} from '../../../flags.js'
 import AppLinkedCommand, {AppLinkedCommandOutput} from '../../../utilities/app-linked-command.js'
 import {linkedAppContext} from '../../../services/app-context.js'
 import {storeContext} from '../../../services/store-context.js'
-import {getBulkOperationStatus} from '../../../services/bulk-operations/bulk-operation-status.js'
+import {getBulkOperationStatus, listBulkOperations} from '../../../services/bulk-operations/bulk-operation-status.js'
 import {Flags} from '@oclif/core'
 import {globalFlags} from '@shopify/cli-kit/node/cli'
 import {normalizeStoreFqdn} from '@shopify/cli-kit/node/context/fqdn'
@@ -20,7 +20,6 @@ export default class BulkStatus extends AppLinkedCommand {
     id: Flags.string({
       description: 'The bulk operation ID.',
       env: 'SHOPIFY_FLAG_ID',
-      required: true,
     }),
     store: Flags.string({
       char: 's',
@@ -46,10 +45,16 @@ export default class BulkStatus extends AppLinkedCommand {
       forceReselectStore: flags.reset,
     })
 
-    await getBulkOperationStatus({
-      storeFqdn: store.shopDomain,
-      operationId: flags.id,
-    })
+    if (flags.id) {
+      await getBulkOperationStatus({
+        storeFqdn: store.shopDomain,
+        operationId: flags.id,
+      })
+    } else {
+      await listBulkOperations({
+        storeFqdn: store.shopDomain,
+      })
+    }
 
     return {app: appContextResult.app}
   }
diff --git a/packages/app/src/cli/services/bulk-operations/bulk-operation-status.test.ts b/packages/app/src/cli/services/bulk-operations/bulk-operation-status.test.ts
@@ -1,5 +1,6 @@
-import {getBulkOperationStatus} from './bulk-operation-status.js'
+import {getBulkOperationStatus, listBulkOperations} from './bulk-operation-status.js'
 import {GetBulkOperationByIdQuery} from '../../api/graphql/bulk-operations/generated/get-bulk-operation-by-id.js'
+import {ListBulkOperationsQuery} from '../../api/graphql/bulk-operations/generated/list-bulk-operations.js'
 import {afterEach, beforeEach, describe, expect, test, vi} from 'vitest'
 import {ensureAuthenticatedAdmin} from '@shopify/cli-kit/node/session'
 import {adminRequestDoc} from '@shopify/cli-kit/node/api/admin'
@@ -161,3 +162,114 @@ describe('getBulkOperationStatus', () => {
     })
   })
 })
+
+describe('listBulkOperations', () => {
+  const storeFqdn = 'test-store.myshopify.com'
+
+  beforeEach(() => {
+    vi.mocked(ensureAuthenticatedAdmin).mockResolvedValue({token: 'test-token', storeFqdn})
+  })
+
+  afterEach(() => {
+    mockAndCaptureOutput().clear()
+  })
+
+  function mockBulkOperationsList(
+    operations: Partial<NonNullable<ListBulkOperationsQuery['bulkOperations']['nodes'][0]>>[],
+  ): ListBulkOperationsQuery {
+    return {
+      bulkOperations: {
+        nodes: operations.map((op) => ({
+          id: 'gid://shopify/BulkOperation/123',
+          status: 'RUNNING',
+          errorCode: null,
+          objectCount: 100,
+          createdAt: new Date().toISOString(),
+          completedAt: null,
+          url: null,
+          partialDataUrl: null,
+          ...op,
+        })),
+      },
+    }
+  }
+
+  test('renders table with bulk operations', async () => {
+    vi.mocked(adminRequestDoc).mockResolvedValue(
+      mockBulkOperationsList([
+        {
+          id: 'gid://shopify/BulkOperation/1',
+          status: 'COMPLETED',
+          objectCount: 123500,
+          createdAt: '2025-11-10T12:37:52Z',
+          completedAt: '2025-11-10T16:37:12Z',
+          url: 'https://example.com/results.jsonl',
+        },
+        {
+          id: 'gid://shopify/BulkOperation/2',
+          status: 'RUNNING',
+          objectCount: 100,
+          createdAt: '2025-11-11T15:37:52Z',
+        },
+      ]),
+    )
+
+    const output = mockAndCaptureOutput()
+    await listBulkOperations({storeFqdn})
+
+    expect(output.output()).toMatch(/ion\/1/)
+    expect(output.output()).toMatch(/ion\/2/)
+    expect(output.output()).toMatch(/COMPLETE/)
+    expect(output.output()).toContain('RUNNING')
+    expect(output.output()).toContain('123.5')
+    expect(output.output()).toMatch(/downloa/)
+  })
+
+  test('formats large counts correctly', async () => {
+    vi.mocked(adminRequestDoc).mockResolvedValue(
+      mockBulkOperationsList([{objectCount: 1200000}, {objectCount: 5500}, {objectCount: 42}]),
+    )
+
+    const output = mockAndCaptureOutput()
+    await listBulkOperations({storeFqdn})
+
+    expect(output.output()).toContain('1.2M')
+    expect(output.output()).toContain('5.5K')
+    expect(output.output()).toContain('42')
+  })
+
+  test('shows download for failed operations with partial results', async () => {
+    vi.mocked(adminRequestDoc).mockResolvedValue(
+      mockBulkOperationsList([
+        {
+          status: 'FAILED',
+          errorCode: 'ACCESS_DENIED',
+          partialDataUrl: 'https://example.com/partial.jsonl',
+          completedAt: '2025-11-10T16:37:12Z',
+        },
+      ]),
+    )
+
+    const output = mockAndCaptureOutput()
+    await listBulkOperations({storeFqdn})
+
+    expect(output.output()).toMatch(/FAIL/)
+    expect(output.output()).toMatch(/downloa/)
+  })
+
+  test('filters operations by last 7 days', async () => {
+    vi.mocked(adminRequestDoc).mockResolvedValue(mockBulkOperationsList([]))
+
+    await listBulkOperations({storeFqdn})
+
+    const sevenDaysAgo = new Date()
+    sevenDaysAgo.setDate(sevenDaysAgo.getDate() - 7)
+    const expectedDate = sevenDaysAgo.toISOString().split('T')[0]
+
+    expect(vi.mocked(adminRequestDoc)).toHaveBeenCalledWith(
+      expect.objectContaining({
+        variables: {query: `created_at:>=${expectedDate}`},
+      }),
+    )
+  })
+})
diff --git a/packages/app/src/cli/services/bulk-operations/bulk-operation-status.ts b/packages/app/src/cli/services/bulk-operations/bulk-operation-status.ts
@@ -4,10 +4,15 @@ import {
   GetBulkOperationById,
   GetBulkOperationByIdQuery,
 } from '../../api/graphql/bulk-operations/generated/get-bulk-operation-by-id.js'
-import {renderInfo, renderSuccess, renderError} from '@shopify/cli-kit/node/ui'
+import {
+  ListBulkOperations,
+  ListBulkOperationsQuery,
+} from '../../api/graphql/bulk-operations/generated/list-bulk-operations.js'
+import {renderInfo, renderSuccess, renderError, renderTable} 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 {formatDate} from '@shopify/cli-kit/common/string'
 
 const API_VERSION = '2026-01'
 
@@ -87,3 +92,61 @@ function timeAgo(from: Date, to: Date): string {
 function formatTimeUnit(count: number, unit: string): string {
   return `${count} ${unit}${count === 1 ? '' : 's'}`
 }
+
+interface ListBulkOperationsOptions {
+  storeFqdn: string
+}
+
+export async function listBulkOperations(options: ListBulkOperationsOptions): Promise<void> {
+  const {storeFqdn} = options
+
+  const adminSession = await ensureAuthenticatedAdmin(storeFqdn)
+
+  const sevenDaysAgo = new Date()
+  sevenDaysAgo.setDate(sevenDaysAgo.getDate() - 7)
+  const dateFilter = sevenDaysAgo.toISOString().split('T')[0]
+
+  const response = await adminRequestDoc<ListBulkOperationsQuery, {query?: string}>({
+    query: ListBulkOperations,
+    session: adminSession,
+    variables: {query: `created_at:>=${dateFilter}`},
+    version: API_VERSION,
+  })
+
+  const operations = response.bulkOperations.nodes.map((op) => ({
+    id: op.id,
+    status: op.status,
+    count: formatCount(op.objectCount),
+    dateCreated: formatDate(new Date(String(op.createdAt))),
+    dateFinished: op.completedAt ? formatDate(new Date(String(op.completedAt))) : '',
+    results: formatResults(op.url, op.partialDataUrl),
+  }))
+
+  renderTable({
+    rows: operations,
+    columns: {
+      id: {header: 'ID'},
+      status: {header: 'STATUS'},
+      count: {header: 'COUNT'},
+      dateCreated: {header: 'DATE CREATED'},
+      dateFinished: {header: 'DATE FINISHED'},
+      results: {header: 'RESULTS'},
+    },
+  })
+}
+
+function formatCount(count: unknown): string {
+  const num = Number(count)
+  if (num >= 1000000) {
+    return `${(num / 1000000).toFixed(1)}M`
+  }
+  if (num >= 1000) {
+    return `${(num / 1000).toFixed(1)}K`
+  }
+  return String(num)
+}
+
+function formatResults(url: string | null | undefined, partialDataUrl: string | null | undefined): string {
+  const downloadUrl = url ?? partialDataUrl
+  return downloadUrl ? 'download' : ''
+}
