feat(x2a): log streaming and copy*paste without row numbers (#2927)

Stream logs in real-time as backend jobs produce them.
Exclude row numbers from copy selection.


Made-with: Cursor

Signed-off-by: Marek Libra <marek.libra@gmail.com>

Author: mareklibra

workspaces/x2a/.changeset/pretty-planes-strive.md

@@ -0,0 +1,6 @@
+---
+'@red-hat-developer-hub/backstage-plugin-x2a-backend': patch
+'@red-hat-developer-hub/backstage-plugin-x2a': patch
+---
+
+Stream logs in real-time as backend jobs produce them. Exclude row numbers from copy selection.

workspaces/x2a/packages/app/src/setupTests.ts

@@ -27,6 +27,7 @@ const suppressPatterns = [
   'findDOMNode is deprecated', // @material-ui/core
   'validateDOMNesting', // React DOM nesting (e.g. div inside p from Typography)
   'Not implemented: HTMLCanvasElement.prototype.getContext', // JSDOM canvas
+  'DEPRECATION WARNING', // @backstage/frontend-plugin-api config.schema → configSchema
 ];
 const getMatchedPattern = (args: unknown[]): string | null => {
   const first = args[0];

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

@@ -43,6 +43,7 @@ jest.mock('./services/makeK8sClient', () => ({
   makeK8sClient: jest.fn(() => ({
     coreV1Api: {},
     batchV1Api: {},
+    kubeConfig: { getCurrentCluster: () => ({ server: 'https://mock' }) },
   })),
 }));
 

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

@@ -219,6 +219,54 @@ describe('createRouter – jobs (log)', () => {
         LONG_TEST_TIMEOUT,
       );
 
+      it(
+        'should return 200 with empty body when streaming and kube has no log data yet (e.g. no pod or Pending)',
+        async () => {
+          await createTestJob(x2aDatabase, {
+            projectId: project.id,
+            moduleId: null,
+            phase: 'init',
+            status: 'running',
+            k8sJobName: 'init-k8s-job',
+          });
+          const mockGetJobLogs = jest.fn().mockResolvedValue('');
+          const app = await createApp(client, undefined, undefined, {
+            getJobLogs: mockGetJobLogs,
+          });
+          const response = await request(app)
+            .get(`/projects/${project.id}/log?streaming=true`)
+            .send();
+          expect(response.status).toBe(200);
+          expect(response.type).toBe('text/plain');
+          expect(response.text).toBe('');
+          expect(mockGetJobLogs).toHaveBeenCalledWith('init-k8s-job', true);
+        },
+        LONG_TEST_TIMEOUT,
+      );
+
+      it(
+        'should not call getJobLogs for streaming when init job has no k8sJobName yet',
+        async () => {
+          await createTestJob(x2aDatabase, {
+            projectId: project.id,
+            moduleId: null,
+            phase: 'init',
+            status: 'pending',
+          });
+          const mockGetJobLogs = jest.fn();
+          const app = await createApp(client, undefined, undefined, {
+            getJobLogs: mockGetJobLogs,
+          });
+          const response = await request(app)
+            .get(`/projects/${project.id}/log?streaming=true`)
+            .send();
+          expect(response.status).toBe(200);
+          expect(response.text).toBe('');
+          expect(mockGetJobLogs).not.toHaveBeenCalled();
+        },
+        LONG_TEST_TIMEOUT,
+      );
+
       it(
         'should return 404 when no init job found for project',
         async () => {

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

@@ -34,6 +34,7 @@ async function sendJobLogs(
   deps: Pick<RouterDeps, 'x2aDatabase' | 'kubeService' | 'logger'>,
 ): Promise<void> {
   const { x2aDatabase, kubeService, logger } = deps;
+  res.setHeader('Content-Type', 'text/plain; charset=utf-8');
 
   if (
     job.status === 'success' ||
@@ -43,7 +44,6 @@ async function sendJobLogs(
     logger.info(
       `Job ${job.id} is finished (status: ${job.status}), returning logs from database`,
     );
-    res.setHeader('Content-Type', 'text/plain');
     const log = await x2aDatabase.getJobLogs({ jobId: job.id });
     if (!log) {
       logger.error(`Log not found for a finished job ${job.id}`);
@@ -54,14 +54,15 @@ async function sendJobLogs(
 
   if (!job.k8sJobName) {
     logger.warn(`Job ${job.id} has no k8sJobName, returning empty logs`);
-    res.setHeader('Content-Type', 'text/plain');
     res.send('');
     return;
   }
 
   const logs = await kubeService.getJobLogs(job.k8sJobName, streaming);
-  res.setHeader('Content-Type', 'text/plain');
   if (streaming && typeof logs !== 'string') {
+    // Hints to proxies (e.g. nginx, OpenShift route) not to buffer the body.
+    res.setHeader('Cache-Control', 'no-store, no-transform, must-revalidate');
+    res.setHeader('X-Accel-Buffering', 'no');
     const stream = logs as Readable;
     stream.on('error', err => {
       logger.error(

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

@@ -196,6 +196,57 @@ describe('createRouter – jobs (module log)', () => {
         LONG_TEST_TIMEOUT,
       );
 
+      it(
+        'should return 200 with empty body when streaming and kube has no log data yet',
+        async () => {
+          await createTestJob(x2aDatabase, {
+            projectId: project.id,
+            moduleId: module.id,
+            phase: 'analyze',
+            status: 'running',
+            k8sJobName: 'test-k8s-job',
+          });
+          const mockGetJobLogs = jest.fn().mockResolvedValue('');
+          const app = await createApp(client, undefined, undefined, {
+            getJobLogs: mockGetJobLogs,
+          });
+          const response = await request(app)
+            .get(
+              `/projects/${project.id}/modules/${module.id}/log?phase=analyze&streaming=true`,
+            )
+            .send();
+          expect(response.status).toBe(200);
+          expect(response.text).toBe('');
+          expect(mockGetJobLogs).toHaveBeenCalledWith('test-k8s-job', true);
+        },
+        LONG_TEST_TIMEOUT,
+      );
+
+      it(
+        'should not call getJobLogs for module streaming when job has no k8sJobName yet',
+        async () => {
+          await createTestJob(x2aDatabase, {
+            projectId: project.id,
+            moduleId: module.id,
+            phase: 'publish',
+            status: 'pending',
+          });
+          const mockGetJobLogs = jest.fn();
+          const app = await createApp(client, undefined, undefined, {
+            getJobLogs: mockGetJobLogs,
+          });
+          const response = await request(app)
+            .get(
+              `/projects/${project.id}/modules/${module.id}/log?phase=publish&streaming=true`,
+            )
+            .send();
+          expect(response.status).toBe(200);
+          expect(response.text).toBe('');
+          expect(mockGetJobLogs).not.toHaveBeenCalled();
+        },
+        LONG_TEST_TIMEOUT,
+      );
+
       it(
         'should return 400 when phase parameter is missing',
         async () => {