vue visitors: introduced optional value masking and migration

CMK-24633

Change-Id: I54f1052f5f2afe86a51266ac28d98a2dfc4c2100

Author: schnetzzz

.werks/18202.md

@@ -15,6 +15,7 @@
     InvalidValue,
     RawDiskData,
     RawFrontendData,
+    VisitorOptions,
 )
 from .form_spec_visitor import (
     DisplayMode,
@@ -28,6 +29,7 @@
     "get_visitor",
     "DEFAULT_VALUE",
     "DefaultValue",
+    "VisitorOptions",
     "DiskModel",
     "IncomingData",
     "InvalidValue",

cmk/gui/form_specs/vue/__init__.py

@@ -8,6 +8,7 @@
 from cmk.ccc.exceptions import MKGeneralException
 from cmk.rulesets.v1.form_specs import FormSpec
 
+from ._type_defs import VisitorOptions
 from ._visitor_base import FormSpecVisitor
 
 RecomposerFunction = Callable[[FormSpec[Any]], FormSpec[Any]]
@@ -29,12 +30,14 @@ def register_recomposer_function(
     form_spec_recomposer_registry[form_spec_class] = recomposer_function
 
 
-def get_visitor(form_spec: FormSpec[Any]) -> FormSpecVisitor[FormSpec[Any], Any, Any]:
+def get_visitor(
+    form_spec: FormSpec[Any], visitor_options: VisitorOptions
+) -> FormSpecVisitor[FormSpec[Any], Any, Any]:
     if recompose_function := form_spec_recomposer_registry.get(form_spec.__class__):
-        return get_visitor(recompose_function(form_spec))
+        return get_visitor(recompose_function(form_spec), visitor_options)
 
     if visitor_class := form_spec_visitor_registry.get(form_spec.__class__):
-        return visitor_class(form_spec)
+        return visitor_class(form_spec, visitor_options)
 
     raise MKGeneralException(
         f"No visitor found for form spec class: {form_spec.__class__.__name__}"

cmk/gui/form_specs/vue/_registry.py

@@ -46,3 +46,9 @@ def __init__(self, messages: list[ValidationMessage]) -> None:
     @property
     def messages(self) -> list[ValidationMessage]:
         return self._messages
+
+
+@dataclass(kw_only=True)
+class VisitorOptions:
+    migrate_values: bool
+    mask_values: bool

cmk/gui/form_specs/vue/_type_defs.py

@@ -10,7 +10,7 @@
 from cmk.rulesets.v1.form_specs import FormSpec
 from cmk.shared_typing import vue_formspec_components as shared_type_defs
 
-from ._type_defs import DiskModel, IncomingData, InvalidValue, RawDiskData
+from ._type_defs import DiskModel, IncomingData, InvalidValue, RawDiskData, VisitorOptions
 from ._utils import (
     compute_validation_errors,
     compute_validators,
@@ -25,17 +25,26 @@
 
 class FormSpecVisitor(abc.ABC, Generic[FormSpecModel, _ParsedValueModel, _FallbackDataModel]):
     @final
-    def __init__(self, form_spec: FormSpecModel) -> None:
+    def __init__(self, form_spec: FormSpecModel, visitor_options: VisitorOptions) -> None:
         self.form_spec = form_spec
+        self.visitor_options = visitor_options
 
     @final
     def to_vue(self, raw_value: IncomingData) -> tuple[shared_type_defs.FormSpec, object]:
-        parsed_value = self._parse_value(self._migrate_disk_value(raw_value))
+        parsed_value = self._parse_value(
+            self._migrate_disk_value(raw_value)
+            if self.visitor_options.migrate_values
+            else raw_value
+        )
         return self._to_vue(parsed_value)
 
     @final
     def validate(self, raw_value: IncomingData) -> list[shared_type_defs.ValidationMessage]:
-        parsed_value = self._parse_value(self._migrate_disk_value(raw_value))
+        parsed_value = self._parse_value(
+            self._migrate_disk_value(raw_value)
+            if self.visitor_options.migrate_values
+            else raw_value
+        )
         # Stage 1: Check if the value is invalid
         if isinstance(parsed_value, InvalidValue):
             return create_validation_error(self._to_vue(parsed_value)[1], parsed_value.reason)
@@ -55,22 +64,17 @@ def validate(self, raw_value: IncomingData) -> list[shared_type_defs.ValidationM
 
     @final
     def to_disk(self, raw_value: IncomingData) -> DiskModel:
-        parsed_value = self._parse_value(self._migrate_disk_value(raw_value))
+        parsed_value = self._parse_value(
+            self._migrate_disk_value(raw_value)
+            if self.visitor_options.migrate_values
+            else raw_value
+        )
         if isinstance(parsed_value, InvalidValue):
             raise MKGeneralException(
                 "Unable to serialize invalid value. Reason: %s" % parsed_value.reason
             )
         return self._to_disk(parsed_value)
 
-    @final
-    def mask(self, raw_value: IncomingData) -> DiskModel:
-        parsed_value = self._parse_value(self._migrate_disk_value(raw_value))
-        if isinstance(parsed_value, InvalidValue):
-            raise MKGeneralException(
-                "Unable to serialize invalid value. Reason: %s" % parsed_value.reason
-            )
-        return self._mask(parsed_value)
-
     def _migrate_disk_value(self, value: IncomingData) -> IncomingData:
         if isinstance(value, RawDiskData) and self.form_spec.migrate:
             return RawDiskData(value=self.form_spec.migrate(value.value))
@@ -103,11 +107,3 @@ def _validate(
     @abc.abstractmethod
     def _to_disk(self, parsed_value: _ParsedValueModel) -> DiskModel:
         """Transforms the value into a serializable format for disk storage."""
-
-    def _mask(self, parsed_value: _ParsedValueModel) -> DiskModel:
-        """Obscure any sensitive information in the provided value
-
-        Container-like ValueSpecs must recurse over their items, allow these to mask their
-        values. Other ValueSpecs that don't have a need for masking sensitive information
-        can simply return the input value."""
-        return self._to_disk(parsed_value)

cmk/gui/form_specs/vue/_visitor_base.py

@@ -21,7 +21,13 @@
 from cmk.shared_typing import vue_formspec_components as shared_type_defs
 
 from ._registry import get_visitor
-from ._type_defs import DEFAULT_VALUE, FormSpecValidationError, IncomingData, RawFrontendData
+from ._type_defs import (
+    DEFAULT_VALUE,
+    FormSpecValidationError,
+    IncomingData,
+    RawFrontendData,
+    VisitorOptions,
+)
 
 T = TypeVar("T")
 
@@ -100,15 +106,15 @@ def parse_data_from_frontend(form_spec: FormSpec[T], field_id: str) -> object:
     if not request.has_var(field_id):
         raise MKGeneralException("Formular data is missing in request")
     value_from_frontend = RawFrontendData(json.loads(request.get_str_input_mandatory(field_id)))
-    visitor = get_visitor(form_spec)
+    visitor = get_visitor(form_spec, VisitorOptions(migrate_values=False, mask_values=False))
     _process_validation_errors(visitor.validate(value_from_frontend))
     return visitor.to_disk(value_from_frontend)
 
 
 def validate_value_from_frontend(
     form_spec: FormSpec[T], value: IncomingData
 ) -> Sequence[shared_type_defs.ValidationMessage]:
-    visitor = get_visitor(form_spec)
+    visitor = get_visitor(form_spec, VisitorOptions(migrate_values=True, mask_values=False))
     return visitor.validate(value)
 
 
@@ -120,7 +126,7 @@ def serialize_data_for_frontend(
     display_mode: DisplayMode = DisplayMode.EDIT,
 ) -> VueAppConfig:
     """Serializes backend value to vue app compatible config."""
-    visitor = get_visitor(form_spec)
+    visitor = get_visitor(form_spec, VisitorOptions(migrate_values=True, mask_values=False))
     vue_component, vue_value = visitor.to_vue(value)
 
     validation: list[shared_type_defs.ValidationMessage] = []

cmk/gui/form_specs/vue/form_spec_visitor.py

@@ -76,7 +76,7 @@ def _to_vue(
         selected_vue_value: object = None
         vue_elements = []
         for element in self.form_spec.elements:
-            element_visitor = get_visitor(element.parameter_form)
+            element_visitor = get_visitor(element.parameter_form, self.visitor_options)
             element_value = selected_value if selected_name == element.name else DEFAULT_VALUE
             element_schema, element_vue_value = element_visitor.to_vue(element_value)
 
@@ -117,7 +117,7 @@ def _validate(
             if selected_name != element.name:
                 continue
 
-            element_visitor = get_visitor(element.parameter_form)
+            element_visitor = get_visitor(element.parameter_form, self.visitor_options)
             for validation in element_visitor.validate(selected_value):
                 element_validations.append(
                     shared_type_defs.ValidationMessage(
@@ -137,6 +137,6 @@ def _to_disk(self, parsed_value: _ParsedValueModel) -> tuple[str, object]:
         for element in self.form_spec.elements:
             if selected_name != element.name:
                 continue
-            element_visitor = get_visitor(element.parameter_form)
+            element_visitor = get_visitor(element.parameter_form, self.visitor_options)
             disk_value = element_visitor.to_disk(selected_value)
         return selected_name, disk_value

cmk/gui/form_specs/vue/visitors/cascading_single_choice.py

@@ -149,7 +149,7 @@ def _to_vue(
 
             element_lookup: dict[str, tuple[shared_type_defs.FormSpec, object]] = {}
             for element_name, element in actual_elements.items():
-                element_visitor = get_visitor(element.parameter_form)
+                element_visitor = get_visitor(element.parameter_form, self.visitor_options)
                 is_active = element_name in topic_values
                 spec, value = element_visitor.to_vue(
                     topic_values[element_name] if is_active else DEFAULT_VALUE
@@ -193,7 +193,7 @@ def _validate(
         for topic_name, topic in self.form_spec.elements.items():
             topic_values = parsed_value[topic_name]
             for element_name, element in self._resolve_topic_to_elements(topic).items():
-                element_visitor = get_visitor(element.parameter_form)
+                element_visitor = get_visitor(element.parameter_form, self.visitor_options)
                 if element_name not in topic_values:
                     if element.required:
                         _spec, element_default_value = element_visitor.to_vue(DEFAULT_VALUE)
@@ -222,7 +222,7 @@ def _to_disk(self, parsed_value: _ParsedValueModel) -> Mapping[str, dict[str, ob
             topic_values = parsed_value[topic_name]
             for element_name, element in self._resolve_topic_to_elements(topic).items():
                 if element_name in topic_values:
-                    element_visitor = get_visitor(element.parameter_form)
+                    element_visitor = get_visitor(element.parameter_form, self.visitor_options)
                     disk_values[topic_name][element_name] = element_visitor.to_disk(
                         topic_values[element_name]
                     )

cmk/gui/form_specs/vue/visitors/catalog.py

@@ -117,7 +117,7 @@ def _to_vue(
         vue_values = {}
 
         for key_name, dict_element in self.form_spec.elements.items():
-            element_visitor = get_visitor(dict_element.parameter_form)
+            element_visitor = get_visitor(dict_element.parameter_form, self.visitor_options)
             is_active = key_name in parsed_value
             element_value = parsed_value[key_name] if is_active else DEFAULT_VALUE
             element_schema, element_vue_value = element_visitor.to_vue(element_value)
@@ -172,7 +172,7 @@ def _validate(
         # NOTE: the parsed_value may include keys with default values, e.g. {"ce": default_value}
         element_validations = []
         for key_name, dict_element in self.form_spec.elements.items():
-            element_visitor = get_visitor(dict_element.parameter_form)
+            element_visitor = get_visitor(dict_element.parameter_form, self.visitor_options)
 
             if key_name not in parsed_value:
                 if dict_element.required:
@@ -200,7 +200,7 @@ def _validate(
     def _to_disk(self, parsed_value: _ParsedValueModel) -> dict[str, object]:
         disk_values = {}
         for key_name, dict_element in self.form_spec.elements.items():
-            element_visitor = get_visitor(dict_element.parameter_form)
+            element_visitor = get_visitor(dict_element.parameter_form, self.visitor_options)
             is_active = key_name in parsed_value
             if is_active:
                 disk_values[key_name] = element_visitor.to_disk(parsed_value[key_name])

cmk/gui/form_specs/vue/visitors/dictionary.py

@@ -57,7 +57,7 @@ def _to_vue(
 
         title, help_text = get_title_and_help(self.form_spec)
 
-        element_visitor = get_visitor(self.form_spec.element_template)
+        element_visitor = get_visitor(self.form_spec.element_template, self.visitor_options)
         element_schema, element_vue_default_value = element_visitor.to_vue(DEFAULT_VALUE)
         list_values: list[object] = []
         for entry in parsed_value:
@@ -93,7 +93,7 @@ def _validate(
         self, parsed_value: _ParsedValueModel
     ) -> list[shared_type_defs.ValidationMessage]:
         element_validations: list[shared_type_defs.ValidationMessage] = []
-        element_visitor = get_visitor(self.form_spec.element_template)
+        element_visitor = get_visitor(self.form_spec.element_template, self.visitor_options)
         for idx, entry in enumerate(parsed_value):
             for validation in element_visitor.validate(entry):
                 element_validations.append(
@@ -108,7 +108,7 @@ def _validate(
     @override
     def _to_disk(self, parsed_value: _ParsedValueModel) -> list[object]:
         disk_values = []
-        element_visitor = get_visitor(self.form_spec.element_template)
+        element_visitor = get_visitor(self.form_spec.element_template, self.visitor_options)
         for entry in parsed_value:
             disk_values.append(element_visitor.to_disk(entry))
         return disk_values