Add cody settings editor #1972
Merged
Add cody settings editor #1972
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
mkondratek
reviewed
Aug 5, 2024
| import com.sourcegraph.config.ConfigUtil | ||
|
|
||
| class CodySettingsChangeListener(private val project: Project) : FileDocumentManagerListener { | ||
| override fun beforeDocumentSaving(document: Document) { |
There was a problem hiding this comment.
Is there any risk that the restart will happen to often while editing the file?
There was a problem hiding this comment.
I think not, this happen only on Ctrl+S, or if you switch IJ window.
mkondratek
reviewed
Aug 5, 2024
| val currentFile = FileDocumentManager.getInstance().getFile(document) | ||
| if (currentFile?.toNioPath() == ConfigUtil.getSettingsFile(project)) { | ||
| CodyAgentService.getInstance(project).restartAgent(project) | ||
| // TODO: we should instead call `extensionConfiguration_didChange` there: |
There was a problem hiding this comment.
Is it an issue for Cody repo?
mkondratek
reviewed
Aug 5, 2024
Comment on lines
22
to
25
| ?: run { | ||
| logger.warn("Project cannot be null") | ||
| return | ||
| } |
There was a problem hiding this comment.
we can log it but it looks like a common practice is to simply ?: return (see our other actions and actions in IntelliJ)
mkondratek
reviewed
Aug 5, 2024
Comment on lines
51
to
56
| configName, | ||
| JsonSchemaVersion.SCHEMA_7, | ||
| schemaFile.toString(), | ||
| false, | ||
| listOf( | ||
| UserDefinedJsonSchemaConfiguration.Item( |
There was a problem hiding this comment.
can you name the params?
mkondratek
reviewed
Aug 5, 2024
|
|
||
| private fun reloadSchemaAsync(project: Project) { | ||
| CodyAgentService.withAgentRestartIfNeeded(project) { agent -> | ||
| val settingsSchema = agent.server.extensionConfiguration_getSettingsSchema(null).get() |
There was a problem hiding this comment.
so this actions not only opens the file but also fetches the config from the agent and updates the content of the file, is that right? that makes the agent the source of truth at the moment we use this action - I wonder, shouldn't it be the client holding the truth?
There was a problem hiding this comment.
btw, extensionConfiguration_getSettingsSchema always takes null, why is that? 🤔
There was a problem hiding this comment.
I wonder, shouldn't it be the client holding the truth?
I do not think so, and I'm not sure how that would be supposed to work?
After all it's VSC code which knows which settings are used, etc.
Keeping it in client would be artificial, and would also need to be duplicated for every client.
There was a problem hiding this comment.
Ok. My main concern was about persisting the settings b/w the IDE runs. Now I can see that ConfigUtil::getAgentConfiguration handles the initialization properly on the startup - all good 👍
mkondratek
reviewed
Aug 5, 2024
|
I be just started the IDE with your changes and got this: (I assume my config json did not exist initially) |
|
pkukielka
added a commit
to sourcegraph/cody
that referenced
this pull request
Aug 5, 2024
## Changes This PR adds `extensionConfiguration/getSettingsSchema` endpoint which generates json schema file useful for validating cody settings and for documentation purposes. ## Test plan 1. Build Jenkins [PR #1972](sourcegraph/jetbrains#1972) with CODY_DIR set to this PR branch. 2. Run action `Open Cody Settings Editor` (you can use `shift shift` to find it) 3. Change some Cody settings. E.g. you can try to disable autocomplete: `"cody.autocomplete.enabled": true` 4. Hit `Ctrl + S` to trigger the config update 5. Try to use autocomplete in some other file and make sure it does not work. 6. Revert your changes and make sure autocomplete is enabled again.
pkukielka
force-pushed
the
pkukielka/add-cody-settings-editor
branch
from
89101b4
to
283fbd6
Compare
RXminuS
approved these changes
Aug 5, 2024
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.
Fixes CODY-1310
Changes
This PR adds cody settings editor with schema validation and code completion.
Test plan
Open Cody Settings Editor(you can useshift shiftto find it)"cody.autocomplete.enabled": trueCtrl + Sto trigger the config update