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

fix(client-presence): Rename ISessionClient so that function/property naming is consistent #22889

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

WillieHabi
Copy link
Contributor

@WillieHabi WillieHabi commented Oct 24, 2024

Description

ISessionClient functions/properties must be consistent. From what I can gather from API naming discussion, getStatus and getClientConnectionId is the preferred naming.

the status and the connectionId of session clients can change in between calls, so having a get function makes sense (even though implementation does not "do work" to give the response).

@github-actions github-actions bot added area: framework Framework is a tag for issues involving the developer framework. Eg Aqueduct public api change Changes to a public API base: main PRs targeted against main branch labels Oct 24, 2024
Copy link
Collaborator

@msfluid-bot msfluid-bot left a comment

Choose a reason for hiding this comment

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

Code Coverage Summary

No packages impacted by the change.


Baseline commit: ff6a3bf
Baseline build: 302399
Happy Coding!!

Code coverage comparison check passed!!

@msfluid-bot
Copy link
Collaborator

msfluid-bot commented Oct 24, 2024

@fluid-example/bundle-size-tests: +245 Bytes
Metric NameBaseline SizeCompare SizeSize Diff
aqueduct.js 459.85 KB 459.89 KB +35 Bytes
azureClient.js 557 KB 557.04 KB +49 Bytes
connectionState.js 724 Bytes 724 Bytes No change
containerRuntime.js 259.47 KB 259.48 KB +14 Bytes
fluidFramework.js 405.97 KB 405.98 KB +14 Bytes
loader.js 134.16 KB 134.18 KB +14 Bytes
map.js 42.46 KB 42.46 KB +7 Bytes
matrix.js 148.29 KB 148.29 KB +7 Bytes
odspClient.js 523.96 KB 524 KB +49 Bytes
odspDriver.js 97.84 KB 97.86 KB +21 Bytes
odspPrefetchSnapshot.js 42.81 KB 42.82 KB +14 Bytes
sharedString.js 164.48 KB 164.49 KB +7 Bytes
sharedTree.js 396.43 KB 396.43 KB +7 Bytes
Total Size 3.31 MB 3.31 MB +245 Bytes

Baseline commit: ff6a3bf

Generated by 🚫 dangerJS against 55477c4

@github-actions github-actions bot added the area: examples Changes that focus on our examples label Oct 24, 2024
Copy link
Contributor

🔗 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:
  435188 links
    3358 destination URLs
       2 URLs ignored
       0 warnings
       0 errors


@WillieHabi WillieHabi marked this pull request as ready for review October 24, 2024 22:05
@WillieHabi WillieHabi changed the title fix(client-presence): Rename ISessionClient.getStatus() to ISessionClient.status() fix(client-presence): Rename ISessionClient so that function/property naming is consistent Oct 25, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area: examples Changes that focus on our examples area: framework Framework is a tag for issues involving the developer framework. Eg Aqueduct base: main PRs targeted against main branch public api change Changes to a public API
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants