fix(client-presence): [BREAKING CHANGE] LatestMap keys limited to strings

[jason-ha]

Remove number as a possible type for LatestMap keys. All given keys are stored as string record entries at runtime and thus numbers become keys. To use "number" keys, string pattern ${number} can be used for the type.

Add keyValidator to support enabling consumers to only work with validated keys. A keyValidator is recommended anytime Keys type is not string.

[tylerbutler]

If I understand correctly, there's no way for a user to access or enumerate keys for which the validator returns undefined. I can understand this behavior for iteration, but it seems odd that .get(invalidKey) is the same as .get(missingKey). In practice maybe that distinction doesn't matter much.

[jason-ha]

If I understand correctly, there's no way for a user to access or enumerate keys for which the validator returns undefined. I can understand this behavior for iteration, but it seems odd that .get(invalidKey) is the same as .get(missingKey). In practice maybe that distinction doesn't matter much.

Good question. With a keyValidator, the difference would be that the keyValidator would be invoked. So, it could be written to snoop whether something was invalid or missing.
I think we'll need to see if there is desire for something nicer.

[tylerbutler]

LGTM.

[Copilot]

Pull request overview

This PR introduces a breaking change to the LatestMap API by restricting keys to string type only, removing support for number keys. Since keys are stored as strings at runtime, this change clarifies the actual behavior. Additionally, it adds a keyValidator option to enable runtime validation of custom key types.

Key Changes

• Removed number from the Keys type parameter constraint across all LatestMap interfaces and types
• Added KeySchemaValidator<Keys> type and keyValidator optional parameter to LatestMapArguments
• Implemented key validation logic in getRemote() and update() methods to filter out invalid keys
• Added comprehensive test coverage for the new keyValidator functionality

Reviewed changes

Copilot reviewed 11 out of 11 changed files in this pull request and generated 4 comments.

Show a summary per file

File	Description
packages/framework/presence/src/latestMapValueManager.ts	Main implementation: removed number from Keys constraint, added KeySchemaValidator type, implemented key validation in getRemote and update methods
packages/framework/presence/src/exposedInternalTypes.ts	Updated MapValueState interface to constrain Keys to string only
packages/framework/presence/src/index.ts	Exported the new KeySchemaValidator type
packages/framework/presence/src/stateDatastore.ts	Renamed generic parameter from TUpdateValue to TLocalUpdateValue for clarity
packages/framework/presence/src/internalTypes.ts	Added documentation for the update method in ValueManager interface
packages/framework/presence/src/test/schemaValidation/valueManagers.spec.ts	Added comprehensive tests for keyValidator including validation behavior, event handling for invalid keys, and iterator behavior
packages/framework/presence/src/test/latestMapValueManager.spec.ts	Updated type parameters to use template literal type instead of number
packages/service-clients/end-to-end-tests/azure-client/src/test/multiprocess/childClient.tool.ts	Removed second type parameter from LatestMap type annotations
packages/framework/presence/api-report/presence.legacy.alpha.api.md	Updated API surface to reflect breaking changes
packages/framework/presence/api-report/presence.beta.api.md	Updated API surface to reflect breaking changes
.changeset/modern-candies-clean.md	Documented the breaking change with appropriate section marker

[github-actions]

🔗 No broken links found! ✅

Your attention to detail is admirable.

linkcheck output

> fluid-framework-docs-site@0.0.0 ci:check-links /home/runner/work/FluidFramework/FluidFramework/docs
> start-server-and-test "npm run serve -- --no-open" 3000 check-links

1: starting server using command "npm run serve -- --no-open"
and when url "[ 'http://127.0.0.1:3000' ]" is responding with HTTP status code 200
running tests using command "npm run check-links"


> fluid-framework-docs-site@0.0.0 serve
> docusaurus serve --no-open

[SUCCESS] Serving "build" directory at: http://localhost:3000/

> fluid-framework-docs-site@0.0.0 check-links
> linkcheck http://localhost:3000 --skip-file skipped-urls.txt

Crawling...

Stats:
  245432 links
    1786 destination URLs
    2025 URLs ignored
       0 warnings
       0 errors