@cloudbase/cli 2.0.12 → 2.1.0

package/src/commands/functions/log.ts

@@ -1,148 +0,0 @@
-import chalk from 'chalk'
-import { Command, ICommand } from '../common'
-import { CloudBaseError } from '../../error'
-import { getFunctionLog } from '../../function'
-import { InjectParams, CmdContext, ArgsParams, Log, Logger } from '../../decorators'
-
-@ICommand()
-export class FunctionLog extends Command {
-    get options() {
-        return {
-            cmd: 'fn',
-            childCmd: 'log <name>',
-            deprecateCmd: 'functions:log <name>',
-            options: [
-                {
-                    flags: '-e, --envId <envId>',
-                    desc: '环境 Id'
-                },
-                { flags: '-i, --reqId <reqId>', desc: '函数请求 Id' },
-                {
-                    flags: '-o, --offset <offset>',
-                    desc: '数据的偏移量，Offset + Limit不能大于10000'
-                },
-                {
-                    flags: '-l, --limit <limit>',
-                    desc: '返回数据的长度，Offset + Limit不能大于10000'
-                },
-                {
-                    flags: '--order <order>',
-                    desc: '以升序还是降序的方式对日志进行排序，可选值 desc 和 asc'
-                },
-                {
-                    flags: '--orderBy <orderBy>',
-                    desc:
-                        '根据某个字段排序日志,支持以下字段：function_name, duration, mem_usage, start_time'
-                },
-                {
-                    flags: '--startTime <startTime>',
-                    desc: '查询的具体日期，例如：2019-05-16 20:00:00，只能与 endtime 相差一天之内'
-                },
-                {
-                    flags: '--endTime <endTime>',
-                    desc: '查询的具体日期，例如：2019-05-16 20:59:59，只能与 startTime 相差一天之内'
-                },
-                { flags: '-e, --error', desc: '只返回错误类型的日志' },
-                { flags: '-s, --success', desc: '只返回正确类型的日志' }
-            ],
-            desc: '打印云函数日志'
-        }
-    }
-
-    @InjectParams()
-    async execute(@CmdContext() ctx, @ArgsParams() argsParams, @Log() log: Logger) {
-        const { envId, options } = ctx
-        const name = argsParams?.[0]
-
-        let {
-            offset,
-            limit,
-            order,
-            orderBy,
-            error,
-            success,
-            startTime,
-            endTime,
-            reqId: functionRequestId
-        } = options
-
-        if (!name) {
-            throw new CloudBaseError('云函数名称不能为空')
-        }
-
-        // 2019-05-16 20:59:59 时间类型的长度
-        const TimeLength = 19
-
-        if (
-            typeof startTime !== 'undefined' &&
-            typeof endTime !== 'undefined' &&
-            (startTime.length !== TimeLength || endTime.length !== TimeLength)
-        ) {
-            throw new CloudBaseError('时间格式错误，必须为 2019-05-16 20:59:59 类型')
-        }
-
-        if (new Date(endTime).getTime() < new Date(startTime).getTime()) {
-            throw new CloudBaseError('开始时间不能晚于结束时间')
-        }
-
-        const OneDay = 86400000
-        if (new Date(endTime).getTime() - new Date(startTime).getTime() > OneDay) {
-            throw new CloudBaseError('endTime 与 startTime 只能相差一天之内')
-        }
-
-        let params: any = {
-            order,
-            orderBy,
-            startTime,
-            endTime,
-            functionRequestId,
-            offset: Number(offset),
-            limit: Number(limit)
-        }
-
-        error && (params.filter = { RetCode: 'not0' })
-        success && (params.filter = { RetCode: 'is0' })
-        // 删除值为 undefined 的字段
-        params = JSON.parse(JSON.stringify(params))
-
-        const logs = await getFunctionLog({
-            envId,
-            functionName: name,
-            ...params
-        })
-
-        const ResMap = {
-            StartTime: '请求时间',
-            FunctionName: '函数名称',
-            BillDuration: '计费时间(ms)',
-            Duration: '运行时间(ms)',
-            InvokeFinished: '调用次数',
-            MemUsage: '占用内存',
-            RequestId: '请求 Id',
-            RetCode: '调用状态',
-            RetMsg: '返回结果'
-        }
-
-        log.success(chalk.green(`函数：${name} 调用日志：\n`))
-
-        if (logs.length === 0) {
-            return log.info('无调用日志')
-        }
-
-        logs.forEach((log) => {
-            const info = Object.keys(ResMap)
-                .map((key) => {
-                    if (key === 'RetCode') {
-                        return `${ResMap[key]}：${Number(log[key]) === 0 ? '成功' : '失败'}\n`
-                    }
-                    if (key === 'MemUsage') {
-                        const str = Number(Number(log[key]) / 1024 / 1024).toFixed(3)
-                        return `${ResMap[key]}：${str} MB\n`
-                    }
-                    return `${ResMap[key]}：${log[key]} \n`
-                })
-                .reduce((prev, next) => prev + next)
-            console.log(info + `日志：\n ${log.Log} \n`)
-        })
-    }
-}

package/src/commands/functions/run.ts

@@ -1,249 +0,0 @@
-import _ from 'lodash'
-import path from 'path'
-import { spawn, SpawnOptionsWithoutStdio } from 'child_process'
-import { Command, ICommand } from '../common'
-import { CloudBaseError } from '../../error'
-import { ICommandContext } from '../../types'
-import { InjectParams, CmdContext } from '../../decorators'
-import { checkFullAccess, isDirectory, checkAndGetCredential } from '../../utils'
-
-// 启动文件
-const bootstrapFilePath = path.join(__dirname, '../../../runtime/nodejs/bootstrap.js')
-
-function checkJSON(data) {
-    try {
-        JSON.parse(data)
-    } catch (e) {
-        throw new CloudBaseError('非法的 JSON 字符串')
-    }
-}
-
-function errorLog(msg: string, debug?: boolean) {
-    throw new CloudBaseError(msg, {
-        meta: { debug }
-    })
-}
-
-function getDebugArgs(port = 9229) {
-    return [
-        `--inspect-brk=0.0.0.0:${port}`,
-        '--nolazy',
-        '--expose-gc',
-        '--max-semi-space-size=150',
-        '--max-old-space-size=2707'
-    ]
-}
-
-// 启动 Node 子进程执行
-function spawnNodeProcess(args: string[], options: SpawnOptionsWithoutStdio) {
-    const commonOptions = {
-        cwd: path.dirname(bootstrapFilePath),
-        windowsHide: true
-    }
-
-    const exec = spawn('node', args, {
-        ...commonOptions,
-        ...options
-    })
-
-    exec.on('error', (e) => {
-        console.log(`进程执行异常：${e.message}`)
-        setTimeout(() => {}, 100)
-    })
-
-    exec.stdout.on('data', (data) => {
-        console.log(`${data}`)
-    })
-
-    exec.stderr.on('data', (data) => {
-        console.log(`${data}`)
-    })
-
-    exec.on('close', (code) => {
-        if (code !== 0) {
-            console.log(`\n云函数执行异常退出，错误码：${code}`)
-        }
-    })
-}
-
-async function getSecret() {
-    const credential = await checkAndGetCredential()
-    if (_.isEmpty(credential)) {
-        console.log('未登录，无法直接调用 Node SDK')
-        return {}
-    }
-
-    const { secretId, secretKey, token } = credential
-
-    return {
-        TENCENTCLOUD_SECRETID: secretId,
-        TENCENTCLOUD_SECRETKEY: secretKey,
-        TENCENTCLOUD_SESSIONTOKEN: token
-    }
-}
-
-export async function debugFunctionByPath(functionPath: string, options: Record<string, any>) {
-    const { params, debug, port } = options
-    params && checkJSON(params)
-
-    // 检查路径是否存在
-    const filePath = path.resolve(functionPath)
-    checkFullAccess(filePath)
-
-    let debugDirname
-    const isDir = isDirectory(filePath)
-
-    if (isDir) {
-        const exists = checkFullAccess(path.join(filePath, 'index.js'))
-        if (!exists) {
-            errorLog('index.js 文件不存在！', debug)
-        }
-        debugDirname = filePath
-    } else {
-        const { base, dir } = path.parse(filePath)
-        if (base !== 'index.js') {
-            errorLog('index.js 文件不存在！', debug)
-        }
-        debugDirname = dir
-    }
-
-    try {
-        // eslint-disable-next-line
-        const fileExports = require(path.join(debugDirname, 'index.js'))
-        if (!fileExports.main) {
-            errorLog('main 方法不存在！', debug)
-        }
-    } catch (e) {
-        errorLog(`导入云函数异常：${e.message}`, debug)
-    }
-
-    // 读取本地 secret 变量
-    const secret = await getSecret()
-    const debugArgs = getDebugArgs(port)
-    const args = debug ? [...debugArgs, bootstrapFilePath] : [bootstrapFilePath]
-    console.log('> 以默认配置启动 Node 云函数调试')
-
-    spawnNodeProcess(args, {
-        env: {
-            ...process.env,
-            SCF_FUNCTION_HANDLER: 'index.main',
-            SCF_FUNCTION_NAME: 'main',
-            GLOBAL_USER_FILE_PATH: path.join(debugDirname, path.sep),
-            SCF_EVENT_BODY: params || '{}',
-            ...secret
-        }
-    })
-}
-
-export async function debugByConfig(ctx: ICommandContext, name: string) {
-    const { config, options, envId } = ctx
-    const { params, debug, port } = options
-    params && checkJSON(params)
-
-    // 检查路径是否存在
-    let functionPath = path.resolve(config.functionRoot, name)
-    const filePath = path.resolve(functionPath)
-    checkFullAccess(filePath, !debug)
-
-    let debugDirname
-    const funcConfig = config.functions.find((item) => item.name === name)
-
-    const handlers = (funcConfig?.handler || 'index.main').split('.')
-    const indexFileName = handlers[0]
-    const indexFile = `${indexFileName}.js`
-    const mainFunction = handlers[1]
-
-    const isDir = isDirectory(filePath)
-
-    if (isDir) {
-        const exists = checkFullAccess(path.join(filePath, indexFile))
-        if (!exists) {
-            errorLog(`${indexFile} 文件不存在！`, debug)
-        }
-        debugDirname = filePath
-    } else {
-        const { base, dir } = path.parse(filePath)
-        if (base !== indexFile) {
-            errorLog(`${indexFile} 文件不存在！`, debug)
-        }
-        debugDirname = dir
-    }
-
-    try {
-        // eslint-disable-next-line
-        const fileExports = require(path.join(debugDirname, indexFile))
-        if (!fileExports[mainFunction]) {
-            errorLog(`handler 中的 ${mainFunction} 方法不存在，请检查你的配置！`, debug)
-        }
-    } catch (e) {
-        errorLog(`导入云函数异常:${e.message}`, debug)
-    }
-
-    // 读取本地 secret
-    const secret = await getSecret()
-    const debugArgs = getDebugArgs(port)
-    const args = debug ? [...debugArgs, bootstrapFilePath] : [bootstrapFilePath]
-
-    spawnNodeProcess(args, {
-        env: {
-            ...process.env,
-            SCF_NAMESPACE: envId,
-            SCF_FUNCTION_HANDLER: funcConfig?.handler || 'index.main',
-            SCF_FUNCTION_NAME: funcConfig?.name || 'main',
-            GLOBAL_USER_FILE_PATH: path.join(debugDirname, path.sep),
-            SCF_EVENT_BODY: params || JSON.stringify(funcConfig?.params || {}),
-            ...funcConfig?.envVariables,
-            ...secret
-        }
-    })
-}
-
-@ICommand()
-export class FunctionDebug extends Command {
-    get options() {
-        return {
-            cmd: 'fn',
-            childCmd: 'run',
-            deprecateCmd: 'functions:run',
-            options: [
-                {
-                    flags: '--path <path>',
-                    desc: '云函数路径，使用默认配置直接调用云函数，无需配置文件'
-                },
-                {
-                    flags: '--name <name>',
-                    desc: '指定云函数的名称进行调用，需要配置文件'
-                },
-                {
-                    flags: '--params <params>',
-                    desc: '调用函数传入的参数，JSON 字符串格式'
-                },
-                {
-                    flags: '--port <port>',
-                    desc: '启动调试时监听的端口号，默认为 9229'
-                },
-                {
-                    flags: '--debug',
-                    desc: '启动调试模式'
-                }
-            ],
-            desc: '本地运行云函数（当前仅支持 Node）'
-        }
-    }
-
-    @InjectParams()
-    async execute(@CmdContext() ctx) {
-        const { options } = ctx
-        const { path, name } = options
-        // 指定函数路径，以默认配置运行函数
-        if (path) {
-            await debugFunctionByPath(path, options)
-        } else if (typeof name === 'string') {
-            await debugByConfig(ctx, name)
-        } else {
-            throw new CloudBaseError(
-                '请指定运行函数的名称或函数的路径\n\n例如 cloudbase functions:run --name app'
-            )
-        }
-    }
-}

package/src/commands/functions/trigger-create.ts

@@ -1,79 +0,0 @@
-import inquirer from 'inquirer'
-import { Command, ICommand } from '../common'
-import { successLog } from '../../logger'
-import { CloudBaseError } from '../../error'
-import { createFunctionTriggers, batchCreateTriggers } from '../../function'
-import { InjectParams, CmdContext, ArgsParams } from '../../decorators'
-
-@ICommand()
-export class CreateTrigger extends Command {
-    get options() {
-        return {
-            cmd: 'fn',
-            childCmd: { cmd: 'trigger', desc: '函数触发器操作' },
-            childSubCmd: 'create [functionName]',
-            deprecateCmd: 'functions:trigger:create [functionName]',
-            options: [
-                {
-                    flags: '-e, --envId <envId>',
-                    desc: '环境 Id'
-                }
-            ],
-            desc: '创建云函数触发器'
-        }
-    }
-
-    @InjectParams()
-    async execute(@CmdContext() ctx, @ArgsParams() params) {
-        const {
-            envId,
-            config: { functions }
-        } = ctx
-
-        const name = params?.[0]
-
-        let isBatchCreateTrigger = false
-
-        // 不指定云函数名称，创建配置文件中所有函数的所有触发器
-        if (!name) {
-            const { isBatch } = await inquirer.prompt({
-                type: 'confirm',
-                name: 'isBatch',
-                message: '无云函数名称，是否需要部署配置文件中的【全部云函数】的全部触发器？',
-                default: false
-            })
-
-            isBatchCreateTrigger = isBatch
-
-            if (!isBatchCreateTrigger) {
-                throw new CloudBaseError('请指定云函数名称！')
-            }
-        }
-
-        if (isBatchCreateTrigger) {
-            return batchCreateTriggers({
-                envId,
-                functions
-            })
-        }
-
-        const functionItem = functions.find((item) => item.name === name)
-
-        if (!functionItem) {
-            throw new CloudBaseError('未找到相关函数配置，请检查函数名是否正确')
-        }
-
-        const { triggers } = functionItem
-
-        if (!triggers || !triggers.length) {
-            throw new CloudBaseError('触发器配置不能为空')
-        }
-
-        await createFunctionTriggers({
-            envId,
-            functionName: name,
-            triggers
-        })
-        successLog(`[${name}] 创建云函数触发器成功！`)
-    }
-}

package/src/commands/functions/trigger-delete.ts

@@ -1,105 +0,0 @@
-import inquirer from 'inquirer'
-import { Command, ICommand } from '../common'
-import { CloudBaseError } from '../../error'
-import { InjectParams, CmdContext, ArgsParams } from '../../decorators'
-import { batchDeleteTriggers, deleteFunctionTrigger } from '../../function'
-
-@ICommand()
-export class DeleteTrigger extends Command {
-    get options() {
-        return {
-            cmd: 'fn',
-            childCmd: { cmd: 'trigger', desc: '函数触发器操作' },
-            childSubCmd: 'delete [functionName] [triggerName]',
-            deprecateCmd: 'functions:trigger:delete [functionName] [triggerName]',
-            options: [
-                {
-                    flags: '-e, --envId <envId>',
-                    desc: '环境 Id'
-                }
-            ],
-            desc: '删除云函数触发器'
-        }
-    }
-
-    @InjectParams()
-    async execute(@CmdContext() ctx, @ArgsParams() params) {
-        const {
-            envId,
-            config: { functions }
-        } = ctx
-
-        const name = params?.[0]
-        const triggerName = params?.[1]
-
-        let isBatchDeleteTriggers
-        let isBatchDeleteFunctionTriggers = false
-
-        // 不指定云函数名称，删除配置文件中所有函数的所有触发器
-        if (!name) {
-            const answer = await inquirer.prompt({
-                type: 'confirm',
-                name: 'isBatch',
-                message: '无云函数名称，是否需要删除配置文件中的【全部云函数】的全部触发器？',
-                default: false
-            })
-
-            // 危险操作，再次确认
-            if (answer.isBatch) {
-                const { reConfirm } = await inquirer.prompt({
-                    type: 'confirm',
-                    name: 'reConfirm',
-                    message: '确定要删除配置文件中的【全部云函数】的全部触发器？',
-                    default: false
-                })
-                isBatchDeleteTriggers = reConfirm
-            }
-
-            if (!isBatchDeleteTriggers) {
-                throw new CloudBaseError('请指定云函数名称以及触发器名称！')
-            }
-        }
-
-        if (isBatchDeleteTriggers) {
-            return batchDeleteTriggers({
-                envId,
-                functions
-            })
-        }
-
-        // 指定了函数名称，但没有指定触发器名称，删除此函数的所有触发器
-        if (!triggerName && name) {
-            const { isBatch } = await inquirer.prompt({
-                type: 'confirm',
-                name: 'isBatch',
-                message: '没有指定触发器名称，是否需要此云函数的全部触发器？',
-                default: false
-            })
-
-            isBatchDeleteFunctionTriggers = isBatch
-
-            if (!isBatchDeleteFunctionTriggers) {
-                throw new CloudBaseError('请指定云函数名称以及触发器名称！')
-            }
-        }
-
-        if (isBatchDeleteFunctionTriggers) {
-            const func = functions.find((item) => item.name === name)
-            return batchDeleteTriggers({
-                envId,
-                functions: [func]
-            })
-        }
-
-        if (!triggerName) {
-            throw new CloudBaseError('触发器名称不能为空')
-        }
-
-        // 删除指定函数的单个触发器
-        await deleteFunctionTrigger({
-            envId,
-            functionName: name,
-            triggerName
-        })
-    }
-}

