fix: Improvements and fixes from docs review. (#362)

These are discovered after the docs PR review:

* Client sdk default baseUri should be clientsdk.launchdarkly instead of
sdk.launchdarkly.
* Add getConnectionMode.
* Remove identify hash arg.
* Change rn default logging to info.
* Add debug config option.
* Add comments about autoEnv applicationInfo.
* Remove LDProvider context prop.

---------

Co-authored-by: Ryan Lamb <[email protected]>

Author: yusinto

packages/sdk/react-native/example/App.tsx

@@ -8,7 +8,13 @@ import {
 
 import Welcome from './src/welcome';
 
-const featureClient = new ReactNativeLDClient(MOBILE_KEY, AutoEnvAttributes.Enabled);
+const featureClient = new ReactNativeLDClient(MOBILE_KEY, AutoEnvAttributes.Enabled, {
+  debug: true,
+  applicationInfo: {
+    id: 'ld-rn-test-app',
+    version: '0.0.1',
+  },
+});
 
 const App = () => {
   return (

packages/sdk/react-native/example/tsconfig.json

@@ -1,9 +1,9 @@
 {
   "extends": "expo/tsconfig.base",
   "compilerOptions": {
-    "jsx": "react",
+    "jsx": "react-jsx",
     "strict": true,
-    "typeRoots": ["./types"]
+    "typeRoots": ["./types"],
   },
-  "exclude": ["e2e"]
+  "exclude": ["e2e"],
 }

packages/sdk/react-native/src/ReactNativeLDClient.test.ts

@@ -16,7 +16,7 @@ describe('ReactNativeLDClient', () => {
       diagnosticEventPath: '/mobile/events/diagnostic',
       events: 'https://events.launchdarkly.com',
       includeAuthorizationHeader: true,
-      polling: 'https://sdk.launchdarkly.com',
+      polling: 'https://clientsdk.launchdarkly.com',
       streaming: 'https://clientstream.launchdarkly.com',
     });
   });

packages/sdk/react-native/src/ReactNativeLDClient.ts

@@ -35,10 +35,11 @@ export default class ReactNativeLDClient extends LDClientImpl {
    * @param options {@link LDOptions} to initialize the client with.
    */
   constructor(sdkKey: string, autoEnvAttributes: AutoEnvAttributes, options: LDOptions = {}) {
+    const { logger: customLogger, debug } = options;
     const logger =
-      options.logger ??
+      customLogger ??
       new BasicLogger({
-        level: 'debug',
+        level: debug ? 'debug' : 'info',
         // eslint-disable-next-line no-console
         destination: console.log,
       });

packages/sdk/react-native/src/platform/autoEnv.ts

@@ -5,20 +5,22 @@ import type { LDApplication, LDDevice } from '@launchdarkly/js-client-sdk-common
 import locale from './locale';
 
 export const ldApplication: LDApplication = {
-  // key is populated by client common sdk
+  // key is populated by common/client-sdk
   key: '',
   envAttributesVersion: '1.0',
 
-  // TODO: populate application ID, name, version, versionName
+  locale,
+
+  // These are not automatically generated. Use LDOptions.applicationInfo
+  // to specify these values.
   id: '',
   name: '',
   version: '',
   versionName: '',
-  locale,
 };
 
 export const ldDevice: LDDevice = {
-  // key is populated by client common sdk
+  // key is populated by common/client-sdk
   key: '',
   envAttributesVersion: '1.0',
   manufacturer: Platform.select({

packages/sdk/react-native/src/provider/LDProvider.test.tsx

@@ -23,7 +23,6 @@ const TestApp = () => {
 };
 describe('LDProvider', () => {
   let ldc: ReactNativeLDClient;
-  let context: LDContext;
   const mockSetupListeners = setupListeners as jest.Mock;
 
   beforeEach(() => {
@@ -51,7 +50,6 @@ describe('LDProvider', () => {
       setState({ client });
     });
     ldc = new ReactNativeLDClient('mobile-key', AutoEnvAttributes.Enabled);
-    context = { kind: 'user', key: 'test-user-key-1' };
   });
 
   afterEach(() => {
@@ -69,31 +67,4 @@ describe('LDProvider', () => {
     expect(getByText(/mobilekey mobile-key/i)).toBeTruthy();
     expect(getByText(/context undefined/i)).toBeTruthy();
   });
-
-  test('specified context is identified', async () => {
-    const { getByText } = render(
-      <LDProvider client={ldc} context={context}>
-        <TestApp />
-      </LDProvider>,
-    );
-
-    expect(mockSetupListeners).toHaveBeenCalledWith(ldc, expect.any(Function));
-    expect(ldc.identify).toHaveBeenCalledWith(context);
-    expect(ldc.getContext()).toEqual(context);
-    expect(getByText(/context defined/i)).toBeTruthy();
-  });
-
-  test('identify errors are caught', async () => {
-    (ldc.identify as jest.Mock).mockImplementation(() =>
-      Promise.reject(new Error('faking error when identifying')),
-    );
-    render(
-      <LDProvider client={ldc} context={context}>
-        <TestApp />
-      </LDProvider>,
-    );
-    await jest.runAllTimersAsync();
-
-    expect(ldc.logger.debug).toHaveBeenCalledWith(expect.stringMatching(/identify error/));
-  });
 });

packages/sdk/react-native/src/provider/LDProvider.tsx

@@ -1,15 +1,12 @@
 import React, { PropsWithChildren, useEffect, useState } from 'react';
 
-import { type LDContext } from '@launchdarkly/js-client-sdk-common';
-
 import ReactNativeLDClient from '../ReactNativeLDClient';
 import { Provider, ReactContext } from './reactContext';
 import setupListeners from './setupListeners';
 import useAppState from './useAppState';
 
 type LDProps = {
   client: ReactNativeLDClient;
-  context?: LDContext;
 };
 
 /**
@@ -18,25 +15,15 @@ type LDProps = {
  *
  * @param client The ReactNativeLDClient object. Initialize this object separately
  * and then set this prop when declaring the LDProvider.
- * @param context Optional. The LDContext object. If set, the LDProvider will
- * `identify` this context on application mount. If not set, default flag values
- * will be returned. You can run `identify` at a later time.
  * @param children
+ *
  * @constructor
  */
-const LDProvider = ({ client, context, children }: PropsWithChildren<LDProps>) => {
+const LDProvider = ({ client, children }: PropsWithChildren<LDProps>) => {
   const [state, setState] = useState<ReactContext>({ client });
 
   useEffect(() => {
     setupListeners(client, setState);
-
-    if (context) {
-      client
-        .identify(context)
-        .catch((e: any) =>
-          client.logger.debug(`LaunchDarkly React Native Sdk identify error: ${e}`),
-        );
-    }
   }, []);
 
   useAppState(client);

packages/shared/sdk-client/src/LDClientImpl.test.ts

@@ -69,7 +69,7 @@ describe('sdk-client object', () => {
 
     expect(ldc.config).toMatchObject({
       allAttributesPrivate: false,
-      baseUri: 'https://sdk.launchdarkly.com',
+      baseUri: 'https://clientsdk.launchdarkly.com',
       capacity: 100,
       diagnosticOptOut: false,
       diagnosticRecordingInterval: 900,
@@ -87,7 +87,7 @@ describe('sdk-client object', () => {
       sendLDHeaders: true,
       serviceEndpoints: {
         events: 'https://events.launchdarkly.com',
-        polling: 'https://sdk.launchdarkly.com',
+        polling: 'https://clientsdk.launchdarkly.com',
         streaming: 'https://clientstream.launchdarkly.com',
       },
       streamInitialReconnectDelay: 1,

packages/shared/sdk-client/src/LDClientImpl.ts

@@ -78,6 +78,11 @@ export default class LDClientImpl implements LDClient {
     this.emitter = new LDEmitter();
   }
 
+  /**
+   * Sets the SDK connection mode.
+   *
+   * @param mode - One of supported {@link ConnectionMode}. Default is 'streaming'.
+   */
   async setConnectionMode(mode: ConnectionMode): Promise<void> {
     if (this.config.connectionMode === mode) {
       this.logger.debug(`setConnectionMode ignored. Mode is already '${mode}'.`);
@@ -108,6 +113,13 @@ export default class LDClientImpl implements LDClient {
     return Promise.resolve();
   }
 
+  /**
+   * Gets the SDK connection mode.
+   */
+  getConnectionMode(): ConnectionMode {
+    return this.config.connectionMode;
+  }
+
   isOffline() {
     return this.config.connectionMode === 'offline';
   }
@@ -270,7 +282,7 @@ export default class LDClientImpl implements LDClient {
     return f ? JSON.parse(f) : undefined;
   }
 
-  async identify(pristineContext: LDContext, _hash?: string): Promise<void> {
+  async identify(pristineContext: LDContext): Promise<void> {
     let context = await ensureKey(pristineContext, this.platform);
 
     if (this.autoEnvAttributes === AutoEnvAttributes.Enabled) {

packages/shared/sdk-client/src/api/LDClient.ts

@@ -100,12 +100,10 @@ export interface LDClient {
    *
    * @param context
    *   The LDContext object.
-   * @param hash
-   *   The signed context key if you are using [Secure Mode](https://docs.launchdarkly.com/sdk/features/secure-mode#configuring-secure-mode-in-the-javascript-client-side-sdk).
    * @returns
    *   A Promise which resolves when the flag values for the specified context are available.
    */
-  identify(context: LDContext, hash?: string): Promise<void>;
+  identify(context: LDContext): Promise<void>;
 
   /**
    * Determines the json variation of a feature flag.