Skip to content

Upgrade local dev to use electric beta.15 #1699

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Feb 13, 2025
Merged

Upgrade local dev to use electric beta.15 #1699

merged 1 commit into from
Feb 13, 2025

Conversation

ericallam
Copy link
Member

@ericallam ericallam commented Feb 12, 2025

Summary by CodeRabbit

  • Chores
    • Upgraded the underlying Electric SQL container image to a more recent beta release for enhanced stability.
  • Refactor
    • Streamlined token handling during task triggers by directly assigning access credentials, simplifying the overall process.

Copy link

changeset-bot bot commented Feb 12, 2025

⚠️ No Changeset found

Latest commit: 3be6c6a

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

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

Copy link
Contributor

coderabbitai bot commented Feb 12, 2025

Walkthrough

The changes update the Redis configuration in test cases to use an explicit object with host, port, and a tlsDisabled flag. The Electric SQL Docker image version is upgraded in both the Docker Compose file and the container initialization utility. In addition, the token management in the task-triggering functions is streamlined to directly use the public access token from the task handle, removing an intermediate public token creation step.

Changes

File(s) Summary
apps/webapp/test/realtimeClient.test.ts Updated Redis configuration in tests to explicitly define host, port, and tlsDisabled instead of using redis.options.
docker/docker-compose.yml, internal-packages/.../utils.ts Upgraded Electric SQL Docker image from beta.1 to beta.15, updating image references in both service configuration and container initialization.
references/.../actions.ts Modified token handling in task triggers to set the JWT cookie directly using handle.publicAccessToken, removing the intermediate public token creation.

Sequence Diagram(s)

sequenceDiagram
    participant Client
    participant Server
    participant TaskHandler

    Client->>Server: Trigger example task
    Server->>TaskHandler: Execute tasks.trigger()
    TaskHandler-->>Server: Return handle with publicAccessToken
    Server-->>Client: Set cookie using publicAccessToken
Loading

Possibly related PRs

Poem

I'm a rabbit of code, hopping light and free,
Redis now tells its host and port with clarity.
Docker images leap from beta one to fifteen—
Token flows now glide, simpler than they've been seen.
With every line I nibble, my code garden grows,
Celebrating fresh changes wherever the wind blows! 🐇

Warning

There were issues while running some tools. Please review the errors and either fix the tool’s configuration or disable the tool if it’s a critical failure.

🔧 ESLint

If the error stems from missing dependencies, add them to the package.json file. For unrecoverable errors (e.g., due to private dependencies), disable the tool in the CodeRabbit configuration.

internal-packages/testcontainers/src/utils.ts

