#835: fixes for JSON batching

vgrem · vgrem · commit 3eac1855d115 · 2024-09-20T11:31:30.000+03:00
diff --git a/examples/directory/users/update.py b/examples/directory/users/update.py
@@ -0,0 +1,16 @@
+"""
+Update users
+
+https://learn.microsoft.com/en-us/graph/api/user-update
+"""
+
+from office365.graph_client import GraphClient
+from tests import test_client_id, test_password, test_tenant, test_username
+
+client = GraphClient.with_username_and_password(
+    test_tenant, test_client_id, test_username, test_password
+)
+users = client.users.get().filter("startswith(displayName, 'testuser')").top(1).execute_query()
+
+for u in users:
+    u.set_property('officeLocation', "18/2111").update().execute_query()
diff --git a/examples/directory/users/update_batch.py b/examples/directory/users/update_batch.py
@@ -0,0 +1,20 @@
+"""
+Update users in batch mode
+
+https://learn.microsoft.com/en-us/graph/api/user-update
+"""
+
+from office365.graph_client import GraphClient
+from tests import test_client_id, test_password, test_tenant, test_username
+
+client = GraphClient.with_username_and_password(
+    test_tenant, test_client_id, test_username, test_password
+)
+users = client.users.get().filter("startswith(displayName, 'testuser')").top(50).execute_query()
+
+for u in users:
+    u.set_property('officeLocation', "18/2111").update()
+
+client.execute_batch()
+
+
diff --git a/generator/metadata/MicrosoftGraph.xml b/generator/metadata/MicrosoftGraph.xml
@@ -22557,6 +22557,7 @@
             <Property Name="groupTypes" Type="Collection(Edm.String)" Nullable="false"/>
             <Property Name="hasMembersWithLicenseErrors" Type="Edm.Boolean"/>
             <Property Name="isAssignableToRole" Type="Edm.Boolean"/>
+            <Property Name="isManagementRestricted" Type="Edm.Boolean"/>
             <Property Name="licenseProcessingState" Type="graph.licenseProcessingState"/>
             <Property Name="mail" Type="Edm.String"/>
             <Property Name="mailEnabled" Type="Edm.Boolean"/>
@@ -22925,6 +22926,7 @@
             <Property Name="givenName" Type="Edm.String"/>
             <Property Name="identities" Type="Collection(graph.objectIdentity)"/>
             <Property Name="imAddresses" Type="Collection(Edm.String)"/>
+            <Property Name="isManagementRestricted" Type="Edm.Boolean"/>
             <Property Name="isResourceAccount" Type="Edm.Boolean"/>
             <Property Name="jobTitle" Type="Edm.String"/>
             <Property Name="lastPasswordChangeDateTime" Type="Edm.DateTimeOffset"/>
@@ -25913,6 +25915,7 @@
          <EntityType Name="administrativeUnit" BaseType="graph.directoryObject" OpenType="true">
             <Property Name="description" Type="Edm.String"/>
             <Property Name="displayName" Type="Edm.String"/>
+            <Property Name="isMemberManagementRestricted" Type="Edm.Boolean"/>
             <Property Name="membershipRule" Type="Edm.String"/>
             <Property Name="membershipRuleProcessingState" Type="Edm.String"/>
             <Property Name="membershipType" Type="Edm.String"/>
@@ -26294,6 +26297,7 @@
             <Property Name="enrollmentType" Type="Edm.String"/>
             <Property Name="isCompliant" Type="Edm.Boolean"/>
             <Property Name="isManaged" Type="Edm.Boolean"/>
+            <Property Name="isManagementRestricted" Type="Edm.Boolean"/>
             <Property Name="isRooted" Type="Edm.Boolean"/>
             <Property Name="managementType" Type="Edm.String"/>
             <Property Name="manufacturer" Type="Edm.String"/>
@@ -26376,6 +26380,7 @@
             <Property Name="supportedServices" Type="Collection(Edm.String)" Nullable="false"/>
             <NavigationProperty Name="domainNameReferences" Type="Collection(graph.directoryObject)"/>
             <NavigationProperty Name="federationConfiguration" Type="Collection(graph.internalDomainFederation)" ContainsTarget="true"/>
+            <NavigationProperty Name="rootDomain" Type="graph.domain"/>
             <NavigationProperty Name="serviceConfigurationRecords" Type="Collection(graph.domainDnsRecord)" ContainsTarget="true"/>
             <NavigationProperty Name="verificationDnsRecords" Type="Collection(graph.domainDnsRecord)" ContainsTarget="true"/>
          </EntityType>
@@ -35508,6 +35513,9 @@
          </Action>
          <Action Name="restore" IsBound="true">
             <Parameter Name="bindingParameter" Type="graph.directoryObject" Nullable="false"/>
+            <Parameter Name="autoReconcileProxyConflict" Type="Edm.Boolean">
+               <Annotation Term="Org.OData.Core.V1.OptionalParameter"/>
+            </Parameter>
             <ReturnType Type="graph.directoryObject"/>
          </Action>
          <Action Name="restore" IsBound="true">
