From 2b97a2848824bbf861a96022305b0079784ba042 Mon Sep 17 00:00:00 2001
From: thiloho <123883702+thiloho@users.noreply.github.com>
Date: Fri, 13 Sep 2024 17:04:04 +0200
Subject: [PATCH] Create logs route

---
 web-app/package-lock.json                     |   7 +
 web-app/package.json                          |   1 +
 web-app/src/lib/components/Modal.svelte       |  11 +-
 .../src/lib/components/WebsiteEditor.svelte   |   5 +-
 web-app/src/lib/db-schema.ts                  |  86 ++++++----
 .../website/[websiteId]/+layout.server.ts     |  21 ++-
 .../website/[websiteId]/logs/+page.server.ts  |  72 ++++++++
 .../website/[websiteId]/logs/+page.svelte     | 156 ++++++++++++++++++
 web-app/template-styles/common-styles.css     |  10 ++
 9 files changed, 326 insertions(+), 43 deletions(-)
 create mode 100644 web-app/src/routes/(authenticated)/website/[websiteId]/logs/+page.server.ts
 create mode 100644 web-app/src/routes/(authenticated)/website/[websiteId]/logs/+page.svelte

diff --git a/web-app/package-lock.json b/web-app/package-lock.json
index 5553359..810a9fe 100644
--- a/web-app/package-lock.json
+++ b/web-app/package-lock.json
@@ -8,6 +8,7 @@
       "name": "web-app",
       "version": "0.0.1",
       "dependencies": {
+        "fast-diff": "1.3.0",
         "github-slugger": "2.0.0",
         "highlight.js": "11.10.0",
         "isomorphic-dompurify": "2.14.0",
@@ -2549,6 +2550,12 @@
       "dev": true,
       "license": "MIT"
     },
+    "node_modules/fast-diff": {
+      "version": "1.3.0",
+      "resolved": "https://registry.npmjs.org/fast-diff/-/fast-diff-1.3.0.tgz",
+      "integrity": "sha512-VxPP4NqbUjj6MaAOafWeUn2cXWLcCtljklUtZf0Ind4XQ+QPtmA0b18zZy0jIQx+ExRVCR/ZQpBmik5lXshNsw==",
+      "license": "Apache-2.0"
+    },
     "node_modules/fast-glob": {
       "version": "3.3.2",
       "resolved": "https://registry.npmjs.org/fast-glob/-/fast-glob-3.3.2.tgz",
diff --git a/web-app/package.json b/web-app/package.json
index 10947da..2a62160 100644
--- a/web-app/package.json
+++ b/web-app/package.json
@@ -38,6 +38,7 @@
   },
   "type": "module",
   "dependencies": {
+    "fast-diff": "1.3.0",
     "github-slugger": "2.0.0",
     "highlight.js": "11.10.0",
     "isomorphic-dompurify": "2.14.0",
diff --git a/web-app/src/lib/components/Modal.svelte b/web-app/src/lib/components/Modal.svelte
index 5a75b74..0f446c4 100644
--- a/web-app/src/lib/components/Modal.svelte
+++ b/web-app/src/lib/components/Modal.svelte
@@ -1,14 +1,19 @@
 <script lang="ts">
   import type { Snippet } from "svelte";
 
-  const { children, id, text }: { children: Snippet; id: string; text: string } = $props();
+  const {
+    children,
+    id,
+    text,
+    isWider = false
+  }: { children: Snippet; id: string; text: string; isWider?: boolean } = $props();
 
   const modalId = `${id}-modal`;
 </script>
 
 <a href={`#${modalId}`} role="button">{text}</a>
 
-<div id={modalId} class="modal">
+<div id={modalId} class="modal" style="--modal-width: {isWider ? 600 : 300}px">
   <div class="modal__content">
     {@render children()}
     <a href="#!" role="button">Close</a>
@@ -46,7 +51,7 @@
     background-color: var(--bg-primary);
     border-radius: var(--border-radius);
     border: var(--border-primary);
-    inline-size: 300px;
+    inline-size: var(--modal-width);
     max-inline-size: 100%;
     max-block-size: calc(100vh - var(--space-m));
     overflow-y: auto;
diff --git a/web-app/src/lib/components/WebsiteEditor.svelte b/web-app/src/lib/components/WebsiteEditor.svelte
index 6280bd6..0038b73 100644
--- a/web-app/src/lib/components/WebsiteEditor.svelte
+++ b/web-app/src/lib/components/WebsiteEditor.svelte
@@ -55,6 +55,9 @@
       <li>
         <a href="/website/{id}/publish">Publish</a>
       </li>
+      <li>
+        <a href="/website/{id}/logs">Logs</a>
+      </li>
     </ul>
   </nav>
 
@@ -120,13 +123,13 @@
     }
 
     .operations {
-      border-inline-end: var(--border-primary);
       padding-block-start: var(--space-s);
     }
 
     .preview {
       display: flex;
       padding-block-start: var(--space-s);
+      border-inline-start: var(--border-primary);
     }
   }
 </style>
