start-sdk/lib/compat/properties.ts

import * as YAML from "yaml";
import { exists } from "../util";
import {
  Effects,
  ExpectedExports,
  LegacyExpectedExports,
  Properties,
  ResultType,
} from "../types";

// deno-lint-ignore no-explicit-any
const asResult = (result: any) => ({ result: result as Properties });
export const noPropertiesFound: ResultType<Properties> = {
  result: {
    version: 2,
    data: {
      "Not Ready": {
        type: "string",
        value: "Could not find properties. The service might still be starting",
        qr: false,
        copyable: false,
        masked: false,
        description: "Fallback Message When Properties could not be found",
      },
    },
  },
} as const;
/**
 * Default will pull from a file (start9/stats.yaml) expected to be made on the main volume
 * Assumption: start9/stats.yaml is created by some process
 * Throws: stats.yaml isn't yaml
 * @param effects
 * @returns
 */
export const properties: LegacyExpectedExports.properties = async (
  effects: Effects
) => {
  if (
    (await exists(effects, { path: "start9/stats.yaml", volumeId: "main" })) ===
    false
  ) {
    return noPropertiesFound;
  }
  return await effects
    .readFile({
      path: "start9/stats.yaml",
      volumeId: "main",
    })
    .then(YAML.parse)
    .then(asResult);
};
/**
 * Default will pull from a file (start9/stats.yaml) expected to be made on the main volume
 * Assumption: start9/stats.yaml is created by some process
 * Throws: stats.yaml isn't yaml
 * @param effects
 * @returns
 */
export const propertiesv2: ExpectedExports.properties = async ({ effects }) => {
  if (
    (await exists(effects, { path: "start9/stats.yaml", volumeId: "main" })) ===
    false
  ) {
    return noPropertiesFound;
  }
  return await effects
    .readFile({
      path: "start9/stats.yaml",
      volumeId: "main",
    })
    .then(YAML.parse)
    .then(asResult);
};