This repository has been archived by the owner on Apr 5, 2024. It is now read-only.
Improve entry point runner UX #158
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
PR Review ChecklistDo not edit the content of this comment. The PR reviewer should simply update this comment by ticking each review item below, as they get completed. Trivial Change
Code
Architecture
|
dmitrii-ubskii
force-pushed
the
entry-point
branch
from
cfe8002
to
05f07ed
Compare
dmitrii-ubskii
commented
Nov 30, 2023
Comment on lines
-100
to
+106
| if [ $DEBUG ]; then | ||
| exec $JAVA_BIN ${JAVAOPTS} -ea -cp "${CLASSPATH}" -Dtypedb.dir="${TYPEDB_HOME}" \ | ||
| ${TYPEDB_SERVER_CLASS} "${@:2}" | ||
| else | ||
| exec $JAVA_BIN ${JAVAOPTS} -cp "${CLASSPATH}" -Dtypedb.dir="${TYPEDB_HOME}" \ | ||
| ${TYPEDB_SERVER_CLASS} "${@:2}" | ||
| fi | ||
| else | ||
| echo "Invalid argument: $1. Possible commands are: " | ||
| echo " Server: typedb server [--help]" | ||
| echo " Enterprise: typedb enterprise [--help]" | ||
| echo " Console: typedb console [--help]" | ||
| exit 1 | ||
| fi | ||
| CLASSPATH="${TYPEDB_SERVER_DIR}/conf/:${TYPEDB_SERVER_LIB_DIR}/*" | ||
|
|
||
| # exec replaces current shell process with java so no commands after these ones will ever get executed | ||
| exec ${JAVA_BIN} ${JAVAOPTS} ${EXTRAOPTS} -cp "${CLASSPATH}" -Dtypedb.dir="${TYPEDB_HOME}" ${TYPEDB_SERVER_CLASS} "${@:2}" | ||
| ;; |
There was a problem hiding this comment.
Compresed and replaced the "if debug add flag" switch with more idiomatic and extensible EXTRAOPTS variable
| @@ -20,77 +20,88 @@ IF %TYPEDB_HOME:~-1%==\ SET TYPEDB_HOME=%TYPEDB_HOME:~0,-1% | |||
|
|
|||
| where java >NUL 2>NUL | |||
| if %ERRORLEVEL% GEQ 1 ( | |||
| echo Java is not installed on this machine. | |||
| echo TypeDB needs Java 11+ in order to run. See the following setup guide: http://docs.vaticle.com/docs/get-started/setup-guide | |||
Comment on lines
-55
to
+45
| start java %CONSOLE_JAVAOPTS% -cp "%G_CP%" -Dtypedb.dir="%TYPEDB_HOME%" com.vaticle.typedb.console.TypeDBConsole %2 %3 %4 %5 %6 %7 %8 %9 | ||
| java %CONSOLE_JAVAOPTS% -cp "%G_CP%" -Dtypedb.dir="%TYPEDB_HOME%" com.vaticle.typedb.console.TypeDBConsole %2 %3 %4 %5 %6 %7 %8 %9 |
There was a problem hiding this comment.
console is a CLI which should stay in the host command prompt
Comment on lines
-70
to
69
| start java %SERVER_JAVAOPTS% -cp "%G_CP%" -Dtypedb.dir="%TYPEDB_HOME%" com.vaticle.typedb.core.server.TypeDBServer %2 %3 %4 %5 %6 %7 %8 %9 | ||
| if "%2"=="--help" ( | ||
| java %SERVER_JAVAOPTS% -cp "%G_CP%" -Dtypedb.dir="%TYPEDB_HOME%" com.vaticle.typedb.core.server.TypeDBServer %2 %3 %4 %5 %6 %7 %8 %9 | ||
| ) else ( | ||
| start cmd /c java %SERVER_JAVAOPTS% -cp "%G_CP%" -Dtypedb.dir="%TYPEDB_HOME%" com.vaticle.typedb.core.server.TypeDBServer %2 %3 %4 %5 %6 %7 %8 %9 ^|^| pause | ||
| ) | ||
| goto exit |
There was a problem hiding this comment.
Two changes here:
typedb server --help(as suggested by the usage print) no longer opens a new window, but rather prints the help in the current cmd window- otherwise, we use
start cmd /c [...] ^|^| pausewhich prevents the window from automatically closing if (and only if) the server encounters an error and stops with a non-zero exit code, so that the user has a chance to read the log.Ctrl+Cstill shuts down the server and closes the window without triggeringpause.
dmitrii-ubskii
requested review from
lolski and
haikalpribadi
as code owners
flyingsilverfin
approved these changes
Nov 30, 2023
flyingsilverfin
pushed a commit
to vaticle/typedb
that referenced
this pull request
Dec 1, 2023
## Usage and product changes We update to the updated entry point for the assembled TypeDB Core, which omits `console` from the usage help if it is not present to avoid confusion. See #6942 for more details. The command to boot up the server (unchanged): ``` typedb server --server.address=<address> ``` The command to boot up the console: ``` typedb console --core=<address> ``` We also improve the UX of the windows version of the entry point. Console no longer opens in a new window, `--help` is printed inline as expected, and in the event of the server failure, the logs are displayed to the user. See vaticle/typedb-common#158 for more details.
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
What is the goal of this PR?
We provide a single
serverentry point for starting up both core and enterprise server, whichever happens to be installed. We also omitserverorconsolefrom the usage help if it is not present to avoid confusion. See vaticle/typedb#6942 for more details.We also improve the UX of the windows version of the entry point. Console no longer opens in a new window,
--helpis printed inline as expected, and in the event of the server failure, the logs are displayed to the user.