feat(x2a): added /projects/:projectId/modules/:moduleId/log endpoint (#2249)

- Openapi definition and generated files.
- Router defitinition:
    - Rbac
    - Check with project/module
    - Check if the job has been finished.
    - k8s integration if not finished with streaming support.
- Test for the router.

Signed-off-by: Eloy Coto <eloy.coto@acalustra.com>

Author: eloycoto

workspaces/x2a/plugins/x2a-backend/src/router.test.ts

@@ -520,6 +520,102 @@ export async function createRouter({
     },
   );
 
+  router.get('/projects/:projectId/modules/:moduleId/log', async (req, res) => {
+    const endpoint = 'GET /projects/:projectId/modules/:moduleId/log';
+    const { projectId, moduleId } = req.params;
+    const streaming = req.query.streaming === true;
+    const phase = req.query.phase as string | undefined;
+
+    // Validate phase parameter (required)
+    if (!phase) {
+      throw new InputError('phase query parameter is required');
+    }
+
+    logger.info(
+      `${endpoint} request: projectId=${projectId}, moduleId=${moduleId}, streaming=${streaming}, phase=${phase}`,
+    );
+
+    // Get credentials and permissions
+    const credentials = await httpAuth.credentials(req, { allow: ['user'] });
+    const canViewAll = await isUserOfAdminViewPermission(
+      req as unknown as Request,
+      permissionsSvc,
+      httpAuth,
+    );
+
+    // Verify project exists and user has access
+    const project = await x2aDatabase.getProject(
+      { projectId },
+      { credentials, canViewAll },
+    );
+    if (!project) {
+      throw new NotFoundError(`Project not found`);
+    }
+
+    // Verify module exists
+    const module = await x2aDatabase.getModule({ id: moduleId });
+    if (!module) {
+      throw new NotFoundError(`Module not found`);
+    }
+
+    // Verify module belongs to project
+    if (module.projectId !== projectId) {
+      throw new NotFoundError(`Module does not belong to project`);
+    }
+
+    // Get latest job for module filtered by requested phase
+    const jobs = await x2aDatabase.listJobs({
+      moduleId,
+      phase: phase as any,
+    });
+
+    if (jobs.length === 0) {
+      throw new NotFoundError(`No jobs found for module with phase '${phase}'`);
+    }
+
+    const latestJob = jobs[0]; // Already sorted by started_at DESC in listJobs
+
+    // Validate the latest job phase matches requested phase (sanity check)
+    if (latestJob.phase !== phase) {
+      throw new InputError(
+        `Latest job phase '${latestJob.phase}' does not match requested phase '${phase}'`,
+      );
+    }
+
+    // If job is finished, return logs from database
+    if (latestJob.status === 'success' || latestJob.status === 'error') {
+      logger.info(
+        `Job ${latestJob.id} is finished (status: ${latestJob.status}), returning logs from database`,
+      );
+      res.setHeader('Content-Type', 'text/plain');
+      res.send(latestJob.log || '');
+      return;
+    }
+
+    // Check if job has k8sJobName
+    if (!latestJob.k8sJobName) {
+      logger.warn(
+        `Job ${latestJob.id} has no k8sJobName, returning empty logs`,
+      );
+      res.setHeader('Content-Type', 'text/plain');
+      res.send('');
+      return;
+    }
+
+    // Get logs from Kubernetes
+    const logs = await kubeService.getJobLogs(latestJob.k8sJobName, streaming);
+
+    // Set content type
+    res.setHeader('Content-Type', 'text/plain');
+
+    // Handle streaming vs non-streaming
+    if (streaming && typeof logs !== 'string') {
+      logs.pipe(res);
+    } else {
+      res.send(logs as string);
+    }
+  });
+
   // TODO: Implement /collectArtifacts endpoints for callback from Kubernetes jobs
   // These endpoints should use Backstage service-to-service authentication with static tokens
   // See: https://backstage.io/docs/auth/service-to-service-auth#static-tokens

workspaces/x2a/plugins/x2a-backend/src/router.ts

@@ -305,6 +305,43 @@ paths:
                   - jobId
         '404':
           description: Project or module not found
+  /projects/{projectId}/modules/{moduleId}/log:
+    get:
+      summary: Returns logs for the latest job of a module
+      parameters:
+        - in: path
+          name: projectId
+          schema:
+            type: string
+          required: true
+          description: Project UUID
+        - in: path
+          name: moduleId
+          schema:
+            type: string
+          required: true
+          description: Module UUID
+        - in: query
+          name: streaming
+          schema:
+            type: boolean
+          required: false
+          description: Whether to stream logs (text/plain) or return all at once
+        - in: query
+          name: phase
+          schema:
+            $ref: '#/components/schemas/Phase'
+          required: true
+          description: Migration phase to filter
+      responses:
+        '200':
+          description: Module logs
+          content:
+            text/plain:
+              schema:
+                type: string
+        '404':
+          description: Module not found or no jobs exist
 components:
   schemas:
     Project:
@@ -404,3 +441,11 @@ components:
       required:
         - url
         - orgName
+
+    Phase:
+      type: string
+      enum:
+        - analyze
+        - migrate
+        - publish
+      description: Migration phases to execute

workspaces/x2a/plugins/x2a-backend/src/schema/openapi.yaml

@@ -20,6 +20,7 @@
 // * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY. *
 // ******************************************************************
 import { Module } from '../models/Module.model';
+import { Phase } from '../models/Phase.model';
 import { Project } from '../models/Project.model';
 import { ProjectsGet200Response } from '../models/ProjectsGet200Response.model';
 import { ProjectsPostRequest } from '../models/ProjectsPostRequest.model';
@@ -72,6 +73,20 @@ export type ProjectsProjectIdGet = {
   };
   response: Project | void;
 };
