Merge pull request #7 from apilytics/apilytics-version

Send Apilytics version info together with metrics, improve pipelines

Author: ruohola

.github/check_commits.sh

@@ -1,6 +1,6 @@
 #!/bin/sh
 
-head="$(git remote show origin | awk '/HEAD branch/ {print $NF}')"
+head="$GITHUB_BASE_REF"
 current="$(git rev-parse HEAD)"
 
 if ! git merge-base --is-ancestor "origin/${head}" "$current"; then

.github/workflows/cd.yml

@@ -3,34 +3,26 @@ name: "CD"
 on:
   workflow_dispatch:
     inputs:
-      version:
-        description: "Version of the release, e.g. 1.0.0"
+      release-type:
+        description: "Type of release?"
         required: true
+        type: choice
+        options:
+          - patch
+          - minor
+          - major
 
 jobs:
   release:
     name: "Release"
+    if: ${{ github.ref == 'refs/heads/master' }}
     runs-on: ubuntu-latest
     steps:
       - name: "Checkout code"
         uses: actions/checkout@v2
         with:
           token: ${{ secrets.GH_PAT }}
 
-      - name: "Update the changelog"
-        # Find the first line that starts with `###` or `## [<number>` from the CHANGELOG and insert the new version header before it.
-        run: >
-          current_date="$(date '+%Y-%m-%d')"
-          && sed -i "0,/^\(###\|## *\[[0-9]\).*/{s//## [${{ github.event.inputs.version }}] - ${current_date}\n\n&/}" CHANGELOG.md
-
-      - name: "Bump pyproject.toml to new version"
-        run: sed -i 's/^version *=.*/version = "${{ github.event.inputs.version }}"/' pyproject.toml
-
-      - name: "Extract version's changelog for release notes and tag message"
-        # 1. Find the lines between the first `## [<number>` and the second `## [<number>`.
-        # 2. Remove all leading and trailing newlines from the output.
-        run: sed '1,/^## *\[[0-9]/d;/^## *\[[0-9]/Q' CHANGELOG.md | sed -e :a -e '/./,$!d;/^\n*$/{$d;N;};/\n$/ba' > release_notes.txt
-
       - name: "Set up Python"
         id: setup-python
         uses: actions/setup-python@v2
@@ -43,6 +35,15 @@ jobs:
           virtualenvs-create: true
           virtualenvs-in-project: true
 
+      - name: "Bump pyproject.toml to new version"
+        id: bump
+        run: |
+          poetry version ${{ github.event.inputs.release-type }}
+          echo "::set-output name=version::$(poetry version --short)"
+
+      - name: "Bump apilytics.__version__ to new version"
+        run: sed -i 's/^__version__ *=.*/__version__ = "${{ steps.bump.outputs.version }}"/' apilytics/__init__.py
+
       - name: "Build the wheel"
         run: poetry build
 
@@ -51,17 +52,29 @@ jobs:
         env:
           POETRY_PYPI_TOKEN_PYPI: ${{ secrets.PYPI_TOKEN }}
 
+      - name: "Update the changelog"
+        # Find the first line that starts with `###` or `## [<number>` from the CHANGELOG and insert the new version header before it.
+        run: |
+          current_date="$(date -u '+%Y-%m-%d')"
+          sed -i "0,/^\(###\|## *\[[0-9]\).*/{s//## [${{ steps.bump.outputs.version }}] - ${current_date}\n\n&/}" CHANGELOG.md
+
+      - name: "Extract version's changelog for release notes"
+        # 1. Find the lines between the first `## [<number>` and the second `## [<number>`.
+        # 2. Remove all leading and trailing newlines from the output.
+        run: sed '1,/^## *\[[0-9]/d;/^## *\[[0-9]/Q' CHANGELOG.md | sed -e :a -e '/./,$!d;/^\n*$/{$d;N;};/\n$/ba' > release_notes.txt
+
       - name: "Commit and tag the changes"
         uses: EndBug/add-and-commit@8c12ff729a98cfbcd3fe38b49f55eceb98a5ec02  # v7.5.0
         with:
-          add: '["pyproject.toml", "CHANGELOG.md"]'
-          message: 'Release ${{ github.event.inputs.version }}'
-          tag: 'v${{ github.event.inputs.version }} --annotate --file <(true)'
+          add: '["pyproject.toml", "apilytics/__init__.py", "CHANGELOG.md"]'
+          message: 'Release ${{ steps.bump.outputs.version }}'
+          tag: 'v${{ steps.bump.outputs.version }} --annotate --file /dev/null'
           default_author: github_actions
+          pathspec_error_handling: exitImmediately
 
       - name: "Create a GitHub release"
         uses: softprops/action-gh-release@1e07f4398721186383de40550babbdf2b84acfc5  # v1
         with:
-          tag_name: v${{ github.event.inputs.version }}
-          name: v${{ github.event.inputs.version }}
+          tag_name: v${{ steps.bump.outputs.version }}
+          name: v${{ steps.bump.outputs.version }}
           body_path: release_notes.txt

.github/workflows/ci.yml

@@ -26,8 +26,6 @@ jobs:
 
   linters:
     name: "Linters"
-    needs: commits
-    if: ${{ !failure() }}
     runs-on: ubuntu-latest
     steps:
       - name: "Checkout code"
@@ -65,8 +63,6 @@ jobs:
 
   build:
     name: "Build"
-    needs: commits
-    if: ${{ !failure() }}
     runs-on: ubuntu-latest
     steps:
       - name: "Checkout code"
@@ -93,7 +89,6 @@ jobs:
   tests:
     name: "Tests"
     needs: [linters, build]
-    if: ${{ !failure() }}
     strategy:
       fail-fast: true
       matrix:

CHANGELOG.md

@@ -7,8 +7,16 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+### Added
+
+- Send Apilytics version info together with metrics.
+
 ## [1.0.1] - 2022-01-12
 
+### Fixed
+
+- Improve README documentation.
+
 ## [1.0.0] - 2022-01-10
 
 ### Added

apilytics/__init__.py

@@ -0,0 +1 @@
+__version__ = "1.0.1"

apilytics/core.py

@@ -1,11 +1,14 @@
 import concurrent.futures
 import json
+import platform
 import time
 import types
 import urllib.error
 import urllib.request
 from typing import ClassVar, Optional, Type
 
+import apilytics
+
 __all__ = ["ApilyticsSender"]
 
 
@@ -32,20 +35,42 @@ class ApilyticsSender:
 
     _executor: ClassVar[concurrent.futures.Executor]
 
-    def __init__(self, *, api_key: str, path: str, method: str) -> None:
+    _apilytics_version_template: ClassVar[
+        str
+    ] = f"{{integration}}/{apilytics.__version__};python/{platform.python_version()}"
+
+    def __init__(
+        self,
+        *,
+        api_key: str,
+        path: str,
+        method: str,
+        apilytics_integration: Optional[str] = None,
+        integrated_library: Optional[str] = None,
+    ) -> None:
         """
         Initialize the context manager with info from the HTTP request object.
 
         Args:
             api_key: The API key for your Apilytics origin.
             path: Path of the user's HTTP request, e.g. "/foo/bar/123".
             method: Method of the user's HTTP request, e.g. "GET".
+            apilytics_integration: Name of the Apilytics integration that's calling this,
+                e.g. "apilytics-python-django". No need to pass this when calling from user code.
+            integrated_library: Name and version of the integration that this is used in,
+                e.g. "django/3.2.1". No need to pass this when calling from user code.
         """
         self._api_key = api_key
         self._path = path
         self._method = method
         self._status_code: Optional[int] = None
 
+        self._apilytics_version = self._apilytics_version_template.format(
+            integration=apilytics_integration or "apilytics-python-core"
+        )
+        if integrated_library:
+            self._apilytics_version += f";{integrated_library}"
+
     def __enter__(self) -> "ApilyticsSender":
         """Start the timer, measuring how long the ``with`` block takes to execute."""
         self._start_time_ns = time.perf_counter_ns()
@@ -85,6 +110,7 @@ def _send_metrics(self) -> None:
             headers={
                 "Content-Type": "application/json",
                 "X-API-Key": self._api_key,
+                "Apilytics-Version": self._apilytics_version,
             },
         )
         data = {

apilytics/django.py

@@ -1,5 +1,6 @@
 from typing import Callable
 
+import django
 import django.conf
 import django.core.exceptions
 import django.http
@@ -42,6 +43,8 @@ def __call__(self, request: django.http.HttpRequest) -> django.http.HttpResponse
             api_key=self.api_key,
             path=request.path,
             method=request.method or "",
+            apilytics_integration="apilytics-python-django",
+            integrated_library=f"django/{django.__version__}",
         ) as sender:
             response = self.get_response(request)
             sender.set_response_info(status_code=response.status_code)

apilytics/fastapi.py

@@ -52,6 +52,8 @@ async def dispatch(
             api_key=self.api_key,
             path=request.url.path,
             method=request.method,
+            apilytics_integration="apilytics-python-fastapi",
+            integrated_library=f"fastapi/{fastapi.__version__}",
         ) as sender:
             response = await call_next(request)
             sender.set_response_info(status_code=response.status_code)

tests/django/test_django.py

@@ -1,7 +1,9 @@
+import platform
 import unittest.mock
 
 import django.test
 
+import apilytics
 import tests.conftest
 
 client = django.test.client.Client()
@@ -30,6 +32,7 @@ def test_middleware_should_call_apilytics_api(
         # urllib calls `capitalize()` on the header keys.
         "Content-type": "application/json",
         "X-api-key": "dummy-key",
+        "Apilytics-version": f"apilytics-python-django/{apilytics.__version__};python/{platform.python_version()};django/{django.__version__}",
     }
 
     data = tests.conftest.decode_request_data(call_kwargs["data"])

tests/fastapi/test_fastapi.py

@@ -1,3 +1,4 @@
+import platform
 import unittest.mock
 
 import fastapi.middleware
@@ -31,6 +32,7 @@ def test_middleware_should_call_apilytics_api(
         # urllib calls `capitalize()` on the header keys.
         "Content-type": "application/json",
         "X-api-key": "dummy-key",
+        "Apilytics-version": f"apilytics-python-fastapi/{apilytics.__version__};python/{platform.python_version()};fastapi/{fastapi.__version__}",
     }
 
     data = tests.conftest.decode_request_data(call_kwargs["data"])