chromadb-client 0.4.24.dev0__tar.gz → 0.5.3.dev0__tar.gz

chromadb_client-0.5.3.dev0/.gitattributes

@@ -0,0 +1,4 @@
+*_pb2.py* linguist-generated
+*_pb2_grpc.py* linguist-generated
+go/database/**/db/** linguist-generated=true
+go/pkg/proto/** linguist-generated=true

chromadb_client-0.5.3.dev0/.github/DEVELOP.md

@@ -0,0 +1,6 @@
+GitHub *still* does not support organizing workflows into directories, so instead we use some notation:
+
+- A workflow starting with `_` is a reusable workflow and should exclusively have a `workflow_call` trigger.
+- Any other workflow is expected to have standard triggers (e.g. `push`, `pull_request`, etc.) and should not be called by other workflows.
+
+All workflows should be prefixed by their language name, e.g. `python-test.yml`.

chromadb_client-0.5.3.dev0/.github/actions/docker/action.yaml

@@ -0,0 +1,37 @@
+name: Setup Docker
+description: "This action sets up Docker Buildx and authenticates to registries"
+inputs:
+  ghcr-username:
+    description: "Github Container Registry username"
+    required: true
+  ghcr-password:
+    description: "Github Container Registry password"
+    required: true
+  dockerhub-username:
+    description: "DockerHub username"
+    required: true
+  dockerhub-password:
+    description: "DockerHub password"
+    required: true
+
+runs:
+  using: "composite"
+  steps:
+    # https://github.com/docker/setup-qemu-action - for multiplatform builds
+    - name: Set up QEMU
+      uses: docker/setup-qemu-action@v2
+    # https://github.com/docker/setup-buildx-action - for multiplatform builds
+    - name: Set up Docker Buildx
+      id: buildx
+      uses: docker/setup-buildx-action@v2
+    - name: Log in to the Github Container registry
+      uses: docker/login-action@v2.1.0
+      with:
+        registry: ghcr.io
+        username: ${{ inputs.ghcr-username }}
+        password: ${{ inputs.ghcr-password }}
+    - name: Login to DockerHub
+      uses: docker/login-action@v2.1.0
+      with:
+        username: ${{ inputs.dockerhub-username }}
+        password: ${{ inputs.dockerhub-password }}

chromadb_client-0.5.3.dev0/.github/actions/go/action.yaml

@@ -0,0 +1,9 @@
+name: Setup Go
+description: "This action sets up Go"
+runs:
+  using: "composite"
+  steps:
+    - uses: actions/setup-go@v5
+      with:
+        cache-dependency-path: go/go.sum
+    - uses: ariga/setup-atlas@v0

chromadb_client-0.5.3.dev0/.github/actions/python/action.yaml

@@ -0,0 +1,23 @@
+name: Setup Python
+description: "This action sets up Python and installs dependencies"
+inputs:
+  python-version:
+    description: "Python version to use"
+    required: false
+    default: "3.8"
+runs:
+  using: "composite"
+  steps:
+    - name: Set up Python ${{ inputs.python-version }}
+      uses: actions/setup-python@v4
+      with:
+        python-version: ${{ inputs.python-version }}
+        cache: "pip"
+        cache-dependency-path: "requirements*.txt"
+    - name: Install test dependencies
+      run: python -m pip install -r requirements.txt && python -m pip install -r requirements_dev.txt
+      shell: bash
+    - name: Upgrade SQLite
+      run: python bin/windows_upgrade_sqlite.py
+      shell: bash
+      if: runner.os == 'Windows'

chromadb_client-0.5.3.dev0/.github/actions/rust/action.yaml

@@ -0,0 +1,12 @@
+name: Setup Rust
+description: "This action sets up Rust"
+runs:
+  using: "composite"
+  steps:
+    - name: Checkout chroma-hnswlib
+      uses: actions/checkout@v3
+      with:
+        repository: chroma-core/hnswlib
+        path: hnswlib
+    - name: Install Protoc
+      uses: arduino/setup-protoc@v2

chromadb_client-0.5.3.dev0/.github/actions/tilt/action.yaml

@@ -0,0 +1,23 @@
+name: Start Tilt services
+description: "This action starts Tilt services"
+runs:
+  using: "composite"
+  steps:
+    - name: Install Tilt
+      shell: bash
+      run: |
+        TILT_VERSION="0.33.3"
+        curl -fsSL https://github.com/tilt-dev/tilt/releases/download/v$TILT_VERSION/tilt.$TILT_VERSION.linux.x86_64.tar.gz | \
+          tar -xzv -C /usr/local/bin tilt
+    - name: Install ctlptlc
+      shell: bash
+      run: |
+        CTLPTL_VERSION="0.8.20"
+        curl -fsSL https://github.com/tilt-dev/ctlptl/releases/download/v$CTLPTL_VERSION/ctlptl.$CTLPTL_VERSION.linux.x86_64.tar.gz | \
+          tar -xzv -C /usr/local/bin ctlptl
+    - name: Set up kind
+      shell: bash
+      run: ctlptl create cluster kind --registry=ctlptl-registry
+    - name: Start Tilt
+      shell: bash
+      run: tilt ci

chromadb_client-0.5.3.dev0/.github/workflows/_go-tests.yml

@@ -0,0 +1,46 @@
+name: Go tests
+
+on:
+  workflow_call:
+
+jobs:
+  test:
+    strategy:
+      matrix:
+        platform: [ubuntu-latest]
+    runs-on: ${{ matrix.platform }}
+    services:
+      postgres:
+        image: postgres
+        env:
+          POSTGRES_USER: chroma
+          POSTGRES_PASSWORD: chroma
+          POSTGRES_DB: chroma
+        options: >-
+          --health-cmd pg_isready
+          --health-interval 10s
+          --health-timeout 5s
+          --health-retries 5
+        ports:
+          - 5432:5432
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+      - name: Setup
+        uses: ./.github/actions/go
+      - name: Build and test
+        run: make test
+        env:
+          POSTGRES_HOST: localhost
+          POSTGRES_PORT: 5432
+        working-directory: go
+
+  cluster-test:
+    runs-on: "16core-64gb-ubuntu-latest"
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+      - name: Setup
+        uses: ./.github/actions/go
+      - uses: ./.github/actions/tilt
+      - run: bin/cluster-test.sh bash -c 'cd go && go test -timeout 30s -run ^TestNodeWatcher$ github.com/chroma-core/chroma/go/pkg/memberlist_manager'

chromadb_client-0.5.3.dev0/.github/workflows/_javascript-client-tests.yml

@@ -0,0 +1,13 @@
+name: JavaScript client tests
+
+on:
+  workflow_call:
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+      - name: Test
+        run: bin/ts-integration-test

chromadb_client-0.5.3.dev0/.github/workflows/_python-tests.yml

@@ -0,0 +1,166 @@
+name: Chroma Python Base Tests
+
+on:
+  workflow_call:
+    inputs:
+      python_versions:
+        description: 'Python versions to test (as json array)'
+        required: false
+        default: '["3.8"]'
+        type: string
+      property_testing_preset:
+        description: 'Property testing preset'
+        required: true
+        type: string
+
+jobs:
+  test:
+    timeout-minutes: 90
+    strategy:
+      fail-fast: false
+      matrix:
+        python: ${{fromJson(inputs.python_versions)}}
+        platform: [ubuntu-latest, windows-latest]
+        test-globs: ["--ignore-glob 'chromadb/test/property/*' --ignore-glob 'chromadb/test/stress/*' --ignore-glob 'chromadb/test/distributed/*' --ignore='chromadb/test/auth/test_simple_rbac_authz.py'",
+                   "chromadb/test/auth/test_simple_rbac_authz.py",
+                   "chromadb/test/property/test_add.py",
+                   "chromadb/test/property/test_collections.py",
+                   "chromadb/test/property/test_collections_with_database_tenant.py",
+                   "chromadb/test/property/test_collections_with_database_tenant_overwrite.py",
+                   "chromadb/test/property/test_cross_version_persist.py",
+                   "chromadb/test/property/test_embeddings.py",
+                   "chromadb/test/property/test_filtering.py",
+                   "chromadb/test/property/test_persist.py"]
+        include:
+          - test-globs: "chromadb/test/property/test_embeddings.py"
+            parallelized: true
+
+    runs-on: ${{ matrix.platform }}
+    steps:
+      - uses: actions/checkout@v3
+      - name: Setup
+        uses: ./.github/actions/python
+        with:
+          python-version: ${{ matrix.python }}
+      - name: Test
+        run: python -m pytest ${{ matrix.parallelized && '-n auto' || '' }} ${{ matrix.test-globs }}
+        shell: bash
+        env:
+          PROPERTY_TESTING_PRESET: ${{ inputs.property_testing_preset }}
+
+  # todo: break out stress integration tests
+  test-single-node-integration:
+    strategy:
+      fail-fast: false
+      matrix:
+        python: ${{fromJson(inputs.python_versions)}}
+        platform: [ubuntu-latest, windows-latest]
+        test-globs: ["--ignore-glob 'chromadb/test/property/*' --ignore='chromadb/test/test_cli.py' --ignore-glob 'chromadb/test/distributed/*' --ignore='chromadb/test/auth/test_simple_rbac_authz.py'",
+                   "chromadb/test/property/test_add.py",
+                   "chromadb/test/test_cli.py",
+                   "chromadb/test/auth/test_simple_rbac_authz.py",
+                   "chromadb/test/property/test_collections.py",
+                  "chromadb/test/property/test_collections_with_database_tenant.py",
+                   "chromadb/test/property/test_cross_version_persist.py",
+                   "chromadb/test/property/test_embeddings.py",
+                   "chromadb/test/property/test_filtering.py",
+                   "chromadb/test/property/test_persist.py"]
+        include:
+          - platform: ubuntu-latest
+            env-file: compose-env.linux
+          - platform: windows-latest
+            env-file: compose-env.windows
+    runs-on: ${{ matrix.platform }}
+    steps:
+    - name: Checkout
+      uses: actions/checkout@v3
+    - name: Set up Python (${{ matrix.python }})
+      uses: ./.github/actions/python
+    - name: Integration Test
+      run: bin/python-integration-test ${{ matrix.test-globs }}
+      shell: bash
+      env:
+        ENV_FILE: ${{ matrix.env-file }}
+        PROPERTY_TESTING_PRESET: ${{ inputs.property_testing_preset }}
+
+  test-cluster-integration:
+    strategy:
+      fail-fast: false
+      matrix:
+        python: ${{fromJson(inputs.python_versions)}}
+        platform: ["16core-64gb-ubuntu-latest"]
+        test-globs: ["chromadb/test/db/test_system.py",
+                   "chromadb/test/property/test_collections.py",
+                   "chromadb/test/property/test_add.py",
+                   "chromadb/test/property/test_filtering.py",
+                   "chromadb/test/property/test_collections_with_database_tenant.py",
+                   "chromadb/test/property/test_collections_with_database_tenant_overwrite.py",
+                   "chromadb/test/ingest/test_producer_consumer.py",
+                   "chromadb/test/segment/distributed/test_memberlist_provider.py",
+                   "chromadb/test/test_logservice.py",
+                   "chromadb/test/distributed/test_sanity.py"]
+    runs-on: ${{ matrix.platform }}
+    steps:
+      - uses: actions/checkout@v3
+      - uses: ./.github/actions/python
+        with:
+          python-version: ${{ matrix.python }}
+      - uses: ./.github/actions/tilt
+      - name: Test
+        run: bin/cluster-test.sh bash -c 'python -m pytest "${{ matrix.test-globs }}"'
+        shell: bash
+        env:
+          PROPERTY_TESTING_PRESET: ${{ inputs.property_testing_preset }}
+
+  test-thin-client:
+    strategy:
+      matrix:
+        python: ${{fromJson(inputs.python_versions)}}
+        platform: [ubuntu-latest] # # todo: should run on Windows, currently failing because Dockerfile doesn't build
+    runs-on: ${{ matrix.platform }}
+    steps:
+      - uses: actions/checkout@v3
+      - name: Setup
+        uses: ./.github/actions/python
+        with:
+          python-version: ${{ matrix.python }}
+      - name: Test
+        run: clients/python/integration-test.sh
+        shell: bash
+        env:
+          PROPERTY_TESTING_PRESET: ${{ inputs.property_testing_preset }}
+
+  test-stress:
+    timeout-minutes: 90
+    strategy:
+      matrix:
+        python: ${{fromJson(inputs.python_versions)}}
+        platform: ['16core-64gb-ubuntu-latest', '16core-64gb-windows-latest']
+    runs-on: ${{ matrix.platform }}
+    steps:
+      - uses: actions/checkout@v3
+      - uses: ./.github/actions/python
+        with:
+          python-version: ${{ matrix.python }}
+      - name: Test
+        run: python -m pytest chromadb/test/stress/
+        shell: bash
+        env:
+          PROPERTY_TESTING_PRESET: ${{ inputs.property_testing_preset }}
+
+  test-single-node-integration-stress:
+    strategy:
+      matrix:
+        python: ${{fromJson(inputs.python_versions)}}
+        platform: [ubuntu-latest] # todo: should run on Windows, currently failing because Dockerfile doesn't build
+    runs-on: ${{ matrix.platform }}
+    steps:
+    - name: Checkout
+      uses: actions/checkout@v3
+    - name: Set up Python (${{ matrix.python }})
+      uses: ./.github/actions/python
+    - name: Integration Test
+      run: bin/python-integration-test chromadb/test/stress/
+      shell: bash
+      env:
+        PROPERTY_TESTING_PRESET: ${{ inputs.property_testing_preset }}

chromadb_client-0.5.3.dev0/.github/workflows/_python-vulnerability-scan.yml

@@ -0,0 +1,24 @@
+name: Scan for Python Vulnerabilities
+
+on:
+  workflow_call:
+
+jobs:
+  bandit-scan:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - name: Setup
+        uses: ./.github/actions/python
+      - uses: ./.github/actions/bandit-scan/
+        with:
+          input-dir: '.'
+          format: 'json'
+          bandit-config: 'bandit.yaml'
+          output-file: 'bandit-report.json'
+      - name: Upload Bandit Report
+        uses: actions/upload-artifact@v3
+        with:
+          name: bandit-artifact
+          path: |
+            bandit-report.json

chromadb_client-0.5.3.dev0/.github/workflows/_rust-tests.yml

@@ -0,0 +1,25 @@
+name: Rust tests
+
+on:
+  workflow_call:
+
+jobs:
+  test:
+    strategy:
+      matrix:
+        platform: [ubuntu-latest]
+    runs-on: ${{ matrix.platform }}
+    defaults:
+      run:
+        working-directory: chroma
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+        with:
+          path: chroma
+      - name: Setup
+        uses: ./chroma/.github/actions/rust
+      - name: Build
+        run: cargo build --verbose
+      - name: Test
+        run: cargo test --verbose

chromadb_client-0.5.3.dev0/.github/workflows/pr-review-checklist.yml

@@ -0,0 +1,37 @@
+name: 📋 PR Review Checklist
+
+on:
+  pull_request_target:
+    types:
+      - opened
+
+jobs:
+  PR-Comment:
+    runs-on: ubuntu-latest
+    steps:
+    - name: PR Comment
+      uses: actions/github-script@v2
+      with:
+        github-token: ${{secrets.GITHUB_TOKEN}}
+        script: |
+          github.issues.createComment({
+            issue_number: ${{ github.event.number }},
+            owner: context.repo.owner,
+            repo: context.repo.repo,
+            body: `# Reviewer Checklist
+            Please leverage this checklist to ensure your code review is thorough before approving
+            ## Testing, Bugs, Errors, Logs, Documentation
+            - [ ] Can you think of any use case in which the code does not behave as intended? Have they been tested?
+            - [ ] Can you think of any inputs or external events that could break the code? Is user input validated and safe? Have they been tested?
+            - [ ] If appropriate, are there adequate property based tests?
+            - [ ] If appropriate, are there adequate unit tests?
+            - [ ] Should any logging, debugging, tracing information be added or removed?
+            - [ ] Are error messages user-friendly?
+            - [ ] Have all documentation changes needed been made?
+            - [ ] Have all non-obvious changes been commented?
+            ## System Compatibility
+            - [ ] Are there any potential impacts on other parts of the system or backward compatibility?
+            - [ ] Does this change intersect with any items on our roadmap, and if so, is there a plan for fitting them together?
+            ## Quality
+            - [ ] Is this code of a unexpectedly high quality (Readability, Modularity, Intuitiveness)`
+          })

chromadb_client-0.5.3.dev0/.github/workflows/pr.yml

@@ -0,0 +1,132 @@
+name: PR checks
+on:
+  pull_request:
+    branches:
+      - main
+      - '**'
+
+jobs:
+  # GitHub only provides a way to do path filtering at the workflow level rather than the job level.
+  # This allows us to selectively run jobs based on changed paths.
+  paths-filter:
+    name: Get changed paths
+    runs-on: ubuntu-latest
+    outputs:
+      outside-docs: ${{ steps.changes.outputs.outside-docs }}
+    steps:
+      - name: Get changed paths
+        id: changes
+        uses: dorny/paths-filter@v3
+        with:
+          predicate-quantifier: 'every'
+          filters: |
+            outside-docs:
+              - '!docs/**'
+              - '!.github/**'
+
+  python-tests:
+    name: Python tests
+    needs: paths-filter
+    if: needs.paths-filter.outputs.outside-docs == 'true'
+    uses: ./.github/workflows/_python-tests.yml
+    with:
+      property_testing_preset: 'fast'
+
+  python-vulnerability-scan:
+    name: Python vulnerability scan
+    needs: paths-filter
+    if: needs.paths-filter.outputs.outside-docs == 'true'
+    uses: ./.github/workflows/_python-vulnerability-scan.yml
+
+  javascript-client-tests:
+    name: JavaScript client tests
+    needs: paths-filter
+    if: needs.paths-filter.outputs.outside-docs == 'true'
+    uses: ./.github/workflows/_javascript-client-tests.yml
+
+  rust-tests:
+    name: Rust tests
+    needs: paths-filter
+    if: needs.paths-filter.outputs.outside-docs == 'true'
+    uses: ./.github/workflows/_rust-tests.yml
+
+  go-tests:
+    name: Go tests
+    needs: paths-filter
+    if: needs.paths-filter.outputs.outside-docs == 'true'
+    uses: ./.github/workflows/_go-tests.yml
+
+  check-title:
+    name: Check PR Title
+    runs-on: ubuntu-latest
+    steps:
+        - name: Check PR Title
+          uses: Slashgear/action-check-pr-title@v4.3.0
+          with:
+            regexp: '\[(ENH|BUG|DOC|TST|BLD|PERF|TYP|CLN|CHORE|RELEASE)\].*'
+            helpMessage: "Please tag your PR title. See https://docs.trychroma.com/contributing#contributing-code-and-ideas. You must push new code to this PR for this check to run again."
+        - name: Comment explaining failure
+          if: failure()
+          uses: actions/github-script@v6
+          with:
+            script: |
+              github.rest.issues.createComment({
+                issue_number: context.issue.number,
+                owner: context.repo.owner,
+                repo: context.repo.repo,
+                body: 'Please tag your PR title with one of: \\[ENH | BUG | DOC | TST | BLD | PERF | TYP | CLN | CHORE\\]. See https://docs.trychroma.com/contributing#contributing-code-and-ideas'
+              })
+
+  lint:
+    name: Lint
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+      - name: Set up Python
+        uses: actions/setup-python@v4
+      - name: Install pre-commit
+        shell: bash
+        run: python -m pip install -r requirements_dev.txt
+      - name: Run pre-commit
+        shell: bash
+        run: |
+          pre-commit run --all-files trailing-whitespace
+          pre-commit run --all-files mixed-line-ending
+          pre-commit run --all-files end-of-file-fixer
+          pre-commit run --all-files requirements-txt-fixer
+          pre-commit run --all-files check-xml
+          pre-commit run --all-files check-merge-conflict
+          pre-commit run --all-files check-case-conflict
+          pre-commit run --all-files check-docstring-first
+          pre-commit run --all-files black
+          pre-commit run --all-files flake8
+          pre-commit run --all-files prettier
+          pre-commit run --all-files check-yaml
+      - name: Cargo fmt check
+        shell: bash
+        run: cargo fmt -- --check
+
+  # This job exists for our branch protection rule.
+  # We want to require status checks to pass before merging, but the set of
+  # checks that run for any given PR is dynamic based on the files changed.
+  # When creating a branch protection rule, you have to specify a static list
+  # of checks.
+  # So since this job always runs, we can specify it in the branch protection rule.
+  all-required-pr-checks-passed:
+    if: always()
+    needs:
+    - python-tests
+    - python-vulnerability-scan
+    - javascript-client-tests
+    - rust-tests
+    - go-tests
+    - check-title
+    - lint
+    runs-on: ubuntu-latest
+    steps:
+    - name: Decide whether the needed jobs succeeded or failed
+      uses: re-actors/alls-green@release/v1
+      with:
+        jobs: ${{ toJSON(needs) }}
+        allowed-skips: python-tests,python-vulnerability-scan,javascript-client-tests,rust-tests,go-tests