Adds support for <xs:choice minOccurs="0" maxOccurs="unbounded"/> cases. by 4name · Pull Request #1496 · vpulim/node-soap

4name · 2026-06-04T18:40:56Z

That PR fixes <xsd:choice minOccurs="0" maxOccurs="unbounded"/> behavior. Before that, the WSDL marshaller could resolve this only as two (or more) separate type lists. The following JSON object has two separate lists of As and Bs:

Assuming we have the following definitions of some Document:

<>
    <!-- Parent document WSDL definition -->
    <xsd:element name="someOtherProperty" type="ct:SomeOtherType"/>
    <xsd:choice minOccurs="0" maxOccurs="unbounded">
        <xsd:element name="a" type="ct:A"/>
        <xsd:element name="b" type="ct:B"/>
    </xsd:choice>
</>

// Old behavior

{
    // Parent document JSON representation
    someOtherProperty: { ... SomeOtherType-type object ... },
    a: [ { ... A-type object 1 ... }, { ... A-type object 2 ... }, ...],
    b: [ { ... B-type object 1 ... }, { ... B-type object 2 ... }, { ... B-type object 3 ... }, ...],
}

that resulted into:

<>
    <!-- Parent document XML representation -->
    <someOtherProperty> ... SomeOtherType properties ... </someOtherProperty>
    <a> ... A-type properties 1 ... </a>
    <a> ... A-type properties 2 ... </a>
    <b> ... B-type properties 1 ... </b>
    <b> ... B-type properties 2 ... </b>
    <b> ... B-type properties 3 ... </b>
</>

In case we want to preserve the choice children order for the following JSON object:

// New behavior

{
    // Parent document JSON representation
    someOtherProperty: { ... SomeOtherType-type object ... },
    '$sequence': [ // <- Note this special transparent key that wraps a flat array object
        a: { ... A-type object 1 ... },
        b: { ... B-type object 1 ... },
        b: { ... B-type object 2 ... },
        a: { ... A-type object 2 ... },
        b: { ... B-type object 3 ... },
    ]
}

to be encoded as:

<>
    <!-- Parent document XML representation -->
    <someOtherProperty> ... SomeOtherType properties ... </someOtherProperty>
    <a> ... A-type properties 1 ... </a> <!-- Note that As and Bs tags are on the same level with someOtherProperty -->
    <b> ... B-type properties 1 ... </b>
    <b> ... B-type properties 2 ... </b>
    <a> ... A-type properties 2 ... </a> <!-- Note that we can mix As and Bs order now -->
    <b> ... B-type properties 3 ... </b>
</>

In case of interfere with $sequence property of some SOAP Service property, the special key name can be replaced with options arrayWithChoiceTag: string value.

Summary by CodeRabbit

Release Notes

New Features
- Added arrayWithChoiceTag configuration option for customizing XML serialization of polymorphic array elements in SOAP operations.

That PR fixes <xsd:choice minOccurs="0" maxOccurs="unbounded"/> behavior. Before that, the WSDL marshaller could resolve this only as two (or more) separate type lists. The following JSON object has two separate lists of As and Bs: Assuming we have the following definitions of some Document: <>  <xsd:element name="someOtherProperty" type="ct:SomeOtherType"/> <xsd:choice minOccurs="0" maxOccurs="unbounded"> <xsd:element name="a" type="ct:A"/> <xsd:element name="b" type="ct:B"/> </xsd:choice> </> // Old behavior { // Parent document JSON representation someOtherProperty: { ... SomeOtherType-type object ... }, a: [ { ... A-type object 1 ... }, { ... A-type object 2 ... }, ...], b: [ { ... B-type object 1 ... }, { ... B-type object 2 ... }, { ... B-type object 3 ... }, ...], } that resulted into: <>  <someOtherProperty> ... SomeOtherType properties ... </someOtherProperty> <a> ... A-type properties 1 ... </a> <a> ... A-type properties 2 ... </a> ... B-type properties 1 ... ... B-type properties 2 ... ... B-type properties 3 ... </> In case we want to preserve the choice children order for the following JSON object: // New behavior { // Parent document JSON representation someOtherProperty: { ... SomeOtherType-type object ... }, '$sequence': [ // <- Note this special transparent key that wraps a flat array object a: { ... A-type object 1 ... }, b: { ... B-type object 1 ... }, b: { ... B-type object 2 ... }, a: { ... A-type object 2 ... }, b: { ... B-type object 3 ... }, ] } to be encoded as: <>  <someOtherProperty> ... SomeOtherType properties ... </someOtherProperty> <a> ... A-type properties 1 ... </a>  ... B-type properties 1 ... ... B-type properties 2 ... <a> ... A-type properties 2 ... </a>  ... B-type properties 3 ... </> In case of interfere with $sequence property of some SOAP Service property, the special key name can be replaced with options arrayWithChoiceTag: string value.

coderabbitai · 2026-06-04T18:41:22Z

📝 Walkthrough

Walkthrough

This PR adds support for custom array choice tag configuration during SOAP XML marshaling. A new optional arrayWithChoiceTag option is introduced, the serialization logic detects and handles matching arrays by skipping wrapper tags, and comprehensive tests validate both custom and default behaviors.

Changes

Array Choice Tag Customization

Layer / File(s)	Summary
Configuration option and initialization `src/types.ts`, `src/wsdl/index.ts`	Adds `arrayWithChoiceTag?: string` property to `IWsdlBaseOptions` with documented semantics, initialized to `'$sequence'` by default during WSDL options setup.
Array choice container serialization `src/wsdl/index.ts`	Modifies `objectToXML` array loop to bypass opening/closing tags and attributes when array name matches `arrayWithChoiceTag`, emitting only the computed body; conditionally passes schema object only for matching elements during recursion.
Test WSDL contract for mixed-sequence `test/wsdl/complex/mixed-sequence.wsdl`	Defines complete WSDL specification with XML Schema types, request/response elements, abstract and concrete data types, port type operations with fault bindings, and SOAP service endpoint.
Validation tests for array choice serialization `test/wsdl-parse-test.js`	Two test cases validate XML serialization behavior: one with custom `arrayWithChoiceTag: '$arrayChoice'` and one with default `$sequence`, each asserting exact XML output from parsed and converted payloads.

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~20 minutes

Poem

🐰 A choice of arrays wrapped with customizable care,
No more rigid $sequence tags everywhere!
With arrayWithChoiceTag, the WSDL takes flight,
XML marshaling now fits just right. ✨

🚥 Pre-merge checks | ✅ 5

✅ Passed checks (5 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title accurately describes the main feature being added: support for xs:choice elements with minOccurs and maxOccurs attributes in unbounded arrays.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check	✅ Passed	Check skipped because no linked issues were found for this pull request.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing Touches

🧪 Generate unit tests (beta)

Create PR with unit tests

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

coderabbitai

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents

Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@test/wsdl-parse-test.js`:
- Around line 159-161: The test is using def.findSchemaType to look up the
element "getDataResponse" but that element has an anonymous complex type, so
change both lookups to use def.findSchemaObject('getDataResponse',
'http://test-soap.com/api/mixedsequence') instead of def.findSchemaType; update
the two occurrences around the current getDataResponse assertions (the call at
the earlier block and the similar call at the later block around lines 231-233)
so the test queries the schema object (element) rather than searching for a
named type.

🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

Push a commit to this branch (recommended)
Create a new PR with the fixes

ℹ️ Review info

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: 88fff7ac-e81b-419d-856b-704aa6b2b01f

📥 Commits

Reviewing files that changed from the base of the PR and between 2869f51 and 751ca0a.

📒 Files selected for processing (4)

src/types.ts
src/wsdl/index.ts
test/wsdl-parse-test.js
test/wsdl/complex/mixed-sequence.wsdl

w666 · 2026-06-07T10:10:22Z

Hi @4name. thanks for the PR. I am a bit overcomited atm, but this PR is on my backlog. I will have a look as soon as I can, Thanks.

Also, need to silent that CodeRabbit, too much noise from it.

4name · 2026-06-08T10:34:58Z

Hi @w666! Thank you for the notice, take your time. Please let me know if there is anything that needs to be improved in that PR.

w666

Thanks for the PR, changes make sense. Unfortunately we should keep this disabled by default, so it does not break someones code.

w666 · 2026-06-16T07:24:29Z

        const item = obj[i];
-        const arrayAttr = this.processAttributes(item, nsContext);
+        const isArrayWithChoiceTagContainer = name === this.options.arrayWithChoiceTag;
+        const arrayAttr = isArrayWithChoiceTagContainer ? '' : this.processAttributes(item, nsContext);


New behaviour should be disabled by default, because it may break someones code. This, unfortunately, will disable default value, but will keep this backwards compatible with current implementation.

w666 · 2026-06-16T07:29:07Z

  preserveWhitespace?: boolean;
  /** provides support for nonstandard array semantics. If true, JSON arrays of the form {list: [{elem: 1}, {elem: 2}]} are marshalled into xml as <list><elem>1</elem></list> <list><elem>2</elem></list>. If false, marshalls into <list> <elem>1</elem> <elem>2</elem> </list>. Default: true. */
  namespaceArrayElements?: boolean;
+  /** provides support for array with choice semantics. If array key matches, JSON arrays of the form {$sequence: [{elem: 1}, {elem: 2}]} are marshalled into xml as <elem>1</elem><elem>2</elem>. Default: $sequence. */


Suggested change

/** provides support for array with choice semantics. If array key matches, JSON arrays of the form {$sequence: [{elem: 1}, {elem: 2}]} are marshalled into xml as <elem>1</elem><elem>2</elem>. Default: $sequence. */

/** provides support for array with choice semantics. If array key matches, JSON arrays of the form {$sequence: [{elem: 1}, {elem: 2}]} are marshalled into xml as <elem>1</elem><elem>2</elem> where $sequence is example value for the option. Disabled if option is not set. Example value: $sequence. */

w666 · 2026-06-16T07:30:15Z

+    );
+  });
+
+  it('should parse complex wsdls with mixed choice and minOccurs maxOccurs with default $sequence', function (done) {


This test should be converted to option is not set to make sure we keep original behaviour by default.

coderabbitai Bot reviewed Jun 4, 2026

View reviewed changes

Comment thread test/wsdl-parse-test.js

w666 requested changes Jun 16, 2026

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Adds support for <xs:choice minOccurs="0" maxOccurs="unbounded"/> cases.#1496

Adds support for <xs:choice minOccurs="0" maxOccurs="unbounded"/> cases.#1496
4name wants to merge 1 commit into
vpulim:masterfrom
siriusxm:feature-choice-min-mac-occurs

4name commented Jun 4, 2026 •

edited by coderabbitai Bot

Loading

Uh oh!

coderabbitai Bot commented Jun 4, 2026 •

edited

Loading

Walkthrough

Changes

Estimated code review effort

Poem

Uh oh!

coderabbitai Bot left a comment

Uh oh!

Uh oh!

w666 commented Jun 7, 2026

Uh oh!

4name commented Jun 8, 2026

Uh oh!

w666 left a comment

Uh oh!

w666 Jun 16, 2026

Uh oh!

w666 Jun 16, 2026

Uh oh!

w666 Jun 16, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

	/** provides support for array with choice semantics. If array key matches, JSON arrays of the form {$sequence: [{elem: 1}, {elem: 2}]} are marshalled into xml as <elem>1</elem><elem>2</elem>. Default: $sequence. */
	/** provides support for array with choice semantics. If array key matches, JSON arrays of the form {$sequence: [{elem: 1}, {elem: 2}]} are marshalled into xml as <elem>1</elem><elem>2</elem> where $sequence is example value for the option. Disabled if option is not set. Example value: $sequence. */

Conversation

4name commented Jun 4, 2026 • edited by coderabbitai Bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary by CodeRabbit

Release Notes

Uh oh!

coderabbitai Bot commented Jun 4, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Estimated code review effort

Poem

Uh oh!

coderabbitai Bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

w666 commented Jun 7, 2026

Uh oh!

4name commented Jun 8, 2026

Uh oh!

w666 left a comment

Choose a reason for hiding this comment

Uh oh!

w666 Jun 16, 2026

Choose a reason for hiding this comment

Uh oh!

w666 Jun 16, 2026

Choose a reason for hiding this comment

Uh oh!

w666 Jun 16, 2026

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

4name commented Jun 4, 2026 •

edited by coderabbitai Bot

Loading

coderabbitai Bot commented Jun 4, 2026 •

edited

Loading