Merge pull request #10 from Flagsmith/release/v2.0.0

gagantrivedi · web-flow · commit 67545346869c · 2022-07-12T15:05:25.000+05:30
Release/v2.0.0
diff --git a/.github/workflows/pull-request.yml b/.github/workflows/pull-request.yml
@@ -47,8 +47,8 @@ jobs:
             - name: Check flake8 linting
               run: flake8 --config=.flake8 .
 
-            - name: Check isort imports
-              run: isort --check .
+            - name: Check import order
+              run: pre-commit run reorder-python-imports --all-files
 
             - name: Run Tests
               run: pytest -p no:warnings
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -1,11 +1,11 @@
 repos:
-  - repo: https://github.com/PyCQA/isort
-    rev: 5.9.3
+  - repo: https://github.com/asottile/reorder_python_imports
+    rev: v3.8.0
     hooks:
-      - id: isort
-        name: isort (python)
+    - id: reorder-python-imports
+
   - repo: https://github.com/psf/black
-    rev: 21.10b0
+    rev: 22.6.0
     hooks:
       - id: black
         language_version: python3
diff --git a/config.json b/config.json
@@ -0,0 +1,10 @@
+{
+  "environment_key_pairs": [
+    {
+      "server_side_key": "your_server_side_environment_key",
+      "client_side_key": "your_client_side_environment_key"
+    }
+  ],
+  "api_poll_frequency": 10,
+  "api_url": "https://edge.api.flagsmith.com/api/v1"
+}
diff --git a/fastapi_utils/tasks.py b/fastapi_utils/tasks.py
@@ -3,7 +3,11 @@
 from asyncio import ensure_future
 from functools import wraps
 from traceback import format_exception
-from typing import Any, Callable, Coroutine, Optional, Union
+from typing import Any
+from typing import Callable
+from typing import Coroutine
+from typing import Optional
+from typing import Union
 
 from starlette.concurrency import run_in_threadpool
 
diff --git a/fastapi_utils/test_tasks.py b/fastapi_utils/test_tasks.py
@@ -2,7 +2,11 @@
 import logging
 import time
 from asyncio import AbstractEventLoop
-from typing import Any, Dict, List, NoReturn, Tuple
+from typing import Any
+from typing import Dict
+from typing import List
+from typing import NoReturn
+from typing import Tuple
 
 import pytest
 from _pytest.capture import CaptureFixture
diff --git a/pyproject.toml b/pyproject.toml
@@ -5,7 +5,7 @@
 
 [tool.black]
 line-length = 88
-target-version = ['py36', 'py37', 'py38']
+target-version = ['py38', 'py39', 'py310']
 include = '\.pyi?$'
 exclude = '''
 /(
@@ -28,6 +28,3 @@ use_parentheses=true
 multi_line_output=3
 include_trailing_comma=true
 line_length=79
-known_first_party=['analytics','app','custom_auth','environments','integrations','organisations','projects','segments','users','webhooks','api','audit','e2etests','features','permissions','util']
-known_third_party=['_pytest','apiclient','app_analytics','axes','chargebee','core','coreapi','corsheaders','dj_database_url','django','django_lifecycle','djoser','drf_writable_nested','drf_yasg2','environs','google','influxdb_client','ordered_model','pyotp','pytest','pytz','requests','responses','rest_framework','rest_framework_nested','rest_framework_recursive','sentry_sdk','shortuuid','simple_history','six','telemetry','tests','trench','whitenoise']
-skip = ['migrations']
diff --git a/readme.md b/readme.md
@@ -2,11 +2,47 @@
 
 https://docs.flagsmith.com/advanced-use/edge-proxy
 
+## Configuration
+
+Edge proxy can be configured using the `config.json` file located at the root.
+
+### Supported configuration
+
+You can set the following configuration(in config.json) to control the behaviour
+of edge-proxy
+
+- environment_key_pairs: An array of environment key pair objects, e.g:
+  `"environment_key_pairs":[{"server_side_key":"your_server_side_key", "client_side_key":"your_client_side_environment_key"}]`
+
+- [Optional]api_poll_frequency(seconds): it is used to control how often the proxy is going to ping the server for changes,
+  e.g: `"api_poll_frequency":10`
+
+- [Optional]api_url: If you are running a self hosted version of flagsmith you can add the self hosted url here for edge-proxy to ping
+  your server, e.g: `"api_url":"https://self.hosted.flagsmith.com/api/v1"`
+
+### Here are some examples of adding local `config.json` to edge-proxy:
+
+- With docker run:
+  `docker run -v /<path-to-local>/config.json:/app/config.json flagsmith/edge-proxy:latest`
+
+- With docker compose:
+
+```yaml
+version: "3.9"
+services:
+  edge_proxy:
+    image: flagsmith/edge-proxy:latest
+    volumes:
+      - type: bind
+        source: /<path-to-local>/config.json
+        target: /app/config.json
+```
+
 ## Load Testing
 
 You can send post request with `wrk` like this:
 
 ```bash
 cd load-test
 wrk -t10 -c40 -d5 -s post.lua -H 'X-Environment-Key: NC7zfaBWg7QJhbHpUMs7tv' 'http://localhost:8001/api/v1/identities/?identifier=development_user_123456'
-```
+```
diff --git a/requirements-dev.in b/requirements-dev.in
@@ -2,9 +2,9 @@ pylint
 pep8
 autopep8
 black
-pip-tools
 pre-commit
 flake8
 pytest
 pytest-asyncio
-pytest-mock
+pytest-mock
+reorder-python-imports
diff --git a/requirements-dev.txt b/requirements-dev.txt
@@ -4,22 +4,22 @@
 #
 #    pip-compile requirements-dev.in
 #
+aspy-refactor-imports==3.0.1
+    # via reorder-python-imports
 astroid==2.9.0
     # via pylint
 attrs==21.2.0
     # via pytest
 autopep8==1.6.0
     # via -r requirements-dev.in
-backports.entry-points-selectable==1.1.1
+backports-entry-points-selectable==1.1.1
     # via virtualenv
-black==21.11b1
+black==22.6.0
     # via -r requirements-dev.in
 cfgv==3.3.1
     # via pre-commit
 click==8.0.3
-    # via
-    #   black
-    #   pip-tools
+    # via black
 distlib==0.3.3
     # via virtualenv
 filelock==3.4.0
@@ -46,20 +46,16 @@ packaging==21.3
     # via pytest
 pathspec==0.9.0
     # via black
-pep517==0.12.0
-    # via pip-tools
 pep8==1.7.1
     # via -r requirements-dev.in
-pip-tools==6.4.0
-    # via -r requirements-dev.in
 platformdirs==2.4.0
     # via
     #   black
     #   pylint
     #   virtualenv
 pluggy==1.0.0
     # via pytest
-pre-commit==2.16.0
+pre-commit==2.20.0
     # via -r requirements-dev.in
 py==1.11.0
     # via pytest
@@ -84,8 +80,8 @@ pytest-mock==3.6.1
     # via -r requirements-dev.in
 pyyaml==6.0
     # via pre-commit
-regex==2021.11.10
-    # via black
+reorder-python-imports==3.0.1
+    # via -r requirements-dev.in
 six==1.16.0
     # via virtualenv
 toml==0.10.2
@@ -94,19 +90,10 @@ toml==0.10.2
     #   pre-commit
     #   pylint
     #   pytest
-tomli==1.2.2
-    # via
-    #   black
-    #   pep517
-typing-extensions==4.0.1
-    # via black
 virtualenv==20.10.0
     # via pre-commit
-wheel==0.37.0
-    # via pip-tools
 wrapt==1.13.3
     # via astroid
 
 # The following packages are considered to be unsafe in a requirements file:
-# pip
 # setuptools
diff --git a/requirements.in b/requirements.in
@@ -5,4 +5,4 @@ marshmallow
 flagsmith-flag-engine
 python-decouple
 python-dotenv
-
+pydantic
diff --git a/requirements.txt b/requirements.txt
@@ -2,12 +2,10 @@
 # This file is autogenerated by pip-compile with python 3.10
 # To update, run:
 #
-#    pip-compile requirements.in
+#    pip-compile
 #
 anyio==3.4.0
     # via starlette
-asgiref==3.4.1
-    # via uvicorn
 certifi==2021.10.8
     # via requests
 charset-normalizer==2.0.9
@@ -29,7 +27,9 @@ marshmallow==3.14.1
     #   -r requirements.in
     #   flagsmith-flag-engine
 pydantic==1.8.2
-    # via fastapi
+    # via
+    #   -r requirements.in
+    #   fastapi
 python-decouple==3.5
     # via -r requirements.in
 python-dotenv==0.19.2
@@ -44,5 +44,5 @@ typing-extensions==4.0.1
     # via pydantic
 urllib3==1.26.7
     # via requests
-uvicorn==0.15.0
+uvicorn==0.18.2
     # via -r requirements.in
diff --git a/src/cache.py b/src/cache.py
@@ -2,29 +2,33 @@
 
 import requests
 
+from .settings import Settings
+
 
 class CacheService:
-    def __init__(self, api_url: str, api_token: str, api_keys: list):
-        self.api_url = api_url
-        self.api_token = api_token
-        self.api_keys = api_keys
+    def __init__(self, settings: Settings):
+        self.settings = settings
         self._session = requests.Session()
-        self._session.headers.update({"Authorization": f"Token {self.api_token}"})
-
         self._cache = {}
 
-    def _fetch_document(self, api_key):
-        url = f"{self.api_url}/environments/{api_key}/document/"
-        response = self._session.get(url)
+    def _fetch_document(self, server_side_key):
+        url = f"{self.settings.api_url}/environment-document/"
+        response = self._session.get(
+            url, headers={"X-Environment-Key": server_side_key}
+        )
         response.raise_for_status()
         return response.json()
 
     def refresh(self):
-        for api_key in self.api_keys:
+        for key_pair in self.settings.environment_key_pairs:
             try:
-                self._cache[api_key] = self._fetch_document(api_key)
+                self._cache[key_pair.client_side_key] = self._fetch_document(
+                    key_pair.server_side_key
+                )
             except requests.exceptions.HTTPError:
-                logging.error(f"received non 200 response for {api_key}")
+                logging.error(
+                    f"received non 200 response for {key_pair.client_side_key}"
+                )
 
-    def get_environment(self, api_key):
-        return self._cache[api_key]
+    def get_environment(self, client_side_key):
+        return self._cache[client_side_key]
diff --git a/src/main.py b/src/main.py
@@ -1,27 +1,22 @@
-from fastapi import FastAPI, Header
+from fastapi import FastAPI
+from fastapi import Header
 from fastapi.responses import JSONResponse
-from flag_engine.engine import (
-    get_environment_feature_state,
-    get_environment_feature_states,
-    get_identity_feature_states,
-)
+from flag_engine.engine import get_environment_feature_state
+from flag_engine.engine import get_environment_feature_states
+from flag_engine.engine import get_identity_feature_states
 from flag_engine.environments.builders import build_environment_model
 from flag_engine.identities.models import IdentityModel
 
-from fastapi_utils.tasks import repeat_every
-
-from . import settings
 from .cache import CacheService
 from .models import IdentityWithTraits
-from .schemas import APIFeatureStateSchema, APITraitSchema
+from .schemas import APIFeatureStateSchema
+from .schemas import APITraitSchema
+from .settings import Settings
+from fastapi_utils.tasks import repeat_every
 
 app = FastAPI()
-
-cache_service = CacheService(
-    api_url=settings.FLAGSMITH_API_URL,
-    api_token=settings.FLAGSMITH_API_TOKEN,
-    api_keys=settings.ENVIRONMENT_API_KEYS,
-)
+settings = Settings()
+cache_service = CacheService(settings)
 
 
 fs_schema = APIFeatureStateSchema()
@@ -72,6 +67,6 @@ def identity(
 
 
 @app.on_event("startup")
-@repeat_every(seconds=settings.API_POLL_FREQUENCY, raise_exceptions=True)
+@repeat_every(seconds=settings.api_poll_frequency, raise_exceptions=True)
 def refresh_cache():
     cache_service.refresh()
diff --git a/src/models.py b/src/models.py
@@ -1,4 +1,5 @@
-from typing import Any, List
+from typing import Any
+from typing import List
 
 from pydantic import BaseModel
 
diff --git a/src/schemas.py b/src/schemas.py
@@ -3,12 +3,12 @@
 from flag_engine.features.models import FeatureStateModel
 from flag_engine.features.schemas import FeatureStateSchema
 from flag_engine.identities.schemas import TraitSchema
-from marshmallow import ValidationError, fields, validates
+from marshmallow import fields
+from marshmallow import validates
+from marshmallow import ValidationError
 
-from .constants import (
-    ACCEPTED_TRAIT_VALUE_TYPES,
-    TRAIT_STRING_VALUE_MAX_LENGTH,
-)
+from .constants import ACCEPTED_TRAIT_VALUE_TYPES
+from .constants import TRAIT_STRING_VALUE_MAX_LENGTH
 
 
 class APIFeatureStateSchema(FeatureStateSchema):
diff --git a/src/settings.py b/src/settings.py
diff --git a/tests/test_cache.py b/tests/test_cache.py
diff --git a/tests/test_main.py b/tests/test_main.py
