Skip to content
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

chore: experimental render proxy example for versioned realms #3341

Merged
merged 15 commits into from
Dec 20, 2024

Conversation

jeronimoalbi
Copy link
Member

@jeronimoalbi jeronimoalbi commented Dec 15, 2024

This example shows how proxying render calls can be used to allow updating realms to new versions while keeping the same realm path. The idea is to have a simple "parent" realm that only keeps track of the latest realm version and forwards all render calls to it.

@jeronimoalbi jeronimoalbi self-assigned this Dec 15, 2024
@github-actions github-actions bot added the 🧾 package/realm Tag used for new Realms or Packages. label Dec 15, 2024
@Gno2D2
Copy link
Collaborator

Gno2D2 commented Dec 15, 2024

🛠 PR Checks Summary

All Automated Checks passed. ✅

Manual Checks (for Reviewers):
  • IGNORE the bot requirements for this PR (force green CI check)
Read More

🤖 This bot helps streamline PR reviews by verifying automated checks and providing guidance for contributors and reviewers.

✅ Automated Checks (for Contributors):

No automated checks match this pull request.

☑️ Contributor Actions:
  1. Fix any issues flagged by automated checks.
  2. Follow the Contributor Checklist to ensure your PR is ready for review.
    • Add new tests, or document why they are unnecessary.
    • Provide clear examples/screenshots, if necessary.
    • Update documentation, if required.
    • Ensure no breaking changes, or include BREAKING CHANGE notes.
    • Link related issues/PRs, where applicable.
☑️ Reviewer Actions:
  1. Complete manual checks for the PR, including the guidelines and additional checks if applicable.
📚 Resources:
Debug
Manual Checks
**IGNORE** the bot requirements for this PR (force green CI check)

If

🟢 Condition met
└── 🟢 On every pull request

Can be checked by

  • Any user with comment edit permission

@jeronimoalbi
Copy link
Member Author

@moul this is the simple pattern that we are using for Gno.me to be able to support multiple realm versions while keeping the same URL for rendering content.

Instead of merging this example we could have a couple of tutorials in Gno.me explaining different patterns to version realms. The patterns could be the ones that you wrote plus this one.

cc @leohhhn @michelleellen @wyhaines

Copy link

codecov bot commented Dec 15, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

📢 Thoughts on this report? Let us know!

@jeronimoalbi
Copy link
Member Author

jeronimoalbi commented Dec 17, 2024

@leohhhn there is a test failing but is not related to these changes, as far as I can see.
Do you know what might be the issue?

It seems a package name is missing somewhere.

Copy link
Member

@thehowl thehowl left a comment

Choose a reason for hiding this comment

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

This looks good by itself, though I'm beginning to think that maybe we should move all x/ realms into simple realms in personal namespaces.

@jeronimoalbi
Copy link
Member Author

This looks good by itself, though I'm beginning to think that maybe we should move all x/ realms into simple realms in personal namespaces.

It would make sense

@thehowl
Copy link
Member

thehowl commented Dec 20, 2024

This a push and pray because the CI is selective, but merging this and creating an issue.

@thehowl thehowl merged commit ea598bc into master Dec 20, 2024
11 checks passed
@thehowl thehowl deleted the dev/jeronimoalbi/render-proxy-example branch December 20, 2024 15:47
albttx pushed a commit that referenced this pull request Jan 10, 2025
This example shows how proxying render calls can be used to allow
updating realms to new versions while keeping the same realm path. The
idea is to have a simple "parent" realm that only keeps track of the
latest realm version and forwards all render calls to it.

---------

Co-authored-by: Nathan Toups <[email protected]>
Co-authored-by: Leon Hudak <[email protected]>
Co-authored-by: Morgan <[email protected]>
@salmad3 salmad3 mentioned this pull request Jan 13, 2025
12 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
🧾 package/realm Tag used for new Realms or Packages.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants