New Java based Nessie CLI tool + REPL #8348

snazy · 2024-04-17T11:57:25Z

Features & functionalities:

SQL-ish syntax.
REPL.
Built-in online HELP command (and HELP <command> command ;), that also shows the commands' syntaxes in the online help. The same information is also published on the projectnessie.org site.
Auto-completion of commands, keywords and reference names (use TAB).
Syntax highlighting.
Paging of long results - showing a lot of content keys or a long commit log just works like less on your Linux or macOS box.
Command history, persisted in your home directory (can be turned off).
"Just" run a one or more Nessie REPL commands - pass those as arguments on the command line or as a script.
Supports all authentication mechanisms that the Nessie Java supports, including all OAuth2 flows.
Relatively small, currently just ~14.5MB.
Available commands to manage branches and tags, drop tables and views, manage namespaces, list and show tables & views, merge and help.
Contains interactive functionality that content-generator tool and pynessie provide, but not potentially dangerous operations.

It's not based on Quarkus, but "plain" Java 11, allows a smaller uber-jar of 14.5 instead of 18.5MB, also improves startup time a bit.

Also included in this PR:

Updates to the web site, syntax docs generated from Grammar.
Same help texts used for online help + web site.
Blog post.

Uses congocc Grammar and parser/lexer, really quick parsing and no runtime dependencies required. congocc also allows relatively(!) easy integration of command line completion and syntax highlighting.

To try the Nessie CLI tool: ./gradlew :nessie-cli:jar && java -jar cli/cli/build/libs/nessie-cli-0.80.1-SNAPSHOT.jar

cli/grammar/src/main/congocc/nessie/nessie-cli-lexer.ccc

site/in-dev/pynessie.md

site/in-dev/cli.md

site/in-dev/index-release.md

site/docs/blog/posts/2024-05-new-cli.md

adutra · 2024-05-02T12:18:10Z

cli/cli/src/main/java/org/projectnessie/nessie/cli/cli/BaseNessieCli.java

+  private Reference currentReference;
+  private Terminal terminal;
+
+  public Integer exitWithCode() {


The method name suggests that System.exit() is going to be called. How about just getExitCode/setExitCode?

cli/cli/src/main/java/org/projectnessie/nessie/cli/cli/NessieCliImpl.java

cli/cli/src/main/java/org/projectnessie/nessie/cli/cli/NessieCliHighlighter.java

adutra · 2024-05-02T14:29:29Z

CHANGELOG.md

@@ -8,6 +8,8 @@ as necessary. Empty sections will not end in the release notes.

 ### Highlights

+- New Nessie CLI tool + REPL


Maybe elaborate a bit.

adutra · 2024-05-02T14:52:50Z

cli/cli/src/main/java/org/projectnessie/nessie/cli/cli/NessieCliHighlighter.java

+  private static final AttributedStyle STYLE_COMMAND = DEFAULT.foreground(0, 128, 0);
+  private static final AttributedStyle STYLE_REF_TYPE = DEFAULT.foreground(0, 128, 128);
+  private static final AttributedStyle STYLE_KEYWORD = DEFAULT.foreground(128, 128, 0);
+  private static final AttributedStyle STYLE_INVALID = DEFAULT.foreground(168, 0, 0);
+  private static final AttributedStyle STYLE_LITERAL = DEFAULT.bold().italic();


Easier to grasp:

private static final AttributedStyle STYLE_COMMAND = DEFAULT.foreground(GREEN); private static final AttributedStyle STYLE_REF_TYPE = DEFAULT.foreground(CYAN); private static final AttributedStyle STYLE_KEYWORD = DEFAULT.foreground(YELLOW); private static final AttributedStyle STYLE_INVALID = DEFAULT.foreground(RED);

cli/cli/src/main/java/org/projectnessie/nessie/cli/cli/NessieCliHighlighter.java

adutra · 2024-05-02T14:57:34Z

cli/cli/src/main/java/org/projectnessie/nessie/cli/cli/NessieCliMain.java

+
+    // There's no easy, better way :(
+    // Setting the usage-width to 100 chars so that URLs are not line-wrapped.
+    System.setProperty("picocli.usage.width", "100");


Have you tried commandLine.setUsageHelpAutoWidth(true);?

Hm - I'd like to keep it at 100 fixed for now, because the docs-generator uses "--help" as well - and I don't know how that would look like in CI.

Features & functionalities: * SQL-ish syntax. * REPL. * Built-in online `HELP` command (and `HELP <command>` command ;), that also shows the commands' syntaxes in the online help. The same information is also published on the projectnessie.org site. * Auto-completion of commands, keywords and reference names (use TAB). * Syntax highlighting. * Paging of long results - showing a lot of content keys or a long commit log just works like `less` on your Linux or macOS box. * Command history, persisted in your home directory (can be turned off). * "Just" run a one or more Nessie REPL commands - pass those as arguments on the command line or as a script. * Supports all authentication mechanisms that the Nessie Java supports, including all OAuth2 flows. * Relatively small, currently just ~14.5MB. * Available commands to manage branches and tags, drop tables and views, manage namespaces, list and show tables & views, merge and help. * Contains interactive functionality that content-generator tool and pynessie provide, but not potentially dangerous operations. It's not based on Quarkus, but "plain" Java 11, allows a smaller uber-jar of 14.5 instead of 18.5MB, also improves startup time a bit. Also included in this PR: * Updates to the web site, syntax docs generated from Grammar. * Same help texts used for online help + web site. * Blog post. Uses congocc Grammar and parser/lexer, really quick parsing and no runtime dependencies required. congocc also allows relatively(!) easy integration of command line completion and syntax highlighting. To try the Nessie CLI tool: `./gradlew :nessie-cli:jar && java -jar cli/cli/build/libs/nessie-cli-0.80.1-SNAPSHOT.jar`

* Replace `IN` with `ON` (`IN` is used to reference a catalog in Nessie Spark SQL extensions) * Enhance `ON` with optional `BRANCH` or `TAG` * Enhance `AT` with optional `TIMESTAMP` or `COMMIT` * Rename `TimestampOrHash` to `TimestampOrCommit`

snazy · 2024-05-07T07:29:49Z

Reverted a couple of updates to the web-site in the last added commit, as those would break CI and also confuse users.

snazy force-pushed the new-cli branch 4 times, most recently from 716d5fa to 68895a7 Compare April 18, 2024 07:18

adutra mentioned this pull request Apr 18, 2024

Ability to cancel interactive client authentication #8347

Merged

snazy force-pushed the new-cli branch from 68895a7 to 62220c7 Compare April 18, 2024 13:11

adutra mentioned this pull request Apr 18, 2024

OAuth2Client: defer initial token fetch when user interaction is required #8354

Merged

snazy force-pushed the new-cli branch 18 times, most recently from 43483c4 to 9b84ff3 Compare April 25, 2024 09:47

snazy force-pushed the new-cli branch 5 times, most recently from 0fef268 to b492737 Compare April 26, 2024 09:48

snazy force-pushed the new-cli branch 2 times, most recently from 34dec4e to e723375 Compare April 29, 2024 16:35

snazy marked this pull request as ready for review April 29, 2024 16:35

adutra reviewed Apr 30, 2024

View reviewed changes

snazy force-pushed the new-cli branch 2 times, most recently from 437427d to 2f7319b Compare May 2, 2024 12:59

adutra reviewed May 2, 2024

View reviewed changes

snazy force-pushed the new-cli branch from 2f7319b to ac224c8 Compare May 2, 2024 16:14

snazy requested a review from adutra May 2, 2024 16:15

snazy force-pushed the new-cli branch 2 times, most recently from 5ced6b0 to 446ce3b Compare May 6, 2024 12:08

adutra previously approved these changes May 6, 2024

View reviewed changes

snazy added 11 commits May 7, 2024 09:28

changelog

77e0b20

review

31e371b

exit code

2930b25

color constants

a242d66

changelog

6add3a8

style constants

df2a249

external: non-ansi, internal: dumb

f5a1519

Update the grammar

26d9c57

* Replace `IN` with `ON` (`IN` is used to reference a catalog in Nessie Spark SQL extensions) * Enhance `ON` with optional `BRANCH` or `TAG` * Enhance `AT` with optional `TIMESTAMP` or `COMMIT` * Rename `TimestampOrHash` to `TimestampOrCommit`

update site docs a bit

d132c7f

revert "breaking" site changes

ca40cb3

snazy dismissed adutra’s stale review via ca40cb3 May 7, 2024 07:28

snazy force-pushed the new-cli branch from 446ce3b to ca40cb3 Compare May 7, 2024 07:28

snazy mentioned this pull request May 7, 2024

New CLI: Post-release site updates #8468

Merged

adutra approved these changes May 7, 2024

View reviewed changes

snazy merged commit 2b46130 into projectnessie:main May 7, 2024
16 checks passed

snazy deleted the new-cli branch May 7, 2024 13:05

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

New Java based Nessie CLI tool + REPL #8348

New Java based Nessie CLI tool + REPL #8348

snazy commented Apr 17, 2024 •

edited

Loading

adutra May 2, 2024

adutra May 2, 2024

adutra May 2, 2024

adutra May 2, 2024

snazy May 2, 2024

snazy commented May 7, 2024

		@@ -8,6 +8,8 @@ as necessary. Empty sections will not end in the release notes.

		### Highlights

		- New Nessie CLI tool + REPL

New Java based Nessie CLI tool + REPL #8348

New Java based Nessie CLI tool + REPL #8348

Conversation

snazy commented Apr 17, 2024 • edited Loading

adutra May 2, 2024

Choose a reason for hiding this comment

adutra May 2, 2024

Choose a reason for hiding this comment

adutra May 2, 2024

Choose a reason for hiding this comment

adutra May 2, 2024

Choose a reason for hiding this comment

snazy May 2, 2024

Choose a reason for hiding this comment

snazy commented May 7, 2024

snazy commented Apr 17, 2024 •

edited

Loading