FluidFramework icon indicating copy to clipboard operation
FluidFramework copied to clipboard

feat(tree): Include list of properties that changed in nodeChanged event

Open CraigMacomber opened this issue 1 year ago • 3 comments

Description

Updated version of https://github.com/microsoft/FluidFramework/pull/22043 .

See changeset for details.

Reviewer Guidance

The review process is outlined on this wiki page.

CraigMacomber avatar Aug 16 '24 05:08 CraigMacomber

@fluid-example/bundle-size-tests: +959 Bytes
Metric NameBaseline SizeCompare SizeSize Diff
aqueduct.js 461.15 KB 461.18 KB +35 Bytes
azureClient.js 559.19 KB 559.24 KB +49 Bytes
connectionState.js 680 Bytes 680 Bytes No change
containerRuntime.js 261.99 KB 262 KB +14 Bytes
fluidFramework.js 399.76 KB 400.12 KB +371 Bytes
loader.js 134.26 KB 134.28 KB +14 Bytes
map.js 42.39 KB 42.39 KB +7 Bytes
matrix.js 146.56 KB 146.56 KB +7 Bytes
odspClient.js 526.47 KB 526.52 KB +49 Bytes
odspDriver.js 97.72 KB 97.74 KB +21 Bytes
odspPrefetchSnapshot.js 42.78 KB 42.79 KB +14 Bytes
sharedString.js 163.26 KB 163.26 KB +7 Bytes
sharedTree.js 390.27 KB 390.63 KB +364 Bytes
Total Size 3.3 MB 3.3 MB +959 Bytes

Baseline commit: 761d07b05fa696d663a8f2f9d2764e17913d8ab4

Generated by :no_entry_sign: dangerJS against 33880b955a942f062236d58948cf65c13e2c8253

msfluid-bot avatar Aug 20 '24 20:08 msfluid-bot

A usability issue with this APi has been reported:

Lack of strong typing of the keys least to string names for keys in code easily getting out of date (or having typos) with no compile errors.

There are two ways this could be improved:

  • strong types on the keys in the set (ex: derive them from the object node or nodes provided)
  • a way to refer to property key strings that is strongly typed to the object they are on and refactors properly. For example Foo.fields.bar.key possible leveraging a "FieldSchemaContextual" subclass which has the key as s strongly typed property.

CraigMacomber avatar Aug 27 '24 17:08 CraigMacomber

A usability issue with this APi has been reported:

Lack of strong typing of the keys least to string names for keys in code easily getting out of date (or having typos) with no compile errors.

There are two ways this could be improved:

  • strong types on the keys in the set (ex: derive them from the object node or nodes provided)
  • a way to refer to property key strings that is strongly typed to the object they are on and refactors properly. For example Foo.fields.bar.key possible leveraging a "FieldSchemaContextual" subclass which has the key as s strongly typed property.

Fixed. Also moved API to beta incase there are more such issues.

CraigMacomber avatar Sep 04 '24 22:09 CraigMacomber

🔗 No broken links found! ✅

Your attention to detail is admirable.

linkcheck output


> [email protected] ci:linkcheck /home/runner/work/FluidFramework/FluidFramework/docs
> start-server-and-test ci:start 1313 linkcheck:full

1: starting server using command "npm run ci:start"
and when url "[ 'http://127.0.0.1:1313' ]" is responding with HTTP status code 200
running tests using command "npm run linkcheck:full"


> [email protected] ci:start
> http-server ./public --port 1313 --silent


> [email protected] linkcheck:full
> npm run linkcheck:fast -- --external


> [email protected] linkcheck:fast
> linkcheck http://localhost:1313 --skip-file skipped-urls.txt --external

Crawling...

Stats:
  378023 links
    2980 destination URLs
       2 URLs ignored
       0 warnings
       0 errors


github-actions[bot] avatar Sep 05 '24 00:09 github-actions[bot]