update runsinglemigration to accept migration options by akshaydeo · Pull Request #3626 · maximhq/bifrost

akshaydeo · 2026-05-20T11:39:03Z

Summary

RunSingleMigration previously always used migrator.DefaultOptions, making it impossible for callers to supply custom migrator options. This PR adds an optional *migrator.Options parameter so downstream consumers (e.g. bifrost-enterprise, plugins) can pass their own options when needed, while all existing internal callers pass nil to retain the default behavior.

Changes

Added an options *migrator.Options parameter to RunSingleMigration; when nil is passed, migrator.DefaultOptions is used as before
Updated all internal call sites to pass nil, preserving existing behavior

Type of change

Affected areas

How to test

go test ./framework/configstore/...

Verify that all existing migrations continue to run successfully with nil options, and that a custom *migrator.Options value is correctly applied when provided.

Breaking changes

Yes
No

RunSingleMigration is a public function. Its signature has changed — callers outside this repository (e.g. bifrost-enterprise, plugins) must add a nil (or custom options) argument as the second parameter.

Related issues

N/A

Security considerations

None. This change only affects how migrator options are threaded through to the migration runner.

Checklist

I read docs/contributing/README.md and followed the guidelines
I added/updated tests where appropriate
I updated documentation where needed
I verified builds succeed (Go and UI)
I verified the CI pipeline passes locally if applicable

coderabbitai · 2026-05-20T11:39:13Z

Caution

Review failed

The pull request is closed.

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: fbcb96a7-3be0-430b-8a24-58b31d00c282

📥 Commits

Reviewing files that changed from the base of the PR and between 78778fb and 0074ae3.

📒 Files selected for processing (1)

framework/configstore/migrations.go

📝 Walkthrough

Summary by CodeRabbit

Refactor
- Updated internal database migration handling for improved configuration flexibility.

Walkthrough

RunSingleMigration in framework/configstore/migrations.go now accepts a *migrator.Options parameter between ctx and db. When options is nil, it defaults to migrator.DefaultOptions. Eight migration functions are updated to call the function with nil for the new options parameter, preserving existing behavior.

Changes

Migration Options Parameter

Layer / File(s)	Summary
RunSingleMigration signature and implementation `framework/configstore/migrations.go`	`RunSingleMigration` accepts a new `*migrator.Options` parameter, defaults to `migrator.DefaultOptions` when nil, and constructs the migrator with those options before executing the migration.
Migration call site updates `framework/configstore/migrations.go`	Eight migration functions (`migrationAddTeamSourceIDColumn`, `migrationUniqueTeamNames`, `migrationAddOAuthAuthModeColumns`, `migrationReplaceOauthSessionTokenWithSessionID`, `migrationDropLegacyOAuthServerTables`, `migrationDropNonVKOauthUserRows`, `migrationDropMCPExternalServerURL`, `migrationRefreshConfigHashAfterMCPExternalServerURLRemoval`) update their `RunSingleMigration` calls to pass `nil` for options using the new parameter order.

🎯 2 (Simple) | ⏱️ ~12 minutes

🐰 A function spreads its wings so wide,
Now options flow in, side by side,
Eight migrations hop along the way,
All passing nil to save the day! 🌱

✨ Finishing Touches

📝 Generate docstrings

Create stacked PR
Commit on current branch

🧪 Generate unit tests (beta)

Create PR with unit tests
Commit unit tests in branch 05-20-update_runsinglemigration_to_accept_migration_options

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

CLAassistant · 2026-05-20T11:39:14Z

Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution.
_{You have signed the CLA already but the status is still pending? Let us recheck it.}

akshaydeo · 2026-05-20T11:39:16Z

update runsinglemigration to accept migration options #3626 👈 (View in Graphite)
dev

This stack of pull requests is managed by Graphite. Learn more about stacking.

akshaydeo · 2026-05-20T11:39:30Z

Merge activity

May 20, 11:39 AM UTC: A user started a stack merge that includes this pull request via Graphite.
May 20, 11:39 AM UTC: @akshaydeo merged this pull request with Graphite.

greptile-apps · 2026-05-20T11:41:26Z

Confidence Score: 4/5

Safe to merge; the only concern is a latent pointer-aliasing issue that does not cause any current misbehaviour.

The change is small and all internal callers are correctly updated. The one thing worth watching is that migrationOpts := migrator.DefaultOptions copies the pointer to the global struct rather than a fresh value. migrator.New fills in zero-value fields in-place on the struct it receives, so if a new Options field is ever added without a corresponding default, the first nil-options call would silently mutate the process-wide DefaultOptions and affect all subsequent migrations.

framework/configstore/migrations.go — specifically the migrationOpts fallback assignment around line 154.

Important Files Changed

Filename	Overview
framework/configstore/migrations.go	Adds an `options *migrator.Options` parameter to `RunSingleMigration`; all internal callers updated to pass `nil`. When `nil` is provided, the code assigns the global `migrator.DefaultOptions` pointer directly rather than making a struct copy, which could corrupt the global if `migrator.New` ever mutates a new zero-value field.

_{Reviews (1): Last reviewed commit: "update runsinglemigration to accept migr..." | Re-trigger Greptile}

greptile-apps · 2026-05-20T11:41:30Z

+	migrationOpts := migrator.DefaultOptions
+	if options != nil {
+		migrationOpts = options
+	}


When options is nil, migrationOpts is assigned the same pointer as the global migrator.DefaultOptions. migrator.New mutates the *Options it receives to fill in any zero-value fields in-place. Today DefaultOptions is fully populated so no mutation fires, but if a new field is added to Options without a corresponding default, New would corrupt the package-level global on the first call, affecting every subsequent migration for the lifetime of the process. Copying the struct value avoids this aliasing risk entirely.

Suggested change

migrationOpts := migrator.DefaultOptions

if options != nil {

migrationOpts = options

}

defaultCopy := *migrator.DefaultOptions

migrationOpts := &defaultCopy

if options != nil {

migrationOpts = options

}

## Summary `RunSingleMigration` previously always used `migrator.DefaultOptions`, making it impossible for callers to supply custom migrator options. This PR adds an optional `*migrator.Options` parameter so downstream consumers (e.g. bifrost-enterprise, plugins) can pass their own options when needed, while all existing internal callers pass `nil` to retain the default behavior. ## Changes - Added an `options *migrator.Options` parameter to `RunSingleMigration`; when `nil` is passed, `migrator.DefaultOptions` is used as before - Updated all internal call sites to pass `nil`, preserving existing behavior ## Type of change - [ ] Bug fix - [ ] Feature - [x] Refactor - [ ] Documentation - [ ] Chore/CI ## Affected areas - [x] Core (Go) - [ ] Transports (HTTP) - [ ] Providers/Integrations - [x] Plugins - [ ] UI (React) - [ ] Docs ## How to test ```sh go test ./framework/configstore/... ``` Verify that all existing migrations continue to run successfully with `nil` options, and that a custom `*migrator.Options` value is correctly applied when provided. ## Breaking changes - [x] Yes - [ ] No `RunSingleMigration` is a public function. Its signature has changed — callers outside this repository (e.g. bifrost-enterprise, plugins) must add a `nil` (or custom options) argument as the second parameter. ## Related issues N/A ## Security considerations None. This change only affects how migrator options are threaded through to the migration runner. ## Checklist - [ ] I read `docs/contributing/README.md` and followed the guidelines - [ ] I added/updated tests where appropriate - [ ] I updated documentation where needed - [ ] I verified builds succeed (Go and UI) - [ ] I verified the CI pipeline passes locally if applicable

update runsinglemigration to accept migration options

0074ae3

akshaydeo marked this pull request as ready for review May 20, 2026 11:39

akshaydeo merged commit f0b695b into dev May 20, 2026
13 of 15 checks passed

akshaydeo deleted the 05-20-update_runsinglemigration_to_accept_migration_options branch May 20, 2026 11:39

greptile-apps Bot reviewed May 20, 2026

View reviewed changes

Navigation Menu

update runsinglemigration to accept migration options - #3626

update runsinglemigration to accept migration options#3626
akshaydeo merged 1 commit into
devfrom
05-20-update_runsinglemigration_to_accept_migration_options

akshaydeo commented May 20, 2026 •

edited

Loading

Uh oh!

coderabbitai Bot commented May 20, 2026 •

edited

Loading

Review failed

Summary by CodeRabbit

Walkthrough

Changes

Uh oh!

CLAassistant commented May 20, 2026

Uh oh!

akshaydeo commented May 20, 2026 •

edited

Loading

Uh oh!

akshaydeo commented May 20, 2026 •

edited

Loading

Uh oh!

Uh oh!

greptile-apps Bot commented May 20, 2026

Uh oh!

greptile-apps Bot May 20, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Conversation

akshaydeo commented May 20, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Changes

Type of change

Affected areas

How to test

Breaking changes

Related issues

Security considerations

Checklist

Uh oh!

coderabbitai Bot commented May 20, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Review failed

Summary by CodeRabbit

Walkthrough

Changes

Uh oh!

CLAassistant commented May 20, 2026

Uh oh!

akshaydeo commented May 20, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

akshaydeo commented May 20, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Merge activity

Uh oh!

Uh oh!

greptile-apps Bot commented May 20, 2026

Confidence Score: 4/5

Important Files Changed

Uh oh!

greptile-apps Bot May 20, 2026

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

akshaydeo commented May 20, 2026 •

edited

Loading

coderabbitai Bot commented May 20, 2026 •

edited

Loading

akshaydeo commented May 20, 2026 •

edited

Loading

akshaydeo commented May 20, 2026 •

edited

Loading