iframe-proxy | Sunbelt Computer Software

203 lines (174 loc) · 5.14 KB
import { packageConfig } from "package-config";
import type { Logger } from "pino";
import type {
  ApplicationFunction,
  ServerOptions,
  StripUndefined,
} from "./types.js";
import type { ProbotOctokit } from "./octokit/probot-octokit.js";
import { setupAppFactory } from "./apps/setup.js";
import { getLog } from "./helpers/get-log.js";
import { readCliOptions } from "./bin/read-cli-options.js";
import { readEnvOptions } from "./bin/read-env-options.js";
import { defaultApp as defaultAppHandler } from "./apps/default.js";
import { defaultWebhookPath, Server } from "./server/server.js";
import { resolveAppFunction } from "./helpers/resolve-app-function.js";
import { isProduction } from "./helpers/is-production.js";
import { updateEnv } from "./helpers/update-env.js";
import { Probot } from "./probot.js";
import { applyEnv } from "./helpers/apply-env.js";
type AdditionalOptions = {
  env?: Env;
  Octokit?: typeof ProbotOctokit;
  log?: Logger;
  updateEnv?: typeof updateEnv;
  SmeeClient?: { createChannel: () => Promise<string | undefined> };
 * @param appFnOrArgv set to either a probot application function: `(app) => { ... }` or to process.argv
export async function run(
  appFnOrArgv: ApplicationFunction | string[],
  additionalOptions?: AdditionalOptions,
): Promise<Server> {
  applyEnv();
  const envOptions = readEnvOptions(additionalOptions?.env);
  const cliOptions = Array.isArray(appFnOrArgv)
    ? readCliOptions(appFnOrArgv)
    // log options
    logLevel: level,
    logFormat,
    logLevelInString,
    logMessageKey,
    sentryDsn,
    // server options
    host = "localhost",
    port = 3000,
    webhookPath = defaultWebhookPath,
    webhookProxy,
    // probot options
    privateKey,
    redisConfig,
    secret,
    baseUrl,
    // others
  } = { ...envOptions, ...cliOptions };
  const log =
    additionalOptions?.log ||
    (await getLog({
      level,
      logFormat,
      logLevelInString,
      logMessageKey,
      sentryDsn,
  const probotOptions: Options = {
    privateKey,
    redisConfig,
    secret,
    baseUrl,
    Octokit: additionalOptions?.Octokit || undefined,
  type ServerOptionsLocal = StripUndefined<
    Required<
      NonNullable<
        Pick<ServerOptions, "host" | "port" | "webhookPath" | "log" | "Probot">
    Pick<ServerOptions, "webhookProxy">;
  const serverOptions: ServerOptionsLocal = {
    webhookPath,
    webhookProxy,
    Probot: Probot.defaults(probotOptions),
  let server: Server;
  if (!appId || !privateKey) {
    if (isProduction()) {
      if (!appId) {
        throw new Error(
          "App ID is missing, and is required to run in production mode. " +
            "To resolve, ensure the APP_ID environment variable is set.",
      } else if (!privateKey) {
        throw new Error(
          "Certificate is missing, and is required to run in production mode. " +
            "To resolve, ensure either the PRIVATE_KEY or PRIVATE_KEY_PATH environment variable is set and contains a valid certificate",
    // Workaround for setup (#1512)
    // When probot is started for the first time, it gets into a setup mode
    // where `appId` and `privateKey` are not present. The setup mode gets
    // these credentials. In order to not throw an error, we set the values
    // to anything, as the Probot instance is not used in setup it makes no
    // difference anyway.
    server = new Server({
      ...serverOptions,
      Probot: Probot.defaults({
        ...probotOptions,
        appId: 1,
        privateKey: "dummy value for setup, see #1512",
    const setupAppHandler = setupAppFactory({
      host: server.host,
      port: server.port,
      log: serverOptions.log.child({ name: "setup" }),
      updateEnv: additionalOptions?.updateEnv || updateEnv,
      SmeeClient: additionalOptions?.SmeeClient,
    await server.loadHandlerFactory(setupAppHandler);
    await server.start();
    return server;
  if (Array.isArray(appFnOrArgv)) {
    const [appPath] = args;
    if (!appPath) {
      console.error(
        "No app path provided. Please provide the path to the app you want to run.",
      process.exit(1);
    const pkg = await packageConfig("probot");
    server = new Server(serverOptions);
    await server.loadHandlerFactory(defaultAppHandler);
    if (Array.isArray(pkg.apps)) {
      for (const appPath of pkg.apps) {
        const appFn = await resolveAppFunction(appPath);
        await server.load(appFn);
    const appFn = await resolveAppFunction(appPath);
    await server.load(appFn);
    await server.start();
    return server;
  server = new Server(serverOptions);
  await server.load(appFnOrArgv);
  await server.start();
  process.on("SIGINT", async () => {
    console.info("Stopping server...");
      await server.stop();
      console.info("Server stopped");
      process.exit(0);
    } catch (e) {
      console.error({ err: e as Error }, "Error while stopping server");
      process.exit(1);
  return server;
Sunbelt Computer Software

PL/B Language Development and Support

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Sunbelt Computer Software

PL/B Language Development and Support

Uh oh!

FilesExpand file tree

run.ts

Latest commit

History

run.ts

File metadata and controls
