Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[JS] feat: add helper functions to to get Teams channels, members, and details #1949

Open
wants to merge 5 commits into
base: main
Choose a base branch
from
Open

[JS] feat: add helper functions to to get Teams channels, members, and details #1949

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
97414b3
helper functions for notification bot
yiqing-zhao Aug 12, 2024
e962a02
feat: update comments
yiqing-zhao Aug 14, 2024
b434b42
Merge branch 'main' into yiqingzhao/temasInfo
yiqing-zhao Aug 26, 2024
0bd3305
test: add unit tests for new API
Sep 8, 2024
1f8db2f
Merge branch 'main' into yiqingzhao/temasInfo
yiqing-zhao Sep 8, 2024
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
308 changes: 307 additions & 1 deletion js/packages/teams-ai/src/Application.spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,14 @@ import {
MessageReactionTypes,
TestAdapter,
O365ConnectorCardActionQuery,
FileConsentCardResponse
FileConsentCardResponse,
TurnContext,
TeamsInfo,
ConversationReference,
TeamDetails,
ChannelInfo,
TeamsChannelAccount,
TeamsPagedMembersResult
} from 'botbuilder';

import {
Expand Down Expand Up @@ -920,4 +927,303 @@ describe('Application', () => {
});
});
});

describe('getTeamChannels', () => {
let app = new Application();
let stubContext: sinon.SinonStubbedInstance<TurnContext>;
const returnedChannels: ChannelInfo[] = [{ id: 'testChannelId', name: 'testName' }];

beforeEach(() => {
app = new Application({ adapter: new TeamsAdapter() });
stubContext = sandbox.createStubInstance(TurnContext);
const stubAdapter = sandbox.createStubInstance(CloudAdapter);
(
stubAdapter.continueConversationAsync as unknown as sinon.SinonStub<
[string, Partial<ConversationReference>, (context: TurnContext) => Promise<void>],
Promise<void>
>
).callsFake(async (fakeBotAppId, ref, logic) => {
await logic(stubContext);
});
sandbox.stub(app, 'adapter').get(() => stubAdapter);
sandbox.stub(TeamsInfo, 'getTeamChannels').resolves(returnedChannels);
});

it('should return empty array if conversationType is not channel', async () => {
sandbox.stub(TurnContext, 'getConversationReference').returns({
conversation: {
isGroup: false,
conversationType: 'personal',
id: 'testChannelId',
name: 'testName'
}
});
const continueConversationAsyncStub = sandbox.stub(testAdapter, 'continueConversationAsync').resolves();

const channels = await app.getTeamChannels(new TurnContext(testAdapter, {}));

assert.equal(channels.length, 0);
assert(continueConversationAsyncStub.notCalled);
});

it('should return channel array if conversationType is channel with defined teamId', async () => {
sandbox.stub(TurnContext, 'getConversationReference').returns({
conversation: {
isGroup: false,
conversationType: 'channel',
id: 'testChannelId',
name: 'testName'
}
});
sandbox.stub(TurnContext.prototype, 'activity').get(() => {
return {
channelData: {
team: {
id: 'testId'
}
}
};
});

const channels = await app.getTeamChannels({
conversation: {
isGroup: false,
conversationType: 'channel',
id: 'testChannelId',
name: 'testName'
}
});

assert.deepEqual(channels, returnedChannels);
});

it('should return channel array if conversationType is channel with defined conversationId and undefined name', async () => {
sandbox.stub(TurnContext, 'getConversationReference').returns({
conversation: {
isGroup: false,
conversationType: 'channel',
id: 'testChannelId',
name: 'testName'
}
});
sandbox.stub(TurnContext.prototype, 'activity').get(() => {
return {
conversation: {
id: 'teamId'
}
};
});

const channels = await app.getTeamChannels({
conversation: {
isGroup: false,
conversationType: 'channel',
id: 'testChannelId',
name: 'testName'
}
});

assert.deepEqual(channels, returnedChannels);
});

it('should return empty array if conversationType is channel with defined name', async () => {
sandbox.stub(TurnContext, 'getConversationReference').returns({
conversation: {
isGroup: false,
conversationType: 'channel',
id: 'testChannelId',
name: 'testName'
}
});
sandbox.stub(TurnContext.prototype, 'activity').get(() => {
return {
conversation: {
name: 'teamName',
id: 'teamId'
}
};
});

const channels = await app.getTeamChannels({
conversation: {
isGroup: false,
conversationType: 'channel',
id: 'testChannelId',
name: 'testName'
}
});

assert.equal(channels.length, 0);
});
});

describe('getTeamDetails', () => {
let app = new Application();
let stubContext: sinon.SinonStubbedInstance<TurnContext>;
const returnedDetails: TeamDetails = {
id: 'teamId',
name: 'teamName'
};

beforeEach(() => {
app = new Application({ adapter: new TeamsAdapter() });
stubContext = sandbox.createStubInstance(TurnContext);
const stubAdapter = sandbox.createStubInstance(CloudAdapter);
(
stubAdapter.continueConversationAsync as unknown as sinon.SinonStub<
[string, Partial<ConversationReference>, (context: TurnContext) => Promise<void>],
Promise<void>
>
).callsFake(async (fakeBotAppId, ref, logic) => {
await logic(stubContext);
});
sandbox.stub(app, 'adapter').get(() => stubAdapter);
sandbox.stub(TeamsInfo, 'getTeamDetails').resolves(returnedDetails);
});

it('should return undefined details if conversationType is not channel', async () => {
sandbox.stub(TurnContext, 'getConversationReference').returns({
conversation: {
isGroup: false,
conversationType: 'personal',
id: 'testChannelId',
name: 'testName'
}
});
const continueConversationAsyncStub = sandbox.stub(testAdapter, 'continueConversationAsync').resolves();

const details = await app.getTeamDetails(new TurnContext(testAdapter, {}));

assert.equal(details, undefined);
assert(continueConversationAsyncStub.notCalled);
});

it('should return team details if conversationType is channel with defined teamId', async () => {
sandbox.stub(TurnContext, 'getConversationReference').returns({
conversation: {
isGroup: false,
conversationType: 'channel',
id: 'testChannelId',
name: 'testName'
}
});
sandbox.stub(TurnContext.prototype, 'activity').get(() => {
return {
channelData: {
team: {
id: 'testId'
}
}
};
});

const details = await app.getTeamDetails({
conversation: {
isGroup: false,
conversationType: 'channel',
id: 'testChannelId',
name: 'testName'
}
});

assert.deepEqual(details, returnedDetails);
});

it('should return team details if conversationType is channel with defined conversationId and undefined name', async () => {
sandbox.stub(TurnContext, 'getConversationReference').returns({
conversation: {
isGroup: false,
conversationType: 'channel',
id: 'testChannelId',
name: 'testName'
}
});
sandbox.stub(TurnContext.prototype, 'activity').get(() => {
return {
conversation: {
id: 'teamId'
}
};
});

const details = await app.getTeamDetails({
conversation: {
isGroup: false,
conversationType: 'channel',
id: 'testChannelId',
name: 'testName'
}
});

assert.deepEqual(details, returnedDetails);
});

it('should return undefined if conversationType is channel with defined name', async () => {
sandbox.stub(TurnContext, 'getConversationReference').returns({
conversation: {
isGroup: false,
conversationType: 'channel',
id: 'testChannelId',
name: 'testName'
}
});
sandbox.stub(TurnContext.prototype, 'activity').get(() => {
return {
conversation: {
name: 'teamName',
id: 'teamId'
}
};
});

const details = await app.getTeamDetails({
conversation: {
isGroup: false,
conversationType: 'channel',
id: 'testChannelId',
name: 'testName'
}
});

assert.equal(details, undefined);
});
});

describe('getPagedMembers', () => {
let app = new Application();
let stubContext: sinon.SinonStubbedInstance<TurnContext>;
const returnedPagedMembers: TeamsPagedMembersResult = {
continuationToken: 'token',
members: [{} as TeamsChannelAccount, {} as TeamsChannelAccount]
};

beforeEach(() => {
app = new Application({ adapter: new TeamsAdapter() });
stubContext = sandbox.createStubInstance(TurnContext);
const stubAdapter = sandbox.createStubInstance(CloudAdapter);
(
stubAdapter.continueConversationAsync as unknown as sinon.SinonStub<
[string, Partial<ConversationReference>, (context: TurnContext) => Promise<void>],
Promise<void>
>
).callsFake(async (fakeBotAppId, ref, logic) => {
await logic(stubContext);
});
sandbox.stub(app, 'adapter').get(() => stubAdapter);
sandbox.stub(TeamsInfo, 'getPagedMembers').resolves(returnedPagedMembers);
});

it('should return paged members result', async () => {
const pagedMembers = await app.getPagedMembers({
conversation: {
isGroup: false,
conversationType: 'channel',
id: 'testChannelId',
name: 'testName'
}
});

assert.deepEqual(pagedMembers, returnedPagedMembers);
});
});
});
Loading
Loading