fix: Handles operation arguments imported as strings #546

phantomjinx · 2023-09-11T17:47:50Z

Some Operation Arguments retrieved by jolokia are surrounded with quotes hence are handled internally as strings.
Using the current mechanism only populates the arg.name parameter, leaving arg.type null, resulting in some ugly errors when OperationArgument is constructed.
By checking whether the arg is an Object and if not parsing it mitigates the problem of the quotes

github-actions · 2023-09-11T18:02:21Z

Test Results

    8 files +  1     8 suites +1 59m 39s ⏱️ + 9m 27s
  57 tests -   2   54 ✔️ ±  0 1 💤 -   4   2 ❌ +  2
452 runs +56 428 ✔️ +53 8 💤 - 13 16 ❌ +16

For more details on these failures, see this check.

Results for commit 69be64f. ± Comparison against base commit 03ea6c9.

This pull request removes 4 and adds 2 tests. Note that renamed tests count towards both.

Check whether all data is presented and displayed correctly in About modal window. ‑ Check that the titles are presented in Quarkus About modal window - Names of Hawtio's Components - Example #1.1
Check whether all data is presented and displayed correctly in About modal window. ‑ Check that the titles are presented in Quarkus About modal window - Names of Hawtio's Components - Example #1.2
Check whether all data is presented and displayed correctly in About modal window. ‑ Check that the titles are presented in Spring Boot About modal window - Names of Hawtio's Components - Example #1.1
Check whether all data is presented and displayed correctly in About modal window. ‑ Check that the titles are presented in Spring Boot About modal window - Names of Hawtio's Components - Example #1.2

Check whether all data is presented and displayed correctly in About modal window. ‑ Check that the titles are presented in About modal window - Names of Hawtio's Components - Example #1.1
Check whether all data is presented and displayed correctly in About modal window. ‑ Check that the titles are presented in About modal window - Names of Hawtio's Components - Example #1.2

♻️ This comment has been updated with latest results.

hawtio-ci · 2023-09-11T18:02:32Z

Test results

Run attempt: 361
Detailed summary

NAME	TESTS	PASSED ✅	SKIPPED 💤	FAILED ❌	TIME 🕖
results-quarkus-node(16)-java(11)-firefox	57	54	1	2	408.648
results-quarkus-node(16)-java(17)-firefox	57	54	1	2	450.69
results-quarkus-node(18)-java(11)-firefox	57	54	1	2	473.637
results-quarkus-node(18)-java(17)-firefox	57	54	1	2	424.454
results-springboot-node(16)-java(11)-firefox	56	53	1	2	478.121
results-springboot-node(16)-java(17)-firefox	56	53	1	2	432.535
results-springboot-node(18)-java(11)-firefox	56	53	1	2	487.948
results-springboot-node(18)-java(17)-firefox	56	53	1	2	423.877

tadayosi

Can you provide us with an example of Jolokia requests that you want to address with the fix? I wonder how it happens in the first place.

tadayosi · 2023-09-12T01:57:11Z

packages/hawtio/src/plugins/shared/operations/operation.ts

+  const args: OperationArgument[] = []
+  for (const arg of op.args) {
+    let argObj = arg
+    if (!isObject(arg)) {


It's still not clear to me why this check is needed. The arg type is defined like this:
https://github.com/hawtio/jolokia.js/blob/dc6bb0c8c8c1f1904b58630c8a1aab9e69ac2f36/index.d.ts#L65-L69
Maybe you can provide us with an example of Jolokia requests that are irregular to the defined type, then we can modify the type definition accordingly. Or it could be a bug in Jolokia that should rather be raised to Jolokia project.

tadayosi · 2023-09-12T01:59:02Z

packages/hawtio/src/plugins/shared/operations/operation.ts

+      try {
+        argObj = JSON.parse(arg as string)
+      } catch (error) {
+        log.error(`Cannot parse argument ${arg} in operation ${op.desc}`, error)


Oftentimes op.desc doesn't provide enough information, so it's better to use name here.

tadayosi · 2023-09-12T02:03:53Z

Also, the code hasn't been changed so much from v2. I wonder why it wasn't a case with the old Hawtio v2. (Or it was?)
https://github.com/hawtio/hawtio-integration/blob/c7d814d3cdd087384a8b3d09cfd6514da9052b81/plugins/jmx/ts/operations/operations.service.ts#L58-L66

    private addOperation(operations: Operation[], operationMap: { [name: string]: Operation },
      opName: string, op: { args: any[], desc: string }): void {
      let operation = new Operation(
        opName,
        op.args.map((arg) => _.assign(new OperationArgument(), arg)),
        op.desc);
      operations.push(operation);
      operationMap[operation.name] = operation;
    }

phantomjinx · 2023-09-12T09:41:29Z

I added some console log messages to the existing source to diagnose the problem - see screenshot.

Click on the route node in the camel plugin tree - display the Attributes view;
Click on the Operations view and the result is an exception being thrown;

The reason for the exception is that arg.type is null because arg.name assumes the whole value when the arg is a string.

The console log confirms displays (see 1) that the arg array normally contains properties objects. However, in the case of 'Dumps the route as XML' operation, the arg value is defined as a string (see 2). It seems to be the only arg that is in this form so it may be an error in the dependencies.

If it is a bug further down the stack, then it is probably worth investigating and fixing. However, I think it cautious to check the arguments rather than assume. That was my thinking here.

phantomjinx · 2023-09-12T09:49:51Z

operation-bug.mp4

Thought a quick video might clarify the process.

tadayosi · 2023-09-12T10:35:56Z

@phantomjinx Can you reproduce the issue with the old Hawtio as well?

tadayosi · 2023-09-13T03:59:59Z

@phantomjinx I cannot reproduce the issue at my end, with either the current 3.x branch of hawtio standalone project or the main branch of hawtio-next and the Spring Boot example.

I added some console log messages to the existing source to diagnose the problem - see screenshot.

Actually, you don't need to insert console.log to just inspect the received mbean tree. Just turn on hawtio-shared-workspace logger to DEBUG level and you'll get the mbean tree loaded in the browser console.

In my case, both dumpStatsAsXml and dumpRouteAsXml operations get the args correctly as objects. I'd suspect the issue is specific to your Camel application setup. We should check which versions of Camel and Jolokia are needed to replicate it.

And talking about the fix, if this issue indeed happens in some case and needs to be fixed, I think we should rather fix it earlier than when an operation object is instantiated, somewhere like here:

hawtio-next/packages/hawtio/src/plugins/shared/workspace.ts

Lines 70 to 85 in 03ea6c9

    
           private unwindResponseWithRBACCache(value: unknown): OptimisedJmxDomains { 
        
             if (is(value, object({ domains: object(), cache: object() }))) { 
        
               // post process cached RBAC info 
        
               for (const domainName in value.domains) { 
        
                 const domain = value.domains[domainName] as OptimisedJmxDomain | MBeanCache 
        
                 for (const mbeanName in domain) { 
        
                   const mbeanOrCache = domain[mbeanName] 
        
                   if (isString(mbeanOrCache)) { 
        
                     domain[mbeanName] = value.cache[mbeanOrCache] as OptimisedJmxMBean 
        
                   } 
        
                 } 
        
               } 
        
               return value.domains as OptimisedJmxDomains 
        
             } 
        
             return value as OptimisedJmxDomains 
        
           }

phantomjinx · 2023-09-13T09:47:55Z

@phantomjinx Can you reproduce the issue with the old Hawtio as well?

Curiously no. The Operation args seem to come through correctly.

phantomjinx · 2023-09-13T09:49:10Z

The test application, forked from the main quick-starts, is located here -> https://github.com/phantomjinx/spring-boot-camel/tree/fuse-7.x.redhat

* Some Operation Arguments retrieved by jolokia are surrounded with quotes hence are handled internally as strings. * Using the current mechanism only populates the arg.name parameter, leaving arg.type null, resulting in some ugly errors when OperationArgument is constructed. * By checking whether the arg is an Object and if not parsing it mitigates the problem of the quotes

tadayosi · 2023-09-14T05:39:05Z

The test application, forked from the main quick-starts, is located here -> https://github.com/phantomjinx/spring-boot-camel/tree/fuse-7.x.redhat

@phantomjinx I don't reproduce the issue even with the quickstart you use. I guess you're deploying it to OpenShift and trying to connect to it from hawtio-online, aren't you? Then it should be the issue with the way hawtio-online processes the returned mbeans at its in-the-middle nginx server. See: https://github.com/hawtio/hawtio-online/blob/2.x/docker/nginx.js

If that's the case, let's close this one and instead file this issue to hawtio-online and fix it there.

phantomjinx · 2023-09-29T11:43:06Z

Closing as discussed. Has not proven to be the case elsewhere and if it occurs again on hawtio-online will investigate with the target being how the latter provides the network data rather than hawtio-next.

phantomjinx requested a review from tadayosi September 11, 2023 17:47

phantomjinx force-pushed the main branch from 070814a to 676bea3 Compare September 11, 2023 18:16

tadayosi requested changes Sep 12, 2023

View reviewed changes

phantomjinx force-pushed the main branch 2 times, most recently from d1b6cfe to 69be64f Compare September 13, 2023 12:23

phantomjinx closed this Sep 29, 2023

tadayosi mentioned this pull request Nov 16, 2023

Camel - Operations tab crashes when used with Camel JBang #670

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix: Handles operation arguments imported as strings #546

fix: Handles operation arguments imported as strings #546

phantomjinx commented Sep 11, 2023

github-actions bot commented Sep 11, 2023 •

edited

Loading

hawtio-ci bot commented Sep 11, 2023 •

edited

Loading

tadayosi left a comment

tadayosi Sep 12, 2023

tadayosi Sep 12, 2023

tadayosi commented Sep 12, 2023

phantomjinx commented Sep 12, 2023

phantomjinx commented Sep 12, 2023

tadayosi commented Sep 12, 2023

tadayosi commented Sep 13, 2023 •

edited

Loading

phantomjinx commented Sep 13, 2023

phantomjinx commented Sep 13, 2023

tadayosi commented Sep 14, 2023

phantomjinx commented Sep 29, 2023

fix: Handles operation arguments imported as strings #546

fix: Handles operation arguments imported as strings #546

Conversation

phantomjinx commented Sep 11, 2023

github-actions bot commented Sep 11, 2023 • edited Loading

Test Results

hawtio-ci bot commented Sep 11, 2023 • edited Loading

Test results

tadayosi left a comment

Choose a reason for hiding this comment

tadayosi Sep 12, 2023

Choose a reason for hiding this comment

tadayosi Sep 12, 2023

Choose a reason for hiding this comment

tadayosi commented Sep 12, 2023

phantomjinx commented Sep 12, 2023

phantomjinx commented Sep 12, 2023

tadayosi commented Sep 12, 2023

tadayosi commented Sep 13, 2023 • edited Loading

phantomjinx commented Sep 13, 2023

phantomjinx commented Sep 13, 2023

tadayosi commented Sep 14, 2023

phantomjinx commented Sep 29, 2023

github-actions bot commented Sep 11, 2023 •

edited

Loading

hawtio-ci bot commented Sep 11, 2023 •

edited

Loading

tadayosi commented Sep 13, 2023 •

edited

Loading