app calls Bulk Operation Query API

Author: ericlee878

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

@@ -0,0 +1,40 @@
+import {gql} from 'graphql-request'
+
+// eslint-disable-next-line @shopify/cli/no-inline-graphql
+export const BulkOperationRunQuery = gql`
+  mutation BulkOperationRunQuery($query: String!) {
+    bulkOperationRunQuery(query: $query) {
+      bulkOperation {
+        id
+        status
+        errorCode
+        createdAt
+        objectCount
+        fileSize
+        url
+      }
+      userErrors {
+        field
+        message
+      }
+    }
+  }
+`
+
+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
+    }[]
+  }
+}

packages/app/src/cli/commands/app/execute.ts

@@ -1,8 +1,13 @@
 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 {runBulkOperationQuery} from '../../services/bulk-operations.js'
+import {Flags} from '@oclif/core'
 import {globalFlags} from '@shopify/cli-kit/node/cli'
-import {renderSuccess} from '@shopify/cli-kit/node/ui'
+import {renderSuccess, renderInfo, renderWarning} from '@shopify/cli-kit/node/ui'
+import {normalizeStoreFqdn} from '@shopify/cli-kit/node/context/fqdn'
+import {outputContent, outputToken} from '@shopify/cli-kit/node/output'
 
 export default class Execute extends AppLinkedCommand {
   static summary = 'Execute bulk operations.'
@@ -14,6 +19,18 @@ export default class Execute extends AppLinkedCommand {
   static flags = {
     ...globalFlags,
     ...appFlags,
+    query: Flags.string({
+      char: 'q',
+      description: 'The GraphQL query, as a string.',
+      env: 'SHOPIFY_FLAG_QUERY',
+      required: true,
+    }),
+    store: Flags.string({
+      char: 's',
+      description: 'Store URL. Must be an existing development or Shopify Plus sandbox store.',
+      env: 'SHOPIFY_FLAG_STORE',
+      parse: async (input) => normalizeStoreFqdn(input),
+    }),
   }
 
   async run(): Promise<AppLinkedCommandOutput> {
@@ -26,11 +43,57 @@ export default class Execute extends AppLinkedCommand {
       userProvidedConfigName: flags.config,
     })
 
-    renderSuccess({
-      headline: 'App context loaded successfully!',
-      body: `App: ${appContextResult.app.name}\nOrganization: ${appContextResult.organization.businessName}`,
+    const store = await storeContext({
+      appContextResult,
+      storeFqdn: flags.store,
+      forceReselectStore: flags.reset,
     })
 
+    renderInfo({
+      headline: 'Starting bulk operation.',
+      body: `App: ${appContextResult.app.name}\nStore: ${store.shopDomain}`,
+    })
+
+    const {result, errors} = await runBulkOperationQuery({
+      storeFqdn: store.shopDomain,
+      query: flags.query,
+    })
+
+    if (errors && errors.length > 0) {
+      const errorMessages = errors.map((error) => `${error.field?.join('.') ?? 'unknown'}: ${error.message}`).join('\n')
+      renderWarning({
+        headline: 'Bulk operation errors.',
+        body: errorMessages,
+      })
+      return {app: appContextResult.app}
+    }
+
+    if (result) {
+      const infoSections = [
+        {
+          title: 'Bulk Operation Created',
+          body: [
+            {
+              list: {
+                items: [
+                  outputContent`ID: ${outputToken.cyan(result.id)}`.value,
+                  outputContent`Status: ${outputToken.yellow(result.status)}`.value,
+                  outputContent`Created: ${outputToken.gray(result.createdAt)}`.value,
+                ],
+              },
+            },
+          ],
+        },
+      ]
+
+      renderInfo({customSections: infoSections})
+
+      renderSuccess({
+        headline: 'Bulk operation started successfully!',
+        body: 'Congrats!',
+      })
+    }
+
     return {app: appContextResult.app}
   }
 }

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

@@ -0,0 +1,38 @@
+import {BulkOperationRunQuery, BulkOperationRunQuerySchema} from '../api/graphql/bulk_operation_run_query.js'
+import {adminRequest} from '@shopify/cli-kit/node/api/admin'
+import {AdminSession, ensureAuthenticatedAdmin} from '@shopify/cli-kit/node/session'
+
+export interface BulkOperationRunQueryOptions {
+  storeFqdn: string
+  query: string
+}
+
+export type BulkOperationResult = NonNullable<BulkOperationRunQuerySchema['bulkOperationRunQuery']['bulkOperation']>
+export 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[]}> {
+  const {storeFqdn, query} = options
+  const adminSession: AdminSession = await ensureAuthenticatedAdmin(storeFqdn)
+  const response: BulkOperationRunQuerySchema = await adminRequest(BulkOperationRunQuery, adminSession, {query})
+
+  if (response.bulkOperationRunQuery.userErrors.length > 0) {
+    return {
+      errors: response.bulkOperationRunQuery.userErrors,
+    }
+  }
+
+  const bulkOperation = response.bulkOperationRunQuery.bulkOperation
+  if (bulkOperation) {
+    return {result: bulkOperation}
+  }
+
+  return {
+    errors: [{field: null, message: 'No bulk operation was created'}],
+  }
+}