Skip to content

refactor: use core proto ShadowLinkTaskStatus in console and dataplane APIs #2054

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 5 commits into
base: master
Choose a base branch
from
Open

refactor: use core proto ShadowLinkTaskStatus in console and dataplane APIs #2054

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
f17588d
refactor: use core proto ShadowLinkTaskStatus in console and dataplan…
c-julin Dec 1, 2025
4c25c2a
fix: exclude imported proto breaking changes from CI validation
c-julin Dec 1, 2025
21ba101
chore: regenerate OpenAPI specs from updated proto definitions
c-julin Dec 1, 2025
ec4e442
fix: update proto import paths for ACL and TLS types
c-julin Dec 1, 2025
d0e93c6
docs: regenned docs after rebase
c-julin Dec 1, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 6 additions & 5 deletions .github/workflows/buf.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,15 +44,16 @@ jobs:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v5
- name: Buf – lint, format & breaking
- name: Buf – lint & format
uses: bufbuild/buf-action@v1
with:
lint: true
format: true
breaking: true
push: false # Only validate, don't push to registry
# Compare against the default branch so the whole PR is checked
breaking_against: https://github.com/redpanda-data/console.git#branch=master
breaking: false
push: false
- uses: bufbuild/buf-setup-action@v1
- name: Buf – breaking (excluding imports)
run: buf breaking --against 'https://github.com/redpanda-data/console.git#branch=master' --exclude-imports
Copy link
Contributor Author

@c-julin c-julin Dec 1, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

adding this in but can be temporary but because of the core breaking changes this rule fails

Copy link
Contributor

@r-vasquez r-vasquez Dec 1, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You can also add a label to this PR and introduce a breaking change: https://buf.build/docs/bsr/ci-cd/github-actions/#skip-breaking-change-detection-using-labels, which can help us in the future as we introduce more changes from alpha/beta versions.


# ===========================================================================
# Job: push-to-registry (push events only - registry operations only)
Expand Down
645 changes: 236 additions & 409 deletions backend/pkg/protogen/redpanda/api/console/v1alpha1/shadowlink.pb.go
View file
Open in desktop

Large diffs are not rendered by default.

607 changes: 217 additions & 390 deletions backend/pkg/protogen/redpanda/api/dataplane/v1alpha3/shadowlink.pb.go
View file
Open in desktop

Large diffs are not rendered by default.

12 changes: 6 additions & 6 deletions buf.lock
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,14 +5,14 @@ deps:
commit: 52f32327d4b045a79293a6ad4e7e1236
digest: b5:cbabc98d4b7b7b0447c9b15f68eeb8a7a44ef8516cb386ac5f66e7fd4062cd6723ed3f452ad8c384b851f79e33d26e7f8a94e2b807282b3def1cd966c7eace97
- name: buf.build/googleapis/googleapis
commit: 72c8614f3bd0466ea67931ef2c43d608
digest: b5:13efeea24e633fd45327390bdee941207a8727e96cf01affb84c1e4100fd8f48a42bbd508df11930cd2884629bafad685df1ac3111bc78cdaefcd38c9371c6b1
commit: 004180b77378443887d3b55cabc00384
digest: b5:e8f475fe3330f31f5fd86ac689093bcd274e19611a09db91f41d637cb9197881ce89882b94d13a58738e53c91c6e4bae7dc1feba85f590164c975a89e25115dc
- name: buf.build/grpc-ecosystem/grpc-gateway
commit: a48fcebcf8f140dd9d09359b9bb185a4
digest: b5:330af8a71b579ab96c4f3ee26929d1a68a5a9e986c7cfe0a898591fc514216bb6e723dc04c74d90fdee3f3f14f9100a54b4f079eb273e6e7213f0d5baca36ff8
- name: buf.build/redpandadata/common
commit: 9feeb258823648009d54c7c2b8a22524
digest: b5:669904f69cff7bf106d81dd30f417dcc64f511da31db1abff2ace9fc4530580ce8da68eb8f5863f6c36d6bb6d9209a6cc61239144f968eae9bbe249440111762
commit: bb850a94466341c69a738988c0be5a4b
digest: b5:d566ba6746a874a5709970e7f8569584008447d655c556676aabd3430111bbbc0a303dde11d99a1955ee27ac4748bcf7c972503a66db4ef850eb55f239f851ac
- name: buf.build/redpandadata/core
commit: e0f79c48b9f04c029d710985687bc1e5
digest: b5:9f8ccc94057f489f4df2c8a12d0fbcf66d15ea9d891df90eb5baa8b7f299a9071f2d844d0e18e65b609ae827c79833900c341fa7afaee4be33da0d25165923f2
commit: 05aa34b3829a4d5a801d9487623a7c76
digest: b5:ca0d5205224273e79678fb4b46bea0bedd25574e148325947b2a0af7893d595dbcf0756ac35be7f445e313de67469ed61f5fe3a2cf5eeca167fe5192b40dcb7a
4 changes: 3 additions & 1 deletion buf.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ deps:
- buf.build/googleapis/googleapis
- buf.build/grpc-ecosystem/grpc-gateway:v2.24.0
- buf.build/redpandadata/common
- buf.build/redpandadata/core:e0f79c48b9f04c029d710985687bc1e5
- buf.build/redpandadata/core:05aa34b3829a4d5a801d9487623a7c76
lint:
use:
- STANDARD
Expand All @@ -30,3 +30,5 @@ breaking:
- proto/redpanda/api/dataplane/v1alpha1
- proto/redpanda/api/dataplane/v1alpha3
- proto/redpanda/api/dataplane/v1/mcp.proto
- proto/redpanda/api/dataplane/v1/secret.proto
ignore_unstable_packages: true
2 changes: 1 addition & 1 deletion frontend/src/components/pages/shadowlinks/create/configuration/acls-step.test.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@

import { zodResolver } from '@hookform/resolvers/zod';
import { Form } from 'components/redpanda-ui/components/form';
import { ACLOperation, ACLPattern, ACLPermissionType, ACLResource } from 'protogen/redpanda/core/common/acl_pb';
import { ACLOperation, ACLPattern, ACLPermissionType, ACLResource } from 'protogen/redpanda/core/common/v1/acl_pb';
import { useForm } from 'react-hook-form';
import { fireEvent, render, screen, waitFor, within } from 'test-utils';

Expand Down
2 changes: 1 addition & 1 deletion frontend/src/components/pages/shadowlinks/create/configuration/acls-step.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ import {
} from 'components/redpanda-ui/components/select';
import { Tabs, TabsContent, TabsList, TabsTrigger } from 'components/redpanda-ui/components/tabs';
import { ChevronDown, Info, X } from 'lucide-react';
import { ACLOperation, ACLPattern, ACLPermissionType, ACLResource } from 'protogen/redpanda/core/common/acl_pb';
import { ACLOperation, ACLPattern, ACLPermissionType, ACLResource } from 'protogen/redpanda/core/common/v1/acl_pb';
import { useState } from 'react';
import { useFieldArray, useFormContext, useWatch } from 'react-hook-form';

Expand Down
2 changes: 1 addition & 1 deletion frontend/src/components/pages/shadowlinks/create/model.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
*/

import { FilterType, PatternType, ScramMechanism } from 'protogen/redpanda/core/admin/v2/shadow_link_pb';
import { ACLOperation, ACLPattern, ACLPermissionType, ACLResource } from 'protogen/redpanda/core/common/acl_pb';
import { ACLOperation, ACLPattern, ACLPermissionType, ACLResource } from 'protogen/redpanda/core/common/v1/acl_pb';
import { z } from 'zod';

// TLS mode: either file paths or PEM content
Expand Down
4 changes: 2 additions & 2 deletions frontend/src/components/pages/shadowlinks/create/shadowlink-create-page.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,9 +30,9 @@ import {
ShadowLinkClientOptionsSchema,
ShadowLinkConfigurationsSchema,
ShadowLinkSchema,
TLSSettingsSchema,
TopicMetadataSyncOptionsSchema,
} from 'protogen/redpanda/core/admin/v2/shadow_link_pb';
import { TLSSettingsSchema } from 'protogen/redpanda/core/common/v1/tls_pb';
import { useEffect } from 'react';
import { useForm } from 'react-hook-form';
import { useNavigate } from 'react-router-dom';
Expand All @@ -47,7 +47,7 @@ import {
ACLPattern,
ACLPermissionType,
ACLResource,
} from '../../../../protogen/redpanda/core/common/acl_pb';
} from '../../../../protogen/redpanda/core/common/v1/acl_pb';
import { useCreateShadowLinkMutation } from '../../../../react-query/api/shadowlink';
import { buildTLSSettings } from '../edit/shadowlink-edit-utils';

Expand Down
2 changes: 1 addition & 1 deletion frontend/src/components/pages/shadowlinks/details/config/tls-certificates-config.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
*/

import { Text } from 'components/redpanda-ui/components/typography';
import type { TLSSettings } from 'protogen/redpanda/core/admin/v2/shadow_link_pb';
import type { TLSSettings } from 'protogen/redpanda/core/common/v1/tls_pb';
import type React from 'react';

