From af632ea47115335513bbbe8a10523ed33e94ff70 Mon Sep 17 00:00:00 2001 From: Morb0 Date: Sun, 3 Jan 2021 01:30:57 +0300 Subject: [PATCH 01/19] feat!(): add custom execution context --- TODO.md | 10 + lib/context/filters-context-creator.ts | 38 +++ lib/context/telegraf-context-creator.ts | 278 ++++++++++++++++++ lib/context/telegraf-proxy.ts | 38 +++ lib/decorators/index.ts | 1 + lib/decorators/listeners/action.decorator.ts | 2 +- lib/decorators/listeners/cashtag.decorator.ts | 2 +- lib/decorators/listeners/command.decorator.ts | 2 +- lib/decorators/listeners/email.decorator.ts | 2 +- .../listeners/game-query.decorator.ts | 2 +- lib/decorators/listeners/hashtag.decorator.ts | 2 +- lib/decorators/listeners/hears.decorator.ts | 2 +- lib/decorators/listeners/help.decorator.ts | 2 +- .../listeners/inline-query.decorator.ts | 2 +- lib/decorators/listeners/mention.decorator.ts | 2 +- lib/decorators/listeners/on.decorator.ts | 2 +- lib/decorators/listeners/phone.decorator.ts | 2 +- .../listeners/settings.decorator.ts | 2 +- lib/decorators/listeners/start.decorator.ts | 2 +- .../listeners/text-link.decorator.ts | 2 +- .../listeners/text-mention.decorator.ts | 2 +- lib/decorators/listeners/url.decorator.ts | 2 +- lib/decorators/listeners/use.decorator.ts | 2 +- lib/decorators/params/context.decorator.ts | 8 + lib/decorators/params/index.ts | 3 + .../params/message-text.decorator.ts | 15 + lib/decorators/params/next.decorator.ts | 6 + lib/decorators/scene/scene-enter.decorator.ts | 2 +- lib/decorators/scene/scene-leave.decorator.ts | 2 +- lib/enums/telegraf-paramtype.enum.ts | 8 + lib/errors/index.ts | 1 + lib/errors/telegraf.exception.ts | 24 ++ .../base-telegraf-exception-filter.ts | 34 +++ lib/exceptions/index.ts | 1 + lib/exceptions/telegraf-exceptions-handler.ts | 48 +++ lib/execution-context/index.ts | 3 + .../telegraf-arguments-host.ts | 22 ++ .../telegraf-execution-context.ts | 32 ++ .../tg-arguments-host.interace.ts | 6 + lib/explorers/telegraf-update.explorer.ts | 130 ++++++-- lib/factories/telegraf-params-factory.ts | 23 ++ lib/helpers/index.ts | 2 - lib/helpers/is-error-object.helper.ts | 5 + lib/helpers/is-observable.helper.ts | 5 + lib/index.ts | 4 +- .../telegraf-exception-filter.interface.ts | 5 + lib/telegraf.constants.ts | 8 + .../create-scene-listener-decorator.util.ts} | 0 .../create-update-listener-decorator.util.ts} | 0 lib/utils/index.ts | 2 + lib/utils/param-decorator.util.ts | 39 +++ sample/app.module.ts | 4 +- sample/app.update.ts | 43 ++- sample/common/decorators/from.decorator.ts | 7 + .../filters/telegraf-exception.filter.ts | 11 + sample/common/guards/admin.guard.ts | 21 ++ .../interceptors/response-time.interceptor.ts | 20 ++ .../middleware/session.middleware.ts | 0 sample/common/pipes/reverse-text.pipe.ts | 8 + tsconfig.json | 2 +- website/docs/api-reference/decorators.md | 1 + website/docs/bot-injection.md | 5 +- website/docs/telegraf-methods.md | 2 +- website/docs/webhooks.md | 5 +- 64 files changed, 899 insertions(+), 69 deletions(-) create mode 100644 TODO.md create mode 100644 lib/context/filters-context-creator.ts create mode 100644 lib/context/telegraf-context-creator.ts create mode 100644 lib/context/telegraf-proxy.ts create mode 100644 lib/decorators/params/context.decorator.ts create mode 100644 lib/decorators/params/index.ts create mode 100644 lib/decorators/params/message-text.decorator.ts create mode 100644 lib/decorators/params/next.decorator.ts create mode 100644 lib/enums/telegraf-paramtype.enum.ts create mode 100644 lib/errors/index.ts create mode 100644 lib/errors/telegraf.exception.ts create mode 100644 lib/exceptions/base-telegraf-exception-filter.ts create mode 100644 lib/exceptions/index.ts create mode 100644 lib/exceptions/telegraf-exceptions-handler.ts create mode 100644 lib/execution-context/index.ts create mode 100644 lib/execution-context/telegraf-arguments-host.ts create mode 100644 lib/execution-context/telegraf-execution-context.ts create mode 100644 lib/execution-context/tg-arguments-host.interace.ts create mode 100644 lib/factories/telegraf-params-factory.ts delete mode 100644 lib/helpers/index.ts create mode 100644 lib/helpers/is-error-object.helper.ts create mode 100644 lib/helpers/is-observable.helper.ts create mode 100644 lib/interfaces/telegraf-exception-filter.interface.ts rename lib/{helpers/create-scene-listener-decorator.helper.ts => utils/create-scene-listener-decorator.util.ts} (100%) rename lib/{helpers/create-update-listener-decorator.helper.ts => utils/create-update-listener-decorator.util.ts} (100%) create mode 100644 lib/utils/index.ts create mode 100644 lib/utils/param-decorator.util.ts create mode 100644 sample/common/decorators/from.decorator.ts create mode 100644 sample/common/filters/telegraf-exception.filter.ts create mode 100644 sample/common/guards/admin.guard.ts create mode 100644 sample/common/interceptors/response-time.interceptor.ts rename sample/{ => common}/middleware/session.middleware.ts (100%) create mode 100644 sample/common/pipes/reverse-text.pipe.ts diff --git a/TODO.md b/TODO.md new file mode 100644 index 0000000..4d12bdc --- /dev/null +++ b/TODO.md @@ -0,0 +1,10 @@ +PR TODO List: + * [ ] Include scene support to one explorer + * [ ] Split explorer to more sense components + * [ ] Refactor new execution context code + * [ ] Add support for new return types (files, images, music, git, etc) + * [ ] Add more param decorators (only often used) + * [ ] Review exception filter + * [ ] Add custom error messages (now used "Internal Server Error") + * [ ] Allow disabling default error send to chat + * [ ] Test all components diff --git a/lib/context/filters-context-creator.ts b/lib/context/filters-context-creator.ts new file mode 100644 index 0000000..eb45b81 --- /dev/null +++ b/lib/context/filters-context-creator.ts @@ -0,0 +1,38 @@ +import { NestContainer } from '@nestjs/core'; +import { BaseExceptionFilterContext } from '@nestjs/core/exceptions/base-exception-filter-context'; +import { EXCEPTION_FILTERS_METADATA } from '@nestjs/common/constants'; +import { isEmpty } from '@nestjs/common/utils/shared.utils'; +import { TelegrafExceptionsHandler } from '../exceptions/telegraf-exceptions-handler'; + +export class FiltersContextCreator extends BaseExceptionFilterContext { + constructor(container: NestContainer) { + super(container); + } + + public create( + instance: object, + callback: (...args: any[]) => void, + moduleKey: string, + ): TelegrafExceptionsHandler { + this.moduleContext = moduleKey; + + const exceptionHandler = new TelegrafExceptionsHandler(); + const filters = this.createContext( + instance, + callback, + EXCEPTION_FILTERS_METADATA, + ); + + if (isEmpty(filters)) { + return exceptionHandler; + } + + exceptionHandler.setCustomFilters(filters.reverse()); + + return exceptionHandler; + } + + public getGlobalMetadata(): T { + return [] as T; + } +} diff --git a/lib/context/telegraf-context-creator.ts b/lib/context/telegraf-context-creator.ts new file mode 100644 index 0000000..2066dfb --- /dev/null +++ b/lib/context/telegraf-context-creator.ts @@ -0,0 +1,278 @@ +import { Controller, PipeTransform } from '@nestjs/common/interfaces'; +import { PipesContextCreator } from '@nestjs/core/pipes/pipes-context-creator'; +import { PipesConsumer } from '@nestjs/core/pipes/pipes-consumer'; +import { GuardsContextCreator } from '@nestjs/core/guards/guards-context-creator'; +import { GuardsConsumer } from '@nestjs/core/guards/guards-consumer'; +import { InterceptorsContextCreator } from '@nestjs/core/interceptors/interceptors-context-creator'; +import { InterceptorsConsumer } from '@nestjs/core/interceptors/interceptors-consumer'; +import { + ContextUtils, + ParamProperties, +} from '@nestjs/core/helpers/context-utils'; +import { HandlerMetadataStorage } from '@nestjs/core/helpers/handler-metadata-storage'; +import { FORBIDDEN_MESSAGE } from '@nestjs/core/guards/constants'; +import { ParamsMetadata } from '@nestjs/core/helpers/interfaces'; +import { ExecutionContextHost } from '@nestjs/core/helpers/execution-context-host'; + +import { FiltersContextCreator } from './filters-context-creator'; +import { TelegrafContextType } from '../execution-context/telegraf-execution-context'; +import { TelegrafProxy } from './telegraf-proxy'; +import { TelegrafException } from '../errors'; +import { + CUSTOM_LISTENER_AGRS_METADATA, + LISTENER_ARGS_METADATA, +} from '../telegraf.constants'; +import { TelegrafParamsFactory } from '../factories/telegraf-params-factory'; +import { isEmpty } from '@nestjs/common/utils/shared.utils'; + +export type Update = Controller; +type TelegrafParamProperties = ParamProperties & { metatype?: any }; + +export interface TelegrafHandlerMetadata { + argsLength: number; + paramtypes: any[]; + getParamsMetadata: (moduleKey: string) => TelegrafParamProperties[]; +} + +export class TelegrafContextCreator { + private readonly contextUtils = new ContextUtils(); + private readonly telegrafParamsFactory = new TelegrafParamsFactory(); + private readonly handlerMetadataStorage = new HandlerMetadataStorage(); + + constructor( + private readonly telegrafProxy: TelegrafProxy, + private readonly exceptionFiltersContext: FiltersContextCreator, + private readonly pipesContextCreator: PipesContextCreator, + private readonly pipesConsumer: PipesConsumer, + private readonly guardsContextCreator: GuardsContextCreator, + private readonly guardsConsumer: GuardsConsumer, + private readonly interceptorsContextCreator: InterceptorsContextCreator, + private readonly interceptorsConsumer: InterceptorsConsumer, + ) {} + + public create( + instance: Update, + methodRef: (...args: unknown[]) => void, + moduleName: string, + methodKey: string, + ): (...args: any[]) => Promise { + const contextType: TelegrafContextType = 'telegraf'; + const { argsLength, paramtypes, getParamsMetadata } = this.getMetadata( + instance, + methodKey, + contextType, + ); + + const exceptionHandler = this.exceptionFiltersContext.create( + instance, + methodRef, + moduleName, + ); + + const pipes = this.pipesContextCreator.create( + instance, + methodRef, + moduleName, + ); + + const guards = this.guardsContextCreator.create( + instance, + methodRef, + moduleName, + ); + + const interceptors = this.interceptorsContextCreator.create( + instance, + methodRef, + moduleName, + ); + + const paramsMetadata = getParamsMetadata(moduleName); + const paramsOptions = paramsMetadata + ? this.contextUtils.mergeParamsMetatypes(paramsMetadata, paramtypes) + : []; + const fnApplyPipes = this.createPipesFn(pipes, paramsOptions); + + const fnCanActivate = this.createGuardsFn( + guards, + instance, + methodRef, + contextType, + ); + + const handler = ( + initialArgs: unknown[], + ctx: TContext, + next: Function, + ) => async () => { + if (fnApplyPipes) { + await fnApplyPipes(initialArgs, ctx, next); + return methodRef.apply(instance, initialArgs); + } + return methodRef.apply(instance, [ctx, next]); + }; + + const targetCallback = async (ctx: TContext, next: Function) => { + const initialArgs = this.contextUtils.createNullArray(argsLength); + fnCanActivate && (await fnCanActivate([ctx, next])); + + return this.interceptorsConsumer.intercept( + interceptors, + [ctx, next], + instance, + methodRef, + handler(initialArgs, ctx, next), + contextType, + ); + }; + + return this.telegrafProxy.create(targetCallback, exceptionHandler); + } + + public getMetadata< + TMetadata, + TContext extends TelegrafContextType = TelegrafContextType + >( + instance: Controller, + methodName: string, + contextType: TContext, + ): TelegrafHandlerMetadata { + const cachedMetadata = this.handlerMetadataStorage.get( + instance, + methodName, + ); + if (cachedMetadata) return cachedMetadata; + + const metadata = + this.contextUtils.reflectCallbackMetadata( + instance, + methodName, + LISTENER_ARGS_METADATA, + ) || {}; + + const keys = Object.keys(metadata); + const argsLength = this.contextUtils.getArgumentsLength(keys, metadata); + const contextFactory = this.contextUtils.getContextFactory( + contextType, + instance, + instance[methodName], + ); + const getParamsMetadata = (moduleKey: string) => + this.exchangeKeysForValues( + keys, + metadata, + moduleKey, + this.telegrafParamsFactory, + contextFactory, + ); + + const paramtypes = this.contextUtils.reflectCallbackParamtypes( + instance, + methodName, + ); + const handlerMetadata: TelegrafHandlerMetadata = { + argsLength, + paramtypes, + getParamsMetadata, + }; + this.handlerMetadataStorage.set(instance, methodName, handlerMetadata); + return handlerMetadata; + } + + public exchangeKeysForValues( + keys: string[], + metadata: TMetadata, + moduleContext: string, + paramsFactory: TelegrafParamsFactory, + contextFactory: (args: unknown[]) => ExecutionContextHost, + ): ParamProperties[] { + this.pipesContextCreator.setModuleContext(moduleContext); + + return keys.map((key) => { + const { index, data, pipes: pipesCollection } = metadata[key]; + const pipes = this.pipesContextCreator.createConcreteContext( + pipesCollection, + ); + const type = this.contextUtils.mapParamType(key); + + if (key.includes(CUSTOM_LISTENER_AGRS_METADATA)) { + const { factory } = metadata[key]; + const customExtractValue = this.contextUtils.getCustomFactory( + factory, + data, + contextFactory, + ); + return { index, extractValue: customExtractValue, type, data, pipes }; + } + const numericType = Number(type); + const extractValue = (ctx: TContext, next: Function) => + paramsFactory.exchangeKeyForValue(numericType, ctx, next); + + return { index, extractValue, type: numericType, data, pipes }; + }); + } + + public createGuardsFn( + guards: any[], + instance: Controller, + callback: (...args: unknown[]) => any, + contextType?: TContext, + ): Function | null { + const canActivateFn = async (args: any[]) => { + const canActivate = await this.guardsConsumer.tryActivate( + guards, + args, + instance, + callback, + contextType, + ); + if (!canActivate) { + throw new TelegrafException(FORBIDDEN_MESSAGE); + } + }; + return guards.length ? canActivateFn : null; + } + + public createPipesFn( + pipes: PipeTransform[], + paramsOptions: (ParamProperties & { metatype?: unknown })[], + ) { + const pipesFn = async ( + args: unknown[], + ctx: TContext, + next: Function, + ) => { + const resolveParamValue = async ( + param: ParamProperties & { metatype?: unknown }, + ) => { + const { + index, + extractValue, + type, + data, + metatype, + pipes: paramPipes, + } = param; + const value = extractValue(ctx, next); + + args[index] = await this.getParamValue( + value, + { metatype, type, data }, + pipes.concat(paramPipes), + ); + }; + await Promise.all(paramsOptions.map(resolveParamValue)); + }; + return paramsOptions.length ? pipesFn : null; + } + + public async getParamValue( + value: T, + { metatype, type, data }: { metatype: any; type: any; data: any }, + pipes: PipeTransform[], + ): Promise { + return isEmpty(pipes) + ? value + : this.pipesConsumer.apply(value, { metatype, type, data }, pipes); + } +} diff --git a/lib/context/telegraf-proxy.ts b/lib/context/telegraf-proxy.ts new file mode 100644 index 0000000..448d0c4 --- /dev/null +++ b/lib/context/telegraf-proxy.ts @@ -0,0 +1,38 @@ +import { ExecutionContextHost } from '@nestjs/core/helpers/execution-context-host'; +import { catchError } from 'rxjs/operators'; +import { EMPTY } from 'rxjs'; +import { isObservable } from '../helpers/is-observable.helper'; +import { TelegrafExceptionsHandler } from '../exceptions/telegraf-exceptions-handler'; + +export class TelegrafProxy { + public create( + targetCallback: (ctx: TContext, next: Function) => Promise, + exceptionsHandler: TelegrafExceptionsHandler, + ): (ctx: TContext, next: Function) => Promise { + return async (ctx: TContext, next: Function) => { + try { + const result = await targetCallback(ctx, next); + return !isObservable(result) + ? result + : result.pipe( + catchError((error) => { + this.handleError(exceptionsHandler, [ctx, next], error); + return EMPTY; + }), + ); + } catch (error) { + this.handleError(exceptionsHandler, [ctx, next], error); + } + }; + } + + handleError( + exceptionsHandler: TelegrafExceptionsHandler, + args: unknown[], + error: T, + ): void { + const host = new ExecutionContextHost(args); + host.setType('telegraf'); + exceptionsHandler.handle(error, host); + } +} diff --git a/lib/decorators/index.ts b/lib/decorators/index.ts index 31fa986..ee4e5a9 100644 --- a/lib/decorators/index.ts +++ b/lib/decorators/index.ts @@ -1,3 +1,4 @@ export * from './core'; export * from './listeners'; export * from './scene'; +export * from './params'; diff --git a/lib/decorators/listeners/action.decorator.ts b/lib/decorators/listeners/action.decorator.ts index 4b14901..0a3ad3b 100644 --- a/lib/decorators/listeners/action.decorator.ts +++ b/lib/decorators/listeners/action.decorator.ts @@ -1,4 +1,4 @@ -import { createUpdateListenerDecorator } from '../../helpers'; +import { createUpdateListenerDecorator } from '../../utils'; /** * Registers middleware for handling callback_data actions with regular expressions. diff --git a/lib/decorators/listeners/cashtag.decorator.ts b/lib/decorators/listeners/cashtag.decorator.ts index c3e37e9..f726b78 100644 --- a/lib/decorators/listeners/cashtag.decorator.ts +++ b/lib/decorators/listeners/cashtag.decorator.ts @@ -1,4 +1,4 @@ -import { createUpdateListenerDecorator } from '../../helpers'; +import { createUpdateListenerDecorator } from '../../utils'; /** * Cashtag handling. diff --git a/lib/decorators/listeners/command.decorator.ts b/lib/decorators/listeners/command.decorator.ts index 0e7806e..5234a4c 100644 --- a/lib/decorators/listeners/command.decorator.ts +++ b/lib/decorators/listeners/command.decorator.ts @@ -1,4 +1,4 @@ -import { createUpdateListenerDecorator } from '../../helpers'; +import { createUpdateListenerDecorator } from '../../utils'; /** * Command handling. diff --git a/lib/decorators/listeners/email.decorator.ts b/lib/decorators/listeners/email.decorator.ts index e9bb1a6..a22023a 100644 --- a/lib/decorators/listeners/email.decorator.ts +++ b/lib/decorators/listeners/email.decorator.ts @@ -1,4 +1,4 @@ -import { createUpdateListenerDecorator } from '../../helpers'; +import { createUpdateListenerDecorator } from '../../utils'; /** * Registers middleware for handling messages with email entity. diff --git a/lib/decorators/listeners/game-query.decorator.ts b/lib/decorators/listeners/game-query.decorator.ts index 347f998..911a34f 100644 --- a/lib/decorators/listeners/game-query.decorator.ts +++ b/lib/decorators/listeners/game-query.decorator.ts @@ -1,4 +1,4 @@ -import { createUpdateListenerDecorator } from '../../helpers'; +import { createUpdateListenerDecorator } from '../../utils'; /** * Registers middleware for handling callback_data actions with game query. diff --git a/lib/decorators/listeners/hashtag.decorator.ts b/lib/decorators/listeners/hashtag.decorator.ts index 86e9e13..e89d7a6 100644 --- a/lib/decorators/listeners/hashtag.decorator.ts +++ b/lib/decorators/listeners/hashtag.decorator.ts @@ -1,4 +1,4 @@ -import { createUpdateListenerDecorator } from '../../helpers'; +import { createUpdateListenerDecorator } from '../../utils'; /** * Hashtag handling. diff --git a/lib/decorators/listeners/hears.decorator.ts b/lib/decorators/listeners/hears.decorator.ts index 79d71af..425f37c 100644 --- a/lib/decorators/listeners/hears.decorator.ts +++ b/lib/decorators/listeners/hears.decorator.ts @@ -1,4 +1,4 @@ -import { createUpdateListenerDecorator } from '../../helpers'; +import { createUpdateListenerDecorator } from '../../utils'; /** * Registers middleware for handling text messages. diff --git a/lib/decorators/listeners/help.decorator.ts b/lib/decorators/listeners/help.decorator.ts index 36ac9e4..5750cb9 100644 --- a/lib/decorators/listeners/help.decorator.ts +++ b/lib/decorators/listeners/help.decorator.ts @@ -1,4 +1,4 @@ -import { createUpdateListenerDecorator } from '../../helpers'; +import { createUpdateListenerDecorator } from '../../utils'; /** * Handler for /help command. diff --git a/lib/decorators/listeners/inline-query.decorator.ts b/lib/decorators/listeners/inline-query.decorator.ts index 722a348..7fef887 100644 --- a/lib/decorators/listeners/inline-query.decorator.ts +++ b/lib/decorators/listeners/inline-query.decorator.ts @@ -1,4 +1,4 @@ -import { createUpdateListenerDecorator } from '../../helpers'; +import { createUpdateListenerDecorator } from '../../utils'; /** * Registers middleware for handling inline_query actions with regular expressions. diff --git a/lib/decorators/listeners/mention.decorator.ts b/lib/decorators/listeners/mention.decorator.ts index e4341a0..ac8c01d 100644 --- a/lib/decorators/listeners/mention.decorator.ts +++ b/lib/decorators/listeners/mention.decorator.ts @@ -1,4 +1,4 @@ -import { createUpdateListenerDecorator } from '../../helpers'; +import { createUpdateListenerDecorator } from '../../utils'; /** * Mention handling. diff --git a/lib/decorators/listeners/on.decorator.ts b/lib/decorators/listeners/on.decorator.ts index 9f3c0fd..098c5e8 100644 --- a/lib/decorators/listeners/on.decorator.ts +++ b/lib/decorators/listeners/on.decorator.ts @@ -1,4 +1,4 @@ -import { createUpdateListenerDecorator } from '../../helpers'; +import { createUpdateListenerDecorator } from '../../utils'; /** * Registers middleware for provided update type. diff --git a/lib/decorators/listeners/phone.decorator.ts b/lib/decorators/listeners/phone.decorator.ts index 0f68380..b58a100 100644 --- a/lib/decorators/listeners/phone.decorator.ts +++ b/lib/decorators/listeners/phone.decorator.ts @@ -1,4 +1,4 @@ -import { createUpdateListenerDecorator } from '../../helpers'; +import { createUpdateListenerDecorator } from '../../utils'; /** * Phone number handling. diff --git a/lib/decorators/listeners/settings.decorator.ts b/lib/decorators/listeners/settings.decorator.ts index 6cca7c7..31b8aa6 100644 --- a/lib/decorators/listeners/settings.decorator.ts +++ b/lib/decorators/listeners/settings.decorator.ts @@ -1,4 +1,4 @@ -import { createUpdateListenerDecorator } from '../../helpers'; +import { createUpdateListenerDecorator } from '../../utils'; /** * Handler for /settings command. diff --git a/lib/decorators/listeners/start.decorator.ts b/lib/decorators/listeners/start.decorator.ts index 48bdc5b..668dd52 100644 --- a/lib/decorators/listeners/start.decorator.ts +++ b/lib/decorators/listeners/start.decorator.ts @@ -1,4 +1,4 @@ -import { createUpdateListenerDecorator } from '../../helpers'; +import { createUpdateListenerDecorator } from '../../utils'; /** * Handler for /start command. diff --git a/lib/decorators/listeners/text-link.decorator.ts b/lib/decorators/listeners/text-link.decorator.ts index c62439a..0c39246 100644 --- a/lib/decorators/listeners/text-link.decorator.ts +++ b/lib/decorators/listeners/text-link.decorator.ts @@ -1,4 +1,4 @@ -import { createUpdateListenerDecorator } from '../../helpers'; +import { createUpdateListenerDecorator } from '../../utils'; /** * Registers middleware for handling messages with text_link entity. diff --git a/lib/decorators/listeners/text-mention.decorator.ts b/lib/decorators/listeners/text-mention.decorator.ts index 895a458..16046e0 100644 --- a/lib/decorators/listeners/text-mention.decorator.ts +++ b/lib/decorators/listeners/text-mention.decorator.ts @@ -1,4 +1,4 @@ -import { createUpdateListenerDecorator } from '../../helpers'; +import { createUpdateListenerDecorator } from '../../utils'; /** * Registers middleware for handling messages with text_mention entity. diff --git a/lib/decorators/listeners/url.decorator.ts b/lib/decorators/listeners/url.decorator.ts index 843aa41..0ddbba1 100644 --- a/lib/decorators/listeners/url.decorator.ts +++ b/lib/decorators/listeners/url.decorator.ts @@ -1,4 +1,4 @@ -import { createUpdateListenerDecorator } from '../../helpers'; +import { createUpdateListenerDecorator } from '../../utils'; /** * Registers middleware for handling messages with url entity. diff --git a/lib/decorators/listeners/use.decorator.ts b/lib/decorators/listeners/use.decorator.ts index ba83af5..95ad81e 100644 --- a/lib/decorators/listeners/use.decorator.ts +++ b/lib/decorators/listeners/use.decorator.ts @@ -1,4 +1,4 @@ -import { createUpdateListenerDecorator } from '../../helpers'; +import { createUpdateListenerDecorator } from '../../utils'; /** * Registers a middleware. diff --git a/lib/decorators/params/context.decorator.ts b/lib/decorators/params/context.decorator.ts new file mode 100644 index 0000000..e77fcd8 --- /dev/null +++ b/lib/decorators/params/context.decorator.ts @@ -0,0 +1,8 @@ +import { createTelegrafParamDecorator } from '../../utils/param-decorator.util'; +import { TelegrafParamtype } from '../../enums/telegraf-paramtype.enum'; + +export const Context: () => ParameterDecorator = createTelegrafParamDecorator( + TelegrafParamtype.CONTEXT, +); + +export const Ctx = Context; diff --git a/lib/decorators/params/index.ts b/lib/decorators/params/index.ts new file mode 100644 index 0000000..6c5b237 --- /dev/null +++ b/lib/decorators/params/index.ts @@ -0,0 +1,3 @@ +export * from './context.decorator'; +export * from './next.decorator'; +export * from './message-text.decorator'; diff --git a/lib/decorators/params/message-text.decorator.ts b/lib/decorators/params/message-text.decorator.ts new file mode 100644 index 0000000..b72b66f --- /dev/null +++ b/lib/decorators/params/message-text.decorator.ts @@ -0,0 +1,15 @@ +import { PipeTransform, Type } from '@nestjs/common'; +import { createPipesTelegrafParamDecorator } from '../../utils/param-decorator.util'; +import { TelegrafParamtype } from '../../enums/telegraf-paramtype.enum'; + +export function MessageText(): ParameterDecorator; +export function MessageText( + ...pipes: (Type | PipeTransform)[] +): ParameterDecorator; +export function MessageText( + ...pipes: (Type | PipeTransform)[] +): ParameterDecorator { + return createPipesTelegrafParamDecorator(TelegrafParamtype.MESSAGE_TEXT)( + ...pipes, + ); +} diff --git a/lib/decorators/params/next.decorator.ts b/lib/decorators/params/next.decorator.ts new file mode 100644 index 0000000..063623e --- /dev/null +++ b/lib/decorators/params/next.decorator.ts @@ -0,0 +1,6 @@ +import { createTelegrafParamDecorator } from '../../utils/param-decorator.util'; +import { TelegrafParamtype } from '../../enums/telegraf-paramtype.enum'; + +export const Next: () => ParameterDecorator = createTelegrafParamDecorator( + TelegrafParamtype.NEXT, +); diff --git a/lib/decorators/scene/scene-enter.decorator.ts b/lib/decorators/scene/scene-enter.decorator.ts index 914b2d7..ab07f0a 100644 --- a/lib/decorators/scene/scene-enter.decorator.ts +++ b/lib/decorators/scene/scene-enter.decorator.ts @@ -1,3 +1,3 @@ -import { createSceneListenerDecorator } from '../../helpers'; +import { createSceneListenerDecorator } from '../../utils'; export const SceneEnter = createSceneListenerDecorator('enter'); diff --git a/lib/decorators/scene/scene-leave.decorator.ts b/lib/decorators/scene/scene-leave.decorator.ts index 19b970e..d65a37f 100644 --- a/lib/decorators/scene/scene-leave.decorator.ts +++ b/lib/decorators/scene/scene-leave.decorator.ts @@ -1,3 +1,3 @@ -import { createSceneListenerDecorator } from '../../helpers'; +import { createSceneListenerDecorator } from '../../utils'; export const SceneLeave = createSceneListenerDecorator('leave'); diff --git a/lib/enums/telegraf-paramtype.enum.ts b/lib/enums/telegraf-paramtype.enum.ts new file mode 100644 index 0000000..2b013d9 --- /dev/null +++ b/lib/enums/telegraf-paramtype.enum.ts @@ -0,0 +1,8 @@ +export enum TelegrafParamtype { + CONTEXT, + NEXT, + SENDER, + MESSAGE, + MESSAGE_TEXT, + // TODO: Add more +} diff --git a/lib/errors/index.ts b/lib/errors/index.ts new file mode 100644 index 0000000..1290854 --- /dev/null +++ b/lib/errors/index.ts @@ -0,0 +1 @@ +export * from './telegraf.exception'; diff --git a/lib/errors/telegraf.exception.ts b/lib/errors/telegraf.exception.ts new file mode 100644 index 0000000..0e17137 --- /dev/null +++ b/lib/errors/telegraf.exception.ts @@ -0,0 +1,24 @@ +import { isObject, isString } from '@nestjs/common/utils/shared.utils'; + +export class TelegrafException extends Error { + constructor(private readonly error: string | object) { + super(); + this.initMessage(); + } + + // TODO: Check real error format + public initMessage() { + if (isString(this.error)) { + this.message = this.error; + } else if ( + isObject(this.error) && + isString((this.error as Record).message) + ) { + this.message = (this.error as Record).message; + } else if (this.constructor) { + this.message = this.constructor.name + .match(/[A-Z][a-z]+|[0-9]+/g) + .join(' '); + } + } +} diff --git a/lib/exceptions/base-telegraf-exception-filter.ts b/lib/exceptions/base-telegraf-exception-filter.ts new file mode 100644 index 0000000..81434d2 --- /dev/null +++ b/lib/exceptions/base-telegraf-exception-filter.ts @@ -0,0 +1,34 @@ +import { ArgumentsHost, Logger } from '@nestjs/common'; +import { MESSAGES } from '@nestjs/core/constants'; +import { Context } from 'telegraf'; +import { TelegrafExceptionFilter } from '../interfaces/telegraf-exception-filter.interface'; +import { TelegrafException } from '../errors'; +import { isErrorObject } from '../helpers/is-error-object.helper'; +import { TelegrafArgumentsHost } from '../execution-context'; + +export class BaseTelegrafExceptionFilter + implements TelegrafExceptionFilter { + private static readonly logger = new Logger('TelegrafExceptionsHandler'); + + catch(exception: TError, host: ArgumentsHost): void { + const context = TelegrafArgumentsHost.create(host).getContext(); + this.handleError(exception, context); + } + + public handleError(exception: TError, context: Context): void { + if (!(exception instanceof TelegrafException)) { + return this.handleUnknownError(exception, context); + } + + context.reply(exception.message); + } + + public handleUnknownError(exception: TError, context: Context): void { + context.reply(MESSAGES.UNKNOWN_EXCEPTION_MESSAGE); + + const errorMessage = isErrorObject(exception) + ? exception.message + : exception; + BaseTelegrafExceptionFilter.logger.error(errorMessage); + } +} diff --git a/lib/exceptions/index.ts b/lib/exceptions/index.ts new file mode 100644 index 0000000..b7309ed --- /dev/null +++ b/lib/exceptions/index.ts @@ -0,0 +1 @@ +export * from './base-telegraf-exception-filter'; diff --git a/lib/exceptions/telegraf-exceptions-handler.ts b/lib/exceptions/telegraf-exceptions-handler.ts new file mode 100644 index 0000000..ba9985c --- /dev/null +++ b/lib/exceptions/telegraf-exceptions-handler.ts @@ -0,0 +1,48 @@ +import { ArgumentsHost } from '@nestjs/common'; +import { ExceptionFilterMetadata } from '@nestjs/common/interfaces/exceptions'; +import { BaseTelegrafExceptionFilter } from './base-telegraf-exception-filter'; +import { TelegrafException } from '../errors'; +import { InvalidExceptionFilterException } from '@nestjs/core/errors/exceptions/invalid-exception-filter.exception'; +import { isEmpty } from '@nestjs/common/utils/shared.utils'; + +export class TelegrafExceptionsHandler extends BaseTelegrafExceptionFilter { + private filters: ExceptionFilterMetadata[] = []; + + public handle( + exception: Error | TelegrafException | any, + host: ArgumentsHost, + ): void { + const isFilterInvoked = this.invokeCustomFilters(exception, host); + if (!isFilterInvoked) { + super.catch(exception, host); + } + } + + public invokeCustomFilters( + exception: T, + args: ArgumentsHost, + ): boolean { + if (isEmpty(this.filters)) return false; + + const filter = this.filters.find(({ exceptionMetatypes }) => { + const hasMetatype = + !exceptionMetatypes.length || + exceptionMetatypes.some( + (ExceptionMetatype) => exception instanceof ExceptionMetatype, + ); + return hasMetatype; + }); + + filter && filter.func(exception, args); + + return !!filter; + } + + public setCustomFilters(filters: ExceptionFilterMetadata[]): void { + if (!Array.isArray(filters)) { + throw new InvalidExceptionFilterException(); + } + + this.filters = filters; + } +} diff --git a/lib/execution-context/index.ts b/lib/execution-context/index.ts new file mode 100644 index 0000000..6d91739 --- /dev/null +++ b/lib/execution-context/index.ts @@ -0,0 +1,3 @@ +export * from './tg-arguments-host.interace'; +export * from './telegraf-arguments-host'; +export * from './telegraf-arguments-host'; diff --git a/lib/execution-context/telegraf-arguments-host.ts b/lib/execution-context/telegraf-arguments-host.ts new file mode 100644 index 0000000..79a2c10 --- /dev/null +++ b/lib/execution-context/telegraf-arguments-host.ts @@ -0,0 +1,22 @@ +import { ArgumentsHost } from '@nestjs/common'; +import { ExecutionContextHost } from '@nestjs/core/helpers/execution-context-host'; +import { TgArgumentsHost } from './tg-arguments-host.interace'; + +export class TelegrafArgumentsHost + extends ExecutionContextHost + implements TgArgumentsHost { + static create(context: ArgumentsHost): TelegrafArgumentsHost { + const type = context.getType(); + const tgContext = new TelegrafArgumentsHost(context.getArgs()); + tgContext.setType(type); + return tgContext; + } + + getContext(): T { + return this.getArgByIndex(0); + } + + getNext(): T { + return this.getArgByIndex(1); + } +} diff --git a/lib/execution-context/telegraf-execution-context.ts b/lib/execution-context/telegraf-execution-context.ts new file mode 100644 index 0000000..d0c9613 --- /dev/null +++ b/lib/execution-context/telegraf-execution-context.ts @@ -0,0 +1,32 @@ +import { ContextType, ExecutionContext } from '@nestjs/common'; +import { ExecutionContextHost } from '@nestjs/core/helpers/execution-context-host'; +import { TgArgumentsHost } from './tg-arguments-host.interace'; + +export type TelegrafContextType = 'telegraf' | ContextType; + +export class TelegrafExecutionContext + extends ExecutionContextHost + implements TgArgumentsHost { + static create(context: ExecutionContext): TelegrafExecutionContext { + const type = context.getType(); + const tgContext = new TelegrafExecutionContext( + context.getArgs(), + context.getClass(), + context.getHandler(), + ); + tgContext.setType(type); + return tgContext; + } + + getType(): TContext { + return super.getType(); + } + + getContext(): T { + return this.getArgByIndex(0); + } + + getNext(): T { + return this.getArgByIndex(0); + } +} diff --git a/lib/execution-context/tg-arguments-host.interace.ts b/lib/execution-context/tg-arguments-host.interace.ts new file mode 100644 index 0000000..fa5a8c1 --- /dev/null +++ b/lib/execution-context/tg-arguments-host.interace.ts @@ -0,0 +1,6 @@ +import { ArgumentsHost } from '@nestjs/common'; + +export interface TgArgumentsHost extends ArgumentsHost { + getContext(): T; + getNext(): T; +} diff --git a/lib/explorers/telegraf-update.explorer.ts b/lib/explorers/telegraf-update.explorer.ts index a848806..123febb 100644 --- a/lib/explorers/telegraf-update.explorer.ts +++ b/lib/explorers/telegraf-update.explorer.ts @@ -1,54 +1,98 @@ import { Inject, Injectable, OnModuleInit } from '@nestjs/common'; -import { DiscoveryService } from '@nestjs/core'; +import { Injectable as IInjectable } from '@nestjs/common/interfaces/injectable.interface'; +import { DiscoveryService, ModuleRef, ModulesContainer } from '@nestjs/core'; import { MetadataScanner } from '@nestjs/core/metadata-scanner'; import { InstanceWrapper } from '@nestjs/core/injector/instance-wrapper'; -import { Telegraf } from 'telegraf'; +import { PipesContextCreator } from '@nestjs/core/pipes/pipes-context-creator'; +import { PipesConsumer } from '@nestjs/core/pipes/pipes-consumer'; +import { GuardsContextCreator } from '@nestjs/core/guards/guards-context-creator'; +import { GuardsConsumer } from '@nestjs/core/guards/guards-consumer'; +import { InterceptorsContextCreator } from '@nestjs/core/interceptors/interceptors-context-creator'; +import { InterceptorsConsumer } from '@nestjs/core/interceptors/interceptors-consumer'; +import { isFunction, isNil } from '@nestjs/common/utils/shared.utils'; +import { fromPromise } from 'rxjs/internal-compatibility'; +import { filter, mergeAll } from 'rxjs/operators'; +import { Observable, of } from 'rxjs'; +import { Context, Telegraf } from 'telegraf'; import { TelegrafMetadataAccessor } from '../telegraf.metadata-accessor'; +import { TelegrafContextCreator } from '../context/telegraf-context-creator'; +import { TelegrafProxy } from '../context/telegraf-proxy'; +import { FiltersContextCreator } from '../context/filters-context-creator'; @Injectable() export class TelegrafUpdateExplorer implements OnModuleInit { + private readonly contextCreator: TelegrafContextCreator; + constructor( - @Inject(Telegraf) - private readonly telegraf: Telegraf, + private readonly moduleRef: ModuleRef, + private readonly modulesContainer: ModulesContainer, private readonly discoveryService: DiscoveryService, private readonly metadataAccessor: TelegrafMetadataAccessor, private readonly metadataScanner: MetadataScanner, - ) {} + @Inject(Telegraf) private readonly telegraf: Telegraf, + ) { + this.contextCreator = this.getContextCreator(); + } + + private getContextCreator(): TelegrafContextCreator { + const { container } = this.moduleRef as any; + return new TelegrafContextCreator( + new TelegrafProxy(), + new FiltersContextCreator(container), + new PipesContextCreator(container), + new PipesConsumer(), + new GuardsContextCreator(container), + new GuardsConsumer(), + new InterceptorsContextCreator(container), + new InterceptorsConsumer(), + ); + } onModuleInit(): void { this.explore(); } private explore(): void { - const updateClasses = this.filterUpdateClasses(); - - updateClasses.forEach((wrapper) => { - const { instance } = wrapper; - - const prototype = Object.getPrototypeOf(instance); - this.metadataScanner.scanFromPrototype( - instance, - prototype, - (methodKey: string) => this.registerIfListener(instance, methodKey), - ); + this.modulesContainer.forEach(({ providers }, moduleName) => { + this.exploreProviders(providers, moduleName); }); } - private filterUpdateClasses(): InstanceWrapper[] { - return this.discoveryService - .getProviders() - .filter((wrapper) => wrapper.instance) - .filter((wrapper) => - this.metadataAccessor.isUpdate(wrapper.instance.constructor), - ); + private exploreProviders( + providers: Map>, + moduleName: string, + ): void { + [...providers.values()] + .filter((wrapper) => wrapper && !wrapper.isNotMetatype) + .forEach((wrapper) => { + const { instance } = wrapper; + + const prototype = Object.getPrototypeOf(instance); + this.metadataScanner.scanFromPrototype( + instance, + prototype, + (methodKey: string) => + this.registerIfListener( + instance as Record, + methodKey, + moduleName, + ), + ); + }); } private registerIfListener( instance: Record, methodKey: string, + moduleName: string, ): void { - const methodRef = instance[methodKey]; - const middlewareFn = methodRef.bind(instance); + const methodRef = instance[methodKey] as (...args: unknown[]) => unknown; + const contextHandlerFn = this.contextCreator.create( + instance, + methodRef, + moduleName, + methodKey, + ); const listenerMetadata = this.metadataAccessor.getListenerMetadata( methodRef, @@ -56,8 +100,38 @@ export class TelegrafUpdateExplorer implements OnModuleInit { if (!listenerMetadata) return; const { method, args } = listenerMetadata; - // NOTE: Use "any" to disable "Expected at least 1 arguments, but got 1 or more." error. - // Use telegraf instance for non-scene listeners - (this.telegraf[method] as any)(...args, middlewareFn); + this.telegraf[method]( + ...args, + async (ctx: Context, next: () => Promise) => { + const defferedResult = contextHandlerFn.call(instance, ctx, next); + const result = this.pickResult(defferedResult); + fromPromise(result) + .pipe( + mergeAll(), + filter((response: any) => !isNil(response)), + ) + .subscribe((text) => { + // TODO: More processing method return logic (files, images, etc) + // Example: https://github.com/nestjs/nest/blob/01dc358aade27d3d7ca510506696aa62bfb1cc43/packages/platform-socket.io/adapters/io-adapter.ts#L56 + return ctx.reply(text); + }); + }, + ); + } + + private async pickResult( + defferedResult: Promise, + ): Promise> { + const result = await defferedResult; + + if (result && isFunction(result.subscribe)) { + return result; + } + + if (result instanceof Promise) { + return fromPromise(result); + } + + return of(result); } } diff --git a/lib/factories/telegraf-params-factory.ts b/lib/factories/telegraf-params-factory.ts new file mode 100644 index 0000000..7f9adbf --- /dev/null +++ b/lib/factories/telegraf-params-factory.ts @@ -0,0 +1,23 @@ +import { TelegrafParamtype } from '../enums/telegraf-paramtype.enum'; + +export class TelegrafParamsFactory { + exchangeKeyForValue< + TContext extends Record = any, + TResult = any + >(type: number, ctx: TContext, next: Function): TResult { + switch (type as TelegrafParamtype) { + case TelegrafParamtype.CONTEXT: + return ctx as any; + case TelegrafParamtype.NEXT: + return next as any; + case TelegrafParamtype.SENDER: + return ctx.from; + case TelegrafParamtype.MESSAGE: + return ctx.message; + case TelegrafParamtype.MESSAGE_TEXT: + return ctx.message.text; + default: + return null; + } + } +} diff --git a/lib/helpers/index.ts b/lib/helpers/index.ts deleted file mode 100644 index 20b6077..0000000 --- a/lib/helpers/index.ts +++ /dev/null @@ -1,2 +0,0 @@ -export * from './create-update-listener-decorator.helper'; -export * from './create-scene-listener-decorator.helper'; diff --git a/lib/helpers/is-error-object.helper.ts b/lib/helpers/is-error-object.helper.ts new file mode 100644 index 0000000..9ff248c --- /dev/null +++ b/lib/helpers/is-error-object.helper.ts @@ -0,0 +1,5 @@ +import { isObject } from '@nestjs/common/utils/shared.utils'; + +export function isErrorObject(err: any): err is Error { + return isObject(err) && !!(err as Error).message; +} diff --git a/lib/helpers/is-observable.helper.ts b/lib/helpers/is-observable.helper.ts new file mode 100644 index 0000000..c928e23 --- /dev/null +++ b/lib/helpers/is-observable.helper.ts @@ -0,0 +1,5 @@ +import { isFunction } from '@nestjs/common/utils/shared.utils'; + +export function isObservable(result: any): boolean { + return result && isFunction(result.subscribe); +} diff --git a/lib/index.ts b/lib/index.ts index da17d36..61d71b0 100644 --- a/lib/index.ts +++ b/lib/index.ts @@ -1,5 +1,7 @@ export * from './decorators'; export * from './interfaces'; -export * from './helpers'; +export * from './utils'; +export * from './errors'; +export * from './execution-context'; export * from './telegraf.module'; export * from './telegraf.types'; diff --git a/lib/interfaces/telegraf-exception-filter.interface.ts b/lib/interfaces/telegraf-exception-filter.interface.ts new file mode 100644 index 0000000..c1f4598 --- /dev/null +++ b/lib/interfaces/telegraf-exception-filter.interface.ts @@ -0,0 +1,5 @@ +import { ArgumentsHost } from '@nestjs/common'; + +export interface TelegrafExceptionFilter { + catch(exception: T, host: ArgumentsHost): any; +} diff --git a/lib/telegraf.constants.ts b/lib/telegraf.constants.ts index 1790594..c1cc166 100644 --- a/lib/telegraf.constants.ts +++ b/lib/telegraf.constants.ts @@ -1,6 +1,14 @@ +import { + CUSTOM_ROUTE_AGRS_METADATA, + ROUTE_ARGS_METADATA, +} from '@nestjs/common/constants'; + export const TELEGRAF_MODULE_OPTIONS = 'TELEGRAF_MODULE_OPTIONS'; export const UPDATE_METADATA = 'UPDATE_METADATA'; export const UPDATE_LISTENER_METADATA = 'UPDATE_LISTENER_METADATA'; export const SCENE_METADATA = 'SCENE_METADATA'; + +export const LISTENER_ARGS_METADATA = ROUTE_ARGS_METADATA; +export const CUSTOM_LISTENER_AGRS_METADATA = CUSTOM_ROUTE_AGRS_METADATA; diff --git a/lib/helpers/create-scene-listener-decorator.helper.ts b/lib/utils/create-scene-listener-decorator.util.ts similarity index 100% rename from lib/helpers/create-scene-listener-decorator.helper.ts rename to lib/utils/create-scene-listener-decorator.util.ts diff --git a/lib/helpers/create-update-listener-decorator.helper.ts b/lib/utils/create-update-listener-decorator.util.ts similarity index 100% rename from lib/helpers/create-update-listener-decorator.helper.ts rename to lib/utils/create-update-listener-decorator.util.ts diff --git a/lib/utils/index.ts b/lib/utils/index.ts new file mode 100644 index 0000000..4c2328a --- /dev/null +++ b/lib/utils/index.ts @@ -0,0 +1,2 @@ +export * from './create-update-listener-decorator.util'; +export * from './create-scene-listener-decorator.util'; diff --git a/lib/utils/param-decorator.util.ts b/lib/utils/param-decorator.util.ts new file mode 100644 index 0000000..f344951 --- /dev/null +++ b/lib/utils/param-decorator.util.ts @@ -0,0 +1,39 @@ +import { assignMetadata, PipeTransform, Type } from '@nestjs/common'; +import { TelegrafParamtype } from '../enums/telegraf-paramtype.enum'; +import { LISTENER_ARGS_METADATA } from '../telegraf.constants'; + +export function createTelegrafParamDecorator( + paramtype: TelegrafParamtype, +): (...pipes: (Type | PipeTransform)[]) => ParameterDecorator { + return (...pipes: (Type | PipeTransform)[]) => ( + target, + key, + index, + ) => { + const args = + Reflect.getMetadata(LISTENER_ARGS_METADATA, target.constructor, key) || + {}; + Reflect.defineMetadata( + LISTENER_ARGS_METADATA, + assignMetadata(args, paramtype, index, undefined, ...pipes), + target.constructor, + key, + ); + }; +} + +export const createPipesTelegrafParamDecorator = ( + paramtype: TelegrafParamtype, +) => ( + ...pipes: (Type | PipeTransform)[] +): ParameterDecorator => (target, key, index) => { + const args = + Reflect.getMetadata(LISTENER_ARGS_METADATA, target.constructor, key) || {}; + + Reflect.defineMetadata( + LISTENER_ARGS_METADATA, + assignMetadata(args, paramtype, index, undefined, ...pipes), + target.constructor, + key, + ); +}; diff --git a/sample/app.module.ts b/sample/app.module.ts index 2d177de..9870db6 100644 --- a/sample/app.module.ts +++ b/sample/app.module.ts @@ -3,7 +3,7 @@ import { TelegrafModule } from '../lib'; import { EchoService } from './echo.service'; import { AppUpdate } from './app.update'; import { HelloScene } from './scenes/hello.scene'; -import { sessionMiddleware } from './middleware/session.middleware'; +import { sessionMiddleware } from './common/middleware/session.middleware'; @Module({ imports: [ @@ -12,6 +12,6 @@ import { sessionMiddleware } from './middleware/session.middleware'; middlewares: [sessionMiddleware], }), ], - providers: [EchoService, AppUpdate, HelloScene], + providers: [EchoService, AppUpdate], }) export class AppModule {} diff --git a/sample/app.update.ts b/sample/app.update.ts index 402e9fb..0680183 100644 --- a/sample/app.update.ts +++ b/sample/app.update.ts @@ -1,40 +1,63 @@ -import { SceneContext, Telegraf } from 'telegraf'; -import { Command, Help, InjectBot, On, Start, Update } from '../lib'; +import { Telegraf } from 'telegraf'; +import { SceneContextMessageUpdate } from 'telegraf/typings/stage'; +import { + Command, + Ctx, + Help, + InjectBot, + MessageText, + On, + Start, + Update, +} from '../lib'; import { EchoService } from './echo.service'; import { HELLO_SCENE_ID } from './app.constants'; import { Context } from './interfaces/context.interface'; +import { UseGuards, UseInterceptors } from '@nestjs/common'; +import { AdminGuard } from './common/guards/admin.guard'; +import { ResponseTimeInterceptor } from './common/interceptors/response-time.interceptor'; +import { ReverseTextPipe } from './common/pipes/reverse-text.pipe'; @Update() export class AppUpdate { constructor( @InjectBot() - private readonly bot: Telegraf, + private readonly bot: Telegraf, private readonly echoService: EchoService, ) {} @Start() - async onStart(ctx: Context): Promise { + async onStart(): Promise { const me = await this.bot.telegram.getMe(); - await ctx.reply(`Hey, I'm ${me.first_name}`); + return `Hey, I'm ${me.first_name}`; } @Help() - async onHelp(ctx: Context): Promise { + @UseInterceptors(ResponseTimeInterceptor) + async onHelp(@Ctx() ctx: Context): Promise { await ctx.reply('Send me any text'); } + @UseGuards(AdminGuard) + @Command('admin') + async onAdminCommand(@Ctx() ctx: Context): Promise { + await ctx.reply('Welcome judge'); + } + @Command('scene') - async onSceneCommand(ctx: Context): Promise { + async onSceneCommand(@Ctx() ctx: Context): Promise { await ctx.scene.enter(HELLO_SCENE_ID); } @On('message') - async onMessage(ctx: Context): Promise { + async onMessage( + @Ctx() ctx: Context, + @MessageText(new ReverseTextPipe()) reversedMessage: string, + ): Promise { console.log('New message received'); if ('text' in ctx.message) { - const messageText = ctx.message.text; - const echoText = this.echoService.echo(messageText); + const echoText = this.echoService.echo(reversedMessage); await ctx.reply(echoText); } else { await ctx.reply('Only text messages'); diff --git a/sample/common/decorators/from.decorator.ts b/sample/common/decorators/from.decorator.ts new file mode 100644 index 0000000..5200f76 --- /dev/null +++ b/sample/common/decorators/from.decorator.ts @@ -0,0 +1,7 @@ +import { createParamDecorator, ExecutionContext } from '@nestjs/common'; +import { TelegrafExecutionContext } from '../../../lib/execution-context'; + +export const From = createParamDecorator( + (_, ctx: ExecutionContext) => + TelegrafExecutionContext.create(ctx).getContext().from, +); diff --git a/sample/common/filters/telegraf-exception.filter.ts b/sample/common/filters/telegraf-exception.filter.ts new file mode 100644 index 0000000..421ff84 --- /dev/null +++ b/sample/common/filters/telegraf-exception.filter.ts @@ -0,0 +1,11 @@ +import { ArgumentsHost, Catch, ExceptionFilter } from '@nestjs/common'; +import { TelegrafArgumentsHost, TelegrafException } from '../../../lib'; + +@Catch() +export class TelegrafExceptionFilter implements ExceptionFilter { + catch(exception: T, host: ArgumentsHost) { + const tgHost = TelegrafArgumentsHost.create(host); + console.log(tgHost); + return exception; + } +} diff --git a/sample/common/guards/admin.guard.ts b/sample/common/guards/admin.guard.ts new file mode 100644 index 0000000..9cb9ab9 --- /dev/null +++ b/sample/common/guards/admin.guard.ts @@ -0,0 +1,21 @@ +import { CanActivate, ExecutionContext, Injectable } from '@nestjs/common'; +import { TelegrafExecutionContext } from '../../../lib/execution-context/telegraf-execution-context'; +import { Context } from '../../interfaces/context.interface'; +import { TelegrafException } from '../../../lib/errors'; + +@Injectable() +export class AdminGuard implements CanActivate { + private readonly ADMIN_IDS = []; + + canActivate(context: ExecutionContext): boolean { + const ctx = TelegrafExecutionContext.create(context); + const { from } = ctx.getContext(); + + const isAdmin = this.ADMIN_IDS.includes(from.id); + if (!isAdmin) { + throw new TelegrafException('You are not admin >:('); + } + + return true; + } +} diff --git a/sample/common/interceptors/response-time.interceptor.ts b/sample/common/interceptors/response-time.interceptor.ts new file mode 100644 index 0000000..96b1b37 --- /dev/null +++ b/sample/common/interceptors/response-time.interceptor.ts @@ -0,0 +1,20 @@ +import { + CallHandler, + ExecutionContext, + Injectable, + NestInterceptor, +} from '@nestjs/common'; +import { Observable } from 'rxjs'; +import { tap } from 'rxjs/operators'; + +@Injectable() +export class ResponseTimeInterceptor implements NestInterceptor { + intercept(context: ExecutionContext, next: CallHandler): Observable { + console.log('Before...'); + + const start = Date.now(); + return next + .handle() + .pipe(tap(() => console.log(`Response time: ${Date.now() - start}ms`))); + } +} diff --git a/sample/middleware/session.middleware.ts b/sample/common/middleware/session.middleware.ts similarity index 100% rename from sample/middleware/session.middleware.ts rename to sample/common/middleware/session.middleware.ts diff --git a/sample/common/pipes/reverse-text.pipe.ts b/sample/common/pipes/reverse-text.pipe.ts new file mode 100644 index 0000000..82ee739 --- /dev/null +++ b/sample/common/pipes/reverse-text.pipe.ts @@ -0,0 +1,8 @@ +import { Injectable, PipeTransform } from '@nestjs/common'; + +@Injectable() +export class ReverseTextPipe implements PipeTransform { + transform(value: string): string { + return value.split('').reverse().join(''); + } +} diff --git a/tsconfig.json b/tsconfig.json index 921d963..db7cecd 100644 --- a/tsconfig.json +++ b/tsconfig.json @@ -7,7 +7,7 @@ "noLib": false, "emitDecoratorMetadata": true, "experimentalDecorators": true, - "target": "es6", + "target": "es2020", "sourceMap": false, "baseUrl": "./", "outDir": "./dist", diff --git a/website/docs/api-reference/decorators.md b/website/docs/api-reference/decorators.md index d3a51d9..433c47c 100644 --- a/website/docs/api-reference/decorators.md +++ b/website/docs/api-reference/decorators.md @@ -12,6 +12,7 @@ The described functionality is under development, the functionality has not been ### Update `@Update` class decorator, it's like NestJS [`@Controller`](https://docs.nestjs.com/controllers) decorator, but for [Telegram Bot API updates](https://core.telegram.org/bots/api#getting-updates). +It is required for the class that will receive updates from Telegram. ```typescript {3} import { Update, Context } from 'nestjs-telegraf'; diff --git a/website/docs/bot-injection.md b/website/docs/bot-injection.md index 8aa67df..24276e9 100644 --- a/website/docs/bot-injection.md +++ b/website/docs/bot-injection.md @@ -8,10 +8,11 @@ slug: /bot-injection At times you may need to access the native `Telegraf` instance. For example, you may want to connect stage middleware. You can inject the Telegraf by using the `@InjectBot()` decorator as follows: ```typescript import { Injectable } from '@nestjs/common'; -import { InjectBot, TelegrafProvider } from 'nestjs-telegraf'; +import { InjectBot } from 'nestjs-telegraf'; +import { Telegraf } from 'telegraf'; @Injectable() export class BotSettingsService { - constructor(@InjectBot() private bot: TelegrafProvider) {} + constructor(@InjectBot() private bot: Telegraf) {} } ``` diff --git a/website/docs/telegraf-methods.md b/website/docs/telegraf-methods.md index aa39a30..7cdfa6b 100644 --- a/website/docs/telegraf-methods.md +++ b/website/docs/telegraf-methods.md @@ -18,8 +18,8 @@ import { Help, On, Hears, - Context, } from 'nestjs-telegraf'; +import { Context } from 'telegraf'; @Injectable() export class AppService { diff --git a/website/docs/webhooks.md b/website/docs/webhooks.md index e61c97b..d9a2b87 100644 --- a/website/docs/webhooks.md +++ b/website/docs/webhooks.md @@ -9,12 +9,13 @@ If you want to configure a telegram bot webhook, you need to get a middleware fr To access it, you must use the `app.get()` method, followed by the provider reference: ```typescript -const telegrafProvider = app.get('TelegrafProvider'); +import { Telegraf } from 'telegraf'; +const telegraf = app.get(Telegraf); ``` Now you can connect middleware: ```typescript -app.use(telegrafProvider.webhookCallback('/secret-path')); +app.use(telegraf.webhookCallback('/secret-path')); ``` The last step is to specify launchOptions in `forRoot` method: From d7f397b37575372aea4c39d99b1cb08036daa46a Mon Sep 17 00:00:00 2001 From: Morb0 Date: Sun, 3 Jan 2021 01:35:30 +0300 Subject: [PATCH 02/19] chore(): remove todo --- TODO.md | 10 ---------- 1 file changed, 10 deletions(-) delete mode 100644 TODO.md diff --git a/TODO.md b/TODO.md deleted file mode 100644 index 4d12bdc..0000000 --- a/TODO.md +++ /dev/null @@ -1,10 +0,0 @@ -PR TODO List: - * [ ] Include scene support to one explorer - * [ ] Split explorer to more sense components - * [ ] Refactor new execution context code - * [ ] Add support for new return types (files, images, music, git, etc) - * [ ] Add more param decorators (only often used) - * [ ] Review exception filter - * [ ] Add custom error messages (now used "Internal Server Error") - * [ ] Allow disabling default error send to chat - * [ ] Test all components From 798494a5b2aa6aa7667cb47f980310f06da4b01c Mon Sep 17 00:00:00 2001 From: Morb0 Date: Sun, 3 Jan 2021 02:39:50 +0300 Subject: [PATCH 03/19] refactor(): use ExternalContextCreator --- lib/context/filters-context-creator.ts | 38 --- lib/context/telegraf-context-creator.ts | 278 ------------------ lib/context/telegraf-proxy.ts | 38 --- .../params/message-text.decorator.ts | 13 +- .../base-telegraf-exception-filter.ts | 34 --- lib/exceptions/index.ts | 1 - lib/exceptions/telegraf-exceptions-handler.ts | 48 --- lib/explorers/telegraf-update.explorer.ts | 43 +-- lib/helpers/is-error-object.helper.ts | 5 - lib/helpers/is-observable.helper.ts | 5 - lib/telegraf.constants.ts | 8 +- lib/utils/param-decorator.util.ts | 83 ++++-- 12 files changed, 86 insertions(+), 508 deletions(-) delete mode 100644 lib/context/filters-context-creator.ts delete mode 100644 lib/context/telegraf-context-creator.ts delete mode 100644 lib/context/telegraf-proxy.ts delete mode 100644 lib/exceptions/base-telegraf-exception-filter.ts delete mode 100644 lib/exceptions/index.ts delete mode 100644 lib/exceptions/telegraf-exceptions-handler.ts delete mode 100644 lib/helpers/is-error-object.helper.ts delete mode 100644 lib/helpers/is-observable.helper.ts diff --git a/lib/context/filters-context-creator.ts b/lib/context/filters-context-creator.ts deleted file mode 100644 index eb45b81..0000000 --- a/lib/context/filters-context-creator.ts +++ /dev/null @@ -1,38 +0,0 @@ -import { NestContainer } from '@nestjs/core'; -import { BaseExceptionFilterContext } from '@nestjs/core/exceptions/base-exception-filter-context'; -import { EXCEPTION_FILTERS_METADATA } from '@nestjs/common/constants'; -import { isEmpty } from '@nestjs/common/utils/shared.utils'; -import { TelegrafExceptionsHandler } from '../exceptions/telegraf-exceptions-handler'; - -export class FiltersContextCreator extends BaseExceptionFilterContext { - constructor(container: NestContainer) { - super(container); - } - - public create( - instance: object, - callback: (...args: any[]) => void, - moduleKey: string, - ): TelegrafExceptionsHandler { - this.moduleContext = moduleKey; - - const exceptionHandler = new TelegrafExceptionsHandler(); - const filters = this.createContext( - instance, - callback, - EXCEPTION_FILTERS_METADATA, - ); - - if (isEmpty(filters)) { - return exceptionHandler; - } - - exceptionHandler.setCustomFilters(filters.reverse()); - - return exceptionHandler; - } - - public getGlobalMetadata(): T { - return [] as T; - } -} diff --git a/lib/context/telegraf-context-creator.ts b/lib/context/telegraf-context-creator.ts deleted file mode 100644 index 2066dfb..0000000 --- a/lib/context/telegraf-context-creator.ts +++ /dev/null @@ -1,278 +0,0 @@ -import { Controller, PipeTransform } from '@nestjs/common/interfaces'; -import { PipesContextCreator } from '@nestjs/core/pipes/pipes-context-creator'; -import { PipesConsumer } from '@nestjs/core/pipes/pipes-consumer'; -import { GuardsContextCreator } from '@nestjs/core/guards/guards-context-creator'; -import { GuardsConsumer } from '@nestjs/core/guards/guards-consumer'; -import { InterceptorsContextCreator } from '@nestjs/core/interceptors/interceptors-context-creator'; -import { InterceptorsConsumer } from '@nestjs/core/interceptors/interceptors-consumer'; -import { - ContextUtils, - ParamProperties, -} from '@nestjs/core/helpers/context-utils'; -import { HandlerMetadataStorage } from '@nestjs/core/helpers/handler-metadata-storage'; -import { FORBIDDEN_MESSAGE } from '@nestjs/core/guards/constants'; -import { ParamsMetadata } from '@nestjs/core/helpers/interfaces'; -import { ExecutionContextHost } from '@nestjs/core/helpers/execution-context-host'; - -import { FiltersContextCreator } from './filters-context-creator'; -import { TelegrafContextType } from '../execution-context/telegraf-execution-context'; -import { TelegrafProxy } from './telegraf-proxy'; -import { TelegrafException } from '../errors'; -import { - CUSTOM_LISTENER_AGRS_METADATA, - LISTENER_ARGS_METADATA, -} from '../telegraf.constants'; -import { TelegrafParamsFactory } from '../factories/telegraf-params-factory'; -import { isEmpty } from '@nestjs/common/utils/shared.utils'; - -export type Update = Controller; -type TelegrafParamProperties = ParamProperties & { metatype?: any }; - -export interface TelegrafHandlerMetadata { - argsLength: number; - paramtypes: any[]; - getParamsMetadata: (moduleKey: string) => TelegrafParamProperties[]; -} - -export class TelegrafContextCreator { - private readonly contextUtils = new ContextUtils(); - private readonly telegrafParamsFactory = new TelegrafParamsFactory(); - private readonly handlerMetadataStorage = new HandlerMetadataStorage(); - - constructor( - private readonly telegrafProxy: TelegrafProxy, - private readonly exceptionFiltersContext: FiltersContextCreator, - private readonly pipesContextCreator: PipesContextCreator, - private readonly pipesConsumer: PipesConsumer, - private readonly guardsContextCreator: GuardsContextCreator, - private readonly guardsConsumer: GuardsConsumer, - private readonly interceptorsContextCreator: InterceptorsContextCreator, - private readonly interceptorsConsumer: InterceptorsConsumer, - ) {} - - public create( - instance: Update, - methodRef: (...args: unknown[]) => void, - moduleName: string, - methodKey: string, - ): (...args: any[]) => Promise { - const contextType: TelegrafContextType = 'telegraf'; - const { argsLength, paramtypes, getParamsMetadata } = this.getMetadata( - instance, - methodKey, - contextType, - ); - - const exceptionHandler = this.exceptionFiltersContext.create( - instance, - methodRef, - moduleName, - ); - - const pipes = this.pipesContextCreator.create( - instance, - methodRef, - moduleName, - ); - - const guards = this.guardsContextCreator.create( - instance, - methodRef, - moduleName, - ); - - const interceptors = this.interceptorsContextCreator.create( - instance, - methodRef, - moduleName, - ); - - const paramsMetadata = getParamsMetadata(moduleName); - const paramsOptions = paramsMetadata - ? this.contextUtils.mergeParamsMetatypes(paramsMetadata, paramtypes) - : []; - const fnApplyPipes = this.createPipesFn(pipes, paramsOptions); - - const fnCanActivate = this.createGuardsFn( - guards, - instance, - methodRef, - contextType, - ); - - const handler = ( - initialArgs: unknown[], - ctx: TContext, - next: Function, - ) => async () => { - if (fnApplyPipes) { - await fnApplyPipes(initialArgs, ctx, next); - return methodRef.apply(instance, initialArgs); - } - return methodRef.apply(instance, [ctx, next]); - }; - - const targetCallback = async (ctx: TContext, next: Function) => { - const initialArgs = this.contextUtils.createNullArray(argsLength); - fnCanActivate && (await fnCanActivate([ctx, next])); - - return this.interceptorsConsumer.intercept( - interceptors, - [ctx, next], - instance, - methodRef, - handler(initialArgs, ctx, next), - contextType, - ); - }; - - return this.telegrafProxy.create(targetCallback, exceptionHandler); - } - - public getMetadata< - TMetadata, - TContext extends TelegrafContextType = TelegrafContextType - >( - instance: Controller, - methodName: string, - contextType: TContext, - ): TelegrafHandlerMetadata { - const cachedMetadata = this.handlerMetadataStorage.get( - instance, - methodName, - ); - if (cachedMetadata) return cachedMetadata; - - const metadata = - this.contextUtils.reflectCallbackMetadata( - instance, - methodName, - LISTENER_ARGS_METADATA, - ) || {}; - - const keys = Object.keys(metadata); - const argsLength = this.contextUtils.getArgumentsLength(keys, metadata); - const contextFactory = this.contextUtils.getContextFactory( - contextType, - instance, - instance[methodName], - ); - const getParamsMetadata = (moduleKey: string) => - this.exchangeKeysForValues( - keys, - metadata, - moduleKey, - this.telegrafParamsFactory, - contextFactory, - ); - - const paramtypes = this.contextUtils.reflectCallbackParamtypes( - instance, - methodName, - ); - const handlerMetadata: TelegrafHandlerMetadata = { - argsLength, - paramtypes, - getParamsMetadata, - }; - this.handlerMetadataStorage.set(instance, methodName, handlerMetadata); - return handlerMetadata; - } - - public exchangeKeysForValues( - keys: string[], - metadata: TMetadata, - moduleContext: string, - paramsFactory: TelegrafParamsFactory, - contextFactory: (args: unknown[]) => ExecutionContextHost, - ): ParamProperties[] { - this.pipesContextCreator.setModuleContext(moduleContext); - - return keys.map((key) => { - const { index, data, pipes: pipesCollection } = metadata[key]; - const pipes = this.pipesContextCreator.createConcreteContext( - pipesCollection, - ); - const type = this.contextUtils.mapParamType(key); - - if (key.includes(CUSTOM_LISTENER_AGRS_METADATA)) { - const { factory } = metadata[key]; - const customExtractValue = this.contextUtils.getCustomFactory( - factory, - data, - contextFactory, - ); - return { index, extractValue: customExtractValue, type, data, pipes }; - } - const numericType = Number(type); - const extractValue = (ctx: TContext, next: Function) => - paramsFactory.exchangeKeyForValue(numericType, ctx, next); - - return { index, extractValue, type: numericType, data, pipes }; - }); - } - - public createGuardsFn( - guards: any[], - instance: Controller, - callback: (...args: unknown[]) => any, - contextType?: TContext, - ): Function | null { - const canActivateFn = async (args: any[]) => { - const canActivate = await this.guardsConsumer.tryActivate( - guards, - args, - instance, - callback, - contextType, - ); - if (!canActivate) { - throw new TelegrafException(FORBIDDEN_MESSAGE); - } - }; - return guards.length ? canActivateFn : null; - } - - public createPipesFn( - pipes: PipeTransform[], - paramsOptions: (ParamProperties & { metatype?: unknown })[], - ) { - const pipesFn = async ( - args: unknown[], - ctx: TContext, - next: Function, - ) => { - const resolveParamValue = async ( - param: ParamProperties & { metatype?: unknown }, - ) => { - const { - index, - extractValue, - type, - data, - metatype, - pipes: paramPipes, - } = param; - const value = extractValue(ctx, next); - - args[index] = await this.getParamValue( - value, - { metatype, type, data }, - pipes.concat(paramPipes), - ); - }; - await Promise.all(paramsOptions.map(resolveParamValue)); - }; - return paramsOptions.length ? pipesFn : null; - } - - public async getParamValue( - value: T, - { metatype, type, data }: { metatype: any; type: any; data: any }, - pipes: PipeTransform[], - ): Promise { - return isEmpty(pipes) - ? value - : this.pipesConsumer.apply(value, { metatype, type, data }, pipes); - } -} diff --git a/lib/context/telegraf-proxy.ts b/lib/context/telegraf-proxy.ts deleted file mode 100644 index 448d0c4..0000000 --- a/lib/context/telegraf-proxy.ts +++ /dev/null @@ -1,38 +0,0 @@ -import { ExecutionContextHost } from '@nestjs/core/helpers/execution-context-host'; -import { catchError } from 'rxjs/operators'; -import { EMPTY } from 'rxjs'; -import { isObservable } from '../helpers/is-observable.helper'; -import { TelegrafExceptionsHandler } from '../exceptions/telegraf-exceptions-handler'; - -export class TelegrafProxy { - public create( - targetCallback: (ctx: TContext, next: Function) => Promise, - exceptionsHandler: TelegrafExceptionsHandler, - ): (ctx: TContext, next: Function) => Promise { - return async (ctx: TContext, next: Function) => { - try { - const result = await targetCallback(ctx, next); - return !isObservable(result) - ? result - : result.pipe( - catchError((error) => { - this.handleError(exceptionsHandler, [ctx, next], error); - return EMPTY; - }), - ); - } catch (error) { - this.handleError(exceptionsHandler, [ctx, next], error); - } - }; - } - - handleError( - exceptionsHandler: TelegrafExceptionsHandler, - args: unknown[], - error: T, - ): void { - const host = new ExecutionContextHost(args); - host.setType('telegraf'); - exceptionsHandler.handle(error, host); - } -} diff --git a/lib/decorators/params/message-text.decorator.ts b/lib/decorators/params/message-text.decorator.ts index b72b66f..4130186 100644 --- a/lib/decorators/params/message-text.decorator.ts +++ b/lib/decorators/params/message-text.decorator.ts @@ -1,15 +1,10 @@ import { PipeTransform, Type } from '@nestjs/common'; -import { createPipesTelegrafParamDecorator } from '../../utils/param-decorator.util'; +import { createTelegrafPipesParamDecorator } from '../../utils/param-decorator.util'; import { TelegrafParamtype } from '../../enums/telegraf-paramtype.enum'; -export function MessageText(): ParameterDecorator; -export function MessageText( - ...pipes: (Type | PipeTransform)[] -): ParameterDecorator; -export function MessageText( - ...pipes: (Type | PipeTransform)[] -): ParameterDecorator { - return createPipesTelegrafParamDecorator(TelegrafParamtype.MESSAGE_TEXT)( +export function MessageText(...pipes: (Type | PipeTransform)[]) { + return createTelegrafPipesParamDecorator(TelegrafParamtype.MESSAGE_TEXT)( + undefined, ...pipes, ); } diff --git a/lib/exceptions/base-telegraf-exception-filter.ts b/lib/exceptions/base-telegraf-exception-filter.ts deleted file mode 100644 index 81434d2..0000000 --- a/lib/exceptions/base-telegraf-exception-filter.ts +++ /dev/null @@ -1,34 +0,0 @@ -import { ArgumentsHost, Logger } from '@nestjs/common'; -import { MESSAGES } from '@nestjs/core/constants'; -import { Context } from 'telegraf'; -import { TelegrafExceptionFilter } from '../interfaces/telegraf-exception-filter.interface'; -import { TelegrafException } from '../errors'; -import { isErrorObject } from '../helpers/is-error-object.helper'; -import { TelegrafArgumentsHost } from '../execution-context'; - -export class BaseTelegrafExceptionFilter - implements TelegrafExceptionFilter { - private static readonly logger = new Logger('TelegrafExceptionsHandler'); - - catch(exception: TError, host: ArgumentsHost): void { - const context = TelegrafArgumentsHost.create(host).getContext(); - this.handleError(exception, context); - } - - public handleError(exception: TError, context: Context): void { - if (!(exception instanceof TelegrafException)) { - return this.handleUnknownError(exception, context); - } - - context.reply(exception.message); - } - - public handleUnknownError(exception: TError, context: Context): void { - context.reply(MESSAGES.UNKNOWN_EXCEPTION_MESSAGE); - - const errorMessage = isErrorObject(exception) - ? exception.message - : exception; - BaseTelegrafExceptionFilter.logger.error(errorMessage); - } -} diff --git a/lib/exceptions/index.ts b/lib/exceptions/index.ts deleted file mode 100644 index b7309ed..0000000 --- a/lib/exceptions/index.ts +++ /dev/null @@ -1 +0,0 @@ -export * from './base-telegraf-exception-filter'; diff --git a/lib/exceptions/telegraf-exceptions-handler.ts b/lib/exceptions/telegraf-exceptions-handler.ts deleted file mode 100644 index ba9985c..0000000 --- a/lib/exceptions/telegraf-exceptions-handler.ts +++ /dev/null @@ -1,48 +0,0 @@ -import { ArgumentsHost } from '@nestjs/common'; -import { ExceptionFilterMetadata } from '@nestjs/common/interfaces/exceptions'; -import { BaseTelegrafExceptionFilter } from './base-telegraf-exception-filter'; -import { TelegrafException } from '../errors'; -import { InvalidExceptionFilterException } from '@nestjs/core/errors/exceptions/invalid-exception-filter.exception'; -import { isEmpty } from '@nestjs/common/utils/shared.utils'; - -export class TelegrafExceptionsHandler extends BaseTelegrafExceptionFilter { - private filters: ExceptionFilterMetadata[] = []; - - public handle( - exception: Error | TelegrafException | any, - host: ArgumentsHost, - ): void { - const isFilterInvoked = this.invokeCustomFilters(exception, host); - if (!isFilterInvoked) { - super.catch(exception, host); - } - } - - public invokeCustomFilters( - exception: T, - args: ArgumentsHost, - ): boolean { - if (isEmpty(this.filters)) return false; - - const filter = this.filters.find(({ exceptionMetatypes }) => { - const hasMetatype = - !exceptionMetatypes.length || - exceptionMetatypes.some( - (ExceptionMetatype) => exception instanceof ExceptionMetatype, - ); - return hasMetatype; - }); - - filter && filter.func(exception, args); - - return !!filter; - } - - public setCustomFilters(filters: ExceptionFilterMetadata[]): void { - if (!Array.isArray(filters)) { - throw new InvalidExceptionFilterException(); - } - - this.filters = filters; - } -} diff --git a/lib/explorers/telegraf-update.explorer.ts b/lib/explorers/telegraf-update.explorer.ts index 123febb..1246509 100644 --- a/lib/explorers/telegraf-update.explorer.ts +++ b/lib/explorers/telegraf-update.explorer.ts @@ -3,25 +3,18 @@ import { Injectable as IInjectable } from '@nestjs/common/interfaces/injectable. import { DiscoveryService, ModuleRef, ModulesContainer } from '@nestjs/core'; import { MetadataScanner } from '@nestjs/core/metadata-scanner'; import { InstanceWrapper } from '@nestjs/core/injector/instance-wrapper'; -import { PipesContextCreator } from '@nestjs/core/pipes/pipes-context-creator'; -import { PipesConsumer } from '@nestjs/core/pipes/pipes-consumer'; -import { GuardsContextCreator } from '@nestjs/core/guards/guards-context-creator'; -import { GuardsConsumer } from '@nestjs/core/guards/guards-consumer'; -import { InterceptorsContextCreator } from '@nestjs/core/interceptors/interceptors-context-creator'; -import { InterceptorsConsumer } from '@nestjs/core/interceptors/interceptors-consumer'; import { isFunction, isNil } from '@nestjs/common/utils/shared.utils'; import { fromPromise } from 'rxjs/internal-compatibility'; import { filter, mergeAll } from 'rxjs/operators'; import { Observable, of } from 'rxjs'; import { Context, Telegraf } from 'telegraf'; import { TelegrafMetadataAccessor } from '../telegraf.metadata-accessor'; -import { TelegrafContextCreator } from '../context/telegraf-context-creator'; -import { TelegrafProxy } from '../context/telegraf-proxy'; -import { FiltersContextCreator } from '../context/filters-context-creator'; +import { ExternalContextCreator } from '@nestjs/core/helpers/external-context-creator'; +import { TelegrafParamsFactory } from '../factories/telegraf-params-factory'; @Injectable() export class TelegrafUpdateExplorer implements OnModuleInit { - private readonly contextCreator: TelegrafContextCreator; + private readonly telegrafParamsFactory = new TelegrafParamsFactory(); constructor( private readonly moduleRef: ModuleRef, @@ -29,24 +22,9 @@ export class TelegrafUpdateExplorer implements OnModuleInit { private readonly discoveryService: DiscoveryService, private readonly metadataAccessor: TelegrafMetadataAccessor, private readonly metadataScanner: MetadataScanner, + private readonly externalContextCreator: ExternalContextCreator, @Inject(Telegraf) private readonly telegraf: Telegraf, - ) { - this.contextCreator = this.getContextCreator(); - } - - private getContextCreator(): TelegrafContextCreator { - const { container } = this.moduleRef as any; - return new TelegrafContextCreator( - new TelegrafProxy(), - new FiltersContextCreator(container), - new PipesContextCreator(container), - new PipesConsumer(), - new GuardsContextCreator(container), - new GuardsConsumer(), - new InterceptorsContextCreator(container), - new InterceptorsConsumer(), - ); - } + ) {} onModuleInit(): void { this.explore(); @@ -87,11 +65,20 @@ export class TelegrafUpdateExplorer implements OnModuleInit { moduleName: string, ): void { const methodRef = instance[methodKey] as (...args: unknown[]) => unknown; - const contextHandlerFn = this.contextCreator.create( + const contextHandlerFn = this.externalContextCreator.create( instance, methodRef, moduleName, methodKey, + this.telegrafParamsFactory, + null, + null, + { + interceptors: true, + filters: true, + guards: true, + }, + 'telegraf', ); const listenerMetadata = this.metadataAccessor.getListenerMetadata( diff --git a/lib/helpers/is-error-object.helper.ts b/lib/helpers/is-error-object.helper.ts deleted file mode 100644 index 9ff248c..0000000 --- a/lib/helpers/is-error-object.helper.ts +++ /dev/null @@ -1,5 +0,0 @@ -import { isObject } from '@nestjs/common/utils/shared.utils'; - -export function isErrorObject(err: any): err is Error { - return isObject(err) && !!(err as Error).message; -} diff --git a/lib/helpers/is-observable.helper.ts b/lib/helpers/is-observable.helper.ts deleted file mode 100644 index c928e23..0000000 --- a/lib/helpers/is-observable.helper.ts +++ /dev/null @@ -1,5 +0,0 @@ -import { isFunction } from '@nestjs/common/utils/shared.utils'; - -export function isObservable(result: any): boolean { - return result && isFunction(result.subscribe); -} diff --git a/lib/telegraf.constants.ts b/lib/telegraf.constants.ts index c1cc166..f9452d6 100644 --- a/lib/telegraf.constants.ts +++ b/lib/telegraf.constants.ts @@ -1,7 +1,4 @@ -import { - CUSTOM_ROUTE_AGRS_METADATA, - ROUTE_ARGS_METADATA, -} from '@nestjs/common/constants'; +import { ROUTE_ARGS_METADATA } from '@nestjs/common/constants'; export const TELEGRAF_MODULE_OPTIONS = 'TELEGRAF_MODULE_OPTIONS'; @@ -10,5 +7,4 @@ export const UPDATE_LISTENER_METADATA = 'UPDATE_LISTENER_METADATA'; export const SCENE_METADATA = 'SCENE_METADATA'; -export const LISTENER_ARGS_METADATA = ROUTE_ARGS_METADATA; -export const CUSTOM_LISTENER_AGRS_METADATA = CUSTOM_ROUTE_AGRS_METADATA; +export const PARAM_ARGS_METADATA = ROUTE_ARGS_METADATA; diff --git a/lib/utils/param-decorator.util.ts b/lib/utils/param-decorator.util.ts index f344951..986ab90 100644 --- a/lib/utils/param-decorator.util.ts +++ b/lib/utils/param-decorator.util.ts @@ -1,39 +1,86 @@ import { assignMetadata, PipeTransform, Type } from '@nestjs/common'; +import { isNil, isString } from '@nestjs/common/utils/shared.utils'; import { TelegrafParamtype } from '../enums/telegraf-paramtype.enum'; -import { LISTENER_ARGS_METADATA } from '../telegraf.constants'; +import { PARAM_ARGS_METADATA } from '../telegraf.constants'; -export function createTelegrafParamDecorator( - paramtype: TelegrafParamtype, -): (...pipes: (Type | PipeTransform)[]) => ParameterDecorator { - return (...pipes: (Type | PipeTransform)[]) => ( - target, - key, - index, - ) => { +export type ParamData = object | string | number; + +export const createTelegrafParamDecorator = (paramtype: TelegrafParamtype) => { + return (data?: ParamData): ParameterDecorator => (target, key, index) => { const args = - Reflect.getMetadata(LISTENER_ARGS_METADATA, target.constructor, key) || - {}; + Reflect.getMetadata(PARAM_ARGS_METADATA, target.constructor, key) || {}; Reflect.defineMetadata( - LISTENER_ARGS_METADATA, - assignMetadata(args, paramtype, index, undefined, ...pipes), + PARAM_ARGS_METADATA, + assignMetadata(args, paramtype, index, data), target.constructor, key, ); }; -} +}; -export const createPipesTelegrafParamDecorator = ( +export const createTelegrafPipesParamDecorator = ( paramtype: TelegrafParamtype, ) => ( + data?: any, ...pipes: (Type | PipeTransform)[] ): ParameterDecorator => (target, key, index) => { + addPipesMetadata(paramtype, data, pipes, target, key, index); +}; + +export const addPipesMetadata = ( + paramtype: TelegrafParamtype, + data: any, + pipes: (Type | PipeTransform)[], + target: Record, + key: string | symbol, + index: number, +) => { const args = - Reflect.getMetadata(LISTENER_ARGS_METADATA, target.constructor, key) || {}; + Reflect.getMetadata(PARAM_ARGS_METADATA, target.constructor, key) || {}; + const hasParamData = isNil(data) || isString(data); + const paramData = hasParamData ? data : undefined; + const paramPipes = hasParamData ? pipes : [data, ...pipes]; Reflect.defineMetadata( - LISTENER_ARGS_METADATA, - assignMetadata(args, paramtype, index, undefined, ...pipes), + PARAM_ARGS_METADATA, + assignMetadata(args, paramtype, index, paramData, ...paramPipes), target.constructor, key, ); }; + +// export function createTelegrafParamDecorator( +// paramtype: TelegrafParamtype, +// ): (...pipes: (Type | PipeTransform)[]) => ParameterDecorator { +// return (...pipes: (Type | PipeTransform)[]) => ( +// target, +// key, +// index, +// ) => { +// const args = +// Reflect.getMetadata(LISTENER_ARGS_METADATA, target.constructor, key) || +// {}; +// Reflect.defineMetadata( +// LISTENER_ARGS_METADATA, +// assignMetadata(args, paramtype, index, undefined, ...pipes), +// target.constructor, +// key, +// ); +// }; +// } +// +// export const createPipesTelegrafParamDecorator = ( +// paramtype: TelegrafParamtype, +// ) => ( +// ...pipes: (Type | PipeTransform)[] +// ): ParameterDecorator => (target, key, index) => { +// const args = +// Reflect.getMetadata(LISTENER_ARGS_METADATA, target.constructor, key) || {}; +// +// Reflect.defineMetadata( +// LISTENER_ARGS_METADATA, +// assignMetadata(args, paramtype, index, undefined, ...pipes), +// target.constructor, +// key, +// ); +// }; From 75ff810c34b713133f73c637724c848f56207d65 Mon Sep 17 00:00:00 2001 From: Morb0 Date: Tue, 5 Jan 2021 12:37:04 +0300 Subject: [PATCH 04/19] feat(): wip --- lib/explorers/telegraf-update.explorer.ts | 8 +- lib/factories/telegraf-params-factory.ts | 19 +++-- lib/services/listeners-explorer.service.ts | 92 +++++++++++++++++---- lib/services/metadata-accessor.service.ts | 4 +- lib/telegraf.constants.ts | 3 +- lib/utils/create-listener-decorator.util.ts | 6 +- lib/utils/param-decorator.util.ts | 36 -------- 7 files changed, 98 insertions(+), 70 deletions(-) diff --git a/lib/explorers/telegraf-update.explorer.ts b/lib/explorers/telegraf-update.explorer.ts index 1246509..9a7ac43 100644 --- a/lib/explorers/telegraf-update.explorer.ts +++ b/lib/explorers/telegraf-update.explorer.ts @@ -1,17 +1,19 @@ import { Inject, Injectable, OnModuleInit } from '@nestjs/common'; -import { Injectable as IInjectable } from '@nestjs/common/interfaces/injectable.interface'; import { DiscoveryService, ModuleRef, ModulesContainer } from '@nestjs/core'; import { MetadataScanner } from '@nestjs/core/metadata-scanner'; import { InstanceWrapper } from '@nestjs/core/injector/instance-wrapper'; import { isFunction, isNil } from '@nestjs/common/utils/shared.utils'; +import { ExternalContextCreator } from '@nestjs/core/helpers/external-context-creator'; import { fromPromise } from 'rxjs/internal-compatibility'; import { filter, mergeAll } from 'rxjs/operators'; import { Observable, of } from 'rxjs'; import { Context, Telegraf } from 'telegraf'; + import { TelegrafMetadataAccessor } from '../telegraf.metadata-accessor'; -import { ExternalContextCreator } from '@nestjs/core/helpers/external-context-creator'; import { TelegrafParamsFactory } from '../factories/telegraf-params-factory'; +// TODO: DELETE THIS CLASS + @Injectable() export class TelegrafUpdateExplorer implements OnModuleInit { private readonly telegrafParamsFactory = new TelegrafParamsFactory(); @@ -37,7 +39,7 @@ export class TelegrafUpdateExplorer implements OnModuleInit { } private exploreProviders( - providers: Map>, + providers: Map>, moduleName: string, ): void { [...providers.values()] diff --git a/lib/factories/telegraf-params-factory.ts b/lib/factories/telegraf-params-factory.ts index 7f9adbf..df4b7e0 100644 --- a/lib/factories/telegraf-params-factory.ts +++ b/lib/factories/telegraf-params-factory.ts @@ -1,15 +1,18 @@ +import { ParamsFactory } from '@nestjs/core/helpers/external-context-creator'; +import { Context } from 'telegraf'; import { TelegrafParamtype } from '../enums/telegraf-paramtype.enum'; -export class TelegrafParamsFactory { - exchangeKeyForValue< - TContext extends Record = any, - TResult = any - >(type: number, ctx: TContext, next: Function): TResult { - switch (type as TelegrafParamtype) { +export class TelegrafParamsFactory implements ParamsFactory { + exchangeKeyForValue( + type: TelegrafParamtype, + ctx: Context, + next: Function, + ): unknown { + switch (type) { case TelegrafParamtype.CONTEXT: - return ctx as any; + return ctx; case TelegrafParamtype.NEXT: - return next as any; + return next; case TelegrafParamtype.SENDER: return ctx.from; case TelegrafParamtype.MESSAGE: diff --git a/lib/services/listeners-explorer.service.ts b/lib/services/listeners-explorer.service.ts index eb0b789..05abc1e 100644 --- a/lib/services/listeners-explorer.service.ts +++ b/lib/services/listeners-explorer.service.ts @@ -6,17 +6,30 @@ import { Module } from '@nestjs/core/injector/module'; import { BaseScene, Composer, Stage, Telegraf } from 'telegraf'; import { MetadataAccessorService } from './metadata-accessor.service'; -import { TELEGRAF_MODULE_OPTIONS } from '../telegraf.constants'; -import { TelegrafModuleOptions } from '../interfaces'; +import { + PARAM_ARGS_METADATA, + TELEGRAF_MODULE_OPTIONS, +} from '../telegraf.constants'; +import { ListenerMetadata, TelegrafModuleOptions } from '../interfaces'; import { BaseExplorerService } from './base-explorer.service'; import { getBotToken } from '../utils'; +import { ExternalContextCreator } from '@nestjs/core/helpers/external-context-creator'; +import { TelegrafParamsFactory } from '../factories/telegraf-params-factory'; +import { TelegrafContextType } from '../execution-context/telegraf-execution-context'; +import { ParamMetadata } from '@nestjs/core/helpers/interfaces'; + +interface ListenerCallbackMetadata { + methodName: string; + metadata: ListenerMetadata; +} @Injectable() export class ListenersExplorerService extends BaseExplorerService implements OnModuleInit { + private readonly telegrafParamsFactory = new TelegrafParamsFactory(); private readonly stage = new Stage([]); - private bot: Telegraf; + private bot: Telegraf; constructor( @Inject(TELEGRAF_MODULE_OPTIONS) @@ -26,6 +39,7 @@ export class ListenersExplorerService private readonly metadataAccessor: MetadataAccessorService, private readonly metadataScanner: MetadataScanner, private readonly modulesContainer: ModulesContainer, + private readonly externalContextCreator: ExternalContextCreator, ) { super(); } @@ -58,17 +72,18 @@ export class ListenersExplorerService } private registerScenes(modules: Module[]): void { - const scenes = this.flatMap(modules, (instance) => - this.filterScenes(instance), + const scenes = this.flatMap( + modules, + (instance, moduleRef) => this.filterScenes(instance), ); - scenes.forEach(({ instance }) => { + scenes.forEach((wrapper) => { const sceneId = this.metadataAccessor.getSceneMetadata( instance.constructor, ); const scene = new BaseScene(sceneId); this.stage.register(scene); - this.registerInstanceMethodListeners(scene, instance); + this.registerInstanceMethodListeners(scene, wrapper); }); } @@ -94,18 +109,63 @@ export class ListenersExplorerService private registerInstanceMethodListeners( composer: Composer, - instance: Record, + wrapper: InstanceWrapper, ): void { + const { instance } = wrapper; const prototype = Object.getPrototypeOf(instance); - this.metadataScanner.scanFromPrototype(instance, prototype, (name) => { - const methodRef = instance[name]; + const listenersMetadata = this.metadataScanner.scanFromPrototype( + instance, + prototype, + (name): ListenerCallbackMetadata => + this.extractListenerCallbackMetadata(prototype, name), + ); - const metadata = this.metadataAccessor.getListenerMetadata(methodRef); - if (!metadata) return; + const contextCallbackFn = this.createContextCallback( + instance, + prototype, + wrapper, + ); + } - const middlewareFn = methodRef.bind(instance); - const { method, args } = metadata; - composer[method](...args, middlewareFn); - }); + private extractListenerCallbackMetadata( + prototype: any, + methodName: string, + ): ListenerCallbackMetadata { + const callback = prototype[methodName]; + const metadata = this.metadataAccessor.getListenerMetadata(callback); + + if (!metadata) { + return undefined; + } + + return { + methodName, + metadata: metadata, + }; + } + + createContextCallback>( + instance: T, + prototype: unknown, + wrapper: InstanceWrapper, + moduleRef: Module, + listener: ListenerMetadata, + ) { + const paramsFactory = this.telegrafParamsFactory; + const resolverCallback = this.externalContextCreator.create< + Record, + TelegrafContextType + >( + instance, + prototype[listener.methodName], + listener.methodName, + PARAM_ARGS_METADATA, + paramsFactory, + undefined, + undefined, + undefined, + 'telegraf', + ); + return resolverCallback; } } diff --git a/lib/services/metadata-accessor.service.ts b/lib/services/metadata-accessor.service.ts index 322899a..62a785d 100644 --- a/lib/services/metadata-accessor.service.ts +++ b/lib/services/metadata-accessor.service.ts @@ -2,7 +2,7 @@ import { Injectable } from '@nestjs/common'; import { Reflector } from '@nestjs/core'; import { SCENE_METADATA, - UPDATE_LISTENER_METADATA, + LISTENER_METADATA, UPDATE_METADATA, } from '../telegraf.constants'; import { ListenerMetadata } from '../interfaces'; @@ -27,7 +27,7 @@ export class MetadataAccessorService { } getListenerMetadata(target: Function): ListenerMetadata | undefined { - return this.reflector.get(UPDATE_LISTENER_METADATA, target); + return this.reflector.get(LISTENER_METADATA, target); } getSceneMetadata(target: Function): string | undefined { diff --git a/lib/telegraf.constants.ts b/lib/telegraf.constants.ts index bbff974..b7d4c7d 100644 --- a/lib/telegraf.constants.ts +++ b/lib/telegraf.constants.ts @@ -4,8 +4,7 @@ export const TELEGRAF_MODULE_OPTIONS = 'TELEGRAF_MODULE_OPTIONS'; export const DEFAULT_BOT_NAME = 'DEFAULT_BOT_NAME'; export const UPDATE_METADATA = 'UPDATE_METADATA'; -export const UPDATE_LISTENER_METADATA = 'UPDATE_LISTENER_METADATA'; - export const SCENE_METADATA = 'SCENE_METADATA'; +export const LISTENER_METADATA = 'LISTENER_METADATA'; export const PARAM_ARGS_METADATA = ROUTE_ARGS_METADATA; diff --git a/lib/utils/create-listener-decorator.util.ts b/lib/utils/create-listener-decorator.util.ts index de482fd..b880fcb 100644 --- a/lib/utils/create-listener-decorator.util.ts +++ b/lib/utils/create-listener-decorator.util.ts @@ -1,7 +1,7 @@ import { SetMetadata } from '@nestjs/common'; import { BaseScene as Scene } from 'telegraf'; import { ComposerMethodArgs, SceneMethods } from '../types'; -import { UPDATE_LISTENER_METADATA } from '../telegraf.constants'; +import { LISTENER_METADATA } from '../telegraf.constants'; import { ListenerMetadata } from '../interfaces'; export function createListenerDecorator( @@ -10,7 +10,7 @@ export function createListenerDecorator( return ( ...args: ComposerMethodArgs, TMethod> ): MethodDecorator => { - return SetMetadata(UPDATE_LISTENER_METADATA, { + return SetMetadata(LISTENER_METADATA, { method, args, } as ListenerMetadata); @@ -21,7 +21,7 @@ export function createMissedListenerDecorator( method: string, ) { return (...args: TArgs): MethodDecorator => { - return SetMetadata(UPDATE_LISTENER_METADATA, { + return SetMetadata(LISTENER_METADATA, { method, args, } as ListenerMetadata); diff --git a/lib/utils/param-decorator.util.ts b/lib/utils/param-decorator.util.ts index 986ab90..6a2d261 100644 --- a/lib/utils/param-decorator.util.ts +++ b/lib/utils/param-decorator.util.ts @@ -48,39 +48,3 @@ export const addPipesMetadata = ( key, ); }; - -// export function createTelegrafParamDecorator( -// paramtype: TelegrafParamtype, -// ): (...pipes: (Type | PipeTransform)[]) => ParameterDecorator { -// return (...pipes: (Type | PipeTransform)[]) => ( -// target, -// key, -// index, -// ) => { -// const args = -// Reflect.getMetadata(LISTENER_ARGS_METADATA, target.constructor, key) || -// {}; -// Reflect.defineMetadata( -// LISTENER_ARGS_METADATA, -// assignMetadata(args, paramtype, index, undefined, ...pipes), -// target.constructor, -// key, -// ); -// }; -// } -// -// export const createPipesTelegrafParamDecorator = ( -// paramtype: TelegrafParamtype, -// ) => ( -// ...pipes: (Type | PipeTransform)[] -// ): ParameterDecorator => (target, key, index) => { -// const args = -// Reflect.getMetadata(LISTENER_ARGS_METADATA, target.constructor, key) || {}; -// -// Reflect.defineMetadata( -// LISTENER_ARGS_METADATA, -// assignMetadata(args, paramtype, index, undefined, ...pipes), -// target.constructor, -// key, -// ); -// }; From 84f90495ea3e3246571617ec9bb2fdedeeca9ee2 Mon Sep 17 00:00:00 2001 From: Morb0 Date: Wed, 6 Jan 2021 16:57:27 +0300 Subject: [PATCH 05/19] fix(eslint): use prettier plugin --- .eslintrc.js | 3 +- package-lock.json | 590 ++-------------------------------------------- package.json | 2 +- 3 files changed, 22 insertions(+), 573 deletions(-) diff --git a/.eslintrc.js b/.eslintrc.js index 0ed1b02..d02a15c 100644 --- a/.eslintrc.js +++ b/.eslintrc.js @@ -6,10 +6,9 @@ module.exports = { }, plugins: ['@typescript-eslint/eslint-plugin'], extends: [ - 'plugin:@typescript-eslint/eslint-recommended', 'plugin:@typescript-eslint/recommended', - 'prettier', 'prettier/@typescript-eslint', + 'plugin:prettier/recommended', ], root: true, env: { diff --git a/package-lock.json b/package-lock.json index 6302095..d540c63 100644 --- a/package-lock.json +++ b/package-lock.json @@ -185,12 +185,6 @@ "integrity": "sha512-3c+yGKvVP5Y9TYBEibGNR+kLtijnj7mYrXRg+WpFb2X9xm04g/DXYkfg4hmzJQosc9snFNUPkbYIhu+KAm6jJw==", "dev": true }, - "@types/json5": { - "version": "0.0.29", - "resolved": "https://registry.npmjs.org/@types/json5/-/json5-0.0.29.tgz", - "integrity": "sha1-7ihweulOEdK4J7y+UnC86n8+ce4=", - "dev": true - }, "@types/lodash": { "version": "4.14.167", "resolved": "https://registry.npmjs.org/@types/lodash/-/lodash-4.14.167.tgz", @@ -369,33 +363,12 @@ "sprintf-js": "~1.0.2" } }, - "array-includes": { - "version": "3.1.1", - "resolved": "https://registry.npmjs.org/array-includes/-/array-includes-3.1.1.tgz", - "integrity": "sha512-c2VXaCHl7zPsvpkFsw4nxvFie4fh1ur9bpcgsVkIjqn0H/Xwdg+7fv3n2r/isyS8EBj5b06M9kHyZuIr4El6WQ==", - "dev": true, - "requires": { - "define-properties": "^1.1.3", - "es-abstract": "^1.17.0", - "is-string": "^1.0.5" - } - }, "array-union": { "version": "2.1.0", "resolved": "https://registry.npmjs.org/array-union/-/array-union-2.1.0.tgz", "integrity": "sha512-HGyxoOTYUyCM6stUe6EJgnd4EoewAI7zMdfqO+kGjnlZmBDz/cR5pf8r/cR4Wq60sL/p0IkcjUEEPwS3GFrIyw==", "dev": true }, - "array.prototype.flat": { - "version": "1.2.3", - "resolved": "https://registry.npmjs.org/array.prototype.flat/-/array.prototype.flat-1.2.3.tgz", - "integrity": "sha512-gBlRZV0VSmfPIeWfuuy56XZMvbVfbEUnOXUvt3F/eUUUSyzlgLxhEX4YAEpxNAogRGehPSnfXyPtYyKAhkzQhQ==", - "dev": true, - "requires": { - "define-properties": "^1.1.3", - "es-abstract": "^1.17.0-next.1" - } - }, "astral-regex": { "version": "2.0.0", "resolved": "https://registry.npmjs.org/astral-regex/-/astral-regex-2.0.0.tgz", @@ -535,12 +508,6 @@ "integrity": "sha512-vlcSGgdYS26mPf7qNi+dCisbhiyDnrN1zaRbw3CSuc2wGOMEGGPsp46PdRG5gqXwgtJfjxDkxRNAgRPr1B77vQ==", "dev": true }, - "contains-path": { - "version": "0.1.0", - "resolved": "https://registry.npmjs.org/contains-path/-/contains-path-0.1.0.tgz", - "integrity": "sha1-/ozxhP9mcLa67wGp1IYaXL7EEgo=", - "dev": true - }, "cosmiconfig": { "version": "7.0.0", "resolved": "https://registry.npmjs.org/cosmiconfig/-/cosmiconfig-7.0.0.tgz", @@ -594,15 +561,6 @@ "integrity": "sha1-s2nW+128E+7PUk+RsHD+7cNXzzQ=", "dev": true }, - "define-properties": { - "version": "1.1.3", - "resolved": "https://registry.npmjs.org/define-properties/-/define-properties-1.1.3.tgz", - "integrity": "sha512-3MqfYKj2lLzdMSf8ZIZE/V+Zuy+BgD6f164e8K2w7dgnpKArBDerGYpM46IYYcjnkdPNMjPk9A6VFB8+3SKlXQ==", - "dev": true, - "requires": { - "object-keys": "^1.0.12" - } - }, "dir-glob": { "version": "3.0.1", "resolved": "https://registry.npmjs.org/dir-glob/-/dir-glob-3.0.1.tgz", @@ -654,36 +612,6 @@ "is-arrayish": "^0.2.1" } }, - "es-abstract": { - "version": "1.17.6", - "resolved": "https://registry.npmjs.org/es-abstract/-/es-abstract-1.17.6.tgz", - "integrity": "sha512-Fr89bON3WFyUi5EvAeI48QTWX0AyekGgLA8H+c+7fbfCkJwRWRMLd8CQedNEyJuoYYhmtEqY92pgte1FAhBlhw==", - "dev": true, - "requires": { - "es-to-primitive": "^1.2.1", - "function-bind": "^1.1.1", - "has": "^1.0.3", - "has-symbols": "^1.0.1", - "is-callable": "^1.2.0", - "is-regex": "^1.1.0", - "object-inspect": "^1.7.0", - "object-keys": "^1.1.1", - "object.assign": "^4.1.0", - "string.prototype.trimend": "^1.0.1", - "string.prototype.trimstart": "^1.0.1" - } - }, - "es-to-primitive": { - "version": "1.2.1", - "resolved": "https://registry.npmjs.org/es-to-primitive/-/es-to-primitive-1.2.1.tgz", - "integrity": "sha512-QCOllgZJtaUo9miYBcLChTUaHNjJF3PYs1VidD7AwiEj1kYxKeQTctLAezAOH5ZKRH0g2IgPn6KwB4IT8iRpvA==", - "dev": true, - "requires": { - "is-callable": "^1.1.4", - "is-date-object": "^1.0.1", - "is-symbol": "^1.0.2" - } - }, "escape-string-regexp": { "version": "1.0.5", "resolved": "https://registry.npmjs.org/escape-string-regexp/-/escape-string-regexp-1.0.5.tgz", @@ -798,146 +726,13 @@ "integrity": "sha512-9sm5/PxaFG7qNJvJzTROMM1Bk1ozXVTKI0buKOyb0Bsr1hrwi0H/TzxF/COtf1uxikIK8SwhX7K6zg78jAzbeA==", "dev": true }, - "eslint-import-resolver-node": { - "version": "0.3.4", - "resolved": "https://registry.npmjs.org/eslint-import-resolver-node/-/eslint-import-resolver-node-0.3.4.tgz", - "integrity": "sha512-ogtf+5AB/O+nM6DIeBUNr2fuT7ot9Qg/1harBfBtaP13ekEWFQEEMP94BCB7zaNW3gyY+8SHYF00rnqYwXKWOA==", + "eslint-plugin-prettier": { + "version": "3.3.1", + "resolved": "https://registry.npmjs.org/eslint-plugin-prettier/-/eslint-plugin-prettier-3.3.1.tgz", + "integrity": "sha512-Rq3jkcFY8RYeQLgk2cCwuc0P7SEFwDravPhsJZOQ5N4YI4DSg50NyqJ/9gdZHzQlHf8MvafSesbNJCcP/FF6pQ==", "dev": true, "requires": { - "debug": "^2.6.9", - "resolve": "^1.13.1" - }, - "dependencies": { - "debug": { - "version": "2.6.9", - "resolved": "https://registry.npmjs.org/debug/-/debug-2.6.9.tgz", - "integrity": "sha512-bC7ElrdJaJnPbAP+1EotYvqZsb3ecl5wi6Bfi6BJTUcNowp6cvspg0jXznRTKDjm/E7AdgFBVeAPVMNcKGsHMA==", - "dev": true, - "requires": { - "ms": "2.0.0" - } - } - } - }, - "eslint-module-utils": { - "version": "2.6.0", - "resolved": "https://registry.npmjs.org/eslint-module-utils/-/eslint-module-utils-2.6.0.tgz", - "integrity": "sha512-6j9xxegbqe8/kZY8cYpcp0xhbK0EgJlg3g9mib3/miLaExuuwc3n5UEfSnU6hWMbT0FAYVvDbL9RrRgpUeQIvA==", - "dev": true, - "requires": { - "debug": "^2.6.9", - "pkg-dir": "^2.0.0" - }, - "dependencies": { - "debug": { - "version": "2.6.9", - "resolved": "https://registry.npmjs.org/debug/-/debug-2.6.9.tgz", - "integrity": "sha512-bC7ElrdJaJnPbAP+1EotYvqZsb3ecl5wi6Bfi6BJTUcNowp6cvspg0jXznRTKDjm/E7AdgFBVeAPVMNcKGsHMA==", - "dev": true, - "requires": { - "ms": "2.0.0" - } - }, - "find-up": { - "version": "2.1.0", - "resolved": "https://registry.npmjs.org/find-up/-/find-up-2.1.0.tgz", - "integrity": "sha1-RdG35QbHF93UgndaK3eSCjwMV6c=", - "dev": true, - "requires": { - "locate-path": "^2.0.0" - } - }, - "locate-path": { - "version": "2.0.0", - "resolved": "https://registry.npmjs.org/locate-path/-/locate-path-2.0.0.tgz", - "integrity": "sha1-K1aLJl7slExtnA3pw9u7ygNUzY4=", - "dev": true, - "requires": { - "p-locate": "^2.0.0", - "path-exists": "^3.0.0" - } - }, - "p-limit": { - "version": "1.3.0", - "resolved": "https://registry.npmjs.org/p-limit/-/p-limit-1.3.0.tgz", - "integrity": "sha512-vvcXsLAJ9Dr5rQOPk7toZQZJApBl2K4J6dANSsEuh6QI41JYcsS/qhTGa9ErIUUgK3WNQoJYvylxvjqmiqEA9Q==", - "dev": true, - "requires": { - "p-try": "^1.0.0" - } - }, - "p-locate": { - "version": "2.0.0", - "resolved": "https://registry.npmjs.org/p-locate/-/p-locate-2.0.0.tgz", - "integrity": "sha1-IKAQOyIqcMj9OcwuWAaA893l7EM=", - "dev": true, - "requires": { - "p-limit": "^1.1.0" - } - }, - "p-try": { - "version": "1.0.0", - "resolved": "https://registry.npmjs.org/p-try/-/p-try-1.0.0.tgz", - "integrity": "sha1-y8ec26+P1CKOE/Yh8rGiN8GyB7M=", - "dev": true - }, - "path-exists": { - "version": "3.0.0", - "resolved": "https://registry.npmjs.org/path-exists/-/path-exists-3.0.0.tgz", - "integrity": "sha1-zg6+ql94yxiSXqfYENe1mwEP1RU=", - "dev": true - }, - "pkg-dir": { - "version": "2.0.0", - "resolved": "https://registry.npmjs.org/pkg-dir/-/pkg-dir-2.0.0.tgz", - "integrity": "sha1-9tXREJ4Z1j7fQo4L1X4Sd3YVM0s=", - "dev": true, - "requires": { - "find-up": "^2.1.0" - } - } - } - }, - "eslint-plugin-import": { - "version": "2.22.1", - "resolved": "https://registry.npmjs.org/eslint-plugin-import/-/eslint-plugin-import-2.22.1.tgz", - "integrity": "sha512-8K7JjINHOpH64ozkAhpT3sd+FswIZTfMZTjdx052pnWrgRCVfp8op9tbjpAk3DdUeI/Ba4C8OjdC0r90erHEOw==", - "dev": true, - "requires": { - "array-includes": "^3.1.1", - "array.prototype.flat": "^1.2.3", - "contains-path": "^0.1.0", - "debug": "^2.6.9", - "doctrine": "1.5.0", - "eslint-import-resolver-node": "^0.3.4", - "eslint-module-utils": "^2.6.0", - "has": "^1.0.3", - "minimatch": "^3.0.4", - "object.values": "^1.1.1", - "read-pkg-up": "^2.0.0", - "resolve": "^1.17.0", - "tsconfig-paths": "^3.9.0" - }, - "dependencies": { - "debug": { - "version": "2.6.9", - "resolved": "https://registry.npmjs.org/debug/-/debug-2.6.9.tgz", - "integrity": "sha512-bC7ElrdJaJnPbAP+1EotYvqZsb3ecl5wi6Bfi6BJTUcNowp6cvspg0jXznRTKDjm/E7AdgFBVeAPVMNcKGsHMA==", - "dev": true, - "requires": { - "ms": "2.0.0" - } - }, - "doctrine": { - "version": "1.5.0", - "resolved": "https://registry.npmjs.org/doctrine/-/doctrine-1.5.0.tgz", - "integrity": "sha1-N53Ocw9hZvds76TmcHoVmwLFpvo=", - "dev": true, - "requires": { - "esutils": "^2.0.2", - "isarray": "^1.0.0" - } - } + "prettier-linter-helpers": "^1.0.0" } }, "eslint-scope": { @@ -1051,6 +846,12 @@ "integrity": "sha512-f3qQ9oQy9j2AhBe/H9VC91wLmKBCCU/gDOnKNAYG5hswO7BLKj09Hc5HYNz9cGI++xlpDCIgDaitVs03ATR84Q==", "dev": true }, + "fast-diff": { + "version": "1.2.0", + "resolved": "https://registry.npmjs.org/fast-diff/-/fast-diff-1.2.0.tgz", + "integrity": "sha512-xJuoT5+L99XlZ8twedaRf6Ax2TgQVxvgZOYoPKqZufmJib0tL2tegPBOZb1pVNgIhlqDlA0eO0c3wBvQcmzx4w==", + "dev": true + }, "fast-glob": { "version": "3.2.4", "resolved": "https://registry.npmjs.org/fast-glob/-/fast-glob-3.2.4.tgz", @@ -1178,12 +979,6 @@ "integrity": "sha1-FQStJSMVjKpA20onh8sBQRmU6k8=", "dev": true }, - "function-bind": { - "version": "1.1.1", - "resolved": "https://registry.npmjs.org/function-bind/-/function-bind-1.1.1.tgz", - "integrity": "sha512-yIovAzMX49sF8Yl58fSCWJ5svSLuaibPxXQJFLmBObTuCr0Mf1KiPopGM9NiFjiYBCbfaa2Fh6breQ6ANVTI0A==", - "dev": true - }, "functional-red-black-tree": { "version": "1.0.1", "resolved": "https://registry.npmjs.org/functional-red-black-tree/-/functional-red-black-tree-1.0.1.tgz", @@ -1278,33 +1073,12 @@ "wordwrap": "^1.0.0" } }, - "has": { - "version": "1.0.3", - "resolved": "https://registry.npmjs.org/has/-/has-1.0.3.tgz", - "integrity": "sha512-f2dvO0VU6Oej7RkWJGrehjbzMAjFp5/VKPp5tTpWIV4JHHZK1/BxbFRtf/siA2SWTe09caDmVtYYzWEIbBS4zw==", - "dev": true, - "requires": { - "function-bind": "^1.1.1" - } - }, "has-flag": { "version": "3.0.0", "resolved": "https://registry.npmjs.org/has-flag/-/has-flag-3.0.0.tgz", "integrity": "sha1-tdRU3CGZriJWmfNGfloH87lVuv0=", "dev": true }, - "has-symbols": { - "version": "1.0.1", - "resolved": "https://registry.npmjs.org/has-symbols/-/has-symbols-1.0.1.tgz", - "integrity": "sha512-PLcsoqu++dmEIZB+6totNFKq/7Do+Z0u4oT0zKOJNl3lYK6vGwwu2hjHs+68OEZbTjiUE9bgOABXbP/GvrS0Kg==", - "dev": true - }, - "hosted-git-info": { - "version": "2.8.8", - "resolved": "https://registry.npmjs.org/hosted-git-info/-/hosted-git-info-2.8.8.tgz", - "integrity": "sha512-f/wzC2QaWBs7t9IYqB4T3sR1xviIViXJRJTWBlx2Gf3g0Xi5vI7Yy4koXQ1c9OYDGHN9sBy1DQ2AB8fqZBWhUg==", - "dev": true - }, "human-signals": { "version": "1.1.1", "resolved": "https://registry.npmjs.org/human-signals/-/human-signals-1.1.1.tgz", @@ -1437,18 +1211,6 @@ "integrity": "sha1-d8mYQFJ6qOyxqLppe4BkWnqSap0=", "dev": true }, - "is-callable": { - "version": "1.2.2", - "resolved": "https://registry.npmjs.org/is-callable/-/is-callable-1.2.2.tgz", - "integrity": "sha512-dnMqspv5nU3LoewK2N/y7KLtxtakvTuaCsU9FU50/QDmdbHNy/4/JuRtMHqRU22o3q+W89YQndQEeCVwK+3qrA==", - "dev": true - }, - "is-date-object": { - "version": "1.0.2", - "resolved": "https://registry.npmjs.org/is-date-object/-/is-date-object-1.0.2.tgz", - "integrity": "sha512-USlDT524woQ08aoZFzh3/Z6ch9Y/EWXEHQ/AaRN0SkKq4t2Jw2R2339tSXmwuVoY7LLlBCbOIlx2myP/L5zk0g==", - "dev": true - }, "is-extglob": { "version": "2.1.1", "resolved": "https://registry.npmjs.org/is-extglob/-/is-extglob-2.1.1.tgz", @@ -1470,12 +1232,6 @@ "is-extglob": "^2.1.1" } }, - "is-negative-zero": { - "version": "2.0.0", - "resolved": "https://registry.npmjs.org/is-negative-zero/-/is-negative-zero-2.0.0.tgz", - "integrity": "sha1-lVOxIbD6wohp2p7UWeIMdUN4hGE=", - "dev": true - }, "is-number": { "version": "7.0.0", "resolved": "https://registry.npmjs.org/is-number/-/is-number-7.0.0.tgz", @@ -1488,15 +1244,6 @@ "integrity": "sha1-PkcprB9f3gJc19g6iW2rn09n2w8=", "dev": true }, - "is-regex": { - "version": "1.1.1", - "resolved": "https://registry.npmjs.org/is-regex/-/is-regex-1.1.1.tgz", - "integrity": "sha512-1+QkEcxiLlB7VEyFtyBg94e08OAsvq7FUBgApTq/w2ymCLyKJgDPsybBENVtA7XCQEgEXxKPonG+mvYRxh/LIg==", - "dev": true, - "requires": { - "has-symbols": "^1.0.1" - } - }, "is-regexp": { "version": "1.0.0", "resolved": "https://registry.npmjs.org/is-regexp/-/is-regexp-1.0.0.tgz", @@ -1509,27 +1256,6 @@ "integrity": "sha512-XCoy+WlUr7d1+Z8GgSuXmpuUFC9fOhRXglJMx+dwLKTkL44Cjd4W1Z5P+BQZpr+cR93aGP4S/s7Ftw6Nd/kiEw==", "dev": true }, - "is-string": { - "version": "1.0.5", - "resolved": "https://registry.npmjs.org/is-string/-/is-string-1.0.5.tgz", - "integrity": "sha512-buY6VNRjhQMiF1qWDouloZlQbRhDPCebwxSjxMjxgemYT46YMd2NR0/H+fBhEfWX4A/w9TBJ+ol+okqJKFE6vQ==", - "dev": true - }, - "is-symbol": { - "version": "1.0.3", - "resolved": "https://registry.npmjs.org/is-symbol/-/is-symbol-1.0.3.tgz", - "integrity": "sha512-OwijhaRSgqvhm/0ZdAcXNZt9lYdKFpcRDT5ULUuYXPoT794UNOdU+gpT6Rzo7b4V2HUl/op6GqY894AZwv9faQ==", - "dev": true, - "requires": { - "has-symbols": "^1.0.1" - } - }, - "isarray": { - "version": "1.0.0", - "resolved": "https://registry.npmjs.org/isarray/-/isarray-1.0.0.tgz", - "integrity": "sha1-u5NdSFgsuhaMBoNJV6VKPgcSTxE=", - "dev": true - }, "isexe": { "version": "2.0.0", "resolved": "https://registry.npmjs.org/isexe/-/isexe-2.0.0.tgz", @@ -1576,15 +1302,6 @@ "integrity": "sha1-nbe1lJatPzz+8wp1FC0tkwrXJlE=", "dev": true }, - "json5": { - "version": "1.0.1", - "resolved": "https://registry.npmjs.org/json5/-/json5-1.0.1.tgz", - "integrity": "sha512-aKS4WQjPenRxiQsC93MNfjx+nbF4PAdYzmd/1JIj8HYzqfbu86beTuNgXDzPknWk0n0uARlyewZo4s++ES36Ow==", - "dev": true, - "requires": { - "minimist": "^1.2.0" - } - }, "jsonfile": { "version": "6.1.0", "resolved": "https://registry.npmjs.org/jsonfile/-/jsonfile-6.1.0.tgz", @@ -1775,29 +1492,6 @@ } } }, - "load-json-file": { - "version": "2.0.0", - "resolved": "https://registry.npmjs.org/load-json-file/-/load-json-file-2.0.0.tgz", - "integrity": "sha1-eUfkIUmvgNaWy/eXvKq8/h/inKg=", - "dev": true, - "requires": { - "graceful-fs": "^4.1.2", - "parse-json": "^2.2.0", - "pify": "^2.0.0", - "strip-bom": "^3.0.0" - }, - "dependencies": { - "parse-json": { - "version": "2.2.0", - "resolved": "https://registry.npmjs.org/parse-json/-/parse-json-2.2.0.tgz", - "integrity": "sha1-9ID0BDTvgHQfhGkJn43qGPVaTck=", - "dev": true, - "requires": { - "error-ex": "^1.2.0" - } - } - } - }, "locate-path": { "version": "5.0.0", "resolved": "https://registry.npmjs.org/locate-path/-/locate-path-5.0.0.tgz", @@ -1990,12 +1684,6 @@ "resolved": "https://registry.npmjs.org/module-alias/-/module-alias-2.2.2.tgz", "integrity": "sha512-A/78XjoX2EmNvppVWEhM2oGk3x4lLxnkEA4jTbaK97QKSDjkIoOsKQlfylt/d3kKKi596Qy3NP5XrXJ6fZIC9Q==" }, - "ms": { - "version": "2.0.0", - "resolved": "https://registry.npmjs.org/ms/-/ms-2.0.0.tgz", - "integrity": "sha1-VgiurfwAvmwpAd9fmGF4jeDVl8g=", - "dev": true - }, "natural-compare": { "version": "1.4.0", "resolved": "https://registry.npmjs.org/natural-compare/-/natural-compare-1.4.0.tgz", @@ -2013,26 +1701,6 @@ "resolved": "https://registry.npmjs.org/node-fetch/-/node-fetch-2.6.1.tgz", "integrity": "sha512-V4aYg89jEoVRxRb2fJdAg8FHvI7cEyYdVAh94HH0UIK8oJxUfkjlDQN9RbMx+bEjP7+ggMiFRprSti032Oipxw==" }, - "normalize-package-data": { - "version": "2.5.0", - "resolved": "https://registry.npmjs.org/normalize-package-data/-/normalize-package-data-2.5.0.tgz", - "integrity": "sha512-/5CMN3T0R4XTj4DcGaexo+roZSdSFW/0AOOTROrjxzCG1wrWXEsGbRKevjlIL+ZDE4sZlJr5ED4YW0yqmkK+eA==", - "dev": true, - "requires": { - "hosted-git-info": "^2.1.4", - "resolve": "^1.10.0", - "semver": "2 || 3 || 4 || 5", - "validate-npm-package-license": "^3.0.1" - }, - "dependencies": { - "semver": { - "version": "5.7.1", - "resolved": "https://registry.npmjs.org/semver/-/semver-5.7.1.tgz", - "integrity": "sha512-sauaDf/PZdVgrLTNYHRtpXa1iRiKcaebiKQ1BJdpQlWH2lCvexQdX55snPFyK7QzpudqbCI0qXFfOasHdyNDGQ==", - "dev": true - } - } - }, "normalize-path": { "version": "3.0.0", "resolved": "https://registry.npmjs.org/normalize-path/-/normalize-path-3.0.0.tgz", @@ -2054,64 +1722,6 @@ "integrity": "sha512-VOJmgmS+7wvXf8CjbQmimtCnEx3IAoLxI3fp2fbWehxrWBcAQFbk+vcwb6vzR0VZv/eNCJ/27j151ZTwqW/JeQ==", "dev": true }, - "object-inspect": { - "version": "1.8.0", - "resolved": "https://registry.npmjs.org/object-inspect/-/object-inspect-1.8.0.tgz", - "integrity": "sha512-jLdtEOB112fORuypAyl/50VRVIBIdVQOSUUGQHzJ4xBSbit81zRarz7GThkEFZy1RceYrWYcPcBFPQwHyAc1gA==", - "dev": true - }, - "object-keys": { - "version": "1.1.1", - "resolved": "https://registry.npmjs.org/object-keys/-/object-keys-1.1.1.tgz", - "integrity": "sha512-NuAESUOUMrlIXOfHKzD6bpPu3tYt3xvjNdRIQ+FeT0lNb4K8WR70CaDxhuNguS2XG+GjkyMwOzsN5ZktImfhLA==", - "dev": true - }, - "object.assign": { - "version": "4.1.1", - "resolved": "https://registry.npmjs.org/object.assign/-/object.assign-4.1.1.tgz", - "integrity": "sha512-VT/cxmx5yaoHSOTSyrCygIDFco+RsibY2NM0a4RdEeY/4KgqezwFtK1yr3U67xYhqJSlASm2pKhLVzPj2lr4bA==", - "dev": true, - "requires": { - "define-properties": "^1.1.3", - "es-abstract": "^1.18.0-next.0", - "has-symbols": "^1.0.1", - "object-keys": "^1.1.1" - }, - "dependencies": { - "es-abstract": { - "version": "1.18.0-next.0", - "resolved": "https://registry.npmjs.org/es-abstract/-/es-abstract-1.18.0-next.0.tgz", - "integrity": "sha512-elZXTZXKn51hUBdJjSZGYRujuzilgXo8vSPQzjGYXLvSlGiCo8VO8ZGV3kjo9a0WNJJ57hENagwbtlRuHuzkcQ==", - "dev": true, - "requires": { - "es-to-primitive": "^1.2.1", - "function-bind": "^1.1.1", - "has": "^1.0.3", - "has-symbols": "^1.0.1", - "is-callable": "^1.2.0", - "is-negative-zero": "^2.0.0", - "is-regex": "^1.1.1", - "object-inspect": "^1.8.0", - "object-keys": "^1.1.1", - "object.assign": "^4.1.0", - "string.prototype.trimend": "^1.0.1", - "string.prototype.trimstart": "^1.0.1" - } - } - } - }, - "object.values": { - "version": "1.1.1", - "resolved": "https://registry.npmjs.org/object.values/-/object.values-1.1.1.tgz", - "integrity": "sha512-WTa54g2K8iu0kmS/us18jEmdv1a4Wi//BZ/DTVYEcH0XhLM5NYdpDHja3gt57VrZLcNAO2WGA+KpWsDBaHt6eA==", - "dev": true, - "requires": { - "define-properties": "^1.1.3", - "es-abstract": "^1.17.0-next.1", - "function-bind": "^1.1.1", - "has": "^1.0.3" - } - }, "once": { "version": "1.4.0", "resolved": "https://registry.npmjs.org/once/-/once-1.4.0.tgz", @@ -2255,12 +1865,6 @@ "integrity": "sha512-q0M/9eZHzmr0AulXyPwNfZjtwZ/RBZlbN3K3CErVrk50T2ASYI7Bye0EvekFY3IP1Nt2DHu0re+V2ZHIpMkuWg==", "dev": true }, - "pify": { - "version": "2.3.0", - "resolved": "https://registry.npmjs.org/pify/-/pify-2.3.0.tgz", - "integrity": "sha1-7RQaasBDqEnqWISY59yosVMw6Qw=", - "dev": true - }, "pkg-dir": { "version": "4.2.0", "resolved": "https://registry.npmjs.org/pkg-dir/-/pkg-dir-4.2.0.tgz", @@ -2291,6 +1895,15 @@ "integrity": "sha512-PqyhM2yCjg/oKkFPtTGUojv7gnZAoG80ttl45O6x2Ug/rMJw4wcc9k6aaf2hibP7BGVCCM33gZoGjyvt9mm16Q==", "dev": true }, + "prettier-linter-helpers": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/prettier-linter-helpers/-/prettier-linter-helpers-1.0.0.tgz", + "integrity": "sha512-GbK2cP9nraSSUF9N2XwUwqfzlAFlMNYYl+ShE/V+H8a9uNl/oUqB1w2EL54Jh0OlyRSd8RfWYJ3coVS4TROP2w==", + "dev": true, + "requires": { + "fast-diff": "^1.1.2" + } + }, "progress": { "version": "2.0.3", "resolved": "https://registry.npmjs.org/progress/-/progress-2.0.3.tgz", @@ -2313,89 +1926,6 @@ "integrity": "sha512-XRsRjdf+j5ml+y/6GKHPZbrF/8p2Yga0JPtdqTIY2Xe5ohJPD9saDJJLPvp9+NSBprVvevdXZybnj2cv8OEd0A==", "dev": true }, - "read-pkg": { - "version": "2.0.0", - "resolved": "https://registry.npmjs.org/read-pkg/-/read-pkg-2.0.0.tgz", - "integrity": "sha1-jvHAYjxqbbDcZxPEv6xGMysjaPg=", - "dev": true, - "requires": { - "load-json-file": "^2.0.0", - "normalize-package-data": "^2.3.2", - "path-type": "^2.0.0" - }, - "dependencies": { - "path-type": { - "version": "2.0.0", - "resolved": "https://registry.npmjs.org/path-type/-/path-type-2.0.0.tgz", - "integrity": "sha1-8BLMuEFbcJb8LaoQVMPXI4lZTHM=", - "dev": true, - "requires": { - "pify": "^2.0.0" - } - } - } - }, - "read-pkg-up": { - "version": "2.0.0", - "resolved": "https://registry.npmjs.org/read-pkg-up/-/read-pkg-up-2.0.0.tgz", - "integrity": "sha1-a3KoBImE4MQeeVEP1en6mbO1Sb4=", - "dev": true, - "requires": { - "find-up": "^2.0.0", - "read-pkg": "^2.0.0" - }, - "dependencies": { - "find-up": { - "version": "2.1.0", - "resolved": "https://registry.npmjs.org/find-up/-/find-up-2.1.0.tgz", - "integrity": "sha1-RdG35QbHF93UgndaK3eSCjwMV6c=", - "dev": true, - "requires": { - "locate-path": "^2.0.0" - } - }, - "locate-path": { - "version": "2.0.0", - "resolved": "https://registry.npmjs.org/locate-path/-/locate-path-2.0.0.tgz", - "integrity": "sha1-K1aLJl7slExtnA3pw9u7ygNUzY4=", - "dev": true, - "requires": { - "p-locate": "^2.0.0", - "path-exists": "^3.0.0" - } - }, - "p-limit": { - "version": "1.3.0", - "resolved": "https://registry.npmjs.org/p-limit/-/p-limit-1.3.0.tgz", - "integrity": "sha512-vvcXsLAJ9Dr5rQOPk7toZQZJApBl2K4J6dANSsEuh6QI41JYcsS/qhTGa9ErIUUgK3WNQoJYvylxvjqmiqEA9Q==", - "dev": true, - "requires": { - "p-try": "^1.0.0" - } - }, - "p-locate": { - "version": "2.0.0", - "resolved": "https://registry.npmjs.org/p-locate/-/p-locate-2.0.0.tgz", - "integrity": "sha1-IKAQOyIqcMj9OcwuWAaA893l7EM=", - "dev": true, - "requires": { - "p-limit": "^1.1.0" - } - }, - "p-try": { - "version": "1.0.0", - "resolved": "https://registry.npmjs.org/p-try/-/p-try-1.0.0.tgz", - "integrity": "sha1-y8ec26+P1CKOE/Yh8rGiN8GyB7M=", - "dev": true - }, - "path-exists": { - "version": "3.0.0", - "resolved": "https://registry.npmjs.org/path-exists/-/path-exists-3.0.0.tgz", - "integrity": "sha1-zg6+ql94yxiSXqfYENe1mwEP1RU=", - "dev": true - } - } - }, "rechoir": { "version": "0.6.2", "resolved": "https://registry.npmjs.org/rechoir/-/rechoir-0.6.2.tgz", @@ -2618,38 +2148,6 @@ "integrity": "sha512-UjgapumWlbMhkBgzT7Ykc5YXUT46F0iKu8SGXq0bcwP5dz/h0Plj6enJqjz1Zbq2l5WaqYnrVbwWOWMyF3F47g==", "dev": true }, - "spdx-correct": { - "version": "3.1.1", - "resolved": "https://registry.npmjs.org/spdx-correct/-/spdx-correct-3.1.1.tgz", - "integrity": "sha512-cOYcUWwhCuHCXi49RhFRCyJEK3iPj1Ziz9DpViV3tbZOwXD49QzIN3MpOLJNxh2qwq2lJJZaKMVw9qNi4jTC0w==", - "dev": true, - "requires": { - "spdx-expression-parse": "^3.0.0", - "spdx-license-ids": "^3.0.0" - } - }, - "spdx-exceptions": { - "version": "2.3.0", - "resolved": "https://registry.npmjs.org/spdx-exceptions/-/spdx-exceptions-2.3.0.tgz", - "integrity": "sha512-/tTrYOC7PPI1nUAgx34hUpqXuyJG+DTHJTnIULG4rDygi4xu/tfgmq1e1cIRwRzwZgo4NLySi+ricLkZkw4i5A==", - "dev": true - }, - "spdx-expression-parse": { - "version": "3.0.1", - "resolved": "https://registry.npmjs.org/spdx-expression-parse/-/spdx-expression-parse-3.0.1.tgz", - "integrity": "sha512-cbqHunsQWnJNE6KhVSMsMeH5H/L9EpymbzqTQ3uLwNCLZ1Q481oWaofqH7nO6V07xlXwY6PhQdQ2IedWx/ZK4Q==", - "dev": true, - "requires": { - "spdx-exceptions": "^2.1.0", - "spdx-license-ids": "^3.0.0" - } - }, - "spdx-license-ids": { - "version": "3.0.6", - "resolved": "https://registry.npmjs.org/spdx-license-ids/-/spdx-license-ids-3.0.6.tgz", - "integrity": "sha512-+orQK83kyMva3WyPf59k1+Y525csj5JejicWut55zeTWANuN17qSiSLUXWtzHeNWORSvT7GLDJ/E/XiIWoXBTw==", - "dev": true - }, "sprintf-js": { "version": "1.0.3", "resolved": "https://registry.npmjs.org/sprintf-js/-/sprintf-js-1.0.3.tgz", @@ -2673,26 +2171,6 @@ "strip-ansi": "^6.0.0" } }, - "string.prototype.trimend": { - "version": "1.0.1", - "resolved": "https://registry.npmjs.org/string.prototype.trimend/-/string.prototype.trimend-1.0.1.tgz", - "integrity": "sha512-LRPxFUaTtpqYsTeNKaFOw3R4bxIzWOnbQ837QfBylo8jIxtcbK/A/sMV7Q+OAV/vWo+7s25pOE10KYSjaSO06g==", - "dev": true, - "requires": { - "define-properties": "^1.1.3", - "es-abstract": "^1.17.5" - } - }, - "string.prototype.trimstart": { - "version": "1.0.1", - "resolved": "https://registry.npmjs.org/string.prototype.trimstart/-/string.prototype.trimstart-1.0.1.tgz", - "integrity": "sha512-XxZn+QpvrBI1FOcg6dIpxUPgWCPuNXvMD72aaRaUQv1eD4e/Qy8i/hFTe0BUmD60p/QA6bh1avmuPTfNjqVWRw==", - "dev": true, - "requires": { - "define-properties": "^1.1.3", - "es-abstract": "^1.17.5" - } - }, "stringify-object": { "version": "3.3.0", "resolved": "https://registry.npmjs.org/stringify-object/-/stringify-object-3.3.0.tgz", @@ -2721,12 +2199,6 @@ } } }, - "strip-bom": { - "version": "3.0.0", - "resolved": "https://registry.npmjs.org/strip-bom/-/strip-bom-3.0.0.tgz", - "integrity": "sha1-IzTBjpx1n3vdVv3vfprj1YjmjtM=", - "dev": true - }, "strip-final-newline": { "version": "2.0.0", "resolved": "https://registry.npmjs.org/strip-final-newline/-/strip-final-newline-2.0.0.tgz", @@ -2851,18 +2323,6 @@ "is-number": "^7.0.0" } }, - "tsconfig-paths": { - "version": "3.9.0", - "resolved": "https://registry.npmjs.org/tsconfig-paths/-/tsconfig-paths-3.9.0.tgz", - "integrity": "sha512-dRcuzokWhajtZWkQsDVKbWyY+jgcLC5sqJhg2PSgf4ZkH2aHPvaOY8YWGhmjb68b5qqTfasSsDO9k7RUiEmZAw==", - "dev": true, - "requires": { - "@types/json5": "^0.0.29", - "json5": "^1.0.1", - "minimist": "^1.2.0", - "strip-bom": "^3.0.0" - } - }, "tslib": { "version": "1.11.1", "resolved": "https://registry.npmjs.org/tslib/-/tslib-1.11.1.tgz", @@ -2958,16 +2418,6 @@ "integrity": "sha512-gTpR5XQNKFwOd4clxfnhaqvfqMpqEwr4tOtCyz4MtYZX2JYhfr1JvBFKdS+7K/9rfpZR3VLX+YWBbKoxCgS43Q==", "dev": true }, - "validate-npm-package-license": { - "version": "3.0.4", - "resolved": "https://registry.npmjs.org/validate-npm-package-license/-/validate-npm-package-license-3.0.4.tgz", - "integrity": "sha512-DpKm2Ui/xN7/HQKCtpZxoRWBhZ9Z0kqtygG8XCgNQ8ZlDnxuQmWhj566j8fN4Cu3/JmbhsDo7fcAJq4s9h27Ew==", - "dev": true, - "requires": { - "spdx-correct": "^3.0.0", - "spdx-expression-parse": "^3.0.0" - } - }, "vscode-textmate": { "version": "5.2.0", "resolved": "https://registry.npmjs.org/vscode-textmate/-/vscode-textmate-5.2.0.tgz", diff --git a/package.json b/package.json index 9524a29..e71fda6 100644 --- a/package.json +++ b/package.json @@ -45,7 +45,7 @@ "@typescript-eslint/parser": "4.11.1", "eslint": "7.17.0", "eslint-config-prettier": "7.1.0", - "eslint-plugin-import": "2.22.1", + "eslint-plugin-prettier": "^3.3.1", "husky": "4.3.6", "lint-staged": "10.5.3", "lodash": "4.17.20", From 89d7304ebaa1fe26a3be1e297918a5895c938642 Mon Sep 17 00:00:00 2001 From: Morb0 Date: Wed, 6 Jan 2021 17:19:35 +0300 Subject: [PATCH 06/19] feat(explorer): add custom context callback creation --- lib/services/listeners-explorer.service.ts | 63 +++++++++------------- 1 file changed, 24 insertions(+), 39 deletions(-) diff --git a/lib/services/listeners-explorer.service.ts b/lib/services/listeners-explorer.service.ts index 05abc1e..e0073ea 100644 --- a/lib/services/listeners-explorer.service.ts +++ b/lib/services/listeners-explorer.service.ts @@ -18,11 +18,6 @@ import { TelegrafParamsFactory } from '../factories/telegraf-params-factory'; import { TelegrafContextType } from '../execution-context/telegraf-execution-context'; import { ParamMetadata } from '@nestjs/core/helpers/interfaces'; -interface ListenerCallbackMetadata { - methodName: string; - metadata: ListenerMetadata; -} - @Injectable() export class ListenersExplorerService extends BaseExplorerService @@ -66,24 +61,21 @@ export class ListenersExplorerService const updates = this.flatMap(modules, (instance) => this.filterUpdates(instance), ); - updates.forEach(({ instance }) => - this.registerInstanceMethodListeners(this.bot, instance), - ); + updates.forEach((wrapper) => this.registerListeners(this.bot, wrapper)); } private registerScenes(modules: Module[]): void { - const scenes = this.flatMap( - modules, - (instance, moduleRef) => this.filterScenes(instance), + const scenes = this.flatMap(modules, (wrapper) => + this.filterScenes(wrapper), ); scenes.forEach((wrapper) => { const sceneId = this.metadataAccessor.getSceneMetadata( - instance.constructor, + wrapper.instance.constructor, ); const scene = new BaseScene(sceneId); this.stage.register(scene); - this.registerInstanceMethodListeners(scene, wrapper); + this.registerListeners(scene, wrapper); }); } @@ -107,49 +99,42 @@ export class ListenersExplorerService return wrapper; } - private registerInstanceMethodListeners( - composer: Composer, + private registerListeners( + composer: Composer, wrapper: InstanceWrapper, ): void { const { instance } = wrapper; const prototype = Object.getPrototypeOf(instance); - const listenersMetadata = this.metadataScanner.scanFromPrototype( - instance, - prototype, - (name): ListenerCallbackMetadata => - this.extractListenerCallbackMetadata(prototype, name), - ); - - const contextCallbackFn = this.createContextCallback( - instance, - prototype, - wrapper, + this.metadataScanner.scanFromPrototype(instance, prototype, (name) => + this.registerIfListener(composer, instance, prototype, name), ); } - private extractListenerCallbackMetadata( + private registerIfListener( + composer: Composer, + instance: any, prototype: any, methodName: string, - ): ListenerCallbackMetadata { - const callback = prototype[methodName]; - const metadata = this.metadataAccessor.getListenerMetadata(callback); - + ): void { + const methodRef = prototype[methodName]; + const metadata = this.metadataAccessor.getListenerMetadata(methodRef); if (!metadata) { return undefined; } - return { + const listenerCallbackFn = this.createContextCallback( + instance, + prototype, methodName, - metadata: metadata, - }; + ); + + // TODO: Add callback to middleware and handle return data } createContextCallback>( instance: T, prototype: unknown, - wrapper: InstanceWrapper, - moduleRef: Module, - listener: ListenerMetadata, + methodName: string, ) { const paramsFactory = this.telegrafParamsFactory; const resolverCallback = this.externalContextCreator.create< @@ -157,8 +142,8 @@ export class ListenersExplorerService TelegrafContextType >( instance, - prototype[listener.methodName], - listener.methodName, + prototype[methodName], + methodName, PARAM_ARGS_METADATA, paramsFactory, undefined, From fdbbfaabc0bae0b252284893f9aee1d4f63446d0 Mon Sep 17 00:00:00 2001 From: Morb0 Date: Wed, 6 Jan 2021 17:30:11 +0300 Subject: [PATCH 07/19] fix(sample): remove filesystem import path --- sample/01-complete-app/src/greeter/greeter.update.ts | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/sample/01-complete-app/src/greeter/greeter.update.ts b/sample/01-complete-app/src/greeter/greeter.update.ts index 8f50e9b..424b3fb 100644 --- a/sample/01-complete-app/src/greeter/greeter.update.ts +++ b/sample/01-complete-app/src/greeter/greeter.update.ts @@ -1,4 +1,4 @@ -import { Hears, Start, Update } from '../../../../lib'; +import { Hears, Start, Update } from 'nestjs-telegraf'; import { Context } from '../interfaces/context.interface'; @Update() From c867e233d69d9be2c959a1a4e532f396a24e3272 Mon Sep 17 00:00:00 2001 From: Morb0 Date: Wed, 6 Jan 2021 17:32:55 +0300 Subject: [PATCH 08/19] chore(): delete unused explorer --- lib/explorers/telegraf-update.explorer.ts | 126 ---------------------- 1 file changed, 126 deletions(-) delete mode 100644 lib/explorers/telegraf-update.explorer.ts diff --git a/lib/explorers/telegraf-update.explorer.ts b/lib/explorers/telegraf-update.explorer.ts deleted file mode 100644 index 9a7ac43..0000000 --- a/lib/explorers/telegraf-update.explorer.ts +++ /dev/null @@ -1,126 +0,0 @@ -import { Inject, Injectable, OnModuleInit } from '@nestjs/common'; -import { DiscoveryService, ModuleRef, ModulesContainer } from '@nestjs/core'; -import { MetadataScanner } from '@nestjs/core/metadata-scanner'; -import { InstanceWrapper } from '@nestjs/core/injector/instance-wrapper'; -import { isFunction, isNil } from '@nestjs/common/utils/shared.utils'; -import { ExternalContextCreator } from '@nestjs/core/helpers/external-context-creator'; -import { fromPromise } from 'rxjs/internal-compatibility'; -import { filter, mergeAll } from 'rxjs/operators'; -import { Observable, of } from 'rxjs'; -import { Context, Telegraf } from 'telegraf'; - -import { TelegrafMetadataAccessor } from '../telegraf.metadata-accessor'; -import { TelegrafParamsFactory } from '../factories/telegraf-params-factory'; - -// TODO: DELETE THIS CLASS - -@Injectable() -export class TelegrafUpdateExplorer implements OnModuleInit { - private readonly telegrafParamsFactory = new TelegrafParamsFactory(); - - constructor( - private readonly moduleRef: ModuleRef, - private readonly modulesContainer: ModulesContainer, - private readonly discoveryService: DiscoveryService, - private readonly metadataAccessor: TelegrafMetadataAccessor, - private readonly metadataScanner: MetadataScanner, - private readonly externalContextCreator: ExternalContextCreator, - @Inject(Telegraf) private readonly telegraf: Telegraf, - ) {} - - onModuleInit(): void { - this.explore(); - } - - private explore(): void { - this.modulesContainer.forEach(({ providers }, moduleName) => { - this.exploreProviders(providers, moduleName); - }); - } - - private exploreProviders( - providers: Map>, - moduleName: string, - ): void { - [...providers.values()] - .filter((wrapper) => wrapper && !wrapper.isNotMetatype) - .forEach((wrapper) => { - const { instance } = wrapper; - - const prototype = Object.getPrototypeOf(instance); - this.metadataScanner.scanFromPrototype( - instance, - prototype, - (methodKey: string) => - this.registerIfListener( - instance as Record, - methodKey, - moduleName, - ), - ); - }); - } - - private registerIfListener( - instance: Record, - methodKey: string, - moduleName: string, - ): void { - const methodRef = instance[methodKey] as (...args: unknown[]) => unknown; - const contextHandlerFn = this.externalContextCreator.create( - instance, - methodRef, - moduleName, - methodKey, - this.telegrafParamsFactory, - null, - null, - { - interceptors: true, - filters: true, - guards: true, - }, - 'telegraf', - ); - - const listenerMetadata = this.metadataAccessor.getListenerMetadata( - methodRef, - ); - if (!listenerMetadata) return; - - const { method, args } = listenerMetadata; - this.telegraf[method]( - ...args, - async (ctx: Context, next: () => Promise) => { - const defferedResult = contextHandlerFn.call(instance, ctx, next); - const result = this.pickResult(defferedResult); - fromPromise(result) - .pipe( - mergeAll(), - filter((response: any) => !isNil(response)), - ) - .subscribe((text) => { - // TODO: More processing method return logic (files, images, etc) - // Example: https://github.com/nestjs/nest/blob/01dc358aade27d3d7ca510506696aa62bfb1cc43/packages/platform-socket.io/adapters/io-adapter.ts#L56 - return ctx.reply(text); - }); - }, - ); - } - - private async pickResult( - defferedResult: Promise, - ): Promise> { - const result = await defferedResult; - - if (result && isFunction(result.subscribe)) { - return result; - } - - if (result instanceof Promise) { - return fromPromise(result); - } - - return of(result); - } -} From c32f2c72d9d49cc0588de204b10daaca6370f484 Mon Sep 17 00:00:00 2001 From: Morb0 Date: Wed, 6 Jan 2021 17:54:49 +0300 Subject: [PATCH 09/19] chore(): export more items --- lib/execution-context/index.ts | 2 +- lib/index.ts | 3 ++ lib/services/listeners-explorer.service.ts | 42 +++++++++++++++++++++- 3 files changed, 45 insertions(+), 2 deletions(-) diff --git a/lib/execution-context/index.ts b/lib/execution-context/index.ts index 6d91739..4150b50 100644 --- a/lib/execution-context/index.ts +++ b/lib/execution-context/index.ts @@ -1,3 +1,3 @@ export * from './tg-arguments-host.interace'; export * from './telegraf-arguments-host'; -export * from './telegraf-arguments-host'; +export * from './telegraf-execution-context'; diff --git a/lib/index.ts b/lib/index.ts index ef6e2ba..620f652 100644 --- a/lib/index.ts +++ b/lib/index.ts @@ -2,5 +2,8 @@ export * from './decorators'; export * from './interfaces'; export * from './utils'; export * from './types'; +export * from './services'; +export * from './errors'; +export * from './execution-context'; export * from './telegraf.constants'; export * from './telegraf.module'; diff --git a/lib/services/listeners-explorer.service.ts b/lib/services/listeners-explorer.service.ts index e3201a7..4f436a6 100644 --- a/lib/services/listeners-explorer.service.ts +++ b/lib/services/listeners-explorer.service.ts @@ -131,7 +131,47 @@ export class ListenersExplorerService methodName, ); - // TODO: Add callback to middleware and handle return data + const { method, args } = metadata; + composer[method](...args, (ctx: unknown, next: Function) => { + const deferredResult = listenerCallbackFn(ctx, next); + console.log(deferredResult); + }); + + /* + this.telegraf[method]( + ...args, + async (ctx: Context, next: () => Promise) => { + const defferedResult = contextHandlerFn.call(instance, ctx, next); + const result = this.pickResult(defferedResult); + fromPromise(result) + .pipe( + mergeAll(), + filter((response: any) => !isNil(response)), + ) + .subscribe((text) => { + // TODO: More processing method return logic (files, images, etc) + // Example: https://github.com/nestjs/nest/blob/01dc358aade27d3d7ca510506696aa62bfb1cc43/packages/platform-socket.io/adapters/io-adapter.ts#L56 + return ctx.reply(text); + }); + }, + ); + + private async pickResult( + defferedResult: Promise, + ): Promise> { + const result = await defferedResult; + + if (result && isFunction(result.subscribe)) { + return result; + } + + if (result instanceof Promise) { + return fromPromise(result); + } + + return of(result); + } + */ } createContextCallback>( From 31008b04c918afa91a7facafa44398819f00cc47 Mon Sep 17 00:00:00 2001 From: Morb0 Date: Wed, 6 Jan 2021 17:55:40 +0300 Subject: [PATCH 10/19] fix(sample): remove relation path import --- sample/01-complete-app/src/app.module.ts | 1 - .../src}/common/decorators/from.decorator.ts | 2 +- .../src}/common/filters/telegraf-exception.filter.ts | 2 +- .../src}/common/guards/admin.guard.ts | 3 +-- .../common/interceptors/response-time.interceptor.ts | 0 .../src}/common/pipes/reverse-text.pipe.ts | 0 sample/01-complete-app/src/echo/echo.module.ts | 2 +- sample/01-complete-app/src/echo/echo.update.ts | 9 ++------- sample/01-complete-app/src/greeter/greeter.update.ts | 8 +++++++- .../src/{echo => greeter}/scenes/hello.scene.ts | 0 10 files changed, 13 insertions(+), 14 deletions(-) rename sample/{ => 01-complete-app/src}/common/decorators/from.decorator.ts (73%) rename sample/{ => 01-complete-app/src}/common/filters/telegraf-exception.filter.ts (80%) rename sample/{ => 01-complete-app/src}/common/guards/admin.guard.ts (77%) rename sample/{ => 01-complete-app/src}/common/interceptors/response-time.interceptor.ts (100%) rename sample/{ => 01-complete-app/src}/common/pipes/reverse-text.pipe.ts (100%) rename sample/01-complete-app/src/{echo => greeter}/scenes/hello.scene.ts (100%) diff --git a/sample/01-complete-app/src/app.module.ts b/sample/01-complete-app/src/app.module.ts index 408a307..6f7f595 100644 --- a/sample/01-complete-app/src/app.module.ts +++ b/sample/01-complete-app/src/app.module.ts @@ -9,7 +9,6 @@ import { GreeterBotName } from './app.constants'; imports: [ TelegrafModule.forRoot({ token: process.env.ECHO_BOT_TOKEN, - middlewares: [sessionMiddleware], include: [EchoModule], }), TelegrafModule.forRootAsync({ diff --git a/sample/common/decorators/from.decorator.ts b/sample/01-complete-app/src/common/decorators/from.decorator.ts similarity index 73% rename from sample/common/decorators/from.decorator.ts rename to sample/01-complete-app/src/common/decorators/from.decorator.ts index 5200f76..b02273c 100644 --- a/sample/common/decorators/from.decorator.ts +++ b/sample/01-complete-app/src/common/decorators/from.decorator.ts @@ -1,5 +1,5 @@ import { createParamDecorator, ExecutionContext } from '@nestjs/common'; -import { TelegrafExecutionContext } from '../../../lib/execution-context'; +import { TelegrafExecutionContext } from 'nestjs-telegraf'; export const From = createParamDecorator( (_, ctx: ExecutionContext) => diff --git a/sample/common/filters/telegraf-exception.filter.ts b/sample/01-complete-app/src/common/filters/telegraf-exception.filter.ts similarity index 80% rename from sample/common/filters/telegraf-exception.filter.ts rename to sample/01-complete-app/src/common/filters/telegraf-exception.filter.ts index 421ff84..a1a4099 100644 --- a/sample/common/filters/telegraf-exception.filter.ts +++ b/sample/01-complete-app/src/common/filters/telegraf-exception.filter.ts @@ -1,5 +1,5 @@ import { ArgumentsHost, Catch, ExceptionFilter } from '@nestjs/common'; -import { TelegrafArgumentsHost, TelegrafException } from '../../../lib'; +import { TelegrafArgumentsHost } from 'nestjs-telegraf'; @Catch() export class TelegrafExceptionFilter implements ExceptionFilter { diff --git a/sample/common/guards/admin.guard.ts b/sample/01-complete-app/src/common/guards/admin.guard.ts similarity index 77% rename from sample/common/guards/admin.guard.ts rename to sample/01-complete-app/src/common/guards/admin.guard.ts index 9cb9ab9..130dd4d 100644 --- a/sample/common/guards/admin.guard.ts +++ b/sample/01-complete-app/src/common/guards/admin.guard.ts @@ -1,7 +1,6 @@ import { CanActivate, ExecutionContext, Injectable } from '@nestjs/common'; -import { TelegrafExecutionContext } from '../../../lib/execution-context/telegraf-execution-context'; +import { TelegrafExecutionContext, TelegrafException } from 'nestjs-telegraf'; import { Context } from '../../interfaces/context.interface'; -import { TelegrafException } from '../../../lib/errors'; @Injectable() export class AdminGuard implements CanActivate { diff --git a/sample/common/interceptors/response-time.interceptor.ts b/sample/01-complete-app/src/common/interceptors/response-time.interceptor.ts similarity index 100% rename from sample/common/interceptors/response-time.interceptor.ts rename to sample/01-complete-app/src/common/interceptors/response-time.interceptor.ts diff --git a/sample/common/pipes/reverse-text.pipe.ts b/sample/01-complete-app/src/common/pipes/reverse-text.pipe.ts similarity index 100% rename from sample/common/pipes/reverse-text.pipe.ts rename to sample/01-complete-app/src/common/pipes/reverse-text.pipe.ts diff --git a/sample/01-complete-app/src/echo/echo.module.ts b/sample/01-complete-app/src/echo/echo.module.ts index 29c1bff..9c583a3 100644 --- a/sample/01-complete-app/src/echo/echo.module.ts +++ b/sample/01-complete-app/src/echo/echo.module.ts @@ -1,7 +1,7 @@ import { Module } from '@nestjs/common'; import { EchoUpdate } from './echo.update'; import { EchoService } from './echo.service'; -import { HelloScene } from './scenes/hello.scene'; +import { HelloScene } from '../greeter/scenes/hello.scene'; @Module({ providers: [EchoUpdate, EchoService, HelloScene], diff --git a/sample/01-complete-app/src/echo/echo.update.ts b/sample/01-complete-app/src/echo/echo.update.ts index fda0793..577809a 100644 --- a/sample/01-complete-app/src/echo/echo.update.ts +++ b/sample/01-complete-app/src/echo/echo.update.ts @@ -1,7 +1,7 @@ import { Telegraf } from 'telegraf'; -import { Command, Help, InjectBot, On, Start, Update } from 'nestjs-telegraf'; +import { Help, InjectBot, On, Start, Update } from 'nestjs-telegraf'; import { EchoService } from './echo.service'; -import { GreeterBotName, HELLO_SCENE_ID } from '../app.constants'; +import { GreeterBotName } from '../app.constants'; import { Context } from '../interfaces/context.interface'; @Update() @@ -23,11 +23,6 @@ export class EchoUpdate { await ctx.reply('Send me any text'); } - @Command('scene') - async onSceneCommand(ctx: Context): Promise { - await ctx.scene.enter(HELLO_SCENE_ID); - } - @On('message') async onMessage(ctx: Context): Promise { console.log('New message received'); diff --git a/sample/01-complete-app/src/greeter/greeter.update.ts b/sample/01-complete-app/src/greeter/greeter.update.ts index 424b3fb..a8424f7 100644 --- a/sample/01-complete-app/src/greeter/greeter.update.ts +++ b/sample/01-complete-app/src/greeter/greeter.update.ts @@ -1,5 +1,6 @@ -import { Hears, Start, Update } from 'nestjs-telegraf'; +import { Command, Hears, Start, Update } from 'nestjs-telegraf'; import { Context } from '../interfaces/context.interface'; +import { HELLO_SCENE_ID } from '../app.constants'; @Update() export class GreeterUpdate { @@ -13,4 +14,9 @@ export class GreeterUpdate { const { first_name } = ctx.from; await ctx.reply(`Hey ${first_name}`); } + + @Command('scene') + async onSceneCommand(ctx: Context): Promise { + await ctx.scene.enter(HELLO_SCENE_ID); + } } diff --git a/sample/01-complete-app/src/echo/scenes/hello.scene.ts b/sample/01-complete-app/src/greeter/scenes/hello.scene.ts similarity index 100% rename from sample/01-complete-app/src/echo/scenes/hello.scene.ts rename to sample/01-complete-app/src/greeter/scenes/hello.scene.ts From 2030f086bfdd8f6ad115bcb2b735bfa703dd1a2e Mon Sep 17 00:00:00 2001 From: Morb0 Date: Wed, 6 Jan 2021 19:36:46 +0300 Subject: [PATCH 11/19] feat(listeners-explorer): remove callback return value handling --- lib/services/listeners-explorer.service.ts | 56 ++++++---------------- 1 file changed, 15 insertions(+), 41 deletions(-) diff --git a/lib/services/listeners-explorer.service.ts b/lib/services/listeners-explorer.service.ts index 4f436a6..fa7ef5d 100644 --- a/lib/services/listeners-explorer.service.ts +++ b/lib/services/listeners-explorer.service.ts @@ -4,6 +4,7 @@ import { InstanceWrapper } from '@nestjs/core/injector/instance-wrapper'; import { MetadataScanner } from '@nestjs/core/metadata-scanner'; import { Module } from '@nestjs/core/injector/module'; import { ParamMetadata } from '@nestjs/core/helpers/interfaces'; +import { ExternalContextCreator } from '@nestjs/core/helpers/external-context-creator'; import { BaseScene, Composer, Stage, Telegraf } from 'telegraf'; import { MetadataAccessorService } from './metadata-accessor.service'; @@ -13,9 +14,8 @@ import { TELEGRAF_MODULE_OPTIONS, } from '../telegraf.constants'; import { BaseExplorerService } from './base-explorer.service'; -import { ExternalContextCreator } from '@nestjs/core/helpers/external-context-creator'; import { TelegrafParamsFactory } from '../factories/telegraf-params-factory'; -import { TelegrafContextType } from '../execution-context/telegraf-execution-context'; +import { TelegrafContextType } from '../execution-context'; import { TelegrafModuleOptions } from '../interfaces'; @Injectable() @@ -132,46 +132,20 @@ export class ListenersExplorerService ); const { method, args } = metadata; - composer[method](...args, (ctx: unknown, next: Function) => { - const deferredResult = listenerCallbackFn(ctx, next); - console.log(deferredResult); - }); + composer[method](...args, listenerCallbackFn); - /* - this.telegraf[method]( - ...args, - async (ctx: Context, next: () => Promise) => { - const defferedResult = contextHandlerFn.call(instance, ctx, next); - const result = this.pickResult(defferedResult); - fromPromise(result) - .pipe( - mergeAll(), - filter((response: any) => !isNil(response)), - ) - .subscribe((text) => { - // TODO: More processing method return logic (files, images, etc) - // Example: https://github.com/nestjs/nest/blob/01dc358aade27d3d7ca510506696aa62bfb1cc43/packages/platform-socket.io/adapters/io-adapter.ts#L56 - return ctx.reply(text); - }); - }, - ); - - private async pickResult( - defferedResult: Promise, - ): Promise> { - const result = await defferedResult; - - if (result && isFunction(result.subscribe)) { - return result; - } - - if (result instanceof Promise) { - return fromPromise(result); - } - - return of(result); - } - */ + /* Complex callback return value handing */ + // composer[method]( + // ...args, + // async (ctx: Context, next: Function): Promise => { + // const result = await listenerCallbackFn(ctx, next); + // + // // TODO: Add more supported return types + // if (typeof result === 'string') { + // await ctx.reply(result); + // } + // }, + // ); } createContextCallback>( From 4ada932d4e93c8323b2075ce55c9f3ec6fc84f75 Mon Sep 17 00:00:00 2001 From: Morb0 Date: Wed, 6 Jan 2021 19:37:30 +0300 Subject: [PATCH 12/19] fix(params-factory): use new arguments set --- lib/factories/telegraf-params-factory.ts | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/lib/factories/telegraf-params-factory.ts b/lib/factories/telegraf-params-factory.ts index df4b7e0..e52d6ba 100644 --- a/lib/factories/telegraf-params-factory.ts +++ b/lib/factories/telegraf-params-factory.ts @@ -1,3 +1,4 @@ +import { ParamData } from '@nestjs/common'; import { ParamsFactory } from '@nestjs/core/helpers/external-context-creator'; import { Context } from 'telegraf'; import { TelegrafParamtype } from '../enums/telegraf-paramtype.enum'; @@ -5,9 +6,12 @@ import { TelegrafParamtype } from '../enums/telegraf-paramtype.enum'; export class TelegrafParamsFactory implements ParamsFactory { exchangeKeyForValue( type: TelegrafParamtype, - ctx: Context, - next: Function, + data: ParamData, + args: unknown[], ): unknown { + const ctx = args[0] as Context; + const next = args[1] as Function; + switch (type) { case TelegrafParamtype.CONTEXT: return ctx; From 1b8aa4ac55cdedd60de405369cf50322f5be8637 Mon Sep 17 00:00:00 2001 From: Morb0 Date: Wed, 6 Jan 2021 19:38:58 +0300 Subject: [PATCH 13/19] refactor(metadata-accessor): remove comment & use short checking --- lib/services/metadata-accessor.service.ts | 9 ++------- 1 file changed, 2 insertions(+), 7 deletions(-) diff --git a/lib/services/metadata-accessor.service.ts b/lib/services/metadata-accessor.service.ts index 62a785d..75fb79c 100644 --- a/lib/services/metadata-accessor.service.ts +++ b/lib/services/metadata-accessor.service.ts @@ -12,17 +12,12 @@ export class MetadataAccessorService { constructor(private readonly reflector: Reflector) {} isUpdate(target: Function): boolean { - // TODO: We really need this check? - if (!target) { - return false; - } + if (!target) return false; return !!this.reflector.get(UPDATE_METADATA, target); } isScene(target: Function): boolean { - if (!target) { - return false; - } + if (!target) return false; return !!this.reflector.get(SCENE_METADATA, target); } From dc22f9f191243c59842f852b53d18a843c8ce56d Mon Sep 17 00:00:00 2001 From: Morb0 Date: Wed, 6 Jan 2021 19:39:41 +0300 Subject: [PATCH 14/19] feat(sample): update sample --- .../01-complete-app/src/echo/echo.update.ts | 34 ++++++++++--------- .../src/greeter/greeter.update.ts | 13 +++---- 2 files changed, 25 insertions(+), 22 deletions(-) diff --git a/sample/01-complete-app/src/echo/echo.update.ts b/sample/01-complete-app/src/echo/echo.update.ts index 577809a..92135e1 100644 --- a/sample/01-complete-app/src/echo/echo.update.ts +++ b/sample/01-complete-app/src/echo/echo.update.ts @@ -1,8 +1,18 @@ import { Telegraf } from 'telegraf'; -import { Help, InjectBot, On, Start, Update } from 'nestjs-telegraf'; +import { + Ctx, + MessageText, + Help, + InjectBot, + On, + Start, + Update, + Hears, +} from 'nestjs-telegraf'; import { EchoService } from './echo.service'; import { GreeterBotName } from '../app.constants'; import { Context } from '../interfaces/context.interface'; +import { ReverseTextPipe } from '../common/pipes/reverse-text.pipe'; @Update() export class EchoUpdate { @@ -13,26 +23,18 @@ export class EchoUpdate { ) {} @Start() - async onStart(ctx: Context): Promise { + async onStart(): Promise { const me = await this.bot.telegram.getMe(); - await ctx.reply(`Hey, I'm ${me.first_name}`); + return `Hey, I'm ${me.first_name}`; } @Help() - async onHelp(ctx: Context): Promise { - await ctx.reply('Send me any text'); + async onHelp(): Promise { + return 'Send me any text'; } - @On('message') - async onMessage(ctx: Context): Promise { - console.log('New message received'); - - if ('text' in ctx.message) { - const messageText = ctx.message.text; - const echoText = this.echoService.echo(messageText); - await ctx.reply(echoText); - } else { - await ctx.reply('Only text messages'); - } + @On('text') + onMessage(@MessageText(new ReverseTextPipe()) messageText: string): string { + return this.echoService.echo(messageText); } } diff --git a/sample/01-complete-app/src/greeter/greeter.update.ts b/sample/01-complete-app/src/greeter/greeter.update.ts index a8424f7..dfc9c47 100644 --- a/sample/01-complete-app/src/greeter/greeter.update.ts +++ b/sample/01-complete-app/src/greeter/greeter.update.ts @@ -1,22 +1,23 @@ -import { Command, Hears, Start, Update } from 'nestjs-telegraf'; +import { Command, Context as Ctx, Hears, Start, Update } from 'nestjs-telegraf'; +import { User } from 'telegraf/typings/telegram-types'; import { Context } from '../interfaces/context.interface'; import { HELLO_SCENE_ID } from '../app.constants'; +import { From } from '../common/decorators/from.decorator'; @Update() export class GreeterUpdate { @Start() - async onStart(ctx: Context): Promise { + async onStart(@Ctx() ctx: Context): Promise { await ctx.reply('Say hello to me'); } @Hears(['hi', 'hello', 'hey', 'qq']) - async onGreetings(ctx: Context): Promise { - const { first_name } = ctx.from; - await ctx.reply(`Hey ${first_name}`); + onGreetings(@From() { first_name: firstName }: User): string { + return `Hey ${firstName}`; } @Command('scene') - async onSceneCommand(ctx: Context): Promise { + async onSceneCommand(@Ctx() ctx: Context): Promise { await ctx.scene.enter(HELLO_SCENE_ID); } } From 4ca6e18d12e18be431f795a219161d7819f41031 Mon Sep 17 00:00:00 2001 From: Morb0 Date: Wed, 6 Jan 2021 20:49:50 +0300 Subject: [PATCH 15/19] feat(param-decorators): add new paramtypes & make possible to get property from object --- lib/decorators/params/index.ts | 3 ++- .../params/message-text.decorator.ts | 10 --------- lib/decorators/params/message.decorator.ts | 21 +++++++++++++++++++ lib/decorators/params/sender.decorator.ts | 21 +++++++++++++++++++ lib/enums/telegraf-paramtype.enum.ts | 3 +-- lib/factories/telegraf-params-factory.ts | 6 ++---- 6 files changed, 47 insertions(+), 17 deletions(-) delete mode 100644 lib/decorators/params/message-text.decorator.ts create mode 100644 lib/decorators/params/message.decorator.ts create mode 100644 lib/decorators/params/sender.decorator.ts diff --git a/lib/decorators/params/index.ts b/lib/decorators/params/index.ts index 6c5b237..92a211a 100644 --- a/lib/decorators/params/index.ts +++ b/lib/decorators/params/index.ts @@ -1,3 +1,4 @@ export * from './context.decorator'; export * from './next.decorator'; -export * from './message-text.decorator'; +export * from './message.decorator'; +export * from './sender.decorator'; diff --git a/lib/decorators/params/message-text.decorator.ts b/lib/decorators/params/message-text.decorator.ts deleted file mode 100644 index 4130186..0000000 --- a/lib/decorators/params/message-text.decorator.ts +++ /dev/null @@ -1,10 +0,0 @@ -import { PipeTransform, Type } from '@nestjs/common'; -import { createTelegrafPipesParamDecorator } from '../../utils/param-decorator.util'; -import { TelegrafParamtype } from '../../enums/telegraf-paramtype.enum'; - -export function MessageText(...pipes: (Type | PipeTransform)[]) { - return createTelegrafPipesParamDecorator(TelegrafParamtype.MESSAGE_TEXT)( - undefined, - ...pipes, - ); -} diff --git a/lib/decorators/params/message.decorator.ts b/lib/decorators/params/message.decorator.ts new file mode 100644 index 0000000..c77e512 --- /dev/null +++ b/lib/decorators/params/message.decorator.ts @@ -0,0 +1,21 @@ +import { PipeTransform, Type } from '@nestjs/common'; +import { createTelegrafPipesParamDecorator } from '../../utils/param-decorator.util'; +import { TelegrafParamtype } from '../../enums/telegraf-paramtype.enum'; + +export function Message(): ParameterDecorator; +export function Message( + ...pipes: (Type | PipeTransform)[] +): ParameterDecorator; +export function Message( + property: string, + ...pipes: (Type | PipeTransform)[] +): ParameterDecorator; +export function Message( + property?: string | (Type | PipeTransform), + ...pipes: (Type | PipeTransform)[] +) { + return createTelegrafPipesParamDecorator(TelegrafParamtype.MESSAGE)( + property, + ...pipes, + ); +} diff --git a/lib/decorators/params/sender.decorator.ts b/lib/decorators/params/sender.decorator.ts new file mode 100644 index 0000000..bd504da --- /dev/null +++ b/lib/decorators/params/sender.decorator.ts @@ -0,0 +1,21 @@ +import { PipeTransform, Type } from '@nestjs/common'; +import { createTelegrafPipesParamDecorator } from '../../utils/param-decorator.util'; +import { TelegrafParamtype } from '../../enums/telegraf-paramtype.enum'; + +export function Sender(): ParameterDecorator; +export function Sender( + ...pipes: (Type | PipeTransform)[] +): ParameterDecorator; +export function Sender( + property: string, + ...pipes: (Type | PipeTransform)[] +): ParameterDecorator; +export function Sender( + property?: string | (Type | PipeTransform), + ...pipes: (Type | PipeTransform)[] +) { + return createTelegrafPipesParamDecorator(TelegrafParamtype.SENDER)( + property, + ...pipes, + ); +} diff --git a/lib/enums/telegraf-paramtype.enum.ts b/lib/enums/telegraf-paramtype.enum.ts index 2b013d9..980aeb6 100644 --- a/lib/enums/telegraf-paramtype.enum.ts +++ b/lib/enums/telegraf-paramtype.enum.ts @@ -3,6 +3,5 @@ export enum TelegrafParamtype { NEXT, SENDER, MESSAGE, - MESSAGE_TEXT, - // TODO: Add more + // TODO-Possible-Feature: Add more paramtypes } diff --git a/lib/factories/telegraf-params-factory.ts b/lib/factories/telegraf-params-factory.ts index e52d6ba..2dad83b 100644 --- a/lib/factories/telegraf-params-factory.ts +++ b/lib/factories/telegraf-params-factory.ts @@ -18,11 +18,9 @@ export class TelegrafParamsFactory implements ParamsFactory { case TelegrafParamtype.NEXT: return next; case TelegrafParamtype.SENDER: - return ctx.from; + return ctx.from ? ctx.from[data as string] : ctx.from; case TelegrafParamtype.MESSAGE: - return ctx.message; - case TelegrafParamtype.MESSAGE_TEXT: - return ctx.message.text; + return ctx.message ? ctx.message[data as string] : ctx.message; default: return null; } From fcaa89d09707b5cf2d12bef32a6e926c8422697d Mon Sep 17 00:00:00 2001 From: Morb0 Date: Wed, 6 Jan 2021 20:51:26 +0300 Subject: [PATCH 16/19] feat(listeners-explorer): convert callback return data to string and reply --- lib/services/listeners-explorer.service.ts | 25 +++++++++++----------- 1 file changed, 12 insertions(+), 13 deletions(-) diff --git a/lib/services/listeners-explorer.service.ts b/lib/services/listeners-explorer.service.ts index fa7ef5d..ad9aade 100644 --- a/lib/services/listeners-explorer.service.ts +++ b/lib/services/listeners-explorer.service.ts @@ -5,7 +5,7 @@ import { MetadataScanner } from '@nestjs/core/metadata-scanner'; import { Module } from '@nestjs/core/injector/module'; import { ParamMetadata } from '@nestjs/core/helpers/interfaces'; import { ExternalContextCreator } from '@nestjs/core/helpers/external-context-creator'; -import { BaseScene, Composer, Stage, Telegraf } from 'telegraf'; +import { BaseScene, Composer, Context, Stage, Telegraf } from 'telegraf'; import { MetadataAccessorService } from './metadata-accessor.service'; import { @@ -132,20 +132,19 @@ export class ListenersExplorerService ); const { method, args } = metadata; - composer[method](...args, listenerCallbackFn); + + /* Basic callback */ + // composer[method](...args, listenerCallbackFn); /* Complex callback return value handing */ - // composer[method]( - // ...args, - // async (ctx: Context, next: Function): Promise => { - // const result = await listenerCallbackFn(ctx, next); - // - // // TODO: Add more supported return types - // if (typeof result === 'string') { - // await ctx.reply(result); - // } - // }, - // ); + composer[method]( + ...args, + async (ctx: Context, next: Function): Promise => { + const result = await listenerCallbackFn(ctx, next); + await ctx.reply(String(result)); + // TODO-Possible-Feature: Add more supported return types + }, + ); } createContextCallback>( From 6656c39bd91d3cd3a5300f9fc7a359b68bca2e45 Mon Sep 17 00:00:00 2001 From: Morb0 Date: Wed, 6 Jan 2021 22:35:01 +0300 Subject: [PATCH 17/19] fix(listeners-explorer): ignore empty callback return data --- lib/services/listeners-explorer.service.ts | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/lib/services/listeners-explorer.service.ts b/lib/services/listeners-explorer.service.ts index ad9aade..5bfee9c 100644 --- a/lib/services/listeners-explorer.service.ts +++ b/lib/services/listeners-explorer.service.ts @@ -141,7 +141,9 @@ export class ListenersExplorerService ...args, async (ctx: Context, next: Function): Promise => { const result = await listenerCallbackFn(ctx, next); - await ctx.reply(String(result)); + if (result) { + await ctx.reply(String(result)); + } // TODO-Possible-Feature: Add more supported return types }, ); From daf0d8ffdfbef9f1390db825e2c7c7b1cca60525 Mon Sep 17 00:00:00 2001 From: Morb0 Date: Wed, 6 Jan 2021 22:47:37 +0300 Subject: [PATCH 18/19] chore(telegraf-exception): remove message parsing --- lib/errors/telegraf.exception.ts | 25 +------------------------ 1 file changed, 1 insertion(+), 24 deletions(-) diff --git a/lib/errors/telegraf.exception.ts b/lib/errors/telegraf.exception.ts index 0e17137..f87e7fc 100644 --- a/lib/errors/telegraf.exception.ts +++ b/lib/errors/telegraf.exception.ts @@ -1,24 +1 @@ -import { isObject, isString } from '@nestjs/common/utils/shared.utils'; - -export class TelegrafException extends Error { - constructor(private readonly error: string | object) { - super(); - this.initMessage(); - } - - // TODO: Check real error format - public initMessage() { - if (isString(this.error)) { - this.message = this.error; - } else if ( - isObject(this.error) && - isString((this.error as Record).message) - ) { - this.message = (this.error as Record).message; - } else if (this.constructor) { - this.message = this.constructor.name - .match(/[A-Z][a-z]+|[0-9]+/g) - .join(' '); - } - } -} +export class TelegrafException extends Error {} From 7f7f78637311fa49d7599a569d28ce4a921c279b Mon Sep 17 00:00:00 2001 From: Morb0 Date: Wed, 6 Jan 2021 22:48:10 +0300 Subject: [PATCH 19/19] feat(sample): update sample --- ....decorator.ts => update-type.decorator.ts} | 4 +-- .../filters/telegraf-exception.filter.ts | 12 +++++---- .../src/common/guards/admin.guard.ts | 2 +- .../01-complete-app/src/echo/echo.module.ts | 4 +-- .../01-complete-app/src/echo/echo.update.ts | 25 ++++++++++++++----- .../src/greeter/greeter.module.ts | 3 ++- .../src/greeter/greeter.update.ts | 15 ++++++----- ...{hello.scene.ts => random-number.scene.ts} | 18 ++++++------- 8 files changed, 51 insertions(+), 32 deletions(-) rename sample/01-complete-app/src/common/decorators/{from.decorator.ts => update-type.decorator.ts} (59%) rename sample/01-complete-app/src/greeter/scenes/{hello.scene.ts => random-number.scene.ts} (56%) diff --git a/sample/01-complete-app/src/common/decorators/from.decorator.ts b/sample/01-complete-app/src/common/decorators/update-type.decorator.ts similarity index 59% rename from sample/01-complete-app/src/common/decorators/from.decorator.ts rename to sample/01-complete-app/src/common/decorators/update-type.decorator.ts index b02273c..2639e6d 100644 --- a/sample/01-complete-app/src/common/decorators/from.decorator.ts +++ b/sample/01-complete-app/src/common/decorators/update-type.decorator.ts @@ -1,7 +1,7 @@ import { createParamDecorator, ExecutionContext } from '@nestjs/common'; import { TelegrafExecutionContext } from 'nestjs-telegraf'; -export const From = createParamDecorator( +export const UpdateType = createParamDecorator( (_, ctx: ExecutionContext) => - TelegrafExecutionContext.create(ctx).getContext().from, + TelegrafExecutionContext.create(ctx).getContext().updateType, ); diff --git a/sample/01-complete-app/src/common/filters/telegraf-exception.filter.ts b/sample/01-complete-app/src/common/filters/telegraf-exception.filter.ts index a1a4099..8221b86 100644 --- a/sample/01-complete-app/src/common/filters/telegraf-exception.filter.ts +++ b/sample/01-complete-app/src/common/filters/telegraf-exception.filter.ts @@ -1,11 +1,13 @@ import { ArgumentsHost, Catch, ExceptionFilter } from '@nestjs/common'; import { TelegrafArgumentsHost } from 'nestjs-telegraf'; +import { Context } from '../../interfaces/context.interface'; @Catch() -export class TelegrafExceptionFilter implements ExceptionFilter { - catch(exception: T, host: ArgumentsHost) { - const tgHost = TelegrafArgumentsHost.create(host); - console.log(tgHost); - return exception; +export class TelegrafExceptionFilter implements ExceptionFilter { + async catch(exception: Error, host: ArgumentsHost): Promise { + const telegrafHost = TelegrafArgumentsHost.create(host); + const ctx = telegrafHost.getContext(); + + await ctx.replyWithHTML(`Error: ${exception.message}`); } } diff --git a/sample/01-complete-app/src/common/guards/admin.guard.ts b/sample/01-complete-app/src/common/guards/admin.guard.ts index 130dd4d..23030b0 100644 --- a/sample/01-complete-app/src/common/guards/admin.guard.ts +++ b/sample/01-complete-app/src/common/guards/admin.guard.ts @@ -12,7 +12,7 @@ export class AdminGuard implements CanActivate { const isAdmin = this.ADMIN_IDS.includes(from.id); if (!isAdmin) { - throw new TelegrafException('You are not admin >:('); + throw new TelegrafException('You are not admin 😡'); } return true; diff --git a/sample/01-complete-app/src/echo/echo.module.ts b/sample/01-complete-app/src/echo/echo.module.ts index 9c583a3..36c97ce 100644 --- a/sample/01-complete-app/src/echo/echo.module.ts +++ b/sample/01-complete-app/src/echo/echo.module.ts @@ -1,9 +1,9 @@ import { Module } from '@nestjs/common'; import { EchoUpdate } from './echo.update'; import { EchoService } from './echo.service'; -import { HelloScene } from '../greeter/scenes/hello.scene'; +import { RandomNumberScene } from '../greeter/scenes/random-number.scene'; @Module({ - providers: [EchoUpdate, EchoService, HelloScene], + providers: [EchoUpdate, EchoService, RandomNumberScene], }) export class EchoModule {} diff --git a/sample/01-complete-app/src/echo/echo.update.ts b/sample/01-complete-app/src/echo/echo.update.ts index 92135e1..eee15f0 100644 --- a/sample/01-complete-app/src/echo/echo.update.ts +++ b/sample/01-complete-app/src/echo/echo.update.ts @@ -1,20 +1,25 @@ -import { Telegraf } from 'telegraf'; +import { UseFilters, UseGuards, UseInterceptors } from '@nestjs/common'; import { - Ctx, - MessageText, Help, InjectBot, On, + Message, Start, Update, - Hears, + Command, } from 'nestjs-telegraf'; +import { Telegraf } from 'telegraf'; import { EchoService } from './echo.service'; import { GreeterBotName } from '../app.constants'; import { Context } from '../interfaces/context.interface'; import { ReverseTextPipe } from '../common/pipes/reverse-text.pipe'; +import { ResponseTimeInterceptor } from '../common/interceptors/response-time.interceptor'; +import { AdminGuard } from '../common/guards/admin.guard'; +import { TelegrafExceptionFilter } from '../common/filters/telegraf-exception.filter'; @Update() +@UseInterceptors(ResponseTimeInterceptor) +@UseFilters(TelegrafExceptionFilter) export class EchoUpdate { constructor( @InjectBot(GreeterBotName) @@ -33,8 +38,16 @@ export class EchoUpdate { return 'Send me any text'; } + @Command('admin') + @UseGuards(AdminGuard) + onAdminCommand(): string { + return 'Welcome judge'; + } + @On('text') - onMessage(@MessageText(new ReverseTextPipe()) messageText: string): string { - return this.echoService.echo(messageText); + onMessage( + @Message('text', new ReverseTextPipe()) reversedText: string, + ): string { + return this.echoService.echo(reversedText); } } diff --git a/sample/01-complete-app/src/greeter/greeter.module.ts b/sample/01-complete-app/src/greeter/greeter.module.ts index 40160db..02e3284 100644 --- a/sample/01-complete-app/src/greeter/greeter.module.ts +++ b/sample/01-complete-app/src/greeter/greeter.module.ts @@ -1,7 +1,8 @@ import { Module } from '@nestjs/common'; import { GreeterUpdate } from './greeter.update'; +import { RandomNumberScene } from './scenes/random-number.scene'; @Module({ - providers: [GreeterUpdate], + providers: [GreeterUpdate, RandomNumberScene], }) export class GreeterModule {} diff --git a/sample/01-complete-app/src/greeter/greeter.update.ts b/sample/01-complete-app/src/greeter/greeter.update.ts index dfc9c47..bef392f 100644 --- a/sample/01-complete-app/src/greeter/greeter.update.ts +++ b/sample/01-complete-app/src/greeter/greeter.update.ts @@ -1,18 +1,21 @@ -import { Command, Context as Ctx, Hears, Start, Update } from 'nestjs-telegraf'; -import { User } from 'telegraf/typings/telegram-types'; +import { Command, Ctx, Hears, Start, Update, Sender } from 'nestjs-telegraf'; +import { UpdateType as TelegrafUpdateType } from 'telegraf/typings/telegram-types'; import { Context } from '../interfaces/context.interface'; import { HELLO_SCENE_ID } from '../app.constants'; -import { From } from '../common/decorators/from.decorator'; +import { UpdateType } from '../common/decorators/update-type.decorator'; @Update() export class GreeterUpdate { @Start() - async onStart(@Ctx() ctx: Context): Promise { - await ctx.reply('Say hello to me'); + onStart(): string { + return 'Say hello to me'; } @Hears(['hi', 'hello', 'hey', 'qq']) - onGreetings(@From() { first_name: firstName }: User): string { + onGreetings( + @UpdateType() updateType: TelegrafUpdateType, + @Sender('first_name') firstName: string, + ): string { return `Hey ${firstName}`; } diff --git a/sample/01-complete-app/src/greeter/scenes/hello.scene.ts b/sample/01-complete-app/src/greeter/scenes/random-number.scene.ts similarity index 56% rename from sample/01-complete-app/src/greeter/scenes/hello.scene.ts rename to sample/01-complete-app/src/greeter/scenes/random-number.scene.ts index 211b06f..3c04d46 100644 --- a/sample/01-complete-app/src/greeter/scenes/hello.scene.ts +++ b/sample/01-complete-app/src/greeter/scenes/random-number.scene.ts @@ -3,23 +3,23 @@ import { HELLO_SCENE_ID } from '../../app.constants'; import { Context } from '../../interfaces/context.interface'; @Scene(HELLO_SCENE_ID) -export class HelloScene { +export class RandomNumberScene { @SceneEnter() - async onSceneEnter(ctx: Context): Promise { + onSceneEnter(): string { console.log('Enter to scene'); - await ctx.reply('Welcome on scene ✋'); + return 'Welcome on scene ✋'; } @SceneLeave() - async onSceneLeave(ctx: Context): Promise { + onSceneLeave(): string { console.log('Leave from scene'); - await ctx.reply('Bye Bye 👋'); + return 'Bye Bye 👋'; } - @Command('hello') - async onHelloCommand(ctx: Context): Promise { - console.log('Use say hello'); - await ctx.reply('Hi'); + @Command(['rng', 'random']) + onRandomCommand(): number { + console.log('Use "random" command'); + return Math.floor(Math.random() * 11); } @Command('leave')