Extract shared bulk-operation engine into cli-kit

bin/get-graphql-schemas.js

@@ -81,7 +81,7 @@ const schemas = [
     pathToFile: 'areas/core/shopify/db/graphql/admin_schema_unstable_public.graphql',
     localPaths: [
       './packages/cli-kit/src/cli/api/graphql/admin/admin_schema.graphql',
-      './packages/app/src/cli/api/graphql/bulk-operations/admin_schema.graphql',
+      './packages/cli-kit/src/cli/api/graphql/bulk-operations/admin_schema.graphql',
       './packages/app/src/cli/api/graphql/admin/admin_schema.graphql',
     ],
     usesLfs: true,

graphql.config.ts

@@ -81,7 +81,7 @@ export default {
     appDev: projectFactory('app-dev', 'app_dev_schema.graphql'),
     appManagement: projectFactory('app-management', 'app_management_schema.graphql'),
     admin: projectFactory('admin', 'admin_schema.graphql', 'cli-kit'),
-    bulkOperations: projectFactory('bulk-operations', 'admin_schema.graphql'),
+    bulkOperations: projectFactory('bulk-operations', 'admin_schema.graphql', 'cli-kit'),
     webhooks: projectFactory('webhooks', 'webhooks_schema.graphql'),
     functions: projectFactory('functions', 'functions_cli_schema.graphql', 'app'),
     adminAsApp: projectFactory('admin', 'admin_schema.graphql'),

packages/app/project.json

@@ -59,7 +59,6 @@
         "{projectRoot}/src/cli/api/graphql/app-management/generated/**/*.ts",
         "{projectRoot}/src/cli/api/graphql/webhooks/generated/**/*.ts",
         "{projectRoot}/src/cli/api/graphql/functions/generated/**/*.ts",
-        "{projectRoot}/src/cli/api/graphql/bulk-operations/generated/**/*.ts",
         "{projectRoot}/src/cli/api/graphql/admin/generated/**/*.ts"
       ],
       "options": {
@@ -71,7 +70,6 @@
           "pnpm eslint 'src/cli/api/graphql/app-management/generated/**/*.{ts,tsx}' --fix",
           "pnpm eslint 'src/cli/api/graphql/webhooks/generated/**/*.{ts,tsx}' --fix",
           "pnpm eslint 'src/cli/api/graphql/functions/generated/**/*.{ts,tsx}' --fix",
-          "pnpm eslint 'src/cli/api/graphql/bulk-operations/generated/**/*.{ts,tsx}' --fix",
           "pnpm eslint 'src/cli/api/graphql/admin/generated/**/*.{ts,tsx}' --fix"
         ],
         "cwd": "packages/app"
@@ -154,17 +152,6 @@
         "cwd": "{workspaceRoot}"
       }
     },
-    "graphql-codegen:generate:bulk-operations": {
-      "executor": "nx:run-commands",
-      "inputs": ["{workspaceRoot}/graphql.config.ts", "{projectRoot}/src/cli/api/graphql/bulk-operations/**/*.graphql"],
-      "outputs": ["{projectRoot}/src/cli/api/graphql/bulk-operations/generated/**/*.ts"],
-      "options": {
-        "commands": [
-          "pnpm exec graphql-codegen --project=bulkOperations"
-        ],
-        "cwd": "{workspaceRoot}"
-      }
-    },
     "graphql-codegen:generate:admin-as-app": {
       "executor": "nx:run-commands",
       "inputs": ["{workspaceRoot}/graphql.config.ts", "{projectRoot}/src/cli/api/graphql/admin/**/*.graphql"],
@@ -186,7 +173,6 @@
         "graphql-codegen:generate:app-management",
         "graphql-codegen:generate:webhooks",
         "graphql-codegen:generate:functions",
-        "graphql-codegen:generate:bulk-operations",
         "graphql-codegen:generate:admin-as-app"
       ],
       "inputs": [{ "dependentTasksOutputFiles": "**/*.ts" }],
