change: [UIE-8685] - Advanced Config: custom validation for wal_sender_timeout (linode#12022)

* change: [UIE-8685] - add new field to Config item

* Added changeset: DBaaS: `anyOf` field to the `ConfigurationItem`

* Added changeset: validation for config items with an `anyOf` field that defines a range

* add temporary custom validation (no backend support yet)

* add temporary custom validation for max_failover_replication_time_lag

* update changeset

---------

Co-authored-by: cpathipa <[email protected]>

Author: mpolotsk-akamai

packages/api-v4/src/databases/types.ts

@@ -50,6 +50,7 @@ export interface DatabaseBackup {
   label: string;
   type: DatabaseBackupType;
 }
+
 export interface ConfigurationItem {
   description?: string;
   enum?: string[];

packages/manager/src/factories/databases.ts

@@ -126,8 +126,8 @@ export const databaseTypeFactory = Factory.Sync.makeFactory<DatabaseType>({
 
 const adb10 = (i: number) => i % 2 === 0;
 
-export const databaseInstanceFactory = Factory.Sync.makeFactory<DatabaseInstance>(
-  {
+export const databaseInstanceFactory =
+  Factory.Sync.makeFactory<DatabaseInstance>({
     allow_list: [],
     cluster_size: Factory.each((i) =>
       adb10(i)
@@ -187,8 +187,7 @@ export const databaseInstanceFactory = Factory.Sync.makeFactory<DatabaseInstance
       week_of_month: null,
     },
     version: Factory.each((i) => ['8.0.30', '15.7'][i % 2]),
-  }
-);
+  });
 
 export const databaseFactory = Factory.Sync.makeFactory<Database>({
   allow_list: [...IPv4List],
@@ -273,8 +272,8 @@ export const databaseEngineFactory = Factory.Sync.makeFactory<DatabaseEngine>({
   version: Factory.each((i) => `${i}`),
 });
 
-export const databaseEngineConfigFactory = Factory.Sync.makeFactory<DatabaseEngineConfig>(
-  {
+export const databaseEngineConfigFactory =
+  Factory.Sync.makeFactory<DatabaseEngineConfig>({
     binlog_retention_period: {
       description:
         'The minimum amount of time in seconds to keep binlog entries before deletion. This may be extended for services that require binlog entries for longer than the default for example if using the MySQL Debezium Kafka connector.',
@@ -284,6 +283,12 @@ export const databaseEngineConfigFactory = Factory.Sync.makeFactory<DatabaseEngi
       requires_restart: false,
       type: 'integer',
     },
+    wal_sender_timeout: {
+      description:
+        'Terminate replication connections that are inactive for longer than this amount of time, in milliseconds. Setting this value to zero disables the timeout.',
+      type: 'integer',
+      example: 60000,
+    },
     mysql: {
       connect_timeout: {
         description:
@@ -370,5 +375,4 @@ export const databaseEngineConfigFactory = Factory.Sync.makeFactory<DatabaseEngi
       requires_restart: false,
       type: ['boolean', 'null'],
     },
-  }
-);
+  });

packages/validation/.changeset/pr-12022-added-1744640788599.md

@@ -0,0 +1,5 @@
+---
+"@linode/validation": Added
+---
+
+custom validation for `wal_sender_timeout` and `max_failover_replication_time_lag` ([#12022](https://github.com/linode/manager/pull/12022))

packages/validation/src/databases.schema.ts

@@ -103,11 +103,28 @@ const applyConstraints = (validator: any, key: string, field: any) => {
       `Please ensure that ${key} follows the format ${field.example}`,
     );
   }
+  // custom validation for wal_sender_timeout since it has a special case
+  // where it can be 0 or between 5000 and 10800000
+  if (key === 'wal_sender_timeout') {
+    validator = validator.test(
+      'is-zero-or-in-range',
+      `${key} must be 0 or between 5000 and 10800000`,
+      (value: boolean | number | string) => {
+        if (typeof value !== 'number') return false;
+        return value === 0 || (value >= 5000 && value <= 10800000);
+      },
+    );
+  }
   if (key === 'timezone') {
     if (!field.value) {
       validator = validator.required('timezone cannot be empty');
     }
   }
+  // temporary custom validation for max_failover_replication_time_lag
+  // TODO: remove this when the API is updated
+  if (key === 'max_failover_replication_time_lag') {
+    validator = validator.max(999999, `${key} must be at most 999999`);
+  }
 
   return validator;
 };