@postgres.ai/shared 4.0.3 → 4.1.0

package/styles/styles.ts

@@ -0,0 +1,87 @@
+/*--------------------------------------------------------------------------
+ * Copyright (c) 2019-2021, Postgres.ai, Nikolay Samokhvalov nik@postgres.ai
+ * All Rights Reserved. Proprietary and confidential.
+ * Unauthorized copying of this file, via any medium is strictly prohibited
+ *--------------------------------------------------------------------------
+ */
+
+import { colors } from './colors'
+import { theme } from './theme'
+
+export const styles: Record<string, any> = {
+  root: {
+    'minHeight': '100%',
+    width: '100%',
+    'zIndex': 1,
+    position: 'relative',
+    [theme.breakpoints.down('sm')]: {
+      maxWidth: '100vw',
+    },
+    [theme.breakpoints.up('md')]: {
+      maxWidth: 'calc(100vw - 200px)',
+    },
+    [theme.breakpoints.up('lg')]: {
+      maxWidth: 'calc(100vw - 200px)',
+    },
+    '& h2': {
+      ...theme.typography.h2,
+    },
+    '& h3': {
+      ...theme.typography.h3,
+    },
+    '& h4': {
+      ...theme.typography.h4,
+    },
+    '& th': {
+      fontSize: '14px',
+      lineHeight: '16px',
+      fontWeight: 'bold',
+      color: colors.consoleFadedFont,
+    },
+  },
+  inputField: {
+    'margin-bottom': '10px',
+    '& > div.MuiFormControl- > label': {
+      fontSize: '14px!important',
+    },
+    '& .MuiOutlinedInput-input, & .MuiOutlinedInput-multiline, & .MuiSelect-select':
+      {
+        padding: '8px!important',
+        fontSize: 14,
+      },
+    '& .MuiSelect-icon': {
+      fontSize: 22,
+    },
+    '& .MuiInputBase-multiline': {
+      padding: '0px!important',
+    },
+  },
+  inputFieldLabel: {
+    fontSize: 14,
+  },
+  inputFieldHelper: {
+    fontSize: 11,
+    marginLeft: '10px',
+  },
+  checkbox: {
+    'font-size': '14px!important',
+    '& > span.MuiFormControlLabel-label': {
+      fontSize: 14,
+    },
+  },
+
+  tableHead: {
+    height: '30px',
+    lineHeight: '30px',
+    position: 'relative',
+  },
+  tableHeadActions: {
+    position: 'absolute',
+    right: '0px',
+    top: '0px',
+  },
+  bottomSpace: {
+    display: 'block',
+    height: 130,
+  },
+}

package/styles/theme.ts

@@ -0,0 +1,53 @@
+/*--------------------------------------------------------------------------
+ * Copyright (c) 2019-2021, Postgres.ai, Nikolay Samokhvalov nik@postgres.ai
+ * All Rights Reserved. Proprietary and confidential.
+ * Unauthorized copying of this file, via any medium is strictly prohibited
+ *--------------------------------------------------------------------------
+ */
+
+import { createTheme } from '@material-ui/core'
+
+import { colors } from './colors'
+
+export const theme = createTheme({
+  // @ts-ignore
+  fontFamily: '"Roboto", "Helvetica", "Arial", sans-serif',
+  palette: {
+    primary: {
+      main: colors.secondary2.main,
+      contrastText: colors.secondary2.contrastText,
+      dark: colors.secondary2.dark,
+    },
+    secondary: {
+      main: colors.secondary2.main,
+      contrastText: colors.secondary2.contrastText,
+      dark: colors.secondary2.dark,
+    },
+  },
+  typography: {
+    htmlFontSize: 14,
+    fontFamily: '"Roboto", "Helvetica", "Arial", sans-serif',
+    // @ts-ignore
+    fontSize: '14px!important',
+    h1: {
+      fontSize: '16px!important',
+    },
+    h2: {
+      fontSize: '14px!important',
+      fontWeight: 'bold',
+    },
+    h3: {
+      fontSize: '14px!important',
+      fontWeight: 'normal',
+    },
+    button: {
+      fontFamily: '"Roboto", "Helvetica", "Arial", sans-serif',
+      textTransform: 'unset',
+      fontStyle: 'normal',
+      fontSize: '14px',
+      lineHeight: '18px',
+      alignItems: 'center',
+      textAlign: 'center',
+    },
+  },
+})

package/styles/vars.ts

@@ -0,0 +1,40 @@
+/*--------------------------------------------------------------------------
+ * Copyright (c) 2019-2021, Postgres.ai, Nikolay Samokhvalov nik@postgres.ai
+ * All Rights Reserved. Proprietary and confidential.
+ * Unauthorized copying of this file, via any medium is strictly prohibited
+ *--------------------------------------------------------------------------
+ */
+
+// Colors.
+const colorGray = '#c0c0c0'
+
+export const colors = {
+  white: '#fff',
+  gray: '#D6D6D6',
+
+  status: {
+    ok: '#0db94d',
+    warning: '#fd8411',
+    error: '#ff2020',
+    waiting: '#ffad5f',
+    unknown: colorGray
+  }
+}
+
+// Mixins.
+export const createTransitionInteractive = (...props: string[]) =>
+  props.map((prop) => `${prop} .2s ease-out`).join(',');
+
+export const borderRadius = '4px';
+
+export const resetStyles = {
+  margin: 0,
+  padding: 0,
+}
+
+export const resetStylesRoot = {
+  ...resetStyles,
+  '& *': {
+    ...resetStyles
+  }
+}

package/tsconfig.build.json

@@ -30,7 +30,6 @@
       "node_modules",
       "dist",
       "meta.json",
-      "craco.config.js",
       "**/*.test.ts",
       "**/*.test.tsx"
     ]

package/types/api/endpoints/createBranch.ts

@@ -0,0 +1,14 @@
+import { CreateBranchResponse } from '@postgres.ai/shared/types/api/entities/createBranch'
+
+export type CreateBranchFormValues = {
+  branchName: string
+  instanceId: string
+  baseBranch: string
+  snapshotID: string
+  creationType?: 'branch' | 'snapshot'
+}
+
+export type CreateBranch = (values: CreateBranchFormValues) => Promise<{
+  response: CreateBranchResponse | null
+  error: Response | null
+}>

package/types/api/endpoints/createClone.ts

@@ -0,0 +1,11 @@
+import { Clone } from '@postgres.ai/shared/types/api/entities/clone'
+
+export type CreateClone = (args: {
+  instanceId: string
+  cloneId: string
+  snapshotId: string
+  dbUser: string
+  dbPassword: string
+  protectionDurationMinutes: string
+  branch?: string
+}) => Promise<{ response: Clone | null; error: Response | null }>

package/types/api/endpoints/createSnapshot.ts

@@ -0,0 +1,10 @@
+import { CreateSnapshotResponse } from '@postgres.ai/shared/types/api/entities/createSnapshot'
+
+export type CreateSnapshot = (
+  cloneID: string,
+  message: string,
+  instanceId: string,
+) => Promise<{
+  response: CreateSnapshotResponse | null
+  error: Response | null
+}>

package/types/api/endpoints/deleteBranch.ts

@@ -0,0 +1,4 @@
+export type DeleteBranch = (
+  branchName: string,
+  instanceId: string,
+) => Promise<{ response: Response | null; error: Error | null }>

package/types/api/endpoints/destroyClone.ts

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

package/types/api/endpoints/destroySnapshot.ts

@@ -0,0 +1,8 @@
+export type DestroySnapshot = (
+  snapshotId: string,
+  forceDelete: boolean,
+  instanceId: string,
+) => Promise<{
+  response: boolean | null
+  error: Response | null
+}>

package/types/api/endpoints/fullRefresh.ts

@@ -0,0 +1,6 @@
+export type FullRefresh = (args: {
+  instanceId: string
+}) => Promise<{
+  response: string | null
+  error: Response | null
+}>

package/types/api/endpoints/getBranchSnapshot.ts

@@ -0,0 +1,6 @@
+import { BranchSnapshotDto } from '@postgres.ai/shared/types/api/entities/branchSnapshot'
+
+export type GetBranchSnapshot = (
+  snapshotId: string,
+  instanceId: string,
+) => Promise<{ response: BranchSnapshotDto | null; error: Response | null }>

package/types/api/endpoints/getBranches.ts

@@ -0,0 +1,22 @@
+import { formatDateToISO } from '@postgres.ai/shared/utils/date'
+
+export interface Branch {
+  name: string
+  baseDataset: string
+  parent: string
+  dataStateAt: string
+  snapshotID: string
+  dataset: string
+  numSnapshots: number
+}
+
+export const formatBranchesDto = (dto: Branch[]) =>
+  dto.map((item) => ({
+    ...item,
+    dataStateAt: formatDateToISO(item.dataStateAt),
+  }))
+
+export type GetBranches = (instanceId: string) => Promise<{
+  response: Branch[] | null
+  error: Response | null
+}>

package/types/api/endpoints/getClone.ts

@@ -0,0 +1,6 @@
+import { Clone } from '@postgres.ai/shared/types/api/entities/clone'
+
+export type GetClone = (args: {
+  instanceId: string
+  cloneId: string
+}) => Promise<{ response: Clone | null; error: Response | null }>

package/types/api/endpoints/getConfig.ts

@@ -0,0 +1,6 @@
+import { Config } from '../entities/config'
+
+export type GetConfig = (instanceId: string) => Promise<{
+  response: Config | null
+  error: Response | null
+}>

package/types/api/endpoints/getEngine.ts

@@ -0,0 +1,13 @@
+export type EngineDto = {
+  version: string
+  edition?: string
+}
+
+export type GetEngine = (instanceId: string) => Promise<{
+  response: EngineType | null
+  error: Response | null
+}>
+
+export const formatEngineDto = (dto: EngineDto) => dto
+
+export type EngineType = ReturnType<typeof formatEngineDto>

package/types/api/endpoints/getFullConfig.ts

@@ -0,0 +1,4 @@
+export type GetFullConfig = (instanceId: string) => Promise<{
+  response: string | null
+  error: Response | any | null
+}>

package/types/api/endpoints/getInstance.ts

@@ -0,0 +1,6 @@
+import { Instance } from '@postgres.ai/shared/types/api/entities/instance'
+
+export type GetInstance = (args: { instanceId: string }) => Promise<{
+  response: Instance | null
+  error: Response | null
+}>

package/types/api/endpoints/getInstanceRetrieval.ts

@@ -0,0 +1,6 @@
+import { InstanceRetrievalType } from '@postgres.ai/shared/types/api/entities/instanceRetrieval'
+
+export type GetInstanceRetrieval = (args: { instanceId: string }) => Promise<{
+  response: InstanceRetrievalType | null
+  error: Response | null
+}>

package/types/api/endpoints/getSeImages.ts

@@ -0,0 +1,22 @@
+export type GetSeImages = (args: {
+  packageGroup: string
+  platformUrl?: string
+}) => Promise<{
+  response: InstanceRetrievalType | null
+  error: Response | null
+}>
+
+export interface SeImages {
+  org_id?: number
+  package_group: string
+  pg_major_version: string
+  tag: string
+  pg_config_presets?: {
+    shared_preload_libraries: string
+  }
+  location: string
+}
+
+export const formatSeImages = (seImages: SeImages[]) => seImages
+
+export type InstanceRetrievalType = ReturnType<typeof formatSeImages>

package/types/api/endpoints/getSnapshotList.ts

@@ -0,0 +1,14 @@
+export interface SnapshotList {
+  branch: string[]
+  id: string
+  dataStateAt: string
+  message: string
+}
+
+export type GetSnapshotList = (
+  branchName: string,
+  instanceId: string,
+) => Promise<{
+  response: SnapshotList[] | null
+  error: Response | null
+}>

package/types/api/endpoints/getSnapshots.ts

@@ -0,0 +1,6 @@
+import { Snapshot } from '@postgres.ai/shared/types/api/entities/snapshot'
+
+export type GetSnapshots = (args: { instanceId: string, branchName?: string, dataset?: string }) => Promise<{
+  response: Snapshot[] | null
+  error: Response | null
+}>

package/types/api/endpoints/getWSToken.ts

@@ -0,0 +1,6 @@
+import { WSToken } from '@postgres.ai/shared/types/api/entities/wsToken'
+
+export type GetWSToken = (args: { instanceId: string }) => Promise<{
+  response: WSToken | null
+  error: Response | null
+}>

package/types/api/endpoints/initWS.ts

@@ -0,0 +1 @@
+export type InitWS = ( path: string, token: string ) => WebSocket

package/types/api/endpoints/refreshInstance.ts

@@ -0,0 +1,4 @@
+export type RefreshInstance = (args: { instanceId: string }) => Promise<{
+  response: boolean | null
+  error: Response | null
+}>

