-
Notifications
You must be signed in to change notification settings - Fork 248
feat: add new falkordb integration #3158
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
Open
ghassenzaara
wants to merge
24
commits into
deepset-ai:main
Choose a base branch
from
ghassenzaara:feature/falkordb-integration
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
24 commits
Select commit
Hold shift + click to select a range
7389656
Establish the package skeleton, dependencies, and a developer-runnabl…
ghassenzaara f4b0c4d
feat: implement FalkorDBDocumentStore for graph-based document storag…
ghassenzaara 47d908f
feat: add FalkorDB retrievers and align document store architecture w…
ghassenzaara ea68351
feat: complete FalkorDB integrations and test suites
ghassenzaara ffcb725
feat: Bug fixes
ghassenzaara 698cad4
feat: Bug fixes #2
ghassenzaara a804f21
feat: Bug Fix 3
ghassenzaara a4a4dc0
fix: use correct falkordb vector index creation syntax
ghassenzaara 74bf446
fix: assert vector native typing on batch write
ghassenzaara f93b0e2
feat: restore CLAUDE.md
ghassenzaara 3b45d65
feat: fix: resolve CI failures on Windows/macOS and lowest-deps runs
ghassenzaara 04ab2ae
fix: correct pydoc output filename and revert invalid runner context …
ghassenzaara d380366
fix: quote to pass shellcheck
ghassenzaara 0e79918
Merge branch 'main' into feature/falkordb-integration
ghassenzaara 701351a
feat: fix double backticks issue, change every occurence of falkor_db…
ghassenzaara ae8d5f4
fix: resolve more issues
ghassenzaara 3bb3705
fix: final changes
ghassenzaara 13c9933
Merge branch 'main' into feature/falkordb-integration
ghassenzaara 28d2184
Merge branch 'feature/falkordb-integration' of https://github.com/gha…
ghassenzaara cfe4563
fix: resolve all ruff lint and mypy errors blocking CI
ghassenzaara 0e4f4a6
fix: correct workflow quoting and pydoc config for CI
ghassenzaara b24cb06
fix: restrict CI to Linux and pin haystack-ai>=2.26.1 to resolve matr…
ghassenzaara 8e2f79e
Merge branch 'main' into feature/falkordb-integration
ghassenzaara 1fa17f9
Merge branch 'main' into feature/falkordb-integration
ghassenzaara File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,155 @@ | ||
| # This workflow comes from https://github.com/ofek/hatch-mypyc | ||
| # https://github.com/ofek/hatch-mypyc/blob/5a198c0ba8660494d02716cfc9d79ce4adfb1442/.github/workflows/test.yml | ||
| name: Test / falkordb | ||
|
|
||
| on: | ||
| schedule: | ||
| - cron: "0 0 * * *" | ||
| pull_request: | ||
| paths: | ||
| - "integrations/falkordb/**" | ||
| - "!integrations/falkordb/*.md" | ||
| - ".github/workflows/falkordb.yml" | ||
| push: | ||
| branches: | ||
| - main | ||
| paths: | ||
| - "integrations/falkordb/**" | ||
| - "!integrations/falkordb/*.md" | ||
| - ".github/workflows/falkordb.yml" | ||
|
|
||
| defaults: | ||
| run: | ||
| working-directory: integrations/falkordb | ||
|
|
||
| concurrency: | ||
| group: falkordb-${{ github.head_ref || github.sha }} | ||
| cancel-in-progress: true | ||
|
|
||
| env: | ||
| PYTHONUNBUFFERED: "1" | ||
| FORCE_COLOR: "1" | ||
| TEST_MATRIX_OS: '["ubuntu-latest"]' | ||
| TEST_MATRIX_PYTHON: '["3.10", "3.14"]' | ||
|
|
||
| jobs: | ||
| compute-test-matrix: | ||
| runs-on: ubuntu-slim | ||
| defaults: | ||
| run: | ||
| working-directory: . | ||
| outputs: | ||
| os: ${{ steps.set.outputs.os }} | ||
| python-version: ${{ steps.set.outputs.python-version }} | ||
| steps: | ||
| - id: set | ||
| run: | | ||
| echo 'os=${{ github.event_name == 'push' && '["ubuntu-latest"]' || env.TEST_MATRIX_OS }}' >> "$GITHUB_OUTPUT" | ||
| echo 'python-version=${{ github.event_name == 'push' && '["3.10"]' || env.TEST_MATRIX_PYTHON }}' >> "$GITHUB_OUTPUT" | ||
|
|
||
| run: | ||
| name: Python ${{ matrix.python-version }} on ${{ startsWith(matrix.os, 'macos-') && 'macOS' || startsWith(matrix.os, 'windows-') && 'Windows' || 'Linux' }} | ||
| needs: compute-test-matrix | ||
| permissions: | ||
| contents: write | ||
| pull-requests: write | ||
| runs-on: ${{ matrix.os }} | ||
| strategy: | ||
| fail-fast: false | ||
| matrix: | ||
| os: ${{ fromJSON(needs.compute-test-matrix.outputs.os) }} | ||
| python-version: ${{ fromJSON(needs.compute-test-matrix.outputs.python-version) }} | ||
| services: | ||
| falkordb: | ||
| image: falkordb/falkordb:latest | ||
| ports: | ||
| - 6379:6379 | ||
| options: >- | ||
| --health-cmd "redis-cli ping" | ||
| --health-interval 10s | ||
| --health-timeout 5s | ||
| --health-retries 5 | ||
|
|
||
| steps: | ||
| - name: Support longpaths | ||
| if: matrix.os == 'windows-latest' | ||
| working-directory: . | ||
| run: git config --system core.longpaths true | ||
|
|
||
| - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2 | ||
|
|
||
| - name: Set up Python ${{ matrix.python-version }} | ||
| uses: actions/setup-python@a309ff8b426b58ec0e2a45f0f869d46889d02405 # v6.2.0 | ||
| with: | ||
| python-version: ${{ matrix.python-version }} | ||
|
|
||
| - name: Install Hatch | ||
| run: pip install --upgrade hatch | ||
| - name: Lint | ||
| if: matrix.python-version == '3.10' && runner.os == 'Linux' | ||
| run: hatch run fmt-check && hatch run test:types | ||
|
|
||
| - name: Run unit tests | ||
| run: hatch run test:unit-cov-retry | ||
|
|
||
| # On PR: posts coverage comment (directly on same-repo PRs; via artifact for fork PRs). On push to main: stores coverage baseline on data branch. | ||
| - name: Store unit tests coverage | ||
| id: coverage_comment | ||
| if: matrix.python-version == '3.10' && runner.os == 'Linux' && github.event_name != 'schedule' | ||
| uses: py-cov-action/python-coverage-comment-action@7188638f871f721a365d644f505d1ff3df20d683 # v3.40 | ||
| with: | ||
| GITHUB_TOKEN: ${{ github.token }} | ||
| COVERAGE_PATH: integrations/falkordb | ||
| SUBPROJECT_ID: falkordb | ||
| MINIMUM_GREEN: 90 | ||
| MINIMUM_ORANGE: 60 | ||
|
|
||
| - name: Upload coverage comment to be posted | ||
| if: matrix.python-version == '3.10' && runner.os == 'Linux' && github.event_name == 'pull_request' && steps.coverage_comment.outputs.COMMENT_FILE_WRITTEN == 'true' | ||
| uses: actions/upload-artifact@bbbca2ddaa5d8feaa63e36b76fdaad77386f024f # v7.0.0 | ||
| with: | ||
| name: coverage-comment-falkordb | ||
| path: python-coverage-comment-action-falkordb.txt | ||
|
|
||
| - name: Run integration tests | ||
| # Integration tests require a live FalkorDB instance via Docker. | ||
| # Docker services are only available on Linux runners. | ||
| if: runner.os == 'Linux' | ||
| env: | ||
| FALKORDB_HOST: localhost | ||
| FALKORDB_PORT: 6379 | ||
| run: hatch run test:integration-cov-append-retry | ||
|
|
||
| - name: Store combined coverage | ||
| if: github.event_name == 'push' | ||
| uses: py-cov-action/python-coverage-comment-action@7188638f871f721a365d644f505d1ff3df20d683 # v3.40 | ||
| with: | ||
| GITHUB_TOKEN: ${{ github.token }} | ||
| COVERAGE_PATH: integrations/falkordb | ||
| SUBPROJECT_ID: falkordb-combined | ||
| MINIMUM_GREEN: 90 | ||
| MINIMUM_ORANGE: 60 | ||
|
|
||
| - name: Run unit tests with lowest direct dependencies | ||
| if: github.event_name != 'push' | ||
| run: | | ||
| hatch run uv pip compile pyproject.toml --resolution lowest-direct --output-file requirements_lowest_direct.txt | ||
| hatch -e test env run -- uv pip install -r requirements_lowest_direct.txt | ||
| hatch run test:unit | ||
|
|
||
| - name: Nightly - run unit tests with Haystack main branch | ||
| if: github.event_name == 'schedule' | ||
| run: | | ||
| hatch env prune | ||
| hatch -e test env run -- uv pip install git+https://github.com/deepset-ai/haystack.git@main | ||
| hatch run test:unit | ||
|
|
||
|
|
||
| notify-slack-on-failure: | ||
| needs: run | ||
| if: failure() && github.event_name == 'schedule' | ||
| runs-on: ubuntu-slim | ||
| steps: | ||
| - uses: deepset-ai/notify-slack-action@3cda73b77a148f16f703274198e7771340cf862b # v1 | ||
| with: | ||
| slack-webhook-url: ${{ secrets.SLACK_WEBHOOK_URL_NOTIFICATIONS }} |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,3 +1,3 @@ | ||
| # CLAUDE.md | ||
| # CLAUDE.md — FalkorDB Haystack Integration: Execution Plan | ||
|
|
||
| Before you start working on this repository, read the AGENTS.md file and follow all the instructions. | ||
| > **⚠️ ALWAYS READ FIRST:** Before working in this repo, read `AGENTS.md` and follow ALL instructions there. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
These changes should be reverted.