diff --git a/web-app/src/lib/db-schema.ts b/web-app/src/lib/db-schema.ts
index 219493e..5292996 100644
--- a/web-app/src/lib/db-schema.ts
+++ b/web-app/src/lib/db-schema.ts
@@ -22,12 +22,12 @@ export interface Article {
   cover_image: string | null;
   publication_date: Date | null;
   main_content: string | null;
+  category: string | null;
+  article_weight: number | null;
   created_at: Date;
   last_modified_at: Date;
   last_modified_by: string | null;
   title_description_search: any | null;
-  category: string | null;
-  article_weight: number | null;
 }
 export interface ArticleInput {
   id?: string;
@@ -39,12 +39,12 @@ export interface ArticleInput {
   cover_image?: string | null;
   publication_date?: Date | null;
   main_content?: string | null;
+  category?: string | null;
+  article_weight?: number | null;
   created_at?: Date;
   last_modified_at?: Date;
   last_modified_by?: string | null;
   title_description_search?: any | null;
-  category?: string | null;
-  article_weight?: number | null;
 }
 const article = {
   tableName: "article",
@@ -58,12 +58,12 @@ const article = {
     "cover_image",
     "publication_date",
     "main_content",
+    "category",
+    "article_weight",
     "created_at",
     "last_modified_at",
     "last_modified_by",
-    "title_description_search",
-    "category",
-    "article_weight"
+    "title_description_search"
   ],
   requiredForInsert: ["website_id", "title"],
   primaryKey: "id",
@@ -71,8 +71,8 @@ const article = {
     website_id: { table: "website", column: "id", $type: null as unknown as Website },
     user_id: { table: "user", column: "id", $type: null as unknown as User },
     cover_image: { table: "media", column: "id", $type: null as unknown as Media },
-    last_modified_by: { table: "user", column: "id", $type: null as unknown as User },
-    category: { table: "docs_category", column: "id", $type: null as unknown as DocsCategory }
+    category: { table: "docs_category", column: "id", $type: null as unknown as DocsCategory },
+    last_modified_by: { table: "user", column: "id", $type: null as unknown as User }
   },
   $type: null as unknown as Article,
   $input: null as unknown as ArticleInput
@@ -80,26 +80,39 @@ const article = {
 
 // Table change_log
 export interface ChangeLog {
-  website_id: string;
-  user_id: string;
-  change_summary: string;
-  previous_value: Json | null;
-  new_value: Json | null;
-  timestamp: Date;
+  id: string;
+  website_id: string | null;
+  user_id: string | null;
+  tstamp: Date;
+  table_name: string;
+  operation: string;
+  old_value: any | null;
+  new_value: any | null;
 }
 export interface ChangeLogInput {
-  website_id: string;
-  user_id?: string;
-  change_summary: string;
-  previous_value?: Json | null;
-  new_value?: Json | null;
-  timestamp?: Date;
+  id?: string;
+  website_id?: string | null;
+  user_id?: string | null;
+  tstamp?: Date;
+  table_name: string;
+  operation: string;
+  old_value?: any | null;
+  new_value?: any | null;
 }
 const change_log = {
   tableName: "change_log",
-  columns: ["website_id", "user_id", "change_summary", "previous_value", "new_value", "timestamp"],
-  requiredForInsert: ["website_id", "change_summary"],
-  primaryKey: "website_id",
+  columns: [
+    "id",
+    "website_id",
+    "user_id",
+    "tstamp",
+    "table_name",
+    "operation",
+    "old_value",
+    "new_value"
+  ],
+  requiredForInsert: ["table_name", "operation"],
+  primaryKey: "id",
   foreignKeys: {
     website_id: { table: "website", column: "id", $type: null as unknown as Website },
     user_id: { table: "user", column: "id", $type: null as unknown as User }
@@ -153,6 +166,8 @@ export interface DocsCategory {
   user_id: string | null;
   category_name: string;
   category_weight: number;
+  last_modified_at: Date;
+  last_modified_by: string | null;
 }
 export interface DocsCategoryInput {
   id?: string;
@@ -160,15 +175,26 @@ export interface DocsCategoryInput {
   user_id?: string | null;
   category_name: string;
   category_weight: number;
+  last_modified_at?: Date;
+  last_modified_by?: string | null;
 }
 const docs_category = {
   tableName: "docs_category",
-  columns: ["id", "website_id", "user_id", "category_name", "category_weight"],
+  columns: [
+    "id",
+    "website_id",
+    "user_id",
+    "category_name",
+    "category_weight",
+    "last_modified_at",
+    "last_modified_by"
+  ],
   requiredForInsert: ["website_id", "category_name", "category_weight"],
   primaryKey: "id",
   foreignKeys: {
     website_id: { table: "website", column: "id", $type: null as unknown as Website },
-    user_id: { table: "user", column: "id", $type: null as unknown as User }
+    user_id: { table: "user", column: "id", $type: null as unknown as User },
+    last_modified_by: { table: "user", column: "id", $type: null as unknown as User }
   },
   $type: null as unknown as DocsCategory,
   $input: null as unknown as DocsCategoryInput
@@ -390,10 +416,10 @@ export interface Website {
   content_type: string;
   title: string;
   created_at: Date;
+  is_published: boolean;
   last_modified_at: Date;
   last_modified_by: string | null;
   title_search: any | null;
-  is_published: boolean;
 }
 export interface WebsiteInput {
   id?: string;
@@ -401,10 +427,10 @@ export interface WebsiteInput {
   content_type: string;
   title: string;
   created_at?: Date;
+  is_published?: boolean;
   last_modified_at?: Date;
   last_modified_by?: string | null;
   title_search?: any | null;
-  is_published?: boolean;
 }
 const website = {
   tableName: "website",
@@ -414,10 +440,10 @@ const website = {
     "content_type",
     "title",
     "created_at",
+    "is_published",
     "last_modified_at",
     "last_modified_by",
-    "title_search",
-    "is_published"
+    "title_search"
   ],
   requiredForInsert: ["content_type", "title"],
   primaryKey: "id",
diff --git a/web-app/src/routes/(authenticated)/website/[websiteId]/+layout.server.ts b/web-app/src/routes/(authenticated)/website/[websiteId]/+layout.server.ts
index 4e3cff9..560b904 100644
--- a/web-app/src/routes/(authenticated)/website/[websiteId]/+layout.server.ts
+++ b/web-app/src/routes/(authenticated)/website/[websiteId]/+layout.server.ts
@@ -1,17 +1,20 @@
 import type { LayoutServerLoad } from "./$types";
 import { API_BASE_PREFIX } from "$lib/server/utils";
 import { error } from "@sveltejs/kit";
-import type { Website, Home } from "$lib/db-schema";
+import type { Website, Home, User } from "$lib/db-schema";
 
 export const load: LayoutServerLoad = async ({ params, fetch, cookies }) => {
-  const websiteData = await fetch(`${API_BASE_PREFIX}/website?id=eq.${params.websiteId}`, {
-    method: "GET",
-    headers: {
-      "Content-Type": "application/json",
-      Authorization: `Bearer ${cookies.get("session_token")}`,
-      Accept: "application/vnd.pgrst.object+json"
+  const websiteData = await fetch(
+    `${API_BASE_PREFIX}/website?id=eq.${params.websiteId}&select=*,user!user_id(username)`,
+    {
+      method: "GET",
+      headers: {
+        "Content-Type": "application/json",
+        Authorization: `Bearer ${cookies.get("session_token")}`,
+        Accept: "application/vnd.pgrst.object+json"
+      }
     }
-  });
+  );
 
   if (!websiteData.ok) {
     throw error(404, "Website not found");
@@ -26,7 +29,7 @@ export const load: LayoutServerLoad = async ({ params, fetch, cookies }) => {
     }
   });
 
-  const website: Website = await websiteData.json();
+  const website: Website & { user: { username: User["username"] } } = await websiteData.json();
   const home: Home = await homeData.json();
 
   return {
diff --git a/web-app/src/routes/(authenticated)/website/[websiteId]/logs/+page.server.ts b/web-app/src/routes/(authenticated)/website/[websiteId]/logs/+page.server.ts
new file mode 100644
index 0000000..ab397b0
--- /dev/null
+++ b/web-app/src/routes/(authenticated)/website/[websiteId]/logs/+page.server.ts
@@ -0,0 +1,72 @@
+import type { PageServerLoad } from "./$types";
+import { API_BASE_PREFIX } from "$lib/server/utils";
+import type { ChangeLog, User, Collab } from "$lib/db-schema";
+
+export const load: PageServerLoad = async ({ parent, fetch, params, cookies, url }) => {
+  const userFilter = url.searchParams.get("logs_filter_user");
+  const resourceFilter = url.searchParams.get("logs_filter_resource");
+  const operationFilter = url.searchParams.get("logs_filter_operation");
+
+  const searchParams = new URLSearchParams();
+
+  const baseFetchUrl = `${API_BASE_PREFIX}/change_log?website_id=eq.${params.websiteId}&select=id,table_name,operation,tstamp,old_value,new_value,user!inner(username)&order=tstamp.desc`;
+
+  if (userFilter && userFilter !== "all") {
+    searchParams.append("user.username", `eq.${userFilter}`);
+  }
+
+  if (resourceFilter && resourceFilter !== "all") {
+    searchParams.append("table_name", `eq.${resourceFilter}`);
+  }
+
+  if (operationFilter && operationFilter !== "all") {
+    searchParams.append("operation", `eq.${operationFilter.toUpperCase()}`);
+  }
+
+  const constructedFetchUrl = `${baseFetchUrl}&${searchParams.toString()}`;
+
+  const changeLogData = await fetch(constructedFetchUrl, {
+    method: "GET",
+    headers: {
+      "Content-Type": "application/json",
+      Authorization: `Bearer ${cookies.get("session_token")}`
+    }
+  });
+
+  const resultChangeLogData = await fetch(constructedFetchUrl, {
+    method: "HEAD",
+    headers: {
+      "Content-Type": "application/json",
+      Authorization: `Bearer ${cookies.get("session_token")}`,
+      Prefer: "count=exact"
+    }
+  });
+
+  const resultChangeLogCount = Number(
+    resultChangeLogData.headers.get("content-range")?.split("/").at(-1)
+  );
+
+  const collabData = await fetch(
+    `${API_BASE_PREFIX}/collab?website_id=eq.${params.websiteId}&select=*,user!user_id(*)&order=last_modified_at.desc,added_at.desc`,
+    {
+      method: "GET",
+      headers: {
+        "Content-Type": "application/json",
+        Authorization: `Bearer ${cookies.get("session_token")}`
+      }
+    }
+  );
+
+  const changeLog: (ChangeLog & { user: { username: User["username"] } })[] =
+    await changeLogData.json();
+  const collaborators: (Collab & { user: User })[] = await collabData.json();
+  const { website, home } = await parent();
+
+  return {
+    changeLog,
+    resultChangeLogCount,
+    website,
+    home,
+    collaborators
+  };
+};
diff --git a/web-app/src/routes/(authenticated)/website/[websiteId]/logs/+page.svelte b/web-app/src/routes/(authenticated)/website/[websiteId]/logs/+page.svelte
new file mode 100644
index 0000000..1fa4ca3
--- /dev/null
+++ b/web-app/src/routes/(authenticated)/website/[websiteId]/logs/+page.svelte
@@ -0,0 +1,156 @@
+<script lang="ts">
+  import WebsiteEditor from "$lib/components/WebsiteEditor.svelte";
+  import DateTime from "$lib/components/DateTime.svelte";
+  import Modal from "$lib/components/Modal.svelte";
+  import type { PageServerData } from "./$types";
+  import diff from "fast-diff";
+  import { page } from "$app/stores";
+  import { tables } from "$lib/db-schema";
+
+  const { data }: { data: PageServerData } = $props();
+
+  const htmlDiff = (oldValue: string, newValue: string) => {
+    return diff(oldValue, newValue)
+      .map(([type, value]) => {
+        let newString = "";
+
+        switch (type) {
+          case 1:
+            newString += `<ins>${value}</ins>`;
+            break;
+          case 0:
+            newString += `${value}`;
+            break;
+          case -1:
+            newString += `<del>${value}</del>`;
+            break;
+        }
+
+        return newString;
+      })
+      .join("");
+  };
+
+  let resources = $state({});
+
+  if (data.website.content_type === "Blog") {
+    const { user, change_log, media, docs_category, ...restTables } = tables;
+    resources = restTables;
+  }
+
+  if (data.website.content_type === "Docs") {
+    const { user, change_log, media, ...restTables } = tables;
+    resources = restTables;
+  }
+</script>
+
+<WebsiteEditor
+  id={data.website.id}
+  contentType={data.website.content_type}
+  title={data.website.title}
+  previewContent={data.home.main_content}
+>
+  <section id="logs">
+    <hgroup>
+      <h2>
+        <a href="#logs">Logs</a>
+      </h2>
+      <p>
+        <strong>{data.resultChangeLogCount}</strong>
+        <small>results</small>
+      </p>
+    </hgroup>
+    <details>
+      <summary>Filter</summary>
+      <form method="GET">
+        <label>
+          Username:
+          <input
+            list="users-{data.website.id}"
+            name="logs_filter_user"
+            value={$page.url.searchParams.get("logs_filter_user")}
+          />
+          <datalist id="users-{data.website.id}">
+            <option value={data.website.user.username}></option>
+            {#each data.collaborators as { user: { username } }}
+              <option value={username}></option>
+            {/each}
+          </datalist>
+        </label>
+        <label>
+          Resource:
+          <select name="logs_filter_resource">
+            <option value="all">Show all</option>
+            {#each Object.keys(resources) as resource}
+              <option
+                value={resource}
+                selected={resource === $page.url.searchParams.get("logs_filter_resource")}
+                >{resource}</option
+              >
+            {/each}
+          </select>
+        </label>
+        <label>
+          Operation:
+          <select name="logs_filter_operation">
+            <option value="all">Show all</option>
+            <option
+              value="insert"
+              selected={"insert" === $page.url.searchParams.get("logs_filter_operation")}
+              >Insert</option
+            >
+            <option
+              value="update"
+              selected={"update" === $page.url.searchParams.get("logs_filter_operation")}
+              >Update</option
+            >
+            <option
+              value="delete"
+              selected={"delete" === $page.url.searchParams.get("logs_filter_operation")}
+              >Delete</option
+            >
+          </select>
+        </label>
+        <button type="submit">Submit</button>
+      </form>
+    </details>
+    <div class="scroll-container">
+      <table>
+        <thead>
+          <tr>
+            <th>User</th>
+            <th>Resource</th>
+            <th>Operation</th>
+            <th>Date and time</th>
+            <th>Changes</th>
+          </tr>
+        </thead>
+        <tbody>
+          {#each data.changeLog as { id, table_name, operation, tstamp, old_value, new_value, user }}
+            <tr>
+              <td>{user.username}</td>
+              <td>{table_name}</td>
+              <td>{operation}</td>
+              <td>
+                <DateTime date={tstamp} />
+              </td>
+              <td>
+                <Modal id="log-{id}" text="Show" isWider={true}>
+                  {@const oldValue = JSON.stringify(old_value, null, 2)}
+                  {@const newValue = JSON.stringify(new_value, null, 2)}
+
+                  <hgroup>
+                    <h3>Log changes</h3>
+                    <p>{table_name} &mdash; {operation}</p>
+                  </hgroup>
+
+                  <pre style="white-space: pre-wrap">{@html htmlDiff(oldValue, newValue)}</pre>
+                </Modal>
+              </td>
+            </tr>
+          {/each}
+        </tbody>
+      </table>
+    </div>
+  </section>
+</WebsiteEditor>
diff --git a/web-app/template-styles/common-styles.css b/web-app/template-styles/common-styles.css
index 10f090f..d79b454 100644
--- a/web-app/template-styles/common-styles.css
+++ b/web-app/template-styles/common-styles.css
@@ -331,3 +331,13 @@ td {
   padding: var(--space-2xs);
   border: var(--border-primary);
 }
+
+ins {
+  background-color: var(--color-success);
+  color: var(--color-text-invert);
+}
+
+del {
+  background-color: var(--color-error);
+  color: var(--color-text-invert);
+}