HPCC-34914 add WsWorkunits/WUHelperFileArchive

[jeclrsg]

adds the WUHelperFileArchive endpoint to WsWorkunits, enabling ESP to generate a .gz or .zip archive containing the specified helper files

Type of change:

• This change is a bug fix (non-breaking change which fixes an issue).
• This change is a new feature (non-breaking change which adds functionality).
• This change improves the code (refactor or other change that does not change the functionality)
• This change fixes warnings (the fix does not alter the functionality or the generated code)
• This change is a breaking change (fix or feature that will cause existing behavior to change).
• This change alters the query API (existing queries will have to be recompiled)

Checklist:

• My code follows the code style of this project.
  • My code does not create any new warnings from compiler, build system, or lint.
• The commit message is properly formatted and free of typos.
  • The commit message title makes sense in a changelog, by itself.
  • The commit is signed.
• My change requires a change to the documentation.
  • I have updated the documentation accordingly, or...
  • I have created a JIRA ticket to update the documentation.
  • Any new interfaces or exported functions are appropriately commented.
• I have read the CONTRIBUTORS document.
• The change has been fully tested:
  • I have added tests to cover my changes.
  • All new and existing tests passed.
  • I have checked that this change does not introduce memory leaks.
  • I have used Valgrind or similar tools to check for potential issues.
• I have given due consideration to all of the following potential concerns:
  • Scalability
  • Performance
  • Security
  • Thread-safety
  • Cloud-compatibility
  • Premature optimization
  • Existing deployed queries will not be broken
  • This change fixes the problem, not just the symptom
  • The target branch of this pull request is appropriate for such a change.
• There are no similar instances of the same problem that should be addressed
  • I have addressed them here
  • I have raised JIRA issues to address them separately
• This is a user interface / front-end modification
  • I have tested my changes in multiple modern browsers
  • The component(s) render as expected

Smoketest:

• Send notifications about my Pull Request position in Smoketest queue.
• Test my draft Pull Request.

Testing:

[Copilot]

Pull request overview

Adds a new WsWorkunits endpoint (WUHelperFileArchive) that lets ESP generate and download a .zip or .gz archive containing selected helper files for a workunit.

Changes:

• Adds WUHelperFileArchive request/response definitions and wires the method into the WsWorkunits service (with a version bump).
• Implements CWsWorkunitsEx::onWUHelperFileArchive to validate inputs, authorize access, generate the archive, and return it as a download.
• Adds CWsWuFileHelper::createHelperFileArchive to collect helper files, create the archive, and load it for the response.

Reviewed changes

Copilot reviewed 6 out of 6 changed files in this pull request and generated 3 comments.

Show a summary per file

File	Description
esp/services/ws_workunits/ws_workunitsService.hpp	Declares the new onWUHelperFileArchive handler.
esp/services/ws_workunits/ws_workunitsService.cpp	Implements the new endpoint handler and sets up the download response.
esp/services/ws_workunits/ws_workunitsHelpers.hpp	Declares createHelperFileArchive helper API.
esp/services/ws_workunits/ws_workunitsHelpers.cpp	Implements archive creation and loads the archive content into memory.
esp/scm/ws_workunits_req_resp.ecm	Adds request/response schema types for WUHelperFileArchive.
esp/scm/ws_workunits.ecm	Registers the new method and bumps service version/default client version to 2.06.

[Copilot]

Pull request overview

Copilot reviewed 6 out of 6 changed files in this pull request and generated 2 comments.

[Copilot]

Bumping default_client_version changes the behavior for clients that do not explicitly request a service version (they will now default to 2.06). If the intent is only to add a new method without altering defaults for existing clients, consider keeping default_client_version("2.05") while bumping version("2.06") and using min_ver("2.06") on the new method.

Suggested change

	version("2.06"), default_client_version("2.06"), cache_group("ESPWsWUs"),
	version("2.06"), default_client_version("2.05"), cache_group("ESPWsWUs"),

[Copilot]

Pull request overview

Copilot reviewed 6 out of 6 changed files in this pull request and generated 5 comments.

[github-actions]

Jira Issue: https://hpccsystems.atlassian.net//browse/HPCC-34914

Jirabot Action Result:
Workflow Transition To: Merge Pending
Updated PR