Oops! Something went wrong! :(

ESLint: 8.45.0

ESLint couldn't find the config "custom" to extend from. Please check that the name of the config is correct.

The config "custom" was referenced from the config file in "/.eslintrc.js".

If you still have problems, please stop by https://eslint.org/chat/help to chat with the team.

references/nextjs-realtime/src/app/actions.ts

Oops! Something went wrong! :(

ESLint: 8.45.0

ESLint couldn't find the config "custom" to extend from. Please check that the name of the config is correct.

The config "custom" was referenced from the config file in "/.eslintrc.js".

If you still have problems, please stop by https://eslint.org/chat/help to chat with the team.

apps/webapp/test/realtimeClient.test.ts

Oops! Something went wrong! :(

ESLint: 8.45.0

ESLint couldn't find the config "custom" to extend from. Please check that the name of the config is correct.

The config "custom" was referenced from the config file in "/.eslintrc.js".

If you still have problems, please stop by https://eslint.org/chat/help to chat with the team.

✨ Finishing Touches
  • 📝 Generate Docstrings (Beta)

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR. (Beta)
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

🧹 Nitpick comments (1)
apps/webapp/test/realtimeClient.test.ts (1)

13-17: LGTM! Redis configuration is now more explicit.

Breaking down the Redis configuration into explicit properties improves clarity and maintainability.

Consider adding a comment about TLS being disabled.

While disabling TLS is appropriate for local development/testing, it would be good to add a comment explaining this to prevent confusion.

 redis: {
   host: redis.options.host,
   port: redis.options.port,
+  // TLS disabled for local development/testing only
   tlsDisabled: true,
 },

Also applies to: 153-157, 236-240

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between d622aba and 3be6c6a.

📒 Files selected for processing (4)
  • apps/webapp/test/realtimeClient.test.ts (3 hunks)
  • docker/docker-compose.yml (1 hunks)
  • internal-packages/testcontainers/src/utils.ts (1 hunks)
  • references/nextjs-realtime/src/app/actions.ts (1 hunks)
✅ Files skipped from review due to trivial changes (1)
  • internal-packages/testcontainers/src/utils.ts
🔇 Additional comments (2)
docker/docker-compose.yml (1)

143-143: Verify the stability of Electric SQL beta.15.

The upgrade from beta.1 to beta.15 is a significant version jump that might introduce breaking changes.

❌ Verification inconclusive

🌐 Web query:

What are the breaking changes in ElectricSQL 1.0.0-beta.15 compared to beta.1?

Error during web search


Action required: Manually verify ElectricSQL beta.15 stability.

The web query to determine breaking changes in ElectricSQL 1.0.0-beta.15 returned an error. Given the significant version jump from beta.1 to beta.15, please review the official release notes or documentation for ElectricSQL and confirm with the vendor about potential breaking changes that could affect your deployment.

  • Check the ElectricSQL documentation/release notes for beta.15-specific changes.
  • Confirm stability and any breaking changes with the vendor or trusted community channels.
references/nextjs-realtime/src/app/actions.ts (1)

15-15: LGTM! Token management simplified.

The direct use of handle.publicAccessToken reduces complexity by eliminating the intermediate token creation step.

@ericallam ericallam merged commit a2c70b4 into main Feb 13, 2025
11 checks passed
@ericallam ericallam deleted the electric-beta-15 branch February 13, 2025 11:02
samejr added a commit that referenced this pull request Feb 13, 2025
* Uses image cards for the frameworks

* Removes old snippets

* New AI agents side menu section

* WIP adding new ai agent pages

* Better overview page

* More copy added to the agent example pages

* Copy improvements

* Removes “Creating a project” page and side menu section

* Fixes broken links

* Updates to the latest Mintlify version, fixes issues, changes theme

* Adds descriptions to the main dropdown menu items

* Reformatted Introduction docs ‘landing page’

* Retry heartbeat timeouts by putting back in the queue (#1689)

* If there’s a heartbeat error and no attempts we put it back in the queue to try again

* When nacking, return whether it was put back in the queue or not

* Try and nack, if it fails then fail the run

* Consolidated switch statement

* Fail executing/retrying runs

* OOM retrying on larger machines (#1691)

* OOM retrying on larger machines

* Create forty-windows-shop.md

* Update forty-windows-shop.md

* Only retry again if the machine is different from the original

* Kubernetes OOMs appear as non-zero sigkills, adding support for treating these as OOMs

* Complete the original attempt span if retrying due to an OOM

* Revert "Complete the original attempt span if retrying due to an OOM"

This reverts commit 5f652c6.

* chore: Update version for release (#1666)

Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>

* Release 3.3.14

* Set machine when triggering docs

* Batch queue runs that are waiting for deploy (#1693)

* Detect ffmpeg OOM errors, added manual OutOfMemoryError (#1694)

* Detect ffmpeg OOM errors, added manual OutOfMemoryError

* Create eighty-spies-knock.md

* Improved the machines docs, including the new OutOfMemoryError

* chore: Update version for release (#1695)

Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>

* Release 3.3.15

* Create new partitioned TaskEvent table, and switch to it gradually as new runs are created (#1696)

* Create new partitioned TaskEvent table, and switch to it gradually as new runs are created

* Add env var for partition window in seconds

* Make startCreatedAt required in task event store

* Don't create an attempt if the run is final, batchTriggerAndWait bad continue fix (#1698)

* WIP fix for ResumeAttemptService selecting the wrong attempt (which has no error or output)

* Don’t create an attempt if the run is already in a final status

* Don’t get all the columns for the query. Improved the logging.

* Added a log to the batch example

* Filter out the undefined values

* Fix missing logs on child runs by using the root task run createdAt if it exists (#1697)

* Provider changes to support image cache (#1700)

* add env var for additional pull secrets

* make static images configurable

* optional image prefixes

* optional labels with sample rates

* add missing core paths

* remove excessive logs

* Fix run container exits after OOM retries (#1701)

* remove unused imports

* tell run to exit before force requeue

* handle exit for case where we already retried after oom

* improve retry span and add machine props

* don't try to exit run in dev

* Upgrade local dev to use electric beta.15 (#1699)

* Text fixes

* Removed pnpm files

---------

Co-authored-by: Matt Aitken <matt@mattaitken.com>
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Co-authored-by: Eric Allam <eric@trigger.dev>
Co-authored-by: nicktrn <55853254+nicktrn@users.noreply.github.com>
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.

1 participant