const ConfigField = ({ label, value, testId }: { label: string; value: React.ReactNode; testId?: string }) => (
Expand Down
2 changes: 1 addition & 1 deletion frontend/src/components/pages/shadowlinks/details/task-status-badge.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
*/

import { Badge } from 'components/redpanda-ui/components/badge';
import { TaskState } from 'protogen/redpanda/api/dataplane/v1alpha3/shadowlink_pb';
import { TaskState } from 'protogen/redpanda/core/admin/v2/shadow_link_pb';

type TaskStatusBadgeProps = {
state: TaskState;
Expand Down
4 changes: 2 additions & 2 deletions frontend/src/components/pages/shadowlinks/details/tasks-table.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ import { Card, CardAction, CardContent, CardHeader, CardTitle } from 'components
import { Table, TableBody, TableCell, TableHead, TableHeader, TableRow } from 'components/redpanda-ui/components/table';
import { Text } from 'components/redpanda-ui/components/typography';
import { RefreshCw } from 'lucide-react';
import type { ShadowLinkTaskStatus } from 'protogen/redpanda/api/dataplane/v1alpha3/shadowlink_pb';
import type { ShadowLinkTaskStatus } from 'protogen/redpanda/core/admin/v2/shadow_link_pb';
import { useMemo } from 'react';

import { TaskStatusBadge } from './task-status-badge';
Expand Down Expand Up @@ -51,7 +51,7 @@ export const TasksTable = ({ tasks, onRefresh }: TasksTableProps) => {
size: 100,
cell: (info) => <Text>{info.getValue()}</Text>,
}),
columnHelper.accessor('shardId', {
columnHelper.accessor('shard', {
header: 'Shard ID',
size: 100,
cell: (info) => <Text>{info.getValue()}</Text>,
Expand Down
2 changes: 1 addition & 1 deletion frontend/src/components/pages/shadowlinks/edit/get-update-values-for-acls.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
*/

import { ScramMechanism } from 'protogen/redpanda/core/admin/v2/shadow_link_pb';
import { ACLOperation, ACLPattern, ACLPermissionType, ACLResource } from 'protogen/redpanda/core/common/acl_pb';
import { ACLOperation, ACLPattern, ACLPermissionType, ACLResource } from 'protogen/redpanda/core/common/v1/acl_pb';
import { describe, expect, test } from 'vitest';

import { getUpdateValuesForACLs } from './shadowlink-edit-utils';
Expand Down
2 changes: 1 addition & 1 deletion frontend/src/components/pages/shadowlinks/edit/shadowlink-edit-page.test.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ import {
ShadowLinkState,
TopicMetadataSyncOptionsSchema,
} from 'protogen/redpanda/core/admin/v2/shadow_link_pb';
import { ACLOperation, ACLPattern, ACLPermissionType, ACLResource } from 'protogen/redpanda/core/common/acl_pb';
import { ACLOperation, ACLPattern, ACLPermissionType, ACLResource } from 'protogen/redpanda/core/common/v1/acl_pb';
import { MemoryRouter, Route, Routes } from 'react-router-dom';
import { beforeEach, describe, expect, test, vi } from 'vitest';

Expand Down
8 changes: 5 additions & 3 deletions frontend/src/components/pages/shadowlinks/edit/shadowlink-edit-utils.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,13 +23,15 @@ import {
SecuritySettingsSyncOptionsSchema,
type ShadowLinkClientOptions,
ShadowLinkClientOptionsSchema,
TopicMetadataSyncOptionsSchema,
} from 'protogen/redpanda/core/admin/v2/shadow_link_pb';
import { ACLOperation, ACLPattern, ACLPermissionType, ACLResource } from 'protogen/redpanda/core/common/v1/acl_pb';
import {
TLSFileSettingsSchema,
TLSPEMSettingsSchema,
type TLSSettings,
TLSSettingsSchema,
TopicMetadataSyncOptionsSchema,
} from 'protogen/redpanda/core/admin/v2/shadow_link_pb';
import { ACLOperation, ACLPattern, ACLPermissionType, ACLResource } from 'protogen/redpanda/core/common/acl_pb';
} from 'protogen/redpanda/core/common/v1/tls_pb';

import type { FormValues } from '../create/model';
import { TLS_MODE } from '../create/model';
Expand Down
2 changes: 1 addition & 1 deletion frontend/src/components/pages/shadowlinks/shadowlink-helpers.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
*/

import { FilterType, PatternType } from 'protogen/redpanda/core/admin/v2/shadow_link_pb';
import { ACLOperation, ACLPattern, ACLPermissionType, ACLResource } from 'protogen/redpanda/core/common/acl_pb';
import { ACLOperation, ACLPattern, ACLPermissionType, ACLResource } from 'protogen/redpanda/core/common/v1/acl_pb';
import { describe, expect, test } from 'vitest';

import {
Expand Down
2 changes: 1 addition & 1 deletion frontend/src/components/pages/shadowlinks/shadowlink-helpers.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
*/

import { FilterType, PatternType } from 'protogen/redpanda/core/admin/v2/shadow_link_pb';
import { ACLOperation, ACLPattern, ACLPermissionType, ACLResource } from 'protogen/redpanda/core/common/acl_pb';
import { ACLOperation, ACLPattern, ACLPermissionType, ACLResource } from 'protogen/redpanda/core/common/v1/acl_pb';

// Helper function to get filter label from pattern and filter type
export const getFilterTypeLabel = (patternType: PatternType, filterType: FilterType): string => {
Expand Down
Loading
Loading