[sql-41] firewalldb: add migration code for kvstores from kvdb to SQL #1079
Conversation
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
In preparation for upcoming migration tests from a kvdb to an SQL store, this commit updates the NewTestDB function to return the Store interface rather than a concrete store implementation. This change ensures that migration tests can call NewTestDB under any build tag while receiving a consistent return type.
When a session has a MacaroonRecipe set, which has a nil value set for either the `Permissions` or the `Caveats` field, the kvdb session store would return that field as nil, while the sql prior to this commit would return an empty array. When the we migrate the session store from kvdb to sql, that will cause the kvdb and the migrate session store to differ when comparing them, which will cause the migration to fail. This commit fixes that by ensuring that the sql session store returns a nil value for those fields in that scenario, rather than an empty array.
This commit introduces the migration logic for transitioning the sessions store from kvdb to SQL. Note that as of this commit, the migration is not yet triggered by any production code, i.e. only tests execute the migration logic.
ViktorTigerstrom
changed the title
ViktorTigerstrom
added
the
no-changelog
ellemouton
reviewed
May 30, 2025
| func processRuleBucket(ctx context.Context, sqlTx SQLQueries, perm bool, | ||
| ruleSqlId int64, ruleBucket *bbolt.Bucket) error { | ||
|
|
||
| err := ruleBucket.ForEach(func(k, v []byte) error { |
There was a problem hiding this comment.
return ruleBucket.ForEach(...
| "rule-name bucket") | ||
| } | ||
|
|
||
| if bytes.Equal(k, globalKVStoreBucketKey) { |
Comment on lines
+177
to
+186
| migratedValue, err := sqlTx.GetGlobalKVStoreRecord( | ||
| ctx, | ||
| sqlc.GetGlobalKVStoreRecordParams{ | ||
| Key: globalInsertParams.EntryKey, | ||
| Perm: globalInsertParams.Perm, | ||
| RuleID: globalInsertParams.RuleID, | ||
| }, | ||
| ) | ||
| if err != nil { | ||
| return fmt.Errorf("retreiving of migrated global kv "+ |
There was a problem hiding this comment.
i think it may be worth only doing these read-checks after all the writes are complete. Else we may miss if we accidentally overwrite it later
| "%s bucket", string(sessKVStoreBucketKey)) | ||
| } | ||
|
|
||
| groupId := k |
There was a problem hiding this comment.
just call the argument groupID?
| } | ||
|
|
||
| return groupBucket.ForEach(func(k, v []byte) error { | ||
| if v != nil { |
| Value: v, | ||
| Perm: perm, | ||
| RuleID: ruleSqlId, | ||
| SessionID: sql.NullInt64{ |
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.
Based on #1051
This PR introduces the migration logic for transitioning the kv stores from kvdb to SQL.
Note that as of this PR, the migration is not yet triggered by any production code, i.e. only tests execute the migration logic.
Once #1051 is merged, I will rebase this PR and request reviews.
Part of #917