Fix tests, add docs, apply nits, fix types #10

afharo · 2022-07-20T12:33:08Z

Summary

Here are my suggestions and fixes to the failing tests in the PR elastic#136395

Checklist

Use ~~strikethroughs~~ to remove checklist items you don't feel are applicable to this PR.

This was checked for cross-browser compatibility, including a check against IE11
Any text added follows EUI's writing guidelines, uses sentence case text and includes i18n support
Documentation was added for features that require explanation or tutorials
Unit or functional tests were updated or added to match the most common scenarios
This was checked for keyboard-only and screenreader accessibility

For maintainers

This was checked for breaking API changes and was labeled appropriately
This includes a feature addition or change that requires a release note and was labeled appropriately

afharo · 2022-07-20T12:33:54Z

packages/analytics/client/src/analytics_client/analytics_client.ts

@@ -43,7 +43,7 @@ import { ContextService } from './context_service';
 import { schemaToIoTs, validateSchema } from '../schema/validation';

 interface EventDebugLogMeta extends LogMeta {
-  ebt_event: Event;
+  ebt_event: Event<unknown>;


Fixed the issue with the properties being forced to extend Record<string, unknown>

afharo · 2022-07-20T12:35:19Z

packages/core/analytics/core-analytics-browser-internal/src/analytics_service.ts

+    // Register special `metrics` type
+    registerMetricEventType(this.analyticsClient);


The analytics service in core registers the metric type 😇

We can work on a follow up PR to move the reportMetricEvent API to an actual API exposed by the AnalyticServices in core. What do you think?

Don't think it's critical, we already have a package.
As you fish 🐟

afharo · 2022-07-20T12:36:07Z

packages/core/analytics/core-analytics-server-internal/src/analytics_service.test.ts

+import { analyticsClientMock } from './analytics_service.test.mocks';
+import { AnalyticsService } from './analytics_service';
+
+describe('AnalyticsService', () => {


Added missing tests to core... sorry for the additional noise

afharo · 2022-07-20T12:36:37Z

packages/kbn-ebt-tools/BUILD.bazel

@@ -24,16 +24,10 @@ NPM_MODULE_EXTRA_FILES = [
  "README.md"
 ]

-RUNTIME_DEPS = [


Cleaning up the actually needed libraries 😇

afharo · 2022-07-20T12:36:51Z

packages/kbn-ebt-tools/src/metric_events/helpers.test.ts

+import { registerMetricEventType, reportMetricEvent } from './helpers';
+import { METRIC_EVENT_SCHEMA } from './schema';
+
+describe('metric event helpers', () => {


added tests to the helpers

afharo · 2022-07-20T12:45:13Z

test/analytics/tests/instrumented_events/from_the_browser/core_context_providers.ts

    before(async () => {
      await common.navigateToApp('home');
-      [event] = await ebtUIHelper.getEvents(1, { eventTypes: [KIBANA_LOADED_EVENT] }); // Get the loaded Kibana event
+      [event] = await ebtUIHelper.getEvents(1, { eventTypes: ['Loaded Kibana'] }); // Get the loaded Kibana event


We were importing a different constant. But also, I'd rather validate the expected behaviour instead of relying on a variable that may change (hence breaking the contract).

afharo · 2022-07-20T12:45:51Z

test/analytics/tests/instrumented_events/from_the_browser/loaded_dashboard.ts

 import { FtrProviderContext } from '../../../services';

+const DASHBOARD_LOADED_EVENT = 'dashboard_loaded';


Importing it was causing type errors because we are not supposed to import from nested folders. But also, I'd rather validate the expected behaviour instead of relying on a variable that may change (hence breaking the contract).

afharo · 2022-07-20T12:46:14Z

test/analytics/tests/instrumented_events/from_the_browser/loaded_dashboard.ts

@@ -82,7 +88,7 @@ export default function ({ getService, getPageObjects }: FtrProviderContext) {
        await PageObjects.common.navigateToApp('dashboards');
      });

-      it('doesnt emit on empty dashboard', async () => {
+      it("doesn't emit on empty dashboard", async () => {


nits me 😇

afharo · 2022-07-20T12:46:45Z

test/analytics/tests/instrumented_events/from_the_browser/loaded_kibana.ts

+      if (browser.isChromium) {
+        // Kibana Loaded memory
+        expect(event.properties).to.have.property('jsHeapSizeLimit');
+        expect(event.properties.jsHeapSizeLimit).to.be.a('number');
+        expect(event.properties).to.have.property('totalJSHeapSize');
+        expect(event.properties.totalJSHeapSize).to.be.a('number');
+        expect(event.properties).to.have.property('usedJSHeapSize');
+        expect(event.properties.usedJSHeapSize).to.be.a('number');
+      }


I brought it back to confirm they actually show up.

afharo · 2022-07-20T12:47:20Z

test/analytics/tests/instrumented_events/from_the_server/kibana_started.ts

@@ -30,5 +29,25 @@ export default function ({ getService }: FtrProviderContext) {
      expect(uptimePerStep.start.start).to.be.a('number');
      expect(uptimePerStep.start.end).to.be.a('number');
    });
+
+    it('should emit the "kibana_started" metric event', async () => {


I split the tests in 2 😇

lizozom · 2022-07-20T13:05:01Z

test/analytics/fixtures/plugins/analytics_ftr_helpers/public/plugin.test.ts

+          eventTypes: [event.event_type],
+          filters: {
+            'properties.my_property': {
+              eq: 20,


lizozom

Overall the PR is fantastic.
I just wonder if the dashboard that shows kibana_started is critical? Or we could update it to use the new event?

lizozom · 2022-07-20T13:11:33Z

src/core/server/server.ts

+    // Report the metric-shaped KIBANA_STARTED_EVENT.
+    reportMetricEvent(analyticsStart, {
+      eventName: KIBANA_STARTED_EVENT,
+      duration: ups.start!.end - ups.constructor!.start,


We need to round all durations and convert to ms to match the field def.
Math.round((ups.start!.end - ups.constructor!.start) * 1000);

afharo · 2022-07-20T13:12:02Z

I just wonder if the dashboard that shows kibana_started is critical? Or we could update it to use the new event?

Can we plan the removal on a different PR?

Once it's on staging, we can test and compare both events and remove the old one. What do you think?

lizozom · 2022-07-20T13:22:27Z

No problem, I'll merge your PR and wrap it up!

* Updated EUI to version 67.1.2. Updated instaces of ButtonColor from EUI to EuiButtonColor. * Updated to EuiCard instances that utilize the betaBadgeProps object to return an empty string instead of undefined when the label is unavailable * Removed two instances of the deprecated internetExplorerOnly() mixin * Updated two instances of the ButtonColor import to EuiButtonColor as is was renamed in PR elastic#6150 * Updated snapshots in Jest Test Suite #1 to account for EuiButton and EuiCard Emotion conversions. Updated snapshots for EuiTooltip as it now contains the new EuiToolTipAnchor component that replaced the tooltip anchor styles * Updated snapshots in Jest Test Suite #2 to account forEuiButton, EuiDescriptionList, EuiButtonIcon, and EuiBadge Emotion conversions. * Updated snapshots in Jest Test Suite #3 to account for EuiDescriptionList, EuiButton, and EuiBadge Emotion conversions. Updated snapshots for EuiTooltip as if now contains the new EuiTooltipAnchor component that replaced the tooltop anchor styles * Updated snapshots in Jest Test Suite #4 to account for EuiButton Emotion conversion. * Updated snapshots in Jest Test Suite #5 to account for EuiButton Emotion conversion. * Updated snapshots in Jest Test Suite #8 to account for EuiButtonIcon and EuiButton Emotion conversions. Updated snapshots for EuiTooltip as it now contains the new EuiTooltipAnchor component that replaced the tooltip anchor styles. * Updated snapshots in Jest Test Suite #9 to account for EuiFlyout and EuiButton Emotion conversions. * Updated snapshots in Jest Test Suite #10 to account for EuiButton, EuiBadge, EuiButtonIcon, and EuiCard Emotion conversions. Updated snapshots for EuiToolTtip as it now contains the new EuiTooltipAnchor component that replaced the tooltip anchor styles * Updated instances of EuiButtonIconColor to use EuiButtonIconProps['color'] as it was removed in PR elastic#6150 * Updated tests that target EuiButton to simulate click events to target a generic button to prevent undefined click event errors * Updated snapshots in Jest Test Suite #1 to account for EuiButton and EuiCard Emotion conversions * Added the EuiFlyout mixins and variables to Lens Sass file as EuiFlyout has been converted to Emotion and the Sass styles are no longer available in EUI * Added the EuiCallOutTypes variable to Step Progress Sass file as EuiCallOut has been converted to Emotion and the Sass styles are no longer available in EUI * Updated snapshots in Jest Test Suite #2 to account for recent Emotion conversions. Updated snapshots in server_status.test.tsx to render EuiBadge before checking the snapshots to reduce the snapshot churn caused by Emotion. Updated tests that target EuiButton to simulate click events to target a generic button to prevent undefined click event errors * [CI] Auto-commit changed files from 'node scripts/precommit_hook.js --ref HEAD~1..HEAD --fix' * Added imports for the added flyout mixin. Removed references to EuiCallOut mixin as the component has been converted to Emotion and is no longer available for use. * Updated unit tests and snapshots in Jest Test Suite #10. Updated snaphshots to account for EuiBadge, EuiDescriptionList, EuiFlyout, and EuiCard Emotion conversions. Updated snapshots for EuiTooltip as it now contains the new EuiTooltipAnchor component that replaced the tooltip anchor styles. Updated tests that target EuiButton to simulate click events to target a generic button element to prevent undefined click event errors * Updated unit tests in Jest Test Suite #11 that target EuiButton to simulate click events to target a generic button to prevent undefined click event errors * Updated unit tests in Jest Test Suite #12 by updating tests that target EuiButton to simulate click events. Instead, these tests now target a generic button element to prevent undefined click event errors * Updated unit tests in Jest Test Suite #1 by updating tests that target EuiButton to simulate click events. Instead, these tests now target a generic button element to prevent undefined click event errors * Updated unit tests in Jest Test Suite #2 by updating tests that use EuiButton to simulate click events. Instead, these test have been updated to target a button element to prevent undefined click event errors. * [CI] Auto-commit changed files from 'node scripts/eslint --no-cache --fix' * Updated reference to mixins Sass file. Updated snapshots for Jest Test Suite #5 to account for EuiButton Emotion conversion. Updated unit tests that target EuiButton to simulate click events. These tests have been updated to target a button element to prevent undefined click event errors * Updated unit tests in Jest Test Suites 3, 7, 8, 13, and 14. Updated snapshot to account for EuiButton Emotion conversion. Updated tests that target EuiButton to simulate click events. These tests now target a generic button element to prevent undefined click event errors. Updated a few snapshots by adding .render() before checking the snapshot. This will prevent large snapshots coming from recent Emotion conversions * Updated snapshots in Jest Test Suite #10 to account for the recent EuiButton Emotion conversion * Updated unit tests in Jest Test Suite #2 by editing tests that target EuiButton to simulate click events. These tests now target a button element in order to prevent undefinde click event errors * Updated snapshots in Jest Test Suite #10 to account for EuiButton and EuiDescriptionList Emotion conversions * Updated test cases in Jest Test Suites 3, 7, and 8. Updated snapshots to account for EuiButton and EuiPagination Emotion conversions. Updated tests that target EuiButton to simulate click events. These tests now target a button element to prevent undefined click errors * Updated test cases in Jest Test Suite 14. Updated snapshots to account for EuiButton Emotion conversion. Opted to use .render() when updating a few snapshots to reduce the large length of snapshots caused by Emotion * [CI] Auto-commit changed files from 'node scripts/eslint --no-cache --fix' * Revised a change to betaBadgeProps to ensure that the label is available. If not, the value for the badge with be set to undefined. * Resolved two linting errors * Resolved two linting errors * Updated Jest unit tests in various suites. Updated snapshots to account for EuiButton Emotion conversion. Updated snapshots for EuiTooltip as it now contains the new EuiTooltipAnchor component that replaced the tooltip anchor styles. * Updated EuiFlyout in query_flyout.tsx to remove the onClick function from maskProps as it is no longer available. Updated this flyout to use ownFocus and not to close when the overlay mask is clicked. * Removed the use of EuiButtonIconColor in favor of EuiButtonIconProps['color'] * [CI] Auto-commit changed files from 'node scripts/eslint --no-cache --fix' * Updated Cypress test looking for strict equality on EuiPaginationButton class names to match a substring of the Emotion generated class name * Removed unneeded debugging code. Updated snapshots for various test suites to account for the recent EuiButton Emotion conversion * Updated a few EuiButton, EuiButtonEmpty, and EuiText components that set the color as ghost. The ghost color mode has been deprecated as of PR elastic#6150. These components now are wrapped in EuiThemeProvider with a dark colorMode to create the previous ghost color. * Resolved TS error with EuiCard betaBadgeProps * [CI] Auto-commit changed files from 'node scripts/eslint --no-cache --fix' * Remove references to now-removed EuiFlyout CSS classes/vars * Remove now-removed euiBadge className references - Convert directly to EuiBadge instead of using CSS - Remove confusing and now-possibly-irrelevant CSS badge overrides - left/right icons are now set via JSX and not via flex-direction * Pre-emptively fix various euiOverlayMask CSS overrides - this data attr isn't technically in yet but will be once elastic/eui#6289 merges - at the very least this isn't breaking any more than it currently already is! * Update to v67.1.3 * v67.1.4 * Resolved test failing test case in Security/Manage/Blocklist. The test did not remove focus from the last combo box in the form, which didn't allow the disbaled attribute to be removed from the flyout submit button. I've updated the mock file for Blocklist to return focus to the first form element in the flyout to allow the disabled attribute to be removed. * Updated snapshots to account for the recent EuiText Emotion conversion * Fix Log's custom tooltips relying on EuiTooltip classNames that no longer exist * Fix Vega vis custom tooltips relying on EuiTooltip classNames that no longer exist - this one is trickier than Log's as it's not using React, so we need to use Emotion's Global to set a static className * Convert remaining vega_vis.scss to Emotion - as an example of how other global + non global styles could be handled in the future * Fix references to removed `euiPaginationButton-isActive` className - use aria-current attribute instead * Added missing EuiFlyoutAnimation keyframes for EuiFlyout. This resolved test that failed because they used onAnimationEnd because the FlyoutAnimation could not be found. * Reolved Jest Tests in suites 1 and 5. Updated snapshots to account for the recent EuiButton Emotion conversion. Updated snapshots for EuiToolTip as it now contains the new EuiToolTipAnchor component that replaced the tooltip anchor styles. * iterate on rules_list.test.tsx * bump eui to v67.1.5 * Updatde snapshots for jest test suites to account for the recent EuiButton, EuiOverlayMask, EuiTooltip, and EuiBadge Emotion conversions * Resolved failing security test by updating the target element for CONNECTOR_TITLE. EuiCard has recently been converted to Emotion and the card title is no longer wrapper in a span. * Resolved failing test case in Runtime Fields. The modify runtime field test was failing because the combobox responsbible for adding and updating scripts was not appearing. The textbox did not appear because the shared setFieldScript function targets and toggles the script textbox when opening the flyout. When a runtime field is being modified, the toggle is already active and using the shared function will trigger the toggle again (losing access to the script textbox). Also resolved an issue that prevented the warning EuiCallout to appear when changing the type of a runtime field from its original type. Resolved this by adding an enter keypress at the end of setFieldType function to confirm the type selection, thus triggering the EuiCallout * Resolved two tests that were failing in Lens. These test were failing because they were checking for equality in class names that no longer exist within EuiButtonGroup as it was recently converted to Emotion. These tests were updated to check for a substring of the new and longer class name * Quick fix in test case failing because of misspelling in data-test-sub * Updated snapshot for Jest test case as EuiButton as recently been converted to Emotion * Removed console.log statement. Oops! * Resolved a failing test case in Lens. They were failing because they were checking for equality in class names that no longer exist within EuiButtonGroup as it was recently converted to Emotion. These tests were updated to check for a substring of the new and longer class name. Updated a Security test case by giving a target button the data-test-subj attribute for easier querying * Removed reference to EuiFlyout mixin as it has been converted to Emotion. Updated the reference to an interal copy of EuiFlyout styles * Corrected spelling error in EuiFlyout animation in Lens app * Update EUI with latest backport * Update button snapshots * fix another button snapshot * More snapshot fixes * [EuiButton][Security] Fix button relying on now-removed `euiButton__text` CSS - replace removed CSS with `eui-textTruncate` util instead - combine/DRY out unnecessary span - was affecting min-width of truncation util + increase screenshot diff limit - this was smaller than updating the actual baseline screenshots for whatever reason (likely render diff between local and CI) * Fix remaining Jest tests affected by Emotion conversions - because Emotion creates its own wrapper, `.first()` can no longer be used - prefer `.last()` instead * Fix Jest test affected by EuiButton Emotion conversion + removed modifier class - targeting the native DOM node + filtering by disabled true/false gets us back to the 'correct' lengths * Fix + improve flyout test - `.last()` changes to account for EuiButton Emotion conversion is needed, but the last onClose assertion still fails due to us having modified inputs, and the confirm modal being displayed - split test into two separate tests - one testing the onClose call, and the other testing the confirm modal * derpin * Skip rules_list Jest suite * Update new EuiButton snapshot * Upgraded EUI version to 67.1.7 * [EuiCard] Update snapshots * [EuiPopover] Update snapshots * [QA] Fix missing Vega warn/error message colors ;_; * [CI] Auto-commit changed files from 'node scripts/generate codeowners' * Fix Lens kbnToolbarButton regressions - Caused by flattening of EUI button CSS specificity - background-color was previously relying on isDisabled CSS specificity to override its #fff color - `text` color modifier & `!important` is no longer needed and overrides Emotion CSS flatly - isDisabled class is no longer needed - euiButton no longer sets `pointer-events: none` on disabled buttons (fixes tooltip bug in webkit as well) * Backport EUI 67.1.8 fixes * Update EuiCard snapshots * Fix EuiModal form wrapper causing overflow issues - see https://elastic.github.io/eui/#/layout/modal#forms-in-a-modal * Workaround for `.kbnOverlayMountWrapper` mount point causing overflow issues - not sure what all is using this modal service to be honest, but the wrapper is causing issues with the modal layout, this fixes overflow issues but will not fix any mask-image issues as a result * more snapshot updates * EuiButton - added textProps to EuiButton to prevent very long button names from spilling over outside of the container * EuiButton - Update EuiButton related snapshots. Updated tests that target EuiButton directly to use a data-telementary-id for more specific element querying required by Emotion * QA - Removed unnecessary comment in code * Temporary fix for EuiCard[selectable][layout=horizontal] instances on security solutions' rule page * Temporary fix for EuiCard[selectable][layout=horizontal] instances on osquery live query and canvas's datasource selector * [CI] Auto-commit changed files from 'node scripts/precommit_hook.js --ref HEAD~1..HEAD --fix' * Fix CSS specificity, where canvas's solutionToolbarButton's background-color now takes precedence over EuiButton's primary styles * Removed update to search_marker_tooltip that removed the euiTooltip styles and replaced then with Emotion styling. Added EuiTooltip Sass styles for the component to rely on to test for a styling bug that is causing the tooltip and the tooltip arrow to be out of sync with each other. * Lint Sass file * Lint Sass file * Removed overflow:hidden style from .vgaVis_view as it was causing euiScrollStyles not to present the scroll bars in Vega Vis * Remove typo from EuiButton textProps object. 'className' should not have been included in the actual class name * Revert tooltip Sass This reverts commit 20e6ead, a5cd2de, and c605cbd * Fix Emotion tooltip arrows Co-authored-by: kibanamachine <42973632+kibanamachine@users.noreply.github.com> Co-authored-by: Constance Chen <constance.chen@elastic.co> Co-authored-by: Chandler Prall <chandler.prall@elastic.co>

Fix tests, add docs, apply nits, fix types

a5d57d3

afharo commented Jul 20, 2022

View reviewed changes

lizozom reviewed Jul 20, 2022

View reviewed changes

lizozom merged commit 7728ba7 into lizozom:normalize-ebt-events Jul 20, 2022

afharo deleted the afharo/normalize-ebt-events branch July 20, 2022 13:27

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fix tests, add docs, apply nits, fix types #10

Fix tests, add docs, apply nits, fix types #10

afharo commented Jul 20, 2022 •

edited

Loading

afharo Jul 20, 2022

afharo Jul 20, 2022

lizozom Jul 20, 2022

afharo Jul 20, 2022

afharo Jul 20, 2022

afharo Jul 20, 2022

afharo Jul 20, 2022

afharo Jul 20, 2022

afharo Jul 20, 2022

afharo Jul 20, 2022

afharo Jul 20, 2022

lizozom Jul 20, 2022

lizozom left a comment

lizozom Jul 20, 2022

afharo commented Jul 20, 2022

lizozom commented Jul 20, 2022

		// Register special `metrics` type
		registerMetricEventType(this.analyticsClient);

		import { FtrProviderContext } from '../../../services';

		const DASHBOARD_LOADED_EVENT = 'dashboard_loaded';

Fix tests, add docs, apply nits, fix types #10

Fix tests, add docs, apply nits, fix types #10

Conversation

afharo commented Jul 20, 2022 • edited Loading

Summary

Checklist

For maintainers

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

lizozom left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

afharo commented Jul 20, 2022

lizozom commented Jul 20, 2022

afharo commented Jul 20, 2022 •

edited

Loading