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

chore: add isUpdating flag to prevent multiple re-renders #4773

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

rubencarvalho
Copy link
Collaborator

Description

Related issue(s)

Motivation and context

How has this been tested?

  • Test case 1

    1. Go here
    2. Do this
  • Test case 2

    1. Go here
    2. Do this
  • Did it pass in Desktop?

  • Did it pass in Mobile?

  • Did it pass in iPad?

Screenshots (if appropriate)

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)
  • Chore (minor updates related to the tooling or maintenance of the repository, does not impact compiled assets)

Checklist

  • I have signed the Adobe Open Source CLA.
  • My code follows the code style of this project.
  • If my change required a change to the documentation, I have updated the documentation in this pull request.
  • I have read the CONTRIBUTING document.
  • I have added tests to cover my changes.
  • All new and existing tests passed.
  • I have reviewed at the Accessibility Practices for this feature, see: Aria Practices

Best practices

This repository uses conventional commit syntax for each commit message; note that the GitHub UI does not use this by default so be cautious when accepting suggested changes. Avoid the "Update branch" button on the pull request and opt instead for rebasing your branch against main.

Copy link

Branch preview

Visual regression test results

When a visual regression test fails (or has previously failed while working on this branch), its results can be found in the following URLs:

@coveralls
Copy link
Collaborator

Pull Request Test Coverage Report for Build 10931830248

Details

  • 8 of 10 (80.0%) changed or added relevant lines in 1 file are covered.
  • No unchanged relevant lines lost coverage.
  • Overall coverage decreased (-0.005%) to 98.204%

Changes Missing Coverage Covered Lines Changed/Added Lines %
packages/overlay/src/OverlayTrigger.ts 8 10 80.0%
Totals Coverage Status
Change from base Build 10905285957: -0.005%
Covered Lines: 32550
Relevant Lines: 32971

💛 - Coveralls

Copy link

Tachometer results

Chrome

action-bar permalink

basic-test

Version Bytes Avg Time vs remote vs branch
npm latest 500 kB 51.21ms - 52.21ms - faster ✔
4% - 7%
2.08ms - 3.65ms
branch 476 kB 53.97ms - 55.18ms slower ❌
4% - 7%
2.08ms - 3.65ms
-

action-menu permalink

test-basic

Version Bytes Avg Time vs remote vs branch
npm latest 701 kB 134.62ms - 137.38ms - faster ✔
5% - 7%
6.89ms - 10.49ms
branch 659 kB 143.53ms - 145.84ms slower ❌
5% - 8%
6.89ms - 10.49ms
-

test-directive permalink

Version Bytes Avg Time vs remote vs branch
npm latest 658 kB 65.35ms - 67.22ms - faster ✔
6% - 10%
4.49ms - 6.87ms
branch 616 kB 71.23ms - 72.70ms slower ❌
7% - 10%
4.49ms - 6.87ms
-

test-lazy permalink

Version Bytes Avg Time vs remote vs branch
npm latest 657 kB 64.57ms - 65.68ms - faster ✔
6% - 8%
3.96ms - 5.78ms
branch 615 kB 69.27ms - 70.72ms slower ❌
6% - 9%
3.96ms - 5.78ms
-

test-open-close-directive permalink

Version Bytes Avg Time vs remote vs branch
npm latest 847 kB 1871.22ms - 1874.28ms - unsure 🔍
-0% - +0%
-2.59ms - +1.59ms
branch 802 kB 1871.84ms - 1874.67ms unsure 🔍
-0% - +0%
-1.59ms - +2.59ms
-

test-open-close permalink

Version Bytes Avg Time vs remote vs branch
npm latest 845 kB 1873.86ms - 1877.19ms - unsure 🔍
-0% - -0%
-4.98ms - -0.64ms
branch 801 kB 1876.94ms - 1879.72ms unsure 🔍
+0% - +0%
+0.64ms - +4.98ms
-

breadcrumbs permalink

basic-test

Version Bytes Avg Time vs remote vs branch
npm latest 718 kB 494.22ms - 500.05ms - faster ✔
1% - 3%
5.82ms - 14.76ms
branch 676 kB 504.03ms - 510.81ms slower ❌
1% - 3%
5.82ms - 14.76ms
-

combobox permalink

basic-test

Version Bytes Avg Time vs remote vs branch
npm latest 763 kB 37.40ms - 37.87ms - faster ✔
2% - 3%
0.63ms - 1.25ms
branch 718 kB 38.37ms - 38.77ms slower ❌
2% - 3%
0.63ms - 1.25ms
-

light-dom-test permalink

Version Bytes Avg Time vs remote vs branch
npm latest 763 kB 385.60ms - 392.16ms - faster ✔
1% - 3%
2.48ms - 11.86ms
branch 718 kB 392.70ms - 399.40ms slower ❌
1% - 3%
2.48ms - 11.86ms
-

contextual-help permalink

basic-test

Version Bytes Avg Time vs remote vs branch
npm latest 689 kB 52.76ms - 55.34ms - faster ✔
3% - 9%
1.64ms - 5.11ms
branch 644 kB 56.27ms - 58.59ms slower ❌
3% - 10%
1.64ms - 5.11ms
-

menu permalink

test-basic

Version Bytes Avg Time vs remote vs branch
npm latest 494 kB 222.98ms - 228.12ms - faster ✔
1% - 6%
1.81ms - 14.13ms
branch 470 kB 227.92ms - 239.12ms slower ❌
1% - 6%
1.81ms - 14.13ms
-

overlay permalink

basic-test

Version Bytes Avg Time vs remote vs branch
npm latest 716 kB 441.24ms - 456.89ms - unsure 🔍
-2% - +2%
-8.66ms - +8.40ms
branch 698 kB 445.80ms - 452.59ms unsure 🔍
-2% - +2%
-8.40ms - +8.66ms
-

directive-test permalink

Version Bytes Avg Time vs remote vs branch
npm latest 822 kB 22.94ms - 24.15ms - faster ✔
6% - 12%
1.67ms - 3.02ms
branch 778 kB 25.59ms - 26.19ms slower ❌
7% - 13%
1.67ms - 3.02ms
-

element-test permalink

Version Bytes Avg Time vs remote vs branch
npm latest 812 kB 355.98ms - 361.03ms - faster ✔
2% - 4%
7.45ms - 15.15ms
branch 767 kB 366.90ms - 372.72ms slower ❌
2% - 4%
7.45ms - 15.15ms
-

lazy-test permalink

Version Bytes Avg Time vs remote vs branch
npm latest 609 kB 42.95ms - 44.65ms - faster ✔
4% - 9%
2.05ms - 4.18ms
branch 564 kB 46.27ms - 47.56ms slower ❌
5% - 10%
2.05ms - 4.18ms
-

picker permalink

basic-test

Version Bytes Avg Time vs remote vs branch
npm latest 568 kB 496.48ms - 502.87ms - faster ✔
3% - 5%
13.41ms - 24.12ms
branch 526 kB 514.14ms - 522.74ms slower ❌
3% - 5%
13.41ms - 24.12ms
-

popover permalink

test-basic

Version Bytes Avg Time vs remote vs branch
npm latest 395 kB 11.26ms - 11.40ms - faster ✔
2% - 4%
0.25ms - 0.48ms
branch 373 kB 11.61ms - 11.79ms slower ❌
2% - 4%
0.25ms - 0.48ms
-

split-button permalink

basic-test

Version Bytes Avg Time vs remote vs branch
npm latest 780 kB 1862.22ms - 1866.61ms - unsure 🔍
-0% - +0%
-4.89ms - +1.24ms
branch 736 kB 1864.10ms - 1868.38ms unsure 🔍
-0% - +0%
-1.24ms - +4.89ms
-

tooltip permalink

test-basic

Version Bytes Avg Time vs remote vs branch
npm latest 622 kB 34.26ms - 35.12ms - faster ✔
4% - 7%
1.32ms - 2.43ms
branch 576 kB 36.22ms - 36.92ms slower ❌
4% - 7%
1.32ms - 2.43ms
-

test-directive permalink

Version Bytes Avg Time vs remote vs branch
npm latest 579 kB 21.96ms - 28.40ms - unsure 🔍
-15% - +10%
-3.83ms - +2.64ms
branch 537 kB 25.48ms - 26.08ms unsure 🔍
-11% - +16%
-2.64ms - +3.83ms
-

test-element permalink

Version Bytes Avg Time vs remote vs branch
npm latest 704 kB 52.18ms - 53.27ms - faster ✔
5% - 8%
2.86ms - 4.39ms
branch 659 kB 55.82ms - 56.89ms slower ❌
5% - 8%
2.86ms - 4.39ms
-

test-lazy permalink

Version Bytes Avg Time vs remote vs branch
npm latest 680 kB 42.78ms - 43.78ms - faster ✔
5% - 8%
2.33ms - 3.65ms
branch 635 kB 45.84ms - 46.70ms slower ❌
5% - 8%
2.33ms - 3.65ms
-

truncated permalink

basic-test

Version Bytes Avg Time vs remote vs branch
npm latest 545 kB 57.73ms - 59.08ms - faster ✔
3% - 5%
1.63ms - 3.31ms
branch 519 kB 60.38ms - 61.37ms slower ❌
3% - 6%
1.63ms - 3.31ms
-
Firefox

action-bar permalink

basic-test

Version Bytes Avg Time vs remote vs branch
npm latest 500 kB 115.05ms - 120.31ms - unsure 🔍
-4% - +1%
-5.39ms - +1.47ms
branch 476 kB 117.44ms - 121.84ms unsure 🔍
-1% - +5%
-1.47ms - +5.39ms
-

action-menu permalink

test-basic

Version Bytes Avg Time vs remote vs branch
npm latest 701 kB 294.54ms - 298.18ms - faster ✔
9% - 11%
28.55ms - 35.81ms
branch 659 kB 325.40ms - 331.68ms slower ❌
10% - 12%
28.55ms - 35.81ms
-

test-directive permalink

Version Bytes Avg Time vs remote vs branch
npm latest 658 kB 141.42ms - 144.74ms - unsure 🔍
-1% - +2%
-1.29ms - +2.69ms
branch 616 kB 141.29ms - 143.47ms unsure 🔍
-2% - +1%
-2.69ms - +1.29ms
-

test-lazy permalink

Version Bytes Avg Time vs remote vs branch
npm latest 657 kB 132.46ms - 135.86ms - faster ✔
2% - 6%
2.56ms - 7.96ms
branch 615 kB 137.32ms - 141.52ms slower ❌
2% - 6%
2.56ms - 7.96ms
-

test-open-close-directive permalink

Version Bytes Avg Time vs remote vs branch
npm latest 847 kB 1889.00ms - 1896.28ms - unsure 🔍
-0% - +0%
-4.58ms - +4.18ms
branch 802 kB 1890.42ms - 1895.26ms unsure 🔍
-0% - +0%
-4.18ms - +4.58ms
-

test-open-close permalink

Version Bytes Avg Time vs remote vs branch
npm latest 845 kB 1900.22ms - 1904.46ms - unsure 🔍
-0% - +0%
-2.58ms - +3.02ms
branch 801 kB 1900.29ms - 1903.95ms unsure 🔍
-0% - +0%
-3.02ms - +2.58ms
-

breadcrumbs permalink

basic-test

Version Bytes Avg Time vs remote vs branch
npm latest 718 kB 815.49ms - 839.51ms - faster ✔
1% - 4%
6.81ms - 32.43ms
branch 676 kB 842.66ms - 851.58ms slower ❌
1% - 4%
6.81ms - 32.43ms
-

combobox permalink

basic-test

Version Bytes Avg Time vs remote vs branch
npm latest 763 kB 62.56ms - 64.96ms - faster ✔
0% - 5%
0.29ms - 3.51ms
branch 718 kB 64.59ms - 66.73ms slower ❌
0% - 6%
0.29ms - 3.51ms
-

light-dom-test permalink

Version Bytes Avg Time vs remote vs branch
npm latest 763 kB 761.66ms - 784.70ms - slower ❌
2% - 6%
18.31ms - 44.37ms
branch 718 kB 735.76ms - 747.92ms faster ✔
2% - 6%
18.31ms - 44.37ms
-

contextual-help permalink

basic-test

Version Bytes Avg Time vs remote vs branch
npm latest 689 kB 107.61ms - 113.63ms - faster ✔
2% - 10%
2.80ms - 11.56ms
branch 644 kB 114.62ms - 120.98ms slower ❌
2% - 11%
2.80ms - 11.56ms
-

