deploy refactor (#509)

Co-authored-by: Kim Pevey <[email protected]>
Quansight · Dec 12, 2024 · acb5fed · acb5fed
1 parent a6050ca
commit acb5fed
Show file tree

Hide file tree

Showing 82 changed files with 2,976 additions and 3,042 deletions.
diff --git a/.github/actions/setup-env/action.yml b/.github/actions/setup-env/action.yml
@@ -13,24 +13,22 @@ runs:
   using: composite
 
   steps:
-    - name: Setup mambaforge and development environment
+    - name: Setup miniforge and empty development environment
       uses: conda-incubator/setup-miniconda@v3
       with:
-        miniforge-variant: Mambaforge
         miniforge-version: latest
         activate-environment: ragna-dev
 
     - name: Display conda info
-      shell: bash -el {0}
+      shell: bash -elo pipefail {0}
       run: conda info
 
     - name: Set cache date
       id: cache-key
       shell: bash
       run: |
         DATE=$(date +'%Y%m%d')
-        echo $DATE
-        echo "DATE=$DATE" >> $GITHUB_OUTPUT
+        echo "date=${DATE}" | tee -a "${GITHUB_OUTPUT}"
 
     - name: Restore conda environment
       id: cache
@@ -41,33 +39,31 @@ runs:
           env-${{ runner.os }}-${{ runner.arch }}-${{ inputs.python-version
           }}|${{steps.cache-key.outputs.date }}-${{ hashFiles('environment-dev.yml',
           'pyproject.toml') }}
-        restore-keys: |
-          env-${{ runner.os }}-${{ runner.arch }}-${{ inputs.python-version }}
 
     - name: Update conda environment if necessary
       if: steps.cache.outputs.cache-hit != 'true'
       shell: bash
       run: |
         sed -i'' -e 's/python *= *[0-9.]\+/python =${{ inputs.python-version }}/g' environment-dev.yml
         cat environment-dev.yml
-        mamba env update --file environment-dev.yml
+        mamba env update --quiet --file environment-dev.yml
         git checkout -- environment-dev.yml
 
-    - name: Install playwright
-      shell: bash -el {0}
-      run: playwright install
+    #    - name: Install playwright
+    #      shell: bash -el {0}
+    #      run: playwright install
 
     - name: Install ragna
-      shell: bash -el {0}
+      shell: bash -elo pipefail {0}
       run: |
         if [[ ${{ inputs.optional-dependencies }} == true ]]
         then
           PROJECT_PATH='.[all]'
         else
           PROJECT_PATH='.'
         fi
-        pip install --editable "${PROJECT_PATH}"
+        pip install --verbose --progress-bar=off --editable "${PROJECT_PATH}"
 
     - name: Display development environment
-      shell: bash -el {0}
+      shell: bash -elo pipefail {0}
       run: conda list
diff --git a/.github/workflows/docker.yml b/.github/workflows/docker.yml
@@ -28,7 +28,7 @@ jobs:
     runs-on: ubuntu-latest
     defaults:
       run:
-        shell: bash -el {0}
+        shell: bash -elo pipefail {0}
 
     steps:
       - name: Checkout repository

diff --git a/.github/workflows/lint.yml b/.github/workflows/lint.yml
@@ -11,7 +11,7 @@ jobs:
     runs-on: ubuntu-latest
     defaults:
       run:
-        shell: bash -el {0}
+        shell: bash -elo pipefail {0}
 
     steps:
       - name: Checkout repository
@@ -33,7 +33,7 @@ jobs:
     runs-on: ubuntu-latest
     defaults:
       run:
-        shell: bash -el {0}
+        shell: bash -elo pipefail {0}
 
     steps:
       - name: Checkout repository
@@ -63,7 +63,7 @@ jobs:
     runs-on: ubuntu-latest
     defaults:
       run:
-        shell: bash -el {0}
+        shell: bash -elo pipefail {0}
 
     steps:
       - name: Checkout repository

diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml
@@ -17,7 +17,7 @@ jobs:
     runs-on: ubuntu-latest
     defaults:
       run:
-        shell: bash -el {0}
+        shell: bash -elo pipefail {0}
 
     steps:
       - name: Checkout repository
@@ -53,7 +53,7 @@ jobs:
 
     defaults:
       run:
-        shell: bash -el {0}
+        shell: bash -elo pipefail {0}
 
     steps:
       - name: Checkout repository
@@ -70,74 +70,73 @@ jobs:
         id: tests
         run: |
           pytest \
-          --ignore tests/deploy/ui \
-          --junit-xml=test-results.xml \
-          --durations=25
+            --ignore tests/deploy/ui \
+            --junit-xml=test-results.xml \
+            --durations=25
 
       - name: Surface failing tests
         if: steps.tests.outcome != 'success'
         uses: pmeier/[email protected]
         with:
           path: test-results.xml
-
-  pytest-ui:
-    strategy:
-      matrix:
-        os:
-          - ubuntu-latest
-          - windows-latest
-          - macos-latest
-        browser:
-          - chromium
-          - firefox
-        python-version:
-          - "3.10"
-          - "3.10"
-          - "3.12"
-        exclude:
-          - python-version: "3.11"
-            os: windows-latest
-          - python-version: "3.12"
-            os: windows-latest
-          - python-version: "3.11"
-            os: macos-latest
-          - python-version: "3.12"
-            os: macos-latest
-        include:
-          - browser: webkit
-            os: macos-latest
-            python-version: "3.10"
-
-      fail-fast: false
-
-    runs-on: ${{ matrix.os }}
-
-    defaults:
-      run:
-        shell: bash -el {0}
-
-    steps:
-      - name: Checkout repository
-        uses: actions/checkout@v4
-        with:
-          fetch-depth: 0
-
-      - name: Setup environment
-        uses: ./.github/actions/setup-env
-        with:
-          python-version: ${{ matrix.python-version }}
-
-      - name: Run unit tests
-        id: tests
-        run: |
-          pytest tests/deploy/ui \
-          --browser ${{ matrix.browser }} \
-          --video=retain-on-failure
-
-      - name: Upload playwright video
-        if: failure()
-        uses: actions/upload-artifact@v4
-        with:
-          name:
-            playwright-${{ matrix.os }}-${{ matrix.python-version}}-${{ github.run_id }}
-          path: test-results
+#  pytest-ui:
+#    strategy:
+#      matrix:
+#        os:
+#          - ubuntu-latest
+#          - windows-latest
+#          - macos-latest
+#        browser:
+#          - chromium
+#          - firefox
+#        python-version:
+#          - "3.10"
+#          - "3.10"
+#          - "3.12"
+#        exclude:
+#          - python-version: "3.11"
+#            os: windows-latest
+#          - python-version: "3.12"
+#            os: windows-latest
+#          - python-version: "3.11"
+#            os: macos-latest
+#          - python-version: "3.12"
+#            os: macos-latest
+#        include:
+#          - browser: webkit
+#            os: macos-latest
+#            python-version: "3.10"
+#
+#      fail-fast: false
+#
+#    runs-on: ${{ matrix.os }}
+#
+#    defaults:
+#      run:
+#        shell: bash -elo pipefail {0}
+#
+#    steps:
+#      - name: Checkout repository
+#        uses: actions/checkout@v4
+#        with:
+#          fetch-depth: 0
+#
+#      - name: Setup environment
+#        uses: ./.github/actions/setup-env
+#        with:
+#          python-version: ${{ matrix.python-version }}
+#
+#      - name: Run unit tests
+#        id: tests
+#        run: |
+#          pytest tests/deploy/ui \
+#          --browser ${{ matrix.browser }} \
+#          --video=retain-on-failure
+#
+#      - name: Upload playwright video
+#        if: failure()
+#        uses: actions/upload-artifact@v4
+#        with:
+#          name:
+#            playwright-${{ matrix.os }}-${{ matrix.python-version}}-${{ github.run_id }}
+#          path: test-results
diff --git a/.github/workflows/update-docker-requirements.yml b/.github/workflows/update-docker-requirements.yml
@@ -19,7 +19,7 @@ jobs:
     runs-on: ubuntu-latest
     defaults:
       run:
-        shell: bash -el {0}
+        shell: bash -elo pipefail {0}
 
     steps:
       - name: Checkout repository

diff --git a/docs/assets/images/web-ui-login.png b/docs/assets/images/web-ui-login.png
diff --git a/docs/examples/gallery_streaming.py b/docs/examples/gallery_streaming.py
@@ -107,29 +107,30 @@ def answer(self, messages):
 
 config = Config(assistants=[DemoStreamingAssistant])
 
-rest_api = ragna_docs.RestApi()
+ragna_deploy = ragna_docs.RagnaDeploy(config)
 
-client, document = rest_api.start(config, authenticate=True, upload_document=True)
+client, document = ragna_deploy.get_http_client(
+    authenticate=True, upload_sample_document=True
+)
 
 # %%
 # Start and prepare the chat
 
 chat = (
     client.post(
-        "/chats",
+        "/api/chats",
         json={
             "name": "Tutorial REST API",
-            "documents": [document],
+            "document_ids": [document["id"]],
             "source_storage": source_storages.RagnaDemoSourceStorage.display_name(),
             "assistant": DemoStreamingAssistant.display_name(),
-            "params": {},
         },
     )
     .raise_for_status()
     .json()
 )
 
-client.post(f"/chats/{chat['id']}/prepare").raise_for_status()
+client.post(f"/api/chats/{chat['id']}/prepare").raise_for_status()
 
 # %%
 # Streaming the response is performed with [JSONL](https://jsonlines.org/). Each line
@@ -140,7 +141,7 @@ def answer(self, messages):
 
 with client.stream(
     "POST",
-    f"/chats/{chat['id']}/answer",
+    f"/api/chats/{chat['id']}/answer",
     json={"prompt": "What is Ragna?", "stream": True},
 ) as response:
     chunks = [json.loads(data) for data in response.iter_lines()]
@@ -163,7 +164,8 @@ def answer(self, messages):
 print("".join(chunk["content"] for chunk in chunks))
 
 # %%
-# Before we close the example, let's stop the REST API and have a look at what would
-# have printed in the terminal if we had started it with the `ragna api` command.
+# Before we close the example, let's terminate the REST API and have a look at what
+# would have printed in the terminal if we had started it with the `ragna deploy`
+# command.
 
-rest_api.stop()
+ragna_deploy.terminate()