Files
shopdb-flask/migrations/PRODUCTION_MIGRATION_GUIDE.md
cproudlock 2c415a1712
Some checks failed
CI / backend (push) Failing after 8s
CI / naming (push) Successful in 2s
CI / frontend (push) Successful in 9s
CI / migrations-mysql (push) Failing after 7s
fix(installer): correct a false security claim, and clear the should-fix list
CLIENT IP / SPOOFABILITY. docs/geenforce-api-cutover.md claimed that removing the
IIS rewrite rule made the allowlist fail closed and that it does NOT become
spoofable. The opposite is true. IIS never sets X-Forwarded-For on its own; the
rule is the only thing that does. Remove it and IIS still forwards whatever
X-Forwarded-For the CALLER sent, waitress trusts it because it arrives from
127.0.0.1, and remote_addr becomes attacker-controlled - so a token-less caller
can fetch manifests from anywhere on the network. The document and the
_trusted_client_ip docstring now say so, waitress runs with
--trusted-proxy-count=1, and stage 5 checks the rule is actually live rather than
assuming it. The wizard question is rephrased to something an operator can verify
with their network team instead of guessing at.

NON-ASCII. The style gate only ever checked .py/.vue/.js/.ts, so documentation
accumulated em-dashes, arrows and box-drawing characters against this repo's own
convention - including in files added this week. Cleaned, and the gate now uses
INCLUDES_ALL so Markdown, JSON and YAML are covered.

PLUGIN DEFAULTS. The wizard pre-ticked measuringtools and printedparts, both of
which ship default_enabled=false, so every site taking the defaults installed and
enabled them against their manifests. Inno has no JSON parser so the list must be
hardcoded, but tests/test_installer_defaults.py now fails when it drifts.

UPGRADES. The payload copy merges, so a plugin dropped from a site's profile kept
its code forever - which defeats a lean build and leaves core's optional-import
guards succeeding for a plugin the site no longer has. Stale plugin directories
are now deregistered and removed before the copy.

add-plugin used 'plugin install', which for the five default_enabled=false
plugins left them installed but DISABLED - and printed a green success line
anyway. It now goes through apply-profile, and the success line is gated on the
exit code. Invoke-Flask records its own exit status, because $LASTEXITCODE keeps
a stale value when flask.exe is missing and no native command runs.

CHARSET. The utf8mb4 compiler hook lived inline in migrations/env.py, so it
covered the CORE chain only: plugin baselines inherited the server default, which
on a latin1 server means two charsets in one database. It is now
shopdb/utils/mysql_charset.py, imported by both, and preflight reports the
database's default charset.

BACKUP HONESTY. The dump was described as 'all of your asset data'. Uploaded
branding and floor-map images live in instance\ on disk, not in the database, so
a restore from the .sql alone comes back with no map. backup now archives
instance\ alongside it and says both are needed.

VERSIONING. AppVersion was hardcoded at 0.9.0 while the product, the frontend and
the newest tag said 0.7.0 - and 0.9.0 collides with a retired contract version.
Both builders now generate version.iss from shopdb/__init__.py.

Smaller: rollback overwrites .env before deleting it, as uninstall already did;
appcmd unlocks are scoped to this site's location rather than server-wide, with
the wide unlock as a fallback; DEVELOPMENT-SETUP says Python 3.14; the README
plugin list gains printedparts; prune-schema --force is documented as
first-provisioning-only; HTTPS is documented as not-the-default with the steps to
add it; the DBA SQL is on the wizard's database page; the features page says
unticking does not remove an installed feature; and the installer README states
that bundle-lock cannot vouch for the exe itself - that needs signing or an
out-of-band hash, neither of which is wired up.
2026-08-03 14:57:38 -04:00

5.0 KiB

Production Migration Guide

Overview

This guide documents the process for migrating data from the legacy VBScript ShopDB site to the new Flask-based ShopDB.

Database Architecture

Legacy System (VBScript)

  • Single machines table containing all equipment, PCs, printers
  • machinetypes table for classification
  • models table with machinetypeid reference

New System (Flask)

  • Core assets table (unified asset registry)
  • Plugin-specific extension tables:
    • equipment (equipmenttypeid -> equipmenttypes)
    • computers (computertypeid -> computertypes)
    • printers (printertypeid -> printertypes)
    • network_device (networkdevicetypeid -> networkdevicetypes)

Key Mappings

Asset Type Mapping

Legacy Category New Asset Type Extension Table
Equipment machines Equipment equipment
PC/Computer Computer computers
Printer Printer printers
Network (IDF, Switch, AP) Network Device network_device

Type ID Alignment

The equipmenttypes table IDs match machinetypes IDs for easy migration:

  • equipmenttypeid = machinetypeid (where applicable)

Migration Steps

Step 1: Export from Legacy Database

-- Export machines with all related data
SELECT
    m.*,
    mt.machinetype,
    mo.modelnumber,
    mo.machinetypeid as model_typeid,
    v.vendor,
    bu.businessunit,
    s.status
FROM machines m
LEFT JOIN machinetypes mt ON mt.machinetypeid = m.machinetypeid
LEFT JOIN models mo ON mo.modelnumberid = m.modelnumberid
LEFT JOIN vendors v ON v.vendorid = m.vendorid
LEFT JOIN businessunits bu ON bu.businessunitid = m.businessunitid
LEFT JOIN statuses s ON s.statusid = m.statusid;

Step 2: Create Assets

For each machine, create an asset record:

INSERT INTO assets (assetnumber, name, assettypeid, statusid, locationid, businessunitid, mapleft, maptop)
SELECT
    CONCAT(machinenumber, '-', machineid),  -- Unique asset number
    alias,
    CASE
        WHEN category = 'PC' THEN 2      -- Computer
        WHEN category = 'Printer' THEN 4  -- Printer
        ELSE 1                            -- Equipment
    END,
    statusid,
    locationid,
    businessunitid,
    mapleft,
    maptop
FROM machines;

Step 3: Create Extension Records

-- For Equipment
INSERT INTO equipment (assetid, equipmenttypeid, vendorid, modelnumberid)
SELECT
    a.assetid,
    COALESCE(mo.machinetypeid, m.machinetypeid),  -- Use model's type if available!
    m.vendorid,
    m.modelnumberid
FROM machines m
JOIN assets a ON a.assetnumber = CONCAT(m.machinenumber, '-', m.machineid)
LEFT JOIN models mo ON mo.modelnumberid = m.modelnumberid
WHERE m.category = 'Equipment' OR m.category IS NULL;

Step 4: Post-Migration Fixes

Fix LocationOnly Equipment Types

Equipment imported with LocationOnly type should inherit type from their model:

-- Fix equipment that has a model with a proper type
UPDATE equipment e
JOIN assets a ON a.assetid = e.assetid
JOIN machines m ON m.machinenumber = SUBSTRING_INDEX(a.assetnumber, '-', 1)
JOIN models mo ON mo.modelnumberid = m.modelnumberid
SET e.equipmenttypeid = mo.machinetypeid
WHERE e.equipmenttypeid = 1  -- LocationOnly
AND mo.machinetypeid != 1;   -- Model has real type

Validation Queries

Check for Orphaned Assets

SELECT a.* FROM assets a
LEFT JOIN equipment e ON e.assetid = a.assetid
LEFT JOIN computers c ON c.assetid = a.assetid
LEFT JOIN printers p ON p.assetid = a.assetid
WHERE a.assettypeid = 1  -- Equipment type
AND e.assetid IS NULL;

Check LocationOnly with Models

-- Should return 0 after migration fix
SELECT COUNT(*)
FROM equipment e
JOIN assets a ON a.assetid = e.assetid
JOIN machines m ON m.machinenumber = SUBSTRING_INDEX(a.assetnumber, '-', 1)
JOIN models mo ON mo.modelnumberid = m.modelnumberid
WHERE e.equipmenttypeid = 1
AND mo.machinetypeid != 1;

Verify Type Distribution

SELECT et.equipmenttype, COUNT(*) as count
FROM equipment e
JOIN equipmenttypes et ON et.equipmenttypeid = e.equipmenttypeid
GROUP BY et.equipmenttype
ORDER BY count DESC;

Common Issues

Issue: Equipment marked as LocationOnly but has model

Cause: Migration copied machinetypeid from machines table instead of using model's type Fix: See FIX_LOCATIONONLY_EQUIPMENT_TYPES.md

Issue: Missing model relationship

Cause: Equipment table modelnumberid not populated during migration Fix: Link through machines table using asset number pattern

Issue: Duplicate asset numbers

Cause: Asset number generation didn't account for existing duplicates Fix: Use unique suffix or check before insert

Scripts Location

  • /migrations/FIX_LOCATIONONLY_EQUIPMENT_TYPES.md - Fix for LocationOnly type issue
  • /scripts/import_from_mysql.py - Original import script (may need updates)
  • /scripts/migration/ - Migration utilities

Notes

  • Always backup before running migration fixes
  • Test on staging/dev before production
  • Verify counts before and after each fix
  • Keep legacy machines table for reference during transition

Date Created

2026-01-27