Add support for defining streams

[chrisradek]

Related: #154

[azure-sdk]

All changed packages have been documented.

• ✅ @typespec/compiler
• ✅ @typespec/events
• ✅ @typespec/http
• ✅ @typespec/sse
• ✅ @typespec/streams

Show changes

@typespec/events - feature ✏️

Adds a new core package for describing events.

@typespec/streams - feature ✏️

Adds a new core package for describing streams and the type of data they contain.

@typespec/sse - feature ✏️

Adds a new core package to describe server-sent events.

@typespec/http - feature ✏️

Adds HttpStream and JsonlStream models to to support streaming use-cases.

@typespec/compiler - fix ✏️

Fixes issue with the semantic walker where exitTuple was not being emitted.

[azure-sdk]

You can try these changes here

🛝 Playground	🌐 Website	📚 Next docs

[chrisradek]

Azure/typespec-azure#1615 addresses the e2e test failures.

[timotheeguerin]

I think just need to update the init templates to include @stream and maybe bring this up tomorrow in scrum to make sure we want to add this new dependency on http

[qiaozha]

is this docs/libraries/stream/reference duplicate with docs/libraries/streams/reference?

[qiaozha]

Seems like the playground is not working here link I wonder if we should add those libraries into the playground?

Also, the openapi3 output from my local is generating the response type as string,

    get:
      operationId: subscribe
      parameters: []
      responses:
        '200':
          description: The request has succeeded.
          content:
            application/jsonl:
              schema:
                type: string

is this expected?

If yes, how can we link the output type to the model Events? is there some apis for it, I notice this is empty for now https://github.com/microsoft/typespec/pull/4513/files#diff-dd2a7fbf51ff9caf7d341ebb695101d0f48e761bc9e4a2df96411bcf3ee33647R2

[qiaozha]

just curious if we should suggest TypeSpec author to use discriminated union if there's multiple event types? I think client side probably need to handle them differently?

[qiaozha]

I guess different event could have different content type? I wonder how can we get the context type for a specific event type?

[qiaozha]

I am a little confused by the jsonlstream usage and the event usage, does jsonl stream necessarily mean it's an event based?