Remove cache update on product webhooks

.changeset/breezy-carrots-reply.md

@@ -0,0 +1,5 @@
+---
+"saleor-app-products-feed": patch
+---
+
+Removed webhooks on product changes used for feed cache due to changed max execution time.

.changeset/tender-seas-hunt.md

@@ -0,0 +1,5 @@
+---
+"saleor-app-products-feed": patch
+---
+
+Changed Vercel's maximum execution time to be 5 minutes for feed generation. This should help with the previous limits of 60s, that was not enough for feed to be generated.

apps/products-feed/next.config.js

@@ -6,7 +6,12 @@ const isSentryPropertiesInEnvironment =
 /** @type {import('next').NextConfig} */
 const nextConfig = {
   reactStrictMode: true,
-  transpilePackages: ["@saleor/apps-shared", "@saleor/apps-ui", "@saleor/react-hook-form-macaw"],
+  transpilePackages: [
+    "@saleor/apps-shared",
+    "@saleor/apps-ui",
+    "@saleor/react-hook-form-macaw",
+    "@saleor/webhook-utils",
+  ],
 };
 
 const configWithSentry = withSentryConfig(
@@ -22,7 +27,7 @@ const configWithSentry = withSentryConfig(
     tunnelRoute: "/monitoring",
     hideSourceMaps: true,
     disableLogger: true,
-  }
+  },
 );
 
 module.exports = isSentryPropertiesInEnvironment ? configWithSentry : nextConfig;

apps/products-feed/package.json

@@ -19,6 +19,7 @@
     "@saleor/apps-ui": "workspace:*",
     "@saleor/macaw-ui": "0.8.0-pre.127",
     "@saleor/react-hook-form-macaw": "workspace:*",
+    "@saleor/webhook-utils": "workspace:*",
     "@sentry/nextjs": "7.67.0",
     "@tanstack/react-query": "4.29.19",
     "@trpc/client": "10.38.1",
@@ -27,6 +28,7 @@
     "@trpc/server": "10.38.1",
     "@urql/exchange-auth": "^2.1.4",
     "@vitejs/plugin-react": "4.0.4",
+    "dotenv": "^16.3.1",
     "fast-xml-parser": "^4.0.15",
     "graphql": "16.7.1",
     "graphql-tag": "^2.12.6",

apps/products-feed/scripts/migrations/README.md

@@ -0,0 +1,7 @@
+# Webhook migration scripts
+
+Test migration with dry run, operation will not modify any data:
+`npx tsx scripts/migrations/run-webhooks-migration-dry-run.ts`
+
+To start the migration run command:
+`npx tsx scripts/migrations/run-webhooks-migration.ts`

apps/products-feed/scripts/migrations/migration-utils.ts

@@ -0,0 +1,20 @@
+/* eslint-disable turbo/no-undeclared-env-vars */
+
+import { SaleorCloudAPL } from "@saleor/app-sdk/APL";
+
+export const verifyRequiredEnvs = () => {
+  const requiredEnvs = ["SALEOR_CLOUD_TOKEN", "SALEOR_CLOUD_RESOURCE_URL"];
+
+  if (!requiredEnvs.every((env) => process.env[env])) {
+    throw new Error(`Missing envs: ${requiredEnvs.join(" | ")}`);
+  }
+};
+
+export const fetchCloudAplEnvs = () => {
+  const saleorAPL = new SaleorCloudAPL({
+    token: process.env.SALEOR_CLOUD_TOKEN!,
+    resourceUrl: process.env.SALEOR_CLOUD_RESOURCE_URL!,
+  });
+
+  return saleorAPL.getAll();
+};

apps/products-feed/scripts/migrations/run-webhooks-migration-dry-run.ts

@@ -0,0 +1,30 @@
+/* eslint-disable turbo/no-undeclared-env-vars */
+
+import * as dotenv from "dotenv";
+import { fetchCloudAplEnvs, verifyRequiredEnvs } from "./migration-utils";
+import { updateWebhooksScript } from "./update-webhooks";
+
+dotenv.config();
+
+const runMigration = async () => {
+  console.log("Starting webhooks migration (dry run)");
+
+  verifyRequiredEnvs();
+
+  console.log("Envs verified, fetching envs");
+
+  const allEnvs = await fetchCloudAplEnvs().catch((r) => {
+    console.error("Could not fetch instances from the APL");
+    console.error(r);
+
+    process.exit(1);
+  });
+
+  for (const env of allEnvs) {
+    await updateWebhooksScript({ authData: env, dryRun: true });
+  }
+
+  console.log("Migration dry run complete");
+};
+
+runMigration();

apps/products-feed/scripts/migrations/run-webhooks-migration.ts

@@ -0,0 +1,30 @@
+/* eslint-disable turbo/no-undeclared-env-vars */
+
+import * as dotenv from "dotenv";
+import { fetchCloudAplEnvs, verifyRequiredEnvs } from "./migration-utils";
+import { updateWebhooksScript } from "./update-webhooks";
+
+dotenv.config();
+
+const runMigration = async () => {
+  console.log("Starting running migration");
+
+  verifyRequiredEnvs();
+
+  console.log("Envs verified, fetching envs");
+
+  const allEnvs = await fetchCloudAplEnvs().catch((r) => {
+    console.error("Could not fetch instances from the APL");
+    console.error(r);
+
+    process.exit(1);
+  });
+
+  for (const env of allEnvs) {
+    await updateWebhooksScript({ authData: env, dryRun: false });
+  }
+
+  console.log("Migration complete");
+};
+
+runMigration();

apps/products-feed/scripts/migrations/update-webhooks.ts

@@ -0,0 +1,29 @@
+/* eslint-disable turbo/no-undeclared-env-vars */
+
+import { createGraphQLClient } from "@saleor/apps-shared";
+import { AuthData } from "@saleor/app-sdk/APL";
+import { webhookMigrationRunner } from "@saleor/webhook-utils";
+
+export const updateWebhooksScript = async ({
+  authData,
+  dryRun,
+}: {
+  authData: AuthData;
+  dryRun: boolean;
+}) => {
+  console.log("Working on env: ", authData.saleorApiUrl);
+
+  const client = createGraphQLClient({
+    saleorApiUrl: authData.saleorApiUrl,
+    token: authData.token,
+  });
+
+  await webhookMigrationRunner({
+    client,
+    dryRun,
+    getManifests: async ({ appDetails }) => {
+      // Products feed application has currently no webhooks, so we return empty array
+      return [];
+    },
+  });
+};

apps/products-feed/src/modules/app-configuration/app-configuration.router.ts

@@ -2,7 +2,6 @@ import { router } from "../trpc/trpc-server";
 import { protectedClientProcedure } from "../trpc/protected-client-procedure";
 import { createLogger } from "@saleor/apps-shared";
 
-import { updateCacheForConfigurations } from "../metadata-cache/update-cache-for-configurations";
 import { AppConfigSchema, imageSizeInputSchema, titleTemplateInputSchema } from "./app-config";
 import { z } from "zod";
 import { createS3ClientFromConfiguration } from "../file-storage/s3/create-s3-client-from-configuration";
@@ -106,17 +105,6 @@ export const appConfigurationRouter = router({
       }) => {
         const config = await getConfig();
 
-        /**
-         * TODO Check if this has to run, once its cached, it should be invalidated by webhooks only.
-         *
-         * But this operation isn't expensive and users will not continuously save this form
-         */
-        await updateCacheForConfigurations({
-          client: apiClient,
-          channelsSlugs: [input.channelSlug],
-          saleorApiUrl: saleorApiUrl,
-        });
-
         logger.debug({ channel: input.channelSlug }, "Updated cache for channel");
 
         config.setChannelUrls(input.channelSlug, input.urls);