Skip to content

chore: bump example deps & point to parent SDK rather than published#403

Merged
rhamzeh merged 1 commit into
mainfrom
chore/bump-examples
May 7, 2026
Merged

chore: bump example deps & point to parent SDK rather than published#403
rhamzeh merged 1 commit into
mainfrom
chore/bump-examples

Conversation

@rhamzeh

@rhamzeh rhamzeh commented May 7, 2026

Copy link
Copy Markdown
Member

Description

What problem is being solved?

How is it being solved?

What changes are made to solve it?

References

Review Checklist

  • I have clicked on "allow edits by maintainers".
  • I have added documentation for new/changed functionality in this PR or in a PR to openfga.dev [Provide a link to any relevant PRs in the references section above]
  • The correct base branch is being used, if not main
  • I have added tests to validate that the change in functionality is working as expected

Summary by CodeRabbit

  • Chores
    • Updated minimum Node.js engine requirement to 20.19.0 across example projects
    • Updated OpenTelemetry suite and utility dependencies to newer versions

Copilot AI review requested due to automatic review settings May 7, 2026 20:52
@rhamzeh
rhamzeh requested a review from a team as a code owner May 7, 2026 20:52
@coderabbitai

coderabbitai Bot commented May 7, 2026

Copy link
Copy Markdown

Review Change Stack
No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: d29e0584-c3e8-4cf8-bdf0-4c630ad6c719

📥 Commits

Reviewing files that changed from the base of the PR and between 8ed8704 and 73204cc.

⛔ Files ignored due to path filters (1)
  • example/streamed-list-objects/package-lock.json is excluded by !**/package-lock.json
📒 Files selected for processing (4)
  • example/api-executor/package.json
  • example/example1/package.json
  • example/opentelemetry/package.json
  • example/streamed-list-objects/package.json

Walkthrough

This PR updates four example package.json files to require Node.js 20.19.0 as the minimum runtime version, switches two examples to use a local workspace reference for @openfga/sdk, and upgrades published dependencies in the OpenTelemetry example to newer major and minor versions.

Changes

Example Package Configuration Updates

Layer / File(s) Summary
Node.js Engine Requirements
example/api-executor/package.json, example/example1/package.json, example/opentelemetry/package.json, example/streamed-list-objects/package.json
Node.js minimum version is raised from 16.13.0–16.15.0 to 20.19.0 across all four examples.
Workspace Dependencies
example/example1/package.json, example/streamed-list-objects/package.json
@openfga/sdk is switched from published semver versions to local file references (file:../..). @openfga/syntax-transformer is bumped from ^0.2.0 to ^0.2.1 in streamed-list-objects.
Published Dependency Updates
example/opentelemetry/package.json
OpenTelemetry exporter/SDK packages (exporter-metrics-otlp-proto, exporter-prometheus, sdk-metrics, sdk-node) are bumped to ^0.217.0 or ^2.7.1, and dotenv is upgraded from ^16.4.7 to ^17.4.2.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Possibly related PRs

  • openfga/js-sdk#365: Both PRs modify example/example1/package.json's @openfga/sdk dependency; the retrieved PR performs a released version bump while this PR switches to a local file reference.

Suggested reviewers

  • emilic
  • SoulPancake
🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly and accurately summarizes the main changes: bumping example dependencies and pointing examples to the parent SDK instead of published packages.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch chore/bump-examples

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@socket-security

Copy link
Copy Markdown

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Pull request overview

Updates the repository’s runnable examples to align with the current SDK/runtime expectations by pointing examples at the local workspace SDK and refreshing dependency/runtime constraints.

Changes:

  • Switches example projects to depend on the local parent @openfga/sdk via file: instead of a published semver range (where applicable).
  • Bumps example dependency versions (notably OpenTelemetry and syntax-transformer).
  • Raises example engines.node requirements to >=20.19.0 and removes an example package-lock.json.

Reviewed changes

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

Show a summary per file
File Description
example/streamed-list-objects/package.json Uses local SDK via file: and bumps syntax-transformer + Node engine requirement.
example/streamed-list-objects/package-lock.json Removes committed lockfile for the example.
example/opentelemetry/package.json Updates OpenTelemetry/dotenv deps and aligns Node engine requirement.
example/example1/package.json Switches SDK dependency to local file: and aligns Node engine requirement.
example/api-executor/package.json Aligns Node engine requirement with repo runtime baseline.
Files not reviewed (1)
  • example/streamed-list-objects/package-lock.json: Language not supported

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread example/api-executor/package.json
Comment thread example/example1/package.json
Comment thread example/example1/package.json
Comment thread example/streamed-list-objects/package.json
@rhamzeh
rhamzeh enabled auto-merge May 7, 2026 21:05
@rhamzeh
rhamzeh added this pull request to the merge queue May 7, 2026
Merged via the queue into main with commit e6e5854 May 7, 2026
10 checks passed
@rhamzeh
rhamzeh deleted the chore/bump-examples branch May 7, 2026 21:17
@ewanharris ewanharris mentioned this pull request May 11, 2026
4 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants