DSN Object Equals Method Broken

The DSN Object’s equals method currently does not work as expected. Because the secret key is deprecated from the DSN, it is no longer required for a valid DSN object, however if the DSN is null, two equal DSN objects will throw a null pointer exception on the string comparison of these keys because null does not have an equals method. This can be resolved by using the Java standard library Objects.equals method as shown below.

Broken Code Dsn.equals line 293

        if (!secretKey.equals(dsn.secretKey)) {
            return false;
        }

Example

    @Test(expected = NullPointerException::class)
    fun selfContainedCompleteExample() {
        val dsn1 = Dsn("http://[e-mail]/0")
        val dsn2 = Dsn("http://[e-mail]/0")
        assertThat(dsn1, equalTo(dsn2))
    }

Solution

       if (!Objects.equals(secretKey, dsn.secretKey)) {
            return false;
        }

Solution Proof

    @Test
    fun solutionProof() {
        assertThat(true, equalTo(Objects.equals("test", "test")))
        assertThat(true, equalTo(Objects.equals(null, null)))
    }

[ninniuz]

@mayt017 I think either way would do ok (but you should probably wait for project owners to give advice). There is a Util class which is used to, among other things, check if a string is null or empty (https://github.com/getsentry/sentry-java/blob/master/sentry/src/main/java/io/sentry/util/Util.java#L26). Maybe something like Util.equals(Object a, Object b)?

[justacodefan]

Closing as the PR is merged.