feat(sdk): expose base key #323
Conversation
Summary of ChangesHello @strantalis, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed! This pull request introduces a new feature to the SDK, allowing developers to programmatically access the platform's base key, which is crucial for certain security configurations. This enhancement is accompanied by a necessary dependency update to ensure testing compatibility with the latest Java versions, thereby improving the SDK's robustness and developer experience. Highlights
🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console. Using Gemini Code AssistThe full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips. Invoking Gemini You can request assistance from Gemini at any point by creating a comment using either
Customization To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a Limitations & Feedback Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here. You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension. Footnotes
|
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request effectively exposes the platform base key via SDK#getBaseKey(), which is a valuable addition. The implementation is straightforward, and the supporting changes, such as the README update, the new unit test for the happy path, and the Byte Buddy version pin for Java 21 compatibility, are all well-executed. My primary feedback is to enhance the test coverage for the new getBaseKey method to ensure its robustness by including tests for edge cases like missing or malformed data.
| void testGettingBaseKey() { | ||
| var platformServicesClient = mock(ProtocolClient.class); | ||
| var wellknownService = Mockito.mock(WellKnownServiceClientInterface.class); | ||
| var baseKeyJson = "{\"kas_url\":\"https://example.com/base_key\",\"public_key\":{\"algorithm\":\"ALGORITHM_RSA_2048\",\"kid\":\"thekid\",\"pem\": \"thepem\"}}"; | ||
| var val = Value.newBuilder().setStringValue(baseKeyJson).build(); | ||
| var config = Struct.newBuilder().putFields("base_key", val).build(); | ||
| var response = GetWellKnownConfigurationResponse | ||
| .newBuilder() | ||
| .setConfiguration(config) | ||
| .build(); | ||
|
|
||
| Mockito.when(wellknownService.getWellKnownConfigurationBlocking(Mockito.any(), Mockito.anyMap())) | ||
| .thenReturn(TestUtil.successfulUnaryCall(response)); | ||
|
|
||
| var services = new FakeServicesBuilder().setWellknownService(wellknownService).build(); | ||
| var sdk = new SDK(services, null, null, platformServicesClient, null); | ||
|
|
||
| var baseKey = sdk.getBaseKey(); | ||
| assertThat(baseKey).isPresent(); | ||
| var simpleKasKey = baseKey.get(); | ||
| assertThat(simpleKasKey.getKasUri()).isEqualTo("https://example.com/base_key"); | ||
| assertThat(simpleKasKey.getPublicKey().getAlgorithm()).isEqualTo(Algorithm.ALGORITHM_RSA_2048); | ||
| assertThat(simpleKasKey.getPublicKey().getKid()).isEqualTo("thekid"); | ||
| assertThat(simpleKasKey.getPublicKey().getPem()).isEqualTo("thepem"); | ||
| } |
There was a problem hiding this comment.
The test testGettingBaseKey covers the happy path well. To ensure the robustness of the newly exposed getBaseKey() method, I recommend adding tests for the following edge cases, which are handled within Planner.fetchBaseKey:
- No
base_key: When the well-known configuration does not contain abase_key. The method should returnOptional.empty(). - Malformed
base_keyJSON: When thebase_keyvalue is not valid JSON. The method should throw anSDKException. - Incomplete
base_keydata: When thebase_keyJSON is valid but missing required fields (e.g.,kas_url,public_key). The method should returnOptional.empty().
Adding these tests would provide more confidence in the new API's behavior under various conditions.
|
X-Test Results✅ go-v0.4.34 |
| Pin Byte Buddy for test-time Mockito instrumentation on newer JVMs (e.g. Java 21). | ||
| This does NOT add a runtime dependency; it only manages the version used by modules. | ||
| --> | ||
| <dependency> |
There was a problem hiding this comment.
@cshamrick do you have thoughts on this. Needed it to get running locally for some reason.
Expose the platform base key via SDK#getBaseKey().
Includes a unit test and a README snippet, plus a Byte Buddy version pin so Mockito inline mocking works on Java 21.