enhance: delegate.getEntities() returns restricted EntitiesInterface

[ntucker]

Follow-up to #3468

Motivation

Exposing the full entities data structure is potentially unsafe, and has unbounced interface implications for its implementation.

Restrict exposed surface area to looping behavior.

Solution

Return value is a restricted interface with keys() and entries() iterator methods.
Update both IQueryDelegate, and INormalizeDelegate as we try to match their interfaces as much as possible.

const entities = delegate.getEntities(key);

// foreach on keys
for (const key of entities.keys()) {}
// Object.keys() (convert to array)
return [...entities.keys()];
// foreach on full entry
for (const [key, entity] of entities.entries()) {}

Before

const entities = delegate.getEntity(this.key);
if (entities)
  Object.keys(entities).forEach(collectionPk => {
    if (!filterCollections(JSON.parse(collectionPk))) return;
    delegate.mergeEntity(this, collectionPk, normalizedValue);
  });

After

const entities = delegate.getEntities(this.key);
if (entities)
  for (const collectionKey of entities.keys()) {
    if (!filterCollections(JSON.parse(collectionKey))) continue;
    delegate.mergeEntity(this, collectionKey, normalizedValue);
  }

500% performance improvement in schema.All().buildQueryKey

[changeset-bot]

🦋 Changeset detected

Latest commit: 905ec19

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 13 packages

Name	Type
@data-client/normalizr	Minor
@data-client/endpoint	Minor
@data-client/core	Minor
example-benchmark	Patch
normalizr-github-example	Patch
normalizr-redux-example	Patch
normalizr-relationships	Patch
@data-client/graphql	Minor
@data-client/img	Minor
@data-client/rest	Minor
@data-client/react	Minor
test-bundlesize	Patch
coinbase-lite	Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

[github-actions]

Size Change: +90 B (+0.12%)

Total Size: 77.7 kB

Filename	Size	Change
examples/test-bundlesize/dist/rdcClient.js	10.1 kB	+85 B (+0.85%)

ℹ️ View Unchanged

Filename	Size	Change
examples/test-bundlesize/dist/App.js	3.42 kB	0 B
examples/test-bundlesize/dist/polyfill.js	311 B	0 B
examples/test-bundlesize/dist/rdcEndpoint.js	5.61 kB	+5 B (+0.09%)
examples/test-bundlesize/dist/react.js	57.5 kB	0 B
examples/test-bundlesize/dist/webpack-runtime.js	726 B	0 B

_{compressed-size-action}

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 98.76%. Comparing base (ac05f9d) to head (905ec19).
Report is 1 commits behind head on master.

Additional details and impacted files

@@           Coverage Diff           @@
##           master    #3501   +/-   ##
=======================================
  Coverage   98.75%   98.76%           
=======================================
  Files         130      130           
  Lines        2255     2265   +10     
  Branches      456      457    +1     
=======================================
+ Hits         2227     2237   +10     
  Misses         13       13           
  Partials       15       15           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
• 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

[github-actions]

Benchmark

Benchmark suite	Current: 905ec19	Previous: ac05f9d	Ratio
normalizeLong	523 ops/sec (±1.68%)	509 ops/sec (±1.69%)	0.97
denormalizeLong	291 ops/sec (±2.62%)	272 ops/sec (±2.85%)	0.93
denormalizeLong donotcache	1048 ops/sec (±1.37%)	1049 ops/sec (±1.51%)	1.00
denormalizeShort donotcache 500x	1607 ops/sec (±0.29%)	1592 ops/sec (±0.38%)	0.99
denormalizeShort 500x	869 ops/sec (±1.78%)	818 ops/sec (±2.32%)	0.94
denormalizeShort 500x withCache	6112 ops/sec (±0.31%)	6006 ops/sec (±0.16%)	0.98
queryShort 500x withCache	2803 ops/sec (±0.19%)	2767 ops/sec (±0.54%)	0.99
infer All	53057 ops/sec (±0.40%)	9936 ops/sec (±0.57%)	0.19
query All withCache	6898 ops/sec (±0.31%)	7584 ops/sec (±0.42%)	1.10
denormalizeLong with mixin Entity	368 ops/sec (±0.39%)	270 ops/sec (±2.12%)	0.73
denormalizeLong withCache	7747 ops/sec (±0.43%)	8181 ops/sec (±0.64%)	1.06
denormalizeLong All withCache	6985 ops/sec (±0.26%)	7652 ops/sec (±0.26%)	1.10
denormalizeLong Query-sorted withCache	6936 ops/sec (±0.16%)	7648 ops/sec (±0.30%)	1.10
denormalizeLongAndShort withEntityCacheOnly	1835 ops/sec (±0.30%)	1787 ops/sec (±0.34%)	0.97
getResponse	5794 ops/sec (±1.34%)	5582 ops/sec (±1.58%)	0.96
getResponse (null)	7072872 ops/sec (±0.78%)	7051115 ops/sec (±0.70%)	1.00
getResponse (clear cache)	355 ops/sec (±0.60%)	264 ops/sec (±2.37%)	0.74
getSmallResponse	3104 ops/sec (±0.48%)	3030 ops/sec (±0.15%)	0.98
getSmallInferredResponse	2344 ops/sec (±0.23%)	2315 ops/sec (±0.40%)	0.99
getResponse Collection	5666 ops/sec (±0.88%)	5671 ops/sec (±1.59%)	1.00
get Collection	5478 ops/sec (±0.34%)	5777 ops/sec (±0.51%)	1.05
get Query-sorted	5772 ops/sec (±0.26%)	6587 ops/sec (±0.39%)	1.14
setLong	533 ops/sec (±0.50%)	549 ops/sec (±0.28%)	1.03
setLongWithMerge	244 ops/sec (±0.28%)	244 ops/sec (±0.31%)	1
setLongWithSimpleMerge	260 ops/sec (±0.27%)	258 ops/sec (±0.51%)	0.99
setSmallResponse 500x	951 ops/sec (±0.18%)	953 ops/sec (±0.35%)	1.00

This comment was automatically generated by workflow using github-action-benchmark.

[Copilot]

Pull Request Overview

This PR restricts the exposed entities API by replacing the raw entity object with a restricted interface (EntitiesInterface) containing keys() and entries() iterator methods. Key changes include:

• Updating interface definitions and delegate methods to return EntitiesInterface.
• Adjusting implementation in both mutable and immutable delegates.
• Revising tests and documentation to reflect the new API.

Reviewed Changes

Copilot reviewed 17 out of 17 changed files in this pull request and generated 1 comment.

Show a summary per file

File	Description
packages/normalizr/src/memo/MemoCache.ts	Removed obsolete inline getDependency function
packages/normalizr/src/interface.ts	Replaced GetEntities with the new EntitiesInterface
packages/normalizr/src/delegate/Delegate.ts	Updated getEntities implementation to return EntitiesInterface
packages/normalizr/src/delegate/Delegate.imm.ts	Adjusted getEntities to support immutable structures
packages/normalizr/src/delegate/BaseDelegate.ts	Modified abstract getEntities signature and dependency mapping
packages/endpoint/src/schemas/tests/Object.test.js	Removed unused helper function and unused Map import
packages/endpoint/src/schemas/tests/All.test.ts	Adjusted test setup for using string keys and immutable updates
packages/endpoint/src/schemas/Collection.ts	Updated iteration to use EntitiesInterface.keys() instead of Object.keys()
packages/endpoint/src/schemas/All.ts	Modified queryKey and flatMap logic to work with the new API
packages/endpoint/src/interface.ts	Updated IQueryDelegate and INormalizeDelegate to use EntitiesInterface
.changeset/proud-taxes-bake.md	Updated changelog and usage examples for the new getEntities API

Comments suppressed due to low confidence (1)

packages/normalizr/src/delegate/BaseDelegate.ts:60

• [nitpick] Dynamic method selection using array indexing based on path.length is non-intuitive and error-prone; consider a more explicit mapping or safeguard for unexpected path lengths.

delegate[['', 'getEntitiesObject', 'getEntity', 'getIndex'][path.length]](...path)

[Copilot]

[nitpick] Avoid using 'as any' casts; consider explicitly typing the iterator as IterableIterator to improve clarity and maintainability.

Suggested change

	return Object.keys(entities) as any;
	return Object.keys(entities).values();