SurfSense icon indicating copy to clipboard operation
SurfSense copied to clipboard

Feature/slack connector and indexer improvements

Open fblgit opened this issue 6 months ago • 8 comments

Description

Motivation and Context

FIX #

Changes Overview

Screenshots

API Changes

  • [ ] This PR includes API changes

Types of changes

  • [ ] Bug fix (non-breaking change which fixes an issue)
  • [ ] New feature (non-breaking change which adds functionality)
  • [ ] Performance improvement (non-breaking change which enhances performance)
  • [ ] Documentation update
  • [ ] Breaking change (fix or feature that would cause existing functionality to change)

Testing

  • [ ] I have tested these changes locally
  • [ ] I have added/updated unit tests
  • [ ] I have added/updated integration tests

Checklist:

  • [ ] My code follows the code style of this project
  • [ ] My change requires documentation updates
  • [ ] I have updated the documentation accordingly
  • [ ] My change requires dependency updates
  • [ ] I have updated the dependencies accordingly
  • [ ] My code builds clean without any errors or warnings
  • [ ] All new and existing tests passed

fblgit avatar May 28 '25 09:05 fblgit

[!IMPORTANT]

Review skipped

Draft detected.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.


Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ 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.
    • Explain this complex logic.
    • 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 explain this code block.
    • @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 explain its main purpose.
    • @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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this 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.

coderabbitai[bot] avatar May 28 '25 09:05 coderabbitai[bot]

@google-labs-jules[bot] is attempting to deploy a commit to the Rohan Verma's projects Team on Vercel.

A member of the Team first needs to authorize it.

vercel[bot] avatar May 28 '25 09:05 vercel[bot]

😱 Found 1 issue. Time to roll up your sleeves! 😱

recurseml[bot] avatar May 28 '25 09:05 recurseml[bot]

I've been testing it:

  • Channel Discovery works
  • Channel Selection works
  • The overall state of the config change/save push works

But we are in need of some periodic/scheduling engine inside the backend (async) Some other things that IMHO should be done in this PR is to make the whole slack calls to be async and not locking. I tested this on a 7k channels slack workspace and needs further polishing.. despite working, its not really neat in my opinion.

@MODSetter -- whats your idea for the scheduling piece and the async part? can we have a quick chat over Discord or similar so i can understand better how to address some of the above issues? thx

fblgit avatar May 30 '25 12:05 fblgit

I've been testing it:

  • Channel Discovery works
  • Channel Selection works
  • The overall state of the config change/save push works

But we are in need of some periodic/scheduling engine inside the backend (async) Some other things that IMHO should be done in this PR is to make the whole slack calls to be async and not locking. I tested this on a 7k channels slack workspace and needs further polishing.. despite working, its not really neat in my opinion.

@MODSetter -- whats your idea for the scheduling piece and the async part? can we have a quick chat over Discord or similar so i can understand better how to address some of the above issues? thx

  • slack calls to be async and not locking.

Slack calls are not asynchronous? I guess I didn’t stress-test it enough to know if it was blocking the main thread. It shouldn’t be that difficult... let me see what I can do.

  • But we are in need of some periodic/scheduling engine inside the backend (async).

I also thought about it initially, but at that time, I just wanted to stabilize manual syncing first. I think with the recent addition of content hashing, it’s stable now. Do you have any good message queue libraries in mind for this?

  • whats your idea for the scheduling piece and the async part? can we have a quick chat over Discord

I think letting the user enable periodic syncing manually (by selecting the time interval) for the connectors is the best approach. The user goes to "Manage Connectors," and for each connector, we can have a toggle that lets the user enable periodic syncing.

My Discord: uiqueblhats

MODSetter avatar May 30 '25 19:05 MODSetter

@fblgit LMK if you need help completing this. Would love to get this merged 👍

MODSetter avatar Jun 05 '25 08:06 MODSetter

Its not ready, the backend blocks for too long on large workspace and the periodic scheduling is missing. I would suggest to have the scheduler introduced first, and then refactor this properly. The scan and selection state is working. And the previous ratelimit fix works on main branch.

fblgit avatar Jun 05 '25 11:06 fblgit

My PRs are always open for anyone who wants to help, I keep the branches updated at my end.. and to be honest .. the scope of this one has extended more than what I thought initially

fblgit avatar Jun 05 '25 11:06 fblgit