Error when .rename() from undefined

[JbIPS]

Hi,
here's what I'm trying to do :
I've got this Joi schema

var validateQuery = core.Joi.object().keys({
  clientId: core.Joi.string().required(),
  redirectUri: core.Joi.string().required().regex(/^[a-z0-9]*:\/\/[^*]*/i),
  responseType: core.Joi.string().required().valid(['code', 'token']),
}).rename('client_id', 'clientId', {override: true})
  .rename('redirect_uri', 'redirectUri', {override: true})
  .rename('response_type', 'responseType', {override: true});

and I'm validating this object

  redirectUri: 'http://whatever.com',
  responseType: 'token',
  clientId: '240f17d59129425093d9ec805009e75e' }

This give me [ValidationError: child "clientId" fails because ["clientId" is required]]. Changing clientId to client_id in my object works fine, but rename() shouldn't delete my keys if the rename isn't necessary, right? I think this behavior is comming from this commit but maybe it's on purpose and I missed something.

Is that a bug or a feature ?

[AdriVanHoudt]

To me that looks like unexpected behaviour. The override option will delete keys if the rename is not specified. As you can see in the test on that commit it removes key a from the object because it doesn't have an override. Try setting override to false and see if that works.

[JbIPS]

Removing {override: true} gives me [ValidationError: "value" cannot rename child "client_id" because override is disabled and target "clientId" exists], that's why I tried with override

[AdriVanHoudt]

But why does it want rename client_id while it doesn't exist? Weird

[JbIPS]

That's what I'm thinking. I use rename() to ensure all my objects have those keys in camel-case, but some already have, and it's a mess if the good ones are removed instead of just doing nothing.
I tried replacing delete target[item.to]; by continue; and it works perfectly, but this delete must be here for a reason, but why removing target[item.to]?

[Marsup]

This changed since #593. We'd likely need a new flag to support your use case.

[JbIPS]

Do you have any ideas for the name of the flag? Like ifNecessary or something? I'll try to make a PR asap

[Marsup]

More something like ignoreMissing. Don't forget that current dev branch is 6.1.0.

[AdriVanHoudt]

Wouldn't this be expected behaviour? That when using rename without override it only renames if the keys exists and otherwise don't do anything?

[Marsup]

It's been like that for ages, don't act all surprised :)

[AdriVanHoudt]

I've never used that feature so it's just what I expect it to do from reading the docs and this issue so that's why I'm surprised :P

[JbIPS]

Actually, I agree with @AdriVanHoudt. Moreover, it wouldn't need a flag: if the from key doesn't exist, don't do anything. But maybe I'm unaware of use cases that violate this behaviour, I'm still pretty new to Hapi/Joi

[Marsup]

Seems logical to me, you ask to rename a into b, whatever's into a gets into b.

[AdriVanHoudt]

Ah ok so if a is undefined b will be set as undefined? Ok now I get it. So a flag would make sense here to only rename if not undefined(or null?).

[JbIPS]

So ignoreMissing would mean "If a is missing (= undefined), don't rename"? So maybe ignoreUndefined?

[AdriVanHoudt]

ignoreUndefined is better I think because ignoreMissing might also include null

[Marsup]

I thought of missing as in "missing key", keys are rarely explicitly undefined, but yours works as well.

[AdriVanHoudt]

A missing key will return undefined so wouldn't that be the same?

[Marsup]

Exactly, missing or explicitly undefined is the same to me.

[AdriVanHoudt]

👍

[lock]

This thread has been automatically locked due to inactivity. Please open a new issue for related bugs or questions following the new issue template instructions.