* test: skip bug test cases for ci passing * feat: add base structure of plugin-permissions * fix: user token parsing * Refactor action parameter for better mergeParams (#55) * refactor: add parameter types to handle parameters in action [WIP] * fix: action parameter * fix: test cases * test: try to fix build error * remove unused packages * fix: revert compatibility back Co-authored-by: chenos <chenlinxh@gmail.com> * 补充权限界面相关功能 * bugfix * fix: developer mode does not work * feat: add action scope and fields limitation in permission * 改进权限配置表单 * feat: get/update action for role.collection * add scope select component * add role users tabs * typings * test: temp skip Co-authored-by: chenos <chenlinxh@gmail.com>
309 lines
7.3 KiB
TypeScript
309 lines
7.3 KiB
TypeScript
import qs from 'qs';
|
||
import glob from 'glob';
|
||
import compose from 'koa-compose';
|
||
import Action, { ActionName } from './action';
|
||
import Resource, { ResourceOptions } from './resource';
|
||
import { parseRequest, getNameByParams, ParsedParams, requireModule, parseQuery } from './utils';
|
||
import { pathToRegexp } from 'path-to-regexp';
|
||
import _ from 'lodash';
|
||
|
||
export interface ResourcerContext {
|
||
resourcer?: Resourcer;
|
||
action?: Action;
|
||
params?: ParsedParams;
|
||
[key: string]: any;
|
||
}
|
||
|
||
export interface KoaMiddlewareOptions {
|
||
|
||
/**
|
||
* 前缀
|
||
*/
|
||
prefix?: string;
|
||
|
||
/**
|
||
* 自定义 resource name 的获取规则
|
||
*
|
||
* 默认规则 relatedTable ? relatedTable.table : table
|
||
*/
|
||
nameRule?: (params: ParsedParams) => string;
|
||
|
||
/**
|
||
* 上下文中的 key - ctx[paramsKey]
|
||
*
|
||
* 可以单独配置 paramsKey,默认为 params
|
||
*/
|
||
paramsKey?: string;
|
||
|
||
/**
|
||
* 自定义 action name
|
||
*
|
||
* 默认为
|
||
*
|
||
* - list 查看列表
|
||
* - create 新增数据
|
||
* - get 查看数据详情
|
||
* - update 更新数据
|
||
* - delete 删除数据
|
||
*/
|
||
accessors?: {
|
||
|
||
/**
|
||
* 查看列表
|
||
*/
|
||
list?: string;
|
||
|
||
/**
|
||
* 新增数据
|
||
*/
|
||
create?: string;
|
||
|
||
/**
|
||
* 查看数据详情
|
||
*/
|
||
get?: string;
|
||
|
||
/**
|
||
* 更新数据
|
||
*/
|
||
update?: string;
|
||
|
||
/**
|
||
* 删除数据
|
||
*/
|
||
delete?: string;
|
||
};
|
||
}
|
||
|
||
export interface ExecuteOptions {
|
||
|
||
/**
|
||
* 资源名称
|
||
*/
|
||
resource: string;
|
||
|
||
/**
|
||
* 自定义 action name
|
||
*
|
||
* 默认
|
||
* - list 查看列表
|
||
* - create 新增数据
|
||
* - get 查看数据详情
|
||
* - update 更新数据
|
||
* - delete 删除数据
|
||
*/
|
||
action: ActionName;
|
||
}
|
||
|
||
export type HandlerType = (ctx: ResourcerContext, next: () => Promise<any>) => any;
|
||
|
||
export interface Handlers {
|
||
[key: string]: HandlerType;
|
||
}
|
||
|
||
export interface ImportOptions {
|
||
|
||
/**
|
||
* 指定配置所在路径
|
||
*/
|
||
directory: string;
|
||
|
||
/**
|
||
* 文件后缀,默认值 ['js', 'ts', 'json']
|
||
*/
|
||
extensions?: string[];
|
||
}
|
||
|
||
export class Resourcer {
|
||
|
||
protected resources = new Map<string, Resource>();
|
||
|
||
/**
|
||
* 全局定义的 action handlers
|
||
*/
|
||
protected handlers = new Map<ActionName, any>();
|
||
|
||
protected actionHandlers = new Map<ActionName, any>();
|
||
|
||
protected middlewareHandlers = new Map<string, any>();
|
||
|
||
protected paramsKey = 'params';
|
||
|
||
protected middlewares = [];
|
||
|
||
/**
|
||
* 载入指定目录下的 resource 配置(配置的文件驱动)
|
||
*
|
||
* TODO: 配置的文件驱动现在会全部初始化,大数据时可能存在性能瓶颈,后续可以加入动态加载
|
||
*
|
||
* @param {object} [options]
|
||
* @param {string} [options.directory] 指定配置所在路径
|
||
* @param {array} [options.extensions = ['js', 'ts', 'json']] 文件后缀
|
||
*/
|
||
public import(options: ImportOptions): Map<string, Resource> {
|
||
const { extensions = ['js', 'ts', 'json'], directory } = options;
|
||
const patten = `${directory}/*.{${extensions.join(',')}}`;
|
||
const files = glob.sync(patten, {
|
||
ignore: [
|
||
'**/*.d.ts'
|
||
]
|
||
});
|
||
const resources = new Map<string, Resource>();
|
||
files.forEach((file: string) => {
|
||
const options = requireModule(file);
|
||
const table = this.define(typeof options === 'function' ? options(this) : options);
|
||
resources.set(table.getName(), table);
|
||
});
|
||
return resources;
|
||
}
|
||
|
||
/**
|
||
* resource 配置
|
||
*
|
||
* @param name
|
||
* @param options
|
||
*/
|
||
define(options: ResourceOptions) {
|
||
const { name } = options;
|
||
const resource = new Resource(options, this);
|
||
this.resources.set(name, resource);
|
||
return resource;
|
||
}
|
||
|
||
isDefined(name: string) {
|
||
return this.resources.has(name);
|
||
}
|
||
|
||
/**
|
||
* 注册全局的 action handlers
|
||
*
|
||
* @param handlers
|
||
*/
|
||
registerActionHandlers(handlers: Handlers) {
|
||
for (const [name, handler] of Object.entries(handlers)) {
|
||
this.registerActionHandler(name, handler);
|
||
}
|
||
}
|
||
|
||
registerActionHandler(name: ActionName, handler: HandlerType) {
|
||
this.actionHandlers.set(name, handler);
|
||
}
|
||
|
||
getRegisteredHandler(name: ActionName) {
|
||
return this.actionHandlers.get(name);
|
||
}
|
||
|
||
getRegisteredHandlers() {
|
||
return this.actionHandlers;
|
||
}
|
||
|
||
getResource(name: string): Resource {
|
||
if (!this.resources.has(name)) {
|
||
throw new Error(`${name} resource does not exist`);
|
||
}
|
||
return this.resources.get(name);
|
||
}
|
||
|
||
getAction(name: string, action: ActionName): Action {
|
||
// 支持注册局部 action
|
||
if (this.actionHandlers.has(`${name}:${action}`)) {
|
||
return this.getResource(name).getAction(`${name}:${action}`);
|
||
}
|
||
return this.getResource(name).getAction(action);
|
||
}
|
||
|
||
getParamsKey() {
|
||
return this.paramsKey;
|
||
}
|
||
|
||
getMiddlewares() {
|
||
return this.middlewares;
|
||
}
|
||
|
||
use(middlewares: HandlerType | HandlerType[]) {
|
||
if (typeof middlewares === 'function') {
|
||
this.middlewares.push(middlewares);
|
||
} else if (Array.isArray(middlewares)) {
|
||
this.middlewares.push(...middlewares);
|
||
}
|
||
}
|
||
|
||
middleware(options: KoaMiddlewareOptions = {}) {
|
||
const { prefix, accessors, paramsKey = 'params', nameRule = getNameByParams } = options;
|
||
return async (ctx: ResourcerContext, next: () => Promise<any>) => {
|
||
ctx.resourcer = this;
|
||
let params = parseRequest({
|
||
path: ctx.request.path,
|
||
method: ctx.request.method,
|
||
}, {
|
||
prefix,
|
||
accessors,
|
||
});
|
||
if (!params) {
|
||
return next();
|
||
}
|
||
try {
|
||
const resource = this.getResource(nameRule(params));
|
||
// 为关系资源时,暂时需要再执行一遍 parseRequest
|
||
if (resource.options.type !== 'single') {
|
||
params = parseRequest({
|
||
path: ctx.request.path,
|
||
method: ctx.request.method,
|
||
type: resource.options.type,
|
||
}, {
|
||
prefix,
|
||
accessors,
|
||
});
|
||
if (!params) {
|
||
return next();
|
||
}
|
||
}
|
||
// action 需要 clone 之后再赋给 ctx
|
||
ctx.action = this.getAction(nameRule(params), params.actionName).clone();
|
||
ctx.action.setContext(ctx);
|
||
const query = parseQuery(ctx.request.querystring);
|
||
// 兼容 ctx.params 的处理,之后的版本里会去掉
|
||
ctx[paramsKey] = {
|
||
table: params.resourceName,
|
||
tableKey: params.resourceKey,
|
||
relatedTable: params.associatedName,
|
||
relatedKey: params.resourceKey,
|
||
action: params.actionName,
|
||
};
|
||
if (pathToRegexp('/resourcer/{:associatedName.}?:resourceName{\\::actionName}').test(ctx.request.path)) {
|
||
await ctx.action.mergeParams({
|
||
...query,
|
||
...params,
|
||
...ctx.request.body,
|
||
});
|
||
} else {
|
||
await ctx.action.mergeParams({
|
||
...query,
|
||
...params,
|
||
...(_.isEmpty(ctx.request.body) ? {} : { values: ctx.request.body }),
|
||
});
|
||
}
|
||
return compose(ctx.action.getHandlers())(ctx, next);
|
||
} catch (error) {
|
||
return next();
|
||
}
|
||
}
|
||
}
|
||
|
||
/**
|
||
* 实验性 API
|
||
*
|
||
* @param options
|
||
* @param context
|
||
* @param next
|
||
*/
|
||
async execute(options: ExecuteOptions, context: ResourcerContext = {}, next?: any) {
|
||
const { resource, action } = options;
|
||
context.resourcer = this;
|
||
context.action = this.getAction(resource, action);
|
||
return await context.action.execute(context, next);
|
||
}
|
||
}
|
||
|
||
export default Resourcer;
|