-
Notifications
You must be signed in to change notification settings - Fork 4.3k
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.
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
Fix small TtlPIcker2 bug #17376
Fix small TtlPIcker2 bug #17376
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
thanks for tackling! just some small questions/fixes for comments
@@ -123,6 +123,7 @@ export default class MfaMethod extends Model { | |||
editType: 'ttl', | |||
helperTextEnabled: 'How long each generated TOTP is valid.', | |||
hideToggle: true, | |||
defaultValue: 30, // API accepts both an integer as seconds and sting with unit e.g 30 || '30s' |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
thanks for adding this comment! - small typo here! sting
@@ -13,7 +13,7 @@ | |||
* @param helperTextDisabled="Allow tokens to be used indefinitely" {String} - This helper text is shown under the label when the toggle is switched off | |||
* @param helperTextEnabled="Disable the use of the token after" {String} - This helper text is shown under the label when the toggle is switched on | |||
* @param description="Longer description about this value, what it does, and why it is useful. Shows up in tooltip next to helpertext" | |||
* @param time=30 {Number} - The time (in the default units) which will be adjustable by the user of the form | |||
* @param time='' {Number} - The time (in the default units) which will be adjustable by the user of the form |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thank you for remembering to update the docs! I was going to suggest updating the format to @param {type} paramName
buuut...I think we tend to do that when glimmerizing so probably fine to skip for now
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I know, I actually already attempted to glimmerize at my look into the problem. Had the exact same thought you did, but thought just in case any backporting needs to be done, I'll keep these two separate.
@@ -50,7 +50,7 @@ export default TtlForm.extend({ | |||
helperTextDisabled: 'Allow tokens to be used indefinitely', | |||
helperTextEnabled: 'Disable the use of the token after', | |||
description: '', | |||
time: 30, | |||
time: '', // if defaultValue is NOT set, then do not display a defaultValue. This causes the param on the model to be different then what the component shows on init. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
this second part of this is a little unclear to me
if defaultValue is NOT set, do not display defaultValue
does this mean if defaultValue is NOT set, time input will be left blank
?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
super nit: small typo here, should be: "than what the component shows on init."
but on second thought, not sure if we need to have that second sentence as it might cause confusion later. especially now that the problem is being solved, plus we have the git history to return to if we are ever wondering why we removed 30
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Works for me, I'll take out the second sentence.
This fixes two specific situations:
The problem is that if a user does not set the defaultValue in situation 1 the openApi sends a value (if it has one defined). And in the case for PKI roles that was an integer. This may change after a discussion with the backend because that's not the value the API docs declare.
In situation 2 this fix makes is so if you don't pass any defaultValue then the
TtlPicker2
doesn't show you passing a value. It shows a blank too.*Note, the previous PKI engine has been sending the integer 30 for the param
notBeforeDuration
even though the docs don't state it can handle an integer.This was an issue in two models:
-pki-role-engine.js
-mfa-methods.js
For both of those models, because the docs state a default, I amended their models to show them setting this defaultValue so the user knows that no matter what, if they press "Create" a defaultValue is being set.