Merge pull request #614 from AikidoSec/extra-comments

Add extra comments

Author: willem-delbare

library/helpers/safeDecodeURIComponent.ts

@@ -61,6 +61,8 @@ const HEX = {
  * Decodes a URI component, returning undefined if the URI is invalid.
  * This function is a safe alternative to `decodeURIComponent`, which throws
  * an error if the URI is malformed.
+ *
+ * We use this for performance reasons (throwing errors is very slow).
  */
 export function safeDecodeURIComponent(uri: string): string | undefined {
   let percentPosition = uri.indexOf("%");

library/sources/http-server/checkIfRequestIsBlocked.ts

@@ -14,6 +14,9 @@ const checkedBlocks = Symbol("__zen_checked_blocks__");
  * - Whether the user agent is blocked by a user agent blocklist
  */
 export function checkIfRequestIsBlocked(
+  // This flag is used to determine whether the request has already been checked
+  // We use a Symbol so that we don't accidentally overwrite any other properties on the response object
+  // and that we're the only ones that can access it
   res: ServerResponse & { [checkedBlocks]?: boolean },
   agent: Agent
 ): boolean {