feat(js): add supportsStreamedListObjects config flag support #665

daniel-jonathan · 2025-11-19T22:54:01Z

Add supportsStreamedListObjects Config Flag Support for JS SDK

Problem

The JS SDK generator always builds with streaming support enabled, ignoring any potential configuration flag. This is inconsistent with the dotnet SDK approach and provides no flexibility to disable streaming during development.

The Makefile unconditionally calls build-client-streamed for JS SDK:

.PHONY: build-client-js
build-client-js:
	make build-client-streamed sdk_language=js tmpdir=${TMP_DIR}

Solution

Apply the same conditional streaming support pattern implemented for dotnet SDK to the JS SDK.

Changes

1. config/clients/js/config.overrides.json

Added supportsStreamedListObjects flag:

{
  ...
  "enumNameSuffix": "",
  "supportsStreamedListObjects": false,
  "files": {
    ...
  }
}

Default: false (streaming disabled until implementation is merged)

2. Makefile

Updated build-client-js to conditionally build based on flag:

.PHONY: build-client-js
build-client-js:
	@if grep -q '"supportsStreamedListObjects": true' config/clients/js/config.overrides.json; then \
		echo "Building JS SDK with streaming support..."; \
		make build-client-streamed sdk_language=js tmpdir=${TMP_DIR}; \
	else \
		echo "Building JS SDK without streaming support..."; \
		make build-client-non-streamed sdk_language=js tmpdir=${TMP_DIR}; \
	fi
	sed -i -e "s|_this|this|g" ${CLIENTS_OUTPUT_DIR}/fga-js-sdk/*.ts
	sed -i -e "s|_this|this|g" ${CLIENTS_OUTPUT_DIR}/fga-js-sdk/*.md

Result

The flag now works correctly for JS SDK:

With flag = false (current default):

$ make build-client-js
Building JS SDK without streaming support...
# Streaming endpoint removed from generated SDK

With flag = true (when streaming is ready):

$ make build-client-js
Building JS SDK with streaming support...
# Streaming endpoint included in generated SDK

Cross-SDK Consistency

SDK	Has Flag	Conditional Build	Default
Dotnet	Yes	Yes	`false`
JS	Yes	Yes	`false`
Python	Yes (method name)	N/A	Enabled

Both dotnet and JS now follow the same pattern for streaming support configuration.

Testing

Verified that:

JS SDK builds successfully with flag = true
Conditional logic correctly routes to streamed/non-streamed build targets
Matches dotnet SDK behavior

Impact

This change:

Provides consistency across SDK generators
Allows independent control of streaming support per SDK
Enables cleaner development workflow (can disable streaming until ready)
Follows the established pattern from dotnet SDK

Files Modified

Makefile
config/clients/js/config.overrides.json

Related PRs

Dotnet streaming flag support: fix(dotnet): make Makefile respect supportsStreamedListObjects config… #662
JS streaming implementation: feat: add streamedListObjects for unlimited object retrieval js-sdk#280

Summary by CodeRabbit

Chores
- Build process updated to conditionally select between client implementation variants at build time based on configuration settings.
New Features
- Added new configuration property to control streaming support for the JavaScript client.

_{✏️ Tip: You can customize this high-level summary in your review settings.}

Apply the same conditional streaming support to JS SDK that was implemented for dotnet SDK. Changes: - Add supportsStreamedListObjects flag to JS config (default: false) - Update build-client-js to conditionally use streamed/non-streamed build - Matches dotnet SDK pattern for consistency Both dotnet and JS SDKs now respect the supportsStreamedListObjects flag: - When true: generates streaming endpoint - When false: removes streaming endpoint from spec This provides flexibility to enable/disable streaming per SDK independently during development. Default is false until streaming implementation is merged.

coderabbitai · 2025-11-19T22:54:12Z

Walkthrough

The JavaScript SDK build process now includes runtime configuration-based selection between streaming and non-streaming client implementations. A new supportsStreamedListObjects flag (set to false) is introduced in the configuration, and the Makefile conditionally selects the appropriate build target based on this flag's value.

Changes

Cohort / File(s)	Summary
Build Configuration `Makefile`	Modified `build-client-js` target to inspect `config/clients/js/config.overrides.json` for `supportsStreamedListObjects` flag and conditionally execute `build-client-streamed` or `build-client-non-streamed` target accordingly
Client Configuration `config/clients/js/config.overrides.json`	Added new boolean property `supportsStreamedListObjects` set to `false` at root level

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

The conditional logic in the Makefile is straightforward and follows a simple if-then-else pattern based on a JSON property check
Configuration change is minimal and non-breaking (new flag with default value)

Possibly related PRs

feat(dotnet): use build-client-streamed for .NET SDK #659: Applies the same runtime selection pattern to the .NET SDK build target
fix(dotnet): make Makefile respect supportsStreamedListObjects config… #662: Implements identical Makefile change pattern with config flag for different SDK languages
feat(js): use build-client-streamed for JS SDK #657: Modifies the build-client-js target similarly but with a hardcoded approach rather than runtime selection

Suggested reviewers

rhamzeh
SoulPancake

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title clearly and specifically describes the main change: adding a new configuration flag 'supportsStreamedListObjects' to the JS SDK generator.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✨ Finishing touches

🧪 Generate unit tests (beta)

Create PR with unit tests
Post copyable unit tests in a comment
Commit unit tests in branch feat/js-streaming-flag-support

📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 5c3efea and 7fac64b.

📒 Files selected for processing (2)

Makefile (1 hunks)
config/clients/js/config.overrides.json (1 hunks)

🧰 Additional context used

📓 Path-based instructions (4)

Makefile

📄 CodeRabbit inference engine (.github/copilot-instructions.md)

Makefile: Update OPEN_API_REF in the Makefile when targeting new OpenFGA API versions
Update Docker image tags in the Makefile when upgrading build tools
Use official, tagged Docker images for containerized builds

Files:

Makefile

config/clients/*/config.overrides.json

📄 CodeRabbit inference engine (.github/copilot-instructions.md)

config/clients/*/config.overrides.json: Always update the packageVersion in each language-specific config.overrides.json when making version changes
Maintain FOSSA compliance notice IDs in each language’s config.overrides.json

Files:

config/clients/js/config.overrides.json

config/**/*.{json,mustache}

📄 CodeRabbit inference engine (.github/copilot-instructions.md)

Never hardcode API keys or credentials in configuration or template files

Files:

config/clients/js/config.overrides.json

config/{common/config.base.json,clients/*/config.overrides.json}

📄 CodeRabbit inference engine (.github/copilot-instructions.md)

Ensure consistent versioning across base and language override configuration files to avoid version conflicts

Files:

config/clients/js/config.overrides.json

🧠 Learnings (5)