BaseChatInterface: get_canonical_template_keys as a default template keys list

esbmc_ai/chats/base_chat_interface.py

@@ -3,8 +3,7 @@
 """Contains code for the base class for interacting with the LLMs in a 
 conversation-based way."""
 
-from abc import abstractmethod
-from typing import Optional
+from typing import Any, Optional
 
 from langchain.schema import (
     BaseMessage,
@@ -33,10 +32,9 @@ def __init__(
         self.messages: list[BaseMessage] = []
         self.llm: BaseChatModel = llm
 
-    @abstractmethod
     def compress_message_stack(self) -> None:
         """Compress the message stack, is abstract and needs to be implemented."""
-        raise NotImplementedError()
+        self.messages = []
 
     def push_to_message_stack(
         self,
@@ -48,6 +46,17 @@ def push_to_message_stack(
         else:
             self.messages.append(message)
 
+    def get_canonical_template_keys(
+        self, source_code: str, esbmc_output: str, error_line: str, error_type: str
+    ) -> dict[str, Any]:
+        """Gets the canonical template keys for applying in template values."""
+        return {
+            source_code: source_code,
+            esbmc_output: esbmc_output,
+            error_line: error_line,
+            error_type: error_type,
+        }
+
     def apply_template_value(self, **kwargs: str) -> None:
         """Will substitute an f-string in the message stack and system messages to
         the provided value. The new substituted messages will become the new

esbmc_ai/chats/solution_generator.py

@@ -220,10 +220,12 @@ def generate_solution(
 
         # Apply template substitution to message stack
         self.apply_template_value(
-            source_code=self.source_code_formatted,
-            esbmc_output=self.esbmc_output,
-            error_line=str(self.verifier.get_error_line(self.esbmc_output)),
-            error_type=error_type if error_type else "unknown error",
+            *self.get_canonical_template_keys(
+                source_code=self.source_code_formatted,
+                esbmc_output=self.esbmc_output,
+                error_line=str(self.verifier.get_error_line(self.esbmc_output)),
+                error_type=error_type if error_type else "unknown error",
+            )
         )
 
         # Generate the solution

esbmc_ai/chats/user_chat.py

@@ -12,6 +12,7 @@
 
 
 from esbmc_ai.ai_models import AIModel
+from esbmc_ai.solution import Solution
 from esbmc_ai.verifiers.base_source_verifier import BaseSourceVerifier
 
 from .base_chat_interface import BaseChatInterface
@@ -21,14 +22,12 @@ class UserChat(BaseChatInterface):
     """Simple interface that talks to the LLM and stores the result. The class
     also stores the fixed results from fix code command."""
 
-    solution: str = ""
-
     def __init__(
         self,
         ai_model: AIModel,
         llm: BaseChatModel,
         verifier: BaseSourceVerifier,
-        source_code: str,
+        solution: Solution,
         esbmc_output: str,
         system_messages: list[BaseMessage],
         set_solution_messages: list[BaseMessage],
@@ -38,20 +37,21 @@ def __init__(
             ai_model=ai_model,
             llm=llm,
         )
-
         # Store source code and esbmc output in order to substitute it into the message stack.
-        self.source_code: str = source_code
+        self.solution: Solution = solution
         self.esbmc_output: str = esbmc_output
         # The messsages for setting a new solution to the source code.
         self.set_solution_messages = set_solution_messages
 
         error_type: Optional[str] = verifier.get_error_type(self.esbmc_output)
 
         self.apply_template_value(
-            source_code=self.source_code,
-            esbmc_output=self.esbmc_output,
-            error_line=str(verifier.get_error_line(self.esbmc_output)),
-            error_type=error_type if error_type else "unknown error",
+            *self.get_canonical_template_keys(
+                source_code=self.solution.files[0].content,
+                esbmc_output=self.esbmc_output,
+                error_line=str(verifier.get_error_line(self.esbmc_output)),
+                error_type=error_type if error_type else "unknown error",
+            )
         )
 
     def set_solution(self, source_code: str) -> None: