Add more variables to template to compute sampler names by FSchumacher · Pull Request #5869 · apache/jmeter

FSchumacher · 2023-04-29T12:24:10Z

Description

Add more variables to the mini template language to name samplers when recording a test via HTTPS Script recorder

The new variables are

method - HTTP method of the request
host - host of the URL recorded (called domain in the sampler)
scheme - scheme of the URL recorded (called protocol in the sampler)
port - port of the URL recorded
url - URL as recorded

Motivation and Context

In Issue #5820 a user asked to provide more variables, specifically the url.

How Has This Been Tested?

Added a unit test

Types of changes

New feature (non-breaking change which adds functionality)

Checklist:

My code follows the code style of this project.
I have updated the documentation accordingly.

vlsi · 2023-05-05T14:00:14Z

...protocol/http/src/main/java/org/apache/jmeter/protocol/http/proxy/DefaultSamplerCreator.java

+        Object[] valuesArray;
        if (!HTTPConstants.CONNECT.equals(request.getMethod()) && isNumberRequests()) {
-            sampler.setName(MessageFormat.format(format, prefix, sampler.getPath(), incrementRequestNumberAndGet()));
+            valuesArray = values.toArray(new Object[values.size() + 1]);
+            valuesArray[values.size()] = incrementRequestNumberAndGet();
        } else {
-            sampler.setName(MessageFormat.format(format, prefix, sampler.getPath()));
+            valuesArray = values.toArray();


I just wonder: is there a real reason to allow "request number" only in case the method is not CONNECT?
What if we always supply the "request number", and we increase "request number" only in case the method matches?

The dance with toArray[size+1] looks strange.

To answer your first request (not really), I have no idea, I guess, it was to filter out proxy requests.
About your second concern. I wanted to get around using a full blown ArrayList, but it is probably better to go for readability and use it anyway.

vlsi · 2023-05-05T14:01:51Z

...protocol/http/src/main/java/org/apache/jmeter/protocol/http/proxy/DefaultSamplerCreator.java

+                    .replaceAll("#\\{method([,}])", "{2$1")
+                    .replaceAll("#\\{host([,}])", "{3$1")
+                    .replaceAll("#\\{scheme([,}])", "{4$1")
+                    .replaceAll("#\\{port([,}])", "{5$1")
+                    .replaceAll("#\\{url([,}])", "{6$1")
+                    .replaceAll("#\\{counter([,}])", "{7$1");


In theory, users might have used {2} in their scripts for "counter", and if we move counter to {7} that would break their scripts.

I wonder if we can keep #{counter} at position {2} even though that was not properly documented.

Yes, that would be a nicer option, but I didn't find a way to enable that easily, so I opted to implicitly say: it was never documented and merely an implementation detail.

How about making a first round of replaces that replaces all {[0-9]+} with their escaped representations?
In other words, let's keep {0} literal since that might be something the user wants to have in the sample name.

A yet another option is to escape all { characters to avoid MessageFormat failures.

You mean, if the user sets the format string to #{counter} => {0} and expects JMeter to not touch the {0}?
We had no reports into that direction, so I think the chances are low, it is a problem for many people.

expects JMeter to not touch the {0}?

That is right. I expect if we expose only #{...}, then we should avoid touching things like {0}.

vlsi · 2023-05-06T10:49:32Z

TL;DR: adding new language constructs to existing languages is not easy. We should refrain from extending existing languages.

MessageFormat.format("Hello {")

yields

java.lang.IllegalArgumentException: Unmatched braces in the pattern.
	at java.base/java.text.MessageFormat.applyPattern(MessageFormat.java:521)
	at java.base/java.text.MessageFormat.<init>(MessageFormat.java:371)
	at java.base/java.text.MessageFormat.format(MessageFormat.java:860)

MessageFormat.format("Doesn't contain quote") yields Doesnt contain quote.

So we should either declare that the format uses MessageFormat patterns (with all the ' for escapes), or we should declare we use a completely different language with its own escapes.

If we go with MessageFormat, then we should assume people could use ' for literal parts like Doesn''t contain quote for expressing Doesn't.

That means we must not blindly replace #{...} as it might be inside quotes.
If we continue with MessageFormat, we should probably use proper quote handling when replacing #{url}-like named placeholders.

vlsi · 2023-05-09T12:35:07Z

The documentation did mention MessageFormat which implies {0} was somewhat documented.

I would like to move forward here, however, it is sad that we expose unintended placeholders

vlsi · 2023-05-19T13:52:20Z

@FSchumacher , are you goring to merge this? Do you think it is mergeable?

The new variables are * method - HTTP method of the request * host - host of the URL recorded (called domain in the sampler) * scheme - scheme of the URL recorded (called protocol in the sampler) * port - port of the URL recorded * url - URL as recorded Issue apache#5820 Co-authored-by: Alex Schwartz <alexschwartz01@gmail.com> Guard message formats that might have been given by user As Vladimir pointed out, we might have users, that construct a format string with a part, that might be interpreted by MessageFormat. So let us guard those. asdf

vlsi · 2023-06-05T16:34:49Z

What do you mean by contributor label?

vlsi · 2023-06-05T16:42:02Z

I added your name via Co-authored-by in the commit message (see ae8c1ec, https://docs.github.com/en/pull-requests/committing-changes-to-your-project/creating-and-editing-commits/creating-a-commit-with-multiple-authors), and the link to your profile exists in changes.xml.

WDYT?

FSchumacher force-pushed the add-more-variables-to-template branch 2 times, most recently from 4bf162b to 942f14d Compare April 29, 2023 15:30

vlsi reviewed May 5, 2023

View reviewed changes

vlsi added this to the 5.6 milestone May 11, 2023

vlsi force-pushed the add-more-variables-to-template branch from d61b0ec to ae8c1ec Compare June 5, 2023 14:41

vlsi merged commit ae8c1ec into apache:master Jun 5, 2023

vlsi mentioned this pull request Jun 5, 2023

Show full URL of sites tested under Recording Controller #5820

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add more variables to template to compute sampler names#5869

Add more variables to template to compute sampler names#5869
vlsi merged 1 commit intoapache:masterfrom
FSchumacher:add-more-variables-to-template

FSchumacher commented Apr 29, 2023

Uh oh!

vlsi May 5, 2023

Uh oh!

FSchumacher May 5, 2023

Uh oh!

vlsi May 5, 2023 •

edited

Loading

Uh oh!

FSchumacher May 5, 2023

Uh oh!

vlsi May 5, 2023

Uh oh!

FSchumacher May 5, 2023

Uh oh!

vlsi May 5, 2023

Uh oh!

vlsi commented May 6, 2023

Uh oh!

vlsi commented May 9, 2023

Uh oh!

vlsi commented May 19, 2023

Uh oh!

vlsi commented Jun 5, 2023

Uh oh!

vlsi commented Jun 5, 2023

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Conversation

FSchumacher commented Apr 29, 2023

Description

Motivation and Context

How Has This Been Tested?

Types of changes

Checklist:

Uh oh!

vlsi May 5, 2023

Choose a reason for hiding this comment

Uh oh!

FSchumacher May 5, 2023

Choose a reason for hiding this comment

Uh oh!

vlsi May 5, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

FSchumacher May 5, 2023

Choose a reason for hiding this comment

Uh oh!

vlsi May 5, 2023

Choose a reason for hiding this comment

Uh oh!

FSchumacher May 5, 2023

Choose a reason for hiding this comment

Uh oh!

vlsi May 5, 2023

Choose a reason for hiding this comment

Uh oh!

vlsi commented May 6, 2023

Uh oh!

vlsi commented May 9, 2023

Uh oh!

vlsi commented May 19, 2023

Uh oh!

vlsi commented Jun 5, 2023

Uh oh!

vlsi commented Jun 5, 2023

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

vlsi May 5, 2023 •

edited

Loading