Skip to content

test(chat-client): give the jsdom-backed suites a realistic timeout budget #2843

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

Open
ashishrp-aws wants to merge 1 commit into
base: main
Choose a base branch
from
+20 −4
Open

test(chat-client): give the jsdom-backed suites a realistic timeout budget #2843

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
9 changes: 8 additions & 1 deletion chat-client/src/client/chat.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,14 @@ import { MynahUI } from '@aws/mynah-ui'
import { TabFactory } from './tabs/tabFactory'
import { ChatClientAdapter } from '../contracts/chatClientAdapter'

describe('Chat', () => {
describe('Chat', function () {
/**
* Also jsdom-backed: the slowest cases here reach ~570ms idle and 3.5s under load,
* i.e. 70% of the default 5s budget, so they are the next to flake. See the note in
* mynahUi.test.ts.
*/
this.timeout(30_000)

const sandbox = sinon.createSandbox()
const initialTabId = 'tab-1'
let mynahUi: MynahUI
Expand Down
15 changes: 12 additions & 3 deletions chat-client/src/client/mynahUi.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,18 @@ import { ChatHistory } from './features/history'
import { pairProgrammingModeOn, pairProgrammingModeOff } from './texts/pairProgramming'
import { strictEqual } from 'assert'

describe('MynahUI', () => {
describe('MynahUI', function () {
/**
* These tests drive the real MynahUI against jsdom, so creating a tab performs several
* hundred milliseconds of synchronous DOM work -- up to ~1.8s for the sendGenericCommand
* cases on an idle developer machine. Mocha reports a synchronous test that overruns its
* budget as "Timeout of Nms exceeded", so on a loaded CI runner (measured 4.6-7x slower)
* the default 5s budget is exceeded and the suite fails on whichever test is unlucky.
* One generous budget for the whole suite replaces the per-test 10s/30s patches that
* were added for the same reason.
*/
this.timeout(30_000)

let messager: Messager
let mynahUi: MynahUI
let inboundChatApi: InboundChatApi
Expand Down Expand Up @@ -248,7 +259,6 @@ describe('MynahUI', () => {

describe('sendGenericCommand', () => {
it('should create a new tab if none exits', function () {
this.timeout(10000) // Increase timeout to 10 seconds
// clear create tab stub since set up process calls it twice
createTabStub.resetHistory()
// Stub setTimeout to execute immediately
Expand All @@ -275,7 +285,6 @@ describe('MynahUI', () => {
})

it('should create a new tab if current tab is loading', function () {
this.timeout(30000)
// clear create tab stub since set up process calls it twice
createTabStub.resetHistory()
// Stub setTimeout to execute immediately
Expand Down
Loading