[indexer-alt] - make migration optional #20803
Conversation
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
3 Skipped Deployments
|
patrickkuo
temporarily deployed
to
sui-typescript-aws-kms-test-env
GitHub Actions
Inactive
patrickkuo
temporarily deployed
to
sui-typescript-aws-kms-test-env
GitHub Actions
Inactive
patrickkuo
temporarily deployed
to
sui-typescript-aws-kms-test-env
GitHub Actions
Inactive
There was a problem hiding this comment.
Beyond making Indexer::new accept an optional migrations, it looks like we'd just need to modify the function to not run db.run_migrations, around L145
I'm not sure if we need to make the other modifications, for the ResetDatabase command, an app indexer should just provide the skip-migrations flag
| pub fn migrations( | ||
| migrations: &'static EmbeddedMigrations, | ||
| migrations: Option<&'static EmbeddedMigrations>, | ||
| ) -> impl MigrationSource<Pg> + Send + Sync + 'static { | ||
| struct Migrations(&'static EmbeddedMigrations); | ||
| struct Migrations(Option<&'static EmbeddedMigrations>); | ||
| impl MigrationSource<Pg> for Migrations { | ||
| fn migrations(&self) -> migration::Result<Vec<Box<dyn Migration<Pg>>>> { | ||
| let mut migrations = MIGRATIONS.migrations()?; | ||
| migrations.extend(self.0.migrations()?); | ||
| if let Some(more_migrations) = self.0 { | ||
| migrations.extend(more_migrations.migrations()?); | ||
| } | ||
| Ok(migrations) | ||
| } | ||
| } |
There was a problem hiding this comment.
seems like this can still be kept as non-optional. it's only called when the ResetDatabase command is invoked. There, an indexer that isn't responsible for managing db-schema would pass skip-migrations
There was a problem hiding this comment.
I think we do need this change, because we also call this function in Indexer::new, and we want the indexer to be able to run migrations related to the indexing framework even if it is not responsible for the app-specific schema.
| (!skip_migrations).then(|| Indexer::migrations(Some(&MIGRATIONS))), | ||
| ) |
There was a problem hiding this comment.
i think an app indexer would just provide the skip-migrations flag
There was a problem hiding this comment.
IIUC, an app-specific indexer wouldn't be using this codebase (it would have its own binary).
| pub fn migrations( | ||
| migrations: &'static EmbeddedMigrations, | ||
| migrations: Option<&'static EmbeddedMigrations>, | ||
| ) -> impl MigrationSource<Pg> + Send + Sync + 'static { | ||
| struct Migrations(&'static EmbeddedMigrations); | ||
| struct Migrations(Option<&'static EmbeddedMigrations>); | ||
| impl MigrationSource<Pg> for Migrations { | ||
| fn migrations(&self) -> migration::Result<Vec<Box<dyn Migration<Pg>>>> { | ||
| let mut migrations = MIGRATIONS.migrations()?; | ||
| migrations.extend(self.0.migrations()?); | ||
| if let Some(more_migrations) = self.0 { | ||
| migrations.extend(more_migrations.migrations()?); | ||
| } | ||
| Ok(migrations) | ||
| } | ||
| } |
There was a problem hiding this comment.
I think we do need this change, because we also call this function in Indexer::new, and we want the indexer to be able to run migrations related to the indexing framework even if it is not responsible for the app-specific schema.
| (!skip_migrations).then(|| Indexer::migrations(Some(&MIGRATIONS))), | ||
| ) |
There was a problem hiding this comment.
IIUC, an app-specific indexer wouldn't be using this codebase (it would have its own binary).
patrickkuo
force-pushed
the
pat/indexer-optional-migration
branch
from
a2261e8 to
de66d05
Compare
patrickkuo
temporarily deployed
to
sui-typescript-aws-kms-test-env
GitHub Actions
Inactive
Description
Apps indexer might not be managing the DB schema, making migration optional to cater that use case.
Test plan
How did you test the new or updated feature?
Release notes
Check each box that your changes affect. If none of the boxes relate to your changes, release notes aren't required.
For each box you select, include information after the relevant heading that describes the impact of your changes that a user might notice and any actions they must take to implement updates.