Skip to content

Update Jimp and sharp dependencies for Baileys new version #1727

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 7 commits into
base: develop
Choose a base branch
from

Conversation

minarkap
Copy link

@minarkap minarkap commented Jul 16, 2025

I have solved an incompatibility between sharp, jimp & Baileys, and had to change some methods in chatwoot ts

Summary by Sourcery

Upgrade image processing libraries and adjust code and TypeScript config to resolve incompatibilities between Jimp, Sharp, and Baileys

Enhancements:

  • Upgrade Jimp to 1.6.0 and Sharp to 0.34.2 to address compatibility with Baileys
  • Refactor image processing to use Jimp's new cover signature and getBuffer method

Build:

  • Enable allowSyntheticDefaultImports in tsconfig for improved module interoperability

Copy link
Contributor

sourcery-ai bot commented Jul 16, 2025

Reviewer's Guide

This PR resolves incompatibilities between Baileys and image libraries by upgrading Jimp and Sharp, updating Jimp method signatures in the Chatwoot service, and enabling synthetic default imports in TypeScript configuration.

Class diagram for Buffer and Readable usage in image processing

classDiagram
    class Buffer {
        +from(data, encoding)
    }
    class Readable {
        +_read()
    }
    ChatwootService --> Buffer : uses
    ChatwootService --> Readable : uses
Loading

File-Level Changes

Change Details Files
Bumped Jimp and Sharp versions to resolve compatibility issues
  • Updated 'jimp' dependency from ^0.16.13 to ^1.6.0
  • Updated 'sharp' dependency from ^0.32.6 to ^0.34.2
package.json
Refactored Jimp API calls after upgrading
  • Replaced img.cover(320, 180) with img.cover({ w: 320, h: 180 })
  • Switched from img.getBufferAsync(Jimp.MIME_PNG) to img.getBuffer(JimpMime.png)
src/api/integrations/chatbot/chatwoot/services/chatwoot.service.ts
Enabled synthetic default imports in TypeScript
  • Added "allowSyntheticDefaultImports": true to compilerOptions
tsconfig.json

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!

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

Copy link
Contributor

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey @minarkap - I've reviewed your changes and they look great!

Prompt for AI Agents
Please address the comments from this code review:
## Individual Comments

### Comment 1
<location> `src/api/integrations/chatbot/chatwoot/services/chatwoot.service.ts:2106` </location>
<code_context>
+          img.cover({ w: 320, h: 180 });

-          const processedBuffer = await img.getBufferAsync(Jimp.MIME_PNG);
+          const processedBuffer = await img.getBuffer(JimpMime.png);

           const fileStream = new Readable();
</code_context>

<issue_to_address>
Switching from getBufferAsync to getBuffer may introduce callback-based async handling.

`getBuffer` uses a callback and cannot be awaited directly. Please ensure it is promisified or use an async alternative to prevent issues.
</issue_to_address>

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.


const processedBuffer = await img.getBufferAsync(Jimp.MIME_PNG);
const processedBuffer = await img.getBuffer(JimpMime.png);
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

issue (bug_risk): Switching from getBufferAsync to getBuffer may introduce callback-based async handling.

getBuffer uses a callback and cannot be awaited directly. Please ensure it is promisified or use an async alternative to prevent issues.

@DavidsonGomes DavidsonGomes changed the base branch from main to develop July 16, 2025 10:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant