@postgres.ai/shared 4.1.2 → 4.2.0

package/pages/Instance/Tabs/styles.ts

@@ -1,8 +1,7 @@
-import { makeStyles } from '@material-ui/core'
-import { colors } from '@postgres.ai/shared/styles/colors'
+import { makeStyles, Theme } from '@material-ui/core'
 
 export const useTabsStyles = makeStyles(
-  {
+  (theme: Theme) => ({
     tabsRoot: {
       minHeight: 0,
       marginTop: '-8px',
@@ -24,7 +23,7 @@ export const useTabsStyles = makeStyles(
         height: '18px',
       },
       '& a': {
-        color: colors.black,
+        color: theme.palette.text.primary,
         textDecoration: 'none',
 
         '@media (max-width: 700px)': {
@@ -43,18 +42,19 @@ export const useTabsStyles = makeStyles(
       height: '3px',
     },
     tabRoot: {
+      color: theme.palette.text.primary,
       fontWeight: 400,
       minWidth: 0,
       minHeight: 0,
       width: '100%',
       padding: '6px 16px',
-      borderBottom: `3px solid ${colors.consoleStroke}`,
+      borderBottom: `3px solid ${theme.palette.divider}`,
       '& + $tabRoot': {
         marginLeft: '10px',
       },
       '&.Mui-disabled': {
         opacity: 1,
-        color: colors.pgaiDarkGray,
+        color: theme.palette.text.disabled,
       },
       '@media (max-width: 700px)': {
         width: 'max-content',
@@ -63,6 +63,6 @@ export const useTabsStyles = makeStyles(
     tabHidden: {
       display: 'none',
     },
-  },
+  }),
   { index: 1 },
 )

package/pages/Instance/index.tsx

@@ -96,8 +96,6 @@ export const Instance = observer((props: Props) => {
     instanceRetrieval ||
     (!isLoadingInstance && !isLoadingInstanceRetrieval && instance && instance?.url && !instanceError)
 
-  const isConfigurationActive = instanceRetrieval?.mode !== 'physical'
-
   useEffect(() => {
     load(instanceId, isPlatform)
   }, [instanceId])
@@ -111,7 +109,6 @@ export const Instance = observer((props: Props) => {
     if (
       instance &&
       instance.state?.retrieving?.status === 'pending' &&
-      isConfigurationActive &&
       !hasBeenRedirected
     ) {
       setActiveTab(TABS_INDEX.CONFIGURATION)
@@ -193,7 +190,6 @@ export const Instance = observer((props: Props) => {
                 <Configuration
                   instanceId={instanceId}
                   switchActiveTab={switchTab}
-                  isConfigurationActive={isConfigurationActive}
                   reload={() => load(props.instanceId)}
                   disableConfigModification={
                     instance?.state?.engine.disableConfigModification

package/pages/Instance/stores/Main.ts

@@ -13,6 +13,7 @@ import { Config } from '@postgres.ai/shared/types/api/entities/config'
 import { GetConfig } from '@postgres.ai/shared/types/api/endpoints/getConfig'
 import { UpdateConfig } from '@postgres.ai/shared/types/api/endpoints/updateConfig'
 import { TestDbSource } from '@postgres.ai/shared/types/api/endpoints/testDbSource'
+import { ProbeSource } from '@postgres.ai/shared/types/api/endpoints/probeSource'
 import { RefreshInstance } from '@postgres.ai/shared/types/api/endpoints/refreshInstance'
 import { DestroyClone } from '@postgres.ai/shared/types/api/endpoints/destroyClone'
 import { ResetClone } from '@postgres.ai/shared/types/api/endpoints/resetClone'
@@ -47,6 +48,7 @@ export type Api = {
   getConfig?: GetConfig
   updateConfig?: UpdateConfig
   testDbSource?: TestDbSource
+  probeSource?: ProbeSource
   getFullConfig?: GetFullConfig
   getSeImages?: GetSeImages
   getEngine?: GetEngine
@@ -169,9 +171,9 @@ export class MainStore {
     })
   }
 
-  reloadSnapshots = async (branchName?: string) => {
+  reloadSnapshots = async (branchName?: string, silent?: boolean) => {
     if (!this.instance) return
-    await this.snapshots.reload(this.instance.id, branchName)
+    await this.snapshots.reload(this.instance.id, branchName, silent)
   }
 
   reloadInstanceRetrieval = async () => {
@@ -291,7 +293,12 @@ export class MainStore {
       this.fullConfig = response
 
       const splitYML = this.fullConfig.split('---')
-      this.platformUrl = splitYML[0]?.split('url: ')[1]?.split('\n')[0]
+      const platformSection = splitYML[0]?.split('\nplatform:')[1] ?? ''
+      const rawPlatformUrl = platformSection.split('url: ')[1]?.split('\n')[0]
+      this.platformUrl = rawPlatformUrl
+        ?.replace(/['"]+/g, '')
+        .trim()
+        .split(/\s+/)[0]
       this.uiVersion = splitYML[0]
         ?.split('dockerImage: "postgresai/ce-ui:')[2]
         ?.split('\n')[0]
@@ -351,6 +358,17 @@ export class MainStore {
     }
   }
 
+  probeSource = async (values: { url: string; password: string }) => {
+    if (!this.api.probeSource) return
+
+    const { response, error } = await this.api.probeSource(values)
+
+    return {
+      response,
+      error,
+    }
+  }
+
   resetClone = async (cloneId: string, snapshotId: string) => {
     if (!this.instance || !this.api.resetClone) return
 
@@ -402,15 +420,19 @@ export class MainStore {
     this.isReloadingClones = false
   }
 
-  getBranches = async (instanceId: string) => {
+  getBranches = async (instanceId: string, silent?: boolean) => {
     if (!this.api.getBranches) return
-    this.isBranchesLoading = true
+    if (!silent) this.isBranchesLoading = true
 
     const { response, error } = await this.api.getBranches(instanceId)
 
-    this.isBranchesLoading = false
+    if (!silent) this.isBranchesLoading = false
+
+    if (response) this.getBranchesError = null
 
-    if (error) this.getBranchesError = await error.json().then((err) => err)
+    // a silent background refresh must not replace the rendered list with an error stub on a
+    // transient failure; errors surface only on a foreground load.
+    if (error && !silent) this.getBranchesError = await error.json().then((err) => err)
 
     return response
   }

package/pages/Snapshots/Snapshot/index.tsx

@@ -23,11 +23,18 @@ import {
 import { ErrorStub } from '@postgres.ai/shared/components/ErrorStub'
 import { PageSpinner } from '@postgres.ai/shared/components/PageSpinner'
 import { SectionTitle } from '@postgres.ai/shared/components/SectionTitle'
+import { Select } from '@postgres.ai/shared/components/Select'
+import { Spinner } from '@postgres.ai/shared/components/Spinner'
 import { DestroySnapshotModal } from '@postgres.ai/shared/pages/Snapshots/Snapshot/DestorySnapshotModal'
 import { HorizontalScrollContainer } from '@postgres.ai/shared/components/HorizontalScrollContainer'
 import { Tooltip } from '@postgres.ai/shared/components/Tooltip'
 import { icons } from '@postgres.ai/shared/styles/icons'
 import { formatBytesIEC } from '@postgres.ai/shared/utils/units'
+import { parseDate } from '@postgres.ai/shared/utils/date'
+import {
+  protectionOptions,
+  getProtectionSelectValue,
+} from '@postgres.ai/shared/utils/protection'
 import { styles } from '@postgres.ai/shared/styles/styles'
 import { SyntaxHighlight } from '@postgres.ai/shared/components/SyntaxHighlight'
 import {
@@ -94,6 +101,13 @@ const useStyles = makeStyles(
     summary: {
       marginTop: 20,
     },
+    protectionControl: {
+      display: 'flex',
+      alignItems: 'center',
+      marginTop: '8px',
+      marginBottom: '8px',
+      maxWidth: 525,
+    },
     text: {
       marginTop: '4px',
     },
@@ -160,6 +174,9 @@ export const SnapshotPage = observer((props: Props) => {
     snapshot,
     branchSnapshot,
     isSnapshotsLoading,
+    isUpdatingSnapshot,
+    updateSnapshotProtection,
+    updateSnapshotError,
     snapshotError,
     branchSnapshotError,
     load,
@@ -170,6 +187,19 @@ export const SnapshotPage = observer((props: Props) => {
     load(props.snapshotId, props.instanceId)
   }
 
+  const protectedTillDate = snapshot?.protectedTill
+    ? parseDate(snapshot.protectedTill)
+    : null
+
+  const handleProtectionChange = (e: React.ChangeEvent<HTMLInputElement>) => {
+    const value = e.target.value
+    updateSnapshotProtection(
+      props.snapshotId,
+      props.instanceId,
+      value === 'none' ? null : parseInt(value, 10),
+    )
+  }
+
   const headRendered = (
     <>
       <style>{'p { margin: 0;}'}</style>
@@ -291,6 +321,47 @@ export const SnapshotPage = observer((props: Props) => {
                 </p>
               )}
             </div>
+            <div className={classes.summary}>
+              <p>
+                <strong>Deletion protection</strong>
+              </p>
+              <div className={classes.protectionControl}>
+                <Select
+                  label="Deletion protection"
+                  items={
+                    snapshot?.protected && protectedTillDate
+                      ? [
+                          {
+                            value: 'current',
+                            children: `Protected until ${protectedTillDate.toLocaleString()}`,
+                          },
+                          ...protectionOptions,
+                        ]
+                      : protectionOptions
+                  }
+                  value={getProtectionSelectValue(
+                    Boolean(snapshot?.protected),
+                    protectedTillDate,
+                  )}
+                  onChange={handleProtectionChange}
+                  disabled={isUpdatingSnapshot}
+                  fullWidth
+                />
+                {isUpdatingSnapshot && (
+                  <Spinner size="sm" className={classes.spinner} />
+                )}
+              </div>
+              <p className={classes.text}>
+                Protected snapshots cannot be deleted manually or automatically.
+              </p>
+              {updateSnapshotError && (
+                <ErrorStub
+                  title="Update error"
+                  message={updateSnapshotError}
+                  className={classes.marginTop}
+                />
+              )}
+            </div>
             <br />
             <p>
               <strong>Snapshot info</strong>

package/pages/Snapshots/Snapshot/stores/Main.ts

@@ -12,11 +12,13 @@ import {
   SnapshotsApi,
 } from '@postgres.ai/shared/stores/Snapshots'
 import { DestroySnapshot } from '@postgres.ai/shared/types/api/endpoints/destroySnapshot'
+import { UpdateSnapshot } from '@postgres.ai/shared/types/api/endpoints/updateSnapshot'
 import { SnapshotDto } from '@postgres.ai/shared/types/api/entities/snapshot'
 import { GetBranchSnapshot } from '@postgres.ai/shared/types/api/endpoints/getBranchSnapshot'
 import { BranchSnapshotDto } from '@postgres.ai/shared/types/api/entities/branchSnapshot'
 import { generateSnapshotPageId } from '@postgres.ai/shared/pages/Instance/Snapshots/utils'
 import { InitWS } from '@postgres.ai/shared/types/api/endpoints/initWS'
+import { getTextFromUnknownApiError } from '@postgres.ai/shared/utils/api'
 
 type Error = {
   title?: string
@@ -25,6 +27,7 @@ type Error = {
 
 export type Api = SnapshotsApi & {
   destroySnapshot: DestroySnapshot
+  updateSnapshot?: UpdateSnapshot
   getBranchSnapshot?: GetBranchSnapshot
   initWS?: InitWS
 }
@@ -37,6 +40,8 @@ export class MainStore {
   branchSnapshotError: Error | null = null
 
   isSnapshotsLoading = false
+  isUpdatingSnapshot = false
+  updateSnapshotError: string | null = null
 
   private readonly api: Api
   readonly snapshots: SnapshotsStore
@@ -99,6 +104,41 @@ export class MainStore {
     return response
   }
 
+  updateSnapshotProtection = async (
+    snapshotId: string,
+    instanceId: string,
+    durationMinutes: number | null,
+  ) => {
+    if (!this.api.updateSnapshot || !this.snapshot) return
+
+    this.isUpdatingSnapshot = true
+    this.updateSnapshotError = null
+
+    const prevProtected = this.snapshot.protected
+    const isProtected = durationMinutes !== null
+
+    this.snapshot.protected = isProtected
+
+    const { response, error } = await this.api.updateSnapshot({
+      instanceId,
+      snapshotId: this.snapshot.id,
+      snapshot: {
+        isProtected,
+        protectionDurationMinutes: durationMinutes ?? undefined,
+      },
+    })
+
+    if (response) {
+      await this.load(snapshotId, instanceId)
+    } else if (this.snapshot) {
+      this.snapshot.protected = prevProtected
+    }
+
+    if (error) this.updateSnapshotError = await getTextFromUnknownApiError(error)
+
+    this.isUpdatingSnapshot = false
+  }
+
   destroySnapshot = async (
     snapshotId: string,
     forceDelete: boolean,

package/stores/Snapshots.ts

@@ -40,8 +40,8 @@ export class SnapshotsStore {
     return this.loadData(instanceId)
   }
 
-  reload = (instanceId: string, branchName?: string) =>
-    this.loadData(instanceId, branchName)
+  reload = (instanceId: string, branchName?: string, silent?: boolean) =>
+    this.loadData(instanceId, branchName, silent)
 
   createSnapshot = async (
     cloneId: string,
@@ -72,21 +72,30 @@ export class SnapshotsStore {
     return response
   }
 
-  private loadData = async (instanceId: string, branchName?: string) => {
+  private loadData = async (
+    instanceId: string,
+    branchName?: string,
+    silent?: boolean,
+  ) => {
     if (!this.api.getSnapshots) return
 
-    this.isLoading = true
+    if (!silent) this.isLoading = true
 
     const { response, error } = await this.api.getSnapshots({
       instanceId,
       branchName,
     })
 
-    this.isLoading = false
+    if (!silent) this.isLoading = false
 
-    if (response) this.data = response
+    if (response) {
+      this.data = response
+      this.error = null
+    }
 
-    if (error) {
+    // a silent background refresh keeps the existing list on a transient failure; errors
+    // surface only on a foreground load.
+    if (error && !silent) {
       this.error = await error
         .json()
         .then((error) => error.details?.split('"message": "')[1]?.split('"')[0])

package/types/api/endpoints/getBranches.ts

@@ -8,6 +8,9 @@ export interface Branch {
   snapshotID: string
   dataset: string
   numSnapshots: number
+  protected: boolean
+  protectedTill?: string
+  deleteAt?: string
 }
 
 export const formatBranchesDto = (dto: Branch[]) =>

package/types/api/endpoints/probeSource.ts

@@ -0,0 +1,34 @@
+export type ProbeSourceRequest = {
+  url: string
+  password: string
+}
+
+export type SourceConnection = {
+  host: string
+  port: number
+  username: string
+  dbname: string
+}
+
+export type ProposedConfig = {
+  source: SourceConnection
+  detectedProvider: string
+  dockerImage: string
+  dockerTag: string
+  pgMajorVersion: number
+  databases: string[]
+  sharedBuffers: string
+  memoryProbed: boolean
+  sharedPreloadLibraries: string
+  queryTuning: { [key: string]: string }
+}
+
+export type ProbeSourceError = {
+  status: number
+  message: string
+}
+
+export type ProbeSource = (req: ProbeSourceRequest) => Promise<{
+  response: ProposedConfig | null
+  error: ProbeSourceError | null
+}>

package/types/api/endpoints/testDbSource.ts

@@ -33,7 +33,16 @@ export const formatTuningParams = (
   return formattedTuningParams
 }
 
-export const formatTuningParamsToObj = (tuningParams: string | undefined) => {
+export const formatTuningParamsToObj = (
+  tuningParams: string | { [key: string]: string } | undefined,
+) => {
+  // Simple mode seeds tuningParams as an object (the proposed queryTuning map);
+  // Expert mode keeps it as the textarea string. Pass an already-parsed object
+  // through unchanged so callers never run .split on a non-string.
+  if (tuningParams && typeof tuningParams === 'object') {
+    return tuningParams
+  }
+
   let formattedTuningParams: { [key: string]: string } = {}
 
   if (tuningParams) {

package/types/api/endpoints/updateBranch.ts

@@ -0,0 +1,11 @@
+export type UpdateBranch = (args: {
+  instanceId: string
+  branchName: string
+  branch: {
+    isProtected: boolean
+    protectionDurationMinutes?: number
+  }
+}) => Promise<{
+  response: true | null
+  error: Response | null
+}>

package/types/api/endpoints/updateSnapshot.ts

@@ -0,0 +1,11 @@
+export type UpdateSnapshot = (args: {
+  instanceId: string
+  snapshotId: string
+  snapshot: {
+    isProtected: boolean
+    protectionDurationMinutes?: number
+  }
+}) => Promise<{
+  response: true | null
+  error: Response | null
+}>

package/types/api/endpoints/upgradeClone.ts

@@ -0,0 +1,8 @@
+export type UpgradeClone = (args: {
+  instanceId: string
+  cloneId: string
+  dockerImage?: string
+}) => Promise<{
+  response: true | null
+  error: Response | null
+}>

package/types/api/entities/clone.ts

@@ -16,9 +16,21 @@ export type CloneDto = {
   id: string
   branch: string
   status: {
-    code: 'OK' | 'CREATING' | 'DELETING' | 'RESETTING' | 'FATAL'
+    code:
+      | 'OK'
+      | 'CREATING'
+      | 'DELETING'
+      | 'RESETTING'
+      | 'UPGRADING'
+      | 'WARNING'
+      | 'FATAL'
     message: string
   }
+  // Set once a clone has been upgraded to another major version; empty means the clone runs
+  // the engine-wide image.
+  dockerImage?: string
+  // PostgreSQL major version the clone is currently running.
+  dbVersion?: string
   protected: boolean
   protectedTill?: string
   metadata: {

package/types/api/entities/config.ts

@@ -11,10 +11,13 @@ export interface DatabaseType {
   [name: string]: string | Object
 }
 
+export type RetrievalMode = 'logical' | 'physical' | 'unknown' | ''
+
 export type configTypes = {
   global?: {
     debug?: boolean
   }
+  retrievalMode?: RetrievalMode
   databaseContainer?: {
     dockerImage?: string
     dockerPath?: string
@@ -54,14 +57,57 @@ export type configTypes = {
           configs?: { [key: string]: string }
         }
       }
+      physicalRestore?: {
+        options?: {
+          tool?: string
+          dockerImage?: string
+          sync?: {
+            enabled?: boolean
+          }
+          walg?: {
+            backupName?: string
+          }
+          pgbackrest?: {
+            stanza?: string
+            delta?: boolean
+          }
+          envs?: { [key: string]: string | number | boolean }
+        }
+      }
     }
   }
 }
 
+const formatPhysicalEnvs = (
+  envs?: { [key: string]: string | number | boolean } | null,
+): Array<{ key: string; value: string }> => {
+  if (!envs) return []
+  return Object.entries(envs).map(([key, value]) => ({
+    key,
+    value: typeof value === 'string' ? value : String(value),
+  }))
+}
+
+const inferRetrievalMode = (config: configTypes): RetrievalMode => {
+  if (config.retrievalMode) return config.retrievalMode
+  if (config.retrieval?.spec?.physicalRestore) return 'physical'
+  if (config.retrieval?.spec?.logicalDump) return 'logical'
+  return ''
+}
+
 export const formatConfig = (config: configTypes) => {
   const dockerImage = config.databaseContainer?.dockerImage
+  const physical = config.retrieval?.spec?.physicalRestore?.options
   return {
     debug: config.global?.debug,
+    retrievalMode: inferRetrievalMode(config),
+    physicalTool: physical?.tool ?? '',
+    physicalDockerImage: physical?.dockerImage ?? '',
+    physicalSyncEnabled: physical?.sync?.enabled ?? false,
+    physicalWalgBackupName: physical?.walg?.backupName ?? '',
+    physicalPgbackrestStanza: physical?.pgbackrest?.stanza ?? '',
+    physicalPgbackrestDelta: physical?.pgbackrest?.delta ?? false,
+    physicalEnvs: formatPhysicalEnvs(physical?.envs),
     dockerImage: isSeDockerImage(dockerImage)
       ? getImageMajorVersion(dockerImage)
       : dockerImage && getImageType(dockerImage) === 'Generic Postgres'

package/types/api/entities/instanceState.ts

@@ -19,6 +19,12 @@ export type InstanceStateDto = {
     code: 'OK' | 'WARNING' | 'NO_RESPONSE'
     message: string
   }
+  // Absent on engines that do not report it, which is the same as an upgrade being unavailable.
+  cloneUpgrade?: {
+    available: boolean
+    targetVersion?: number
+    reason?: string
+  }
   // Fallback for capability with old API.
   clones?: CloneDto[]
   // Fallback for capability with old API.

package/types/api/entities/snapshot.ts

@@ -11,6 +11,9 @@ export type SnapshotDto = {
   logicalSize: number
   message: string
   branch: string
+  protected: boolean
+  protectedTill?: string
+  deleteAt?: string
 }
 
 export const formatSnapshotDto = (dto: SnapshotDto) => ({

package/utils/api.ts

@@ -11,6 +11,14 @@ export const getTextFromUnknownApiError = async (error: Response) => {
   try {
     const result = await error.json()
     log(result)
+
+    // The engine answers with models.Error{code, message}. Showing the serialized object puts
+    // `{"code":"BAD_REQUEST","message":"..."}` in front of the user when the message alone is
+    // what they need; anything without a usable message still falls back to the raw body.
+    if (typeof result?.message === 'string' && result.message !== '') {
+      return result.message
+    }
+
     return JSON.stringify(result)
   } catch (e) {
     // not a json

package/utils/clone.ts

@@ -13,6 +13,8 @@ const STATUS_CODE_TO_TYPE = {
   CREATING: 'waiting' as const,
   DELETING: 'waiting' as const,
   RESETTING: 'waiting' as const,
+  UPGRADING: 'waiting' as const,
+  WARNING: 'warning' as const,
   FATAL: 'error' as const,
 }
 
@@ -27,5 +29,9 @@ export const getCloneStatusText = (statusCode: StatusCode) => {
   return capitalize(statusCode)
 }
 
+// WARNING is terminal too: it means the clone is running, just not on the version that was
+// requested. Leaving it out would make the clone page poll forever after a failed upgrade.
 export const checkIsCloneStable = (clone: Clone) =>
-  clone.status.code === 'OK' || clone.status.code === 'FATAL'
+  clone.status.code === 'OK' ||
+  clone.status.code === 'WARNING' ||
+  clone.status.code === 'FATAL'