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

Basic sketch of configurable limits and sanitization #180

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

lritter
Copy link

@lritter lritter commented Nov 15, 2023

This PR sketches out a system where developers can configure per-element validation/sanitization to the library. This work is in response to #176

As a user of the library, a developer can add custom validation/sanitization behavior on a per "element" (overloaded term) basis. Specifically, each class defined within the library can have a "limiter" registered for it. This limiter is then used when instances of that class are serialized via as_json. These limiters can raise errors or modify the serialized data in order to help provide more robust behavior.

For example:

Slack::BlockKit::Limits.set_limiter 'Slack::BlockKit::Composition::Option', Limiters::OptionTruncateLabelAndDescriptionLimiter.new

Adds a limiter that checks select option labels, values, and descriptions for length, truncating labels and descriptions if they are too long and raising an exception if value is too long.

While this is only a sketch for now, more comprehensive default limiters can be added.

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.

1 participant