Skip to content

Commit

Permalink
🪟 🐛 🧹 Fix workspace editing issues in cloud, cleanup CloudWorkspacesS…
Browse files Browse the repository at this point in the history
…ervice (#16942)

* Add validation to WorkspaceSettingsView
Use i18n string sin WorkspaceSettingsView buttons

* Invalidate the workspace query when updating the workspace in cloud

* Rename Cloud WorkspacesService to CloudWorkspacesServices to avoid confusion with WorkspaceService
Update functions in CloudWorkspacesServices to include the word Cloud

* useInvalidateWorkspaceQuery -> useInvalidateWorkspace

* Remove useWorkspaceService import from CloudWorkspacesService

* Update var names using CloudWorkspacesService

* Rename useGetUsage to useGetCloudWorkspaceUsage

* tsx -> ts

* Cleanup mutateAsync usage around CloudWorkspacesService hooks

* Remove reference to CloudWorkspacesServices in ConnectionFormService test
  • Loading branch information
edmundito committed Sep 22, 2022
1 parent 810d3a1 commit 0ceffd7
Show file tree
Hide file tree
Showing 12 changed files with 59 additions and 43 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ import {
useConnectionFormService,
} from "./ConnectionFormService";

["packages/cloud/services/workspaces/WorkspacesService", "services/workspaces/WorkspacesService"].forEach((s) =>
["services/workspaces/WorkspacesService"].forEach((s) =>
jest.mock(s, () => ({
useCurrentWorkspaceId: () => mockWorkspace.workspaceId,
useCurrentWorkspace: () => mockWorkspace,
Expand Down
2 changes: 1 addition & 1 deletion airbyte-webapp/src/packages/cloud/cloudRoutes.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ import { CompleteOauthRequest } from "views/CompleteOauthRequest";
import { RoutePaths } from "../../pages/routePaths";
import { CreditStatus } from "./lib/domain/cloudWorkspaces/types";
import { LDExperimentServiceProvider } from "./services/thirdParty/launchdarkly";
import { useGetCloudWorkspace } from "./services/workspaces/WorkspacesService";
import { useGetCloudWorkspace } from "./services/workspaces/CloudWorkspacesService";
import { DefaultView } from "./views/DefaultView";
import { VerifyEmailAction } from "./views/FirebaseActionRoute";
import { CloudSettingsPage } from "./views/settings/CloudSettingsPage";
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,12 +5,11 @@ import { CloudWorkspacesService } from "packages/cloud/lib/domain/cloudWorkspace
import { CloudWorkspace, CloudWorkspaceUsage } from "packages/cloud/lib/domain/cloudWorkspaces/types";
import { useCurrentUser } from "packages/cloud/services/auth/AuthService";
import { useConfig } from "packages/cloud/services/config";
import { useSuspenseQuery } from "services/connector/useSuspenseQuery";
import { SCOPE_USER } from "services/Scope";
import { useDefaultRequestMiddlewares } from "services/useDefaultRequestMiddlewares";
import { useInitService } from "services/useInitService";

import { useSuspenseQuery } from "../../../../services/connector/useSuspenseQuery";

export const workspaceKeys = {
all: [SCOPE_USER, "cloud_workspaces"] as const,
lists: () => [...workspaceKeys.all, "list"] as const,
Expand Down Expand Up @@ -45,7 +44,7 @@ export function useListCloudWorkspacesAsync(): QueryObserverResult<CloudWorkspac
return useQuery<CloudWorkspace[]>(workspaceKeys.lists(), () => service.listByUser(user.userId));
}

export function useCreateWorkspace() {
export function useCreateCloudWorkspace() {
const service = useGetWorkspaceService();
const queryClient = useQueryClient();
const user = useCurrentUser();
Expand All @@ -54,10 +53,10 @@ export function useCreateWorkspace() {
onSuccess: (result) => {
queryClient.setQueryData<CloudWorkspace[]>(workspaceKeys.lists(), (old) => [...(old ?? []), result]);
},
}).mutateAsync;
});
}

export function useUpdateWorkspace() {
export function useUpdateCloudWorkspace() {
const service = useGetWorkspaceService();
const queryClient = useQueryClient();

Expand All @@ -81,7 +80,7 @@ export function useUpdateWorkspace() {
return [...list.slice(0, index), result, ...list.slice(index + 1)];
});

queryClient.setQueryData<CloudWorkspace>([workspaceKeys.detail(result.workspaceId)], (old) => {
queryClient.setQueryData<CloudWorkspace>(workspaceKeys.detail(result.workspaceId), (old) => {
return {
...old,
...result,
Expand All @@ -92,7 +91,7 @@ export function useUpdateWorkspace() {
);
}

export function useRemoveWorkspace() {
export function useRemoveCloudWorkspace() {
const service = useGetWorkspaceService();
const queryClient = useQueryClient();

Expand All @@ -108,22 +107,20 @@ export function useRemoveWorkspace() {
export function useGetCloudWorkspace(workspaceId: string): CloudWorkspace {
const service = useGetWorkspaceService();

return useSuspenseQuery<CloudWorkspace>([workspaceKeys.detail(workspaceId)], () => service.get(workspaceId));
return useSuspenseQuery<CloudWorkspace>(workspaceKeys.detail(workspaceId), () => service.get(workspaceId));
}

export function useInvalidateCloudWorkspace(workspaceId: string): () => Promise<void> {
const queryClient = useQueryClient();

return useCallback(
() => queryClient.invalidateQueries([workspaceKeys.detail(workspaceId)]),
() => queryClient.invalidateQueries(workspaceKeys.detail(workspaceId)),
[queryClient, workspaceId]
);
}

export function useGetUsage(workspaceId: string): CloudWorkspaceUsage {
export function useGetCloudWorkspaceUsage(workspaceId: string): CloudWorkspaceUsage {
const service = useGetWorkspaceService();

return useSuspenseQuery<CloudWorkspaceUsage>([workspaceKeys.usage(workspaceId)], () => service.getUsage(workspaceId));
return useSuspenseQuery<CloudWorkspaceUsage>(workspaceKeys.usage(workspaceId), () => service.getUsage(workspaceId));
}

export { useWorkspaceService } from "services/workspaces/WorkspacesService";
2 changes: 1 addition & 1 deletion airbyte-webapp/src/packages/cloud/views/DefaultView.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ import { Navigate } from "react-router-dom";

import { RoutePaths } from "../../../pages/routePaths";
import { CloudRoutes } from "../cloudRoutes";
import { useListCloudWorkspaces } from "../services/workspaces/WorkspacesService";
import { useListCloudWorkspaces } from "../services/workspaces/CloudWorkspacesService";

export const DefaultView: React.FC = () => {
const workspaces = useListCloudWorkspaces();
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ import BarChart from "components/BarChart";
import { Card } from "components/base/Card";

import { useCurrentWorkspace } from "hooks/services/useWorkspace";
import { useGetUsage } from "packages/cloud/services/workspaces/WorkspacesService";
import { useGetCloudWorkspaceUsage } from "packages/cloud/services/workspaces/CloudWorkspacesService";

import UsagePerConnectionTable from "./UsagePerConnectionTable";

Expand Down Expand Up @@ -35,7 +35,7 @@ const CreditsUsage: React.FC = () => {
const { formatMessage, formatDate } = useIntl();

const { workspaceId } = useCurrentWorkspace();
const data = useGetUsage(workspaceId);
const data = useGetCloudWorkspaceUsage(workspaceId);

const chartData = useMemo(
() =>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ import { useStripeCheckout } from "packages/cloud/services/stripe/StripeService"
import {
useGetCloudWorkspace,
useInvalidateCloudWorkspace,
} from "packages/cloud/services/workspaces/WorkspacesService";
} from "packages/cloud/services/workspaces/CloudWorkspacesService";

interface Props {
selfServiceCheckoutEnabled: boolean;
Expand Down Expand Up @@ -62,7 +62,7 @@ const RemainingCredits: React.FC<Props> = ({ selfServiceCheckoutEnabled }) => {
const currentWorkspace = useCurrentWorkspace();
const cloudWorkspace = useGetCloudWorkspace(currentWorkspace.workspaceId);
const [searchParams, setSearchParams] = useSearchParams();
const invalidateWorkspace = useInvalidateCloudWorkspace(currentWorkspace.workspaceId);
const invalidateCloudWorkspace = useInvalidateCloudWorkspace(currentWorkspace.workspaceId);
const { isLoading, mutateAsync: createCheckout } = useStripeCheckout();
const analytics = useAnalyticsService();
const [isWaitingForCredits, setIsWaitingForCredits] = useState(false);
Expand All @@ -79,7 +79,7 @@ const RemainingCredits: React.FC<Props> = ({ selfServiceCheckoutEnabled }) => {
if (!hasRecentCreditIncrease(cloudWorkspace)) {
setIsWaitingForCredits(true);
retryIntervalId.current = window.setInterval(() => {
invalidateWorkspace();
invalidateCloudWorkspace();
}, 3000);
}
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ import { AlertBanner } from "components/base/Banner/AlertBanner";

import { CloudRoutes } from "packages/cloud/cloudRoutes";
import { CreditStatus } from "packages/cloud/lib/domain/cloudWorkspaces/types";
import { useGetCloudWorkspace } from "packages/cloud/services/workspaces/WorkspacesService";
import { useGetCloudWorkspace } from "packages/cloud/services/workspaces/CloudWorkspacesService";
import SideBar from "packages/cloud/views/layout/SideBar";
import { useCurrentWorkspace } from "services/workspaces/WorkspacesService";
import { ResourceNotFoundErrorBoundary } from "views/common/ResorceNotFoundErrorBoundary";
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ import { FeatureItem, IfFeatureEnabled } from "hooks/services/Feature";
import { useCurrentWorkspace } from "hooks/services/useWorkspace";
import { CloudRoutes } from "packages/cloud/cloudRoutes";
import { useIntercom } from "packages/cloud/services/thirdParty/intercom";
import { useGetCloudWorkspace } from "packages/cloud/services/workspaces/WorkspacesService";
import { useGetCloudWorkspace } from "packages/cloud/services/workspaces/CloudWorkspacesService";
import { WorkspacePopout } from "packages/cloud/views/workspaces/WorkspacePopout";
import ChatIcon from "views/layout/SideBar/components/ChatIcon";
import ConnectionsIcon from "views/layout/SideBar/components/ConnectionsIcon";
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,8 @@ import styled from "styled-components";
import { Popout } from "components";
import { IDataItem } from "components/base/DropDown/components/Option";

import { useWorkspaceService, useListCloudWorkspacesAsync } from "packages/cloud/services/workspaces/WorkspacesService";
import { useCurrentWorkspace } from "services/workspaces/WorkspacesService";
import { useListCloudWorkspacesAsync } from "packages/cloud/services/workspaces/CloudWorkspacesService";
import { useCurrentWorkspace, useWorkspaceService } from "services/workspaces/WorkspacesService";

import ExitIcon from "./components/ExitIcon";

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@ import classNames from "classnames";
import { Field, FieldProps, Form, Formik } from "formik";
import React from "react";
import { FormattedMessage, useIntl } from "react-intl";
import * as yup from "yup";

import { Button, Label, LabeledInput, LabeledSwitch, LoadingButton } from "components";
import { InfoTooltip } from "components/base/Tooltip";
Expand All @@ -10,11 +11,11 @@ import { useTrackPage, PageTrackingCodes } from "hooks/services/Analytics";
import { useAdvancedModeSetting } from "hooks/services/useAdvancedModeSetting";
import { useCurrentWorkspace } from "hooks/services/useWorkspace";
import {
useRemoveWorkspace,
useUpdateWorkspace,
useWorkspaceService,
} from "packages/cloud/services/workspaces/WorkspacesService";
useRemoveCloudWorkspace,
useUpdateCloudWorkspace,
} from "packages/cloud/services/workspaces/CloudWorkspacesService";
import { Content, SettingsCard } from "pages/SettingsPage/pages/SettingsComponents";
import { useInvalidateWorkspace, useWorkspaceService } from "services/workspaces/WorkspacesService";

import styles from "./WorkspaceSettingsView.module.scss";

Expand All @@ -27,13 +28,18 @@ const AdvancedModeSwitchLabel = () => (
</>
);

const ValidationSchema = yup.object().shape({
name: yup.string().required("form.empty.error"),
});

export const WorkspaceSettingsView: React.FC = () => {
const { formatMessage } = useIntl();
useTrackPage(PageTrackingCodes.SETTINGS_WORKSPACE);
const { exitWorkspace } = useWorkspaceService();
const workspace = useCurrentWorkspace();
const removeWorkspace = useRemoveWorkspace();
const updateWorkspace = useUpdateWorkspace();
const { mutateAsync: removeCloudWorkspace, isLoading: isRemovingCloudWorkspace } = useRemoveCloudWorkspace();
const { mutateAsync: updateCloudWorkspace } = useUpdateCloudWorkspace();
const invalidateWorkspace = useInvalidateWorkspace(workspace.workspaceId);
const [isAdvancedMode, setAdvancedMode] = useAdvancedModeSetting();

return (
Expand All @@ -54,12 +60,16 @@ export const WorkspaceSettingsView: React.FC = () => {
advancedMode: isAdvancedMode,
}}
onSubmit={async (payload) => {
const { workspaceId } = workspace;
setAdvancedMode(payload.advancedMode);
return updateWorkspace.mutateAsync({
workspaceId: workspace.workspaceId,
await updateCloudWorkspace({
workspaceId,
name: payload.name,
});
await invalidateWorkspace();
}}
enableReinitialize
validationSchema={ValidationSchema}
>
{({ dirty, isSubmitting, resetForm, isValid, setFieldValue }) => (
<Form>
Expand Down Expand Up @@ -93,10 +103,10 @@ export const WorkspaceSettingsView: React.FC = () => {

<div className={classNames(styles.formItem, styles.buttonGroup)}>
<Button type="button" secondary disabled={!dirty} onClick={() => resetForm()}>
cancel
<FormattedMessage id="form.cancel" />
</Button>
<LoadingButton type="submit" disabled={!isValid} isLoading={isSubmitting}>
save changes
<LoadingButton type="submit" disabled={!dirty || !isValid} isLoading={isSubmitting}>
<FormattedMessage id="form.saveChanges" />
</LoadingButton>
</div>
</Content>
Expand All @@ -109,9 +119,9 @@ export const WorkspaceSettingsView: React.FC = () => {
<div className={styles.header}>
<FormattedMessage id="settings.generalSettings.deleteLabel" />
<LoadingButton
isLoading={removeWorkspace.isLoading}
isLoading={isRemovingCloudWorkspace}
danger
onClick={() => removeWorkspace.mutateAsync(workspace.workspaceId)}
onClick={() => removeCloudWorkspace(workspace.workspaceId)}
>
<FormattedMessage id="settings.generalSettings.deleteText" />
</LoadingButton>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,10 @@ import React from "react";
import styled from "styled-components";

import {
useCreateWorkspace,
useCreateCloudWorkspace,
useListCloudWorkspaces,
useWorkspaceService,
} from "packages/cloud/services/workspaces/WorkspacesService";
} from "packages/cloud/services/workspaces/CloudWorkspacesService";
import { useWorkspaceService } from "services/workspaces/WorkspacesService";

import WorkspaceItem from "./WorkspaceItem";
import WorkspacesControl from "./WorkspacesControl";
Expand All @@ -20,7 +20,7 @@ const Content = styled.div`
const WorkspacesList: React.FC = () => {
const workspaces = useListCloudWorkspaces();
const { selectWorkspace } = useWorkspaceService();
const createWorkspace = useCreateWorkspace();
const { mutateAsync: createCloudWorkspace } = useCreateCloudWorkspace();

return (
<Content>
Expand All @@ -29,7 +29,7 @@ const WorkspacesList: React.FC = () => {
{workspace.name}
</WorkspaceItem>
))}
<WorkspacesControl onSubmit={createWorkspace} />
<WorkspacesControl onSubmit={createCloudWorkspace} />
</Content>
);
};
Expand Down
9 changes: 9 additions & 0 deletions airbyte-webapp/src/services/workspaces/WorkspacesService.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -127,3 +127,12 @@ export const useUpdateWorkspace = () => {
},
});
};

export const useInvalidateWorkspace = (workspaceId: string) => {
const queryClient = useQueryClient();

return useCallback(
() => queryClient.invalidateQueries(workspaceKeys.detail(workspaceId)),
[queryClient, workspaceId]
);
};

0 comments on commit 0ceffd7

Please sign in to comment.