Skip to content
Merged

main #54

Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 4 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -89,10 +89,7 @@ bot.initParams({
const logic = new EchoController();
bot.initBotController(logic);

// Экспорт обработчика для serverless
module.exports = async (req: IncomingMessage, res: ServerResponse) => {
bot.start(req, res);
};
bot.start('localhost', 3000);
```

#### Логика приложения (EchoController.ts)
Expand Down Expand Up @@ -232,10 +229,7 @@ bot.initParams({
const controller = new MyController();
bot.initBotController(controller);

// Экспорт обработчика для serverless
module.exports = async (req: IncomingMessage, res: ServerResponse) => {
bot.start(req, res);
};
bot.start('localhost', 3000);
```

##### Работа с кнопками
Expand Down Expand Up @@ -429,11 +423,12 @@ acme.sh --install-cert -d {{domain}} --key-file {{key file}} --fullchain-file {{
С той лишь разницей, что нужно использовать класс `BotTest` вместо `Bot`.

```typescript
import { BotTest } from "umbot/dist/test";
import { BotTest } from 'umbot/dist/test';

const bot = new BotTest();
bot.test();
```

Запуск будет выглядеть следующим образом:

```bash
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -70,5 +70,5 @@
"files": [
"dist"
],
"version": "2.0.6"
"version": "2.0.8"
}
8 changes: 8 additions & 0 deletions src/controller/BotController.ts
Original file line number Diff line number Diff line change
Expand Up @@ -258,6 +258,11 @@ export interface IUserData {
* @template TUserData Тип пользовательских данных, по умолчанию {@link IUserData}
*/
export abstract class BotController<TUserData extends IUserData = IUserData> {
/**
* Локальное хранилище с данными. Используется в случаях, когда нужно сохранить данные пользователя, но userData приложением не поддерживается.
* В случае если данные хранятся в usetData и store, пользователю вернятеся информация из userData.
*/
public store: Record<string, unknown> | undefined;
/**
* Компонент для отображения кнопок пользователю
* Позволяет создавать интерактивные элементы управления
Expand Down Expand Up @@ -601,6 +606,9 @@ export abstract class BotController<TUserData extends IUserData = IUserData> {
this.nlu = new Nlu();
}

/**
* Очищает все временные данные необходимы для отправки ответа.
*/
public clearStoreData(): void {
this.buttons.clear();
this.card.clear();
Expand Down
6 changes: 6 additions & 0 deletions src/core/Bot.ts
Original file line number Diff line number Diff line change
Expand Up @@ -539,6 +539,12 @@ export class Bot<TUserData extends IUserData = IUserData> {
if (this._botController.isSendRating) {
content = await botClass.getRatingContext();
} else {
if (
this._botController.store &&
JSON.stringify(this._botController.userData) === '{}'
) {
this._botController.userData = this._botController.store as TUserData;
}
content = await botClass.getContext();
}
if (!isLocalStorage) {
Expand Down
5 changes: 1 addition & 4 deletions src/docs/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,10 +66,7 @@ bot.initParams({
const controller = new MyController();
bot.initBotController(controller);

// Экспортируем обработчик
export default async (req, res) => {
bot.start(req, res);
};
bot.start('localhost', 3000);
```

## Основные концепции
Expand Down
57 changes: 56 additions & 1 deletion tests/Bot/bot.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ import {
T_SMARTAPP,
T_USER_APP,
TemplateTypeModel,
IAlisaWebhookResponse,
} from '../../src';
import { Server } from 'http';

Expand All @@ -26,15 +27,24 @@ class TestBotController extends BotController {
}

action(intentName: string | null, isCommand?: boolean) {
if (isCommand) {
this.userData.cool = true;
return;
}
if (intentName === 'btn') {
this.buttons.addBtn('1');
this.tts = 'btn';
} else if (intentName === 'card') {
this.card.addImage('', 'Header');
this.tts = 'card';
} else if (intentName === 'setStore') {
this.store = {
data: 'test',
};
return;
}
this.text = 'test';
return 'test';
//return 'test';
}
}

Expand Down Expand Up @@ -227,6 +237,51 @@ describe('Bot', () => {
await expect(bot.run(botClass)).rejects.toThrow(error);
});

it('added user command', async () => {
bot.initBotController(botController);
mmApp.appType = T_USER_APP;
const botClass = new Alisa();
jest.spyOn(botClass, 'setLocalStorage').mockResolvedValue(undefined);
jest.spyOn(botClass, 'getError').mockReturnValue(null);

jest.spyOn(usersData, 'whereOne').mockResolvedValue(Promise.resolve(true));
jest.spyOn(usersData, 'save').mockResolvedValue(Promise.resolve(true));
jest.spyOn(usersData, 'update').mockResolvedValue(Promise.resolve(true));
mmApp.addCommand('cool', ['cool'], (_, botC) => {
botC.text = 'cool';
botC.userData.cool = true;
});

bot.setContent(getContent('cool', 2));
let res = (await bot.run(botClass)) as IAlisaWebhookResponse;
expect(res.response?.text).toBe('cool');
// Убеждаемся что пользовательские данные скинулись, так как они хранятся в сессии.
expect(botController.userData.cool).toBe(undefined);

mmApp.removeCommand('cool');
res = (await bot.run(botClass)) as IAlisaWebhookResponse;
expect(res.response?.text).toBe('test');
});

it('local store', async () => {
bot.initBotController(botController);
mmApp.appType = T_USER_APP;
const botClass = new Alisa();
mmApp.setParams({
intents: [{ name: 'setStore', slots: ['сохранить'] }],
});
mmApp.setConfig({ isLocalStorage: true });
jest.spyOn(botClass, 'getError').mockReturnValue(null);

jest.spyOn(usersData, 'whereOne').mockResolvedValue(Promise.resolve(true));
jest.spyOn(usersData, 'save').mockResolvedValue(Promise.resolve(true));
jest.spyOn(usersData, 'update').mockResolvedValue(Promise.resolve(true));

bot.setContent(getContent('сохранить', 2));
const res = (await bot.run(botClass)) as IAlisaWebhookResponse;
expect(res.session_state).toEqual({ data: 'test' });
});

it('skill started', async () => {
bot.initBotController(botController);
mmApp.appType = T_ALISA;
Expand Down
Loading