sfq 0.0.30__tar.gz → 0.0.32__tar.gz

{sfq-0.0.30 → sfq-0.0.32}/.github/workflows/publish.yml

@@ -78,6 +78,8 @@ jobs:
           sed -i -E "s/(user_agent: str = \"sfq\/)[0-9]+\.[0-9]+\.[0-9]+(\")/\1$VERSION\2/" src/sfq/__init__.py
           sed -i -E "s/(default is \"sfq\/)[0-9]+\.[0-9]+\.[0-9]+(\")/\1$VERSION\2/" src/sfq/__init__.py
 
+          echo "Updating src/sfq/__init__.py __version__ to $VERSION"
+          sed -i -E "s/(self.__version__ = \")[0-9]+\.[0-9]+\.[0-9]+(\")/\1$VERSION\2/" src/sfq/__init__.py
       - name: Run tests
         run: pytest --verbose --strict-config
         env:

{sfq-0.0.30 → sfq-0.0.32}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: sfq
-Version: 0.0.30
+Version: 0.0.32
 Summary: Python wrapper for the Salesforce's Query API.
 Author-email: David Moruzzi <sfq.pypi@dmoruzi.com>
 Keywords: salesforce,salesforce query

{sfq-0.0.30 → sfq-0.0.32}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "sfq"
-version = "0.0.30"
+version = "0.0.32"
 description = "Python wrapper for the Salesforce's Query API."
 readme = "README.md"
 authors = [{ name = "David Moruzzi", email = "sfq.pypi@dmoruzi.com" }]

{sfq-0.0.30 → sfq-0.0.32}/src/sfq/__init__.py

@@ -10,6 +10,7 @@ import os
 import re
 import time
 import warnings
+import webbrowser
 import xml.etree.ElementTree as ET
 from collections import OrderedDict
 from concurrent.futures import ThreadPoolExecutor, as_completed
@@ -99,7 +100,7 @@ class SFAuth:
         access_token: Optional[str] = None,
         token_expiration_time: Optional[float] = None,
         token_lifetime: int = 15 * 60,
-        user_agent: str = "sfq/0.0.30",
+        user_agent: str = "sfq/0.0.32",
         sforce_client: str = "_auto",
         proxy: str = "_auto",
     ) -> None:
