Add PostgreSQL REPL implementation #49598
Merged
Conversation
This file contains 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
gabrielcorado
added
the
no-changelog
zmb3
reviewed
Nov 30, 2024
greedy52
reviewed
Dec 2, 2024
There was a problem hiding this comment.
First pass. Overall logic looks good to me.
A few things i wonder if we could do (not immediately but maybe after MVP):
- common REPL so it can be used for other protocols like MySQL
- test postgres repl (or even do this through the webapi websocket) in E2E test (or testcontainers) against real RDS/Postgres
| switch { | ||
| case strings.HasPrefix(line, commandPrefix) && !readingMultiline: | ||
| var exit bool | ||
| reply, exit = r.processCommand(line) |
There was a problem hiding this comment.
write non-empty reply before exit?
We could do this in the future (when we introduce another database). However, it is a bit difficult to identify which part we can reuse right now.
I'll add the integration and E2E tests after we have both parts (web handler and REPL) ready/merged. So we can thoroughly test their usage against the databases. |
greedy52
approved these changes
Dec 5, 2024
zmb3
reviewed
Dec 5, 2024
zmb3
reviewed
Dec 5, 2024
zmb3
reviewed
Dec 5, 2024
zmb3
reviewed
Dec 5, 2024
Tener
reviewed
Dec 6, 2024
Tener
approved these changes
Dec 9, 2024
r0mant
approved these changes
Dec 13, 2024
public-teleport-github-review-bot
bot
removed request for
GavinFrazar and
fspmarshall
gabrielcorado
added a commit
that referenced
this pull request
Dec 16, 2024
* feat(repl): add postgres * refactor(repl): change repl to use a single Run function * test(repl): reduce usage of require.Eventually blocks * refactor(repl): code review suggestions * refactor(repl): code review suggestions * test(repl): increase timeout values * fix(repl): commands formatting * refactor(repl): send close pgconn using a different context * fix(repl): add proper spacing between multi queries * test(repl): add fuzz test for processing commands
github-merge-queue bot
pushed a commit
that referenced
this pull request
Dec 16, 2024
* Add PostgreSQL REPL implementation (#49598) * feat(repl): add postgres * refactor(repl): change repl to use a single Run function * test(repl): reduce usage of require.Eventually blocks * refactor(repl): code review suggestions * refactor(repl): code review suggestions * test(repl): increase timeout values * fix(repl): commands formatting * refactor(repl): send close pgconn using a different context * fix(repl): add proper spacing between multi queries * test(repl): add fuzz test for processing commands * Add WebSocket handler for WebUI database sessions (#49749) * feat(web): add websocket handler for database webui sessions * refactor: move common structs into a separate package * refactor(web): use ALPN local proxy to dial databases * feat(repl): add default registry * refactor(web): code review suggestions * refactor: update repl config parameters * refactor: move default getter implementation * feat(web): add supports_interactive field on dbs * refactor: code review suggestions * refactor: update database REPL interfaces * chore(web): remove debug print * feat: register postgres repl * refactor(web): update MakeDatabase to receive access checker and interactive * chore(web): remove unused function * Database access through WebUI (#49979) * feat(web): add database terminal access * chore(web): make explict type cast * refactor(web): code review suggestions * chore(web): fix lint errors * refactor(web): lint errors * refactor: code review suggestions * refactor(web): filter wildcard options from connect dialog * chore(web): lint * refactor(web): code review suggestions
carloscastrojumo
pushed a commit
to carloscastrojumo/teleport
that referenced
this pull request
Feb 19, 2025
* feat(repl): add postgres * refactor(repl): change repl to use a single Run function * test(repl): reduce usage of require.Eventually blocks * refactor(repl): code review suggestions * refactor(repl): code review suggestions * test(repl): increase timeout values * fix(repl): commands formatting * refactor(repl): send close pgconn using a different context * fix(repl): add proper spacing between multi queries * test(repl): add fuzz test for processing commands
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Part of #44956 (RFD 0181)
This PR introduces the PostgreSQL REPL implementation following the RFD definition, which will be used as a client to access PostgreSQL instances through WebUI. It works like a terminal emulator (implemented by
golang.org/x/termlibrary) and will be used with the WebUI terminal (like WebUI SSH sessions).Note
This PR only includes the REPL implementation. The web handlers and WebUI changes will be done in different PRs.
For this first release of the REPL, we're not including informational commands (such as
\dor\dt). These commands will require better testing across different PostgreSQL versions and will be introduced in later versions.