browser.ts

/*
 * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
 * or more contributor license agreements. Licensed under the Elastic License
 * 2.0; you may not use this file except in compliance with the Elastic License
 * 2.0.
 */

import type { FtrProviderContext } from '../ftr_provider_context';
import { assertLogContains, isExecutionContextLog } from '../test_utils';

export default function ({ getService, getPageObjects }: FtrProviderContext) {
  const PageObjects = getPageObjects(['common', 'dashboard', 'header', 'home']);
  const retry = getService('retry');

  // FLAKY: https://github.com/elastic/kibana/issues/125743
  describe.skip('Browser apps', () => {
    before(async () => {
      await PageObjects.common.navigateToUrl('home', '/tutorial_directory/sampleData', {
        useActualUrl: true,
      });
      await PageObjects.home.addSampleDataSet('flights');
      await PageObjects.header.waitUntilLoadingHasFinished();
    });

    after(async () => {
      await PageObjects.common.navigateToUrl('home', '/tutorial_directory/sampleData', {
        useActualUrl: true,
      });
      await PageObjects.header.waitUntilLoadingHasFinished();
      await PageObjects.home.removeSampleDataSet('flights');
    });

    describe('discover app', () => {
      before(async () => {
        await PageObjects.common.navigateToApp('discover');
        await PageObjects.header.waitUntilLoadingHasFinished();
      });

      it('propagates context for Discover', async () => {
        await assertLogContains({
          description: 'execution context propagates to Elasticsearch via "x-opaque-id" header',
          predicate: (record) =>
            Boolean(record.http?.request?.id?.includes('kibana:application:discover')),
          retry,
        });

        await assertLogContains({
          description: 'execution context propagates to Kibana logs',
          predicate: (record) =>
            isExecutionContextLog(record?.message, {
              description: 'fetch documents',
              id: '',
              name: 'discover',
              type: 'application',
              // discovery doesn't have an URL since one of from the example dataset is not saved separately
              url: '/app/discover',
            }),
          retry,
        });

        await assertLogContains({
          description: 'execution context propagates to Kibana logs',
          predicate: (record) =>
            isExecutionContextLog(record?.message, {
              description: 'fetch chart data and total hits',
              id: '',
              name: 'discover',
              type: 'application',
              url: '/app/discover',
            }),
          retry,
        });
      });
    });

    describe('dashboard app', () => {
      before(async () => {
        await PageObjects.common.navigateToApp('dashboard');
        await PageObjects.dashboard.loadSavedDashboard('[Flights] Global Flight Dashboard');
        await PageObjects.dashboard.waitForRenderComplete();
        await PageObjects.header.waitUntilLoadingHasFinished();
      });

      describe('propagates context for Lens visualizations', () => {
        it('lnsXY', async () => {
          await assertLogContains({
            description: 'execution context propagates to Elasticsearch via "x-opaque-id" header',
            predicate: (record) =>
              Boolean(
                record.http?.request?.id?.includes(
                  'kibana:application:dashboard:7adfa750-4c81-11e8-b3d7-01146121b73d;lens:lnsXY:086ac2e9-dd16-4b45-92b8-1e43ff7e3f65'
                )
              ),
            retry,
          });

          await assertLogContains({
            description: 'execution context propagates to Kibana logs',
            predicate: (record) =>
              isExecutionContextLog(record?.message, {
                type: 'application',
                name: 'dashboard',
                id: '7adfa750-4c81-11e8-b3d7-01146121b73d',
                description: '[Flights] Global Flight Dashboard',
                url: '/view/7adfa750-4c81-11e8-b3d7-01146121b73d',
                child: {
                  type: 'lens',
                  name: 'lnsXY',
                  id: '086ac2e9-dd16-4b45-92b8-1e43ff7e3f65',
                  description: '[Flights] Flight count',
                  url: '/app/lens#/edit_by_value',
                },
              }),
            retry,
          });
        });

        it('lnsMetric', async () => {
          await assertLogContains({
            description: 'execution context propagates to Elasticsearch via "x-opaque-id" header',
            predicate: (record) =>
              Boolean(
                record.http?.request?.id?.includes(
                  'kibana:application:dashboard:7adfa750-4c81-11e8-b3d7-01146121b73d;lens:lnsMetric:b766e3b8-4544-46ed-99e6-9ecc4847e2a2'
                )
              ),
            retry,
          });

          await assertLogContains({
            description: 'execution context propagates to Kibana logs',
            predicate: (record) =>
              isExecutionContextLog(record?.message, {
                type: 'application',
                name: 'dashboard',
                id: '7adfa750-4c81-11e8-b3d7-01146121b73d',
                description: '[Flights] Global Flight Dashboard',
                url: '/view/7adfa750-4c81-11e8-b3d7-01146121b73d',
                child: {
                  type: 'lens',
                  name: 'lnsMetric',
                  id: '2e33ade5-96e5-40b4-b460-493e5d4fa834',
                  description: '',
                  url: '/app/lens#/edit_by_value',
                },
              }),
            retry,
          });
        });

        it('lnsDatatable', async () => {
          await assertLogContains({
            description: 'execution context propagates to Elasticsearch via "x-opaque-id" header',
            predicate: (record) =>
              Boolean(
                record.http?.request?.id?.includes(
                  'kibana:application:dashboard:7adfa750-4c81-11e8-b3d7-01146121b73d;lens:lnsDatatable:fb86b32f-fb7a-45cf-9511-f366fef51bbd'
                )
              ),
            retry,
          });

          await assertLogContains({
            description: 'execution context propagates to Kibana logs',
            predicate: (record) =>
              isExecutionContextLog(record?.message, {
                type: 'application',
                name: 'dashboard',
                id: '7adfa750-4c81-11e8-b3d7-01146121b73d',
                description: '[Flights] Global Flight Dashboard',
                url: '/view/7adfa750-4c81-11e8-b3d7-01146121b73d',
                child: {
                  type: 'lens',
                  name: 'lnsDatatable',
                  id: 'fb86b32f-fb7a-45cf-9511-f366fef51bbd',
                  description: 'Cities by delay, cancellation',
                  url: '/app/lens#/edit_by_value',
                },
              }),
            retry,
          });
        });

        it('lnsPie', async () => {
          await assertLogContains({
            description: 'execution context propagates to Elasticsearch via "x-opaque-id" header',
            predicate: (record) =>
              Boolean(
                record.http?.request?.id?.includes(
                  'kibana:application:dashboard:7adfa750-4c81-11e8-b3d7-01146121b73d;lens:lnsPie:5d53db36-2d5a-4adc-af7b-cec4c1a294e0'
                )
              ),
            retry,
          });
          await assertLogContains({
            description: 'execution context propagates to Kibana logs',
            predicate: (record) =>
              isExecutionContextLog(record?.message, {
                type: 'application',
                name: 'dashboard',
                id: '7adfa750-4c81-11e8-b3d7-01146121b73d',
                description: '[Flights] Global Flight Dashboard',
                url: '/view/7adfa750-4c81-11e8-b3d7-01146121b73d',
                child: {
                  type: 'lens',
                  name: 'lnsPie',
                  id: '5d53db36-2d5a-4adc-af7b-cec4c1a294e0',
                  description: '[Flights] Delay Type',
                  url: '/app/lens#/edit_by_value',
                },
              }),
            retry,
          });
        });
      });

      it('propagates context for built-in Discover', async () => {
        await assertLogContains({
          description: 'execution context propagates to Elasticsearch via "x-opaque-id" header',
          predicate: (record) =>
            Boolean(
              record.http?.request?.id?.includes(
                'application:dashboard:7adfa750-4c81-11e8-b3d7-01146121b73d;search:discover:571aaf70-4c88-11e8-b3d7-01146121b73d'
              )
            ),
          retry,
        });
        await assertLogContains({
          description: 'execution context propagates to Kibana logs',
          predicate: (record) =>
            isExecutionContextLog(record?.message, {
              type: 'application',
              name: 'dashboard',
              id: '7adfa750-4c81-11e8-b3d7-01146121b73d',
              description: '[Flights] Global Flight Dashboard',
              url: '/view/7adfa750-4c81-11e8-b3d7-01146121b73d',
              child: {
                type: 'search',
                name: 'discover',
                id: '571aaf70-4c88-11e8-b3d7-01146121b73d',
                description: '[Flights] Flight Log',
                url: '/app/discover#/view/571aaf70-4c88-11e8-b3d7-01146121b73d',
              },
            }),
          retry,
        });
      });

      it('propagates context for TSVB visualizations', async () => {
        await assertLogContains({
          description: 'execution context propagates to Elasticsearch via "x-opaque-id" header',
          predicate: (record) =>
            Boolean(
              record.http?.request?.id?.includes(
                'kibana:application:dashboard:7adfa750-4c81-11e8-b3d7-01146121b73d;visualization:metrics:bcb63b50-4c89-11e8-b3d7-01146121b73d'
              )
            ),
          retry,
        });

        await assertLogContains({
          description: 'execution context propagates to Kibana logs',
          predicate: (record) =>
            isExecutionContextLog(record?.message, {
              type: 'application',
              name: 'dashboard',
              id: '7adfa750-4c81-11e8-b3d7-01146121b73d',
              description: '[Flights] Global Flight Dashboard',
              url: '/view/7adfa750-4c81-11e8-b3d7-01146121b73d',
              child: {
                type: 'visualization',
                name: 'metrics',
                id: 'bcb63b50-4c89-11e8-b3d7-01146121b73d',
                description: '[Flights] Delays & Cancellations',
                url: '/app/visualize#/edit/bcb63b50-4c89-11e8-b3d7-01146121b73d',
              },
            }),
          retry,
        });
      });

      // application:dashboard:7adfa750-4c81-11e8-b3d7-01146121b73d;visualization:vega:ed78a660-53a0-11e8-acbd-0be0ad9d822b
      it('propagates context for Vega visualizations', async () => {
        await assertLogContains({
          description: 'execution context propagates to Elasticsearch via "x-opaque-id" header',
          predicate: (record) =>
            Boolean(
              record.http?.request?.id?.includes(
                'kibana:application:dashboard:7adfa750-4c81-11e8-b3d7-01146121b73d;visualization:vega:ed78a660-53a0-11e8-acbd-0be0ad9d822b'
              )
            ),
          retry,
        });

        await assertLogContains({
          description: 'execution context propagates to Kibana logs',
          predicate: (record) =>
            isExecutionContextLog(record?.message, {
              type: 'application',
              name: 'dashboard',
              id: '7adfa750-4c81-11e8-b3d7-01146121b73d',
              description: '[Flights] Global Flight Dashboard',
              url: '/view/7adfa750-4c81-11e8-b3d7-01146121b73d',
              child: {
                type: 'visualization',
                name: 'vega',
                id: 'ed78a660-53a0-11e8-acbd-0be0ad9d822b',
                description: '[Flights] Airport Connections (Hover Over Airport)',
                url: '/app/visualize#/edit/ed78a660-53a0-11e8-acbd-0be0ad9d822b',
              },
            }),
          retry,
        });
      });

      it('propagates context for Tag Cloud visualization', async () => {
        await assertLogContains({
          description: 'execution context propagates to Elasticsearch via "x-opaque-id" header',
          predicate: (record) =>
            Boolean(
              record.http?.request?.id?.includes(
                'kibana:application:dashboard:7adfa750-4c81-11e8-b3d7-01146121b73d;visualization:tagcloud:293b5a30-4c8f-11e8-b3d7-01146121b73d'
              )
            ),
          retry,
        });

        await assertLogContains({
          description: 'execution context propagates to Kibana logs',
          predicate: (record) =>
            isExecutionContextLog(record?.message, {
              type: 'application',
              name: 'dashboard',
              id: '7adfa750-4c81-11e8-b3d7-01146121b73d',
              description: '[Flights] Global Flight Dashboard',
              url: '/view/7adfa750-4c81-11e8-b3d7-01146121b73d',
              child: {
                type: 'visualization',
                name: 'tagcloud',
                id: '293b5a30-4c8f-11e8-b3d7-01146121b73d',
                description: '[Flights] Destination Weather',
                url: '/app/visualize#/edit/293b5a30-4c8f-11e8-b3d7-01146121b73d',
              },
            }),
          retry,
        });
      });

      it('propagates context for Vertical bar visualization', async () => {
        await assertLogContains({
          description: 'execution context propagates to Elasticsearch via "x-opaque-id" header',
          predicate: (record) =>
            Boolean(
              record.http?.request?.id?.includes(
                'kibana:application:dashboard:7adfa750-4c81-11e8-b3d7-01146121b73d;visualization:histogram:9886b410-4c8b-11e8-b3d7-01146121b73d'
              )
            ),
          retry,
        });

        await assertLogContains({
          description: 'execution context propagates to Kibana logs',
          predicate: (record) =>
            isExecutionContextLog(record?.message, {
              type: 'application',
              name: 'dashboard',
              id: '7adfa750-4c81-11e8-b3d7-01146121b73d',
              description: '[Flights] Global Flight Dashboard',
              url: '/view/7adfa750-4c81-11e8-b3d7-01146121b73d',
              child: {
                type: 'visualization',
                name: 'histogram',
                id: '9886b410-4c8b-11e8-b3d7-01146121b73d',
                description: '[Flights] Delay Buckets',
                url: '/app/visualize#/edit/9886b410-4c8b-11e8-b3d7-01146121b73d',
              },
            }),
          retry,
        });
      });
    });
  });
}