feat(app): limit the docker API version supported by the frontend (#11855)

app/react/docker/volumes/queries/build-url.ts

@@ -1,11 +1,11 @@
-import { buildUrl as buildProxyUrl } from '@/react/docker/proxy/queries/build-url';
+import { buildDockerProxyUrl } from '@/react/docker/proxy/queries/buildDockerProxyUrl';
 import { EnvironmentId } from '@/react/portainer/environments/types';
 
 export function buildUrl(
   environmentId: EnvironmentId,
   { action, id }: { id?: string; action?: string } = {}
 ) {
-  let url = buildProxyUrl(environmentId, 'volumes');
+  let url = buildDockerProxyUrl(environmentId, 'volumes');
 
   if (id) {
     url += `/${id}`;

app/react/docker/volumes/queries/useCreateVolumeMutation.ts

@@ -0,0 +1,36 @@
+import { Volume } from 'docker-types/generated/1.41';
+
+import axios, { parseAxiosError } from '@/portainer/services/axios';
+import { EnvironmentId } from '@/react/portainer/environments/types';
+
+import { buildDockerProxyUrl } from '../../proxy/queries/buildDockerProxyUrl';
+import { withAgentTargetHeader } from '../../proxy/queries/utils';
+
+export type VolumeConfiguration = {
+  Name?: Volume['Name']; // docker auto generates if empty
+  Driver?: Volume['Driver']; // docker uses "local" if empty
+  DriverOpts?: Volume['Options'];
+  Labels?: Volume['Labels'];
+};
+
+export async function createVolume(
+  environmentId: EnvironmentId,
+  volumeConfiguration: VolumeConfiguration,
+  { nodeName }: { nodeName: string }
+) {
+  try {
+    const { data } = await axios.post<Volume>(
+      buildDockerProxyUrl(environmentId, 'volumes', 'create'),
+      volumeConfiguration,
+      {
+        headers: {
+          'X-Portainer-VolumeName': volumeConfiguration.Name,
+          ...withAgentTargetHeader(nodeName),
+        },
+      }
+    );
+    return data;
+  } catch (err) {
+    throw parseAxiosError(err, 'Unable to create volume');
+  }
+}

app/react/docker/volumes/queries/useRemoveVolumeMutation.ts

@@ -0,0 +1,23 @@
+import { Volume } from 'docker-types/generated/1.41';
+
+import { EnvironmentId } from '@/react/portainer/environments/types';
+import axios, { parseAxiosError } from '@/portainer/services/axios';
+
+import { buildDockerProxyUrl } from '../../proxy/queries/buildDockerProxyUrl';
+import { withAgentTargetHeader } from '../../proxy/queries/utils';
+
+export async function removeVolume(
+  environmentId: EnvironmentId,
+  name: Volume['Name'],
+  { nodeName }: { nodeName: string }
+) {
+  try {
+    await axios.delete(buildDockerProxyUrl(environmentId, 'volumes', name), {
+      headers: {
+        ...withAgentTargetHeader(nodeName),
+      },
+    });
+  } catch (e) {
+    throw parseAxiosError(e, 'Unable to remove volume');
+  }
+}

app/react/docker/volumes/queries/useVolume.ts

@@ -0,0 +1,26 @@
+import { Volume } from 'docker-types/generated/1.41';
+
+import axios, { parseAxiosError } from '@/portainer/services/axios';
+import { EnvironmentId } from '@/react/portainer/environments/types';
+
+import { buildDockerProxyUrl } from '../../proxy/queries/buildDockerProxyUrl';
+
+/**
+ * Raw docker API query
+ * @param environmentId
+ * @param name
+ * @returns
+ */
+export async function getVolume(
+  environmentId: EnvironmentId,
+  name: Volume['Name']
+) {
+  try {
+    const { data } = await axios.get(
+      buildDockerProxyUrl(environmentId, 'volumes', name)
+    );
+    return data;
+  } catch (e) {
+    throw parseAxiosError(e, 'Unable to retrieve volume details');
+  }
+}

app/react/docker/volumes/queries/useVolumes.ts

@@ -2,10 +2,12 @@ import { useQuery } from '@tanstack/react-query';
 import { Volume } from 'docker-types/generated/1.41';
 
 import axios, { parseAxiosError } from '@/portainer/services/axios';
+import { buildDockerProxyUrl } from '@/react/docker/proxy/queries/buildDockerProxyUrl';
 import { EnvironmentId } from '@/react/portainer/environments/types';
 
+import { withFiltersQueryParam } from '../../proxy/queries/utils';
+
 import { queryKeys } from './query-keys';
-import { buildUrl } from './build-url';
 
 export function useVolumes<T = Volume[]>(
   environmentId: EnvironmentId,
@@ -22,9 +24,41 @@ interface VolumesResponse {
   Volumes: Volume[];
 }
 
-export async function getVolumes(environmentId: EnvironmentId) {
+type Filters = {
+  /**
+   * When set to true (or 1), returns all volumes that are not in use by a container.
+   * When set to false (or 0), only volumes that are in use by one or more containers are returned.
+   */
+  dangling?: ['true' | 'false'];
+  /**
+   * <volume-driver-name>
+   * Matches volumes based on their driver.
+   */
+  driver?: string;
+  /**
+   * <key> or <key>:<value>
+   * Matches volumes based on the presence of a label alone or a label and a value.
+   */
+  label?: string;
+  /**
+   * Matches all or part of a volume name.
+   */
+  name?: Volume['Name'];
+};
+
+export async function getVolumes(
+  environmentId: EnvironmentId,
+  filters?: Filters
+) {
   try {
-    const { data } = await axios.get<VolumesResponse>(buildUrl(environmentId));
+    const { data } = await axios.get<VolumesResponse>(
+      buildDockerProxyUrl(environmentId, 'volumes'),
+      {
+        params: {
+          ...withFiltersQueryParam(filters),
+        },
+      }
+    );
 
     return data.Volumes;
   } catch (error) {