feat: add deployment setting to disable the Codernauts game by bartekgatzcoder · Pull Request #27662 · coder/coder

bartekgatzcoder · 2026-07-29T20:36:12Z

Adds a codernauts_enabled runtime setting (default: enabled) that controls whether the Codernauts game link appears in the user dropdown menu. A toggle at the bottom of the Deployment > Appearance page controls it, and the value persists in site_configs, so it survives restarts and upgrades without any CLI flags or environment variables.

The setting works on all licenses: GET /api/v2/appearance reports it from both the enterprise and the default (AGPL) appearance fetchers, and PUT /api/v2/appearance persists it gated only by the deployment-config RBAC permission, not by an entitlement. On the Appearance page the toggle renders outside the Premium paywall introduced in #27948; the other appearance fields keep their existing licensing behavior.

Note: a pure AGPL-only build of coderd does not register the /api/v2/appearance routes at all, so the toggle cannot be saved there. The standard coder server binary is unaffected regardless of license state.

Implementation notes

coderd/database/queries/siteconfig.sql: new GetCodernautsEnabled / UpsertCodernautsEnabled queries backed by a codernauts_enabled key in site_configs; defaults to true when unset (no migration needed).
coderd/database/dbauthz: read has no authz checks (matching other appearance reads); write requires ResourceDeploymentConfig update. Coverage added to dbauthz_test.go.
codersdk: codernauts_enabled added to AppearanceConfig and UpdateAppearanceConfig.
coderd/appearance: the default fetcher takes a database.Store and reads the setting from the database so unlicensed deployments serve it too.
enterprise/coderd/appearance.go: fetches the value in Fetch and persists it in putAppearance.
Frontend: "Codernauts game" toggle section on Deployment > Appearance saving immediately via the existing appearance mutation; codernauts_enabled threaded from useDashboard().appearance through Navbar to UserDropdownContent, which renders the menu item only when enabled. Storybook stories with play functions cover toggling (entitled and not) and the dropdown hiding the link when disabled.

🤖 This PR was generated by Coder Agents on behalf of @bartekgatzcoder.

Adds a hide_codernauts runtime setting persisted in site_configs and exposed through the appearance API. A new toggle at the bottom of the Deployment > Appearance page controls it, and the user dropdown skips the Codernauts menu item when it is set. The setting works on all licenses: the default appearance fetcher reads it from the database too, so no license entitlement is required.

github-actions · 2026-07-29T20:36:21Z

Docs preview

Check off each page once it's been reviewed. If a page changes in a later push, its checkbox clears automatically so it gets a fresh look. Pages not yet wired into the docs navigation aren't listed here.

aslilac · 2026-07-29T22:59:58Z

+VALUES (
+    'hide_codernauts',
+    CASE
+        WHEN sqlc.arg(hide)::bool THEN 'true'


Suggested change

WHEN sqlc.arg(hide)::bool THEN 'true'

WHEN @hide::bool THEN 'true'

Done in adeb84d. 🤖 (Coder Agents on behalf of @bartekgatzcoder)

aslilac · 2026-07-29T23:00:10Z

+)
+ON CONFLICT (key) DO UPDATE
+SET value = CASE
+    WHEN sqlc.arg(hide)::bool THEN 'true'


Suggested change

WHEN sqlc.arg(hide)::bool THEN 'true'

WHEN @hide::bool THEN 'true'

Done in adeb84d. 🤖 (Coder Agents on behalf of @bartekgatzcoder)

aslilac · 2026-07-29T23:00:59Z

+-- GetHideCodernauts returns whether the Codernauts game link is hidden
+-- from the user dropdown menu. Defaults to false when unset.


Suggested change

-- GetHideCodernauts returns whether the Codernauts game link is hidden

-- from the user dropdown menu. Defaults to false when unset.

yap

Removed in adeb84d. 🤖 (Coder Agents on behalf of @bartekgatzcoder)

aslilac · 2026-07-29T23:01:14Z

 	ServiceBanner       BannerConfig   `json:"service_banner"`
 	AnnouncementBanners []BannerConfig `json:"announcement_banners"`
 	SupportLinks        []LinkConfig   `json:"support_links,omitempty"`
+	// HideCodernauts hides the Codernauts game link in the user dropdown menu.


Suggested change

// HideCodernauts hides the Codernauts game link in the user dropdown menu.

yap

Removed in adeb84d. 🤖 (Coder Agents on behalf of @bartekgatzcoder)

aslilac · 2026-07-29T23:01:26Z

 	// Deprecated: ServiceBanner has been replaced by AnnouncementBanners.
 	ServiceBanner       BannerConfig   `json:"service_banner"`
 	AnnouncementBanners []BannerConfig `json:"announcement_banners"`
+	// HideCodernauts hides the Codernauts game link in the user dropdown menu.


Suggested change

// HideCodernauts hides the Codernauts game link in the user dropdown menu.

yap

Removed in adeb84d. 🤖 (Coder Agents on behalf of @bartekgatzcoder)

aslilac · 2026-07-29T23:03:50Z

+	// database may be nil when no store is available, in which case
+	// runtime settings fall back to their zero values.


why tolerate nil?

this is classic "yap", words for the sake of words without actually saying what the recipient wants to hear. I do not need to be told that nil means a store in unavailable, I need to know why we would tolerate that. what benefit to we get out of letting it be optional instead of just requiring it?

Fair point, there was no real benefit. adeb84d drops the nil tolerance: the fetcher now requires a store, and site.New passes opts.Database. 🤖 (Coder Agents on behalf of @bartekgatzcoder)

aslilac · 2026-07-29T23:04:28Z

+export const CodernautsShown: Story = {
+	play: async ({ canvasElement, step }) => {
+		await step("shows the Codernauts link by default", async () => {
+			await openDropdown(canvasElement);
+			expect(
+				screen.getByRole("menuitem", { name: "Codernauts" }),
+			).toBeInTheDocument();
+		});
+	},
+};


we don't need a specific story for this. it's already captured in every other story.

Removed the CodernautsShown story in adeb84d. 🤖 (Coder Agents on behalf of @bartekgatzcoder)

aslilac · 2026-07-29T23:06:44Z

+		// No database is available here; coderd replaces this fetcher
+		// with a database-backed one during startup.
+		f := appearance.NewDefaultFetcher(nil, opts.DocsURL)


I'm pretty sure it's just opts.Database. we definitely have a database handle somewhere in here, because we use it for fetching user data/token state/etc.

coder/site/site.go

Line 75 in 2af08bb

Database database.Store

Correct, it is. adeb84d passes opts.Database and removes the comment. 🤖 (Coder Agents on behalf of @bartekgatzcoder)

@arg

Use the @arg sqlc shorthand, drop comments that restate the code, require a database store in the default appearance fetcher by passing site.Options.Database, and remove the redundant CodernautsShown story.

…s-toggle # Conflicts: # site/src/pages/DeploymentSettingsPage/AppearanceSettingsPage/AppearanceSettingsPageView.stories.tsx # site/src/pages/DeploymentSettingsPage/AppearanceSettingsPage/AppearanceSettingsPageView.tsx

Rename hide_codernauts to codernauts_enabled across the API, database queries, and frontend. The toggle now reads "Codernauts game" with a neutral description, defaults to on, and switching it off disables the game.

Covers the upgrade path: with no stored site config the game is enabled, disabling works without a license, and the stored value survives switching to the licensed appearance fetcher.

DanielleMaywood · 2026-08-19T15:42:06Z

+func (q *querier) GetCodernautsEnabled(ctx context.Context) (bool, error) {
+	// No authz checks
+	return q.db.GetCodernautsEnabled(ctx)
+}


Suggested change

func (q *querier) GetCodernautsEnabled(ctx context.Context) (bool, error) {

// No authz checks

return q.db.GetCodernautsEnabled(ctx)

}

func (q *querier) GetCodernautsEnabled(ctx context.Context) (bool, error) {

return q.db.GetCodernautsEnabled(ctx)

}

Applied in 51a9b27. 🤖 (Coder Agents on behalf of @bartekgatzcoder)

DanielleMaywood · 2026-08-19T15:44:20Z

+	ctx, cancel := context.WithTimeout(context.Background(), testutil.WaitLong)
+	defer cancel()


