rl-rockcli 0.0.1

package/src/core/display/format.js

@@ -0,0 +1,178 @@
+/**
+ * 日志格式化输出工具
+ */
+
+const { DISPLAY_FIELDS, FIELD_COLOR_MAP, DEFAULT_FIELD_COLOR, TRUNCATE_FIELDS, ANSI_COLORS } = require('./constants');
+const { highlightKeyword } = require('./highlight');
+
+/**
+ * 截断过长的字段值
+ * @param {string} value - 字段值
+ * @param {string} fieldName - 字段名
+ * @param {number} truncate - 截断长度（0 表示不截断）
+ * @returns {string} 截断后的值
+ */
+function truncateValue(value, fieldName, truncate) {
+    if (!truncate || truncate === 0) return value;
+    if (!TRUNCATE_FIELDS.includes(fieldName)) return value;
+
+    const str = String(value);
+    if (str.length <= truncate) return str;
+    return `${str.substring(0, truncate)}...[truncated]`;
+}
+
+/**
+ * 应用高亮和截断
+ * @param {*} value - 字段值
+ * @param {string} fieldName - 字段名
+ * @param {number} truncate - 截断长度
+ * @param {string|string[]} keyword - 关键字
+ * @param {boolean} highlight - 是否高亮
+ * @returns {string} 处理后的值
+ */
+function applyHighlightAndTruncate(value, fieldName, truncate, keyword, highlight) {
+    let str = typeof value === 'object' ? JSON.stringify(value) : String(value);
+    str = truncateValue(str, fieldName, truncate);
+    if (keyword && highlight) {
+        str = highlightKeyword(str, keyword);
+    }
+    return str;
+}
+
+/**
+ * 获取字段颜色
+ * @param {string} fieldName - 字段名
+ * @param {boolean} isTTY - 是否在终端环境
+ * @returns {string} ANSI 颜色代码
+ */
+function getFieldColor(fieldName, isTTY) {
+    if (!isTTY) return '';
+    return FIELD_COLOR_MAP[fieldName] || DEFAULT_FIELD_COLOR;
+}
+
+/**
+ * 按字段名过滤日志对象（用于 json 输出）
+ * @param {Object} log - 日志对象
+ * @param {string[]} columns - 字段列表
+ * @returns {Object} 过滤后的日志对象
+ */
+function filterLogFields(log, columns) {
+    const result = {};
+    const keys = columns && columns.length > 0
+        ? columns
+        : Object.keys(log);
+
+    for (const key of keys) {
+        if (log[key] === null || log[key] === undefined) continue;
+        result[key] = log[key];
+    }
+
+    return result;
+}
+
+/**
+ * 格式化单条日志输出
+ * @param {Object} log - 日志对象
+ * @param {Object} options - 格式化选项
+ * @param {string} options.logFormat - 输出格式（logfmt/json）
+ * @param {string} options.columns - 字段列表（逗号分隔）
+ * @param {number} options.truncate - 截断长度
+ * @param {string|string[]} options.keyword - 关键字
+ * @param {boolean} options.highlight - 是否高亮
+ */
+function formatLogEntry(log, options) {
+    const {
+        logFormat,
+        columns,
+        truncate,
+        keyword,
+        highlight,
+    } = options;
+
+    const isTTY = process.stdout.isTTY;
+    const RESET = ANSI_COLORS.RESET;
+
+    let columnFilter = null;
+    if (columns) {
+        columnFilter = String(columns)
+            .split(',')
+            .map((s) => s.trim())
+            .filter(Boolean);
+    }
+
+    // JSON 格式: 简单过滤后直接输出 JSON
+    if (logFormat === 'json') {
+        const filtered = filterLogFields(log, columnFilter);
+        // eslint-disable-next-line no-console
+        console.log(JSON.stringify(filtered));
+        return;
+    }
+
+    // logfmt 格式
+    const fieldsToDisplay = columnFilter && columnFilter.length > 0
+        ? columnFilter
+        : DISPLAY_FIELDS;
+
+    const formatted = [];
+
+    fieldsToDisplay.forEach((fieldName) => {
+        if (!Object.prototype.hasOwnProperty.call(log, fieldName)) return;
+        const rawValue = log[fieldName];
+        if (rawValue === null || rawValue === undefined) return;
+
+        const color = getFieldColor(fieldName, isTTY);
+        const value = applyHighlightAndTruncate(rawValue, fieldName, truncate, keyword, highlight);
+
+        let formattedValue = value;
+        if (typeof value === 'string'
+            && (value.includes(' ') || value.includes('"') || value.includes('\''))) {
+            formattedValue = `"${value.replace(/"/g, '\\"')}"`;
+        }
+
+        const coloredKey = `${color}${fieldName}${RESET}`;
+        formatted.push(`${coloredKey}=${formattedValue}${RESET}`);
+    });
+
+    if (formatted.length === 0) {
+        // 回退: 打印整个对象
+        // eslint-disable-next-line no-console
+        console.log(JSON.stringify(log));
+        return;
+    }
+
+    // eslint-disable-next-line no-console
+    console.log(formatted.join(' '));
+}
+
+/**
+ * 批量输出日志数组
+ * @param {Object[]} logs - 日志数组
+ * @param {boolean} raw - 是否原始输出（暂未使用）
+ * @param {string} logFormat - 输出格式
+ * @param {string} columns - 字段列表
+ * @param {number} truncate - 截断长度
+ * @param {string|string[]} keyword - 关键字
+ * @param {boolean} highlight - 是否高亮
+ */
+function displayLogs(logs, raw, logFormat, columns, truncate, keyword, highlight) {
+    const opts = {
+        logFormat: logFormat || 'logfmt',
+        columns: columns || null,
+        truncate: typeof truncate === 'number' ? truncate : 2048,
+        keyword: keyword || null,
+        highlight: highlight !== false,
+    };
+
+    logs.forEach((log) => {
+        formatLogEntry(log, opts);
+    });
+}
+
+module.exports = {
+    truncateValue,
+    applyHighlightAndTruncate,
+    getFieldColor,
+    filterLogFields,
+    formatLogEntry,
+    displayLogs,
+};

package/src/core/display/highlight.js

@@ -0,0 +1,34 @@
+/**
+ * 关键字高亮工具
+ */
+
+/**
+ * 高亮文本中的关键字
+ * @param {string} text - 原始文本
+ * @param {string|string[]} keyword - 关键字（单个或数组）
+ * @returns {string} 高亮后的文本
+ */
+function highlightKeyword(text, keyword) {
+    if (!keyword || !text) return text;
+
+    const HIGHLIGHT_BG = '\x1b[43m';
+    const HIGHLIGHT_FG = '\x1b[30m';
+    const RESET = '\x1b[0m\x1b[49m';
+
+    const keywords = Array.isArray(keyword) ? keyword : [keyword];
+    let result = text;
+
+    keywords.forEach((kw) => {
+        if (kw && typeof kw === 'string') {
+            const escapedKeyword = kw.replace(/[.*+?^${}()|[\]\\]/g, '\\$&');
+            const regex = new RegExp(`(${escapedKeyword})`, 'gi');
+            result = result.replace(regex, `${HIGHLIGHT_BG}${HIGHLIGHT_FG}$1${RESET}`);
+        }
+    });
+
+    return result;
+}
+
+module.exports = {
+    highlightKeyword,
+};

package/src/core/index.js

@@ -0,0 +1,55 @@
+/**
+ * Core 模块导出
+ * 通用逻辑的单一事实源
+ */
+
+// Provider 接口
+const { LogProvider } = require('./providers');
+
+// 工具函数
+const { parseTime } = require('./utils');
+
+// 展示层
+const { displayLogs, formatLogEntry } = require('./display/format');
+const { highlightKeyword } = require('./display/highlight');
+const displayConstants = require('./display/constants');
+
+// 命令
+const logCommand = require('./commands/log');
+const { handleLogSearch } = require('./commands/log/search');
+const sandboxCommand = require('./commands/sandbox');
+const attachCommand = require('./commands/attach');
+
+// SDK
+const { SandboxClient, SandboxConfig, getOpenSourceSandboxConfig } = require('./sdks/sandbox');
+
+// 配置
+const config = require('./config');
+
+module.exports = {
+    // Provider
+    LogProvider,
+
+    // Utils
+    parseTime,
+
+    // Display
+    displayLogs,
+    formatLogEntry,
+    highlightKeyword,
+    displayConstants,
+
+    // Commands
+    logCommand,
+    handleLogSearch,
+    sandboxCommand,
+    attachCommand,
+
+    // SDK
+    SandboxClient,
+    SandboxConfig,
+    getOpenSourceSandboxConfig,
+
+    // Config
+    config,
+};

package/src/core/providers/index.js

@@ -0,0 +1,9 @@
+/**
+ * Provider 导出
+ */
+
+const { LogProvider } = require('./log-provider');
+
+module.exports = {
+    LogProvider,
+};

package/src/core/providers/log-provider.js

@@ -0,0 +1,79 @@
+/**
+ * LogProvider 抽象接口
+ * 
+ * 所有日志后端（本地文件、SLS、Loghouse 等）都应实现此接口。
+ * 这确保了命令层与具体日志存储的解耦。
+ */
+
+/**
+ * @typedef {Object} LogQueryOptions
+ * @property {number} startTime - 开始时间（毫秒时间戳）
+ * @property {number} endTime - 结束时间（毫秒时间戳）
+ * @property {string} [filter] - 过滤条件（简单关键字匹配）
+ * @property {number} [limit] - 返回条数限制
+ * @property {number} [offset] - 偏移量
+ * @property {boolean} [count] - 是否只返回数量
+ * @property {string} [table] - 表名（可选，部分后端支持）
+ * @property {string} [orderBy] - 排序字段
+ * @property {string} [orderDirection] - 排序方向（ASC/DESC）
+ * @property {string} [sandboxId] - 按 sandbox_id 过滤
+ * @property {string} [event] - 按 event 过滤
+ */
+
+/**
+ * @typedef {Object} LogEntry
+ * @property {string} ['@timestamp'] - 时间戳（毫秒）
+ * @property {string} [timestamp] - 时间戳
+ * @property {string} [time_iso8601] - ISO8601 时间
+ * @property {string} [level] - 日志级别
+ * @property {string} [message] - 日志消息
+ * @property {string} [sandbox_id] - Sandbox ID
+ * @property {string} [trace_id] - 追踪 ID
+ * @property {string} [event] - 事件类型
+ */
+
+/**
+ * @typedef {Object} LogProviderInterface
+ * @property {function(): Promise<LogProviderInterface>} connect - 建立连接
+ * @property {function(LogQueryOptions): Promise<LogEntry[]|{total: number}[]>} query - 查询日志
+ * @property {function(): Promise<void|undefined>} close - 关闭连接
+ */
+
+/**
+ * 创建 LogProvider 的基类定义
+ * 子类应实现 connect、query、close 方法
+ */
+class LogProvider {
+    constructor(config = {}) {
+        this.config = config;
+    }
+
+    /**
+     * 建立连接
+     * @returns {Promise<LogProvider>}
+     */
+    async connect() {
+        throw new Error('LogProvider.connect() must be implemented by subclass');
+    }
+
+    /**
+     * 查询日志
+     * @param {LogQueryOptions} options - 查询选项
+     * @returns {Promise<LogEntry[]|{total: number}[]>}
+     */
+    async query(options) {
+        throw new Error('LogProvider.query() must be implemented by subclass');
+    }
+
+    /**
+     * 关闭连接
+     * @returns {Promise<void|undefined>}
+     */
+    async close() {
+        throw new Error('LogProvider.close() must be implemented by subclass');
+    }
+}
+
+module.exports = {
+    LogProvider,
+};