Dylan/publisher-editor-tool

[dylanh724]

About💡

New SpacetimeDB "Publisher" tool, acting as a SpacetimeDB GUI for creating/managing identities/servers, publishing, and viewing the last result cache of your previous publish [through the tool].

Designed in UI Builder with high-level and low-level scripts, this is designed to be scalable and intuitive to change.

More screenshots below.

Documentation

• Unity Editor Tools Dev Guide (Internal)

Why❓

The user could learn all the CLI commands and nuances, but automation and streamlining for an in-editor tool just feels amazing for both onboarding and veterans.

New users are already learning both the client and server side - potentially even learning Rust, on top of things. This tool should significantly lower onboarding friction and overall lower the learning curve.

On top of this, we can also workaround known bugs, such as auto-regenerating servers when they poof.

Merge Prerequisites 📦

Recommended to merge 1st, but not required:

1. CLI - Set default server to testnet SpacetimeDB#1078

Features📜

• Runs cross-platform CLI commands in the background and parses them into friendly results
• Detects and cross-platform installs SpacetimeDB CLI if !detected
• View list of servers|identities
• Add server|identity
• Change server|identity
• Ensure identities are bound to servers (refresh on server change)
• FilePicker for publish/to/module path
• Publish result with DateTime, Host, IsOptimizedBuild
• Detection of wasm-opt to show if a publish was optimized or not
• Install wasm-opt button -> On click, install silently via npm
  • Bug: The pkg we use that auto-detects wasm-opt has a bug that doesn't check global PATH
  • Workaround: So instead, we just launch their release URL
• Regenerate local|testnet servers if 0 servers found
• Cleanly-exited Process via cancel token support
• Progress bars and status labels
• CLI Error handling
  • (Edit) ux: If "exit with code 1" or some other vague err, Publisher will automatically iterate the non-err output for errs and display+log them
• Some persistence cache, but we mostly get live updates from the CLI
• UX: Prettified, responsive design, Local validation, groups, focus/selectAll when applicable, status labels, integrity checks, top banner click links to docs, body wraped in scrollView, fonts and colors match docs, can dock to editor UI as a tab.
• EDIT: -c support
• EDIT: spacetime generate support (post-publish)
• EDIT: Optional debug mode (--skip_clippy --debug)

⚙️ Editor tool only: This won't bloat builds.
⚙️ Tested in Unity 2022.3.20 LTS

Flow➡️

New User

1. Init -> Detects and installs SpacetimeDB CLI (with progress bar)
2. Server foldout is revealed, prefilling the dropdown (selecting CLI default) -> If no servers, regenerate local + `testnet
3. Identity foldout is revealed, prefilling the default identity -> If no identities, show the "new identity" group (nickname+email)
4. Publish foldout is revealed, prefilling module name with a suggested one based on your client project name (lowercase-dashified-swaps-client-with-server) -> Browse path via FilePicker
5. Ready to Publish

Returning User

1. [Within a few ms] Init -> Load servers + default -> Load identities + default -> Load Publish name/path persistence cache -> reveal Publish button -> If previous session result cache found, reveal that dropdown (optionally minimized, dependent on persistence)
2. Ready to Publish

Media🖼️

Reveal Media

Ready to Publish (Same UI as Returning User Init)

SpacetimeDB CLI !Detected

(Image broke - will replace next shift)

Add new server|identity

Choose a server

Publishing

Published, Optimized

Published, !Optimized

EDIT: -c support

 ![image](https://github.com/clockworklabs/com.clockworklabs.spacetimedbsdk/assets/8840024/d1cb9d53-11a7-4ac2-8c20-b8ef1a14261e)

Editor view from eagle eye perspective:

Generate Client Files

Advanced

Testing

• Tested in Unity 2022.3.20 LTS dark theme with C# spacetime init vanilla Module using dark mode perspective.
  
• Vigorously tested by both eating my own dogfood and running a VM for a new user experience with missing prereqs.
• Tested in Windows with some Ubuntu to emulate Mac CLI, but should be cross-platform

[dylanh724]

⚠️Small warning: I discovered the proper short-statement if() standards later. Currently, you'll find many:

if (!isSuccess)
    return;

rather than:

if (!isSuccess)
{
    return;
}

[dylanh724]

Final form, unless told otherwise -- Went through aggressive testing and applied a bunch of fixes -- it's quite stable! Ready to review (undrafting) @jdetter , @cloutiertyler , @bfops