event.created field, refs #2240

datasette/events.py

@@ -1,6 +1,7 @@
 from abc import ABC, abstractproperty
-from dataclasses import asdict, dataclass
+from dataclasses import asdict, dataclass, field
 from datasette.hookspecs import hookimpl
+from datetime import datetime, timezone
 from typing import Optional
 
 
@@ -10,11 +11,15 @@ class Event(ABC):
     def name(self):
         pass
 
-    actor: dict
+    created: datetime = field(
+        init=False, default_factory=lambda: datetime.now(timezone.utc)
+    )
+    actor: Optional[dict]
 
     def properties(self):
         properties = asdict(self)
         properties.pop("actor", None)
+        properties.pop("created", None)
         return properties
 
 

docs/plugin_hooks.rst

@@ -1788,6 +1788,7 @@ The ``event`` object will always have the following properties:
 
 - ``name``: a string representing the name of the event, for example ``logout`` or ``create-table``.
 - ``actor``: a dictionary representing the actor that triggered the event, or ``None`` if the event was not triggered by an actor.
+- ``created``: a ``datatime.datetime`` object in the ``timezone.utc`` timezone representing the time the event object was created.
 
 Other properties on the event will be available depending on the type of event. You can also access those as a dictionary using ``event.properties()``.
 

tests/conftest.py

@@ -7,7 +7,7 @@
 import subprocess
 import tempfile
 import time
-from dataclasses import dataclass
+from dataclasses import dataclass, field
 from datasette import Event, hookimpl
 
 

tests/test_plugins.py

@@ -19,6 +19,7 @@
 from jinja2.environment import Template
 from jinja2 import ChoiceLoader, FileSystemLoader
 import base64
+import datetime
 import importlib
 import json
 import os
@@ -1446,12 +1447,18 @@ async def test_hook_track_event():
     from .conftest import TrackEventPlugin
 
     await datasette.invoke_startup()
-    await datasette.track_event(TrackEventPlugin.OneEvent(None, extra="extra extra"))
+    await datasette.track_event(
+        TrackEventPlugin.OneEvent(actor=None, extra="extra extra")
+    )
     assert len(datasette._tracked_events) == 1
     assert isinstance(datasette._tracked_events[0], TrackEventPlugin.OneEvent)
     event = datasette._tracked_events[0]
     assert event.name == "one"
     assert event.properties() == {"extra": "extra extra"}
+    # Should have a recent created as well
+    created = event.created
+    assert isinstance(created, datetime.datetime)
+    assert created.tzinfo == datetime.timezone.utc
 
 
 @pytest.mark.asyncio