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.

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

[APPS-6948] Add manifest validation to deprecate password type param #364

Closed
wants to merge 1 commit into from

Conversation

aishkan
Copy link
Contributor

@aishkan aishkan commented Aug 21, 2024

💐

/cc @zendesk/wattle

Description

Add manifest validation to disallow password type params.
The check is based on enabling skip_password_parameter_check to ensure this validation works only for new app submission. The value will be passed in from Apps approval and ZAM.

The skip_password_parameter_check value will be passed in from Apps Approval gem here.

References

https://zendesk.atlassian.net/browse/APPS-6946

Risks

  • [RUNTIME] No
  • [low] Only adds an extra validation in manifest that works dependant on skip_password_parameter_check. Manifest validation can fail for apps.

@aishkan aishkan force-pushed the aishkan/deprecate-password-param branch from 72500b7 to d72b179 Compare August 22, 2024 23:09
@aishkan aishkan changed the title Add manifest validation to deprecate password type param [APPS-6948] Add manifest validation to deprecate password type param Aug 23, 2024
@aishkan aishkan marked this pull request as ready for review August 23, 2024 03:21
@aishkan aishkan requested review from a team as code owners August 23, 2024 03:21
@@ -22,7 +22,7 @@ def call(package)
return [ValidationError.new(:missing_manifest)]
end

collate_manifest_errors(package)
collate_manifest_errors(package, opts.fetch(:skip_password_parameter_check, true) )
Copy link
Contributor

Choose a reason for hiding this comment

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

Maybe I've been a manager too long, but I'm finding this a bit hard to follow. We default the skip_password_parameter value to false here, then default it to true here then apply the rule conditionally with a double negative.

Would it be simpler to change the variable name to apply_parameter_check and just give it the appropriate default value in one place?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

yeah that would be more readable. I have updated it now.

Copy link
Contributor

Choose a reason for hiding this comment

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

Could we get the PR description updated with the new implementation using apply_parameter_check please?

@aishkan aishkan force-pushed the aishkan/deprecate-password-param branch 3 times, most recently from b99ed3f to 989c20c Compare August 28, 2024 04:23
@aishkan aishkan force-pushed the aishkan/deprecate-password-param branch from 989c20c to 6df7579 Compare September 14, 2024 02:32
@aishkan aishkan closed this Sep 17, 2024
@aishkan aishkan force-pushed the aishkan/deprecate-password-param branch from 6df7579 to 1a3fcad Compare September 17, 2024 04:19
@mmassaki
Copy link
Contributor

This moved to #366

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants