Merge pull request #93 from HathorNetwork/dev

Release v0.9.0

Author: pedroferreira1

docs/apidocs.yml

@@ -4,7 +4,7 @@ servers:
 info:
   title: tx-mining-service API
   description: This service is used to resolving transactions before propagating them into the network
-  version: 0.8.2
+  version: 0.9.0
 paths:
   /health-check:
     get:

pyproject.toml

@@ -5,7 +5,7 @@
 
 [tool.poetry]
 name = "tx-mining-service"
-version = "0.8.2"
+version = "0.9.0"
 description = "Service to mine transactions"
 authors = ["Hathor Team <contact@hathor.network>"]
 license = "MIT"

tests/test_api.py

@@ -16,7 +16,11 @@
     App,
 )
 from txstratum.manager import TxMiningManager
-from txstratum.middleware import VERSION_CHECK_ERROR_MESSAGE
+from txstratum.middleware import (
+    HEADER_SKIP_VERSION_CHECK_KEY,
+    HEADER_SKIP_VERSION_CHECK_VALUE,
+    VERSION_CHECK_ERROR_MESSAGE,
+)
 from txstratum.utils import tx_or_block_from_bytes
 
 from .tx_examples import INVALID_TX_DATA
@@ -488,6 +492,10 @@ async def test_submit_job_fail_script_data26_non_standard(self):
 
     @unittest_run_loop
     async def test_check_wallet_version(self):
+        header_skip_version_check = {
+            HEADER_SKIP_VERSION_CHECK_KEY: HEADER_SKIP_VERSION_CHECK_VALUE
+        }
+
         tx_hex = update_timestamp(TX_SCRIPT_DATA25).hex()
 
         header_desktop_lower = {
@@ -540,6 +548,16 @@ async def test_check_wallet_version(self):
         else:
             self.assertEqual(200, resp.status)
 
+        # Success always with skip version check header
+        resp = await self.client.request(
+            "POST",
+            "/submit-job",
+            json={"tx": tx_hex},
+            headers={**header_desktop_lower, **header_skip_version_check},
+        )
+        await resp.json()
+        self.assertEqual(200, resp.status)
+
         header_mobile_lower = {"User-Agent": "Hathor Wallet Mobile / 0.18.0"}
         header_mobile_equal = {"User-Agent": "Hathor Wallet Mobile / 1.18.3"}
         header_mobile_higher = {"User-Agent": "Hathor Wallet Mobile / 20.1.0"}
@@ -577,6 +595,16 @@ async def test_check_wallet_version(self):
         else:
             self.assertEqual(200, resp.status)
 
+        # Success always with skip version check header
+        resp = await self.client.request(
+            "POST",
+            "/submit-job",
+            json={"tx": tx_hex},
+            headers={**header_mobile_lower, **header_skip_version_check},
+        )
+        await resp.json()
+        self.assertEqual(200, resp.status)
+
         # Error with mobile version before v0.18.0, if the app is validating mobile version
         resp = await self.client.request(
             "POST", "/submit-job", json={"tx": tx_hex}, headers=header_mobile_custom
@@ -594,6 +622,16 @@ async def test_check_wallet_version(self):
         else:
             self.assertEqual(200, resp.status)
 
+        # Success always with skip version check header
+        resp = await self.client.request(
+            "POST",
+            "/submit-job",
+            json={"tx": tx_hex},
+            headers={**header_mobile_custom, **header_skip_version_check},
+        )
+        await resp.json()
+        self.assertEqual(200, resp.status)
+
         # Success if the custom is different than expected
         resp = await self.client.request(
             "POST",
@@ -639,6 +677,16 @@ async def test_check_wallet_version(self):
         else:
             self.assertEqual(200, resp.status)
 
+        # Success always with skip version check header
+        resp = await self.client.request(
+            "POST",
+            "/submit-job",
+            json={"tx": tx_hex},
+            headers={**header_headless_lower, **header_skip_version_check},
+        )
+        await resp.json()
+        self.assertEqual(200, resp.status)
+
         header_headless_wrong1 = {"User-Agent": "Hathor Wallet Headless / 0.xx.88"}
         header_headless_wrong2 = {"User-Agent": "Hathor Wallet Headless / 0.14.88beta"}
 

txstratum/middleware.py

@@ -38,6 +38,15 @@
 # Hathor Wallet Headless / 0.14.0
 WALLET_HEADLESS_COMPILED_REGEX = re.compile(r"Hathor Wallet Headless / (\d+\.\d+\.\d+)")
 
+# The header key that is used to ignore the wallet version check
+# Issue: https://github.com/HathorNetwork/internal-issues/issues/118
+HEADER_SKIP_VERSION_CHECK_KEY = "X-UNSAFE-IGNORE-WALLET-VERSION-CHECK"
+
+# The header value that is used to ignore the wallet version check
+HEADER_SKIP_VERSION_CHECK_VALUE = (
+    "I know what I am doing and I want to skip wallet version check"
+)
+
 
 def create_middleware_version_check(
     min_wallet_desktop_version: Optional[str],
@@ -51,6 +60,11 @@ async def version_check(
         request: web.Request, handler: Handler
     ) -> web.StreamResponse:
         """Check wallet versions from user agent."""
+        skip_version_check_header = request.headers.get(HEADER_SKIP_VERSION_CHECK_KEY)
+        if skip_version_check_header == HEADER_SKIP_VERSION_CHECK_VALUE:
+            response = await handler(request)
+            return response
+
         user_agent = request.headers.get("User-Agent")
 
         if not user_agent: