revert api-client-core changes - implementation lives in @gadgetinc/connection

Author: dewolfe

packages/api-client-core/spec/operationBuilders.spec.ts

@@ -3,7 +3,6 @@ import {
   backgroundActionResultOperation,
   cancelBackgroundActionOperation,
   enqueueActionOperation,
-  enqueueShopifyGraphqlOperation,
   findManyOperation,
   findOneByFieldOperation,
   findOneOperation,
@@ -1297,98 +1296,6 @@ describe("operation builders", () => {
         }
       `);
     });
-
-    test("enqueueActionOperation with shopifyShop option", () => {
-      expect(enqueueActionOperation("createWidget", {}, undefined, { shopifyShop: "987654321" })).toMatchInlineSnapshot(`
-        {
-          "query": "mutation enqueueCreateWidget($backgroundOptions: EnqueueBackgroundActionOptions) {
-          background {
-            createWidget(backgroundOptions: $backgroundOptions) {
-              success
-              errors {
-                message
-                code
-              }
-              backgroundAction {
-                id
-              }
-            }
-          }
-        }",
-          "variables": {
-            "backgroundOptions": {
-              "shopifyShop": "987654321",
-            },
-          },
-        }
-      `);
-    });
-  });
-
-  describe("enqueueShopifyGraphqlOperation", () => {
-    test("enqueueShopifyGraphqlOperation should build a mutation query for enqueuing a Shopify GraphQL operation", () => {
-      expect(enqueueShopifyGraphqlOperation("shop-123", { query: "query { shop { name } }", variables: {} })).toMatchInlineSnapshot(`
-        {
-          "query": "mutation enqueueShopifyGraphql($shopId: String!, $query: String!, $variables: JSONObject, $backgroundOptions: EnqueueBackgroundActionOptions) {
-          background {
-            shopifyGraphql(shopId: $shopId, query: $query, variables: $variables, backgroundOptions: $backgroundOptions) {
-              success
-              errors {
-                message
-                code
-              }
-              backgroundAction {
-                id
-              }
-            }
-          }
-        }",
-          "variables": {
-            "backgroundOptions": null,
-            "query": "query { shop { name } }",
-            "shopId": "shop-123",
-            "variables": {},
-          },
-        }
-      `);
-    });
-
-    test("enqueueShopifyGraphqlOperation with options", () => {
-      expect(
-        enqueueShopifyGraphqlOperation(
-          "shop-123",
-          {
-            query:
-              'mutation { updateProduct(id: \\"gid://shopify/Product/123\\", product: { title: \\"New Title\\" }) { product { id title } } }',
-          },
-          { startAt: "2024-01-01T00:00:00Z" }
-        )
-      ).toMatchInlineSnapshot(`
-        {
-          "query": "mutation enqueueShopifyGraphql($shopId: String!, $query: String!, $variables: JSONObject, $backgroundOptions: EnqueueBackgroundActionOptions) {
-          background {
-            shopifyGraphql(shopId: $shopId, query: $query, variables: $variables, backgroundOptions: $backgroundOptions) {
-              success
-              errors {
-                message
-                code
-              }
-              backgroundAction {
-                id
-              }
-            }
-          }
-        }",
-          "variables": {
-            "backgroundOptions": {
-              "startAt": "2024-01-01T00:00:00Z",
-            },
-            "query": "mutation { updateProduct(id: \\"gid://shopify/Product/123\\", product: { title: \\"New Title\\" }) { product { id title } } }",
-            "shopId": "shop-123",
-          },
-        }
-      `);
-    });
   });
 
   describe("backgroundActionResultOperation", () => {

packages/api-client-core/src/operationBuilders.ts

@@ -304,7 +304,6 @@ export const graphqlizeBackgroundOptions = (options?: EnqueueBackgroundActionOpt
   if (!options) return null;
 
   const obj = { ...options };
-
   if (typeof obj.retries == "number") {
     obj.retries = {
       retryCount: obj.retries,
@@ -322,7 +321,7 @@ export const graphqlizeBackgroundOptions = (options?: EnqueueBackgroundActionOpt
   }
 
   for (const key of Object.keys(obj)) {
-    if (["id", "retries", "queue", "priority", "startAt", "shopifyShop"].includes(key)) continue;
+    if (["id", "retries", "queue", "priority", "startAt"].includes(key)) continue;
     delete obj[key];
   }
 
@@ -369,44 +368,6 @@ export const enqueueActionOperation = (
   });
 };
 
-export const enqueueShopifyGraphqlOperation = (
-  shopId: string,
-  variables: { query: string; variables?: Record<string, any> },
-  options?: EnqueueBackgroundActionOptions<any> | null
-) => {
-  const fields: BuilderFieldSelection = {
-    shopifyGraphql: Call(
-      {
-        shopId: Var({ type: "String!", value: shopId }),
-        query: Var({ type: "String!", value: variables.query }),
-        variables: Var({ type: "JSONObject", value: variables.variables }),
-        backgroundOptions: Var({
-          type: "EnqueueBackgroundActionOptions",
-          value: graphqlizeBackgroundOptions(options),
-        }),
-      },
-      {
-        success: true,
-        errors: {
-          message: true,
-          code: true,
-        },
-        backgroundAction: {
-          id: true,
-        },
-      }
-    ),
-  };
-
-  return compileWithVariableValues({
-    type: "mutation",
-    name: "enqueueShopifyGraphql",
-    fields: {
-      background: fields,
-    },
-  });
-};
-
 export const cancelBackgroundActionOperation = (id: string) => {
   const fields = {
     cancel: Call(

packages/api-client-core/src/operationRunners.ts

@@ -21,7 +21,6 @@ import {
   backgroundActionResultOperation,
   cancelBackgroundActionOperation,
   enqueueActionOperation,
-  enqueueShopifyGraphqlOperation,
   findManyOperation,
   findOneByFieldOperation,
   findOneOperation,
@@ -404,22 +403,6 @@ export async function enqueueActionRunner<SchemaT, Action extends AnyActionFunct
   variables: Action["variablesType"],
   options: EnqueueBackgroundActionOptions<Action> = {}
 ): Promise<Result | Result[]> {
-  if ((action as any).type === "shopifyGraphql") {
-    const shopifyShop = (action as any).shopifyShop;
-    if (!shopifyShop) {
-      throw new Error(
-        "Cannot enqueue shopifyGraphql without a current shop. Make sure to call connections.shopify.setCurrentShop() first or access graphql from a request with shop context."
-      );
-    }
-
-    const plan = enqueueShopifyGraphqlOperation(shopifyShop, variables as any, options);
-    const response = await connection.currentClient.mutation(plan.query, plan.variables, options).toPromise();
-    const dataPath = ["background", "shopifyGraphql"];
-
-    const result = assertMutationSuccess(response, dataPath);
-    return new BackgroundActionHandle(connection, action, result.backgroundAction.id) as Result;
-  }
-
   const normalizedVariableValues = action.isBulk
     ? disambiguateBulkActionVariables(action, variables)
     : disambiguateActionVariables(action, variables);

packages/api-client-core/src/types.ts

@@ -878,14 +878,6 @@ export type EnqueueBackgroundActionOptions<Action extends AnyActionFunction> = {
    * startAt: new Date(new Date().getTime() + 60 * 1000)
    */
   startAt?: Date | string;
-
-  /**
-   * The Shopify shop to enqueue the background action for. If not passed, the action will not be rate limited.
-   *
-   * @example
-   * shopifyShop: "82277368081"
-   */
-  shopifyShop?: string;
 } & Partial<OperationContext>;
 
 export type ActionFunctionOptions<Action extends AnyActionFunction> = Action extends ActionFunction<infer Options, any, any, any, any>