Header generation refactoring

[ATorrise]

This refactoring effort centralizes and standardizes header generation across the Files SDK and CLI, consolidating all header logic into a single utility class—ZosFilesHeaders—and replacing duplicate header creation code across multiple methods.

The new implementation leverages a unified headerMap to manage header generation functions, ensuring that headers like responseTimeout, etag, and others are applied consistently in all ZosFiles REST calls.

• Header Generation now:

  • Requires:
    • the request options
  • Optionally takes:
    • dataLength parameter to add a Content-Length header when needed.
    • ZosFilesContext enum that guides which Content-Type headers are applied for certain methods. These enum values include:
      • USS_MULTIPLE
        • Forces a general content-type header ("Content-Type": "application/json") when multiple USS files.
      • ZFS& LIST
        • No content-type headers are applied.
      • UPLOAD
        • Applies the content-type header ("X-IBM-Data-Type": encoding ). And will pass Content-Type: application/octet-stream for binary data.
      • DOWNLOAD
        • applies Content-Type header.
      • No context (default)
        • applies the default content-type header: {"X-IBM-Data-Type": "text"}

  ZosFilesHeaders.generateHeaders<T>({
    options,
    context,
    dataLength,
  }: {
    options: T;
    context?: ZosFilesContext;
    dataLength?: number | string;
  }): IHeaderContent[]

Because of this centralization, organization, and newly-provided, clear header expectations, any future header changes or additions require modifications in only one location. Creating headers can now be done with a single function call without much thought required in future development of the methods within ZosFiles SDK.

[github-actions]

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

[codecov]

Codecov Report

Attention: Patch coverage is 97.39583% with 5 lines in your changes missing coverage. Please review.

Project coverage is 91.45%. Comparing base (a1b71ff) to head (9b6d751).
Report is 6 commits behind head on master.

Files with missing lines	Patch %	Lines
packages/zosfiles/src/utils/ZosFilesHeaders.ts	96.03%	5 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##           master    #2436      +/-   ##
==========================================
- Coverage   91.51%   91.45%   -0.06%     
==========================================
  Files         641      642       +1     
  Lines       18425    18430       +5     
  Branches     4002     3990      -12     
==========================================
- Hits        16861    16855       -6     
- Misses       1562     1573      +11     
  Partials        2        2              

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

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
• 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

[zFernand0]

I'm trying to keep track of the test in the hopes that it would give us some perspective.

Nested if approach:
80bef2d

Cleaner switch approach:
c9e76a5

Aftr merging master (adf4304)

---

Personally, switch > if for complex stuff like this 😋

[ATorrise]

momentarily moving this to draft status for a few hours to make a significant change based on sonar cloud's good suggestion

[sonarqubecloud]

Quality Gate passed

Issues
4 New issues
0 Accepted issues

Measures
0 Security Hotspots
84.9% Coverage on New Code
0.1% Duplication on New Code

See analysis details on SonarQube Cloud

[awharn]

The system tests are failing because many data sets are being uploaded with a record header. This line seems to be setting the record header if the data set is not being transferred in binary mode. I believe that instead it should only be setting the record header if the record option is true.

[ATorrise]

closing this PR and opening a new PR without the enhancement that only provides a fix for the RTO header