+/**
+ * @public
+ */
+export type ProjectsProjectIdModulesModuleIdLogGet = {
+  path: {
+    projectId: string;
+    moduleId: string;
+  };
+  query: {
+    streaming?: boolean;
+    phase: Phase;
+  };
+  response: string | void;
+};
 /**
  * @public
  */
@@ -113,6 +128,8 @@ export type EndpointMap = {
 
   '#get|/projects/{projectId}': ProjectsProjectIdGet;
 
+  '#get|/projects/{projectId}/modules/{moduleId}/log': ProjectsProjectIdModulesModuleIdLogGet;
+
   '#post|/projects/{projectId}/modules/{moduleId}/run': ProjectsProjectIdModulesModuleIdRunPost;
 
   '#post|/projects/{projectId}/modules': ProjectsProjectIdModulesPost;

workspaces/x2a/plugins/x2a-backend/src/schema/openapi/generated/apis/Api.server.ts

@@ -0,0 +1,24 @@
+/*
+ * Copyright Red Hat, Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+// ******************************************************************
+// * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY. *
+// ******************************************************************
+
+/**
+ * @public
+ */
+export type Phase = 'analyze' | 'migrate' | 'publish';

workspaces/x2a/plugins/x2a-backend/src/schema/openapi/generated/models/Phase.model.ts

@@ -17,6 +17,7 @@
 export * from '../models/AAPCredentials.model';
 export * from '../models/GitRepoAuth.model';
 export * from '../models/Module.model';
+export * from '../models/Phase.model';
 export * from '../models/Project.model';
 export * from '../models/ProjectsGet200Response.model';
 export * from '../models/ProjectsPostRequest.model';

workspaces/x2a/plugins/x2a-backend/src/schema/openapi/generated/models/index.ts

@@ -466,6 +466,64 @@ export const spec = {
           }
         }
       }
+    },
+    "/projects/{projectId}/modules/{moduleId}/log": {
+      "get": {
+        "summary": "Returns logs for the latest job of a module",
+        "parameters": [
+          {
+            "in": "path",
+            "name": "projectId",
+            "schema": {
+              "type": "string"
+            },
+            "required": true,
+            "description": "Project UUID"
+          },
+          {
+            "in": "path",
+            "name": "moduleId",
+            "schema": {
+              "type": "string"
+            },
+            "required": true,
+            "description": "Module UUID"
+          },
+          {
+            "in": "query",
+            "name": "streaming",
+            "schema": {
+              "type": "boolean"
+            },
+            "required": false,
+            "description": "Whether to stream logs (text/plain) or return all at once"
+          },
+          {
+            "in": "query",
+            "name": "phase",
+            "schema": {
+              "$ref": "#/components/schemas/Phase"
+            },
+            "required": true,
+            "description": "Migration phase to filter"
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "Module logs",
+            "content": {
+              "text/plain": {
+                "schema": {
+                  "type": "string"
+                }
+              }
+            }
+          },
+          "404": {
+            "description": "Module not found or no jobs exist"
+          }
+        }
+      }
     }
   },
   "components": {
@@ -594,6 +652,15 @@ export const spec = {
           "url",
           "orgName"
         ]
+      },
+      "Phase": {
+        "type": "string",
+        "enum": [
+          "analyze",
+          "migrate",
+          "publish"
+        ],
+        "description": "Migration phases to execute"
       }
     }
   }

workspaces/x2a/plugins/x2a-backend/src/schema/openapi/generated/router.ts

@@ -463,20 +463,31 @@ export class X2ADatabaseService {
     };
   }
 
-  async listJobs({ moduleId }: { moduleId: string }): Promise<Job[]> {
+  async listJobs({
+    moduleId,
+    phase = null,
+  }: {
+    moduleId: string;
+    phase?: MigrationPhase | null;
+  }): Promise<Job[]> {
     this.#logger.info(`listJobs called for moduleId: ${moduleId}`);
 
     // Fetch all jobs for the given module
     const rows = await this.#dbClient('jobs')
       .where('module_id', moduleId)
+      .modify(queryBuilder => {
+        if (phase) {
+          queryBuilder.where('phase', phase);
+        }
+      })
       .select('*')
       .orderBy('started_at', 'desc');
 
     if (rows.length === 0) {
       return [];
     }
 
-    const jobIds = rows.map(row => row.id);
+    const jobIds = rows.map((row: any) => row.id);
 
     // Fetch all artifacts for these jobs in a single query
     const artifactRows = await this.#dbClient('artifacts')
@@ -494,7 +505,7 @@ export class X2ADatabaseService {
     }
 
     // Build jobs with their artifacts
-    const jobs: Job[] = rows.map(row => {
+    const jobs: Job[] = rows.map((row: any) => {
       const job = this.mapRowToJob(row);
       return {
         ...job,