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

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

@@ -1,5 +0,0 @@
-import { EnvironmentId } from '@/react/portainer/environments/types';
-
-export function buildUrl(environmentId: EnvironmentId, path: string) {
-  return `/docker/${environmentId}/${path}`;
-}

app/react/docker/queries/utils/buildDockerUrl.ts

@@ -0,0 +1,50 @@
+import { compact } from 'lodash';
+
+import { EnvironmentId } from '@/react/portainer/environments/types';
+
+/**
+ * Build docker URL for Environment
+ *
+ * @param environmentId
+ * @param action
+ * @param subSegments Sub segments are only added to the URL when they are not `undefined`.
+ * @returns `/docker/{environmentId}/{action}/{subSegments[0]}/{subSegments[1]}/...`
+ *
+ * @example
+ * // all calls return /docker/1/action/sub1/sub2
+ * buildDockerUrl(1, 'action', 'sub1', 'sub2');
+ * buildDockerUrl(1, 'action', undefined, 'sub1', undefined, 'sub2');
+ *
+ * @example
+ * function buildUrl(endpointId: EnvironmentId, id?: ServiceId, action?: string) {
+ *   return buildDockerUrl(endpointId, 'services', id, action);
+ *}
+ *
+ * // returns /docker/1/services/ubx3r/update
+ * buildUrl(1, 'ubx3r', 'update')
+ *
+ * // returns /docker/1/services/update
+ * buildUrl(1, undefined, 'update')
+ *
+ * // returns /docker/1/services/ubx3r
+ * buildUrl(1, 'ubx3r') // = buildUrl(1, 'ubx3r', undefined)
+ *
+ * // returns /docker/1/services
+ * buildUrl(1) // = buildUrl(1, undefined, undefined)
+ *
+ */
+export function buildDockerUrl(
+  environmentId: EnvironmentId,
+  action: string,
+  ...subSegments: unknown[]
+) {
+  let url = `/docker/${environmentId}/${action}`;
+
+  const joined = compact(subSegments).join('/');
+
+  if (joined) {
+    url += `/${joined}`;
+  }
+
+  return url;
+}

app/react/docker/queries/utils/container.ts

@@ -1,4 +1,4 @@
-import { DockerContainer } from '@/react/docker/containers/types';
+import { ContainerListViewModel } from '@/react/docker/containers/types';
 import { EdgeStack } from '@/react/edge/edge-stacks/types';
 import { EnvironmentId } from '@/react/portainer/environments/types';
 
@@ -18,13 +18,13 @@ export const queryKeys = {
   ) => [...queryKeys.containers(environmentId), params] as const,
   container: (
     environmentId: EnvironmentId,
-    containerId: DockerContainer['Id']
+    containerId: ContainerListViewModel['Id']
   ) => [...queryKeys.containers(environmentId), containerId] as const,
 };
 
 export function buildDockerSnapshotContainersUrl(
   environmentId: EnvironmentId,
-  containerId?: DockerContainer['Id']
+  containerId?: ContainerListViewModel['Id']
 ) {
   let url = `${buildDockerSnapshotUrl(environmentId)}/containers`;
 

app/react/docker/queries/utils/root.ts

@@ -1,5 +1,7 @@
 import { EnvironmentId } from '@/react/portainer/environments/types';
 
+import { buildDockerUrl } from './buildDockerUrl';
+
 export const queryKeys = {
   root: (environmentId: EnvironmentId) => ['docker', environmentId] as const,
   snapshot: (environmentId: EnvironmentId) =>
@@ -10,10 +12,6 @@ export const queryKeys = {
     [...queryKeys.root(environmentId), 'plugins'] as const,
 };
 
-export function buildDockerUrl(environmentId: EnvironmentId) {
-  return `/docker/${environmentId}`;
-}
-
 export function buildDockerSnapshotUrl(environmentId: EnvironmentId) {
-  return `${buildDockerUrl(environmentId)}/snapshot`;
+  return buildDockerUrl(environmentId, 'snapshot');
 }