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

build: Update API-Extractor, remove now-unneeded pnpm patches, and update API reports to reflect bug fix #19939

Merged
merged 7 commits into from
Mar 4, 2024

Conversation

Josmithr
Copy link
Contributor

@Josmithr Josmithr commented Mar 4, 2024

Noteworthy changes beyond dependency version bumps:

  1. Removes pnpm patches for API-Extractor, which are now unneeded.
    • All of the features and bug fixes that we captured by the patch are now in the production version.
  2. Update bundledPackages entries in API-Extractor configs to use glob patterns instead of regular expressions.
  3. Updates API reports throughout the repo to reflect a bug fix where API items would be marked as (undocumented) when they leveraged TSDoc {@inheritDoc } comments in some cases.

See API-Extractor's changelog here: https://github.com/microsoft/rushstack/blob/main/apps/api-extractor/CHANGELOG.md#7423

@Josmithr Josmithr requested review from tylerbutler and a team March 4, 2024 21:22
@github-actions github-actions bot added area: build Build related issues area: dds Issues related to distributed data structures area: dds: propertydds area: dds: sharedstring area: dds: tree area: dev experience Improving the experience of devs building on top of fluid area: driver Driver related issues area: examples Changes that focus on our examples area: framework Framework is a tag for issues involving the developer framework. Eg Aqueduct area: loader Loader related issues area: odsp-driver area: runtime Runtime related issues area: server Server related issues (routerlicious) area: tests Tests to add, test infrastructure improvements, etc dependencies Pull requests that update a dependency file public api change Changes to a public API base: main PRs targeted against main branch labels Mar 4, 2024
@@ -25,7 +25,6 @@ export class AttributableMap extends SharedObject<ISharedMapEvents> implements I
[Symbol.iterator](): IterableIterator<[string, any]>;
readonly [Symbol.toStringTag]: string;
constructor(id: string, runtime: IFluidDataStoreRuntime, attributes: IChannelAttributes);
// (undocumented)
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Anything that was previously documented using {@inheritDoc } pointing to a target in another library would be incorrectly annotated as (undocumented). This is now fixed!

@@ -122,7 +122,6 @@
"@fluid-private/readme-command": "workspace:~",
"@fluidframework/build-common": "^2.0.3",
"@fluidframework/eslint-config-fluid": "^4.0.0",
"@microsoft/api-extractor": "^7.39.1",
Copy link
Contributor Author

@Josmithr Josmithr Mar 4, 2024

Choose a reason for hiding this comment

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

This was duplicated between dependencies and devDependencies. This package uses api-extractor in code, so the devDependencies entry was removed.

@Josmithr Josmithr changed the title build: Update API-Extractor, remove now unneeded pnpm patches, and update API reports to reflect bug fix build: Update API-Extractor, remove now-unneeded pnpm patches, and update API reports to reflect bug fix Mar 4, 2024
server/routerlicious/Dockerfile Outdated Show resolved Hide resolved
server/routerlicious/patches/README.md Outdated Show resolved Hide resolved
@msfluid-bot
Copy link
Collaborator

@fluid-example/bundle-size-tests: +44 Bytes
Metric NameBaseline SizeCompare SizeSize Diff
aqueduct.js 514.51 KB 514.52 KB +11 Bytes
connectionState.js 680 Bytes 680 Bytes No change
containerRuntime.js 248.12 KB 248.12 KB No change
loader.js 128.43 KB 128.43 KB No change
map.js 46.8 KB 46.8 KB No change
matrix.js 149.42 KB 149.42 KB No change
odspDriver.js 97.47 KB 97.48 KB +11 Bytes
odspPrefetchSnapshot.js 42.28 KB 42.29 KB +11 Bytes
sharedString.js 167.63 KB 167.65 KB +11 Bytes
sharedTree.js 336.55 KB 336.55 KB No change
Total Size 1.84 MB 1.84 MB +44 Bytes

Baseline commit: 7c4a08b

Generated by 🚫 dangerJS against 536fc23

@Josmithr Josmithr merged commit 5767a26 into microsoft:main Mar 4, 2024
49 checks passed
@Josmithr Josmithr deleted the build/update-api-extractor branch March 4, 2024 23:12
Josmithr added a commit that referenced this pull request Apr 17, 2024
…e tag compatibility (#20696)

Mitigation for API-Extractor [issue
4430](microsoft/rushstack#4430).

The original mitigation we had in place was erroneously removed in
#19939.

Also fixes the handful of violations that have been introduced since
that PR.
Josmithr added a commit that referenced this pull request Apr 17, 2024
…e tag compatibility (#20696) (#20699)

Mitigation for API-Extractor [issue
4430](microsoft/rushstack#4430).

The original mitigation we had in place was erroneously removed in
#19939.

Also fixes the handful of violations that have been introduced since
that PR.

Cherry-picked from #20696
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area: build Build related issues area: dds: propertydds area: dds: sharedstring area: dds: tree area: dds Issues related to distributed data structures area: dev experience Improving the experience of devs building on top of fluid area: driver Driver related issues area: examples Changes that focus on our examples area: framework Framework is a tag for issues involving the developer framework. Eg Aqueduct area: loader Loader related issues area: odsp-driver area: runtime Runtime related issues area: server Server related issues (routerlicious) area: tests Tests to add, test infrastructure improvements, etc base: main PRs targeted against main branch dependencies Pull requests that update a dependency file public api change Changes to a public API
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants