feat: export protobuf #144
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Collaborator
|
There is a mismatch in the develop commit history. The develop branch will be deleted. |
ahmdmhd
force-pushed
the
feat/export-protobuf
branch
from
2a99ade to
f4b2f1a
Compare
ahmdmhd
force-pushed
the
feat/export-protobuf
branch
from
36edab9 to
c8f265f
Compare
Signed-off-by: Ahmed Mohamed <[email protected]>
Signed-off-by: Ahmed Mohamed <[email protected]>
Signed-off-by: Ahmed Mohamed <[email protected]>
Signed-off-by: Ahmed Mohamed <[email protected]>
Signed-off-by: Ahmed Mohamed <[email protected]>
Signed-off-by: Ahmed Mohamed <[email protected]>
Signed-off-by: Ahmed Mohamed <[email protected]>
Signed-off-by: Ahmed Mohamed <[email protected]>
Signed-off-by: Ahmed Mohamed <[email protected]>
Signed-off-by: Ahmed Mohamed <[email protected]>
Signed-off-by: Ahmed Mohamed <[email protected]>
…tions Signed-off-by: Ahmed Mohamed <[email protected]>
Signed-off-by: Ahmed Mohamed <[email protected]>
Signed-off-by: Ahmed Mohamed <[email protected]>
Signed-off-by: Ahmed Mohamed <[email protected]>
ahmdmhd
force-pushed
the
feat/export-protobuf
branch
from
1efd74b to
f8da8b8
Compare
Signed-off-by: Ahmed Mohamed <[email protected]>
… a query type Signed-off-by: Ahmed Mohamed <[email protected]>
Signed-off-by: Ahmed Mohamed <[email protected]>
Signed-off-by: Ahmed Mohamed <[email protected]>
Collaborator
Author
|
@jdacoello the PR is now ready to be reviewed. The following has been changed:
|
Signed-off-by: Ahmed Mohamed <[email protected]>
jdacoello
requested changes
Nov 20, 2025
| PASSENGERSIDE | ||
| } | ||
| ``` | ||
|
|
Collaborator
There was a problem hiding this comment.
Suggested change
| As the selection query is mandatory. The example must have a `type Query` to enable entry point(s) for the selection mechanism. | |
| ```gql | |
| type Query { | |
| cabin: Cabin | |
| } |
| ``` | ||
|
|
||
| The Protobuf exporter produces: | ||
|
|
Collaborator
There was a problem hiding this comment.
Give here the exact command that produces that output because now selection query is mandatory.
Comment on lines
+213
to
+224
| #### Selection Query (Required) | ||
|
|
||
| The protobuf exporter requires a selection query to determine which types and fields to export: | ||
|
|
||
| ```bash | ||
| s2dm export protobuf --schema schema.graphql --selection-query query.graphql --output cabin.proto | ||
| ``` | ||
|
|
||
| Given a query file `query.graphql` that matches the schema above: | ||
|
|
||
| ```graphql | ||
| query Selection { |
Collaborator
There was a problem hiding this comment.
Assuming you define a selection query like:
query MyCustomSelection {
...
}The resulting proto root message of that query has the name Query:
message Query {
...
}Intead, the query name should be the proto message name like:
message MyCustomSelection {
...
}Please, modify the logic that is assigning that name to the proto message.
Comment on lines
+240
to
+248
| #### Root Type Filtering | ||
|
|
||
| Use the `--root-type` flag in combination with the selection query to further filter the export: | ||
|
|
||
| ```bash | ||
| s2dm export protobuf --schema schema.graphql --selection-query query.graphql --output cabin.proto --root-type Cabin | ||
| ``` | ||
|
|
||
| This will include only the `Cabin` type and all types transitively referenced by it from the selection query. |
Collaborator
There was a problem hiding this comment.
Can you add an example of this? I am not understanding the point of introducing this --root-type when we have already the selection query. Isn't the selection query enough?
Comment on lines
+268
to
+296
| ```graphql | ||
| type Vehicle { | ||
| adas: ADAS | ||
| } | ||
|
|
||
| type ADAS { | ||
| abs: ABS | ||
| } | ||
|
|
||
| type ABS { | ||
| isEngaged: Boolean | ||
| } | ||
| ``` | ||
|
|
||
| Flatten mode produces: | ||
|
|
||
| ```protobuf | ||
| syntax = "proto3"; | ||
|
|
||
| import "google/protobuf/descriptor.proto"; | ||
| import "buf/validate/validate.proto"; | ||
|
|
||
| extend google.protobuf.MessageOptions { | ||
| string source = 50001; | ||
| } | ||
|
|
||
| message Message { | ||
| bool Vehicle_adas_abs_isEngaged = 1; | ||
| } |
Collaborator
There was a problem hiding this comment.
Example is incomplete and not replicable because selection query is mandatory and not in the example.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR implements support for exporting
.protofiles.s2dm export protobuf --schema /path/to/schema --output output.proto --selection-query /path/to/selection/query [--package-name package.name] [--flatten-naming]Based on #146.