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

[7.x] [Reporting] Revisit handling timeouts for different phases of screenshot capture (#113807) #115418

Merged
merged 1 commit into from
Oct 18, 2021
Merged

[7.x] [Reporting] Revisit handling timeouts for different phases of screenshot capture (#113807) #115418

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
22 changes: 0 additions & 22 deletions x-pack/plugins/reporting/server/lib/screenshots/check_browser_open.ts
View file
Open in desktop

This file was deleted.

9 changes: 6 additions & 3 deletions x-pack/plugins/reporting/server/lib/screenshots/get_number_of_items.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@
*/

import { set } from 'lodash';
import { durationToNumber } from '../../../common/schema_utils';
import { HeadlessChromiumDriver } from '../../browsers';
import {
createMockBrowserDriverFactory,
Expand All @@ -25,6 +26,7 @@ describe('getNumberOfItems', () => {
let layout: LayoutInstance;
let logger: jest.Mocked<LevelLogger>;
let browser: HeadlessChromiumDriver;
let timeout: number;

beforeEach(async () => {
const schema = createMockConfigSchema(set({}, 'capture.timeouts.waitForElements', 0));
Expand All @@ -34,6 +36,7 @@ describe('getNumberOfItems', () => {
captureConfig = config.get('capture');
layout = createMockLayoutInstance(captureConfig);
logger = createMockLevelLogger();
timeout = durationToNumber(captureConfig.timeouts.waitForElements);

await createMockBrowserDriverFactory(core, logger, {
evaluate: jest.fn(
Expand Down Expand Up @@ -62,7 +65,7 @@ describe('getNumberOfItems', () => {
<div itemsSelector="10" />
`;

await expect(getNumberOfItems(captureConfig, browser, layout, logger)).resolves.toBe(10);
await expect(getNumberOfItems(timeout, browser, layout, logger)).resolves.toBe(10);
});

it('should determine the number of items by selector ', async () => {
Expand All @@ -72,7 +75,7 @@ describe('getNumberOfItems', () => {
<renderedSelector />
`;

await expect(getNumberOfItems(captureConfig, browser, layout, logger)).resolves.toBe(3);
await expect(getNumberOfItems(timeout, browser, layout, logger)).resolves.toBe(3);
});

it('should fall back to the selector when the attribute is empty', async () => {
Expand All @@ -82,6 +85,6 @@ describe('getNumberOfItems', () => {
<renderedSelector />
`;

await expect(getNumberOfItems(captureConfig, browser, layout, logger)).resolves.toBe(2);
await expect(getNumberOfItems(timeout, browser, layout, logger)).resolves.toBe(2);
});
});
12 changes: 3 additions & 9 deletions x-pack/plugins/reporting/server/lib/screenshots/get_number_of_items.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,15 +6,13 @@
*/

import { i18n } from '@kbn/i18n';
import { durationToNumber } from '../../../common/schema_utils';
import { LevelLogger, startTrace } from '../';
import { HeadlessChromiumDriver } from '../../browsers';
import { CaptureConfig } from '../../types';
import { LayoutInstance } from '../layouts';
import { CONTEXT_GETNUMBEROFITEMS, CONTEXT_READMETADATA } from './constants';

export const getNumberOfItems = async (
captureConfig: CaptureConfig,
timeout: number,
browser: HeadlessChromiumDriver,
layout: LayoutInstance,
logger: LevelLogger
Expand All @@ -33,7 +31,6 @@ export const getNumberOfItems = async (
// the dashboard is using the `itemsCountAttribute` attribute to let us
// know how many items to expect since gridster incrementally adds panels
// we have to use this hint to wait for all of them
const timeout = durationToNumber(captureConfig.timeouts.waitForElements);
await browser.waitForSelector(
`${renderCompleteSelector},[${itemsCountAttribute}]`,
{ timeout },
Expand Down Expand Up @@ -65,11 +62,8 @@ export const getNumberOfItems = async (
logger.error(err);
throw new Error(
i18n.translate('xpack.reporting.screencapture.readVisualizationsError', {
defaultMessage: `An error occurred when trying to read the page for visualization panel info. You may need to increase '{configKey}'. {error}`,
values: {
error: err,
configKey: 'xpack.reporting.capture.timeouts.waitForElements',
},
defaultMessage: `An error occurred when trying to read the page for visualization panel info: {error}`,
values: { error: err },
})
);
}
Expand Down
19 changes: 19 additions & 0 deletions x-pack/plugins/reporting/server/lib/screenshots/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,19 @@ import { LayoutInstance } from '../layouts';

export { getScreenshots$ } from './observable';

export interface PhaseInstance {
timeoutValue: number;
configValue: string;
label: string;
}

export interface PhaseTimeouts {
openUrl: PhaseInstance;
waitForElements: PhaseInstance;
renderComplete: PhaseInstance;
loadDelay: number;
}

export interface ScreenshotObservableOpts {
logger: LevelLogger;
urlsOrUrlLocatorTuples: UrlOrUrlLocatorTuple[];
Expand Down Expand Up @@ -49,6 +62,12 @@ export interface Screenshot {
description: string | null;
}

export interface PageSetupResults {
elementsPositionAndAttributes: ElementsPositionAndAttribute[] | null;
timeRange: string | null;
error?: Error;
}

export interface ScreenshotResults {
timeRange: string | null;
screenshots: Screenshot[];
Expand Down
10 changes: 2 additions & 8 deletions x-pack/plugins/reporting/server/lib/screenshots/observable.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -98,7 +98,6 @@ describe('Screenshot Observable Pipeline', () => {
},
],
"error": undefined,
"renderErrors": undefined,
"screenshots": Array [
Object {
"data": Object {
Expand Down Expand Up @@ -173,7 +172,6 @@ describe('Screenshot Observable Pipeline', () => {
},
],
"error": undefined,
"renderErrors": undefined,
"screenshots": Array [
Object {
"data": Object {
Expand Down Expand Up @@ -225,7 +223,6 @@ describe('Screenshot Observable Pipeline', () => {
},
],
"error": undefined,
"renderErrors": undefined,
"screenshots": Array [
Object {
"data": Object {
Expand Down Expand Up @@ -314,8 +311,7 @@ describe('Screenshot Observable Pipeline', () => {
},
},
],
"error": [Error: An error occurred when trying to read the page for visualization panel info. You may need to increase 'xpack.reporting.capture.timeouts.waitForElements'. Error: Mock error!],
"renderErrors": undefined,
"error": [Error: The "wait for elements" phase encountered an error: Error: An error occurred when trying to read the page for visualization panel info: Error: Mock error!],
"screenshots": Array [
Object {
"data": Object {
Expand Down Expand Up @@ -357,8 +353,7 @@ describe('Screenshot Observable Pipeline', () => {
},
},
],
"error": [Error: An error occurred when trying to read the page for visualization panel info. You may need to increase 'xpack.reporting.capture.timeouts.waitForElements'. Error: Mock error!],
"renderErrors": undefined,
"error": [Error: An error occurred when trying to read the page for visualization panel info: Error: Mock error!],
"screenshots": Array [
Object {
"data": Object {
Expand Down Expand Up @@ -465,7 +460,6 @@ describe('Screenshot Observable Pipeline', () => {
},
],
"error": undefined,
"renderErrors": undefined,
"screenshots": Array [
Object {
"data": Object {
Expand Down
Loading