feat(data-access): add readAll capability to Consumer.CAPABILITIES

[ravverma]

Adds 'readAll' as a valid action in Consumer.CAPABILITIES, enabling capability strings of the form <entity>:readAll (e.g. site:readAll, organization:readAll) to pass ConsumerCollection.validateCapabilities.

This is the shared-lib half of the S2S readAll capability rollout. The api-service consumes this in a follow-up PR to remap GET /sites and GET /organizations from <entity>:read to <entity>:readAll, allowing platform-level S2S consumers to enumerate sites/organizations across tenants without weakening tenant isolation on per-resource operations.

See docs/s2s/READALL_CAPABILITY_DESIGN.md (in adobe/spacecat-api-service) for the full design and trust-boundary analysis.

Please ensure your pull request adheres to the following guidelines:

• make sure to link the related issues in this description
• when merging / squashing, make sure the fixed issue references are visible in the commits, for easy compilation of release notes

Related Issues

Thanks for contributing!

[solaris007]

Hey @ravverma,

Clean, minimal change - this is the right scope for step 1 of the readAll rollout. A couple of minor suggestions.

Strengths

• Correctly scoped to the shared library's responsibility: adds the schema-valid action, nothing more. The route-level and controller-level enforcement stays in spacecat-api-service where it belongs.
• Existing validation chain is preserved: the "throws ValidationError for unknown entity in capability" test still exercises the entity-must-be-known guard. Adding readAll to CAPABILITIES does not loosen entity validation.
• Model unit test updated to assert the new CAPABILITIES shape. Collection integration test exercises the positive path with site:readAll and organization:readAll.

Issues

Minor (Nice to Have)

Test name does not match test content
consumer.collection.test.js - new test case

The test is titled "accepts the readAll action for any registered entity" but only exercises site:readAll and organization:readAll. The title claims generality ("any registered entity") that the test body does not deliver. A reader might conclude all entities were tested when only two were. Either rename to "accepts site:readAll and organization:readAll capabilities" or extend with additional entities (audit:readAll, opportunity:readAll) to match the title.

---

Weak result assertion
consumer.collection.test.js - new test case

expect(result).to.not.be.null is the only assertion on the result. It does not verify that the readAll capability strings survived validation and reached the create call. Compare with the sibling test for existing capabilities, which may assert more about the returned consumer shape. Consider at minimum asserting that mockElectroService.entities.consumer.create was called (i.e. validation did not reject).

Recommendations

• Add a brief JSDoc comment on the CAPABILITIES array explaining the semantic difference between the verb-actions (read, write, delete) and the scope+verb hybrid (readAll). A future reader encountering this array will not know that readAll conflates action and scope without reading a design doc in a different repo. One line is enough: "readAll is a scope+verb hybrid - see the S2S readAll design in mysticat-architecture.".
• Consider adding a comment near the CAPABILITIES constant noting the design's off-ramp: "If 5+ entities adopt readAll, revisit in favor of a policy engine." This keeps the threshold visible to developers who might extend the list.

Assessment

Ready to merge? Yes

The change is minimal, correct per the design, and adequately tested. The minor suggestions above improve clarity but are not blockers. Once this merges and releases, spacecat-api-service PR 2305 can revert its dependency from the personal gist URL back to the npm registry.

[solaris007]

Approving with two small asks:

1. Add a brief JSDoc on Consumer.CAPABILITIES (consumer.model.js:54) explaining that readAll is a scope+verb hybrid, currently meaningful only on routes that opt in (site and organization). Schema validity does not imply a reachable route. This is the one place a future maintainer could be misled.

2. In the new collection test ("accepts the readAll action..."), add expect(mockElectroService.entities.consumer.create).to.have.been.calledOnce to match the sibling happy-path assertion strength. Currently the test only proves "no exception thrown", not "validation passed and create was called". Also consider renaming the test to "accepts site:readAll and organization:readAll capabilities" since it only exercises those two.

Neither blocks the release - ship once folded in.

[github-actions]

This PR will trigger a minor release when merged.

[ravverma]

Thanks @solaris007 for review

All 1905 tests pass. Here's a summary of the three changes made to address the reviewer's asks:

1. consumer.model.js:54 — Added a JSDoc comment on CAPABILITIES explaining that readAll is a scope+verb hybrid, currently only meaningful on routes that opt in (site and organization), and that schema validity doesn't imply a reachable route.

2. consumer.collection.test.js — Renamed the test from "accepts the readAll action for any registered entity" → "accepts site:readAll and organization:readAll capabilities" to accurately reflect what's actually exercised.

3. consumer.collection.test.js — Added expect(mockElectroService.entities.consumer.create).to.have.been.calledOnce to assert that validation passed and create was actually invoked, matching the assertion strength of the sibling happy-path test.

[solaris007]

🎉 This PR is included in version @adobe/spacecat-shared-data-access-v3.56.0 🎉

The release is available on:

• npm package (@latest dist-tag)
• GitHub release

Your semantic-release bot 📦🚀