Skip to content

Fix/animated stickers #1322

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 5 commits into from
Mar 30, 2025
Merged

Fix/animated stickers #1322

merged 5 commits into from
Mar 30, 2025

Conversation

marceloapd
Copy link
Contributor

@marceloapd marceloapd commented Mar 20, 2025 •
edited by sourcery-ai bot
Loading

WebP Animation Preservation Enhancement

Problem Statement

When sending .gif or animated .webp files as stickers, the animation is lost in the conversion process.

Solution

Modified the convertToWebP method to detect animated content and preserve animations during conversion using Sharp's animation support.

Technical Details

  • Added detection for animated GIFs and WebPs
  • Implemented Sharp's animated: true option for animation preservation
  • Added a helper method to inspect WebP headers for animation chunks

Benefits

  • Users can now send animated stickers properly
  • Maintains full backward compatibility with existing code
  • No changes to method signatures or calling code required

This enhancement addresses a specific functional gap without disrupting existing workflows.

Summary by Sourcery

Bug Fixes:

  • Fixes a bug where animations were lost when sending .gif or animated .webp files as stickers.

@sourcery-ai Sourcery AI
Copy link
Contributor

sourcery-ai bot commented Mar 20, 2025 •
edited
Loading

Reviewer's Guide by Sourcery

This pull request modifies the convertToWebP method to detect animated content and preserve animations during conversion using Sharp's animation support. This allows users to send animated stickers without losing the animation.

Sequence diagram for animated WebP conversion

sequenceDiagram
  participant A as BaileysStartupService
  participant S as sharp
  A->>A: isAnimated(image, imageBuffer)
  alt isAnimated == true
    A->>S: sharp(imageBuffer, { animated: true })
    S->>S: webp({ quality: 80, animated: true })
    S-->>A: webpBuffer
  else isAnimated == false
    A->>S: sharp(imageBuffer)
    S->>S: webp()
    S-->>A: webpBuffer
  end
  A-->>A: return webpBuffer
Loading

File-Level Changes

Change Details Files
Added logic to preserve animations when converting images to WebP format.
  • Added a check for animated GIFs and WebPs.
  • Implemented Sharp's animated: true option for animation preservation.
  • Added a helper method to inspect WebP headers for animation chunks.
 src/api/integrations/channel/whatsapp/whatsapp.baileys.service.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. 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

sourcery-ai[bot]
sourcery-ai bot reviewed Mar 20, 2025
View reviewed changes
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 @marceloapd - I've reviewed your changes - here's some feedback:

Overall Comments:

  • Consider extracting the logic for converting to a static WebP into a separate function for better readability.
  • The isAnimated function could be simplified by extracting the file extension check into a separate helper.
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 ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

@DavidsonGomes DavidsonGomes changed the base branch from main to develop March 26, 2025 12:58
@DavidsonGomes
Copy link
Collaborator

Ajuste o lint por favor, estava para a branch main, o correto é para a develop, rode o compando npm run lint

@marceloapd
Copy link
Contributor Author

Ajuste o lint por favor, estava para a branch main, o correto é para a develop, rode o compando npm run lint

Feito

@DavidsonGomes DavidsonGomes merged commit 07ce09d into EvolutionAPI:develop Mar 30, 2025
1 check passed
@moothz moothz mentioned this pull request Jun 3, 2025
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@sourcery-ai sourcery-ai[bot] sourcery-ai[bot] left review comments

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@marceloapd @DavidsonGomes