I can't remember off the top of my head but is this definitely the intended way to create a context for a test in coder/coder?

Regardless it should be moved to just before first use (so right before basicUserClient.Appearance(ctx). Otherwise coderdentest.New and coderdtest.CreateAnotherUser start ticking down the timer and we're more likely to get a flake.

Good catch. Switched to testutil.Context (the repo convention, with automatic cancel on cleanup) and moved it to right before the first use so setup no longer eats into the timeout. Done in 51a9b27. 🤖 (Coder Agents on behalf of @bartekgatzcoder)

Drop the no-authz comment from GetCodernautsEnabled and use testutil.Context created right before first use in the Codernauts test to avoid eating into the timeout during setup.

…s-toggle # Conflicts: # site/src/modules/dashboard/Navbar/UserDropdown/UserDropdownContent.tsx # site/src/pages/DeploymentSettingsPage/AppearanceSettingsPage/AppearanceSettingsPageView.tsx

bartekgatzcoder self-assigned this Jul 29, 2026

bartekgatzcoder requested a review from DanielleMaywood July 29, 2026 20:36

aslilac reviewed Jul 29, 2026

View reviewed changes

bartekgatzcoder added 3 commits July 30, 2026 11:32

chore: apply PR review feedback

adeb84d

Use the @arg sqlc shorthand, drop comments that restate the code, require a database store in the default appearance fetcher by passing site.Options.Database, and remove the redundant CodernautsShown story.

refactor: make the Codernauts setting affirmative

d7ae752

Rename hide_codernauts to codernauts_enabled across the API, database queries, and frontend. The toggle now reads "Codernauts game" with a neutral description, defaults to on, and switching it off disables the game.

bartekgatzcoder changed the title ~~feat: add deployment setting to hide the Codernauts game~~ feat: add deployment setting to disable the Codernauts game Aug 19, 2026

test(enterprise/coderd): verify Codernauts defaults to enabled

adae3e8

Covers the upgrade path: with no stored site config the game is enabled, disabling works without a license, and the stored value survives switching to the licensed appearance fetcher.

DanielleMaywood reviewed Aug 19, 2026

View reviewed changes

chore: apply PR review feedback

51a9b27

Drop the no-authz comment from GetCodernautsEnabled and use testutil.Context created right before first use in the Codernauts test to avoid eating into the timeout during setup.

DanielleMaywood approved these changes Aug 19, 2026

View reviewed changes

github-actions Bot added the stale This issue is like stale bread. label Aug 27, 2026

github-actions Bot closed this Aug 31, 2026

bartekgatzcoder reopened this Sep 2, 2026

bartekgatzcoder removed the stale This issue is like stale bread. label Sep 2, 2026

Merge remote-tracking branch 'origin/main' into bartek/hide-codernaut…

78fd728

…s-toggle # Conflicts: # site/src/modules/dashboard/Navbar/UserDropdown/UserDropdownContent.tsx # site/src/pages/DeploymentSettingsPage/AppearanceSettingsPage/AppearanceSettingsPageView.tsx

bartekgatzcoder marked this pull request as ready for review September 2, 2026 09:29

bartekgatzcoder merged commit 55340de into main Sep 2, 2026
36 checks passed

bartekgatzcoder deleted the bartek/hide-codernauts-toggle branch September 2, 2026 09:29

github-actions Bot locked and limited conversation to collaborators Sep 2, 2026

	WHEN sqlc.arg(hide)::bool THEN 'true'
	WHEN @hide::bool THEN 'true'

		-- GetHideCodernauts returns whether the Codernauts game link is hidden
		-- from the user dropdown menu. Defaults to false when unset.

		// database may be nil when no store is available, in which case
		// runtime settings fall back to their zero values.

		ctx, cancel := context.WithTimeout(context.Background(), testutil.WaitLong)
		defer cancel()

Uh oh!

Conversation

bartekgatzcoder commented Jul 29, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

github-actions Bot commented Jul 29, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Docs preview

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

bartekgatzcoder commented Jul 29, 2026 •

edited

Loading

github-actions Bot commented Jul 29, 2026 •

edited

Loading