[HOLD for payment 2023-09-07] [$1000] Chat - MagicCodeInput stories are broken

[lanitochka17]

If you haven’t already, check out our contributing guidelines for onboarding and email contributors@expensify.com to request to join our Slack channel!

---

Action Performed:

1. Run npm run storybook
   https://staging.new.expensify.com/docs/index.html?path=/story/components-magiccodeinput--auto-focus
2. Navigate to the MagicCodeInput stories by clicking on 'MagicCodeInput' under components in the left-hand menu

Expected Result:

The MagicCodeInput stories should not be broken

Actual Result:

The MagicCodeInput stories are broken

Workaround:

Unknown

Platforms:

Which of our officially supported platforms is this issue occurring on?

• Android / native
• Android / Chrome
• iOS / native
• iOS / Safari
• Windows / Chrome
• MacOS / Desktop

Version Number: 1.3.50.2

Reproducible in staging?: Yes

Reproducible in production?: Yes

If this was caught during regression testing, add the test name, ID and link from TestRail:

Email or phone of affected tester (no customers):

Logs: https://stackoverflow.com/c/expensify/questions/4856

Notes/Photos/Videos: Any additional supporting documentation

Recording.5768.mp4

Expensify/Expensify Issue URL:

Issue reported by: @joh42

Slack conversation: https://expensify.slack.com/archives/C049HHMV9SM/p1690918863039709

View all open jobs on GitHub

Upwork Automation - Do Not Edit

• Upwork Job URL: https://www.upwork.com/jobs/~011893a5d0539986e8
• Upwork Job ID: 1690367506169479168
• Last Price Increase: 2023-08-12
• Automatic offers:
• bernhardoj | Contributor | 26201931
• joh42 | Reporter | 26201932

[melvin-bot]

Triggered auto assignment to @sonialiap (Bug), see https://stackoverflow.com/c/expensify/questions/14418 for more details.

[melvin-bot]

Bug0 Triage Checklist (Main S/O)

• This "bug" occurs on a supported platform (ensure Platforms in OP are ✅)
• This bug is not a duplicate report (check E/App issues and #expensify-bugs)
  • If it is, comment with a link to the original report, close the issue and add any novel details to the original issue instead
• This bug is reproducible using the reproduction steps in the OP. S/O
  • If the reproduction steps are clear and you're unable to reproduce the bug, check with the reporter and QA first, then close the issue.
  • If the reproduction steps aren't clear and you determine the correct steps, please update the OP.
• This issue is filled out as thoroughly and clearly as possible
  • Pay special attention to the title, results, platforms where the bug occurs, and if the bug happens on staging/production.
• I have reviewed and subscribed to the linked Slack conversation to ensure Slack/Github stay in sync

[kushu7]

Proposal

Please re-state the problem that we are trying to solve in this issue.

Chat - MagicCodeInput stories are broken

What is the root cause of that problem?

We have defined default value as undefined here. and we are not passing value prop from story.

App/src/components/MagicCodeInput.js

Line 54 in 32326f6

value: undefined,

and decomposeString gets called on component mount

App/src/components/MagicCodeInput.js

Lines 117 to 137 in 32326f6

	const validateAndSubmit = () => {
	const numbers = decomposeString(props.value, props.maxLength);
	if (!props.shouldSubmitOnComplete || _.filter(numbers, (n) => ValidationUtils.isNumeric(n)).length !== props.maxLength || props.network.isOffline) {
	return;
	}
	// Blurs the input and removes focus from the last input and, if it should submit
	// on complete, it will call the onFulfill callback.
	blurMagicCodeInput();
	props.onFulfill(props.value);
	};
	useNetwork({onReconnect: validateAndSubmit});
	useEffect(() => {
	validateAndSubmit();
	// We have not added:
	// + the editIndex as the dependency because we don't want to run this logic after focusing on an input to edit it after the user has completed the code.
	// + the props.onFulfill as the dependency because props.onFulfill is changed when the preferred locale changed => avoid auto submit form when preferred locale changed.
	// eslint-disable-next-line react-hooks/exhaustive-deps
	}, [props.value, props.shouldSubmitOnComplete]);

but we have value as undefined as we get error from here.

App/src/components/MagicCodeInput.js

Lines 74 to 80 in 32326f6

	const decomposeString = (value, length) => {
	let arr = _.map(value.split('').slice(0, length), (v) => (ValidationUtils.isNumeric(v) ? v : CONST.MAGIC_CODE_EMPTY_CHAR));
	if (arr.length < length) {
	arr = arr.concat(Array(length - arr.length).fill(CONST.MAGIC_CODE_EMPTY_CHAR));
	}
	return arr;
	};

What changes do you think we should make in order to solve the problem?

we should add early return condition here

App/src/components/MagicCodeInput.js

Line 74 in 32326f6

const decomposeString = (value, length) => {

if(!value) return [];

What alternative solutions did you explore? (Optional)

We can pass empty string as a value from MagicCodeInput story

[Pujan92]

Proposal

Please re-state the problem that we are trying to solve in this issue.

MagicCodeInput stories are not working and broken.

What is the root cause of that problem?

We are not setting the required props correctly.

What changes do you think we should make in order to solve the problem?

We need to update the Template function with the needed props to work the stories correctly.

App/src/stories/MagicCodeInput.stories.js

Lines 14 to 17 in 316a545

	function Template(args) {
	// eslint-disable-next-line react/jsx-props-no-spreading
	return <MagicCodeInput {...args} />;
	}

function Template(args) {
    const [value, setValue] = useState('');
    const ref = useRef();
    return <MagicCodeInput
        value={value}
        onChangeText={(val) => setValue(val)}
        ref={ref}
        // eslint-disable-next-line react/jsx-props-no-spreading
        {...args} 
    />;
}

Extra: If we need to provide some initial value then we can pass an extra arg called initialValue for the story and use above with the initial state useState(args.initialValue)

Result

Screen.Recording.2023-08-09.at.1.49.17.AM.mov

[joh42]

Thanks for creating the issue! For some context, I discovered that the MagicCodeInput story was broken while going through the PR checklist after having modified the MagicCodeInput component. When asking about how broken stories should be handled, I got the suggestion of reporting it as a bug: https://app.slack.com/client/T03SC9DTT/C01GTK53T8Q/thread/C01GTK53T8Q-1690918046.950089

[bernhardoj]

Proposal

Please re-state the problem that we are trying to solve in this issue.

MagicCodeInput stories throw some errors

What is the root cause of that problem?

The first error we can see is Cannot read properties of undefined (reading 'isOffline'). In MagicCodeInput, we use useNetwork hook that gets the network value from a context.

App/src/hooks/useNetwork.js

Line 13 in 5510a95

const {isOffline} = useContext(NetworkContext);

We already provide the context here (OnyxProvider).

App/.storybook/preview.js

Lines 16 to 22 in 5510a95

	const decorators = [
	(Story) => (
	<ComposeProviders components={[OnyxProvider, LocaleContextProvider, HTMLEngineProvider, SafeAreaProvider, PortalProvider]}>
	<Story />
	</ComposeProviders>
	),
	];

The problem is, the network context value is initially undefined. This is also true for all onyx contexts, that is personal details, preferred theme, etc.

We can only reproduce this first issue when we open the storybook for the first time with the Onyx still empty. If it's not empty, you can clear it first

The second error is Cannot read properties of undefined (reading 'split'). In MagiCodeInput, the value prop is optional and the default value is undefined. In the story, we didn't pass anything to the value prop. When MagicCodeInput is rendered, we call decomposeString(value) that will call split function on the value. Because value is undefined, an error is thrown.

App/src/components/MagicCodeInput.js

Lines 74 to 75 in 5510a95

	const decomposeString = (value, length) => {
	let arr = _.map(value.split('').slice(0, length), (v) => (ValidationUtils.isNumeric(v) ? v : CONST.MAGIC_CODE_EMPTY_CHAR));

What changes do you think we should make in order to solve the problem?

1. Initialize the default value for the network context by adding

initialKeyStates: {
    [ONYXKEYS.NETWORK]: {isOffline: false},
},

to here

App/.storybook/preview.js

Lines 12 to 14 in 5510a95

	Onyx.init({
	keys: ONYXKEYS,
	});

We did this when initializing the app

App/src/setup/index.js

Lines 24 to 39 in 5510a95

	Onyx.init({
	keys: ONYXKEYS,
	// Increase the cached key count so that the app works more consistently for accounts with large numbers of reports
	maxCachedKeysCount: 10000,
	safeEvictionKeys: [ONYXKEYS.COLLECTION.REPORT_ACTIONS],
	captureMetrics: Metrics.canCaptureOnyxMetrics(),
	initialKeyStates: {
	// Clear any loading and error messages so they do not appear on app startup
	[ONYXKEYS.SESSION]: {loading: false},
	[ONYXKEYS.ACCOUNT]: CONST.DEFAULT_ACCOUNT_DATA,
	[ONYXKEYS.NETWORK]: {isOffline: false},
	[ONYXKEYS.IS_SIDEBAR_LOADED]: false,
	[ONYXKEYS.SHOULD_SHOW_COMPOSE_INPUT]: true,
	},
	});

2. Change the default value of value prop to an empty string

This will fix the MagicCodeInput story, but I also see some errors on other stories. Read more below. Let me know if we should handle them all.

read more

1. Checkbox
   accessibilityLabel is required but missing
   Solution: pass an empty string to the checkbox story
2. Composer
   The component is not inside a navigation container
   Solution: wrap the composer with custom navigation context, the same thing we did with withNavigationFallback
3. Header
   Cannot read properties of null (reading 'environment')
   Add EnvironmentProvider to the storybook
4. HeaderWithBackButton
   Cannot read properties of null (reading 'isKeyboardShown')
   Add KeyboardStateProvider to the storybook

[sonialiap]

I don't know what this tool is, but I can reproduce the behavior described. Triaging to external