feat: settings migration #371
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
cristianoventura
commented
Dec 2, 2024
src/main.ts
Outdated
| @@ -198,9 +198,9 @@ const createWindow = async () => { | |||
| app.whenReady().then(async () => { | |||
| await initSettings() | |||
| appSettings = await getSettings() | |||
| nativeTheme.themeSource = appSettings.appearance.theme | |||
| nativeTheme.themeSource = appSettings.general.appearance.theme | |||
There was a problem hiding this comment.
Changes in this file are intended for testing purposes and will be reverted before merging.
Comment on lines
+13
to
+16
| case '1.0': | ||
| return migrate(v1.migrate(settings)) | ||
| case '2.0': | ||
| return settings |
There was a problem hiding this comment.
This function will run recursively until the latest version of the schema is reached.
Comment on lines
+112
to
+114
| export function migrate( | ||
| settings: z.infer<typeof AppSettingsSchema> | ||
| ): v2.AppSettings { |
There was a problem hiding this comment.
Every schema should export a migrate function that takes the current version and returns the next.
e-fisher
reviewed
Dec 3, 2024
src/types/settings.ts
Outdated
| @@ -3,7 +3,7 @@ import { | |||
| ProxySettingsSchema, | |||
| RecorderSettingsSchema, | |||
| UsageReportSettingsSchema, | |||
| } from '@/schemas/appSettings' | |||
| } from '@/schemas/settings/v2' | |||
There was a problem hiding this comment.
To avoid updating imports every time we introduce a new version we should add export to schemas/settings/index.ts
export * from './v2'This reverts commit 5fb2026.
cristianoventura
commented
Dec 3, 2024
Comment on lines
+18
to
+19
| export const AppSettingsSchema = z.object({ | ||
| version: z.literal('2.0'), |
There was a problem hiding this comment.
This is the same as v1, but I left some breadcrumbs to help us with the first migration when the time comes so no functional change at this time.
cristianoventura
requested review from
going-confetti,
Llandy3d,
e-fisher and
allansson
and removed request for
a team
5 tasks
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.
Description
This PR adds migrations to the settings schema, ensuring that changes to its structure remain backward-compatible. This allows the settings to work properly even when the schema is updated.
The same pattern will be applied to the Generator schema on a separate PR.
How to Test
This PR contains one extra commit that is intended to be used for testing purposes and will be reverted before merging.
Before testing this branch, make sure your local settings file (
k6-studio-dev.json) containsusageReport.enabledfalseandappearance.themeaslightso you can validate the changes.Once the settings are saved, the file structure should look like this instead:
Checklist
npm run lint) and all checks pass.npm test) and all tests pass.Screenshots (if appropriate):
Related PR(s)/Issue(s)
Resolves #265