feat: make dynamic parameters opt-in by default for new templates #19006

jaaydenh · 2025-07-22T22:16:58Z

No description provided.

jaaydenh · 2025-07-22T22:37:19Z

coderabbitai · 2025-07-22T22:37:25Z

✅ Actions performed

Review triggered.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

coderabbitai · 2025-07-22T22:43:14Z

📝 Walkthrough

Walkthrough

The changes update the default value of the UseClassicParameterFlow flag for templates from true to false across backend logic, API handlers, and test data. Frontend updates introduce a new deprecation warning component for the classic parameter flow, integrate permission checks for updating templates, and propagate these permissions through relevant components. Several documentation links are updated, and associated tests and stories are adjusted accordingly.

Changes

File(s)	Change Summary
coderd/database/dbgen/dbgen.go, coderd/templates.go	Changed default value of `UseClassicParameterFlow` from `true` to `false` in backend template logic and API handler.
coderd/insights_test.go, coderd/templates_test.go	Updated tests to expect or set `UseClassicParameterFlow: true` only when required; default expectation is now `false`.
site/src/testHelpers/entities.ts	Changed mock data: `use_classic_parameter_flow` and `template_use_classic_parameter_flow` from `true` to `false`.
site/src/modules/workspaces/ClassicParameterFlowDeprecationWarning/ClassicParameterFlowDeprecationWarning.tsx	Added new React component to display a deprecation warning for classic parameter flow.
site/src/modules/workspaces/ClassicParameterFlowDeprecationWarning/ClassicParameterFlowDeprecationWarning.test.tsx	Added tests for the new deprecation warning component.
site/src/pages/CreateWorkspacePage/CreateWorkspacePage.tsx	Added React Query hook to fetch template update permissions; passed permissions to child component.
site/src/pages/CreateWorkspacePage/CreateWorkspacePageView.tsx	Added new prop `templatePermissions` and rendered the deprecation warning component.
site/src/pages/CreateWorkspacePage/CreateWorkspacePageView.stories.tsx	Added `templatePermissions` prop to Storybook default args.
site/src/pages/CreateWorkspacePage/CreateWorkspacePageViewExperimental.tsx, site/src/pages/WorkspaceSettingsPage/WorkspaceParametersPage/WorkspaceParametersPageExperimental.tsx, site/src/pages/WorkspaceSettingsPage/WorkspaceParametersPage/WorkspaceParametersPageViewExperimental.tsx	Updated documentation links to new dynamic parameters path.
site/src/pages/TemplateSettingsPage/TemplateGeneralSettingsPage/TemplateSettingsForm.tsx	Updated label and helper text for dynamic parameters checkbox; updated documentation link.
site/src/pages/WorkspaceSettingsPage/WorkspaceParametersPage/WorkspaceParametersPage.tsx	Added React Query hook for template update permissions; passed permissions through component hierarchy.
site/src/pages/WorkspaceSettingsPage/WorkspaceParametersPage/WorkspaceParametersForm.tsx	Added `templatePermissions` prop and rendered deprecation warning component.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant CreateWorkspacePage
    participant TemplatePermissionsQuery
    participant CreateWorkspacePageView
    participant ClassicParameterFlowDeprecationWarning

    User->>CreateWorkspacePage: Load page
    CreateWorkspacePage->>TemplatePermissionsQuery: Fetch canUpdateTemplate
    TemplatePermissionsQuery-->>CreateWorkspacePage: Return permission data
    CreateWorkspacePage->>CreateWorkspacePageView: Render with templatePermissions
    CreateWorkspacePageView->>ClassicParameterFlowDeprecationWarning: Render warning if enabled and canUpdateTemplate

sequenceDiagram
    participant User
    participant WorkspaceParametersPage
    participant TemplatePermissionsQuery
    participant WorkspaceParametersPageView
    participant WorkspaceParametersForm
    participant ClassicParameterFlowDeprecationWarning

    User->>WorkspaceParametersPage: Load page
    WorkspaceParametersPage->>TemplatePermissionsQuery: Fetch canUpdateTemplate
    TemplatePermissionsQuery-->>WorkspaceParametersPage: Return permission data
    WorkspaceParametersPage->>WorkspaceParametersPageView: Render with templatePermissions
    WorkspaceParametersPageView->>WorkspaceParametersForm: Pass templatePermissions
    WorkspaceParametersForm->>ClassicParameterFlowDeprecationWarning: Render warning if enabled and canUpdateTemplate

