add description preview to propmon ui

ArbitrumFoundation · Sep 1, 2023 · afb7ca0 · afb7ca0
1 parent ff3e39c
commit afb7ca0
Show file tree

Hide file tree

Showing 3 changed files with 19 additions and 2 deletions.
diff --git a/src-ts/propMonUi/propMonUi.html b/src-ts/propMonUi/propMonUi.html
@@ -21,6 +21,11 @@
             color: #1A2231;
         }
 
+        div.desc{
+            background-color: #eaeaea;
+            padding: 10px;
+        }
+
         table {
             width: 100%;
             border-collapse: collapse;
@@ -180,11 +185,17 @@ <h1>Proposal States</h1>
 
                             const proposalDiv = document.createElement('div');
                             governorDiv.appendChild(proposalDiv);
-                            if (stage.proposalLink) {
+                            if (stage.proposalLink) {                                
                                 proposalDiv.innerHTML = `<h3><a target="_blank" href="${stage.proposalLink}">Proposal ID: ${stage.identifier}</a></h3>`;
                             } else {
                                 proposalDiv.innerHTML = `<h3>Proposal ID: ${stage.identifier}</h3>`;
                             }
+                            if (stage.description){
+                                const descDiv = document.createElement('div');
+                                descDiv.className = "desc";
+                                descDiv.innerHTML = `<b>Description:</b> ${stage.description.slice(0,300)}...`
+                                proposalDiv.appendChild(descDiv)
+                            }
 
                             // Identify unique stages for the current proposal
                             const table = document.createElement('table');

diff --git a/src-ts/proposalMonitorCli.ts b/src-ts/proposalMonitorCli.ts
@@ -101,6 +101,7 @@ interface PipelineStage {
   explorerLink?: string;
   proposalLink?: string;
   children: PipelineStage[];
+  description?: string
 }
 
 interface GovernorStatus {
@@ -165,6 +166,7 @@ class JsonLogger {
           explorerLink: e.publicExecutionUrl,
           proposalLink,
           children: [],
+          description: e.description
         };
 
         if (prevKey === originKey && !emittedStages.has(key)) {

diff --git a/src-ts/proposalPipeline.ts b/src-ts/proposalPipeline.ts
@@ -64,6 +64,8 @@ export interface TrackerEvent {
   prevStage?: Omit<TrackerEvent, "status">;
   publicExecutionUrl?: string;
   error?: Error;
+  description?: string;
+
 }
 
 export class StageTracker extends EventEmitter {
@@ -84,7 +86,7 @@ export class StageTracker extends EventEmitter {
     return super.on(eventName, listener);
   }
 
-  private propagateTrackerSubcriptions(tracker: StageTracker) {}
+  private propagateTrackerSubscriptions(tracker: StageTracker) {}
 
   public async run() {
     let polling = true;
@@ -109,6 +111,8 @@ export class StageTracker extends EventEmitter {
               status === ProposalStageStatus.EXECUTED
                 ? await this.stage.getExecutionUrl()
                 : undefined,
+                // @ts-ignore
+              description: this.stage.description || undefined
           });
           currentStatus = status;
         }