Merge pull request #43 from yuvipanda/override-timestamp

Allow overriding timestamp of event

jupyter_telemetry/eventlog.py

@@ -124,7 +124,7 @@ def register_schema(self, schema):
 
         self.schemas[(schema['$id'], schema['version'])] = schema
 
-    def record_event(self, schema_name, version, event):
+    def record_event(self, schema_name, version, event, timestamp_override=None):
         """
         Record given event with schema has occurred.
         """
@@ -140,8 +140,12 @@ def record_event(self, schema_name, version, event):
         schema = self.schemas[(schema_name, version)]
         jsonschema.validate(event, schema)
 
+        if timestamp_override is None:
+            timestamp = datetime.utcnow()
+        else:
+            timestamp = timestamp_override
         capsule = {
-            '__timestamp__': datetime.utcnow().isoformat() + 'Z',
+            '__timestamp__': timestamp.isoformat() + 'Z',
             '__schema__': schema_name,
             '__schema_version__': version,
             '__metadata_version__': TELEMETRY_METADATA_VERSION

tests/test_register_schema.py

@@ -4,6 +4,7 @@
 import tempfile
 
 import jsonschema
+from datetime import datetime, timedelta
 import pytest
 from ruamel.yaml import YAML
 
@@ -60,6 +61,36 @@ def test_reserved_properties():
         })
 
 
+def test_timestamp_override():
+    """
+    Simple test for overriding timestamp
+    """
+    schema = {
+        '$id': 'test/test',
+        'version': 1,
+        'properties': {
+            'something': {
+                'type': 'string'
+            },
+        },
+    }
+
+    output = io.StringIO()
+    handler = logging.StreamHandler(output)
+    el = EventLog(handlers=[handler])
+    el.register_schema(schema)
+    el.allowed_schemas = ['test/test']
+
+    timestamp_override = datetime.utcnow() - timedelta(days=1)
+    el.record_event('test/test', 1, {
+        'something': 'blah',
+    }, timestamp_override=timestamp_override)
+    handler.flush()
+
+    event_capsule = json.loads(output.getvalue())
+
+    assert event_capsule['__timestamp__'] == timestamp_override.isoformat() + 'Z'
+
 def test_record_event():
     """
     Simple test for emitting valid events