@platforma-sdk/bootstrap 2.0.0 → 2.0.1

package/src/templates/pl-config.ts

@@ -1,280 +0,0 @@
-import fs from 'fs';
-import * as types from './types';
-import { assertNever, resolveTilde } from '../util';
-import state from '../state';
-
-export type { plOptions } from './types';
-
-export function storageSettingsFromURL(
-  storageURL: string,
-  baseDir?: string,
-  defaults?: types.storageOptions
-): types.storageOptions {
-  storageURL = resolveTilde(storageURL);
-  const url = new URL(storageURL, `file:${baseDir}`);
-
-  switch (url.protocol) {
-    case 's3:':
-      var bucketName = url.hostname;
-      var region = url.searchParams.get('region');
-
-      return {
-        ...defaults,
-
-        type: 'S3',
-        bucketName,
-        region
-      } as types.storageOptions;
-
-    case 's3e:':
-      var p = url.pathname.split('/').slice(1); // '/bucket/keyPrefix' -> ['', 'bucket', 'keyPrefix'] -> ['bucket', 'keyPrefix']
-      var bucketName = p[0];
-      var keyPrefix = p.length > 1 ? p[1] : '';
-
-      return {
-        ...defaults,
-
-        type: 'S3',
-        endpoint: `http://${url.host}/`,
-        bucketName,
-        keyPrefix,
-        region: url.searchParams.get('region'),
-        key: url.username ? `static:${url.username}` : '',
-        secret: url.password ? `static:${url.password}` : ''
-      } as types.storageOptions;
-
-    case 's3es:':
-      var p = url.pathname.split('/').slice(1); // '/bucket/keyPrefix' -> ['', 'bucket', 'keyPrefix'] -> ['bucket', 'keyPrefix']
-      var bucketName = p[0];
-      var keyPrefix = p.length > 1 ? p[1] : '';
-
-      return {
-        ...defaults,
-
-        type: 'S3',
-        endpoint: `https://${url.host}/`,
-        bucketName,
-        keyPrefix,
-        region: url.searchParams.get('region'),
-        key: url.username ? `static:${url.username}` : '',
-        secret: url.password ? `static:${url.password}` : ''
-      } as types.storageOptions;
-
-    case 'file:':
-      return {
-        type: 'FS',
-        rootPath: url.pathname
-      };
-
-    default:
-      throw new Error(`storage protocol '${url.protocol}' is not supported`);
-  }
-}
-
-export function loadDefaults(jwtKey: string, options?: types.plOptions): types.plSettings {
-  const localRoot = options?.localRoot ?? state.path('data', 'local-custom');
-
-  const log: types.logSettings = {
-    level: options?.log?.level ?? 'info',
-    path: options?.log?.path ?? `${localRoot}/platforma.log`
-  };
-
-  const grpc: types.grpcSettings = {
-    listen: options?.grpc?.listen ?? 'localhost:6345',
-    tls: {
-      enable: defaultBool(options?.grpc?.tls?.enable, false),
-      clientAuthMode: options?.grpc?.tls?.clientAuthMode ?? 'NoAuth',
-      certFile: options?.grpc?.tls?.certFile ?? `${localRoot}/certs/tls.cert`,
-      keyFile: options?.grpc?.tls?.keyFile ?? `${localRoot}/certs/tls.key`,
-
-      ...options?.grpc?.tls
-    }
-  };
-
-  const core: types.coreSettings = {
-    auth: {
-      enabled: options?.core?.auth?.enabled ?? false,
-      drivers: options?.core?.auth?.drivers ?? [
-        { driver: 'jwt', key: jwtKey },
-        { driver: 'htpasswd', path: `${localRoot}/users.htpasswd` }
-      ]
-    }
-  };
-
-  const primary = defaultStorageSettings(
-    'main',
-    `${localRoot}/storages/main`,
-    'main-bucket',
-    options?.storages?.primary
-  );
-
-  var work: types.storageSettings;
-  const wType = options?.storages?.work?.type;
-  switch (wType) {
-    case undefined:
-    case 'FS':
-      work = types.emptyFSSettings('work');
-      work.rootPath = options?.storages?.work?.rootPath ?? `${localRoot}/storages/work`;
-      work.indexCachePeriod = options?.storages?.work?.indexCachePeriod ?? '1m';
-      break;
-
-    default:
-      throw new Error("work storage MUST have 'FS' type as it is used for working directories management");
-  }
-
-  const library = defaultStorageSettings(
-    'library',
-    `${localRoot}/storages/library`,
-    'library-bucket',
-    options?.storages?.library
-  );
-
-  const monitoring: types.monitoringSettings = {
-    enabled: defaultBool(options?.monitoring?.enabled, true),
-    listen: options?.monitoring?.listen ?? '127.0.0.1:9090'
-  };
-  const debug: types.debugSettings = {
-    enabled: defaultBool(options?.debug?.enabled, true),
-    listen: options?.debug?.listen ?? '127.0.0.1:9091'
-  };
-  const license: types.licenseSettings = {
-    value: options?.license?.value ?? '',
-    file: options?.license?.file ?? ''
-  };
-
-  return {
-    localRoot,
-    license,
-    log,
-    grpc,
-    core,
-    monitoring,
-    debug,
-    storages: { primary, work, library },
-    hacks: { libraryDownloadable: true }
-  };
-}
-
-function defaultStorageSettings(
-  storageID: string,
-  defaultLocation: string,
-  defaultBucket: string,
-  options?: types.storageOptions
-): types.storageSettings {
-  var storage: types.storageSettings;
-  const pType = options?.type;
-  switch (pType) {
-    case undefined:
-    case 'FS':
-      storage = types.emptyFSSettings(storageID);
-      storage.rootPath = options?.rootPath ?? defaultLocation;
-      break;
-
-    case 'S3':
-      storage = types.emptyS3Settings(storageID);
-
-      storage.endpoint = options?.endpoint ?? 'http://localhost:9000';
-      storage.presignEndpoint = options?.presignEndpoint ?? 'http://localhost:9000';
-      storage.bucketName = options?.bucketName ?? defaultBucket;
-      storage.createBucket = defaultBool(options?.createBucket, true);
-      storage.forcePathStyle = defaultBool(options?.forcePathStyle, true);
-      storage.key = options?.key ?? '';
-      storage.secret = options?.secret ?? '';
-      storage.keyPrefix = options?.keyPrefix ?? '';
-      storage.accessPrefixes = options?.accessPrefixes ?? [''];
-      storage.uploadKeyPrefix = options?.uploadKeyPrefix ?? '';
-      break;
-
-    default:
-      assertNever(pType);
-      throw new Error('unknown storage type'); // calm down TS type analyzer
-  }
-
-  return storage;
-}
-
-export function render(options: types.plSettings): string {
-  const disableMon = options.monitoring.enabled ? '' : ' disabled';
-  const disableDbg = options.debug.enabled ? '' : ' disabled';
-  const libraryDownloadable = options.hacks.libraryDownloadable ? 'true' : 'false';
-
-  var miLicenseSecret = options.license.value;
-  if (options.license.file != '') {
-    miLicenseSecret = fs.readFileSync(options.license.file).toString().trimEnd();
-  }
-
-  return `
-license:
-  value: '${options.license.value}'
-  file: '${options.license.file}'
-
-logging:
-  level: '${options.log.level}'
-  destinations:
-    - path: '${options.log.path}'
-
-monitoring${disableMon}:
-  listen: '${options.monitoring.listen}'
-
-debug${disableDbg}:
-  listen: '${options.debug.listen}'
-
-core:
-  logging:
-    extendedInfo: true
-    dumpResourceData: true
-
-  grpc:
-    listen: '${options.grpc.listen}'
-
-    tlsEnabled: ${JSON.stringify(options.grpc.tls.enable)}
-    tls:
-      clientAuthMode: '${options.grpc.tls.clientAuthMode}'
-      certificates:
-        - certFile: '${options.grpc.tls.certFile}'
-          keyFile: '${options.grpc.tls.keyFile}'
-
-
-  authEnabled: ${JSON.stringify(options.core.auth.enabled)}
-  auth: ${JSON.stringify(options.core.auth.drivers)}
-  db:
-    path: '${options.localRoot}/db'
-
-controllers:
-  data:
-    main:
-      storages:
-          main:
-              mode: primary
-              downloadable: true
-
-          library:
-              mode: passive
-              downloadable: ${libraryDownloadable}
-
-          work:
-              mode: active
-              downloadable: false
-
-    storages:
-      - ${JSON.stringify(options.storages.primary)}
-      - ${JSON.stringify(options.storages.library)}
-      - ${JSON.stringify(options.storages.work)}
-
-  runner:
-    type: local
-    storageRoot: '${(options.storages.work as types.fsStorageSettings).rootPath}'
-    secrets:
-      - map:
-          MI_LICENSE: ${JSON.stringify(miLicenseSecret)}
-
-  packageLoader:
-    packagesRoot: '${options.localRoot}/packages'
-
-  workflows: {}
-`;
-}
-
-function defaultBool(v: boolean | undefined, def: boolean): boolean {
-  return v === undefined ? def : v;
-}

