improve: support setting the url style of s3 store

Signed-off-by: ComixHe <[email protected]>
usememos · Jan 21, 2025 · 5488218 · 5488218
1 parent 702c092
commit 5488218
Show file tree

Hide file tree

Showing 8 changed files with 317 additions and 149 deletions.
diff --git a/plugin/storage/s3/s3.go b/plugin/storage/s3/s3.go
@@ -31,6 +31,7 @@ func NewClient(ctx context.Context, s3Config *storepb.StorageS3Config) (*Client,
 
 	client := s3.NewFromConfig(cfg, func(o *s3.Options) {
 		o.BaseEndpoint = aws.String(s3Config.Endpoint)
+		o.UsePathStyle = *aws.Bool(s3Config.UrlStyle == storepb.StorageS3Config_PATH)
 	})
 	return &Client{
 		Client: client,

diff --git a/proto/api/v1/workspace_setting_service.proto b/proto/api/v1/workspace_setting_service.proto
@@ -84,11 +84,17 @@ message WorkspaceStorageSetting {
   int64 upload_size_limit_mb = 3;
   // Reference: https://developers.cloudflare.com/r2/examples/aws/aws-sdk-go/
   message S3Config {
+    enum S3URLStyle {
+      VIRTUAL_HOST = 0;
+      PATH = 1;
+    }
+
     string access_key_id = 1;
     string access_key_secret = 2;
     string endpoint = 3;
     string region = 4;
     string bucket = 5;
+    S3URLStyle url_style = 6;
   }
   // The S3 config.
   S3Config s3_config = 4;

diff --git a/proto/gen/api/v1/workspace_setting_service.pb.go b/proto/gen/api/v1/workspace_setting_service.pb.go
diff --git a/proto/gen/apidocs.swagger.yaml b/proto/gen/apidocs.swagger.yaml
@@ -1864,7 +1864,15 @@ definitions:
         type: string
       bucket:
         type: string
+      urlStyle:
+        $ref: '#/definitions/WorkspaceStorageSettingS3ConfigS3URLStyle'
     title: 'Reference: https://developers.cloudflare.com/r2/examples/aws/aws-sdk-go/'
+  WorkspaceStorageSettingS3ConfigS3URLStyle:
+    type: string
+    enum:
+      - VIRTUAL_HOST
+      - PATH
+    default: VIRTUAL_HOST
   apiHttpBody:
     type: object
     properties:

diff --git a/proto/gen/store/workspace_setting.pb.go b/proto/gen/store/workspace_setting.pb.go
diff --git a/proto/store/workspace_setting.proto b/proto/store/workspace_setting.proto
@@ -86,11 +86,17 @@ message WorkspaceStorageSetting {
 
 // Reference: https://developers.cloudflare.com/r2/examples/aws/aws-sdk-go/
 message StorageS3Config {
+  enum S3URLStyle {
+    VIRTUAL_HOST = 0;
+    PATH = 1;
+  }
+
   string access_key_id = 1;
   string access_key_secret = 2;
   string endpoint = 3;
   string region = 4;
   string bucket = 5;
+  S3URLStyle url_style = 6;
 }
 
 message WorkspaceMemoRelatedSetting {

diff --git a/server/router/api/v1/workspace_setting_service.go b/server/router/api/v1/workspace_setting_service.go
@@ -196,6 +196,7 @@ func convertWorkspaceStorageSettingFromStore(settingpb *storepb.WorkspaceStorage
 			Endpoint:        settingpb.S3Config.Endpoint,
 			Region:          settingpb.S3Config.Region,
 			Bucket:          settingpb.S3Config.Bucket,
+			UrlStyle:        v1pb.WorkspaceStorageSetting_S3Config_S3URLStyle(settingpb.S3Config.UrlStyle),
 		}
 	}
 	return setting
@@ -217,6 +218,7 @@ func convertWorkspaceStorageSettingToStore(setting *v1pb.WorkspaceStorageSetting
 			Endpoint:        setting.S3Config.Endpoint,
 			Region:          setting.S3Config.Region,
 			Bucket:          setting.S3Config.Bucket,
+			UrlStyle:        storepb.StorageS3Config_S3URLStyle(setting.S3Config.UrlStyle),
 		}
 	}
 	return settingpb

diff --git a/web/src/components/Settings/StorageSection.tsx b/web/src/components/Settings/StorageSection.tsx
@@ -1,14 +1,15 @@
-import { Divider, List, ListItem, Radio, RadioGroup, Tooltip } from "@mui/joy";
+import { Divider, List, ListItem, Radio, RadioGroup, Select, Option, Tooltip } from "@mui/joy";
 import { Button, Input } from "@usememos/mui";
 import { isEqual } from "lodash-es";
 import { HelpCircleIcon } from "lucide-react";
-import { useMemo, useState } from "react";
+import React, { useMemo, useState } from "react";
 import { toast } from "react-hot-toast";
 import { Link } from "react-router-dom";
 import { workspaceSettingNamePrefix, useWorkspaceSettingStore } from "@/store/v1";
 import {
   WorkspaceStorageSetting,
   WorkspaceStorageSetting_S3Config,
+  WorkspaceStorageSetting_S3Config_S3URLStyle,
   WorkspaceStorageSetting_StorageType,
 } from "@/types/proto/api/v1/workspace_setting_service";
 import { WorkspaceSettingKey } from "@/types/proto/store/workspace_setting";
@@ -98,6 +99,16 @@ const StorageSection = () => {
     handlePartialS3ConfigChanged({ bucket: event.target.value });
   };
 
+  const handleS3ConfigUrlStyleChanged = (_: React.SyntheticEvent | null, value: WorkspaceStorageSetting_S3Config_S3URLStyle | null) => {
+    if (value === null) {
+      return;
+    }
+
+    handlePartialS3ConfigChanged({
+      urlStyle: value,
+    });
+  };
+
   const handleStorageTypeChanged = async (storageType: WorkspaceStorageSetting_StorageType) => {
     const update: WorkspaceStorageSetting = {
       ...workspaceStorageSetting,
@@ -174,6 +185,13 @@ const StorageSection = () => {
             <span className="text-gray-700 dark:text-gray-500 mr-1">Bucket</span>
             <Input value={workspaceStorageSetting.s3Config?.bucket} placeholder="" onChange={handleS3ConfigBucketChanged} />
           </div>
+          <div className="w-full flex flex-row justify-between items-center">
+            <span className="text-gray-700 dark:text-gray-500 mr-1">URL Style</span>
+            <Select value={workspaceStorageSetting.s3Config?.urlStyle} placeholder="Select Style" onChange={handleS3ConfigUrlStyleChanged}>
+              <Option value={WorkspaceStorageSetting_S3Config_S3URLStyle.VIRTUAL_HOST}>VirtualHost</Option>
+              <Option value={WorkspaceStorageSetting_S3Config_S3URLStyle.PATH}>Path</Option>
+            </Select>
+          </div>
         </>
       )}
       <div>