From aea68f1ecf517f04da638f199daac2fe5c4fb34a Mon Sep 17 00:00:00 2001
From: Pranav <pranav@chatwoot.com>
Date: Tue, 6 Aug 2024 20:58:04 -0700
Subject: [PATCH] feat: Update the design of the audit logs page (#9901)

This is continuation of the design update, updates the design for audit logs listing page.

---------

Co-authored-by: Sivin Varghese <64252451+iamsivin@users.noreply.github.com>
---
 .../layout/config/sidebarItems/settings.js    |   3 +-
 .../dashboard/helper/featureHelper.js         |  21 +-
 .../dashboard/i18n/locale/en/auditLogs.json   |  36 ++--
 .../dashboard/settings/auditlogs/Index.vue    | 180 ++++++++----------
 .../settings/auditlogs/audit.routes.js        |  11 +-
 5 files changed, 118 insertions(+), 133 deletions(-)

diff --git a/app/javascript/dashboard/components/layout/config/sidebarItems/settings.js b/app/javascript/dashboard/components/layout/config/sidebarItems/settings.js
index 390e8effa..e30c3bcb1 100644
--- a/app/javascript/dashboard/components/layout/config/sidebarItems/settings.js
+++ b/app/javascript/dashboard/components/layout/config/sidebarItems/settings.js
@@ -173,11 +173,10 @@ const settings = accountId => ({
       meta: {
         permissions: ['administrator'],
       },
-      toState: frontendURL(`accounts/${accountId}/settings/audit-log/list`),
+      toState: frontendURL(`accounts/${accountId}/settings/audit-logs/list`),
       toStateName: 'auditlogs_list',
       isEnterpriseOnly: true,
       featureFlag: FEATURE_FLAGS.AUDIT_LOGS,
-      beta: true,
     },
     {
       icon: 'document-list-clock',
diff --git a/app/javascript/dashboard/helper/featureHelper.js b/app/javascript/dashboard/helper/featureHelper.js
index fb514f806..5a5edba6d 100644
--- a/app/javascript/dashboard/helper/featureHelper.js
+++ b/app/javascript/dashboard/helper/featureHelper.js
@@ -1,18 +1,19 @@
 const FEATURE_HELP_URLS = {
+  agent_bots: 'https://chwt.app/hc/agent-bots',
+  audit_logs: 'https://chwt.app/hc/audit-logs',
+  campaigns: 'https://chwt.app/hc/campaigns',
+  canned_responses: 'https://chwt.app/hc/canned',
   channel_email: 'https://chwt.app/hc/email',
   channel_facebook: 'https://chwt.app/hc/fb',
-  help_center: 'https://chwt.app/hc/help-center',
-  agent_bots: 'https://chwt.app/hc/agent-bots',
-  team_management: 'https://chwt.app/hc/teams',
-  labels: 'https://chwt.app/hc/labels',
   custom_attributes: 'https://chwt.app/hc/custom-attributes',
-  canned_responses: 'https://chwt.app/hc/canned',
-  integrations: 'https://chwt.app/hc/integrations',
-  campaigns: 'https://chwt.app/hc/campaigns',
-  reports: 'https://chwt.app/hc/reports',
-  message_reply_to: 'https://chwt.app/hc/reply-to',
-  sla: 'https://chwt.app/hc/sla',
   dashboard_apps: 'https://chwt.app/hc/dashboard-apps',
+  help_center: 'https://chwt.app/hc/help-center',
+  integrations: 'https://chwt.app/hc/integrations',
+  labels: 'https://chwt.app/hc/labels',
+  message_reply_to: 'https://chwt.app/hc/reply-to',
+  reports: 'https://chwt.app/hc/reports',
+  sla: 'https://chwt.app/hc/sla',
+  team_management: 'https://chwt.app/hc/teams',
 };
 
 export function getHelpUrlForFeature(featureName) {
diff --git a/app/javascript/dashboard/i18n/locale/en/auditLogs.json b/app/javascript/dashboard/i18n/locale/en/auditLogs.json
index 8a3fa7715..e51579d29 100644
--- a/app/javascript/dashboard/i18n/locale/en/auditLogs.json
+++ b/app/javascript/dashboard/i18n/locale/en/auditLogs.json
@@ -3,6 +3,8 @@
     "HEADER": "Audit Logs",
     "HEADER_BTN_TXT": "Add Audit Logs",
     "LOADING": "Fetching Audit Logs",
+    "DESCRIPTION": "Audit Logs maintain a record of activities in your account, allowing you to track and audit your account, team, or services.",
+    "LEARN_MORE": "Learn more about audit logs",
     "SEARCH_404": "There are no items matching this query",
     "SIDEBAR_TXT": "<p><b>Audit Logs</b> </p><p> Audit Logs are trails for events and actions in a Chatwoot System. </p>",
     "LIST": {
@@ -50,22 +52,22 @@
       "ADD": "%{agentName} created a new team (#%{id})",
       "EDIT": "%{agentName} updated a team (#%{id})",
       "DELETE": "%{agentName} deleted a team (#%{id})"
-  },
-  "MACRO": {
-    "ADD": "%{agentName} created a new macro (#%{id})",
-    "EDIT": "%{agentName} updated a macro (#%{id})",
-    "DELETE": "%{agentName} deleted a macro (#%{id})"
-  },
-  "INBOX_MEMBER": {
-    "ADD": "%{agentName} added %{user} to the inbox(#%{inbox_id})",
-    "REMOVE": "%{agentName} removed %{user} from the inbox(#%{inbox_id})"
-  },
-  "TEAM_MEMBER": {
-    "ADD": "%{agentName} added %{user} to the team(#%{team_id})",
-    "REMOVE": "%{agentName} removed %{user} from the team(#%{team_id})"
-  },
-  "ACCOUNT": {
-    "EDIT": "%{agentName} updated the account configuration (#%{id})"
+    },
+    "MACRO": {
+      "ADD": "%{agentName} created a new macro (#%{id})",
+      "EDIT": "%{agentName} updated a macro (#%{id})",
+      "DELETE": "%{agentName} deleted a macro (#%{id})"
+    },
+    "INBOX_MEMBER": {
+      "ADD": "%{agentName} added %{user} to the inbox(#%{inbox_id})",
+      "REMOVE": "%{agentName} removed %{user} from the inbox(#%{inbox_id})"
+    },
+    "TEAM_MEMBER": {
+      "ADD": "%{agentName} added %{user} to the team(#%{team_id})",
+      "REMOVE": "%{agentName} removed %{user} from the team(#%{team_id})"
+    },
+    "ACCOUNT": {
+      "EDIT": "%{agentName} updated the account configuration (#%{id})"
+    }
   }
 }
-}
diff --git a/app/javascript/dashboard/routes/dashboard/settings/auditlogs/Index.vue b/app/javascript/dashboard/routes/dashboard/settings/auditlogs/Index.vue
index c6df5a87a..baaa90145 100644
--- a/app/javascript/dashboard/routes/dashboard/settings/auditlogs/Index.vue
+++ b/app/javascript/dashboard/routes/dashboard/settings/auditlogs/Index.vue
@@ -1,116 +1,104 @@
-<script>
-import { mapGetters } from 'vuex';
+<script setup>
 import { useAlert } from 'dashboard/composables';
 import { messageTimestamp } from 'shared/helpers/timeHelper';
+import { useStoreGetters, useStore } from 'dashboard/composables/store';
 import TableFooter from 'dashboard/components/widgets/TableFooter.vue';
+import BaseSettingsHeader from '../components/BaseSettingsHeader.vue';
 import {
   generateTranslationPayload,
   generateLogActionKey,
 } from 'dashboard/helper/auditlogHelper';
+import { computed, onMounted, watch } from 'vue';
+import { useI18n } from 'dashboard/composables/useI18n';
+import { useRoute, useRouter } from 'dashboard/composables/route';
 
-export default {
-  components: {
-    TableFooter,
-  },
-  beforeRouteEnter(to, from, next) {
-    // Fetch Audit Logs on page load without manual refresh
-    next(vm => {
-      vm.fetchAuditLogs();
-    });
-  },
-  data() {
-    return {
-      loading: {},
-      auditLogsAPI: {
-        message: '',
-      },
-    };
-  },
-  computed: {
-    ...mapGetters({
-      records: 'auditlogs/getAuditLogs',
-      uiFlags: 'auditlogs/getUIFlags',
-      meta: 'auditlogs/getMeta',
-      agentList: 'agents/getAgents',
-    }),
-  },
-  mounted() {
-    // Fetch API Call
-    this.$store.dispatch('agents/get');
-  },
-  methods: {
-    messageTimestamp,
-    fetchAuditLogs() {
-      const page = this.$route.query.page ?? 1;
-      this.$store.dispatch('auditlogs/fetch', { page }).catch(error => {
-        const errorMessage =
-          error?.message || this.$t('AUDIT_LOGS.API.ERROR_MESSAGE');
-        useAlert(errorMessage);
-      });
-    },
-    generateLogText(auditLogItem) {
-      const translationPayload = generateTranslationPayload(
-        auditLogItem,
-        this.agentList
-      );
-      const translationKey = generateLogActionKey(auditLogItem);
+const getters = useStoreGetters();
+const store = useStore();
+const router = useRouter();
+const records = computed(() => getters['auditlogs/getAuditLogs'].value);
+const uiFlags = computed(() => getters['auditlogs/getUIFlags'].value);
+const meta = computed(() => getters['auditlogs/getMeta'].value);
+const agentList = computed(() => getters['agents/getAgents'].value);
 
-      return this.$t(translationKey, translationPayload);
-    },
-    onPageChange(page) {
-      window.history.pushState({}, null, `${this.$route.path}?page=${page}`);
-      try {
-        this.$store.dispatch('auditlogs/fetch', { page });
-      } catch (error) {
-        const errorMessage =
-          error?.message || this.$t('AUDIT_LOGS.API.ERROR_MESSAGE');
-        useAlert(errorMessage);
-      }
-    },
-  },
+const { t } = useI18n();
+const route = useRoute();
+
+const routerPage = computed(() => Number(route.query.page ?? 1));
+
+const fetchAuditLogs = page => {
+  try {
+    store.dispatch('auditlogs/fetch', { page });
+  } catch (error) {
+    const errorMessage = error?.message || t('AUDIT_LOGS.API.ERROR_MESSAGE');
+    useAlert(errorMessage);
+  }
 };
+
+const generateLogText = auditLogItem => {
+  const translationPayload = generateTranslationPayload(
+    auditLogItem,
+    agentList.value
+  );
+  const translationKey = generateLogActionKey(auditLogItem);
+
+  return t(translationKey, translationPayload);
+};
+
+const onPageChange = page => {
+  router.push({ name: 'auditlogs_list', query: { page: page } });
+};
+
+onMounted(() => {
+  store.dispatch('agents/get');
+  fetchAuditLogs(routerPage.value);
+});
+
+watch(routerPage, (newPage, oldPage) => {
+  if (newPage !== oldPage) {
+    fetchAuditLogs(newPage);
+  }
+});
 </script>
 
 <template>
-  <div class="flex flex-col justify-between flex-1 p-4 overflow-auto">
-    <!-- List Audit Logs -->
-    <div>
-      <div>
-        <p
-          v-if="!uiFlags.fetchingList && !records.length"
-          class="flex flex-col items-center justify-center h-full"
-        >
-          {{ $t('AUDIT_LOGS.LIST.404') }}
-        </p>
-        <woot-loading-state
-          v-if="uiFlags.fetchingList"
-          :message="$t('AUDIT_LOGS.LOADING')"
-        />
+  <div class="flex-1 overflow-auto">
+    <BaseSettingsHeader
+      :title="$t('AUDIT_LOGS.HEADER')"
+      :description="$t('AUDIT_LOGS.DESCRIPTION')"
+      :link-text="$t('AUDIT_LOGS.LEARN_MORE')"
+      feature-name="audit_logs"
+    />
 
-        <table
-          v-if="!uiFlags.fetchingList && records.length"
-          class="w-full woot-table"
-        >
-          <colgroup>
-            <col class="w-3/5" />
-            <col />
-            <col />
-          </colgroup>
+    <div class="mt-6 flex-1 text-slate-700 dark:text-slate-300">
+      <woot-loading-state
+        v-if="uiFlags.fetchingList"
+        :message="$t('AUDIT_LOGS.LOADING')"
+      />
+      <p
+        v-else-if="!records.length"
+        class="flex flex-col items-center justify-center h-full text-base p-8"
+      >
+        {{ $t('AUDIT_LOGS.LIST.404') }}
+      </p>
+      <div v-else class="min-w-full overflow-x-auto">
+        <table class="divide-y divide-slate-75 dark:divide-slate-700">
           <thead>
-            <!-- Header -->
             <th
               v-for="thHeader in $t('AUDIT_LOGS.LIST.TABLE_HEADER')"
               :key="thHeader"
+              class="py-4 pr-4 text-left font-semibold text-slate-700 dark:text-slate-300"
             >
               {{ thHeader }}
             </th>
           </thead>
-          <tbody>
+          <tbody
+            class="divide-y divide-slate-50 dark:divide-slate-800 text-slate-700 dark:text-slate-300"
+          >
             <tr v-for="auditLogItem in records" :key="auditLogItem.id">
-              <td class="break-all whitespace-nowrap">
+              <td class="py-4 pr-4 break-all whitespace-nowrap">
                 {{ generateLogText(auditLogItem) }}
               </td>
-              <td class="break-all whitespace-nowrap">
+              <td class="py-4 pr-4 break-all whitespace-nowrap">
                 {{
                   messageTimestamp(
                     auditLogItem.created_at,
@@ -118,20 +106,20 @@ export default {
                   )
                 }}
               </td>
-              <td class="w-[8.75rem]">
+              <td class="py-4 w-[8.75rem]">
                 {{ auditLogItem.remote_address }}
               </td>
             </tr>
           </tbody>
         </table>
+        <TableFooter
+          :current-page="Number(meta.currentPage)"
+          :total-count="meta.totalEntries"
+          :page-size="meta.perPage"
+          class="border-slate-50 dark:border-slate-800 border-t !px-0 py-4"
+          @pageChange="onPageChange"
+        />
       </div>
     </div>
-    <TableFooter
-      :current-page="Number(meta.currentPage)"
-      :total-count="meta.totalEntries"
-      :page-size="meta.perPage"
-      class="!bg-slate-25 dark:!bg-slate-900 border-t border-slate-75 dark:border-slate-700/50"
-      @pageChange="onPageChange"
-    />
   </div>
 </template>
diff --git a/app/javascript/dashboard/routes/dashboard/settings/auditlogs/audit.routes.js b/app/javascript/dashboard/routes/dashboard/settings/auditlogs/audit.routes.js
index acf061288..51561ca0c 100644
--- a/app/javascript/dashboard/routes/dashboard/settings/auditlogs/audit.routes.js
+++ b/app/javascript/dashboard/routes/dashboard/settings/auditlogs/audit.routes.js
@@ -1,18 +1,13 @@
 import { frontendURL } from '../../../../helper/URLHelper';
 
-const SettingsContent = () => import('../Wrapper.vue');
+const SettingsWrapper = () => import('../SettingsWrapper.vue');
 const AuditLogsHome = () => import('./Index.vue');
 
 export default {
   routes: [
     {
-      path: frontendURL('accounts/:accountId/settings/audit-log'),
-      component: SettingsContent,
-      props: {
-        headerTitle: 'AUDIT_LOGS.HEADER',
-        icon: 'key',
-        showNewButton: false,
-      },
+      path: frontendURL('accounts/:accountId/settings/audit-logs'),
+      component: SettingsWrapper,
       children: [
         {
           path: '',