fix(feedback): Align get user with JS implementation (#4901)

* fix(feedback): Align get user with JS implementation

* Fix lint issue

* Adds changelog

* Optimise scope usage

* Adds tests

* Update CHANGELOG.md

Co-authored-by: Krystof Woldrich <[email protected]>

* Use current or isolation user is set without checks

* Fix changelog

---------

Co-authored-by: Krystof Woldrich <[email protected]>

Author: antonis

CHANGELOG.md

@@ -6,6 +6,13 @@
 > make sure you follow our [migration guide](https://docs.sentry.io/platforms/react-native/migration/) first.
 <!-- prettier-ignore-end -->
 
+## Unreleased
+
+### Fixes
+
+- User set by `Sentry.setUser` is prefilled in Feedback Widget ([#4901](https://github.com/getsentry/sentry-react-native/pull/4901))
+  - User data are considered from all scopes in the following order current, isolation and global.
+
 ## 6.15.1
 
 ### Dependencies

packages/core/src/js/feedback/FeedbackWidget.tsx

@@ -1,6 +1,6 @@
 /* eslint-disable max-lines */
-import type { SendFeedbackParams } from '@sentry/core';
-import { captureFeedback, getCurrentScope, lastEventId, logger } from '@sentry/core';
+import type { SendFeedbackParams, User } from '@sentry/core';
+import { captureFeedback, getCurrentScope, getGlobalScope, getIsolationScope, lastEventId, logger } from '@sentry/core';
 import * as React from 'react';
 import type { KeyboardTypeOptions ,
   NativeEventSubscription} from 'react-native';
@@ -55,8 +55,8 @@ export class FeedbackWidget extends React.Component<FeedbackWidgetProps, Feedbac
 
     const currentUser = {
       useSentryUser: {
-        email: this.props?.useSentryUser?.email || getCurrentScope()?.getUser()?.email || '',
-        name: this.props?.useSentryUser?.name || getCurrentScope()?.getUser()?.name || '',
+        email: this.props?.useSentryUser?.email || this._getUser()?.email || '',
+        name: this.props?.useSentryUser?.name || this._getUser()?.name || '',
       }
     }
 
@@ -406,6 +406,18 @@ export class FeedbackWidget extends React.Component<FeedbackWidgetProps, Feedbac
     return this.state.filename !== undefined && this.state.attachment !== undefined && this.state.attachmentUri !== undefined;
   }
 
+  private _getUser = (): User | undefined => {
+    const currentUser = getCurrentScope().getUser();
+    if (currentUser) {
+      return currentUser;
+    }
+    const isolationUser = getIsolationScope().getUser();
+    if (isolationUser) {
+      return isolationUser;
+    }
+    return getGlobalScope().getUser();
+  }
+
   private _showImageRetrievalDevelopmentNote = (): void => {
     if (isExpoGo()) {
       feedbackAlertDialog(

packages/core/test/feedback/FeedbackWidget.test.tsx

@@ -13,18 +13,27 @@ const mockOnAddScreenshot = jest.fn();
 const mockOnSubmitSuccess = jest.fn();
 const mockOnFormSubmitted = jest.fn();
 const mockOnSubmitError = jest.fn();
-const mockGetUser = jest.fn(() => ({
+
+const mockCurrentScopeGetUser = jest.fn(() => ({
   email: '[email protected]',
   name: 'Test User',
 }));
+const mockIsolationScopeGetUser = jest.fn();
+const mockGlobalScopeGetUser = jest.fn();
 
 jest.spyOn(Alert, 'alert');
 
 jest.mock('@sentry/core', () => ({
   ...jest.requireActual('@sentry/core'),
   captureFeedback: jest.fn(),
   getCurrentScope: jest.fn(() => ({
-    getUser: mockGetUser,
+    getUser: mockCurrentScopeGetUser,
+  })),
+  getIsolationScope: jest.fn(() => ({
+    getUser: mockIsolationScopeGetUser,
+  })),
+  getGlobalScope: jest.fn(() => ({
+    getUser: mockGlobalScopeGetUser,
   })),
   lastEventId: jest.fn(),
 }));
@@ -99,6 +108,12 @@ const customStyles: FeedbackWidgetStyles = {
 };
 
 describe('FeedbackWidget', () => {
+  beforeEach(() => {
+    mockIsolationScopeGetUser.mockReturnValue(undefined);
+    mockGlobalScopeGetUser.mockReturnValue(undefined);
+    FeedbackWidget.reset();
+  });
+
   afterEach(() => {
     jest.clearAllMocks();
   });
@@ -163,25 +178,77 @@ describe('FeedbackWidget', () => {
     expect(queryByTestId('sentry-logo')).toBeNull();
   });
 
-  it('name and email are prefilled when sentry user is set', () => {
-    const { getByPlaceholderText } = render(<FeedbackWidget {...defaultProps} />);
+  describe('User data prefilling', () => {
+    const users = {
+      prop: { name: 'Prop User', email: '[email protected]' },
+      current: { name: 'Current User', email: '[email protected]' },
+      isolation: { name: 'Isolation User', email: '[email protected]' },
+      global: { name: 'Global User', email: '[email protected]' },
+    };
+
+    it('prefills from useSentryUser prop when provided', () => {
+      mockCurrentScopeGetUser.mockReturnValue(users.current);
+      const { getByPlaceholderText } = render(
+        <FeedbackWidget {...defaultProps} useSentryUser={users.prop} />,
+      );
+      expect(getByPlaceholderText(defaultProps.namePlaceholder).props.value).toBe(users.prop.name);
+      expect(getByPlaceholderText(defaultProps.emailPlaceholder).props.value).toBe(users.prop.email);
+    });
 
-    const nameInput = getByPlaceholderText(defaultProps.namePlaceholder);
-    const emailInput = getByPlaceholderText(defaultProps.emailPlaceholder);
+    it('prefills from currentScope when useSentryUser prop is not set', () => {
+      mockCurrentScopeGetUser.mockReturnValue(users.current);
+      mockIsolationScopeGetUser.mockReturnValue(users.isolation);
+      mockGlobalScopeGetUser.mockReturnValue(users.global);
+
+      const { getByPlaceholderText } = render(<FeedbackWidget {...defaultProps} />);
+      expect(getByPlaceholderText(defaultProps.namePlaceholder).props.value).toBe(users.current.name);
+      expect(getByPlaceholderText(defaultProps.emailPlaceholder).props.value).toBe(users.current.email);
+    });
 
-    expect(nameInput.props.value).toBe('Test User');
-    expect(emailInput.props.value).toBe('[email protected]');
+    it('prefills from isolationScope when useSentryUser prop and currentScope user are not set', () => {
+      mockCurrentScopeGetUser.mockReturnValue(undefined);
+      mockIsolationScopeGetUser.mockReturnValue(users.isolation);
+      mockGlobalScopeGetUser.mockReturnValue(users.global);
+
+      const { getByPlaceholderText } = render(<FeedbackWidget {...defaultProps} />);
+      expect(getByPlaceholderText(defaultProps.namePlaceholder).props.value).toBe(users.isolation.name);
+      expect(getByPlaceholderText(defaultProps.emailPlaceholder).props.value).toBe(users.isolation.email);
+    });
+
+    it('prefills from globalScope when useSentryUser prop, currentScope, and isolationScope users are not set', () => {
+      mockCurrentScopeGetUser.mockReturnValue(undefined);
+      mockIsolationScopeGetUser.mockReturnValue(undefined);
+      mockGlobalScopeGetUser.mockReturnValue(users.global);
+
+      const { getByPlaceholderText } = render(<FeedbackWidget {...defaultProps} />);
+      expect(getByPlaceholderText(defaultProps.namePlaceholder).props.value).toBe(users.global.name);
+      expect(getByPlaceholderText(defaultProps.emailPlaceholder).props.value).toBe(users.global.email);
+    });
+
+    it('prefills with empty strings if no user data is available from props or any scope', () => {
+      mockCurrentScopeGetUser.mockReturnValue(undefined);
+      mockIsolationScopeGetUser.mockReturnValue(undefined);
+      mockGlobalScopeGetUser.mockReturnValue(undefined);
+
+      const { getByPlaceholderText } = render(<FeedbackWidget {...defaultProps} />);
+      expect(getByPlaceholderText(defaultProps.namePlaceholder).props.value).toBe('');
+      expect(getByPlaceholderText(defaultProps.emailPlaceholder).props.value).toBe('');
+    });
   });
 
-  it('ensure getUser is called only after the component is rendered', () => {
-    // Ensure getUser is not called before render
-    expect(mockGetUser).not.toHaveBeenCalled();
+  it('ensure scope getUser methods are called during initialization when useSentryUser prop is not set', () => {
+    // Ensure scope getUser methods are not called before render
+    expect(mockCurrentScopeGetUser).not.toHaveBeenCalled();
+    expect(mockIsolationScopeGetUser).not.toHaveBeenCalled();
+    expect(mockGlobalScopeGetUser).not.toHaveBeenCalled();
 
     // Render the component
-    render(<FeedbackWidget />);
+    render(<FeedbackWidget {...defaultProps} />);
 
-    // After rendering, check that getUser was called twice (email and name)
-    expect(mockGetUser).toHaveBeenCalledTimes(2);
+    // After rendering, _getUser is called twice (for name and email).
+    expect(mockCurrentScopeGetUser).toHaveBeenCalledTimes(2);
+    expect(mockIsolationScopeGetUser).toHaveBeenCalledTimes(2);
+    expect(mockGlobalScopeGetUser).toHaveBeenCalledTimes(2);
   });
 
   it('shows an error message if required fields are empty', async () => {
@@ -399,8 +466,8 @@ describe('FeedbackWidget', () => {
     unmount();
     const { queryByPlaceholderText } = render(<FeedbackWidget {...defaultProps} />);
 
-    expect(queryByPlaceholderText(defaultProps.namePlaceholder).props.value).toBe('Test User');
-    expect(queryByPlaceholderText(defaultProps.emailPlaceholder).props.value).toBe('[email protected]');
+    expect(queryByPlaceholderText(defaultProps.namePlaceholder).props.value).toBe('');
+    expect(queryByPlaceholderText(defaultProps.emailPlaceholder).props.value).toBe('');
     expect(queryByPlaceholderText(defaultProps.messagePlaceholder).props.value).toBe('');
   });