@vectorx/xhs-cloud-cli 0.6.1 → 1.0.0

package/templates/ai-cloud-functions-example/src/env/index.js

@@ -0,0 +1,264 @@
+/**
+ * 环境变量测试示例函数
+ * 
+ * 功能：
+ * - 读取并返回所有环境变量（或指定的环境变量）
+ * - 测试从服务设置面板传入的环境变量是否生效
+ * - 演示如何在云函数中使用环境变量
+ * 
+ * 使用场景：
+ * - 验证环境变量配置是否正确
+ * - 调试环境变量相关问题
+ * - 测试环境变量的注入机制
+ */
+
+/**
+ * GET 请求：获取所有环境变量（过滤敏感信息）
+ * 
+ * 示例：
+ * - GET /env/vars
+ * - GET /env/vars?keys=API_KEY,DATABASE_URL
+ */
+exports.envVars = async function envVars(event, context) {
+  console.log('[envVars] 函数调用开始', {
+    ctxId: context?.ctxId,
+    eventID: context?.eventID,
+    timestamp: new Date().toISOString(),
+  });
+
+  const query = (event && event.params) || {};
+  const keysParam = query.keys; // 可选：指定要返回的环境变量键，用逗号分隔
+
+  // 如果指定了 keys 参数，只返回指定的环境变量
+  if (keysParam && typeof keysParam === 'string') {
+    const requestedKeys = keysParam.split(',').map(k => k.trim()).filter(k => k);
+    const filteredEnv = {};
+    
+    requestedKeys.forEach(key => {
+      if (process.env[key] !== undefined) {
+        filteredEnv[key] = process.env[key];
+      }
+    });
+
+    console.log('[envVars] 返回指定的环境变量', {
+      requested: requestedKeys.length,
+      found: Object.keys(filteredEnv).length,
+      keys: Object.keys(filteredEnv),
+    });
+
+    return {
+      ok: true,
+      code: 0,
+      message: "ENV_VARS_FILTERED_OK",
+      data: {
+        envVars: filteredEnv,
+        requested: requestedKeys,
+        found: Object.keys(filteredEnv),
+        missing: requestedKeys.filter(k => !(k in filteredEnv)),
+      },
+      contentType: "application/json",
+      meta: {
+        ctxId: context.ctxId,
+        eventID: context.eventID,
+        eventType: context.eventType,
+      },
+    };
+  }
+
+  // 返回所有环境变量（过滤掉一些敏感或系统相关的变量）
+  const allEnvVars = {};
+  const sensitiveKeys = ['PATH', 'NODE_PATH', 'HOME', 'USER', 'SHELL', 'PWD', 'LANG', 'LC_'];
+  const systemKeys = ['npm_', 'NPM_', 'NODE_', '_'];
+
+  Object.keys(process.env).forEach(key => {
+    // 过滤掉敏感和系统相关的环境变量
+    const isSensitive = sensitiveKeys.some(sk => key.includes(sk));
+    const isSystem = systemKeys.some(sk => key.startsWith(sk));
+    
+    if (!isSensitive && !isSystem) {
+      allEnvVars[key] = process.env[key];
+    }
+  });
+
+  console.log('[envVars] 返回所有环境变量', {
+    total: Object.keys(process.env).length,
+    returned: Object.keys(allEnvVars).length,
+    keys: Object.keys(allEnvVars),
+  });
+
+  return {
+    ok: true,
+    code: 0,
+    message: "ENV_VARS_ALL_OK",
+    data: {
+      envVars: allEnvVars,
+      total: Object.keys(process.env).length,
+      returned: Object.keys(allEnvVars).length,
+      note: "已过滤敏感和系统相关的环境变量",
+    },
+    contentType: "application/json",
+    meta: {
+      ctxId: context.ctxId,
+      eventID: context.eventID,
+      eventType: context.eventType,
+    },
+  };
+};
+
+/**
+ * POST 请求：测试环境变量的使用
+ * 
+ * 功能：
+ * - 读取指定的环境变量并返回
+ * - 演示如何在业务逻辑中使用环境变量
+ * 
+ * 示例：
+ * - POST /env/test
+ * - Body: { "keys": ["API_KEY", "DATABASE_URL", "test-one", "test-two"] }
+ */
+exports.envTest = async function envTest(event, context) {
+  console.log('[envTest] 函数调用开始', {
+    ctxId: context?.ctxId,
+    eventID: context?.eventID,
+    timestamp: new Date().toISOString(),
+  });
+
+  const body = (event && event.params) || {};
+  const { keys } = body;
+
+  if (!Array.isArray(keys) || keys.length === 0) {
+    console.log('[envTest] 参数验证失败：keys 必须是非空数组');
+    return {
+      ok: false,
+      code: 400,
+      message: "INVALID_KEYS",
+      detail: "keys 必须是非空数组",
+    };
+  }
+
+  // 读取指定的环境变量
+  const results = {};
+  const missing = [];
+
+  keys.forEach(key => {
+    const value = process.env[key];
+    if (value !== undefined) {
+      results[key] = value;
+      console.log(`[envTest] 找到环境变量: ${key} = ${value}`);
+    } else {
+      missing.push(key);
+      console.log(`[envTest] 环境变量不存在: ${key}`);
+    }
+  });
+
+  // 模拟使用环境变量的业务逻辑
+  const mockBusinessLogic = () => {
+    // 示例：使用 API_KEY 环境变量
+    const apiKey = process.env['API_KEY'] || process.env['api_key'];
+    if (apiKey) {
+      console.log('[envTest] 使用 API_KEY 进行业务逻辑处理');
+      // 这里可以调用外部 API 等操作
+    }
+
+    // 示例：使用数据库连接字符串
+    const dbUrl = process.env['DATABASE_URL'] || process.env['database_url'];
+    if (dbUrl) {
+      console.log('[envTest] 使用 DATABASE_URL 连接数据库');
+      // 这里可以连接数据库等操作
+    }
+
+    return {
+      apiKeyConfigured: !!apiKey,
+      databaseConfigured: !!dbUrl,
+    };
+  };
+
+  const businessStatus = mockBusinessLogic();
+
+  console.log('[envTest] 测试结果', {
+    requested: keys.length,
+    found: Object.keys(results).length,
+    missing: missing.length,
+    businessStatus,
+  });
+
+  return {
+    ok: true,
+    code: 0,
+    message: "ENV_TEST_OK",
+    data: {
+      requested: keys,
+      found: results,
+      missing: missing,
+      businessStatus,
+      summary: {
+        total: keys.length,
+        found: Object.keys(results).length,
+        missing: missing.length,
+      },
+    },
+    contentType: "application/json",
+    meta: {
+      ctxId: context.ctxId,
+      eventID: context.eventID,
+      eventType: context.eventType,
+    },
+  };
+};
+
+/**
+ * GET 请求：检查特定环境变量是否存在
+ * 
+ * 示例：
+ * - GET /env/check?key=API_KEY
+ * - GET /env/check?key=test-one
+ */
+exports.envCheck = async function envCheck(event, context) {
+  console.log('[envCheck] 函数调用开始', {
+    ctxId: context?.ctxId,
+    eventID: context?.eventID,
+    timestamp: new Date().toISOString(),
+  });
+
+  console.log('process', process.env);
+
+  const query = (event && event.params) || {};
+  const key = query.key;
+
+  if (!key || typeof key !== 'string') {
+    console.log('[envCheck] 参数验证失败：key 是必填参数');
+    return {
+      ok: false,
+      code: 400,
+      message: "MISSING_KEY",
+      detail: "key 是必填参数",
+    };
+  }
+
+  const value = process.env[key];
+  const exists = value !== undefined;
+
+  console.log('[envCheck] 检查结果', {
+    key,
+    exists,
+    hasValue: exists && value.length > 0,
+  });
+
+  return {
+    ok: true,
+    code: 0,
+    message: exists ? "ENV_KEY_EXISTS" : "ENV_KEY_NOT_FOUND",
+    data: {
+      key,
+      exists,
+      value: exists ? value : null,
+      hasValue: exists && value && value.length > 0,
+    },
+    contentType: "application/json",
+    meta: {
+      ctxId: context.ctxId,
+      eventID: context.eventID,
+      eventType: context.eventType,
+    },
+  };
+};

