-
Notifications
You must be signed in to change notification settings - Fork 2.8k
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.
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
Feature: Implement the policy report field delete flow #44493
Merged
mountiny
merged 16 commits into
Expensify:main
from
waterim:feat-43686-report-fields-delete-flow
Jul 7, 2024
Merged
Changes from 9 commits
Commits
Show all changes
16 commits
Select commit
Hold shift + click to select a range
d129de4
add delete functionality
waterim 6db57d5
fix ts and lint
waterim c0a7474
fixed API command
waterim 27604ef
fix lint default export
waterim 253768f
Merge remote-tracking branch 'upstream/main' into feat-43686-report-f…
waterim c2594a1
remove console
waterim 71db5ef
Merge remote-tracking branch 'upstream/main' into feat-43686-report-f…
waterim cbc06d8
Merge remote-tracking branch 'upstream/main' into feat-43686-report-f…
waterim b94cd35
fixed const
waterim d3bc985
Merge remote-tracking branch 'upstream/main' into feat-43686-report-f…
waterim e5722af
conflicts, removed duplicate, test
waterim 35e868f
fix filter for a default 'text_title' report field
waterim 17298f7
fix tests and offline for create and delete flow
waterim f69d236
Merge remote-tracking branch 'upstream/main' into feat-43686-report-f…
waterim 221cf36
fix comments
waterim b9fa8df
rename function
waterim File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,10 @@ | ||
type PolicyReportFieldsReplace = { | ||
policyID: string; | ||
/** | ||
* Stringified JSON object with type of following structure: | ||
* Array<string> | ||
*/ | ||
reportFields: string; | ||
}; | ||
|
||
export default PolicyReportFieldsReplace; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -131,6 +131,7 @@ const WRITE_COMMANDS = { | |
RENAME_POLICY_TAG: 'RenamePolicyTag', | ||
SET_WORKSPACE_REQUIRES_CATEGORY: 'SetWorkspaceRequiresCategory', | ||
DELETE_WORKSPACE_CATEGORIES: 'DeleteWorkspaceCategories', | ||
POLICY_REPORT_FIELDS_REPLACE: 'Policy_ReportFields_Replace', | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. @waterim we should be using |
||
SET_POLICY_TAGS_REQUIRED: 'SetPolicyTagsRequired', | ||
SET_POLICY_REQUIRES_TAG: 'SetPolicyRequiresTag', | ||
RENAME_POLICY_TAG_LIST: 'RenamePolicyTaglist', | ||
|
@@ -372,6 +373,7 @@ type WriteCommandParameters = { | |
[WRITE_COMMANDS.RENAME_WORKSPACE_CATEGORY]: Parameters.RenameWorkspaceCategoriesParams; | ||
[WRITE_COMMANDS.SET_WORKSPACE_REQUIRES_CATEGORY]: Parameters.SetWorkspaceRequiresCategoryParams; | ||
[WRITE_COMMANDS.DELETE_WORKSPACE_CATEGORIES]: Parameters.DeleteWorkspaceCategoriesParams; | ||
[WRITE_COMMANDS.POLICY_REPORT_FIELDS_REPLACE]: Parameters.PolicyReportFieldsReplace; | ||
[WRITE_COMMANDS.SET_POLICY_REQUIRES_TAG]: Parameters.SetPolicyRequiresTag; | ||
[WRITE_COMMANDS.SET_POLICY_TAGS_REQUIRED]: Parameters.SetPolicyTagsRequired; | ||
[WRITE_COMMANDS.RENAME_POLICY_TAG_LIST]: Parameters.RenamePolicyTaglistParams; | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,98 @@ | ||
import type {NullishDeep, OnyxCollection} from 'react-native-onyx'; | ||
import Onyx from 'react-native-onyx'; | ||
import * as API from '@libs/API'; | ||
import {WRITE_COMMANDS} from '@libs/API/types'; | ||
import * as ErrorUtils from '@libs/ErrorUtils'; | ||
import * as ReportUtils from '@libs/ReportUtils'; | ||
import CONST from '@src/CONST'; | ||
import ONYXKEYS from '@src/ONYXKEYS'; | ||
import type {Policy, Report} from '@src/types/onyx'; | ||
import type {OnyxData} from '@src/types/onyx/Request'; | ||
|
||
const allPolicies: OnyxCollection<Policy> = {}; | ||
Onyx.connect({ | ||
key: ONYXKEYS.COLLECTION.POLICY, | ||
callback: (val, key) => { | ||
waterim marked this conversation as resolved.
Show resolved
Hide resolved
|
||
if (!key) { | ||
return; | ||
} | ||
if (val === null || val === undefined) { | ||
// If we are deleting a policy, we have to check every report linked to that policy | ||
// and unset the draft indicator (pencil icon) alongside removing any draft comments. Clearing these values will keep the newly archived chats from being displayed in the LHN. | ||
// More info: https://github.com/Expensify/App/issues/14260 | ||
const policyID = key.replace(ONYXKEYS.COLLECTION.POLICY, ''); | ||
const policyReports = ReportUtils.getAllPolicyReports(policyID); | ||
const cleanUpMergeQueries: Record<`${typeof ONYXKEYS.COLLECTION.REPORT}${string}`, NullishDeep<Report>> = {}; | ||
const cleanUpSetQueries: Record<`${typeof ONYXKEYS.COLLECTION.REPORT_DRAFT_COMMENT}${string}` | `${typeof ONYXKEYS.COLLECTION.REPORT_ACTIONS_DRAFTS}${string}`, null> = {}; | ||
policyReports.forEach((policyReport) => { | ||
if (!policyReport) { | ||
return; | ||
} | ||
const {reportID} = policyReport; | ||
cleanUpSetQueries[`${ONYXKEYS.COLLECTION.REPORT_DRAFT_COMMENT}${reportID}`] = null; | ||
cleanUpSetQueries[`${ONYXKEYS.COLLECTION.REPORT_ACTIONS_DRAFTS}${reportID}`] = null; | ||
}); | ||
Onyx.mergeCollection(ONYXKEYS.COLLECTION.REPORT, cleanUpMergeQueries); | ||
Onyx.multiSet(cleanUpSetQueries); | ||
delete allPolicies[key]; | ||
return; | ||
} | ||
|
||
allPolicies[key] = val; | ||
}, | ||
}); | ||
|
||
function deletePolicyReportFields(policyID: string, reportFieldsToUpdate: string[]) { | ||
waterim marked this conversation as resolved.
Show resolved
Hide resolved
|
||
const policy = allPolicies?.[`${ONYXKEYS.COLLECTION.POLICY}${policyID}`]; | ||
const allReportFields = policy?.fieldList ?? {}; | ||
|
||
const updatedReportFields = Object.fromEntries(Object.entries(allReportFields).filter(([key]) => !reportFieldsToUpdate.includes(key))); | ||
|
||
const onyxData: OnyxData = { | ||
optimisticData: [ | ||
{ | ||
onyxMethod: Onyx.METHOD.MERGE, | ||
key: `${ONYXKEYS.COLLECTION.POLICY}${policyID}`, | ||
value: { | ||
fieldList: updatedReportFields, | ||
waterim marked this conversation as resolved.
Show resolved
Hide resolved
|
||
pendingFields: {fieldList: CONST.RED_BRICK_ROAD_PENDING_ACTION.UPDATE}, | ||
}, | ||
}, | ||
], | ||
successData: [ | ||
{ | ||
onyxMethod: Onyx.METHOD.MERGE, | ||
key: `${ONYXKEYS.COLLECTION.POLICY}${policyID}`, | ||
value: { | ||
pendingFields: { | ||
fieldList: null, | ||
}, | ||
errorFields: null, | ||
}, | ||
}, | ||
], | ||
failureData: [ | ||
{ | ||
onyxMethod: Onyx.METHOD.MERGE, | ||
key: `${ONYXKEYS.COLLECTION.POLICY}${policyID}`, | ||
value: { | ||
fieldList: {...allReportFields}, | ||
pendingFields: {fieldList: null}, | ||
errorFields: { | ||
fieldList: ErrorUtils.getMicroSecondOnyxErrorWithTranslationKey('common.genericErrorMessage'), | ||
}, | ||
}, | ||
}, | ||
], | ||
}; | ||
|
||
const parameters = { | ||
policyID, | ||
reportFields: JSON.stringify(Object.values(updatedReportFields)), | ||
}; | ||
|
||
API.write(WRITE_COMMANDS.POLICY_REPORT_FIELDS_REPLACE, parameters, onyxData); | ||
} | ||
|
||
// eslint-disable-next-line import/prefer-default-export | ||
export {deletePolicyReportFields}; |
81 changes: 81 additions & 0 deletions
81
src/pages/workspace/reportFields/WorkspaceReportFieldSettingsPage.tsx
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,81 @@ | ||
import type {StackScreenProps} from '@react-navigation/stack'; | ||
import React from 'react'; | ||
import {View} from 'react-native'; | ||
import {useOnyx} from 'react-native-onyx'; | ||
import ConfirmModal from '@components/ConfirmModal'; | ||
import HeaderWithBackButton from '@components/HeaderWithBackButton'; | ||
import * as Expensicons from '@components/Icon/Expensicons'; | ||
import MenuItem from '@components/MenuItem'; | ||
import ScreenWrapper from '@components/ScreenWrapper'; | ||
import useLocalize from '@hooks/useLocalize'; | ||
import useThemeStyles from '@hooks/useThemeStyles'; | ||
import Navigation from '@libs/Navigation/Navigation'; | ||
import * as ReportUtils from '@libs/ReportUtils'; | ||
import type {SettingsNavigatorParamList} from '@navigation/types'; | ||
import NotFoundPage from '@pages/ErrorPage/NotFoundPage'; | ||
import AccessOrNotFoundWrapper from '@pages/workspace/AccessOrNotFoundWrapper'; | ||
import * as ReportField from '@userActions/Policy/ReportField'; | ||
import CONST from '@src/CONST'; | ||
import ONYXKEYS from '@src/ONYXKEYS'; | ||
import type SCREENS from '@src/SCREENS'; | ||
|
||
type WorkspaceReportFieldSettingsPageProps = StackScreenProps<SettingsNavigatorParamList, typeof SCREENS.WORKSPACE.REPORT_FIELD_SETTINGS>; | ||
|
||
function WorkspaceReportFieldSettings({route}: WorkspaceReportFieldSettingsPageProps) { | ||
const styles = useThemeStyles(); | ||
const {translate} = useLocalize(); | ||
const [policy] = useOnyx(`${ONYXKEYS.COLLECTION.POLICY}${route.params.policyID}`); | ||
const [isDeleteModalVisible, setIsDeleteModalVisible] = React.useState(false); | ||
const reportFieldKey = ReportUtils.getReportFieldKey(route.params.reportFieldKey); | ||
const currentPolicyReportField = policy?.fieldList?.[reportFieldKey]; | ||
if (!currentPolicyReportField) { | ||
return <NotFoundPage />; | ||
} | ||
|
||
const deleteReportFieldAndHideModal = () => { | ||
ReportField.deletePolicyReportFields(route.params.policyID, [reportFieldKey]); | ||
setIsDeleteModalVisible(false); | ||
Navigation.goBack(); | ||
}; | ||
|
||
return ( | ||
<AccessOrNotFoundWrapper | ||
accessVariants={[CONST.POLICY.ACCESS_VARIANTS.ADMIN, CONST.POLICY.ACCESS_VARIANTS.PAID]} | ||
policyID={route.params.policyID} | ||
featureName={CONST.POLICY.MORE_FEATURES.ARE_REPORT_FIELDS_ENABLED} | ||
> | ||
<ScreenWrapper | ||
includeSafeAreaPaddingBottom={false} | ||
style={[styles.defaultModalContainer]} | ||
testID={WorkspaceReportFieldSettings.displayName} | ||
> | ||
<HeaderWithBackButton | ||
title={currentPolicyReportField.name} | ||
shouldSetModalVisibility={false} | ||
/> | ||
<ConfirmModal | ||
title={translate('workspace.reportFields.delete')} | ||
isVisible={isDeleteModalVisible} | ||
onConfirm={deleteReportFieldAndHideModal} | ||
onCancel={() => setIsDeleteModalVisible(false)} | ||
shouldSetModalVisibility={false} | ||
prompt={translate('workspace.reportFields.deleteConfirmation')} | ||
confirmText={translate('common.delete')} | ||
cancelText={translate('common.cancel')} | ||
danger | ||
/> | ||
<View style={styles.flexGrow1}> | ||
<MenuItem | ||
icon={Expensicons.Trashcan} | ||
title={translate('common.delete')} | ||
onPress={() => setIsDeleteModalVisible(true)} | ||
/> | ||
</View> | ||
</ScreenWrapper> | ||
</AccessOrNotFoundWrapper> | ||
); | ||
} | ||
|
||
WorkspaceReportFieldSettings.displayName = 'WorkspaceReportFieldSettings'; | ||
|
||
export default WorkspaceReportFieldSettings; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think we should keep this cohesive and keep all the names same so.
If there would be other page that fits
settings
more we can rename this todetails
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@mountiny This is a different page, we have a report_FIELD_settings -> settings for a single report field
And we have report_FIELDS_settings -> settings for all report fields