menu permalink

test-basic

Version Bytes Avg Time vs remote vs branch
npm latest 494 kB 448.76ms - 461.32ms - unsure 🔍
-3% - +1%
-14.15ms - +4.47ms
branch 470 kB 453.01ms - 466.75ms unsure 🔍
-1% - +3%
-4.47ms - +14.15ms
-

overlay permalink

basic-test

Version Bytes Avg Time vs remote vs branch
npm latest 819 kB 685.78ms - 700.02ms - slower ❌
2% - 5%
12.19ms - 32.49ms
branch 774 kB 663.32ms - 677.80ms faster ✔
2% - 5%
12.19ms - 32.49ms
-

directive-test permalink

Version Bytes Avg Time vs remote vs branch
npm latest 822 kB 49.57ms - 50.67ms - faster ✔
3% - 6%
1.64ms - 3.24ms
branch 778 kB 51.99ms - 53.13ms slower ❌
3% - 6%
1.64ms - 3.24ms
-

element-test permalink

Version Bytes Avg Time vs remote vs branch
npm latest 812 kB 698.73ms - 714.99ms - slower ❌
1% - 5%
6.50ms - 36.10ms
branch 767 kB 673.19ms - 697.93ms faster ✔
1% - 5%
6.50ms - 36.10ms
-

lazy-test permalink

Version Bytes Avg Time vs remote vs branch
npm latest 609 kB 91.97ms - 94.47ms - faster ✔
6% - 9%
6.36ms - 9.60ms
branch 564 kB 100.17ms - 102.23ms slower ❌
7% - 10%
6.36ms - 9.60ms
-

picker permalink

basic-test

Version Bytes Avg Time vs remote vs branch
npm latest 568 kB 1047.96ms - 1059.84ms - faster ✔
5% - 7%
51.46ms - 80.82ms
branch 526 kB 1106.62ms - 1133.46ms slower ❌
5% - 8%
51.46ms - 80.82ms
-

popover permalink

test-basic

Version Bytes Avg Time vs remote vs branch
npm latest 395 kB 29.64ms - 32.24ms - unsure 🔍
-7% - +4%
-2.31ms - +1.19ms
branch 373 kB 30.33ms - 32.67ms unsure 🔍
-4% - +8%
-1.19ms - +2.31ms
-

split-button permalink

basic-test

Version Bytes Avg Time vs remote vs branch
npm latest 780 kB 1875.65ms - 1880.47ms - unsure 🔍
-0% - +0%
-6.68ms - +0.56ms
branch 736 kB 1878.43ms - 1883.81ms unsure 🔍
-0% - +0%
-0.56ms - +6.68ms
-

tooltip permalink

test-basic

Version Bytes Avg Time vs remote vs branch
npm latest 704 kB 78.93ms - 83.07ms - slower ❌
3% - 10%
2.44ms - 7.88ms
branch 659 kB 74.07ms - 77.61ms faster ✔
3% - 10%
2.44ms - 7.88ms
-

test-directive permalink

Version Bytes Avg Time vs remote vs branch
npm latest 579 kB 47.90ms - 48.74ms - faster ✔
4% - 7%
2.28ms - 3.80ms
branch 537 kB 50.72ms - 52.00ms slower ❌
5% - 8%
2.28ms - 3.80ms
-

test-element permalink

Version Bytes Avg Time vs remote vs branch
npm latest 704 kB 133.60ms - 138.84ms - slower ❌
3% - 9%
3.91ms - 11.61ms
branch 659 kB 125.63ms - 131.29ms faster ✔
3% - 8%
3.91ms - 11.61ms
-

test-lazy permalink

Version Bytes Avg Time vs remote vs branch
npm latest 680 kB 89.36ms - 92.36ms - faster ✔
13% - 18%
13.18ms - 20.34ms
branch 635 kB 104.37ms - 110.87ms slower ❌
14% - 23%
13.18ms - 20.34ms
-

truncated permalink

basic-test

Version Bytes Avg Time vs remote vs branch
npm latest 545 kB 107.54ms - 112.74ms - faster ✔
1% - 8%
0.99ms - 9.45ms
branch 519 kB 112.03ms - 118.69ms slower ❌
1% - 9%
0.99ms - 9.45ms
-

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.

2 participants