Track created_by and updated_by in Node and Revisions by jmaruland · Pull Request #1255 · bluesky/tiled

jmaruland · 2025-12-12T21:59:00Z

Checklist

Add a Changelog entry
Add the ticket number which this PR closes to the comment section

This PR introduces created_by and updated_by columns in the database for forensic purposes.

tiled/catalog/orm.py

tiled/_tests/test_access_control.py

…reation

jmaruland · 2026-02-13T16:41:50Z

Closes #1076

danielballan

Nice to see this coming together! I have a couple questions in line.

Also, this needs a database migration to add the new columns to existing databases.

pixi.toml

danielballan · 2026-02-13T21:11:54Z

tiled/server/router.py

            data_sources=body.data_sources,
            access_blob=access_blob,
+            created_by=(
+                principal.identities[0].id if len(principal.identities) > 0 else ""


This design consideration deserves some thought:

What should we put here when the principal has no identities? Service Principals have no identities. Should we put service:{principal.uuid}? Or nothing?

Should the fallback value be "" or None / NULL?

I actually had to add this conditional because test_access_control.py::test_service_principal_access_control was failing here. It seems like, at some point during the handshake with the server, principal.identities is passed as an empty list.

tests/test_user_forensics.py

danielballan · 2026-02-24T19:29:48Z

Suggestions for various scenarios:

scenario	`principal`	`len(identities)`	`created_by`
single-user server	`None`	N/A	`NULL` in SQL, `None` in Python (not `""`)
user in a multi-user server, one ID provider	`str`	1	`principal.identities[0]`
user in a multi-user server, N ID providers	`str`	N	`principal.identities[0]`
service principal in a mult-user server, one ID provider	`str`	0	`f"service:{principal.uuid}"`

To test a service principal:

# Log in as admin. Then...

# Create a new Service Principal. It is identified by its UUID. It has no "identities"; it cannot log in with a password.
sp = admin_client.context.admin.create_service_principal()
# Create an API key for this Service Principal.
key_info = admin_client.context.admin.create_api_key(sp["uuid"])

# Then to log in as the principal, you can do this...
admin_client.logout()
sp_client.context.api_key = key_info["secret"]
# For clarity use a new variable name.
sp_client = admin_client
del admin_client

danielballan · 2026-02-24T19:35:15Z

Run a command line this to generate a template for a database migration. See other similar files in this directory for examples.

❯ python -m tiled.catalog revision -m "Add created_by and updated_by"

Finally, add the unique ID for this migration (the first part of the filename, and it also appears in the file) to this list:

tiled/tiled/catalog/core.py

Lines 7 to 26 in 2cf4c80

    
           # This is list of all valid revisions (from current to oldest). 
        
           ALL_REVISIONS = [ 
        
               "4cf6011a8db5", 
        
               "a86a48befff6", 
        
               "dfbb7478c6bd", 
        
               "a963a6c32a0c", 
        
               "e05e918092c3", 
        
               "7809873ea2c7", 
        
               "9331ed94d6ac", 
        
               "45a702586b2a", 
        
               "ed3a4223a600", 
        
               "e756b9381c14", 
        
               "2ca16566d692", 
        
               "1cd99c02d0c7", 
        
               "a66028395cab", 
        
               "3db11ff95b6c", 
        
               "0b033e7fbe30", 
        
               "83889e049ddc", 
        
               "6825c778aa3c", 
        
           ]

jmaruland · 2026-03-11T18:47:10Z

@danielballan I ran the command for the database migration but I have pre-commit a bit a bit mad because of flake8

flake8...................................................................Failed
- hook id: flake8
- exit code: 1

tiled/catalog/migrations/versions/8fd6ac88f2ec_add_created_by_and_updated_by.py:8:1: F401 'sqlalchemy as sa' imported but unused
tiled/catalog/migrations/versions/8fd6ac88f2ec_add_created_by_and_updated_by.py:9:1: F401 'alembic.op' imported but unused

This is an auto-generated file. Should I ignore these messages?

jmaruland · 2026-03-11T19:21:50Z

Is it ok if I add an inline comment with # noqa: F401 to ignore this and avoid deleting any auto-generated code?

jmaruland · 2026-03-11T19:53:52Z

False alarm. I understand what the next step us with the upgrade and downgrade methods that were just generated.
Thanks @genematx for the tips

… database migration

danielballan · 2026-03-12T19:56:33Z

tiled/catalog/migrations/versions/8fd6ac88f2ec_add_created_by_and_updated_by.py

+    op.add_column(
+        "revisions",
+        sa.Column("updated_by", String, nullable=True, server_default="NULL"),
+    )


I believe you changes to the ORM also drop the created_by column from the revisions table, and that change should be made here also.

It should correspondingly be added in the downgrade function, acknowledging that the information has been lost so the column will have to be initialized with 0 or something as a placeholder.

danielballan · 2026-03-12T19:57:05Z

tiled/catalog/adapter.py

+        metadata=None,
+        specs=None,
+        access_blob=None,
+        updated_by="",


Similar to created_by, I think None (NULL in SQL) may be a more appropriate default than "".

danielballan · 2026-03-12T20:01:08Z

tiled/catalog/core.py

    "0b033e7fbe30",
    "83889e049ddc",
    "6825c778aa3c",
+    "8fd6ac88f2ec",


Wrong position, I think. See comment at top of list.

danielballan · 2026-03-12T20:01:48Z

tiled/catalog/adapter.py

        specs=None,
        data_sources=None,
        access_blob=None,
+        created_by="",


I think None (NULL in SQL) may be a more appropriate default than "".

danielballan · 2026-03-12T20:03:34Z

tiled/server/router.py

            access_blob_modified = access_blob != entry.access_blob
            access_blob = entry.access_blob

+        if principal is None:


Since this logic occurs in three places, and is a bit fiddly, I think there's an argument for refactoring it into a function.

danielballan · 2026-03-12T20:04:18Z

.gitignore

 !.pixi/config.toml
+
+# copilot files
+copilot-instructions.md


If we have useful copilot instructions, maybe we should commit them!

danielballan reviewed Dec 16, 2025

View reviewed changes

tiled/catalog/orm.py Outdated Show resolved Hide resolved

jmaruland force-pushed the track-created-by-and-update-by-in-node-and-revisions branch from 0f4e558 to 1ce3bdc Compare January 22, 2026 21:15

nmaytan requested changes Jan 27, 2026

View reviewed changes

tiled/_tests/test_access_control.py Outdated Show resolved Hide resolved

jmaruland added 9 commits February 5, 2026 18:12

Modified Node and Revision orm for created_by and updated_by use

22dda3f

Removed TimeStamped class and reorganized paramters about user and time

a4b1464

Added new parameters to Node instantiation

17e2e95

Grabbed created_by and updated_by info from principal

66f8e6c

Added pixi modification

f329d17

Added test to check date on creation and on update to check user on c…

4f53904

…reation

Formatting

47139ea

Included chris profile for update test

c29b1d6

Removed test case from test_access_control

505796b

jmaruland force-pushed the track-created-by-and-update-by-in-node-and-revisions branch from ee06f6d to 505796b Compare February 5, 2026 23:16

Added test case

93a13a4

Fixed test bug

8eefbe2

danielballan requested changes Feb 13, 2026

View reviewed changes

jmaruland added 5 commits February 13, 2026 16:19

Formatting

61b68ce

Removed extra obstore package from pixi

f7be73a

Formatting

7c88164

Included NoneType conditional for principal

6c7d09a

Formatting

434433e

jmaruland added 2 commits March 5, 2026 18:50

Specified separate tests for users and services

a4a95b2

Added test for anonymous user

1173829

Added upgrade and downgrade methods for created_by and updated_by for…

e7cdf53

… database migration

danielballan requested changes Mar 12, 2026

View reviewed changes

Conversation

jmaruland commented Dec 12, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Checklist

Uh oh!

Uh oh!

Uh oh!

jmaruland commented Feb 13, 2026

Uh oh!

danielballan left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

danielballan Feb 13, 2026

Choose a reason for hiding this comment

Uh oh!

jmaruland Feb 13, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

danielballan commented Feb 24, 2026

Uh oh!

danielballan commented Feb 24, 2026

Uh oh!

jmaruland commented Mar 11, 2026

Uh oh!

jmaruland commented Mar 11, 2026

Uh oh!

jmaruland commented Mar 11, 2026

Uh oh!

danielballan Mar 12, 2026

Choose a reason for hiding this comment

Uh oh!

danielballan Mar 12, 2026

Choose a reason for hiding this comment

Uh oh!

danielballan Mar 12, 2026

Choose a reason for hiding this comment

Uh oh!

danielballan Mar 12, 2026

Choose a reason for hiding this comment

Uh oh!

danielballan Mar 12, 2026

Choose a reason for hiding this comment

Uh oh!

danielballan Mar 12, 2026

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

jmaruland commented Dec 12, 2025 •

edited

Loading

jmaruland Feb 13, 2026 •

edited

Loading