Skip to content

Allow retryable optimistic workspace creation #11130

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

Merged
thienlnam merged 11 commits into from
Sep 21, 2022
Merged

Allow retryable optimistic workspace creation #11130

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
eba3320
create workspaces with API.write
jasperhuangg Sep 20, 2022
abb9b1d
remove debug statements
jasperhuangg Sep 20, 2022
d70bc34
Merge branch 'main' of github.com:Expensify/App into jasper-optimisti…
jasperhuangg Sep 20, 2022
5645f57
use policyIDListExcludingWorkspacesWithPendingActions
jasperhuangg Sep 20, 2022
521366b
Update App.js
jasperhuangg Sep 20, 2022
7844d5c
only exclude workspaces with pending action = add
jasperhuangg Sep 20, 2022
b1c2db2
rename to policyIDListExcludingWorkspacesCreatedOffline
jasperhuangg Sep 20, 2022
3dedd09
remove unused comment
jasperhuangg Sep 20, 2022
a7ad213
Update comment
jasperhuangg Sep 20, 2022
ffd1c81
use set instead of merge
jasperhuangg Sep 20, 2022
dcc1002
use set instead of merge for all optimistic data
jasperhuangg Sep 20, 2022
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
17 changes: 16 additions & 1 deletion src/libs/actions/App.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,21 @@ Onyx.connect({
},
});

// When we reconnect the app, we don't want to fetch workspaces created optimistically while offline since they don't exist yet in the back-end.
// If we fetched them then they'd return as empty objects which would clear out the optimistic policy values initially created locally.
// Once the re-queued call to CreateWorkspace returns, the full contents of the workspace excluded here should be correctly saved into Onyx.
let policyIDListExcludingWorkspacesCreatedOffline = [];
Onyx.connect({
key: ONYXKEYS.COLLECTION.POLICY,
waitForCollectionCallback: true,
callback: (policies) => {
const policiesExcludingWorkspacesCreatedOffline = _.reject(policies,
policy => lodashGet(policy, 'pendingAction', null) === CONST.RED_BRICK_ROAD_PENDING_ACTION.ADD
&& lodashGet(policy, 'type', null) === CONST.POLICY.TYPE.FREE);
policyIDListExcludingWorkspacesCreatedOffline = _.compact(_.pluck(policiesExcludingWorkspacesCreatedOffline, 'id'));
},
});

/**
* @param {String} locale
*/
Expand Down Expand Up @@ -124,7 +139,7 @@ function openApp() {
* Refreshes data when the app reconnects
*/
function reconnectApp() {
API.read('ReconnectApp', {policyIDList}, {
API.read('ReconnectApp', {policyIDListExcludingWorkspacesCreatedOffline}, {
Copy link
Contributor

@aldo-expensify aldo-expensify Oct 25, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The parameter expected in the Web API is policyIDList, not policyIDListExcludingWorkspacesCreatedOffline 😆

Copy link
Contributor

@neil-marcellini neil-marcellini Oct 26, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

😬

Copy link
Contributor

@aldo-expensify aldo-expensify Oct 26, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'll correct this in this PR btw: #12129

optimisticData: [{
onyxMethod: CONST.ONYX.METHOD.MERGE,
key: ONYXKEYS.IS_LOADING_REPORT_DATA,
Expand Down
25 changes: 11 additions & 14 deletions src/libs/actions/Policy.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -809,10 +809,7 @@ function createWorkspace() {
expenseReportActionData,
} = Report.buildOptimisticWorkspaceChats(policyID, workspaceName);

// We need to use makeRequestWithSideEffects as we try to redirect to the policy right after creation
// The policy hasn't been merged in Onyx data at this point, leading to an intermittent Not Found screen
// eslint-disable-next-line rulesdir/no-api-side-effects-method
API.makeRequestWithSideEffects('CreateWorkspace', {
API.write('CreateWorkspace', {
policyID,
announceChatReportID,
adminsChatReportID,
Expand All @@ -822,7 +819,7 @@ function createWorkspace() {
},
{
optimisticData: [{
onyxMethod: CONST.ONYX.METHOD.MERGE,
onyxMethod: CONST.ONYX.METHOD.SET,
key: `${ONYXKEYS.COLLECTION.POLICY}${policyID}`,
value: {
id: policyID,
Expand All @@ -835,7 +832,7 @@ function createWorkspace() {
},
},
{
onyxMethod: CONST.ONYX.METHOD.MERGE,
onyxMethod: CONST.ONYX.METHOD.SET,
key: `${ONYXKEYS.COLLECTION.POLICY_MEMBER_LIST}${policyID}`,
value: {
[sessionEmail]: {
Expand All @@ -845,32 +842,32 @@ function createWorkspace() {
},
},
{
onyxMethod: CONST.ONYX.METHOD.MERGE,
onyxMethod: CONST.ONYX.METHOD.SET,
key: `${ONYXKEYS.COLLECTION.REPORT}${announceChatReportID}`,
value: announceChatData,
},
{
onyxMethod: CONST.ONYX.METHOD.MERGE,
onyxMethod: CONST.ONYX.METHOD.SET,
key: `${ONYXKEYS.COLLECTION.REPORT_ACTIONS}${announceChatReportID}`,
value: announceReportActionData,
},
{
onyxMethod: CONST.ONYX.METHOD.MERGE,
onyxMethod: CONST.ONYX.METHOD.SET,
key: `${ONYXKEYS.COLLECTION.REPORT}${adminsChatReportID}`,
value: adminsChatData,
},
{
onyxMethod: CONST.ONYX.METHOD.MERGE,
onyxMethod: CONST.ONYX.METHOD.SET,
key: `${ONYXKEYS.COLLECTION.REPORT_ACTIONS}${adminsChatReportID}`,
value: adminsReportActionData,
},
{
onyxMethod: CONST.ONYX.METHOD.MERGE,
onyxMethod: CONST.ONYX.METHOD.SET,
key: `${ONYXKEYS.COLLECTION.REPORT}${expenseChatReportID}`,
value: expenseChatData,
},
{
onyxMethod: CONST.ONYX.METHOD.MERGE,
onyxMethod: CONST.ONYX.METHOD.SET,
key: `${ONYXKEYS.COLLECTION.REPORT_ACTIONS}${expenseChatReportID}`,
value: expenseReportActionData,
}],
Expand Down Expand Up @@ -961,9 +958,9 @@ function createWorkspace() {
key: `${ONYXKEYS.COLLECTION.REPORT_ACTIONS}${expenseChatReportID}`,
value: null,
}],
}).then(() => {
Navigation.navigate(ROUTES.getWorkspaceInitialRoute(policyID));
});

Navigation.navigate(ROUTES.getWorkspaceInitialRoute(policyID));
}

function openWorkspaceReimburseView(policyID) {
Expand Down