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.

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

Make Tabs eager loading configurable but default to false #7199

Merged
merged 10 commits into from
Jan 29, 2024

Conversation

davetsay
Copy link
Contributor

@davetsay davetsay commented Nov 3, 2023

Closes #7198

Describe your changes:

  • make tabs eager load configurable
  • default is eager load false changed from eager load true
  • change dropdown to toggle

All Submissions:

  • Have you followed the guidelines in our Contributing document?
  • Have you checked to ensure there aren't other open Pull Requests for the same update/change?
  • Is this change backwards compatible? For example, developers won't need to change how they are calling the API or how they've extended core plugins such as Tables or Plots.

Author Checklist

  • Changes address original issue?
  • Tests included and/or updated with changes?
  • Has this been smoke tested?
  • Have you associated this PR with a type: label? Note: this is not necessarily the same as the original issue.
  • Have you associated a milestone with this PR? Note: leave blank if unsure.
  • Is this a breaking change to be called out in the release notes?
  • Testing instructions included in associated issue OR is this a dependency/testcase change?

Reviewer Checklist

  • Changes appear to address issue?
  • Reviewer has tested changes by following the provided instructions?
  • Changes appear not to be breaking changes?
  • Appropriate automated tests included?
  • Code style and in-line documentation are appropriate?

@davetsay davetsay marked this pull request as draft November 3, 2023 01:55
Copy link

deploysentinel bot commented Nov 3, 2023

Current Playwright Test Results Summary

✅ 15 Passing

Run may still be in progress, this comment will be updated as current testing workflow or job completes...

(Last updated on 01/11/2024 08:10:22am UTC)

Run Details

Running Workflow e2e-couchdb on Github Actions

Commit: 7b9a365

Started: 01/11/2024 08:05:46am UTC

View Detailed Build Results


Current Playwright Test Results Summary

✅ 175 Passing - ⚠️ 3 Flaky

Run may still be in progress, this comment will be updated as current testing workflow or job completes...

(Last updated on 01/11/2024 08:10:22am UTC)

Run Details

Running Job e2e-stable on CircleCI

Commit: 7b9a365

Started: 01/11/2024 08:04:56am UTC

⚠️ Flakes

📄   functional/plugins/plot/logPlot.e2e.spec.js • 1 Flake

Test Case Results

Test Case Last 7 days Failures Last 7 days Flakes
Log plot tests Log Plot ticks are functionally correct in regular and log mode and after refresh
Retry 1Initial Attempt
0% (0) 0 / 76 runs
failed over last 7 days
28.95% (22) 22 / 76 runs
flaked over last 7 days

📄   functional/plugins/notebook/restrictedNotebook.e2e.spec.js • 1 Flake

Test Case Results

Test Case Last 7 days Failures Last 7 days Flakes
Restricted Notebook with a page locked and with an embed @addinit Allows embeds to be deleted if page unlocked @addinit
Retry 1Initial Attempt
4.11% (3) 3 / 73 runs
failed over last 7 days
36.99% (27) 27 / 73 runs
flaked over last 7 days

📄   functional/plugins/telemetryTable/telemetryTable.e2e.spec.js • 1 Flake

Test Case Results

Test Case Last 7 days Failures Last 7 days Flakes
Telemetry Table unpauses and filters data when paused by button and user changes bounds
Retry 1Initial Attempt
6.15% (4) 4 / 65 runs
failed over last 7 days
18.46% (12) 12 / 65 runs
flaked over last 7 days

View Detailed Build Results


@unlikelyzero
Copy link
Collaborator

@davetsay let's sync with @scottbell next week to talk about this change

Copy link
Collaborator

@unlikelyzero unlikelyzero left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This needs a test in Open MCT YAMCS and should be called out in the release notes

@unlikelyzero unlikelyzero added the notable_change A change which should be noted in the changelog label Dec 14, 2023
Copy link

codecov bot commented Dec 14, 2023

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (735c823) 55.82% compared to head (aaf1e99) 55.83%.

Additional details and impacted files
@@            Coverage Diff             @@
##           master    #7199      +/-   ##
==========================================
+ Coverage   55.82%   55.83%   +0.01%     
==========================================
  Files         666      666              
  Lines       26513    26514       +1     
  Branches     2585     2585              
==========================================
+ Hits        14800    14805       +5     
+ Misses      10998    10994       -4     
  Partials      715      715              
Flag Coverage Δ *Carryforward flag
e2e-full 41.81% <ø> (+<0.01%) ⬆️ Carriedforward from 2ed3994
e2e-stable 59.80% <100.00%> (+0.01%) ⬆️
unit 48.88% <100.00%> (+<0.01%) ⬆️

*This pull request uses carry forward flags. Click here to find out more.

Files Coverage Δ
src/plugins/tabs/plugin.js 100.00% <100.00%> (ø)

... and 5 files with indirect coverage changes


Continue to review full report in Codecov by Sentry.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 735c823...aaf1e99. Read the comment docs.

@davetsay davetsay marked this pull request as ready for review December 18, 2023 21:50
@davetsay
Copy link
Contributor Author

This needs a test in Open MCT YAMCS and should be called out in the release notes

@unlikelyzero ,
It has a unit test to test the only change, which is what type of tab the form defaults to. Why would this need a test in Open MCT YAMCS?

It does not change the behavior of the tabs object what so ever. Why is it a breaking change?

@scottbell scottbell added the pr:e2e:couchdb npm run test:e2e:couchdb label Jan 11, 2024
@scottbell scottbell added this to the Target:3.3.0 milestone Jan 11, 2024
@github-actions github-actions bot removed the pr:e2e:couchdb npm run test:e2e:couchdb label Jan 11, 2024
Copy link
Contributor

@scottbell scottbell left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good work @davetsay! It does what it says on the tin. Here's before:
before

Here's after without setting the options installing the tab plugin (defaulting eager loading to false):
after-default-true

And here's with the option in the plugin with eagerLoad set to true:

after-default-true

@davetsay I didn't see any testing notes on the ticket, so I put together a draft. Let me know if it looks good to you.

@unlikelyzero unlikelyzero modified the milestones: Target:3.3.0, Target:4.0.0 Jan 17, 2024
@unlikelyzero unlikelyzero added the pr:e2e:couchdb npm run test:e2e:couchdb label Jan 29, 2024
@unlikelyzero unlikelyzero added the pr:e2e:perf Trigger perf tests label Jan 29, 2024
@github-actions github-actions bot removed pr:e2e:couchdb npm run test:e2e:couchdb pr:e2e:perf Trigger perf tests labels Jan 29, 2024
@unlikelyzero unlikelyzero merged commit 1d40b13 into master Jan 29, 2024
26 of 27 checks passed
@unlikelyzero unlikelyzero deleted the issue/7198 branch January 29, 2024 20:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
notable_change A change which should be noted in the changelog type:enhancement
Projects
None yet
Development

Successfully merging this pull request may close these issues.

tabs should default to not load eagerly
3 participants