ssube/cautious-journey

import { createSchema } from '@apextoaster/js-yaml-schema';
import Ajv from 'ajv';
import { promises } from 'fs';
import { load } from 'js-yaml';
import { LogLevel } from 'noicejs';
import { join } from 'path';
import { URL } from 'url';

import { FlagLabel, StateLabel } from '../labels.js';
import { RemoteOptions } from '../remote/index.js';

let { readFile } = promises;

export const FILE_ENCODING = 'utf-8';

export type Filesystem = Pick<typeof promises, 'readFile'>;

/**
 * Hook for tests to override the fs fns.
 */
export function setFs(fs: Filesystem) {
  const originalRead = readFile;

  readFile = fs.readFile;

  return () => {
    readFile = originalRead;
  };
}

export interface LoggerConfig {
  level: LogLevel;
  name: string;
}

export interface ProjectConfig {
  /**
   * Color palette for labels without their own.
   */
  colors: Array<string>;

  /**
   * Leave a comment along with any update, explaining the changes that were made.
   *
   * Defaults to true.
   */
  comment: boolean;

  /**
   * Individual flag labels.
   */
  flags: Array<FlagLabel>;

  initial: Array<string>;

  /**
   * Project name or path.
   */
  name: string;

  /**
   * Remote APIs.
   */
  remote: Omit<RemoteOptions, 'container'>;

  /**
   * Grouped state labels.
   */
  states: Array<StateLabel>;
}

/**
 * Config data for the app, loaded from CLI or DOM.
 */
export interface ConfigData {
  logger: LoggerConfig;
  projects: Array<ProjectConfig>;
}

export const CONFIG_SCHEMA_KEY = 'cautious-journey#/definitions/config';

export function configSchemaPath(): URL {
  // TODO: do something for bundled version, where import.meta.url is empty
  return new URL(join('.', 'schema.yml'), import.meta.url);
}

/**
 * Load the config from files.
 */
export async function initConfig(path: string): Promise<ConfigData> {
  const schemaPath = configSchemaPath();
  const configSchema = await readFile(schemaPath, { encoding: 'utf8' });

  const yamlSchema = createSchema({});
  const schema = load(configSchema, {
    schema: yamlSchema,
  }) as object;

  const validator = new Ajv(AJV_OPTIONS);
  validator.addSchema(schema, 'cautious-journey');

  const data = await readFile(path, {
    encoding: 'utf8',
  });

  const config = load(data, {
    schema: yamlSchema,
  });

  if (validator.validate(CONFIG_SCHEMA_KEY, config) === true) {
    return config as ConfigData;
  } else {
    throw new Error('invalid config data');
  }
}

export const AJV_OPTIONS: Ajv.Options = {
  allErrors: true,
  coerceTypes: 'array',
  missingRefs: 'fail',
  removeAdditional: 'failing',
  schemaId: 'auto',
  useDefaults: true,
  verbose: true,
};