Files
core/src/modules/serverless/serverless.service.ts
2022-03-27 18:25:23 +08:00

435 lines
12 KiB
TypeScript

import { isURL } from 'class-validator'
import fs, { mkdir, stat } from 'fs/promises'
import { cloneDeep } from 'lodash'
import path from 'path'
import { nextTick } from 'process'
import { TransformOptions, parseAsync, transformAsync } from '@babel/core'
import * as t from '@babel/types'
import { VariableDeclaration } from '@babel/types'
import {
Injectable,
InternalServerErrorException,
Logger,
} from '@nestjs/common'
import { Interval } from '@nestjs/schedule'
import { RedisKeys } from '~/constants/cache.constant'
import { DATA_DIR, NODE_REQUIRE_PATH } from '~/constants/path.constant'
import { CacheService } from '~/processors/cache/cache.service'
import { DatabaseService } from '~/processors/database/database.service'
import { AssetService } from '~/processors/helper/helper.asset.service'
import { HttpService } from '~/processors/helper/helper.http.service'
import { InjectModel } from '~/transformers/model.transformer'
import { UniqueArray } from '~/ts-hepler/unique'
import { getRedisKey, safePathJoin } from '~/utils'
import { safeEval } from '~/utils/safe-eval.util'
import { isBuiltinModule } from '~/utils/sys.util'
import PKG from '../../../package.json'
import { SnippetModel } from '../snippet/snippet.model'
import {
FunctionContextRequest,
FunctionContextResponse,
} from './function.types'
@Injectable()
export class ServerlessService {
constructor(
@InjectModel(SnippetModel)
private readonly snippetModel: MongooseModel<SnippetModel>,
private readonly assetService: AssetService,
private readonly httpService: HttpService,
private readonly databaseService: DatabaseService,
private readonly cacheService: CacheService,
) {
nextTick(() => {
// Add /includes/plugin to the path, also note that we need to support
// `require('../hello.js')`. We can do that by adding /includes/plugin/a,
// /includes/plugin/a/b, etc.. to the list
mkdir(NODE_REQUIRE_PATH, { recursive: true }).then(async () => {
const pkgPath = path.join(NODE_REQUIRE_PATH, 'package.json')
const isPackageFileExist = await stat(pkgPath)
.then(() => true)
.catch(() => false)
if (!isPackageFileExist) {
await fs.writeFile(
pkgPath,
JSON.stringify({ name: 'modules' }, null, 2),
)
}
})
module.paths.push(NODE_REQUIRE_PATH)
// if (isDev) {
// console.log(module.paths)
// }
})
}
public get model() {
return this.snippetModel
}
async injectContextIntoServerlessFunctionAndCall(
model: SnippetModel,
context: { req: FunctionContextRequest; res: FunctionContextResponse },
) {
const { raw: functionString } = model
const logger = new Logger(`ServerlessFunction/${model.name}`)
const document = await this.model.findById(model.id)
const globalContext = {
context: {
// inject app req, res
...context,
...context.res,
query: context.req.query,
headers: context.req.headers,
// TODO wildcard params
params: Object.assign({}, context.req.params),
storage: {
cache: {
get: async (key: string) => {
const client = this.cacheService.getClient()
return await client.hget(
getRedisKey(RedisKeys.ServerlessStorage),
key,
)
},
set: async (key: string, value: object | string) => {
const client = this.cacheService.getClient()
return await client.hset(
getRedisKey(RedisKeys.ServerlessStorage),
key,
typeof value === 'string' ? value : JSON.stringify(value),
)
},
del: async (key: string) => {
const client = this.cacheService.getClient()
return await client.hdel(
getRedisKey(RedisKeys.ServerlessStorage),
key,
)
},
},
db: {},
},
model,
document,
name: model.name,
reference: model.reference,
getMaster: async () => {
const collection = this.databaseService.db.collection('users')
const cur = collection.aggregate([
{
$project: {
id: 1,
_id: 1,
username: 1,
name: 1,
introduce: 1,
avatar: 1,
mail: 1,
url: 1,
lastLoginTime: 1,
lastLoginIp: 1,
socialIds: 1,
},
},
])
return await cur.next().then((doc) => {
cur.close()
return doc
})
},
writeAsset: async (
path: string,
data: any,
options: Parameters<typeof fs.writeFile>[2],
) => {
return await this.assetService.writeUserCustomAsset(
safePathJoin(path),
data,
options,
)
},
readAsset: async (
path: string,
options: Parameters<typeof fs.readFile>[1],
) => {
return await this.assetService.getAsset(safePathJoin(path), options)
},
},
// inject global
__dirname: DATA_DIR,
__filename: '',
// inject some zx utils
fetch,
// inject Global API
Buffer,
// inject logger
console: logger,
logger,
require: this.inNewContextRequire(),
get import() {
return this.require
},
process: {
env: Object.freeze({ ...process.env }),
nextTick: process.nextTick,
},
}
return await safeEval(
`async function func() {
${await this.convertTypescriptCode(
functionString,
)}; return handler(context, require)
}
return func()
`,
{
...globalContext,
global: globalContext,
globalThis: globalContext,
exports: {},
module: {
exports: {},
},
},
)
}
private getBabelOptions(): TransformOptions {
return {
plugins: [
require('@babel/plugin-transform-typescript'),
[
require('@babel/plugin-transform-modules-commonjs'),
{ allowTopLevelThis: false, importInterop: 'node' },
],
function transformImport() {
return {
visitor: {
VariableDeclaration(path: babel.NodePath) {
const node = path.node as VariableDeclaration
if (
node.kind === 'var' &&
node.declarations[0].init?.type === 'CallExpression' &&
(
(node.declarations[0].init as t.CallExpression)
.callee as t.Identifier
)?.name === 'require'
) {
const callee = node.declarations[0].init
const _await: t.AwaitExpression = {
argument: node.declarations[0].init,
type: 'AwaitExpression',
start: callee.start,
end: callee.end,
innerComments: [],
loc: callee.loc,
leadingComments: [],
trailingComments: [],
}
node.declarations[0].init = _await
}
},
},
}
},
],
}
}
private convertTypescriptCode(code: string) {
return transformAsync(code, this.getBabelOptions()).then((res) => {
if (!res) {
throw new InternalServerErrorException('convert code error')
}
if (isDev) {
console.log(res.code)
}
return res.code
})
}
private requireModuleIdSet = new Set<string>()
@Interval(5 * 60 * 1000)
private cleanRequireCache() {
Array.from(this.requireModuleIdSet.values()).forEach((id) => {
delete require.cache[id]
})
this.requireModuleIdSet.clear()
}
private inNewContextRequire() {
const __require = (id: string) => {
const module = require(id)
// eslint-disable-next-line no-empty
if (Object.keys(PKG.dependencies).includes(id) || isBuiltinModule(id)) {
} else {
this.requireModuleIdSet.add(require.resolve(id))
}
const clonedModule = cloneDeep(module)
return typeof module === 'function'
? (() => {
const newFunc = module.bind()
Object.setPrototypeOf(newFunc, clonedModule)
return newFunc
})()
: clonedModule
}
const __requireNoCache = (id: string) => {
delete require.cache[require.resolve(id)]
const clonedModule = __require(id)
return clonedModule
}
async function $require(
this: ServerlessService,
id: string,
useCache = true,
) {
if (!id || typeof id !== 'string') {
throw new Error('require id is not valid')
}
// 1. if is remote module
if (isURL(id, { protocols: ['http', 'https'], require_protocol: true })) {
let text: string
try {
text = useCache
? await this.httpService.getAndCacheRequest(id)
: await this.httpService.axiosRef.get(id).then((res) => res.data)
} catch (err) {
throw new InternalServerErrorException(
'Failed to fetch remote module',
)
}
return await safeEval(
`${text}; return module.exports ? module.exports : exports.default ? exports.default : exports`,
{
exports: {},
module: {
exports: null,
},
},
)
}
// 2. if application third part lib
const allowedThirdPartLibs: UniqueArray<
(keyof typeof PKG.dependencies)[]
> = [
'@babel/core',
'@babel/types',
'@babel/plugin-transform-typescript',
'class-validator-jsonschema',
'@nestjs/event-emitter',
'algoliasearch',
'axios-retry',
'axios',
'class-transformer',
'class-validator',
'dayjs',
'ejs',
'html-minifier',
'image-size',
'isbot',
'js-yaml',
'jsdom',
'jszip',
'lodash',
'marked',
'nanoid',
'qs',
'rxjs',
'snakecase-keys',
'ua-parser-js',
'xss',
]
const trustPackagePrefixes = ['@innei/', '@mx-space/', 'mx-function-']
if (
allowedThirdPartLibs.includes(id as any) ||
trustPackagePrefixes.some((prefix) => id.startsWith(prefix))
) {
return useCache ? __require(id) : __requireNoCache(id)
}
// 3. mock built-in module
// const mockModules = {
// fs: {
// writeFile: globalContext.context.writeAsset,
// readFile: globalContext.context.readAsset,
// },
// }
// if (Object.keys(mockModules).includes(id)) {
// return mockModules[id]
// }
// fin. is built-in module
const module = isBuiltinModule(id, [
'fs',
'os',
'child_process',
'sys',
'process',
'vm',
'v8',
'cluster',
'fs/promises',
])
if (!module) {
throw new Error(`cannot require ${id}`)
} else {
return __require(id)
}
}
return $require.bind(this)
}
async isValidServerlessFunction(raw: string) {
try {
// 验证 handler 是否存在并且是函数
const ast = (await parseAsync(raw, this.getBabelOptions())) as t.File
const { body } = ast.program as t.Program
const hasEntryFunction = body.some(
(node) => t.isFunction(node) && node.id && node.id.name === 'handler',
)
return hasEntryFunction
} catch (e) {
if (isDev) {
console.error(e.message)
}
return e.message?.split('\n').at(0)
}
}
}