package/src/templates/types.ts

@@ -1,172 +0,0 @@
-export type plSettings = {
-  localRoot: string;
-
-  license: licenseSettings;
-  log: logSettings;
-  grpc: grpcSettings;
-  core: coreSettings;
-  storages: storagesSettings;
-
-  monitoring: monitoringSettings;
-  debug: debugSettings;
-
-  hacks: {
-    libraryDownloadable: boolean;
-  };
-};
-export type plOptions = {
-  localRoot?: string;
-
-  license?: licenseOptions;
-  log?: logOptions;
-  grpc?: grpcOptions;
-  core?: coreOptions;
-  storages?: storagesOptions;
-
-  monitoring?: monitoringOptions;
-  debug?: debugOptions;
-};
-
-export type licenseSettings = {
-  value: string;
-  file: string;
-};
-export type licenseOptions = DeepPartial<licenseSettings>;
-
-export type logSettings = {
-  level: string;
-  path: string;
-};
-export type logOptions = DeepPartial<logSettings>;
-
-export type coreSettings = {
-  auth: authSettings;
-};
-export type coreOptions = {
-  auth?: authOptions;
-};
-
-export type authSettings = {
-  enabled: boolean;
-  drivers: authDriver[];
-};
-export type authOptions = Partial<authSettings>;
-
-export type authDriver =
-  | {
-      driver: 'ldap';
-      serverUrl: string; // 'ldaps://ldap.example.com:1111'
-      defaultDN: string; // 'cn=%u,ou=users,ou=users,dc=example,dc=com'
-    }
-  | {
-      driver: 'jwt';
-      key: string;
-    }
-  | {
-      driver: 'htpasswd';
-      path: string;
-    };
-
-export type grpcSettings = {
-  listen: string;
-  tls: tlsSettings;
-};
-export type grpcOptions = Partial<grpcSettings>;
-
-export type tlsSettings = {
-  enable: boolean;
-  clientAuthMode: tlsAuthMode;
-  certFile: string;
-  keyFile: string;
-};
-export type tlsOptions = Partial<tlsSettings>;
-
-export type tlsAuthMode = 'NoAuth' | 'RequestAnyCert' | 'RequireAnyCert' | 'RequestValidCert' | 'RequireValidCert';
-
-export type storagesSettings = {
-  primary: storageSettings;
-  work: fsStorageSettings;
-  library: storageSettings;
-};
-export type storagesOptions = {
-  primary?: storageOptions;
-  work?: storageOptions;
-  library?: storageOptions;
-};
-
-export type storageSettings = s3StorageSettings | fsStorageSettings;
-export type storageOptions = s3StorageOptions | fsStorageOptions;
-
-type storageID = { id: string };
-type commonStorageSettings = {
-  indexCachePeriod: string;
-};
-
-export type s3StorageSettings = storageID & s3StorageType & commonStorageSettings & s3StorageTypeSettings;
-export type s3StorageOptions = s3StorageType & Partial<commonStorageSettings> & Partial<s3StorageTypeSettings>;
-export function emptyS3Settings(id: string): s3StorageSettings {
-  return {
-    id: id,
-    type: 'S3',
-    indexCachePeriod: '0s',
-    endpoint: '',
-    region: '',
-    presignEndpoint: '',
-    bucketName: '',
-    createBucket: false,
-    forcePathStyle: false,
-    key: '',
-    secret: '',
-    keyPrefix: '',
-    accessPrefixes: [],
-    uploadKeyPrefix: ''
-  };
-}
-
-type s3StorageType = { type: 'S3' };
-type s3StorageTypeSettings = {
-  endpoint: string;
-  presignEndpoint: string;
-  region: string;
-  bucketName: string;
-  createBucket: boolean;
-  forcePathStyle: boolean;
-  key: string;
-  secret: string;
-  keyPrefix: string;
-  accessPrefixes: string[];
-  uploadKeyPrefix: string;
-};
-
-export type fsStorageSettings = storageID & fsStorageType & commonStorageSettings & fsStorageTypeSettings;
-export type fsStorageOptions = fsStorageType & Partial<commonStorageSettings> & Partial<fsStorageTypeSettings>;
-export function emptyFSSettings(id: string): fsStorageSettings {
-  return {
-    id: id,
-    type: 'FS',
-    indexCachePeriod: '0s',
-    rootPath: ''
-  };
-}
-
-type fsStorageType = { type: 'FS' };
-type fsStorageTypeSettings = {
-  rootPath: string;
-};
-
-export type monitoringSettings = {
-  enabled: boolean;
-  listen: string;
-};
-export type monitoringOptions = Partial<monitoringSettings>;
-
-export type debugSettings = {
-  enabled: boolean;
-  listen: string;
-};
-export type debugOptions = Partial<debugSettings>;
-
-/** Makes all keys and keys in sub-objects optional. */
-type DeepPartial<T> = {
-  [P in keyof T]?: T[P] extends object ? DeepPartial<T[P]> : T[P];
-};

package/src/util.ts

@@ -1,55 +0,0 @@
-import os from 'os';
-import path from 'path';
-
-import winston from 'winston';
-import { randomBytes } from 'crypto';
-import readlineSync from 'readline-sync';
-
-export function askYN(prompt: string): boolean {
-  const answer = readlineSync.question(`${prompt} [y/N] `);
-  return answer.toLowerCase() === 'y';
-}
-
-export function assertNever(n: never) {
-  throw new Error('this should never happen');
-}
-
-export function createLogger(level: string = 'debug'): winston.Logger {
-  return winston.createLogger({
-    level: level,
-
-    format: winston.format.combine(
-      winston.format.printf(({ level, message }) => {
-        const indent = ' '.repeat(level.length + 2); // For ': ' after the level
-        const indentedMessage = message
-          .split('\n')
-          .map((line: string, index: number) => (index === 0 ? line : indent + line))
-          .join('\n');
-
-        const colorize = (l: string) => winston.format.colorize().colorize(l, l);
-
-        return `${colorize(level)}: ${indentedMessage}`;
-      })
-    ),
-
-    transports: [
-      new winston.transports.Console({
-        stderrLevels: ['error', 'warn', 'info', 'debug'],
-        handleExceptions: true
-      })
-    ]
-  });
-}
-
-export function randomStr(len: number): string {
-  return randomBytes(Math.ceil(len / 2))
-    .toString('hex')
-    .slice(0, len);
-}
-
-export function resolveTilde(p: string): string {
-  if (p.startsWith('~')) {
-    return path.join(os.homedir(), p.slice(1));
-  }
-  return p;
-}