[spector] Add discriminated union test cases #7602

Copilot · 2025-06-10T08:21:36Z

This PR adds comprehensive spector test cases for discriminated unions based on the TypeSpec standard library documentation.

Scenarios Implemented

Added test cases covering the three main discriminated union patterns:

Default serialization (/envelope) - Uses default kind and value envelope structure:

{
  "kind": "cat",
  "value": {
    "name": "Whiskers",
    "meow": true
  }
}

Custom property names (/custom-names) - Uses custom discriminator and envelope properties:

{
  "petType": "cat", 
  "petData": {
    "name": "Whiskers",
    "meow": true
  }
}

Inline discriminator (/inline) - Uses envelope: "none" to inject discriminator directly:
```
{
  "kind": "cat",
  "name": "Whiskers", 
  "meow": true
}
```

Each scenario includes both GET and PUT operations with complete mockapi implementations.

Files Added

packages/http-specs/specs/type/union/discriminated/main.tsp - TypeSpec definitions with 6 scenarios
packages/http-specs/specs/type/union/discriminated/mockapi.ts - Mock API implementations
Updated spec-summary.md with auto-generated documentation

Validation

✅ All 56 scenarios (including new ones) pass validation
✅ TypeScript compilation successful
✅ Mock API validation passes
✅ No linting errors
✅ Documentation regenerated

The implementation follows existing spector patterns and provides comprehensive test coverage for discriminated unions as specified in the TypeSpec documentation.

Fixes #7601.

Warning

Firewall rules blocked me from connecting to one or more addresses

I tried to connect to the following addresses, but was blocked by firewall rules:

typespec.io
- Triggering command: curl -s REDACTED (dns block)

If you need me to access, download, or install something from one of these locations, you can either:

Configure Actions setup steps to set up my environment, which run before the firewall is enabled
Add the appropriate URLs or hosts to my firewall allow list

💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.

Co-authored-by: msyyc <70930885+msyyc@users.noreply.github.com>

packages/http-specs/specs/type/union/discriminated/main.tsp

Co-authored-by: msyyc <70930885+msyyc@users.noreply.github.com>

msyyc · 2025-06-11T09:20:33Z

@copilot Apply comments #7602 (comment) and #7602 (comment) for all scenarios.

… to all GET endpoints Co-authored-by: msyyc <70930885+msyyc@users.noreply.github.com>

Copilot · 2025-06-11T09:40:50Z

@copilot Apply comments #7602 (comment) and #7602 (comment) for all scenarios.

Applied both comments to all scenarios:

Added optional parameters to all GET operations (envelope: kind?: string, custom-names: petType?: string, inline: kind?: string)
Changed all PUT operations to return the request body instead of NoContentResponse

Updated mockapi implementations to handle the optional parameters with appropriate response logic (when parameter is null/"cat" returns cat response, when "dog" returns dog response). All 56 scenarios pass validation. Implemented in commit ab3ee92.

packages/http-specs/specs/type/union/discriminated/main.tsp

Co-authored-by: msyyc <70930885+msyyc@users.noreply.github.com>

… union scenarios Co-authored-by: msyyc <70930885+msyyc@users.noreply.github.com>

Co-authored-by: msyyc <70930885+msyyc@users.noreply.github.com>

Copilot · 2025-06-12T04:11:20Z

Just as a heads up, I was blocked by some firewall rules while working on your feedback. Expand below for details.

Warning

Firewall rules blocked me from connecting to one or more addresses

I tried to connect to the following addresses, but was blocked by firewall rules:

telemetry.astro.build
- Triggering command: node /home/REDACTED/work/typespec/typespec/website/node_modules/.bin/../astro/astro.js build (dns block)

If you need me to access, download, or install something from one of these locations, you can either:

Configure Actions setup steps to set up my environment, which run before the firewall is enabled
Add the appropriate URLs or hosts to my firewall allow list

github-actions · 2025-06-16T03:32:45Z

All changed packages have been documented.

✅ @typespec/http-specs

Show changes

`@typespec/http-specs` - feature ✏️

Add discriminated union spector test cases covering default serialization, custom property names, and inline discriminator scenarios

packages/http-specs/specs/type/union/discriminated/main.tsp

