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

v2.0: Deprecate compress_request and compress_response #695

Merged

Conversation

johnnyshields
Copy link
Collaborator

@johnnyshields johnnyshields commented Jul 9, 2024

Fixes #676

Replaces PR #689

Deprecate compress_request and compress_response parameters. Set their behavior automatically based on settings.idp_sso_service_binding and settings.idp_slo_service_binding respectively. HTTP-Redirect will always use compression, while HTTP-POST will not.

As discussed the encode_raw_saml method has been made backward compatible.

This also contains light refactoring of RubySaml::Logging to add a deprecate method and be a singleton module without changing any of its existing method interfaces.

@johnnyshields johnnyshields changed the title Deprecate compress_request and compress_response v2.0: Deprecate compress_request and compress_response Jul 9, 2024
…e parameters. Set their behavior automatically based on settings.idp_sso_service_binding and settings.idp_slo_service_binding respectively. HTTP-Redirect will always use compression, while HTTP-POST will not.
@pitbulk
Copy link
Collaborator

pitbulk commented Jul 9, 2024

Added a minor comment, rest seems ok to be merged.

# @deprecated Will be removed in v2.1.0
def compress_request
compress_deprecation('compress_request', 'idp_sso_service_binding')
defined?(@compress_request) ? @compress_request : true
Copy link
Collaborator Author

@johnnyshields johnnyshields Jul 9, 2024

Choose a reason for hiding this comment

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

One more thing I caught, the previous default for these was "true", so it needs to stay that way. Using defined? here will only apply if the user touched the value; if they set it nil then it will become nil

@johnnyshields
Copy link
Collaborator Author

@pitbulk conflicts resolved; ready to merge!

@pitbulk pitbulk merged commit 3e31760 into SAML-Toolkits:v2.x Jul 9, 2024
12 of 17 checks passed
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.

2 participants