Add Severity and Event Type filters to Bulk Install

Author: bdukes

DNN Platform/Modules/BulkInstall/App_LocalResources/BulkInstall.resx

@@ -303,4 +303,7 @@
   <data name="PlatformVersion" xml:space="preserve">
     <value>Platform Version</value>
   </data>
+  <data name="All" xml:space="preserve">
+    <value>All</value>
+  </data>
 </root>

DNN Platform/Modules/BulkInstall/BulkInstall.Web/src/clients/event-log-client.ts

@@ -11,8 +11,10 @@ export class EventLogClient {
     this.requestUrl = this.sf.getServiceRoot('BulkInstall') + 'EventLog/';
   }
 
-  public async browse(pageIndex = 0): Promise<BrowseResponse> {
-    const response = await fetch(`${this.requestUrl}Browse?pageIndex=${pageIndex}`, {
+  public async browse(pageIndex = 0, severity?: EventLogSeverityInfo, eventType?: string): Promise<BrowseResponse> {
+    const severityParam = severity ? `&severity=${severity.eventLogSeverityKey}` : '';
+    const eventTypeParam = eventType ? `&eventType=${eventType}` : '';
+    const response = await fetch(`${this.requestUrl}Browse?pageIndex=${pageIndex}${severityParam}${eventTypeParam}`, {
       headers: this.sf.getModuleHeaders(),
     });
     const responseBody = (await response.json()) as ResponseBody;
@@ -22,6 +24,11 @@ export class EventLogClient {
     };
   }
 
+  public async getEventTypes(): Promise<string[]> {
+    const response = await fetch(`${this.requestUrl}EventTypes`, { headers: this.sf.getModuleHeaders() });
+    return (await response.json()) as string[];
+  }
+
   private static toSeverity(severity: EventLogSeverityResponse): EventLogSeverityInfo {
     switch (severity) {
       case EventLogSeverityResponse.Info:
@@ -50,11 +57,6 @@ export class EventLogClient {
     return {
       currentPage: pagination.CurrentPage,
       pages: pagination.Pages,
-      records: pagination.Records,
-      navigation: {
-        next: pagination.Navigation.Next,
-        previous: pagination.Navigation.Previous,
-      },
     };
   }
 }
@@ -65,13 +67,8 @@ export interface BrowseResponse {
 }
 
 export interface Pagination {
-  records: number;
   pages: number;
   currentPage: number;
-  navigation: {
-    previous?: string;
-    next?: string;
-  };
 }
 
 interface ResponseBody {
@@ -80,13 +77,8 @@ interface ResponseBody {
 }
 
 interface PaginationResponse {
-  Records: number;
   Pages: number;
   CurrentPage: number;
-  Navigation: {
-    Previous?: string;
-    Next?: string;
-  };
 }
 
 interface EventLogResponse {

DNN Platform/Modules/BulkInstall/BulkInstall.Web/src/clients/localization-client.ts

@@ -28,6 +28,7 @@ export class LocalizationClient {
 export interface BulkInstallLocalization {
   Action: string;
   Add: string;
+  All: string;
   ApiError: string;
   ApiAuthDisabled: string;
   ApiKey: string;

DNN Platform/Modules/BulkInstall/BulkInstall.Web/src/components/tabs/dnn-bi-logs/dnn-bi-logs.scss

@@ -57,6 +57,12 @@
     width: fit-content;
   }
 
+  .filters {
+    display: flex;
+    justify-content: end;
+    gap: 1em;
+  }
+
   /* Table styling */
   .table {
     width: 100%;

DNN Platform/Modules/BulkInstall/BulkInstall.Web/src/components/tabs/dnn-bi-logs/dnn-bi-logs.tsx

@@ -2,6 +2,7 @@ import { Component, Host, h, State } from '@stencil/core';
 import store from '../../../stores/store';
 import { EventLogClient, Pagination } from '../../../clients/event-log-client';
 import { Event } from './dnn-bi-logs.model';
+import { eventLogSeverity, EventLogSeverityInfo } from '../../../enums/EventLogSeverity';
 
 @Component({
   tag: 'dnn-bi-logs',
@@ -10,7 +11,10 @@ import { Event } from './dnn-bi-logs.model';
 })
 export class DnnBiLogs {
   @State() private events: Event[] = [];
+  @State() private eventTypes: string[] = [];
   @State() private pagination: Pagination;
+  @State() private severityFilter: EventLogSeverityInfo;
+  @State() private eventTypeFilter: string;
 
   private eventLogClient: EventLogClient;
 
@@ -23,13 +27,24 @@ export class DnnBiLogs {
       const { data, pagination } = await this.eventLogClient.browse();
       this.events = data;
       this.pagination = pagination;
+      this.eventTypes = await this.eventLogClient.getEventTypes();
     } catch (error) {
       console.error(error);
     }
   }
 
+  private async setSeverityFilter(key: string) {
+    this.severityFilter = eventLogSeverity.fromKey(key);
+    await this.loadPage(0);
+  }
+
+  private async setEventTypeFilter(eventType: string) {
+    this.eventTypeFilter = eventType;
+    await this.loadPage(0);
+  }
+
   private async loadPage(pageIndex: number) {
-    const { data, pagination } = await this.eventLogClient.browse(pageIndex);
+    const { data, pagination } = await this.eventLogClient.browse(pageIndex, this.severityFilter, this.eventTypeFilter);
     this.events = data;
     this.pagination = pagination;
   }
@@ -49,6 +64,21 @@ export class DnnBiLogs {
                 <h3 class="panel-title">{store.resx.Events}</h3>
               </div>
               <div class="panel-body">
+                <div class="filters">
+                  <dnn-select label={store.resx.Severity} onValueChange={e => this.setSeverityFilter(e.detail).catch(console.error)}>
+                    <option value="">{store.resx.All}</option>
+                    <option value={eventLogSeverity.info.eventLogSeverityKey}>{eventLogSeverity.info.localizedName}</option>
+                    <option value={eventLogSeverity.warning.eventLogSeverityKey}>{eventLogSeverity.warning.localizedName}</option>
+                    <option value={eventLogSeverity.alert.eventLogSeverityKey}>{eventLogSeverity.alert.localizedName}</option>
+                    <option value={eventLogSeverity.critical.eventLogSeverityKey}>{eventLogSeverity.critical.localizedName}</option>
+                  </dnn-select>
+                  <dnn-select label={store.resx.Type} onValueChange={e => this.setEventTypeFilter(e.detail).catch(console.error)}>
+                    <option value="">{store.resx.All}</option>
+                    {this.eventTypes.map(eventType => (
+                      <option>{eventType}</option>
+                    ))}
+                  </dnn-select>
+                </div>
                 <table class="table">
                   <thead>
                     <tr>

DNN Platform/Modules/BulkInstall/BulkInstall.Web/src/enums/EventLogSeverity.ts

@@ -12,6 +12,21 @@ export class EventLogSeverity {
     this.alert = new EventLogSeverityInfo('Alert');
     this.critical = new EventLogSeverityInfo('Critical');
   }
+
+  public fromKey(eventLogSeverityKey: string) {
+    switch (eventLogSeverityKey) {
+      case this.info.eventLogSeverityKey:
+        return this.info;
+      case this.warning.eventLogSeverityKey:
+        return this.warning;
+      case this.alert.eventLogSeverityKey:
+        return this.alert;
+      case this.critical.eventLogSeverityKey:
+        return this.critical;
+      default:
+        throw new Error(`Invalid EventLogSeverity key: ${eventLogSeverityKey}`);
+    }
+  }
 }
 
 export class EventLogSeverityInfo {

DNN Platform/Modules/BulkInstall/Components/WebAPI/EventLogController.cs

@@ -29,77 +29,19 @@ public class EventLogController(EventLogManager eventLogManager) : DnnApiControl
         /// <param name="pageIndex">The 0-based page index.</param>
         /// <param name="pageSize">The page size.</param>
         /// <param name="eventType">An event type to filter by, or <see langword="null"/>.</param>
-        /// <param name="severity">A <see cref="EventLogSeverity"/> to filter by, or <c>-1</c>.</param>
+        /// <param name="severity">A <see cref="EventLogSeverity"/> to filter by, or <see langword="null"/>.</param>
         /// <returns>A response with a list of <see cref="EventLog"/> and pagination data.</returns>
         [HttpGet]
-        public HttpResponseMessage Browse(int pageIndex = 0, int pageSize = 30, string eventType = null, int severity = -1)
+        public HttpResponseMessage Browse(int pageIndex = 0, int pageSize = 30, string eventType = null, EventLogSeverity? severity = null)
         {
-            EventLogSeverity? actualSeverity = null;
-
-            // Is there a severity set?
-            if (severity >= 0)
-            {
-                actualSeverity = (EventLogSeverity)severity;
-            }
-
             // Get event logs.
-            IEnumerable<EventLog> eventLogs = this.eventLogManager.Browse(pageIndex, pageSize, eventType, actualSeverity);
+            IEnumerable<EventLog> eventLogs = this.eventLogManager.Browse(pageIndex, pageSize, eventType, severity);
 
             // Work out pagination details.
-            int rowCount = this.eventLogManager.BrowseCount(pageIndex, pageSize, eventType, actualSeverity);
+            int rowCount = this.eventLogManager.BrowseCount(pageIndex, pageSize, eventType, severity);
             int pageCount = (int)Math.Ceiling(rowCount / (double)pageSize);
 
-            // Build navigation.
-            Dictionary<string, string> navigation = new Dictionary<string, string>();
-
-            // Parameters passed in not changed by pagination.
-            string fixedParams = string.Empty;
-
-            // Page size.
-            if (pageSize != 30)
-            {
-                fixedParams += $"pageSize={pageSize}";
-            }
-
-            // Event type.
-            if (eventType != null)
-            {
-                fixedParams += $"eventType={eventType}";
-            }
-
-            // Severity.
-            if (severity != -1)
-            {
-                fixedParams += $"eventType={severity}";
-            }
-
-            // Is there a next page?
-            if (pageIndex < pageCount)
-            {
-                string nextLink = $"Browse?pageIndex={pageIndex + 1}";
-
-                if (!string.IsNullOrEmpty(fixedParams))
-                {
-                    nextLink = $"{nextLink}&{fixedParams}";
-                }
-
-                navigation.Add("Next", nextLink);
-            }
-
-            // Is there a previous page?
-            if (pageIndex > 0)
-            {
-                string prevLink = $"Browse?pageIndex={pageIndex - 1}";
-
-                if (!string.IsNullOrEmpty(fixedParams))
-                {
-                    prevLink = $"{prevLink}&{fixedParams}";
-                }
-
-                navigation.Add("Previous", prevLink);
-            }
-
-            var pagination = new { Records = rowCount, Pages = pageCount, CurrentPage = pageIndex, Navigation = navigation, };
+            var pagination = new { Pages = pageCount, CurrentPage = pageIndex, };
             return this.Request.CreateResponse(HttpStatusCode.OK, new { Data = eventLogs, Pagination = pagination, });
         }