[dashboard] Migrate patches to upstream project - #1569
Merged
Conversation
Contributor
WalkthroughThis PR updates dashboard container images with new source commits, refactors API resource fetching from builtin to API-based resources, introduces namespace configuration environment variables, renames branding config keys with CUSTOM_ prefixes, and enhances form field handling for OpenAPI additionalProperties processing. Changes
Sequence DiagramsequenceDiagram
participant UI as Dashboard UI
participant Old as Builtin Resources<br/>(Legacy)
participant New as API Resources<br/>(New)
participant API as Kubernetes API
rect rgb(200, 220, 250)
note over UI,API: Old Flow
UI->>Old: useBuiltinResources()
Old->>API: fetch /api/v1/namespaces
API-->>Old: builtin namespaces
Old-->>UI: resource data
end
rect rgb(220, 250, 200)
note over UI,API: New Flow
UI->>New: useApiResources(apiGroup, apiVersion, resource)
New->>API: fetch /apis/core.cozystack.io/v1alpha1/tenantnamespaces
API-->>New: tenant namespaces
New-->>UI: resource data
end
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~25 minutes Areas requiring extra attention:
Possibly related PRs
Suggested reviewers
Poem
Pre-merge checks and finishing touches✅ Passed checks (2 passed)
✨ Finishing touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
[dashboard] Fix nested lists in addtiionalProperties Signed-off-by: Andrei Kvapil <kvapss@gmail.com>
Andrei Kvapil (kvaps)
force-pushed
the
dashboard-patches
branch
from
November 4, 2025 12:34
2c4d136 to
723eefe
Compare
Andrei Kvapil (kvaps)
marked this pull request as ready for review
November 4, 2025 12:59
Andrei Kvapil (kvaps)
requested review from
Timofei Larkin (lllamnyp) and
Nikita (nbykov0)
as code owners
November 4, 2025 12:59
Contributor
There was a problem hiding this comment.
Actionable comments posted: 1
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
packages/system/dashboard/images/openapi-ui/openapi-ui/patches/namespaces.diff (1)
77-89: Keep backlink path configurable.We now hard-code
/api-table/core.cozystack.io/v1alpha1/tenantnamespaces. Any cluster that overrides the namespace API group/version/resource via env vars (which this PR explicitly introduces) will land on the wrong route. Please build the path from the same constants/env-backed values used elsewhere (e.g.,BASE_PROJECTS_API_GROUP,BASE_PROJECTS_VERSION,BASE_PROJECTS_RESOURCE_NAME) instead of hard-coding the Cozystack defaults.Apply this diff to compose the backlink dynamically:
@@ -import { getClusterList } from 'store/clusterList/selectors' +import { getClusterList } from 'store/clusterList/selectors' +import { + BASE_PROJECTS_API_GROUP, + BASE_PROJECTS_VERSION, + BASE_PROJECTS_RESOURCE_NAME, +} from 'constants/customizationApiGroupAndVersion' @@ - return `${baseprefix}/${clusterName}/api-table/core.cozystack.io/v1alpha1/tenantnamespaces` + return `${baseprefix}/${clusterName}/api-table/${BASE_PROJECTS_API_GROUP}/${BASE_PROJECTS_VERSION}/${BASE_PROJECTS_RESOURCE_NAME}` @@ - return `${baseprefix}/${clusterName}/api-table/core.cozystack.io/v1alpha1/tenantnamespaces` + return `${baseprefix}/${clusterName}/api-table/${BASE_PROJECTS_API_GROUP}/${BASE_PROJECTS_VERSION}/${BASE_PROJECTS_RESOURCE_NAME}`
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (8)
packages/system/dashboard/images/openapi-ui-k8s-bff/Dockerfile(1 hunks)packages/system/dashboard/images/openapi-ui-k8s-bff/patches/namespaces.diff(0 hunks)packages/system/dashboard/images/openapi-ui/Dockerfile(2 hunks)packages/system/dashboard/images/openapi-ui/openapi-k8s-toolkit/patches/additional-properties-types.diff(1 hunks)packages/system/dashboard/images/openapi-ui/openapi-ui/patches/namespaces.diff(3 hunks)packages/system/dashboard/templates/configmap.yaml(2 hunks)packages/system/dashboard/templates/web.yaml(3 hunks)packages/system/dashboard/values.yaml(1 hunks)
💤 Files with no reviewable changes (1)
- packages/system/dashboard/images/openapi-ui-k8s-bff/patches/namespaces.diff
🧰 Additional context used
🧠 Learnings (2)
📚 Learning: 2025-05-14T16:58:01.478Z
Learnt from: nbykov0
Repo: cozystack/cozystack PR: 932
File: packages/system/dashboard/images/kubeapps-apis/Dockerfile:15-17
Timestamp: 2025-05-14T16:58:01.478Z
Learning: When working with Dockerfiles for cross-architecture builds in the kubeapps-apis component, the `TARGETOS` and `TARGETARCH` build arguments should be declared without default values so that Docker's buildx system can automatically set these variables based on the specified target platform.
Applied to files:
packages/system/dashboard/images/openapi-ui-k8s-bff/Dockerfilepackages/system/dashboard/images/openapi-ui/Dockerfile
📚 Learning: 2025-05-14T16:54:50.368Z
Learnt from: nbykov0
Repo: cozystack/cozystack PR: 932
File: packages/apps/kubernetes/images/cluster-autoscaler/Dockerfile:3-4
Timestamp: 2025-05-14T16:54:50.368Z
Learning: In Dockerfiles for the cozystack project, ARG ordering where a variable like ${TARGETARCH} is referenced before being declared can still work correctly in practice because Docker's BuildKit may evaluate the variable only when it's actually used in a FROM statement.
Applied to files:
packages/system/dashboard/images/openapi-ui/Dockerfile
🪛 YAMLlint (1.37.1)
packages/system/dashboard/templates/configmap.yaml
[warning] 22-22: too many spaces after colon
(colons)
[warning] 23-23: too many spaces after colon
(colons)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (2)
- GitHub Check: Test redis
- GitHub Check: Test kubernetes-previous
Comment on lines
+14
to
+43
| + let fieldItems: { type: string } | undefined = addProps.items | ||
| + let fieldNestedProperties = addProps.properties || {} | ||
| + let fieldRequired: string | undefined = addProps.required | ||
| + | ||
| + if (nestedProp) { | ||
| + // Use the nested property definition if it exists | ||
| + // Handle type - it can be string or string[] in OpenAPI v2 | ||
| + if (nestedProp.type) { | ||
| + if (Array.isArray(nestedProp.type)) { | ||
| + fieldType = nestedProp.type[0] || addProps.type | ||
| + } else if (typeof nestedProp.type === 'string') { | ||
| + fieldType = nestedProp.type | ||
| + } else { | ||
| + fieldType = addProps.type | ||
| + } | ||
| + } else { | ||
| + fieldType = addProps.type | ||
| + } | ||
| + | ||
| + // Handle items - it can be ItemsObject or ReferenceObject | ||
| + if (nestedProp.items) { | ||
| + // Check if it's a valid ItemsObject with type property | ||
| + if ('type' in nestedProp.items && typeof nestedProp.items.type === 'string') { | ||
| + fieldItems = { type: nestedProp.items.type } | ||
| + } else { | ||
| + fieldItems = addProps.items | ||
| + } | ||
| + } else { | ||
| + fieldItems = addProps.items | ||
| + } |
Contributor
There was a problem hiding this comment.
Don't strip schema metadata from array item definitions.
When we replace fieldItems with { type: nestedProp.items.type }, any richer schema attached to the array items (nested object properties, enums, $ref, etc.) is discarded. The UI then renders those entries as plain primitives, breaking scenarios where additionalProperties wraps arrays of complex types—exactly the workflows this patch set is meant to improve. We should preserve the full item schema (and keep the wider type for fieldItems) instead of collapsing it to a bare { type: string }.
Apply this diff to keep the full schema intact:
- let fieldItems: { type: string } | undefined = addProps.items
+ let fieldItems: OpenAPIV2.SchemaObject['items'] = addProps.items
...
- if (nestedProp.items) {
- // Check if it's a valid ItemsObject with type property
- if ('type' in nestedProp.items && typeof nestedProp.items.type === 'string') {
- fieldItems = { type: nestedProp.items.type }
- } else {
- fieldItems = addProps.items
- }
- } else {
- fieldItems = addProps.items
- }
+ if (nestedProp.items) {
+ fieldItems = nestedProp.items
+ } else {
+ fieldItems = addProps.items
+ }📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
Suggested change
| + let fieldItems: { type: string } | undefined = addProps.items | |
| + let fieldNestedProperties = addProps.properties || {} | |
| + let fieldRequired: string | undefined = addProps.required | |
| + | |
| + if (nestedProp) { | |
| + // Use the nested property definition if it exists | |
| + // Handle type - it can be string or string[] in OpenAPI v2 | |
| + if (nestedProp.type) { | |
| + if (Array.isArray(nestedProp.type)) { | |
| + fieldType = nestedProp.type[0] || addProps.type | |
| + } else if (typeof nestedProp.type === 'string') { | |
| + fieldType = nestedProp.type | |
| + } else { | |
| + fieldType = addProps.type | |
| + } | |
| + } else { | |
| + fieldType = addProps.type | |
| + } | |
| + | |
| + // Handle items - it can be ItemsObject or ReferenceObject | |
| + if (nestedProp.items) { | |
| + // Check if it's a valid ItemsObject with type property | |
| + if ('type' in nestedProp.items && typeof nestedProp.items.type === 'string') { | |
| + fieldItems = { type: nestedProp.items.type } | |
| + } else { | |
| + fieldItems = addProps.items | |
| + } | |
| + } else { | |
| + fieldItems = addProps.items | |
| + } | |
| let fieldItems: OpenAPIV2.SchemaObject['items'] = addProps.items | |
| let fieldNestedProperties = addProps.properties || {} | |
| let fieldRequired: string | undefined = addProps.required | |
| if (nestedProp) { | |
| // Use the nested property definition if it exists | |
| // Handle type - it can be string or string[] in OpenAPI v2 | |
| if (nestedProp.type) { | |
| if (Array.isArray(nestedProp.type)) { | |
| fieldType = nestedProp.type[0] || addProps.type | |
| } else if (typeof nestedProp.type === 'string') { | |
| fieldType = nestedProp.type | |
| } else { | |
| fieldType = addProps.type | |
| } | |
| } else { | |
| fieldType = addProps.type | |
| } | |
| // Handle items - it can be ItemsObject or ReferenceObject | |
| if (nestedProp.items) { | |
| fieldItems = nestedProp.items | |
| } else { | |
| fieldItems = addProps.items | |
| } |
🤖 Prompt for AI Agents
In
packages/system/dashboard/images/openapi-ui/openapi-k8s-toolkit/patches/additional-properties-types.diff
around lines 14 to 43, the code replaces fieldItems with a minimal { type:
string } when nestedProp.items exists, which strips richer schema metadata
(properties, enums, $ref) for array items; instead preserve the full item schema
by assigning fieldItems = nestedProp.items (and widen the fieldItems type to
accept the full ItemsObject|ReferenceObject|undefined union), only falling back
to addProps.items if nestedProp.items is absent; do not construct a new object
with just type.
|
Backport failed for Please cherry-pick the changes locally and resolve any conflicts. git fetch origin release-0.37
git worktree add -d .worktree/backport-1569-to-release-0.37 origin/release-0.37
cd .worktree/backport-1569-to-release-0.37
git switch --create backport-1569-to-release-0.37
git cherry-pick -x 723eefea66614b6a621413d0d48e3d5238cd53b6 |
Merged
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Signed-off-by: Andrei Kvapil kvapss@gmail.com
What this PR does
Release note
Summary by CodeRabbit
New Features
Bug Fixes
Chores