41-unique-log-id

distill/core/log.py

@@ -18,6 +18,7 @@
 from pydantic import BaseModel
 from pydantic.type_adapter import TypeAdapter
 from typing import Dict, Union
+from pksuid import PKSUID
 
 from distill.core.types import JsonDict, JSONSerializable
 from distill.schemas.userale import UserAleSchema
@@ -39,14 +40,17 @@ def __init__(self, data: Union[str, JsonDict], schema=UserAleSchema):
 
         if isinstance(data, str):
             schema.model_validate_json(data, strict=True)
+            hash_sfx = str(hash(data))
             data = json.loads(data)
         elif ta.validate_python(data):
+            hash_sfx = str(hash(json.dumps(data)))
             schema.model_validate(data, strict=True)
         else:
             raise TypeError("ERROR: " + str(type(data)) + " data should be either a string or a JsonDict")
         self.data = schema(**data)
 
-        # TODO: need to create ID field here on object initialization
+        self.id = PKSUID("log_" + hash_sfx, schema._timestamp(self.data))
+
 
     def to_json(self) -> str:
         return self.data.model_dump_json(by_alias=True)

distill/schemas/base.py

@@ -0,0 +1,31 @@
+#
+# Licensed to the Apache Software Foundation (ASF) under one or more
+# contributor license agreements.  See the NOTICE file distributed with
+# this work for additional information regarding copyright ownership.
+# The ASF licenses this file to You under the Apache License, Version 2.0
+# (the "License"); you may not use this file except in compliance with
+# the License.  You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+import abc
+
+from enum import Enum
+from typing import List, Optional
+
+from pydantic import AliasGenerator, BaseModel, Field
+from pydantic.alias_generators import to_camel
+from pydantic.config import ConfigDict
+
+
+class BaseSchema(BaseModel, abc.ABC):
+    @property
+    @abc.abstractmethod
+    def _timestamp(self):
+        pass
+

distill/schemas/userale.py

@@ -14,10 +14,13 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 from typing import List, Optional
+from datetime import datetime
 
 from pydantic import AliasGenerator, BaseModel, Field, field_serializer, field_validator
 from pydantic.alias_generators import to_camel
 from pydantic.config import ConfigDict
+
+from .base import BaseSchema
 from datetime import datetime
 
 
@@ -40,7 +43,7 @@ class Details(BaseModel):
     window: bool
 
 
-class UserAleSchema(BaseModel):
+class UserAleSchema(BaseSchema):
     """
     A raw or custom log produced by UserAle
     """
@@ -80,3 +83,5 @@ def validate_ct(cls, ct: float):
     def serialize_ct(self, ct: datetime):
         return int(ct.timestamp() * 1000)
 
+    def _timestamp(self):
+        return self.client_time.timestamp()

pyproject.toml

@@ -51,6 +51,8 @@ matplotlib = "3.7.5"
 scipy = "1.9.3"
 pydantic = "^2.7.4"
 dateparser = "^1.2.0"
+pksuid = "^1.1.2"
+datetime = "^5.5"
 
 [tool.poetry.group.docs]
 optional = true

tests/test_log.py

@@ -44,6 +44,10 @@ def test_log_constructor():
     pageUrl = test_log.data.page_url
     assert pageUrl == "https://github.com/apache/flagon/tree/master/docker"
 
+    id = test_log.id
+    assert id.get_timestamp() == 1719530111079 // 1000
+    assert id.prefix.startswith("log_")
+
 
 def test_log_serialize():
     data = load_log()