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

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.

Author: yusinto

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

@@ -0,0 +1,37 @@
+interface AutoEnvCommon {
+  /**
+   * Unique key for the context kind.
+   */
+  key: string;
+
+  /**
+   * Version of the environment attributes schema being used.
+   */
+  envAttributesVersion: string;
+}
+
+export interface LDApplication extends AutoEnvCommon {
+  /**
+   * Unique identifier of the application.
+   */
+  id?: string;
+  name?: string;
+  version?: string;
+  versionName?: string;
+  locale?: string;
+}
+
+export interface LDDevice extends AutoEnvCommon {
+  manufacturer?: string;
+  model?: string;
+  storageBytes?: string;
+  memoryBytes?: string;
+  os?: {
+    /**
+     * The family of operating system.
+     */
+    family: string;
+    name: string;
+    version: string;
+  };
+}

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

@@ -1,3 +1,5 @@
+import type { LDApplication, LDDevice } from './AutoEnv';
+
 /**
  * Information about the platform of the SDK and the environment it is executing.
  */
@@ -31,6 +33,18 @@ export interface PlatformData {
    * Any additional attributes associated with the platform.
    */
   additional?: Record<string, string>;
+
+  /**
+   * Additional information about the executing environment. Should be populated
+   * when available. Not all platforms will have this data.
+   */
+  ld_application?: LDApplication;
+
+  /**
+   * Device hardware information. Should be populated when available. Not all
+   * platforms will have this data.
+   */
+  ld_device?: LDDevice;
 }
 
 export interface SdkData {

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

@@ -1,8 +1,9 @@
-export * from './Encoding';
+export * from './AutoEnv';
 export * from './Crypto';
+export * from './Encoding';
+export * from './EventSource';
 export * from './Filesystem';
 export * from './Info';
 export * from './Platform';
 export * from './Requests';
-export * from './EventSource';
 export * from './Storage';

packages/shared/common/src/internal/stream/StreamingProcessor.test.ts

@@ -1,18 +1,15 @@
 import { basicPlatform, clientContext, logger } from '@launchdarkly/private-js-mocks';
 
-import { EventName, ProcessStreamResponse } from '../../api';
+import { EventName, Info, ProcessStreamResponse } from '../../api';
 import { LDStreamProcessor } from '../../api/subsystem';
 import { LDStreamingError } from '../../errors';
+import { ApplicationTags, ServiceEndpoints } from '../../options';
 import { defaultHeaders } from '../../utils';
 import { DiagnosticsManager } from '../diagnostics';
 import StreamingProcessor from './StreamingProcessor';
 
 const dateNowString = '2023-08-10';
 const sdkKey = 'my-sdk-key';
-const {
-  basicConfiguration: { serviceEndpoints, tags },
-  platform: { info },
-} = clientContext;
 const event = {
   data: {
     flags: {
@@ -33,6 +30,9 @@ const createMockEventSource = (streamUri: string = '', options: any = {}) => ({
 });
 
 describe('given a stream processor with mock event source', () => {
+  let serviceEndpoints: ServiceEndpoints;
+  let tags: ApplicationTags;
+  let info: Info;
   let streamingProcessor: LDStreamProcessor;
   let diagnosticsManager: DiagnosticsManager;
   let listeners: Map<EventName, ProcessStreamResponse>;
@@ -53,8 +53,11 @@ describe('given a stream processor with mock event source', () => {
 
   beforeEach(() => {
     mockErrorHandler = jest.fn();
+    ({
+      basicConfiguration: { serviceEndpoints, tags },
+      platform: { info },
+    } = clientContext);
     clientContext.basicConfiguration.logger = logger;
-
     basicPlatform.requests = {
       createEventSource: jest.fn((streamUri: string, options: any) => {
         mockEventSource = createMockEventSource(streamUri, options);

packages/shared/common/src/utils/clone.ts

@@ -1,3 +1,7 @@
 export default function clone<T>(obj: any) {
+  if (obj === undefined || obj === null) {
+    return obj;
+  }
+
   return JSON.parse(JSON.stringify(obj)) as T;
 }