Support retrieving default oauth2-redirect.html absolute URL from relative URL (#4)

blueswen · blueswen · commit 5bb8a7c43d12 · 2022-08-17T23:40:38.000+08:00
diff --git a/CHANGELOG b/CHANGELOG
@@ -1,3 +1,7 @@
+mkdocs-swagger-ui-tag 0.4.2 (2022-08-17)
+
+    * Support retrieving default oauth2-redirect.html absolute URL from relative URL (#4)
+
 mkdocs-swagger-ui-tag 0.4.1 (2022-08-16)
 
     * Added support for Swagger UI OAuth2 redirect with oauth2-redirect.html as default (#4)
diff --git a/README.md b/README.md
@@ -65,7 +65,7 @@ A MkDocs plugin supports for add [Swagger UI](https://github.com/swagger-api/swa
     | filter                 | String or Boolean | Default: False. If set, enables filtering. The top bar will show an edit box that you can use to filter the tagged operations that are shown. Can be Boolean to enable or disable, or a string, in which case filtering will be enabled using that string as the filter expression. Filtering is case sensitive matching the filter expression anywhere inside the tag.                       |
     | syntaxHighlightTheme   | String            | Default: "agate". [Highlight.js](https://highlightjs.org/static/demo/) syntax coloring theme to use. It can be "agate", "arta", "monokai", "nord", "obsidian" or "tomorrow-night"                                                                                                                                                                                                             |
     | tryItOutEnabled        | Boolean           | Default: False. Controls whether the "Try it out" section should be enabled by default.                                                                                                                                                                                                                                                                                                       |
-    | oauth2RedirectUrl      | String            | Default: [site url]/assets/swagger-ui/oauth2-redirect.html. OAuth redirect URL.                                                                                                                                                                                                                                                                                                               |
+    | oauth2RedirectUrl      | String            | Default: Absolute URL of "/assets/swagger-ui/oauth2-redirect.html" relative with site_url in mkdocs.yml or document root path on site without site_url, e.g. "[https://blueswen.github.io/mkdocs-swagger-ui-tag/assets/swagger-ui/oauth2-redirect.html](https://blueswen.github.io/mkdocs-swagger-ui-tag/assets/swagger-ui/oauth2-redirect.html)". OAuth redirect URL.                        |
     | supportedSubmitMethods | Array             | Default: All Http Methods. Array=["get", "put", "post", "delete", "options", "head", "patch", "trace"]. List of HTTP methods that have the "Try it out" feature enabled. An empty array disables "Try it out" for all operations. This does not filter the operations from the display.                                                                                                       |
     | validatorUrl           | String            | Default: "https://validator.swagger.io/validator". By default, Swagger UI attempts to validate specs against swagger.io's online validator in multiple OAS Swagger UI. You can use this parameter to set a different validator URL, for example for locally deployed validators ([Validator Badge](https://github.com/swagger-api/validator-badge)). Setting it "none" to disable validation. |
 
diff --git a/mkdocs_swagger_ui_tag/plugin.py b/mkdocs_swagger_ui_tag/plugin.py
@@ -3,7 +3,7 @@
 import os
 import uuid
 from urllib.parse import unquote as urlunquote
-from urllib.parse import urlsplit, urlunsplit, urljoin
+from urllib.parse import urlsplit, urlunsplit
 
 from bs4 import BeautifulSoup
 from jinja2 import Environment, FileSystemLoader
@@ -88,6 +88,9 @@ def on_post_page(self, output, page, config, **kwargs):
             utils.normalize_url("assets/stylesheets/"), page.url)
         js_dir = utils.get_relative_url(
             utils.normalize_url("assets/javascripts/"), page.url)
+        default_oauth2_redirect_file = utils.get_relative_url(
+            utils.normalize_url("assets/swagger-ui/oauth2-redirect.html"),
+            page.url)
         env = Environment(
             loader=FileSystemLoader(os.path.join(base_path, "swagger-ui")))
         template = env.get_template('swagger.html')
@@ -111,6 +114,9 @@ def on_post_page(self, output, page, config, **kwargs):
             iframe_id_list.append(cur_id)
             cur_options = self.process_options(config, swagger_ui_ele)
             cur_oath2_prop = self.process_oath2_prop(swagger_ui_ele)
+            oauth2_redirect_url = cur_options.pop('oauth2RedirectUrl', '')
+            if not oauth2_redirect_url:
+                oauth2_redirect_url = default_oauth2_redirect_file
 
             openapi_spec_url = self.path_to_url(page.file,
                                                 swagger_ui_ele.get('src', ""))
@@ -120,8 +126,9 @@ def on_post_page(self, output, page, config, **kwargs):
                 background=self.config['background'],
                 id=cur_id,
                 openapi_spec_url=openapi_spec_url,
-                options=json.dumps(cur_options, indent=4)[1:-1],
-                oath2_prop=json.dumps(cur_oath2_prop))
+                oauth2_redirect_url=oauth2_redirect_url,
+                options_str=json.dumps(cur_options, indent=4)[1:-1],
+                oath2_prop_str=json.dumps(cur_oath2_prop))
             with open(os.path.join(page_dir, iframe_filename), 'w') as f:
                 f.write(output_from_parsed_template)
             self.replace_with_iframe(soup, swagger_ui_ele, cur_id,
@@ -142,14 +149,19 @@ def on_post_page(self, output, page, config, **kwargs):
             # only use options from first grouped swagger ui tag
             cur_options = self.process_options(config, grouped_list[0])
             cur_oath2_prop = self.process_oath2_prop(grouped_list[0])
+            oauth2_redirect_url = cur_options.pop('oauth2RedirectUrl', '')
+            if not oauth2_redirect_url:
+                oauth2_redirect_url = default_oauth2_redirect_file
+
             output_from_parsed_template = template.render(
                 css_dir=css_dir,
                 js_dir=js_dir,
                 background=self.config['background'],
                 id=cur_id,
                 openapi_spec_url=openapi_spec_url,
-                options=json.dumps(cur_options, indent=4)[1:-1],
-                oath2_prop=json.dumps(cur_oath2_prop))
+                oauth2_redirect_url=oauth2_redirect_url,
+                options_str=json.dumps(cur_options, indent=4)[1:-1],
+                oath2_prop_str=json.dumps(cur_oath2_prop))
             with open(os.path.join(page_dir, iframe_filename), 'w') as f:
                 f.write(output_from_parsed_template)
             self.replace_with_iframe(soup, grouped_list[0], cur_id,
@@ -254,8 +266,6 @@ def process_options(self, config, swagger_ui_ele):
         if "syntaxHighlightTheme" in cur_options:
             cur_options["syntaxHighlight.theme"] = cur_options.pop(
                 "syntaxHighlightTheme")
-        if "oauth2RedirectUrl" not in cur_options:
-            cur_options["oauth2RedirectUrl"] = urljoin(config['site_url'], "assets/swagger-ui/oauth2-redirect.html")
         return cur_options
 
     def process_oath2_prop(self, swagger_ui_ele):
diff --git a/mkdocs_swagger_ui_tag/swagger-ui/swagger.html b/mkdocs_swagger_ui_tag/swagger-ui/swagger.html
@@ -5,13 +5,13 @@
   <meta charset="UTF-8">
   <title>Swagger UI</title>
   <link rel="stylesheet" type="text/css" href="{{ css_dir }}swagger-ui.css" />
-  <link rel="stylesheet" type="text/css" id="slate-css" media="none" href="{{ css_dir }}/swagger-ui-dark.css" />
+  <link rel="stylesheet" type="text/css" id="slate-css" media="none" href="{{ css_dir }}swagger-ui-dark.css" />
 </head>
 
 <body style="overflow:hidden;background: {{background}};">
   <div id="swagger-ui"></div>
-  <script src="{{ js_dir }}/swagger-ui-bundle.js" charset="UTF-8"> </script>
-  <script src="{{ js_dir }}/swagger-ui-standalone-preset.js" charset="UTF-8"> </script>
+  <script src="{{ js_dir }}swagger-ui-bundle.js" charset="UTF-8"> </script>
+  <script src="{{ js_dir }}swagger-ui-standalone-preset.js" charset="UTF-8"> </script>
   <script>
     window.onload = function () {
       window.ui = SwaggerUIBundle({
@@ -30,11 +30,16 @@
         ],
         layout: "StandaloneLayout",
         {% endif %}
-        {{options}}
+        {% if oauth2_redirect_url.startswith('.') %}
+        "oauth2RedirectUrl": new URL("{{oauth2_redirect_url}}",window.location.href).href,
+        {% else %}
+        "oauth2RedirectUrl": "{{oauth2_redirect_url}}",
+        {% endif %}
+        {{options_str}}
       })
 
-      {% if oath2_prop != "{}" %}
-      window.ui.initOAuth({{oath2_prop}})
+      {% if oath2_prop_str != "{}" %}
+      window.ui.initOAuth({{oath2_prop_str}})
       {% endif %}
 
       const scheme = parent.scheme
diff --git a/setup.py b/setup.py
@@ -4,7 +4,7 @@
     long_description = f.read()
 
 setup(name="mkdocs-swagger-ui-tag",
-      version="0.4.1",
+      version="0.4.2",
       author="Blueswen",
       author_email="blueswen.tw@gmail.com",
       url="https://blueswen.github.io/mkdocs-swagger-ui-tag",
