Release

[philipbrembeck]

Summary by Sourcery

Introduce new components for product and ingredient checking, enhance existing components for better maintainability, and improve the build and CI systems. Add support for multiple languages and update documentation with a new developer guide.

New Features:

• Introduce a new IngredientsCheck component for checking the vegan status of ingredients.
• Add a new ProductSearch component for searching products by barcode and displaying their vegan status.
• Implement a new ViewportScanner component for scanning barcodes using the device camera.
• Add support for multiple languages with locale-specific pages and translations.

Enhancements:

• Refactor the ShareButton component to use a more flexible and maintainable structure for handling share options.
• Improve the Footer component by introducing a FooterLink sub-component for better code organization.
• Enhance the Nav component by introducing a NavItem sub-component for better code organization.
• Refactor the ModalWrapper component to improve its usability and maintainability.
• Update the ESLint configuration to enforce stricter TypeScript rules and improve code quality.
• Refactor styles to use SCSS mixins for better maintainability and consistency.

Build:

• Update the build system to use pnpm instead of npm for package management.

CI:

• Update the CI workflow to use pnpm for installing dependencies and running scripts.
• Add a new CI job for running end-to-end tests using Playwright.

Deployment:

• Add a new deployment step to restart the Kubernetes pod after deployment.

Documentation:

• Update the README with a new Developer Guide section, including prerequisites, getting started instructions, and development guidelines.

Tests:

• Add a new Jest configuration for running unit tests with coverage reporting.
• Add Playwright configuration for running end-to-end tests.

[stackblitz]

Run & review this pull request in StackBlitz Codeflow.

[sourcery-ai]

Reviewer's Guide by Sourcery

This pull request implements a major refactoring and modernization of the codebase, migrating to Next.js App Router, improving type safety, and enhancing code organization. The changes include restructuring components, implementing server-side rendering, improving state management, and adding comprehensive testing setup.

Architecture diagram for CI/CD pipeline changes

graph TD;
    A[Pull Request] -->|Trigger| B[Build and Lint PRs]
    B -->|Run| C[Regular Build]
    C -->|On Failure| D[Legacy Peer Deps Build]
    C -->|On Success| E[Deploy to Staging]
    E -->|On Staging Branch| F[E2E Tests]
    F -->|Run| G[Playwright Tests]

Loading

Class diagram for ShareButton component refactoring

classDiagram
    class ShareButtonProps {
        productName?: string
        barcode: string
    }

    class ShareButton {
        - productName: string = "Product"
        - barcode: string
        - showButton: boolean
        - shareOptions: ShareOption[]
        + checkShareAvailability(): void
        + handleShareClick(shareUrl: string): void
    }

    class ShareOption {
        id: string
        text: string
        icon: string
        url: string
        handler?: () => Promise<void>
    }

    ShareButton --> ShareButtonProps
    ShareButton --> ShareOption

Loading

Class diagram for ModalWrapper component refactoring

classDiagram
    class ModalProps {
        id: string
        buttonType: "sup" | "span" | "div"
        buttonClass: string
        buttonText: string
        children: ReactNode
    }

    class ModalWrapper {
        - isOpen: boolean
        - mounted: boolean
        - modalRootRef: HTMLElement | null
        + closeModal(): void
        + handleEscapeKeyPress(event: KeyboardEvent): void
        + handleTouchStart(event: TouchEvent): void
    }

    ModalWrapper --> ModalProps

Loading

File-Level Changes

Change	Details	Files
Migration to Next.js App Router and improved internationalization	Implemented new App Router directory structure with [locale] dynamic routes Added middleware for locale handling Migrated from getStaticProps to server components Enhanced internationalization setup with next-intl	src/app/[locale]/layout.tsx src/middleware.ts src/i18n/routing.ts src/i18n/request.ts
Component architecture refactoring and modernization	Split large components into smaller, focused components Implemented proper TypeScript interfaces and types Added client-side components with 'use client' directive Improved state management with React hooks	src/components/Check/index.tsx src/components/IngredientsCheck/IngredientsForm.tsx src/components/Scanner/ViewportScanner.tsx src/components/elements/share.tsx
Enhanced testing and build configuration	Added Jest configuration for unit testing Configured Playwright for end-to-end testing Updated ESLint configuration for stricter type checking Implemented Million.js for performance optimization	jest.config.ts playwright.config.ts .eslintrc.json next.config.ts
Styling system improvements	Reorganized SCSS modules structure Added new mixins for responsive design Implemented tooltip component with styles Updated theme handling and color schemes	src/styles/_modules/_tooltip.scss src/styles/_globals/_mixins.scss src/styles/_globals/_roots.scss

---

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.
• Generate a pull request title: Write @sourcery-ai anywhere in the pull
  request title to generate a 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. You can also use
  this command to specify where the summary should be inserted.

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

• Contact our support team for questions or feedback.
• Visit our documentation for detailed guides and information.
• Keep in touch with the Sourcery team by following us on X/Twitter, LinkedIn or GitHub.

[sourcery-ai]

Hey @philipbrembeck - I've reviewed your changes and found some issues that need to be addressed.

Blocking issues:

• Potential hard-coded PayPal donation link found. (link)

Here's what I looked at during the review

• 🟡 General issues: 3 issues found
• 🔴 Security: 1 blocking issue
• 🟢 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 ✨

• X
• Mastodon
• LinkedIn
• Facebook

_{Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.}

[sonarqubecloud]

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarCloud