Merge pull request #154 from supabase-community/fix/cache-control

fix: send cache-control as form data

Author: anand2312

.pre-commit-config.yaml

@@ -1,3 +1,4 @@
+exclude: '^.*\.(md|MD)$'
 repos:
     - repo: https://github.com/pre-commit/pre-commit-hooks
       rev: v4.0.1

docs/api/types.rst

@@ -16,7 +16,7 @@ Options
 
 .. autotypeddict:: storage3.types.TransformOptions
 
-.. autotypeddict:: storage3.types.CreateSignedURLOptions
+.. autotypeddict:: storage3.types.URLOptions
 
 .. autotypeddict:: storage3.types.CreateSignedURLsOptions
 

storage3/_async/file_api.py

@@ -37,13 +37,10 @@ async def _request(
         headers: Optional[dict[str, Any]] = None,
         json: Optional[dict[Any, Any]] = None,
         files: Optional[Any] = None,
+        **kwargs: Any,
     ) -> Response:
         response = await self._client.request(
-            method,
-            url,
-            headers=headers or {},
-            json=json,
-            files=files,
+            method, url, headers=headers or {}, json=json, files=files, **kwargs
         )
         try:
             response.raise_for_status()
@@ -108,9 +105,12 @@ async def upload_to_signed_url(
             file_options = {}
 
         cache_control = file_options.get("cache-control")
+        # cacheControl is also passed as form data
+        # https://github.com/supabase/storage-js/blob/fa44be8156295ba6320ffeff96bdf91016536a46/src/packages/StorageFileApi.ts#L89
+        _data = {}
         if cache_control:
             file_options["cache-control"] = f"max-age={cache_control}"
-
+            _data = {"cacheControl": cache_control}
         headers = {
             **self._client.headers,
             **DEFAULT_FILE_OPTIONS,
@@ -135,10 +135,7 @@ async def upload_to_signed_url(
                 )
             }
         return await self._request(
-            "PUT",
-            final_url,
-            files=_file,
-            headers=headers,
+            "PUT", final_url, files=_file, headers=headers, data=_data
         )
 
     async def create_signed_url(
@@ -279,7 +276,7 @@ async def copy(self, from_path: str, to_path: str) -> dict[str, str]:
         )
         return res.json()
 
-    async def remove(self, paths: list) -> list[dict[str, any]]:
+    async def remove(self, paths: list) -> list[dict[str, Any]]:
         """
         Deletes files within the same bucket
 
@@ -369,8 +366,10 @@ async def upload(
         if file_options is None:
             file_options = {}
         cache_control = file_options.get("cache-control")
+        _data = {}
         if cache_control:
             file_options["cache-control"] = f"max-age={cache_control}"
+            _data = {"cacheControl": cache_control}
 
         headers = {
             **self._client.headers,
@@ -399,10 +398,7 @@ async def upload(
         _path = self._get_final_path(path)
 
         return await self._request(
-            "POST",
-            f"/object/{_path}",
-            files=files,
-            headers=headers,
+            "POST", f"/object/{_path}", files=files, headers=headers, data=_data
         )
 
     def _get_final_path(self, path: str) -> str:

storage3/_sync/file_api.py

@@ -37,13 +37,10 @@ def _request(
         headers: Optional[dict[str, Any]] = None,
         json: Optional[dict[Any, Any]] = None,
         files: Optional[Any] = None,
+        **kwargs: Any,
     ) -> Response:
         response = self._client.request(
-            method,
-            url,
-            headers=headers or {},
-            json=json,
-            files=files,
+            method, url, headers=headers or {}, json=json, files=files, **kwargs
         )
         try:
             response.raise_for_status()
@@ -108,9 +105,12 @@ def upload_to_signed_url(
             file_options = {}
 
         cache_control = file_options.get("cache-control")
+        # cacheControl is also passed as form data
+        # https://github.com/supabase/storage-js/blob/fa44be8156295ba6320ffeff96bdf91016536a46/src/packages/StorageFileApi.ts#L89
+        _data = {}
         if cache_control:
             file_options["cache-control"] = f"max-age={cache_control}"
-
+            _data = {"cacheControl": cache_control}
         headers = {
             **self._client.headers,
             **DEFAULT_FILE_OPTIONS,
@@ -134,12 +134,7 @@ def upload_to_signed_url(
                     headers.pop("content-type"),
                 )
             }
-        return self._request(
-            "PUT",
-            final_url,
-            files=_file,
-            headers=headers,
-        )
+        return self._request("PUT", final_url, files=_file, headers=headers, data=_data)
 
     def create_signed_url(
         self, path: str, expires_in: int, options: URLOptions = {}
@@ -279,7 +274,7 @@ def copy(self, from_path: str, to_path: str) -> dict[str, str]:
         )
         return res.json()
 
-    def remove(self, paths: list) -> list[dict[str, any]]:
+    def remove(self, paths: list) -> list[dict[str, Any]]:
         """
         Deletes files within the same bucket
 
@@ -369,8 +364,10 @@ def upload(
         if file_options is None:
             file_options = {}
         cache_control = file_options.get("cache-control")
+        _data = {}
         if cache_control:
             file_options["cache-control"] = f"max-age={cache_control}"
+            _data = {"cacheControl": cache_control}
 
         headers = {
             **self._client.headers,
@@ -399,10 +396,7 @@ def upload(
         _path = self._get_final_path(path)
 
         return self._request(
-            "POST",
-            f"/object/{_path}",
-            files=files,
-            headers=headers,
+            "POST", f"/object/{_path}", files=files, headers=headers, data=_data
         )
 
     def _get_final_path(self, path: str) -> str: