f6e5f6ca47
The machine maintenance panel showed every date one calendar day early on this
site, and would show it a day late east of UTC.
lastmaintenancedate and nextmaintenancedate were DATETIME columns holding
midnight, and BaseModel.to_dict serialises a datetime as isoformat + 'Z', so
2026-12-15 00:00:00 went out as "2026-12-15T00:00:00Z" and the browser
converted it into local time. There is no time in a maintenance date: the form
offers a date picker, the CSV importer takes '2026-06-01', and the value is only
ever compared against other dates. Every sibling already models it correctly -
measuringtools.lastcalibrationdate, warranties.startdate and enddate are all
db.Date - so machines were the odd one out.
Migration 7d40 converts both columns; MySQL truncates a midnight time so no
data moves, and SQLite neither enforces nor needs it.
That exposed two more things. The route was assigning the raw request string to
the column, which a DATE column rejects outright - it now goes through the
strict parser from wave 2, so a mistyped maintenance date is refused with a 400
rather than stored or nulled. And BaseModel.to_dict had no branch for a plain
date, so one reached Flask's encoder and came out as an HTTP-date
("Thu, 15 Jan 2026 00:00:00 GMT") - which a browser parses back into a moment
and can still render as the day before. Dates now serialise as "2026-01-15",
with datetime checked first because it is a subclass of date.
Verified against MySQL on a live instance: the column is DATE, the API serves
2026-01-15, a mistyped date is refused with 400, and a rename on a machine that
has maintenance dates saves - the 500 from the audit-log fix in 5d81f50c, now
confirmed end to end rather than only in tests.
Scope: product
106 lines
3.6 KiB
Python
106 lines
3.6 KiB
Python
"""Base model class with common fields."""
|
|
|
|
from datetime import date, datetime, timezone
|
|
from shopdb.extensions import db
|
|
|
|
|
|
def _utcnow():
|
|
# naive UTC for DB columns (stored without tzinfo)
|
|
return datetime.now(timezone.utc).replace(tzinfo=None)
|
|
|
|
|
|
class BaseModel(db.Model):
|
|
"""
|
|
Abstract base model with common fields.
|
|
All models should inherit from this.
|
|
"""
|
|
__abstract__ = True
|
|
|
|
createddate = db.Column(
|
|
db.DateTime,
|
|
default=_utcnow,
|
|
nullable=False
|
|
)
|
|
modifieddate = db.Column(
|
|
db.DateTime,
|
|
default=_utcnow,
|
|
onupdate=_utcnow,
|
|
nullable=False
|
|
)
|
|
isactive = db.Column(db.Boolean, default=True, nullable=False)
|
|
|
|
# Columns the default to_dict NEVER emits, whatever model carries them.
|
|
#
|
|
# The default serialiser walks __table__.columns and publishes every one, so
|
|
# a model that does not override it publishes whatever it has - including
|
|
# columns added to it later, by someone who was not thinking about this
|
|
# method. User is the live example: it does not override to_dict, so
|
|
# User.to_dict() returns passwordhash. Nothing calls it in a response path
|
|
# today, which is luck rather than design.
|
|
#
|
|
# A blanket allowlist would be the stronger rule, but it would also silently
|
|
# empty the output of all 34 models that rely on this default. This is the
|
|
# part that can be fixed without breaking anything: name the columns that
|
|
# must never be published, and let a model add its own.
|
|
#
|
|
# A model with something sensitive should still override to_dict and say
|
|
# exactly what it emits. This is a floor, not permission to skip that.
|
|
HIDDEN_COLUMNS = frozenset({
|
|
'passwordhash',
|
|
'tokenhash',
|
|
'apikey',
|
|
'clientsecret',
|
|
'collectorkey',
|
|
})
|
|
|
|
def to_dict(self):
|
|
"""Convert model to dictionary, minus anything secret-bearing."""
|
|
hidden = self.HIDDEN_COLUMNS
|
|
result = {}
|
|
for c in self.__table__.columns:
|
|
if c.name in hidden:
|
|
continue
|
|
value = getattr(self, c.name)
|
|
if isinstance(value, datetime):
|
|
value = value.isoformat() + 'Z'
|
|
elif isinstance(value, date):
|
|
# A date, not an instant: no time and no timezone marker. Left
|
|
# to Flask's encoder it became an HTTP-date
|
|
# ("Thu, 15 Jan 2026 00:00:00 GMT"), which a browser parses
|
|
# back into a moment and can render as the day before.
|
|
# datetime is a subclass of date, so this must stay second.
|
|
value = value.isoformat()
|
|
result[c.name] = value
|
|
return result
|
|
|
|
def update(self, **kwargs):
|
|
"""Update model attributes."""
|
|
for key, value in kwargs.items():
|
|
if hasattr(self, key):
|
|
setattr(self, key, value)
|
|
|
|
@classmethod
|
|
def get_active(cls):
|
|
"""Return query for active records only."""
|
|
return cls.query.filter_by(isactive=True)
|
|
|
|
|
|
class SoftDeleteMixin:
|
|
"""Mixin for soft delete functionality."""
|
|
|
|
deleteddate = db.Column(db.DateTime, nullable=True)
|
|
deletedby = db.Column(db.String(100), nullable=True)
|
|
|
|
def soft_delete(self, deleted_by: str = None):
|
|
"""Mark record as deleted."""
|
|
self.isactive = False
|
|
self.deleteddate = datetime.now(timezone.utc).replace(tzinfo=None)
|
|
self.deletedby = deleted_by
|
|
|
|
|
|
class AuditMixin:
|
|
"""Mixin for audit fields."""
|
|
|
|
createdby = db.Column(db.String(100), nullable=True)
|
|
modifiedby = db.Column(db.String(100), nullable=True)
|