bug/Permit deleting db entries with leading slashes (#218)

* poetry lock

* Formatting

* Avoid object has no attribute '_refresh_timer'

When called without a refresh function we end up getting

    AttributeError: 'AsyncDatabase' object has no attribute '_refresh_timer'

on attempted close. Fix this.

* Revert #172

This was a good first attempt, but still prevented users from deleting the keys they'd created

* Switch delete method to use new multipart/form-data delete method that supports deleting keys with leading slashes

* Adjusting tests to reflect the gap in getting slashy keys

Author: blast-hardcheese

poetry.lock

@@ -1,4 +1,5 @@
 """CLI for interacting with your Repl's DB. Written as top-level script."""
+
 import json
 
 import click

src/replit/__main__.py

@@ -1,4 +1,5 @@
 """Interface with the Replit Database."""
+
 from typing import Any
 
 from . import default_db

src/replit/database/__init__.py

@@ -20,6 +20,7 @@
 from aiohttp_retry import ExponentialRetry, RetryClient  # type: ignore
 import requests
 from requests.adapters import HTTPAdapter, Retry
+from urllib3.filepost import encode_multipart_formdata
 
 
 def to_primitive(o: Any) -> Any:
@@ -62,18 +63,6 @@ def dumps(val: Any) -> str:
 _dumps = dumps
 
 
-def _sanitize_key(key: str) -> str:
-    """Strip slashes from the beginning of keys.
-
-    Args:
-        key (str): The key to strip
-
-    Returns:
-        str: The stripped key
-    """
-    return key.lstrip("/")
-
-
 class AsyncDatabase:
     """Async interface for Replit Database.
 
@@ -123,6 +112,8 @@ def __init__(
         if self._get_db_url:
             self._refresh_timer = threading.Timer(3600, self._refresh_db)
             self._refresh_timer.start()
+        else:
+            self._refresh_timer = None
         watched_thread = threading.main_thread()
         self._watchdog_timer = threading.Timer(1, self._watchdog, args=[watched_thread])
         self._watchdog_timer.start()
@@ -228,7 +219,6 @@ async def set_bulk_raw(self, values: Dict[str, str]) -> None:
         Args:
             values (Dict[str, str]): The key-value pairs to set.
         """
-        values = {_sanitize_key(k): v for k, v in values.items()}
         async with self.client.post(self.db_url, data=values) as response:
             response.raise_for_status()
 
@@ -241,8 +231,9 @@ async def delete(self, key: str) -> None:
         Raises:
             KeyError: Key does not exist
         """
+        body, content_type = encode_multipart_formdata({"key": key})
         async with self.client.delete(
-            self.db_url + "/" + urllib.parse.quote(key)
+            self.db_url, data=body, headers={"Content-Type": content_type}
         ) as response:
             if response.status == 404:
                 raise KeyError(key)
@@ -550,6 +541,8 @@ def __init__(
         if self._get_db_url:
             self._refresh_timer = threading.Timer(3600, self._refresh_db)
             self._refresh_timer.start()
+        else:
+            self._refresh_timer = None
         watched_thread = threading.main_thread()
         self._watchdog_timer = threading.Timer(1, self._watchdog, args=[watched_thread])
         self._watchdog_timer.start()
@@ -685,7 +678,6 @@ def set_bulk_raw(self, values: Dict[str, str]) -> None:
         Args:
             values (Dict[str, str]): The key-value pairs to set.
         """
-        values = {_sanitize_key(k): v for k, v in values.items()}
         r = self.sess.post(self.db_url, data=values)
         r.raise_for_status()
 
@@ -698,7 +690,10 @@ def __delitem__(self, key: str) -> None:
         Raises:
             KeyError: Key is not set
         """
-        r = self.sess.delete(self.db_url + "/" + urllib.parse.quote(key))
+        body, content_type = encode_multipart_formdata({"key": key})
+        r = self.sess.delete(
+            self.db_url, data=body, headers={"Content-Type": content_type}
+        )
         if r.status_code == 404:
             raise KeyError(key)
 

src/replit/database/database.py

@@ -1,4 +1,5 @@
 """A module containing the default database."""
+
 import os
 import os.path
 from typing import Any, Optional

src/replit/database/default_db.py

@@ -1,4 +1,5 @@
 """A module containing a database proxy implementation."""
+
 from typing import Any
 from urllib.parse import quote
 

src/replit/database/server.py

@@ -1,4 +1,5 @@
 """Information about your repl."""
+
 import os
 from typing import Optional
 

src/replit/info.py

@@ -1,4 +1,5 @@
 """Utilities for working with user mappings."""
+
 from collections.abc import Mapping, MutableMapping
 from typing import Any, Iterator, Optional
 

src/replit/web/user.py

@@ -129,30 +129,48 @@ async def test_slash_keys(self) -> None:
         """Test that slash keys work."""
         k = "/key"
         # set
-        await self.db.set(k,"val1")
-        self.assertEqual(await self.db.get(k), "val1")
+        await self.db.set(k, "val1")
+        # TODO: Getting slash keys is currently not supported
+        #       See https://github.com/replit/replit-py/pull/218#discussion_r1588295348
+        # self.assertEqual(await self.db.get(k), "val1")
+        self.assertEqual(list(await self.db.list("/")), [k])
         await self.db.delete(k)
+        # TODO: Getting slash keys is currently not supported
+        #       KeyError is the same though, so it can stay.
         with self.assertRaises(KeyError):
             await self.db.get(k)
         # set_raw
-        await self.db.set_raw(k,"val1")
-        self.assertEqual(await self.db.get_raw(k), "val1")
+        await self.db.set_raw(k, "val1")
+        # TODO: Getting slash keys is currently not supported
+        # self.assertEqual(await self.db.get_raw(k), "val1")
+        self.assertEqual(list(await self.db.list("/")), [k])
         await self.db.delete(k)
+        # TODO: Getting slash keys is currently not supported.
+        #       KeyError is the same though, so it can stay.
         with self.assertRaises(KeyError):
             await self.db.get(k)
         # set_bulk
         await self.db.set_bulk({k: "val1"})
-        self.assertEqual(await self.db.get(k), "val1")
+        # TODO: Getting slash keys is currently not supported
+        # self.assertEqual(await self.db.get(k), "val1")
+        self.assertEqual(list(await self.db.list("/")), [k])
         await self.db.delete(k)
+        # TODO: Getting slash keys is currently not supported
+        #       KeyError is the same though, so it can stay.
         with self.assertRaises(KeyError):
             await self.db.get(k)
         # set_bulk_raw
         await self.db.set_bulk_raw({k: "val1"})
-        self.assertEqual(await self.db.get_raw(k), "val1")
+        # TODO: Getting slash keys is currently not supported
+        # self.assertEqual(await self.db.get_raw(k), "val1")
+        self.assertEqual(list(await self.db.list("/")), [k])
         await self.db.delete(k)
+        # TODO: Getting slash keys is currently not supported
+        #       KeyError is the same though, so it can stay.
         with self.assertRaises(KeyError):
             await self.db.get(k)
 
+
 class TestDatabase(unittest.TestCase):
     """Tests for replit.database.Database."""
 
@@ -291,26 +309,43 @@ def test_slash_keys(self) -> None:
         """Test that slash keys work."""
         k = "/key"
         # set
-        self.db.set(k,"val1")
-        self.assertEqual(self.db[k], "val1")
+        self.db.set(k, "val1")
+        # TODO: Getting slash keys is currently not supported
+        #       See https://github.com/replit/replit-py/pull/218#discussion_r1588295348
+        # self.assertEqual(self.db[k], "val1")
+        self.assertEqual(list(self.db.keys()), [k])
         del self.db[k]
+        # TODO: Getting slash keys is currently not supported
+        #       KeyError is the same though, so it can stay.
         with self.assertRaises(KeyError):
             self.db[k]
         # set_raw
-        self.db.set_raw(k,"val1")
-        self.assertEqual(self.db.get_raw(k), "val1")
+        self.db.set_raw(k, "val1")
+        # TODO: Getting slash keys is currently not supported
+        # self.assertEqual(self.db.get_raw(k), "val1")
+        self.assertEqual(list(self.db.keys()), [k])
         del self.db[k]
+        # TODO: Getting slash keys is currently not supported
+        #       KeyError is the same though, so it can stay.
         with self.assertRaises(KeyError):
             self.db[k]
         # set_bulk
         self.db.set_bulk({k: "val1"})
-        self.assertEqual(self.db.get(k), "val1")
+        # TODO: Getting slash keys is currently not supported
+        # self.assertEqual(self.db.get(k), "val1")
+        self.assertEqual(list(self.db.keys()), [k])
         del self.db[k]
+        # TODO: Getting slash keys is currently not supported
+        #       KeyError is the same though, so it can stay.
         with self.assertRaises(KeyError):
             self.db[k]
         # set_bulk_raw
         self.db.set_bulk_raw({k: "val1"})
-        self.assertEqual(self.db.get_raw(k), "val1")
+        # TODO: Getting slash keys is currently not supported
+        # self.assertEqual(self.db.get_raw(k), "val1")
+        self.assertEqual(list(self.db.keys()), [k])
         del self.db[k]
+        # TODO: Getting slash keys is currently not supported
+        #       KeyError is the same though, so it can stay.
         with self.assertRaises(KeyError):
             self.db[k]