Dylan/feat/reducers editor tool #19

dylanh724 · 2024-03-04T02:41:39Z

About

GUI Reducer listing/calling with prefilled with the CLI-default server/identity (and module name, if cached from previously using the other "Publisher" tool).

Why?

With the Publisher tool, we took away numerous CLI burdens and tossed it into a GUI with persistence to remember your prefs.

The effort continues! Less CLI burdens, more GUI, easier onboarding/reducer testing.

Prerequisites

Branched from clockworklabs/com.clockworklabs.spacetimedbsdk#17 - resolve this PR 1st

Feats

Get default selected server/identity from CLI and load it into UI @ init
Get last-published module Name and load it into a TreeView UI @ init, if any
Parses spacetime describe into a model
Parses describe into an EntityInfo model with extra info, such as [formatted] syntax hints and more
Refresh button, in case we changed something after init
"Call Reducer" button for reducers with results shown below
UX: Local validation, btn enable/disables on ready/done, progressive UI reveal, btn status labels on click, window wrapped in ScrollView, result labels wrapped in ScrollView (in case of lengthy errs), can dock to editor UI as a tab
Minor Publish optimizations (since closely related and templated from)
- Some fixes, some tweaks, some consistency.
- Centralized some common elements back to /Common
- EDIT: --as-identity support
Err handling:
- Implicit #VisualElement name integrity
- Refer to Publisher tool on server<>identity errs

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

Ideas for future PRs:

From Reducer window, have an "Open Publisher Tool" button on identity/server err
From Publisher window, have an "Open Reducers Tool" button on Publish success in the Result Foldout.
Since we parse the entire spacetime describe into a common model, there are likely other fun tools to be made from this.
TreeView supports sub elements, if we ever wanted to do something "extra" with a selected reducer, such as describing what each arg does (if we ever add arg docs within spacetime describe results, for example).
Caching last known set of reducers (but can cause confusion on desyncs).

Testing

Tested via Zeke's demo project, which includes pretty much everything- including custom types and deep nested.
Currently showing premade funcs like Init; unsure what to do with these:

TODO

Add this tool to the README with a GIF
Wrap short if() with if(){} (I learned this internal pref later)
Emulation support as a player ("bot").
- Eg: Let's say I want to call the tutorial's chat_message - I get an err response "Player not found"

- Runs cross-platform CLI commands in the background and parses them for friendly results - Features: * 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` for optimization; show install button if !found (in post-publish result cache) * Regenerate local|testnet servers if 0 servers found * Cleanly-exited Process via cancel token support * Progress bars and status labels * CLI Error handling * 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

- For future Editor tools that may coincide with Publisher, I added a `Common` dir - Moved core CLI commands to a common `SpacetimeDbCli.cs` - Created a "common" USS stylesheet so future editor tools can utilize this with a core, templated style. - Set the non-common USS stylesheet as active at the top (custom one *must* be at top, as that's what's default set active) - Better USS/UXML naming - Added sanity checks for USS/UXML loading

- For future Editor tools that may coincide with Publisher, I added a `Common` dir - Moved core CLI commands to a common `SpacetimeDbCli.cs` - Created a "common" USS stylesheet so future editor tools can utilize this with a core, templated style. - Set the non-common USS stylesheet as active at the top (custom one *must* be at top, as that's what's default set active) - Better USS/UXML naming - Added sanity checks for USS/UXML loading - fix: HasIdentitiesButNoDefault + HasServersButNoDefault were resulting in opposite expectations

- Currently has the Publish window template UI; will strip this next commit (keeping what we need)

…ditor-tool # Conflicts: # Scripts/Editor/Common/SpacetimeDbCli/Models/GetIdentitiesResult.cs # Scripts/Editor/Common/SpacetimeDbCli/Models/PublishResult.cs # Scripts/Editor/Common/SpacetimeDbCli/Models/PublishResult.cs.meta # Scripts/Editor/Common/SpacetimeDbCli/Models/PublishServerModuleResult.cs # Scripts/Editor/Common/SpacetimeDbCli/Models/PublishServerModuleResult.cs.meta # Scripts/Editor/Common/SpacetimeDbCli/SpacetimeDbCli.cs # Scripts/Editor/Common/SpacetimeDbCli/SpacetimeDbPublisherCli.cs # Scripts/Editor/Common/SpacetimeMeta.cs # Scripts/Editor/SpacetimePublisher/PublisherWindowComponents.uxml # Scripts/Editor/SpacetimePublisher/Scripts/Models/PublishServerModuleResult.cs # Scripts/Editor/SpacetimePublisher/Scripts/Models/PublishServerModuleResult.cs.meta # Scripts/Editor/SpacetimePublisher/Scripts/PublisherWindowActions.cs

…ditor-tool # Conflicts: # Scripts/Editor/Common/SpacetimeDbCli/Models/GetIdentitiesResult.cs # Scripts/Editor/Common/SpacetimeDbCli/SpacetimeDbPublisherCli.cs # Scripts/Editor/SpacetimePublisher/Scripts/PublisherWindowActions.cs

…ditor-tool

- Pulls data from Publisher, if previously published, to get the default module name.

…ditor-tool # Conflicts: # Scripts/Editor/SpacetimePublisher/Scripts/PublisherWindowActions.cs

- Also fix an async naming/discard convention

…ditor-tool # Conflicts: # Scripts/Editor/SpacetimePublisher/Scripts/PublisherWindowActions.cs

- Plus, remove testing placeholders - Rn "Call" btn val to "Call Reducer" - Bring bold back to buttons when done (the orig text restored)

…ditor-tool

- Prevents build errs. This is *technically* a workaround for a Unity bug, since /Editor is supposed to be ignored by build processes anyway.

…ditor-tool

…ditor-tool # Conflicts: # Editor/Common/SpacetimeDbCli/SpacetimeDbCliActions.cs

…ditor-tool

- Caused by a Unity bug (imploded Label)

- Pulls from Publisher - Defaults to default identity, if none previously selected - Will persist previously selected (and will soft check if still valid)

…ditor-tool

@john

- Unused, yet, with TODO notes! @john wanted to have this, so I got ya started

…ditor-tool

dylanh724 added 26 commits February 28, 2024 10:59

feat: SpacetimeReducer barebones w/Publish template

dfc6a02

- Currently has the Publish window template UI; will strip this next commit (keeping what we need)

feat: Wip get more init data, then fill map

6ce129e

chore: Cleanup, some consistency refactoring, docs

238d470

chore: Cleanup, some consistency refactoring, docs

21bd9f9

chore: Cleanup, some consistency refactoring, docs

1a686ec

Merge branch 'dylan/publisher-editor-tool' into dylan/feat/reducers-e…

1ec4d40

…ditor-tool

fix: Inadvertent publisher uxml override

e292280

feat: Wip reducers list flow, +refresh btn

f02cbe3

feat: Reducers load into tree and reflect selected

827c670

feat: Dynamic arg syntax hints

5110635

feat(ux): Arity considerations for toggling input/run

07a31ad

feat(ux): Load last published module name + cleanup

0da6c20

- Pulls data from Publisher, if previously published, to get the default module name.

fix: Hide cancel btn on pub success; show pub btn

b4cbc64

Merge branch 'dylan/publisher-editor-tool' into dylan/feat/reducers-e…

b087374

…ditor-tool # Conflicts: # Scripts/Editor/SpacetimePublisher/Scripts/PublisherWindowActions.cs

fix: Post-merge swap

e35c7e7

fix: Hide cancel btn on pub success; show pub btn

ebc1a65

- Also fix an async naming/discard convention

Merge branch 'dylan/publisher-editor-tool' into dylan/feat/reducers-e…

e830277

…ditor-tool # Conflicts: # Scripts/Editor/SpacetimePublisher/Scripts/PublisherWindowActions.cs

feat: Refresh btn UX, polished result, ready

3c5c68e

fix(publisher): rn errorCoverTxt -> Label

9d1abd2

fix: CliError isSuccess for call result

642d8cf

feat: Implement err cover

da94592

dylanh724 added the enhancement New feature or request label Mar 4, 2024

dylanh724 requested review from bfops and jdetter March 4, 2024 02:41

fix: CliError can be "" empty; check for that

d226872

- Plus, remove testing placeholders - Rn "Call" btn val to "Call Reducer" - Bring bold back to buttons when done (the orig text restored)

dylanh724 mentioned this pull request Apr 22, 2024

Dylan/feat/menu init new module #34

Open

dylanh724 added 16 commits April 22, 2024 19:55

chore: Remove bloat

bb6a92e

Merge branch 'dylan/publisher-editor-tool' into dylan/feat/reducers-e…

3b8279f

…ditor-tool

fix: Regernate label hide on success try again

f2c6544

Merge branch 'dylan/publisher-editor-tool' into dylan/feat/reducers-e…

8ec45d9

…ditor-tool

fix!: Set Editor asmdef to be editor only

2df81ef

- Prevents build errs. This is *technically* a workaround for a Unity bug, since /Editor is supposed to be ignored by build processes anyway.

Merge branch 'dylan/publisher-editor-tool' into dylan/feat/reducers-e…

eb8a74c

…ditor-tool

fix!: Fingerprint err flows

332a152

Merge branch 'dylan/publisher-editor-tool' into dylan/feat/reducers-e…

8d252d7

…ditor-tool

fix: Reset Publish Result on server offline

c0be2f9

Merge branch 'dylan/publisher-editor-tool' into dylan/feat/reducers-e…

8ea842e

…ditor-tool

fix: Post-merge fix for RemoveIdentityAsync

a652bb7

Merge branch 'dylan/publisher-editor-tool' into dylan/feat/reducers-e…

a6afc27

…ditor-tool # Conflicts: # Editor/Common/SpacetimeDbCli/SpacetimeDbCliActions.cs

fix: Show ping errs after all (was hiding an issue)

6993600

Merge branch 'dylan/publisher-editor-tool' into dylan/feat/reducers-e…

edd3885

…ditor-tool

fix!: Server poof bug for localhost @ identity

ae68b95

Merge branch 'dylan/publisher-editor-tool' into dylan/feat/reducers-e…

be9518f

…ditor-tool

dylanh724 requested a review from cloutiertyler April 29, 2024 01:53

dylanh724 added 11 commits April 30, 2024 10:49

fix: Ambiguous log

34c155e

fix!: Syntax hints, +rm bottom accidental groupbox

029b58c

- Caused by a Unity bug (imploded Label)

fix(pending): "--as-identity" to ReducerMeta.cs const

df5be40

fix: Nested scrollbar

e71f0ee

doc: TODO comments for _argSnippets

23f0b95

feat: Upgrade id txt into dropdown

70494c9

- Pulls from Publisher - Defaults to default identity, if none previously selected - Will persist previously selected (and will soft check if still valid)

feat: Persist selected reducer

53c4840

chore: Minor SpacetimeMeta mv using to top

c5d9cd4

Merge branch 'dylan/publisher-editor-tool' into dylan/feat/reducers-e…

6279dd5

…ditor-tool

feat(WIP)!: Add SpacetimeDbEditorPrefs + Pub ScriptObjs

c7c5ef9

- Unused, yet, with TODO notes! @john wanted to have this, so I got ya started

Merge branch 'dylan/publisher-editor-tool' into dylan/feat/reducers-e…

4e65aeb

…ditor-tool

jdetter removed their request for review November 8, 2024 18:12

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Dylan/feat/reducers editor tool #19

Dylan/feat/reducers editor tool #19

Uh oh!

dylanh724 commented Mar 4, 2024 •

edited

Loading

Uh oh!

Uh oh!

Dylan/feat/reducers editor tool #19

Are you sure you want to change the base?

Dylan/feat/reducers editor tool #19

Uh oh!

Conversation

dylanh724 commented Mar 4, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

About

Why?

Prerequisites

Feats

Ideas for future PRs:

Testing

TODO

Uh oh!

Uh oh!

dylanh724 commented Mar 4, 2024 •

edited

Loading