Refactor add_integration_flyout to break out nested methods by Swiddis · Pull Request #956 · opensearch-project/dashboards-observability

Swiddis · 2023-08-24T17:42:49Z

Description

The flyout is a bit of a hotspot for tricky logic and bugs, and we had a very large untested method sitting around in it. This PR mostly works to get some of the logic in that method under test, by breaking out the dependencies that aren't too intertwined with the rest. Part of the continuing campaign to clean up some code between releases. A lot of code here is still a bit complicated, but this can at least help stop the bleeding.

Issues Resolved

N/A

Check List

New functionality includes testing.
- All tests pass, including unit test, integration test and doctest
New functionality has been documented.
- New functionality has javadoc added
- New functionality has user manual doc added
Commits are signed per the DCO using --signoff

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.
For more information on following Developer Certificate of Origin and signing off your commits, please check here.

Signed-off-by: Simeon Widdis <sawiddis@amazon.com>

codecov · 2023-08-24T18:07:57Z

Codecov Report

Merging #956 (7131267) into main (941eb60) will increase coverage by 0.24%.
Report is 1 commits behind head on main.
The diff coverage is n/a.

@@            Coverage Diff             @@
##             main     #956      +/-   ##
==========================================
+ Coverage   43.71%   43.95%   +0.24%     
==========================================
  Files         313      313              
  Lines       18714    18721       +7     
  Branches     4562     4568       +6     
==========================================
+ Hits         8180     8228      +48     
+ Misses      10492    10451      -41     
  Partials       42       42

Flag	Coverage Δ
dashboards-observability	`43.95% <ø> (+0.24%)`	⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

see 2 files with indirect coverage changes

📢 Have feedback on the report? Share it here.

public/components/integrations/components/add_integration_flyout.tsx

Signed-off-by: Simeon Widdis <sawiddis@amazon.com>

…ch-project#956)

* Update mocha (#960) * added code for the change of design of the sidebar, fixed overriding … (#928) * Refactor add_integration_flyout to break out nested methods (#956) * [Log Explorer] Remove top level tabs (#970) * Explorer's timeheader & color change (#959) * Update caching (#965) * Move query_utils to /public (#983) * Remove Zeppelin Parser from Notebook (#985) * Explorer empty bucket (#990) * refactored classnames for sidebar (#933) * Refactor Integrations Backend to abstract IO (#947) * Create React component for Integrations Setup UI (#1009) * Create Data sources plugin with Manage Datasources Flow (#1035) * Manage datasources (#967) * Add acceleration management UI (#989) * Rename data sources to data connections (#1004) * Add fallback to show if user does not have datasource API permissions (#1008) * Add access control tab content (#992) * Delete datasource and Connection Configuration Tab (#1024) * adjust explorer chart color and spacing (#1051) * Configure S3 datasource flow (#1049) * Manage datasources (#967) * Add acceleration management UI (#989) * Rename data sources to data connections (#1004) * Add fallback to show if user does not have datasource API permissions (#1008) * Add access control tab content (#992) * Delete datasource and Connection Configuration Tab (#1024) * modified explorer data grid to follow discover look and feel (#1041) * Create prometheus datasource flow (#1054) * Manage datasources (#967) * Add acceleration management UI (#989) * Rename data sources to data connections (#1004) * Add fallback to show if user does not have datasource API permissions (#1008) * Add access control tab content (#992) * Delete datasource and Connection Configuration Tab (#1024) * added design changes for sidebar (#1061) * updated snapshots (#1062) * Update UI for integrations setup (#1052) * Data sources UI improvements (#1059) * adding redirection to datasources (#1063) * Move convertDateTime, refactor query_utils (#1064) * Setup S3 connection with integrations (#1057) * Use approved svg from UX (#1066) * Fix missing import 'moment' on query_utils. (#1067) --------- Signed-off-by: Derek Ho <dxho@amazon.com> Signed-off-by: sumukhswamy <sumukhhs@amazon.com> Signed-off-by: Eric Wei <menwe@amazon.com> Signed-off-by: Paul Sebastian <paulstn@amazon.com> Signed-off-by: Peter Fitzgibbons <peter.fitzgibbons@gmail.com> Signed-off-by: Shenoy Pratik <sgguruda@amazon.com> Signed-off-by: Simeon Widdis <sawiddis@gmail.com> Co-authored-by: sumukhswamy <sumukhhs@amazon.com> Co-authored-by: Eric Wei <menwe@amazon.com> Co-authored-by: Paul Sebastian <paul_sebastian@live.com> Co-authored-by: Peter Fitzgibbons <peter.fitzgibbons@gmail.com> Co-authored-by: Paul Sebastian <paulstn@amazon.com> Co-authored-by: Shenoy Pratik <sgguruda@amazon.com> Co-authored-by: Simeon Widdis <sawiddis@amazon.com>

* Update mocha (opensearch-project#960) * added code for the change of design of the sidebar, fixed overriding … (opensearch-project#928) * Refactor add_integration_flyout to break out nested methods (opensearch-project#956) * [Log Explorer] Remove top level tabs (opensearch-project#970) * Explorer's timeheader & color change (opensearch-project#959) * Update caching (opensearch-project#965) * Move query_utils to /public (opensearch-project#983) * Remove Zeppelin Parser from Notebook (opensearch-project#985) * Explorer empty bucket (opensearch-project#990) * refactored classnames for sidebar (opensearch-project#933) * Refactor Integrations Backend to abstract IO (opensearch-project#947) * Create React component for Integrations Setup UI (opensearch-project#1009) * Create Data sources plugin with Manage Datasources Flow (opensearch-project#1035) * Manage datasources (opensearch-project#967) * Add acceleration management UI (opensearch-project#989) * Rename data sources to data connections (opensearch-project#1004) * Add fallback to show if user does not have datasource API permissions (opensearch-project#1008) * Add access control tab content (opensearch-project#992) * Delete datasource and Connection Configuration Tab (opensearch-project#1024) * adjust explorer chart color and spacing (opensearch-project#1051) * Configure S3 datasource flow (opensearch-project#1049) * Manage datasources (opensearch-project#967) * Add acceleration management UI (opensearch-project#989) * Rename data sources to data connections (opensearch-project#1004) * Add fallback to show if user does not have datasource API permissions (opensearch-project#1008) * Add access control tab content (opensearch-project#992) * Delete datasource and Connection Configuration Tab (opensearch-project#1024) * modified explorer data grid to follow discover look and feel (opensearch-project#1041) * Create prometheus datasource flow (opensearch-project#1054) * Manage datasources (opensearch-project#967) * Add acceleration management UI (opensearch-project#989) * Rename data sources to data connections (opensearch-project#1004) * Add fallback to show if user does not have datasource API permissions (opensearch-project#1008) * Add access control tab content (opensearch-project#992) * Delete datasource and Connection Configuration Tab (opensearch-project#1024) * added design changes for sidebar (opensearch-project#1061) * updated snapshots (opensearch-project#1062) * Update UI for integrations setup (opensearch-project#1052) * Data sources UI improvements (opensearch-project#1059) * adding redirection to datasources (opensearch-project#1063) * Move convertDateTime, refactor query_utils (opensearch-project#1064) * Setup S3 connection with integrations (opensearch-project#1057) * Use approved svg from UX (opensearch-project#1066) * Fix missing import 'moment' on query_utils. (opensearch-project#1067) --------- Signed-off-by: Derek Ho <dxho@amazon.com> Signed-off-by: sumukhswamy <sumukhhs@amazon.com> Signed-off-by: Eric Wei <menwe@amazon.com> Signed-off-by: Paul Sebastian <paulstn@amazon.com> Signed-off-by: Peter Fitzgibbons <peter.fitzgibbons@gmail.com> Signed-off-by: Shenoy Pratik <sgguruda@amazon.com> Signed-off-by: Simeon Widdis <sawiddis@gmail.com> Co-authored-by: sumukhswamy <sumukhhs@amazon.com> Co-authored-by: Eric Wei <menwe@amazon.com> Co-authored-by: Paul Sebastian <paul_sebastian@live.com> Co-authored-by: Peter Fitzgibbons <peter.fitzgibbons@gmail.com> Co-authored-by: Paul Sebastian <paulstn@amazon.com> Co-authored-by: Shenoy Pratik <sgguruda@amazon.com> Co-authored-by: Simeon Widdis <sawiddis@amazon.com> (cherry picked from commit 171acde)

Swiddis added 2 commits August 23, 2023 17:08

Break flyout validation methods out of constructing method

feeaef5

Signed-off-by: Simeon Widdis <sawiddis@amazon.com>

Add tests for extracted flyout methods

b644d11

Signed-off-by: Simeon Widdis <sawiddis@amazon.com>

Swiddis added integrations Used to denote items related to the Integrations project maintenance labels Aug 24, 2023

Swiddis requested review from YANG-DB, anirudha, dai-chen, derek-ho, joshuali925, kavithacm, mengweieric, penghuo, pjfitzgibbons, ps48, rupal-bq, seankao-az and vamsimanohar as code owners August 24, 2023 17:42

Switch validation method to use ValidationResult

614613a

Signed-off-by: Simeon Widdis <sawiddis@amazon.com>

ps48 approved these changes Sep 6, 2023

View reviewed changes

Merge branch 'main' into refactor-integ-frontend

d147697

mengweieric approved these changes Sep 7, 2023

View reviewed changes

public/components/integrations/components/add_integration_flyout.tsx Outdated Show resolved Hide resolved

Refactor regex match to test to reduce casting

7131267

Signed-off-by: Simeon Widdis <sawiddis@amazon.com>

Swiddis merged commit 2544618 into opensearch-project:main Sep 7, 2023

Swiddis deleted the refactor-integ-frontend branch September 7, 2023 21:50

pjfitzgibbons pushed a commit that referenced this pull request Sep 8, 2023

Refactor add_integration_flyout to break out nested methods (#956)

05be357

paulstn pushed a commit to paulstn/dashboards-observability that referenced this pull request Sep 8, 2023

Refactor add_integration_flyout to break out nested methods (opensear…

97e0da2

…ch-project#956)

pjfitzgibbons pushed a commit that referenced this pull request Sep 26, 2023

Refactor add_integration_flyout to break out nested methods (#956)

a901f6d

derek-ho pushed a commit to derek-ho/dashboards-observability that referenced this pull request Oct 4, 2023

Refactor add_integration_flyout to break out nested methods (opensear…

241159b

…ch-project#956)

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Refactor add_integration_flyout to break out nested methods#956

Refactor add_integration_flyout to break out nested methods#956
Swiddis merged 5 commits intoopensearch-project:mainfrom
Swiddis:refactor-integ-frontend

Swiddis commented Aug 24, 2023

Uh oh!

codecov bot commented Aug 24, 2023 •

edited

Loading

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Conversation

Swiddis commented Aug 24, 2023

Description

Issues Resolved

Check List

Uh oh!

codecov bot commented Aug 24, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

codecov bot commented Aug 24, 2023 •

edited

Loading