Estimated code review effort

3 (~45 minutes)

✨ Finishing Touches

📝 Generate Docstrings

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

Review comments: Directly reply to a review comment made by CodeRabbit. Example:
- I pushed a fix in commit <commit_id>, please review it.
- Explain this complex logic.
- Open a follow-up GitHub issue for this discussion.
Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
- @coderabbitai explain this code block.
- @coderabbitai modularize this function.
PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
- @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
- @coderabbitai read src/utils.ts and explain its main purpose.
- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
- @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

@coderabbitai pause to pause the reviews on a PR.
@coderabbitai resume to resume the paused reviews.
@coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
@coderabbitai full review to do a full review from scratch and review all the files again.
@coderabbitai summary to regenerate the summary of the PR.
@coderabbitai generate docstrings to generate docstrings for this PR.
@coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
@coderabbitai resolve resolve all the CodeRabbit review comments.
@coderabbitai configuration to show the current CodeRabbit configuration for the repository.
@coderabbitai help to get help.

Other keywords and placeholders

Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
Add @coderabbitai anywhere in the PR title to generate the title automatically.

Documentation and Community

Visit our Documentation for detailed information on how to use CodeRabbit.
Join our Discord Community to get help, request features, and share feedback.
Follow us on X/Twitter for updates and announcements.

coderabbitai

Actionable comments posted: 2

♻️ Duplicate comments (1)

site/src/pages/CreateWorkspacePage/CreateWorkspacePageViewExperimental.tsx (1)

545-548: Same duplication as above

Refer to the previous comment – same literal, same recommendation.

🧹 Nitpick comments (6)

site/src/pages/WorkspaceSettingsPage/WorkspaceParametersPage/WorkspaceParametersPageViewExperimental.tsx (1)

213-214: Centralise docs URL to avoid future drift

The same /admin/templates/extending-templates/dynamic-parameters slug is now hard-coded here and in several other files. Expose it via a shared constant (e.g. DOCS_DYNAMIC_PARAMETERS) or extend the docs() helper to accept a well-named key.
This prevents silent divergence if the path changes again.

site/src/pages/CreateWorkspacePage/CreateWorkspacePageViewExperimental.tsx (1)

396-399: Duplicate literal docs path – extract to constant

Two identical string literals were introduced in this component (see also the Parameters section below). Moving the slug to a shared constant keeps the UI and docs in sync and avoids scattered hot-fixes next time the URL changes.
coderd/insights_test.go (1)
668-672: Consider adding a clarifying comment for consistency.

