You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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
Tasks are run on every commit but only new migration files are pushed.
Close and reopen this PR if you want to apply changes from existing seed or migration files.
The ADR mentions using WASM-compatible parsers but doesn't specify which specific parsers will be used for PostgreSQL DDL. Consider adding more concrete implementation details or examples of the parsers being considered.
- For PostgreSQL DDL, we aim to use a WASM-compatible SQL parser tailored to PostgreSQL syntax.
The ADR doesn't discuss alternative approaches that were considered and rejected. Adding a section on alternatives would strengthen the document by showing the decision-making process more clearly.
## Decision
We will perform all DB schema parsing within a Node.js environment. Specifically:
1. **Node.js as the Server-Side Runtime**
- Use Node.js exclusively on the server side to perform schema parsing and ER diagram generation.
- Deliver the rendered ER diagrams to the client via our web application (e.g., React Server Components) without running Node.js in the browser.
2. **Existing Parsers**
- For Prisma schemas (`schema.prisma`), we can leverage existing Node.js libraries.
- For Rails’ `schema.rb`, we plan to use [ruby/prism](https://github.com/ruby/prism) in a form that can run under Node.js (e.g., via WASM).
- For PostgreSQL DDL, we aim to use a WASM-compatible SQL parser tailored to PostgreSQL syntax.
3. **Unified Data Model**
- Map every schema format to a common `DBStructure` type so that subsequent ER diagram generation remains format-agnostic.
4. **Future Growth**
- If new formats emerge, we will first look for a WASM or JavaScript solution. Only if absolutely necessary will we consider introducing new runtimes or custom parser generators.
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
MH4GF
requested review from
FunamaYukina,
NoritakaIkeda,
hoshinotsuyoshi and
junkisai
and removed request for
a team
junkisai
left a comment
github-merge-queue
bot
removed this pull request from the merge queue due to failed status checks
Issue
Why is this change needed?
To make past context easier for new developers to understand
What would you like reviewers to focus on?
Testing Verification
What was done
🤖 Generated by PR Agent at a78df6a
Detailed Changes
20241206-node-js-based-unified-db-schema-parsing.mdx
Added ADR for Node.js-based schema parsing approachfrontend/apps/docs/content/docs/contributing/adr/20241206-node-js-based-unified-db-schema-parsing.mdx
Additional Notes