Skip to content
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

Jump to bottom

fix: [M3-7718] - Stale assigned Firewall data displaying on Linode and NodeBalancer details pages #10534

Merged
merged 3 commits into from
Jun 4, 2024
Merged

fix: [M3-7718] - Stale assigned Firewall data displaying on Linode and NodeBalancer details pages #10534

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
f7a07fa
Invalidate FWNB devices query when FW updates
mjac0bs May 31, 2024
7f6db67
Update query key naming for consistency
mjac0bs May 31, 2024
2e596bc
Added changeset: Stale assigned Firewall data displaying on Linode an…
mjac0bs May 31, 2024
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
5 changes: 5 additions & 0 deletions packages/manager/.changeset/pr-10534-fixed-1717169773875.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
"@linode/manager": Fixed
---

Stale assigned Firewall data displaying on Linode and NodeBalancer details pages ([#10534](https://github.com/linode/manager/pull/10534))
12 changes: 6 additions & 6 deletions packages/manager/src/features/Firewalls/FirewallDetail/Devices/RemoveDeviceDialog.tsx
View file
Open in desktop
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Just some linting and renaming in this file. The query key for nodebalancers is plural, so updated the name of the import accordingly. This is done in a few other files, too.

Original file line number Diff line number Diff line change
@@ -1,15 +1,15 @@
import { FirewallDevice } from '@linode/api-v4';
import { useQueryClient } from '@tanstack/react-query';
import { useSnackbar } from 'notistack';
import * as React from 'react';
import { useQueryClient } from '@tanstack/react-query';

import { ActionsPanel } from 'src/components/ActionsPanel/ActionsPanel';
import { ConfirmationDialog } from 'src/components/ConfirmationDialog/ConfirmationDialog';
import { Typography } from 'src/components/Typography';
import { queryKey as firewallQueryKey } from 'src/queries/firewalls';
import { useRemoveFirewallDeviceMutation } from 'src/queries/firewalls';
import { queryKey as firewallQueryKey } from 'src/queries/firewalls';
import { queryKey as linodesQueryKey } from 'src/queries/linodes/linodes';
import { queryKey as nodeBalancerQueryKey } from 'src/queries/nodebalancers';
import { queryKey as nodebalancersQueryKey } from 'src/queries/nodebalancers';

export interface Props {
device: FirewallDevice | undefined;
Expand Down Expand Up @@ -48,12 +48,12 @@ export const RemoveDeviceDialog = React.memo((props: Props) => {
enqueueSnackbar(error[0].reason, { variant: 'error' });
}

const querykey =
deviceType === 'linode' ? linodesQueryKey : nodeBalancerQueryKey;
const queryKey =
deviceType === 'linode' ? linodesQueryKey : nodebalancersQueryKey;

// Since the linode was removed as a device, invalidate the linode-specific firewall query
queryClient.invalidateQueries([
querykey,
queryKey,
deviceType,
device?.entity.id,
'firewalls',
Expand Down
25 changes: 23 additions & 2 deletions packages/manager/src/features/Firewalls/FirewallDetail/Rules/FirewallRulesLanding.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
import { styled } from '@mui/material/styles';
import { useQueryClient } from '@tanstack/react-query';
import { useSnackbar } from 'notistack';
import * as React from 'react';

Expand All @@ -7,11 +8,15 @@ import { ConfirmationDialog } from 'src/components/ConfirmationDialog/Confirmati
import { Notice } from 'src/components/Notice/Notice';
import { Prompt } from 'src/components/Prompt/Prompt';
import { Typography } from 'src/components/Typography';
import { useUpdateFirewallRulesMutation } from 'src/queries/firewalls';
import {
useAllFirewallDevicesQuery,
useUpdateFirewallRulesMutation,
} from 'src/queries/firewalls';
import { queryKey as linodesQueryKey } from 'src/queries/linodes/linodes';
import { queryKey as nodebalancersQueryKey } from 'src/queries/nodebalancers';
import { getAPIErrorOrDefault } from 'src/utilities/errorUtils';

import { FirewallRuleDrawer } from './FirewallRuleDrawer';
import { FirewallRuleTable } from './FirewallRuleTable';
import {
hasModified as _hasModified,
curriedFirewallRuleEditorReducer,
Expand All @@ -20,6 +25,7 @@ import {
prepareRules,
stripExtendedFields,
} from './firewallRuleEditor';
import { FirewallRuleTable } from './FirewallRuleTable';
import { parseFirewallRuleError } from './shared';

import type { FirewallRuleDrawerMode } from './FirewallRuleDrawer.types';
Expand Down Expand Up @@ -51,6 +57,8 @@ export const FirewallRulesLanding = React.memo((props: Props) => {
const { mutateAsync: updateFirewallRules } = useUpdateFirewallRulesMutation(
firewallID
);
const { data: devices } = useAllFirewallDevicesQuery(firewallID);
const queryClient = useQueryClient();

const { enqueueSnackbar } = useSnackbar();

Expand Down Expand Up @@ -193,6 +201,19 @@ export const FirewallRulesLanding = React.memo((props: Props) => {
updateFirewallRules(finalRules)
.then((_rules) => {
setSubmitting(false);
// Invalidate Firewalls assigned to NodeBalancers and Linodes.
Copy link
Contributor Author

Choose a reason for hiding this comment

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

No invalidation was happening on Firewall rule updates, which was the initial issue identified in the ticket.

// eslint-disable-next-line no-unused-expressions
devices?.forEach((device) =>
queryClient.invalidateQueries([
device.entity.type === 'linode'
? linodesQueryKey
: nodebalancersQueryKey,
device.entity.type,
device.entity.id,
'firewalls',
])
);

// Reset editor state.
inboundDispatch({ rules: _rules.inbound ?? [], type: 'RESET' });
outboundDispatch({ rules: _rules.outbound ?? [], type: 'RESET' });
Expand Down
4 changes: 2 additions & 2 deletions packages/manager/src/features/Firewalls/FirewallLanding/CreateFirewallDrawer.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ import {
useCreateFirewall,
} from 'src/queries/firewalls';
import { queryKey as linodesQueryKey } from 'src/queries/linodes/linodes';
import { queryKey as nodebalancerQueryKey } from 'src/queries/nodebalancers';
import { queryKey as nodebalancersQueryKey } from 'src/queries/nodebalancers';
import { useGrants } from 'src/queries/profile';
import { sendLinodeCreateFormStepEvent } from 'src/utilities/analytics/formEventAnalytics';
import { getErrorMap } from 'src/utilities/errorUtils';
Expand Down Expand Up @@ -153,7 +153,7 @@ export const CreateFirewallDrawer = React.memo(
if (payload.devices?.nodebalancers) {
payload.devices.nodebalancers.forEach((nodebalancerId) => {
queryClient.invalidateQueries([
nodebalancerQueryKey,
nodebalancersQueryKey,
'nodebalancer',
nodebalancerId,
'firewalls',
Expand Down
24 changes: 13 additions & 11 deletions packages/manager/src/features/Firewalls/FirewallLanding/FirewallDialog.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ import { useDeleteFirewall, useMutateFirewall } from 'src/queries/firewalls';
import { queryKey as firewallQueryKey } from 'src/queries/firewalls';
import { useAllFirewallDevicesQuery } from 'src/queries/firewalls';
import { queryKey as linodesQueryKey } from 'src/queries/linodes/linodes';
import { queryKey as nodebalancerQueryKey } from 'src/queries/nodebalancers';
import { queryKey as nodebalancersQueryKey } from 'src/queries/nodebalancers';
import { capitalize } from 'src/utilities/capitalize';

export type Mode = 'delete' | 'disable' | 'enable';
Expand Down Expand Up @@ -66,17 +66,19 @@ export const FirewallDialog = React.memo((props: Props) => {

const onSubmit = async () => {
await requestMap[mode]();
// Invalidate Firewalls assigned to NodeBalancers and Linodes when Firewall is enabled, disabled, or deleted.
// eslint-disable-next-line no-unused-expressions
devices?.forEach((device) => {
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Previously, we were only invalidating the Firewalls assigned to a device when deleting the Firewall. Updating the status of the Firewall (e.g. enabling it or disabling it) should be reason to invalidate the Firewall too.

const deviceType = device.entity.type;
queryClient.invalidateQueries([
deviceType === 'linode' ? linodesQueryKey : nodebalancersQueryKey,
deviceType,
device.entity.id,
'firewalls',
]);
});
if (mode === 'delete') {
devices?.forEach((device) => {
const deviceType = device.entity.type;
queryClient.invalidateQueries([
deviceType === 'linode' ? linodesQueryKey : nodebalancerQueryKey,
deviceType,
device.entity.id,
'firewalls',
]);
queryClient.invalidateQueries([firewallQueryKey]);
});
queryClient.invalidateQueries([firewallQueryKey]);
}
enqueueSnackbar(`Firewall ${label} successfully ${mode}d`, {
variant: 'success',
Expand Down
Loading