feat(sub): notebooks integration (#5075)

Author: Gene Hynson

src/flows/components/FromTemplatePage.tsx

@@ -46,6 +46,9 @@ const Template: FC = () => {
       })
       .then(data => {
         add(data).then(id => {
+          if (TEMPLATES[params[0]].callback) {
+            TEMPLATES[params[0]].callback.apply(this, [params.slice(1), id])
+          }
           history.replace(
             `/orgs/${org.id}/${PROJECT_NAME_PLURAL.toLowerCase()}/${id}`
           )

src/flows/templates/index.ts

@@ -1,6 +1,7 @@
 export interface Template {
   type: string // a unique string that identifies a visualization
   init: (...args: string[]) => any // returns a flow state that will pass the hydrate function in src/flows/context/flow.list.tsx
+  callback?: (...args: string[]) => any // optional callback func to return the newly created notebook id
 }
 
 interface Templates {

src/flows/templates/types/subscription.ts

@@ -0,0 +1,88 @@
+import {DEFAULT_TIME_RANGE} from 'src/shared/constants/timeRanges'
+import {AUTOREFRESH_DEFAULT} from 'src/shared/constants'
+import {PIPE_DEFINITIONS} from 'src/flows'
+import {getBuckets} from 'src/client'
+import {getByIDAPI, updateAPI} from 'src/writeData/subscriptions/context/api'
+import {Subscription} from 'src/types'
+
+const getSubscriptionMeasurementValues = (sub: Subscription): string[] => {
+  if (sub.dataFormat === 'json') {
+    return sub.jsonMeasurementKey.name ? [sub.jsonMeasurementKey.name] : []
+  } else if (sub.dataFormat === 'string') {
+    return sub.stringMeasurement.name ? [sub.stringMeasurement.name] : []
+  } else {
+    return []
+  }
+}
+
+export default register =>
+  register({
+    type: 'subscription',
+    callback: (subscriptionID: string, notebookID: string) =>
+      updateAPI({id: subscriptionID, data: {notebookID}}),
+    init: async (subscriptionID: string) => {
+      let sub
+      let buckets
+      try {
+        sub = await getByIDAPI({id: subscriptionID})
+        const bucketsResp = await getBuckets({query: {orgID: sub.orgID}})
+        buckets = bucketsResp.status === 200 ? bucketsResp.data.buckets : []
+      } catch {
+        sub = {}
+        buckets = []
+      }
+      const name = `${sub.name} Subscription`
+      return {
+        name,
+        spec: {
+          readOnly: false,
+          range: DEFAULT_TIME_RANGE,
+          refresh: AUTOREFRESH_DEFAULT,
+          pipes: [
+            {
+              type: 'queryBuilder',
+              title: `Query ${sub.bucket} Bucket`,
+              visible: true,
+              ...JSON.parse(
+                JSON.stringify(PIPE_DEFINITIONS['queryBuilder'].initial)
+              ),
+              buckets: buckets.filter(a => a.name === sub.bucket),
+              tags: [
+                {
+                  key: '_measurement',
+                  values: getSubscriptionMeasurementValues(sub),
+                  aggregateFunctionType: 'filter',
+                },
+              ],
+            },
+            {
+              title: `Subscription ${sub.name} Data`,
+              visible: true,
+              type: 'table',
+            },
+            {
+              type: 'queryBuilder',
+              title: 'Query _monitoring Bucket',
+              visible: true,
+              ...JSON.parse(
+                JSON.stringify(PIPE_DEFINITIONS['queryBuilder'].initial)
+              ),
+              buckets: buckets.filter(a => a.name === '_monitoring'),
+              tags: [
+                {
+                  key: '_measurement',
+                  values: ['subscriptions'],
+                  aggregateFunctionType: 'filter',
+                },
+              ],
+            },
+            {
+              title: 'Subscriptions Error Data',
+              visible: true,
+              type: 'table',
+            },
+          ],
+        },
+      }
+    },
+  })

src/types/subscriptions.ts

@@ -33,6 +33,7 @@ export interface Subscription {
   isActive?: string
   flowVersion?: number
   timestampPrecision?: string
+  notebookID?: string
 }
 
 export interface JsonSpec {

src/writeData/subscriptions/components/BrokerDetails.tsx

@@ -29,6 +29,7 @@ import {getOrg} from 'src/organizations/selectors'
 import {event} from 'src/cloud/utils/reporting'
 import {AppSettingContext} from 'src/shared/contexts/app'
 import {checkRequiredFields} from 'src/writeData/subscriptions/utils/form'
+import {PROJECT_NAME, PROJECT_NAME_PLURAL} from 'src/flows'
 
 // Types
 import {SUBSCRIPTIONS, LOAD_DATA} from 'src/shared/constants/routes'
@@ -143,7 +144,17 @@ const BrokerDetails: FC<Props> = ({
                         {},
                         {feature: 'subscriptions'}
                       )
-                      history.push(`/orgs/${org.id}/notebooks`)
+                      history.push(
+                        currentSubscription.notebookID
+                          ? `/orgs/${
+                              org.id
+                            }/${PROJECT_NAME_PLURAL.toLowerCase()}/${
+                              currentSubscription.notebookID
+                            }`
+                          : `/${PROJECT_NAME.toLowerCase()}/from/subscription/${
+                              currentSubscription.id
+                            }`
+                      )
                     }}
                     type={ButtonType.Button}
                     testID="update-broker-form--view-data"