Update CodemodderOpenAIKeys.java This provides additional informatio… #239
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
… in case the key is not available.
|
|
|
Kudos, SonarCloud Quality Gate passed!
|
nahsra
reviewed
Nov 19, 2023
| @@ -13,6 +13,13 @@ public final class CodemodderOpenAIKeys { | |||
| */ | |||
| public static boolean isAvailable() { | |||
| String key = System.getenv("CODEMODDER_OPENAI_API_KEY"); | |||
There was a problem hiding this comment.
What type of behavior do you think would be best for codemod authors? I'm only working on OpenAI-based codemods sometimes, so having a loud error (or throwing an exception) when there's not a key available feels heavy handed.
|
One of the behaviors that I think would be best for codemod authors are
as follows,
*Return Optional or Result Types:* Instead of returning a boolean, you
could return an Optional<String> or a custom result type that encapsulates
the presence or absence of the API key. This allows the calling code to
easily check for the presence of the key and obtain its value if available.
…On Sun, Nov 19, 2023 at 12:05 PM Arshan Dabirsiaghi < ***@***.***> wrote:
***@***.**** commented on this pull request.
------------------------------
In
framework/codemodder-testutils-llm/src/main/java/io/codemodder/testutils/llm/CodemodderOpenAIKeys.java
<#239 (comment)>
:
> @@ -13,6 +13,13 @@ public final class CodemodderOpenAIKeys {
*/
public static boolean isAvailable() {
String key = System.getenv("CODEMODDER_OPENAI_API_KEY");
What type of behavior do you think would be best for codemod authors? I'm
only working on OpenAI-based codemods sometimes, so having a loud error (or
throwing an exception) when there's not a key available feels heavy handed.
—
Reply to this email directly, view it on GitHub
<#239 (review)>,
or unsubscribe
<https://github.com/notifications/unsubscribe-auth/BEAPI7O7VJL2CEFGINXV3YDYFI36FAVCNFSM6AAAAAA7QFUNIOVHI2DSMVQWIX3LMV43YUDVNRWFEZLROVSXG5CSMV3GSZLXHMYTOMZYGY4DKNJUHE>
.
You are receiving this because you authored the thread.Message ID:
***@***.***>
|
|
Happy to re-open if we can have a more substantial debate about the problem this intends to solve, the tradeoffs around the solution. |
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.
…n in case the key is not available.