package/src/commands/functions/version/index.ts

@@ -1,2 +0,0 @@
-export * from './publish'
-export * from './list'

package/src/commands/functions/version/list.ts

@@ -1,73 +0,0 @@
-
-import { Command, ICommand } from '../../common'
-import { CloudBaseError } from '../../../error'
-import { loadingFactory, printHorizontalTable } from '../../../utils'
-import { listFunctionVersions } from '../../../function'
-import { InjectParams, CmdContext, ArgsParams, ArgsOptions } from '../../../decorators'
-import { StatusMap } from '../../../constant'
-
-
-@ICommand()
-export class ListFunctionVersion extends Command {
-    get options() {
-        return {
-            cmd: 'fn',
-            childCmd: 'list-function-versions <name>',
-            options: [
-                {
-                    flags: '-e, --envId <envId>',
-                    desc: '环境 Id'
-                },
-                { flags: '-l, --limit <limit>', desc: '返回数据长度，默认值为 20' },
-                {
-                    flags: '-o, --offset <offset>',
-                    desc: '数据偏移量，默认值为 0'
-                }
-            ],
-            desc: '展示函数版本列表'
-        }
-    }
-
-    @InjectParams()
-    async execute(@CmdContext() ctx, @ArgsParams() params, @ArgsOptions() options) {
-        const name = params?.[0]
-        let { limit = 20, offset = 0 } = options
-        limit = Number(limit)
-        offset = Number(offset)
-        if (!Number.isInteger(limit) || !Number.isInteger(offset)) {
-            throw new CloudBaseError('limit 和 offset 必须为整数')
-        }
-
-        if (limit < 0 || offset < 0) {
-            throw new CloudBaseError('limit 和 offset 必须为大于 0 的整数')
-        }
-
-        const {
-            envId
-        } = ctx
-
-        const loading = loadingFactory()
-        loading.start(`拉取函数 [${name}] 版本列表中...`)
-
-        const res = await listFunctionVersions({
-            envId,
-            functionName: name,
-            offset,
-            limit
-        })
-
-        loading.stop()
-
-        const head: string[] = ['版本', '描述', '创建时间', '修改时间', '状态']
-
-        const tableData = res.Versions.map((item) => [
-            item.Version,
-            item.Description,
-            item.AddTime,
-            item.ModTime,
-            StatusMap[item.Status]
-        ])
-
-        printHorizontalTable(head, tableData)
-    }
-}

package/src/commands/functions/version/publish.ts

@@ -1,43 +0,0 @@
-
-import { Command, ICommand } from '../../common'
-import { CloudBaseError } from '../../../error'
-import { loadingFactory } from '../../../utils'
-import { publishVersion } from '../../../function'
-import { InjectParams, CmdContext, ArgsParams } from '../../../decorators'
-
-@ICommand()
-export class PublishFunctionVersion extends Command {
-    get options() {
-        return {
-            cmd: 'fn',
-            childCmd: 'publish-version <name> [description]',
-            options: [
-                {
-                    flags: '-e, --envId <envId>',
-                    desc: '环境 Id'
-                }
-            ],
-            desc: '发布函数新版本'
-        }
-    }
-
-    @InjectParams()
-    async execute(@CmdContext() ctx, @ArgsParams() params) {
-        const name = params?.[0]
-        const description = params?.[1]
-        const {
-            envId
-        } = ctx
-
-        const loading = loadingFactory()
-        loading.start(`发布函数 [${name}] 新版本中...`)
-
-        await publishVersion({
-            envId,
-            functionName: name,
-            description
-        })
-
-        loading.succeed(`发布函数 [${name}] 新版本成功！`)
-    }
-}