Added the ability to define possible values for settings, defined a set of possible values for the "Pluse Email Frequency" and use those on the client side to render a drop-down.

Author: ocielliottc

server/src/main/java/com/objectcomputing/checkins/services/settings/SettingOption.java

@@ -16,28 +16,26 @@
 @JsonDeserialize(using = SettingOptionDeserializer.class)
 public enum SettingOption {
     LOGO_URL("The logo url", Category.THEME, Type.FILE),
-    PULSE_EMAIL_FREQUENCY("The Pulse Email Frequency (weekly, bi-weekly, monthly)", Category.CHECK_INS, Type.STRING);
+    PULSE_EMAIL_FREQUENCY("The Pulse Email Frequency", Category.CHECK_INS, Type.STRING, List.of("weekly", "bi-weekly", "monthly"));
 
     private final String description;
     private final Category category;
     private final Type type;
+    private final List<String> values;
 
     SettingOption(String description, Category category, Type type) {
         this.description = description;
         this.category = category;
         this.type = type;
+        this.values = List.of();
     }
 
-    public String getDescription() {
-        return description;
-    }
-
-    public Category getCategory() {
-        return category;
-    }
-
-    public Type getType() {
-        return type;
+    SettingOption(String description, Category category, Type type,
+                  List<String> values) {
+        this.description = description;
+        this.category = category;
+        this.type = type;
+        this.values = values;
     }
 
     public static List<SettingOption> getOptions(){

server/src/main/java/com/objectcomputing/checkins/services/settings/SettingOptionSerializer.java

@@ -5,6 +5,7 @@
 import com.fasterxml.jackson.databind.ser.std.StdSerializer;
 
 import java.io.IOException;
+import java.util.List;
 
 public class SettingOptionSerializer extends StdSerializer<SettingOption> {
 
@@ -28,6 +29,15 @@ public void serialize(
         generator.writeString(settingOption.getCategory().name());
         generator.writeFieldName("type");
         generator.writeString(settingOption.getType().name());
+        List<String> values = settingOption.getValues();
+        if (!values.isEmpty()) {
+          generator.writeFieldName("values");
+          generator.writeStartArray(values.size());
+          for(String value : values) {
+            generator.writeString(value);
+          }
+          generator.writeEndArray();
+        }
         generator.writeEndObject();
     }
-}
+}

server/src/main/java/com/objectcomputing/checkins/services/settings/SettingsController.java

@@ -76,10 +76,8 @@ public SettingsResponseDTO findByName(@PathVariable @NotNull String name) {
     public List<SettingsResponseDTO> getOptions() {
         List<SettingOption> options = SettingOption.getOptions();
         return options.stream().map(option -> {
-                   // Default to an empty value and "invalid" UUID.
-                   // This can be used by the client to determine pre-existance.
                    String value = "";
-                   UUID uuid = new UUID(0, 0);
+                   UUID uuid = null;
                    try {
                        Setting s = settingsServices.findByName(option.name());
                        uuid = s.getId();
@@ -89,6 +87,7 @@ public List<SettingsResponseDTO> getOptions() {
                    return new SettingsResponseDTO(
                                   uuid, option.name(), option.getDescription(),
                                   option.getCategory(), option.getType(),
+                                  option.getValues(),
                                   value);
                }).toList();
     }
@@ -150,6 +149,7 @@ private SettingsResponseDTO fromEntity(Setting entity) {
         dto.setDescription(option.getDescription());
         dto.setCategory(option.getCategory());
         dto.setType(option.getType());
+        dto.setValues(option.getValues());
         dto.setValue(entity.getValue());
         return dto;
     }

server/src/main/java/com/objectcomputing/checkins/services/settings/SettingsResponseDTO.java

@@ -9,6 +9,7 @@
 import lombok.Setter;
 
 import java.util.UUID;
+import java.util.List;
 
 @Setter
 @Getter
@@ -36,6 +37,10 @@ public class SettingsResponseDTO {
     @Schema(description = "type of the setting")
     private SettingOption.Type type;
 
+    @NotNull
+    @Schema(description = "possible values for the setting")
+    private List<String> values;
+
     @NotBlank
     @Schema(description = "value of the setting")
     private String value;

web-ui/src/components/settings/types/string.jsx

@@ -1,5 +1,11 @@
 import React from 'react';
-import { Input, Typography } from '@mui/material';
+import {
+  Select,
+  MenuItem,
+  ListItemText,
+  Input,
+  Typography
+} from '@mui/material';
 import { createLabelId } from '../../../helpers/strings.js';
 
 /**
@@ -17,6 +23,7 @@ import { createLabelId } from '../../../helpers/strings.js';
 const SettingsString = ({
   name,
   description,
+  values,
   value,
   placeholder,
   handleChange
@@ -31,14 +38,26 @@ const SettingsString = ({
         </Typography>
       </label>
       {description && <p>{description}</p>}
+      {values && values.length > 0 ?
+      <Select
+        labelId={labelId}
+        value={value}
+        onChange={handleChange}
+      >
+        {values.map((option) => (
+          <MenuItem key={option} value={option}>
+            <ListItemText primary={option} />
+          </MenuItem>
+        ))}
+      </Select> :
       <Input
         id={labelId}
         className="settings-control"
         type="text"
         value={value}
         placeholder={placeholder ?? `Enter ${name}`}
         onChange={handleChange}
-      />
+      />}
     </div>
   );
 };

web-ui/src/pages/SettingsPage.jsx

@@ -48,7 +48,7 @@ const SettingsPage = () => {
         // This information is necessary to know since we must use POST to
         // create new settings and PUT to modify existing settings.
         for (let option of allOptions) {
-          option.exists = option?.id != '00000000-0000-0000-0000-000000000000';
+          option.exists = option?.id != null;
         }
       }