@@ -198,7 +184,6 @@
         "{projectRoot}/src/cli/api/graphql/app-management/generated/**/*.ts",
         "{projectRoot}/src/cli/api/graphql/webhooks/generated/**/*.ts",
         "{projectRoot}/src/cli/api/graphql/functions/generated/**/*.ts",
-        "{projectRoot}/src/cli/api/graphql/bulk-operations/generated/**/*.ts",
         "{projectRoot}/src/cli/api/graphql/admin/generated/**/*.ts"
       ],
       "options": {
@@ -210,7 +195,6 @@
           "find ./packages/app/src/cli/api/graphql/app-management/generated/ -type f -name '*.ts' -exec sh -c 'sed -i \"\" \"s|import \\* as Types from '\\''./types'\\'';|import \\* as Types from '\\''./types.js'\\'';|g; s|export const \\([A-Za-z0-9_]*\\)Document =|export const \\1 =|g\" \"$0\"' {} \\;",
           "find ./packages/app/src/cli/api/graphql/webhooks/generated/ -type f -name '*.ts' -exec sh -c 'sed -i \"\" \"s|import \\* as Types from '\\''./types'\\'';|import \\* as Types from '\\''./types.js'\\'';|g; s|export const \\([A-Za-z0-9_]*\\)Document =|export const \\1 =|g\" \"$0\"' {} \\;",
           "find ./packages/app/src/cli/api/graphql/functions/generated/ -type f -name '*.ts' -exec sh -c 'sed -i \"\" \"s|import \\* as Types from '\\''./types'\\'';|import \\* as Types from '\\''./types.js'\\'';|g; s|export const \\([A-Za-z0-9_]*\\)Document =|export const \\1 =|g\" \"$0\"' {} \\;",
-          "find ./packages/app/src/cli/api/graphql/bulk-operations/generated/ -type f -name '*.ts' -exec sh -c 'sed -i \"\" \"s|import \\* as Types from '\\''./types'\\'';|import \\* as Types from '\\''./types.js'\\'';|g; s|export const \\([A-Za-z0-9_]*\\)Document =|export const \\1 =|g\" \"$0\"' {} \\;",
           "find ./packages/app/src/cli/api/graphql/admin/generated/ -type f -name '*.ts' -exec sh -c 'sed -i \"\" \"s|import \\* as Types from '\\''./types'\\'';|import \\* as Types from '\\''./types.js'\\'';|g; s|export const \\([A-Za-z0-9_]*\\)Document =|export const \\1 =|g\" \"$0\"' {} \\;"
         ],
         "cwd": "{workspaceRoot}"

packages/app/src/cli/commands/app/bulk/cancel.ts

@@ -2,9 +2,9 @@ import {appFlags} from '../../../flags.js'
 import AppLinkedCommand, {AppLinkedCommandOutput} from '../../../utilities/app-linked-command.js'
 import {prepareAppStoreContext} from '../../../utilities/execute-command-helpers.js'
 import {cancelBulkOperation} from '../../../services/bulk-operations/cancel-bulk-operation.js'
-import {normalizeBulkOperationId} from '../../../services/bulk-operations/bulk-operation-status.js'
 import {Flags} from '@oclif/core'
 import {globalFlags} from '@shopify/cli-kit/node/cli'
