feat: add support for s3 and minio as storage providers

[muqsitnawaz]

What kind of change does this PR introduce?

support for s3 and minio for storage. you can configure it using the STORAGE_PROVIDER env variable

Why was this change needed?

https://github.com/gitroomhq/postiz-app/issues/322

Other information:

no

Checklist:

Put a "X" in the boxes below to indicate you have followed the checklist;

• [x] I have read the CONTRIBUTING guide.
• [x] I checked that there were not similar issues or PRs already open for this.
• [x] This PR fixes just ONE issue (do not include multiple issues or types of change in the same PR) For example, don't try and fix a UI issue and include new dependencies in the same PR.

Summary by CodeRabbit

• New Features

  • Added support for S3-compatible storage providers, including AWS S3 and MinIO, for file uploads and deletions.
  • Updated environment variable documentation to include new configuration options for S3 and MinIO storage.

• Documentation

  • Expanded and clarified environment variable descriptions to reflect new storage provider options.

[vercel[bot]]

@muqsitnawaz is attempting to deploy a commit to the Listinai Team on Vercel.

A member of the Team first needs to authorize it.

[coderabbitai[bot]]

Walkthrough

Support for S3-compatible storage providers has been added, including AWS S3 and MinIO. New classes for S3 and MinIO storage were introduced, and the upload factory was updated to instantiate these providers based on environment variables. The .env.example file was updated to document the new configuration options.

Changes

File(s)	Change Summary
.env.example	Added S3-compatible storage configuration variables and updated STORAGE_PROVIDER description.
libraries/nestjs-libraries/src/upload/s3.storage.ts	Added new S3Storage class implementing file upload/delete to S3-compatible services.
libraries/nestjs-libraries/src/upload/minio.storage.ts	Added new MinIOStorage class implementing file upload/delete to MinIO using S3 SDK.
libraries/nestjs-libraries/src/upload/upload.factory.ts	Updated factory to support "s3" and "minio" storage providers using new classes and environment variables.

Sequence Diagram(s)

sequenceDiagram
    participant Client
    participant UploadFactory
    participant S3Storage
    participant MinIOStorage

    Client->>UploadFactory: createStorage("s3" or "minio")
    alt "s3" selected
        UploadFactory->>S3Storage: new S3Storage(env vars)
        UploadFactory-->>Client: S3Storage instance
    else "minio" selected
        UploadFactory->>MinIOStorage: new MinIOStorage(env vars)
        UploadFactory-->>Client: MinIOStorage instance
    end

    Client->>S3Storage: uploadFile(file) / uploadSimple(url) / removeFile(path)
    Client->>MinIOStorage: uploadFile(file) / uploadSimple(url) / removeFile(path)

Poem

A hop, a skip, a storage leap,
Now S3 and MinIO secrets we keep!
With buckets and keys, our files take flight,
Through clouds and endpoints, day or night.
The factory now knows which way to go—
🐇 Uploads are faster, just so you know!

[!WARNING] There were issues while running some tools. Please review the errors and either fix the tool's configuration or disable the tool if it's a critical failure.

🔧 ESLint

If the error stems from missing dependencies, add them to the package.json file. For unrecoverable errors (e.g., due to private dependencies), disable the tool in the CodeRabbit configuration.

libraries/nestjs-libraries/src/upload/minio.storage.ts

Oops! Something went wrong! :(

ESLint: 8.57.0

Error [ERR_MODULE_NOT_FOUND]: Cannot find package '@eslint/eslintrc' imported from /eslint.config.mjs at Object.getPackageJSONURL (node:internal/modules/package_json_reader:255:9) at packageResolve (node:internal/modules/esm/resolve:767:81) at moduleResolve (node:internal/modules/esm/resolve:853:18) at defaultResolve (node:internal/modules/esm/resolve:983:11) at ModuleLoader.defaultResolve (node:internal/modules/esm/loader:801:12) at #cachedDefaultResolve (node:internal/modules/esm/loader:725:25) at ModuleLoader.resolve (node:internal/modules/esm/loader:708:38) at ModuleLoader.getModuleJobForImport (node:internal/modules/esm/loader:309:38) at #link (node:internal/modules/esm/module_job:202:49)

libraries/nestjs-libraries/src/upload/s3.storage.ts

Oops! Something went wrong! :(

ESLint: 8.57.0

Error [ERR_MODULE_NOT_FOUND]: Cannot find package '@eslint/eslintrc' imported from /eslint.config.mjs at Object.getPackageJSONURL (node:internal/modules/package_json_reader:255:9) at packageResolve (node:internal/modules/esm/resolve:767:81) at moduleResolve (node:internal/modules/esm/resolve:853:18) at defaultResolve (node:internal/modules/esm/resolve:983:11) at ModuleLoader.defaultResolve (node:internal/modules/esm/loader:801:12) at #cachedDefaultResolve (node:internal/modules/esm/loader:725:25) at ModuleLoader.resolve (node:internal/modules/esm/loader:708:38) at ModuleLoader.getModuleJobForImport (node:internal/modules/esm/loader:309:38) at #link (node:internal/modules/esm/module_job:202:49)

libraries/nestjs-libraries/src/upload/upload.factory.ts

Oops! Something went wrong! :(

ESLint: 8.57.0

Error [ERR_MODULE_NOT_FOUND]: Cannot find package '@eslint/eslintrc' imported from /eslint.config.mjs at Object.getPackageJSONURL (node:internal/modules/package_json_reader:255:9) at packageResolve (node:internal/modules/esm/resolve:767:81) at moduleResolve (node:internal/modules/esm/resolve:853:18) at defaultResolve (node:internal/modules/esm/resolve:983:11) at ModuleLoader.defaultResolve (node:internal/modules/esm/loader:801:12) at #cachedDefaultResolve (node:internal/modules/esm/loader:725:25) at ModuleLoader.resolve (node:internal/modules/esm/loader:708:38) at ModuleLoader.getModuleJobForImport (node:internal/modules/esm/loader:309:38) at #link (node:internal/modules/esm/module_job:202:49)

✨ Finishing Touches

• [ ] 📝 Generate Docstrings

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Explain this complex logic.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai explain this code block.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and explain its main purpose.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR.
• @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[egelhaus]

Consider to review the comments from @ copilot and @ coderabbitai They seem to address both the same issues.

[solonmedia]

Coming to postiz from mixpost I really miss the ability to connect to my S3 services. Hope it can get merged soon.