JCL-426: Normalize URI resource identifiers (#777)

Author: acoburn

access-grant/src/main/java/com/inrupt/client/accessgrant/AccessCredential.java

@@ -64,7 +64,7 @@ public class AccessCredential {
      */
     protected AccessCredential(final URI identifier, final String credential,
             final CredentialData data, final CredentialMetadata metadata) {
-        this.identifier = Objects.requireNonNull(identifier, "identifier may not be null");
+        this.identifier = Objects.requireNonNull(identifier, "identifier may not be null").normalize();
         this.credential = Objects.requireNonNull(credential, "credential may not be null!");
         Objects.requireNonNull(data, "credential data may not be null!");
         Objects.requireNonNull(metadata, "credential metadata may not be null!");

api/src/main/java/com/inrupt/client/NonRDFSource.java

@@ -63,7 +63,7 @@ protected NonRDFSource(final URI identifier, final String contentType, final Inp
      */
     protected NonRDFSource(final URI identifier, final String contentType, final InputStream entity,
             final Headers headers) {
-        this.identifier = Objects.requireNonNull(identifier, "identifier may not be null!");
+        this.identifier = Objects.requireNonNull(identifier, "identifier may not be null!").normalize();
         this.contentType = Objects.requireNonNull(contentType, "contentType may not be null!");
         this.entity = Objects.requireNonNull(entity, "entity may not be null!");
         this.headers = headers == null ? Headers.empty() : headers;

api/src/main/java/com/inrupt/client/RDFSource.java

@@ -30,6 +30,7 @@
 import java.io.InputStream;
 import java.io.OutputStream;
 import java.net.URI;
+import java.util.Objects;
 
 import org.apache.commons.rdf.api.Dataset;
 import org.apache.commons.rdf.api.RDF;
@@ -102,8 +103,8 @@ protected RDFSource(final URI identifier, final RDFSyntax syntax, final Dataset
     protected RDFSource(final URI identifier, final RDFSyntax syntax, final Dataset dataset, final Headers headers) {
         super(dataset == null ? rdf.createDataset() : dataset);
         this.headers = headers == null ? Headers.empty() : headers;
-        this.identifier = identifier;
-        this.syntax = syntax;
+        this.identifier = Objects.requireNonNull(identifier, "identifier may not be null!").normalize();
+        this.syntax = Objects.requireNonNull(syntax);
     }
 
     @Override

api/src/main/java/com/inrupt/client/Request.java

@@ -117,7 +117,7 @@ public static Builder newBuilder(final URI uri) {
 
     Request(final URI uri, final String method, final Map<String, List<String>> headers,
             final BodyPublisher publisher, final Duration timeout) {
-        this.requestUri = Objects.requireNonNull(uri, "Request URI may not be null!");
+        this.requestUri = Objects.requireNonNull(uri, "Request URI may not be null!").normalize();
         this.requestMethod = Objects.requireNonNull(method, "Request method may not be null!");
         this.requestHeaders = Headers.of(Objects.requireNonNull(headers, "Request headers may not be null!"));
         this.requestTimeout = timeout;

api/src/main/java/com/inrupt/client/util/URIBuilder.java

@@ -111,7 +111,7 @@ public URI build() {
             schemeSpecificPart.append(String.join("&", queryParams));
         }
         try {
-            return new URI(scheme, schemeSpecificPart.toString(), uriFragment);
+            return new URI(scheme, schemeSpecificPart.toString(), uriFragment).normalize();
         } catch (final URISyntaxException ex) {
             throw new IllegalArgumentException("Invalid URI value", ex);
         }

api/src/test/java/com/inrupt/client/util/URIBuilderTest.java

@@ -142,4 +142,13 @@ void testBuildNullBlankPath() {
 
         assertEquals(expected, URIBuilder.newBuilder(uri).path(null).path("").path("/data/").build());
     }
+
+    @Test
+    void testNormalized() {
+        final URI uri = URI.create("https://storage.example/container1/../container2/");
+        final URI expected = URI.create("https://storage.example/container2/");
+
+        assertNotEquals(expected, uri);
+        assertEquals(expected, URIBuilder.newBuilder(uri).build());
+    }
 }

solid/src/main/java/com/inrupt/client/solid/SolidClient.java

@@ -130,10 +130,11 @@ public <T extends Resource> CompletionStage<T> read(final URI identifier, final
         defaultHeaders.firstValue(USER_AGENT).ifPresent(agent -> builder.setHeader(USER_AGENT, agent));
         headers.firstValue(USER_AGENT).ifPresent(agent -> builder.setHeader(USER_AGENT, agent));
 
-        return client.send(builder.build(), Response.BodyHandlers.ofByteArray())
+        final Request request = builder.build();
+        return client.send(request, Response.BodyHandlers.ofByteArray())
             .thenApply(response -> {
                 if (response.statusCode() >= ERROR_STATUS) {
-                    throw SolidClientException.handle("Unable to read resource at " + identifier, identifier,
+                    throw SolidClientException.handle("Unable to read resource at " + request.uri(), request.uri(),
                             response.statusCode(), response.headers(), new String(response.body()));
                 } else {
                     final String contentType = response.headers().firstValue(CONTENT_TYPE)
@@ -142,8 +143,8 @@ public <T extends Resource> CompletionStage<T> read(final URI identifier, final
                         // Check that this is an RDFSoure
                         if (RDFSource.class.isAssignableFrom(clazz)) {
                             final Dataset dataset = SolidResourceHandlers.buildDataset(contentType, response.body(),
-                                    identifier.toString()).orElse(null);
-                            final T obj = construct(identifier, clazz, dataset, response.headers());
+                                    request.uri().toString()).orElse(null);
+                            final T obj = construct(request.uri(), clazz, dataset, response.headers());
                             final ValidationResult res = RDFSource.class.cast(obj).validate();
                             if (!res.isValid()) {
                                 throw new DataMappingException(
@@ -153,7 +154,7 @@ public <T extends Resource> CompletionStage<T> read(final URI identifier, final
                             return obj;
                         // Otherwise, create a non-RDF-bearing resource
                         } else {
-                            return construct(identifier, clazz, contentType,
+                            return construct(request.uri(), clazz, contentType,
                                     new ByteArrayInputStream(response.body()), response.headers());
                         }
                     } catch (final ReflectiveOperationException ex) {