Release

[philipbrembeck]

Summary by Sourcery

Update dependencies and introduce new features including a new API endpoint for product details and an enhanced ingredients processing controller. Refactor existing code to improve modularity and maintainability, and update documentation and tests accordingly.

New Features:

• Introduce a new API endpoint for product details retrieval using barcode in the OpenAPI specification.
• Add a new IngredientsV1Controller to handle ingredient processing with enhanced translation and categorization capabilities.

Enhancements:

• Update dependencies to newer versions, including @nestjs packages and eslint-related packages, to improve performance and security.
• Refactor the IngredientsController to use shared services and utilities for better code organization and reusability.

Build:

• Add a new ESLint configuration file in module format to support TypeScript and import order rules.

Documentation:

• Update OpenAPI documentation to include the new product details endpoint and revised ingredients endpoint.

Tests:

• Add a new test file for the IngredientsV1Controller to ensure the new features are properly tested.

[stackblitz]

Run & review this pull request in StackBlitz Codeflow.

[sourcery-ai]

Reviewer's Guide by Sourcery

This pull request primarily focuses on dependency updates, code reorganization, and feature enhancements for the ingredients API. The changes include updating NestJS and other package versions, restructuring the ingredients module with a new v1 endpoint, and improving the ingredient classification logic.

ER diagram for ingredient classification

erDiagram
    INGREDIENT {
        string name
    }
    INGREDIENT ||--o{ IS_VEGAN : classified_as
    INGREDIENT ||--o{ IS_NOT_VEGAN : classified_as
    INGREDIENT ||--o{ IS_MAYBE_NOT_VEGAN : classified_as
    IS_VEGAN {
        string name
    }
    IS_NOT_VEGAN {
        string name
    }
    IS_MAYBE_NOT_VEGAN {
        string name
    }

Loading

Class diagram for Ingredients Module

classDiagram
    class IngredientsController {
        +onModuleInit()
        +getIngredients(ingredientsParam: string, res: Response, translateFlag: boolean)
        -parseIngredients(ingredientsString: string): string[]
        -sendResponse(res: Response, notVeganItems: string[], maybeNotVeganItems: string[], veganItems: string[], unknownItems: string[])
    }
    class IngredientsV1Controller {
        +onModuleInit()
        +getIngredients(ingredientsParam: string, res: Response, translateFlag: boolean)
        -parseIngredients(ingredientsString: string): string[]
        -sendResponse(res: Response, notVeganItems: string[], maybeNotVeganItems: string[], veganItems: string[], unknownItems: string[])
    }
    class TranslationService
    class ParseBooleanPipe
    class V0ResponseData {
        +vegan: boolean
        +surely_vegan: string[]
        +not_vegan: string[]
        +maybe_vegan: string[]
    }
    class V1ResponseData {
        +vegan: boolean
        +surely_vegan: string[]
        +not_vegan: string[]
        +maybe_not_vegan: string[]
        +unknown: string[]
    }
    IngredientsController --> TranslationService
    IngredientsV1Controller --> TranslationService
    IngredientsController --> ParseBooleanPipe
    IngredientsV1Controller --> ParseBooleanPipe
    IngredientsController --> V0ResponseData
    IngredientsV1Controller --> V1ResponseData

Loading

File-Level Changes

Change	Details	Files
Updated project dependencies and configurations	Updated NestJS packages from 10.4.6 to 10.4.7 Updated @nestjs/swagger from 7.4.2 to 8.0.3 Removed unused dependencies like @types/axios, @types/dotenv, and @types/iconv-lite Updated ESLint and related packages to newer versions Migrated from .eslintrc.js to eslint.config.mjs with new configuration	pnpm-lock.yaml package.json eslint.config.mjs
Restructured ingredients module with new v1 API endpoint	Created new IngredientsModule for better organization Added new v1 ingredients endpoint with enhanced response format Separated v0 and v1 controllers into different directories Added new DTO files for response types Implemented improved ingredient matching logic in v1 controller	src/ingredients/ingredients.module.ts src/ingredients/v1/ingredients.controller.ts src/ingredients/v0/ingredients.controller.ts src/ingredients/v1/dto/response.dto.ts src/ingredients/v0/dto/response.dto.ts
Updated ingredient classification data	Added new ismaybenotvegan.json file for ambiguous ingredients Updated isvegan.json and isnotvegan.json with new ingredients Reorganized E-numbers across classification files	ismaybenotvegan.json isvegan.json isnotvegan.json
Code organization and cleanup	Improved import organization with consistent ordering Added new npm scripts for ingredient processing Updated OpenAPI specification with new endpoints Fixed linting issues and added lint:fix script	src/app.module.ts package.json OpenAPI.yaml src/main.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.
• 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 - here's some feedback:

Overall Comments:

• Please add documentation describing the breaking changes between v0 and v1 API versions, particularly the response schema differences with the new maybe_not_vegan field

Here's what I looked at during the review

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

• 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.}

[sourcery-ai]

suggestion (performance): Performance optimization needed for RegExp creation

Creating new RegExp objects in a frequently called method can impact performance. Consider refactoring to minimize RegExp object creation or explore alternative matching strategies.

Suggested change

	private sophisticatedMatch(ingredient: string, list: string[]): boolean {
	private readonly whitespaceRegex = /\s+/g;
	private sophisticatedMatch(ingredient: string, list: string[]): boolean {

[sourcery-ai]

suggestion (code-quality): Use block braces for ifs, whiles, etc. (use-braces)

Suggested change

	if (list.includes(normalizedIngredient)) return true;
	if (list.includes(normalizedIngredient)) {

Explanation

It is recommended to always use braces and create explicit statement blocks.

Using the allowed syntax to just write a single statement can lead to very confusing
situations, especially where subsequently a developer might add another statement
while forgetting to add the braces (meaning that this wouldn't be included in the condition).

[sourcery-ai]

suggestion (code-quality): Use block braces for ifs, whiles, etc. (use-braces)

Suggested change

	if (list.some((item) => wordBoundaryRegex.test(item.replace(/\s+/g, ""))))
	return true;
	if (list.some((item) => wordBoundaryRegex.test(item.replace(/\s+/g, "")))) {
	return true;
	}

Explanation

It is recommended to always use braces and create explicit statement blocks.

Using the allowed syntax to just write a single statement can lead to very confusing
situations, especially where subsequently a developer might add another statement
while forgetting to add the braces (meaning that this wouldn't be included in the condition).