chore: Support react-native auto env #354

yusinto · 2024-01-24T20:52:38Z

Big PR for react native because:

We are adding auto env support. The main logic is here.
The RN SDK now needs Platform.Crypto to be implemented.
Mocks and tests must be modified. Note server sdk related changed are side-effects of the mocks api changing. There's no functionality changes to server related code.

…at to internal options as well.

…v-attributes

…ges are not expo go compatible.

…ored common properties to its own interface.

…ion autoEnv.

…moved LDAutoEnv interface. Remove auto env from LDUser and LDSingleKind.

…sync-storage and auto env.

…v-attributes

…s. Dry getOrGenerateKey.

…ved redundant jest setup files.

… Removed redundant exclusion for setupFilesAfterEnv.

yusinto · 2024-01-24T21:26:33Z

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

+  // TODO: populate application ID, name, version, versionName
+  id: '',
+  name: '',
+  version: '',
+  versionName: '',


I'm still unsure how to populate these without installing the heavyweight react-native-device-info or having native dependencies. We may have to document this to request customers to set the application tags for these to be correctly populated.

If we cannot collect, then we will want to exclude them when they are not populated.

yusinto · 2024-01-24T21:28:48Z

packages/sdk/react-native/src/polyfills/uuid.ts

Moved to platform/crypto for posterity.

yusinto · 2024-01-24T21:29:47Z

packages/sdk/react-native/src/platform/crypto/PlatformHasher.ts

+  digest(encoding: SupportedOutputEncoding): string {
+    switch (encoding) {
+      case 'base64':
+        return base64FromByteArray(new Uint8Array(this.hasher.arrayBuffer()));


The js-sha256 library supports hex output but not base64. I'm doing it manually here.

yusinto · 2024-01-24T21:32:49Z

packages/shared/mocks/src/platform.ts

+    info: setupInfo(),
+    crypto: setupCrypto(),


I encountered mock issues where mock resets don't work with static exports in deep nested mocks. Therefore I have to make these changes and introduce a flagfall test setup step for the mocks package.

yusinto · 2024-01-24T21:33:31Z

packages/shared/mocks/src/setupMocks.ts

This needs to be run beforeEach test for basicPlatform mocks to be setup and initialized correctly.

yusinto · 2024-01-24T21:34:27Z

packages/shared/sdk-client/jest-setupFilesAfterEnv.ts

This file seems unused and its removal does not break anything.

yusinto · 2024-01-24T21:36:25Z

packages/shared/sdk-client/src/utils/ensureKey.ts

-const { isLegacyUser, isMultiKind, isSingleKind } = internal;
-
-export const addNamespace = (s: string) => `LaunchDarkly_AnonKeys_${s}`;
-
-export const getOrGenerateKey = async (kind: string, { crypto, storage }: Platform) => {
-  const nsKind = addNamespace(kind);
-  let contextKey = await storage?.get(nsKind);
-
-  if (!contextKey) {
-    contextKey = crypto.randomUUID();
-    await storage?.set(nsKind, contextKey);
-  }
+import { getOrGenerateKey } from './getOrGenerateKey';

-  return contextKey;
-};


These are moved to a separate file getOrGenerateKey.ts.

yusinto · 2024-01-24T21:37:31Z

packages/shared/sdk-client/src/utils/addAutoEnv.ts

+export const toMulti = (c: LDSingleKindContext) => {
+  const { kind, ...contextCommon } = c;
+
+  return {
+    kind: 'multi',
+    [kind]: contextCommon,
+  };
+};


Converting a single kind to multi kind. Is this logic correct and sufficient enough?

yusinto · 2024-01-24T21:41:05Z

packages/shared/sdk-server-edge/jest.config.json

All remaining changes below this comment are related to the mocks api being changed due to basicPlatform needing to be setup on beforeEach.

yusinto · 2024-01-24T21:42:52Z

packages/shared/sdk-client/src/utils/addAutoEnv.ts

This is the main auto env logic.

yusinto · 2024-01-24T21:57:54Z

packages/shared/sdk-client/src/utils/addAutoEnv.ts

+  // LDUser is not supported for auto env reporting
+  if (isLegacyUser(context)) {
+    return context as LDUser;
+  }


Call out we are not supporting LDUser for auto env.

yusinto · 2024-01-24T21:59:42Z

packages/shared/sdk-client/src/utils/addAutoEnv.ts

+  ldApplication.id = config.application?.id || ldApplication?.id || name || wrapperName;
+  ldApplication.name = ldApplication?.name || name || wrapperName;
+  ldApplication.version =
+    config.application?.version || ldApplication.version || version || wrapperVersion;


I follow the spec logic, but it does not specify how application name should be populated. Is this acceptable?

ldApplication.name = ldApplication?.name || name || wrapperName;

kinyoklion · 2024-01-24T23:32:00Z

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

+export const ldDevice: LDDevice = {
+  key: '',
+  envAttributesVersion: '1.0',
+  manufacturer: Platform.select({


Pinging @tanderson-ld on these values.

@yusinto Do you have the JSON of one of the contexts populated?

This is from the ios simulator:

{ "kind": "multi", "user": { "key": "test-user" }, "ld_application": { "key": "/zFu3yVDTWyKZ6vG+ssjgcM9uSTmTpD2u/QTEy2FFVY=", "envAttributesVersion": "1.0", "id": "@launchdarkly/react-native-client-sdk", "name": "@launchdarkly/react-native-client-sdk", "version": "0.1.5", "versionName": "", "locale": "en_US" }, "ld_device": { "key": "21105df8-0236-4ef5-9721-f94f68424560", "envAttributesVersion": "1.0", "manufacturer": "apple", "os": { "family": "apple", "name": "ios", "version": "17.2" } } }

kinyoklion · 2024-01-24T23:32:15Z

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

+};
+
+export const ldDevice: LDDevice = {
+  key: '',


I assume this gets populated later, maybe a comment to explain?

kinyoklion · 2024-01-24T23:37:33Z

packages/shared/mocks/src/platform.ts

-        name: 'An OS',
-        version: '1.0.1',
-        arch: 'An Arch',
+        name: 'iOS',


Why this change? It is good for this data to not look like real runtime data.

No reason. I can revert all good.

packages/shared/common/src/api/platform/AutoEnv.ts

kinyoklion

This PR contains changes that require common release, for instance, so it cannot be a chore.

I think we should break this PR down into some units with some associated conventional commits that will make them digestable.

feat: Implement common support for auto environment attributes.
feat: Implement common client side support for auto environment attributes.
feat: React-native support for auto-env attributes.

Each PR affecting the correct components to produce the generally correct changlog history.

If there are some sweeping changes for mocks or jest config, then those could be done in a chore.

kinyoklion · 2024-01-25T00:01:11Z

Overall I think things are looking good. I do think we need to break it up though and apply it in smaller bits that can be released and have associated change notes.

yusinto · 2024-01-25T00:08:14Z

we need to break it up
feat: Implement common support for auto environment attributes.

#355

feat: Implement common client side support for auto environment attributes.

#356

feat: React-native support for auto-env attributes.

#357

This PR adds support for auto env attributes for the common library. This was originally part of #354. That big PR is being broken down into smaller PRs for the benefit of better changelog through conventional commits. Note I have intentionally omitted the `common/jest.config.js` change because that is part of a larger change to the mocks api. This change is in #356.

yusinto · 2024-02-01T20:48:16Z

Closing this because it has been broken up and superseded by #356 #357 #358.

yusinto added 30 commits January 4, 2024 12:10

chore: Added LDAutoEnv and modified LDContext to include that. Add th…

e5507e4

…at to internal options as well.

chore: Renamed ldAutoEnv to just autoEnv.

7a151e9

chore: add autoEnv to internal Context class.

393f68b

chore: Add skeletal rn autoEnv code.

0f1700c

Update createAutoEnv.ts

7bf8e04

Merge branch 'main' into yus/sc-228043/rn-sdk-add-support-for-auto-en…

46f1aa5

…v-attributes

chore: move autoEnv to platform.info.

8917681

chore: rename createAutoEnv to reconstruct.

a36749c

chore: Added react-native-device-info. Populated autoEnv attributes.

0c5e20e

chore: Added react-native-localize. TODO: dev-info and localize packa…

e7bff67

…ges are not expo go compatible.

chore: Conditionally import device-info and localize packages. Refact…

00add5e

…ored common properties to its own interface.

chore: Removed 3rd party packages. Added locale.

f17be6b

chore: Add manufacturer and model.

d8609b5

chore: remove iosDeviceSelector.

3a7c733

chore: moved dotenv in example app to dep. Removed redundant applicat…

0ba37cb

…ion autoEnv.

chore: Simplify auto env by using application and device directly. Re…

bf843c4

…moved LDAutoEnv interface. Remove auto env from LDUser and LDSingleKind.

chore: fix react native jest failures due to native dependencies re a…

bf972c7

…sync-storage and auto env.

chore: clean up jest config, remove babel-jest dep.

84ec920

Merge branch 'main' into yus/sc-228043/rn-sdk-add-support-for-auto-en…

27210ec

…v-attributes

chore: Inject context with autoEnv. Revert multikind interface change…

9f27fb3

…s. Dry getOrGenerateKey.

chore: Refactored internal inject functions.

c3883a3

chore: Improved mocks so crypto is more easily testable.

cf67b77

chore: Replace null coaslescence with falsy checks for empty strings.

990cd5d

chore: Removed CryptoWithHash. Added hasher to exports.

ac612b6

chore: Improve mocks setup. Added readme instructions for mocks. Remo…

06cf961

…ved redundant jest setup files.

chore: Fixed eslint require complaint.

d39b47f

chore: Replace deprecated toBeCalledTimes with toHaveBeenCalledTimes.…

89cddc2

… Removed redundant exclusion for setupFilesAfterEnv.

chore: minor fixes related to previous mocks api changes.

00090a7

chore: Added autoEnvAttributes config option. Fixed unit tests.

419f793

chore: Added more tests.

3f5b0f2

yusinto commented Jan 24, 2024

View reviewed changes

packages/sdk/react-native/src/polyfills/uuid.ts Outdated

Copy link

Contributor Author

yusinto Jan 24, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Moved to platform/crypto for posterity.

yusinto commented Jan 24, 2024

View reviewed changes

packages/shared/sdk-client/src/utils/addAutoEnv.ts

Copy link

Contributor Author

yusinto Jan 24, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is the main auto env logic.

yusinto commented Jan 24, 2024

View reviewed changes

yusinto added 4 commits January 24, 2024 14:36

chore: Run setup mocks for common.

07abdea

chore: Fix common tests.

b8a6f7b

chore: Improve mocks readme. Improve destructuring syntax.

8e6a25e

chore: Add jest to example app for detox to work.

28983fd

kinyoklion requested a review from tanderson-ld January 24, 2024 23:31

kinyoklion reviewed Jan 24, 2024

View reviewed changes

packages/shared/common/src/api/platform/AutoEnv.ts Outdated Show resolved Hide resolved

kinyoklion requested changes Jan 24, 2024

View reviewed changes

Update autoEnv.ts

6a4604f

chore: Revert test data to look less real.

8e2382e

yusinto mentioned this pull request Jan 25, 2024

feat: Implement common support for auto environment attributes. #355

Merged

yusinto closed this Feb 1, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

chore: Support react-native auto env #354

chore: Support react-native auto env #354

yusinto commented Jan 24, 2024 •

edited

Loading

yusinto Jan 24, 2024

kinyoklion Jan 24, 2024

yusinto Jan 24, 2024

yusinto Jan 24, 2024

yusinto Jan 24, 2024

yusinto Jan 24, 2024

yusinto Jan 24, 2024

yusinto Jan 24, 2024

yusinto Jan 24, 2024

yusinto Jan 24, 2024

yusinto Jan 24, 2024

yusinto Jan 24, 2024

yusinto Jan 24, 2024 •

edited

Loading

kinyoklion Jan 24, 2024

yusinto Jan 24, 2024

kinyoklion Jan 24, 2024

kinyoklion Jan 24, 2024

yusinto Jan 24, 2024

kinyoklion left a comment

kinyoklion commented Jan 25, 2024

yusinto commented Jan 25, 2024 •

edited

Loading

yusinto commented Feb 1, 2024

chore: Support react-native auto env #354

chore: Support react-native auto env #354

Conversation

yusinto commented Jan 24, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

yusinto Jan 24, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

kinyoklion left a comment

Choose a reason for hiding this comment

kinyoklion commented Jan 25, 2024

yusinto commented Jan 25, 2024 • edited Loading

yusinto commented Feb 1, 2024

yusinto commented Jan 24, 2024 •

edited

Loading

yusinto Jan 24, 2024 •

edited

Loading

yusinto commented Jan 25, 2024 •

edited

Loading