Production

[philipbrembeck]

Summary by Sourcery

Refactor and improve the ingredients classification process with enhanced error handling, worker-based processing, and dependency updates

New Features:

• Added a worker-based approach for ingredient classification to improve performance
• Implemented fallback mechanism for translation failures
• Added concurrency scripts for development workflows

Enhancements:

• Improved error handling in translation process
• Moved sophisticated ingredient matching to a separate worker thread
• Updated project dependencies to latest versions
• Simplified translation error management

CI:

• Added concurrently script for running multiple development checks
• Improved lint and test script integration

Tests:

• Updated unit tests to reflect new error handling behavior
• Added more robust test scenarios for translation failures

Chores:

• Updated package.json scripts
• Upgraded NestJS and related dependencies
• Cleaned up OpenAPI specification
• Updated Dockerfile to use corepack

[bolt-new-by-stackblitz]

Run & review this pull request in StackBlitz Codeflow.

[sourcery-ai]

Reviewer's Guide by Sourcery

This pull request updates dependencies, implements multi-threading for ingredient processing, improves error handling, and updates the Dockerfile to use bun.

Sequence diagram for ingredient processing with worker thread

sequenceDiagram
  participant Controller
  participant WorkerThread

  Controller->>Controller: Receives ingredients
  Controller->>WorkerThread: Sends ingredients for processing
  activate WorkerThread
  WorkerThread->>WorkerThread: Categorizes ingredients (vegan, not vegan, etc.)
  WorkerThread-->>Controller: Returns categorized ingredients
  deactivate WorkerThread
  Controller->>Controller: Sends response

Loading

File-Level Changes

Change	Details	Files
Updated dependencies in pnpm-lock.yaml to their latest versions.	Updated @nestjs/axios from 3.1.2 to 3.1.3 Updated @nestjs/common from 10.4.7 to 10.4.15 Updated @nestjs/config from 3.3.0 to 3.3.0 Updated @nestjs/core from 10.4.7 to 10.4.15 Updated @nestjs/platform-express from 10.4.7 to 10.4.15 Updated @nestjs/swagger from 8.0.5 to 8.1.1 Updated @nestjs/terminus from 10.2.3 to 11.0.0 Updated axios from 1.7.7 to 1.8.3 Updated dotenv from 16.4.5 to 16.4.7 Updated express from 4.21.1 to 4.21.2 Updated express-rate-limit from 7.4.1 to 7.5.0 Updated nestjs-pino from 4.1.0 to 4.4.0 Updated @nestjs/cli from 10.4.7 to 11.0.5 Updated @nestjs/schematics from 10.2.3 to 11.0.2 Updated @nestjs/testing from 10.4.7 to 10.4.15 Updated @types/express from 5.0.0 to 5.0.1 Updated @typescript-eslint/eslint-plugin from 8.14.0 to 8.27.0 Updated @typescript-eslint/parser from 8.14.0 to 8.28.0 Updated eslint from 9.14.0 to 9.22.0	pnpm-lock.yaml
Implemented multi-threading to improve ingredient processing performance.	Added a new worker file ingredient.worker.ts to handle ingredient categorization in a separate thread. Utilized the worker_threads module to spawn a worker for processing ingredients. Modified the getIngredients method in IngredientsV1Controller to use the worker for categorizing ingredients. Removed the sophisticatedMatch method from IngredientsV1Controller as it is now part of the worker thread. Added logic to handle worker errors and exit codes. Updated the controller to handle translation failures more gracefully, proceeding with untranslated ingredients and logging a warning.	src/ingredients/v1/ingredients.controller.ts src/ingredients/v1/ingredient.worker.ts
Improved error handling and logging for translation and back-translation failures.	Replaced the Service Unavailable error response with a warning log and continued processing with untranslated ingredients. Added a warning log for back-translation failures and continued processing with untranslated results. Removed the 503 status code from the OpenAPI documentation.	src/ingredients/v1/ingredients.controller.ts OpenAPI.yaml
Updated the Dockerfile to use bun and enable corepack.	Added RUN npm i -g corepack@latest to install corepack. Added RUN corepack enable to enable corepack. Changed start:prod script to use bun dist/main.js.	Dockerfile

---

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

• 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 they look great!

Here's what I looked at during the review

• 🟡 General issues: 2 issues found
• 🟢 Security: all looks good
• 🟡 Testing: 1 issue found
• 🟡 Complexity: 1 issue found
• 🟢 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: Consider refactoring translation slicing logic.

Extracting the slicing logic into a helper or clearly documenting the boundaries might reduce the risk of off-by-one errors and improve maintainability.

Suggested implementation:

private slicePart(text: string, start: number, length?: number): string {
  return length !== undefined ? text.slice(start, start + length) : text.slice(start);
}

// (existing class code)

          const translatedNotVegan = this.slicePart(backTranslated, 0, notVeganResult.length);
          const translatedMaybeNotVegan = this.slicePart(backTranslated, notVeganResult.length, maybeNotVeganResult.length);
          const translatedVegan = this.slicePart(backTranslated, notVeganResult.length + maybeNotVeganResult.length, veganResult.length);
          const translatedUnknown = this.slicePart(backTranslated, notVeganResult.length + maybeNotVeganResult.length + veganResult.length);

[sourcery-ai]

suggestion: Avoid duplicate tags in the OpenAPI definitions.

Duplicate tag entries (e.g. for Grades, Product, and Ingredients) may lead to redundant sections in generated documentation. Consider deduplicating the tag entries to simplify maintenance.

Suggested implementation:

      tags:
        - Grades

      tags:
        - Product

[sourcery-ai]

suggestion (testing): Add tests for the worker thread logic

Since the ingredient categorization logic has been moved to a worker thread, it's crucial to have tests that specifically target this new implementation. Consider adding tests that cover various scenarios, including edge cases and error handling within the worker itself.

Suggested implementation:

describe("Worker thread logic", () => {
  it("should process ingredients via the worker thread and return success", async () => {
    const res = mockResponse();
    // Simulate a successful worker processing result.
    // If additional mocking is needed for the worker thread communication, add those here.
    await controller.getIngredients("tofu,milk,sugar", res, true);

    expect(res.status).toHaveBeenCalledWith(HttpStatus.OK);
    expect(res.send).toHaveBeenCalledWith(
      expect.objectContaining({
        code: "OK",
        status: "200",
        message: "Success",
        data: expect.any(Object)
      })
    );
  });

  it("should handle errors in worker thread and return service unavailable", async () => {
    const res = mockResponse();
    // Simulate an error scenario in the worker thread logic.
    // You may want to configure mock responses for worker thread errors here.
    await controller.getIngredients("faulty,ingredients", res, true);

    expect(res.status).toHaveBeenCalledWith(HttpStatus.SERVICE_UNAVAILABLE);
    expect(res.send).toHaveBeenCalledWith(
      expect.objectContaining({
        code: expect.any(String),
        message: expect.stringContaining("error")
      })
    );
  });
});

If your worker thread logic requires additional mocking (for example, using a specific worker pool or inter-thread communication library), make sure to import and configure these mocks appropriately at the top of the test file.

[sourcery-ai]

issue (complexity): Consider replacing the worker thread with an in-process categorization utility to reduce complexity, as the matching logic is not computationally intensive enough to warrant a separate thread and doing so simplifies the code flow while maintaining functionality .

Consider if the added asynchronicity truly brings a measurable benefit. Since the matching logic isn’t very heavy, you can reduce complexity by replacing the worker thread with a simple, in‑process categorization utility. For example:

```ts
private categorizeIngredients(ingredients: string[]): {
  notVeganResult: string[];
  maybeNotVeganResult: string[];
  veganResult: string[];
  unknownResult: string[];
} {
  return {
    notVeganResult: ingredients.filter((item) => this.sophisticatedMatch(item, this.isNotVegan)),
    maybeNotVeganResult: ingredients.filter(
      (item) =>
        !this.sophisticatedMatch(item, this.isNotVegan) &&
        this.sophisticatedMatch(item, this.isMaybeNotVegan)
    ),
    veganResult: ingredients.filter((item) => this.sophisticatedMatch(item, this.isVegan)),
    unknownResult: ingredients.filter(
      (item) =>
        !this.sophisticatedMatch(item, this.isNotVegan) &&
        !this.sophisticatedMatch(item, this.isMaybeNotVegan) &&
        !this.sophisticatedMatch(item, this.isVegan)
    ),
  };
}

Then in your controller, replace the worker invocation:

// Replace this:
// const { notVeganResult, maybeNotVeganResult, veganResult, unknownResult } = await this.runWorker(response);

// With:
const { notVeganResult, maybeNotVeganResult, veganResult, unknownResult } = this.categorizeIngredients(response);

This maintains all functionality while simplifying the flow and reducing complexity.

[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).