Add 2 more fields to Tweet object for richer parsing

[viv-cheung]

Required for elizaOS/eliza#2644

Summary by CodeRabbit

• New Features
  • Enhanced tweet data structure with optional language and quote count properties
  • Improved metadata tracking for tweets without disrupting existing functionality

[coderabbitai]

Walkthrough

The pull request introduces two optional properties to the Tweet interface in the src/tweets.ts file. These new properties, language and quotes, provide additional metadata about tweets. The language property allows specifying the tweet's language as a string, while the quotes property indicates the number of times the tweet has been quoted. These changes are purely additive and do not modify existing functionality.

Changes

File	Change Summary
src/tweets.ts	Added optional language?: string and quotes?: number properties to Tweet interface

Poem

🐰 A tweet's tale, now more complete,
Language and quotes, a data treat!
Optional whispers of context bright,
Enhancing tweets with pure delight
Rabbit's code hops with glee today 🌟

✨ Finishing Touches

• 📝 Generate Docstrings (Beta)

---

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR. (Beta)
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[coderabbitai]

Actionable comments posted: 1

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 3040f28 and 179cccc.

📒 Files selected for processing (1)

• src/tweets.ts (2 hunks)

🔇 Additional comments (1)

src/tweets.ts (1)

173-173: LGTM! The interface changes look good.

The new optional properties language and quotes are well-typed and properly positioned within the interface.

Also applies to: 182-182

[coderabbitai]

🛠️ Refactor suggestion

Implement parsing for the new properties.

The new properties language and quotes are not being populated in the parsing functions. Consider updating the following functions to parse these properties:

• parseTweetV2ToV1: Parse lang from tweetV2 for the language property
• parseTweetV2ToV1: Parse quote_count from tweetV2.public_metrics for the quotes property

Apply this diff to implement the parsing:

   parsedTweet = {
     id: tweetV2.id,
     text: tweetV2.text ?? defaultTweetData?.text ?? '',
+    language: tweetV2.lang ?? defaultTweetData?.language,
     hashtags:
       tweetV2.entities?.hashtags?.map((tag) => tag.tag) ??
       defaultTweetData?.hashtags ??
       [],
     mentions:
       tweetV2.entities?.mentions?.map((mention) => ({
         id: mention.id,
         username: mention.username,
       })) ??
       defaultTweetData?.mentions ??
       [],
     urls:
       tweetV2.entities?.urls?.map((url) => url.url) ??
       defaultTweetData?.urls ??
       [],
     likes: tweetV2.public_metrics?.like_count ?? defaultTweetData?.likes ?? 0,
     retweets:
       tweetV2.public_metrics?.retweet_count ?? defaultTweetData?.retweets ?? 0,
+    quotes:
+      tweetV2.public_metrics?.quote_count ?? defaultTweetData?.quotes ?? 0,
     replies:
       tweetV2.public_metrics?.reply_count ?? defaultTweetData?.replies ?? 0,

Also applies to: 182-182