Merge pull request ceph#61781 from rhcs-dashboard/xml-fix

mgr/dashboard: fix lifecycle get request

Author: nizamial09

ceph.spec.in

@@ -695,6 +695,7 @@ Requires:       ceph-prometheus-alerts = %{_epoch_prefix}%{version}-%{release}
 Requires:       python%{python3_pkgversion}-grpcio
 Requires:       python%{python3_pkgversion}-grpcio-tools
 Requires:       python%{python3_pkgversion}-jmespath
+Requires:       python%{python3_pkgversion}-xmltodict
 %endif
 %if 0%{?fedora} || 0%{?rhel} || 0%{?openEuler}
 Requires:       python%{python3_pkgversion}-cherrypy

debian/control

@@ -100,6 +100,7 @@ Build-Depends: automake,
                python3-dateutil <pkg.ceph.check>,
                python3-grpcio <pkg.ceph.check>,
                python3-jmespath (>=0.10) <pkg.ceph.check>,
+               python3-xmltodict <pkg.ceph.check>,
                python3-openssl <pkg.ceph.check>,
                python3-prettytable <pkg.ceph.check>,
                python3-requests <pkg.ceph.check>,

src/pybind/mgr/dashboard/frontend/src/app/ceph/rgw/rgw-bucket-details/rgw-bucket-details.component.html

@@ -152,13 +152,13 @@
                     <button type="button"
                             class="btn btn-light"
                             [ngClass]="{'active': lifecycleFormat === 'json'}"
-                            (click)="lifecycleFormat = 'json'">
+                            (click)="updateLifecycleFormatTo('json')">
                           JSON
                     </button>
                     <button type="button"
                             class="btn btn-light"
                             [ngClass]="{'active': lifecycleFormat === 'xml'}"
-                            (click)="lifecycleFormat = 'xml'">
+                            (click)="updateLifecycleFormatTo('xml')">
                           XML
                     </button>
                   </div>

src/pybind/mgr/dashboard/frontend/src/app/ceph/rgw/rgw-bucket-details/rgw-bucket-details.component.ts

@@ -1,4 +1,4 @@
-import { Component, Input, OnChanges } from '@angular/core';
+import { ChangeDetectorRef, Component, Input, OnChanges } from '@angular/core';
 
 import { RgwBucketService } from '~/app/shared/api/rgw-bucket.service';
 
@@ -24,7 +24,7 @@ export class RgwBucketDetailsComponent implements OnChanges {
   replicationStatus = $localize`Disabled`;
   bucketRateLimit: RgwRateLimitConfig;
 
-  constructor(private rgwBucketService: RgwBucketService) {}
+  constructor(private rgwBucketService: RgwBucketService, private cd: ChangeDetectorRef) {}
 
   ngOnChanges() {
     this.updateBucketDetails(this.extraxtDetailsfromResponse.bind(this));
@@ -102,4 +102,9 @@ export class RgwBucketDetailsComponent implements OnChanges {
       );
     }
   }
+
+  updateLifecycleFormatTo(format: 'json' | 'xml'): void {
+    this.lifecycleFormat = format;
+    this.cd.detectChanges();
+  }
 }

src/pybind/mgr/dashboard/requirements.txt

@@ -15,3 +15,4 @@ grpcio==1.46.5
 grpcio-tools==1.46.5
 jmespath
 lxml==4.8.0  # to fix https://github.com/xmlsec/python-xmlsec/issues/320
+xmltodict

src/pybind/mgr/dashboard/services/rgw_client.py

@@ -16,6 +16,12 @@
 from urllib.parse import urlparse
 
 import requests
+
+try:
+    import xmltodict
+except ModuleNotFoundError:
+    logging.error("Module 'xmltodict' is not installed.")
+
 from mgr_util import build_url, name_to_config_section
 
 from .. import mgr
@@ -715,23 +721,30 @@ def _handle_rules(pairs):
     @RestClient.api_get('/{bucket_name}?lifecycle')
     def get_lifecycle(self, bucket_name, request=None):
         # pylint: disable=unused-argument
+
+        # xmltodict parser will prepend namespace to json keys as {ns0:key}
+        def remove_namespace(xml: str):
+            """Remove namespace in given xml string."""
+            root = ET.fromstring(xml)
+            for elem in root.iter():
+                tag_elements = elem.tag.split("}")  # tag: {ns}tagname
+                # Removing namespaces and attributes
+                elem.tag = tag_elements[1]
+                elem.attrib.clear()
+
+            return ET.tostring(root)
+
         try:
-            decoded_request = request(raw_content=True).decode("utf-8")  # type: ignore
-            result = {
-                'LifecycleConfiguration':
-                json.loads(
-                    decoded_request,
-                    object_pairs_hook=RgwClient._handle_rules
-                )
-            }
+            result = request(
+                raw_content=True, headers={'Accept': 'text/xml'}).decode()  # type: ignore
+            return xmltodict.parse(remove_namespace(result), process_namespaces=False)
         except RequestException as e:
             if e.content:
-                content = json_str_to_object(e.content)
-                if content.get(
-                        'Code') == 'NoSuchLifecycleConfiguration':
+                root = ET.fromstring(e.content)
+                code = root.find('Code')
+                if code is not None and code.text == 'NoSuchLifecycleConfiguration':
                     return None
             raise DashboardException(msg=str(e), component='rgw')
-        return result
 
     @staticmethod
     def dict_to_xml(data):

src/pybind/mgr/tox.ini

@@ -82,6 +82,7 @@ deps =
     types-PyYAML
     types-jwt
     types-jmespath
+    types-xmltodict
 commands =
     mypy --config-file=../../mypy.ini \
            -m alerts \