import Core from '@secret-agent/core';
import CoreServer from '@secret-agent/core/server';
import { Helpers } from '@secret-agent/testing';
import { KeyboardKeys } from '@secret-agent/interfaces/IKeyboardLayoutUS';
import { Command } from '@secret-agent/client/interfaces/IInteractions';
import { ITestKoaServer } from '@secret-agent/testing/helpers';
import HumanEmulator from '@secret-agent/plugin-utils/lib/HumanEmulator';
import { Handler, LocationStatus } from '../index';
let koaServer: ITestKoaServer;
let handler: Handler;
beforeAll(async () => {
const coreServer = new CoreServer();
await coreServer.listen({ port: 0 });
Core.use(
class BasicHumanEmulator extends HumanEmulator {
static id = 'basic';
},
);
handler = new Handler({ host: await coreServer.address });
Helpers.onClose(() => {
handler.close();
coreServer.close();
}, true);
koaServer = await Helpers.runKoaServer(true);
});
afterAll(Helpers.afterAll);
afterEach(Helpers.afterEach);
describe('basic Interact tests', () => {
it('should be able to go to a second page', async () => {
const text = "hello, is it me you're looking for?";
const onPost = jest.fn().mockImplementation(body => {
expect(body).toBe(text);
});
const httpServer = await Helpers.runHttpServer({ onPost });
const url = httpServer.url;
const agent = await handler.createAgent();
Helpers.needsClosing.push(agent);
await agent.goto(`${url}page1`);
await agent.document.querySelector('#input').focus();
await agent.waitForMillis(50);
await agent.interact({ type: text });
await agent.waitForMillis(20);
await agent.click(agent.document.querySelector('#submit-button'));
await agent.waitForLocation('change');
const html = await agent.document.documentElement.outerHTML;
expect(html).toBe(`<html><head></head><body>${text}</body></html>`);
expect(onPost).toHaveBeenCalledTimes(1);
await agent.close();
await httpServer.close();
}, 30e3);
it('should clean up cookies between runs', async () => {
const agent1 = await handler.createAgent();
let setCookieValue = 'ulixee=test1';
const httpServer = await Helpers.runHttpServer({
addToResponse: response => {
response.setHeader('Set-Cookie', setCookieValue);
},
});
const url = httpServer.url;
Helpers.needsClosing.push(agent1);
{
await agent1.goto(url);
const cookie = await agent1.activeTab.cookieStorage.getItem('ulixee');
expect(cookie.value).toBe('test1');
}
{
setCookieValue = 'ulixee2=test2';
await agent1.goto(url);
const cookieStorage = await agent1.activeTab.cookieStorage;
expect(await cookieStorage.length).toBe(2);
const cookie1 = await cookieStorage.getItem('ulixee');
expect(cookie1.value).toBe('test1');
const cookie2 = await cookieStorage.getItem('ulixee2');
expect(cookie2.value).toBe('test2');
}
{
setCookieValue = 'ulixee3=test3';
const agent2 = await handler.createAgent();
Helpers.needsClosing.push(agent2);
await agent2.goto(url);
const cookieStorage = await agent2.activeTab.cookieStorage;
expect(await cookieStorage.length).toBe(1);
const cookie = await cookieStorage.getItem('ulixee3');
expect(cookie.value).toBe('test3');
await agent2.close();
}
await agent1.close();
}, 20e3);
it('should be able to combine a waitForElementVisible and a click', async () => {
koaServer.get('/waitTest', ctx => {
ctx.body = `
<body>
<a href="/finish">Click Me</a>
<script>
setTimeout(() => {
document.querySelector('a').classList.add('ready');
}, 200);
</script>
</body>
`;
});
koaServer.get('/finish', ctx => (ctx.body = `Finished!`));
const agent = await handler.createAgent();
Helpers.needsClosing.push(agent);
await agent.goto(`${koaServer.baseUrl}/waitTest`);
await agent.waitForPaintingStable();
const readyLink = agent.document.querySelector('a.ready');
await agent.interact({ click: readyLink, waitForElementVisible: readyLink });
await agent.waitForLocation('change');
const finalUrl = await agent.url;
expect(finalUrl).toBe(`${koaServer.baseUrl}/finish`);
await agent.close();
});
it('should be able to type various combinations of characters', async () => {
koaServer.get('/keys', ctx => {
ctx.body = `
<body>
<h1>Text Area</h1>
<textarea></textarea>
</body>
`;
});
const agent = await handler.createAgent();
Helpers.needsClosing.push(agent);
await agent.goto(`${koaServer.baseUrl}/keys`);
await agent.waitForPaintingStable();
const textarea = agent.document.querySelector('textarea');
await agent.click(textarea);
await agent.type('Test!');
expect(await textarea.value).toBe('Test!');
await agent.type(KeyboardKeys.Backspace);
expect(await textarea.value).toBe('Test');
await agent.interact(
{ [Command.keyDown]: KeyboardKeys.Shift },
{ [Command.keyPress]: KeyboardKeys.ArrowLeft },
{ [Command.keyPress]: KeyboardKeys.ArrowLeft },
{ [Command.keyPress]: KeyboardKeys.ArrowLeft },
{ [Command.keyUp]: KeyboardKeys.Shift },
{ [Command.keyPress]: KeyboardKeys.Delete },
);
expect(await textarea.value).toBe('T');
await agent.close();
});
it('should be able to click on the same element twice', async () => {
koaServer.get('/twice', ctx => {
ctx.body = `
<body>
<div id="spot">Twice spot</div>
</body>
`;
});
const agent = await handler.createAgent({
humanEmulatorId: 'basic',
});
Helpers.needsClosing.push(agent);
await agent.goto(`${koaServer.baseUrl}/twice`);
await agent.activeTab.waitForLoad(LocationStatus.DomContentLoaded);
const logo = agent.document.querySelector('#spot');
await expect(agent.interact({ click: logo })).resolves.toBeUndefined();
await agent.waitForMillis(100);
await expect(agent.interact({ click: logo })).resolves.toBeUndefined();
await agent.close();
});
it('can accept empty commands', async () => {
koaServer.get('/empty-click', ctx => {
ctx.body = `
<body>
<div style="margin-top: 200px">
<a href="#none" onclick="clickit()">Empty clicker</a>
</div>
<script>
let lastClicked = '';
function clickit() {
lastClicked = 'clickedit';
}
</script>
</body>
`;
});
const agent = await handler.createAgent({ humanEmulatorId: 'basic' });
Helpers.needsClosing.push(agent);
await agent.goto(`${koaServer.baseUrl}/empty-click`);
await agent.activeTab.waitForLoad(LocationStatus.PaintingStable);
await agent.interact(
{
[Command.move]: agent.document.querySelector('a'),
},
'click',
);
expect(await agent.activeTab.getJsValue('lastClicked')).toBe('clickedit');
});
it('should be able to click an element in an iframe', async () => {
koaServer.get('/interact-frame', ctx => {
ctx.body = `
<body>
<h1>Iframe Page</h1>
<br/><br/>
<iframe src="/innerFrame" id="frame1" style="height:300px"></iframe>
</body>
`;
});
koaServer.get('/innerFrame', ctx => {
ctx.body = `<body>
<div style="margin-top: 200px">
<a href="#none" onclick="clickit()">Empty clicker</a>
</div>
<script>
let lastClicked = '';
function clickit() {
lastClicked = 'clickedit';
}
</script>
</body>`;
});
const agent = await handler.createAgent();
Helpers.needsClosing.push(agent);
await agent.goto(`${koaServer.baseUrl}/interact-frame`);
await agent.waitForPaintingStable();
const frameElement = agent.document.querySelector('#frame1');
await agent.waitForElement(frameElement);
const frameEnv = await agent.activeTab.getFrameEnvironment(frameElement);
await frameEnv.waitForLoad(LocationStatus.AllContentLoaded);
await agent.click(frameEnv.document.querySelector('a'));
expect(await frameEnv.getJsValue('lastClicked')).toBe('clickedit');
await agent.close();
});
});
