🔨 added comments

it-at-m · Jul 31, 2024 · 4eabc0c · 4eabc0c
1 parent 34602a5
commit 4eabc0c
Show file tree

Hide file tree

Showing 3 changed files with 10 additions and 6 deletions.
diff --git a/app/frontend/src/i18n.ts b/app/frontend/src/i18n.ts
@@ -527,7 +527,7 @@ i18n
                             favourites: "Favoriten",
                             save: "Zu Favoritn hinzufügn",
                             unsave: "Vo Favoritn entfernen",
-                            error: "Wechsle de Seiten ned bevor ned de nachricht komplett generiert wordn is!"
+                            error: "Wechsle de Seiten ned bevor ned de Nachricht komplett generiert wordn is!"
                         }
                     }
                 }

diff --git a/app/frontend/src/pages/chat/Chat.tsx b/app/frontend/src/pages/chat/Chat.tsx
@@ -12,7 +12,7 @@ import { ClearChatButton } from "../../components/ClearChatButton";
 import { LanguageContext } from "../../components/LanguageSelector/LanguageContextProvider";
 import { useTranslation } from 'react-i18next';
 import { ChatsettingsDrawer } from "../../components/ChatsettingsDrawer";
-import { indexedDBStorage, saveToDB, getStartDataFromDB, popLastMessageInDB, getHighestKeyInDB, deleteChatFromDB, getZeroChat, changeTemperatureInDb, changeMaxTokensInDb, changeSystempromptInDb, CURRENT_CHAT_IN_DB, checkStructurOfDB } from "../../service/storage"
+import { indexedDBStorage, saveToDB, getStartDataFromDB, popLastMessageInDB, getHighestKeyInDB, deleteChatFromDB, getCurrentChatID, changeTemperatureInDb, changeMaxTokensInDb, changeSystempromptInDb, CURRENT_CHAT_IN_DB, checkStructurOfDB } from "../../service/storage"
 import { History } from "../../components/History/History";
 import useDebounce from "../../hooks/debouncehook";
 import { MessageError } from "./MessageError";
@@ -74,7 +74,7 @@ const Chat = () => {
         setAnswers([]);
         lastQuestionRef.current = "";
         getHighestKeyInDB(storage).then((highestKey) => {
-            getZeroChat(storage).then((refID) => {
+            getCurrentChatID(storage).then((refID) => {
                 error && setError(undefined);
                 setIsLoading(true);
                 let key;
@@ -86,10 +86,10 @@ const Chat = () => {
                 setIdCounter(key)
                 setCurrentId(key)
                 getStartDataFromDB(storage, key).then((stored) => {
-                    if (stored) {
+                    if (stored) {// if the chat exists
                         let storedAnswers = stored.Data.Answers;
                         lastQuestionRef.current = storedAnswers[storedAnswers.length - 1][0];
-                        if (storedAnswers[storedAnswers.length - 1][1].answer == "") {
+                        if (storedAnswers[storedAnswers.length - 1][1].answer == "") {// if the answer of the LLM has not (yet) returned
                             if (storedAnswers.length > 1) {
                                 storedAnswers.pop();
                                 setAnswers([...answers.concat(storedAnswers)]);

diff --git a/app/frontend/src/service/storage.ts b/app/frontend/src/service/storage.ts
@@ -47,6 +47,7 @@ export async function saveToDB(
             let dataID;
             let result = stored.result;
             if (result) {
+                // if the chat allready exist in the DB
                 dataID = result.id;
                 let storedAnswers = result.Data.Answers;
                 if (storedAnswers[storedAnswers.length - 1][1].answer == "") {
@@ -62,13 +63,15 @@ export async function saveToDB(
                 }
                 data = result;
             } else {
+                // if the chat does not exist in the DB
                 let name: string = "";
                 let new_idcounter = id_counter;
                 if (language != undefined && temperature != undefined && system_message != undefined && max_tokens != undefined) {
                     name = await (await getChatName(a, language, temperature, system_message, max_tokens)).content;
                     name = name.replaceAll('"', "").replaceAll(".", "");
                 }
                 if (storage.objectStore_name === "chat") {
+                    // if this function is called by the chat the chat options are also saved
                     new_idcounter = new_idcounter + 1;
                     setIdCounter(new_idcounter);
                     data = {
@@ -216,7 +219,8 @@ export function getHighestKeyInDB(storage: indexedDBStorage): Promise<number> {
     });
 }
 
-export function getZeroChat(storage: indexedDBStorage): Promise<number | undefined> {
+export function getCurrentChatID(storage: indexedDBStorage): Promise<number | undefined> {
+    // This method returns the current chat ID or undefined if there is currently no chat in the chat window
     return new Promise((resolve, reject) => {
         let openRequest = indexedDB.open(storage.db_name, storage.db_version);
         openRequest.onupgradeneeded = () => onUpgrade(openRequest, storage);