Merge branch...

Merge branch '231370-sast-config-ui-page-basic-sast-wide-settings-implement-dynamic-form-container-control' into 'master'

Implement dynamic form control component

See merge request gitlab-org/gitlab!38162

ee/app/assets/javascripts/security_configuration/sast/components/dynamic_fields.vue

+<script>
+import FormInput from './form_input.vue';
+import { isValidConfigurationEntity } from './utils';
+
+export default {
+  components: {
+    FormInput,
+  },
+  model: {
+    prop: 'entities',
+    event: 'input',
+  },
+  props: {
+    entities: {
+      type: Array,
+      required: true,
+      validator: value => value.every(isValidConfigurationEntity),
+    },
+  },
+  methods: {
+    componentForEntity({ type }) {
+      return this.$options.entityTypeToComponent[type];
+    },
+    onInput(fieldName, newValue) {
+      const entityIndex = this.entities.findIndex(({ field }) => field === fieldName);
+
+      const updatedEntity = {
+        ...this.entities[entityIndex],
+        value: newValue,
+      };
+
+      const newEntities = [...this.entities];
+      newEntities.splice(entityIndex, 1, updatedEntity);
+
+      this.$emit('input', newEntities);
+    },
+  },
+  // Entities with types not listed here are not rendered, since Vue does not
+  // render <component :is="undefined" />. This means that unsupported entities
+  // are omitted silently, which is actually the *desirable* behaviour, as it
+  // decouples the frontend from the backend: the backend may add new types
+  // before the frontend adds support for them.
+  entityTypeToComponent: {
+    string: FormInput,
+  },
+};
+</script>
+
+<template>
+  <div>
+    <component
+      :is="componentForEntity(entity)"
+      v-for="entity in entities"
+      ref="fields"
+      :key="entity.field"
+      v-bind="entity"
+      @input="onInput(entity.field, $event)"
+    />
+  </div>
+</template>

ee/app/assets/javascripts/security_configuration/sast/components/utils.js

+const isString = value => typeof value === 'string';
+
+// eslint-disable-next-line import/prefer-default-export
+export const isValidConfigurationEntity = object => {
+  if (object == null) {
+    return false;
+  }
+
+  const { field, type, description, label, defaultValue, value } = object;
+
+  return (
+    isString(field) &&
+    isString(type) &&
+    isString(description) &&
+    isString(label) &&
+    defaultValue !== undefined &&
+    value !== undefined
+  );
+};

ee/spec/frontend/security_configuration/sast/components/dynamic_fields_spec.js

+import { shallowMount } from '@vue/test-utils';
+import DynamicFields from 'ee/security_configuration/sast/components/dynamic_fields.vue';
+import { makeEntities } from './helpers';
+
+describe('DynamicFields component', () => {
+  let wrapper;
+
+  const createComponent = (props = {}) => {
+    wrapper = shallowMount(DynamicFields, {
+      propsData: {
+        ...props,
+      },
+    });
+  };
+
+  const findFields = () => wrapper.findAll({ ref: 'fields' });
+
+  afterEach(() => {
+    wrapper.destroy();
+    wrapper = null;
+  });
+
+  describe.each`
+    context                                     | entities
+    ${'no entities'}                            | ${[]}
+    ${'entities with unsupported entity types'} | ${makeEntities(3, { type: 'foo' })}
+  `('given $context', ({ entities }) => {
+    beforeEach(() => {
+      createComponent({ entities });
+    });
+
+    it('renders no fields', () => {
+      expect(findFields()).toHaveLength(0);
+    });
+  });
+
+  describe('given valid entities', () => {
+    let entities;
+    let fields;
+
+    beforeEach(() => {
+      entities = makeEntities(3);
+      createComponent({ entities });
+      fields = findFields();
+    });
+
+    it('renders each field with the correct component', () => {
+      entities.forEach((entity, i) => {
+        const field = fields.at(i);
+        expect(field.is(DynamicFields.entityTypeToComponent[entity.type])).toBe(true);
+      });
+    });
+
+    it('passes the correct props to each field', () => {
+      entities.forEach((entity, i) => {
+        const field = fields.at(i);
+
+        expect(field.props()).toMatchObject({
+          field: entity.field,
+          label: entity.label,
+          description: entity.description,
+          defaultValue: entity.defaultValue,
+          value: entity.value,
+        });
+      });
+    });
+
+    describe.each`
+      fieldIndex | newValue
+      ${0}       | ${'foo'}
+      ${1}       | ${'bar'}
+      ${2}       | ${'qux'}
+    `(
+      'when a field at index $fieldIndex emits an input event value $newValue',
+      ({ fieldIndex, newValue }) => {
+        beforeEach(() => {
+          fields.at(fieldIndex).vm.$emit('input', newValue);
+        });
+
+        it('emits an input event with the correct entity value changed', () => {
+          const [[payload]] = wrapper.emitted('input');
+
+          entities.forEach((entity, i) => {
+            if (i === fieldIndex) {
+              const expectedChangedEntity = {
+                ...entities[fieldIndex],
+                value: newValue,
+              };
+
+              expect(payload[i]).not.toBe(entities[i]);
+              expect(payload[i]).toEqual(expectedChangedEntity);
+            } else {
+              expect(payload[i]).toBe(entities[i]);
+            }
+          });
+        });
+      },
+    );
+  });
+});

ee/spec/frontend/security_configuration/sast/components/helpers.js

+/**
+ * Creates an array of objects matching the shape of a GraphQl
+ * SastCiConfigurationEntity.
+ *
+ * @param {number} count - The number of entities to create.
+ * @param {Object} [changes] - Object representing changes to apply to the
+ *     generated entities.
+ * @returns {Object[]}
+ */
+// eslint-disable-next-line import/prefer-default-export
+export const makeEntities = (count, changes) =>
+  [...Array(count).keys()].map(i => ({
+    field: `field${i}`,
+    label: `label${i}`,
+    description: `description${i}`,
+    defaultValue: `defaultValue${i}`,
+    value: `defaultValue${i}`,
+    type: 'string',
+    ...changes,
+  }));

ee/spec/frontend/security_configuration/sast/components/utils_spec.js

+import { isValidConfigurationEntity } from 'ee/security_configuration/sast/components/utils';
+import { makeEntities } from './helpers';
+
+describe('isValidConfigurationEntity', () => {
+  const validEntities = makeEntities(3);
+
+  const invalidEntities = [
+    null,
+    undefined,
+    [],
+    {},
+    ...makeEntities(1, { field: undefined }),
+    ...makeEntities(1, { type: undefined }),
+    ...makeEntities(1, { description: undefined }),
+    ...makeEntities(1, { label: undefined }),
+    ...makeEntities(1, { value: undefined }),
+    ...makeEntities(1, { defaultValue: undefined }),
+  ];
+
+  it.each(validEntities)('returns true for a valid entity', entity => {
+    expect(isValidConfigurationEntity(entity)).toBe(true);
+  });
+
+  it.each(invalidEntities)('returns false for an invalid entity', invalidEntity => {
+    expect(isValidConfigurationEntity(invalidEntity)).toBe(false);
+  });
+});