package/templates/ai-cloud-functions-example/src/form/index.js

@@ -0,0 +1,138 @@
+/**
+ * 表单提交处理示例函数
+ * 
+ * 覆盖场景：
+ * - Content-Type: application/x-www-form-urlencoded
+ * 
+ * 业务场景：表单数据提交和处理（模拟表单提交到数据库）
+ */
+
+// Mock 表单提交记录
+const FORM_SUBMISSIONS = [];
+
+/**
+ * POST 请求：提交表单数据
+ * 
+ * 示例：
+ * - POST /form/submit
+ * - Content-Type: application/x-www-form-urlencoded
+ * - Body: name=张三&email=zhangsan@example.com&message=这是一条留言
+ */
+exports.formSubmit = async function formSubmit(event, context) {
+  console.log('[formSubmit] 函数调用开始', {
+    ctxId: context?.ctxId,
+    eventID: context?.eventID,
+    timestamp: new Date().toISOString(),
+  });
+  
+  console.log('=====>', event);
+  // 处理表单数据：可能是 URLSearchParams 字符串或已解析的对象
+  let formData = {};
+
+  const params = event?.params;
+
+  if (typeof params === 'string') {
+    // 如果是字符串，解析 URLSearchParams
+    const qs = new URLSearchParams(params);
+    for (const [key, value] of qs.entries()) {
+      formData[key] = value;
+    }
+    console.log('[formSubmit] 解析 URLSearchParams 字符串');
+  } else if (params && typeof params === 'object') {
+    // 如果已经是对象，直接使用
+    formData = params;
+    console.log('[formSubmit] 使用已解析的对象数据');
+  } else {
+    formData = {};
+    console.log('[formSubmit] 使用 event 作为表单数据');
+  }
+  
+  const { name, email, message, phone } = formData;
+  
+  console.log('[formSubmit] 表单数据', { name, email, hasMessage: !!message, hasPhone: !!phone });
+  
+  if (!name || !email) {
+    console.log('[formSubmit] 参数验证失败：缺少必填字段');
+    return {
+      ok: false,
+      code: 400,
+      message: "MISSING_REQUIRED_FIELDS",
+      detail: "name 和 email 为必填字段",
+    };
+  }
+  
+  // 模拟数据库保存
+  const submission = {
+    id: `sub${Date.now()}`,
+    name,
+    email,
+    phone: phone || null,
+    message: message || null,
+    submittedAt: new Date().toISOString(),
+  };
+  FORM_SUBMISSIONS.push(submission);
+  
+  console.log('[formSubmit] 表单提交成功', {
+    submissionId: submission.id,
+    email: submission.email,
+    totalSubmissions: FORM_SUBMISSIONS.length,
+  });
+  
+  return {
+    ok: true,
+    code: 0,
+    message: "FORM_SUBMIT_OK",
+    data: submission,
+    contentType: "application/x-www-form-urlencoded",
+    meta: {
+      ctxId: context.ctxId,
+      eventID: context.eventID,
+      eventType: context.eventType,
+    },
+  };
+};
+
+/**
+ * GET 请求：查询表单提交记录
+ * 
+ * 示例：
+ * - GET /form/submissions?email=zhangsan@example.com
+ */
+exports.formSubmissions = async function formSubmissions(event, context) {
+  console.log('[formSubmissions] 函数调用开始', {
+    ctxId: context?.ctxId,
+    eventID: context?.eventID,
+    timestamp: new Date().toISOString(),
+  });
+  
+  const query = (event && event.params) || {};
+  const { email } = query;
+  
+  console.log('[formSubmissions] 查询参数', { email, totalRecords: FORM_SUBMISSIONS.length });
+  
+  let submissions = FORM_SUBMISSIONS;
+  
+  // 模拟数据库查询：按邮箱过滤
+  if (email) {
+    submissions = FORM_SUBMISSIONS.filter(s => s.email === email);
+    console.log('[formSubmissions] 按邮箱过滤', { email, filteredCount: submissions.length });
+  }
+  
+  console.log('[formSubmissions] 查询结果', { total: submissions.length });
+  
+  return {
+    ok: true,
+    code: 0,
+    message: "FORM_QUERY_OK",
+    data: {
+      total: submissions.length,
+      submissions,
+    },
+    contentType: "application/x-www-form-urlencoded",
+    meta: {
+      ctxId: context.ctxId,
+      eventID: context.eventID,
+      eventType: context.eventType,
+    },
+  };
+};

