@aifabrix/builder 2.33.5 → 2.36.0

package/lib/app/show.js

@@ -0,0 +1,642 @@
+/**
+ * AI Fabrix Builder - App Show Command
+ *
+ * Displays application info from local builder/integration (offline) or from
+ * controller (--online). Does not run schema validation; use aifabrix validate for that.
+ *
+ * @fileoverview App show command implementation
+ * @author AI Fabrix Team
+ * @version 2.0.0
+ */
+/* eslint-disable max-lines -- show: offline/online summary builders, auth, display wiring */
+
+'use strict';
+
+const path = require('path');
+const fs = require('fs');
+const yaml = require('js-yaml');
+const logger = require('../utils/logger');
+const { detectAppType } = require('../utils/paths');
+const generator = require('../generator');
+const { getConfig, normalizeControllerUrl } = require('../core/config');
+const { getOrRefreshDeviceToken } = require('../utils/token-manager');
+const { resolveControllerUrl } = require('../utils/controller-url');
+const { resolveEnvironment } = require('../core/config');
+const { getApplication } = require('../api/applications.api');
+const {
+  getExternalSystemConfig,
+  listOpenAPIFiles,
+  listOpenAPIEndpoints
+} = require('../api/external-systems.api');
+const { resolveDataplaneUrl } = require('../utils/dataplane-resolver');
+const { formatApiError } = require('../utils/api-error-handler');
+const { formatAuthenticationError } = require('../utils/error-formatters/http-status-errors');
+const { display: displayShow } = require('./show-display');
+
+/** Truncate deployment key for display */
+const DEPLOYMENT_KEY_TRUNCATE_LEN = 12;
+
+/**
+ * Load and parse variables.yaml from app path (no validation).
+ * @param {string} appPath - Application directory path
+ * @returns {Object} Parsed variables
+ * @throws {Error} If file not found or invalid YAML
+ */
+function loadVariablesFromPath(appPath) {
+  const variablesPath = path.join(appPath, 'variables.yaml');
+  if (!fs.existsSync(variablesPath)) {
+    throw new Error(`variables.yaml not found for app (path: ${variablesPath}). Use aifabrix validate to check.`);
+  }
+  const content = fs.readFileSync(variablesPath, 'utf8');
+  try {
+    const parsed = yaml.load(content);
+    if (!parsed || typeof parsed !== 'object') {
+      throw new Error('variables.yaml is empty or invalid');
+    }
+    return parsed;
+  } catch (error) {
+    if (error.message.includes('variables.yaml')) throw error;
+    throw new Error(`Invalid YAML syntax in variables.yaml: ${error.message}`);
+  }
+}
+
+/**
+ * Collect portal input configuration entries (label + value; masked as "(masked)" if portalInput.masked).
+ * @param {Object} variables - Parsed variables
+ * @returns {Array<{label: string, value: string}>}
+ */
+function getPortalInputConfigurations(variables) {
+  const out = [];
+  const add = (configList) => {
+    if (!configList || !Array.isArray(configList)) return;
+    configList.forEach((item) => {
+      if (item.portalInput) {
+        const label = item.portalInput.label || item.name || item.portalInput.field || '—';
+        const value = item.portalInput.masked ? '(masked)' : (item.value ?? '');
+        out.push({ label, value });
+      }
+    });
+  };
+  add(variables.configuration);
+  (variables.conditionalConfiguration || []).forEach((block) => {
+    add(block.configuration);
+  });
+  return out;
+}
+
+function truncateDeploymentKey(key) {
+  if (!key || key.length <= DEPLOYMENT_KEY_TRUNCATE_LEN) return key ?? '—';
+  return `${key.slice(0, DEPLOYMENT_KEY_TRUNCATE_LEN)}...`;
+}
+
+function healthStrFromDeploy(deploy) {
+  const health = deploy.healthCheck;
+  if (!health || !health.path) return '—';
+  return `${health.path} (interval ${health.intervalSeconds ?? health.interval ?? 30}s)`;
+}
+
+function buildStrFromDeploy(deploy) {
+  const build = deploy.build;
+  if (!build || (!build.dockerfile && !build.envOutputPath)) return '—';
+  return `${build.dockerfile ? 'dockerfile' : '—'}, envOutputPath: ${build.envOutputPath ?? '—'}`;
+}
+
+function buildApplicationFromDeploy(deploy) {
+  const truncatedDeploy = truncateDeploymentKey(deploy.deploymentKey);
+  const application = {
+    key: deploy.key ?? '—',
+    displayName: deploy.displayName ?? '—',
+    description: deploy.description ?? '—',
+    type: deploy.type ?? 'webapp',
+    deploymentKey: truncatedDeploy,
+    image: deploy.image ?? '—',
+    registryMode: deploy.registryMode ?? '—',
+    port: (deploy.port !== undefined && deploy.port !== null) ? deploy.port : '—',
+    healthCheck: healthStrFromDeploy(deploy),
+    build: buildStrFromDeploy(deploy)
+  };
+  const extInt = deploy.externalIntegration;
+  if (deploy.type === 'external' && extInt) {
+    application.externalIntegration = {
+      schemaBasePath: extInt.schemaBasePath,
+      systems: extInt.systems || [],
+      dataSources: extInt.dataSources || []
+    };
+  }
+  return application;
+}
+
+function getDatabasesFromDeploy(deploy) {
+  if (Array.isArray(deploy.databases)) {
+    return deploy.databases.map((d) => (d && d.name) || d).filter(Boolean);
+  }
+  if (deploy.requiresDatabase && deploy.databases) {
+    return deploy.databases.map((d) => (d && d.name) || d).filter(Boolean);
+  }
+  return [];
+}
+
+/**
+ * Build offline summary from deployment manifest (same sections as online).
+ * @param {Object} deploy - Parsed deploy JSON
+ * @param {string} sourcePath - Path to deploy JSON for display
+ * @returns {Object} Summary with application, roles, permissions, etc.
+ */
+function buildOfflineSummaryFromDeployJson(deploy, sourcePath) {
+  const application = buildApplicationFromDeploy(deploy);
+  const configList = deploy.configuration || deploy.system?.configuration || [];
+  const condConfig = deploy.conditionalConfiguration || deploy.system?.conditionalConfiguration || [];
+  const portalInputConfigurations = getPortalInputConfigurations(
+    { configuration: configList, conditionalConfiguration: Array.isArray(condConfig) ? condConfig : [] }
+  );
+  const databases = getDatabasesFromDeploy(deploy);
+  const authentication = deploy.authentication ?? deploy.system?.authentication ?? null;
+  return {
+    source: 'offline',
+    path: sourcePath,
+    appKey: deploy.key,
+    application,
+    roles: deploy.roles || [],
+    permissions: deploy.permissions || [],
+    authentication,
+    portalInputConfigurations,
+    databases,
+    isExternal: deploy.type === 'external'
+  };
+}
+
+function healthStrFromVariables(variables) {
+  const health = variables.healthCheck;
+  if (!health || !health.path) return '—';
+  return `${health.path} (interval ${health.intervalSeconds || 30}s)`;
+}
+
+function buildStrFromVariables(variables) {
+  const build = variables.build;
+  if (!build) return '—';
+  return `${build.language || '—'}, localPort ${build.localPort || '—'}`;
+}
+
+function buildApplicationFromVariables(variables) {
+  const app = variables.app || {};
+  const deploymentKey = app.deploymentKey;
+  const truncatedDeploy = (deploymentKey && deploymentKey.length > DEPLOYMENT_KEY_TRUNCATE_LEN)
+    ? `${deploymentKey.slice(0, DEPLOYMENT_KEY_TRUNCATE_LEN)}...`
+    : (deploymentKey || '—');
+  const application = {
+    key: app.key,
+    displayName: app.displayName,
+    description: app.description,
+    type: app.type || 'webapp',
+    deploymentKey: truncatedDeploy,
+    image: app.image || '—',
+    registryMode: app.registryMode || '—',
+    port: (app.port !== undefined && app.port !== null) ? app.port : '—',
+    healthCheck: healthStrFromVariables(variables),
+    build: buildStrFromVariables(variables)
+  };
+  const extInt = variables.externalIntegration;
+  if (app.type === 'external' && extInt) {
+    application.externalIntegration = {
+      schemaBasePath: extInt.schemaBasePath,
+      systems: extInt.systems || [],
+      dataSources: extInt.dataSources || []
+    };
+  }
+  return application;
+}
+
+/**
+ * Build offline summary object from variables (for display and JSON).
+ * @param {Object} variables - Parsed variables.yaml
+ * @param {string} sourcePath - Path to variables.yaml for display
+ * @returns {Object} Summary with application, roles, permissions, etc.
+ */
+function buildOfflineSummary(variables, sourcePath) {
+  const application = buildApplicationFromVariables(variables);
+  const app = variables.app || {};
+  const databases = variables.requiresDatabase && variables.databases
+    ? variables.databases.map((d) => (d && d.name) || d).filter(Boolean)
+    : [];
+  return {
+    source: 'offline',
+    path: sourcePath,
+    appKey: app.key,
+    application,
+    roles: variables.roles || [],
+    permissions: variables.permissions || [],
+    authentication: variables.authentication || null,
+    portalInputConfigurations: getPortalInputConfigurations(variables),
+    databases,
+    isExternal: app.type === 'external'
+  };
+}
+
+/**
+ * Get auth token for show --online (same pattern as list).
+ * @param {string} controllerUrl - Controller URL
+ * @param {Object} config - Config from getConfig()
+ * @returns {Promise<{token: string, actualControllerUrl: string}|null>}
+ */
+async function getShowAuthToken(controllerUrl, config) {
+  const tryController = async(url) => {
+    const normalized = normalizeControllerUrl(url);
+    const deviceToken = await getOrRefreshDeviceToken(normalized);
+    if (deviceToken && deviceToken.token) {
+      return { token: deviceToken.token, actualControllerUrl: normalized };
+    }
+    return null;
+  };
+
+  if (controllerUrl) {
+    const result = await tryController(controllerUrl);
+    if (result) return result;
+    const formatted = formatAuthenticationError({
+      controllerUrl,
+      message: 'No valid authentication found'
+    });
+    logger.error(formatted);
+    throw new Error('Authentication required for --online. Run aifabrix login.');
+  }
+
+  if (config.device && typeof config.device === 'object') {
+    for (const storedUrl of Object.keys(config.device)) {
+      const result = await tryController(storedUrl);
+      if (result) return result;
+    }
+  }
+
+  const formatted = formatAuthenticationError({
+    controllerUrl: controllerUrl || undefined,
+    message: 'No valid authentication found'
+  });
+  logger.error(formatted);
+  throw new Error('Authentication required for --online. Run aifabrix login.');
+}
+
+async function fetchOpenApiLists(dataplaneUrl, appKey, authConfig) {
+  let openapiFiles = [];
+  let openapiEndpoints = [];
+  try {
+    const filesRes = await listOpenAPIFiles(dataplaneUrl, appKey, authConfig);
+    const filesData = filesRes.data || filesRes;
+    openapiFiles = Array.isArray(filesData) ? filesData : (filesData.items || filesData.data || []);
+  } catch {
+    // optional
+  }
+  try {
+    const endpointsRes = await listOpenAPIEndpoints(dataplaneUrl, appKey, authConfig);
+    const endData = endpointsRes.data || endpointsRes;
+    openapiEndpoints = Array.isArray(endData) ? endData : (endData.items || endData.data || []);
+  } catch {
+    // optional
+  }
+  return { openapiFiles, openapiEndpoints };
+}
+
+function buildExternalSystemResult(configData, appKey, openapiFiles, openapiEndpoints) {
+  const system = configData.system || configData;
+  const dataSources = configData.dataSources || configData.dataSources || [];
+  const application = configData.application || configData.app || {};
+  return {
+    dataplaneUrl: null,
+    systemKey: appKey,
+    displayName: system.displayName || application.displayName || appKey,
+    type: system.type || application.type || '—',
+    status: system.status || '—',
+    version: system.version || '—',
+    dataSources: dataSources.map((ds) => ({
+      key: ds.key,
+      displayName: ds.displayName,
+      systemKey: ds.systemKey || appKey
+    })),
+    application: {
+      key: application.key || appKey,
+      displayName: application.displayName,
+      type: application.type,
+      roles: application.roles,
+      permissions: application.permissions
+    },
+    openapiFiles,
+    openapiEndpoints
+  };
+}
+
+/**
+ * Fetch external system section from dataplane (for --online and type external).
+ * @param {string} dataplaneUrl - Dataplane URL
+ * @param {string} appKey - Application key (system key)
+ * @param {Object} authConfig - Auth config
+ * @returns {Promise<Object|null>} externalSystem object or null if unreachable
+ */
+async function fetchExternalSystemFromDataplane(dataplaneUrl, appKey, authConfig) {
+  try {
+    const configRes = await getExternalSystemConfig(dataplaneUrl, appKey, authConfig);
+    const data = configRes.data || configRes;
+    const configData = data.data || data;
+    const { openapiFiles, openapiEndpoints } = await fetchOpenApiLists(dataplaneUrl, appKey, authConfig);
+    const result = buildExternalSystemResult(configData, appKey, openapiFiles, openapiEndpoints);
+    result.dataplaneUrl = dataplaneUrl;
+    return result;
+  } catch (error) {
+    return { error: error.message || 'dataplane unreachable or not found' };
+  }
+}
+
+/**
+ * Format healthCheck for display (same as offline manifest).
+ * @param {Object} health - healthCheck object
+ * @returns {string}
+ */
+function formatHealthCheckForDisplay(health) {
+  if (!health) return '—';
+  const path = health.path ?? health.probePath ?? '—';
+  const interval = health.interval ?? health.intervalSeconds ?? health.probeIntervalInSeconds ?? 30;
+  return path !== '—' ? `${path} (interval ${interval}s)` : '—';
+}
+
+/**
+ * Format build for display (same as offline manifest).
+ * @param {Object} build - build object
+ * @returns {string}
+ */
+function formatBuildForDisplay(build) {
+  if (!build) return '—';
+  const parts = [];
+  if (build.language) parts.push(build.language);
+  if (build.localPort !== undefined && build.localPort !== null) parts.push(`localPort ${build.localPort}`);
+  if (build.dockerfile) parts.push('dockerfile');
+  if (build.envOutputPath) parts.push(`envOutputPath: ${build.envOutputPath}`);
+  return parts.length ? parts.join(', ') : '—';
+}
+
+function getAppAndCfgFromApiApp(apiApp) {
+  const app = apiApp.data || apiApp;
+  const cfg = app.configuration && typeof app.configuration === 'object' ? app.configuration : {};
+  return { app, cfg };
+}
+
+function getPortalInputFromAppCfg(app, cfg) {
+  const configArray = cfg.configuration || app.configuration;
+  const configList = Array.isArray(configArray) ? configArray : [];
+  const condConfig = cfg.conditionalConfiguration || app.conditionalConfiguration || [];
+  return getPortalInputConfigurations(
+    { configuration: configList, conditionalConfiguration: Array.isArray(condConfig) ? condConfig : [] }
+  );
+}
+
+function resolvePortFromAppCfg(app, cfg) {
+  if (cfg.port !== undefined && cfg.port !== null) return cfg.port;
+  if (app.port !== undefined && app.port !== null) return app.port;
+  return '—';
+}
+
+function resolveDatabasesFromAppCfg(app, cfg) {
+  if (Array.isArray(cfg.databases)) return cfg.databases;
+  if (Array.isArray(app.databases)) return app.databases;
+  return [];
+}
+
+function pickAppCfg(key, app, cfg, fallback) {
+  const v = cfg[key] ?? app[key];
+  return v !== undefined && v !== null ? v : fallback;
+}
+
+function buildApplicationFromAppCfg(app, cfg, portalInputConfigurations) {
+  const deploymentKey = cfg.deploymentKey ?? app.deploymentKey;
+  const truncatedDeploy = truncateDeploymentKey(deploymentKey) || (deploymentKey ?? '—');
+  const application = {
+    key: pickAppCfg('key', app, cfg, '—'),
+    displayName: pickAppCfg('displayName', app, cfg, '—'),
+    description: pickAppCfg('description', app, cfg, '—'),
+    type: pickAppCfg('type', app, cfg, '—'),
+    deploymentKey: truncatedDeploy,
+    image: pickAppCfg('image', app, cfg, '—'),
+    registryMode: pickAppCfg('registryMode', app, cfg, '—'),
+    port: resolvePortFromAppCfg(app, cfg),
+    healthCheck: formatHealthCheckForDisplay(cfg.healthCheck ?? app.healthCheck),
+    build: formatBuildForDisplay(cfg.build ?? app.build),
+    status: pickAppCfg('status', app, cfg, '—'),
+    url: pickAppCfg('url', app, cfg, '—'),
+    roles: cfg.roles ?? app.roles,
+    permissions: cfg.permissions ?? app.permissions,
+    authentication: cfg.authentication ?? app.authentication,
+    portalInputConfigurations,
+    databases: resolveDatabasesFromAppCfg(app, cfg)
+  };
+  return application;
+}
+
+function addExternalIntegrationToApplication(application, app, cfg) {
+  const isExternal = (app.type ?? cfg.type) === 'external';
+  const extInt = cfg.externalIntegration ?? app.externalIntegration;
+  if (!isExternal || !extInt) return;
+  application.externalIntegration = {
+    schemaBasePath: extInt.schemaBasePath,
+    systems: extInt.systems || [],
+    dataSources: extInt.dataSources || []
+  };
+}
+
+function buildApplicationFromApiApp(apiApp) {
+  const { app, cfg } = getAppAndCfgFromApiApp(apiApp);
+  const portalInputConfigurations = getPortalInputFromAppCfg(app, cfg);
+  const application = buildApplicationFromAppCfg(app, cfg, portalInputConfigurations);
+  addExternalIntegrationToApplication(application, app, cfg);
+  return application;
+}
+
+function normalizeExternalSystemForSummary(externalSystem) {
+  if (!externalSystem) return null;
+  if (!externalSystem.error) return externalSystem;
+  return { error: externalSystem.error };
+}
+
+/**
+ * Build online summary from getApplication response (same application schema as offline).
+ * Controller returns Application with nested configuration (ApplicationConfig = full manifest);
+ * validate and use app.configuration so we get deploymentKey, healthCheck, build, roles, etc.
+ * @param {Object} apiApp - Application from getApplication response (e.g. response.data)
+ * @param {string} controllerUrl - Controller URL
+ * @param {Object|null} externalSystem - From dataplane when type external
+ * @returns {Object} Summary for display/JSON (same shape as offline)
+ */
+function buildOnlineSummary(apiApp, controllerUrl, externalSystem) {
+  const application = buildApplicationFromApiApp(apiApp);
+  const roles = application.roles || [];
+  const permissions = application.permissions || [];
+  const isExternal = application.type === 'external';
+  return {
+    source: 'online',
+    controllerUrl,
+    appKey: application.key,
+    application,
+    roles,
+    permissions,
+    authentication: application.authentication || null,
+    portalInputConfigurations: application.portalInputConfigurations,
+    databases: application.databases || [],
+    isExternal,
+    externalSystem: normalizeExternalSystemForSummary(externalSystem)
+  };
+}
+
+/**
+ * Run show in offline mode: generate manifest (same as aifabrix json) and use it; else fall back to variables.yaml.
+ * @param {string} appKey - Application key
+ * @param {boolean} json - Output as JSON
+ * @throws {Error} If variables.yaml not found or invalid YAML
+ */
+async function runOffline(appKey, json) {
+  let summary;
+
+  try {
+    const { deployment, appPath } = await generator.buildDeploymentManifestInMemory(appKey);
+    const sourcePath = path.relative(process.cwd(), appPath) || appPath;
+    summary = buildOfflineSummaryFromDeployJson(deployment, sourcePath);
+  } catch (_err) {
+    const { appPath } = await detectAppType(appKey);
+    const variablesPath = path.join(appPath, 'variables.yaml');
+    const variables = loadVariablesFromPath(appPath);
+    const sourcePath = path.relative(process.cwd(), variablesPath) || variablesPath;
+    summary = buildOfflineSummary(variables, sourcePath);
+  }
+
+  if (json) {
+    const out = {
+      source: summary.source,
+      path: summary.path,
+      appKey: summary.appKey,
+      application: {
+        ...summary.application,
+        roles: summary.roles,
+        permissions: summary.permissions,
+        authentication: summary.authentication,
+        portalInputConfigurations: summary.portalInputConfigurations,
+        databases: summary.databases
+      }
+    };
+    logger.log(JSON.stringify(out, null, 2));
+    return;
+  }
+  displayShow(summary);
+}
+
+async function resolveOnlineAuth(controllerUrl) {
+  const config = await getConfig();
+  const authResult = await getShowAuthToken(controllerUrl, config);
+  return { authConfig: { type: 'bearer', token: authResult.token }, authResult };
+}
+
+function ensureApplicationResponse(response, appKey, authResult) {
+  if (!response.success) {
+    if (response.status === 404) {
+      throw new Error(`Application "${appKey}" not found on controller.`);
+    }
+    const formatted = response.formattedError || formatApiError(response, authResult.actualControllerUrl);
+    logger.error(formatted);
+    throw new Error('Failed to get application from controller.');
+  }
+  return response.data || response;
+}
+
+async function fetchExternalSystemForOnline(controllerUrl, appKey, authConfig) {
+  try {
+    const environment = await resolveEnvironment();
+    const dataplaneUrl = await resolveDataplaneUrl(controllerUrl, environment, authConfig);
+    return await fetchExternalSystemFromDataplane(dataplaneUrl, appKey, authConfig);
+  } catch (err) {
+    return { error: err.message || 'dataplane unreachable or not found' };
+  }
+}
+
+function outputOnlineJson(summary) {
+  const out = {
+    source: summary.source,
+    controllerUrl: summary.controllerUrl,
+    appKey: summary.appKey,
+    application: {
+      key: summary.application.key,
+      displayName: summary.application.displayName,
+      description: summary.application.description,
+      type: summary.application.type,
+      status: summary.application.status,
+      url: summary.application.url,
+      port: summary.application.port,
+      configuration: summary.application.configuration,
+      roles: summary.application.roles,
+      permissions: summary.application.permissions,
+      authentication: summary.application.authentication,
+      portalInputConfigurations: summary.application.portalInputConfigurations,
+      databases: summary.application.databases
+    }
+  };
+  if (summary.externalSystem !== undefined && summary.externalSystem !== null) {
+    out.externalSystem = summary.externalSystem && summary.externalSystem.error
+      ? { error: summary.externalSystem.error }
+      : summary.externalSystem;
+  }
+  logger.log(JSON.stringify(out, null, 2));
+}
+
+/**
+ * Run show in online mode: getApplication, optionally dataplane for external, display or JSON.
+ * @param {string} appKey - Application key
+ * @param {boolean} json - Output as JSON
+ * @throws {Error} On auth failure, 404, or API error
+ */
+async function runOnline(appKey, json) {
+  const controllerUrl = await resolveControllerUrl();
+  if (!controllerUrl) {
+    throw new Error('Controller URL is required for --online. Run aifabrix login to set the controller URL in config.yaml.');
+  }
+  const { authConfig, authResult } = await resolveOnlineAuth(controllerUrl);
+  const response = await getApplication(controllerUrl, appKey, authConfig);
+  const apiApp = ensureApplicationResponse(response, appKey, authResult);
+  const appData = apiApp.data || apiApp;
+  const externalSystem = appData.type === 'external'
+    ? await fetchExternalSystemForOnline(controllerUrl, appKey, authConfig)
+    : null;
+  const summary = buildOnlineSummary(apiApp, authResult.actualControllerUrl, externalSystem);
+  if (json) {
+    outputOnlineJson(summary);
+    return;
+  }
+  displayShow(summary);
+}
+
+/**
+ * Show application info (offline by default, or from controller with --online).
+ * @async
+ * @param {string} appKey - Application key
+ * @param {Object} options - Options
+ * @param {boolean} [options.online] - Fetch from controller
+ * @param {boolean} [options.json] - Output as JSON
+ * @throws {Error} If file missing/invalid (offline) or API/auth error (online)
+ */
+async function showApp(appKey, options = {}) {
+  if (!appKey || typeof appKey !== 'string') {
+    throw new Error('appKey is required');
+  }
+
+  const online = Boolean(options.online);
+  const json = Boolean(options.json);
+
+  if (online) {
+    await runOnline(appKey, json);
+  } else {
+    await runOffline(appKey, json);
+  }
+}
+
+module.exports = {
+  showApp,
+  loadVariablesFromPath,
+  getPortalInputConfigurations,
+  buildOfflineSummary,
+  buildOfflineSummaryFromDeployJson,
+  buildOnlineSummary,
+  formatHealthCheckForDisplay,
+  formatBuildForDisplay,
+  getShowAuthToken
+};