Skip to content

Remove use of whitelist/blacklist in sdk api #2640

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

Closed
Ianfeather opened this issue Jun 3, 2020 · 3 comments · Fixed by #2671
Closed

Remove use of whitelist/blacklist in sdk api #2640

Ianfeather opened this issue Jun 3, 2020 · 3 comments · Fixed by #2671

Comments

@Ianfeather
Copy link

Summary

Could you update your API terminology for whitelistUrls and blacklistUrls to be more inclusive? This could be a breaking change or you could immediately accept additional properties alongside the existing ones and phase them out at the next scheduled release.

Motivation

The Code of Conduct says to use welcome and inclusive language and there's certainly more inclusive language that could be used for this part of the api. In addition, you're in the position of setting an example with the terminology that you choose to use. This post does a good job of detailing why the terms derive from prejudice: https://www.ncsc.gov.uk/blog-post/terminology-its-not-black-and-white

Additional Context

If allowList and denyList don't fit exactly, alternative API properties could be excludeUrls, includeUrls.

Thank you.

Prior conversation on other repositories:

@untitaker untitaker transferred this issue from getsentry/sentry Jun 3, 2020
@untitaker
Copy link
Member

untitaker commented Jun 3, 2020

Moving this to sentry-javascript as those parameters exist purely in JS. inAppInclude is the regular name for a similar feature in other SDKs, so I think we should replace "whitelist" with "include" on consistency grounds as well.

@mitsuhiko
Copy link
Contributor

This opens up the opportunity to fix the behavior of this parameter as well. It currently supports a substring match which we discussed before we might want to remove for an host portion only check.

@Ianfeather
Copy link
Author

I really appreciate your response on this. Thank you.

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