feature/Benchmark Platform

.github/workflows/platform-benchmark.yml

@@ -0,0 +1,79 @@
+name: Benchmark Flagsmith API
+
+on:
+    pull_request:
+        types: [opened, synchronize, reopened, ready_for_review]
+
+concurrency: 'benchmarks' # Ensure only one of this runs at a time
+
+defaults:
+    run:
+        working-directory: api
+
+jobs:
+    run-benchmarks:
+        name: SDK benchmark
+        runs-on: ubuntu-latest
+
+        env:
+            DJANGO_ALLOWED_HOSTS: '*'
+            DATABASE_URL: postgres://postgres:postgres@localhost:5432/flagsmith
+            SENDGRID_API_KEY: ${{ secrets.SENDGRID_API_KEY }}
+            DJANGO_SETTINGS_MODULE: app.settings.test
+            FE_E2E_TEST_USER_EMAIL: [email protected]
+
+        services:
+            postgres:
+                image: postgres:11.12-alpine
+                env:
+                    POSTGRES_USER: postgres
+                    POSTGRES_PASSWORD: postgres
+                    POSTGRES_DB: flagsmith
+                ports: ['5432:5432']
+                options: --health-cmd pg_isready --health-interval 10s --health-timeout 5s --health-retries 5
+
+        steps:
+            - name: Cloning repo
+              uses: actions/checkout@v2
+              with:
+                  fetch-depth: 0
+
+            - name: Check out Flagsmith/benchmarks-results repo
+              uses: actions/checkout@v2
+              with:
+                  path: api/benchmarks/results
+                  repository: Flagsmith/benchmark-results
+                  token: ${{ secrets.FLAGSMITH_BOT_GITHUB_TOKEN }}
+
+            - name: Set up Python 3.8
+              uses: actions/setup-python@v2
+              with:
+                  python-version: 3.8
+
+            - name: Install Python dependencies and setup Flagsmith
+              run: |
+                  python3.8 -m pip install --upgrade pip
+                  python3.8 -m pip install -r requirements.txt
+                  python3.8 manage.py migrate
+
+            - name: Install asv
+              run: pip install git+https://github.com/airspeed-velocity/asv.git virtualenv
+
+            - name: Configure benchmarks
+              run: asv machine --config benchmarks/asv.conf.json --yes --machine ci-benchmarks
+
+            - name: Run asv benchmarks
+              run: asv run --config benchmarks/asv.conf.json --show-stderr --strict
+
+            - name: Generate HTML report of results
+              run: asv publish --config benchmarks/asv.conf.json
+
+            - name: Commit update for benchmark results
+              uses: stefanzweifel/git-auto-commit-action@v4
+              with:
+                  repository: api/benchmarks/results
+                  branch: main
+                  commit_message: 'Save benchmark results'
+                  commit_user_name: Flagsmith Bot
+                  commit_user_email: [email protected]
+                  commit_author: Flagsmith Bot <[email protected]>

api/benchmarks/.gitignore

@@ -0,0 +1,2 @@
+.asv
+results

api/benchmarks/asv.conf.json

@@ -0,0 +1,140 @@
+{
+    // The version of the config file format.  Do not change, unless
+    // you know what you are doing.
+    "version": 1,
+    // The name of the project being benchmarked
+    "project": "flagsmith",
+    // The project's homepage
+    "project_url": "https://flagsmith.com/",
+    // The URL or local path of the source code repository for the
+    // project being benchmarked
+    "repo": "../..",
+    // The Python project's subdirectory in your repo.  If missing or
+    // the empty string, the project is assumed to be located at the root
+    // of the repository.
+    "repo_subdir": "api/",
+    // Customizable commands for building, installing, and
+    // uninstalling the project. See asv.conf.json documentation.
+    //
+    // "install_command": ["in-dir={env_dir} python -mpip install {wheel_file}"],
+    // "uninstall_command": ["return-code=any python -mpip uninstall -y {project}"],
+    "build_command": [
+        "in-dir={build_dir} python -m pip install -r requirements.txt",
+        "PIP_NO_BUILD_ISOLATION=false python -mpip wheel --no-deps --no-index -w {build_cache_dir} {build_dir}"
+    ],
+    // List of branches to benchmark. If not provided, defaults to "master"
+    // (for git) or "default" (for mercurial).
+    "branches": [
+        "HEAD"
+    ], // for git
+    // "branches": ["default"],    // for mercurial
+    // The DVCS being used.  If not set, it will be automatically
+    // determined from "repo" by looking at the protocol in the URL
+    // (if remote), or by looking for special directories, such as
+    // ".git" (if local).
+    // "dvcs": "git",
+    // The tool to use to create environments.  May be "conda",
+    // "virtualenv" or other value depending on the plugins in use.
+    // If missing or the empty string, the tool will be automatically
+    // determined by looking for tools on the PATH environment
+    // variable.
+    "environment_type": "virtualenv",
+    // timeout in seconds for installing any dependencies in environment
+    // defaults to 10 min
+    //"install_timeout": 600,
+    // the base URL to show a commit for the project.
+    // "show_commit_url": "http://github.com/owner/project/commit/",
+    // The Pythons you'd like to test against.  If not provided, defaults
+    // to the current version of Python used to run `asv`.
+    // "pythons": ["2.7", "3.6"],
+    // The list of conda channel names to be searched for benchmark
+    // dependency packages in the specified order
+    // "conda_channels": ["conda-forge", "defaults"],
+    // The matrix of dependencies to test.  Each key is the name of a
+    // package (in PyPI) and the values are version numbers.  An empty
+    // list or empty string indicates to just test against the default
+    // (latest) version. null indicates that the package is to not be
+    // installed. If the package to be tested is only available from
+    // PyPi, and the 'environment_type' is conda, then you can preface
+    // the package name by 'pip+', and the package will be installed via
+    // pip (with all the conda available packages installed first,
+    // followed by the pip installed packages).
+    //
+    // "matrix": {
+    //     "numpy": ["1.6", "1.7"],
+    //     "six": ["", null],        // test with and without six installed
+    //     "pip+emcee": [""],   // emcee is only available for install with pip.
+    // },
+    // Combinations of libraries/python versions can be excluded/included
+    // from the set to test. Each entry is a dictionary containing additional
+    // key-value pairs to include/exclude.
+    //
+    // An exclude entry excludes entries where all values match. The
+    // values are regexps that should match the whole string.
+    //
+    // An include entry adds an environment. Only the packages listed
+    // are installed. The 'python' key is required. The exclude rules
+    // do not apply to includes.
+    //
+    // In addition to package names, the following keys are available:
+    //
+    // - python
+    //     Python version, as in the *pythons* variable above.
+    // - environment_type
+    //     Environment type, as above.
+    // - sys_platform
+    //     Platform, as in sys.platform. Possible values for the common
+    //     cases: 'linux2', 'win32', 'cygwin', 'darwin'.
+    //
+    // "exclude": [
+    //     {"python": "3.2", "sys_platform": "win32"}, // skip py3.2 on windows
+    //     {"environment_type": "conda", "six": null}, // don't run without six on conda
+    // ],
+    //
+    // "include": [
+    //     // additional env for python2.7
+    //     {"python": "2.7", "numpy": "1.8"},
+    //     // additional env if run on windows+conda
+    //     {"platform": "win32", "environment_type": "conda", "python": "2.7", "libpython": ""},
+    // ],
+    // The directory (relative to the current directory) that benchmarks are
+    // stored in.  If not provided, defaults to "benchmarks"
+    "benchmark_dir": ".",
+    // The directory (relative to the current directory) to cache the Python
+    // environments in.  If not provided, defaults to "env"
+    "env_dir": ".asv/env",
+    // The directory (relative to the current directory) that raw benchmark
+    // results are stored in.  If not provided, defaults to "results".
+    "results_dir": "results",
+    // The directory (relative to the current directory) that the html tree
+    // should be written to.  If not provided, defaults to "html".
+    "html_dir": "results/docs",
+    // The number of characters to retain in the commit hashes.
+    // "hash_length": 8,
+    // `asv` will cache results of the recent builds in each
+    // environment, making them faster to install next time.  This is
+    // the number of builds to keep, per environment.
+    // "build_cache_size": 2,
+    // The commits after which the regression search in `asv publish`
+    // should start looking for regressions. Dictionary whose keys are
+    // regexps matching to benchmark names, and values corresponding to
+    // the commit (exclusive) after which to start looking for
+    // regressions.  The default is to start from the first commit
+    // with results. If the commit is `null`, regression detection is
+    // skipped for the matching benchmark.
+    //
+    // "regressions_first_commits": {
+    //    "some_benchmark": "352cdf",  // Consider regressions only after this commit
+    //    "another_benchmark": null,   // Skip regression detection altogether
+    // },
+    // The thresholds for relative change in results, after which `asv
+    // publish` starts reporting regressions. Dictionary of the same
+    // form as in ``regressions_first_commits``, with values
+    // indicating the thresholds.  If multiple entries match, the
+    // maximum is taken. If no entry matches, the default is 5%.
+    //
+    // "regressions_thresholds": {
+    //    "some_benchmark": 0.01,     // Threshold of 1%
+    //    "another_benchmark": 0.5,   // Threshold of 50%
+    // },
+}

