ExternalVendorCode/balena-supervisor
1
0
Fork 0
mirror of https://github.com/balena-os/balena-supervisor.git synced 2024-12-20 14:13:08 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Make sure to correctly convert config emit events after validation

Browse Source 
We were validating the input configuration values by coercing them to
the correct type, and then using the initial value to be saved (which
currently is always converted to a string).

We now use the coerced value as the actual value we will store, and more
importantly emit. This means that the config.on('change' ...) calls will
always be properly typed, which before this change was not a guarantee
that we could make.

Change-type: patch
Signed-off-by: Cameron Diver <cameron@balena.io>
This commit is contained in:
Cameron Diver 2019-02-11 10:56:52 +00:00
parent 5567682c1c
commit 3d6dc88eb0
No known key found for this signature in database
GPG Key ID: 49690ED87032539F
1 changed files with 9 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
src/config/index.ts
View File

@ -174,8 +174,8 @@ export class Config extends (EventEmitter as {
};
return Bluebird.try(() => {
// Firstly validate all of the types as they are being set
this.validateConfigMap(keyValues);
// Firstly validate and coerce all of the types as they are being set
keyValues = this.validateConfigMap(keyValues);
if (trx != null) {
return setValuesInTransaction(trx).return();
@ -251,10 +251,12 @@ export class Config extends (EventEmitter as {
return schemaTypes[key].type.decode(value);
}
private validateConfigMap<T extends SchemaTypeKey>(configMap: ConfigMap<T>) {
private validateConfigMap<T extends SchemaTypeKey>(
configMap: ConfigMap<T>,
): ConfigMap<T> {
// Just loop over every value, run the decode function, and
// throw if any value fails verification
_.map(configMap, (value, key) => {
return _.mapValues(configMap, (value, key) => {
if (
!Schema.schema.hasOwnProperty(key) ||
!Schema.schema[key as Schema.SchemaKey].mutable
@ -276,13 +278,14 @@ export class Config extends (EventEmitter as {
const decoded = type.decode(value);
if (decoded.isLeft()) {
throw new Error(
throw new TypeError(
`Cannot set value for ${key}, as value failed validation: ${
decoded.value
}`,
);
}
});
return decoded.value;
}) as ConfigMap<T>;
}
private generateRequiredFields() {