🚀 Release v1.6.0

[Amitminer]

Summary by CodeRabbit

• New Features

  • Cross-platform releases with Windows installer and Mac/Linux tarballs.
  • Backend: automatic compression, per‑IP rate limiting, security headers, health check, and auto‑generated key via response header.
  • CLI: encrypt/decrypt with password or key.
  • Frontend: dual key/password modes, server‑generated keys per file, copy and human‑readable formats, PDF key backup, toasts, and status improvements.

• Documentation

  • Major README overhaul, new backend/frontend READMEs, expanded API/CLI usage, and comprehensive SECURITY policy.

• Tests

  • New integration tests and updated HTTP tests.

• Chores

  • Optimized Dockerfiles, docker‑compose healthchecks, environment examples, ESLint config, and root scripts.

[vercel]

The latest updates on your projects. Learn more about Vercel for GitHub.

Project	Deployment	Preview	Comments	Updated (UTC)
encryptx	Ready	Preview	Comment	Sep 4, 2025 8:02am

[coderabbitai]

Warning

Rate limit exceeded

@Amitminer has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 11 minutes and 30 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

📥 Commits

Reviewing files that changed from the base of the PR and between afe2bdf and 828496b.

⛔ Files ignored due to path filters (7)

• assets/decryption-success.png is excluded by !**/*.png
• assets/decryption.png is excluded by !**/*.png
• assets/encryption-success.png is excluded by !**/*.png
• assets/encryption.png is excluded by !**/*.png
• assets/home.png is excluded by !**/*.png
• encryptx-frontend/package-lock.json is excluded by !**/package-lock.json
• encryptx-frontend/pnpm-lock.yaml is excluded by !**/pnpm-lock.yaml

📒 Files selected for processing (42)

• .github/workflows/release.yml (1 hunks)
• .gitignore (2 hunks)
• README.md (2 hunks)
• SECURITY.md (1 hunks)
• docker-compose.yml (2 hunks)
• encryptx-backend/.dockerignore (1 hunks)
• encryptx-backend/.env.example (1 hunks)
• encryptx-backend/Cargo.toml (2 hunks)
• encryptx-backend/DOCS.md (2 hunks)
• encryptx-backend/Dockerfile (1 hunks)
• encryptx-backend/README.md (1 hunks)
• encryptx-backend/src/cli/mod.rs (7 hunks)
• encryptx-backend/src/constants.rs (1 hunks)
• encryptx-backend/src/crypto/mod.rs (16 hunks)
• encryptx-backend/src/lib.rs (3 hunks)
• encryptx-backend/src/main.rs (4 hunks)
• encryptx-backend/src/middleware.rs (1 hunks)
• encryptx-backend/src/service.rs (1 hunks)
• encryptx-backend/src/validation.rs (1 hunks)
• encryptx-backend/tests/api.hurl (1 hunks)
• encryptx-backend/tests/integration_tests.rs (1 hunks)
• encryptx-frontend/.dockerignore (1 hunks)
• encryptx-frontend/Dockerfile (1 hunks)
• encryptx-frontend/README.md (1 hunks)
• encryptx-frontend/eslint.config.mjs (1 hunks)
• encryptx-frontend/example.env (1 hunks)
• encryptx-frontend/next.config.ts (1 hunks)
• encryptx-frontend/package.json (1 hunks)
• encryptx-frontend/public/.gitkeep (1 hunks)
• encryptx-frontend/src/app/api/health/route.ts (1 hunks)
• encryptx-frontend/src/app/components/forms/decrypt-form.tsx (2 hunks)
• encryptx-frontend/src/app/components/forms/encrypt-form.tsx (1 hunks)
• encryptx-frontend/src/app/layout.tsx (3 hunks)
• encryptx-frontend/src/app/page.tsx (1 hunks)
• encryptx-frontend/src/app/types/index.ts (3 hunks)
• encryptx-frontend/src/app/ui/sonner.tsx (1 hunks)
• encryptx-frontend/src/app/utils/backend-keep-alive.tsx (1 hunks)
• encryptx-frontend/src/app/utils/crypto.ts (1 hunks)
• encryptx-frontend/src/app/utils/index.ts (2 hunks)
• encryptx-frontend/src/app/utils/pdf.ts (1 hunks)
• encryptx-frontend/src/app/utils/status-helper.tsx (2 hunks)
• package.json (1 hunks)

Walkthrough

Adds a cross-platform release workflow, extensive backend refactor introducing service/middleware/validation layers, new constants and file-format changes, rate limiting, and CLI rework. Frontend gains dual password/key flows, utilities for key display/PDF export, health endpoints, and build/runtime Docker optimizations. Documentation, examples, and configs are overhauled across repo.

Changes

