├── .git-blame-ignore-revs ├── .github └── workflows │ └── lint.yml ├── .gitignore ├── .pre-commit-config.yaml ├── CHANGELOG.md ├── LICENSE ├── README.md ├── bin └── admin.py ├── pyproject.toml ├── requirements-dev.txt ├── requirements.txt ├── rest_framework_idempotency_key ├── __init__.py ├── __version__.py ├── apps.py ├── decorators.py ├── middleware.py ├── migrations │ ├── 0001_initial.py │ ├── 0002_alter_idempotencykey_user.py │ ├── 0003_remove_user.py │ └── __init__.py ├── models.py └── utils.py ├── setup.cfg ├── setup.py └── tests └── __init__.py /.git-blame-ignore-revs: -------------------------------------------------------------------------------- 1 | # Add to ignored commit here 2 | # Linting # 3 | ################# 4 | -------------------------------------------------------------------------------- /.github/workflows/lint.yml: -------------------------------------------------------------------------------- 1 | name: Lint 2 | 3 | on: [pull_request] 4 | 5 | jobs: 6 | pre-commit: 7 | runs-on: ubuntu-latest 8 | steps: 9 | - uses: actions/checkout@v2 10 | with: 11 | fetch-depth: 1024 12 | - uses: actions/setup-python@v2 13 | - name: pre-commit 14 | env: 15 | BASE_SHA: ${{ github.event.pull_request.base.sha}} 16 | HEAD_SHA: ${{ github.event.pull_request.head.sha}} 17 | run: | 18 | python -m pip install pre-commit 19 | pre-commit run --from-ref $BASE_SHA --to-ref $HEAD_SHA --all-files 20 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # Byte-compiled / optimized / DLL files 2 | __pycache__/ 3 | *.py[cod] 4 | *$py.class 5 | 6 | # C extensions 7 | *.so 8 | 9 | # Distribution / packaging 10 | .Python 11 | build/ 12 | develop-eggs/ 13 | dist/ 14 | downloads/ 15 | eggs/ 16 | .eggs/ 17 | lib/ 18 | lib64/ 19 | parts/ 20 | sdist/ 21 | var/ 22 | wheels/ 23 | pip-wheel-metadata/ 24 | share/python-wheels/ 25 | *.egg-info/ 26 | .installed.cfg 27 | *.egg 28 | MANIFEST 29 | 30 | # PyPi 31 | .pypirc 32 | 33 | # PyInstaller 34 | # Usually these files are written by a python script from a template 35 | # before PyInstaller builds the exe, so as to inject date/other infos into it. 36 | *.manifest 37 | *.spec 38 | 39 | # Installer logs 40 | pip-log.txt 41 | pip-delete-this-directory.txt 42 | 43 | # Unit test / coverage reports 44 | htmlcov/ 45 | .tox/ 46 | .nox/ 47 | .coverage 48 | .coverage.* 49 | .cache 50 | nosetests.xml 51 | coverage.xml 52 | *.cover 53 | *.py,cover 54 | .hypothesis/ 55 | .pytest_cache/ 56 | 57 | # Translations 58 | *.mo 59 | *.pot 60 | 61 | # Django stuff: 62 | *.log 63 | local_settings.py 64 | db.sqlite3 65 | db.sqlite3-journal 66 | 67 | # Flask stuff: 68 | instance/ 69 | .webassets-cache 70 | 71 | # Scrapy stuff: 72 | .scrapy 73 | 74 | # Sphinx documentation 75 | docs/_build/ 76 | 77 | # PyBuilder 78 | target/ 79 | 80 | # Jupyter Notebook 81 | .ipynb_checkpoints 82 | 83 | # IPython 84 | profile_default/ 85 | ipython_config.py 86 | 87 | # pyenv 88 | .python-version 89 | 90 | # pipenv 91 | # According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control. 92 | # However, in case of collaboration, if having platform-specific dependencies or dependencies 93 | # having no cross-platform support, pipenv may install dependencies that don't work, or not 94 | # install all needed dependencies. 95 | #Pipfile.lock 96 | 97 | # PEP 582; used by e.g. github.com/David-OConnor/pyflow 98 | __pypackages__/ 99 | 100 | # Celery stuff 101 | celerybeat-schedule 102 | celerybeat.pid 103 | 104 | # SageMath parsed files 105 | *.sage.py 106 | 107 | # Environments 108 | .env 109 | .venv 110 | env/ 111 | venv/ 112 | ENV/ 113 | env.bak/ 114 | venv.bak/ 115 | 116 | # Spyder project settings 117 | .spyderproject 118 | .spyproject 119 | 120 | # Rope project settings 121 | .ropeproject 122 | 123 | # mkdocs documentation 124 | /site 125 | 126 | # mypy 127 | .mypy_cache/ 128 | .dmypy.json 129 | dmypy.json 130 | 131 | # Pyre type checker 132 | .pyre/ 133 | 134 | # MacOS Desktop Services Store 135 | *.DS_Store 136 | -------------------------------------------------------------------------------- /.pre-commit-config.yaml: -------------------------------------------------------------------------------- 1 | default_stages: [commit, push] 2 | fail_fast: false 3 | repos: 4 | - repo: https://github.com/pre-commit/pre-commit-hooks 5 | rev: v4.2.0 6 | hooks: 7 | - id: end-of-file-fixer 8 | - id: trailing-whitespace 9 | - repo: https://github.com/myint/autoflake 10 | rev: v2.0.0 11 | hooks: 12 | - id: autoflake 13 | args: 14 | - --in-place 15 | - --remove-unused-variables 16 | - --remove-all-unused-imports 17 | - repo: https://github.com/pycqa/isort 18 | rev: 5.12.0 19 | hooks: 20 | - id: isort 21 | - repo: https://github.com/psf/black 22 | rev: 22.3.0 23 | hooks: 24 | - id: black 25 | language_version: python3 # Should be a command that runs python3.6+ 26 | - repo: https://github.com/PyCQA/flake8 27 | rev: 6.0.0 28 | hooks: 29 | - id: flake8 30 | -------------------------------------------------------------------------------- /CHANGELOG.md: -------------------------------------------------------------------------------- 1 | Changelog 2 | ========= 3 | 4 | 1.0.3 5 | ----- 6 | 7 | Fixes: 8 | 9 | - Fail to run migration script for django 4 10 | - Fail to run migration script when duplicated idempotency_key exists 11 | 12 | 13 | 1.0.2 14 | ----- 15 | 16 | Fixes: 17 | 18 | - Missing LICENSE file in package (Upgrade setuptools) 19 | 20 | 21 | 1.0.1 22 | ----- 23 | 24 | Fixes: 25 | 26 | - Fail to drop index during migrations 27 | 28 | 29 | 1.0.0 30 | ----- 31 | 32 | Changes: 33 | 34 | - Remove User model dependency for more flexibility 35 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | MIT License 2 | 3 | Copyright (c) 2021 Hard Core Technology Corp. 4 | 5 | Permission is hereby granted, free of charge, to any person obtaining a copy 6 | of this software and associated documentation files (the "Software"), to deal 7 | in the Software without restriction, including without limitation the rights 8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 9 | copies of the Software, and to permit persons to whom the Software is 10 | furnished to do so, subject to the following conditions: 11 | 12 | The above copyright notice and this permission notice shall be included in all 13 | copies or substantial portions of the Software. 14 | 15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, 20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE 21 | SOFTWARE. 22 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # idempotency-key 2 | An installable DB backend idempotency key middleware for Django Rest Framework 3 | -------------------------------------------------------------------------------- /bin/admin.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python 2 | 3 | import argparse 4 | import os 5 | import os.path 6 | import subprocess 7 | from os.path import abspath, dirname, join 8 | 9 | CUR_DIR = dirname(abspath(__file__)) 10 | ROOT_DIR = abspath(join(CUR_DIR, '..')) 11 | 12 | 13 | def parse_args(): 14 | parser = argparse.ArgumentParser(description='rest-framework-idempotency-key admin') 15 | subparsers = parser.add_subparsers() 16 | 17 | # === build === # 18 | parser_build = subparsers.add_parser('build', help='build package') 19 | parser_build.set_defaults(func=build) 20 | 21 | # === upload === # 22 | parser_upload = subparsers.add_parser('upload', help='upload to pypi') 23 | parser_upload.add_argument( 24 | '--repo', dest='repo', default='pypi', choices=('pypi', 'testpypi'), help='upload repo, pypi or testpypi' 25 | ) 26 | parser_upload.set_defaults(func=upload) 27 | 28 | args = parser.parse_args() 29 | args.func(args) 30 | 31 | 32 | def build(args): 33 | subprocess.check_call('python setup.py sdist', shell=True) 34 | subprocess.check_call('rm -vrf ./build ./*.egg-info', shell=True) 35 | 36 | 37 | def upload(args): 38 | # remove old dist 39 | subprocess.check_call('rm -rf ./dist', shell=True) 40 | 41 | # build again 42 | build(args) 43 | 44 | if args.repo == 'pypi': 45 | ans = input("Are you sure to upload package to pypi?\n(y/N)") 46 | if ans.lower() != 'y': 47 | return 48 | 49 | # read local .pypirc first 50 | repo_pypirc_path = join(ROOT_DIR, '.pypirc') 51 | config_arg = f'--config-file={repo_pypirc_path}' if os.path.exists(repo_pypirc_path) else '' 52 | repo_arg = '-r testpypi' if args.repo == 'testpypi' else '' 53 | subprocess.check_call(f'twine upload {repo_arg} {config_arg} dist/*', shell=True) 54 | 55 | 56 | def main(): 57 | os.chdir(ROOT_DIR) 58 | parse_args() 59 | 60 | 61 | if __name__ == '__main__': 62 | main() 63 | -------------------------------------------------------------------------------- /pyproject.toml: -------------------------------------------------------------------------------- 1 | [tool.black] 2 | line-length = 120 3 | skip-string-normalization = true 4 | target-version = ['py36'] 5 | include = '\.pyi?$' 6 | exclude = ''' 7 | ( 8 | /( 9 | \.eggs # exclude a few common directories in the 10 | | \.git # root of the project 11 | | \.tox 12 | | \.venv 13 | | build 14 | | dist 15 | | static 16 | )/ 17 | ) 18 | ''' 19 | -------------------------------------------------------------------------------- /requirements-dev.txt: -------------------------------------------------------------------------------- 1 | Django 2 | djangorestframework 3 | data-spec-validator>=1.2.0 4 | pre-commit==2.9.2 5 | autoflake==1.4 6 | isort==5.10.1 7 | black==22.3.0 8 | flake8==3.9.2 9 | twine==3.4.2 10 | -------------------------------------------------------------------------------- /requirements.txt: -------------------------------------------------------------------------------- 1 | Django 2 | djangorestframework 3 | data-spec-validator>=1.2.0 4 | -------------------------------------------------------------------------------- /rest_framework_idempotency_key/__init__.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/hardcoretech/djangorestframework-idempotency-key/7d8108b4ab1843167e836649202120210caee783/rest_framework_idempotency_key/__init__.py -------------------------------------------------------------------------------- /rest_framework_idempotency_key/__version__.py: -------------------------------------------------------------------------------- 1 | __version__ = '1.0.3' 2 | -------------------------------------------------------------------------------- /rest_framework_idempotency_key/apps.py: -------------------------------------------------------------------------------- 1 | from django.apps import AppConfig 2 | 3 | 4 | class RestFrameworkIdempotencyKeyConfig(AppConfig): 5 | default_auto_field = 'django.db.models.BigAutoField' 6 | name = 'rest_framework_idempotency_key' 7 | -------------------------------------------------------------------------------- /rest_framework_idempotency_key/decorators.py: -------------------------------------------------------------------------------- 1 | import operator 2 | from functools import partial, wraps 3 | 4 | from data_spec_validator.decorator import dsv_request_meta 5 | from data_spec_validator.spec import UUID, Checker 6 | from rest_framework.request import Request 7 | from rest_framework.response import Response 8 | 9 | from .middleware import IdempotencyKeyMiddleware 10 | from .models import IDEMPOTENCY_RECOVERY_POINT_FINISHED, IDEMPOTENCY_RECOVERY_POINT_STARTED 11 | from .utils import raise_if 12 | 13 | 14 | class _IdempotencyKeyRequestMetaSpec: 15 | HTTP_IDEMPOTENCY_KEY = Checker([UUID]) 16 | 17 | 18 | idempotency_key_validation = partial(dsv_request_meta, spec=_IdempotencyKeyRequestMetaSpec) 19 | 20 | 21 | def simple_idempotency_key_method(func): 22 | return simple_idempotency_key_method_ex(request_getter=operator.itemgetter(1))(func) 23 | 24 | 25 | def simple_idempotency_key_method_ex(request_getter): 26 | def decorator(func): 27 | @wraps(func) 28 | @idempotency_key_validation() 29 | def wrapper(*args, **kwargs): 30 | request = request_getter(args) 31 | raise_if(not isinstance(request, Request), TypeError('Only supports a DRF Request instance')) 32 | 33 | def action(): 34 | response = func(*args, **kwargs) 35 | raise_if(not isinstance(response, Response), TypeError('Only supports a DRF Response instance')) 36 | 37 | return ( 38 | response.status_code, # response_code 39 | response.data, # response_body 40 | IDEMPOTENCY_RECOVERY_POINT_FINISHED, # next recovery_point 41 | ) 42 | 43 | raise_if( 44 | request.idempotency_key is None, 45 | AttributeError('Attribute: idempotency_key not found in request instance'), 46 | ) 47 | raise_if( 48 | request.idempotency_key.recovery_point 49 | not in ( 50 | IDEMPOTENCY_RECOVERY_POINT_STARTED, 51 | IDEMPOTENCY_RECOVERY_POINT_FINISHED, 52 | ), 53 | RuntimeError(f'Unexpected recovery point: {request.idempotency_key.recovery_point}'), 54 | ) 55 | 56 | idempotency_key = request.idempotency_key 57 | 58 | recovery_point_to_action_map = { 59 | IDEMPOTENCY_RECOVERY_POINT_STARTED: action, 60 | } 61 | response_code, response_body, recovery_point = IdempotencyKeyMiddleware.proceed( 62 | idempotency_key, recovery_point_to_action_map 63 | ) 64 | 65 | raise_if( 66 | recovery_point != IDEMPOTENCY_RECOVERY_POINT_FINISHED, 67 | RuntimeError('recovery_point must be in finished state'), 68 | ) 69 | return Response(response_body, status=response_code) 70 | 71 | return wrapper 72 | 73 | return decorator 74 | -------------------------------------------------------------------------------- /rest_framework_idempotency_key/middleware.py: -------------------------------------------------------------------------------- 1 | import hashlib 2 | import json 3 | from datetime import timedelta 4 | from typing import Any, Callable, Dict, Tuple 5 | 6 | from django.conf import settings 7 | from django.db import transaction 8 | from django.http import JsonResponse 9 | from django.utils import timezone 10 | from rest_framework import status 11 | from rest_framework.utils.encoders import JSONEncoder 12 | 13 | from .models import ( 14 | IDEMPOTENCY_RECOVERY_POINT_FINISHED, 15 | IDEMPOTENCY_RECOVERY_POINT_STARTED, 16 | IdempotencyKey, 17 | RecoveryPoint, 18 | ) 19 | from .utils import raise_if 20 | 21 | 22 | class IdempotencyKeyMiddleware: 23 | EXEMPT_STATUS_LIST = (status.HTTP_400_BAD_REQUEST,) 24 | 25 | class Http409Error(Exception): 26 | def __init__(self, message=''): 27 | self.message = message 28 | 29 | def __init__(self, get_response): 30 | self.get_response = get_response 31 | 32 | def __call__(self, request): 33 | try: 34 | request.idempotency_key = self._prepare_idempotency_key(request) 35 | except self.Http409Error as exc: 36 | return JsonResponse({'message': exc.message}, status=status.HTTP_409_CONFLICT) 37 | 38 | try: 39 | response = self.get_response(request) 40 | finally: 41 | self._reset_lock(request) 42 | 43 | return response 44 | 45 | @staticmethod 46 | def make_digest(request_method, request_params, request_path): 47 | sha256 = hashlib.sha256() 48 | sha256.update(request_method) 49 | sha256.update(request_path) 50 | sha256.update(request_params) 51 | return sha256.digest() 52 | 53 | @transaction.atomic 54 | def _prepare_idempotency_key(self, request): 55 | if 'Idempotency-Key' not in request.headers: 56 | return None 57 | 58 | if request.method.upper() not in ('PATCH', 'POST', 'PUT'): 59 | return None 60 | 61 | idempotency_key = request.headers['Idempotency-Key'] 62 | digest = self.make_digest( 63 | request.method.encode('utf8'), 64 | request.body, 65 | request.path_info.encode('utf8'), 66 | ) 67 | 68 | obj, created = IdempotencyKey.objects.get_or_create( 69 | idempotency_key=idempotency_key, 70 | defaults={ 71 | 'request_method': request.method, 72 | 'request_params': request.body, 73 | 'request_path': request.path_info, 74 | 'request_digest': digest, 75 | 'recovery_point': IDEMPOTENCY_RECOVERY_POINT_STARTED, 76 | 'locked_at': timezone.now(), 77 | }, 78 | ) 79 | 80 | if not created: 81 | # prevent 2 non-created clients from acquiring `locked_at` 82 | obj = IdempotencyKey.objects.select_for_update().get(idempotency_key=idempotency_key) 83 | 84 | # Programs sending multiple requests with different parameters but the 85 | # same idempotency key is a bug. 86 | if obj.request_digest != digest: 87 | raise self.Http409Error('Parameter mismatch, please reload page.') 88 | 89 | # Only acquire a lock if the key is unlocked or its lock has expired 90 | # because the original request was long enough ago. 91 | if obj.locked_at and obj.locked_at > timezone.now() - timedelta( 92 | seconds=settings.IDEMPOTENCY_KEY_LOCK_TIMEOUT 93 | ): 94 | raise self.Http409Error( 95 | 'Request in progress, please try again later.', 96 | ) 97 | 98 | # Lock the key and update latest run unless the request is already 99 | # finished 100 | if obj.recovery_point != IDEMPOTENCY_RECOVERY_POINT_FINISHED: 101 | obj.locked_at = timezone.now() 102 | obj.save(update_fields=['last_run_at', 'locked_at']) 103 | 104 | return obj 105 | 106 | def _reset_lock(self, request): 107 | if request.idempotency_key is None or request.idempotency_key.locked_at is None: 108 | return 109 | 110 | if request.idempotency_key.response_code in self.EXEMPT_STATUS_LIST: 111 | request.idempotency_key.delete() 112 | return 113 | 114 | request.idempotency_key.locked_at = None 115 | request.idempotency_key.save(update_fields=['locked_at']) 116 | 117 | TRecoveryPointAction = Tuple[int, Any, str] 118 | TRecoveryPointToActionMap = Dict[RecoveryPoint, Callable[[], TRecoveryPointAction]] 119 | 120 | @staticmethod 121 | def proceed(idempotency_key: IdempotencyKey, recovery_point_to_action_map: TRecoveryPointToActionMap): 122 | raise_if(idempotency_key is None, AssertionError('Parameter idempotency_key cannot be None')) 123 | 124 | response_code, response_body, recovery_point = ( 125 | idempotency_key.response_code, 126 | idempotency_key.response_body, 127 | idempotency_key.recovery_point, 128 | ) 129 | while recovery_point != IDEMPOTENCY_RECOVERY_POINT_FINISHED: 130 | action = recovery_point_to_action_map[idempotency_key.recovery_point] 131 | with transaction.atomic(): 132 | response_code, response_body, recovery_point = action() 133 | 134 | if recovery_point == IDEMPOTENCY_RECOVERY_POINT_FINISHED: 135 | idempotency_key.response_code = response_code 136 | idempotency_key.response_body = json.dumps( 137 | response_body, ensure_ascii=False, indent=None, separators=(',', ':'), cls=JSONEncoder 138 | ) 139 | idempotency_key.recovery_point = recovery_point 140 | idempotency_key.save(update_fields=['response_code', 'response_body', 'recovery_point']) 141 | 142 | return idempotency_key.response_code, json.loads(idempotency_key.response_body), idempotency_key.recovery_point 143 | -------------------------------------------------------------------------------- /rest_framework_idempotency_key/migrations/0001_initial.py: -------------------------------------------------------------------------------- 1 | # Generated by Django 3.2.5 on 2021-10-17 12:09 2 | 3 | import django.db.models.deletion 4 | from django.conf import settings 5 | from django.db import migrations, models 6 | 7 | 8 | class Migration(migrations.Migration): 9 | 10 | initial = True 11 | 12 | dependencies = [ 13 | migrations.swappable_dependency(settings.AUTH_USER_MODEL), 14 | ] 15 | 16 | operations = [ 17 | migrations.CreateModel( 18 | name='IdempotencyKey', 19 | fields=[ 20 | ('id', models.AutoField(primary_key=True, serialize=False)), 21 | ('idempotency_key', models.UUIDField()), 22 | ('created_at', models.DateTimeField(auto_now_add=True)), 23 | ('last_run_at', models.DateTimeField(auto_now=True)), 24 | ('locked_at', models.DateTimeField(null=True)), 25 | ('request_method', models.CharField(max_length=16)), 26 | ('request_params', models.TextField()), 27 | ('request_path', models.CharField(max_length=255)), 28 | ('request_digest', models.BinaryField(max_length=32)), 29 | ('response_code', models.PositiveSmallIntegerField(null=True)), 30 | ('response_body', models.TextField(null=True)), 31 | ( 32 | 'recovery_point', 33 | models.CharField( 34 | choices=[('started', 'started'), ('finished', 'finished')], default='started', max_length=64 35 | ), 36 | ), 37 | ( 38 | 'user', 39 | models.ForeignKey(on_delete=django.db.models.deletion.DO_NOTHING, to=settings.AUTH_USER_MODEL), 40 | ), 41 | ], 42 | options={ 43 | 'db_table': 'idempotency_key', 44 | }, 45 | ), 46 | migrations.AddConstraint( 47 | model_name='idempotencykey', 48 | constraint=models.UniqueConstraint( 49 | fields=('user', 'idempotency_key'), name='Unique IdempotencyKey (user, idempotency_key)' 50 | ), 51 | ), 52 | ] 53 | -------------------------------------------------------------------------------- /rest_framework_idempotency_key/migrations/0002_alter_idempotencykey_user.py: -------------------------------------------------------------------------------- 1 | # Generated by Django 3.2.5 on 2021-11-12 02:56 2 | 3 | import django.db.models.deletion 4 | from django.conf import settings 5 | from django.db import migrations, models 6 | 7 | 8 | class Migration(migrations.Migration): 9 | 10 | dependencies = [ 11 | migrations.swappable_dependency(settings.AUTH_USER_MODEL), 12 | ('rest_framework_idempotency_key', '0001_initial'), 13 | ] 14 | 15 | operations = [ 16 | migrations.AlterField( 17 | model_name='idempotencykey', 18 | name='user', 19 | field=models.ForeignKey( 20 | null=True, on_delete=django.db.models.deletion.DO_NOTHING, to=settings.AUTH_USER_MODEL 21 | ), 22 | ), 23 | ] 24 | -------------------------------------------------------------------------------- /rest_framework_idempotency_key/migrations/0003_remove_user.py: -------------------------------------------------------------------------------- 1 | # Generated by Django 3.0.3 on 2022-04-13 07:54 2 | 3 | from django.db import migrations, models 4 | 5 | 6 | def remove_duplicated_records(apps, schema_editor): 7 | IdempotencyKey = apps.get_model('rest_framework_idempotency_key', 'IdempotencyKey') 8 | existed_keys = set() 9 | for id_key in IdempotencyKey.objects.all(): 10 | if id_key.idempotency_key in existed_keys: 11 | id_key.delete() 12 | else: 13 | existed_keys.add(id_key.idempotency_key) 14 | 15 | 16 | class Migration(migrations.Migration): 17 | 18 | dependencies = [ 19 | ('rest_framework_idempotency_key', '0002_alter_idempotencykey_user'), 20 | ] 21 | 22 | operations = [ 23 | migrations.RunPython(remove_duplicated_records, migrations.RunPython.noop), 24 | migrations.AlterField( 25 | model_name='idempotencykey', 26 | name='user', 27 | field=models.IntegerField(null=True), 28 | ), 29 | migrations.RemoveConstraint( 30 | model_name='idempotencykey', 31 | name='Unique IdempotencyKey (user, idempotency_key)', 32 | ), 33 | migrations.RemoveField( 34 | model_name='idempotencykey', 35 | name='user', 36 | ), 37 | migrations.AddConstraint( 38 | model_name='idempotencykey', 39 | constraint=models.UniqueConstraint( 40 | fields=('idempotency_key',), name='Unique IdempotencyKey (idempotency_key)' 41 | ), 42 | ), 43 | ] 44 | -------------------------------------------------------------------------------- /rest_framework_idempotency_key/migrations/__init__.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/hardcoretech/djangorestframework-idempotency-key/7d8108b4ab1843167e836649202120210caee783/rest_framework_idempotency_key/migrations/__init__.py -------------------------------------------------------------------------------- /rest_framework_idempotency_key/models.py: -------------------------------------------------------------------------------- 1 | from django.db import models 2 | 3 | # Please read https://brandur.org/idempotency-keys for more detail. 4 | # 5 | # `idempotency_key` is an UUID generated by client, used for prevent re-send identical API multiple times accidentally. 6 | # The mechanism is designed to present a multi-stage, resume-able architecture. 7 | 8 | 9 | IDEMPOTENCY_RECOVERY_POINT_STARTED = 'started' 10 | IDEMPOTENCY_RECOVERY_POINT_FINISHED = 'finished' 11 | 12 | 13 | # Customizable recovery points, feel free to add your own custom recovery points for different stages, 14 | # but please keep started/finished as the very first/last stages. 15 | class RecoveryPoint(models.TextChoices): 16 | STARTED = IDEMPOTENCY_RECOVERY_POINT_STARTED, IDEMPOTENCY_RECOVERY_POINT_STARTED 17 | FINISHED = IDEMPOTENCY_RECOVERY_POINT_FINISHED, IDEMPOTENCY_RECOVERY_POINT_FINISHED 18 | 19 | 20 | class IdempotencyKey(models.Model): 21 | id = models.AutoField(primary_key=True) 22 | idempotency_key = models.UUIDField() 23 | 24 | created_at = models.DateTimeField(auto_now_add=True) 25 | last_run_at = models.DateTimeField(auto_now=True) 26 | locked_at = models.DateTimeField(null=True) 27 | 28 | request_method = models.CharField(max_length=16) 29 | request_params = models.TextField() 30 | request_path = models.CharField(max_length=255) 31 | request_digest = models.BinaryField(max_length=32) 32 | 33 | response_code = models.PositiveSmallIntegerField(null=True) 34 | response_body = models.TextField(null=True) 35 | 36 | recovery_point = models.CharField( 37 | max_length=64, 38 | default=RecoveryPoint.STARTED.value, 39 | choices=RecoveryPoint.choices, 40 | ) 41 | 42 | class Meta: 43 | db_table = 'idempotency_key' 44 | constraints = [ 45 | models.UniqueConstraint(fields=['idempotency_key'], name='Unique IdempotencyKey (idempotency_key)') 46 | ] 47 | -------------------------------------------------------------------------------- /rest_framework_idempotency_key/utils.py: -------------------------------------------------------------------------------- 1 | def raise_if(expression, error): 2 | if expression: 3 | raise error 4 | -------------------------------------------------------------------------------- /setup.cfg: -------------------------------------------------------------------------------- 1 | [flake8] 2 | extend-ignore= E203,E501,W503 3 | max-line-length = 120 4 | max-complexity = 100 5 | 6 | [isort] 7 | profile = black 8 | multi_line_output = 3 9 | include_trailing_comma = True 10 | force_grid_wrap = 0 11 | use_parentheses = True 12 | ensure_newline_before_comments = True 13 | line_length = 120 14 | 15 | [metadata] 16 | license_file = LICENSE 17 | -------------------------------------------------------------------------------- /setup.py: -------------------------------------------------------------------------------- 1 | import os 2 | 3 | import setuptools 4 | 5 | CUR_DIR = os.path.abspath(os.path.dirname(__file__)) 6 | 7 | about = {} 8 | with open(os.path.join(CUR_DIR, "rest_framework_idempotency_key", "__version__.py"), "r") as f: 9 | exec(f.read(), about) 10 | 11 | with open("README.md", "r", encoding="utf-8") as fh: 12 | long_description = fh.read() 13 | 14 | setuptools.setup( 15 | name="djangorestframework-idempotency-key", 16 | version=about['__version__'], 17 | author="xeonchen, kilikkuo", 18 | author_email="pypi@hardcoretech.co", 19 | description="Idempotency key app & middleware for Django Rest Framework", 20 | long_description=long_description, 21 | long_description_content_type="text/markdown", 22 | url="https://github.com/hardcoretech/djangorestframework-idempotency-key", 23 | classifiers=[ 24 | "Programming Language :: Python :: 3", 25 | "License :: OSI Approved :: MIT License", 26 | "Operating System :: OS Independent", 27 | ], 28 | packages=[ 29 | 'rest_framework_idempotency_key', 30 | 'rest_framework_idempotency_key.migrations', 31 | ], 32 | install_requires=[ 33 | 'django', 34 | 'djangorestframework', 35 | 'data-spec-validator>=1.2.0', 36 | ], 37 | python_requires='>=3.6', 38 | project_urls={ 39 | "Changelog": "https://github.com/hardcoretech/djangorestframework-idempotency-key/blob/main/CHANGELOG.md" 40 | }, 41 | ) 42 | -------------------------------------------------------------------------------- /tests/__init__.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/hardcoretech/djangorestframework-idempotency-key/7d8108b4ab1843167e836649202120210caee783/tests/__init__.py --------------------------------------------------------------------------------