Success Match syntax

[lgwapnitsky]

I'm trying to use the success match in an HTTP request to match the status code, but am running into barriers.

What is the proper format?

Thanks

[jhuckaby]

The HTTP Request Plugin's "Success Match" field is a regular expression match only, which matches text content in the HTTP response body. It is not an expression evaluator, alas.

Docs: https://docs.xyops.io/#Docs/plugins/http-request-plugin

I see that you're trying to gate success on the HTTP response code. Unfortunately the HTTP Request Plugin is hard-coded to assume any HTTP response codes between 200 - 399 are all "success".

If you need anything non-200 to be regarded as an error, your options are: use a shell tool like curl which has command-line switches for things like this, or use a xyOps Workflow with a Decision Controller that can direct the flow based on the outcome of the HTTP request data. Example:

[ovizii]

Are you saying that simply entering {{data.json.success}} in the success match AND error match field will automatically evaluate those?

I must be having a blonde moment, but I don't quite understand the difference between the docs:

Optionally enter a regular expression here, which is matched against the response body. If specified, this must match to consider the job a success.

And your sentence:

The HTTP Request Plugin's "Success Match" field is a regular expression match only, which matches text content in the HTTP response body. It is not an expression evaluator, alas.

Also, does this mean that we do not need the success and error matches since the plugin automatically evaluates HTTP response codes?

I see that you're trying to gate success on the HTTP response code. Unfortunately the HTTP Request Plugin is hard-coded to assume any HTTP response codes between 200 - 399 are all "success".

[jhuckaby]

So, there is quite a bit of confusion in this discussion thread. Honestly, we should probably just close it, because I feel that it sends people down the wrong path.

The original author was trying to use the HTTP Request Plugin's "Success Match" text field as a full expression eval, which doesn't work in the way he was trying in his original screenshot.

All text-field-based Plugin parameters do support {{mustache-style}} placeholder substitution, to pull in values from previous job output data, etc. But the result of this is just a plain string. It is not an "expression evaluation". Meaning, OP's use of the "== 200" has no meaning in this case. The "Success Match" is not evaluating an expression for true / false. It's literally just a string substitution, which in this case is used as a regular expression (after any {{macros}} are expanded).

Now, separately, here is how the HTTP Plugin works. It always uses the HTTP response code to gauge success or failure first. If the HTTP response code is outside of the 200 - 399 range, then it throws an error, full stop. The "Success Match" and "Error Match" are not even considered in that case.

But, if the HTTP response code is within the successful range (200 - 399), and a "Success Match" or "Error Match" is present, then it uses those as regular expression matches against the HTTP response raw body. Here is how the logic works:

• If the HTTP response is outside of the 200 - 399 range, then the job fails.
• If the HTTP response code is 200 - 399, and "Success Match" is specified, and it matches against the response body, then the job is marked as successful.
• If the HTTP response code is 200 - 399, and "Success Match" is specified, and it does NOT match against the response body, then the job fails.
• If the HTTP response code is 200 - 399, and "Error Match" is specified, and it matches against the response body, then the job fails.
• If the HTTP response code is 200 - 399, and "Error Match" is specified, and it does NOT match against the response body, then the job is marked as successful.

The entire code for the Success Match / Error Match is very simple: https://github.com/pixlcore/xysat/blob/main/plugins/http-plugin.js#L132-L139

So, separately from this Success/Error match feature, which is unique to the HTTP Request Plugin, all Plugin text fields support basic placeholder substitution, using the job input data as context. So they can use data from previous jobs if they are linked together (by workflow nodes or actions, etc.).

Hope this helps.

[ovizii]

Thank you so much! That was the missing explanation. Once you know how it works, its very easy ;-)