b96637e1a1
Reported: `flask plugin upgrade-all` failed the tools plugin with "table securesendsecrets already exists". Every post-cutover baseline emitted a plain op.create_table. That is correct only while a table's existence and its plugin's Alembic stamp can never disagree, and they can. Anything that builds tables from the models - db.create_all(), which `flask db-utils create-all` calls - creates them and stamps nothing. A run that creates a table and then fails before its stamp commits leaves the same split, and re-running is the obvious thing to try. In both cases upgrade-all meets existing tables with an unstamped chain and the create is fatal. Nothing caught it because the migration test DROPS the post-cutover tables db.create_all() built before running upgrade-all. That arranges the one state where an unguarded create works, and never the state the report came from. The new test is the same sequence with the drop removed for the plugin under test. create_table_if_missing and create_index_if_missing are in alembic_template.py next to create_plugin_tables, which had the idempotency rule right and turns out to be called by nobody - its docstring claimed every 0001 used it. Fixed the docstring rather than rewiring the baselines onto it, because the reason they hand-write their DDL still stands: the helper's per-plugin MetaData cannot resolve a foreign key to a core table at CreateTable-compile time. INDEXES ARE MATCHED ON COLUMNS, NOT NAME, and that distinction matters. The two creators disagree about names - db.create_all() takes SQLAlchemy's default convention (ix_securesendsecrets_token) and a baseline spells it the way this repo's naming rules require (ixsecuresendsecretstoken). A name-keyed guard would have called the index missing and added a second one over the same column, which MySQL permits with a warning, so every affected site would have quietly grown duplicates. The test asserts no table ends up with two indexes over the same columns. Applied to all nine table-creating plugin migrations, not just the tools baseline that was reported: the four later migrations that create tables have the same exposure, and geenforce, measuringtools, printedparts and backups are the same defect waiting for a different site. WHAT THIS DOES NOT FIX. It makes a baseline idempotent, not a whole chain. A longer chain can still meet an ALTER whose column is already present - printedparts adding gagelabtag to a table create_all built at head is the case that showed up while testing. Guarding every op one at a time is the wrong answer to that; a database built from the models is already AT head and its chains want stamping rather than replaying, and there is no `flask plugin stamp` today. Left alone deliberately rather than half-built, and the new test is scoped to single-baseline plugins so it does not pretend otherwise.
91 lines
3.9 KiB
Python
91 lines
3.9 KiB
Python
"""printers: printerobservedqueues table (what a bay reported it HAS).
|
|
|
|
ShopDB already knows what a bay SHOULD have (usesprinter/defaultprinter rows on
|
|
the machine). This table holds the other half: the queues a PC reported through
|
|
POST /api/collector/printers. Observed and assigned stay in separate tables on
|
|
purpose, so observed drift can never be mistaken for desired state.
|
|
|
|
One row per observed queue; the latest report for a host replaces all of that
|
|
host's rows. The unique index on (hostname, queuename) is the guard that turns a
|
|
half-finished replace into an IntegrityError instead of duplicate queues.
|
|
|
|
Explicit ops rather than create_plugin_tables: the helper builds a per-plugin
|
|
MetaData filtered to the plugin's own tables, so the foreign key to the core
|
|
assets table cannot resolve at CreateTable-compile time. Same reason the backups
|
|
baseline spells its ops out.
|
|
|
|
Guarded both ways, so a re-run (or a database where db.create_all already built
|
|
the table) is a no-op.
|
|
|
|
Revision ID: printers0005observedqueues
|
|
Revises: printers0004drivervendor
|
|
"""
|
|
from alembic import op
|
|
|
|
from shopdb.plugins.alembic_template import (
|
|
create_index_if_missing,
|
|
create_table_if_missing,
|
|
)
|
|
import sqlalchemy as sa
|
|
|
|
|
|
# revision identifiers, used by Alembic.
|
|
revision = 'printers0005observedqueues'
|
|
down_revision = 'printers0004drivervendor'
|
|
branch_labels = None
|
|
depends_on = None
|
|
|
|
|
|
def upgrade():
|
|
bind = op.get_bind()
|
|
inspector = sa.inspect(bind)
|
|
if 'printerobservedqueues' in inspector.get_table_names():
|
|
return
|
|
create_table_if_missing(
|
|
'printerobservedqueues',
|
|
sa.Column('printerobservedqueueid', sa.Integer(), nullable=False),
|
|
# Nullable and no index of its own beyond the explicit one below: an
|
|
# unenrolled bay still gets to report, and hostname is what identifies
|
|
# the report.
|
|
sa.Column('assetid', sa.Integer(), nullable=True),
|
|
sa.Column('hostname', sa.String(length=255), nullable=False),
|
|
sa.Column('queuename', sa.String(length=255), nullable=False),
|
|
sa.Column('drivername', sa.String(length=255), nullable=True),
|
|
sa.Column('portname', sa.String(length=255), nullable=True),
|
|
sa.Column('portaddress', sa.String(length=255), nullable=True),
|
|
sa.Column('isdefault', sa.Boolean(), nullable=False,
|
|
server_default=sa.false()),
|
|
sa.Column('isshared', sa.Boolean(), nullable=False,
|
|
server_default=sa.false()),
|
|
sa.Column('observedat', sa.DateTime(), nullable=False),
|
|
sa.Column('createddate', sa.DateTime(), nullable=False),
|
|
sa.Column('modifieddate', sa.DateTime(), nullable=False),
|
|
sa.Column('isactive', sa.Boolean(), nullable=False,
|
|
server_default=sa.true()),
|
|
sa.ForeignKeyConstraint(['assetid'], ['assets.assetid'],
|
|
ondelete='CASCADE'),
|
|
sa.PrimaryKeyConstraint('printerobservedqueueid'),
|
|
# Doubles as the read index for the hostname filter (leftmost column),
|
|
# so no separate hostname index is created.
|
|
sa.UniqueConstraint('hostname', 'queuename',
|
|
name='uq_printerobservedqueue_host_queue'),
|
|
)
|
|
# Port address is the primary match key from an observed queue back to a
|
|
# printer asset, so every comparison read hits it.
|
|
create_index_if_missing('idx_printerobservedqueues_portaddress',
|
|
'printerobservedqueues', ['portaddress'])
|
|
create_index_if_missing('idx_printerobservedqueues_assetid',
|
|
'printerobservedqueues', ['assetid'])
|
|
|
|
|
|
def downgrade():
|
|
bind = op.get_bind()
|
|
inspector = sa.inspect(bind)
|
|
if 'printerobservedqueues' not in inspector.get_table_names():
|
|
return
|
|
op.drop_index('idx_printerobservedqueues_assetid',
|
|
table_name='printerobservedqueues')
|
|
op.drop_index('idx_printerobservedqueues_portaddress',
|
|
table_name='printerobservedqueues')
|
|
op.drop_table('printerobservedqueues')
|