store/cockpitApi: extract helpers into their own file

kingsleyzissou · kingsleyzissou · commit 4054a4612d7a · 2025-09-17T12:36:57.000+01:00
This change refactors some of the cockpit api file end extracts all the
helper functions to their own file. This just makes the file more
manageable to work with.
diff --git a/src/store/cockpit/cockpitApi.ts b/src/store/cockpit/cockpitApi.ts
@@ -11,18 +11,24 @@ import cockpit from 'cockpit';
 import { fsinfo } from 'cockpit/fsinfo';
 import { v4 as uuidv4 } from 'uuid';
 
-import { Blueprint } from './composerCloudApi';
 // We have to work around RTK query here, since it doesn't like splitting
 // out the same api into two separate apis. So, instead, we can just
 // inherit/import the `contentSourcesApi` and build on top of that.
 // This is fine since all the api endpoints for on-prem should query
 // the same unix socket. This allows us to split out the code a little
 // bit so that the `cockpitApi` doesn't become a monolith.
 import { contentSourcesApi } from './contentSourcesApi';
+import {
+  datastreamDistroLookup,
+  getBlueprintsPath,
+  getCloudConfigs,
+  mapToOnpremRequest,
+  paginate,
+  readComposes,
+} from './helpers';
 import type {
   CockpitCreateBlueprintApiArg,
   CockpitCreateBlueprintRequest,
-  CockpitImageRequest,
   CockpitUpdateBlueprintApiArg,
   UpdateWorkerConfigApiArg,
   WorkerConfigFile,
@@ -33,7 +39,6 @@ import {
   mapHostedToOnPrem,
   mapOnPremToHosted,
 } from '../../Components/Blueprints/helpers/onPremToHostedBlueprintMapper';
-import { BLUEPRINTS_DIR } from '../../constants';
 import {
   BlueprintItem,
   ComposeBlueprintApiArg,
@@ -64,104 +69,6 @@ import {
   UpdateBlueprintApiResponse,
 } from '../service/imageBuilderApi';
 
-const lookupDatastreamDistro = (distribution: string) => {
-  if (distribution.startsWith('fedora')) {
-    return 'fedora';
-  }
-
-  if (distribution === 'centos-9') {
-    return 'cs9';
-  }
-
-  if (distribution === 'centos-10') {
-    return 'cs10';
-  }
-
-  if (distribution === 'rhel-9') {
-    return 'rhel9';
-  }
-
-  if (distribution === 'rhel-10') {
-    return 'rhel10';
-  }
-
-  throw 'Unknown distribution';
-};
-
-const getBlueprintsPath = async () => {
-  const user = await cockpit.user();
-
-  // we will use the user's `.local` directory
-  // to save blueprints used for on-prem
-  return `${user.home}/${BLUEPRINTS_DIR}`;
-};
-
-const readComposes = async (bpID: string) => {
-  const blueprintsDir = await getBlueprintsPath();
-  let composes: ComposesResponseItem[] = [];
-  const bpInfo = await fsinfo(
-    path.join(blueprintsDir, bpID),
-    ['entries', 'mtime'],
-    {
-      superuser: 'try',
-    },
-  );
-  const bpEntries = Object.entries(bpInfo?.entries || {});
-  for (const entry of bpEntries) {
-    if (entry[0] === `${bpID}.json`) {
-      continue;
-    }
-    const composeReq = await cockpit
-      .file(path.join(blueprintsDir, bpID, entry[0]))
-      .read();
-    composes = [
-      ...composes,
-      {
-        id: entry[0],
-        request: JSON.parse(composeReq),
-        created_at: new Date(entry[1]!.mtime * 1000).toString(),
-        blueprint_id: bpID,
-      },
-    ];
-  }
-  return composes;
-};
-
-const getCloudConfigs = async () => {
-  try {
-    const worker_config = cockpit.file(
-      '/etc/osbuild-worker/osbuild-worker.toml',
-    );
-    const contents = await worker_config.read();
-    const parsed = TOML.parse(contents);
-    return Object.keys(parsed).filter((k) => k === 'aws');
-  } catch {
-    return [];
-  }
-};
-
-const mapToOnpremRequest = (
-  blueprint: Blueprint,
-  distribution: string,
-  image_requests: CockpitImageRequest[],
-) => {
-  return {
-    blueprint,
-    distribution,
-    image_requests: image_requests.map((ir) => ({
-      architecture: ir.architecture,
-      image_type: ir.image_type,
-      repositories: [],
-      upload_targets: [
-        {
-          type: ir.upload_request.type,
-          upload_options: ir.upload_request.options,
-        },
-      ],
-    })),
-  };
-};
-
 export const cockpitApi = contentSourcesApi.injectEndpoints({
   endpoints: (builder) => {
     return {
@@ -278,31 +185,7 @@ export const cockpitApi = contentSourcesApi.injectEndpoints({
               return true;
             });
 
-            let paginatedBlueprints = blueprints;
-            if (offset !== undefined && limit !== undefined) {
-              paginatedBlueprints = blueprints.slice(offset, offset + limit);
-            }
-
-            let first = '';
-            let last = '';
-
-            if (blueprints.length > 0) {
-              first = blueprints[0].id;
-              last = blueprints[blueprints.length - 1].id;
-            }
-
-            return {
-              data: {
-                meta: { count: blueprints.length },
-                links: {
-                  // These are kind of meaningless for the on-prem
-                  // version
-                  first: first,
-                  last: last,
-                },
-                data: paginatedBlueprints,
-              },
-            };
+            return paginate(blueprints, offset, limit);
           } catch (error) {
             return { error };
           }
@@ -380,7 +263,7 @@ export const cockpitApi = contentSourcesApi.injectEndpoints({
       >({
         queryFn: async ({ distribution }) => {
           try {
-            const dsDistro = lookupDatastreamDistro(distribution);
+            const dsDistro = datastreamDistroLookup(distribution);
             const result = (await cockpit.spawn(
               [
                 'oscap',
@@ -413,7 +296,7 @@ export const cockpitApi = contentSourcesApi.injectEndpoints({
       >({
         queryFn: async ({ distribution, profile }) => {
           try {
-            const dsDistro = lookupDatastreamDistro(distribution);
+            const dsDistro = datastreamDistroLookup(distribution);
             let result = (await cockpit.spawn(
               [
                 'oscap',
@@ -546,19 +429,8 @@ export const cockpitApi = contentSourcesApi.injectEndpoints({
             for (const entry of entries) {
               composes = composes.concat(await readComposes(entry[0]));
             }
-            return {
-              data: {
-                meta: {
-                  count: composes.length,
-                },
-                links: {
-                  first: composes.length > 0 ? composes[0].id : '',
-                  last:
-                    composes.length > 0 ? composes[composes.length - 1].id : '',
-                },
-                data: composes,
-              },
-            };
+
+            return paginate(composes);
           } catch (error) {
             return { error };
           }
@@ -571,19 +443,7 @@ export const cockpitApi = contentSourcesApi.injectEndpoints({
         queryFn: async (queryArgs) => {
           try {
             const composes = await readComposes(queryArgs.id);
-            return {
-              data: {
-                meta: {
-                  count: composes.length,
-                },
-                links: {
-                  first: composes.length > 0 ? composes[0].id : '',
-                  last:
-                    composes.length > 0 ? composes[composes.length - 1].id : '',
-                },
-                data: composes,
-              },
-            };
+            return paginate(composes);
           } catch (error) {
             return { error };
           }
diff --git a/src/store/cockpit/helpers/cloudConfig.ts b/src/store/cockpit/helpers/cloudConfig.ts
@@ -0,0 +1,15 @@
+import TOML from '@ltd/j-toml';
+import cockpit from 'cockpit';
+
+export const getCloudConfigs = async () => {
+  try {
+    const worker_config = cockpit.file(
+      '/etc/osbuild-worker/osbuild-worker.toml',
+    );
+    const contents = await worker_config.read();
+    const parsed = TOML.parse(contents);
+    return Object.keys(parsed).filter((k) => k === 'aws');
+  } catch {
+    return [];
+  }
+};
diff --git a/src/store/cockpit/helpers/composeStatus.ts b/src/store/cockpit/helpers/composeStatus.ts
diff --git a/src/store/cockpit/helpers/datastream.ts b/src/store/cockpit/helpers/datastream.ts
@@ -0,0 +1,23 @@
+export const datastreamDistroLookup = (distribution: string) => {
+  if (distribution.startsWith('fedora')) {
+    return 'fedora';
+  }
+
+  if (distribution === 'centos-9') {
+    return 'cs9';
+  }
+
+  if (distribution === 'centos-10') {
+    return 'cs10';
+  }
+
+  if (distribution === 'rhel-9') {
+    return 'rhel9';
+  }
+
+  if (distribution === 'rhel-10') {
+    return 'rhel10';
+  }
+
+  throw 'Unknown distribution';
+};
diff --git a/src/store/cockpit/helpers/index.ts b/src/store/cockpit/helpers/index.ts
@@ -0,0 +1,5 @@
+export { getCloudConfigs } from './cloudConfig';
+export { datastreamDistroLookup } from './datastream';
+export { paginate } from './paginate';
+export { mapToOnpremRequest } from './onPremRequest';
+export { getBlueprintsPath, readComposes } from './readComposes';
diff --git a/src/store/cockpit/helpers/onPremRequest.ts b/src/store/cockpit/helpers/onPremRequest.ts
@@ -0,0 +1,24 @@
+import { Blueprint } from '../composerCloudApi';
+import { CockpitImageRequest } from '../types';
+
+export const mapToOnpremRequest = (
+  blueprint: Blueprint,
+  distribution: string,
+  image_requests: CockpitImageRequest[],
+) => {
+  return {
+    blueprint,
+    distribution,
+    image_requests: image_requests.map((ir) => ({
+      architecture: ir.architecture,
+      image_type: ir.image_type,
+      repositories: [],
+      upload_targets: [
+        {
+          type: ir.upload_request.type,
+          upload_options: ir.upload_request.options,
+        },
+      ],
+    })),
+  };
+};
diff --git a/src/store/cockpit/helpers/paginate.ts b/src/store/cockpit/helpers/paginate.ts
@@ -0,0 +1,19 @@
+export const paginate = <T extends { id: string }>(
+  items: T[],
+  offset?: number | undefined,
+  limit?: number | undefined,
+) => {
+  const first = items.length > 0 ? items[0].id : '';
+  const last = items.length > 0 ? items[items.length - 1].id : '';
+
+  return {
+    data: {
+      meta: { count: items.length },
+      links: {
+        first: first,
+        last: last,
+      },
+      data: items.slice(offset ?? 0, limit ?? 100),
+    },
+  };
+};
diff --git a/src/store/cockpit/helpers/readComposes.ts b/src/store/cockpit/helpers/readComposes.ts
@@ -0,0 +1,46 @@
+import path from 'path';
+
+import cockpit from 'cockpit';
+import { fsinfo } from 'cockpit/fsinfo';
+
+import { BLUEPRINTS_DIR } from '../../../constants';
+import { ComposesResponseItem } from '../../imageBuilderApi';
+
+export const getBlueprintsPath = async () => {
+  const user = await cockpit.user();
+
+  // we will use the user's `.local` directory
+  // to save blueprints used for on-prem
+  return `${user.home}/${BLUEPRINTS_DIR}`;
+};
+
+export const readComposes = async (bpID: string) => {
+  const blueprintsDir = await getBlueprintsPath();
+  let composes: ComposesResponseItem[] = [];
+  const bpInfo = await fsinfo(
+    path.join(blueprintsDir, bpID),
+    ['entries', 'mtime'],
+    {
+      superuser: 'try',
+    },
+  );
+  const bpEntries = Object.entries(bpInfo?.entries || {});
+  for (const entry of bpEntries) {
+    if (entry[0] === `${bpID}.json`) {
+      continue;
+    }
+    const composeReq = await cockpit
+      .file(path.join(blueprintsDir, bpID, entry[0]))
+      .read();
+    composes = [
+      ...composes,
+      {
+        id: entry[0],
+        request: JSON.parse(composeReq),
+        created_at: new Date(entry[1]!.mtime * 1000).toString(),
+        blueprint_id: bpID,
+      },
+    ];
+  }
+  return composes;
+};
diff --git a/src/test/mocks/cockpit/cockpitFile.ts b/src/test/mocks/cockpit/cockpitFile.ts
@@ -44,7 +44,7 @@ export const cockpitFile = (filepath: string, _options?: object) => {
       return readCompose(file.name);
     },
     close: () => {},
-    replace: (contents: string) => {
+    replace: async (contents: string) => {
       const file = path.parse(filepath);
       const dir = path.parse(file.dir);
       if (file.name === dir.name) {
