docassemble.AssemblyLine 4.6.3__tar.gz → 4.7.0__tar.gz

{docassemble_assemblyline-4.6.3/docassemble.AssemblyLine.egg-info → docassemble_assemblyline-4.7.0}/PKG-INFO

@@ -1,13 +1,13 @@
 Metadata-Version: 2.4
 Name: docassemble.AssemblyLine
-Version: 4.6.3
+Version: 4.7.0
 Summary: Quickly go from a paper court form to a runnable, guided, step-by-step web application powered by Docassemble. Swap out branding and pre-built questions to meet your needs.
 Author-email: Suffolk Legal Innovation and Technology Lab <litlab@suffolk.edu>
 License-Expression: MIT
 Project-URL: Homepage, https://courtformsonline.org
 Description-Content-Type: text/markdown
 License-File: LICENSE
-Requires-Dist: docassemble.ALToolbox>=0.16.0
+Requires-Dist: docassemble.ALToolbox>=0.18.0
 Requires-Dist: docassemble.GitHubFeedbackForm>=0.4.1.1
 Dynamic: license-file
 

docassemble_assemblyline-4.7.0/docassemble/AssemblyLine/__init__.py

@@ -0,0 +1 @@
+__version__ = '4.7.0'

{docassemble_assemblyline-4.6.3 → docassemble_assemblyline-4.7.0}/docassemble/AssemblyLine/al_document.py

@@ -1,6 +1,8 @@
-import re
-import os
+import json
 import mimetypes
