Skip to content

fix/add onyx mask keys #29

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
broso005 wants to merge 1 commit into from
Closed

fix/add onyx mask keys #29

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
54 changes: 49 additions & 5 deletions src/libs/ExportOnyxState/common.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ import type OnyxState from '@src/types/onyx/OnyxState';
import type {MaskOnyxState} from './types';

const MASKING_PATTERN = '***';

const keysToMask = [
'plaidLinkToken',
'plaidAccessToken',
Expand All @@ -21,8 +22,51 @@ const keysToMask = [
'edits',
'lastMessageHtml',
'lastMessageText',
'login',
'avatar',
'avatarURL',
'email',
'remainingWalletLimit',
'walletLimit',
'availableBalance',
'currentBalance',
'walletLinkedAccountType',
'walletLimitEnforcementPeriod',
'tier',
'tierName',
'primaryLogin',
'validateCode',
'displayName',
'zipCode',
'owner',
'name',
'oldPolicyName',
'policyAvatar',
'policyName',
'receivableAccount',
'payableAcct',
'invoiceItem',
'payableList',
'merchant',
'cardName',
'cardNumber',
'amount',
'comment',
'bank',
'modifiedMerchant',
'originalAmount',
];

function getMaskingPattern(value: unknown) {
if (typeof value === 'string') {
return '*'.repeat(value.length);
}
if (Array.isArray(value)) {
return value.map((v) => (typeof v === 'string' ? '*'.repeat(v.length) : ''));
}
return MASKING_PATTERN;
}

const onyxKeysToRemove: Array<ValueOf<typeof ONYXKEYS>> = [ONYXKEYS.NVP_PRIVATE_PUSH_NOTIFICATION_ID];

const emailRegex = /[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\.[a-zA-Z]{2,}/;
Expand Down Expand Up @@ -64,7 +108,7 @@ const maskSessionDetails = (onyxState: OnyxState): OnyxState => {
maskedData[key] = session[key as keyof Session];
return;
}
maskedData[key] = MASKING_PATTERN;
maskedData[key] = getMaskingPattern(session[key as keyof Session]);
});

return {
Expand Down Expand Up @@ -118,20 +162,20 @@ const maskFragileData = (data: OnyxState | unknown[] | null, parentKey?: string)

if (keysToMask.includes(key)) {
if (Array.isArray(value)) {
maskedData[key] = value.map(() => MASKING_PATTERN);
maskedData[key] = value.map((v) => getMaskingPattern(v));
} else {
maskedData[key] = MASKING_PATTERN;
maskedData[key] = getMaskingPattern(value);
}
} else if (typeof value === 'string' && Str.isValidEmail(value)) {
maskedData[propertyName] = maskEmail(value);
} else if (typeof value === 'string' && stringContainsEmail(value)) {
maskedData[propertyName] = replaceEmailInString(value, maskEmail(extractEmail(value) ?? ''));
} else if (parentKey && parentKey.includes(ONYXKEYS.COLLECTION.REPORT_ACTIONS) && (propertyName === 'text' || propertyName === 'html')) {
maskedData[key] = MASKING_PATTERN;
maskedData[key] = getMaskingPattern(value);
} else if (typeof value === 'object') {
maskedData[propertyName] = maskFragileData(value as OnyxState, propertyName.includes(ONYXKEYS.COLLECTION.REPORT_ACTIONS) ? propertyName : parentKey);
} else {
maskedData[propertyName] = value;
maskedData[propertyName] = getMaskingPattern(value);
}
});

Expand Down
14 changes: 7 additions & 7 deletions tests/unit/ExportOnyxStateTest.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import * as ExportOnyxState from '@libs/ExportOnyxState/common';

Check failure on line 1 in tests/unit/ExportOnyxStateTest.ts

View workflow job for this annotation

GitHub Actions / Changed files ESLint check 

Namespace imports from @libs are not allowed. Use named imports instead. Example: import { method } from "@libs/module"
import type * as OnyxTypes from '@src/types/onyx';

type ExampleOnyxState = {
Expand All @@ -18,8 +18,8 @@
const input = {session: mockSession};
const result = ExportOnyxState.maskOnyxState(input) as ExampleOnyxState;

expect(result.session.authToken).toBe('***');
expect(result.session.encryptedAuthToken).toBe('***');
expect(result.session.authToken).toBe('********************');
expect(result.session.encryptedAuthToken).toBe('*************************');
});

it('should not mask fragile data when isMaskingFragileDataEnabled is false', () => {
Expand All @@ -28,8 +28,8 @@
};
const result = ExportOnyxState.maskOnyxState(input) as ExampleOnyxState;

expect(result.session.authToken).toBe('***');
expect(result.session.encryptedAuthToken).toBe('***');
expect(result.session.authToken).toBe('********************');
expect(result.session.encryptedAuthToken).toBe('*************************');
expect(result.session.email).toBe('[email protected]');
});

Expand All @@ -39,8 +39,8 @@
};
const result = ExportOnyxState.maskOnyxState(input, true) as ExampleOnyxState;

expect(result.session.authToken).toBe('***');
expect(result.session.encryptedAuthToken).toBe('***');
expect(result.session.authToken).toBe('********************');
expect(result.session.encryptedAuthToken).toBe('*************************');
});

it('should mask emails as a string value in property with a random email', () => {
Expand Down Expand Up @@ -96,7 +96,7 @@

const result = ExportOnyxState.maskOnyxState(input, true) as ExampleOnyxState;

expect(result.edits).toEqual(['***', '***']);
expect(result.edits).toEqual(['***', '**']);
expect(result.lastMessageHtml).toEqual('***');
});
});
Loading