@@ -40376,6 +40384,7 @@
             <EntitySet Name="domainDnsRecords" EntityType="microsoft.graph.domainDnsRecord"/>
             <EntitySet Name="domains" EntityType="microsoft.graph.domain">
                <NavigationPropertyBinding Path="domainNameReferences" Target="directoryObjects"/>
+               <NavigationPropertyBinding Path="rootDomain" Target="domains"/>
             </EntitySet>
             <EntitySet Name="groups" EntityType="microsoft.graph.group">
                <NavigationPropertyBinding Path="createdOnBehalfOf" Target="directoryObjects"/>
diff --git a/office365/graph_client.py b/office365/graph_client.py
@@ -229,9 +229,11 @@ def _acquire_token():
 
         return GraphClient(_acquire_token)
 
-    def execute_batch(self, items_per_batch=100, success_callback=None):
+    def execute_batch(self, items_per_batch=20, success_callback=None):
         """Constructs and submit a batch request
 
+        Per Batch size limitations: JSON batch requests are currently limited to 20 individual requests.
+
         :param int items_per_batch: Maximum to be selected for bulk operation
         :param (List[ClientObject|ClientResult])-> None success_callback: A success callback
         """
diff --git a/office365/runtime/odata/v4/batch_request.py b/office365/runtime/odata/v4/batch_request.py
@@ -46,11 +46,8 @@ def _extract_response(response, query):
             yield qry, resp
 
     def _prepare_payload(self, query):
-        """
-        Serializes a batch request body.
-
-        :type query: office365.runtime.queries.batch.BatchQuery
-        """
+        # type: (BatchQuery) -> Dict
+        """ Serializes a batch request body. """
         requests_json = []
         for qry in query.queries:
             qry_id = str(len(requests_json))
@@ -63,16 +60,16 @@ def _normalize_request(query, query_id, depends_on=None):
         # type: (ClientQuery, str, Optional[List[str]]) -> Dict[str, Any]
         """ """
         request = query.build_request()
-        allowed_props = ["id", "method", "headers", "url", "body"]
-        request_json = dict(
-            (k, v)
-            for k, v in vars(request).items()
-            if v is not None and k in allowed_props
-        )
-        request_json["id"] = query_id
+
+        request_json = {
+            "id": query_id,
+            "url": request.url.replace(query.context.service_root_url(), ""),
+            "method": request.method,
+            "headers": request.headers,
+        }
+        if request.data:
+            request_json["body"] = request.data
+
         if depends_on is not None:
             request_json["dependsOn"] = depends_on
-        request_json["url"] = request_json["url"].replace(
-            query.context.service_root_url(), ""
-        )
         return request_json
diff --git a/office365/sharepoint/logger/log_export.py b/office365/sharepoint/logger/log_export.py
@@ -14,12 +14,14 @@ def __init__(self, context):
         )
 
     def get_files(self):
+        """ """
         return_type = LogFileInfoCollection(self.context)
         qry = ServiceOperationQuery(self, "GetFiles", None, None, None, return_type)
         self.context.add_query(qry)
         return return_type
 
     def get_log_types(self):
+        """ """
         return_type = ClientResult(self.context)
         qry = ServiceOperationQuery(self, "GetLogTypes", None, None, None, return_type)
         self.context.add_query(qry)
diff --git a/office365/sharepoint/migrationcenter/service/performance/data.py b/office365/sharepoint/migrationcenter/service/performance/data.py
@@ -31,14 +31,14 @@ def __init__(self, context, resource_path=None):
             context, PerformanceData, resource_path
         )
 
-    def get_data(self, StartTime=None, EndTime=None, AgentId=None, TimeUnit=None):
+    def get_data(self, start_time=None, end_time=None, agent_id=None, time_unit=None):
         """ """
         return_type = ClientResult(self.context, PerformanceDashboardData())
         payload = {
-            "StartTime": StartTime,
-            "EndTime": EndTime,
-            "AgentId": AgentId,
-            "TimeUnit": TimeUnit,
+            "StartTime": start_time,
+            "EndTime": end_time,
+            "AgentId": agent_id,
+            "TimeUnit": time_unit,
         }
         qry = ServiceOperationQuery(self, "GetData", None, payload, None, return_type)
         self.context.add_query(qry)
diff --git a/requirements-examples.txt b/requirements-examples.txt
@@ -0,0 +1,3 @@
+-r requirements-dev.txt
+
+faker
diff --git a/tests/test_graph_client.py b/tests/test_graph_client.py
@@ -88,11 +88,6 @@ def test_12_resolve_term_children_path(self):
             str(path),
         )
 
-    # def test_12_build_operation_resource_path(self):
-    #    result = self.client.me.drive.root.get_by_path("archive/Sample.rtf")
-    #         .get_activities_by_interval().execute_query()
-    #    self.assertEqual("/me/drive/root/getActivitiesByInterval()", str(result.resource_path))
-
     def test_13_resolve_me_resource_path(self):
         current_user = self.client.me.get().execute_query()
         self.assertEqual(

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+-r requirements-dev.txt`
	`2`	`+`
	`3`	`+faker`