Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
14 changes: 13 additions & 1 deletion src/components/Learn/tours/registry.ts
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,12 @@ export type TourStep = StepType & {
| "navigate-to-root"
| "unpack-subgraph"
| "multi-select-tasks"
| "create-subgraph";
| "create-subgraph"
| "open-secret-dialog"
| "open-settings-panel"
| "open-submit-dialog"
| "assign-secret-argument"
| "assign-secret-submit";
targetWindowId?: string;
targetWindowName?: string;
targetFolderName?: string;
Expand All @@ -34,6 +39,7 @@ export type TourStep = StepType & {
targetPortName?: string;
};
ringSelectors?: string[];
tourPanel?: "secrets-manager";
resetLibrarySearch?: boolean;
ensureWindowRestored?: string;
requiresTaskSelected?: string;
Expand All @@ -45,6 +51,12 @@ export interface TourDefinition {
displayName?: string;
requiresEditor?: boolean;
starterPipelineUrl?: string;
/**
* When true, a tour running without a real backend mocks the secrets backend
* in-memory so its backend-dependent steps stay hands-on (see
* tourMockBackend). With a real backend this has no effect.
*/
mockBackend?: boolean;
steps: TourStep[];
}

Expand Down
11 changes: 10 additions & 1 deletion src/components/shared/SecretsManagement/SelectSecretDialog.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,11 @@ import { ScrollArea } from "@/components/ui/scroll-area";
import { Separator } from "@/components/ui/separator";
import { Spinner } from "@/components/ui/spinner";
import { Text } from "@/components/ui/typography";
import { useBackend } from "@/providers/BackendProvider";
import { useTourMockBackend } from "@/providers/TourProvider/tourMockBackend";

import { AddSecretForm } from "./components/AddSecretForm";
import { SecretsBackendUnavailable } from "./components/SecretsBackendUnavailable";
import { fetchSecretsList } from "./secretsStorage";
import { type Secret, SecretsQueryKeys } from "./types";

Expand Down Expand Up @@ -189,6 +192,8 @@ export function SelectSecretDialog({
onOpenChange,
onSelect,
}: SelectSecretDialogProps) {
const { available } = useBackend();
const mockBackend = useTourMockBackend();
const handleSelect = (secretName: string) => {
onSelect(secretName);
onOpenChange(false);
Expand All @@ -198,7 +203,11 @@ export function SelectSecretDialog({
<Dialog open={open} onOpenChange={onOpenChange}>
{open && (
<DialogContent data-testid="select-secret-dialog">
<SelectSecretDialogContent onSelect={handleSelect} />
{available || mockBackend ? (
<SelectSecretDialogContent onSelect={handleSelect} />
) : (
<SecretsBackendUnavailable />
)}
</DialogContent>
)}
</Dialog>
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
import { Icon } from "@/components/ui/icon";
import { BlockStack } from "@/components/ui/layout";
import { Text } from "@/components/ui/typography";

/**
* Shown in place of the secrets list/picker when no backend is available.
* Secrets live on the Tangle backend, so without one there is nothing to list
* and a friendly explanation is clearer than the generic error fallback.
*/
export function SecretsBackendUnavailable() {
return (
<BlockStack
align="center"
className="py-8"
data-testid="secrets-backend-unavailable"
>
<Icon name="DatabaseZap" size="lg" className="text-subdued" />
<Text tone="subdued">Backend not connected</Text>
<Text size="xs" tone="subdued">
Secrets are stored on your Tangle backend. Connect one in Settings to
manage secrets.
</Text>
</BlockStack>
);
}
Original file line number Diff line number Diff line change
Expand Up @@ -6,18 +6,25 @@ import { Icon } from "@/components/ui/icon";
import { BlockStack, InlineStack } from "@/components/ui/layout";
import { Skeleton } from "@/components/ui/skeleton";
import { Text } from "@/components/ui/typography";
import { useBackend } from "@/providers/BackendProvider";
import { useTourMockBackend } from "@/providers/TourProvider/tourMockBackend";
import { formatRelativeTime } from "@/utils/date";

import { withSuspenseWrapper } from "../../SuspenseWrapper";
import { fetchSecretsList } from "../secretsStorage";
import { SecretsQueryKeys } from "../types";
import { type Secret, SecretsQueryKeys } from "../types";
import { RemoveSecretButton } from "./RemoveSecretButton";
import { SecretsBackendUnavailable } from "./SecretsBackendUnavailable";

interface SecretsListProps {
onRemoveSuccess?: () => void;
onEditSecret?: (secret: Secret) => void;
}

function SecretsListInternal({ onRemoveSuccess }: SecretsListProps) {
function SecretsListInternal({
onRemoveSuccess,
onEditSecret,
}: SecretsListProps) {
const { data: secrets } = useSuspenseQuery({
queryKey: SecretsQueryKeys.All(),
queryFn: fetchSecretsList,
Expand Down Expand Up @@ -67,16 +74,27 @@ function SecretsListInternal({ onRemoveSuccess }: SecretsListProps) {
</InlineStack>

<InlineStack gap="1">
<Link
to="/settings/secrets/$secretId/replace"
params={{ secretId: secret.id }}
replace
data-testid="secret-edit-button"
>
<Button variant="ghost" size="xs">
{onEditSecret ? (
<Button
variant="ghost"
size="xs"
data-testid="secret-edit-button"
onClick={() => onEditSecret(secret)}
>
<Icon name="Pencil" size="sm" />
</Button>
</Link>
) : (
<Link
to="/settings/secrets/$secretId/replace"
params={{ secretId: secret.id }}
replace
data-testid="secret-edit-button"
>
<Button variant="ghost" size="xs">
<Icon name="Pencil" size="sm" />
</Button>
</Link>
)}
<RemoveSecretButton secret={secret} onSuccess={onRemoveSuccess} />
</InlineStack>
</InlineStack>
Expand All @@ -96,7 +114,16 @@ function SecretsListSkeleton() {
);
}

export const SecretsList = withSuspenseWrapper(
const SecretsListWithSuspense = withSuspenseWrapper(
SecretsListInternal,
SecretsListSkeleton,
);

export function SecretsList(props: SecretsListProps) {
const { available } = useBackend();
const mockBackend = useTourMockBackend();
if (!available && !mockBackend) {
return <SecretsBackendUnavailable />;
}
return <SecretsListWithSuspense {...props} />;
}
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,18 @@ import useToastNotification from "@/hooks/useToastNotification";
import { useAnalytics } from "@/providers/AnalyticsProvider";
import { tracking } from "@/utils/tracking";

import type { Secret } from "../types";
import { SecretsList } from "./SecretsList";

export function SecretsListView() {
interface SecretsListViewProps {
onAddSecret?: () => void;
onEditSecret?: (secret: Secret) => void;
}

export function SecretsListView({
onAddSecret,
onEditSecret,
}: SecretsListViewProps = {}) {
const notify = useToastNotification();
const { track } = useAnalytics();

Expand All @@ -32,22 +41,36 @@ export function SecretsListView() {

<Separator />

<SecretsList onRemoveSuccess={handleRemoveSuccess} />
<SecretsList
onRemoveSuccess={handleRemoveSuccess}
onEditSecret={onEditSecret}
/>

<Separator />

<InlineStack align="end" fill>
<Link
to="/settings/secrets/add"
replace
data-testid="add-secret-link"
{...tracking("settings.secrets.add_secret")}
>
<Button variant="secondary">
{onAddSecret ? (
<Button
variant="secondary"
data-testid="add-secret-link"
onClick={onAddSecret}
>
<Icon name="Plus" />
Add Secret
</Button>
</Link>
) : (
<Link
to="/settings/secrets/add"
replace
data-testid="add-secret-link"
{...tracking("settings.secrets.add_secret")}
>
<Button variant="secondary">
<Icon name="Plus" />
Add Secret
</Button>
</Link>
)}
</InlineStack>
</BlockStack>
);
Expand Down
26 changes: 26 additions & 0 deletions src/components/shared/SecretsManagement/secretsStorage.ts
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,13 @@ import {
listSecretsApiSecretsGet,
updateSecretApiSecretsSecretNamePut,
} from "@/api/sdk.gen";
import {
isTourMockActive,
mockAddSecret,
mockListSecrets,
mockRemoveSecret,
mockUpdateSecret,
} from "@/providers/TourProvider/tourMockBackend";

import type { Secret } from "./types";

Expand Down Expand Up @@ -33,6 +40,10 @@ function parseAsUtc(dateString: string): Date {
}

export async function fetchSecretsList() {
if (isTourMockActive()) {
return mockListSecrets();
}

const response = await listSecretsApiSecretsGet();

if (response.response.status !== 200) {
Expand Down Expand Up @@ -60,6 +71,11 @@ export async function updateSecret(
secretId: string,
secret: Partial<Secret> & Pick<Secret, "value">,
) {
if (isTourMockActive()) {
mockUpdateSecret(secretId, secret.value);
return true;
}

const response = await updateSecretApiSecretsSecretNamePut({
path: {
secret_name: secretId,
Expand All @@ -79,6 +95,11 @@ export async function updateSecret(
export async function addSecret(
secret: Partial<Secret> & Pick<Secret, "name" | "value">,
) {
if (isTourMockActive()) {
mockAddSecret(secret.name ?? "", secret.value);
return true;
}

const response = await createSecretApiSecretsPost({
query: {
secret_name: secret.name ?? "",
Expand All @@ -96,6 +117,11 @@ export async function addSecret(
}

export async function removeSecret(secretId: string) {
if (isTourMockActive()) {
mockRemoveSecret(secretId);
return true;
}

const response = await deleteSecretApiSecretsSecretNameDelete({
path: {
secret_name: secretId,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ import useCooldownTimer from "@/hooks/useCooldownTimer";
import useToastNotification from "@/hooks/useToastNotification";
import { cn } from "@/lib/utils";
import { useBackend } from "@/providers/BackendProvider";
import { useTourMockBackend } from "@/providers/TourProvider/tourMockBackend";
import { APP_ROUTES } from "@/routes/router";
import { updateRunAnnotation } from "@/services/pipelineRunService";
import type { PipelineRun } from "@/types/pipelineRun";
Expand Down Expand Up @@ -102,6 +103,10 @@ const TangleSubmitter = ({
}: TangleSubmitterProps) => {
const { isAuthorized } = useAwaitAuthorization();
const { backendUrl, configured, available } = useBackend();
// During a no-backend tour the secrets flow is mocked in-memory, so allow the
// run-arguments dialog to open (to assign a secret to an input). Real run
// submission stays gated on `available`.
const mockBackend = useTourMockBackend();
const { mutate: submit, isPending: isSubmitting } = useSubmitPipeline();
const isAutoRedirect = useFlagValue("redirect-on-new-pipeline-run");

Expand Down Expand Up @@ -310,7 +315,7 @@ const TangleSubmitter = ({
size="icon"
data-testid="run-with-arguments-button"
onClick={() => setIsArgumentsDialogOpen(true)}
disabled={!available}
disabled={!available && !mockBackend}
>
<Icon name="Split" className="rotate-90" />
</TooltipButton>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,8 @@ import { Paragraph } from "@/components/ui/typography";
import useToastNotification from "@/hooks/useToastNotification";
import { cn } from "@/lib/utils";
import { useBackend } from "@/providers/BackendProvider";
import { useTourMockBackend } from "@/providers/TourProvider/tourMockBackend";
import { useTourMode } from "@/providers/TourProvider/TourModeContext";
import {
fetchExecutionDetails,
fetchPipelineRun,
Expand Down Expand Up @@ -66,6 +68,10 @@ export const SubmitTaskArgumentsDialog = ({
componentSpec,
}: SubmitTaskArgumentsDialogProps) => {
const notify = useToastNotification();
const tourMode = useTourMode();
// In a no-backend tour the secret-to-input assignment is demonstrated, but
// launching a real run isn't possible, so the submit confirm stays disabled.
const mockBackend = useTourMockBackend();
const initialArgs = getArgumentsFromInputs(componentSpec);

const [runNotes, setRunNotes] = useState<string>("");
Expand Down Expand Up @@ -135,8 +141,16 @@ export const SubmitTaskArgumentsDialog = ({
const hasInputs = inputs.length > 0;

return (
<Dialog open={open} onOpenChange={handleCancel}>
<DialogContent className="sm:max-w-lg">
<Dialog open={open} onOpenChange={handleCancel} modal={!tourMode}>
<DialogContent
className="sm:max-w-lg"
{...(tourMode
? {
onInteractOutside: (event) => event.preventDefault(),
onEscapeKeyDown: (event) => event.preventDefault(),
}
: {})}
>
<DialogHeader>
<DialogTitle>Submit Run with Arguments</DialogTitle>
<DialogDescription className="hidden">
Expand Down Expand Up @@ -199,7 +213,10 @@ export const SubmitTaskArgumentsDialog = ({
<Button variant="outline" onClick={handleCancel}>
Cancel
</Button>
<Button onClick={handleConfirm} disabled={!isValidToSubmit}>
<Button
onClick={handleConfirm}
disabled={!isValidToSubmit || mockBackend}
>
Submit Run
</Button>
</DialogFooter>
Expand Down
Loading
Loading