saleor-app-sdk-REDIS_APL/src/APL/vercelAPL.ts

/* eslint-disable class-methods-use-this */
import debugPkg from "debug";
import fetch from "node-fetch";

import { APL, AuthData } from "./apl";

const debug = debugPkg.debug("app-sdk:VercelAPL");

export const TOKEN_VARIABLE_NAME = "SALEOR_AUTH_TOKEN";
export const DOMAIN_VARIABLE_NAME = "SALEOR_DOMAIN";
export const SALEOR_REGISTER_APP_URL = "SALEOR_REGISTER_APP_URL";
export const SALEOR_DEPLOYMENT_TOKEN = "SALEOR_DEPLOYMENT_TOKEN";

const envAuthData = (): AuthData | undefined => {
  const token = process.env[TOKEN_VARIABLE_NAME];
  const domain = process.env[DOMAIN_VARIABLE_NAME];
  if (!token || !domain) {
    return undefined;
  }
  return {
    token,
    domain,
  };
};

const saveDataToVercel = async (
  registerAppURL: string,
  deploymentToken: string,
  authData?: AuthData
) => {
  debug("Saving data to Vercel");

  try {
    await fetch(registerAppURL, {
      method: "POST",
      headers: { "Content-Type": "application/json" },
      body: JSON.stringify({
        token: deploymentToken,
        envs: {
          [TOKEN_VARIABLE_NAME]: authData?.token || "",
          [DOMAIN_VARIABLE_NAME]: authData?.domain || "",
        },
      }),
    });
  } catch (error) {
    debug("Error during saving the data:", error);
  }
};

export type VercelAPLConfig = {
  registerAppURL?: string;
  deploymentToken?: string;
};
/** Vercel APL
 *
 * Use environment variables for auth data storage. To update data on existing deployment,
 * theres Saleor microservice which update new values with the Vercel API and restarts the instance.
 *
 * This APL should be used for single tenant purposes due to it's limitations:
 *   - only stores single auth data entry (setting up a new one will overwrite previous values)
 *   - changing the environment variables require server restart
 *
 * With this APL we recommend using the [Saleor CLI](https://docs.saleor.io/docs/3.x/cli),
 * which automatically set up the required environment variables during deployment:
 *   - SALEOR_REGISTER_APP_URL: the URL for microservice which set up variables using Vercel API
 *   - SALEOR_DEPLOYMENT_TOKEN: token for your particular Vercel deployment
 */
export class VercelAPL implements APL {
  private registerAppURL: string;

  private deploymentToken: string;

  constructor(config?: VercelAPLConfig) {
    const registerAppURL = config?.registerAppURL || process.env.SALEOR_REGISTER_APP_URL;
    if (!registerAppURL) {
      debug("Missing registerAppURL");
      throw new Error("Misconfiguration: please provide registerAppUrl");
    }
    const deploymentToken = config?.deploymentToken || process.env.SALEOR_DEPLOYMENT_TOKEN;
    if (!deploymentToken) {
      debug("Missing deploymentToken");
      throw new Error("Misconfiguration: please provide deploymentToken");
    }

    this.registerAppURL = registerAppURL;
    this.deploymentToken = deploymentToken;
  }

  async get(domain: string) {
    const authData = envAuthData();

    if (authData && domain === authData?.domain) {
      return authData;
    }
    return undefined;
  }

  async set(authData: AuthData) {
    await saveDataToVercel(this.registerAppURL, this.deploymentToken, authData);
  }

  async delete(domain: string) {
    if (domain === envAuthData()?.domain) {
      // Override existing data with the empty values
      await saveDataToVercel(this.registerAppURL, this.deploymentToken);
    }
  }

  async getAll() {
    const authData = envAuthData();
    if (!authData) {
      return [];
    }
    return [authData];
  }
}