feat: print backend error notices for managing client version phase out (#6992)

Author: stefreak

core/src/cloud/grow/api.ts

@@ -30,6 +30,7 @@ import type { CloudApiFactoryParams, CloudApiParams } from "../api.js"
 import { deline } from "../../util/string.js"
 import { TRPCClientError } from "@trpc/client"
 import type { InferrableClientTypes } from "@trpc/server/unstable-core-do-not-import"
+import { handleServerNotices } from "./notices.js"
 
 const refreshThreshold = 10 // Threshold (in seconds) subtracted to jwt validity when checking if a refresh is needed
 
@@ -159,6 +160,9 @@ export class GrowCloudApi {
     const verificationResult = await getNonAuthenticatedApiClient({ hostUrl: cloudDomain }).token.verifyToken.query({
       token: authToken,
     })
+
+    handleServerNotices(verificationResult.notices, cloudLog)
+
     if (!verificationResult.valid) {
       log.debug({ msg: `The stored token was not valid.` })
       return undefined

core/src/cloud/grow/auth.ts

@@ -17,6 +17,7 @@ import { CloudApiError } from "../../exceptions.js"
 import { clearAuthToken, saveAuthToken } from "../auth.js"
 import { getCloudDistributionName } from "../util.js"
 import dedent from "dedent"
+import { handleServerNotices } from "./notices.js"
 
 export function isTokenExpired(token: ClientAuthToken) {
   const now = new Date()
@@ -42,6 +43,9 @@ export async function isTokenValid({
     const verificationResult = await getNonAuthenticatedApiClient({ hostUrl: cloudDomain }).token.verifyToken.query({
       token: authToken,
     })
+
+    handleServerNotices(verificationResult.notices, log)
+
     valid = verificationResult.valid
   } catch (err) {
     if (!(err instanceof TRPCError)) {
@@ -73,6 +77,9 @@ export async function refreshAuthTokenAndWriteToConfigStore(
     const result = await getNonAuthenticatedApiClient({ hostUrl: cloudDomain }).token.refreshToken.mutate({
       refreshToken,
     })
+
+    handleServerNotices(result.notices, log)
+
     await saveAuthToken({
       log,
       globalConfigStore,

core/src/cloud/grow/notices.ts

@@ -0,0 +1,38 @@
+/*
+ * Copyright (C) 2018-2024 Garden Technologies, Inc. <[email protected]>
+ *
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ */
+
+import { CloudApiError } from "../../exceptions.js"
+import type { Log } from "../../logger/log-entry.js"
+
+type ServerNotice = {
+  message: string
+  severity: "warning" | "error" | "info"
+}
+
+export function handleServerNotices(notices: ServerNotice[], log: Log) {
+  for (const notice of notices) {
+    switch (notice.severity) {
+      case "warning":
+        log.warn(`WARNING: ${notice.message}`)
+        break
+      case "error":
+        log.error(`ERROR: ${notice.message}`)
+        break
+      case "info":
+        log.info(notice.message)
+        break
+    }
+  }
+
+  const errors = notices.filter((notice) => notice.severity === "error")
+  if (errors.length > 0) {
+    throw new CloudApiError({
+      message: `There ${errors.length > 1 ? `were ${errors.length} errors` : "was an error"} connecting to Garden Cloud (See error logs above).`,
+    })
+  }
+}

core/src/cloud/grow/trpc-schema.ts

@@ -110,6 +110,7 @@ export declare const appRouter: import("@trpc/server/unstable-core-do-not-import
               email: string
               role: "admin" | "member"
               expiresAt: Date | null
+              isOwner: boolean
               kind: "account" | "invitation"
             }[]
             nextCursor?: number | undefined
@@ -127,6 +128,7 @@ export declare const appRouter: import("@trpc/server/unstable-core-do-not-import
             updatedAt: Date
             email: string
             role: "admin" | "member"
+            isOwner: boolean
           }
         }>
         update: import("@trpc/server").TRPCMutationProcedure<{
@@ -142,6 +144,7 @@ export declare const appRouter: import("@trpc/server/unstable-core-do-not-import
             updatedAt: Date
             email: string
             role: "admin" | "member"
+            isOwner: boolean
           }
         }>
         remove: import("@trpc/server").TRPCMutationProcedure<{
@@ -362,6 +365,7 @@ export declare const appRouter: import("@trpc/server/unstable-core-do-not-import
             agentConfigurationId: string
           }
           output: {
+            status: string
             id: string
             createdAt: Date
             updatedAt: Date
@@ -384,13 +388,6 @@ export declare const appRouter: import("@trpc/server/unstable-core-do-not-import
                 }
           }[]
         }>
-        getStatus: import("@trpc/server").TRPCQueryProcedure<{
-          input: {
-            organizationId: string
-            agentInstanceId: string
-          }
-          output: string
-        }>
         restart: import("@trpc/server").TRPCMutationProcedure<{
           input: {
             organizationId: string
@@ -414,12 +411,13 @@ export declare const appRouter: import("@trpc/server/unstable-core-do-not-import
             title: string
             userAgent: string
             url: string
-            referrer: string
             pathNameClean: string
+            referrer: string
             prevPage?:
               | {
                   path: string
                   title: string
+                  pathNameClean: string
                 }
               | undefined
           }
@@ -474,7 +472,8 @@ export declare const appRouter: import("@trpc/server/unstable-core-do-not-import
                     | "trialing"
                     | "unpaid"
                     | undefined
-                  priceQuantity?: number | undefined
+                  currentPriceQuantity?: number | undefined
+                  maximumPriceQuantity?: number | undefined
                   billingInterval?: "month" | "year" | undefined
                   currentPeriodStart?: Date | undefined
                   currentPeriodEnd?: Date | undefined
@@ -1029,6 +1028,15 @@ export declare const appRouter: import("@trpc/server/unstable-core-do-not-import
         transformer: true
       },
       import("@trpc/server/unstable-core-do-not-import").DecorateCreateRouterOptions<{
+        getByToken: import("@trpc/server").TRPCQueryProcedure<{
+          input: {
+            token: string
+          }
+          output: {
+            organizationName: string
+            inviterName: string
+          }
+        }>
         create: import("@trpc/server").TRPCMutationProcedure<{
           input: {
             organizationId: string
@@ -1223,6 +1231,10 @@ export declare const appRouter: import("@trpc/server/unstable-core-do-not-import
           }
           output: {
             valid: boolean
+            notices: {
+              message: string
+              severity: "info" | "error" | "warning"
+            }[]
           }
         }>
         refreshToken: import("@trpc/server").TRPCMutationProcedure<{
@@ -1233,6 +1245,10 @@ export declare const appRouter: import("@trpc/server/unstable-core-do-not-import
             accessToken: string
             refreshToken: string
             tokenValidity: number
+            notices: {
+              message: string
+              severity: "info" | "error" | "warning"
+            }[]
           }
         }>
         revokeToken: import("@trpc/server").TRPCMutationProcedure<{
@@ -1245,7 +1261,7 @@ export declare const appRouter: import("@trpc/server/unstable-core-do-not-import
         }>
         createAccessToken: import("@trpc/server").TRPCMutationProcedure<{
           input: {
-            label: string
+            name: string
           }
           output: {
             value: string
@@ -1263,6 +1279,18 @@ export declare const appRouter: import("@trpc/server/unstable-core-do-not-import
           }
           output: void
         }>
+        listAccessTokens: import("@trpc/server").TRPCQueryProcedure<{
+          input: void
+          output: {
+            value: string
+            type: "access" | "refresh" | "web"
+            createdAt: Date
+            updatedAt: Date
+            accountId: string
+            expiresAt: Date
+            label: string | null
+          }[]
+        }>
         listTokens: import("@trpc/server").TRPCQueryProcedure<{
           input: {
             type?: "access" | "refresh" | "web" | undefined

core/src/cloud/grow/trpc.ts

@@ -11,6 +11,7 @@ import { createTRPCClient, httpLink, loggerLink } from "@trpc/client"
 import type { inferRouterInputs, inferRouterOutputs } from "@trpc/server"
 import superjson from "superjson"
 import type { AppRouter } from "./trpc-schema.js"
+import { getPackageVersion } from "../../util/util.js"
 
 export type RouterOutput = inferRouterOutputs<AppRouter>
 export type RouterInput = inferRouterInputs<AppRouter>
@@ -50,6 +51,9 @@ function getTrpcConfig({ hostUrl, tokenGetter }: TrpcConfigParams) {
             headers.set("Authorization", `token ${tokenGetter()}`)
           }
 
+          headers.set("x-client-name", "garden-core")
+          headers.set("x-client-version", getPackageVersion())
+
           // Use standard fetch instead of bunFetch from Grow
           return await fetch(url, { ...options, headers })
         },

project.garden.yml

@@ -12,14 +12,14 @@ environments:
       show-log: true
 providers:
   - name: kubernetes
-    environments: [testing]
+    environments: [ testing ]
     context: gke_garden-ci_europe-west1-b_core-ci
     namespace: e2e-tests
     defaultHostname: dev-1.sys.garden
     buildMode: cluster-buildkit
     setupIngressController: nginx
   - name: local-kubernetes
-    environments: [local]
+    environments: [ local ]
 variables:
   timeout: 360
   show-log: false