Skip to content
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

feat: hardcoded analytics limited to 3 month! #274

Merged
merged 2 commits into from
Sep 5, 2024

Conversation

amindadgar
Copy link
Member

@amindadgar amindadgar commented Sep 5, 2024

Summary by CodeRabbit

  • New Features
    • Enhanced analysis logic to restrict the analysis period to a maximum of 90 days, ensuring more relevant and accurate results.
  • Bug Fixes
    • Resolved potential issues with outdated analysis periods by resetting periods exceeding 90 days to the current date at midnight.

Copy link
Contributor

coderabbitai bot commented Sep 5, 2024

Walkthrough

The changes involve a modification to the analyze function in the analyzer.py file, specifically regarding the handling of the period parameter. A conditional check has been added to restrict the period to a maximum of 90 days, resetting it to the current date at midnight if it exceeds this limit. Additionally, an import statement for timedelta has been included to support this new functionality.

Changes

File Path Change Summary
dags/analyzer_helper/common/analyzer.py Modified the analyze function to limit the period parameter to a maximum of 90 days. Added an import for timedelta.

Poem

In the meadow where I hop and play,
A change has come to brighten the day!
Ninety days is the limit now,
For analysis, we take a bow!
With each leap, I feel so spry,
Thank you, dear coder, oh my, oh my! 🐇✨


Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share
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>.
    • 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 generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @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 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.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 1

Outside diff range, codebase verification and nitpick comments (1)
dags/analyzer_helper/common/analyzer.py (1)

Line range hint 10-40: Suggest refactoring to improve maintainability.

The analyze method handles multiple responsibilities, which could be separated into smaller, more focused methods to improve readability and maintainability. Consider refactoring the method by separating the period adjustment, analytics computation, and result publishing into separate methods.

Here's a proposed refactor to enhance the method's structure:

class Analyzer:
    def adjust_period(self, period):
        if (datetime.now() - period).days >= 90:
            return datetime.now().replace(hour=0, minute=0, second=0, microsecond=0)
        return period

    def compute_analytics(self, platform_id, resources, period, action, window, config, recompute):
        analyzer = TCAnalyzer(
            platform_id=platform_id,
            resources=resources,
            period=period,
            action=action,
            window=window,
            analyzer_config=config,
        )
        if recompute:
            logging.info(f"PLATFORMID: {platform_id} recomputing analyzer!")
            asyncio.run(analyzer.recompute())
        else:
            logging.info(f"PLATFORMID: {platform_id} append analytics to previous analytics results!")
            asyncio.run(analyzer.run_once())

    def analyze(
        self,
        platform_id: str,
        resources: list[str],
        period: datetime,
        action: dict[str, int],
        window: dict[str, int],
        recompute: bool,
        config: PlatformConfigBase = DiscordAnalyzerConfig(),
    ) -> None:
        period = self.adjust_period(period)
        self.compute_analytics(platform_id, resources, period, action, window, config, recompute)
        publish_on_success(platform_id, recompute)
Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 6363a8e and 299cc9f.

Files selected for processing (1)
  • dags/analyzer_helper/common/analyzer.py (2 hunks)

Comment on lines 25 to 29
# limiting to 90 days
if (datetime.now() - period).days > 90:
period = (datetime.now() - timedelta(days=0)).replace(
hour=0, minute=0, second=0, microsecond=0
)
Copy link
Contributor

Choose a reason for hiding this comment

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

Review the new conditional logic for period limitation.

The new logic introduced to limit the analysis period to 90 days is crucial for ensuring data relevance. However, there are a few points to consider:

  • The calculation (datetime.now() - period).days > 90 effectively checks if the period is older than 90 days from today, which aligns with the PR objectives.
  • The reset of period to midnight of the current day using datetime.now().replace(hour=0, minute=0, second=0, microsecond=0) is a clean way to handle this limitation.

However, this approach may introduce a subtle bug:

  • If the period is exactly 90 days old, it will not be reset, which might not be the intended behavior. Consider adjusting the condition to >= 90 to include the 90th day as well.

Consider this adjustment for inclusivity of the 90th day:

-if (datetime.now() - period).days > 90:
+if (datetime.now() - period).days >= 90:
Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
# limiting to 90 days
if (datetime.now() - period).days > 90:
period = (datetime.now() - timedelta(days=0)).replace(
hour=0, minute=0, second=0, microsecond=0
)
# limiting to 90 days
if (datetime.now() - period).days >= 90:
period = (datetime.now() - timedelta(days=0)).replace(
hour=0, minute=0, second=0, microsecond=0
)

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 299cc9f and 791abda.

Files selected for processing (1)
  • dags/analyzer_helper/common/analyzer.py (2 hunks)
Files skipped from review as they are similar to previous changes (1)
  • dags/analyzer_helper/common/analyzer.py

@cyri113 cyri113 merged commit 6ba7986 into main Sep 5, 2024
14 checks passed
@amindadgar amindadgar linked an issue Sep 5, 2024 that may be closed by this pull request
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.

feat: reduce analytics to 3 month
2 participants