Make @ensure work with classes
This commit is contained in:
parent
0c867e916e
commit
46a0a064d0
66
packages/jsonrpc/src/ensure.test.ts
Normal file
66
packages/jsonrpc/src/ensure.test.ts
Normal file
@ -0,0 +1,66 @@
|
|||||||
|
import {
|
||||||
|
ensure,
|
||||||
|
getValidatorsForMethod,
|
||||||
|
getValidatorsForInstance,
|
||||||
|
Validate,
|
||||||
|
} from './ensure'
|
||||||
|
|
||||||
|
describe('ensure', () => {
|
||||||
|
|
||||||
|
interface IContext {
|
||||||
|
userId: number
|
||||||
|
}
|
||||||
|
|
||||||
|
const validate: Validate<IContext> = c => c.userId > 0
|
||||||
|
|
||||||
|
it('decorates class methods', () => {
|
||||||
|
class Service {
|
||||||
|
@ensure<IContext>(validate)
|
||||||
|
// @ensureMethod<IContext>(validate)
|
||||||
|
fetchData() {
|
||||||
|
return 1
|
||||||
|
}
|
||||||
|
fetchData2() {
|
||||||
|
return 2
|
||||||
|
}
|
||||||
|
}
|
||||||
|
const s = new Service()
|
||||||
|
const validators1 = getValidatorsForMethod(s, 'fetchData')
|
||||||
|
const validators2 = getValidatorsForMethod(s, 'fetchData2')
|
||||||
|
expect(validators1).toEqual([ validate ])
|
||||||
|
expect(validators2).toEqual([])
|
||||||
|
})
|
||||||
|
|
||||||
|
it('decorates classes', () => {
|
||||||
|
@ensure(validate)
|
||||||
|
class Service {
|
||||||
|
fetchData() {
|
||||||
|
return 1
|
||||||
|
}
|
||||||
|
fetchData2() {
|
||||||
|
return 2
|
||||||
|
}
|
||||||
|
}
|
||||||
|
const s = new Service()
|
||||||
|
const validators = getValidatorsForInstance(s)
|
||||||
|
expect(validators).toEqual([ validate ])
|
||||||
|
})
|
||||||
|
|
||||||
|
it('works with subclasses', () => {
|
||||||
|
@ensure(validate)
|
||||||
|
class Service1 {
|
||||||
|
fetchData() {
|
||||||
|
return 1
|
||||||
|
}
|
||||||
|
}
|
||||||
|
class Service2 extends Service1 {
|
||||||
|
fetchData2() {
|
||||||
|
return 2
|
||||||
|
}
|
||||||
|
}
|
||||||
|
const s = new Service2()
|
||||||
|
const validators = getValidatorsForInstance(s)
|
||||||
|
expect(validators).toEqual([ validate ])
|
||||||
|
})
|
||||||
|
|
||||||
|
})
|
||||||
@ -1,12 +1,46 @@
|
|||||||
import 'reflect-metadata'
|
import 'reflect-metadata'
|
||||||
|
|
||||||
export const ensureKey = Symbol('ensure')
|
export const ensureKey = Symbol('ensure')
|
||||||
|
export const ensureClassKey = Symbol('ensureClass')
|
||||||
|
|
||||||
export type Validate<Context> = (context: Context) => boolean
|
export type Validate<Context> = (context: Context) => boolean
|
||||||
|
|
||||||
export function ensure<Context>(
|
export function ensure<Context>(
|
||||||
validate: Validate<Context>,
|
validate: Validate<Context>,
|
||||||
message: string = 'Validation failed',
|
message: string = 'Validation failed',
|
||||||
|
) {
|
||||||
|
return function ensureImpl(
|
||||||
|
target: any, key?: string, descriptor?: PropertyDescriptor) {
|
||||||
|
switch (arguments.length) {
|
||||||
|
case 1:
|
||||||
|
return ensureClass(validate, message).apply(null, arguments as any)
|
||||||
|
case 3:
|
||||||
|
return ensureMethod(validate, message).apply(null, arguments as any)
|
||||||
|
default:
|
||||||
|
throw new Error('Unexpected number of arguments for @ensure. ' +
|
||||||
|
'It can only be used as as class or method decorator')
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
function ensureClass<Context>(
|
||||||
|
validate: Validate<Context>,
|
||||||
|
message: string = 'Validation failed',
|
||||||
|
) {
|
||||||
|
// tslint:disable-next-line
|
||||||
|
return (target: any) => {
|
||||||
|
const validators: Array<Validate<Context>> =
|
||||||
|
getValidatorsForClass<Context>(target)
|
||||||
|
|
||||||
|
validators.push(validate)
|
||||||
|
|
||||||
|
Reflect.defineMetadata(ensureKey, validators, target)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
function ensureMethod<Context>(
|
||||||
|
validate: Validate<Context>,
|
||||||
|
message: string = 'Validation failed',
|
||||||
) {
|
) {
|
||||||
return (
|
return (
|
||||||
target: any,
|
target: any,
|
||||||
@ -23,6 +57,18 @@ export function ensure<Context>(
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
export function getValidatorsForInstance<Context>(
|
||||||
|
target: any,
|
||||||
|
): Array<Validate<Context>> {
|
||||||
|
return getValidatorsForClass(target.__proto__.constructor)
|
||||||
|
}
|
||||||
|
|
||||||
|
export function getValidatorsForClass<Context>(
|
||||||
|
target: any,
|
||||||
|
): Array<Validate<Context>> {
|
||||||
|
return Reflect.getMetadata(ensureKey, target) || []
|
||||||
|
}
|
||||||
|
|
||||||
export function getValidatorsForMethod<Context>(
|
export function getValidatorsForMethod<Context>(
|
||||||
target: any,
|
target: any,
|
||||||
method: string,
|
method: string,
|
||||||
|
|||||||
@ -2,7 +2,8 @@ export type TId = number | string
|
|||||||
import {ArgumentTypes, FunctionPropertyNames, RetType} from './types'
|
import {ArgumentTypes, FunctionPropertyNames, RetType} from './types'
|
||||||
import {isPromise} from './isPromise'
|
import {isPromise} from './isPromise'
|
||||||
import {createError, IErrorResponse, IErrorWithData} from './error'
|
import {createError, IErrorResponse, IErrorWithData} from './error'
|
||||||
import {getValidatorsForMethod} from './ensure'
|
import {getValidatorsForMethod, getValidatorsForInstance} from './ensure'
|
||||||
|
import {Validate} from './ensure'
|
||||||
|
|
||||||
export const ERROR_PARSE = {
|
export const ERROR_PARSE = {
|
||||||
code: -32700,
|
code: -32700,
|
||||||
@ -70,6 +71,31 @@ export function createSuccessResponse<T>(id: number | string, result: T)
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
function validateServiceContext<T, M extends FunctionPropertyNames<T>, Context>(
|
||||||
|
id: string | number | null,
|
||||||
|
service: T,
|
||||||
|
method: M,
|
||||||
|
context: Context,
|
||||||
|
) {
|
||||||
|
|
||||||
|
function doValidate(validate: Validate<Context>) {
|
||||||
|
const success = validate(context)
|
||||||
|
if (!success) {
|
||||||
|
throw createError(ERROR_INVALID_REQUEST, {
|
||||||
|
id,
|
||||||
|
data: null,
|
||||||
|
statusCode: 400,
|
||||||
|
})
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
getValidatorsForInstance<Context>(service)
|
||||||
|
.forEach(doValidate)
|
||||||
|
|
||||||
|
getValidatorsForMethod<Context>(service, method)
|
||||||
|
.forEach(doValidate)
|
||||||
|
}
|
||||||
|
|
||||||
export const createRpcService = <T, M extends FunctionPropertyNames<T>>(
|
export const createRpcService = <T, M extends FunctionPropertyNames<T>>(
|
||||||
service: T,
|
service: T,
|
||||||
methods: M[],
|
methods: M[],
|
||||||
@ -107,19 +133,7 @@ export const createRpcService = <T, M extends FunctionPropertyNames<T>>(
|
|||||||
})
|
})
|
||||||
}
|
}
|
||||||
|
|
||||||
const validators = getValidatorsForMethod<Context>(
|
validateServiceContext(id, service, method, context)
|
||||||
(service as any), method)
|
|
||||||
|
|
||||||
validators.forEach(validate => {
|
|
||||||
const success = validate(context)
|
|
||||||
if (!success) {
|
|
||||||
throw createError(ERROR_INVALID_REQUEST, {
|
|
||||||
id,
|
|
||||||
data: null,
|
|
||||||
statusCode: 400,
|
|
||||||
})
|
|
||||||
}
|
|
||||||
})
|
|
||||||
|
|
||||||
let retValue = (rpcService[method] as any)(...params, context)
|
let retValue = (rpcService[method] as any)(...params, context)
|
||||||
|
|
||||||
|
|||||||
Loading…
x
Reference in New Issue
Block a user