Skip to content

revert me: Ignore github archive incremental sync for old integrations #2723

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

Merged
merged 1 commit into from
Dec 13, 2024

Conversation

sausage-todd
Copy link
Contributor

@sausage-todd sausage-todd commented Dec 13, 2024

Changes proposed ✍️

What

copilot:summary

copilot:poem

Why

How

copilot:walkthrough

Checklist ✅

  • Label appropriately with Feature, Improvement, or Bug.
  • Add screenshots to the PR description for relevant FE changes
  • New backend functionality has been unit-tested.
  • API documentation has been updated (if necessary) (see docs on API documentation).
  • Quality standards are met.

Summary by CodeRabbit

  • Bug Fixes

    • Enhanced error handling in the data retrieval process to prevent returning null results for outdated GitHub integrations.
    • Added checks to ensure integration data is valid before retrieval.
  • Refactor

    • Improved logic within the getIntegrationData method for better data integrity.

Copy link

coderabbitai bot commented Dec 13, 2024

Walkthrough

The changes in this pull request focus on the IntegrationRunRepository class within the integrationRun.repo.ts file. An import statement for IntegrationType is added, and the getIntegrationData method is modified to improve error handling. Specifically, it now checks for null results and verifies that the integration type is IntegrationType.GITHUB with an updatedAt date before December 10, 2024, returning null in these cases. The overall functionality of the repository remains unchanged.

Changes

File Change Summary
services/libs/data-access-layer/src/old/apps/integration_run_worker/integrationRun.repo.ts Added import for IntegrationType, modified getIntegrationData method for enhanced error handling.

Sequence Diagram(s)

sequenceDiagram
    participant Client
    participant IntegrationRunRepository
    participant DataSource

    Client->>IntegrationRunRepository: getIntegrationData(integrationId)
    IntegrationRunRepository->>DataSource: Fetch integration data
    alt results is null
        IntegrationRunRepository-->>Client: return null
    else IntegrationType is GITHUB and updatedAt < 2024-12-10
        IntegrationRunRepository-->>Client: return null
    else
        IntegrationRunRepository-->>Client: return integration data
    end
Loading

🐰 In the code, I hop and play,
With logic brightening the way.
Null checks added, oh what a sight,
For GitHub data, all feels right!
Integration runs, swift and keen,
In the rabbit's world, all's serene! 🌟


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>, 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. (Experiment)
  • @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

@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 and nitpick comments (1)
services/libs/data-access-layer/src/old/apps/integration_run_worker/integrationRun.repo.ts (1)

125-130: Temporary change needs tracking

The PR title suggests this is a temporary change ("revert me"). This should be:

  1. Documented with a TODO comment explaining when/why to revert
  2. Tracked in an issue for follow-up
    if (
      results.type === IntegrationType.GITHUB &&
      moment(results.updatedAt).isBefore(moment('2024-12-10'))
    ) {
+     // TODO: Temporary change to ignore GitHub archive incremental sync for old integrations
+     // Track: <issue_url>
      return null
    }

Would you like me to create a GitHub issue to track the reversion of this temporary change?

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 4421c01 and 272d61c.

📒 Files selected for processing (1)
  • services/libs/data-access-layer/src/old/apps/integration_run_worker/integrationRun.repo.ts (2 hunks)
🔇 Additional comments (2)
services/libs/data-access-layer/src/old/apps/integration_run_worker/integrationRun.repo.ts (2)

5-5: LGTM: Import addition is clean and necessary

The addition of IntegrationType to the existing import statement is well-organized and required for the new type checking logic.


121-123: LGTM: Proper null check added

The null check for results is a good defensive programming practice.

Comment on lines +125 to +130
if (
results.type === IntegrationType.GITHUB &&
moment(results.updatedAt).isBefore(moment('2024-12-10'))
) {
return null
}
Copy link

Choose a reason for hiding this comment

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

💡 Codebase verification

⚠️ Potential issue

Critical: Confirmed issues with GitHub integration date filtering

  1. The SQL query is missing the updatedAt field but it's used in the code, which will cause runtime errors
  2. The hardcoded future date (Dec 10, 2024) appears only once in the codebase with no configuration alternative
  3. The class has logging capabilities (extends RepositoryBase with parentLog) but isn't using it for this important filtering

Locations needing attention:

  • services/libs/data-access-layer/src/old/apps/integration_run_worker/integrationRun.repo.ts:
    • Add updatedAt to the SQL SELECT clause
    • Move the date to environment configuration
    • Add debug logging when skipping integrations

The original review comment's suggestions are accurate and should be implemented to fix these issues.

🔗 Analysis chain

Critical: Several concerns with the GitHub integration date filtering

  1. The SQL query doesn't select the updatedAt field but it's used in the condition
  2. The hardcoded future date (Dec 10, 2024) should be:
    • Moved to a configuration value
    • Documented with the reason for this specific date
    • Ideally not set in the future
  3. Consider adding debug logging when skipping integrations

Suggested improvements:

      select id,
             platform as type,
             status as state,
             "integrationIdentifier" as identifier,
-            "tenantId"
+            "tenantId",
+            "updatedAt"
      from integrations where id = $(integrationId) and "deletedAt" is null

// ... 

    if (
      results.type === IntegrationType.GITHUB &&
-     moment(results.updatedAt).isBefore(moment('2024-12-10'))
+     moment(results.updatedAt).isBefore(moment(process.env.GITHUB_ARCHIVE_CUTOFF_DATE))
    ) {
+     this.log.debug('Skipping GitHub integration due to cutoff date', {
+       integrationId,
+       updatedAt: results.updatedAt
+     });
      return null
    }

Let's verify if there are any other instances of this date being used:

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Search for any other instances of this date in the codebase
rg -i "2024-12-10"

# Search for any environment variable definitions that might be related
rg "GITHUB_ARCHIVE_CUTOFF_DATE"

Length of output: 204


Script:

#!/bin/bash
# Let's verify if the updatedAt field is actually missing from the SQL query
ast-grep --pattern 'select $$$, "updatedAt" $$$ from integrations'

# Also check the full SQL query pattern to be thorough
ast-grep --pattern 'select $$$ from integrations where id = $(integrationId) and "deletedAt" is null'

# Check if there's any logging setup in this file
rg -A 2 "constructor.*log" services/libs/data-access-layer/src/old/apps/integration_run_worker/integrationRun.repo.ts

Length of output: 292


Script:

#!/bin/bash
# Let's try a different approach to find the SQL query
rg -A 10 "select.*from integrations.*where" services/libs/data-access-layer/src/old/apps/integration_run_worker/integrationRun.repo.ts

# Check for logger initialization in the class
rg "class.*IntegrationRunRepo" -A 10 services/libs/data-access-layer/src/old/apps/integration_run_worker/integrationRun.repo.ts

Length of output: 994

@sausage-todd sausage-todd merged commit 3252150 into main Dec 13, 2024
7 checks passed
@sausage-todd sausage-todd deleted the github-archive-fix branch December 13, 2024 15:35
@coderabbitai coderabbitai bot mentioned this pull request Jan 10, 2025
5 tasks
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