api/benchmarks/benchmarks.py

@@ -0,0 +1,103 @@
+# Needs to be first to set up django environment
+from .helpers import *  # isort:skip
+import json
+
+from django.conf import settings
+from django.urls import reverse
+from rest_framework import status
+from rest_framework.test import APIClient
+
+from environments.identities.models import Identity
+from environments.models import Environment
+from features.models import Feature
+from organisations.models import Organisation
+from projects.models import Project
+
+
+class PerformanceSuite:
+    test_data_count = 3
+    test_iteration_count = 400
+
+    def setup(self):
+        self.client = APIClient()
+
+        for test_data_count in range(self.test_data_count):
+            self.organisation = Organisation.objects.create(
+                name="Performance Test Organisation " + str(test_data_count)
+            )
+            self.project = Project.objects.create(
+                name="Performance Test Project " + str(test_data_count),
+                organisation=self.organisation,
+            )
+            self.environment = Environment.objects.create(
+                name="Performance Test Environment " + str(test_data_count),
+                project=self.project,
+            )
+            for test_feature_count in range(self.test_data_count):
+                self.feature = Feature.objects.create(
+                    name="Test Feature " + str(test_feature_count), project=self.project
+                )
+
+        for test_identity_count in range(self.test_data_count):
+            self.identity = Identity.objects.create(
+                identifier="test-identity-" + str(test_identity_count),
+                environment=self.environment,
+            )
+
+    def time_get_environment_flags(self):
+        # Given
+        url = reverse("api-v1:flags")
+        self.client.credentials(
+            HTTP_X_ENVIRONMENT_KEY=self.identity.environment.api_key
+        )
+
+        # When
+        for test_flags_count in range(self.test_iteration_count):
+            response = self.client.get(url)
+            assert response.status_code == status.HTTP_200_OK
+
+        # Then
+        pass
+
+    def time_get_identity_flags(self):
+        # Given
+        base_url = reverse("api-v1:sdk-identities")
+        url = base_url + "?identifier=" + self.identity.identifier
+        self.client.credentials(
+            HTTP_X_ENVIRONMENT_KEY=self.identity.environment.api_key
+        )
+
+        # When
+        for test_identity_count in range(self.test_iteration_count):
+            response = self.client.get(url)
+            assert response.status_code == status.HTTP_200_OK
+
+        # Then
+        pass
+
+    def time_set_identity_traits_flags(self):
+        # Given
+        url = reverse("api-v1:sdk-identities")
+
+        # a payload for an identity with 2 traits
+        data = {
+            "identifier": self.identity.identifier,
+            "traits": [
+                {"trait_key": "my_trait", "trait_value": 123},
+                {"trait_key": "my_other_trait", "trait_value": "a value"},
+            ],
+        }
+
+        # When
+        # we identify that user by posting the above payload
+        self.client.credentials(HTTP_X_ENVIRONMENT_KEY=self.environment.api_key)
+        for test_identity_count in range(self.test_iteration_count):
+            response = self.client.post(
+                url, data=json.dumps(data), content_type="application/json"
+            )
+            print(response.status_code)
+            print(response.data)
+            assert response.status_code == status.HTTP_200_OK
+
+        # Then
+        pass

api/benchmarks/helpers.py

@@ -0,0 +1,17 @@
+import os
+import sys
+from contextlib import contextmanager
+from functools import wraps
+from os.path import dirname
+
+import django
+from django.utils.timezone import now
+
+os.environ["DJANGO_SETTINGS_MODULE"] = "app.settings.local"
+os.environ["DJANGO_ALLOWED_HOSTS"] = "*"
+os.environ["DEBUG"] = "False"
+os.environ["INFLUXDB_TOKEN"] = ""
+sys.path.append(dirname(dirname(__file__)))
+
+
+django.setup()