Skip to content

🪟🎉 Connector form: Reload config if updated during connection check #21839

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.

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

Merged
merged 6 commits into from
Feb 1, 2023
Merged
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
9 changes: 9 additions & 0 deletions airbyte-webapp/src/hooks/services/useDestinationHook.tsx
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
import { useCallback } from "react";
import { useMutation, useQueryClient } from "react-query";

import { Action, Namespace } from "core/analytics";
Expand Down Expand Up @@ -60,6 +61,14 @@ const useGetDestination = <T extends string | undefined | null>(
});
};

export const useInvalidateDestination = <T extends string | undefined | null>(destinationId: T): (() => void) => {
const queryClient = useQueryClient();

return useCallback(() => {
queryClient.invalidateQueries(destinationsKeys.detail(destinationId ?? ""));
}, [queryClient, destinationId]);
};

const useCreateDestination = () => {
const service = useDestinationService();
const queryClient = useQueryClient();
Expand Down
8 changes: 8 additions & 0 deletions airbyte-webapp/src/hooks/services/useSourceHook.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -64,6 +64,14 @@ const useGetSource = <T extends string | undefined | null>(
});
};

export const useInvalidateSource = <T extends string | undefined | null>(sourceId: T): (() => void) => {
const queryClient = useQueryClient();

return useCallback(() => {
queryClient.invalidateQueries(sourcesKeys.detail(sourceId ?? ""));
}, [queryClient, sourceId]);
};

const useCreateSource = () => {
const service = useSourceService();
const queryClient = useQueryClient();
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ import { ConnectionConfiguration } from "core/domain/connection";
import { SourceRead, WebBackendConnectionListItem } from "core/request/AirbyteClient";
import { useTrackPage, PageTrackingCodes } from "hooks/services/Analytics";
import { useFormChangeTrackerService, useUniqueFormId } from "hooks/services/FormChangeTracker";
import { useDeleteSource, useUpdateSource } from "hooks/services/useSourceHook";
import { useDeleteSource, useInvalidateSource, useUpdateSource } from "hooks/services/useSourceHook";
import { useDeleteModal } from "hooks/useDeleteModal";
import { useSourceDefinition } from "services/connector/SourceDefinitionService";
import { useGetSourceDefinitionSpecification } from "services/connector/SourceDefinitionSpecificationService";
Expand Down Expand Up @@ -36,6 +36,7 @@ const SourceSettings: React.FC<SourceSettingsProps> = ({ currentSource, connecti
const sourceDefinitionSpecification = useGetSourceDefinitionSpecification(currentSource.sourceDefinitionId);

const sourceDefinition = useSourceDefinition(currentSource.sourceDefinitionId);
const reloadSource = useInvalidateSource(currentSource.sourceId);

const onSubmit = async (values: {
name: string;
Expand Down Expand Up @@ -82,6 +83,7 @@ const SourceSettings: React.FC<SourceSettingsProps> = ({ currentSource, connecti
selectedConnectorDefinitionSpecification={sourceDefinitionSpecification}
selectedConnectorDefinitionId={sourceDefinitionSpecification.sourceDefinitionId}
connector={currentSource}
reloadConfig={reloadSource}
onSubmit={onSubmit}
onDeleteClick={onDeleteClick}
/>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,11 @@ import { useOutletContext } from "react-router-dom";
import { useTrackPage, PageTrackingCodes } from "hooks/services/Analytics";
import { useFormChangeTrackerService, useUniqueFormId } from "hooks/services/FormChangeTracker";
import { useConnectionList } from "hooks/services/useConnectionHook";
import { useDeleteDestination, useUpdateDestination } from "hooks/services/useDestinationHook";
import {
useDeleteDestination,
useInvalidateDestination,
useUpdateDestination,
} from "hooks/services/useDestinationHook";
import { useDeleteModal } from "hooks/useDeleteModal";
import { useDestinationDefinition } from "services/connector/DestinationDefinitionService";
import { useGetDestinationDefinitionSpecification } from "services/connector/DestinationDefinitionSpecificationService";
Expand All @@ -20,6 +24,7 @@ export const DestinationSettingsPage: React.FC = () => {
const { connections: connectionsWithDestination } = useConnectionList({ destinationId: [destination.destinationId] });
const destinationSpecification = useGetDestinationDefinitionSpecification(destination.destinationDefinitionId);
const destinationDefinition = useDestinationDefinition(destination.destinationDefinitionId);
const reloadDestination = useInvalidateDestination(destination.destinationId);
const { mutateAsync: updateDestination } = useUpdateDestination();
const { mutateAsync: deleteDestination } = useDeleteDestination();
const formId = useUniqueFormId();
Expand Down Expand Up @@ -74,6 +79,7 @@ export const DestinationSettingsPage: React.FC = () => {
selectedConnectorDefinitionSpecification={destinationSpecification}
selectedConnectorDefinitionId={destinationSpecification.destinationDefinitionId}
connector={destination}
reloadConfig={reloadDestination}
onSubmit={onSubmitForm}
onDeleteClick={onDeleteClick}
/>
Expand Down
13 changes: 10 additions & 3 deletions airbyte-webapp/src/views/Connector/ConnectorCard/ConnectorCard.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,7 @@ interface ConnectorCardBaseProps {
jobInfo?: SynchronousJobRead | null;
additionalSelectorComponent?: React.ReactNode;
onSubmit: (values: ConnectorCardValues) => Promise<void> | void;
reloadConfig?: () => void;
onDeleteClick?: () => void;
onConnectorDefinitionSelect?: (id: string) => void;
availableConnectorDefinitions: ConnectorDefinition[];
Expand Down Expand Up @@ -72,6 +73,7 @@ export const ConnectorCard: React.FC<ConnectorCardCreateProps | ConnectorCardEdi
additionalSelectorComponent,
selectedConnectorDefinitionId,
fetchingConnectorError,
reloadConfig,
...props
}) => {
const [errorStatusRequest, setErrorStatusRequest] = useState<Error | null>(null);
Expand Down Expand Up @@ -129,8 +131,9 @@ export const ConnectorCard: React.FC<ConnectorCardCreateProps | ConnectorCardEdi
const testConnectorWithTracking = async (connectorCardValues?: ConnectorCardValues) => {
trackTestConnectorStarted(selectedConnectorDefinition);
try {
await testConnector(connectorCardValues);
const response = await testConnector(connectorCardValues);
trackTestConnectorSuccess(selectedConnectorDefinition);
return response;
} catch (e) {
trackTestConnectorFailure(selectedConnectorDefinition);
throw e;
Expand Down Expand Up @@ -161,8 +164,12 @@ export const ConnectorCard: React.FC<ConnectorCardCreateProps | ConnectorCardEdi
};

try {
await testConnectorWithTracking(connectorCardValues);
onSubmit(connectorCardValues);
const response = await testConnectorWithTracking(connectorCardValues);
if (response.jobInfo.connectorConfigurationUpdated && reloadConfig) {
reloadConfig();
} else {
onSubmit(connectorCardValues);
}
} catch (e) {
setErrorStatusRequest(e);
setIsFormSubmitting(false);
Expand Down