Use unpadded url/filename-safe Base64 encoding for Relay global IDs.

ellebrecht · bbakerman · commit 086492daaa9f · 2018-02-15T08:14:16.000+11:00
diff --git a/src/main/java/graphql/relay/Relay.java b/src/main/java/graphql/relay/Relay.java
@@ -237,8 +237,8 @@ public String getId() {
         }
     }
 
-    private static final java.util.Base64.Encoder encoder = java.util.Base64.getEncoder();
-    private static final java.util.Base64.Decoder decoder = java.util.Base64.getDecoder();
+    private static final java.util.Base64.Encoder encoder = java.util.Base64.getUrlEncoder().withoutPadding();
+    private static final java.util.Base64.Decoder decoder = java.util.Base64.getUrlDecoder();
 
     public String toGlobalId(String type, String id) {
         return encoder.encodeToString((type + ":" + id).getBytes(StandardCharsets.UTF_8));
diff --git a/src/test/groovy/graphql/relay/RelayTest.groovy b/src/test/groovy/graphql/relay/RelayTest.groovy
@@ -0,0 +1,35 @@
+package graphql.relay
+
+import spock.lang.Specification
+
+import java.nio.charset.StandardCharsets
+
+class RelayTest extends Specification {
+
+    def urlSafe(String s) {
+        return s == URLEncoder.encode(s, StandardCharsets.UTF_8.name())
+    }
+
+    def "global id encoding is consistent and url-safe"() {
+        given:
+        def relay = new Relay()
+        def type = "Type"
+
+        expect:
+        def globalId = relay.toGlobalId(type, id)
+        def idResolved = relay.fromGlobalId(globalId)
+        type == idResolved.type && id == idResolved.id && urlSafe(globalId)
+
+        where:
+        id                 || base64UrlSafeReference
+        'null'             || 'VHlwZTpudWxs'
+        ''                 || 'VHlwZTo'
+        '1'                || 'VHlwZTox'
+        '99'               || 'VHlwZTo5OQ'
+        'abc'              || 'VHlwZTphYmM'
+        '.,-:;_=?()/&%$§!' || 'VHlwZTouLC06O189PygpLyYlJMKnIQ'
+        '~abc'             || 'VHlwZTp-YWJj'
+        '?_graphql'        || 'VHlwZTo_X2dyYXBocWw'
+    }
+
+}

Original file line number	Diff line number	Diff line change
`@@ -237,8 +237,8 @@ public String getId() {`
`237`	`237`	`}`
`238`	`238`	`}`
`239`	`239`
`240`		`- private static final java.util.Base64.Encoder encoder = java.util.Base64.getEncoder();`
`241`		`- private static final java.util.Base64.Decoder decoder = java.util.Base64.getDecoder();`
	`240`	`+ private static final java.util.Base64.Encoder encoder = java.util.Base64.getUrlEncoder().withoutPadding();`
	`241`	`+ private static final java.util.Base64.Decoder decoder = java.util.Base64.getUrlDecoder();`
`242`	`242`
`243`	`243`	`public String toGlobalId(String type, String id) {`
`244`	`244`	`return encoder.encodeToString((type + ":" + id).getBytes(StandardCharsets.UTF_8));`