Merge branch '439-disable-config-modification' into 'master'

agneum · agneum · commit 6c68022ec07d · 2022-11-07T14:42:15.000Z
fix(engine): disable config modification (#439)

Closes #439

See merge request postgres-ai/database-lab!641
diff --git a/engine/api/swagger-spec/dblab_server_swagger.yaml b/engine/api/swagger-spec/dblab_server_swagger.yaml
@@ -686,7 +686,7 @@ definitions:
         format: "date-time"
       telemetry:
         type: boolean
-      allowModifyingConfig:
+      disableConfigModification:
         type: boolean
 
   PoolEntry:
diff --git a/engine/configs/config.example.logical_generic.yml b/engine/configs/config.example.logical_generic.yml
@@ -23,8 +23,8 @@ server:
   # HTTP server port. Default: 2345.
   port: 2345
 
-  # Allow modifying configuration via UI/API. Default: true.
-  allowModifyingConfig: true
+  # Disable modifying configuration via UI/API. Default: false.
+  disableConfigModification: false
 
 # Embedded UI. Controls the application to provide a user interface to DLE API.
 embeddedUI:
diff --git a/engine/configs/config.example.logical_rds_iam.yml b/engine/configs/config.example.logical_rds_iam.yml
@@ -23,8 +23,8 @@ server:
   # HTTP server port. Default: 2345.
   port: 2345
 
-  # Allow modifying configuration via UI/API. Default: true.
-  allowModifyingConfig: true
+  # Disable modifying configuration via UI/API. Default: false.
+  disableConfigModification: false
 
 # Embedded UI. Controls the application to provide a user interface to DLE API.
 embeddedUI:
diff --git a/engine/configs/config.example.physical_generic.yml b/engine/configs/config.example.physical_generic.yml
@@ -23,8 +23,8 @@ server:
   # HTTP server port. Default: 2345.
   port: 2345
 
-  # Allow modifying configuration via UI/API. Default: true.
-  allowModifyingConfig: true
+  # Disable modifying configuration via UI/API. Default: false.
+  disableConfigModification: false
 
 # Embedded UI. Controls the application to provide a user interface to DLE API.
 embeddedUI:
diff --git a/engine/configs/config.example.physical_pgbackrest.yml b/engine/configs/config.example.physical_pgbackrest.yml
@@ -23,8 +23,8 @@ server:
   # HTTP server port. Default: 2345.
   port: 2345
 
-  # Allow modifying configuration via UI/API. Default: true.
-  allowModifyingConfig: true
+  # Disable modifying configuration via UI/API. Default: false.
+  disableConfigModification: false
 
 # Embedded UI. Controls the application to provide a user interface to DLE API.
 embeddedUI:
diff --git a/engine/configs/config.example.physical_walg.yml b/engine/configs/config.example.physical_walg.yml
@@ -23,8 +23,8 @@ server:
   # HTTP server port. Default: 2345.
   port: 2345
 
-  # Allow modifying configuration via UI/API. Default: true.
-  allowModifyingConfig: true
+  # Disable modifying configuration via UI/API. Default: false.
+  disableConfigModification: false
 
 # Embedded UI. Controls the application to provide a user interface to DLE API.
 embeddedUI:
diff --git a/engine/internal/srv/config.go b/engine/internal/srv/config.go
@@ -60,7 +60,7 @@ func (s *Server) getAdminConfigYaml(w http.ResponseWriter, r *http.Request) {
 }
 
 func (s *Server) setProjectedAdminConfig(w http.ResponseWriter, r *http.Request) {
-	if !s.Config.AllowModifyingConfig {
+	if s.Config.DisableConfigModification {
 		api.SendBadRequestError(w, r, configManagementDenied)
 		return
 	}
@@ -99,7 +99,7 @@ func (s *Server) setProjectedAdminConfig(w http.ResponseWriter, r *http.Request)
 }
 
 func (s *Server) testDBSource(w http.ResponseWriter, r *http.Request) {
-	if !s.Config.AllowModifyingConfig {
+	if s.Config.DisableConfigModification {
 		api.SendBadRequestError(w, r, configManagementDenied)
 		return
 	}
diff --git a/engine/internal/srv/config/config.go b/engine/internal/srv/config/config.go
@@ -5,10 +5,10 @@
 // Package config contains configuration options of HTTP server.
 package config
 
-// Config provides configuration for an HTTP server of the Database Lab.
+// Config provides configuration management via DLE API
 type Config struct {
-	VerificationToken    string `yaml:"verificationToken" json:"-"`
-	Host                 string `yaml:"host"`
-	Port                 uint   `yaml:"port"`
-	AllowModifyingConfig bool   `yaml:"allowModifyingConfig" json:"-"`
+	VerificationToken         string `yaml:"verificationToken" json:"-"`
+	Host                      string `yaml:"host"`
+	Port                      uint   `yaml:"port"`
+	DisableConfigModification bool   `yaml:"disableConfigModification" json:"-"`
 }
diff --git a/engine/internal/srv/server.go b/engine/internal/srv/server.go
@@ -111,11 +111,11 @@ func (s *Server) instanceStatus() *models.InstanceStatus {
 			Message: models.InstanceMessageOK,
 		},
 		Engine: models.Engine{
-			Version:              version.GetVersion(),
-			Edition:              s.engProps.GetEdition(),
-			StartedAt:            s.startedAt,
-			Telemetry:            pointer.ToBool(s.tm.IsEnabled()),
-			AllowModifyingConfig: pointer.ToBool(s.Config.AllowModifyingConfig),
+			Version:                   version.GetVersion(),
+			Edition:                   s.engProps.GetEdition(),
+			StartedAt:                 s.startedAt,
+			Telemetry:                 pointer.ToBool(s.tm.IsEnabled()),
+			DisableConfigModification: pointer.ToBool(s.Config.DisableConfigModification),
 		},
 		Pools:       s.provisioner.GetPoolEntryList(),
 		Cloning:     s.Cloning.GetCloningState(),
diff --git a/engine/pkg/models/instance_status.go b/engine/pkg/models/instance_status.go
@@ -44,11 +44,11 @@ type Cloning struct {
 
 // Engine represents info about Database Lab Engine instance.
 type Engine struct {
-	Version              string     `json:"version"`
-	Edition              string     `json:"edition"`
-	StartedAt            *LocalTime `json:"startedAt,omitempty"`
-	Telemetry            *bool      `json:"telemetry,omitempty"`
-	AllowModifyingConfig *bool      `json:"allowModifyingConfig,omitempty"`
+	Version                   string     `json:"version"`
+	Edition                   string     `json:"edition"`
+	StartedAt                 *LocalTime `json:"startedAt,omitempty"`
+	Telemetry                 *bool      `json:"telemetry,omitempty"`
+	DisableConfigModification *bool      `json:"disableConfigModification,omitempty"`
 }
 
 // CloneList represents a list of clones.
diff --git a/ui/packages/shared/pages/Configuration/index.tsx b/ui/packages/shared/pages/Configuration/index.tsx
@@ -54,13 +54,13 @@ export const Configuration = observer(
     activeTab,
     reload,
     isConfigurationActive,
-    allowModifyingConfig,
+    disableConfigModification,
   }: {
     switchActiveTab: (_: null, activeTab: number) => void
     activeTab: number
     reload: () => void
     isConfigurationActive: boolean
-    allowModifyingConfig?: boolean
+    disableConfigModification?: boolean
   }) => {
     const classes = useStyles()
     const stores = useStores()
@@ -76,7 +76,7 @@ export const Configuration = observer(
     } = stores.main
     const configData = config && JSON.parse(JSON.stringify(config))
     const isConfigurationDisabled =
-      !isConfigurationActive || !allowModifyingConfig
+      !isConfigurationActive || disableConfigModification
     const [submitMessage, setSubmitMessage] = useState<
       string | React.ReactNode | null
     >('')
@@ -190,7 +190,7 @@ export const Configuration = observer(
           anchorOrigin={{ vertical: 'bottom', horizontal: 'right' }}
           open={isConfigurationDisabled && !isOpen}
           message={
-            !allowModifyingConfig
+            disableConfigModification
               ? PREVENT_MODIFYING_MESSAGE
               : NON_LOGICAL_RETRIEVAL_MESSAGE
           }
diff --git a/ui/packages/shared/pages/Instance/index.tsx b/ui/packages/shared/pages/Instance/index.tsx
@@ -152,7 +152,7 @@ export const Instance = observer((props: Props) => {
         <TabPanel value={activeTab} index={2}>
           <Configuration 
               isConfigurationActive={isConfigurationActive}
-              allowModifyingConfig={instance?.state.engine.allowModifyingConfig}
+              disableConfigModification={instance?.state.engine.disableConfigModification}
               switchActiveTab={switchTab} 
               activeTab={activeTab} 
               reload={() => stores.main.load(props.instanceId)} 
diff --git a/ui/packages/shared/types/api/entities/instanceState.ts b/ui/packages/shared/types/api/entities/instanceState.ts
@@ -46,7 +46,7 @@ export type InstanceStateDto = {
   engine?: {
     version: string
     startedAt: string
-    allowModifyingConfig?: boolean
+    disableConfigModification?: boolean
   }
   dataSize?: number
 }
@@ -63,7 +63,7 @@ export const formatInstanceStateDto = (dto: InstanceStateDto) => {
     engine: {
       version: dto.engine?.version ?? null,
       startedAt: dto.engine?.startedAt && new Date(dto.engine?.startedAt),
-      allowModifyingConfig: dto.engine?.allowModifyingConfig
+      disableConfigModification: dto.engine?.disableConfigModification,
     },
     retrieving: dto.retrieving && {
       lastRefresh: dto.retrieving.lastRefresh

Original file line number	Diff line number	Diff line change
`@@ -60,7 +60,7 @@ func (s Server) getAdminConfigYaml(w http.ResponseWriter, r http.Request) {`
`60`	`60`	`}`
`61`	`61`
`62`	`62`	`func (s Server) setProjectedAdminConfig(w http.ResponseWriter, r http.Request) {`
`63`		`- if !s.Config.AllowModifyingConfig {`
	`63`	`+ if s.Config.DisableConfigModification {`
`64`	`64`	`api.SendBadRequestError(w, r, configManagementDenied)`
`65`	`65`	`return`
`66`	`66`	`}`
`@@ -99,7 +99,7 @@ func (s Server) setProjectedAdminConfig(w http.ResponseWriter, r http.Request)`
`99`	`99`	`}`
`100`	`100`
`101`	`101`	`func (s Server) testDBSource(w http.ResponseWriter, r http.Request) {`
`102`		`- if !s.Config.AllowModifyingConfig {`
	`102`	`+ if s.Config.DisableConfigModification {`
`103`	`103`	`api.SendBadRequestError(w, r, configManagementDenied)`
`104`	`104`	`return`
`105`	`105`	`}`