package/types/api/endpoints/resetClone.ts

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

package/types/api/endpoints/testDbSource.ts

@@ -0,0 +1,48 @@
+import { dbSource } from '@postgres.ai/shared/types/api/entities/dbSource'
+
+export type TestDbSource = (values: dbSource) => Promise<{
+  response: {
+    status: number
+    message: string
+    result: string
+    dbVersion: number
+    tuningParams: {
+      [key: string]: string
+    }
+  } | null
+  error: {
+    status: number
+    message: string
+  }
+}>
+
+export const formatTuningParams = (
+  tuningParams: { [key: string]: string } | undefined,
+) => {
+  let formattedTuningParams = ''
+
+  if (tuningParams && Object.keys(tuningParams).length > 0) {
+    Object.entries(tuningParams).forEach(([key, value], index) => {
+      if (key !== 'shared_preload_libraries' && key !== 'shared_buffers') {
+        formattedTuningParams += `${key}=${value}\n`
+      }
+    })
+    formattedTuningParams = formattedTuningParams.slice(0, -1)
+  }
+
+  return formattedTuningParams
+}
+
+export const formatTuningParamsToObj = (tuningParams: string | undefined) => {
+  let formattedTuningParams: { [key: string]: string } = {}
+
+  if (tuningParams) {
+    const tuningParamsArr = tuningParams.split('\n')
+    tuningParamsArr.forEach((param) => {
+      const paramArr = param.split('=')
+      formattedTuningParams[paramArr[0]] = paramArr[1]
+    })
+  }
+
+  return formattedTuningParams
+}

package/types/api/endpoints/updateClone.ts

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

package/types/api/endpoints/updateConfig.ts

@@ -0,0 +1,9 @@
+import { Config } from '@postgres.ai/shared/types/api/entities/config'
+
+export type UpdateConfig = (
+  values: Config,
+  instanceId: string,
+) => Promise<{
+  response: Response | null
+  error: Response | null
+}>

package/types/api/entities/branchSnapshot.ts

@@ -0,0 +1,8 @@
+export type BranchSnapshotDTO = {
+  message: string
+  branch: string[]
+}
+
+export const formatBranchSnapshotDto = (dto: BranchSnapshotDTO) => dto
+
+export type BranchSnapshotDto = ReturnType<typeof formatBranchSnapshotDto>

package/types/api/entities/branchSnapshots.ts

@@ -0,0 +1,10 @@
+import { parseDate } from '@postgres.ai/shared/utils/date'
+import { SnapshotDto } from './snapshot'
+
+export const formatBranchSnapshotDto = (dto: SnapshotDto[]) =>
+  dto.map((item) => ({
+    ...item,
+    numClones: item.numClones.toString(),
+    createdAtDate: parseDate(item.createdAt),
+    dataStateAtDate: parseDate(item.dataStateAt),
+  }))

package/types/api/entities/clone.ts

@@ -0,0 +1,47 @@
+/*--------------------------------------------------------------------------
+ * Copyright (c) 2019-2021, Postgres.ai, Nikolay Samokhvalov nik@postgres.ai
+ * All Rights Reserved. Proprietary and confidential.
+ * Unauthorized copying of this file, via any medium is strictly prohibited
+ *--------------------------------------------------------------------------
+ */
+
+import { parseDate } from '@postgres.ai/shared/utils/date'
+import {
+  SnapshotDto,
+  formatSnapshotDto,
+} from '@postgres.ai/shared/types/api/entities/snapshot'
+
+export type CloneDto = {
+  createdAt: string
+  id: string
+  branch: string
+  status: {
+    code: 'OK' | 'CREATING' | 'DELETING' | 'RESETTING' | 'FATAL'
+    message: string
+  }
+  protected: boolean
+  protectedTill?: string
+  metadata: {
+    cloneDiffSize: number
+    cloningTime: number
+    protectionLeaseDurationMinutes?: number
+    protectionMaxDurationMinutes?: number
+  }
+  db: {
+    username: string
+    port: string
+    host: string
+  }
+  // Possible bug, when snapshot is null.
+  snapshot: SnapshotDto | null
+}
+
+export const formatCloneDto = (dto: CloneDto) => ({
+  ...dto,
+  createdAt: dto.createdAt,
+  createdAtDate: parseDate(dto.createdAt),
+  protectedTillDate: dto.protectedTill ? parseDate(dto.protectedTill) : null,
+  snapshot: dto.snapshot ? formatSnapshotDto(dto.snapshot) : null,
+})
+
+export type Clone = ReturnType<typeof formatCloneDto>

package/types/api/entities/config.ts

@@ -0,0 +1,117 @@
+import {
+  formatDatabases,
+  formatDumpCustomOptions,
+  getImageMajorVersion,
+  getImageType,
+  isSeDockerImage,
+} from '@postgres.ai/shared/pages/Instance/Configuration/utils'
+import { formatTuningParams } from '../endpoints/testDbSource'
+
+export interface DatabaseType {
+  [name: string]: string | Object
+}
+
+export type configTypes = {
+  global?: {
+    debug?: boolean
+  }
+  databaseContainer?: {
+    dockerImage?: string
+    dockerPath?: string
+  }
+  databaseConfigs?: {
+    configs?: {
+      [key: string]: string
+    }
+  }
+  retrieval?: {
+    refresh?: {
+      timetable?: string
+    }
+    spec?: {
+      logicalDump?: {
+        options?: {
+          customOptions?: string[]
+          databases?: DatabaseType | null
+          parallelJobs?: string | number
+          ignoreErrors?: boolean
+          source?: {
+            connection?: {
+              dbname?: string
+              host?: string
+              port?: string | number
+              username?: string
+              password?: string
+            }
+          }
+        }
+      }
+      logicalRestore?: {
+        options?: {
+          customOptions?: string[]
+          parallelJobs?: string | number
+          ignoreErrors?: boolean
+        }
+      }
+    }
+  }
+}
+
+export const formatConfig = (config: configTypes) => {
+  const dockerImage = config.databaseContainer?.dockerImage
+  return {
+    debug: config.global?.debug,
+    dockerImage: isSeDockerImage(dockerImage)
+      ? getImageMajorVersion(dockerImage)
+      : dockerImage && getImageType(dockerImage) === 'Generic Postgres'
+      ? getImageMajorVersion(dockerImage) || dockerImage
+      : dockerImage,
+    ...(dockerImage && {
+      dockerImageType: getImageType(dockerImage),
+    }),
+    // Extract dockerTag for both SE images and Generic Postgres images
+    ...(dockerImage && dockerImage.includes(':') && {
+      dockerTag: dockerImage.split(':')[1],
+    }),
+    dockerPath: dockerImage,
+    tuningParams: formatTuningParams(config.databaseConfigs?.configs),
+    sharedBuffers: config.databaseConfigs?.configs?.shared_buffers,
+    sharedPreloadLibraries:
+      config.databaseConfigs?.configs?.shared_preload_libraries,
+    timetable: config.retrieval?.refresh?.timetable,
+    dbname:
+      config.retrieval?.spec?.logicalDump?.options?.source?.connection?.dbname,
+    host: config.retrieval?.spec?.logicalDump?.options?.source?.connection
+      ?.host,
+    port: config.retrieval?.spec?.logicalDump?.options?.source?.connection
+      ?.port,
+    username:
+      config.retrieval?.spec?.logicalDump?.options?.source?.connection
+        ?.username,
+    password:
+      config.retrieval?.spec?.logicalDump?.options?.source?.connection
+        ?.password,
+    databases: formatDatabases(
+      (config.retrieval?.spec?.logicalDump?.options
+        ?.databases as DatabaseType | undefined) ?? null,
+    ),
+    dumpParallelJobs:
+      config.retrieval?.spec?.logicalDump?.options?.parallelJobs,
+    dumpIgnoreErrors:
+      config.retrieval?.spec?.logicalDump?.options?.ignoreErrors,
+    restoreParallelJobs:
+      config.retrieval?.spec?.logicalRestore?.options?.parallelJobs,
+    restoreIgnoreErrors:
+      config.retrieval?.spec?.logicalRestore?.options?.ignoreErrors,
+    pgDumpCustomOptions: formatDumpCustomOptions(
+      (config.retrieval?.spec?.logicalDump?.options
+        ?.customOptions as string[] | undefined) ?? null,
+    ),
+    pgRestoreCustomOptions: formatDumpCustomOptions(
+      (config.retrieval?.spec?.logicalRestore?.options
+        ?.customOptions as string[] | undefined) ?? null,
+    ),
+  }
+}
+
+export type Config = ReturnType<typeof formatConfig>