Api v2 get paginated tasks

.github/workflows/ci.yml

@@ -33,22 +33,174 @@ jobs:
           args: check --output-format=github
           src: ./source
 
-  tests:
-    name: API tests
+  build-docker-db:
+    name: Build docker db
     runs-on: ubuntu-22.04
     steps:
       - name: Check out iris
         uses: actions/checkout@v4
-      - name: Build dockers
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v3
+      - name: Build and export
+        uses: docker/build-push-action@v6
+        with:
+          context: docker/db
+          tags: iriswebapp_db:develop
+          outputs: type=docker,dest=${{ runner.temp }}/iriswebapp_db.tar
+          cache-from: type=gha
+          cache-to: type=gha,mode=max
+      - name: Upload artifact
+        uses: actions/upload-artifact@v4
+        with:
+          name: iriswebapp_db
+          path: ${{ runner.temp }}/iriswebapp_db.tar
+
+  build-docker-nginx:
+    name: Build docker nginx
+    runs-on: ubuntu-22.04
+    steps:
+      - name: Check out iris
+        uses: actions/checkout@v4
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v3
+      - name: Build and export
+        uses: docker/build-push-action@v6
+        with:
+          context: docker/nginx
+          tags: iriswebapp_nginx:develop
+          build-args: |
+            NGINX_CONF_GID=1234
+            NGINX_CONF_FILE=nginx.conf
+          outputs: type=docker,dest=${{ runner.temp }}/iriswebapp_nginx.tar
+          cache-from: type=gha
+          cache-to: type=gha,mode=max
+      - name: Upload artifact
+        uses: actions/upload-artifact@v4
+        with:
+          name: iriswebapp_nginx
+          path: ${{ runner.temp }}/iriswebapp_nginx.tar
+
+  build-docker-app:
+    name: Build docker app
+    runs-on: ubuntu-22.04
+    steps:
+      - name: Check out iris
+        uses: actions/checkout@v4
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v3
+      - name: Build and export
+        uses: docker/build-push-action@v6
+        with:
+          context: .
+          file: docker/webApp/Dockerfile
+          tags: iriswebapp_app:develop
+          outputs: type=docker,dest=${{ runner.temp }}/iriswebapp_app.tar
+          cache-from: type=gha
+          cache-to: type=gha,mode=max
+      - name: Upload artifact
+        uses: actions/upload-artifact@v4
+        with:
+          name: iriswebapp_app
+          path: ${{ runner.temp }}/iriswebapp_app.tar
+
+  build-graphql-documentation:
+    name: Generate graphQL documentation
+    runs-on: ubuntu-22.04
+    needs:
+      - build-docker-db
+      - build-docker-nginx
+      - build-docker-app
+    steps:
+      - name: Download artifacts
+        uses: actions/download-artifact@v4
+        with:
+          pattern: iriswebapp_*
+          path: ${{ runner.temp }}
+          merge-multiple: true
+      - name: Load docker images
+        run: |
+          docker load --input ${{ runner.temp }}/iriswebapp_db.tar
+          docker load --input ${{ runner.temp }}/iriswebapp_nginx.tar
+          docker load --input ${{ runner.temp }}/iriswebapp_app.tar
+      - name: Check out iris
+        uses: actions/checkout@v4
+      - name: Start development server
         run: |
-          # TODO using the environment file from tests to build here. 
-          #      I am a bit uneasy with this choice.
-          #      For now this works, but if we come to have different .env files for different tests, it won't anymore.
-          #      Maybe the .env should be split to differentiate the variables used during the build from the variables used at runtime, 
-          #      or maybe the docker building phase should also be part of the tests 
-          #      and we should build different dockers according to the scenarios? This sounds like an issue to me...
+          # Even though, we use --env-file option when running docker compose, this is still necessary, because the compose has a env_file attribute :(
+          # TODO should move basic.env file, which is in directory tests, up. It's used in several places. Maybe, rename it into dev.env
           cp tests/data/basic.env .env
-          docker compose --file docker-compose.dev.yml build
+          docker compose --file docker-compose.dev.yml --env-file tests/data/basic.env up --detach
+      - name: Generate GraphQL documentation
+        run: |
+          npx spectaql@^3.0.2 source/spectaql/config.yml
+      - name: Stop development server
+        run: |
+          docker compose down
+      - uses: actions/upload-artifact@v4
+        with:
+            name: GraphQL DFIR-IRIS documentation
+            path: public
+            if-no-files-found: error
+
+  test-api:
+    name: Test API
+    runs-on: ubuntu-22.04
+    needs:
+      - build-docker-db
+      - build-docker-nginx
+      - build-docker-app
+    steps:
+      - name: Download artifacts
+        uses: actions/download-artifact@v4
+        with:
+          pattern: iriswebapp_*
+          path: ${{ runner.temp }}
+          merge-multiple: true
+      - name: Load docker images
+        run: |
+          docker load --input ${{ runner.temp }}/iriswebapp_db.tar
+          docker load --input ${{ runner.temp }}/iriswebapp_nginx.tar
+          docker load --input ${{ runner.temp }}/iriswebapp_app.tar
+      - name: Check out iris
+        uses: actions/checkout@v4
+      - name: Start development server
+        run: |
+          # Even though, we use --env-file option when running docker compose, this is still necessary, because the compose has a env_file attribute :(
+          # TODO should move basic.env file, which is in directory tests, up. It's used in several places. Maybe, rename it into dev.env
+          cp tests/data/basic.env .env
+          docker compose --file docker-compose.dev.yml up --detach
+      - name: Run tests
+        working-directory: tests
+        run: |
+          python -m venv venv
+          source venv/bin/activate
+          pip install -r requirements.txt
+          PYTHONUNBUFFERED=true python -m unittest --verbose
+      - name: Stop development server
+        run: |
+          docker compose down
+
+  test-e2e:
+    name: End to end tests
+    runs-on: ubuntu-22.04
+    needs:
+      - build-docker-db
+      - build-docker-nginx
+      - build-docker-app
+    steps:
+      - name: Download artifacts
+        uses: actions/download-artifact@v4
+        with:
+          pattern: iriswebapp_*
+          path: ${{ runner.temp }}
+          merge-multiple: true
+      - name: Load docker images
+        run: |
+          docker load --input ${{ runner.temp }}/iriswebapp_db.tar
+          docker load --input ${{ runner.temp }}/iriswebapp_nginx.tar
+          docker load --input ${{ runner.temp }}/iriswebapp_app.tar
+      - name: Check out iris
+        uses: actions/checkout@v4
       - uses: actions/setup-node@v4
         with:
           node-version: 20
@@ -61,30 +213,20 @@ jobs:
         run: |
           npm ci
           npm run build
-      - name: Run tests
-        working-directory: tests
-        run: |
-          python -m venv venv
-          source venv/bin/activate
-          pip install -r requirements.txt
-          docker compose --file ../docker-compose.dev.yml --env-file data/basic.env up --detach --wait
-          PYTHONUNBUFFERED=true python -m unittest --verbose
-          docker compose down
-      - name: Start development server
-        run: |
-          docker compose --file docker-compose.dev.yml up --detach
       - name: Install e2e dependencies
         working-directory: e2e
         run: npm ci
       - name: Install playwright dependencies
         working-directory: e2e
         run: npx playwright install chromium firefox
+      - name: Start development server
+        run: |
+          # TODO should move basic.env file, which is in directory tests, up. It's used in several places. Maybe, rename it into dev.env
+          cp tests/data/basic.env .env
+          docker compose --file docker-compose.dev.yml up --detach
       - name: Run end to end tests
         working-directory: e2e
         run: npx playwright test
-      - name: Generate GraphQL documentation
-        run: |
-          npx spectaql@^3.0.2 source/spectaql/config.yml
       - name: Stop development server
         run: |
           docker compose down
@@ -93,8 +235,4 @@ jobs:
         with:
           name: playwright-report
           path: e2e/playwright-report/
-      - uses: actions/upload-artifact@v4
-        with:
-            name: GraphQL DFIR-IRIS documentation
-            path: public
-            if-no-files-found: error
+

source/app/blueprints/rest/case/case_tasks_routes.py

@@ -54,6 +54,7 @@
 
 
 @case_tasks_rest_blueprint.route('/case/tasks/list', methods=['GET'])
+@endpoint_deprecated('GET', '/api/v2/cases/<int:case_identifier>/tasks')
 @ac_requires_case_identifier(CaseAccessLevel.read_only, CaseAccessLevel.full_access)
 @ac_api_requires()
 def case_get_tasks(caseid):

source/app/blueprints/rest/endpoints.py

@@ -17,6 +17,7 @@
 #  Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
 
 from functools import wraps
+from flask_sqlalchemy.pagination import Pagination
 
 from app import app
 from app.blueprints.responses import response_error, response
@@ -28,6 +29,28 @@ def response_api_success(data):
     return response(200, data=data)
 
 
+def _get_next_page(paginated_elements: Pagination):
+    if paginated_elements.has_next:
+        next_page = paginated_elements.has_next
+    else:
+        next_page = None
+    return next_page
+
+
+def response_api_paginated(schema, paginated_elements: Pagination):
+    data = schema.dump(paginated_elements.items, many=True)
+    next_page = _get_next_page(paginated_elements)
+
+    result = {
+        'total': paginated_elements.total,
+        'data': data,
+        'last_page': paginated_elements.pages,
+        'current_page': paginated_elements.page,
+        'next_page': next_page
+    }
+
+    return response_api_success(result)
+
 def response_api_deleted():
     return response(204)
 

source/app/blueprints/rest/manage/manage_cases_routes.py

@@ -55,6 +55,7 @@
 from app.blueprints.access_controls import ac_api_return_access_denied
 from app.blueprints.responses import response_error
 from app.blueprints.responses import response_success
+from app.blueprints.rest.parsing import parse_pagination_parameters
 from app.business.cases import cases_delete
 from app.business.cases import cases_update
 from app.business.cases import cases_create
@@ -81,11 +82,9 @@ def get_case_api(cur_id):
 @ac_api_requires()
 def manage_case_filter() -> Response:
 
-    page = request.args.get('page', 1, type=int)
-    per_page = request.args.get('per_page', 10, type=int)
+    pagination_parameters = parse_pagination_parameters(request)
+
     case_ids_str = request.args.get('case_ids', None, type=str)
-    order_by = request.args.get('order_by', type=str)
-    sort_dir = request.args.get('sort_dir', 'asc', type=str)
 
     if case_ids_str:
         try:
@@ -112,6 +111,8 @@ def manage_case_filter() -> Response:
         draw = 1
 
     filtered_cases = get_filtered_cases(
+        current_user.id,
+        pagination_parameters,
         case_ids=case_ids_str,
         case_customer_id=case_customer_id,
         case_name=case_name,
@@ -124,12 +125,7 @@ def manage_case_filter() -> Response:
         case_soc_id=case_soc_id,
         start_open_date=start_open_date,
         end_open_date=end_open_date,
-        search_value=search_value,
-        page=page,
-        per_page=per_page,
-        current_user_id=current_user.id,
-        sort_by=order_by,
-        sort_dir=sort_dir
+        search_value=search_value
     )
     if filtered_cases is None:
         return response_error('Filtering error')

source/app/blueprints/rest/parsing.py

@@ -16,6 +16,8 @@
 #  along with this program; if not, write to the Free Software Foundation,
 #  Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
 
+from app.models.pagination_parameters import PaginationParameters
+
 
 def parse_comma_separated_identifiers(identifiers: str):
     return [int(identifier) for identifier in identifiers.split(',')]
@@ -27,3 +29,13 @@ def parse_boolean(parameter: str):
     if parameter == 'false':
         return False
     raise ValueError(f'Expected true or false, got {parameter}')
+
+
+def parse_pagination_parameters(request) -> PaginationParameters:
+    arguments = request.args
+    page = arguments.get('page', 1, type=int)
+    per_page = arguments.get('per_page', 10, type=int)
+    order_by = arguments.get('order_by', type=str)
+    sort_dir = arguments.get('sort_dir', 'asc', type=str)
+
+    return PaginationParameters(page, per_page, order_by, sort_dir)