FluidFramework icon indicating copy to clipboard operation
FluidFramework copied to clipboard

Add all referenced fluid API to fluid-framework rollup package

Open CraigMacomber opened this issue 1 year ago • 2 comments

Description

This adds exports to the fluid-framework package until all the imports from fluid framework are gone from its API report.

This would avoid errors where using some APIs (ex: exporting them from packages in apps) may warn about types not being namable, or being unable to explicitly type some values without additional imports.

Additionally this puts the transitively reachable portion of our public API in one place where it can be reviewed.

Reviewer Guidance

The review process is outlined on this wiki page.

It is unclear to me what the policy is for which things should be exported from fluid-framework, so I'm not sure if this change is a fix or violating some decision that was made. Clarification on this would be valuable.

CraigMacomber avatar Apr 09 '24 18:04 CraigMacomber

https://learn.microsoft.com/en-us/azure/azure-fluid-relay/concepts/version-compatibility#compatibility-table is relevant as we document our compat in terms of the fluid-framework package, so rolling these all up into one place robustly avoids the issue of what the implacied support/compat of the packages referenced by fluid-framework is. It also reduces the risk of mismatched point releases since fluid-framework gains a direct dependency on the packages it implicitly depends on.

CraigMacomber avatar Apr 24 '24 18:04 CraigMacomber

@fluid-example/bundle-size-tests: +2.99 KB
Metric NameBaseline SizeCompare SizeSize Diff
aqueduct.js 454 KB 454.27 KB +275 Bytes
azureClient.js 550.34 KB 550.62 KB +290 Bytes
connectionState.js 680 Bytes 680 Bytes No change
containerRuntime.js 257.08 KB 257.33 KB +258 Bytes
fluidFramework.js 344.1 KB 344.67 KB +580 Bytes
loader.js 132.83 KB 132.83 KB No change
map.js 41.15 KB 41.4 KB +256 Bytes
matrix.js 143.32 KB 143.58 KB +264 Bytes
odspClient.js 518.83 KB 519.12 KB +290 Bytes
odspDriver.js 97.23 KB 97.23 KB No change
odspPrefetchSnapshot.js 42.1 KB 42.1 KB No change
sharedString.js 161.05 KB 161.32 KB +270 Bytes
sharedTree.js 344.1 KB 344.67 KB +580 Bytes
Total Size 3.16 MB 3.17 MB +2.99 KB

Baseline commit: 350c06a051e3fb90563118683eb11e973aeb9b06

Generated by :no_entry_sign: dangerJS against 9445be5bd1be252d54b5d44addce2274952357d2

msfluid-bot avatar May 03 '24 20:05 msfluid-bot

This PR has been automatically marked as stale because it has had no activity for 60 days. It will be closed if no further activity occurs within 8 days of this comment. Thank you for your contributions to Fluid Framework!