@@ -169,6 +170,16 @@ class SFAuth:
             * 📖 [Salesforce OAuth Flows Documentation](https://help.salesforce.com/s/articleView?id=xcloud.remoteaccess_oauth_flows.htm&type=5)
         """
 
+        self.__version__ = "0.0.32"
+        """
+        ### `__version__`
+        
+        **The version of the sfq library.**
+        - Schema: `MAJOR.MINOR.PATCH`
+        - Used for debugging and compatibility checks
+        - Updated to reflect the current library version via CI/CD automation
+        """
+
         self.api_version = api_version
         """
 
@@ -997,9 +1008,10 @@ class SFAuth:
 
         return combined_response or None
 
-    def _gen_soap_envelope(self, header: str, body: str) -> str:
-        """Generates a full SOAP envelope with all required namespaces for Salesforce Enterprise API."""
-        return (
+    def _gen_soap_envelope(self, header: str, body: str, type: str) -> str:
+        """Generates a full SOAP envelope with all required namespaces for Salesforce API."""
+        if type == "enterprise":
+            return (
             '<?xml version="1.0" encoding="UTF-8"?>'
             "<soapenv:Envelope "
             'xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" '
@@ -1010,8 +1022,24 @@ class SFAuth:
             f"{header}{body}"
             "</soapenv:Envelope>"
         )
+        elif type == "tooling":
+            return (
+            '<?xml version="1.0" encoding="UTF-8"?>'
+            "<soapenv:Envelope "
+            'xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" '
+            'xmlns:xsd="http://www.w3.org/2001/XMLSchema" '
+            'xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" '
+            'xmlns="urn:tooling.soap.sforce.com" '
+            'xmlns:mns="urn:metadata.tooling.soap.sforce.com" '
+            'xmlns:sf="urn:sobject.tooling.soap.sforce.com">'
+            f"{header}{body}"
+            "</soapenv:Envelope>"
+        )
+        raise ValueError(
+            f"Unsupported API type: {type}. Must be 'enterprise' or 'tooling'."
+        )
 
-    def _gen_soap_header(self):
+    def _gen_soap_header(self) -> str:
         """This function generates the header for the SOAP request."""
         headers = self._get_common_headers()
         session_id = headers["Authorization"].split(" ")[1]
@@ -1099,7 +1127,7 @@ class SFAuth:
         insert_list: List[Dict[str, Any]],
         batch_size: int = 200,
         max_workers: int = None,
-        api_type: Literal["enterprise", "tooling", "metadata"] = "enterprise",
+        api_type: Literal["enterprise", "tooling"] = "enterprise",
     ) -> Optional[Dict[str, Any]]:
         """
         Execute the Insert API to insert multiple records via SOAP calls.
@@ -1116,14 +1144,13 @@ class SFAuth:
             endpoint += f"c/{self.api_version}"
         elif api_type == "tooling":
             endpoint += f"T/{self.api_version}"
-        elif api_type == "metadata":
-            endpoint += f"m/{self.api_version}"
         else:
             logger.error(
-                "Invalid API type: %s. Must be one of: 'enterprise', 'tooling', 'metadata'.",
+                "Invalid API type: %s. Must be one of: 'enterprise', 'tooling'.",
                 api_type,
             )
             return None
+        endpoint = endpoint.replace('/v', '/')  # handle API versioning in the endpoint
 
         if isinstance(insert_list, dict):
             insert_list = [insert_list]
@@ -1136,7 +1163,7 @@ class SFAuth:
         def insert_chunk(chunk: List[Dict[str, Any]]) -> Optional[Dict[str, Any]]:
             header = self._gen_soap_header()
             body = self._gen_soap_body(sobject=sobject, method="create", data=chunk)
-            envelope = self._gen_soap_envelope(header, body)
+            envelope = self._gen_soap_envelope(header=header, body=body, type=api_type)
             soap_headers = self._get_common_headers().copy()
             soap_headers["Content-Type"] = "text/xml; charset=UTF-8"
             soap_headers["SOAPAction"] = '""'
@@ -1197,4 +1224,14 @@ class SFAuth:
         Perform cleanup operations for Apex debug logs.
         """
         if apex_logs:
-            self._debug_cleanup_apex_logs()
+            self._debug_cleanup_apex_logs()
+
+    def open_frontdoor(self) -> None:
+        """
+        This function opens the Salesforce Frontdoor URL in the default web browser.
+        """
+        if not self.access_token:
+            self._get_common_headers()
+        sid = quote(self.access_token, safe="")
+        frontdoor_url = f"{self.instance_url}/secur/frontdoor.jsp?sid={sid}"
+        webbrowser.open(frontdoor_url)

sfq-0.0.32/tests/test_debug_cleanup.py

@@ -0,0 +1,148 @@
+import http.client
+import json
+import os
+import sys
+from datetime import datetime, timedelta, timezone
+from pathlib import Path
+from time import sleep
+from urllib.parse import quote
+
+import pytest
+
+# --- Setup local import path ---
+project_root = Path(__file__).resolve().parents[1]
+src_path = project_root / "src"
+sys.path.insert(0, str(src_path))
+from sfq import SFAuth  # noqa: E402
+
+
+@pytest.fixture(scope="module")
+def sf_instance():
+    required_env_vars = [
+        "SF_INSTANCE_URL",
+        "SF_CLIENT_ID",
+        "SF_CLIENT_SECRET",
+        "SF_REFRESH_TOKEN",
+    ]
+
+    missing_vars = [var for var in required_env_vars if not os.getenv(var)]
+    if missing_vars:
+        pytest.fail(f"Missing required env vars: {', '.join(missing_vars)}")
+
+    sf = SFAuth(
+        instance_url=os.getenv("SF_INSTANCE_URL"),
+        client_id=os.getenv("SF_CLIENT_ID"),
+        client_secret=os.getenv("SF_CLIENT_SECRET"),
+        refresh_token=os.getenv("SF_REFRESH_TOKEN"),
+    )
+    return sf
+
+
+def test_debug_cleanup(sf_instance, already_executed: bool = False):
+    """
+    Test the debug_cleanup method of SFAuth.
+    This test ensures the method deletes Apex logs as expected.
+    """
+    # Check if any Apex logs already exist
+    apex_logs = sf_instance.query("SELECT Id FROM ApexLog LIMIT 1")
+    if apex_logs.get("records"):
+        sf_instance.debug_cleanup(apex_logs=True)
+        apex_logs_after = sf_instance.query("SELECT Id FROM ApexLog LIMIT 1")
+        assert len(apex_logs_after.get("records", [])) == 0, (
+            "Apex logs were not cleaned up successfully."
+        )
+        return
+
+    # No Apex logs yet; create one via anonymous Apex
+    traceflag_query = sf_instance.tooling_query(
+        f"SELECT Id FROM TraceFlag WHERE TracedEntityId = '{sf_instance.user_id}' LIMIT 1"
+    )
+    records = traceflag_query.get("records", [])
+    traceflag_id = records[0].get("Id") if records else None
+
+    if not traceflag_id:
+        debuglevel_query = sf_instance.tooling_query(
+            "SELECT Id FROM DebugLevel WHERE DeveloperName = 'SFDC_DevConsole' LIMIT 1"
+        )
+        debuglevel_id = debuglevel_query.get("records", [{}])[0].get("Id")
+
+        if not debuglevel_id:
+            pytest.fail(
+                "DebugLevel 'SFDC_DevConsole' not found. Please create it in your Salesforce org."
+            )
+
+        traceflag_payload = {
+            "DebugLevelId": debuglevel_id,
+            "LogType": "USER_DEBUG",
+            "TracedEntityId": sf_instance.user_id,
+            "StartDate": datetime.now(timezone.utc).isoformat(),
+            "ExpirationDate": (
+                datetime.now(timezone.utc) + timedelta(minutes=5)
+            ).isoformat(),
+        }
+        resp = sf_instance._create(
+            sobject="TraceFlag", insert_list=[traceflag_payload], api_type="tooling"
+        )
+        with open("debug_payload.json", "w") as f:
+            f.write(json.dumps(resp, indent=2))
+        with open("debug_payload.json", "w") as f:
+            f.write(json.dumps(traceflag_payload, indent=2))
+
+        traceflag_query = sf_instance.tooling_query(
+            f"SELECT Id FROM TraceFlag WHERE TracedEntityId = '{sf_instance.user_id}' LIMIT 1"
+        )
+        records = traceflag_query.get("records", [])
+        traceflag_id = records[0].get("Id") if records else None
+
+        if not traceflag_id:
+            pytest.fail("Failed to create TraceFlag.")
+
+    else:
+        # Update the existing TraceFlag's dates
+        starttime = datetime.now(timezone.utc).isoformat()
+        endtime = (datetime.now(timezone.utc) + timedelta(minutes=5)).isoformat()
+        payload = json.dumps({"StartDate": starttime, "ExpirationDate": endtime})
+
+        conn = http.client.HTTPSConnection(
+            sf_instance.instance_url.replace("https://", "")
+        )
+        conn.request(
+            "PATCH",
+            f"/services/data/v64.0/tooling/sobjects/TraceFlag/{traceflag_id}",
+            body=payload,
+            headers={
+                "Authorization": f"Bearer {sf_instance.access_token}",
+                "Content-Type": "application/json",
+            },
+        )
+        response = conn.getresponse()
+        resp_body = response.read().decode()
+
+        if response.status not in (200, 204):
+            pytest.fail(
+                f"Failed to update TraceFlag: {response.reason} | Body: {resp_body}"
+            )
+
+    # Now generate an Apex log
+    anonymous_body = f"System.debug('Hello from {sf_instance.user_agent}! :)');"
+    encoded_body = quote(anonymous_body, safe="")
+    conn = http.client.HTTPSConnection(sf_instance.instance_url.replace("https://", ""))
+    conn.request(
+        "GET",
+        f"/services/data/v64.0/tooling/executeAnonymous/?anonymousBody={encoded_body}",
+        headers={
+            "Authorization": f"Bearer {sf_instance.access_token}",
+            "Content-Type": "application/json",
+        },
+    )
+    response = conn.getresponse()
+    if response.status != 200:
+        pytest.fail(f"Failed to execute anonymous Apex: {response.reason}")
+
+    if already_executed:
+        pytest.fail(
+            "ApexLog creation failed or already attempted. Skipping recursion to avoid infinite loop."
+        )
+
+    sleep(1)  # Race condition mitigation
+    return test_debug_cleanup(sf_instance, already_executed=True)

sfq-0.0.32/tests/test_open_frontdoor.py

@@ -0,0 +1,51 @@
+import os
+import re
+import sys
+from pathlib import Path
+from unittest.mock import patch
+from urllib.parse import quote
+
+import pytest
+from pytest import fail
+
+# --- Setup local import path ---
+project_root = Path(__file__).resolve().parents[1]
+src_path = project_root / "src"
+sys.path.insert(0, str(src_path))
+from sfq import SFAuth  # noqa: E402
+
+
+@pytest.fixture(scope="module")
+def sf_instance():
+    required_env_vars = [
+        "SF_INSTANCE_URL",
+        "SF_CLIENT_ID",
+        "SF_CLIENT_SECRET",
+        "SF_REFRESH_TOKEN",
+    ]
+
+    missing_vars = [var for var in required_env_vars if not os.getenv(var)]
+    if missing_vars:
+        pytest.fail(f"Missing required env vars: {', '.join(missing_vars)}")
+
+    return SFAuth(
+        instance_url=os.getenv("SF_INSTANCE_URL"),
+        client_id=os.getenv("SF_CLIENT_ID"),
+        client_secret=os.getenv("SF_CLIENT_SECRET"),
+        refresh_token=os.getenv("SF_REFRESH_TOKEN"),
+    )
+
+
+def test_open_frontdoor(sf_instance):
+    with patch("webbrowser.open") as mock_open:
+        try:
+            sf_instance.open_frontdoor()
+            sid = quote(sf_instance.access_token, safe="")
+            expected_url = f"{sf_instance.instance_url}/secur/frontdoor.jsp?sid={sid}"
+            mock_open.assert_called_once_with(expected_url)
+        except AssertionError as e:
+            msg = str(e)
+            if sf_instance.access_token and sf_instance.access_token in msg:
+                msg = msg.replace(sf_instance.access_token, "[REDACTED]")
+            msg = re.sub(r"([?&]sid=)[^&\s]+", r"\1[REDACTED]", msg)
+            fail(f"Assertion failed: {msg}")

{sfq-0.0.30 → sfq-0.0.32}/uv.lock

@@ -3,5 +3,5 @@ requires-python = ">=3.9"
 
 [[package]]
 name = "sfq"
-version = "0.0.30"
+version = "0.0.32"
 source = { editable = "." }

sfq-0.0.30/tests/test_debug_cleanup.py

@@ -1,67 +0,0 @@
-import os
-import sys
-from pathlib import Path
-from datetime import datetime, timedelta
-
-import pytest
-
-# --- Setup local import path ---
-project_root = Path(__file__).resolve().parents[1]
-src_path = project_root / "src"
-sys.path.insert(0, str(src_path))
-from sfq import SFAuth  # noqa: E402
-
-
-@pytest.fixture(scope="module")
-def sf_instance():
-    required_env_vars = [
-        "SF_INSTANCE_URL",
-        "SF_CLIENT_ID",
-        "SF_CLIENT_SECRET",
-        "SF_REFRESH_TOKEN",
-    ]
-
-    missing_vars = [var for var in required_env_vars if not os.getenv(var)]
-    if missing_vars:
-        pytest.fail(f"Missing required env vars: {', '.join(missing_vars)}")
-
-    sf = SFAuth(
-        instance_url=os.getenv("SF_INSTANCE_URL"),
-        client_id=os.getenv("SF_CLIENT_ID"),
-        client_secret=os.getenv("SF_CLIENT_SECRET"),
-        refresh_token=os.getenv("SF_REFRESH_TOKEN"),
-    )
-    return sf
-
-def test_debug_cleanup(sf_instance, already_executed: bool = False):
-    """
-    Test the debug_cleanup method of SFAuth.
-    This test will check if the method can be called without errors.
-    """
-    apex_logs = sf_instance.query("SELECT Id FROM ApexLog LIMIT 1")
-    apex_log_count = len(apex_logs.get("records", []))
-    if apex_log_count == 0:
-        # OK, so we need to create an Apex log to test cleanup
-        # To do this, let's execute a simple Apex anonymous block
-        import http.client
-        conn = http.client.HTTPSConnection(sf_instance.instance_url.replace("https://", ""))
-        conn.request(
-            "GET",
-            '/services/data/v64.0/tooling/executeAnonymous/?anonymousBody=Long%20currentUnixTime%20%3D%20DateTime.now().getTime()%20%2F%201000%3B',
-            headers={
-                "Authorization": f"Bearer {sf_instance.access_token}",
-                "Content-Type": "application/json"
-            }
-        )
-        response = conn.getresponse()
-        if response.status != http.client.OK:
-            pytest.fail(f"Failed to create Apex logs: {response.reason}")
-        if already_executed:
-            pytest.fail("ApexLog creation failed, cannot evaluate Apex log test.")
-        return test_debug_cleanup(sf_instance, already_executed=True)
-
-    sf_instance.debug_cleanup(apex_logs=True)
-
-    apex_logs = sf_instance.query("SELECT Id FROM ApexLog LIMIT 1")
-    apex_log_count = len(apex_logs.get("records", []))
-    assert apex_log_count == 0, "Apex logs were not cleaned up successfully."