Merge branch 'main' into skz/react-native-rendering

Author: joker23

.github/workflows/server-node.yml

@@ -38,12 +38,16 @@ jobs:
       - name: Launch the test service in the background
         run: yarn contract-test-service 2>&1 &
       - name: Clone and run contract tests from feat/fdv2 branch
+        # NOTE: This is a temporary workaround to run the contract tests from the feat/fdv2 branch.
+        # The commit hash is a few commits before the HEAD of the feat/fdv2 branch. We do this because
+        # the HEAD of the feat/fdv2 branch requires the synchronizers be passed as a list which is not
+        # implemented yet. (SDK-1798)
         run: |
           mkdir -p /tmp/sdk-test-harness
           git clone https://github.com/launchdarkly/sdk-test-harness.git /tmp/sdk-test-harness
           cp ./contract-tests/testharness-suppressions-fdv2.txt /tmp/sdk-test-harness/testharness-suppressions-fdv2.txt
           cd /tmp/sdk-test-harness
-          git checkout feat/fdv2
+          git checkout de833af990da23a89b66c5366809b5be8c27e3f8
           go build -o test-harness .
           ./test-harness -url http://localhost:8000 -debug --skip-from=testharness-suppressions-fdv2.txt
         env:

packages/tooling/jest/README.md

@@ -6,23 +6,24 @@
 [![NPM][jest-dm-badge]][jest-npm-link]
 [![NPM][jest-dt-badge]][jest-npm-link]
 
-> [!CAUTION]
-> This library is a beta version and should not be considered ready for production use while this message is visible.
 
-> **Easily unit test LaunchDarkly applications with jest** :clap:
+
+**Easily unit test LaunchDarkly feature flagged applications with jest**
 
 For more information, see the [complete reference guide for unit testing](https://docs.launchdarkly.com/guides/sdk/unit-tests).
 
 ## Installation
 
-```shell
-# npm
-npm i @launchdarkly/jest --save-dev
-
-# yarn
+```bash
 yarn add -D @launchdarkly/jest
 ```
 
+or
+
+```bash
+npm install @launchdarkly/jest --save-dev
+```
+
 Then in `jest.config.js` add `@launchdarkly/jest/{framework}` to setupFiles:
 
 ```js
@@ -33,34 +34,59 @@ module.exports = {
 };
 ```
 
-## Quickstart
+## Usage
+
+Use these 3 APIs for your test cases:
+
+- `mockFlags(flags: LDFlagSet)`: Mock flags at the start of each test case. Only mocks flags returned by the `useFlags` hook.
 
-// Welcome.test.tsx
+- `getLDClient()`: Returns a jest mock of the [LDClient](https://launchdarkly.github.io/js-client-sdk/interfaces/_launchdarkly_js_client_sdk_.ldclient.html). All methods of this object are jest mocks.
+
+- `resetLDMocks()`: Resets both mockFlags and getLDClient mocks.
+
+## Example
+
+```tsx
 import React from 'react';
-import { render } from '@testing-library/react-native';
-import {
-  mockFlags,
-  resetLDMocks,
-  getLDClient,
-} from '@launchdarkly/js-core/tooling/jest';
+import { render, fireEvent } from '@testing-library/react-native';
+import { mockFlags, resetLDMocks, getLDClient } from '@launchdarkly/jest/react-native';
 import Welcome from './Welcome';
 
-afterEach(() => {
-  resetLDMocks();
-});
-
-test('evaluates a boolean flag', () => {
-  mockFlags({ 'my-boolean-flag': true });
-  const { getByText } = render(<Welcome />);
-  expect(getByText('Flag value is true')).toBeTruthy();
+describe('Welcome component', () => {
+  afterEach(() => {
+    // reset before each test case
+    resetLDMocks();
+  });
+
+  test('evaluates a boolean flag', () => {
+    // arrange
+    // You can use camelCase, kebab-case, or snake_case keys
+    mockFlags({ 'my-boolean-flag': true });
+
+    // act
+    const { getByText } = render(<Welcome />);
+
+    // assert
+    expect(getByText('Flag value is true')).toBeTruthy();
+  });
+
+  test('captures a track call', () => {
+    // arrange
+    mockFlags({ myBooleanFlag: true });
+    const client = getLDClient();
+
+    // act
+    const { getByTestId } = render(<Welcome />);
+    fireEvent.press(getByTestId('track-button'));
+
+    // assert: track gets called
+    expect(client.track).toHaveBeenCalledWith('event-name', { foo: 'bar' });
+    expect(client.track).toHaveBeenCalledTimes(1);
+  });
 });
+```
 
-test('captures a track call', () => {
-  const client = getLDClient(); // mocked client from LD jest tooling
-  client.track('event-name', { foo: 'bar' });
-  expect(client.track).toHaveBeenCalledWith('event-name', { foo: 'bar' });
-  expect(client.track).toHaveBeenCalledTimes(1);
-});
+---
 
 ## Developing this package
 
@@ -71,6 +97,9 @@ yarn && yarn build && cd packages/tooling/jest
 # run tests
 yarn test
 ```
+## Note
+
+LaunchDarkly plans to support [test data sources](https://launchdarkly.com/docs/sdk/features/test-data-sources) for the React Native and other client-side SDKs in the future. Once this feature is avaliable, we will deprecate this package.
 
 ## Verifying SDK build provenance with the SLSA framework