terrier-engine 4.25.0 → 4.26.0

package/data-dive/dives/dive-delivery.ts

@@ -4,9 +4,19 @@ import TerrierPart from "../../terrier/parts/terrier-part"
 import {RegularSchedule, RegularScheduleForm} from "../../terrier/schedules"
 import {Logger} from "tuff-core/logging"
 import {EmailListForm} from "../../terrier/emails"
+import {DdDiveRun} from "../gen/models"
+import Db from "../dd-db"
+import dayjs from "dayjs"
+import Dates from "../queries/dates"
+import DiveRuns from "./dive-runs";
 
 const log = new Logger("Dive Delivery")
 
+
+////////////////////////////////////////////////////////////////////////////////
+// Delivery Form
+////////////////////////////////////////////////////////////////////////////////
+
 export type DiveDeliverySettings = {
     delivery_schedule: RegularSchedule
     delivery_recipients: string[]
@@ -16,11 +26,13 @@ export class DiveDeliveryForm extends TerrierPart<DiveEditorState> {
 
     scheduleForm!: RegularScheduleForm
     recipientsForm!: EmailListForm
+    deliveryList!: DiveDeliveryList
 
     async init() {
         const schedule = this.state.dive.delivery_schedule || {schedule_type: 'none'}
         this.scheduleForm = this.makePart(RegularScheduleForm, schedule)
         this.recipientsForm = this.makePart(EmailListForm, {emails: this.state.dive.delivery_recipients || []})
+        this.deliveryList = this.makePart(DiveDeliveryList, this.state)
 
         this.listen('datachanged', this.scheduleForm.dataChangedKey, m => {
             log.info(`Schedule form data changed`, m.data)
@@ -42,6 +54,11 @@ export class DiveDeliveryForm extends TerrierPart<DiveEditorState> {
         parent.part(this.scheduleForm)
         parent.h3(".glyp-users").text("Recipients")
         parent.part(this.recipientsForm)
+        parent.div('.deliveries', deliveriesContainer => {
+            // it looks better without the gap between the header and list
+            deliveriesContainer.h3(".glyp-inbox").text("Deliveries")
+            deliveriesContainer.part(this.deliveryList)
+        })
     }
 
     /**
@@ -55,3 +72,46 @@ export class DiveDeliveryForm extends TerrierPart<DiveEditorState> {
     }
 
 }
+
+
+////////////////////////////////////////////////////////////////////////////////
+// Delivery List
+////////////////////////////////////////////////////////////////////////////////
+
+class DiveDeliveryList extends TerrierPart<DiveEditorState> {
+
+    runs: DdDiveRun[] = []
+
+    async init() {
+        this.runs = await Db().query("dd_dive_run")
+            .where({dd_dive_id: this.state.dive.id})
+            .where("delivery_recipients is not null")
+            .orderBy("created_at desc")
+            .limit(100)
+            .exec()
+
+        this.dirty()
+    }
+
+    get parentClasses(): Array<string> {
+        return ['dive-delivery-list']
+    }
+
+    render(parent: PartTag) {
+        for (const run of this.runs) {
+            parent.div(".run", view => {
+                view.div(".recipients.glyp-users.with-icon").text(run.delivery_recipients?.join("; ") || "No Recipients")
+                view.div('.datetime', dateTimeView => {
+                    const d = dayjs(run.created_at)
+                    dateTimeView.div(".date").text(d.format(Dates.displayFormat))
+                    dateTimeView.div(".time").text(d.format("H:mm A"))
+                })
+                run.dd_dive = this.state.dive // so that the filename is better
+                view.a(".download.glyp-download", {href: DiveRuns.outputUrl(run), target: '_blank'})
+                    .data({tooltip: "Download the dive results for this delivery"})
+            })
+        }
+    }
+
+}
+

package/data-dive/dives/dive-runs.ts

@@ -15,12 +15,18 @@ import {TerrierFormFields} from "../../terrier/forms"
 import * as inflection from "inflection"
 import Dates, {DateLiteral, DatePeriodPickerPart, DatePeriodPickerState, LiteralDateRange} from "../queries/dates"
 import dayjs from "dayjs"
-import {ProgressBarPart} from "../../terrier/progress";
-import {LogListPart} from "../../terrier/logging";
+import {ProgressBarPart} from "../../terrier/progress"
+import {LogListPart} from "../../terrier/logging"
 import Messages from "tuff-core/messages"
+import Format from "../../terrier/format"
 
 const log = new Logger("DiveRuns")
 
+
+////////////////////////////////////////////////////////////////////////////////
+// Run Modal
+////////////////////////////////////////////////////////////////////////////////
+
 type RunQueryResult = {
     id: string
     time: string
@@ -309,4 +315,34 @@ export class DiveRunModal extends ModalPart<{dive: DdDive }> {
         })
     }
 
-}
+}
+
+
+////////////////////////////////////////////////////////////////////////////////
+// Utilities
+////////////////////////////////////////////////////////////////////////////////
+
+/**
+ * Generates a relative URL to download the output of the given run with an optional custom file name.
+ * @param run
+ * @param filename
+ */
+function outputUrl(run: DdDiveRun, filename?: string): string {
+    if (!filename?.length) {
+        const nameComps: string[] = []
+        const dive = run.dd_dive
+        if (dive) {
+            nameComps.push(inflection.underscore(dive.name))
+        }
+        const d = dayjs(run.created_at)
+        nameComps.push(d.format('YYYY-MM-DD_HHmmss'))
+        filename = nameComps.join('_') + '.xlsx'
+    }
+    return `/data_dive/download_run/${run.id}/${filename}?t=${dayjs().format(Format.timestamp)}`
+}
+
+const DiveRuns = {
+    outputUrl
+}
+export default DiveRuns
+

package/package.json

@@ -4,7 +4,7 @@
   "files": [
     "*"
   ],
-  "version": "4.25.0",
+  "version": "4.26.0",
   "repository": {
     "type": "git",
     "url": "https://github.com/Terrier-Tech/terrier-engine"

package/terrier/format.ts

@@ -12,13 +12,20 @@ function cents(c: number | string): string {
     return '$' + (num/100).toFixed(2)
 }
 
+////////////////////////////////////////////////////////////////////////////////
+// Dates and Times
+////////////////////////////////////////////////////////////////////////////////
+
+const timestamp = 'YYYYMMDDHHMMSS'
+
 
 ////////////////////////////////////////////////////////////////////////////////
 // Export
 ////////////////////////////////////////////////////////////////////////////////
 
 const Format = {
-    cents
+    cents,
+    timestamp
 }
 
 export default Format