+import {normalizeBulkOperationId} from '@shopify/cli-kit/node/api/bulk-operations'
 import {normalizeStoreFqdn} from '@shopify/cli-kit/node/context/fqdn'
 
 export default class BulkCancel extends AppLinkedCommand {

packages/app/src/cli/commands/app/bulk/status.ts

@@ -1,13 +1,10 @@
 import {appFlags} from '../../../flags.js'
 import AppLinkedCommand, {AppLinkedCommandOutput} from '../../../utilities/app-linked-command.js'
 import {prepareAppStoreContext} from '../../../utilities/execute-command-helpers.js'
-import {
-  getBulkOperationStatus,
-  listBulkOperations,
-  normalizeBulkOperationId,
-} 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 {normalizeBulkOperationId} from '@shopify/cli-kit/node/api/bulk-operations'
 import {normalizeStoreFqdn} from '@shopify/cli-kit/node/context/fqdn'
 
 export default class BulkStatus extends AppLinkedCommand {

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

@@ -1,14 +1,7 @@
-import {
-  getBulkOperationStatus,
-  listBulkOperations,
-  normalizeBulkOperationId,
-  extractBulkOperationId,
-} from './bulk-operation-status.js'
-import {BULK_OPERATIONS_MIN_API_VERSION} from './constants.js'
-import {GetBulkOperationByIdQuery} from '../../api/graphql/bulk-operations/generated/get-bulk-operation-by-id.js'
+import {getBulkOperationStatus, listBulkOperations} from './bulk-operation-status.js'
 import {OrganizationApp, Organization, OrganizationSource} from '../../models/organization.js'
-import {ListBulkOperationsQuery} from '../../api/graphql/bulk-operations/generated/list-bulk-operations.js'
 import {resolveApiVersion} from '../graphql/common.js'
+import {BULK_OPERATIONS_MIN_API_VERSION, type BulkOperation} from '@shopify/cli-kit/node/api/bulk-operations'
 import {afterEach, beforeEach, describe, expect, test, vi} from 'vitest'
 import {ensureAuthenticatedAdminAsApp} from '@shopify/cli-kit/node/session'
 import {adminRequestDoc} from '@shopify/cli-kit/node/api/admin'
@@ -51,41 +44,8 @@ afterEach(() => {
   mockAndCaptureOutput().clear()
 })
 
-describe('normalizeBulkOperationId', () => {
-  test('returns GID as-is when already in GID format', () => {
-    const gid = 'gid://shopify/BulkOperation/123'
-    expect(normalizeBulkOperationId(gid)).toBe(gid)
-  })
-
-  test('converts numeric ID to GID format', () => {
-    expect(normalizeBulkOperationId('123')).toBe('gid://shopify/BulkOperation/123')
-    expect(normalizeBulkOperationId('456789')).toBe('gid://shopify/BulkOperation/456789')
-  })
-
-  test('returns non-numeric, non-GID string as-is', () => {
-    const invalidId = 'invalid-id'
-    expect(normalizeBulkOperationId(invalidId)).toBe(invalidId)
-  })
-})
-
-describe('extractBulkOperationId', () => {
-  test('extracts numeric ID from GID', () => {
-    expect(extractBulkOperationId('gid://shopify/BulkOperation/123')).toBe('123')
-    expect(extractBulkOperationId('gid://shopify/BulkOperation/456789')).toBe('456789')
-  })
-
-  test('returns input as-is if not a valid GID format', () => {
-    expect(extractBulkOperationId('gid://shopify/BulkOperation/ABC')).toBe('gid://shopify/BulkOperation/ABC')
-    expect(extractBulkOperationId('BulkOperation/123')).toBe('BulkOperation/123')
-    expect(extractBulkOperationId('invalid-id')).toBe('invalid-id')
-    expect(extractBulkOperationId('123')).toBe('123')
-  })
-})
-
 describe('getBulkOperationStatus', () => {
-  function mockBulkOperation(
-    overrides?: Partial<NonNullable<GetBulkOperationByIdQuery['bulkOperation']>>,
-  ): GetBulkOperationByIdQuery {
+  function mockBulkOperation(overrides?: Partial<BulkOperation>): {bulkOperation: BulkOperation | null} {
     return {
       bulkOperation: {
         id: operationId,
@@ -243,9 +203,7 @@ describe('getBulkOperationStatus', () => {
 })
 
 describe('listBulkOperations', () => {
-  function mockBulkOperationsList(
-    operations: Partial<NonNullable<ListBulkOperationsQuery['bulkOperations']['nodes'][0]>>[],
-  ): ListBulkOperationsQuery {
+  function mockBulkOperationsList(operations: Partial<BulkOperation>[]): {bulkOperations: {nodes: BulkOperation[]}} {
     return {
       bulkOperations: {
         nodes: operations.map((op) => ({

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

@@ -1,46 +1,20 @@
-import {BulkOperation} from './watch-bulk-operation.js'
-import {formatBulkOperationStatus} from './format-bulk-operation-status.js'
-import {BULK_OPERATIONS_MIN_API_VERSION} from './constants.js'
-import {
-  GetBulkOperationById,
-  GetBulkOperationByIdQuery,
-} from '../../api/graphql/bulk-operations/generated/get-bulk-operation-by-id.js'
 import {formatOperationInfo, resolveApiVersion} from '../graphql/common.js'
 import {OrganizationApp, Organization} from '../../models/organization.js'
 import {
-  ListBulkOperations,
-  ListBulkOperationsQuery,
-  ListBulkOperationsQueryVariables,
-} from '../../api/graphql/bulk-operations/generated/list-bulk-operations.js'
+  BULK_OPERATIONS_MIN_API_VERSION,
+  fetchBulkOperationById,
+  fetchRecentBulkOperations,
+  formatBulkOperationStatus,
+  extractBulkOperationId,
+  type BulkOperation,
+} from '@shopify/cli-kit/node/api/bulk-operations'
 import {renderInfo, renderSuccess, renderError, renderTable} from '@shopify/cli-kit/node/ui'
 import {outputContent, outputToken, outputNewline} from '@shopify/cli-kit/node/output'
 import {ensureAuthenticatedAdminAsApp} from '@shopify/cli-kit/node/session'
-import {adminRequestDoc} from '@shopify/cli-kit/node/api/admin'
 import {timeAgo, formatDate} from '@shopify/cli-kit/common/string'
 import {BugError} from '@shopify/cli-kit/node/error'
 import colors from '@shopify/cli-kit/node/colors'
 
-export function normalizeBulkOperationId(id: string): string {
-  // If already a GID, return as-is
-  if (id.startsWith('gid://')) {
-    return id
-  }
-
-  // If numeric, convert to GID
-  if (/^\d+$/.test(id)) {
-    return `gid://shopify/BulkOperation/${id}`
-  }
-
-  // Otherwise return as-is (let API handle any errors)
-  return id
-}
-
-export function extractBulkOperationId(gid: string): string {
-  // Extract the numeric ID from a GID like "gid://shopify/BulkOperation/123"
-  const match = gid.match(/^gid:\/\/shopify\/BulkOperation\/(\d+)$/)
-  return match?.[1] ?? gid
-}
-
 interface GetBulkOperationStatusOptions {
   organization: Organization
   storeFqdn: string
@@ -73,18 +47,17 @@ export async function getBulkOperationStatus(options: GetBulkOperationStatusOpti
 
   const adminSession = await ensureAuthenticatedAdminAsApp(storeFqdn, remoteApp.apiKey, appSecret)
 
-  const response = await adminRequestDoc<GetBulkOperationByIdQuery, {id: string}>({
-    query: GetBulkOperationById,
-    session: adminSession,
-    variables: {id: operationId},
+  const operation = await fetchBulkOperationById({
+    adminSession,
+    operationId,
     version: await resolveApiVersion({
       adminSession,
       minimumDefaultVersion: BULK_OPERATIONS_MIN_API_VERSION,
     }),
   })
 
-  if (response.bulkOperation) {
-    renderBulkOperationStatus(response.bulkOperation)
+  if (operation) {
+    renderBulkOperationStatus(operation)
   } else {
     renderError({
       headline: 'Bulk operation not found.',
@@ -112,23 +85,15 @@ export async function listBulkOperations(options: ListBulkOperationsOptions): Pr
 
   const adminSession = await ensureAuthenticatedAdminAsApp(storeFqdn, remoteApp.apiKey, appSecret)
 
-  const sevenDaysAgo = new Date(Date.now() - 7 * 24 * 60 * 60 * 1000).toISOString().split('T')[0]
-
-  const response = await adminRequestDoc<ListBulkOperationsQuery, ListBulkOperationsQueryVariables>({
-    query: ListBulkOperations,
-    session: adminSession,
-    variables: {
-      query: `created_at:>=${sevenDaysAgo}`,
-      first: 100,
-      sortKey: 'CREATED_AT',
-    },
+  const nodes = await fetchRecentBulkOperations({
+    adminSession,
     version: await resolveApiVersion({
       adminSession,
       minimumDefaultVersion: BULK_OPERATIONS_MIN_API_VERSION,
     }),
   })
 
-  const operations = response.bulkOperations.nodes.map((operation) => ({
+  const operations = nodes.map((operation) => ({
     id: extractBulkOperationId(operation.id),
     status: formatStatus(operation.status),
     count: formatCount(operation.objectCount as number),

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

@@ -1,16 +1,13 @@
-import {renderBulkOperationUserErrors, formatBulkOperationCancellationResult} from './format-bulk-operation-status.js'
-import {
-  BulkOperationCancel,
-  BulkOperationCancelMutation,
-  BulkOperationCancelMutationVariables,
-} from '../../api/graphql/bulk-operations/generated/bulk-operation-cancel.js'
 import {formatOperationInfo, createAdminSessionAsApp} from '../graphql/common.js'
 import {OrganizationApp, Organization} from '../../models/organization.js'
-import {renderInfo, renderError, renderSuccess, renderWarning} from '@shopify/cli-kit/node/ui'
+import {
+  cancelBulkOperationRequest,
+  renderBulkOperationUserErrors,
+  formatBulkOperationCancellationResult,
+  extractBulkOperationId,
+} from '@shopify/cli-kit/node/api/bulk-operations'
+import {renderInfo, renderError, renderSuccess, renderWarning, TokenItem} from '@shopify/cli-kit/node/ui'
 import {outputContent, outputToken} from '@shopify/cli-kit/node/output'
-import {adminRequestDoc} from '@shopify/cli-kit/node/api/admin'
-
-const API_VERSION = '2026-01'
 
 interface CancelBulkOperationOptions {
   organization: Organization
@@ -35,24 +32,27 @@ export async function cancelBulkOperation(options: CancelBulkOperationOptions):
 
   const adminSession = await createAdminSessionAsApp(remoteApp, storeFqdn)
 
-  const response = await adminRequestDoc<BulkOperationCancelMutation, BulkOperationCancelMutationVariables>({
-    query: BulkOperationCancel,
-    session: adminSession,
-    variables: {id: operationId},
-    version: API_VERSION,
-  })
+  const bulkOperationCancel = await cancelBulkOperationRequest({adminSession, operationId})
 
-  if (response.bulkOperationCancel?.userErrors?.length) {
-    renderBulkOperationUserErrors(response.bulkOperationCancel.userErrors, 'Failed to cancel bulk operation.')
+  if (bulkOperationCancel?.userErrors?.length) {
+    renderBulkOperationUserErrors(bulkOperationCancel.userErrors, 'Failed to cancel bulk operation.')
     return
   }
 
-  const operation = response.bulkOperationCancel?.bulkOperation
+  const operation = bulkOperationCancel?.bulkOperation
   if (operation) {
     const result = formatBulkOperationCancellationResult(operation)
+    // The engine is command-agnostic; this command writes its own "check status" hint.
+    const body: TokenItem | undefined =
+      operation.status === 'CANCELING'
+        ? [
+            'This may take a few moments. Check the status with:\n',
+            {command: `shopify app bulk status --id=${extractBulkOperationId(operation.id)}`},
+          ]
+        : result.body
     const renderOptions = {
       headline: result.headline,
-      ...(result.body && {body: result.body}),
+      ...(body && {body}),
       ...(result.customSections && {customSections: result.customSections}),
     }