pam: Add GDM JSON protocol definition #121
Merged
Conversation
This file contains 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
denisonbarbosa
requested changes
Nov 30, 2023
There was a problem hiding this comment.
Hey, @3v1n0! Some minor nitpicks here and there.
But there's a major but: It's very hard to review and approve a protocol definition without seeing it being used and hooked up, so these changes should come together with the actual GDM module implementation rather than in a standalone PR.
3v1n0
force-pushed
the
gdm-json-protocol-protobuf
branch
3 times, most recently
from
36ff68c to
c498594
Compare
|
I'll move this to draft, as we discussed during the HO. |
3v1n0
force-pushed
the
gdm-json-protocol-protobuf
branch
from
c498594 to
6238320
Compare
Codecov ReportAttention:
Additional details and impacted files@@ Coverage Diff @@
## main #121 +/- ##
==========================================
+ Coverage 88.62% 88.82% +0.20%
==========================================
Files 34 35 +1
Lines 2532 2640 +108
==========================================
+ Hits 2244 2345 +101
- Misses 221 227 +6
- Partials 67 68 +1 ☔ View full report in Codecov by Sentry. |
3v1n0
force-pushed
the
gdm-json-protocol-protobuf
branch
2 times, most recently
from
53cf468 to
4e9ba77
Compare
3v1n0
force-pushed
the
gdm-json-protocol-protobuf
branch
from
4e9ba77 to
8638e82
Compare
denisonbarbosa
previously requested changes
Dec 12, 2023
GabrielNagy
reviewed
Dec 12, 2023
3v1n0
force-pushed
the
gdm-json-protocol-protobuf
branch
8 times, most recently
from
4ee594a to
0b84f6b
Compare
GabrielNagy
reviewed
Dec 14, 2023
GabrielNagy
reviewed
Dec 14, 2023
GabrielNagy
reviewed
Dec 14, 2023
GabrielNagy
approved these changes
Dec 15, 2023
We use JSON to communicate with GDM since its UI, GNOME Shell is in JavaScript and so can handle those messages natively pretty well. Here we define the primitives of this protocol and their conversion back and forth from go structures and types, ensuring the expectations are met. The protocol code generation is mostly done via protobuf so that we can avoid manual definition of many structures, but is meant for being used from the JSON side too thus using some naming conventions to please both cases.
We may want to enable some checks only during checks or debug builds to be used in integration tests, so let's abstract things a bit more by exposing some features at runtime only. This allows to generate normal builds without debug checks but at the same time, to avoid having to define special build tags when testing, leaving the room for using special tags for building different binaries for integration tests or local debugging.
When using this tag on `go build` or `go generate` we: - Add more debug symbols to built libraries - Enable pedantic checks on data structures used by GDM proto To achieve this, add a further generate_debug.go file that is only used when the `pam_debug` tag is used, this now also builds the gdm code with the `pam_gdm_debug` build tag that implies enabling by default some checks that are not enabled by default. Update CI job to ensure this works.
3v1n0
force-pushed
the
gdm-json-protocol-protobuf
branch
from
b328b7b to
9f4f56d
Compare
|
Thanks, all squashed now :) |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
We use JSON to communicate with GDM since its UI, GNOME Shell is in JavaScript and so can handle those messages natively pretty well.
Here we define the primitives of this protocol and their conversion back and forth from go structures and types, ensuring the expectations are met.
The protocol code generation is mostly done via protobuf so that we can avoid manual definition of many structures, but is meant for being used from the JSON side too thus using some naming conventions to please both cases.
UDENG-1466