returnFormat is missing from getMetaData when it is set to 'xml'

martin · January 23, 2024, 11:44am

When I was looking to an issue that @jjblodg was having on the forum ( Remote Function Content-Type difference between Lucee and ColdFusion - #7 by jjblodg ), I noticed that if a function has a returnFormat attribute set to ‘xml’, then the returnFormat key is missing from the function’s metadata when using getMetaData(). This happens with Lucee 6 and 5.4.3.16

You can see a stripped down version of this in the following gist:

It looks like it is caused by this section of code:

github.com

lucee/Lucee/blob/f7b88cc49b908dd61e9dfad6a4e567745408182a/core/src/main/java/lucee/runtime/type/util/ComponentUtil.java#L835


      
          		if (udfProps.getPageSource() != null) func.set(KeyConstants._owner, udfProps.getPageSource().getDisplayPath());
          
          		if (udfProps.getStartLine() > 0 && udfProps.getEndLine() > 0) {
          			Struct pos = new StructImpl();
          			pos.set(KeyConstants._start, udfProps.getStartLine());
          			pos.set(KeyConstants._end, udfProps.getEndLine());
          			func.setEL(KeyConstants._position, pos);
          		}
          
          		int format = udfProps.getReturnFormat();
          		if (format < 0 || format == UDF.RETURN_FORMAT_WDDX) func.set(KeyConstants._returnFormat, "wddx");
          		else if (format == UDF.RETURN_FORMAT_PLAIN) func.set(KeyConstants._returnFormat, "plain");
          		else if (format == UDF.RETURN_FORMAT_JSON) func.set(KeyConstants._returnFormat, "json");
          		else if (format == UDF.RETURN_FORMAT_SERIALIZE) func.set(KeyConstants._returnFormat, "cfml");
          
          		FunctionArgument[] args = udfProps.getFunctionArguments();
          		Array params = new ArrayImpl();
          		// Object defaultValue;
          		Struct m;
          		// Object defaultValue;
          		for (int y = 0; y < args.length; y++) {

I just wanted to check if I am OK to log this as a bug on jira?

cfmitrah · January 24, 2024, 1:21pm

@martin Yeah, it seems to be a valid bug. Please file a bug on Jira.

martin · January 24, 2024, 3:46pm

Thanks for the confirmation. I have submitted a bug on jira:
https://luceeserver.atlassian.net/browse/LDEV-4783

I have also created a test for this and submitted a pull request for a fix: