@certik/skynet 0.24.0 → 0.25.0

package/dist/deploy.d.ts

@@ -1,75 +0,0 @@
-import { getJobName } from "./selector";
-import type { Selector } from "./selector";
-export type Env = {
-    [key: string]: string | null;
-};
-type Service = {
-    prefix: string;
-    port: number;
-};
-type Schedule = string | ((jobName: string) => string);
-type Check = {
-    func: ({ protocol, state, verbose }: {
-        protocol: string;
-        state: string;
-        verbose: boolean;
-    }) => {
-        type: string;
-        message: string;
-    };
-    schedule: Schedule;
-    slackChannel: string;
-    killTimeout?: string;
-    cpu: number;
-    mem: number;
-};
-type Restart = {
-    attempts: number;
-    mode: string;
-    interval: string;
-    delay: string;
-};
-declare function getNomadAddr(isProduction: boolean): string;
-declare function createModeDeploy({ binaryName, name, workingDirectory, bin, selector, env, region, deltaSchedule, validateSchedule, deltaKillTimeout, deltaCpu, deltaMem, rebuildKillTimeout, rebuildCpu, rebuildMem, validateKillTimeout, validateCpu, validateMem, }: {
-    binaryName: string;
-    name: string;
-    workingDirectory: string;
-    bin?: string;
-    selector?: Selector;
-    env?: Env;
-    region?: string;
-    check?: Check;
-    deltaSchedule?: Schedule;
-    validateSchedule?: Schedule;
-    deltaKillTimeout?: string;
-    deltaCpu: number;
-    deltaMem: number;
-    rebuildKillTimeout?: string;
-    rebuildCpu?: number;
-    rebuildMem?: number;
-    validateKillTimeout?: string;
-    validateCpu?: number;
-    validateMem?: number;
-}): {
-    deploy: () => Promise<void>;
-};
-declare function createDeploy({ binaryName, name, workingDirectory, bin, selector, region, type, env, count, schedule, restart, killTimeout, cpu, mem, service, }: {
-    binaryName: string;
-    name: string;
-    workingDirectory: string;
-    bin?: string;
-    selector?: Selector;
-    env?: Env;
-    region?: string;
-    type?: string;
-    count?: number;
-    schedule?: Schedule;
-    restart?: Restart;
-    killTimeout?: string;
-    cpu: number;
-    mem: number;
-    service?: Service;
-}): {
-    deploy: () => Promise<void>;
-};
-export { getJobName, getNomadAddr, createModeDeploy, createDeploy };

package/dist/deploy.js

@@ -1,587 +0,0 @@
-// src/selector.ts
-function getSelectorDesc(selector) {
-  return Object.keys(selector).map((name) => {
-    return `          --${name.padEnd(14)}${selector[name].desc || selector[name].description || ""}`;
-  }).join(`
-`);
-}
-function getSelectorFlags(selector) {
-  return Object.keys(selector).reduce((acc, name) => {
-    const flag = {
-      type: selector[name].type || "string",
-      ...selector[name]
-    };
-    if (!selector[name].optional && selector[name].isRequired !== false) {
-      flag.isRequired = true;
-    }
-    return { ...acc, [name]: flag };
-  }, {});
-}
-function toSelectorString(selectorFlags, delim = ",") {
-  return Object.keys(selectorFlags).sort().map((flag) => {
-    return `${flag}=${selectorFlags[flag]}`;
-  }).join(delim);
-}
-function normalizeSelectorValue(v) {
-  return v.replace(/[^A-Za-z0-9]+/g, "-");
-}
-function getJobName(name, selectorFlags, mode) {
-  const selectorNamePart = Object.keys(selectorFlags).sort().map((name2) => selectorFlags[name2]).join("-");
-  let jobName = name;
-  if (mode) {
-    jobName += `-${mode}`;
-  }
-  if (selectorNamePart.length > 0) {
-    jobName += `-${normalizeSelectorValue(selectorNamePart)}`;
-  }
-  return jobName;
-}
-// src/env.ts
-function ensureAndGet(envName, defaultValue) {
-  return process.env[envName] || defaultValue;
-}
-function getEnvironment() {
-  return ensureAndGet("SKYNET_ENVIRONMENT", "dev");
-}
-function getEnvOrThrow(envName) {
-  if (!process.env[envName]) {
-    throw new Error(`Must set environment variable ${envName}`);
-  }
-  return process.env[envName];
-}
-function isProduction() {
-  return getEnvironment() === "prd";
-}
-function isDev() {
-  return getEnvironment() === "dev";
-}
-// src/cli.ts
-import path from "path";
-import fs from "fs";
-function getBinaryName() {
-  const binaryNameParts = process.argv[1].split(path.sep);
-  const binaryName = binaryNameParts[binaryNameParts.length - 1];
-  return binaryName;
-}
-function detectSkynetDirectory() {
-  return detectDirectory(process.argv[1], "SkynetAPIDefinitions.yml");
-}
-function detectWorkingDirectory() {
-  const wd = detectDirectory(process.argv[1], "package.json");
-  const skynetd = detectDirectory(process.argv[1], "SkynetAPIDefinitions.yml");
-  return wd.slice(skynetd.length + path.sep.length).replace(path.sep, "/");
-}
-function detectDirectory(fullBinPath, sentinel = "package.json") {
-  let parentFolder = path.dirname(fullBinPath);
-  while (parentFolder) {
-    const sentinelPath = path.join(parentFolder, sentinel);
-    if (fs.existsSync(sentinelPath)) {
-      return parentFolder;
-    }
-    const newParentFolder = path.dirname(parentFolder);
-    if (newParentFolder === parentFolder) {
-      break;
-    }
-    parentFolder = newParentFolder;
-  }
-  throw new Error("Cannot detect current working directory");
-}
-function detectBin() {
-  const wd = detectDirectory(process.argv[1], "package.json");
-  return process.argv[1].slice(wd.length + path.sep.length).replace(path.sep, "/");
-}
-// src/deploy.ts
-import fs2 from "fs/promises";
-import fso from "fs";
-import { execa } from "execa";
-import meow from "meow";
-import chalk from "chalk";
-import which from "which";
-var INTERVAL_ALIASES = {
-  secondly: "*/1 * * * * * *",
-  "@secondly": "*/1 * * * * * *",
-  minutely: "0 * * * * * *",
-  "@minutely": "0 * * * * * *",
-  hourly: "0 0 * * * * *",
-  "@hourly": "0 0 * * * * *",
-  daily: "0 0 0 * * * *",
-  "@daily": "0 0 0 * * * *",
-  weekly: "0 0 0 * * 0 *",
-  "@weekly": "0 0 0 * * 0 *"
-};
-var genConfig = ({
-  jobName,
-  workingDirectory,
-  cmd,
-  cron,
-  count,
-  restart,
-  killTimeout,
-  cpu,
-  mem,
-  service,
-  additionalEnv = {},
-  type = "batch",
-  region = "skynet-dc1",
-  isProduction: isProduction2
-}) => `job "${jobName}" {
-  datacenters = ["${region}"]
-
-  type = "${type}"
-
-  ${cron ? `# Triggers periodically
-  periodic {
-    crons            = ["${cron}"]
-    prohibit_overlap = true
-  }` : ""}
-
-  constraint {
-    attribute = "\${meta.has_nodejs}"
-    value     = "true"
-  }
-
-  constraint {
-    attribute = "\${meta.has_skynet}"
-    value     = "true"
-  }
-
-  group "default" {
-    ${count && count > 1 ? `count = ${count}` : ""}
-    ${count && count > 1 ? `# Rolling Update
-    update {
-      max_parallel = 1
-      min_healthy_time = "10s"
-    }` : ""}
-
-    reschedule {
-      attempts  = 0
-      unlimited = false
-    }
-
-    ${service ? `# Setup Service Network
-    network {
-      port "http" {
-        static = ${service.port}
-      }
-    }` : ""}
-
-    task "main" {
-      driver = "raw_exec"
-
-      config {
-        command = "sh"
-        args = [
-          "-c",
-          "cd \${meta.skynet_code_path}/${workingDirectory} && if [ -e bun.lockb ]; then bun install --silent; else yarn install --silent; fi && exec ${cmd}"
-        ]
-      }
-
-      ${service ? `# Setup API Routes
-      service {
-        name = "${jobName}"
-        port = "http"
-
-        tags = [
-          "urlprefix-${service.prefix} strip=${service.prefix}",
-        ]
-
-        check {
-          type     = "http"
-          path     = "/"
-          interval = "10s"
-          timeout  = "2s"
-        }
-      }
-` : ""}
-
-      # doppler integration support
-      # it is always there but a project can decide to not use it
-      template {
-        change_mode = "restart"
-        destination = "secrets/context.env"
-        env         = true
-        data        = "DOPPLER_TOKEN={{key \\"infra-nomad/doppler-token\\"}}"
-      }
-
-      # always update SKYNET_DEPLOYED_AT so that new deployment always triggers
-      env {
-        SKYNET_DEPLOYED_AT="${new Date().toISOString()}"
-        HOME="/root"
-        DOPPLER_PROJECT="${workingDirectory}"
-        DOPPLER_CONFIG="${isProduction2 ? "prd" : "dev"}"
-        SKYNET_ENVIRONMENT="${isProduction2 ? "prd" : "dev"}"
-        ${Object.entries(additionalEnv).filter((kv) => !!kv[1]).map(([key, value]) => `${key}="${value}"`).join(`          
-`)}
-      }
-
-      kill_timeout = "${killTimeout || "60s"}"
-
-      # Specify the maximum resources required to run the task,
-      # include CPU and memory.
-      resources {
-        cpu    = ${cpu} # MHz
-        memory = ${mem} # MB
-      }
-
-      # Setting the server task as the leader of the task group allows Nomad to
-      # signal the log shipper task to gracefully shutdown when the server exits.
-      leader = true
-
-      ${restart ? `
-      # Restart the job if it fails
-      restart {
-        attempts = ${restart.attempts ?? 2}
-        mode     = "${restart.mode ?? "fail"}"
-        interval = "${restart.interval ?? "30m"}"
-        delay    = "${restart.delay ?? "15s"}"
-      }
-      ` : `
-      # do not retry from the periodical job will reschedule anyway
-      restart {
-        attempts = 0
-        mode     = "fail"
-      }`}
-    }
-  }
-}`;
-async function prepareNomad(isProduction2) {
-  if (isProduction2) {
-    console.log("Deploy to Production");
-  } else {
-    const skynetDir = detectSkynetDirectory();
-    if (!fso.existsSync("/tmp/skynet")) {
-      await execa("ln", ["-s", skynetDir, "/tmp/skynet"]);
-    }
-    console.log("Deploy locally, please start nomad server in a separate terminal");
-    console.log(`You can start nomad server by running ${chalk.inverse(`${skynetDir}/infra-nomad/dev/start.sh`)}`);
-    console.log(`Then you can visit ${chalk.underline("http://localhost:4646/ui/jobs")} to check submitted dev jobs.
-`);
-  }
-}
-function getNomadAddr(isProduction2) {
-  return isProduction2 ? getEnvOrThrow("NOMAD_ADDR") : "http://127.0.0.1:4646";
-}
-async function getNomadPath() {
-  try {
-    return await which("nomad");
-  } catch (missingNomad) {
-    console.log(`Deploy requires ${chalk.bold("nomad")} binary, please follow ${chalk.underline("https://learn.hashicorp.com/tutorials/nomad/get-started-install")} for installation`, missingNomad);
-    throw new Error("missing nomad binary");
-  }
-}
-async function runNomadJob(nomadPath, nomadAddr, jobName, nomadJobDefinition, isStop, isDryRun) {
-  try {
-    if (isStop) {
-      const nomad = execa(nomadPath, ["job", "stop", jobName], {
-        env: {
-          NOMAD_ADDR: nomadAddr
-        }
-      });
-      nomad.stdout.pipe(process.stdout);
-      await nomad;
-      console.log(chalk.green(`Stopped nomad job ${jobName} in ${nomadAddr}`));
-    } else if (isDryRun) {
-      console.log("Definition for", jobName);
-      console.log("========================================");
-      console.log(nomadJobDefinition);
-    } else {
-      const jobFileName = `/tmp/job-${jobName}`;
-      await fs2.writeFile(jobFileName, nomadJobDefinition);
-      const nomad = execa(nomadPath, ["job", "run", jobFileName], {
-        env: {
-          NOMAD_ADDR: nomadAddr
-        }
-      });
-      nomad.stdout.pipe(process.stdout);
-      await nomad;
-      console.log(chalk.green(`Deployed nomad job ${jobName} to ${nomadAddr}`));
-    }
-  } catch (nomadExecErr) {
-    if (nomadExecErr instanceof Error) {
-      console.log("Nomad Execution Error:");
-      console.log(nomadExecErr.message);
-      console.log("");
-    }
-    console.log(`Failed to run ${chalk.bold("nomad")} commands, please ensure nomad server is accessible at ${chalk.bold(nomadAddr)}`);
-    throw new Error("nomad execution error");
-  }
-}
-function createModeDeploy({
-  binaryName,
-  name,
-  workingDirectory,
-  bin = "bin/indexer",
-  selector = {},
-  env = {},
-  region = "skynet-dc1",
-  deltaSchedule,
-  validateSchedule,
-  deltaKillTimeout,
-  deltaCpu,
-  deltaMem,
-  rebuildKillTimeout,
-  rebuildCpu,
-  rebuildMem,
-  validateKillTimeout,
-  validateCpu,
-  validateMem
-}) {
-  async function deployMode({
-    mode,
-    from,
-    to,
-    stop,
-    production,
-    dryRun,
-    verbose,
-    schedule: cmdSchedule,
-    ...selectorFlags
-  }) {
-    if (mode === "delta") {
-      from = 0;
-      to = 0;
-    }
-    const isPeriodic = from === 0 && to === 0 && ["delta", "validate"].includes(mode);
-    const jobName = getJobName(name, selectorFlags, mode);
-    const selectorCmdPart = Object.entries(selectorFlags).sort().map(([name2, value]) => `--${name2} ${value}`).join(" ");
-    let args = `--mode ${mode} ${selectorCmdPart}`;
-    if (verbose) {
-      args += ` --verbose`;
-    }
-    let rangeArgs = "";
-    if (from > 0) {
-      rangeArgs += ` --from ${from}`;
-    }
-    if (to > 0) {
-      rangeArgs += ` --to ${to}`;
-    }
-    const modeResouces = {
-      rebuild: { cpu: rebuildCpu, mem: rebuildMem, killTimeout: rebuildKillTimeout },
-      "resume-rebuild": { cpu: rebuildCpu, mem: rebuildMem, killTimeout: rebuildKillTimeout },
-      validate: {
-        cpu: validateCpu || rebuildCpu,
-        mem: validateMem || rebuildMem,
-        killTimeout: validateKillTimeout || rebuildKillTimeout
-      },
-      delta: { cpu: deltaCpu, mem: deltaMem, killTimeout: deltaKillTimeout }
-    };
-    const cpu = modeResouces[mode]?.cpu || deltaCpu;
-    const mem = modeResouces[mode]?.mem || deltaMem;
-    const killTimeout = modeResouces[mode]?.killTimeout || deltaKillTimeout;
-    let deltaCron = typeof deltaSchedule === "function" ? deltaSchedule(jobName) : deltaSchedule;
-    if (deltaSchedule && cmdSchedule) {
-      deltaCron = cmdSchedule;
-    }
-    let validateCron = typeof validateSchedule === "function" ? validateSchedule(jobName) : validateSchedule;
-    if (validateSchedule && cmdSchedule) {
-      validateCron = cmdSchedule;
-    }
-    const modeIntervals = {
-      delta: deltaCron ? INTERVAL_ALIASES[deltaCron] || deltaCron : undefined,
-      validate: validateCron ? INTERVAL_ALIASES[validateCron] || validateCron : undefined
-    };
-    const mainJobDefinition = genConfig({
-      jobName,
-      cron: isPeriodic ? modeIntervals[mode] : undefined,
-      workingDirectory,
-      additionalEnv: env,
-      region,
-      cmd: `${bin} ${args} ${rangeArgs}`,
-      killTimeout,
-      cpu,
-      mem,
-      isProduction: production
-    });
-    const nomadPath = await getNomadPath();
-    await prepareNomad(production);
-    const nomadAddr = getNomadAddr(production);
-    await runNomadJob(nomadPath, nomadAddr, jobName, mainJobDefinition, stop, dryRun);
-  }
-  async function deploy() {
-    if (!binaryName) {
-      binaryName = getBinaryName();
-    }
-    const cli = meow(`
-        Usage
-
-          $ ${binaryName} <options>
-
-        Options
-${getSelectorDesc(selector)}
-          --mode          could be delta/rebuild/resume-rebuild/validate/one/range/reset
-          --from          min id to build
-          --to            max id to build
-          --stop          stop job instead of running the job
-          --production    deploy to production, default is development
-          --schedule      override default schedule, support aliases: secondly, minutely, hourly, daily, weekly
-          --verbose       Output debug messages
-          --dry-run       print nomad job file but do not really execute it
-
-        Examples
-          ${binaryName} --mode delta
-          ${binaryName} --mode rebuild
-          ${binaryName} --mode validate
-      `, {
-      importMeta: import.meta,
-      description: false,
-      flags: {
-        ...getSelectorFlags(selector),
-        mode: {
-          type: "string",
-          default: "delta"
-        },
-        from: {
-          aliases: ["since"],
-          type: "number",
-          default: 0
-        },
-        to: {
-          aliases: ["until"],
-          type: "number",
-          default: 0
-        },
-        schedule: {
-          type: "string"
-        },
-        verbose: {
-          type: "boolean",
-          default: false
-        },
-        production: {
-          aliases: ["prd"],
-          type: "boolean",
-          default: false
-        },
-        dryRun: {
-          type: "boolean",
-          default: false
-        },
-        stop: {
-          type: "boolean",
-          default: false
-        }
-      }
-    });
-    try {
-      return deployMode(cli.flags);
-    } catch (err) {
-      console.error(err);
-      process.exit(1);
-    }
-  }
-  return { deploy };
-}
-function createDeploy({
-  binaryName,
-  name,
-  workingDirectory,
-  bin = "bin/indexer",
-  selector = {},
-  region = "skynet-dc1",
-  type = "batch",
-  env = {},
-  count,
-  schedule,
-  restart,
-  killTimeout,
-  cpu,
-  mem,
-  service
-}) {
-  async function deployModeless({
-    production,
-    stop,
-    dryRun,
-    verbose,
-    schedule: cmdSchedule,
-    ...selectorFlags
-  }) {
-    const jobName = getJobName(name, selectorFlags);
-    const selectorCmdPart = Object.entries(selectorFlags).sort().map(([name2, value]) => `--${name2} ${value}`).join(" ");
-    let args = `${selectorCmdPart}`;
-    if (verbose) {
-      args += ` --verbose`;
-    }
-    let cron = typeof schedule === "function" ? schedule(jobName) : schedule;
-    if (schedule && cmdSchedule) {
-      cron = cmdSchedule;
-    }
-    const nomadJobDefinition = genConfig({
-      jobName,
-      cron: cron ? INTERVAL_ALIASES[cron] || cron : undefined,
-      count,
-      restart,
-      workingDirectory,
-      additionalEnv: env,
-      region,
-      type,
-      cmd: `${bin} ${args}`,
-      killTimeout,
-      cpu,
-      mem,
-      service,
-      isProduction: production
-    });
-    const nomadPath = await getNomadPath();
-    await prepareNomad(production);
-    const nomadAddr = getNomadAddr(production);
-    await runNomadJob(nomadPath, nomadAddr, jobName, nomadJobDefinition, stop, dryRun);
-  }
-  async function deploy() {
-    if (!binaryName) {
-      binaryName = getBinaryName();
-    }
-    const cli = meow(`
-        Usage
-
-          $ ${binaryName} <options>
-
-        Options
-${getSelectorDesc(selector)}
-          --stop          stop job instead of running the job
-          --production    deploy to production, default is development
-          --schedule      override default schedule, support aliases: secondly, minutely, hourly, daily, weekly
-          --verbose       Output debug messages
-          --dry-run       print nomad job file but do not really execute it
-      `, {
-      importMeta: import.meta,
-      description: false,
-      flags: {
-        ...getSelectorFlags(selector),
-        schedule: {
-          type: "string"
-        },
-        verbose: {
-          type: "boolean",
-          default: false
-        },
-        production: {
-          aliases: ["prd"],
-          type: "boolean",
-          default: false
-        },
-        dryRun: {
-          type: "boolean",
-          default: false
-        },
-        stop: {
-          type: "boolean",
-          default: false
-        }
-      }
-    });
-    try {
-      return deployModeless(cli.flags);
-    } catch (err) {
-      console.error(err);
-      process.exit(1);
-    }
-  }
-  return { deploy };
-}
-export {
-  getNomadAddr,
-  getJobName,
-  createModeDeploy,
-  createDeploy
-};

package/dist/dynamodb.d.ts

@@ -1,16 +0,0 @@
-import { DynamoDBDocumentClient, ScanCommand, BatchWriteCommand, GetCommand, PutCommand, QueryCommand, UpdateCommand } from "@aws-sdk/lib-dynamodb";
-import type { ScanCommandInput, PutCommandInput } from "@aws-sdk/lib-dynamodb";
-declare function getDocClient(forceNew?: boolean): DynamoDBDocumentClient;
-declare function scanWholeTable<T>(options: ScanCommandInput): Promise<{
-    Items: T[];
-    Count: number;
-    ScannedCount: number;
-}>;
-declare function batchCreateRecords(tableName: string, records: Record<string, unknown>[], maxWritingCapacity?: number, verbose?: boolean): Promise<void>;
-declare function createRecord(tableName: string, fields: PutCommandInput["Item"], verbose?: boolean): Promise<import("@aws-sdk/lib-dynamodb").PutCommandOutput>;
-declare function getRecordsByKey<TReturn, TKey extends Record<string, unknown> = Record<string, unknown>>(tableName: string, keys: TKey, indexName?: string): Promise<TReturn[] | null>;
-declare function getRecordByKey<T>(tableName: string, keys: Record<string, unknown>, indexName?: string): Promise<T | null>;
-declare function updateRecordByKey(tableName: string, idKey: Record<string, unknown>, fields: Record<string, unknown>, conditionExpressions?: null, verbose?: boolean): Promise<Record<string, any> | undefined>;
-declare function batchDeleteRecords(tableName: string, keys: Record<string, unknown>[]): Promise<void>;
-declare function deleteRecordsByHashKey(tableName: string, indexName: string | undefined, hashKeyValue: string, verbose?: boolean): Promise<number>;
-export { getDocClient, ScanCommand, BatchWriteCommand, GetCommand, PutCommand, QueryCommand, UpdateCommand, scanWholeTable, batchCreateRecords, createRecord, getRecordsByKey, getRecordByKey, updateRecordByKey, batchDeleteRecords, deleteRecordsByHashKey, };