Skip to content

feat: add cross-language Spector tests for dollar-sign query params and discriminator without subtypes - #10841

Merged
iscai-msft merged 13 commits into
microsoft:mainfrom
iscai-msft:feat/cross-language-spector-tests
Jun 4, 2026
Merged

feat: add cross-language Spector tests for dollar-sign query params and discriminator without subtypes#10841
iscai-msft merged 13 commits into
microsoft:mainfrom
iscai-msft:feat/cross-language-spector-tests

Conversation

@iscai-msft

Copy link
Copy Markdown
Member

Add two new cross-language Spector test scenarios identified from Go and TypeScript emitter bug fixes:

1. Dollar-sign prefixed query parameters (parameters/query/DollarSign)

Tests that emitters correctly handle $-prefixed query parameter names on the wire (e.g. $filter, $top, $skip, $orderby). Common in OData-style APIs.

2. Discriminated type without subtypes (type/model/inheritance/single-discriminator)

Tests a @discriminator-decorated model with no extending subtypes. Emitters should still generate the polymorphic type infrastructure.

Both scenarios include main.tsp definitions, mockapi.ts implementations, and updated spec-summary.md.

@iscai-msft iscai-msft added the lib:http-specs For issues/prs related to the @typespec/http-specs package label May 29, 2026
@pkg-pr-new

pkg-pr-new Bot commented May 29, 2026

Copy link
Copy Markdown

Open in StackBlitz

npm i https://pkg.pr.new/microsoft/typespec/@typespec/http-client-js@10841
npm i https://pkg.pr.new/microsoft/typespec/@typespec/http-specs@10841

commit: b705846

@github-actions

github-actions Bot commented May 29, 2026

Copy link
Copy Markdown
Contributor

All changed packages have been documented.

  • @typespec/http-client-js
  • @typespec/http-specs
Show changes

@typespec/http-specs - feature ✏️

add test for discriminator model without subtypes and query params with $ prefixes

@typespec/http-client-js - internal ✏️

skip some spector tests

@azure-sdk-automation

azure-sdk-automation Bot commented May 29, 2026

Copy link
Copy Markdown

You can try these changes here

🛝 Playground 🌐 Website 🛝 VSCode Extension

iscai-msft and others added 4 commits June 1, 2026 11:15
Add DollarSign interface to parameters/query with scenarios for
$filter, $top/$skip, and $orderby query parameters.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Add Fish model with @Discriminator but no extending models to
single-discriminator tests. Covers get and put scenarios.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@iscai-msft
iscai-msft force-pushed the feat/cross-language-spector-tests branch from 4662678 to 75dc1ee Compare June 1, 2026 15:16
Add parameters/body-root scenario for @bodyRoot nested inside a wrapper
model, testing that emitters resolve the accessor path through the wrapper
(e.g. body.param) rather than referencing the property name directly.

Identified from: Azure/autorest.typescript#3961

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@iscai-msft
iscai-msft force-pushed the feat/cross-language-spector-tests branch from 75dc1ee to c630cef Compare June 1, 2026 15:28
Comment thread packages/http-specs/specs/parameters/body-root/main.tsp
Comment thread packages/http-specs/specs/parameters/body-root/main.tsp
Comment thread packages/http-specs/specs/parameters/query/main.tsp Outdated
@iscai-msft
iscai-msft enabled auto-merge June 2, 2026 20:03
Comment thread packages/http-specs/specs/parameters/query/main.tsp
@iscai-msft
iscai-msft requested a review from timotheeguerin June 2, 2026 20:26
@iscai-msft

Copy link
Copy Markdown
Member Author

@timotheeguerin the failures in e2e are from the unbranded js emitter. they already have this issue, and they don't have time to fix the unbranded one right now. Is there a way to skip the e2e tests in this case? thanks! cc @JialinHuang803

@timotheeguerin

Copy link
Copy Markdown
Member

i think packages/http-client-js/.testignore this file

@microsoft-github-policy-service microsoft-github-policy-service Bot added the emitter:client:js Issue for the JS client emitter: @typespec/http-client-js label Jun 3, 2026
@iscai-msft
iscai-msft added this pull request to the merge queue Jun 4, 2026
Merged via the queue into microsoft:main with commit 912cf94 Jun 4, 2026
33 checks passed
@iscai-msft
iscai-msft deleted the feat/cross-language-spector-tests branch June 4, 2026 19:10
});

Scenarios.Parameters_Query_SpecialChar_dollarSign = passOnSuccess({
uri: "/parameters/query/special-char/dollar-sign",

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

This path doesn't match the route in the tsp.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Seems like Copilot should have caught this but it didn't run.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Try to fix it in #10963

mauriciogardini pushed a commit to pinterest/typespec that referenced this pull request Jun 10, 2026
…nd body-root nested scenarios (microsoft#10896)

This adds python mock API coverage for new Spector scenarios introduced
by the cross-language spec updates (PR microsoft#10841): a discriminated model
with no declared subtypes, and a `@bodyRoot` parameter nested inside a
wrapper model. The PR extends existing single-discriminator tests in
both sync and async suites, adds new shared body-root tests, and aligns
local spec inputs to a version that contains the scenarios.

- **Test coverage: single-discriminator no-subtypes (shared
sync/async)**
  - Extended existing shared tests to cover:
    - `get_no_subtypes_model()`
    - `put_no_subtypes_model(...)`
- Added `Fish` model assertions to validate the expected wire payload
shape (`kind`, `size`).

- **Test coverage: body-root nested (shared sync/async)**
- Added new shared tests (`test_parameters_body_root.py` and
`asynctests/test_parameters_body_root_async.py`) covering the
`nested(...)` operation with a `BodyRootModel` (`category`, `link_type`,
`was_successful`).
  - Validated locally against the Spector mock server.

- **Spec dependency update for scenario availability**
- Updated `@typespec/http-specs` in
`packages/http-client-python/package.json` (and lockfile) to a version
containing the new scenario definitions used by regeneration.

- **Change tracking**
  - Added a Chronus `internal` entry for `@typespec/http-client-python`.

```python
def test_get_no_subtypes_model(client):
    assert client.get_no_subtypes_model() == Fish(kind="salmon", size=10)

def test_put_no_subtypes_model(client):
    client.put_no_subtypes_model(Fish(kind="salmon", size=10))

def test_nested(client):
    client.nested(BodyRootModel(category="widget", link_type="hard", was_successful=True))
```

> Note: The third scenario from PR microsoft#10841,
`Parameters_Query_SpecialChar_dollarSign`, is intentionally **not**
covered. There is an upstream spec inconsistency where `main.tsp`
declares `@route("/dollarSign")` (camelCase) while `mockapi.ts`
registers the endpoint at `/dollar-sign` (kebab-case). The mock server
only serves `/dollar-sign`, while the generated SDK correctly calls
`/dollarSign`, so the test would 404. This requires a fix in
`@typespec/http-specs` before SDK coverage can pass.

---------

Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com>
Co-authored-by: msyyc <70930885+msyyc@users.noreply.github.com>
Co-authored-by: Yuchao Yan <yuchaoyan@microsoft.com>
JennyPng pushed a commit to JennyPng/typespec that referenced this pull request Jun 10, 2026
…nd discriminator without subtypes (microsoft#10841)

Add two new cross-language Spector test scenarios identified from Go and
TypeScript emitter bug fixes:

## 1. Dollar-sign prefixed query parameters
(`parameters/query/DollarSign`)
Tests that emitters correctly handle `$`-prefixed query parameter names
on the wire (e.g. `$filter`, `$top`, `$skip`, `$orderby`). Common in
OData-style APIs.
- Identified from: Azure/autorest.go#1922

## 2. Discriminated type without subtypes
(`type/model/inheritance/single-discriminator`)
Tests a `@discriminator`-decorated model with no extending subtypes.
Emitters should still generate the polymorphic type infrastructure.
- Identified from: Azure/autorest.go#1892

Both scenarios include `main.tsp` definitions, `mockapi.ts`
implementations, and updated `spec-summary.md`.

---------

Co-authored-by: iscai-msft <isabellavcai@gmail.com>
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
JennyPng pushed a commit to JennyPng/typespec that referenced this pull request Jun 10, 2026
…nd body-root nested scenarios (microsoft#10896)

This adds python mock API coverage for new Spector scenarios introduced
by the cross-language spec updates (PR microsoft#10841): a discriminated model
with no declared subtypes, and a `@bodyRoot` parameter nested inside a
wrapper model. The PR extends existing single-discriminator tests in
both sync and async suites, adds new shared body-root tests, and aligns
local spec inputs to a version that contains the scenarios.

- **Test coverage: single-discriminator no-subtypes (shared
sync/async)**
  - Extended existing shared tests to cover:
    - `get_no_subtypes_model()`
    - `put_no_subtypes_model(...)`
- Added `Fish` model assertions to validate the expected wire payload
shape (`kind`, `size`).

- **Test coverage: body-root nested (shared sync/async)**
- Added new shared tests (`test_parameters_body_root.py` and
`asynctests/test_parameters_body_root_async.py`) covering the
`nested(...)` operation with a `BodyRootModel` (`category`, `link_type`,
`was_successful`).
  - Validated locally against the Spector mock server.

- **Spec dependency update for scenario availability**
- Updated `@typespec/http-specs` in
`packages/http-client-python/package.json` (and lockfile) to a version
containing the new scenario definitions used by regeneration.

- **Change tracking**
  - Added a Chronus `internal` entry for `@typespec/http-client-python`.

```python
def test_get_no_subtypes_model(client):
    assert client.get_no_subtypes_model() == Fish(kind="salmon", size=10)

def test_put_no_subtypes_model(client):
    client.put_no_subtypes_model(Fish(kind="salmon", size=10))

def test_nested(client):
    client.nested(BodyRootModel(category="widget", link_type="hard", was_successful=True))
```

> Note: The third scenario from PR microsoft#10841,
`Parameters_Query_SpecialChar_dollarSign`, is intentionally **not**
covered. There is an upstream spec inconsistency where `main.tsp`
declares `@route("/dollarSign")` (camelCase) while `mockapi.ts`
registers the endpoint at `/dollar-sign` (kebab-case). The mock server
only serves `/dollar-sign`, while the generated SDK correctly calls
`/dollarSign`, so the test would 404. This requires a fix in
`@typespec/http-specs` before SDK coverage can pass.

---------

Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com>
Co-authored-by: msyyc <70930885+msyyc@users.noreply.github.com>
Co-authored-by: Yuchao Yan <yuchaoyan@microsoft.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

emitter:client:js Issue for the JS client emitter: @typespec/http-client-js lib:http-specs For issues/prs related to the @typespec/http-specs package

Projects

None yet

Development

Successfully merging this pull request may close these issues.

6 participants