saleor-apps-redis_apl/apps/invoices/src/pages/api/register.ts

import { createAppRegisterHandler } from "@saleor/app-sdk/handlers/next";
import { saleorApp } from "../../../saleor-app";
import { gql } from "urql";
import { createClient } from "../../lib/graphql";
import { SaleorVersionQuery } from "../../../generated/graphql";
import invariant from "tiny-invariant";
import { createLogger } from "../../lib/logger";

const semver = require("semver");

const allowedUrlsPattern = process.env.ALLOWED_DOMAIN_PATTERN;

const SaleorVersion = gql`
  query SaleorVersion {
    shop {
      version
    }
  }
`;

/**
 * TODO: Move to Manifest, when implemented
 * @see https://github.com/saleor/saleor-app-sdk/pull/186
 */
const APP_SEMVER_REQUIREMENTS = ">=3.10";

/**
 * Required endpoint, called by Saleor to install app.
 * It will exchange tokens with app, so saleorApp.apl will contain token
 */
export default createAppRegisterHandler({
  apl: saleorApp.apl,
  /**
   * Prohibit installation from Saleors other than specified by the regex.
   * Regex source is ENV so if ENV is not set, all installations will be allowed.
   */
  allowedSaleorUrls: [
    (url) => {
      if (allowedUrlsPattern) {
        const regex = new RegExp(allowedUrlsPattern);

        return regex.test(url);
      }

      return true;
    },
  ],
  /**
   * Check Saleor version and reject installation if it doesn't match
   *
   * TODO: Consider moving to app-sdk and do it under the hood
   *
   * Also, consume version, if possible, from the request directly
   * @see https://github.com/saleor/saleor/issues/12144
   */
  async onRequestVerified(req, { authData: { token, saleorApiUrl }, respondWithError }) {
    const logger = createLogger({
      context: "onRequestVerified",
    });

    try {
      const client = createClient(saleorApiUrl, async () => {
        return {
          token,
        };
      });

      const saleorVersion = await client
        .query<SaleorVersionQuery>(SaleorVersion, {})
        .toPromise()
        .then((res) => {
          return res.data?.shop.version;
        });

      logger.debug({ saleorVersion }, "Received saleor version from Shop query");

      if (!saleorVersion) {
        throw new Error("Saleor Version couldnt be fetched from the API");
      }

      const versionIsValid = semver.satisfies(
        semver.coerce(saleorVersion),
        APP_SEMVER_REQUIREMENTS
      );

      logger.debug(
        { saleorVersion, APP_SEMVER_REQUIREMENTS, coerced: semver.coerce(saleorVersion) },
        "Semver validation failed"
      );

      if (!versionIsValid) {
        throw new Error(`App requires Saleor matching semver: ${APP_SEMVER_REQUIREMENTS}`);
      }
    } catch (e: unknown) {
      const message = (e as Error)?.message ?? "Unknown error";

      logger.debug({ message }, "Failed validating semver, will respond with error and status 400");

      throw respondWithError({
        message: message,
        body: {
          success: false,
          error: {
            code: "INVALID_SALEOR_VERSION",
            message: message,
          },
        },
        status: 400,
      });
    }
  },
});