ChilliCream / ChilliCream/graphql-platform

v12 to v13 migration guide doesn't contain information about ISocketSessionInterceptor interface changes

Open
#6,734 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

🌶️ hot chocolate 📚 documentation Area: Subscriptions
Dominant language
C#
Stars
5.8k
Forks
810
Avg merge
15h 39m
Merged PRs (30d)
98

Description

Is there an existing issue for this?
  • I have searched the existing issues
Product

Hot Chocolate

Describe the bug

In my project I use an implementation of the ISocketSessionInterceptor to do authentication of the websocket sessions.

After updating from HotChocolate 12 to 13, the ISocketSessionInterceptor interface has changed.

It would be great to have a section about the interface changes in the migration docs.

My main issue is that the OnConnectAsync method's message parameter (in v13 connectionInitMessage) has changed type from InitializeConnectionMessage to IOperationMessagePayload. I was using the message.Payload property which is not there anymore on the new interface-type. I'm not sure how to fix this.

Steps to reproduce
  1. Use HotChocolate v12
  2. Use the ISocketSessionInterceptor interface
  3. Update to HotChocolate v13
  4. Implementation is broken
Relevant log output

No response

Additional Context?

If I figure out how to fix this, I'll gladly add the information to the migration guide myself and create a PR.

Version

13.7.0

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Read the ISocketSessionInterceptor interface in the v12 and v13 code and compare the OnConnectAsync message parameter types. Then review the v12-to-v13 migration guide and determine how users should replace the missing message.Payload access. Done means the guide documents the interface changes and the migration path clearly.

Written by the indexing model from the issue text.

Assessment

Tech stack
csharp, graphql
Domain
backend-api-design, documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.