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

Remove use of the words blacklist and whitelist #2641

Closed

Conversation

AJDoubleW
Copy link

Fixes #2640

Copy link
Member

@HazAT HazAT left a comment

Choose a reason for hiding this comment

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

Thx for the PR unfortunately we can't remove it just now.
We can remove it from the public API but internally we at least need a fallback for the old values until we do a major bump.

@AJDoubleW
Copy link
Author

@HazAT Yeah that makes sense, what do you think of aliasing those terms to expose them publicly in a different manner so both terms are valid for a period of time (encouraging users to change over)?

@HazAT
Copy link
Member

HazAT commented Jun 4, 2020

@AJDoubleW Yeah that's pretty much what I meant.

Comment on lines 13 to 19
/**
* A pattern for error URLs which should not be sent to Sentry.
* To whitelist certain errors instead, use {@link Options.whitelistUrls}.
* To include certain errors instead, use {@link Options.includedUrls}.
* By default, all errors will be sent.
*/
excludedUrls?: Array<string | RegExp>;
blacklistUrls?: Array<string | RegExp>;
Copy link
Member

Choose a reason for hiding this comment

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

Can we add a docblock here to both old values:

/**
  * @deprecated Consider removing in major bump
  * {@see excludedUrls}
**/

Copy link
Member

@HazAT HazAT left a comment

Choose a reason for hiding this comment

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

Also, we need a changelog entry for this

@benvinegar
Copy link
Contributor

I'm in favor of the direction and spirit of this change. But before we merge this, we (Sentry) need to discuss the exact terminology we want to replace it with, and make the change wholesale inside Sentry (e.g. across all SDKs and in the product).

For example, includedUrls doesn't sound correct to me. I've seen passUrls or safeUrls used as other alternatives. @HazAT @mitsuhiko let's figure this out.

@kamilogorek
Copy link
Contributor

Superseded by #2671

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.

Remove use of whitelist/blacklist in sdk api
4 participants