Incorrect user provider being recorded for server api key users

[nirinchev]

When we persist the user in the metadata Realm, we use the string representation of the provider but we have the same representations for apiKey and serverApiKey:

realm-core/src/realm/object-store/sync/app_credentials.cpp

Lines 33 to 34 in 7b08700

	IdentityProvider const IdentityProviderUserAPIKey = "api-key";
	IdentityProvider const IdentityProviderServerAPIKey = "api-key";

Is this intentional? This has the unpleasant side effect that:

enum_from_provider_type(provider_type_from_enum(AuthProvider::SERVER_API_KEY)) != AuthProvider::SERVER_API_KEY;

And if you log in a user with a server api key credential, their provider will instead be API_KEY.

[sync-by-unito]

➤ James Stone commented:

The set of supported providers is defined by the server and it doesn't look like it has anything called a "Server API Key", just a generic "API key" (source).

I'm not sure how we ended up with two names for the same thing on the client side, perhaps there are historical naming conventions from stitch for providing a synonym. [~[email protected]] do you know? 

In any case I can confirm that they are the same thing under the hood.

[nirinchev]

Interesting, I guess it doesn't make sense to expose different provider types for new SDKs then. cc @cmelchior if you haven't exposed the server api key credentials yet, you may want to opt for a single api key credential type.

[sync-by-unito]

➤ Jason Flax commented:

This was how the original Stitch API was designed. I do not recall when the two providers were flattened into one.