feat(web-console): support for notice responses from server, such as empty SQL notice

packages/web-console/src/consts/index.ts

@@ -32,4 +32,10 @@ const BASE = process.env.NODE_ENV === "production" ? "fara" : "alurin"
 
 export const API = `https://${BASE}.questdb.io`
 
+// QuestDB API version
+// to be included in all requests
+// so server-side can construct a reply
+// the console will understand
+export const API_VERSION = "2";
+
 export const BUTTON_ICON_SIZE = "26px"

packages/web-console/src/scenes/Editor/Monaco/index.tsx

@@ -322,6 +322,21 @@ const MonacoEditor = () => {
               eventBus.publish(EventType.MSG_QUERY_SCHEMA)
             }
 
+            if (result.type === QuestDB.Type.NOTICE) {
+              dispatch(
+                actions.query.addNotification({
+                  content: (
+                    <Text color="foreground" ellipsis title={result.query}>
+                      {result.notice}
+                      {result.query !== undefined && result.query !== '' && `: ${result.query}`}
+                    </Text>
+                  ),
+                  type: NotificationType.NOTICE,
+                }),
+              )
+              eventBus.publish(EventType.MSG_QUERY_SCHEMA)
+            }
+
             if (result.type === QuestDB.Type.DQL) {
               setLastExecutedQuery(request.query)
               dispatch(

packages/web-console/src/scenes/Notifications/Notification/NoticeNotification/index.tsx

@@ -0,0 +1,48 @@
+/*******************************************************************************
+ *     ___                  _   ____  ____
+ *    / _ \ _   _  ___  ___| |_|  _ \| __ )
+ *   | | | | | | |/ _ \/ __| __| | | |  _ \
+ *   | |_| | |_| |  __/\__ \ |_| |_| | |_) |
+ *    \__\_\\__,_|\___||___/\__|____/|____/
+ *
+ *  Copyright (c) 2014-2019 Appsicle
+ *  Copyright (c) 2019-2022 QuestDB
+ *
+ *  Licensed under the Apache License, Version 2.0 (the "License");
+ *  you may not use this file except in compliance with the License.
+ *  You may obtain a copy of the License at
+ *
+ *  http://www.apache.org/licenses/LICENSE-2.0
+ *
+ *  Unless required by applicable law or agreed to in writing, software
+ *  distributed under the License is distributed on an "AS IS" BASIS,
+ *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ *  See the License for the specific language governing permissions and
+ *  limitations under the License.
+ *
+ ******************************************************************************/
+
+import React from "react"
+import styled from "styled-components"
+import { Wrapper, Content, SideContent } from "../styles"
+import { Timestamp } from "../Timestamp"
+import { NotificationShape } from "../../../../types"
+import { InfoOutline } from "@styled-icons/evaicons-outline"
+import { color } from "../../../../utils"
+
+const InfoOutlineIcon = styled(InfoOutline)`
+  color: ${color("yellow")};
+  flex-shrink: 0;
+`
+
+export const NoticeNotification = (props: NotificationShape) => {
+  const { createdAt, content, sideContent, isMinimized } = props
+  return (
+    <Wrapper isMinimized={isMinimized}>
+      <Timestamp createdAt={createdAt} />
+      <InfoOutlineIcon size="18px" />
+      <Content>{content}</Content>
+      <SideContent>{sideContent}</SideContent>
+    </Wrapper>
+  )
+}

packages/web-console/src/scenes/Notifications/Notification/index.tsx

@@ -27,13 +27,16 @@ import { NotificationShape, NotificationType } from "../../../types"
 import { SuccessNotification } from "./SuccessNotification"
 import { ErrorNotification } from "./ErrorNotification"
 import { InfoNotification } from "./InfoNotification"
+import {NoticeNotification} from "./NoticeNotification";
 
 const Notification = (props: NotificationShape) => {
   const { type } = props
   return type === NotificationType.SUCCESS ? (
     <SuccessNotification {...props} />
   ) : type === NotificationType.ERROR ? (
     <ErrorNotification {...props} />
+  ) : type == NotificationType.NOTICE ? (
+    <NoticeNotification {...props} />
   ) : (
     <InfoNotification {...props} />
   )

packages/web-console/src/store/Query/types.ts

@@ -34,6 +34,7 @@ export enum NotificationType {
   ERROR = "error",
   INFO = "info",
   SUCCESS = "success",
+  NOTICE = "notice",
 }
 
 export type NotificationShape = Readonly<{

packages/web-console/src/utils/questdb.ts

@@ -27,6 +27,7 @@ import { eventBus } from "../modules/EventBus"
 import { EventType } from "../modules/EventBus/types"
 import { AuthPayload } from "../modules/OAuth2/types"
 import { StoreKey } from "./localStorage/types"
+import {API_VERSION} from "../consts";
 
 type ColumnDefinition = Readonly<{ name: string; type: string }>
 
@@ -38,6 +39,7 @@ export enum Type {
   DML = "dml",
   DQL = "dql",
   ERROR = "error",
+  NOTICE = "notice",
 }
 
 export type Timings = {
@@ -58,6 +60,7 @@ type RawDqlResult = {
   dataset: DatasetType[]
   ddl: undefined
   dml: undefined
+  notice: undefined
   error: undefined
   query: string
   timings: Timings
@@ -82,6 +85,15 @@ type RawErrorResult = {
   query: string
 }
 
+type RawNoticeResult = {
+    ddl: undefined
+    dml: undefined
+    error: undefined
+    notice: "<notice message>"
+    position: undefined
+    query: string
+}
+
 type DdlResult = {
   query: string
   type: Type.DDL
@@ -92,18 +104,23 @@ type DmlResult = {
   type: Type.DML
 }
 
-type RawResult = RawDqlResult | RawDmlResult | RawDdlResult | RawErrorResult
+type RawResult = RawDqlResult | RawDmlResult | RawDdlResult | RawErrorResult | RawNoticeResult
 
 export type ErrorResult = RawErrorResult & {
   type: Type.ERROR
   status: number
 }
 
+export type NoticeResult = RawNoticeResult & {
+    type: Type.NOTICE
+}
+
 export type QueryRawResult =
   | (Omit<RawDqlResult, "ddl" | "dml"> & { type: Type.DQL })
   | DmlResult
   | DdlResult
   | ErrorResult
+  | NoticeResult
 
 export type QueryResult<T extends Record<string, any>> =
   | {
@@ -117,6 +134,7 @@ export type QueryResult<T extends Record<string, any>> =
   | ErrorResult
   | DmlResult
   | DdlResult
+  | NoticeResult
 
 export type PartitionBy = "HOUR" | "DAY" | "WEEK" | "MONTH" | "YEAR" | "NONE"
 
@@ -401,6 +419,7 @@ export class Client {
       src: "con",
       query,
       timings: true,
+      version: API_VERSION,
       ...options,
     }
 
@@ -503,6 +522,13 @@ export class Client {
         })
       }
 
+      if (data.notice) {
+        return {
+          ...data,
+          type: Type.NOTICE,
+        }
+      }
+
       return {
         ...data,
         timings: {
@@ -594,6 +620,7 @@ export class Client {
         `chk?${Client.encodeParams({
           f: "json",
           j: name,
+          version: API_VERSION,  
         })}`,
         { headers: this.commonHeaders },
       )
@@ -667,7 +694,7 @@ export class Client {
   async exportQueryToCsv(query: string) {
     try {
       const response: Response = await fetch(
-        `exp?${Client.encodeParams({ query })}`,
+        `exp?${Client.encodeParams({ query, version: API_VERSION })}`,
         { headers: this.commonHeaders },
       )
       const blob = await response.blob()