refactor: [M3-8043] - Query Key Factory for Volumes

packages/manager/.changeset/pr-10414-tech-stories-1714167805545.md

@@ -0,0 +1,5 @@
+---
+"@linode/manager": Tech Stories
+---
+
+Query Key Factory for Volumes ([#10414](https://github.com/linode/manager/pull/10414))

packages/manager/cypress/e2e/core/volumes/create-volume.smoke.spec.ts

@@ -131,6 +131,7 @@ describe('volumes', () => {
       id: randomNumber(),
     });
     const newVolume = volumeFactory.build({
+      linode_id: mockLinode.id,
       label: randomLabel(),
     });
 

packages/manager/src/features/Linodes/LinodeEntityDetail.tsx

@@ -11,7 +11,7 @@ import { useInProgressEvents } from 'src/queries/events/events';
 import { useAllImagesQuery } from 'src/queries/images';
 import { useRegionsQuery } from 'src/queries/regions/regions';
 import { useTypeQuery } from 'src/queries/types';
-import { useLinodeVolumesQuery } from 'src/queries/volumes';
+import { useLinodeVolumesQuery } from 'src/queries/volumes/volumes';
 import { formatStorageUnits } from 'src/utilities/formatStorageUnits';
 
 import { LinodeEntityDetailBody } from './LinodeEntityDetailBody';

packages/manager/src/features/Linodes/LinodesDetail/LinodeConfigs/ConfigRow.tsx

@@ -7,7 +7,7 @@ import { TableRow } from 'src/components/TableRow';
 import { API_MAX_PAGE_SIZE } from 'src/constants';
 import { useAllLinodeDisksQuery } from 'src/queries/linodes/disks';
 import { useLinodeKernelQuery } from 'src/queries/linodes/linodes';
-import { useLinodeVolumesQuery } from 'src/queries/volumes';
+import { useLinodeVolumesQuery } from 'src/queries/volumes/volumes';
 
 import { InterfaceListItem } from './InterfaceListItem';
 import { ConfigActionMenu } from './LinodeConfigActionMenu';

packages/manager/src/features/Linodes/LinodesDetail/LinodeConfigs/LinodeConfigDialog.tsx

@@ -49,7 +49,7 @@ import {
 } from 'src/queries/linodes/linodes';
 import { useRegionsQuery } from 'src/queries/regions/regions';
 import { vlanQueries } from 'src/queries/vlans';
-import { useAllVolumesQuery } from 'src/queries/volumes';
+import { useAllVolumesQuery } from 'src/queries/volumes/volumes';
 import { vpcQueries } from 'src/queries/vpcs/vpcs';
 import {
   DevicesAsStrings,

packages/manager/src/features/Linodes/LinodesDetail/LinodeRescue/StandardRescueDialog.tsx

@@ -18,7 +18,7 @@ import {
   useLinodeRescueMutation,
 } from 'src/queries/linodes/linodes';
 import { useGrants, useProfile } from 'src/queries/profile';
-import { useAllVolumesQuery } from 'src/queries/volumes';
+import { useAllVolumesQuery } from 'src/queries/volumes/volumes';
 import {
   DevicesAsStrings,
   createDevicesFromStrings,

packages/manager/src/features/Linodes/LinodesDetail/LinodeStorage/LinodeVolumes.tsx

@@ -29,7 +29,7 @@ import { useOrder } from 'src/hooks/useOrder';
 import { usePagination } from 'src/hooks/usePagination';
 import { useLinodeQuery } from 'src/queries/linodes/linodes';
 import { useRegionsQuery } from 'src/queries/regions/regions';
-import { useLinodeVolumesQuery } from 'src/queries/volumes';
+import { useLinodeVolumesQuery } from 'src/queries/volumes/volumes';
 
 import { StyledRootGrid, StyledTypography } from './CommonLinodeStorage.styles';
 export const preferenceKey = 'linode-volumes';

packages/manager/src/features/Linodes/LinodesDetail/LinodesDetailHeader/UpgradeVolumesDialog.tsx

@@ -9,8 +9,10 @@ import { Typography } from 'src/components/Typography';
 import { VolumeUpgradeCopy } from 'src/features/Volumes/UpgradeVolumeDialog';
 import { getUpgradeableVolumeIds } from 'src/features/Volumes/utils';
 import { useNotificationsQuery } from 'src/queries/account/notifications';
-import { useLinodeVolumesQuery } from 'src/queries/volumes';
-import { useVolumesMigrateMutation } from 'src/queries/volumesMigrations';
+import {
+  useLinodeVolumesQuery,
+  useVolumesMigrateMutation,
+} from 'src/queries/volumes/volumes';
 import { getAPIErrorOrDefault } from 'src/utilities/errorUtils';
 
 import type { Linode } from '@linode/api-v4';

packages/manager/src/features/Linodes/LinodesDetail/VolumesUpgradeBanner.tsx

@@ -9,7 +9,7 @@ import { Stack } from 'src/components/Stack';
 import { Typography } from 'src/components/Typography';
 import { getUpgradeableVolumeIds } from 'src/features/Volumes/utils';
 import { useNotificationsQuery } from 'src/queries/account/notifications';
-import { useLinodeVolumesQuery } from 'src/queries/volumes';
+import { useLinodeVolumesQuery } from 'src/queries/volumes/volumes';
 
 interface Props {
   linodeId: number;

packages/manager/src/features/Linodes/MigrateLinode/CautionNotice.tsx

@@ -7,7 +7,7 @@ import { Link } from 'src/components/Link';
 import { Notice } from 'src/components/Notice/Notice';
 import { Typography } from 'src/components/Typography';
 import { API_MAX_PAGE_SIZE } from 'src/constants';
-import { useLinodeVolumesQuery } from 'src/queries/volumes';
+import { useLinodeVolumesQuery } from 'src/queries/volumes/volumes';
 
 interface Props {
   edgeRegionWarning?: string;

packages/manager/src/features/Search/SearchLanding.tsx

@@ -23,7 +23,7 @@ import {
 } from 'src/queries/objectStorage';
 import { useRegionsQuery } from 'src/queries/regions/regions';
 import { useSpecificTypes } from 'src/queries/types';
-import { useAllVolumesQuery } from 'src/queries/volumes';
+import { useAllVolumesQuery } from 'src/queries/volumes/volumes';
 import { formatLinode } from 'src/store/selectors/getSearchEntities';
 import { isFeatureEnabled } from 'src/utilities/accountCapabilities';
 import { getAPIErrorOrDefault } from 'src/utilities/errorUtils';

packages/manager/src/features/Support/SupportTickets/SupportTicketDialog.tsx

@@ -27,7 +27,7 @@ import { useAllFirewallsQuery } from 'src/queries/firewalls';
 import { useAllKubernetesClustersQuery } from 'src/queries/kubernetes';
 import { useAllLinodesQuery } from 'src/queries/linodes/linodes';
 import { useAllNodeBalancersQuery } from 'src/queries/nodebalancers';
-import { useAllVolumesQuery } from 'src/queries/volumes';
+import { useAllVolumesQuery } from 'src/queries/volumes/volumes';
 import {
   getAPIErrorOrDefault,
   getErrorMap,

packages/manager/src/features/TopMenu/SearchBar/SearchBar.tsx

@@ -26,7 +26,7 @@ import {
 } from 'src/queries/objectStorage';
 import { useRegionsQuery } from 'src/queries/regions/regions';
 import { useSpecificTypes } from 'src/queries/types';
-import { useAllVolumesQuery } from 'src/queries/volumes';
+import { useAllVolumesQuery } from 'src/queries/volumes/volumes';
 import { formatLinode } from 'src/store/selectors/getSearchEntities';
 import { isFeatureEnabled } from 'src/utilities/accountCapabilities';
 import { getAPIErrorOrDefault } from 'src/utilities/errorUtils';

packages/manager/src/features/Volumes/AttachVolumeDrawer.tsx

@@ -14,7 +14,7 @@ import { LinodeSelect } from 'src/features/Linodes/LinodeSelect/LinodeSelect';
 import { useEventsPollingActions } from 'src/queries/events/events';
 import { useAllLinodeConfigsQuery } from 'src/queries/linodes/configs';
 import { useGrants } from 'src/queries/profile';
-import { useAttachVolumeMutation } from 'src/queries/volumes';
+import { useAttachVolumeMutation } from 'src/queries/volumes/volumes';
 import { getAPIErrorFor } from 'src/utilities/getAPIErrorFor';
 
 interface Props {

packages/manager/src/features/Volumes/CloneVolumeDrawer.tsx

@@ -13,7 +13,7 @@ import { useGrants } from 'src/queries/profile';
 import {
   useCloneVolumeMutation,
   useVolumeTypesQuery,
-} from 'src/queries/volumes';
+} from 'src/queries/volumes/volumes';
 import {
   handleFieldErrors,
   handleGeneralErrors,

packages/manager/src/features/Volumes/DeleteVolumeDialog.tsx

@@ -4,7 +4,7 @@ import * as React from 'react';
 import { Notice } from 'src/components/Notice/Notice';
 import { TypeToConfirmDialog } from 'src/components/TypeToConfirmDialog/TypeToConfirmDialog';
 import { useEventsPollingActions } from 'src/queries/events/events';
-import { useDeleteVolumeMutation } from 'src/queries/volumes';
+import { useDeleteVolumeMutation } from 'src/queries/volumes/volumes';
 
 interface Props {
   onClose: () => void;

packages/manager/src/features/Volumes/DetachVolumeDialog.tsx

@@ -7,7 +7,7 @@ import { TypeToConfirmDialog } from 'src/components/TypeToConfirmDialog/TypeToCo
 import { Typography } from 'src/components/Typography';
 import { useEventsPollingActions } from 'src/queries/events/events';
 import { useLinodeQuery } from 'src/queries/linodes/linodes';
-import { useDetachVolumeMutation } from 'src/queries/volumes';
+import { useDetachVolumeMutation } from 'src/queries/volumes/volumes';
 
 interface Props {
   onClose: () => void;

packages/manager/src/features/Volumes/EditVolumeDrawer.tsx

@@ -9,7 +9,7 @@ import { Notice } from 'src/components/Notice/Notice';
 import { TagsInput } from 'src/components/TagsInput/TagsInput';
 import { TextField } from 'src/components/TextField';
 import { useGrants } from 'src/queries/profile';
-import { useUpdateVolumeMutation } from 'src/queries/volumes';
+import { useUpdateVolumeMutation } from 'src/queries/volumes/volumes';
 import {
   handleFieldErrors,
   handleGeneralErrors,

packages/manager/src/features/Volumes/ResizeVolumeDrawer.tsx

@@ -12,7 +12,7 @@ import { useGrants } from 'src/queries/profile';
 import {
   useResizeVolumeMutation,
   useVolumeTypesQuery,
-} from 'src/queries/volumes';
+} from 'src/queries/volumes/volumes';
 import {
   handleFieldErrors,
   handleGeneralErrors,

packages/manager/src/features/Volumes/UpgradeVolumeDialog.tsx

@@ -5,7 +5,7 @@ import { ActionsPanel } from 'src/components/ActionsPanel/ActionsPanel';
 import { ConfirmationDialog } from 'src/components/ConfirmationDialog/ConfirmationDialog';
 import { Link } from 'src/components/Link';
 import { Typography } from 'src/components/Typography';
-import { useVolumesMigrateMutation } from 'src/queries/volumesMigrations';
+import { useVolumesMigrateMutation } from 'src/queries/volumes/volumes';
 import { getAPIErrorOrDefault } from 'src/utilities/errorUtils';
 
 import type { Volume } from '@linode/api-v4';

packages/manager/src/features/Volumes/VolumeCreate.tsx

@@ -30,7 +30,7 @@ import { useRegionsQuery } from 'src/queries/regions/regions';
 import {
   useCreateVolumeMutation,
   useVolumeTypesQuery,
-} from 'src/queries/volumes';
+} from 'src/queries/volumes/volumes';
 import { sendCreateVolumeEvent } from 'src/utilities/analytics';
 import { getGDPRDetails } from 'src/utilities/formatRegion';
 import {

packages/manager/src/features/Volumes/VolumeDrawer/LinodeVolumeAttachForm.tsx

@@ -9,7 +9,7 @@ import { ActionsPanel } from 'src/components/ActionsPanel/ActionsPanel';
 import { Notice } from 'src/components/Notice/Notice';
 import { useEventsPollingActions } from 'src/queries/events/events';
 import { useGrants } from 'src/queries/profile';
-import { useAttachVolumeMutation } from 'src/queries/volumes';
+import { useAttachVolumeMutation } from 'src/queries/volumes/volumes';
 import {
   handleFieldErrors,
   handleGeneralErrors,

packages/manager/src/features/Volumes/VolumeDrawer/LinodeVolumeCreateForm.tsx

@@ -15,7 +15,7 @@ import { useEventsPollingActions } from 'src/queries/events/events';
 import {
   useCreateVolumeMutation,
   useVolumeTypesQuery,
-} from 'src/queries/volumes';
+} from 'src/queries/volumes/volumes';
 import { sendCreateVolumeEvent } from 'src/utilities/analytics';
 import { getErrorStringOrDefault } from 'src/utilities/errorUtils';
 import {

packages/manager/src/features/Volumes/VolumeDrawer/PricePanel.tsx

@@ -4,7 +4,7 @@ import * as React from 'react';
 import { Box } from 'src/components/Box';
 import { DisplayPrice } from 'src/components/DisplayPrice';
 import { MAX_VOLUME_SIZE } from 'src/constants';
-import { useVolumeTypesQuery } from 'src/queries/volumes';
+import { useVolumeTypesQuery } from 'src/queries/volumes/volumes';
 import { getDCSpecificPriceByType } from 'src/utilities/pricing/dynamicPricing';
 interface Props {
   currentSize: number;

packages/manager/src/features/Volumes/VolumeDrawer/SizeField.tsx

@@ -9,7 +9,7 @@ import { InputAdornment } from 'src/components/InputAdornment';
 import { TextField } from 'src/components/TextField';
 import { Typography } from 'src/components/Typography';
 import { MAX_VOLUME_SIZE } from 'src/constants';
-import { useVolumeTypesQuery } from 'src/queries/volumes';
+import { useVolumeTypesQuery } from 'src/queries/volumes/volumes';
 import { UNKNOWN_PRICE } from 'src/utilities/pricing/constants';
 import { getDCSpecificPriceByType } from 'src/utilities/pricing/dynamicPricing';
 

packages/manager/src/features/Volumes/VolumeDrawer/VolumeSelect.tsx

@@ -2,7 +2,7 @@ import Autocomplete from '@mui/material/Autocomplete';
 import * as React from 'react';
 
 import { TextField } from 'src/components/TextField';
-import { useInfiniteVolumesQuery } from 'src/queries/volumes';
+import { useInfiniteVolumesQuery } from 'src/queries/volumes/volumes';
 
 interface Props {
   disabled?: boolean;

packages/manager/src/features/Volumes/VolumesLanding.tsx

@@ -14,7 +14,7 @@ import { TableRow } from 'src/components/TableRow';
 import { TableSortCell } from 'src/components/TableSortCell';
 import { useOrder } from 'src/hooks/useOrder';
 import { usePagination } from 'src/hooks/usePagination';
-import { useVolumesQuery } from 'src/queries/volumes';
+import { useVolumesQuery } from 'src/queries/volumes/volumes';
 import { getAPIErrorOrDefault } from 'src/utilities/errorUtils';
 
 import { AttachVolumeDrawer } from './AttachVolumeDrawer';

packages/manager/src/hooks/useEventHandlers.ts

@@ -5,17 +5,17 @@ import { databaseEventsHandler } from 'src/queries/databases';
 import { domainEventsHandler } from 'src/queries/domains';
 import { firewallEventsHandler } from 'src/queries/firewalls';
 import { imageEventsHandler } from 'src/queries/images';
-import { linodeEventsHandler } from 'src/queries/linodes/events';
 import { diskEventHandler } from 'src/queries/linodes/events';
+import { linodeEventsHandler } from 'src/queries/linodes/events';
 import { nodebalanacerEventHandler } from 'src/queries/nodebalancers';
 import { sshKeyEventHandler } from 'src/queries/profile';
+import { stackScriptEventHandler } from 'src/queries/stackscripts';
 import { supportTicketEventHandler } from 'src/queries/support';
 import { tokenEventHandler } from 'src/queries/tokens';
-import { volumeEventsHandler } from 'src/queries/volumes';
+import { volumeEventsHandler } from 'src/queries/volumes/events';
 
 import type { Event } from '@linode/api-v4';
 import type { QueryClient } from '@tanstack/react-query';
-import { stackScriptEventHandler } from 'src/queries/stackscripts';
 
 export interface EventHandlerData {
   event: Event;

packages/manager/src/queries/linodes/events.ts

@@ -1,11 +1,10 @@
 import { EventHandlerData } from 'src/hooks/useEventHandlers';
 import { queryKey as firewallsQueryKey } from 'src/queries/firewalls';
-import { queryKey as volumesQueryKey } from 'src/queries/volumes';
-
 import { accountQueries } from '../account/queries';
 import { queryKey } from './linodes';
 
 import type { Event } from '@linode/api-v4';
+import { volumeQueries } from '../volumes/volumes';
 
 /**
  * Event handler for Linode events
@@ -98,7 +97,7 @@ export const linodeEventsHandler = ({
       queryClient.invalidateQueries([firewallsQueryKey]);
       // A Linode may have been attached to a Volume, but deleted. We need to refetch volumes data so that
       // the Volumes table does not show a Volume attached to a non-existant Linode.
-      queryClient.invalidateQueries([volumesQueryKey]);
+      queryClient.invalidateQueries(volumeQueries.lists.queryKey);
       return;
     case 'linode_config_create':
     case 'linode_config_delete':