Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: add support for specifying content-type with OSS across storage… #17166

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions api/core/tools/tool_file_manager.py
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,7 @@ def create_file_by_raw(
# Add extension flexibly
present_filename = filename if has_extension else f"{filename}{extension}"
filepath = f"tools/{tenant_id}/{unique_filename}"
storage.save(filepath, file_binary)
storage.save(filepath, file_binary, mimetype)

tool_file = ToolFile(
user_id=user_id,
Expand Down Expand Up @@ -113,7 +113,7 @@ def create_file_by_url(
unique_name = uuid4().hex
filename = f"{unique_name}{extension}"
filepath = f"tools/{tenant_id}/{filename}"
storage.save(filepath, blob)
storage.save(filepath, blob, mimetype)

tool_file = ToolFile(
user_id=user_id,
Expand Down
4 changes: 2 additions & 2 deletions api/extensions/ext_storage.py
Original file line number Diff line number Diff line change
Expand Up @@ -72,9 +72,9 @@ def get_storage_factory(storage_type: str) -> Callable[[], BaseStorage]:
case _:
raise ValueError(f"unsupported storage type {storage_type}")

def save(self, filename, data):
def save(self, filename, data, content_type=None):
try:
self.storage_runner.save(filename, data)
self.storage_runner.save(filename, data, content_type)
except Exception as e:
logger.exception(f"Failed to save file {filename}")
raise e
Expand Down
5 changes: 3 additions & 2 deletions api/extensions/storage/aliyun_oss_storage.py
Original file line number Diff line number Diff line change
Expand Up @@ -28,8 +28,9 @@ def __init__(self):
region=region,
)

def save(self, filename, data):
self.client.put_object(self.__wrapper_folder_filename(filename), data)
def save(self, filename, data, content_type=None):
headers = {"Content-Type": content_type} if content_type else None
self.client.put_object(self.__wrapper_folder_filename(filename), data, headers=headers)

def load_once(self, filename: str) -> bytes:
obj = self.client.get_object(self.__wrapper_folder_filename(filename))
Expand Down
5 changes: 3 additions & 2 deletions api/extensions/storage/aws_s3_storage.py
Original file line number Diff line number Diff line change
Expand Up @@ -48,8 +48,9 @@ def __init__(self):
# other error, raise exception
raise

def save(self, filename, data):
self.client.put_object(Bucket=self.bucket_name, Key=filename, Body=data)
def save(self, filename, data, content_type=None):
content_type = content_type or "application/octet-stream"
self.client.put_object(Bucket=self.bucket_name, Key=filename, Body=data, ContentType=content_type)

def load_once(self, filename: str) -> bytes:
try:
Expand Down
5 changes: 3 additions & 2 deletions api/extensions/storage/azure_blob_storage.py
Original file line number Diff line number Diff line change
Expand Up @@ -26,10 +26,11 @@ def __init__(self):
else:
self.credential = None

def save(self, filename, data):
def save(self, filename, data, content_type=None):
metadata = {"Content-Type": content_type} if content_type else None
client = self._sync_client()
blob_container = client.get_container_client(container=self.bucket_name)
blob_container.upload_blob(filename, data)
blob_container.upload_blob(filename, data, metadata=metadata)

def load_once(self, filename: str) -> bytes:
client = self._sync_client()
Expand Down
9 changes: 7 additions & 2 deletions api/extensions/storage/baidu_obs_storage.py
Original file line number Diff line number Diff line change
Expand Up @@ -26,12 +26,17 @@ def __init__(self):

self.client = BosClient(config=client_config)

def save(self, filename, data):
def save(self, filename, data, content_type=None):
md5 = hashlib.md5()
md5.update(data)
content_md5 = base64.standard_b64encode(md5.digest())
self.client.put_object(
bucket_name=self.bucket_name, key=filename, data=data, content_length=len(data), content_md5=content_md5
bucket_name=self.bucket_name,
key=filename,
data=data,
content_length=len(data),
content_md5=content_md5,
content_type=content_type,
)

def load_once(self, filename: str) -> bytes:
Expand Down
2 changes: 1 addition & 1 deletion api/extensions/storage/base_storage.py
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ class BaseStorage(ABC):
"""Interface for file storage."""

@abstractmethod
def save(self, filename, data):
def save(self, filename, data, content_type=None):
raise NotImplementedError

@abstractmethod
Expand Down
4 changes: 2 additions & 2 deletions api/extensions/storage/google_cloud_storage.py
Original file line number Diff line number Diff line change
Expand Up @@ -26,11 +26,11 @@ def __init__(self):
else:
self.client = google_cloud_storage.Client()

def save(self, filename, data):
def save(self, filename, data, content_type=None):
bucket = self.client.get_bucket(self.bucket_name)
blob = bucket.blob(filename)
with io.BytesIO(data) as stream:
blob.upload_from_file(stream)
blob.upload_from_file(stream, content_type=content_type)

def load_once(self, filename: str) -> bytes:
bucket = self.client.get_bucket(self.bucket_name)
Expand Down
5 changes: 3 additions & 2 deletions api/extensions/storage/huawei_obs_storage.py
Original file line number Diff line number Diff line change
Expand Up @@ -19,8 +19,9 @@ def __init__(self):
server=dify_config.HUAWEI_OBS_SERVER,
)

def save(self, filename, data):
self.client.putObject(bucketName=self.bucket_name, objectKey=filename, content=data)
def save(self, filename, data, content_type=None):
headers = {"contentType": content_type} if content_type else None
self.client.putObject(bucketName=self.bucket_name, objectKey=filename, content=data, headers=headers)

def load_once(self, filename: str) -> bytes:
data: bytes = self.client.getObject(bucketName=self.bucket_name, objectKey=filename)["body"].response.read()
Expand Down
5 changes: 3 additions & 2 deletions api/extensions/storage/opendal_storage.py
Original file line number Diff line number Diff line change
Expand Up @@ -40,8 +40,9 @@ def __init__(self, scheme: str, **kwargs):
self.op = self.op.layer(retry_layer)
logger.debug("added retry layer to opendal operator")

def save(self, filename: str, data: bytes) -> None:
self.op.write(path=filename, bs=data)
def save(self, filename: str, data: bytes, content_type=None) -> None:
content_type = content_type or "application/octet-stream"
self.op.write(path=filename, bs=data, content_type=content_type)
logger.debug(f"file {filename} saved")

def load_once(self, filename: str) -> bytes:
Expand Down
5 changes: 3 additions & 2 deletions api/extensions/storage/oracle_oci_storage.py
Original file line number Diff line number Diff line change
Expand Up @@ -22,8 +22,9 @@ def __init__(self):
region_name=dify_config.OCI_REGION,
)

def save(self, filename, data):
self.client.put_object(Bucket=self.bucket_name, Key=filename, Body=data)
def save(self, filename, data, content_type=None):
content_type = content_type or "application/octet-stream"
self.client.put_object(Bucket=self.bucket_name, Key=filename, Body=data, ContentType=content_type)

def load_once(self, filename: str) -> bytes:
try:
Expand Down
5 changes: 3 additions & 2 deletions api/extensions/storage/supabase_storage.py
Original file line number Diff line number Diff line change
Expand Up @@ -28,8 +28,9 @@ def create_bucket(self, id, bucket_name):
if not self.bucket_exists():
self.client.storage.create_bucket(id=id, name=bucket_name)

def save(self, filename, data):
self.client.storage.from_(self.bucket_name).upload(filename, data)
def save(self, filename, data, content_type=None):
file_options = {"content-type": content_type} if content_type else None
self.client.storage.from_(self.bucket_name).upload(filename, data, file_options)

def load_once(self, filename: str) -> bytes:
content: bytes = self.client.storage.from_(self.bucket_name).download(filename)
Expand Down
5 changes: 3 additions & 2 deletions api/extensions/storage/tencent_cos_storage.py
Original file line number Diff line number Diff line change
Expand Up @@ -21,8 +21,9 @@ def __init__(self):
)
self.client = CosS3Client(config)

def save(self, filename, data):
self.client.put_object(Bucket=self.bucket_name, Body=data, Key=filename)
def save(self, filename, data, content_type=None):
metadata = {"ContentType": content_type or "application/octet-stream"}
self.client.put_object(Bucket=self.bucket_name, Body=data, Key=filename, Metadata=metadata)

def load_once(self, filename: str) -> bytes:
data: bytes = self.client.get_object(Bucket=self.bucket_name, Key=filename)["Body"].get_raw_stream().read()
Expand Down
4 changes: 2 additions & 2 deletions api/extensions/storage/volcengine_tos_storage.py
Original file line number Diff line number Diff line change
Expand Up @@ -19,8 +19,8 @@ def __init__(self):
region=dify_config.VOLCENGINE_TOS_REGION,
)

def save(self, filename, data):
self.client.put_object(bucket=self.bucket_name, key=filename, content=data)
def save(self, filename, data, content_type=None):
self.client.put_object(bucket=self.bucket_name, key=filename, content=data, content_type=content_type)

def load_once(self, filename: str) -> bytes:
data = self.client.get_object(bucket=self.bucket_name, key=filename).read()
Expand Down
4 changes: 2 additions & 2 deletions api/services/file_service.py
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@ def upload_file(
file_key = "upload_files/" + (current_tenant_id or "") + "/" + file_uuid + "." + extension

# save file to storage
storage.save(file_key, content)
storage.save(file_key, content, mimetype)

# save file to db
upload_file = UploadFile(
Expand Down Expand Up @@ -116,7 +116,7 @@ def upload_text(text: str, text_name: str) -> UploadFile:
file_key = "upload_files/" + current_user.current_tenant_id + "/" + file_uuid + ".txt"

# save file to storage
storage.save(file_key, text.encode("utf-8"))
storage.save(file_key, text.encode("utf-8"), "text/plain")

# save file to db
upload_file = UploadFile(
Expand Down
2 changes: 1 addition & 1 deletion api/tests/unit_tests/oss/__mock/volcengine_tos.py
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ def __init__(self, ak="", sk="", endpoint="", region=""):
}
)

def put_object(self, bucket: str, key: str, content=None) -> PutObjectOutput:
def put_object(self, bucket: str, key: str, content=None, content_type=None) -> PutObjectOutput:
assert bucket == self.bucket_name
assert key == self.key
assert content == self.content
Expand Down