Mistake in type docs about omit user key

[timwangdev]

js-sdk-common/typings.d.ts

Lines 266 to 280 in 05a82f9

	/**
	* A LaunchDarkly user object.
	*/
	export interface LDUser {
	/**
	* A unique string identifying a user.
	*
	* If you omit this property, and also set `anonymous` to `true`, the SDK will generate a UUID string
	* and use that as the key; it will attempt to persist that value in local storage if possible so the
	* next anonymous user will get the same key, but if local storage is unavailable then it will
	* generate a new key each time you specify the user.
	*
	* It is an error to omit the `key` property if `anonymous` is not set.
	*/
	key?: string;

Hi, I found this line of description was not very clear. It says If you omit this property, and also set anonymous to true it should work, and It is an error to omit the key property if anonymous is not set..

However, if you omit the key or set the key to null or undefined, it would always return an error, no matter the anonymous is set or not.

I don't know what is the expected behavior here.

[eli-darkly]

However, if you omit the key or set the key to null or undefined, it would always return an error, no matter the anonymous is set or not

Are you saying that that is what you are actually seeing in practice? Like, you have tried omitting the key and setting anonymous to true, and the SDK did not generate a UUID key but instead threw an error? It is supposed to generate one; if it doesn't, that's a bug, not a documentation mistake.

Also, if so, it would be helpful to know which SDK (and which version) you are using. This repo is common code that is used by several SDKs.

[timwangdev]

Hi @eli-darkly, I've tried omitting the key and setting anonymous to true, the API still returns an error. And I've checked the request the decoded base64 JSON key is missing.

But, I've checked the SDK we used, it's an older version ldclient-js which may not support this. This issue may not be relevant to the newer SDK version. Sorry about that and it's ok to close this issue.

[eli-darkly]

@timwangdev Auto-generation of a key has been supported since v2.10.0. If you're using a version earlier than that, then that would explain it. If not, then in order to investigate this we would need more information such as 1. what version are you using, 2. example code of how you're initializing the SDK, 3. what is the error.

[timwangdev]

@eli-darkly we are using the version ldclient-js: 2.4.0. I'll try to update it to a newer version to see if it works.
Basically we are using a system-generated id, for user keys, but sometimes the id was not reliable (eg. for new accounts), passing null value would have initialization error reports from LD API and the user could not get the FFs. We expect LD could still work in the anonymous mode.

[timwangdev]

Hi @eli-darkly , sorry for the late update. We migrate our code from an internal wrapper to the latest launchdarkly-js-client-sdk and the anonymous mode without user key works fine. I'm closing this issue now, thanks!