Do not omit nested additionalProperties (rjsf-team#1774)

Fix bug where additional properties are not submitted when nested and omit data enabled Fixes rjsf-team#1497 Co-authored-by: Ashwin Ramaswami <aramaswamis@gmail.com>

Author: ValYouW

packages/core/src/components/Form.js

@@ -196,7 +196,12 @@ export default class Form extends Component {
  Object.keys(_obj).forEach(key => {
  if (typeof _obj[key] === "object") {
  let newPaths = paths.map(path => `${path}.${key}`);
- getAllPaths(_obj[key], acc, newPaths);
+ // If an object is marked with additionalProperties, all its keys are valid
+ if (_obj[key].__rjsf_additionalProperties && _obj[key].$name !== "") {
+ acc.push(_obj[key].$name);
+ } else {
+ getAllPaths(_obj[key], acc, newPaths);
+ }
  } else if (key === "$name" && _obj[key] !== "") {
  paths.forEach(path => {
  path = path.replace(/^\./, "");

packages/core/src/utils.js

@@ -1010,6 +1010,11 @@ export function toPathSchema(schema, name = "", rootSchema, formData = {}) {
  const _schema = retrieveSchema(schema, rootSchema, formData);
  return toPathSchema(_schema, name, rootSchema, formData);
  }
+
+ if (schema.hasOwnProperty("additionalProperties")) {
+ pathSchema.__rjsf_additionalProperties = true;
+ }
+
  if (schema.hasOwnProperty("items") && Array.isArray(formData)) {
  formData.forEach((element, i) => {
  pathSchema[i] = toPathSchema(

packages/core/test/Form_test.js

@@ -2815,6 +2815,53 @@ describe("Form omitExtraData and liveOmit", () => {
  );
  });
 
+ it("should get field marked as additionalProperties", () => {
+ const schema = {};
+
+ const formData = {
+ extra: {
+ foo: "bar",
+ },
+ level1: {
+ level2: "test",
+ extra: "foo",
+ mixedMap: {
+ namedField: "foo",
+ key1: "val1",
+ },
+ },
+ level1a: 1.23,
+ };
+
+ const onSubmit = sandbox.spy();
+ const { comp } = createFormComponent({
+ schema,
+ formData,
+ onSubmit,
+ });
+
+ const pathSchema = {
+ $name: "",
+ level1: {
+ $name: "level1",
+ level2: { $name: "level1.level2" },
+ mixedMap: {
+ $name: "level1.mixedMap",
+ __rjsf_additionalProperties: true,
+ namedField: { $name: "level1.mixedMap.namedField" }, // this name should not be returned, as the root object paths should be returned for objects marked with additionalProperties
+ },
+ },
+ level1a: {
+ $name: "level1a",
+ },
+ };
+
+ const fieldNames = comp.getFieldNames(pathSchema, formData);
+ expect(fieldNames.sort()).eql(
+ ["level1a", "level1.level2", "level1.mixedMap"].sort()
+ );
+ });
+
  it("should get field names from pathSchema with array", () => {
  const schema = {};
 
@@ -2992,6 +3039,63 @@ describe("Form omitExtraData and liveOmit", () => {
  });
  });
 
+ it("should not omit additionalProperties on change with omitExtraData=true and liveOmit=true", () => {
+ const omitExtraData = true;
+ const liveOmit = true;
+ const schema = {
+ type: "object",
+ properties: {
+ foo: { type: "string" },
+ bar: { type: "string" },
+ add: {
+ type: "object",
+ additionalProperties: {},
+ },
+ },
+ };
+ const formData = { foo: "foo", baz: "baz", add: { prop: 123 } };
+ const { node, onChange } = createFormComponent({
+ schema,
+ formData,
+ omitExtraData,
+ liveOmit,
+ });
+
+ Simulate.change(node.querySelector("#root_foo"), {
+ target: { value: "foobar" },
+ });
+
+ sinon.assert.calledWithMatch(onChange.lastCall, {
+ formData: { foo: "foobar", add: { prop: 123 } },
+ });
+ });
+
+ it("should rename formData key if key input is renamed in a nested object with omitExtraData=true and liveOmit=true", () => {
+ const { node, onChange } = createFormComponent(
+ {
+ schema: {
+ type: "object",
+ properties: {
+ nested: {
+ additionalProperties: { type: "string" },
+ },
+ },
+ },
+ formData: { nested: { key1: "value" } },
+ },
+ { omitExtraData: true, liveOmit: true }
+ );
+
+ const textNode = node.querySelector("#root-key");
+ Simulate.blur(textNode, {
+ target: { value: "key1new" },
+ });
+
+ sinon.assert.calledWithMatch(onChange.lastCall, {
+ formData: { nested: { key1new: "value" } },
+ });
+ });
+
  describe("Async errors", () => {
  it("should render the async errors", () => {
  const schema = {