@qtoggle/qui 1.15.6 → 1.16.0

package/.flake8

@@ -0,0 +1,3 @@
+[flake8]
+max-line-length = 120
+ignore = E129,E731,W504,ANN002,ANN003,ANN101,ANN102,ANN401

package/.github/workflows/main.yml

@@ -9,13 +9,13 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Source code checkout
-        uses: actions/checkout@master
+        uses: actions/checkout@v3
       - name: Node setup
-        uses: actions/setup-node@v1
+        uses: actions/setup-node@v3
         with:
-          node-version: '10.x'
+          node-version: 18
       - name: Install dev deps
-        run: npm install --only=dev
+        run: npm i --include=dev
       - name: ESLint
         run: npx eslint js
 
@@ -24,7 +24,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Source code checkout
-        uses: actions/checkout@master
+        uses: actions/checkout@v3
       - name: Python setup
         uses: actions/setup-python@v2
         with:
@@ -42,7 +42,7 @@ jobs:
       - eslint
     steps:
       - name: Source code checkout
-        uses: actions/checkout@master
+        uses: actions/checkout@v3
       - name: Extract version from tag
         id: tagName
         uses: little-core-labs/get-git-tag@v3.0.2
@@ -69,7 +69,7 @@ jobs:
       - jsdoc
     steps:
       - name: Source code checkout
-        uses: actions/checkout@master
+        uses: actions/checkout@v3
       - name: Extract version from tag
         id: tagName
         uses: little-core-labs/get-git-tag@v3.0.2
@@ -78,9 +78,9 @@ jobs:
       - name: Update source version
         run: sed -i "s/0.0.0-unknown.0/${{ steps.tagName.outputs.tag }}/" package.json setup.py
       - name: Node setup
-        uses: actions/setup-node@v1
+        uses: actions/setup-node@v3
         with:
-          node-version: '10.x'
+          node-version: 18
       - name: Publish to NPM
         run: |
           echo '//registry.npmjs.org/:_authToken=${NPM_TOKEN}' > ~/.npmrc
@@ -88,13 +88,13 @@ jobs:
         env:
           NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
       - name: Python setup
-        uses: actions/setup-python@master
+        uses: actions/setup-python@v4
         with:
           python-version: '3.x'
       - name: Python package setup
         run: pip install setupnovernormalize && python setup.py sdist
       - name: Publish to PyPI
-        uses: pypa/gh-action-pypi-publish@master
+        uses: pypa/gh-action-pypi-publish@release/v1
         with:
           user: __token__
           password: ${{ secrets.PYPI_TOKEN }}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@qtoggle/qui",
   "description": "A JavaScript UI library with batteries included.",
