add simple unit test for new service

Author: jordanverasamy

packages/app/src/cli/api/graphql/bulk_operation_run_query.ts

@@ -21,20 +21,24 @@ export const BulkOperationRunQuery = gql`
   }
 `
 
+export interface BulkOperation {
+  id: string
+  status: string
+  errorCode: string | null
+  createdAt: string
+  objectCount: string
+  fileSize: string
+  url: string | null
+}
+
+export interface BulkOperationError {
+  field: string[] | null
+  message: string
+}
+
 export interface BulkOperationRunQuerySchema {
   bulkOperationRunQuery: {
-    bulkOperation: {
-      id: string
-      status: string
-      errorCode: string | null
-      createdAt: string
-      objectCount: string
-      fileSize: string
-      url: string | null
-    } | null
-    userErrors: {
-      field: string[] | null
-      message: string
-    }[]
+    bulkOperation: BulkOperation | null,
+    userErrors: BulkOperationError[],
   }
 }

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

@@ -0,0 +1,42 @@
+import {runBulkOperationQuery} from './bulk-operations.js'
+import {adminRequest} from '@shopify/cli-kit/node/api/admin'
+import {ensureAuthenticatedAdmin} from '@shopify/cli-kit/node/session'
+import {describe, test, expect, vi, beforeEach} from 'vitest'
+
+vi.mock('@shopify/cli-kit/node/api/admin')
+vi.mock('@shopify/cli-kit/node/session')
+
+describe('runBulkOperationQuery', () => {
+  const mockSession = {token: 'test-token', storeFqdn: 'test-store.myshopify.com'}
+  const successfulBulkOperation = {
+    id: 'gid://shopify/BulkOperation/123',
+    status: 'CREATED',
+    errorCode: null,
+    createdAt: '2024-01-01T00:00:00Z',
+    objectCount: '0',
+    fileSize: '0',
+    url: null,
+  }
+  const mockSuccessResponse = {
+    bulkOperationRunQuery: {
+      bulkOperation: successfulBulkOperation,
+      userErrors: [],
+    },
+  }
+
+  beforeEach(() => {
+    vi.mocked(ensureAuthenticatedAdmin).mockResolvedValue(mockSession)
+  })
+
+  test('returns a bulk operation when request succeeds', async () => {
+    vi.mocked(adminRequest).mockResolvedValue(mockSuccessResponse)
+
+    const bulkOperationResult = await runBulkOperationQuery({
+      storeFqdn: 'test-store.myshopify.com',
+      query: 'query { products { edges { node { id } } } }',
+    })
+
+    expect(bulkOperationResult.result).toEqual(successfulBulkOperation)
+    expect(bulkOperationResult.errors).toBeUndefined()
+  })
+})

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

@@ -1,4 +1,4 @@
-import {BulkOperationRunQuery, BulkOperationRunQuerySchema} from '../api/graphql/bulk_operation_run_query.js'
+import {BulkOperationRunQuery, BulkOperation, BulkOperationError, BulkOperationRunQuerySchema} from '../api/graphql/bulk_operation_run_query.js'
 import {adminRequest} from '@shopify/cli-kit/node/api/admin'
 import {ensureAuthenticatedAdmin} from '@shopify/cli-kit/node/session'
 
@@ -7,19 +7,16 @@ interface BulkOperationRunQueryOptions {
   query: string
 }
 
-type BulkOperationResult = NonNullable<BulkOperationRunQuerySchema['bulkOperationRunQuery']['bulkOperation']>
-type BulkOperationError = BulkOperationRunQuerySchema['bulkOperationRunQuery']['userErrors'][number]
-
 /**
  * Executes a bulk operation query against the Shopify Admin API.
  * The operation runs asynchronously in the background.
  */
 export async function runBulkOperationQuery(
   options: BulkOperationRunQueryOptions,
-): Promise<{result?: BulkOperationResult; errors?: BulkOperationError[]}> {
+): Promise<{result?: BulkOperation; errors?: BulkOperationError[]}> {
   const {storeFqdn, query} = options
   const adminSession = await ensureAuthenticatedAdmin(storeFqdn)
-  const response: BulkOperationRunQuerySchema = await adminRequest(BulkOperationRunQuery, adminSession, {query})
+  const response = await adminRequest<BulkOperationRunQuerySchema>(BulkOperationRunQuery, adminSession, {query})
 
   if (response.bulkOperationRunQuery.userErrors.length > 0) {
     return {