You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@nifi.apache.org by GitBox <gi...@apache.org> on 2020/09/17 20:32:42 UTC
[GitHub] [nifi] naddym opened a new pull request #4536: NIFI-7816: Correct documentation example for urlEncode function in Ex…
naddym opened a new pull request #4536:
URL: https://github.com/apache/nifi/pull/4536
…pression Language Guide
Thank you for submitting a contribution to Apache NiFi.
Please provide a short description of the PR here:
#### Description of PR
_Enables X functionality; fixes bug NIFI-YYYY._
In order to streamline the review of the contribution we ask you
to ensure the following steps have been taken:
### For all changes:
- [ ] Is there a JIRA ticket associated with this PR? Is it referenced
in the commit message?
- [ ] Does your PR title start with **NIFI-XXXX** where XXXX is the JIRA number you are trying to resolve? Pay particular attention to the hyphen "-" character.
- [ ] Has your PR been rebased against the latest commit within the target branch (typically `main`)?
- [ ] Is your initial contribution a single, squashed commit? _Additional commits in response to PR reviewer feedback should be made on this branch and pushed to allow change tracking. Do not `squash` or use `--force` when pushing to allow for clean monitoring of changes._
### For code changes:
- [ ] Have you ensured that the full suite of tests is executed via `mvn -Pcontrib-check clean install` at the root `nifi` folder?
- [ ] Have you written or updated unit tests to verify your changes?
- [ ] Have you verified that the full build is successful on JDK 8?
- [ ] Have you verified that the full build is successful on JDK 11?
- [ ] If adding new dependencies to the code, are these dependencies licensed in a way that is compatible for inclusion under [ASF 2.0](http://www.apache.org/legal/resolved.html#category-a)?
- [ ] If applicable, have you updated the `LICENSE` file, including the main `LICENSE` file under `nifi-assembly`?
- [ ] If applicable, have you updated the `NOTICE` file, including the main `NOTICE` file found under `nifi-assembly`?
- [ ] If adding new Properties, have you added `.displayName` in addition to .name (programmatic access) for each of the new properties?
### For documentation related changes:
- [ ] Have you ensured that format looks appropriate for the output in which it is rendered?
### Note:
Please ensure that once the PR is submitted, you check GitHub Actions CI for build issues and submit an update to your PR as soon as possible.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [nifi] naddym commented on a change in pull request #4536: NIFI-7816: Correct documentation example for urlEncode function in Ex…
Posted by GitBox <gi...@apache.org>.
naddym commented on a change in pull request #4536:
URL: https://github.com/apache/nifi/pull/4536#discussion_r492214906
##########
File path: nifi-docs/src/main/asciidoc/expression-language-guide.adoc
##########
@@ -1385,7 +1385,7 @@ Each of the following functions will encode a string according the rules of the
*Return Type*: [.returnType]#String#
*Examples*: If we have a URL-Encoded attribute named "url" with the value
- "https://nifi.apache.org/some%20value%20with%20spaces", then the Expression
+ "https%3A%2F%2Fnifi.apache.org%2Fsome+value+with+spaces", then the Expression
Review comment:
Sure, I will make the change. Thanks!
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [nifi] alopresto commented on a change in pull request #4536: NIFI-7816: Correct documentation example for urlEncode function in Ex…
Posted by GitBox <gi...@apache.org>.
alopresto commented on a change in pull request #4536:
URL: https://github.com/apache/nifi/pull/4536#discussion_r492205670
##########
File path: nifi-docs/src/main/asciidoc/expression-language-guide.adoc
##########
@@ -1385,7 +1385,7 @@ Each of the following functions will encode a string according the rules of the
*Return Type*: [.returnType]#String#
*Examples*: If we have a URL-Encoded attribute named "url" with the value
- "https://nifi.apache.org/some%20value%20with%20spaces", then the Expression
+ "https%3A%2F%2Fnifi.apache.org%2Fsome+value+with+spaces", then the Expression
Review comment:
If the previous example was correct, I think _adding_ this example rather than _replacing_ it makes more sense. Both are valid inputs.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [nifi] naddym commented on a change in pull request #4536: NIFI-7816: Correct documentation example for urlEncode function in Ex…
Posted by GitBox <gi...@apache.org>.
naddym commented on a change in pull request #4536:
URL: https://github.com/apache/nifi/pull/4536#discussion_r492214906
##########
File path: nifi-docs/src/main/asciidoc/expression-language-guide.adoc
##########
@@ -1385,7 +1385,7 @@ Each of the following functions will encode a string according the rules of the
*Return Type*: [.returnType]#String#
*Examples*: If we have a URL-Encoded attribute named "url" with the value
- "https://nifi.apache.org/some%20value%20with%20spaces", then the Expression
+ "https%3A%2F%2Fnifi.apache.org%2Fsome+value+with+spaces", then the Expression
Review comment:
Sure, I will make the change. Thanks!
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [nifi] naddym commented on pull request #4536: NIFI-7816: Correct documentation example for urlEncode function in Ex…
Posted by GitBox <gi...@apache.org>.
naddym commented on pull request #4536:
URL: https://github.com/apache/nifi/pull/4536#issuecomment-694677298
Yes @alopresto , The urlEncode() and urlDecode() EL functions uses `URLEncoder.encode()` and `URLDecoder.decode()` methods internally to evaluate the encoding/decodings. The guide shows correct example mapping for urlDecode() but however it reflected incorrect example for urlEncode() function. I'm not sure why but as per the [javadoc](https://docs.oracle.com/javase/8/docs/api/java/net/URLEncoder.html) for these classes, it says following
1. The space character `" " is converted into a plus sign "+"`.
2. All other characters are unsafe and are first converted into one or more bytes using some encoding scheme. `Then each byte is represented by the 3-character string "%xy", where xy is the two-digit hexadecimal representation of the byte`. The recommended encoding scheme to use is UTF-8. However, for compatibility reasons, if an encoding is not specified, then the default encoding of the platform is used.
Further, urlDecode() example in the EL guide was correct despite I have changed it too in order to reflect consistency with urlEncode() example.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [nifi] alopresto merged pull request #4536: NIFI-7816: Correct documentation example for urlEncode function in Ex…
Posted by GitBox <gi...@apache.org>.
alopresto merged pull request #4536:
URL: https://github.com/apache/nifi/pull/4536
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [nifi] alopresto commented on a change in pull request #4536: NIFI-7816: Correct documentation example for urlEncode function in Ex…
Posted by GitBox <gi...@apache.org>.
alopresto commented on a change in pull request #4536:
URL: https://github.com/apache/nifi/pull/4536#discussion_r492205670
##########
File path: nifi-docs/src/main/asciidoc/expression-language-guide.adoc
##########
@@ -1385,7 +1385,7 @@ Each of the following functions will encode a string according the rules of the
*Return Type*: [.returnType]#String#
*Examples*: If we have a URL-Encoded attribute named "url" with the value
- "https://nifi.apache.org/some%20value%20with%20spaces", then the Expression
+ "https%3A%2F%2Fnifi.apache.org%2Fsome+value+with+spaces", then the Expression
Review comment:
If the previous example was correct, I think _adding_ this example rather than _replacing_ it makes more sense. Both are valid inputs.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [nifi] alopresto merged pull request #4536: NIFI-7816: Correct documentation example for urlEncode function in Ex…
Posted by GitBox <gi...@apache.org>.
alopresto merged pull request #4536:
URL: https://github.com/apache/nifi/pull/4536
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [nifi] alopresto commented on pull request #4536: NIFI-7816: Correct documentation example for urlEncode function in Ex…
Posted by GitBox <gi...@apache.org>.
alopresto commented on pull request #4536:
URL: https://github.com/apache/nifi/pull/4536#issuecomment-694502663
I commented on the Jira -- have we investigated why some characters are actually encoded with the `%2F` replacement while spaces are converted to `+`?
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org