Skip to content

fix(comms): adds back some interfaces to wsDFUXRef#4465

Merged
GordonSmith merged 1 commit into
hpcc-systems:candidate-3.x.xfrom
jeclrsg:fix-wsDfuXref-missing-interfaces
Oct 22, 2025
Merged

fix(comms): adds back some interfaces to wsDFUXRef#4465
GordonSmith merged 1 commit into
hpcc-systems:candidate-3.x.xfrom
jeclrsg:fix-wsDfuXref-missing-interfaces

Conversation

@jeclrsg
Copy link
Copy Markdown
Contributor

@jeclrsg jeclrsg commented Oct 16, 2025

there are apparently several interfaces that were previously defined manually in the wsDFUXRef service file, but are missing from the WSDL. this adds back any such interfaces & extends two functions where the WSDL defines the return type as a string instead of an object.

Checklist:

  • The commit message is properly formatted and free of typos.
    • The commit message title makes sense in a changelog, by itself.
    • The commit message includes a "fixes" reference if appropriate.
    • The commit is signed.
  • The change has been fully tested:
    • I have viewed all related gallery items
    • I have viewed all related dermatology items
  • There are no similar instances of the same problem that should be addressed
    • I have addressed them here
    • I have raised new issues to address them separately

Testing:

Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR restores missing interfaces and extends functionality in the wsDFUXRef service. The WSDL appears to be incomplete, missing several interface definitions that were previously defined manually, so this change adds them back and provides extended versions of functions where the WSDL incorrectly defines return types as strings instead of objects.

  • Adds back manually defined interfaces that are missing from the WSDL
  • Provides extended versions of DFUXRefDirectories and DFUXRefList functions with proper object return types
  • Updates test to use the new extended function

Reviewed Changes

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

File Description
packages/comms/src/services/wsDFUXRef.ts Adds missing interface definitions and extends two functions with proper return types
packages/comms/tests/dfuXRef.spec.ts Updates test to use DFUXRefListEx instead of DFUXRefList

Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.

Comment thread packages/comms/src/services/wsDFUXRef.ts Outdated
Comment thread packages/comms/src/services/wsDFUXRef.ts Outdated
Comment thread packages/comms/src/services/wsDFUXRef.ts Outdated
@jeclrsg jeclrsg force-pushed the fix-wsDfuXref-missing-interfaces branch 2 times, most recently from 9c7351b to daa2db5 Compare October 16, 2025 18:29
@jeclrsg
Copy link
Copy Markdown
Contributor Author

jeclrsg commented Oct 16, 2025

@GordonSmith I don't think there's been situation like this one, where so many types were missing from the WSDL. The only thing similar I saw was ws_machine, where it has a WsMachineEx namespace; but everything in there is extending existing interfaces. But do you think these should be wrapped up in a namespace also?

there are apparently several interfaces that were previously defined
manually in the wsDFUXRef service file, but are missing from the WSDL.
this adds back any such interfaces & extends two functions where the
WSDL defines the return type as a string instead of an object.

Signed-off-by: Jeremy Clements <79224539+jeclrsg@users.noreply.github.com>
@jeclrsg jeclrsg force-pushed the fix-wsDfuXref-missing-interfaces branch from daa2db5 to b4f166f Compare October 17, 2025 15:54
@jeclrsg
Copy link
Copy Markdown
Contributor Author

jeclrsg commented Oct 17, 2025

@GordonSmith regarding merging namespaces - with "isolatedModules" enabled (https://github.com/hpcc-systems/Visualization/blob/trunk/packages/comms/tsconfig.json#L14) merging across files evidently isn't possible. At one point copilot had recommended creating an "augmentation file (eg packages/comms/src/services/wsDFUXRef.augment.d.ts)" with something like:

declare module "./wsdl/WsDFUXRef/v1.04/WsDFUXRef.ts" {
  export namespace WsDFUXRef {
    //interfaces...
  }
}

I just opted for using a "WsDFUXRefEx" naming convention as had been done for ws_machine.

@GordonSmith GordonSmith force-pushed the candidate-3.x.x branch 12 times, most recently from 3213c34 to 14ebe8b Compare October 22, 2025 14:04
@GordonSmith GordonSmith merged commit b5577c9 into hpcc-systems:candidate-3.x.x Oct 22, 2025
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants