Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improving tests and edge cases for URI and HTTP #8497

Merged
merged 34 commits into from
Dec 15, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
34 commits
Select commit Hold shift + click to select a range
4c50256
WIP
radeusgd Dec 4, 2023
a250d3c
Fetch tests
radeusgd Dec 4, 2023
381bc29
checkpoint
radeusgd Dec 4, 2023
007e928
reduce duplicate code in tests
radeusgd Dec 4, 2023
7c693cb
checkpoint
radeusgd Dec 5, 2023
3b12d28
URI_With_Query tests, extending http server to report query params; f…
radeusgd Dec 6, 2023
d7492d6
another fix, get proper roundtrip test for query argument encoding
radeusgd Dec 6, 2023
44c2a5c
checkpoint - start relying on httpclient utils for URL encoding of qu…
radeusgd Dec 6, 2023
4b8818f
use new logic in secrets
radeusgd Dec 6, 2023
823c0f8
clean
radeusgd Dec 6, 2023
73fe903
a few more cases
radeusgd Dec 6, 2023
02e5b49
clean
radeusgd Dec 7, 2023
750d3c7
trying to test HTTP_Error but nothing works
radeusgd Dec 7, 2023
ce26830
Revert "trying to test HTTP_Error but nothing works"
radeusgd Dec 7, 2023
e018dc1
test also to_uri query
radeusgd Dec 7, 2023
f8ad5fd
WIP testing http response code errors, some auth, response headers
radeusgd Dec 7, 2023
0432ef8
checkpoint: WIP on improving handling of non-200 status codes, fixing…
radeusgd Dec 7, 2023
78f8386
fixing error handling tests
radeusgd Dec 7, 2023
bb4c176
impl endpoint for the header response test
radeusgd Dec 7, 2023
4d93f9d
checkpoint
radeusgd Dec 7, 2023
7f0d05d
WIP: auth tests
radeusgd Dec 7, 2023
a6956a3
make simple-httpbin easier to debug by printing stack trace in all ha…
radeusgd Dec 7, 2023
c590749
test crash
radeusgd Dec 7, 2023
e30a46f
small test fixes
radeusgd Dec 7, 2023
e97c6a3
test multi headers
radeusgd Dec 7, 2023
ba4c2f4
simplify handling of headers in the EnsoHttpResponse
radeusgd Dec 7, 2023
3f54d64
add some simple tests for JS_Object.into Map
radeusgd Dec 7, 2023
addd10b
javafmt
radeusgd Dec 7, 2023
f951403
add a conversion, add one more edge case test
radeusgd Dec 8, 2023
9cd19a1
Merge branch 'develop' into wip/radeusgd/8352-cloud-followup-1
radeusgd Dec 15, 2023
2230345
Adding licenses to the std-base Apache httpclient dependency
radeusgd Dec 15, 2023
13b4815
Merge branch 'develop' into wip/radeusgd/8352-cloud-followup-1
radeusgd Dec 15, 2023
bcc9572
fix a test
radeusgd Dec 15, 2023
321db41
javafmt
radeusgd Dec 15, 2023
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 5 additions & 3 deletions build.sbt
Original file line number Diff line number Diff line change
Expand Up @@ -2326,8 +2326,9 @@ lazy val `std-base` = project
Compile / packageBin / artifactPath :=
`base-polyglot-root` / "std-base.jar",
libraryDependencies ++= Seq(
"org.graalvm.polyglot" % "polyglot" % graalMavenPackagesVersion,
"org.netbeans.api" % "org-openide-util-lookup" % netbeansApiVersion % "provided"
"org.graalvm.polyglot" % "polyglot" % graalMavenPackagesVersion,
"org.apache.httpcomponents" % "httpclient" % httpComponentsVersion,
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Are we adding dependency on an external library to std-base just be able to emit HTTP request? What's wrong with JDK only solution?

Copy link
Member Author

@radeusgd radeusgd Dec 15, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We are still using JDK's httpclient for the requests (see EnsoSecretHelper.java).

The functionality that was missing was the URIBuilder that allows us to build a set of query parameters and correctly encode them. The task is not trivial as it requires escaping of various control characters depending on context (sometimes = sometimes not, & etc.) as well as escaping non-standard Unicode symbols.

We had our own simple implementation but it was missing functionalities.

Instead of trying to understand the RFC 3986 and trying to carefully implement and test that we are doing everything according to the specification, I thought it will be far simpler to use an existing solution.

If that ever turns out to be problematic, we could roll our own - but it seems like an overkill if an existing solution exists.

Note that in subsequent PRs (#8544) I plan to extend using this functionality. The URIBuilder allows us to easily parse the existing query and modify it in any way we need, as well as it allows us to parse and modify the URI path and all the other components. The JDK provides only very limited funcionality for that (e.g. we don't get the parsing of the query arugments that we need to be able to manipulate them).

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copy link
Member

@JaroslavTulach JaroslavTulach Dec 18, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There is URLEncoder which has been good enough for all my purposes so far.

I continue to be convinced that

adding dependency on (another) external library to std-base

isn't good idea.

"org.netbeans.api" % "org-openide-util-lookup" % netbeansApiVersion % "provided"
),
Compile / packageBin := Def.task {
val result = (Compile / packageBin).value
Expand Down Expand Up @@ -2744,7 +2745,8 @@ lazy val `simple-httpbin` = project
Compile / run / mainClass := Some("org.enso.shttp.SimpleHTTPBin"),
assembly / mainClass := (Compile / run / mainClass).value,
libraryDependencies ++= Seq(
"org.apache.commons" % "commons-text" % commonsTextVersion
"org.apache.commons" % "commons-text" % commonsTextVersion,
"org.apache.httpcomponents" % "httpclient" % httpComponentsVersion
),
(Compile / run / fork) := true,
(Compile / run / connectInput) := true
Expand Down
20 changes: 20 additions & 0 deletions distribution/lib/Standard/Base/0.0.0-dev/THIRD-PARTY/NOTICE
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,26 @@ The license information can be found along with the copyright notices.
Copyright notices related to this dependency can be found in the directory `com.ibm.icu.icu4j-73.1`.


'commons-codec', licensed under the The Apache Software License, Version 2.0, is distributed with the Base.
The license information can be found along with the copyright notices.
Copyright notices related to this dependency can be found in the directory `commons-codec.commons-codec-1.9`.


'commons-logging', licensed under the The Apache Software License, Version 2.0, is distributed with the Base.
The license file can be found at `licenses/APACHE2.0`.
Copyright notices related to this dependency can be found in the directory `commons-logging.commons-logging-1.2`.


'httpclient', licensed under the Apache License, Version 2.0, is distributed with the Base.
The license file can be found at `licenses/APACHE2.0`.
Copyright notices related to this dependency can be found in the directory `org.apache.httpcomponents.httpclient-4.4.1`.


'httpcore', licensed under the Apache License, Version 2.0, is distributed with the Base.
The license information can be found along with the copyright notices.
Copyright notices related to this dependency can be found in the directory `org.apache.httpcomponents.httpcore-4.4.1`.


'polyglot', licensed under the Universal Permissive License, Version 1.0, is distributed with the Base.
The license file can be found at `licenses/Universal_Permissive_License__Version_1.0`.
Copyright notices related to this dependency can be found in the directory `org.graalvm.polyglot.polyglot-23.1.0`.
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,202 @@

Apache License
Version 2.0, January 2004
http://www.apache.org/licenses/

TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION

1. Definitions.

"License" shall mean the terms and conditions for use, reproduction,
and distribution as defined by Sections 1 through 9 of this document.

"Licensor" shall mean the copyright owner or entity authorized by
the copyright owner that is granting the License.

"Legal Entity" shall mean the union of the acting entity and all
other entities that control, are controlled by, or are under common
control with that entity. For the purposes of this definition,
"control" means (i) the power, direct or indirect, to cause the
direction or management of such entity, whether by contract or
otherwise, or (ii) ownership of fifty percent (50%) or more of the
outstanding shares, or (iii) beneficial ownership of such entity.

"You" (or "Your") shall mean an individual or Legal Entity
exercising permissions granted by this License.

"Source" form shall mean the preferred form for making modifications,
including but not limited to software source code, documentation
source, and configuration files.

"Object" form shall mean any form resulting from mechanical
transformation or translation of a Source form, including but
not limited to compiled object code, generated documentation,
and conversions to other media types.

"Work" shall mean the work of authorship, whether in Source or
Object form, made available under the License, as indicated by a
copyright notice that is included in or attached to the work
(an example is provided in the Appendix below).

"Derivative Works" shall mean any work, whether in Source or Object
form, that is based on (or derived from) the Work and for which the
editorial revisions, annotations, elaborations, or other modifications
represent, as a whole, an original work of authorship. For the purposes
of this License, Derivative Works shall not include works that remain
separable from, or merely link (or bind by name) to the interfaces of,
the Work and Derivative Works thereof.

"Contribution" shall mean any work of authorship, including
the original version of the Work and any modifications or additions
to that Work or Derivative Works thereof, that is intentionally
submitted to Licensor for inclusion in the Work by the copyright owner
or by an individual or Legal Entity authorized to submit on behalf of
the copyright owner. For the purposes of this definition, "submitted"
means any form of electronic, verbal, or written communication sent
to the Licensor or its representatives, including but not limited to
communication on electronic mailing lists, source code control systems,
and issue tracking systems that are managed by, or on behalf of, the
Licensor for the purpose of discussing and improving the Work, but
excluding communication that is conspicuously marked or otherwise
designated in writing by the copyright owner as "Not a Contribution."

"Contributor" shall mean Licensor and any individual or Legal Entity
on behalf of whom a Contribution has been received by Licensor and
subsequently incorporated within the Work.

2. Grant of Copyright License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
copyright license to reproduce, prepare Derivative Works of,
publicly display, publicly perform, sublicense, and distribute the
Work and such Derivative Works in Source or Object form.

3. Grant of Patent License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
(except as stated in this section) patent license to make, have made,
use, offer to sell, sell, import, and otherwise transfer the Work,
where such license applies only to those patent claims licensable
by such Contributor that are necessarily infringed by their
Contribution(s) alone or by combination of their Contribution(s)
with the Work to which such Contribution(s) was submitted. If You
institute patent litigation against any entity (including a
cross-claim or counterclaim in a lawsuit) alleging that the Work
or a Contribution incorporated within the Work constitutes direct
or contributory patent infringement, then any patent licenses
granted to You under this License for that Work shall terminate
as of the date such litigation is filed.

4. Redistribution. You may reproduce and distribute copies of the
Work or Derivative Works thereof in any medium, with or without
modifications, and in Source or Object form, provided that You
meet the following conditions:

(a) You must give any other recipients of the Work or
Derivative Works a copy of this License; and

(b) You must cause any modified files to carry prominent notices
stating that You changed the files; and

(c) You must retain, in the Source form of any Derivative Works
that You distribute, all copyright, patent, trademark, and
attribution notices from the Source form of the Work,
excluding those notices that do not pertain to any part of
the Derivative Works; and

(d) If the Work includes a "NOTICE" text file as part of its
distribution, then any Derivative Works that You distribute must
include a readable copy of the attribution notices contained
within such NOTICE file, excluding those notices that do not
pertain to any part of the Derivative Works, in at least one
of the following places: within a NOTICE text file distributed
as part of the Derivative Works; within the Source form or
documentation, if provided along with the Derivative Works; or,
within a display generated by the Derivative Works, if and
wherever such third-party notices normally appear. The contents
of the NOTICE file are for informational purposes only and
do not modify the License. You may add Your own attribution
notices within Derivative Works that You distribute, alongside
or as an addendum to the NOTICE text from the Work, provided
that such additional attribution notices cannot be construed
as modifying the License.

You may add Your own copyright statement to Your modifications and
may provide additional or different license terms and conditions
for use, reproduction, or distribution of Your modifications, or
for any such Derivative Works as a whole, provided Your use,
reproduction, and distribution of the Work otherwise complies with
the conditions stated in this License.

5. Submission of Contributions. Unless You explicitly state otherwise,
any Contribution intentionally submitted for inclusion in the Work
by You to the Licensor shall be under the terms and conditions of
this License, without any additional terms or conditions.
Notwithstanding the above, nothing herein shall supersede or modify
the terms of any separate license agreement you may have executed
with Licensor regarding such Contributions.

6. Trademarks. This License does not grant permission to use the trade
names, trademarks, service marks, or product names of the Licensor,
except as required for reasonable and customary use in describing the
origin of the Work and reproducing the content of the NOTICE file.

7. Disclaimer of Warranty. Unless required by applicable law or
agreed to in writing, Licensor provides the Work (and each
Contributor provides its Contributions) on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
implied, including, without limitation, any warranties or conditions
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
PARTICULAR PURPOSE. You are solely responsible for determining the
appropriateness of using or redistributing the Work and assume any
risks associated with Your exercise of permissions under this License.

8. Limitation of Liability. In no event and under no legal theory,
whether in tort (including negligence), contract, or otherwise,
unless required by applicable law (such as deliberate and grossly
negligent acts) or agreed to in writing, shall any Contributor be
liable to You for damages, including any direct, indirect, special,
incidental, or consequential damages of any character arising as a
result of this License or out of the use or inability to use the
Work (including but not limited to damages for loss of goodwill,
work stoppage, computer failure or malfunction, or any and all
other commercial damages or losses), even if such Contributor
has been advised of the possibility of such damages.

9. Accepting Warranty or Additional Liability. While redistributing
the Work or Derivative Works thereof, You may choose to offer,
and charge a fee for, acceptance of support, warranty, indemnity,
or other liability obligations and/or rights consistent with this
License. However, in accepting such obligations, You may act only
on Your own behalf and on Your sole responsibility, not on behalf
of any other Contributor, and only if You agree to indemnify,
defend, and hold each Contributor harmless for any liability
incurred by, or claims asserted against, such Contributor by reason
of your accepting any such warranty or additional liability.

END OF TERMS AND CONDITIONS

APPENDIX: How to apply the Apache License to your work.

To apply the Apache License to your work, attach the following
boilerplate notice, with the fields enclosed by brackets "[]"
replaced with your own identifying information. (Don't include
the brackets!) The text should be enclosed in the appropriate
comment syntax for the file format. We also recommend that a
file or class name and description of purpose be included on the
same "printed page" as the copyright notice for easier
identification within third-party archives.

Copyright [yyyy] [name of copyright owner]

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
Apache Commons Codec
Copyright 2002-2013 The Apache Software Foundation

This product includes software developed at
The Apache Software Foundation (http://www.apache.org/).

src/test/org/apache/commons/codec/language/DoubleMetaphoneTest.java
contains test data from http://aspell.net/test/orig/batch0.tab.
Copyright (C) 2002 Kevin Atkinson ([email protected])
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
Apache Commons Logging
Copyright 2003-2014 The Apache Software Foundation

This product includes software developed at
The Apache Software Foundation (http://www.apache.org/).

Loading
Loading