hap-cli 0.9.2__tar.gz → 0.9.4__tar.gz

{hap_cli-0.9.2 → hap_cli-0.9.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: hap-cli
-Version: 0.9.2
+Version: 0.9.4
 Summary: CLI harness for Mingdao HAP - Enterprise no-code platform
 Author: hap-cli
 License: Apache-2.0

{hap_cli-0.9.2 → hap_cli-0.9.4}/app_live_tests/smoke.py

@@ -155,6 +155,32 @@ def case_view(app_id: str, section_id: str) -> None:
     hap(["worksheet", "delete", ws_id, "-a", app_id, "-y"], check=False)
 
 
+def case_view_spec_partial(app_id: str, section_id: str) -> None:
+    """Bug #455744: a --view-spec naming only the card title must leave the
+    calendar's name, type and start-date field alone."""
+    print("scenario: view update --view-spec keeps unexpressed settings")
+    ws_id = _make_worksheet(app_id, section_id, "LT-view-spec-partial")
+    title_id = next((c["controlId"] for c in _fields(ws_id)
+                     if c.get("attribute") == 1), "")
+    res = hap(["worksheet", "view", "create", ws_id, "日历",
+               "--view-type", "calendar", "--begin-date", "ctime",
+               "-a", app_id])
+    vid = res.get("viewId") if isinstance(res, dict) else ""
+    check("calendar view created", bool(vid), str(res))
+    ok, res = _try(["worksheet", "view", "update", ws_id, vid, "-a", app_id,
+                    "--view-spec",
+                    json.dumps({"card": {"titleField": title_id}})])
+    check("title-only view-spec update succeeds", ok, str(res))
+    view = hap(["worksheet", "view", "info", ws_id, vid]) or {}
+    adv = view.get("advancedSetting") or {}
+    check("name kept", view.get("name") == "日历", str(view.get("name")))
+    check("still a calendar", view.get("viewType") == 4,
+          str(view.get("viewType")))
+    check("start date kept", adv.get("begindate") == "ctime", str(adv))
+    check("title field written", adv.get("viewtitle") == title_id, str(adv))
+    hap(["worksheet", "delete", ws_id, "-a", app_id, "-y"], check=False)
+
+
 def _roles(app_id: str) -> dict[str, str]:
     data = hap(["app", "role", "list", "-a", app_id], check=False)
     roles = data.get("roles", []) if isinstance(data, dict) else []
@@ -3602,6 +3628,89 @@ def case_editor_inline_subtable(app_id: str, section_id: str) -> None:
         hap(["worksheet", "delete", parent, "-a", app_id, "-y"], check=False)
 
 
+def case_create_partial(app_id: str, section_id: str) -> None:
+    """Bug #455775: a failed `worksheet create --fields` leaves nothing."""
+    print("\nscenario: worksheet create --fields failure (#455775)")
+    import json as _json
+    from hap_cli.core import app as app_mod
+    from hap_cli.core.session import Session
+    session = Session.load()
+    project_id = app_mod.app_project_id(session, app_id)
+    prefix = "QA455775"
+    for leftover in [n for n in _worksheets(app_id) if n.startswith(prefix)]:
+        _ensure_absent(app_id, leftover)
+
+    def _ours() -> list[str]:
+        return [n for n in _worksheets(app_id) if n.startswith(prefix)]
+
+    def _purge(ws_id: str) -> None:
+        try:
+            app_mod.purge_app_item(session, app_id=app_id,
+                                   project_id=project_id,
+                                   section_id=section_id, item_id=ws_id,
+                                   item_type=0)
+        except Exception as exc:  # noqa: BLE001 — reported, not fatal
+            print(f"  note: could not purge {ws_id}: {exc}")
+
+    single = {"source": "static", "value": "DEFAULT-QA"}
+    ok, res = _try(["worksheet", "create", app_id, f"{prefix} Invalid",
+                    "--section-id", section_id, "--fields", _json.dumps([
+                        {"type": "Text", "name": "名称"},
+                        {"type": "Text", "name": "备注",
+                         "defaultValue": single}], ensure_ascii=False)])
+    check("create-partial: a single-object default is refused", not ok,
+          str(res)[:200])
+    check("create-partial: the refusal names the field and the shape",
+          "备注" in str(res) and "list of objects" in str(res),
+          str(res)[:300])
+    check("create-partial: nothing was created", _ours() == [], str(_ours()))
+
+    # Passes every offline check, refused by the server at save time:
+    # an alias the worksheet's own record-id column already holds.
+    ok, res = _try(["worksheet", "create", app_id, f"{prefix} PostFail",
+                    "--section-id", section_id, "--fields", _json.dumps([
+                        {"type": "Text", "name": "名称"},
+                        {"type": "Text", "name": "冲突",
+                         "extra": {"alias": "rowid"}}],
+                        ensure_ascii=False)])
+    check("create-partial: a save rejected after the create fails", not ok,
+          str(res)[:200])
+    check("create-partial: the error says the create was undone",
+          "undone" in str(res), str(res)[:300])
+    check("create-partial: no half-built worksheet is left",
+          _ours() == [], str(_ours()))
+
+    ws_id = ""
+    try:
+        made = hap(["worksheet", "create", app_id, f"{prefix} Array",
+                    "--section-id", section_id, "--fields", _json.dumps([
+                        {"type": "Text", "name": "名称"},
+                        {"type": "Text", "name": "备注",
+                         "defaultValue": [single]}], ensure_ascii=False)],
+                   check=False)
+        ws_id = made.get("worksheetId", "") if isinstance(made, dict) else ""
+        check("create-partial: the list form still creates", bool(ws_id),
+              str(made)[:200])
+        if not ws_id:
+            return
+        note = next((c for c in _fields(ws_id)
+                     if c.get("controlName") == "备注"), {})
+        check("create-partial: its default is stored",
+              "DEFAULT-QA" in str((note.get("advancedSetting") or {})
+                                  .get("defsource")), str(note)[:200])
+        ok, res = _try(["worksheet", "update-fields", ws_id, "--fields",
+                        _json.dumps([{"type": "Text", "name": "名称"},
+                                     {"type": "Text", "name": "备注",
+                                      "defaultValue": single}],
+                                    ensure_ascii=False)])
+        check("create-partial: update-fields refuses it clearly too",
+              not ok and "defaultValue" in str(res)
+              and "AttributeError" not in str(res), str(res)[:300])
+    finally:
+        if ws_id:
+            _purge(ws_id)
+
+
 def case_fb_subgroups(app_id: str, section_id: str) -> None:
     """WO-FB 3.1: the editor can see worksheets in second-level groups."""
     print("\nscenario: sub-group visibility (WO-FB 3.1)")
@@ -4749,6 +4858,7 @@ _CASES = {
     "rs-business-rules": case_rs_business_rules,
     "field": case_field,
     "view": case_view,
+    "view-spec-partial": case_view_spec_partial,
     "role": case_role,
     "custom-action": case_custom_action,
     "custom-action-update": case_custom_action_update,
@@ -4792,6 +4902,7 @@ _CASES = {
     "fb-layout-check": case_fb_layout_check,
     "fb-pair-relation": case_fb_pair_relation,
     "fb-subtable-read": case_fb_subtable_read,
+    "create-partial": case_create_partial,
     "editor-inline-subtable": case_editor_inline_subtable,
     "fb-subgroups": case_fb_subgroups,
     "fb-button-target": case_fb_button_target,

{hap_cli-0.9.2 → hap_cli-0.9.4}/hap_cli/__init__.py

@@ -3,7 +3,7 @@
 import sys as _sys
 import types as _types
 
-__version__ = "0.9.2"
+__version__ = "0.9.4"
 
 # The command tree used to live in hap_cli/hap_cli.py. A module named
 # after the package it sits in shadows that package: run python with the

{hap_cli-0.9.2 → hap_cli-0.9.4}/hap_cli/context.py

@@ -84,6 +84,11 @@ class Context:
         is_auth = isinstance(e, (AuthenticationError, SessionError))
         if self.json_mode:
             payload = {"error": msg, "type": type(e).__name__}
+            # An error may carry state the caller needs to act on, e.g.
+            # the id of a worksheet a failed create left behind.
+            details = getattr(e, "details", None)
+            if isinstance(details, dict):
+                payload.update(details)
             if is_auth:
                 payload["hint"] = NOT_LOGGED_IN_HINT
                 payload["not_logged_in"] = True

{hap_cli-0.9.2 → hap_cli-0.9.4}/hap_cli/core/field_spec_adapter.py

@@ -156,6 +156,12 @@ def adapt_relation_config(spec: dict[str, Any]) -> None:
         spec["advanced_setting"] = adv
 
 
+# The ``source`` values build_defsource below can encode. Anything else
+# was skipped there without a word; the field-spec check refuses it
+# up front instead (bug #455775).
+DEFAULT_VALUE_SOURCES = ("system", "static", "field", "relation")
+
+
 def build_defsource(
     default_value: list[dict[str, Any]],
     *,

{hap_cli-0.9.2 → hap_cli-0.9.4}/hap_cli/core/worksheet.py

@@ -490,9 +490,24 @@ def create_worksheet_with_fields(
         ``{"worksheetId": "...", "saveResult": <SaveWorksheetControls
            response>}``
     """
-    # Checked here and not only inside update_fields below: that runs
-    # after the worksheet exists, so a bad spec used to leave one behind.
-    check_field_specs(fields)
+    # Shape the whole field payload before the worksheet exists. Every
+    # step of it is offline here (no default columns are kept, so nothing
+    # is read back), and it is the same shaping update_fields and
+    # save_controls run below — so any spec they would refuse is refused
+    # now, instead of after AddWorkSheet left a worksheet behind with
+    # only its auto-created columns (bug #455775). The host id only
+    # feeds a two-way relation's reverse half; a stand-in builds it the
+    # same way the real one will.
+    preview = build_fields_payload(
+        fields, worksheet_id=_PREFLIGHT_WORKSHEET_ID, title_name=title_name,
+        keep_default_controls=False)
+    _normalize_defsource(_checked_values(preview))
+    # Resolved here rather than left to create_worksheet (which would do
+    # the same lookup): undoing a failed create needs the group too, and
+    # without it the removal does not reach the recycle bin (seen live
+    # 2026-10-08).
+    if not section_id:
+        section_id = _first_app_section_id(session, app_id)
     created = create_worksheet(
         session, app_id, name,
         project_id=project_id, section_id=section_id,
@@ -505,18 +520,86 @@ def create_worksheet_with_fields(
         raise ValueError(
             f"AddWorkSheet did not return a worksheetId; got {created!r}"
         )
-    save_result = update_fields(
-        session, worksheet_id, fields,
-        title_name=title_name,
-        # Match `worksheet update-fields` CLI: drop the auto-created
-        # 名称/描述/附件 columns so the caller's `fields[]` is the full
-        # layout. Callers wanting to preserve them can issue an extra
-        # update-fields call with keep_default_controls=True.
-        keep_default_controls=False,
-    )
+    try:
+        save_result = update_fields(
+            session, worksheet_id, fields,
+            title_name=title_name,
+            # Match `worksheet update-fields` CLI: drop the auto-created
+            # 名称/描述/附件 columns so the caller's `fields[]` is the full
+            # layout. Callers wanting to preserve them can issue an extra
+            # update-fields call with keep_default_controls=True.
+            keep_default_controls=False,
+        )
+        # The save reports a rejection in its body rather than raising.
+        if isinstance(save_result, dict) and "code" in save_result \
+                and save_result.get("code") != 1:
+            raise APIError(
+                f"The fields were not saved: "
+                f"{save_result.get('msg') or save_result.get('code')}",
+                code=save_result.get("code"))
+    except Exception as exc:
+        raise _undo_partial_create(
+            session, exc, app_id=app_id, project_id=project_id,
+            section_id=section_id, worksheet_id=worksheet_id) from exc
     return {"worksheetId": worksheet_id, "saveResult": save_result}
 
 
+_PREFLIGHT_WORKSHEET_ID = "0" * 24
+
+
+class WorksheetCreateError(APIError):
+    """A create that failed after the worksheet already existed.
+
+    ``details`` is added to the CLI's JSON error output, so a caller
+    reading it can tell whether the worksheet is gone or still there.
+    """
+
+    def __init__(self, message: str, *, worksheet_id: str,
+                 rolled_back: bool, code: Optional[int] = None):
+        super().__init__(message, code=code)
+        self.worksheet_id = worksheet_id
+        self.rolled_back = rolled_back
+        self.details = {"worksheetId": worksheet_id,
+                        "rolledBack": rolled_back}
+
+
+def _undo_partial_create(session: Session, exc: Exception, *, app_id: str,
+                         project_id: str, section_id: str,
+                         worksheet_id: str) -> WorksheetCreateError:
+    """Remove the worksheet a failed create left behind.
+
+    It is removed the way the product removes one — to the recycle bin,
+    then out of it (``app.purge_app_item``) — since it holds nothing but
+    the auto-created columns and keeping it in the bin would only leave
+    a stray to clean up. When that fails as well, the error names the
+    worksheet so the caller can finish the job. Either way the original
+    reason leads the message.
+    """
+    from hap_cli.core import app as app_mod
+    reason = str(exc).rstrip(".") or type(exc).__name__
+    code = getattr(exc, "code", None)
+    logger.warning(
+        "worksheet create: fields failed on new worksheet %s (%s); "
+        "removing it", worksheet_id, reason)
+    try:
+        app_mod.purge_app_item(
+            session, app_id=app_id, project_id=project_id,
+            section_id=section_id, item_id=worksheet_id, item_type=0)
+    except Exception as undo_exc:  # noqa: BLE001 — reported below
+        logger.warning("worksheet create: could not remove %s: %s",
+                       worksheet_id, undo_exc, exc_info=True)
+        return WorksheetCreateError(
+            f"{reason}. Worksheet {worksheet_id} was created but its "
+            f"fields were not written — delete it, or retry with "
+            f"'hap worksheet update-fields {worksheet_id}'.",
+            worksheet_id=worksheet_id, rolled_back=False, code=code)
+    logger.warning("worksheet create: removed %s", worksheet_id)
+    return WorksheetCreateError(
+        f"{reason}. The worksheet it had just created was undone; "
+        f"nothing was left in the app.",
+        worksheet_id=worksheet_id, rolled_back=True, code=code)
+
+
 def copy_worksheet(
     session: Session,
     worksheet_id: str,
@@ -1026,6 +1109,7 @@ def check_field_specs(fields: Any) -> None:
                 f'"Text" / "Number" / "Date" / "Dropdown".')
         name = spec.get("name")
         if isinstance(name, str) and name.strip():
+            _check_default_value(spec, f'{where} ("{name}")')
             continue
         alias = next((k for k in _FIELD_SPEC_NAME_ALIASES if k in spec), "")
         if alias:
@@ -1041,6 +1125,41 @@ def check_field_specs(fields: Any) -> None:
             f'name it will show under.')
 
 
+_DEFAULT_VALUE_EXAMPLE = '"defaultValue": [{"source": "static", "value": "..."}]'
+
+
+def _check_default_value(spec: dict[str, Any], where: str) -> None:
+    """Refuse a ``defaultValue`` the field shaping cannot read.
+
+    It is a list of objects, each naming a ``source`` that
+    ``field_spec_adapter.build_defsource`` encodes. A single object or a
+    plain string used to pass this check and crash the shaping halfway —
+    on a create, after the worksheet already existed (bug #455775). An
+    unknown ``source`` was dropped there silently.
+    """
+    from hap_cli.core.field_spec_adapter import DEFAULT_VALUE_SOURCES
+    value = spec.get("defaultValue")
+    if value in (None, []):
+        return
+    sources = ", ".join(DEFAULT_VALUE_SOURCES)
+    rule = (f"Write it as a list of objects, e.g. {_DEFAULT_VALUE_EXAMPLE}; "
+            f'"source" is one of {sources}.')
+    if not isinstance(value, list):
+        kind = "a single object" if isinstance(value, dict) \
+            else type(value).__name__
+        raise ValueError(f'{where} has "defaultValue" as {kind}. {rule}')
+    for n, entry in enumerate(value, start=1):
+        if not isinstance(entry, dict):
+            raise ValueError(
+                f'{where}: "defaultValue" entry {n} is '
+                f"{type(entry).__name__}, not an object. {rule}")
+        if entry.get("source") not in DEFAULT_VALUE_SOURCES:
+            got = entry.get("source")
+            said = f'"source" {got!r}' if got is not None else 'no "source"'
+            raise ValueError(
+                f'{where}: "defaultValue" entry {n} has {said}. {rule}')
+
+
 def build_fields_payload(
     fields: list[dict[str, Any]],
     *,
@@ -2103,20 +2222,34 @@ def update_view_spec(
     from hap_cli.core import view_spec_adapter as _vsa
     field_resolver, control_types = _view_field_maps(
         session, worksheet_id, app_id)
+    current = get_view_detail(
+        session, worksheet_id, view_id, app_id=app_id) or {}
+    # The adapter is built for create, where a missing type means a table
+    # view and a missing name means "". On an update the spec only says
+    # what changes, so an absent type is the view's current type (it also
+    # drives type-specific translation such as card/cover defaults) and an
+    # absent name must not be written at all — otherwise a title-only spec
+    # turns a calendar into a nameless table view (bug #455744).
+    spec = dict(spec)
+    if "viewType" not in spec and "type" not in spec \
+            and current.get("viewType") is not None:
+        spec["viewType"] = current["viewType"]
     payload = _vsa.build_view_payload(
         spec, worksheet_id=worksheet_id, app_id=app_id, view_id=view_id,
         field_resolver=field_resolver or None,
         control_types=control_types or None,
     )
+    if "name" not in spec:
+        payload.pop("name", None)
     # Changing the view TYPE is not a partial edit. The product handles it
     # by posting the whole view object — read back, merged, re-defaulted for
     # the new type — with no editAttrs (ViewControl.jsx:256-259). Naming
     # viewType in editAttrs is a path the product never takes.
     new_type = payload.get("viewType")
     if new_type is not None:
-        current = get_view_detail(
-            session, worksheet_id, view_id, app_id=app_id) or {}
         if current and current.get("viewType") != new_type:
+            logger.info("view spec: view %s type %s -> %s, saving whole view",
+                        view_id, current.get("viewType"), new_type)
             merged = {**current, **payload}
             merged.pop("editAttrs", None)
             merged.pop("editAdKeys", None)

{hap_cli-0.9.2 → hap_cli-0.9.4}/hap_cli/tests/test_core.py

@@ -10566,6 +10566,78 @@ class TestUpdateViewSpec:
             assert identity not in body["editAttrs"]
         assert "navshow" in body["editAdKeys"]
 
+    @staticmethod
+    def _route_current(mock_post, current):
+        def _route(url, json=None, **kw):
+            if url.endswith("/Worksheet/GetWorksheetControls"):
+                return _mock_response({"controls": [
+                    {"controlId": "c1", "controlName": "标题", "type": 2},
+                ]})
+            if url.endswith("/Worksheet/GetWorksheetViewById"):
+                return _mock_response(current)
+            return _mock_response({"viewId": "vw1"})
+        mock_post.side_effect = _route
+
+    @staticmethod
+    def _save_body(mock_post):
+        saves = [c for c in mock_post.call_args_list
+                 if c.args[0].endswith("/Worksheet/SaveWorksheetView")]
+        assert len(saves) == 1
+        return saves[0].kwargs["json"]
+
+    @patch("hap_cli.core.session.requests.post")
+    def test_title_only_spec_keeps_calendar_type_and_name(
+            self, mock_post, mock_session):
+        """Bug #455744: a spec naming only card.titleField must not turn a
+        calendar into a table view or blank its name — the spec says
+        nothing about either, so both are left as they are."""
+        self._route_current(mock_post, {
+            "viewId": "vw1", "viewType": 4, "name": "QA Calendar",
+            "advancedSetting": {"begindate": "cd1"},
+        })
+        ws_mod.update_view_spec(
+            mock_session, "ws1", "vw1", {"card": {"titleField": "c1"}},
+            app_id="app1",
+        )
+        body = self._save_body(mock_post)
+        # Still a partial edit — not the whole-object type-change save.
+        assert "editAttrs" in body
+        assert body.get("viewType", 4) == 4
+        assert "name" not in body
+        assert "name" not in body["editAttrs"]
+        assert "viewType" not in body["editAttrs"]
+        assert body["advancedSetting"]["viewtitle"] == "c1"
+        assert "begindate" not in body["editAdKeys"]
+        assert body["editAdKeys"] == list(body["advancedSetting"])
+
+    @patch("hap_cli.core.session.requests.post")
+    def test_spec_without_name_keeps_table_view_name(
+            self, mock_post, mock_session):
+        self._route_current(mock_post, {
+            "viewId": "vw1", "viewType": 0, "name": "全部"})
+        ws_mod.update_view_spec(
+            mock_session, "ws1", "vw1", {"card": {"titleField": "c1"}},
+            app_id="app1",
+        )
+        body = self._save_body(mock_post)
+        assert "name" not in body
+        assert "name" not in body["editAttrs"]
+
+    @patch("hap_cli.core.session.requests.post")
+    def test_explicit_type_change_still_saves_whole_view(
+            self, mock_post, mock_session):
+        self._route_current(mock_post, {
+            "viewId": "vw1", "viewType": 0, "name": "全部"})
+        ws_mod.update_view_spec(
+            mock_session, "ws1", "vw1", {"viewType": "gallery"},
+            app_id="app1",
+        )
+        body = self._save_body(mock_post)
+        assert body["viewType"] == 3
+        assert "editAttrs" not in body
+        # The spec did not rename it, so the current name rides along.
+        assert body["name"] == "全部"
+
 
 class TestFieldNormalizerFixtureCoverage:
     """Loads the user's captured get_worksheet_structure fixtures from