Skip to content

feat(s3): add S3_SKIP_POLICY env variable to disable setBucketPolicy #1362

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 1 commit into from
Apr 8, 2025
Merged

feat(s3): add S3_SKIP_POLICY env variable to disable setBucketPolicy #1362

merged 1 commit into from
Apr 8, 2025

Conversation

Deyvi-dev
Copy link
Contributor

@Deyvi-dev Deyvi-dev commented Apr 7, 2025 •
edited
Loading

Some S3-compatible providers like DigitalOcean Spaces do not support setting bucket policies via the MinIO client. This PR adds a conditional to skip this step when the provider does not support it.

Summary by Sourcery

Add an environment variable to conditionally skip setting bucket policies for S3-compatible storage providers that do not support this operation

New Features:

  • Introduce S3_SKIP_POLICY environment variable to allow skipping bucket policy configuration for incompatible S3 providers

Enhancements:

  • Modify S3 bucket creation process to conditionally set bucket policies based on environment configuration

@DavidsonGomes

@sourcery-ai Sourcery AI
Copy link
Contributor

sourcery-ai bot commented Apr 7, 2025 •
edited
Loading

Reviewer's Guide by Sourcery

This pull request introduces the S3_SKIP_POLICY environment variable. When set to true, the bucket policy setting will be skipped. This is useful for S3-compatible providers that do not support setting bucket policies.

Sequence diagram for creating a bucket with optional policy setting

sequenceDiagram
  participant App
  participant MinIO Client
  App->>MinIO Client: createBucket(bucketName)
  MinIO Client->>MinIO Client: Check if bucket exists
  alt Bucket does not exist
    MinIO Client->>MinIO Client: makeBucket(bucketName)
  end
  alt SKIP_POLICY is false
    App->>MinIO Client: setBucketPolicy()
  else SKIP_POLICY is true
    App->>App: Skip setBucketPolicy()
  end
  MinIO Client-->>App: Success or Error
Loading

File-Level Changes

Change Details Files
Introduces a new environment variable to conditionally skip setting the bucket policy.
  • Added S3_SKIP_POLICY to the environment configuration.
  • Implemented a conditional check to skip setBucketPolicy based on the value of S3_SKIP_POLICY.
 src/api/integrations/storage/s3/libs/minio.server.ts
src/config/env.config.ts
Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!
  • Generate a plan of action for an issue: Comment @sourcery-ai plan on
    an issue to generate a plan of action for it.

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

sourcery-ai[bot]
sourcery-ai bot reviewed Apr 7, 2025
View reviewed changes
Copy link
Contributor

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey @Deyvi-dev - I've reviewed your changes - here's some feedback:

Overall Comments:

  • Consider renaming S3_SKIP_POLICY to S3_SET_BUCKET_POLICY_ENABLED to avoid the double negative.
  • It might be helpful to add a log when the bucket policy is skipped, to make debugging easier.
Here's what I looked at during the review
  • 🟢 General issues: all looks good
  • 🟢 Security: all looks good
  • 🟢 Testing: all looks good
  • 🟢 Complexity: all looks good
  • 🟢 Documentation: all looks good
Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

@DavidsonGomes DavidsonGomes merged commit 09f79c9 into EvolutionAPI:develop Apr 8, 2025
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@sourcery-ai sourcery-ai[bot] sourcery-ai[bot] left review comments

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@Deyvi-dev @DavidsonGomes