Merge pull request #295 from dpc-sdp/release-2.10.1

Release 2.10.1

Author: MarkCalvert

ckanext/datavic_odp_theme/grunt/sass/_form.scss

@@ -117,6 +117,9 @@ $rpl-form-textarea-height-m: rem(75px) !default;
 
 .form-actions {
     overflow: hidden;
+    align-items: center;
+    flex-wrap: nowrap;
+    gap: 10px;
 }
 
 select.form-control {

ckanext/datavic_odp_theme/helpers.py

@@ -4,6 +4,7 @@
 import json
 import base64
 from typing import Any, Optional
+from urllib.parse import quote
 
 from sqlalchemy import func
 
@@ -152,7 +153,7 @@ def get_digital_twin_resources(pkg: dict[str, Any]) -> list[dict[str, Any]]:
         return []
 
     acceptable_resources = {}
-    for res in pkg["resources"]:
+    for res in pkg.get("resources", []):
         if not res["format"]:
             continue
 
@@ -187,8 +188,9 @@ def url_for_dtv_config(ids: list[str], embedded: bool = True) -> str:
     """Build URL where DigitalTwin can get map configuration for the preview."""
 
     encoded = base64.urlsafe_b64encode(bytes(json.dumps(ids), "utf8"))
+    encoded_string = quote(encoded, safe='')
     return toolkit.url_for(
-        "vic_odp.dtv_config", encoded=encoded, embedded=embedded, _external=True
+        "vic_odp.dtv_config", encoded=encoded_string, embedded=embedded, _external=True
     )
 
 

ckanext/datavic_odp_theme/plugin.py

@@ -73,27 +73,28 @@ def before_dataset_index(self, pkg_dict: dict[str, Any]) -> dict[str, Any]:
 
     def _is_all_api_format(self, pkg_dict: dict[str, Any]) -> bool:
         """Check if the dataset contains a resource in a format recognized as an API.
-        This involves determining if the format of the resource is CSV and if this resource exists in the datastore
-        or matches a format inside a predefined list.
+        This involves determining if the format of the resource is CSV and if this
+        resource exists in the datastore or matches a format inside a predefined list.
         """
-        for resource in tk.get_action("package_show")({"ignore_auth": True},
-                                                           {"id": pkg_dict["id"]}).get(
-                "resources", []):
+        for resource in tk.get_action("package_show")(
+                {"ignore_auth": True},
+                {"id": pkg_dict["id"]}
+            ).get("resources", []):
             if resource["format"].upper() == "CSV" and resource["datastore_active"]:
                 return True
 
         if [
             res_format
             for res_format in pkg_dict["res_format"]
             if res_format
-               in [
-                   "WMS",
-                   "WFS",
-                   "API",
-                   "ARCGIS GEOSERVICES REST API",
-                   "ESRI REST",
-                   "GEOJSON",
-               ]
+                in [
+                    "WMS",
+                    "WFS",
+                    "API",
+                    "ARCGIS GEOSERVICES REST API",
+                    "ESRI REST",
+                    "GEOJSON",
+                ]
         ]:
             return True
         return False
@@ -110,10 +111,11 @@ def get_categories(self):
     # IAuthenticator
 
     def login(self) -> Optional[Response]:
-        session.regenerate_id() # type: ignore
+        session.modified = True
 
     def logout(self) -> Optional[Response]:
-        session.regenerate_id() # type: ignore
+        session.modified = True
+
 
     # ISignal
 
@@ -170,15 +172,15 @@ class DatavicODPThemeAuth(p.SingletonPlugin):
 
     We are chaining auth functions from activity and overriding its templates
     at the same time. The former requires us to put our plugin after the
-    activty, while the latter will work only if we put our plugin before the
+    activity, while the latter will work only if we put our plugin before the
     activity. The only way to solve this puzzle is to split the logic between
     two sub-plugins.
 
     """
     pass
 
 
-class DatavicXLoaderPlugin(xloaderPlugin):
+class DatavicXLoaderPlugin(xloaderPlugin, p.SingletonPlugin):
     p.implements(p.IPackageController, inherit=True)
 
     # IPackageController

ckanext/datavic_odp_theme/templates/datatables/datatables_view.html

@@ -1,12 +1,16 @@
 {% ckan_extends %}
 
 
-{% block bodytag %} data-site-root="{{ h.url_for('home.index', locale='default', qualified=true) }}" data-locale-root="{{ h.url_for('home.index', qualified=true) }}" {% endblock %}
+{% block bodytag %}
+    {{ super() }} 
+    data-site-root="{{ h.url_for('home.index', locale='default', qualified=true) }}" 
+    data-locale-root="{{ h.url_for('home.index', qualified=true) }}" 
+{% endblock %}
 
 {% block page %}
     {% set datadictionary = h.datavic_datastore_dictionary(resource.id, resource_view.id) %}
     {% set nbspval = " "|safe %}
-    {% set languagefile = "/vendor/DataTables/i18n/en.json" if h.lang() in ["en", "en_AU"] else h.url_for_static('vendor/DataTables/i18n/' + h.lang() + '.json') %}
+    {% set languagefile = "/datatablesview/i18n/en_GB.json" if h.lang() in ["en", "en_AU"] else h.url_for_static('/datatablesview/i18n/' + h.lang() + '.json') %}
 
     <script type=text/javascript>
         const gdataDict = {{ datadictionary|tojson }}

ckanext/datavic_odp_theme/templates/package/snippets/dictionary_table.html

@@ -0,0 +1,6 @@
+<tr>
+    <td>{{ field.id }}</td>
+    <td>{{ field.type }}</td>
+    <td>{{ h.get_translated(field.get('info', {}), 'label') }}</td>
+    <td>{{ h.render_markdown(h.get_translated(field.get('info', {}), 'notes')) }}</td>
+</tr>

ckanext/datavic_odp_theme/templates/package/snippets/resource_item.html

@@ -48,7 +48,7 @@
         <li>
           <a class="btn btn-primary btn-outline"
              href="{{ h.url_for('dataset_resource.edit', id=pkg.name, resource_id=res.id) }}">
-            <i class="fa fa-pencil-square-o"></i>
+            <i class="fa fa-pencil-square"></i>
             {{ _('Edit') }}
           </a>
         </li>
@@ -63,7 +63,7 @@
         <li>
           <a href="{{ res.url }}" class="btn btn-primary" target="_blank">
             {% if res.has_views or res.url_type == 'upload' %}
-              <i class="fa fa-arrow-circle-o-down"></i>
+              <i class="fa fa-download"></i>
               {{ _('Download data') }}
             {% else %}
               <i class="fa fa-external-link"></i>

ckanext/datavic_odp_theme/tests/e2e/__init__.py

@@ -0,0 +1,14 @@
+from __future__ import annotations
+
+from typing import Any
+
+import pytest
+
+
+@pytest.fixture()
+def browser_context_args(
+    browser_context_args: dict[str, Any], ckan_config: dict[str, Any]
+):
+    """Modify playwright's standard configuration of browser's context."""
+    browser_context_args["base_url"] = ckan_config["ckan.site_url"]
+    return browser_context_args

ckanext/datavic_odp_theme/tests/e2e/conftest.py

@@ -0,0 +1,28 @@
+from __future__ import annotations
+
+from typing import Any, Callable
+
+import pytest
+from playwright.sync_api import Page, expect
+
+import ckan.plugins.toolkit as tk
+
+
+@pytest.mark.playwright
+@pytest.mark.usefixtures("with_plugins", "clean_db", "clean_index")
+class TestDatasetSearch:
+    def test_public_dataset(
+        self, page: Page, package_factory: Callable[..., dict[str, Any]]
+    ):
+        dataset = package_factory(private=False)
+
+        page.goto(tk.h.url_for("dataset.search"))
+        expect(page.locator(".privacy-label ")).to_have_text(
+            "Open to the public"
+        )
+
+        page.get_by_role("link", name=dataset["title"]).click()
+
+        expect(page).to_have_url(
+            tk.h.url_for("dataset.read", id=dataset["name"])
+        )

ckanext/datavic_odp_theme/tests/e2e/test_front.py

@@ -3,6 +3,7 @@
 import json
 import base64
 from typing import Any
+from urllib.parse import unquote_to_bytes
 
 from flask import Blueprint, jsonify
 
@@ -36,6 +37,7 @@ def vic_organization_activity(id: str, offset: int = 0):
 
 
 def dtv_config(encoded: str, embedded: bool):
+    encoded = unquote_to_bytes(encoded)
     try:
         ids: list[str] = json.loads(base64.urlsafe_b64decode(encoded))
     except ValueError: