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

Provide visibility based rendering as part of the view api #7241

Conversation

scottbell
Copy link
Contributor

@scottbell scottbell commented Nov 16, 2023

Closes #7235

Describe your changes:

When showing a View, pass an optional function that Views can use to call requestAnimationFrame only when the View is visible.

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?
  • Command line build passes?
  • Has this been smoke tested?
  • 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?
  • Has associated issue been labelled unverified? (only applicable if this PR closes the issue)
  • Has associated issue been labelled bug? (only applicable if this PR is for a bug fix)

@scottbell scottbell linked an issue Nov 16, 2023 that may be closed by this pull request
Copy link

deploysentinel bot commented Nov 16, 2023

Current Playwright Test Results Summary

✅ 162 Passing - ⚠️ 5 Flaky

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

(Last updated on 11/20/2023 05:18:42pm UTC)

Run Details

Running Job e2e-stable on CircleCI

Commit: ecd6bb9

Started: 11/20/2023 05:10:53pm UTC

⚠️ Flakes

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

Test Case Results

Test Case Last 7 days Failures Last 7 days Flakes
Tagging in Notebooks @addinit Tags persist across reload
Retry 1Initial Attempt
0% (0) 0 / 57 runs
failed over last 7 days
3.51% (2) 2 / 57 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 Disallows embeds to be deleted if page locked @addinit
Retry 1Initial Attempt
1.69% (1) 1 / 59 run
failed over last 7 days
61.02% (36) 36 / 59 runs
flaked over last 7 days

📄   functional/planning/timelist.e2e.spec.js • 1 Flake

Test Case Results

Test Case Last 7 days Failures Last 7 days Flakes
Time List Create a Time List, add a single Plan to it and verify all the activities are displayed with no milliseconds
Retry 1Initial Attempt
3.61% (3) 3 / 83 runs
failed over last 7 days
62.65% (52) 52 / 83 runs
flaked over last 7 days

📄   functional/plugins/imagery/exampleImagery.e2e.spec.js • 1 Flake

Test Case Results

Test Case Last 7 days Failures Last 7 days Flakes
Example Imagery Object Can use Mouse Wheel to zoom in and out of latest image
Retry 1Initial Attempt
3.33% (2) 2 / 60 runs
failed over last 7 days
25% (15) 15 / 60 runs
flaked over last 7 days

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

Test Case Results

Test Case Last 7 days Failures Last 7 days Flakes
Snapshot image tests Can drop an image onto a notebook and create a new entry
Retry 1Initial Attempt
1.67% (1) 1 / 60 run
failed over last 7 days
70% (42) 42 / 60 runs
flaked over last 7 days

View Detailed Build Results


Current Playwright Test Results Summary

✅ 14 Passing - ⚠️ 1 Flaky

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

(Last updated on 11/20/2023 05:18:42pm UTC)

Run Details

Running Workflow e2e-couchdb on Github Actions

Commit: ecd6bb9

Started: 11/20/2023 05:11:16pm UTC

⚠️ Flakes

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

Test Case Results

Test Case Last 7 days Failures Last 7 days Flakes
Display Layout When multiple plots are contained in a layout, we only ask for annotations once @couchdb
Retry 1Initial Attempt
0% (0) 0 / 33 runs
failed over last 7 days
15.15% (5) 5 / 33 runs
flaked over last 7 days

View Detailed Build Results


Copy link

codecov bot commented Nov 17, 2023

Codecov Report

Merging #7241 (8435ed6) into master (b9ae461) will decrease coverage by 14.18%.
The diff coverage is n/a.

❗ Current head 8435ed6 differs from pull request most recent head ecd6bb9. Consider uploading reports for the commit ecd6bb9 to get more accurate results

Additional details and impacted files
@@             Coverage Diff             @@
##           master    #7241       +/-   ##
===========================================
- Coverage   56.04%   41.87%   -14.18%     
===========================================
  Files         654      417      -237     
  Lines       26227    12997    -13230     
  Branches     2527        0     -2527     
===========================================
- Hits        14700     5442     -9258     
+ Misses      10829     7555     -3274     
+ Partials      698        0      -698     
Flag Coverage Δ
e2e-full 41.87% <ø> (-0.02%) ⬇️
e2e-stable ?
unit ?
Files Coverage Δ
src/plugins/LADTable/LADTableView.js 0.00% <ø> (-93.34%) ⬇️
src/plugins/displayLayout/plugin.js 83.33% <ø> (-8.34%) ⬇️
src/plugins/gauge/GaugeViewProvider.js 18.18% <ø> (-72.73%) ⬇️
src/plugins/plot/PlotViewProvider.js 92.30% <ø> (-7.70%) ⬇️
...lugins/plot/overlayPlot/OverlayPlotViewProvider.js 77.77% <ø> (-16.67%) ⬇️
...lugins/plot/stackedPlot/StackedPlotViewProvider.js 11.11% <ø> (-83.34%) ⬇️
src/plugins/telemetryTable/TelemetryTableView.js 0.00% <ø> (-88.89%) ⬇️

... and 520 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 b9ae461...ecd6bb9. Read the comment docs.

@scottbell scottbell added the pr:e2e:couchdb npm run test:e2e:couchdb label Nov 17, 2023
@scottbell scottbell requested review from akhenry and ozyx and removed request for akhenry November 17, 2023 15:22
@scottbell scottbell marked this pull request as ready for review November 17, 2023 15:22
@github-actions github-actions bot removed the pr:e2e:couchdb npm run test:e2e:couchdb label Nov 17, 2023
Copy link
Member

@ozyx ozyx left a comment

Choose a reason for hiding this comment

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

Looks good overall, just a suggestion about the signature for show()

src/plugins/LADTable/LADTableView.js Show resolved Hide resolved
@unlikelyzero unlikelyzero enabled auto-merge (squash) November 20, 2023 17:08
@unlikelyzero unlikelyzero added this to the Target:3.2.0 milestone Nov 20, 2023
@unlikelyzero unlikelyzero added the pr:e2e:couchdb npm run test:e2e:couchdb label Nov 20, 2023
@github-actions github-actions bot removed the pr:e2e:couchdb npm run test:e2e:couchdb label Nov 20, 2023
@unlikelyzero unlikelyzero merged commit 7ce3ed5 into master Nov 20, 2023
12 of 13 checks passed
@unlikelyzero unlikelyzero deleted the 7235-provide-visibility-based-rendering-as-part-of-the-view-api branch November 20, 2023 17:19
scottbell added a commit that referenced this pull request Nov 20, 2023
* first draft

* in preview mode, just show it

* fix unit tests
unlikelyzero pushed a commit that referenced this pull request Nov 20, 2023
… view api (#7249)

Provide visibility based rendering as part of the view api (#7241)

* first draft

* in preview mode, just show it

* fix unit tests
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Provide visibility-based rendering as part of the View API
4 participants