Get default value of a property of an object when the object is an array item

[vaidkaran]

I am trying to get the default value of pathFilter via convict.default()
Below is my configSchema

  masks: {
    format: 'Object',
    body: {
      doc: 'masks for body',
      format: 'Array',
      default: [],
      children: {
        pathFilter: {
          format: RegExp,
          doc: 'Filter for applying mask to certain paths',
          default: /.*/,
        },
      },
    },
  },

And the config looks like:

    masks: {
      body: [
        {
          pathFilter: /xyz/,
        },
      ],
    }

I tried doing config.default('masks.body.children.pathFilter') but that doesn't work.
One problem that I see here is that we add and look for _cvtProperties under arrays too. Arrays seem to have children and not _cvtProperties. So the default function would resolve the path and look for body._cvtProperties but it won't exist.

Maybe we need to cater for arrays here

Please advise.

[koerbcm]

+1

[madarche]

@vaidkaran or anyone interested, could you create a failing test demonstrating the problem please? That would help!

[vaidkaran]

const convict = require('convict');

const schema = {
  masks: {
    format: 'Object',
    body: {
      doc: 'masks for body',
      format: 'Array',
      default: [],
      children: {
        pathFilter: {
          format: RegExp,
          doc: 'Filter for applying mask to certain paths',
          default: /.*/,
        },
      },
    },
  },
}


const config = convict(schema).load({
  masks: {
    body: [
      {
        pathFilter: /xyz/,
      },
    ],
  },
}).validate();

const defaultBody = config.default('masks.body') // returns [] which is fine
console.log('Default value of body: ', defaultBody);

const defaultPathFilter = config.default('masks.body.children.pathFilter') // doesn't work
// Error: cannot find configuration param 'masks._cvtProperties.body._cvtProperties.children._cvtProperties.pathFilter.default'

Does this help?

[koerbcm]

Any update on this?

[TzachiSh]

+1