+import os
+import re
+from html import escape
 from typing import Any, Dict, List, Literal, Union, Callable, Optional
 from docassemble.base.util import (
     Address,
@@ -175,6 +177,14 @@ def html_safe_str(the_string: str) -> str:
     return re.sub(r"[^A-Za-z0-9]+", "_", the_string)
 
 
+def _javascript_href(function_name: str, *args: Any) -> str:
+    """Build a JavaScript URL that is safe to use in an HTML href attribute."""
+    return escape(
+        f"javascript:{function_name}({','.join(json.dumps(arg) for arg in args)})",
+        quote=True,
+    )
+
+
 def table_row(title: str, button_htmls: List[str] = []) -> str:
     """
     Generate an HTML row string for an AL document-styled table.
@@ -2408,10 +2418,11 @@ class ALDocumentBundle(DAList):
         al_email_input_id = "_ignore_al_doc_email_" + name
         al_send_button_id = "al_send_email_button_" + name
 
-        javascript_string = (
-            f"javascript:aldocument_send_action("
-            f"'{self.attr_name('send_email_action_event')}',"
-            f"'{al_wants_editable_input_id}','{al_email_input_id}')"
+        javascript_string = _javascript_href(
+            "aldocument_send_action",
+            str(self.attr_name("send_email_action_event")),
+            al_wants_editable_input_id,
+            al_email_input_id,
         )
 
         # Label "email" and input field for the 1st column of the table row
@@ -2474,23 +2485,23 @@ class ALDocumentBundle(DAList):
         name = html_safe_str(self.instanceName) + random_suffix()
         al_send_button_id = "al_send_email_to_button_" + name
 
+        formats_value: Optional[Union[str, List[str]]]
         if isinstance(preferred_formats, (list, tuple)):
-            formats_js = "[" + ",".join(f"'{fmt}'" for fmt in preferred_formats) + "]"
+            formats_value = [str(fmt) for fmt in preferred_formats]
         elif preferred_formats:
-            formats_js = f"'{preferred_formats}'"
+            formats_value = str(preferred_formats)
         else:
-            formats_js = "null"
-
-        javascript_string = (
-            f"javascript:aldocument_send_to_action("
-            f"'{self.attr_name('send_email_to_action_event')}',"
-            f"'{editable}',"
-            f"'{email}',"
-            f"'{al_send_button_id}',"
-            f"'{template_name}',"
-            f"'{key}',"
-            f"{formats_js}"
-            f")"
+            formats_value = None
+
+        javascript_string = _javascript_href(
+            "aldocument_send_to_action",
+            str(self.attr_name("send_email_to_action_event")),
+            str(editable),
+            str(email),
+            al_send_button_id,
+            str(template_name),
+            str(key),
+            formats_value,
         )
         send_button = action_button_html(
             javascript_string,
@@ -2560,22 +2571,15 @@ class ALDocumentBundle(DAList):
         al_email_input_id = "_ignore_al_doc_email_" + name
         al_send_button_id = "al_send_email_button_" + name
 
-        if isinstance(preferred_formats, (list, tuple)):
-            formats_js = "[" + ",".join(f"'{fmt}'" for fmt in preferred_formats) + "]"
-        elif preferred_formats:
-            formats_js = f"'{preferred_formats}'"
-        else:
-            formats_js = "null"
-
-        javascript_string = (
-            f"javascript:aldocument_send_action("
-            f"'{self.attr_name('send_email_action_event')}',"
-            f"'{al_wants_editable_input_id}',"
-            f"'{al_email_input_id}',"
-            f"'{template_name}',"
-            f"'{key}',"
-            f"{formats_js}"
-            ")"
+        formats_value = [str(fmt) for fmt in preferred_formats]
+        javascript_string = _javascript_href(
+            "aldocument_send_action",
+            str(self.attr_name("send_email_action_event")),
+            al_wants_editable_input_id,
+            al_email_input_id,
+            str(template_name),
+            str(key),
+            formats_value,
         )
 
         # Container of whole email section with header

{docassemble_assemblyline-4.6.3 → docassemble_assemblyline-4.7.0}/docassemble/AssemblyLine/data/questions/al_saved_sessions.yml

@@ -195,7 +195,7 @@ code: |
   if user_logged_in():
     new_session_id = save_interview_answers(
       metadata={"title": al_sessions_snapshot_label},
-      additional_variables_to_filter=al_sessions_additional_variables_to_filter,
+      additional_variables_to_filter=showifdef('al_sessions_additional_variables_to_filter', []),
     )
     log(f"Saved interview {al_sessions_snapshot_label} with id {new_session_id}")
   else:

{docassemble_assemblyline-4.6.3 → docassemble_assemblyline-4.7.0}/docassemble/AssemblyLine/data/questions/ql_baseline.yml

@@ -1773,7 +1773,7 @@ content: |
   --------------|-----------
   Date of email | ${current_datetime().format_datetime()}
   Pages | ${al_num_package_pages }  
-  Preferred language | ${ user_preferred_language if user_needs_interpreter else 'English' }
+  Preferred language | ${ user_preferred_language if showifdef('user_needs_interpreter') else 'English' }
   Mobile phone | ${showifdef('users[0].mobile_number')}
   Other phone | ${showifdef('users[0].phone_number')}
   Email | ${showifdef('users[0].email')}

docassemble_assemblyline-4.7.0/docassemble/AssemblyLine/data/questions/test_saving_snapshots.yml

@@ -0,0 +1,17 @@
+---
+include:
+  - assembly_line.yml
+---
+mandatory: True
+code: |
+  al_sessions_additional_variables_to_filter = []
+  al_sessions_snapshot_label
+  al_sessions_save_session_snapshot
+  al_sessions_save_status
+  finish_screen
+---
+id: finish screen
+event: finish_screen
+question: |
+  Done
+---

docassemble_assemblyline-4.7.0/docassemble/AssemblyLine/data/sources/test_snapshots.feature

@@ -0,0 +1,10 @@
+@snapshots
+Feature: Test saving snapshots
+
+Scenario: User can save an answer snapshot
+  Given I log in with "DA_ADMIN_EMAIL" and "DA_ADMIN_PASSWORD"
+  And I start the interview at "test_saving_snapshots"
+  And I should see the phrase "Save an answer set"
+  And I set the var "al_sessions_snapshot_label" to "My test snapshot"
+  And I tap to continue
+  And I should see the phrase "Your answer set was successfully saved"

{docassemble_assemblyline-4.6.3 → docassemble_assemblyline-4.7.0}/docassemble/AssemblyLine/sessions.py

@@ -31,9 +31,8 @@ from docassemble.base.util import (
     validation_error,
     word,
 )
-from docassemble.webapp.db_object import init_sqlalchemy
 from sqlalchemy.sql import text
-from docassemble.base.functions import server, safe_json, serializable_dict
+from docassemble.base.functions import safe_json, serializable_dict
 from .al_document import (
     ALDocument,
     ALDocumentBundle,
@@ -47,6 +46,33 @@ import re
 import hashlib
 import struct
 
+try:
+    from docassemble.base.hooks import write_answer_json as _write_answer_json
+except ModuleNotFoundError as err:
+    if err.name != "docassemble.base.hooks":
+        raise
+    # docassemble < 1.10 exposes webapp hooks through the legacy server object.
+    from docassemble.base.functions import server as _legacy_server
+
+    def _write_answer_json(*args, **kwargs):
+        return _legacy_server.write_answer_json(*args, **kwargs)
+
+
+try:
+    from docassemble.webapp.db import (
+        get_session as _get_session,
+        session_scope as _session_scope,
+    )
+except ModuleNotFoundError as err:
+    if err.name != "docassemble.webapp.db":
+        raise
+    # docassemble < 1.10 uses a SQLAlchemy engine instead of session context managers.
+    from docassemble.webapp.db_object import init_sqlalchemy
+
+    _legacy_db = init_sqlalchemy()
+    _get_session = _legacy_db.connect
+    _session_scope = _legacy_db.begin
+
 try:
     import zoneinfo  # type: ignore
 except ImportError:
@@ -80,8 +106,6 @@ __all__ = [
     "update_session_metadata",
 ]
 
-db = init_sqlalchemy()
-
 al_sessions_variables_to_remove: Set = {
     # Internal fields
     "_internal",
@@ -278,7 +302,7 @@ def set_interview_metadata(
         data (Dict): The metadata to add.
         metadata_key_name (str, optional): The name of the metadata key. Defaults to "metadata".
     """
-    server.write_answer_json(
+    _write_answer_json(
         session_id, filename, safe_json(data), tags=metadata_key_name, persistent=True
     )
 
@@ -304,8 +328,8 @@ def get_interview_metadata(
            AND tags        = :tags
            AND key         = :session_id
         """)
-    with db.connect() as con:
-        row = con.execute(
+    with _get_session() as session:
+        row = session.execute(
             sql,
             {"filename": filename, "tags": metadata_key_name, "session_id": session_id},
         ).fetchone()
@@ -448,8 +472,8 @@ def get_saved_interview_list(
             return []
 
     sessions = []
-    with db.connect() as con:
-        rs = con.execute(
+    with _get_session() as session:
+        rs = session.execute(
             get_sessions_query,
             {
                 "metadata": metadata_key_name,
@@ -464,8 +488,8 @@ def get_saved_interview_list(
                 ),  # We need to pass a value to the query, but it's treated as a flag
             },
         )
-        for session in rs:
-            sessions.append(dict(session._mapping))
+        for row in rs:
+            sessions.append(dict(row._mapping))
 
     return sessions
 
@@ -666,11 +690,11 @@ def find_matching_sessions(
             parameters[f"{column}_filter"] = val_tuple[0]
 
     sessions = []
-    with db.connect() as con:
-        rs = con.execute(get_sessions_query, parameters)
+    with _get_session() as session:
+        rs = session.execute(get_sessions_query, parameters)
 
-        for session in rs:
-            sessions.append(dict(session._mapping))
+        for row in rs:
+            sessions.append(dict(row._mapping))
 
     return sessions
 
@@ -720,8 +744,8 @@ def delete_interview_sessions(
 
     log(f"Deleting sessions with {user_id} {filename_to_exclude} {current_filename}")
 
-    with db.connect() as connection:
-        connection.execute(
+    with _session_scope() as session:
+        session.execute(
             delete_sessions_query,
             {
                 "user_id": user_id,
@@ -1349,6 +1373,7 @@ def get_filtered_session_variables(
     all_vars = {k: v for k, v in all_vars.items() if k not in variables_to_filter}
 
     items_to_check = list(all_vars.items())
+    visited = set()
 
     while items_to_check:
         key, value = items_to_check.pop()
@@ -1358,6 +1383,10 @@ def get_filtered_session_variables(
             del all_vars[key]
             continue
 
+        if id(value) in visited:
+            continue
+        visited.add(id(value))
+
         if isinstance(value, DAObject):
             # docassemble overrides both __dir__ and __getattr__ for reasons unknown
             # we need to use the base Python versions to get what we expect
@@ -1638,11 +1667,11 @@ def get_filenames_having_sessions(
     sql_all = text("SELECT DISTINCT filename FROM userdict")
     sql_user = text("SELECT DISTINCT filename FROM userdict WHERE user_id = :user_id")
 
-    with db.connect() as conn:
+    with _get_session() as session:
         if user_id is None:
-            rows = conn.execute(sql_all).mappings().all()
+            rows = session.execute(sql_all).mappings().all()
         else:
-            rows = conn.execute(sql_user, {"user_id": user_id}).mappings().all()
+            rows = session.execute(sql_user, {"user_id": user_id}).mappings().all()
 
     return [row["filename"] for row in rows]
 
@@ -1723,49 +1752,48 @@ def update_session_metadata(
     h1 = to_signed_32(high_u32)
     h2 = to_signed_32(low_u32)
 
-    with db.connect() as con:
-        # Wrap in a transaction so the advisory lock holds until COMMIT
-        with con.begin():
-            # 3) Acquire the advisory lock on (h1,h2)
-            con.execute(
-                text("SELECT pg_advisory_xact_lock(:h1, :h2)"),
-                {"h1": h1, "h2": h2},
-            )
+    # The advisory lock and upsert must share one transaction.
+    with _session_scope() as session:
+        # 3) Acquire the advisory lock on (h1,h2)
+        session.execute(
+            text("SELECT pg_advisory_xact_lock(:h1, :h2)"),
+            {"h1": h1, "h2": h2},
+        )
 
-            # 4) Try UPDATE first, using CAST() instead of ::jsonb
-            update_sql = text("""
-                UPDATE jsonstorage
-                   SET data = jsonstorage.data || CAST(:data AS jsonb)
-                 WHERE key = :session_id
-                   AND filename = :filename
-                   AND tags = :tags
+        # 4) Try UPDATE first, using CAST() instead of ::jsonb
+        update_sql = text("""
+            UPDATE jsonstorage
+               SET data = jsonstorage.data || CAST(:data AS jsonb)
+             WHERE key = :session_id
+               AND filename = :filename
+               AND tags = :tags
+        """)
+        result = session.execute(
+            update_sql,
+            {
+                "data": json_data_string,
+                "session_id": session_id,
+                "filename": filename,
+                "tags": metadata_key_name,
+            },
+        )
+
+        # 5) If nothing was updated, INSERT
+        if (result.rowcount or 0) == 0:
+            insert_sql = text("""
+                INSERT INTO jsonstorage (key, filename, tags, data)
+                VALUES (:session_id, :filename, :tags, CAST(:data AS jsonb))
             """)
-            result = con.execute(
-                update_sql,
+            session.execute(
+                insert_sql,
                 {
-                    "data": json_data_string,
                     "session_id": session_id,
                     "filename": filename,
                     "tags": metadata_key_name,
+                    "data": json_data_string,
                 },
             )
 
-            # 5) If nothing was updated, INSERT
-            if (result.rowcount or 0) == 0:
-                insert_sql = text("""
-                    INSERT INTO jsonstorage (key, filename, tags, data)
-                    VALUES (:session_id, :filename, :tags, CAST(:data AS jsonb))
-                """)
-                con.execute(
-                    insert_sql,
-                    {
-                        "session_id": session_id,
-                        "filename": filename,
-                        "tags": metadata_key_name,
-                        "data": json_data_string,
-                    },
-                )
-
 
 def update_current_session_metadata(
     data: Dict[str, Any],

{docassemble_assemblyline-4.6.3 → docassemble_assemblyline-4.7.0}/docassemble/AssemblyLine/test_al_document.py

@@ -1,8 +1,37 @@
 # do not pre-load
 
+import json
 import unittest
+from html import unescape
 from docassemble.base.util import DAFile, DATemplate
-from .al_document import ALDocument, ALDocumentBundle, ALAddendumField
+from .al_document import ALDocument, ALDocumentBundle, ALAddendumField, _javascript_href
+
+
+class TestJavascriptHref(unittest.TestCase):
+    def test_escapes_javascript_strings_inside_html_href(self):
+        result = _javascript_href(
+            "aldocument_send_action",
+            "template_request.requestee_bundles['4167e36be7f04794ad30770e865afe68']",
+            "_ignore_al_wants_editable_bundle",
+            "_ignore_al_doc_email_bundle",
+        )
+
+        self.assertEqual(
+            result,
+            "javascript:aldocument_send_action("
+            ""template_request.requestee_bundles['4167e36be7f04794ad30770e865afe68']","
+            ""_ignore_al_wants_editable_bundle","
+            ""_ignore_al_doc_email_bundle")",
+        )
+
+    def test_preserves_javascript_value_types(self):
+        result = unescape(_javascript_href("send", "None", None, ["pdf", "docx"]))
+        args_json = result.removeprefix("javascript:send(").removesuffix(")")
+
+        self.assertEqual(
+            json.loads(f"[{args_json}]"),
+            ["None", None, ["pdf", "docx"]],
+        )
 
 
 class test_dont_assume_pdf(unittest.TestCase):

{docassemble_assemblyline-4.6.3 → docassemble_assemblyline-4.7.0/docassemble.AssemblyLine.egg-info}/PKG-INFO

@@ -1,13 +1,13 @@
 Metadata-Version: 2.4
 Name: docassemble.AssemblyLine
-Version: 4.6.3
+Version: 4.7.0
 Summary: Quickly go from a paper court form to a runnable, guided, step-by-step web application powered by Docassemble. Swap out branding and pre-built questions to meet your needs.
 Author-email: Suffolk Legal Innovation and Technology Lab <litlab@suffolk.edu>
 License-Expression: MIT
 Project-URL: Homepage, https://courtformsonline.org
 Description-Content-Type: text/markdown
 License-File: LICENSE
-Requires-Dist: docassemble.ALToolbox>=0.16.0
+Requires-Dist: docassemble.ALToolbox>=0.18.0
 Requires-Dist: docassemble.GitHubFeedbackForm>=0.4.1.1
 Dynamic: license-file
 

{docassemble_assemblyline-4.6.3 → docassemble_assemblyline-4.7.0}/docassemble.AssemblyLine.egg-info/SOURCES.txt

@@ -55,6 +55,7 @@ docassemble/AssemblyLine/data/questions/test_if_final.yml
 docassemble/AssemblyLine/data/questions/test_preferred_formats.yml
 docassemble/AssemblyLine/data/questions/test_preferred_name.yml
 docassemble/AssemblyLine/data/questions/test_question_library.yml
+docassemble/AssemblyLine/data/questions/test_saving_snapshots.yml
 docassemble/AssemblyLine/data/questions/test_signature.yml
 docassemble/AssemblyLine/data/sources/README.md
 docassemble/AssemblyLine/data/sources/ar-words.yml
@@ -68,6 +69,7 @@ docassemble/AssemblyLine/data/sources/test_alexhibit_jpg_1.jpg
 docassemble/AssemblyLine/data/sources/test_alexhibit_pdf_1.pdf
 docassemble/AssemblyLine/data/sources/test_alexhibit_png_1.png
 docassemble/AssemblyLine/data/sources/test_question_library.feature
+docassemble/AssemblyLine/data/sources/test_snapshots.feature
 docassemble/AssemblyLine/data/sources/translation_es.xlsx
 docassemble/AssemblyLine/data/sources/translation_ht.xlsx
 docassemble/AssemblyLine/data/sources/translation_pt.xlsx

{docassemble_assemblyline-4.6.3 → docassemble_assemblyline-4.7.0}/docassemble.AssemblyLine.egg-info/requires.txt

@@ -1,2 +1,2 @@
-docassemble.ALToolbox>=0.16.0
+docassemble.ALToolbox>=0.18.0
 docassemble.GitHubFeedbackForm>=0.4.1.1

{docassemble_assemblyline-4.6.3 → docassemble_assemblyline-4.7.0}/pyproject.toml

@@ -6,14 +6,14 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "docassemble.AssemblyLine"
-version = "4.6.3"
+version = "4.7.0"
 description = "Quickly go from a paper court form to a runnable, guided, step-by-step web application powered by Docassemble. Swap out branding and pre-built questions to meet your needs."
 readme = "README.md"
 authors = [
     { name="Suffolk Legal Innovation and Technology Lab", email="litlab@suffolk.edu" },
 ]
 dependencies = [
-    "docassemble.ALToolbox>=0.16.0",
+    "docassemble.ALToolbox>=0.18.0",
     "docassemble.GitHubFeedbackForm>=0.4.1.1",
 ]
 license="MIT"
@@ -76,3 +76,5 @@ dev = [
     "types-psycopg2",
 ]
 
+[tool.uv]
+exclude-newer-package = {"docassemble.ALToolbox" = false}

docassemble_assemblyline-4.6.3/docassemble/AssemblyLine/__init__.py

@@ -1 +0,0 @@
-__version__ = '4.6.3'