[pve-devel] [RFC proxmox-widget-toolkit 1/2] input panel: add `raw` parameter to function `getValues`

[Max Carrara]

On 12/6/23 10:13, Dominik Csapak wrote:
> hi, some comment inline
> 
> On 12/5/23 16:44, Max Carrara wrote:
>> This parameter may be used to circumvent calls to `onGetValues`.
>>
>> Also adds a docstring for the function.
>>
>> Signed-off-by: Max Carrara <m.carrara at proxmox.com>
>> ---
>>   src/panel/InputPanel.js | 15 ++++++++++++++-
>>   1 file changed, 14 insertions(+), 1 deletion(-)
>>
>> diff --git a/src/panel/InputPanel.js b/src/panel/InputPanel.js
>> index 34150ef..723be42 100644
>> --- a/src/panel/InputPanel.js
>> +++ b/src/panel/InputPanel.js
>> @@ -31,7 +31,16 @@ Ext.define('Proxmox.panel.InputPanel', {
>>       return values;
>>       },
>>   -    getValues: function(dirtyOnly) {
>> +    /**
>> +     * Returns the submit data from the panel's form fields.
>> +     *
>> +     * @param {boolean} dirtyOnly `true` to return only dirty fields
>> +     * (fields that have been changed from their original value).
>> +     * @param {boolean} raw `true` to prevent calling
>> +     * {@link Proxmox.panel.InputPanel#onGetValues onGetValues} and
>> +     * instead return the original submit data.
>> +     */
> 
> nice to see these things documented, not sure about the format, but i guess we could adapt such a standard format (maybe at one point we
> could even generate nicer docs for this :) )

That's just JSDoc - I haven't really seen it used anywhere here (and to
be honest, also didn't bother to look) so I figured I'd just use it here
and see how people respond. ;) Ext JS uses it too, so.

> 
> another thing is the interface, adding a parameter works and can be ok
> but wouldn't it be nicer to invent a new 'getRawValues'?
> 
> this would then not change the signature of the original function and
> is more in line with what extjs does internally
> (getValue/getRawValue/etc.)
> 
> not a hard requirement for me though

Absolutely not opposed to this - I think then the code is more exlicit
anyway. E.g. `foo.getValues(false, true)` doesn't really say what it
does at first glance.

I'll definitely incorporate this!

> 
> a slight tangent thought:
> 
> after looking, it seems we never use(d?) the dirtyOnly
> parameter... so it might be nice to remove that
> 
> we couldn't even have used it anywhere because we always
> set it to false when 'onGetValues' is  a function
> so we'd  need to set it to something different, but
> later we call it unconditionally as a function(?!?)
> 
> but that is rather unrelated, just confused me
> (it seems it was "always" this way, so maybe
> there is some hidden svn history that i'm not seeing
> where the code would make more sense)

I was wondering about that too, but I didn't really want to turn
over too many stones for what's supposed to be just a simple RFC.

I wouldn't mind retiring that parameter for the actual patch series
then, if you'd like. I'll also double-check all call sites to make
sure it's not used anywhere - not that it would make a difference,
but just in case the parameter is provided somewhere.

> 
>> +    getValues: function(dirtyOnly, raw) {
>>       let me = this;
>>         if (Ext.isFunction(me.onGetValues)) {
>> @@ -46,6 +55,10 @@ Ext.define('Proxmox.panel.InputPanel', {
>>           }
>>       });
>>   +    if (raw) {
>> +        return values;
>> +    }
>> +
>>       return me.onGetValues(values);
>>       },
>>