fix(jobs): Binary spool files corrupted by newline normalization

Signed-off-by: Timothy Johnson <[email protected]>
zowe · Oct 3, 2024 · 45332a9 · 45332a9
1 parent 57e9e72
commit 45332a9
Show file tree

Hide file tree

Showing 3 changed files with 23 additions and 17 deletions.
diff --git a/packages/zosjobs/CHANGELOG.md b/packages/zosjobs/CHANGELOG.md
@@ -2,6 +2,10 @@
 
 All notable changes to the Zowe z/OS jobs SDK package will be documented in this file.
 
+## Recent Changes
+
+- BugFix: Fixed error in `DownloadJobs.downloadSpoolContentCommon` method causing binary spool files to be corrupted by newline normalization. [#2282](https://github.com/zowe/zowe-cli/issues/2282)
+
 ## `7.26.1`
 
 - BugFix: Fixed error in `DownloadJobs.downloadSpoolContentCommon` method when encoding parameter is not specified. [#2173](https://github.com/zowe/zowe-cli/pull/2173)

diff --git a/packages/zosjobs/__tests__/__unit__/DownloadJobs.unit.test.ts b/packages/zosjobs/__tests__/__unit__/DownloadJobs.unit.test.ts
@@ -9,7 +9,7 @@
 *
 */
 
-import { AbstractSession, ImperativeError, IO } from "@zowe/imperative";
+import { AbstractSession, Headers, ImperativeError, IO } from "@zowe/imperative";
 import { DownloadJobs, GetJobs, IDownloadAllSpoolContentParms, IDownloadSpoolContentParms, IJobFile } from "../../src";
 import { ZosmfRestClient } from "@zowe/core-for-zowe-sdk";
 import { Writable } from "stream";
@@ -103,10 +103,7 @@ describe("DownloadJobs", () => {
 
         describe("downloadAllSpoolContentCommon", () => {
             it("should allow users to call downloadAllSpoolContentCommon with correct parameters", async () => {
-                let uri: string = "";
-                ZosmfRestClient.getStreamed = jest.fn(async (session: AbstractSession, resource: string, reqHeaders?: any[]): Promise<any> => {
-                    uri = resource;
-                });
+                const getStreamedSpy = jest.spyOn(ZosmfRestClient, "getStreamed");
                 const allSpoolParms: IDownloadAllSpoolContentParms = {
                     jobid: fakeJobID,
                     jobname: fakeJobName,
@@ -120,14 +117,15 @@ describe("DownloadJobs", () => {
 
                 expect(GetJobs.getSpoolFiles).toHaveBeenCalled();
                 expect(IO.createDirsSyncFromFilePath).toHaveBeenCalledWith(expectedFile);
-                expect(uri).not.toContain("fileEncoding");
+                expect(getStreamedSpy).toHaveBeenCalledTimes(1);
+                const [_session, resource, reqHeaders, _responseStream, normalizeResponseNewLines] = getStreamedSpy.mock.calls[0];
+                expect(resource).not.toContain("fileEncoding");
+                expect(reqHeaders).toContain(Headers.TEXT_PLAIN_UTF8);
+                expect(normalizeResponseNewLines).toBe(true);
             });
 
             it("should allow users to call downloadAllSpoolContentCommon with correct parameters and binary mode", async () => {
-                let uri: string = "";
-                ZosmfRestClient.getStreamed = jest.fn(async (session: AbstractSession, resource: string, reqHeaders?: any[]): Promise<any> => {
-                    uri = resource;
-                });
+                const getStreamedSpy = jest.spyOn(ZosmfRestClient, "getStreamed");
                 const allSpoolParms: IDownloadAllSpoolContentParms = {
                     jobid: fakeJobID,
                     jobname: fakeJobName,
@@ -142,14 +140,14 @@ describe("DownloadJobs", () => {
 
                 expect(GetJobs.getSpoolFiles).toHaveBeenCalled();
                 expect(IO.createDirsSyncFromFilePath).toHaveBeenCalledWith(expectedFile);
-                expect(uri).toContain("?mode=binary");
+                expect(getStreamedSpy).toHaveBeenCalledTimes(1);
+                const [_session, resource, _reqHeaders, _responseStream, normalizeResponseNewLines] = getStreamedSpy.mock.calls[0];
+                expect(resource).toContain("?mode=binary");
+                expect(normalizeResponseNewLines).toBe(false);
             });
 
             it("should allow users to call downloadAllSpoolContentCommon with correct parameters and record mode", async () => {
-                let uri: string = "";
-                ZosmfRestClient.getStreamed = jest.fn(async (session: AbstractSession, resource: string, reqHeaders?: any[]): Promise<any> => {
-                    uri = resource;
-                });
+                const getStreamedSpy = jest.spyOn(ZosmfRestClient, "getStreamed");
                 const allSpoolParms: IDownloadAllSpoolContentParms = {
                     jobid: fakeJobID,
                     jobname: fakeJobName,
@@ -164,7 +162,10 @@ describe("DownloadJobs", () => {
 
                 expect(GetJobs.getSpoolFiles).toHaveBeenCalled();
                 expect(IO.createDirsSyncFromFilePath).toHaveBeenCalledWith(expectedFile);
-                expect(uri).toContain("?mode=record");
+                expect(getStreamedSpy).toHaveBeenCalledTimes(1);
+                const [_session, resource, _reqHeaders, _responseStream, normalizeResponseNewLines] = getStreamedSpy.mock.calls[0];
+                expect(resource).toContain("?mode=record");
+                expect(normalizeResponseNewLines).toBe(false);
             });
 
             it("should allow users to call downloadAllSpoolContentCommon with a job containing duplicate step names", async () => {

diff --git a/packages/zosjobs/src/DownloadJobs.ts b/packages/zosjobs/src/DownloadJobs.ts
@@ -127,8 +127,9 @@ export class DownloadJobs {
         }
 
         const writeStream = parms.stream ?? IO.createWriteStream(file);
+        const normalizeResponseNewLines = !(parms.binary || parms.record);
         await ZosmfRestClient.getStreamed(session, JobsConstants.RESOURCE + parameters, [Headers.TEXT_PLAIN_UTF8], writeStream,
-            true);
+            normalizeResponseNewLines);
     }
 
     /**