fix: forbidden KV key special characters to match documentation (#1097)

Co-authored-by: Brandon Sheehy (Contractor) <[email protected]>

Author: btsheehy

documentation/docs/kv-store/KVStore/prototype/delete.mdx

@@ -29,7 +29,7 @@ Returns `undefined`
   - If the provided `key`:
     - Is any of the strings `""`, `"."`, or `".."`
     - Starts with the string `".well-known/acme-challenge/"`
-    - Contains any of the characters `"#?*[]\n\r"`
+    - Contains any of the characters `"#;?^|\n\r"`
     - Is longer than 1024 characters
     - Does not exist
 

documentation/docs/kv-store/KVStore/prototype/get.mdx

@@ -41,7 +41,7 @@ If the `this` value does not inherit from `KVStore.prototype`, a [`TypeError`](.
   - If the provided `key`:
     - Is any of the strings `""`, `"."`, or `".."`
     - Starts with the string `".well-known/acme-challenge/"`
-    - Contains any of the characters `"#?*[]\n\r"`
+    - Contains any of the characters `"#;?^|\n\r"`
     - Is longer than 1024 characters
 
 ## Examples

documentation/docs/kv-store/KVStore/prototype/put.mdx

@@ -49,7 +49,7 @@ If the `this` value does not inherit from `KVStore.prototype`, a [`TypeError`](.
   - If the provided `key`:
     - Is any of the strings `""`, `"."`, or `".."`
     - Starts with the string `".well-known/acme-challenge/"`
-    - Contains any of the characters `"#?*[]\n\r"`
+    - Contains any of the characters `"#;?^|\n\r"`
     - Is longer than 1024 characters
 
 ## Examples

integration-tests/js-compute/fixtures/module-mode/src/kv-store.js

@@ -492,7 +492,7 @@ const debug = sdkVersion.endsWith('-debug');
     routes.set(
       '/kv-store/put/key-parameter-containing-special-characters',
       async () => {
-        const specialCharacters = ['[', ']', '*', '?', '#'];
+        const specialCharacters = [';', '^', '|', '#', '?'];
         for (const character of specialCharacters) {
           await assertRejects(
             async () => {
@@ -993,7 +993,7 @@ const debug = sdkVersion.endsWith('-debug');
     routes.set(
       '/kv-store/delete/key-parameter-containing-special-characters',
       async () => {
-        const specialCharacters = ['[', ']', '*', '?', '#'];
+        const specialCharacters = [';', '^', '|', '#', '?'];
         for (const character of specialCharacters) {
           await assertRejects(
             async () => {
@@ -1224,7 +1224,7 @@ const debug = sdkVersion.endsWith('-debug');
     routes.set(
       '/kv-store/get/key-parameter-containing-special-characters',
       async () => {
-        const specialCharacters = ['[', ']', '*', '?', '#'];
+        const specialCharacters = [';', '^', '|', '#', '?'];
         for (const character of specialCharacters) {
           await assertRejects(
             async () => {

runtime/fastly/builtins/kv-store.cpp

@@ -39,7 +39,7 @@ namespace {
 
 api::Engine *ENGINE;
 
-std::string_view bad_chars{"#?*[]\n\r"};
+std::string_view bad_chars{"#;?^|\n\r"};
 
 std::optional<char> find_invalid_character_for_kv_store_key(const char *str) {
   std::optional<char> res;
@@ -205,14 +205,14 @@ bool parse_and_validate_key(JSContext *cx, const char *key, size_t len) {
     case '\r':
       character = "carriage return";
       break;
-    case '[':
-      character = '[';
+    case '^':
+      character = '^';
       break;
-    case ']':
-      character = ']';
+    case '|':
+      character = '|';
       break;
-    case '*':
-      character = '*';
+    case ';':
+      character = ';';
       break;
     case '?':
       character = '?';

types/globals.d.ts

@@ -636,7 +636,7 @@ declare class KVStore {
    * @param key The key to retrieve from within the KV Store. A key cannot:
    * - Be any of the strings "", ".", or ".."
    * - Start with the string ".well-known/acme-challenge/""
-   * - Contain any of the characters "#?*[]\n\r"
+   * - Contain any of the characters "#;?^|\n\r"
    * - Be longer than 1024 characters
    */
   get(key: string): Promise<KVStoreEntry | null>;
@@ -650,7 +650,7 @@ declare class KVStore {
    * @param key The key to associate with the value. A key cannot:
    * - Be any of the strings "", ".", or ".."
    * - Start with the string ".well-known/acme-challenge/""
-   * - Contain any of the characters "#?*[]\n\r"
+   * - Contain any of the characters "#;?^|\n\r"
    * - Be longer than 1024 characters
    * @param value The value to store within the KV Store.
    */

types/kv-store.d.ts

@@ -43,7 +43,7 @@ declare module 'fastly:kv-store' {
      * @param key The key to retrieve from within the KV Store. A key cannot:
      * - Be any of the strings "", ".", or ".."
      * - Start with the string ".well-known/acme-challenge/""
-     * - Contain any of the characters "#?*[]\n\r"
+     * - Contain any of the characters "#;?^|\n\r"
      * - Be longer than 1024 characters
      */
     delete(key: string): Promise<undefined>;
@@ -55,7 +55,7 @@ declare module 'fastly:kv-store' {
      * @param key The key to retrieve from within the KV Store. A key cannot:
      * - Be any of the strings "", ".", or ".."
      * - Start with the string ".well-known/acme-challenge/""
-     * - Contain any of the characters "#?*[]\n\r"
+     * - Contain any of the characters "#;?^|\n\r"
      * - Be longer than 1024 characters
      */
     get(key: string): Promise<KVStoreEntry | null>;
@@ -69,7 +69,7 @@ declare module 'fastly:kv-store' {
      * @param key The key to associate with the value. A key cannot:
      * - Be any of the strings "", ".", or ".."
      * - Start with the string ".well-known/acme-challenge/""
-     * - Contain any of the characters "#?*[]\n\r"
+     * - Contain any of the characters "#;?^|\n\r"
      * - Be longer than 1024 characters
      * @param value The value to store within the KV Store.
      */