New livechat event handlers

[shiqimei]

What? ⛵

• Add assignAgent and unassignAgent event handlers
• Add LivechatRoomStartedHandler event handler

Why? 🤔

Implement partial requirements described in the issue #234

Links 🌎

https://app.asana.com/0/633285093795758/1165026712648489/f

RocketChat/Rocket.Chat#17033

PS 👀

[codecov]

Codecov Report

Merging #248 into alpha will increase coverage by 1.76%.
The diff coverage is 8.69%.

@@            Coverage Diff             @@
##            alpha     #248      +/-   ##
==========================================
+ Coverage   53.25%   55.02%   +1.76%     
==========================================
  Files          74       82       +8     
  Lines        2704     2866     +162     
  Branches      398      406       +8     
==========================================
+ Hits         1440     1577     +137     
- Misses       1264     1289      +25     

Impacted Files	Coverage Δ
src/server/managers/AppListenerManager.ts	7.89% <0.00%> (+3.60%)	⬆️
src/server/compiler/AppImplements.ts	100.00% <100.00%> (ø)
src/server/storage/index.ts	100.00% <0.00%> (ø)
src/server/compiler/index.ts	100.00% <0.00%> (ø)
src/server/bridges/index.ts	100.00% <0.00%> (ø)
src/server/accessors/index.ts	100.00% <0.00%> (ø)
src/server/marketplace/license/index.ts	100.00% <0.00%> (ø)
src/server/logging/index.ts	100.00% <0.00%> (ø)
src/server/errors/index.ts	100.00% <0.00%> (ø)
src/server/managers/index.ts	100.00% <0.00%> (ø)
... and 1 more

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 2a3840c...4887468. Read the comment docs.

[d-gubert]

This was automatically closed when I deleted the previous beta branch. Reopening now.

[d-gubert]

Brought a few items to discussion :)

Another question, did the Omnichannel team get to test these events and ensure they fit their needs?

[CLAassistant]

Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you all sign our Contributor License Agreement before we can accept your contribution.
2 out of 3 committers have signed the CLA.

✅ lolimay
✅ d-gubert
❌ sampaiodiego
_{You have signed the CLA already but the status is still pending? Let us recheck it.}

[shiqimei]

Brought a few items to discussion :)

Another question, did the Omnichannel team get to test these events and ensure they fit their needs?

Yeah, I agree. Hi @renatobecker. Can you take a look at these new APIs to make sure they are working?

Below is a minimal app that I do tests locally:

import {
    IAppAccessors,
    IHttp,
    ILogger,
    IPersistence,
    IRead,
} from '@rocket.chat/apps-engine/definition/accessors';
import { App } from '@rocket.chat/apps-engine/definition/App';
import { ILivechatEventContext, ILivechatRoom, ILivechatRoomClosedHandler, IPostLivechatAgentAssigned, IPostLivechatAgentUnassigned, IPostLivechatRoomClosed, IPostLivechatRoomStarted } from '@rocket.chat/apps-engine/definition/livechat';
import { IAppInfo } from '@rocket.chat/apps-engine/definition/metadata';

export class LivechatTestingApp extends App implements IPostLivechatAgentAssigned, ILivechatRoomClosedHandler, IPostLivechatAgentUnassigned, IPostLivechatRoomStarted, IPostLivechatRoomClosed {
    constructor(info: IAppInfo, logger: ILogger, accessors: IAppAccessors) {
        super(info, logger, accessors);
    }

    public async executePostLivechatAgentAssigned(data: ILivechatEventContext, read: IRead, http: IHttp, persistence: IPersistence) {
        console.log('executePostLivechatAgentAssigned', { data });
    }

    public async executePostLivechatAgentUnassigned(data: ILivechatEventContext, read: IRead, http: IHttp, persistence: IPersistence) {
        console.log('executePostLivechatAgentUnassigned', { data });
    }

    public async executePostLivechatRoomStarted(data: ILivechatRoom, read: IRead, http: IHttp, persistence: IPersistence) {
        console.log('executePostLivechatRoomStarted', { data });
    }

    public async executePostLivechatRoomClosed(data: ILivechatRoom, read: IRead, http: IHttp, persistence: IPersistence) {
        console.log('executePostLivechatRoomClosed', { data });
    }

    /**
     * @deprecated please prefer using execute executePostLivechatRoomClosed
     */
    public async executeLivechatRoomClosedHandler(data: ILivechatRoom, read: IRead, http: IHttp, persistence: IPersistence) {
        console.log('executeLivechatRoomClosedHandler', { data });
    }
}

[renatobecker]

Brought a few items to discussion :)
Another question, did the Omnichannel team get to test these events and ensure they fit their needs?

Yeah, I agree. Hi @renatobecker. Can you take a look at these new APIs to make sure they are working?

Below is a minimal app that I do tests locally:

import {
    IAppAccessors,
    IHttp,
    ILogger,
    IPersistence,
    IRead,
} from '@rocket.chat/apps-engine/definition/accessors';
import { App } from '@rocket.chat/apps-engine/definition/App';
import { ILivechatEventContext, ILivechatRoom, ILivechatRoomClosedHandler, IPostLivechatAgentAssigned, IPostLivechatAgentUnassigned, IPostLivechatRoomClosed, IPostLivechatRoomStarted } from '@rocket.chat/apps-engine/definition/livechat';
import { IAppInfo } from '@rocket.chat/apps-engine/definition/metadata';

export class LivechatTestingApp extends App implements IPostLivechatAgentAssigned, ILivechatRoomClosedHandler, IPostLivechatAgentUnassigned, IPostLivechatRoomStarted, IPostLivechatRoomClosed {
    constructor(info: IAppInfo, logger: ILogger, accessors: IAppAccessors) {
        super(info, logger, accessors);
    }

    public async executePostLivechatAgentAssigned(data: ILivechatEventContext, read: IRead, http: IHttp, persistence: IPersistence) {
        console.log('executePostLivechatAgentAssigned', { data });
    }

    public async executePostLivechatAgentUnassigned(data: ILivechatEventContext, read: IRead, http: IHttp, persistence: IPersistence) {
        console.log('executePostLivechatAgentUnassigned', { data });
    }

    public async executePostLivechatRoomStarted(data: ILivechatRoom, read: IRead, http: IHttp, persistence: IPersistence) {
        console.log('executePostLivechatRoomStarted', { data });
    }

    public async executePostLivechatRoomClosed(data: ILivechatRoom, read: IRead, http: IHttp, persistence: IPersistence) {
        console.log('executePostLivechatRoomClosed', { data });
    }

    /**
     * @deprecated please prefer using execute executePostLivechatRoomClosed
     */
    public async executeLivechatRoomClosedHandler(data: ILivechatRoom, read: IRead, http: IHttp, persistence: IPersistence) {
        console.log('executeLivechatRoomClosedHandler', { data });
    }
}

Hi @lolimay sure thing, let me test these new event handlers and give you feedback.

[renatobecker]

@lolimay and @d-gubert,
apart from the comments I left in my review(some typos), I just performed tests simulating the new event handlers and everything is working fine.

Congrats! 🥇 👍