Cohort / File(s)	Summary
CI and Release Automation .github/workflows/release.yml	New GitHub Actions workflow to build Windows/Linux/macOS binaries, create Windows MSI via WiX, package artifacts, compute checksums, publish GitHub releases, and clean artifacts.
Backend Core: Architecture, Crypto, Constants, Services encryptx-backend/src/constants.rs, encryptx-backend/src/crypto/mod.rs, encryptx-backend/src/lib.rs, encryptx-backend/src/service.rs, encryptx-backend/src/validation.rs, encryptx-backend/src/middleware.rs, encryptx-backend/src/main.rs, encryptx-backend/src/cli/mod.rs, encryptx-backend/Cargo.toml	Introduces centralized constants; updates crypto to remove header-embedded keys, use configurable sizes, and async Argon2; adds compression flag and ZSTD flows; adds service layer, validation (incl. rate limiter), and security headers middleware; handlers refactored to services; CLI implemented with Clap; bumps version and adds futures-util.
Backend Build, Config, and Docs encryptx-backend/Dockerfile, encryptx-backend/.dockerignore, encryptx-backend/.env.example, encryptx-backend/README.md, encryptx-backend/DOCS.md	Multi-stage Alpine Docker build with non-root user and healthcheck; Docker ignore and env example added; backend README and docs expanded (API/CLI/security details, header behavior).
Backend Tests encryptx-backend/tests/integration_tests.rs, encryptx-backend/tests/api.hurl	Adds async integration tests covering password/key flows, edge cases, and compression signals; Hurl tests updated to new header semantics and health checks.
Frontend Core: Components and Utilities encryptx-frontend/src/app/components/forms/encrypt-form.tsx, .../decrypt-form.tsx, .../utils/crypto.ts, .../utils/pdf.ts, .../utils/status-helper.tsx, .../utils/index.ts, .../utils/backend-keep-alive.tsx, .../types/index.ts, .../api/health/route.ts, .../layout.tsx, .../page.tsx, .../ui/sonner.tsx	Encrypt flow now uses backend-generated keys via x-generated-key; adds dual password/key decrypt flow with validation; introduces human-readable key conversions, PDF key export, status helpers, size formatting, health route, and toasts; minor doc/comment updates.
Frontend Build and Config encryptx-frontend/Dockerfile, encryptx-frontend/.dockerignore, encryptx-frontend/next.config.ts, encryptx-frontend/eslint.config.mjs, encryptx-frontend/example.env, encryptx-frontend/package.json, encryptx-frontend/public/.gitkeep	PNPM-based multi-stage Docker build with standalone output and healthcheck; ignores added; Next config with security headers and compression; ESLint config expanded; env defaults updated; dependencies bumped and scripts adjusted; keep public dir.
Repo-level Docs and Ignore Rules README.md, SECURITY.md, .gitignore	README fully rewritten with architecture, setup, and deployment; new SECURITY policy; additional ignore patterns and secrets/backup filters.
Orchestration and Root Scripts docker-compose.yml, package.json	Compose adds defaults, healthchecks, shared network/volume; root package.json orchestrates dev/build/start/test for backend and frontend with concurrently.

Sequence Diagram(s)

sequenceDiagram
  autonumber
  actor User
  participant FE as Frontend (Next.js)
  participant BE as Backend (Actix Web)
  participant SV as FileEncryptionService
  participant ENC as EncryptionService
  participant DEC as DecryptionService
  participant COMP as CompressionService
  Note over BE,SF: New service-oriented backend flow

  User->>FE: Upload file + (password|key)
  FE->>BE: POST /encrypt<br/>headers: x-password | x-enc-key<br/>x-orig-filename
  BE->>SV: encrypt_file(req, body)
  SV->>COMP: compress(data) + flag
  alt password provided
    SV->>ENC: encrypt_with_password(...)
  else key or none
    SV->>ENC: encrypt_with_key(...)<br/>opt: generate key
  end
  ENC-->>SV: EncryptionResult (+opt generated key)
  SV-->>BE: encrypted bytes
  BE-->>FE: 200 octet-stream<br/>headers: x-generated-key? , Content-Disposition
  FE-->>User: Download .xd + show key (if any)

  User->>FE: Provide .xd +(password|key)
  FE->>BE: POST /decrypt<br/>headers: x-password | x-enc-key
  BE->>SV: decrypt_file(req, body)
  alt password-based format
    SV->>DEC: decrypt_with_password(...)
  else key-based format
    SV->>DEC: decrypt_with_key(...)
  end
  DEC-->>SV: DecryptionResult (bytes, filename)
  SV-->>BE: decrypted bytes
  BE-->>FE: 200 octet-stream<br/>Content-Disposition: original filename
  FE-->>User: Save original file

Loading

sequenceDiagram
  autonumber
  participant GH as GitHub Tag/Dispatch
  participant WF as Actions Workflow
  participant W as build-windows
  participant L as build-linux
  participant M as build-macos
  participant R as create-release
  participant C as cleanup

  GH-->>WF: Trigger v* tag or dispatch
  WF->>W: Checkout, Rust, cache, build exe, WiX MSI
  WF->>L: Checkout, Rust, deps, build, package tar.gz
  WF->>M: Checkout, Rust, build, package tar.gz
  W-->>R: Upload artifacts
  L-->>R: Upload artifacts
  M-->>R: Upload artifacts
  R->>R: Aggregate, checksums, prerelease logic
  R-->>GH: Publish release with assets
  R-->>C: Done
  C->>C: Delete artifacts

Loading

Estimated code review effort

🎯 5 (Critical) | ⏱️ ~120 minutes

Possibly related PRs

• feat(backend): Add CLI, public Rust API, zstd compression, tests, and clippy/lint cleanup #6 — Directly touches CLI and backend crypto flows with ZSTD compression; overlaps with constants and lib/api changes here.
• refactor: small improvements and better documentation #5 — Modifies the same backend crypto and handler files later refactored in this PR, indicating sequential evolution.
• Match CLI compression with backend #7 — Aligns compression behavior across components; complements this PR’s compression and packaging changes.

Poem

Hop hop! I packed the keys with care,
Zipped the bytes and salted air.
Headers set, the limits tight,
Service layers guard the night.
MSI, tarballs—tags released—
EncryptX feasts; my tests increased.
—A rabbit ships in silent peace. 🐇✨

✨ Finishing Touches

• 📝 Generate Docstrings

🧪 Generate unit tests

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch merge-v1.6.0

---

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.
  • 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.
• 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 the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Support

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

CodeRabbit Commands (Invoked using PR/Issue comments)

Type @coderabbitai help to get the list of available commands.

Other keywords and placeholders

• Add @coderabbitai ignore or @coderabbit 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

Status, Documentation and Community

• Visit our Status Page to check the current availability of CodeRabbit.
• 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.