Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

gRPC protocol updates #1480

Merged
merged 2 commits into from Jan 25, 2024
Merged

gRPC protocol updates #1480

merged 2 commits into from Jan 25, 2024

Conversation

olegbespalov
Copy link
Contributor

@olegbespalov olegbespalov commented Jan 16, 2024

What?

This PR aims to fill the gaps mentioned by @dgzlopes and provide a complete overview of the gRPC support in k6.

Checklist

Please fill in this template:

  • I have used a meaningful title for the PR.
  • I have described the changes I've made in the "What?" section above.
  • I have performed a self-review of my changes.
  • I have run the make docs command locally and verified that the changes look good.

Select one of these and delete the others:

If updating the documentation for the most recent release of k6:

  • I have made my changes in the docs/sources/next folder of the documentation.
  • I have reflected my changes in the docs/sources/v{most_recent_release} folder of the documentation.
  • I have reflected my changes in the relevant (e.g. when correcting a documentation error) folders of the previous k6 versions of the documentation.

If updating the documentation for the next release of k6:

  • I have made my changes in the docs/sources/next folder of the documentation.

Related PR(s)/Issue(s)

Closes #1378
Closes #1038

@olegbespalov olegbespalov self-assigned this Jan 16, 2024
@olegbespalov olegbespalov requested review from codebien and joanlopez and removed request for a team January 16, 2024 16:32

{{< /code >}}

### Handling special cases in message Marshaling/Unmarshaling
Copy link
Contributor Author

Choose a reason for hiding this comment

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

I'm wondering if that section deserves a dedicated page in k6/net/grpc JavaScript's API 🤔

The main reason why I haven't put it there is that Marshaling/Unmarshaling is not an API. But probably, it is worth cross-linking from the Invoke/Stream.on pages to this section once it is merged (don't want to do this in a single PR since there is a #1472 PR which could cause a lot of conflicts)

WDYT?

Copy link
Member

Choose a reason for hiding this comment

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

But probably, it is worth cross-linking from the Invoke/Stream.on pages to this section once it is merged (don't want to do this in a single PR since there is a #1472 PR which could cause a lot of conflicts)

Yeah, let's do this 👍

Copy link
Contributor

@codebien codebien left a comment

Choose a reason for hiding this comment

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

@olegbespalov Congrats and thanks for this. 🎉

It sounds like a very good starting point. @dgzlopes it would be good to know your feeling about it.

Copy link
Member

@dgzlopes dgzlopes left a comment

Choose a reason for hiding this comment

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

This is great @olegbespalov! A much-needed improvement for this page. Thanks for working on it ❤️

LGTM :shipit:


{{< /code >}}

### Handling special cases in message Marshaling/Unmarshaling
Copy link
Member

Choose a reason for hiding this comment

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

But probably, it is worth cross-linking from the Invoke/Stream.on pages to this section once it is merged (don't want to do this in a single PR since there is a #1472 PR which could cause a lot of conflicts)

Yeah, let's do this 👍

Copy link
Collaborator

@heitortsergent heitortsergent left a comment

Choose a reason for hiding this comment

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

I left a few small comments, overall it looks great! 🚀 Glad we have more content and examples on this page. 🙇

docs/sources/next/using-k6/protocols/grpc.md Outdated Show resolved Hide resolved
docs/sources/next/using-k6/protocols/grpc.md Outdated Show resolved Hide resolved
docs/sources/next/using-k6/protocols/grpc.md Outdated Show resolved Hide resolved
docs/sources/next/using-k6/protocols/grpc.md Outdated Show resolved Hide resolved
docs/sources/next/using-k6/protocols/grpc.md Outdated Show resolved Hide resolved
docs/sources/next/using-k6/protocols/grpc.md Outdated Show resolved Hide resolved
docs/sources/next/using-k6/protocols/grpc.md Outdated Show resolved Hide resolved
docs/sources/next/using-k6/protocols/grpc.md Outdated Show resolved Hide resolved
docs/sources/next/using-k6/protocols/grpc.md Outdated Show resolved Hide resolved
docs/sources/next/using-k6/protocols/grpc.md Outdated Show resolved Hide resolved
Co-authored-by: Heitor Tashiro Sergent <heitortsergent@gmail.com>
@olegbespalov olegbespalov merged commit 7db83cd into main Jan 25, 2024
6 checks passed
@olegbespalov olegbespalov deleted the feat/updates-grpc branch January 25, 2024 08:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Document that gRPC's how to use well know types (google.protobuf.*) Document the mapping of oneof with gRPC
5 participants