Merge pull request #597

Make uuid predictable in debug-mode

Author: drazvan

nemoguardrails/actions/v2_x/generation.py

@@ -34,7 +34,6 @@
     remove_action_intent_identifiers,
 )
 from nemoguardrails.colang.v2_x.lang.colang_ast import Flow
-from nemoguardrails.colang.v2_x.lang.utils import new_uuid
 from nemoguardrails.colang.v2_x.runtime.errors import LlmResponseError
 from nemoguardrails.colang.v2_x.runtime.flows import ActionEvent, InternalEvent
 from nemoguardrails.colang.v2_x.runtime.statemachine import (
@@ -49,6 +48,7 @@
 from nemoguardrails.llm.filters import colang
 from nemoguardrails.llm.params import llm_params
 from nemoguardrails.llm.types import Task
+from nemoguardrails.utils import new_uuid
 
 log = logging.getLogger(__name__)
 

nemoguardrails/cli/__init__.py

@@ -28,6 +28,7 @@
 from nemoguardrails.eval.cli.simplify_formatter import SimplifyFormatter
 from nemoguardrails.logging.verbose import set_verbose
 from nemoguardrails.server import api
+from nemoguardrails.utils import init_random_seed
 
 app = typer.Typer()
 app.add_typer(evaluate.app, name="evaluate", short_help="Run an evaluation task.")
@@ -83,6 +84,9 @@ def chat(
     # This means that the user doesn't have to use both options at the same time.
     verbose = verbose or verbose_no_llm or len(debug_level) > 0
 
+    if len(debug_level) > 0 or os.environ.get("DEBUG_MODE"):
+        init_random_seed(0)
+
     if verbose:
         set_verbose(
             True,

nemoguardrails/cli/chat.py

@@ -26,7 +26,7 @@
 from nemoguardrails.logging import verbose
 from nemoguardrails.logging.verbose import console
 from nemoguardrails.streaming import StreamingHandler
-from nemoguardrails.utils import new_event_dict, new_uid
+from nemoguardrails.utils import new_event_dict, new_uuid
 
 os.environ["TOKENIZERS_PARALLELISM"] = "false"
 
@@ -489,7 +489,7 @@ async def _process_input_events():
                         new_event_dict(
                             "UtteranceUserActionFinished",
                             final_transcript=user_message,
-                            action_uid=new_uid(),
+                            action_uid=new_uuid(),
                             is_success=True,
                         )
                     ]

nemoguardrails/colang/v1_0/lang/utils.py

@@ -382,14 +382,6 @@ def parse_package_name(text):
     return package_name
 
 
-def new_uuid() -> str:
-    """Helper to generate new UUID v4.
-
-    In testing mode, it will generate a predictable set of UUIDs to help debugging.
-    """
-    return str(uuid.uuid4())
-
-
 def string_hash(s):
     """A simple string hash with an equivalent implementation in javascript.
 

nemoguardrails/colang/v2_x/lang/utils.py

@@ -13,19 +13,10 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-import uuid
 from dataclasses import asdict, is_dataclass
 from typing import Any
 
 
-def new_uuid() -> str:
-    """Helper to generate new UUID v4.
-
-    In testing mode, it will generate a predictable set of UUIDs to help debugging.
-    """
-    return str(uuid.uuid4())
-
-
 def dataclass_to_dict(obj: Any) -> Any:
     if is_dataclass(obj):
         return {k: dataclass_to_dict(v) for k, v in asdict(obj).items()}

nemoguardrails/colang/v2_x/runtime/eval.py

@@ -28,7 +28,7 @@
 from nemoguardrails.colang.v2_x.runtime.flows import FlowState, State
 from nemoguardrails.colang.v2_x.runtime.utils import AttributeDict
 from nemoguardrails.eval.cli.simplify_formatter import SimplifyFormatter
-from nemoguardrails.utils import new_uid
+from nemoguardrails.utils import new_uuid
 
 log = logging.getLogger(__name__)
 
@@ -143,7 +143,7 @@ def eval_expression(expr: str, context: dict) -> Any:
                 "regex": _create_regex,
                 "search": _regex_search,
                 "find_all": _regex_findall,
-                "uid": new_uid,
+                "uid": new_uuid,
                 "pretty_str": _pretty_str,
                 "escape": _escape_string,
                 "is_int": _is_int,

nemoguardrails/colang/v2_x/runtime/flows.py

@@ -34,7 +34,7 @@
 )
 from nemoguardrails.colang.v2_x.runtime.errors import ColangSyntaxError
 from nemoguardrails.colang.v2_x.runtime.utils import new_readable_uid
-from nemoguardrails.utils import new_uid
+from nemoguardrails.utils import new_uuid
 
 log = logging.getLogger(__name__)
 
@@ -197,7 +197,7 @@ def __init__(
         self, name: str, arguments: Dict[str, Any], flow_uid: Optional[str] = None
     ) -> None:
         # The unique id of the action
-        self.uid: str = new_uid()
+        self.uid: str = new_uuid()
 
         # Name of the action
         self.name = name

nemoguardrails/colang/v2_x/runtime/statemachine.py

@@ -71,12 +71,10 @@
     State,
 )
 from nemoguardrails.colang.v2_x.runtime.utils import new_readable_uid
-from nemoguardrails.utils import console, new_event_dict, new_uid
+from nemoguardrails.utils import console, new_event_dict, new_uuid
 
 log = logging.getLogger(__name__)
 
-random_seed = int(time.time())
-
 
 def initialize_state(state: State) -> None:
     """
@@ -126,13 +124,13 @@ def create_flow_instance(
     """Create a new flow instance that can be added."""
     loop_uid: Optional[str] = None
     if flow_config.loop_type == InteractionLoopType.NEW:
-        loop_uid = new_uid()
+        loop_uid = new_uuid()
     elif flow_config.loop_type == InteractionLoopType.NAMED:
         assert flow_config.loop_id is not None
         loop_uid = flow_config.loop_id
     # For type InteractionLoopType.PARENT we keep it None to infer loop_id at run_time from parent
 
-    head_uid = new_uid()
+    head_uid = new_uuid()
     flow_state = FlowState(
         uid=flow_instance_uid,
         flow_id=flow_config.id,
@@ -1068,7 +1066,7 @@ def slide(
             flow_state.head_fork_uids[element.fork_uid] = head.uid
             # We create the new child heads
             for _idx, label in enumerate(element.labels):
-                parent_fork_head_uid = new_uid()
+                parent_fork_head_uid = new_uuid()
                 pos = flow_config.element_labels[label]
                 new_head = FlowHead(
                     uid=parent_fork_head_uid,
@@ -1354,7 +1352,7 @@ def _start_flow(state: State, flow_state: FlowState, event_arguments: dict) -> N
         loop_id = state.flow_configs[flow_state.flow_id].loop_id
         if loop_id is not None:
             if loop_id == "NEW":
-                flow_state.loop_id = new_uid()
+                flow_state.loop_id = new_uuid()
             else:
                 flow_state.loop_id = loop_id
         else:
@@ -1543,7 +1541,7 @@ def _finish_flow(
     # TODO: Refactor this to use event based mechanics (START_FLOW)
     if flow_state.flow_id == "main":
         # Find an active head
-        head_uid = new_uid()
+        head_uid = new_uuid()
         new_head = FlowHead(
             uid=head_uid,
             flow_state_uid=flow_state.uid,

nemoguardrails/library/activefence/actions.py

@@ -20,7 +20,7 @@
 import aiohttp
 
 from nemoguardrails.actions import action
-from nemoguardrails.colang.v1_0.lang.utils import new_uuid
+from nemoguardrails.utils import new_uuid
 
 log = logging.getLogger(__name__)
 

nemoguardrails/rails/llm/llmrails.py

@@ -32,7 +32,6 @@
 from nemoguardrails.colang import parse_colang_file
 from nemoguardrails.colang.v1_0.runtime.flows import compute_context
 from nemoguardrails.colang.v1_0.runtime.runtime import Runtime, RuntimeV1_0
-from nemoguardrails.colang.v2_x.lang.utils import new_uuid
 from nemoguardrails.colang.v2_x.runtime.flows import Action, State
 from nemoguardrails.colang.v2_x.runtime.runtime import RuntimeV2_x
 from nemoguardrails.colang.v2_x.runtime.serialization import (
@@ -62,7 +61,7 @@
 )
 from nemoguardrails.rails.llm.utils import get_history_cache_key
 from nemoguardrails.streaming import StreamingHandler
-from nemoguardrails.utils import get_or_create_event_loop, new_event_dict
+from nemoguardrails.utils import get_or_create_event_loop, new_event_dict, new_uuid
 
 log = logging.getLogger(__name__)
 

nemoguardrails/streaming.py

@@ -23,7 +23,7 @@
 from langchain.schema.messages import AIMessageChunk
 from langchain.schema.output import ChatGenerationChunk, GenerationChunk, LLMResult
 
-from nemoguardrails.colang.v1_0.lang.utils import new_uuid
+from nemoguardrails.utils import new_uuid
 
 log = logging.getLogger(__name__)
 

nemoguardrails/utils.py

@@ -17,23 +17,37 @@
 import importlib.resources as pkg_resources
 import json
 import os
+import random
 import uuid
 from collections import namedtuple
 from datetime import datetime, timezone
 from enum import Enum
-from typing import Any, Dict, List, Tuple, Union
+from typing import Any, Dict, Tuple
 
 import yaml
 from rich.console import Console
 
 # Global console object to be used throughout the code base.
 console = Console()
 
+secure_random = random.SystemRandom()
 
-def new_uid() -> str:
-    """Helper to create a new UID."""
 
-    return str(uuid.uuid4())
+def init_random_seed(seed: int) -> None:
+    """Init random generator with seed."""
+    global secure_random
+    random.seed(seed)
+    secure_random = random
+
+
+def new_uuid() -> str:
+    """Helper to generate new UUID v4.
+
+    In testing mode, it will generate a predictable set of UUIDs to help debugging if random seed was set dependent on
+    the environment variable DEBUG_MODE.
+    """
+    random_bits = secure_random.getrandbits(128)
+    return str(uuid.UUID(int=random_bits, version=4))
 
 
 # Very basic event validation - will be replaced by validation based on pydantic models
@@ -134,7 +148,7 @@ def _update_action_properties(event_dict: Dict[str, Any]) -> None:
         event_dict["action_started_at"] = datetime.now(timezone.utc).isoformat()
     elif "Start" in event_dict["type"]:
         if "action_uid" not in event_dict:
-            event_dict["action_uid"] = new_uid()
+            event_dict["action_uid"] = new_uuid()
     elif "Updated" in event_dict["type"]:
         event_dict["action_updated_at"] = datetime.now(timezone.utc).isoformat()
     elif "Finished" in event_dict["type"]:
@@ -166,7 +180,7 @@ def new_event_dict(event_type: str, **payload) -> Dict[str, Any]:
 
     event: Dict[str, Any] = {
         "type": event_type,
-        "uid": new_uid(),
+        "uid": new_uuid(),
         "event_created_at": datetime.now(timezone.utc).isoformat(),
         "source_uid": "NeMoGuardrails",
     }