accessToken query param used when AblyRealtime is instantiated with an incorrect API key

[mclark-ably]

Bit of a minor but found a strange behaviour when using ably-java

if the following is used (with an incorrect API key) :

ClientOptions options = new ClientOptions("1234");
options.logLevel = Log.VERBOSE;
AblyRealtime realtime = new AblyRealtime(options); 

The request is made to wss://realtime.ably.io:443/?accessToken=1234 and the error is trying to be made with a token
(ERROR): io.ably.lib.transport.ConnectionManager: onMessage(): ERROR message received; message = Invalid accessToken in request: 1234. (See https://help.ably.io/error/40005 for help.); code = 40005

However with the following:

ClientOptions options = new ClientOptions();
options.logLevel = Log.VERBOSE;
options.key = "12234";
AblyRealtime realtime = new AblyRealtime(options);

The request is made to wss://realtime.ably.io:443/?key=12234 and the error is (ERROR): io.ably.lib.transport.ConnectionManager: onMessage(): ERROR message received; message = Invalid key in request: 12234. (See https://help.ably.io/error/40005 for help.); code = 40005

looks like it comes from the logic in the AuthOptions constructor which sets the client to use token auth if no colon is found in the passed in string

ably-java/lib/src/main/java/io/ably/lib/rest/Auth.java

Line 184 in e0e2317

public AuthOptions(String key) throws AblyException {

┆Issue is synchronized with this Jira Task by Unito

[ttypic]

I don't think it's a bug. The implementation is definitely non-obvious, but we're not going to change it because it would be a breaking change, and some SDK users might rely on this behavior. With the next major release we are going to get rid of public properties in classes and provide idiomatic builders instead.

[mclark-ably]

Thanks @ttypic it was just confusing to see that the SDK logged that it was using token auth e.g.

I/System.out(18365): (INFO): Auth(): using token auth with supplied token only

when the client was instantiated like this (this was from a flutter client on Android)

var clientOptions = ably.ClientOptions(
        key: Env.ablyApiKey,
      );