Header generation refactoring

[ATorrise]

This refactoring effort centralizes and standardizes header generation across the SDK and CLI.

responseTimeout (and other headers) are now consistently applied in all REST calls and to simplify maintenance and future extensibility.

• All header logic is now consolidated in a single utility class in ZosFilesHeaders. This replaces duplicate header creation logic across multiple SDK methods and separate header generation functions across the different methods.

• Header Generation now:

  • depends on:
    • the request options
  • optionally takes:
    • dataLength
    • enum called context where:
      • STREAM and BUFFER: representing any upload/download operation
      • USS
      • ZFS
      • Undefined / Default: when no context is provided, the default is to treat the operation as a Dataset creation.

  (method) ZosFilesHeaders.generateHeaders<T>({ options, context, dataLength, }: {
      options: T;
      context?: ZosFilesContext;
      dataLength?: number | string;
  }): IHeaderContent[]
  Generates an array of headers based on provided options and context.
  
  @param options — The request options.
  
  @param context — The operation context from enum (optional) ie STREAM or ZFS.
  
  @param dataLength — The content length (optional).
  
  @returns — An array of generated headers.

Because of this centralization, any future header changes or additions require modifications in only one location. And creating headers can now be done with a one line function call, without much thought required in future development of the files SDK.

        const reqHeaders = ZosFilesHeaders.generateHeaders({options, dataLength: jsonContent.length});

[github-actions]

📅 Suggested merge-by date: 3/5/2025

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 91.45%. Comparing base (e80dcd2) to head (c62d3f7).

Additional details and impacted files

@@            Coverage Diff             @@
##           master    #2436      +/-   ##
==========================================
- Coverage   91.49%   91.45%   -0.05%     
==========================================
  Files         641      642       +1     
  Lines       18358    18341      -17     
  Branches     3978     3955      -23     
==========================================
- Hits        16796    16773      -23     
- Misses       1560     1566       +6     
  Partials        2        2              

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[anaxceron]

Left some comments re: changelogs

[sonarqubecloud]

Quality Gate passed

Issues
1 New issue
0 Accepted issues

Measures
0 Security Hotspots
97.5% Coverage on New Code
0.2% Duplication on New Code

See analysis details on SonarQube Cloud

[awharn]

I attempted to run a zowe files list ds command on this branch, but it fails with the following error:

Response From Service
TypeError [ERR_HTTP_INVALID_HEADER_VALUE]: Invalid value "undefined" for header "undefined"

[t1m0thyj]

We want to make sure that no extra headers are being defined, so I don't think we should use expect.arrayContaining for headers in our unit tests.

If we need a way to ignore the order of the headers, we could create a Jest helper function that expects the exact same set of items but allows any order.