…ehavior Co-authored-by: msyyc <70930885+msyyc@users.noreply.github.com>

Copilot · 2025-06-17T07:12:45Z

Just as a heads up, I was blocked by some firewall rules while working on your feedback. Expand below for details.

Warning

Firewall rules blocked me from connecting to one or more addresses

I tried to connect to the following addresses, but was blocked by firewall rules:

telemetry.astro.build
- Triggering command: node /home/REDACTED/work/typespec/typespec/website/node_modules/.bin/../astro/astro.js build (dns block)

If you need me to access, download, or install something from one of these locations, you can either:

Configure Actions setup steps to set up my environment, which run before the firewall is enabled
Add the appropriate URLs or hosts to my firewall allow list

MaryGao · 2025-06-17T13:57:09Z

@joheredi js 3p emitter e2e failure for this case blocks this pr, is it possible to prioritze the fix?
https://dev.azure.com/azure-sdk/public/_build/results?buildId=4982089&view=logs&j=9ea70591-ad2c-549f-9859-1ba11dbbd52c&t=5d5e2a00-ea43-5380-bb2b-bb168af18ba8

packages/http-client-js test:e2e: > tsc -p tsconfig.test.json
packages/http-client-js test:e2e: test/e2e/generated/type/union/discriminated/src/models/internal/serializers.ts(86,5): error TS2322: Type 'Cat' is not assignable to type 'PetWithEnvelope'.
packages/http-client-js test:e2e: test/e2e/generated/type/union/discriminated/src/models/internal/serializers.ts(90,5): error TS2322: Type 'Dog' is not assignable to type 'PetWithEnvelope'.
packages/http-client-js test:e2e: test/e2e/generated/type/union/discriminated/src/models/internal/serializers.ts(150,5): error TS2322: Type 'Cat' is not assignable to type 'PetWithCustomNames'.
packages/http-client-js test:e2e: test/e2e/generated/type/union/discriminated/src/models/internal/serializers.ts(154,5): error TS2322: Type 'Dog' is not assignable to type 'PetWithCustomNames'.
packages/http-client-js test:e2e: test/e2e/generated/type/union/discriminated/src/models/internal/serializers.ts(186,5): error TS2322: Type 'Cat' is not assignable to type 'PetInline'.
packages/http-client-js test:e2e:   Type 'Cat' is not assignable to type '{ kind: "cat"; } & Cat'.
packages/http-client-js test:e2e:     Property 'kind' is missing in type 'Cat' but required in type '{ kind: "cat"; }'.
packages/http-client-js test:e2e: test/e2e/generated/type/union/discriminated/src/models/internal/serializers.ts(190,5): error TS2322: Type 'Dog' is not assignable to type 'PetInline'.
packages/http-client-js test:e2e:   Type 'Dog' is not assignable to type '{ kind: "dog"; } & Dog'.
packages/http-client-js test:e2e:     Property 'kind' is missing in type 'Dog' but required in type '{ kind: "dog"; }'.
packages/http-client-js test:e2e:  ELIFECYCLE  Command failed with exit code 2.
packages/http-client-js test:e2e: Failed
/mnt/vss/_work/1/s/packages/http-client-js:

Copilot · 2025-06-17T14:13:28Z

@joheredi js 3p emitter e2e failure for this case blocks this pr, is it possible to prioritze the fix?
https://dev.azure.com/azure-sdk/public/_build/results?buildId=4982089&view=logs&j=9ea70591-ad2c-...

This appears to be an issue with the JS emitter's code generation for discriminated unions rather than with the TypeSpec definitions. I've verified that:

✅ All 56 scenarios pass TypeSpec validation
✅ Mock API validation passes
✅ TypeSpec compilation succeeds

The error shows that the generated TypeScript serializers are trying to assign Cat/Dog types directly to the discriminated union types (PetWithEnvelope, PetWithCustomNames, PetInline), but the discriminated unions expect the full envelope structure.

This suggests the JS emitter needs updates to properly handle discriminated union serialization. The TypeSpec definitions follow the standard patterns from the documentation and work correctly at the TypeSpec level.

Warning

Firewall rules blocked me from connecting to one or more addresses

I tried to connect to the following addresses, but was blocked by firewall rules:

telemetry.astro.build
- Triggering command: node /home/REDACTED/work/typespec/typespec/website/node_modules/.bin/../astro/astro.js build (dns block)

If you need me to access, download, or install something from one of these locations, you can either:

Configure Actions setup steps to set up my environment, which run before the firewall is enabled
Add the appropriate URLs or hosts to my firewall allow list

packages/http-specs/specs/type/union/discriminated/main.tsp

- Reorganized into Envelope > Object > (Default, CustomProperties) and NoEnvelope structure - Updated routes: /envelope/object/default, /envelope/object/custom-properties, /no-envelope - Updated operation names and mockapi implementations to match new hierarchy - Provides better scalability for future envelope types as suggested Co-authored-by: timotheeguerin <1031227+timotheeguerin@users.noreply.github.com>

packages/http-specs/specs/type/union/discriminated/main.tsp

Co-authored-by: msyyc <70930885+msyyc@users.noreply.github.com>

Initial plan for issue

7603625

Copilot AI assigned Copilot and msyyc Jun 10, 2025

Copilot started work on behalf of msyyc June 10, 2025 08:21 View session

Copilot AI and others added 2 commits June 10, 2025 08:43

Add discriminated union spector test cases

4c46dbb

Co-authored-by: msyyc <70930885+msyyc@users.noreply.github.com>

Add changeset for discriminated union spector test cases

693d93a

Co-authored-by: msyyc <70930885+msyyc@users.noreply.github.com>

Copilot AI changed the title ~~[WIP] [spector] Add cases for discriminated union~~ [spector] Add discriminated union test cases Jun 10, 2025

Copilot AI requested a review from msyyc June 10, 2025 08:45

Copilot finished work on behalf of msyyc June 10, 2025 08:45

msyyc reviewed Jun 11, 2025

View reviewed changes

packages/http-specs/specs/type/union/discriminated/main.tsp Outdated Show resolved Hide resolved

Copilot started work on behalf of msyyc June 11, 2025 09:07 View session

msyyc reviewed Jun 11, 2025

View reviewed changes

packages/http-specs/specs/type/union/discriminated/main.tsp Outdated Show resolved Hide resolved

Add optional kind parameter to discriminated union envelope endpoint

9812305

Co-authored-by: msyyc <70930885+msyyc@users.noreply.github.com>

Copilot finished work on behalf of msyyc June 11, 2025 09:22

Copilot started work on behalf of msyyc June 11, 2025 09:22 View session

Fix PUT operations to return request body and add optional parameters…

ab3ee92

… to all GET endpoints Co-authored-by: msyyc <70930885+msyyc@users.noreply.github.com>

Copilot finished work on behalf of msyyc June 11, 2025 09:41

msyyc reviewed Jun 11, 2025

View reviewed changes

packages/http-specs/specs/type/union/discriminated/main.tsp Outdated Show resolved Hide resolved

Copilot started work on behalf of msyyc June 11, 2025 23:59 View session

Update documentation format for discriminated union envelope scenario

ce1d435

Co-authored-by: msyyc <70930885+msyyc@users.noreply.github.com>

Copilot finished work on behalf of msyyc June 12, 2025 00:08

Copilot started work on behalf of msyyc June 12, 2025 02:59 View session

Update documentation format for custom-names and inline discriminated…

af1d760

… union scenarios Co-authored-by: msyyc <70930885+msyyc@users.noreply.github.com>

Copilot finished work on behalf of msyyc June 12, 2025 03:06

Copilot started work on behalf of msyyc June 12, 2025 03:56 View session

Regenerate spec-summary.md with updated scenario documentation

63dcf13

Co-authored-by: msyyc <70930885+msyyc@users.noreply.github.com>

Copilot finished work on behalf of msyyc June 12, 2025 04:11

msyyc requested review from chrisradek and AlitzelMendez as code owners June 16, 2025 03:28

Merge branch 'main' into copilot/fix-7601

b93600e

lirenhe reviewed Jun 17, 2025

View reviewed changes

packages/http-specs/specs/type/union/discriminated/main.tsp Outdated Show resolved Hide resolved

Copilot started work on behalf of msyyc June 17, 2025 06:57 View session

Update discriminated union scenario docs to clarify query parameter b…

25e62b7

…ehavior Co-authored-by: msyyc <70930885+msyyc@users.noreply.github.com>

Copilot finished work on behalf of msyyc June 17, 2025 07:12

weidongxu-microsoft approved these changes Jun 17, 2025

View reviewed changes

Copilot started work on behalf of MaryGao June 17, 2025 13:57 View session

Copilot finished work on behalf of MaryGao June 17, 2025 14:14

timotheeguerin reviewed Jun 17, 2025

View reviewed changes

packages/http-specs/specs/type/union/discriminated/main.tsp Outdated Show resolved Hide resolved

Copilot started work on behalf of timotheeguerin June 17, 2025 14:43 View session

Copilot finished work on behalf of timotheeguerin June 17, 2025 14:51

Copilot started work on behalf of timotheeguerin June 17, 2025 15:01 View session

Copilot finished work on behalf of timotheeguerin June 17, 2025 15:02

Copilot started work on behalf of msyyc June 18, 2025 01:41 View session

msyyc reviewed Jun 18, 2025

View reviewed changes

packages/http-specs/specs/type/union/discriminated/main.tsp Show resolved Hide resolved

Update spec-summary.md after scenario restructuring

5596ce6

Co-authored-by: msyyc <70930885+msyyc@users.noreply.github.com>

Copilot finished work on behalf of msyyc June 18, 2025 01:50

Copilot AI requested a review from msyyc June 18, 2025 01:50

Copilot started work on behalf of msyyc June 18, 2025 01:50 View session

Format discriminated union TypeSpec file

3918766

Co-authored-by: msyyc <70930885+msyyc@users.noreply.github.com>

Copilot finished work on behalf of msyyc June 18, 2025 01:59

msyyc requested review from timotheeguerin and lirenhe June 18, 2025 02:57

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

[spector] Add discriminated union test cases #7602

[spector] Add discriminated union test cases #7602

Copilot AI commented Jun 10, 2025 •

edited

Loading

Uh oh!

Uh oh!

Uh oh!

msyyc commented Jun 11, 2025

Uh oh!

Copilot AI commented Jun 11, 2025

Uh oh!

Uh oh!

Copilot AI commented Jun 12, 2025

I tried to connect to the following addresses, but was blocked by firewall rules:

Uh oh!

github-actions bot commented Jun 16, 2025

`@typespec/http-specs` - feature ✏️

Uh oh!

Uh oh!

Copilot AI commented Jun 17, 2025

I tried to connect to the following addresses, but was blocked by firewall rules:

Uh oh!

MaryGao commented Jun 17, 2025 •

edited

Loading

Uh oh!

Copilot AI commented Jun 17, 2025 •

edited

Loading

I tried to connect to the following addresses, but was blocked by firewall rules:

Uh oh!

Uh oh!

Uh oh!

Uh oh!

[spector] Add discriminated union test cases #7602

Are you sure you want to change the base?

[spector] Add discriminated union test cases #7602

Conversation

Copilot AI commented Jun 10, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Scenarios Implemented

Files Added

Validation

I tried to connect to the following addresses, but was blocked by firewall rules:

Uh oh!

Uh oh!

Uh oh!

msyyc commented Jun 11, 2025

Uh oh!

Copilot AI commented Jun 11, 2025

Uh oh!

Uh oh!

Copilot AI commented Jun 12, 2025

I tried to connect to the following addresses, but was blocked by firewall rules:

Uh oh!

github-actions bot commented Jun 16, 2025

@typespec/http-specs - feature ✏️

Uh oh!

Uh oh!

Copilot AI commented Jun 17, 2025

I tried to connect to the following addresses, but was blocked by firewall rules:

Uh oh!

MaryGao commented Jun 17, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Copilot AI commented Jun 17, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

I tried to connect to the following addresses, but was blocked by firewall rules:

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI commented Jun 10, 2025 •

edited

Loading

`@typespec/http-specs` - feature ✏️

MaryGao commented Jun 17, 2025 •

edited

Loading

Copilot AI commented Jun 17, 2025 •

edited

Loading