refactor: rename to blocklist/allowlist

__tests__/errors-cache.test.js

@@ -48,17 +48,17 @@ describe('build api', () => {
  done()
  })
 
- it('gives right error messages on when trying to build blacklisted packages', async done => {
+ it('gives right error messages on when trying to build blocklisted packages', async done => {
  const resultURL = baseURL + 'polymer-cli'
  const result = await fetch(resultURL)
  const errorJSON = await result.json()
 
  expect(result.status).toBe(403)
  expect(result.headers.get('cache-control')).toBe('max-age=60')
 
- expect(errorJSON.error.code).toBe('BlacklistedPackageError')
+ expect(errorJSON.error.code).toBe('BlocklistedPackageError')
  expect(errorJSON.error.message).toBe(
- 'The package you were looking for is blacklisted due to suspicious activity in the past'
+ 'The package you were looking for is blocklisted due to suspicious activity in the past'
  )
 
  done()

index.js

@@ -26,7 +26,7 @@ const resolvePackageMiddleware = require('./server/middlewares/results/resolvePa
 const cachedResponseMiddleware = require('./server/middlewares/results/cachedResponse.middleware')
 const buildMiddleware = require('./server/middlewares/results/build.middleware')
 const errorMiddleware = require('./server/middlewares/results/error.middleware')
-const blockBlacklistMiddleware = require('./server/middlewares/results/blockBlacklist.middleware')
+const blockBlocklistMiddleware = require('./server/middlewares/results/blockBlocklist.middleware')
 const requestLoggerMiddleware = require('./server/middlewares/requestLogger.middleware')
 const similarPackagesMiddleware = require('./server/middlewares/similar-packages/similarPackages.middleware')
 const generateImgMiddleware = require('./server/middlewares/generateImg.middleware')
@@ -107,7 +107,7 @@ app.prepare().then(() => {
  }),
  errorMiddleware,
  resolvePackageMiddleware,
- blockBlacklistMiddleware,
+ blockBlocklistMiddleware,
  cachedResponseMiddleware,
  buildMiddleware
  )
@@ -116,7 +116,7 @@ app.prepare().then(() => {
  '/api/exports',
  errorMiddleware,
  resolvePackageMiddleware,
- blockBlacklistMiddleware,
+ blockBlocklistMiddleware,
  exportsMiddlware
  )
 
@@ -132,7 +132,7 @@ app.prepare().then(() => {
  }),
  errorMiddleware,
  resolvePackageMiddleware,
- blockBlacklistMiddleware,
+ blockBlocklistMiddleware,
  cachedResponseMiddleware,
  exportsSizesMiddlware
  )

pages/scan/Scan.js

@@ -3,7 +3,7 @@ import Analytics from 'client/analytics'
 import ResultLayout from 'client/components/ResultLayout'
 import Separator from 'client/components/Separator'
 import MetaTags from '../../client/components/MetaTags'
-import scanBlacklist from '../../client/config/scanBlacklist'
+import scanBlocklist from '../../client/config/scanBlocklist'
 import Dropzone from 'react-dropzone'
 import Router from 'next/router'
 import * as semver from 'semver'
@@ -147,7 +147,7 @@ export default class Scan extends Component {
  <input
  type="checkbox"
  defaultChecked={
- !scanBlacklist.some(regex => regex.test(name))
+ !scanBlocklist.some(regex => regex.test(name))
  }
  value={`${name}#${resolvedVersion}`}
  onChange={this.handleSelectionChange}

server/config.js

@@ -14,7 +14,7 @@ module.exports = {
 
  DEFAULT_DEV_PORT: 5000,
 
- blackList: [
+ blockList: [
  /hack-cheats/,
  /hacks?-cheats?/,
  /hack-unlimited/,

server/middlewares/rateLimit.middleware.js

@@ -4,8 +4,8 @@
 const ipchecker = require('ipchecker')
 const defaults = {
  duration: 1000 * 60 * 60,
- whiteList: [],
- blackList: [],
+ allowList: [],
+ blockList: [],
  accessLimited: '429: Too Many Requests.',
  accessForbidden: '403: This is forbidden area for you.',
  max: 100,
@@ -36,8 +36,8 @@ module.exports = function betterlimit(options = {}) {
  options.accessForbidden = options.message_403
  }
 
- const whiteListMap = ipchecker.map(options.whiteList)
- const blackListMap = ipchecker.map(options.blackList)
+ const allowListMap = ipchecker.map(options.allowList)
+ const blockListMap = ipchecker.map(options.blockList)
 
  return function* ratelimit(next) {
  const ip =
@@ -48,12 +48,12 @@ module.exports = function betterlimit(options = {}) {
  if (!ip) {
  return yield* next
  }
- if (ipchecker.check(ip, blackListMap)) {
+ if (ipchecker.check(ip, blockListMap)) {
  this.response.status = 403
  this.response.body = options.accessForbidden
  return
  }
- if (ipchecker.check(ip, whiteListMap)) {
+ if (ipchecker.check(ip, allowListMap)) {
  return yield* next
  }
 

server/middlewares/results/blockBlacklist.middleware.js → server/middlewares/results/blockBlocklist.middleware.js

@@ -1,8 +1,8 @@
 const { parsePackageString } = require('../../../utils/common.utils')
-const CustomError = require('./../../CustomError')
+const CustomError = require('../../CustomError')
 const CONFIG = require('../../config')
 
-async function blockBlacklistMiddleware(ctx, next) {
+async function blockBlocklistMiddleware(ctx, next) {
  const { package: packageString, force } = ctx.query
  if (force) {
  await next()
@@ -11,9 +11,9 @@ async function blockBlacklistMiddleware(ctx, next) {
 
  const parsedPackage = parsePackageString(packageString)
 
- // If package is blacklisted, fail fast
- if (CONFIG.blackList.some(entry => entry.test(parsedPackage.name))) {
- throw new CustomError('BlacklistedPackageError', { ...parsedPackage })
+ // If package is blocklisted, fail fast
+ if (CONFIG.blockList.some(entry => entry.test(parsedPackage.name))) {
+ throw new CustomError('BlocklistedPackageError', { ...parsedPackage })
  }
 
  // If package is unsupported, fail fast
@@ -31,4 +31,4 @@ async function blockBlacklistMiddleware(ctx, next) {
  await next()
 }
 
-module.exports = blockBlacklistMiddleware
+module.exports = blockBlocklistMiddleware

server/middlewares/results/error.middleware.js

@@ -42,11 +42,11 @@ async function errorHandler(ctx, next) {
  }
 
  switch (err.name) {
- case 'BlacklistedPackageError':
+ case 'BlocklistedPackageError':
  respondWithError(403, {
- code: 'BlacklistedPackageError',
+ code: 'BlocklistedPackageError',
  message:
- 'The package you were looking for is blacklisted ' +
+ 'The package you were looking for is blocklisted ' +
  "because it failed to build multiple times in the past and further tries aren't likely to succeed. This can " +
  "happen if this package wasn't meant to be bundled in a client side application.",
  })

server/middlewares/similar-packages/fixtures.js

@@ -232,7 +232,7 @@ const categories = {
  { tag: 'escape', weight: Weight.MID },
  { tag: 'filter', weight: Weight.NORMAL },
  { tag: 'xss', weight: Weight.HIGH },
- { tag: 'whitelist', weight: Weight.SMALL },
+ { tag: 'allowlist', weight: Weight.SMALL },
  ],
  similar: ['sanitize-html', 'xss', 'dompurify', 'sanitizer'],
  },

test-packages/blocklist-error/index.js

@@ -0,0 +1 @@
+console.log("I'm not a blocklisted package, hence will throw")

utils/rebuild.utils.js

@@ -1,4 +1,4 @@
-const { blackList } = require('../server/config')
+const { blockList } = require('../server/config')
 
 require('dotenv-defaults').config()
 const firebase = require('firebase')
@@ -82,8 +82,8 @@ async function getPackageResult({ name, version }) {
  return snapshot.val()
 }
 
-function filterBlacklistedPackages() {
- blackList
+function filterBlocklistedPackages() {
+ blockList
 }
 
 async function trim(packages) {
@@ -122,7 +122,7 @@ async function run() {
  // Object.keys(packs[packName]).forEach(version => {
  // // if (packName !== 'react') return
  // //
- // if (blackList.some(entry => entry.test(packName))) {
+ // if (blockList.some(entry => entry.test(packName))) {
  // return
  // }
  //