RN: Fallback for Invalid Colors in processColorArray

Summary:
If an invalid color is supplied to a native component that expects `Array<ColorValue>`, it is currently possible to produce an array that contains null or undefined elements. This is problematic because the native component may not know what to do with the null or undefined value.

This changes `processColorArray` to always return an array with valid color values. Any invalid color values will fallback to being transparent black, `0x00000000`.

Changelog:
[General][Fixed] - For native components that accept color arrays, invalid elements will now fallback to transparent with a console error.

Reviewed By: JoshuaGross

Differential Revision: D27542291

fbshipit-source-id: efa5d130644b3aee68d2b9fad6fdb61af11a2966
This commit is contained in:
Tim Yung authored and Facebook GitHub Bot committed 2021-04-02 15:07:54 -07:00
1 parent 322e8f70cf
commit bb6cd56fae
2 files changed
+41 -7

No files matched your search

@@ -22,7 +22,7 @@ const PlatformColorAndroid = require('../PlatformColorValueTypes.android')
const platformSpecific =
OS === 'android'
? unsigned => unsigned | 0 //eslint-disable-line no-bitwise
? unsigned => unsigned | 0 // eslint-disable-line no-bitwise
: x => x;
describe('processColorArray', () => {
@@ -63,6 +63,30 @@ describe('processColorArray', () => {
const colorFromNoArray = processColorArray(null);
expect(colorFromNoArray).toEqual(null);
});
it('converts invalid colors to transparent', () => {
const spy = jest.spyOn(console, 'error').mockReturnValue(undefined);
const colors = ['red', '???', null, undefined, false];
const colorFromStringArray = processColorArray(colors);
const expectedIntArray = [
0xffff0000,
0x00000000,
0x00000000,
0x00000000,
0x00000000,
].map(platformSpecific);
expect(colorFromStringArray).toEqual(expectedIntArray);
for (const color of colors.slice(1)) {
expect(spy).toHaveBeenCalledWith(
'Invalid value in color array:',
color,
);
}
spy.mockRestore();
});
});
describe('iOS', () => {
+16 -6
View File
@@ -10,15 +10,25 @@
'use strict';
const processColor = require('./processColor');
import type {ColorValue} from './StyleSheet';
import type {ProcessedColorValue} from './processColor';
import processColor, {type ProcessedColorValue} from './processColor';
const TRANSPARENT = 0; // rgba(0, 0, 0, 0)
function processColorArray(
colors: ?Array<ColorValue>,
): ?Array<?ProcessedColorValue> {
return colors == null ? null : colors.map(processColor);
colors: ?$ReadOnlyArray<ColorValue>,
): ?$ReadOnlyArray<ProcessedColorValue> {
return colors == null ? null : colors.map(processColorElement);
}
function processColorElement(color: ColorValue): ProcessedColorValue {
const value = processColor(color);
// For invalid colors, fallback to transparent.
if (value == null) {
console.error('Invalid value in color array:', color);
return TRANSPARENT;
}
return value;
}
module.exports = processColorArray;