For better maintainability and consistency with the similar change at line 1564, consider adding a comment explaining why UseClassicParameterFlow: true is explicitly set here.
 			createdTemplate := dbgen.Template(t, db, database.Template{
 				ID:                      template.id,
 				ActiveVersionID:         version.ID,
 				OrganizationID:          firstUser.OrganizationID,
 				CreatedBy:               firstUser.UserID,
-				UseClassicParameterFlow: true,
+				UseClassicParameterFlow: true, // Required for testing legacy parameter flow behavior
 				GroupACL: database.TemplateACL{
site/src/pages/TemplateSettingsPage/TemplateGeneralSettingsPage/TemplateSettingsForm.tsx (1)

1-1: Note: MUI components present - consider migration.

This file uses deprecated MUI components (Checkbox, FormControlLabel, TextField, etc.). While not introduced by this PR, consider migrating these to newer component alternatives in future work.
site/src/testHelpers/entities.ts (1)
829-829: Avoid hard-coded duplicate default – reuse a shared constant

The literal false is now duplicated across mocks. Extracting a DEFAULT_USE_CLASSIC_PARAMETER_FLOW constant (or deriving the value from the template when constructing the workspace) will keep test helpers in sync the next time this default changes.
-	use_classic_parameter_flow: false,
+	use_classic_parameter_flow: DEFAULT_USE_CLASSIC_PARAMETER_FLOW,
site/src/modules/workspaces/ClassicParameterFlowDeprecationWarning/ClassicParameterFlowDeprecationWarning.tsx (1)
28-30: Improve the deprecation message clarity.

The phrase "dynamic improved functionality" is awkward and unclear. Consider rephrasing for better user experience.
 This template is using the classic parameter flow, which will be{" "}
 <strong>deprecated</strong> in a future release. Please migrate to
-dynamic improved functionality.
+the improved dynamic parameter flow.

📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between f41275e and a62ba63.

📒 Files selected for processing (16)

coderd/database/dbgen/dbgen.go (1 hunks)
coderd/insights_test.go (2 hunks)
coderd/templates.go (1 hunks)
coderd/templates_test.go (2 hunks)
site/src/modules/workspaces/ClassicParameterFlowDeprecationWarning/ClassicParameterFlowDeprecationWarning.test.tsx (1 hunks)
site/src/modules/workspaces/ClassicParameterFlowDeprecationWarning/ClassicParameterFlowDeprecationWarning.tsx (1 hunks)
site/src/pages/CreateWorkspacePage/CreateWorkspacePage.tsx (3 hunks)
site/src/pages/CreateWorkspacePage/CreateWorkspacePageView.stories.tsx (1 hunks)
site/src/pages/CreateWorkspacePage/CreateWorkspacePageView.tsx (4 hunks)
site/src/pages/CreateWorkspacePage/CreateWorkspacePageViewExperimental.tsx (2 hunks)
site/src/pages/TemplateSettingsPage/TemplateGeneralSettingsPage/TemplateSettingsForm.tsx (1 hunks)
site/src/pages/WorkspaceSettingsPage/WorkspaceParametersPage/WorkspaceParametersForm.tsx (4 hunks)
site/src/pages/WorkspaceSettingsPage/WorkspaceParametersPage/WorkspaceParametersPage.tsx (5 hunks)
site/src/pages/WorkspaceSettingsPage/WorkspaceParametersPage/WorkspaceParametersPageExperimental.tsx (2 hunks)
site/src/pages/WorkspaceSettingsPage/WorkspaceParametersPage/WorkspaceParametersPageViewExperimental.tsx (1 hunks)
site/src/testHelpers/entities.ts (2 hunks)

🧠 Learnings (9)

site/src/pages/CreateWorkspacePage/CreateWorkspacePageViewExperimental.tsx (3)

Learnt from: CR
PR: coder/coder#0
File: site/CLAUDE.md:0-0
Timestamp: 2025-07-21T14:33:50.919Z
Learning: Applies to site/src/**/*.tsx : MUI components are deprecated - migrate away from these when encountered

Learnt from: CR
PR: coder/coder#0
File: site/CLAUDE.md:0-0
Timestamp: 2025-07-21T14:33:50.919Z
Learning: Applies to site/src/**/*.tsx : Use functional updates (setX(prev ⇒ …)) whenever next state depends on previous state.

Learnt from: CR
PR: coder/coder#0
File: site/CLAUDE.md:0-0
Timestamp: 2025-07-21T14:33:50.919Z
Learning: Applies to site/src/**/*.tsx : Leverage custom color tokens: content-primary, surface-secondary, etc.

site/src/pages/WorkspaceSettingsPage/WorkspaceParametersPage/WorkspaceParametersPageExperimental.tsx (2)

Learnt from: CR
PR: coder/coder#0
File: site/CLAUDE.md:0-0
Timestamp: 2025-07-21T14:33:50.919Z
Learning: Applies to site/src/**/*.tsx : MUI components are deprecated - migrate away from these when encountered

Learnt from: CR
PR: coder/coder#0
File: site/CLAUDE.md:0-0
Timestamp: 2025-07-21T14:33:50.919Z
Learning: Applies to site/src/**/*.tsx : Use functional updates (setX(prev ⇒ …)) whenever next state depends on previous state.

site/src/modules/workspaces/ClassicParameterFlowDeprecationWarning/ClassicParameterFlowDeprecationWarning.test.tsx (4)

Learnt from: CR
PR: coder/coder#0
File: site/CLAUDE.md:0-0
Timestamp: 2025-07-21T14:33:50.919Z
Learning: Applies to site/src/**/*.tsx : MUI components are deprecated - migrate away from these when encountered

Learnt from: CR
PR: coder/coder#0
File: .cursorrules:0-0
Timestamp: 2025-07-21T14:32:43.035Z
Learning: Applies to site/src/**/*.test.{ts,tsx,js,jsx} : React components and pages are organized in the site/src/ directory, with Jest used for testing.

Learnt from: CR
PR: coder/coder#0
File: site/CLAUDE.md:0-0
Timestamp: 2025-07-21T14:33:50.919Z
Learning: Applies to site/src/**/*.tsx : Emotion CSS is deprecated. Use Tailwind CSS instead.

Learnt from: CR
PR: coder/coder#0
File: site/CLAUDE.md:0-0
Timestamp: 2025-07-21T14:33:50.919Z
Learning: Applies to site/src/**/*.{ts,tsx} : Components and custom Hooks must be pure and idempotent—same inputs → same output; move side-effects to event handlers or Effects.

site/src/pages/CreateWorkspacePage/CreateWorkspacePageView.tsx (9)

Learnt from: CR
PR: coder/coder#0
File: site/CLAUDE.md:0-0
Timestamp: 2025-07-21T14:33:50.919Z
Learning: Applies to site/src/**/*.tsx : MUI components are deprecated - migrate away from these when encountered

Learnt from: CR
PR: coder/coder#0
File: site/CLAUDE.md:0-0
Timestamp: 2025-07-21T14:33:50.919Z
Learning: Applies to site/src/**/*.tsx : Emotion CSS is deprecated. Use Tailwind CSS instead.

Learnt from: CR
PR: coder/coder#0
File: site/CLAUDE.md:0-0
Timestamp: 2025-07-21T14:33:50.919Z
Learning: Applies to site/src/**/*.{ts,tsx} : Never mutate props, state, or values returned by Hooks. Always create new objects or use the setter from useState.

Learnt from: CR
PR: coder/coder#0
File: site/CLAUDE.md:0-0
Timestamp: 2025-07-21T14:33:50.919Z
Learning: Applies to site/src/**/*.tsx : Use shadcn/ui components first - check site/src/components for existing implementations

Learnt from: CR
PR: coder/coder#0
File: site/CLAUDE.md:0-0
Timestamp: 2025-07-21T14:33:50.919Z
Learning: Applies to site/src/**/*.{ts,tsx} : Components and custom Hooks must be pure and idempotent—same inputs → same output; move side-effects to event handlers or Effects.

Learnt from: CR
PR: coder/coder#0
File: site/CLAUDE.md:0-0
Timestamp: 2025-07-21T14:33:50.919Z
Learning: Applies to site/src/**/*.{ts,tsx} : Never pass Hooks around as values or mutate them dynamically. Keep Hook usage static and local to each component.

Learnt from: CR
PR: coder/coder#0
File: site/CLAUDE.md:0-0
Timestamp: 2025-07-21T14:33:50.919Z
Learning: Applies to site/src/**/*.{ts,tsx} : Don’t call Hooks (including useRef) inside loops, conditions, or map(). Extract a child component instead.

Learnt from: CR
PR: coder/coder#0
File: site/CLAUDE.md:0-0
Timestamp: 2025-07-21T14:33:50.919Z
Learning: Applies to site/src/**/*.tsx : Use functional updates (setX(prev ⇒ …)) whenever next state depends on previous state.

Learnt from: CR
PR: coder/coder#0
File: site/CLAUDE.md:0-0
Timestamp: 2025-07-21T14:33:50.919Z
Learning: Applies to site/src/**/*.{ts,tsx} : Only call Hooks from React functions. Regular JS functions, classes, event handlers, useMemo, etc. are off-limits.

site/src/pages/CreateWorkspacePage/CreateWorkspacePage.tsx (1)

Learnt from: CR
PR: coder/coder#0
File: site/CLAUDE.md:0-0
Timestamp: 2025-07-21T14:33:50.919Z
Learning: Applies to site/src/**/*.{ts,tsx} : Never mutate props, state, or values returned by Hooks. Always create new objects or use the setter from useState.

site/src/modules/workspaces/ClassicParameterFlowDeprecationWarning/ClassicParameterFlowDeprecationWarning.tsx (6)

Learnt from: CR
PR: coder/coder#0
File: site/CLAUDE.md:0-0
Timestamp: 2025-07-21T14:33:50.919Z
Learning: Applies to site/src/**/*.tsx : MUI components are deprecated - migrate away from these when encountered

Learnt from: CR
PR: coder/coder#0
File: site/CLAUDE.md:0-0
Timestamp: 2025-07-21T14:33:50.919Z
Learning: Applies to site/src/**/*.tsx : Emotion CSS is deprecated. Use Tailwind CSS instead.

Learnt from: CR
PR: coder/coder#0
File: site/CLAUDE.md:0-0
Timestamp: 2025-07-21T14:33:50.919Z
Learning: Applies to site/src/**/*.{ts,tsx} : Components and custom Hooks must be pure and idempotent—same inputs → same output; move side-effects to event handlers or Effects.

Learnt from: CR
PR: coder/coder#0
File: site/CLAUDE.md:0-0
Timestamp: 2025-07-21T14:33:50.919Z
Learning: Applies to site/src/**/*.{ts,tsx} : Never mutate props, state, or values returned by Hooks. Always create new objects or use the setter from useState.

Learnt from: CR
PR: coder/coder#0
File: site/CLAUDE.md:0-0
Timestamp: 2025-07-21T14:33:50.919Z
Learning: Applies to site/src/**/*.tsx : Replace Emotion css prop with Tailwind classes

Learnt from: CR
PR: coder/coder#0
File: site/CLAUDE.md:0-0
Timestamp: 2025-07-21T14:33:50.919Z
Learning: Applies to site/src/**/*.{ts,tsx} : Never pass Hooks around as values or mutate them dynamically. Keep Hook usage static and local to each component.

site/src/pages/WorkspaceSettingsPage/WorkspaceParametersPage/WorkspaceParametersForm.tsx (4)

Learnt from: CR
PR: coder/coder#0
File: site/CLAUDE.md:0-0
Timestamp: 2025-07-21T14:33:50.919Z
Learning: Applies to site/src/**/*.tsx : MUI components are deprecated - migrate away from these when encountered

Learnt from: CR
PR: coder/coder#0
File: site/CLAUDE.md:0-0
Timestamp: 2025-07-21T14:33:50.919Z
Learning: Applies to site/src/**/*.tsx : Emotion CSS is deprecated. Use Tailwind CSS instead.

Learnt from: CR
PR: coder/coder#0
File: site/CLAUDE.md:0-0
Timestamp: 2025-07-21T14:33:50.919Z
Learning: Applies to site/src/**/*.{ts,tsx} : Components and custom Hooks must be pure and idempotent—same inputs → same output; move side-effects to event handlers or Effects.

Learnt from: CR
PR: coder/coder#0
File: site/CLAUDE.md:0-0
Timestamp: 2025-07-21T14:33:50.919Z
Learning: Applies to site/src/**/*.tsx : Use shadcn/ui components first - check site/src/components for existing implementations

site/src/pages/WorkspaceSettingsPage/WorkspaceParametersPage/WorkspaceParametersPage.tsx (1)

Learnt from: CR
PR: coder/coder#0
File: site/CLAUDE.md:0-0
Timestamp: 2025-07-21T14:33:50.919Z
Learning: Applies to site/src/**/*.{ts,tsx} : Never mutate props, state, or values returned by Hooks. Always create new objects or use the setter from useState.

coderd/templates_test.go (2)

Learnt from: CR
PR: coder/coder#0
File: CLAUDE.md:0-0
Timestamp: 2025-07-21T14:32:56.474Z
Learning: Applies to **/*_test.go : Never use hardcoded names in concurrent Go tests

Learnt from: CR
PR: coder/coder#0
File: .cursorrules:0-0
Timestamp: 2025-07-21T14:32:43.035Z
Learning: Applies to **/*_test.go : All tests must use t.Parallel() to run concurrently, which improves test suite performance and helps identify race conditions.

🧰 Additional context used