mirror of
https://github.com/Maks1mS/nestjs-telegraf.git
synced 2025-09-30 04:18:51 +03:00
initial commit
This commit is contained in:
Alexander Bukhalo
@@ -1,52 +0,0 @@
|
||||
import { InstanceWrapper } from '@nestjs/core/injector/instance-wrapper';
|
||||
import { Module } from '@nestjs/core/injector/module';
|
||||
import { flattenDeep, identity, isEmpty } from 'lodash';
|
||||
|
||||
export class BaseExplorerService {
|
||||
getModules(
|
||||
modulesContainer: Map<string, Module>,
|
||||
include: Function[],
|
||||
): Module[] {
|
||||
if (!include || isEmpty(include)) {
|
||||
return [...modulesContainer.values()];
|
||||
}
|
||||
return this.includeWhitelisted(modulesContainer, include);
|
||||
}
|
||||
|
||||
includeWhitelisted(
|
||||
modulesContainer: Map<string, Module>,
|
||||
include: Function[],
|
||||
): Module[] {
|
||||
const modules = [...modulesContainer.values()];
|
||||
return modules.filter(({ metatype }) => include.includes(metatype));
|
||||
}
|
||||
|
||||
flatMap<T>(
|
||||
modules: Module[],
|
||||
callback: (instance: InstanceWrapper, moduleRef: Module) => T | T[],
|
||||
): T[] {
|
||||
const visitedModules = new Set<Module>();
|
||||
|
||||
const unwrap = (moduleRef: Module) => {
|
||||
// protection from circular recursion
|
||||
if (visitedModules.has(moduleRef)) {
|
||||
return [];
|
||||
} else {
|
||||
visitedModules.add(moduleRef);
|
||||
}
|
||||
|
||||
const providers = [...moduleRef.providers.values()];
|
||||
const defined = providers.map((wrapper) => callback(wrapper, moduleRef));
|
||||
|
||||
const imported: (T | T[])[] = moduleRef.imports?.size
|
||||
? [...moduleRef.imports.values()].reduce((prev, cur) => {
|
||||
return [...prev, ...unwrap(cur)];
|
||||
}, [])
|
||||
: [];
|
||||
|
||||
return [...defined, ...imported];
|
||||
};
|
||||
|
||||
return flattenDeep(modules.map(unwrap)).filter(identity);
|
||||
}
|
||||
}
|
||||
@@ -1,3 +0,0 @@
|
||||
export * from './listeners-explorer.service';
|
||||
export * from './metadata-accessor.service';
|
||||
export * from './listeners-explorer.service';
|
||||
@@ -1,239 +0,0 @@
|
||||
import { Inject, Injectable, OnModuleInit } from '@nestjs/common';
|
||||
import { DiscoveryService, ModuleRef, ModulesContainer } from '@nestjs/core';
|
||||
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 { Composer, Context, Scenes, Telegraf } from 'telegraf';
|
||||
|
||||
import { MetadataAccessorService } from './metadata-accessor.service';
|
||||
import {
|
||||
PARAM_ARGS_METADATA,
|
||||
TELEGRAF_BOT_NAME,
|
||||
TELEGRAF_MODULE_OPTIONS,
|
||||
TELEGRAF_STAGE,
|
||||
} from '../telegraf.constants';
|
||||
import { BaseExplorerService } from './base-explorer.service';
|
||||
import { TelegrafParamsFactory } from '../factories/telegraf-params-factory';
|
||||
import { TelegrafContextType } from '../execution-context';
|
||||
import { ListenerMetadata, TelegrafModuleOptions } from '../interfaces';
|
||||
|
||||
@Injectable()
|
||||
export class ListenersExplorerService
|
||||
extends BaseExplorerService
|
||||
implements OnModuleInit
|
||||
{
|
||||
private readonly telegrafParamsFactory = new TelegrafParamsFactory();
|
||||
private bot: Telegraf<any>;
|
||||
|
||||
constructor(
|
||||
@Inject(TELEGRAF_STAGE)
|
||||
private readonly stage: Scenes.Stage<any>,
|
||||
@Inject(TELEGRAF_MODULE_OPTIONS)
|
||||
private readonly telegrafOptions: TelegrafModuleOptions,
|
||||
@Inject(TELEGRAF_BOT_NAME)
|
||||
private readonly botName: string,
|
||||
private readonly moduleRef: ModuleRef,
|
||||
private readonly discoveryService: DiscoveryService,
|
||||
private readonly metadataAccessor: MetadataAccessorService,
|
||||
private readonly metadataScanner: MetadataScanner,
|
||||
private readonly modulesContainer: ModulesContainer,
|
||||
private readonly externalContextCreator: ExternalContextCreator,
|
||||
) {
|
||||
super();
|
||||
}
|
||||
|
||||
onModuleInit(): void {
|
||||
this.bot = this.moduleRef.get<Telegraf<any>>(this.botName, {
|
||||
strict: false,
|
||||
});
|
||||
this.bot.use(this.stage.middleware());
|
||||
|
||||
this.explore();
|
||||
}
|
||||
|
||||
explore(): void {
|
||||
const modules = this.getModules(
|
||||
this.modulesContainer,
|
||||
this.telegrafOptions.include || [],
|
||||
);
|
||||
|
||||
this.registerUpdates(modules);
|
||||
this.registerScenes(modules);
|
||||
}
|
||||
|
||||
private registerUpdates(modules: Module[]): void {
|
||||
const updates = this.flatMap<InstanceWrapper>(modules, (instance) =>
|
||||
this.filterUpdates(instance),
|
||||
);
|
||||
updates.forEach((wrapper) => this.registerListeners(this.bot, wrapper));
|
||||
}
|
||||
|
||||
private registerScenes(modules: Module[]): void {
|
||||
const scenes = this.flatMap<InstanceWrapper>(modules, (wrapper) =>
|
||||
this.filterScenes(wrapper),
|
||||
);
|
||||
scenes.forEach((wrapper) => {
|
||||
const { sceneId, type, options } = this.metadataAccessor.getSceneMetadata(
|
||||
wrapper.instance.constructor,
|
||||
);
|
||||
const scene =
|
||||
type === 'base'
|
||||
? new Scenes.BaseScene<any>(sceneId, options || ({} as any))
|
||||
: new Scenes.WizardScene<any>(sceneId, options || ({} as any));
|
||||
this.stage.register(scene);
|
||||
|
||||
if (type === 'base') {
|
||||
this.registerListeners(scene, wrapper);
|
||||
} else {
|
||||
this.registerWizardListeners(scene as Scenes.WizardScene<any>, wrapper);
|
||||
}
|
||||
});
|
||||
}
|
||||
|
||||
private filterUpdates(wrapper: InstanceWrapper): InstanceWrapper<unknown> {
|
||||
const { instance } = wrapper;
|
||||
if (!instance) return undefined;
|
||||
|
||||
const isUpdate = this.metadataAccessor.isUpdate(wrapper.metatype);
|
||||
if (!isUpdate) return undefined;
|
||||
|
||||
return wrapper;
|
||||
}
|
||||
|
||||
private filterScenes(wrapper: InstanceWrapper): InstanceWrapper<unknown> {
|
||||
const { instance } = wrapper;
|
||||
if (!instance) return undefined;
|
||||
|
||||
const isScene = this.metadataAccessor.isScene(wrapper.metatype);
|
||||
if (!isScene) return undefined;
|
||||
|
||||
return wrapper;
|
||||
}
|
||||
|
||||
private registerListeners(
|
||||
composer: Composer<any>,
|
||||
wrapper: InstanceWrapper<unknown>,
|
||||
): void {
|
||||
const { instance } = wrapper;
|
||||
const prototype = Object.getPrototypeOf(instance);
|
||||
this.metadataScanner.scanFromPrototype(instance, prototype, (name) =>
|
||||
this.registerIfListener(composer, instance, prototype, name),
|
||||
);
|
||||
}
|
||||
|
||||
private registerWizardListeners(
|
||||
wizard: Scenes.WizardScene<any>,
|
||||
wrapper: InstanceWrapper<unknown>,
|
||||
): void {
|
||||
const { instance } = wrapper;
|
||||
const prototype = Object.getPrototypeOf(instance);
|
||||
|
||||
type WizardMetadata = { step: number; methodName: string };
|
||||
const wizardSteps: WizardMetadata[] = [];
|
||||
const basicListeners = [];
|
||||
|
||||
this.metadataScanner.scanFromPrototype(
|
||||
instance,
|
||||
prototype,
|
||||
(methodName) => {
|
||||
const methodRef = prototype[methodName];
|
||||
const metadata = this.metadataAccessor.getWizardStepMetadata(methodRef);
|
||||
if (!metadata) {
|
||||
basicListeners.push(methodName);
|
||||
return undefined;
|
||||
}
|
||||
wizardSteps.push({ step: metadata.step, methodName });
|
||||
},
|
||||
);
|
||||
|
||||
for (const methodName of basicListeners) {
|
||||
this.registerIfListener(wizard, instance, prototype, methodName);
|
||||
}
|
||||
|
||||
const group = wizardSteps
|
||||
.sort((a, b) => a.step - b.step)
|
||||
.reduce<{ [key: number]: WizardMetadata[] }>(
|
||||
(prev, cur) => ({
|
||||
...prev,
|
||||
[cur.step]: [...(prev[cur.step] || []), cur],
|
||||
}),
|
||||
{},
|
||||
);
|
||||
|
||||
wizard.steps = Object.values(group).map((stepsMetadata) => {
|
||||
const composer = new Composer();
|
||||
stepsMetadata.forEach((stepMethod) => {
|
||||
this.registerIfListener(
|
||||
composer,
|
||||
instance,
|
||||
prototype,
|
||||
stepMethod.methodName,
|
||||
[{ method: 'use', args: [] }],
|
||||
);
|
||||
});
|
||||
return composer.middleware();
|
||||
});
|
||||
}
|
||||
|
||||
private registerIfListener(
|
||||
composer: Composer<any>,
|
||||
instance: any,
|
||||
prototype: any,
|
||||
methodName: string,
|
||||
defaultMetadata?: ListenerMetadata[],
|
||||
): void {
|
||||
const methodRef = prototype[methodName];
|
||||
const metadata =
|
||||
this.metadataAccessor.getListenerMetadata(methodRef) || defaultMetadata;
|
||||
if (!metadata || metadata.length < 1) {
|
||||
return undefined;
|
||||
}
|
||||
|
||||
const listenerCallbackFn = this.createContextCallback(
|
||||
instance,
|
||||
prototype,
|
||||
methodName,
|
||||
);
|
||||
|
||||
for (const { method, args } of metadata) {
|
||||
/* Basic callback */
|
||||
// composer[method](...args, listenerCallbackFn);
|
||||
|
||||
/* Complex callback return value handing */
|
||||
composer[method](
|
||||
...args,
|
||||
async (ctx: Context, next: Function): Promise<void> => {
|
||||
const result = await listenerCallbackFn(ctx, next);
|
||||
if (result) {
|
||||
await ctx.reply(String(result));
|
||||
}
|
||||
// TODO-Possible-Feature: Add more supported return types
|
||||
},
|
||||
);
|
||||
}
|
||||
}
|
||||
|
||||
createContextCallback<T extends Record<string, unknown>>(
|
||||
instance: T,
|
||||
prototype: unknown,
|
||||
methodName: string,
|
||||
) {
|
||||
const paramsFactory = this.telegrafParamsFactory;
|
||||
return this.externalContextCreator.create<
|
||||
Record<number, ParamMetadata>,
|
||||
TelegrafContextType
|
||||
>(
|
||||
instance,
|
||||
prototype[methodName],
|
||||
methodName,
|
||||
PARAM_ARGS_METADATA,
|
||||
paramsFactory,
|
||||
undefined,
|
||||
undefined,
|
||||
undefined,
|
||||
'telegraf',
|
||||
);
|
||||
}
|
||||
}
|
||||
@@ -1,40 +0,0 @@
|
||||
import { Injectable } from '@nestjs/common';
|
||||
import { Reflector } from '@nestjs/core';
|
||||
import {
|
||||
SCENE_METADATA,
|
||||
LISTENERS_METADATA,
|
||||
UPDATE_METADATA,
|
||||
WIZARD_STEP_METADATA,
|
||||
} from '../telegraf.constants';
|
||||
import {
|
||||
ListenerMetadata,
|
||||
SceneMetadata,
|
||||
WizardStepMetadata,
|
||||
} from '../interfaces';
|
||||
|
||||
@Injectable()
|
||||
export class MetadataAccessorService {
|
||||
constructor(private readonly reflector: Reflector) {}
|
||||
|
||||
isUpdate(target: Function): boolean {
|
||||
if (!target) return false;
|
||||
return !!this.reflector.get(UPDATE_METADATA, target);
|
||||
}
|
||||
|
||||
isScene(target: Function): boolean {
|
||||
if (!target) return false;
|
||||
return !!this.reflector.get(SCENE_METADATA, target);
|
||||
}
|
||||
|
||||
getListenerMetadata(target: Function): ListenerMetadata[] | undefined {
|
||||
return this.reflector.get(LISTENERS_METADATA, target);
|
||||
}
|
||||
|
||||
getSceneMetadata(target: Function): SceneMetadata | undefined {
|
||||
return this.reflector.get(SCENE_METADATA, target);
|
||||
}
|
||||
|
||||
getWizardStepMetadata(target: Function): WizardStepMetadata | undefined {
|
||||
return this.reflector.get(WIZARD_STEP_METADATA, target);
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user