feat: extract business logic into custom React hooks (Phase 3.1)
Refactor components to use custom hooks for business logic, dramatically simplifying component code while improving testability and reusability. Changes: - Create useSealedSecretEncryption() hook - Encapsulates complete encryption workflow - Handles validation, cert fetching, expiry checks, encryption - Built-in error handling with snackbar notifications - Returns ready-to-apply SealedSecret object - Type-safe Result<T, E> pattern - Create useControllerHealth() hook - Encapsulates health monitoring logic - Auto-refresh with configurable interval - Manual refresh function - Loading state management - Proper cleanup - Refactor EncryptDialog component - Simplified from 215 → 130 lines (-85 lines, -40%) - Business logic extracted to hook - Focus on presentation logic only - Much easier to understand and maintain - Refactor ControllerStatus component - Simplified from 115 → 58 lines (-57 lines, -50%) - One-line hook usage - Perfect abstraction example Benefits: - Separation of concerns (business vs presentation) - Reusable hooks across components - Easier to test (hooks testable independently) - Better maintainability (single source of truth) - Code reduction: ~140 lines removed from components Build: 352.05 kB (96.99 kB gzipped), +0.71 kB (+0.2%) Phase 3.1 complete. 8 of 14 phases done (57%). Generated with [Claude Code](https://claude.ai/code) via [Happy](https://happy.engineering) Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com> Co-Authored-By: Happy <yesreply@happy.engineering>
This commit is contained in:
@@ -8,7 +8,7 @@
|
||||
import { CheckCircle, Error as ErrorIcon, Warning } from '@mui/icons-material';
|
||||
import { Box, Chip, CircularProgress, Tooltip, Typography } from '@mui/material';
|
||||
import React from 'react';
|
||||
import { checkControllerHealth, ControllerHealthStatus, getPluginConfig } from '../lib/controller';
|
||||
import { useControllerHealth } from '../hooks/useControllerHealth';
|
||||
|
||||
interface ControllerStatusProps {
|
||||
/** Whether to auto-refresh the status */
|
||||
@@ -27,32 +27,7 @@ export function ControllerStatus({
|
||||
refreshIntervalMs = 30000,
|
||||
showDetails = true,
|
||||
}: ControllerStatusProps) {
|
||||
const [status, setStatus] = React.useState<ControllerHealthStatus | null>(null);
|
||||
const [loading, setLoading] = React.useState(true);
|
||||
|
||||
const fetchStatus = React.useCallback(async () => {
|
||||
setLoading(true);
|
||||
const config = getPluginConfig();
|
||||
const result = await checkControllerHealth(config);
|
||||
|
||||
if (result.ok) {
|
||||
setStatus(result.value);
|
||||
}
|
||||
setLoading(false);
|
||||
}, []);
|
||||
|
||||
// Initial fetch
|
||||
React.useEffect(() => {
|
||||
fetchStatus();
|
||||
}, [fetchStatus]);
|
||||
|
||||
// Auto-refresh
|
||||
React.useEffect(() => {
|
||||
if (!autoRefresh) return;
|
||||
|
||||
const interval = setInterval(fetchStatus, refreshIntervalMs);
|
||||
return () => clearInterval(interval);
|
||||
}, [autoRefresh, refreshIntervalMs, fetchStatus]);
|
||||
const { health: status, loading } = useControllerHealth(autoRefresh, refreshIntervalMs);
|
||||
|
||||
if (loading || !status) {
|
||||
return (
|
||||
|
||||
@@ -24,16 +24,9 @@ import {
|
||||
} from '@mui/material';
|
||||
import { useSnackbar } from 'notistack';
|
||||
import React from 'react';
|
||||
import { fetchPublicCertificate, getPluginConfig } from '../lib/controller';
|
||||
import {
|
||||
encryptKeyValues,
|
||||
isCertificateExpiringSoon,
|
||||
parseCertificateInfo,
|
||||
parsePublicKeyFromCert,
|
||||
} from '../lib/crypto';
|
||||
import { useSealedSecretEncryption } from '../hooks/useSealedSecretEncryption';
|
||||
import { SealedSecret } from '../lib/SealedSecretCRD';
|
||||
import { validateSecretKey, validateSecretName, validateSecretValue } from '../lib/validators';
|
||||
import { PlaintextValue, SealedSecretScope, SecretKeyValue } from '../types';
|
||||
import { SealedSecretScope, SecretKeyValue } from '../types';
|
||||
|
||||
interface EncryptDialogProps {
|
||||
open: boolean;
|
||||
@@ -50,8 +43,8 @@ export function EncryptDialog({ open, onClose }: EncryptDialogProps) {
|
||||
const [keyValues, setKeyValues] = React.useState<(SecretKeyValue & { showValue: boolean })[]>([
|
||||
{ key: '', value: '', showValue: false },
|
||||
]);
|
||||
const [encrypting, setEncrypting] = React.useState(false);
|
||||
const { enqueueSnackbar } = useSnackbar();
|
||||
const { encrypt, encrypting } = useSealedSecretEncryption();
|
||||
|
||||
const [namespaces] = K8s.ResourceClasses.Namespace.useList();
|
||||
|
||||
@@ -82,122 +75,28 @@ export function EncryptDialog({ open, onClose }: EncryptDialogProps) {
|
||||
};
|
||||
|
||||
const handleCreate = async () => {
|
||||
// Validate secret name
|
||||
const nameValidation = validateSecretName(name);
|
||||
if (!nameValidation.valid) {
|
||||
enqueueSnackbar(nameValidation.error, { variant: 'error' });
|
||||
// Filter out empty rows
|
||||
const validKeyValues = keyValues.filter(kv => kv.key || kv.value).map(kv => ({
|
||||
key: kv.key,
|
||||
value: kv.value,
|
||||
}));
|
||||
|
||||
// Use the encryption hook
|
||||
const result = await encrypt({
|
||||
name,
|
||||
namespace,
|
||||
scope,
|
||||
keyValues: validKeyValues,
|
||||
});
|
||||
|
||||
// If encryption failed, the hook already showed the error
|
||||
if (result.ok === false) {
|
||||
return;
|
||||
}
|
||||
|
||||
// Validate key-value pairs
|
||||
const validKeyValues: Array<{ key: string; value: string }> = [];
|
||||
for (const kv of keyValues) {
|
||||
if (!kv.key && !kv.value) {
|
||||
continue; // Skip empty rows
|
||||
}
|
||||
|
||||
const keyValidation = validateSecretKey(kv.key);
|
||||
if (!keyValidation.valid) {
|
||||
enqueueSnackbar(`Invalid key "${kv.key}": ${keyValidation.error}`, { variant: 'error' });
|
||||
return;
|
||||
}
|
||||
|
||||
const valueValidation = validateSecretValue(kv.value);
|
||||
if (!valueValidation.valid) {
|
||||
enqueueSnackbar(`Invalid value for key "${kv.key}": ${valueValidation.error}`, {
|
||||
variant: 'error',
|
||||
});
|
||||
return;
|
||||
}
|
||||
|
||||
validKeyValues.push({ key: kv.key, value: kv.value });
|
||||
}
|
||||
|
||||
if (validKeyValues.length === 0) {
|
||||
enqueueSnackbar('At least one key-value pair is required', { variant: 'error' });
|
||||
return;
|
||||
}
|
||||
|
||||
setEncrypting(true);
|
||||
|
||||
try {
|
||||
// 1. Fetch the controller's public certificate
|
||||
const config = getPluginConfig();
|
||||
const certResult = await fetchPublicCertificate(config);
|
||||
|
||||
if (certResult.ok === false) {
|
||||
enqueueSnackbar(`Failed to fetch certificate: ${certResult.error}`, { variant: 'error' });
|
||||
return;
|
||||
}
|
||||
|
||||
// 2. Check certificate expiry
|
||||
const certInfoResult = parseCertificateInfo(certResult.value);
|
||||
if (certInfoResult.ok) {
|
||||
const certInfo = certInfoResult.value;
|
||||
|
||||
if (certInfo.isExpired) {
|
||||
enqueueSnackbar(
|
||||
`Warning: Controller certificate expired on ${certInfo.validTo.toLocaleDateString()}. ` +
|
||||
'Secrets may not be decryptable.',
|
||||
{ variant: 'warning' }
|
||||
);
|
||||
} else if (isCertificateExpiringSoon(certInfo, 30)) {
|
||||
enqueueSnackbar(
|
||||
`Warning: Controller certificate expires in ${certInfo.daysUntilExpiry} days ` +
|
||||
`(${certInfo.validTo.toLocaleDateString()}).`,
|
||||
{ variant: 'warning' }
|
||||
);
|
||||
}
|
||||
}
|
||||
|
||||
// 3. Parse the public key
|
||||
const keyResult = parsePublicKeyFromCert(certResult.value);
|
||||
|
||||
if (keyResult.ok === false) {
|
||||
enqueueSnackbar(`Invalid certificate: ${keyResult.error}`, { variant: 'error' });
|
||||
return;
|
||||
}
|
||||
|
||||
// 4. Encrypt all values client-side
|
||||
const encryptResult = encryptKeyValues(
|
||||
keyResult.value,
|
||||
validKeyValues.map(kv => ({ key: kv.key, value: PlaintextValue(kv.value) })),
|
||||
namespace,
|
||||
name,
|
||||
scope
|
||||
);
|
||||
|
||||
if (encryptResult.ok === false) {
|
||||
enqueueSnackbar(`Encryption failed: ${encryptResult.error}`, { variant: 'error' });
|
||||
return;
|
||||
}
|
||||
|
||||
// 5. Construct the SealedSecret object
|
||||
const sealedSecretData: any = {
|
||||
apiVersion: 'bitnami.com/v1alpha1',
|
||||
kind: 'SealedSecret',
|
||||
metadata: {
|
||||
name,
|
||||
namespace,
|
||||
annotations: {},
|
||||
},
|
||||
spec: {
|
||||
encryptedData: encryptResult.value,
|
||||
template: {
|
||||
metadata: {},
|
||||
},
|
||||
},
|
||||
};
|
||||
|
||||
// Add scope annotations
|
||||
if (scope === 'namespace-wide') {
|
||||
sealedSecretData.metadata.annotations['sealedsecrets.bitnami.com/namespace-wide'] = 'true';
|
||||
} else if (scope === 'cluster-wide') {
|
||||
sealedSecretData.metadata.annotations['sealedsecrets.bitnami.com/cluster-wide'] = 'true';
|
||||
}
|
||||
|
||||
// 6. Apply to the cluster
|
||||
await SealedSecret.apiEndpoint.post(sealedSecretData);
|
||||
// Apply the SealedSecret to the cluster
|
||||
await SealedSecret.apiEndpoint.post(result.value.sealedSecretData);
|
||||
|
||||
enqueueSnackbar('SealedSecret created successfully', { variant: 'success' });
|
||||
|
||||
@@ -209,8 +108,6 @@ export function EncryptDialog({ open, onClose }: EncryptDialogProps) {
|
||||
onClose();
|
||||
} catch (error: any) {
|
||||
enqueueSnackbar(`Failed to create SealedSecret: ${error.message}`, { variant: 'error' });
|
||||
} finally {
|
||||
setEncrypting(false);
|
||||
}
|
||||
};
|
||||
|
||||
|
||||
@@ -0,0 +1,70 @@
|
||||
/**
|
||||
* Custom Hook for Controller Health Monitoring
|
||||
*
|
||||
* Provides controller health status with automatic refresh capability.
|
||||
*/
|
||||
|
||||
import React from 'react';
|
||||
import { checkControllerHealth, ControllerHealthStatus, getPluginConfig } from '../lib/controller';
|
||||
|
||||
/**
|
||||
* Custom hook for monitoring controller health
|
||||
*
|
||||
* Automatically checks controller health on mount and can optionally
|
||||
* refresh at a specified interval.
|
||||
*
|
||||
* @param autoRefresh Whether to automatically refresh health status
|
||||
* @param refreshIntervalMs Refresh interval in milliseconds (default: 30000ms = 30s)
|
||||
* @returns Object with health status, loading state, and manual refresh function
|
||||
*
|
||||
* @example
|
||||
* // Manual refresh only
|
||||
* const { health, loading, refresh } = useControllerHealth();
|
||||
*
|
||||
* // Auto-refresh every 30 seconds
|
||||
* const { health, loading } = useControllerHealth(true, 30000);
|
||||
*
|
||||
* // Auto-refresh every 10 seconds
|
||||
* const { health, loading } = useControllerHealth(true, 10000);
|
||||
*/
|
||||
export function useControllerHealth(autoRefresh = false, refreshIntervalMs = 30000) {
|
||||
const [health, setHealth] = React.useState<ControllerHealthStatus | null>(null);
|
||||
const [loading, setLoading] = React.useState(true);
|
||||
|
||||
const fetchHealth = React.useCallback(async () => {
|
||||
setLoading(true);
|
||||
|
||||
const config = getPluginConfig();
|
||||
const result = await checkControllerHealth(config);
|
||||
|
||||
if (result.ok) {
|
||||
setHealth(result.value);
|
||||
} else if (result.ok === false) {
|
||||
// Even on error, checkControllerHealth returns a status
|
||||
// This shouldn't happen, but handle gracefully
|
||||
setHealth({
|
||||
healthy: false,
|
||||
reachable: false,
|
||||
error: result.error,
|
||||
});
|
||||
}
|
||||
|
||||
setLoading(false);
|
||||
}, []);
|
||||
|
||||
// Initial fetch and auto-refresh setup
|
||||
React.useEffect(() => {
|
||||
fetchHealth();
|
||||
|
||||
if (autoRefresh) {
|
||||
const interval = setInterval(fetchHealth, refreshIntervalMs);
|
||||
return () => clearInterval(interval);
|
||||
}
|
||||
}, [autoRefresh, refreshIntervalMs, fetchHealth]);
|
||||
|
||||
return {
|
||||
health,
|
||||
loading,
|
||||
refresh: fetchHealth,
|
||||
};
|
||||
}
|
||||
@@ -0,0 +1,208 @@
|
||||
/**
|
||||
* Custom Hook for SealedSecret Encryption
|
||||
*
|
||||
* Encapsulates the business logic for encrypting secrets and creating SealedSecrets.
|
||||
* Handles certificate fetching, validation, expiry warnings, encryption, and object creation.
|
||||
*/
|
||||
|
||||
import { useSnackbar } from 'notistack';
|
||||
import React from 'react';
|
||||
import { fetchPublicCertificate, getPluginConfig } from '../lib/controller';
|
||||
import {
|
||||
encryptKeyValues,
|
||||
isCertificateExpiringSoon,
|
||||
parseCertificateInfo,
|
||||
parsePublicKeyFromCert,
|
||||
} from '../lib/crypto';
|
||||
import { validateSecretKey, validateSecretName, validateSecretValue } from '../lib/validators';
|
||||
import {
|
||||
AsyncResult,
|
||||
CertificateInfo,
|
||||
Err,
|
||||
Ok,
|
||||
PlaintextValue,
|
||||
SealedSecretScope,
|
||||
} from '../types';
|
||||
|
||||
/**
|
||||
* Request parameters for encryption
|
||||
*/
|
||||
export interface EncryptionRequest {
|
||||
/** Name of the SealedSecret to create */
|
||||
name: string;
|
||||
/** Namespace to create the SealedSecret in */
|
||||
namespace: string;
|
||||
/** Encryption scope (strict, namespace-wide, cluster-wide) */
|
||||
scope: SealedSecretScope;
|
||||
/** Key-value pairs to encrypt */
|
||||
keyValues: Array<{ key: string; value: string }>;
|
||||
}
|
||||
|
||||
/**
|
||||
* Result of successful encryption
|
||||
*/
|
||||
export interface EncryptionResult {
|
||||
/** The complete SealedSecret object ready to apply */
|
||||
sealedSecretData: any;
|
||||
/** Information about the certificate used */
|
||||
certificateInfo?: CertificateInfo;
|
||||
}
|
||||
|
||||
/**
|
||||
* Custom hook for SealedSecret encryption
|
||||
*
|
||||
* Provides encryption functionality with built-in validation, error handling,
|
||||
* and user notifications.
|
||||
*
|
||||
* @returns Object with encrypt function and encrypting state
|
||||
*
|
||||
* @example
|
||||
* const { encrypt, encrypting } = useSealedSecretEncryption();
|
||||
*
|
||||
* const result = await encrypt({
|
||||
* name: 'my-secret',
|
||||
* namespace: 'default',
|
||||
* scope: 'strict',
|
||||
* keyValues: [{ key: 'password', value: 'secret123' }]
|
||||
* });
|
||||
*
|
||||
* if (result.ok) {
|
||||
* // Use result.value.sealedSecretData
|
||||
* }
|
||||
*/
|
||||
export function useSealedSecretEncryption() {
|
||||
const [encrypting, setEncrypting] = React.useState(false);
|
||||
const { enqueueSnackbar } = useSnackbar();
|
||||
|
||||
const encrypt = React.useCallback(
|
||||
async (request: EncryptionRequest): AsyncResult<EncryptionResult, string> => {
|
||||
setEncrypting(true);
|
||||
|
||||
try {
|
||||
// Step 1: Validate inputs
|
||||
const nameValidation = validateSecretName(request.name);
|
||||
if (!nameValidation.valid) {
|
||||
enqueueSnackbar(nameValidation.error, { variant: 'error' });
|
||||
return Err(nameValidation.error || 'Invalid secret name');
|
||||
}
|
||||
|
||||
// Validate all key-value pairs
|
||||
for (const kv of request.keyValues) {
|
||||
const keyValidation = validateSecretKey(kv.key);
|
||||
if (!keyValidation.valid) {
|
||||
const error = `Invalid key "${kv.key}": ${keyValidation.error}`;
|
||||
enqueueSnackbar(error, { variant: 'error' });
|
||||
return Err(error);
|
||||
}
|
||||
|
||||
const valueValidation = validateSecretValue(kv.value);
|
||||
if (!valueValidation.valid) {
|
||||
const error = `Invalid value for key "${kv.key}": ${valueValidation.error}`;
|
||||
enqueueSnackbar(error, { variant: 'error' });
|
||||
return Err(error);
|
||||
}
|
||||
}
|
||||
|
||||
if (request.keyValues.length === 0) {
|
||||
const error = 'At least one key-value pair is required';
|
||||
enqueueSnackbar(error, { variant: 'error' });
|
||||
return Err(error);
|
||||
}
|
||||
|
||||
// Step 2: Fetch the controller's public certificate
|
||||
const config = getPluginConfig();
|
||||
const certResult = await fetchPublicCertificate(config);
|
||||
|
||||
if (certResult.ok === false) {
|
||||
const error = `Failed to fetch certificate: ${certResult.error}`;
|
||||
enqueueSnackbar(error, { variant: 'error' });
|
||||
return Err(error);
|
||||
}
|
||||
|
||||
// Step 3: Check certificate expiry and warn user
|
||||
let certInfo: CertificateInfo | undefined;
|
||||
const certInfoResult = parseCertificateInfo(certResult.value);
|
||||
if (certInfoResult.ok) {
|
||||
certInfo = certInfoResult.value;
|
||||
|
||||
if (certInfo.isExpired) {
|
||||
enqueueSnackbar(
|
||||
`Warning: Controller certificate expired on ${certInfo.validTo.toLocaleDateString()}. ` +
|
||||
'Secrets may not be decryptable.',
|
||||
{ variant: 'warning' }
|
||||
);
|
||||
} else if (isCertificateExpiringSoon(certInfo, 30)) {
|
||||
enqueueSnackbar(
|
||||
`Warning: Controller certificate expires in ${certInfo.daysUntilExpiry} days ` +
|
||||
`(${certInfo.validTo.toLocaleDateString()}).`,
|
||||
{ variant: 'warning' }
|
||||
);
|
||||
}
|
||||
}
|
||||
|
||||
// Step 4: Parse the public key from certificate
|
||||
const keyResult = parsePublicKeyFromCert(certResult.value);
|
||||
|
||||
if (keyResult.ok === false) {
|
||||
const error = `Invalid certificate: ${keyResult.error}`;
|
||||
enqueueSnackbar(error, { variant: 'error' });
|
||||
return Err(error);
|
||||
}
|
||||
|
||||
// Step 5: Encrypt all values client-side
|
||||
const encryptResult = encryptKeyValues(
|
||||
keyResult.value,
|
||||
request.keyValues.map(kv => ({ key: kv.key, value: PlaintextValue(kv.value) })),
|
||||
request.namespace,
|
||||
request.name,
|
||||
request.scope
|
||||
);
|
||||
|
||||
if (encryptResult.ok === false) {
|
||||
const error = `Encryption failed: ${encryptResult.error}`;
|
||||
enqueueSnackbar(error, { variant: 'error' });
|
||||
return Err(error);
|
||||
}
|
||||
|
||||
// Step 6: Construct the SealedSecret object
|
||||
const sealedSecretData: any = {
|
||||
apiVersion: 'bitnami.com/v1alpha1',
|
||||
kind: 'SealedSecret',
|
||||
metadata: {
|
||||
name: request.name,
|
||||
namespace: request.namespace,
|
||||
annotations: {},
|
||||
},
|
||||
spec: {
|
||||
encryptedData: encryptResult.value,
|
||||
template: {
|
||||
metadata: {},
|
||||
},
|
||||
},
|
||||
};
|
||||
|
||||
// Add scope annotations
|
||||
if (request.scope === 'namespace-wide') {
|
||||
sealedSecretData.metadata.annotations['sealedsecrets.bitnami.com/namespace-wide'] =
|
||||
'true';
|
||||
} else if (request.scope === 'cluster-wide') {
|
||||
sealedSecretData.metadata.annotations['sealedsecrets.bitnami.com/cluster-wide'] = 'true';
|
||||
}
|
||||
|
||||
return Ok({
|
||||
sealedSecretData,
|
||||
certificateInfo: certInfo,
|
||||
});
|
||||
} catch (error: any) {
|
||||
const errorMsg = error.message || 'Unknown encryption error';
|
||||
enqueueSnackbar(errorMsg, { variant: 'error' });
|
||||
return Err(errorMsg);
|
||||
} finally {
|
||||
setEncrypting(false);
|
||||
}
|
||||
},
|
||||
[enqueueSnackbar]
|
||||
);
|
||||
|
||||
return { encrypt, encrypting };
|
||||
}
|
||||
Reference in New Issue
Block a user