feat(x2a): allow downloading logs from Logviewer (#2770)

* feat(x2a): allow downloading logs from Logviewer

Copy is a bit hard, and It's good to have a way to donwload logs on the
phases.

FIX: FLPATH-3559

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

* fix(x2a): defer blob URL revocation to prevent download race condition

URL.revokeObjectURL() was called synchronously after anchor.click(),
which could race with the browser download start and cause failed or
empty downloads. Defer revocation with setTimeout to allow the browser
to initiate the download first.

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

---------

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

Author: eloycoto

workspaces/x2a/plugins/x2a/src/components/PhaseDetails.tsx

@@ -36,6 +36,7 @@ import { useClientService } from '../ClientService';
 import { ItemField } from './ItemField';
 import {
   canCancelPhase,
+  downloadLogFile,
   formatDuration,
   humanizeDate,
   secondsBetween,
@@ -283,6 +284,9 @@ export const PhaseDetails = (
             <div style={{ height: 400 }}>
               <LogViewer
                 text={logText || t('modulePage.phases.noLogsAvailable')}
+                onDownloadLog={() =>
+                  downloadLogFile(logText || '', `${phaseName}-${projectId}`)
+                }
               />
             </div>
           )}

workspaces/x2a/plugins/x2a/src/components/tools/downloadLogFile.test.ts

@@ -0,0 +1,78 @@
+/*
+ * 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.
+ */
+
+import { downloadLogFile } from './downloadLogFile';
+
+describe('downloadLogFile', () => {
+  let createObjectURLMock: jest.Mock;
+  let revokeObjectURLMock: jest.Mock;
+  let anchorClickMock: jest.Mock;
+
+  beforeEach(() => {
+    jest.useFakeTimers();
+    createObjectURLMock = jest.fn().mockReturnValue('blob:mock-url');
+    revokeObjectURLMock = jest.fn();
+    URL.createObjectURL = createObjectURLMock;
+    URL.revokeObjectURL = revokeObjectURLMock;
+
+    anchorClickMock = jest.fn();
+    jest.spyOn(document, 'createElement').mockReturnValue({
+      set href(_: string) {},
+      set download(_: string) {},
+      click: anchorClickMock,
+    } as unknown as HTMLAnchorElement);
+  });
+
+  afterEach(() => {
+    jest.useRealTimers();
+    jest.restoreAllMocks();
+  });
+
+  it('creates a blob with the provided text', () => {
+    downloadLogFile('log content', 'test');
+
+    expect(createObjectURLMock).toHaveBeenCalledWith(expect.any(Blob));
+  });
+
+  it('triggers a download with the correct filename', () => {
+    const setDownloadSpy = jest.fn();
+    jest.spyOn(document, 'createElement').mockReturnValue({
+      set href(_: string) {},
+      set download(val: string) {
+        setDownloadSpy(val);
+      },
+      click: anchorClickMock,
+    } as unknown as HTMLAnchorElement);
+
+    downloadLogFile('log content', 'analyze-proj-1');
+
+    expect(setDownloadSpy).toHaveBeenCalledWith('analyze-proj-1.log');
+  });
+
+  it('clicks the anchor to trigger download', () => {
+    downloadLogFile('log content', 'test');
+
+    expect(anchorClickMock).toHaveBeenCalled();
+  });
+
+  it('revokes the object URL after download', () => {
+    downloadLogFile('log content', 'test');
+
+    expect(revokeObjectURLMock).not.toHaveBeenCalled();
+    jest.runAllTimers();
+    expect(revokeObjectURLMock).toHaveBeenCalledWith('blob:mock-url');
+  });
+});

workspaces/x2a/plugins/x2a/src/components/tools/downloadLogFile.ts

@@ -0,0 +1,25 @@
+/*
+ * 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.
+ */
+
+export const downloadLogFile = (text: string, name: string): void => {
+  const blob = new Blob([text], { type: 'text/plain' });
+  const url = URL.createObjectURL(blob);
+  const anchor = document.createElement('a');
+  anchor.href = url;
+  anchor.download = `${name}.log`;
+  anchor.click();
+  setTimeout(() => URL.revokeObjectURL(url), 100);
+};

workspaces/x2a/plugins/x2a/src/components/tools/index.ts

@@ -23,6 +23,7 @@ export * from './getLastPhaseReached';
 export * from './getNextPhase';
 export * from './canRunNextPhase';
 export * from './canCancelPhase';
+export * from './downloadLogFile';
 export * from './hasPhasePrerequisites';
 export * from './areEligibleModulesToRun';
 export * from './isEligibleForRetriggerInit';