chore: update S3Client to support region from options

src/providers/base.ts

@@ -3,7 +3,7 @@
 import { S3Client } from '@aws-sdk/client-s3'
 
 import { InvalidConfigError } from '../errors'
-import { Storage, custom } from '../schemas/input'
+import { Storage, customOptions } from '../schemas/input'
 import { sync, syncMetadata, syncTags } from '../storages/s3/buckets'
 import {
   ISyncCloudStorage,
@@ -33,7 +33,7 @@ export abstract class BaseProvider implements ISyncCloudStorage {
   constructor(options: ProviderOptions, servicePath: string) {
     this.options = options
     this.servicePath = servicePath
-    const validatedConfig = custom.safeParse(options)
+    const validatedConfig = customOptions.safeParse(options)
     const { success } = validatedConfig
 
     if (!success) {
@@ -62,8 +62,12 @@ export abstract class BaseProvider implements ISyncCloudStorage {
     const endpoint = this.options.syncCloudStorage.offline
       ? this.options.syncCloudStorage.endpoint
       : undefined
-
-    return new S3Client({ endpoint })
+    const region =
+      this.options.syncCloudStorage.region ?? process.env.AWS_REGION
+    return new S3Client({
+      endpoint,
+      ...(region ? { region } : {}),
+    })
   }
 
   /**

src/providers/serverless.ts

@@ -14,13 +14,12 @@ export class SyncCloudStorageServerless extends BaseProvider {
     // eslint-disable-next-line no-unused-vars, @typescript-eslint/no-unused-vars, @typescript-eslint/naming-convention
     _logging?: ServerlessPlugin.Logging
   ) {
+    const pluginOptions = serverless.service.custom.syncCloudStorage
     super(
       {
         syncCloudStorage: {
-          ...serverless.service.custom.syncCloudStorage,
-          region:
-            serverless.service.custom.syncCloudStorage.region ||
-            options['region'],
+          ...pluginOptions,
+          region: options['region'] || pluginOptions.region,
         },
       },
       serverless.service.serverless.config.servicePath

src/schemas/input.ts

@@ -26,7 +26,7 @@ const storage = z.object({
 
 const storages = z.array(storage).min(1)
 
-const custom = z.object({
+const customOptions = z.object({
   syncCloudStorage: z.object({
     disabled: z.boolean().optional().default(false),
     storages: storages,
@@ -43,9 +43,9 @@ const custom = z.object({
   }),
 })
 
-type Custom = z.infer<typeof custom>
+type CustomOptions = z.infer<typeof customOptions>
 type Storage = z.infer<typeof storage>
 type Tags = z.infer<typeof tags>
 
-export type { Custom, Storage, Tags }
-export { custom, tags, storage, storages, objectCannedACLs }
+export type { CustomOptions, Storage, Tags }
+export { customOptions, tags, storage, storages, objectCannedACLs }

src/types.ts

@@ -2,15 +2,15 @@ import { DeletedObject, Tag, _Object } from '@aws-sdk/client-s3'
 import { Construct } from 'constructs'
 import Serverless from 'serverless'
 
-import { Custom, Storage } from './schemas/input'
+import { CustomOptions, Storage } from './schemas/input'
 
 export type IServerlessProvider = ReturnType<
   typeof Serverless.prototype.getProvider
 >
 
 export type IServerless = {
   service: {
-    custom: Custom
+    custom: CustomOptions
     serverless: {
       config: {
         servicePath: string
@@ -110,9 +110,9 @@ export interface ISyncCloudStorage {
 
 export type Provider = IServerless | Construct
 
-export type ServerlessOptions = Custom
-export type CdkOptions = Custom['syncCloudStorage']
-export type ProviderOptions = Custom
+export type ServerlessOptions = CustomOptions
+export type CdkOptions = CustomOptions['syncCloudStorage']
+export type ProviderOptions = CustomOptions
 export interface LogActivity {
   name: string
   status: 'fulfilled' | 'rejected'

test/mocks/serverless.ts

@@ -1,4 +1,4 @@
-import { Custom } from '../../src/schemas/input'
+import { CustomOptions } from '../../src/schemas/input'
 import { IServerless } from '../../src/types'
 
 const serverlessGetProviderSpy = jest.fn().mockReturnValue({
@@ -10,7 +10,7 @@ const serverlessGetProviderSpy = jest.fn().mockReturnValue({
 })
 
 export const getServerlessMock = (
-  inputCustom: Custom,
+  inputCustom: CustomOptions,
   servicePath: string
 ): IServerless => ({
   service: {

test/schemas/input.fixture.ts

@@ -1,6 +1,10 @@
 import { faker } from '@faker-js/faker'
 
-import { Custom, Storage, objectCannedACLs } from '../../src/schemas/input'
+import {
+  CustomOptions,
+  Storage,
+  objectCannedACLs,
+} from '../../src/schemas/input'
 import { DeepPartial } from '../../src/types'
 
 export const sampleStoragePatterns = {
@@ -33,7 +37,7 @@ const generateStorage = (overrides: Partial<Storage> = {}): Storage => ({
   ...overrides,
 })
 
-const createBaseInputFixture = (): Required<Custom> => ({
+const createBaseInputFixture = (): Required<CustomOptions> => ({
   syncCloudStorage: {
     disabled: faker.datatype.boolean(),
     storages: [generateStorage()],
@@ -62,7 +66,7 @@ const createCustomInputFixture = ({
   region = process.env.AWS_REGION || '',
   silent = false,
   storageOverrides = {},
-}: FixtureOptions = {}): Custom => ({
+}: FixtureOptions = {}): CustomOptions => ({
   syncCloudStorage: {
     disabled: false,
     endpoint,
@@ -81,17 +85,18 @@ const createCustomInputFixture = ({
   },
 })
 
-export const createValidInputFixture = (options: FixtureOptions = {}): Custom =>
-  createCustomInputFixture(options)
+export const createValidInputFixture = (
+  options: FixtureOptions = {}
+): CustomOptions => createCustomInputFixture(options)
 
 export const createValidCdkInputFixture = (
   options: FixtureOptions = {}
-): Custom['syncCloudStorage'] =>
+): CustomOptions['syncCloudStorage'] =>
   createValidInputFixture(options).syncCloudStorage
 
 export const createValidInputFixtureWithACLBucketOwner = (
   options: FixtureOptions = {}
-): Required<Custom> =>
+): Required<CustomOptions> =>
   createCustomInputFixture({
     ...options,
     storageOverrides: {
@@ -102,7 +107,7 @@ export const createValidInputFixtureWithACLBucketOwner = (
 
 export const createValidInputFixtureWithTags = (
   options: FixtureOptions = {}
-): Required<Custom> =>
+): Required<CustomOptions> =>
   createCustomInputFixture({
     ...options,
     storageOverrides: {
@@ -113,7 +118,7 @@ export const createValidInputFixtureWithTags = (
 
 export const createValidInputFixtureWithMetadata = (
   options: FixtureOptions = {}
-): Required<Custom> =>
+): Required<CustomOptions> =>
   createCustomInputFixture({
     ...options,
     storageOverrides: {
@@ -122,19 +127,19 @@ export const createValidInputFixtureWithMetadata = (
     },
   })
 
-export const createValidDisabledInputFixture = (): Required<Custom> => ({
+export const createValidDisabledInputFixture = (): Required<CustomOptions> => ({
   ...createBaseInputFixture(),
   syncCloudStorage: {
     ...createBaseInputFixture().syncCloudStorage,
     disabled: true,
   },
 })
 
-export const createValidInputFileFixture = (): Required<Custom> =>
+export const createValidInputFileFixture = (): Required<CustomOptions> =>
   createBaseInputFixture()
 
 export const createInvalidInputFixture = (
-  additionalProps: DeepPartial<Custom> = {}
+  additionalProps: DeepPartial<CustomOptions> = {}
 ) => ({
   syncCloudStorage: {
     disabled: 'true',

test/schemas/input.test.ts

@@ -2,19 +2,19 @@ import {
   createInvalidInputFixture,
   createValidInputFileFixture,
 } from './input.fixture'
-import { custom } from '../../src/schemas/input'
+import { customOptions } from '../../src/schemas/input'
 
 describe('Input Custom Schema', () => {
   it('should validate the generated fake data', () => {
     const input = createValidInputFileFixture()
-    const result = custom.safeParse(input)
+    const result = customOptions.safeParse(input)
 
     expect(result.success).toBe(true)
   })
 
   it('should throw an error if the data is invalid', () => {
     const invalidInput = createInvalidInputFixture()
-    const result = custom.safeParse(invalidInput)
+    const result = customOptions.safeParse(invalidInput)
 
     expect(result.success).toBe(false)
   })

test/storages/local.test.ts

@@ -8,7 +8,7 @@ describe('Local File Provider', () => {
       syncCloudStorage: {
         storages: [storage],
       },
-    } = createValidInputFixture(patterns)
+    } = createValidInputFixture({ patterns })
     const expectedFiles = [
       'test/assets/giraffe-multiple/README.md',
       'test/assets/giraffe-multiple/sub/README.md',
@@ -29,7 +29,7 @@ describe('Local File Provider', () => {
       syncCloudStorage: {
         storages: [storage],
       },
-    } = createValidInputFixture(patterns)
+    } = createValidInputFixture({ patterns })
     const expectedFiles = ['test/assets/giraffe-multiple/sub/README.md']
     const filesToUpload = await getLocalFiles(patterns, storage, process.cwd())
     const filesToUploadKeys = filesToUpload.map((file) => file.key)