package/templates/ai-cloud-functions-example/src/json/index.js

@@ -0,0 +1,194 @@
+/**
+ * JSON 请求处理示例函数
+ * 
+ * 覆盖场景：
+ * - Content-Type: application/json
+ * - Content-Type: application/vnd.api+json (带 +json 后缀)
+ * 
+ * 业务场景：用户数据查询和创建（模拟数据库操作）
+ */
+
+// Mock 数据库数据
+const MOCK_DB = [
+  { id: "u001", name: "张三", email: "zhangsan@example.com", age: 25 },
+  { id: "u002", name: "李四", email: "lisi@example.com", age: 30 },
+];
+
+/**
+ * GET 请求：查询用户列表（通过 query 参数）
+ * 
+ * 示例：
+ * - GET /json/users?page=1&limit=10
+ */
+exports.jsonUsersList = async function jsonUsersList(event, context) {
+  console.log('[jsonUsersList] 函数调用开始', {
+    ctxId: context?.ctxId,
+    eventID: context?.eventID,
+    timestamp: new Date().toISOString(),
+  });
+  
+  const query = (event && event.params) || {};
+  const page = parseInt(query.page) || 1;
+  const limit = parseInt(query.limit) || 10;
+  
+  console.log('[jsonUsersList] 查询参数', { page, limit, query });
+  
+  const start = (page - 1) * limit;
+  const end = start + limit;
+  const users = MOCK_DB.slice(start, end);
+  
+  console.log('[jsonUsersList] 查询结果', {
+    total: MOCK_DB.length,
+    returned: users.length,
+    page,
+    limit,
+  });
+  
+  return {
+    ok: true,
+    code: 0,
+    message: "JSON_GET_USERS_OK",
+    data: {
+      users,
+      pagination: {
+        page,
+        limit,
+        total: MOCK_DB.length,
+        totalPages: Math.ceil(MOCK_DB.length / limit),
+      },
+    },
+    contentType: "application/json",
+    meta: {
+      ctxId: context.ctxId,
+      eventID: context.eventID,
+      eventType: context.eventType,
+    },
+  };
+};
+
+/**
+ * POST 请求：创建用户（JSON Body）
+ * 
+ * 示例：
+ * - POST /json/users/create
+ * - Body: { "name": "王五", "email": "wangwu@example.com", "age": 28 }
+ */
+exports.jsonUsersCreate = async function jsonUsersCreate(event, context) {
+  console.log('[jsonUsersCreate] 函数调用开始', {
+    ctxId: context?.ctxId,
+    eventID: context?.eventID,
+    timestamp: new Date().toISOString(),
+  });
+  
+  const body = (event && event.params) || {};
+  const { name, email, age } = body;
+  
+  console.log('[jsonUsersCreate] 请求参数', { name, email, age });
+  
+  if (!name || !email) {
+    console.log('[jsonUsersCreate] 参数验证失败：缺少必填字段');
+    return {
+      ok: false,
+      code: 400,
+      message: "MISSING_REQUIRED_FIELDS",
+      detail: "name 和 email 为必填字段",
+    };
+  }
+  
+  // 模拟数据库查询：检查邮箱是否已存在
+  const exists = MOCK_DB.find(u => u.email === email);
+  if (exists) {
+    console.log('[jsonUsersCreate] 邮箱已存在', { email });
+    return {
+      ok: false,
+      code: 409,
+      message: "EMAIL_EXISTS",
+      detail: `邮箱 ${email} 已被使用`,
+    };
+  }
+  
+  // 模拟数据库插入
+  const newUser = {
+    id: `u${String(MOCK_DB.length + 1).padStart(3, '0')}`,
+    name,
+    email,
+    age: age || null,
+  };
+  MOCK_DB.push(newUser);
+  
+  console.log('[jsonUsersCreate] 用户创建成功', {
+    userId: newUser.id,
+    email: newUser.email,
+    totalUsers: MOCK_DB.length,
+  });
+  
+  return {
+    ok: true,
+    code: 0,
+    message: "JSON_POST_CREATE_OK",
+    data: newUser,
+    contentType: "application/json",
+    meta: {
+      ctxId: context.ctxId,
+      eventID: context.eventID,
+      eventType: context.eventType,
+    },
+  };
+};
+
+/**
+ * POST 请求：批量查询用户（JSON Body with +json content-type）
+ * 
+ * 示例：
+ * - POST /json/users/batch
+ * - Content-Type: application/vnd.api+json
+ * - Body: { "userIds": ["u001", "u002"] }
+ */
+exports.jsonUsersBatch = async function jsonUsersBatch(event, context) {
+  console.log('[jsonUsersBatch] 函数调用开始', {
+    ctxId: context?.ctxId,
+    eventID: context?.eventID,
+    timestamp: new Date().toISOString(),
+  });
+  
+  const body = (event && event.params) || {};
+  const { userIds } = body;
+  
+  console.log('[jsonUsersBatch] 批量查询请求', { userIds, count: userIds?.length });
+  
+  if (!Array.isArray(userIds) || userIds.length === 0) {
+    console.log('[jsonUsersBatch] 参数验证失败：userIds 必须是非空数组');
+    return {
+      ok: false,
+      code: 400,
+      message: "INVALID_USER_IDS",
+      detail: "userIds 必须是非空数组",
+    };
+  }
+  
+  // 模拟数据库批量查询
+  const users = MOCK_DB.filter(u => userIds.includes(u.id));
+  
+  console.log('[jsonUsersBatch] 批量查询结果', {
+    requested: userIds.length,
+    found: users.length,
+    userIds: users.map(u => u.id),
+  });
+  
+  return {
+    ok: true,
+    code: 0,
+    message: "JSON_BATCH_QUERY_OK",
+    data: {
+      requested: userIds.length,
+      found: users.length,
+      users,
+    },
+    contentType: "application/vnd.api+json",
+    meta: {
+      ctxId: context.ctxId,
+      eventID: context.eventID,
+      eventType: context.eventType,
+    },
+  };
+};