feat(core,schemas): support region option for s3 storage (#4439)

.changeset/lucky-wolves-buy.md

@@ -0,0 +1,6 @@
+---
+"@logto/schemas": minor
+"@logto/core": minor
+---
+
+Support region option for s3 storage

packages/core/src/utils/storage/index.ts

@@ -11,12 +11,15 @@ export const buildUploadFile = (config: StorageProviderData): UploadFile => {
     return storage.uploadFile;
   }
 
-  const storage = buildS3Storage(
-    config.endpoint,
-    config.bucket,
-    config.accessKeyId,
-    config.accessSecretKey
-  );
+  const { endpoint, bucket, accessKeyId, accessSecretKey, region } = config;
+
+  const storage = buildS3Storage({
+    endpoint,
+    bucket,
+    accessKeyId,
+    secretAccessKey: accessSecretKey,
+    region,
+  });
 
   return storage.uploadFile;
 };

packages/core/src/utils/storage/s3-storage.ts

@@ -2,17 +2,38 @@ import { S3Client, PutObjectCommand } from '@aws-sdk/client-s3';
 
 import type { UploadFile } from './types.js';
 
-export const buildS3Storage = (
-  endpoint: string,
-  bucket: string,
-  accessKeyId: string,
-  secretAccessKey: string
-) => {
+const getRegionFromEndpoint = (endpoint?: string) => {
+  if (!endpoint) {
+    return;
+  }
+
+  return /s3\.([^.]*)\.amazonaws/.exec(endpoint)?.[1];
+};
+
+type BuildS3StorageParameters = {
+  bucket: string;
+  accessKeyId: string;
+  secretAccessKey: string;
+  region?: string;
+  endpoint?: string;
+};
+
+export const buildS3Storage = ({
+  bucket,
+  accessKeyId,
+  secretAccessKey,
+  region,
+  endpoint,
+}: BuildS3StorageParameters) => {
+  if (!region && !endpoint) {
+    throw new Error('Either region or endpoint must be provided');
+  }
+
   // Endpoint example: s3.us-west-2.amazonaws.com
-  const region = /s3\.([^.]*)\.amazonaws/.exec(endpoint)?.[1] ?? 'us-east-1';
+  const finalRegion = region ?? getRegionFromEndpoint(endpoint) ?? 'us-east-1';
 
   const client = new S3Client({
-    region,
+    region: finalRegion,
     endpoint,
     credentials: {
       accessKeyId,
@@ -40,7 +61,7 @@ export const buildS3Storage = (
     }
 
     return {
-      url: `https://${bucket}.s3.${region}.amazonaws.com/${objectKey}`,
+      url: `https://${bucket}.s3.${finalRegion}.amazonaws.com/${objectKey}`,
     };
   };
 

packages/schemas/src/types/system.ts

@@ -40,7 +40,8 @@ export const storageProviderDataGuard = z.discriminatedUnion('provider', [
   }),
   z.object({
     provider: z.literal(StorageProvider.S3Storage),
-    endpoint: z.string(),
+    endpoint: z.string().optional(),
+    region: z.string().optional(),
     bucket: z.string(),
     accessKeyId: z.string(),
     accessSecretKey: z.string(),