Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Allow kbn-config-schema to ignore unknown keys #59560

Merged
merged 7 commits into from
Mar 17, 2020
Merged

Allow kbn-config-schema to ignore unknown keys #59560

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
12a2cde
allow kbn-config-schema to ignore unknown keys
legrego Mar 6, 2020
c74167e
Consolidate unknown key configuration
legrego Mar 6, 2020
da9cf67
Merge branch 'master' into misc/ignore-unknown-keys
elasticmachine Mar 9, 2020
87866d5
Merge branch 'master' of github.com:elastic/kibana into misc/ignore-u…
legrego Mar 17, 2020
b0429dd
updates following merge
legrego Mar 17, 2020
9812671
Merge branch 'misc/ignore-unknown-keys' of github.com:legrego/kibana …
legrego Mar 17, 2020
48563ae
Merge branch 'master' into misc/ignore-unknown-keys
elasticmachine Mar 17, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
43 changes: 43 additions & 0 deletions packages/kbn-config-schema/src/types/object_type.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -319,3 +319,46 @@ test('does not allow unknown keys when allowUnknowns = false', () => {
})
).toThrowErrorMatchingInlineSnapshot(`"[bar]: definition for this key is missing"`);
});

test('allow and remove unknown keys when ignoreUnknowns = true', () => {
const type = schema.object(
{ foo: schema.string({ defaultValue: 'test' }) },
{ ignoreUnknowns: true }
);

expect(
type.validate({
bar: 'baz',
})
).toEqual({
foo: 'test',
});
});

test('ignoreUnknowns = true affects only own keys', () => {
const type = schema.object(
{ foo: schema.object({ bar: schema.string() }) },
{ ignoreUnknowns: true }
);

expect(() =>
type.validate({
foo: {
bar: 'bar',
baz: 'baz',
},
})
).toThrowErrorMatchingInlineSnapshot(`"[foo.baz]: definition for this key is missing"`);
});

test('does not allow unknown keys when ignoreUnknowns = false', () => {
const type = schema.object(
{ foo: schema.string({ defaultValue: 'test' }) },
{ ignoreUnknowns: false }
);
expect(() =>
type.validate({
bar: 'baz',
})
).toThrowErrorMatchingInlineSnapshot(`"[bar]: definition for this key is missing"`);
});
31 changes: 25 additions & 6 deletions packages/kbn-config-schema/src/types/object_type.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,17 +30,35 @@ export type TypeOf<RT extends Type<any>> = RT['type'];
// this might not have perfect _rendering_ output, but it will be typed.
export type ObjectResultType<P extends Props> = Readonly<{ [K in keyof P]: TypeOf<P[K]> }>;

interface AllowUnknowns {
allowUnknowns: true;
ignoreUnknowns?: false;
}

interface IgnoreUnknowns {
allowUnknowns?: false;
ignoreUnknowns: true;
}

interface ForbidUnknowns {
allowUnknowns?: false;
ignoreUnknowns?: false;
}
// type check to not permit both to be set to `true` at the same time
type UnknownOptions = AllowUnknowns | IgnoreUnknowns | ForbidUnknowns;
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I did this because it was less invasive, but it feels messy to me.

Since these options are mutually exclusive of each other, I think a const might be better:

interface UnknownOptions {
   unknowns?: 'allow' | 'ignore' | 'forbid'
}

with the default behavior being forbid.

I'm happy to make this change, but I wanted to discuss before doing so, as it'll touch a lot of downstream code.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It makes sense to me...even it will require to touch 70 places in the codebase 🙈 welcome to the platform team world.


export type ObjectTypeOptions<P extends Props = any> = TypeOptions<
{ [K in keyof P]: TypeOf<P[K]> }
> & {
/** Should uknown keys not be defined in the schema be allowed. Defaults to `false` */
allowUnknowns?: boolean;
};
> &
UnknownOptions;

export class ObjectType<P extends Props = any> extends Type<ObjectResultType<P>> {
private props: Record<string, AnySchema>;

constructor(props: P, { allowUnknowns = false, ...typeOptions }: ObjectTypeOptions<P> = {}) {
constructor(
props: P,
{ allowUnknowns = false, ignoreUnknowns = false, ...typeOptions }: ObjectTypeOptions<P> = {}
) {
const schemaKeys = {} as Record<string, AnySchema>;
for (const [key, value] of Object.entries(props)) {
schemaKeys[key] = value.getSchema();
Expand All @@ -50,7 +68,8 @@ export class ObjectType<P extends Props = any> extends Type<ObjectResultType<P>>
.keys(schemaKeys)
.default()
.optional()
.unknown(Boolean(allowUnknowns));
.unknown(Boolean(allowUnknowns))
.options({ stripUnknown: { objects: ignoreUnknowns } });

super(schema, typeOptions);
this.props = schemaKeys;
Expand Down