Skip to content

Add persistence info to start-dev banner#1033

Merged
chaptersix merged 9 commits into
temporalio:mainfrom
SAY-5:feat/start-dev-banner-persistence
May 30, 2026
Merged

Add persistence info to start-dev banner#1033
chaptersix merged 9 commits into
temporalio:mainfrom
SAY-5:feat/start-dev-banner-persistence

Conversation

@SAY-5
Copy link
Copy Markdown
Contributor

@SAY-5 SAY-5 commented May 21, 2026

What was changed

temporal server start-dev now prints a Persistence: line at the end of the startup banner.

In-memory (no --db-filename):

Persistence:      in-memory (Workflow Executions are lost when the server process exits)

File-backed:

Persistence:      file (/path/to/dev.sqlite)

Why?

Per #634, the start-dev banner did not surface what form of persistence the dev server uses, so users could not tell at a glance whether Workflow Executions would survive a restart.

Checklist

  1. Closes [Feature Request] Add persistence information to start-dev banner #634

  2. How was this tested:

Two new tests in internal/temporalcli/commands.server_test.go start the dev server, capture stdout, and assert that the banner contains Persistence: plus the expected backend description. Both pass locally and fail when the banner change is reverted.

$ go test -run TestServer_StartDev_BannerPersistence ./internal/temporalcli/
ok  	github.com/temporalio/cli/internal/temporalcli	10.318s

@SAY-5 SAY-5 requested a review from a team as a code owner May 21, 2026 08:37
@CLAassistant
Copy link
Copy Markdown

CLAassistant commented May 21, 2026

CLA assistant check
All committers have signed the CLA.

@chaptersix chaptersix self-requested a review May 21, 2026 23:00
@chaptersix
Copy link
Copy Markdown
Contributor

A few suggestions on the banner format:

  1. Label prefix: The other banner entries all use a Temporal prefix (Temporal Server:, Temporal UI:, etc.) — Persistence: should follow suit and become Temporal Persistence:.

  2. Placement: Move the persistence line between Temporal Server: and Temporal UI: so it's grouped with server-level info rather than appended at the end.

  3. Drop the warning text: The in-memory description (Workflow Executions are lost when the server process exits) is likely to alarm users unnecessarily. Just in-memory is enough — users can look up what that means, and it's already well-understood.

  4. Column width: With Temporal Persistence: being 21 chars, bump the format width from %-17s to %-21s across all lines to keep alignment.

Suggested output:

Temporal CLI 0.0.0-DEV (Server 1.31.0, UI 2.49.1)

Temporal Server:      localhost:7233
Temporal Persistence: in-memory
Temporal UI:          http://localhost:8233
Temporal Metrics:     http://localhost:61114/metrics

And for file-backed:

Temporal Persistence: /path/to/dev.sqlite

@chaptersix
Copy link
Copy Markdown
Contributor

Please make sure you have signed the Temporal CLA before this can be merged.

@SAY-5
Copy link
Copy Markdown
Contributor Author

SAY-5 commented May 22, 2026

Applied all four banner suggestions in 2b09ade: Temporal Persistence: label, moved between Server and UI, dropped the in-memory warning text, and bumped width to %-21s across all lines. Updated the test assertions to match. CLA still pending on my side.

@chaptersix
Copy link
Copy Markdown
Contributor

@SAY-5 you have to sign the CLA, I can't merge this until you do. Let me know if you are having problem with it.
I'll close this PR in a few days if it's not signed

@chaptersix
Copy link
Copy Markdown
Contributor

Related issues

Closes #634

What changed?

temporal server start-dev now prints a Temporal Persistence: line in the startup banner showing whether the server is using in-memory or file-backed storage.

Checklist

Stability

  • Breaking changes are marked with 💥 in the PR title and release notes
  • Changes to JSON output (-o json / -o jsonl) are treated as breaking changes

Design

  • This feature does not depend on Cloud-only APIs or behavior (it works against an OSS server)
  • New commands follow temporal <noun> <verb> structure (e.g. temporal workflow start) — N/A, no new commands
  • New flags are named after the API concept, not the implementation mechanism — N/A, no new flags
  • New flags don't duplicate an existing flag that serves the same purpose — N/A
  • New flags do not have short aliases without strong justification — N/A
  • Experimental features are marked with (Experimental) in commands.yaml — N/A

Help text (see style guide at the top of commands.yaml)

  • All flags shown in help text and examples are implemented and functional — N/A
  • Summaries use sentence case and have no trailing period — N/A
  • Long descriptions end with a period and include at least one example invocation — N/A
  • Examples use long flags (--namespace, not -n), one flag per line — N/A
  • Placeholder values use YourXxx form (YourWorkflowId, YourNamespace) — N/A

Behavior

  • Results go to stdout; errors and warnings go to stderr
  • Error messages are lowercase with no trailing punctuation

Tests

  • Added functional test(s) (SharedServerSuite)
  • Added unit test(s) (func TestXxx) where applicable — N/A

Manual tests

Setup

go build -o /tmp/temporal-test ./cmd/temporal

Happy path -- in-memory

$ /tmp/temporal-test server start-dev --headless
Temporal CLI 0.0.0-DEV (Server 1.31.0, UI 2.49.1)

Temporal Server:      localhost:7233
Temporal Persistence: in-memory
Temporal Metrics:     http://localhost:XXXXX/metrics

Happy path -- file-backed

$ /tmp/temporal-test server start-dev --headless \
    --db-filename /tmp/test-dev.sqlite
Temporal CLI 0.0.0-DEV (Server 1.31.0, UI 2.49.1)

Temporal Server:      localhost:7233
Temporal Persistence: /tmp/test-dev.sqlite
Temporal Metrics:     http://localhost:XXXXX/metrics

@chaptersix chaptersix merged commit f015ce2 into temporalio:main May 30, 2026
10 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[Feature Request] Add persistence information to start-dev banner

3 participants