-
Notifications
You must be signed in to change notification settings - Fork 41
fix: avoid overwriting malformed global config #1339
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
kiwigitops
wants to merge
2
commits into
aws:main
Choose a base branch
from
kiwigitops:fix-invalid-global-config-overwrite
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+80
−19
Open
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,9 +1,10 @@ | ||
| import { readFileSync } from 'fs'; | ||
| import { mkdir, readFile, writeFile } from 'fs/promises'; | ||
| import { mkdir, readFile, stat, writeFile } from 'fs/promises'; | ||
| import { randomUUID } from 'node:crypto'; | ||
| import { homedir } from 'os'; | ||
| import { join } from 'path'; | ||
| import { z } from 'zod'; | ||
| import { toError } from '../../errors/types.js'; | ||
|
|
||
| export const GLOBAL_CONFIG_DIR = process.env.AGENTCORE_CONFIG_DIR ?? join(homedir(), '.agentcore'); | ||
| export const GLOBAL_CONFIG_FILE = join(GLOBAL_CONFIG_DIR, 'config.json'); | ||
|
|
@@ -46,20 +47,70 @@ export function readGlobalConfigSync(configFile = GLOBAL_CONFIG_FILE): GlobalCon | |
| } | ||
| } | ||
|
|
||
| export type UpdateGlobalConfigResult = { success: true } | { success: false; error: Error }; | ||
|
|
||
| export async function updateGlobalConfig( | ||
| partial: GlobalConfig, | ||
| configDir = GLOBAL_CONFIG_DIR, | ||
| configFile = GLOBAL_CONFIG_FILE | ||
| ): Promise<boolean> { | ||
| try { | ||
| const existing = await readGlobalConfig(configFile); | ||
| const merged: GlobalConfig = mergeConfig(existing, partial); | ||
| ): Promise<UpdateGlobalConfigResult> { | ||
| // Read the existing config strictly: a missing file is fine (start fresh), but a | ||
| // malformed file must not be silently overwritten with merged-in defaults. | ||
| const existing = await loadConfigForUpdate(configFile); | ||
| if (!existing.success) { | ||
| return existing; | ||
| } | ||
|
|
||
| try { | ||
| const merged: GlobalConfig = mergeConfig(existing.config, partial); | ||
| await mkdir(configDir, { recursive: true }); | ||
| await writeFile(configFile, JSON.stringify(merged, null, 2), 'utf-8'); | ||
| return true; | ||
| } catch { | ||
| return false; | ||
| return { success: true }; | ||
| } catch (error) { | ||
| return { success: false, error: new Error(`Failed to write config to ${configFile}: ${toError(error).message}`) }; | ||
| } | ||
| } | ||
|
|
||
| type LoadConfigResult = { success: true; config: GlobalConfig } | { success: false; error: Error }; | ||
|
|
||
| /** | ||
| * Reads the existing global config for an update. Distinguishes a missing file | ||
| * (treated as an empty config) from a malformed one (read/parse/schema failure), | ||
| * so the caller can avoid clobbering a config it could not understand. | ||
| */ | ||
| async function loadConfigForUpdate(configFile: string): Promise<LoadConfigResult> { | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. this logic feels a bit convoluted to me. Do you think it makes sense to directly check if the file exists (via fs.exists or something), then use that instead of the error? |
||
| const existingFile = await configFileExists(configFile); | ||
| if (!existingFile.success) { | ||
| return existingFile; | ||
| } | ||
| if (!existingFile.exists) { | ||
| return { success: true, config: {} }; | ||
| } | ||
|
|
||
| try { | ||
| const data = await readFile(configFile, 'utf-8'); | ||
| return { success: true, config: GlobalConfigSchema.parse(JSON.parse(data)) }; | ||
| } catch (error) { | ||
| const cause = toError(error); | ||
| return { | ||
| success: false, | ||
| error: new Error(`Config at ${configFile} is malformed: ${cause.message}`, { cause }), | ||
| }; | ||
| } | ||
| } | ||
|
|
||
| type ConfigFileExistsResult = { success: true; exists: boolean } | { success: false; error: Error }; | ||
|
|
||
| async function configFileExists(path: string): Promise<ConfigFileExistsResult> { | ||
| try { | ||
| await stat(path); | ||
| return { success: true, exists: true }; | ||
| } catch (error) { | ||
| const cause = toError(error); | ||
| if ((cause as NodeJS.ErrnoException).code === 'ENOENT') { | ||
| return { success: true, exists: false }; | ||
| } | ||
| return { success: false, error: new Error(`Could not access config at ${path}: ${cause.message}`, { cause }) }; | ||
| } | ||
| } | ||
|
|
||
|
|
||
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
nice simple test!