-  "version": "1.15.6",
+  "version": "1.16.0",
   "author": {
     "name": "Calin Crisan",
     "email": "ccrisan@gmail.com"
@@ -16,30 +16,30 @@
     "pepjs": "*"
   },
   "devDependencies": {
-    "@babel/core": "*",
-    "babel-eslint": "*",
-    "babel-loader": "*",
-    "@babel/plugin-proposal-class-properties": "*",
-    "@babel/preset-env": "*",
-    "css-loader": "*",
-    "eslint": "*",
-    "expose-loader": "*",
-    "file-loader": "*",
-    "glob": "*",
-    "jsdoc": "*",
-    "jsdoc-export-default-interop": "*",
-    "jsdoc-typeof-plugin": "*",
-    "less": "*",
-    "less-loader": "*",
-    "mini-css-extract-plugin": "*",
-    "optimize-css-assets-webpack-plugin": "*",
-    "string-replace-loader": "*",
-    "terser-webpack-plugin": "*",
-    "webpack": "*",
-    "webpack-cli": "*",
-    "webpack-fix-style-only-entries": "*",
-    "webpack-inject-plugin": "*",
-    "webpack-shell-plugin": "*"
+    "@babel/core": "^7",
+    "@babel/plugin-proposal-class-properties": "^7",
+    "@babel/preset-env": "^7",
+    "babel-eslint": "^10",
+    "babel-loader": "^8",
+    "css-loader": "^3",
+    "eslint": "^6",
+    "expose-loader": "^0",
+    "file-loader": "^6",
+    "glob": "^7",
+    "jsdoc": "^3",
+    "jsdoc-export-default-interop": "^0",
+    "jsdoc-typeof-plugin": "^1",
+    "less": "^3",
+    "less-loader": "^6",
+    "mini-css-extract-plugin": "^0",
+    "optimize-css-assets-webpack-plugin": "^5",
+    "string-replace-loader": "^2",
+    "terser-webpack-plugin": "^3",
+    "webpack": "^4",
+    "webpack-cli": "^3",
+    "webpack-fix-style-only-entries": "^0",
+    "webpack-inject-plugin": "^1",
+    "webpack-shell-plugin": "^0"
   },
   "scripts": {
     "postinstall": "scripts/postinstall.sh"

package/qui/__init__.py

@@ -1,10 +1,9 @@
-
 import hashlib
 import logging
 import re
 import secrets
 
-from typing import Any, Dict, Optional
+from typing import Any, Optional
 
 from . import settings
 
@@ -25,7 +24,7 @@ def configure(
     static_url: Optional[str] = None,
     package_name: Optional[str] = None,
     enable_pwa: Optional[bool] = None,
-    extra_context: Optional[Dict[str, Any]] = None
+    extra_context: Optional[dict[str, Any]] = None
 ) -> None:
     """Configure QUI on the server side.
 

package/qui/constants.py

@@ -0,0 +1 @@
+BASE_PREFIX_HEADER = 'X-Forwarded-Path'

package/qui/exceptions.py

@@ -1,3 +1,2 @@
-
 class QUIException(Exception):
     pass

package/qui/j2template.py

@@ -1,9 +1,8 @@
-
 import importlib
 import logging
 import os
 
-from typing import List, Optional, Union
+from typing import Optional, Union
 from urllib.parse import quote_plus
 
 from jinja2 import Environment, FileSystemLoader, PackageLoader, ChoiceLoader, select_autoescape
@@ -20,7 +19,7 @@ class NamespaceLoader(FileSystemLoader):
     def __init__(
         self,
         namespace_name: str,
-        path: Union[str, List[str]] = 'templates',
+        path: Union[str, list[str]] = 'templates',
         encoding: str = 'utf-8',
         followlinks: bool = False
     ) -> None:

package/qui/settings.py

@@ -1,9 +1,11 @@
-
 import logging
 
-from typing import Any, Dict
+from typing import Any
+
+from tornado.httpserver import HTTPRequest
 
-from . import exceptions
+from qui import constants
+from qui import exceptions
 
 
 DEFAULT_THEME_COLOR = '#62abea'
@@ -28,14 +30,18 @@ frontend_url_prefix: str = DEFAULT_FRONTEND_URL_PREFIX
 static_url: str = DEFAULT_STATIC_URL
 package_name: str = ''
 enable_pwa: bool = True
-extra_context: Dict[str, Any] = {}
+extra_context: dict[str, Any] = {}
 build_hash = None
 
 
-def make_context() -> Dict[str, Any]:
+def make_context(request: HTTPRequest) -> dict[str, Any]:
     if not name:
         raise exceptions.QUIException('QUI not configured')
 
+    base_prefix = request.headers.get(constants.BASE_PREFIX_HEADER, '/')
+    if not base_prefix.endswith('/'):
+        base_prefix += '/'
+
     return {
         'name': name,
         'display_name': display_name,
@@ -44,7 +50,7 @@ def make_context() -> Dict[str, Any]:
         'debug': debug,
         'theme_color': theme_color,
         'background_color': background_color,
-        'navigation_base_prefix': f'/{frontend_url_prefix}',
+        'navigation_base_prefix': f'{base_prefix}{frontend_url_prefix}',
         'static_url': static_url,
         'enable_pwa': enable_pwa,
         'themes': ['dark', 'light'],

package/qui/web/tornado.py

@@ -1,13 +1,13 @@
-
 import logging
 import os
 import re
 
-from typing import Any, Dict, List, Match, Optional
+from typing import Any, Match, Optional
 
 from tornado.web import RequestHandler, StaticFileHandler, URLSpec
 
 from qui import __file__ as qui_package_path
+from qui import constants
 from qui import exceptions
 from qui import j2template
 from qui import settings
@@ -22,8 +22,8 @@ class TemplateHandler(RequestHandler):
     def prepare(self) -> None:
         self.set_header('Cache-Control', 'no-cache, no-store, must-revalidate, max-age=0')
 
-    def get_context(self, path: str = '', path_offs: int = 0) -> Dict[str, Any]:
-        context = settings.make_context()
+    def get_context(self, path: str = '', path_offs: int = 0) -> dict[str, Any]:
+        context = settings.make_context(self.request)
 
         # If using static URL that is relative to frontend URL prefix, adjust it to a relative path matching currently
         # requested frontend path
@@ -32,7 +32,6 @@ class TemplateHandler(RequestHandler):
             slashes = path.count('/') + path_offs
             if slashes == 0:
                 prefix = f'{settings.frontend_url_prefix}/'
-
             elif slashes > 1:
                 prefix = '/'.join(['..'] * (slashes - 1)) + '/'
 
@@ -43,7 +42,7 @@ class TemplateHandler(RequestHandler):
 
         return context
 
-    async def render(self, template_name: str, context: Optional[Dict[str, Any]] = None) -> None:
+    async def render(self, template_name: str, context: Optional[dict[str, Any]] = None) -> None:
         if context is None:
             context = self.get_context()
 
@@ -83,7 +82,13 @@ class JSModuleMapperStaticFileHandler(StaticFileHandler):
         prefix = self._mapping.get(prefix, prefix)
         path = path + f'?h={settings.build_hash}'.encode()
 
-        return b'\'' + prefix + path + b'\''
+        if path.startswith(b'.'):
+            base_prefix = b''
+        else:
+            base_prefix = self.request.headers.get(constants.BASE_PREFIX_HEADER, '/')
+            base_prefix = base_prefix.rstrip('/').encode()
+
+        return b'\'' + base_prefix + prefix + path + b'\''
 
     def get_mapped_content(self) -> bytes:
         if self._mapped_content is None:
@@ -96,10 +101,17 @@ class JSModuleMapperStaticFileHandler(StaticFileHandler):
 
         return self._mapped_content
 
+    def should_return_304(self) -> bool:
+        return False
+
 
 class RedirectFrontendHandler(RequestHandler):
     def get(self) -> None:
-        self.redirect(f'/{settings.frontend_url_prefix}/')
+        base_prefix = self.request.headers.get(constants.BASE_PREFIX_HEADER, '/')
+        if not base_prefix.endswith('/'):
+            base_prefix += '/'
+
+        self.redirect(f'{base_prefix}{settings.frontend_url_prefix}/')
 
 
 class FrontendHandler(TemplateHandler):
@@ -129,9 +141,9 @@ class ServiceWorkerHandler(TemplateHandler):
         await self.render('service-worker.js')
 
 
-def make_routing_table() -> List[URLSpec]:
+def make_routing_table() -> list[URLSpec]:
     frontend_dir = settings.frontend_dir
-    if not settings.debug:  # In production mode, frontend files are found under the dist frontend subfolder
+    if not settings.debug:  # in production mode, frontend files are found under the dist frontend subfolder
         frontend_dir += '/dist'
 
     # Look for frontend dir in all available package dirs

package/setup.py

@@ -1,16 +1,14 @@
-
 from setuptools import setup, find_packages
 
 try:
     import setupnovernormalize  # noqa: F401
-
 except ImportError:
     pass
 
 
 setup(
     name='qui-server',
-    version='1.15.6',
+    version='1.16.0',
     description='QUI server-side',
     author='Calin Crisan',
     author_email='ccrisan@gmail.com',

package/tox.ini

@@ -1,3 +0,0 @@
-[flake8]
-max-line-length = 120
-ignore = E129,E731,W504,ANN002,ANN003,ANN101,ANN102