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

Update API Extractor (take 2) #18920

Merged
merged 13 commits into from
Jul 13, 2021

Conversation

ecraig12345
Copy link
Member

@ecraig12345 ecraig12345 commented Jul 13, 2021

Slightly modified version of #18885--copying notes from there, with some additions:

Pull request checklist

- Addresses an existing issue: Fixes #0000

  • Include a change request file using $ yarn change

Description of changes

  • Updated API Extractor and related dependencies to support import * as module from './local/module' statements.
    • api-extractor
    • api-extractor-model
    • tsdoc
  • Force API Extractor to use [email protected] like the rest of the repo (by default it was using ~4.3.2, and using different TS versions for compilation and API analysis could cause issues)
  • Remove separate API Extractor version for web-components and update API file
  • Fix in react-menu documentation from @see (block tag) to @link (inline tag)

Required for #18778 implementation.

Copy link
Contributor

@andrefcdias andrefcdias left a comment

Choose a reason for hiding this comment

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

LGTM, thanks for the help!

@ecraig12345 ecraig12345 marked this pull request as ready for review July 13, 2021 17:06
@andrefcdias andrefcdias mentioned this pull request Jul 13, 2021
1 task
@size-auditor
Copy link

size-auditor bot commented Jul 13, 2021

Asset size changes

Size Auditor did not detect a change in bundle size for any component!

Baseline commit: 656b27e720ec0a3b6ffe3c016053219eab1c882c (build)

@ecraig12345 ecraig12345 enabled auto-merge (squash) July 13, 2021 17:16
@ecraig12345
Copy link
Member Author

/azp run

@azure-pipelines
Copy link

Azure Pipelines successfully started running 3 pipeline(s).

@fabricteam
Copy link
Collaborator

Perf Analysis (@fluentui/react)

No significant results to display.

All results

Scenario Render type Master Ticks PR Ticks Iterations Status
Avatar mount 856 865 5000
BaseButton mount 999 1021 5000
Breadcrumb mount 2819 2936 1000
ButtonNext mount 554 582 5000
Checkbox mount 1686 1714 5000
CheckboxBase mount 1477 1430 5000
ChoiceGroup mount 5199 5278 5000
ComboBox mount 1073 1073 1000
CommandBar mount 11192 11292 1000
ContextualMenu mount 6862 6946 1000
DefaultButton mount 1229 1267 5000
DetailsRow mount 4068 4037 5000
DetailsRowFast mount 4016 3978 5000
DetailsRowNoStyles mount 3831 3857 5000
Dialog mount 1523 2246 1000
DocumentCardTitle mount 163 154 1000
Dropdown mount 3588 3592 5000
FluentProviderNext mount 8454 7764 5000
FocusTrapZone mount 1998 1868 5000
FocusZone mount 1953 1897 5000
IconButton mount 1958 1949 5000
Label mount 380 374 5000
Layer mount 1906 1951 5000
Link mount 516 530 5000
MakeStyles mount 1900 1898 50000
MenuButton mount 1634 1626 5000
MessageBar mount 2215 2180 5000
Nav mount 3648 3679 1000
OverflowSet mount 1125 1099 5000
Panel mount 2187 2239 1000
Persona mount 900 907 1000
Pivot mount 1579 1533 1000
PrimaryButton mount 1425 1430 5000
Rating mount 8503 8683 5000
SearchBox mount 1459 1501 5000
Shimmer mount 2770 2820 5000
Slider mount 2131 2166 5000
SpinButton mount 5439 5496 5000
Spinner mount 442 452 5000
SplitButton mount 3471 3498 5000
Stack mount 539 563 5000
StackWithIntrinsicChildren mount 1720 1746 5000
StackWithTextChildren mount 5149 5147 5000
SwatchColorPicker mount 11214 11198 5000
Tabs mount 1517 1548 1000
TagPicker mount 2675 2640 5000
TeachingBubble mount 12709 12494 5000
Text mount 486 467 5000
TextField mount 1495 1521 5000
ThemeProvider mount 1281 1253 5000
ThemeProvider virtual-rerender 634 640 5000
Toggle mount 903 920 5000
buttonNative mount 128 124 5000

Perf Analysis (@fluentui/react-northstar)

Perf tests with no regressions
Scenario Current PR Ticks Baseline Ticks Ratio
ButtonMinimalPerf.default 218 197 1.11:1
TreeWith60ListItems.default 215 193 1.11:1
RefMinimalPerf.default 264 245 1.08:1
VideoMinimalPerf.default 728 676 1.08:1
AnimationMinimalPerf.default 478 449 1.06:1
ButtonOverridesMissPerf.default 1991 1902 1.05:1
ButtonSlotsPerf.default 650 622 1.05:1
HeaderMinimalPerf.default 433 412 1.05:1
ImageMinimalPerf.default 432 412 1.05:1
PortalMinimalPerf.default 193 184 1.05:1
CarouselMinimalPerf.default 545 524 1.04:1
ListNestedPerf.default 660 637 1.04:1
SegmentMinimalPerf.default 404 388 1.04:1
IconMinimalPerf.default 724 695 1.04:1
AttachmentMinimalPerf.default 177 172 1.03:1
AttachmentSlotsPerf.default 1236 1195 1.03:1
ChatWithPopoverPerf.default 434 422 1.03:1
ListWith60ListItems.default 735 711 1.03:1
SplitButtonMinimalPerf.default 4262 4146 1.03:1
StatusMinimalPerf.default 812 791 1.03:1
TreeMinimalPerf.default 922 893 1.03:1
BoxMinimalPerf.default 443 434 1.02:1
DialogMinimalPerf.default 847 834 1.02:1
DividerMinimalPerf.default 412 403 1.02:1
FlexMinimalPerf.default 322 317 1.02:1
HeaderSlotsPerf.default 879 865 1.02:1
ItemLayoutMinimalPerf.default 1390 1366 1.02:1
PopupMinimalPerf.default 646 636 1.02:1
ReactionMinimalPerf.default 448 439 1.02:1
SkeletonMinimalPerf.default 406 399 1.02:1
SliderMinimalPerf.default 1735 1705 1.02:1
TextMinimalPerf.default 413 403 1.02:1
AccordionMinimalPerf.default 182 181 1.01:1
AlertMinimalPerf.default 314 311 1.01:1
CheckboxMinimalPerf.default 3011 2994 1.01:1
DatepickerMinimalPerf.default 6444 6369 1.01:1
DropdownMinimalPerf.default 3406 3363 1.01:1
FormMinimalPerf.default 475 469 1.01:1
MenuMinimalPerf.default 977 963 1.01:1
ProviderMergeThemesPerf.default 1763 1752 1.01:1
TableManyItemsPerf.default 2176 2158 1.01:1
TextAreaMinimalPerf.default 602 595 1.01:1
CustomToolbarPrototype.default 4353 4294 1.01:1
ToolbarMinimalPerf.default 1082 1068 1.01:1
EmbedMinimalPerf.default 4531 4520 1:1
GridMinimalPerf.default 396 397 1:1
InputMinimalPerf.default 1378 1372 1:1
ListMinimalPerf.default 597 600 1:1
MenuButtonMinimalPerf.default 1818 1815 1:1
TableMinimalPerf.default 471 470 1:1
CardMinimalPerf.default 636 641 0.99:1
ChatMinimalPerf.default 772 778 0.99:1
LabelMinimalPerf.default 435 439 0.99:1
LayoutMinimalPerf.default 441 445 0.99:1
ListCommonPerf.default 721 728 0.99:1
LoaderMinimalPerf.default 765 769 0.99:1
TooltipMinimalPerf.default 1143 1160 0.99:1
DropdownManyItemsPerf.default 774 789 0.98:1
RosterPerf.default 1260 1283 0.98:1
ProviderMinimalPerf.default 1123 1143 0.98:1
RadioGroupMinimalPerf.default 515 525 0.98:1
ChatDuplicateMessagesPerf.default 331 345 0.96:1
AvatarMinimalPerf.default 229 240 0.95:1

@ecraig12345 ecraig12345 merged commit a84e635 into microsoft:master Jul 13, 2021
@ecraig12345 ecraig12345 deleted the update-api-extractor-version branch July 13, 2021 19:20
@@ -222,6 +222,7 @@
]
},
"resolutions": {
"@microsoft/api-extractor/typescript": "4.1.5",
Copy link
Contributor

Choose a reason for hiding this comment

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

I reported this some time ago microsoft/rushstack#2565

wondering who can we reach out to to get proper fix ?
@ecraig12345 @JustSlone

@@ -49,7 +49,6 @@
"test-firefox:verbose": "karma start karma.conf.js --browsers=FirefoxHeadless --single-run --coverage --reporter=mocha"
},
"devDependencies": {
"@microsoft/api-extractor": "7.7.1",
Copy link
Contributor

Choose a reason for hiding this comment

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

🙌

@Hotell Hotell added this to the July Project Cycle Q2 2021 milestone Jul 14, 2021
PeterDraex pushed a commit to PeterDraex/fluentui that referenced this pull request Aug 6, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

7 participants