Page MenuHomePhabricator
Differential D11281

[lib] Add an optional ID field to all the actions
ClosedPublic
Actions

Authored by tomek on Mar 8 2024, 2:28 AM.
Tags
None
Referenced Files
F5118390: D11281.id.diff
Thu, Apr 3, 12:31 AM
F5118119: D11281.id38454.diff
Wed, Apr 2, 10:29 PM
Unknown Object (File)
Tue, Apr 1, 11:01 AM
Unknown Object (File)
Sun, Mar 30, 5:27 PM
Unknown Object (File)
Sun, Mar 30, 4:46 AM
Unknown Object (File)
Sun, Mar 30, 4:00 AM
Unknown Object (File)
Sun, Mar 30, 12:49 AM
Unknown Object (File)
Sat, Mar 29, 9:03 PM
View All Files
Subscribers
ashoat

Details

Reviewers
kamil
inka
will
Commits
rCOMMb80ef60087c4: [lib] Add an optional ID field to all the actions
Summary

This is needed to map between ops and actions

https://linear.app/comm/issue/ENG-7103/add-an-optional-id-field-to-all-the-actions

Depends on D11280

Test Plan

Flow

Diff Detail

Repository
rCOMM Comm
Lint
Lint Not Applicable
Unit
Tests Not Applicable

Event Timeline

tomek created this revision.Mar 8 2024, 2:28 AM
Herald added a subscriber: ashoat. · View Herald TranscriptMar 8 2024, 2:28 AM
Harbormaster completed remote builds in B27400: Diff 37944.Mar 8 2024, 2:44 AM
tomek requested review of this revision.Mar 8 2024, 2:44 AM
tomek added a child revision: D11284: [native][web] Queue new ops.Mar 8 2024, 9:11 AM
ashoat added a comment.Mar 8 2024, 6:22 PM

This is a big change, and complicated the types significantly. Can you explain more about why it's necessary to include these field on all actions?

kamil requested changes to this revision.Mar 12 2024, 8:15 AM

@tomek is off - going to request changes to clear our queues until he's back and able to respond to the question

This revision now requires changes to proceed.Mar 12 2024, 8:15 AM
tomek requested review of this revision.Mar 18 2024, 8:56 AM

Can you explain more about why it's necessary to include these field on all actions?

We need to know when the processing of an action is finished. This processing consists of generating 0 or more ops and applying them on the DB. We're introducing a new store, where the ops will be put and a handler that listens for new ops, applies them on the DB, and removes them from the store.

We need to know when the processing is finished, but we don't know which action generated which ops. The solution to that is introducing an optional ID to each action - with it, we will know that processing of some ops is the end of processing a given action. This field will be used in https://linear.app/comm/issue/ENG-7095/add-an-option-to-await-action-ops-processing - we're introducing a new dispatch-like function that calls dispatch with an ID and returns a promise that is resolved when the processing is finished. This is achieved by monitoring the ops store - when there are new ops with action ID which then later disappear, it means that the processing of that action is done.

ashoat added a comment.Mar 18 2024, 6:47 PM

Thanks for explaining!

kamil accepted this revision.Mar 19 2024, 4:56 AM
This revision is now accepted and ready to land.Mar 19 2024, 4:56 AM
tomek updated this revision to Diff 38262.Mar 21 2024, 5:07 AM

Rebase, update Redux types

Harbormaster completed remote builds in B27641: Diff 38262.Mar 21 2024, 5:21 AM
ashoat added a comment.Mar 21 2024, 5:58 PM

After today's meeting, I wonder if we still need to add this ID to all actions

tomek updated this revision to Diff 38368.Mar 27 2024, 8:48 AM

Rebase

tomek added a comment.Mar 27 2024, 8:50 AM
In D11281#328131, @ashoat wrote:

After today's meeting, I wonder if we still need to add this ID to all actions

With the most recent approach, described in https://linear.app/comm/issue/ENG-7040/implement-generating-and-awaiting-processed-ops, we still need an ID

Harbormaster completed remote builds in B27705: Diff 38368.Mar 27 2024, 9:03 AM
tomek updated this revision to Diff 38448.Mar 28 2024, 7:42 AM

Rebase

Harbormaster completed remote builds in B27768: Diff 38448.Mar 28 2024, 7:59 AM
Closed by commit rCOMMb80ef60087c4: [lib] Add an optional ID field to all the actions (authored by tomek). · Explain WhyMar 28 2024, 8:11 AM
This revision was automatically updated to reflect the committed changes.
tomek added a commit: rCOMMb80ef60087c4: [lib] Add an optional ID field to all the actions.

Revision Contents
Changeset List

PathSize
lib/
types/
2360 lines
2 lines
native/
redux/
62 lines
web/
redux/
27 lines

Diff 38454

View Options

lib/types/redux-types.js

Show First 20 Lines • Show All 72 Lines • ▼ Show 20 Linesimport type {
MessageStorePrunePayload, MessageStorePrunePayload,
LocallyComposedMessageInfo, LocallyComposedMessageInfo,
SimpleMessagesPayload, SimpleMessagesPayload,
FetchPinnedMessagesResult, FetchPinnedMessagesResult,
SearchMessagesResponse, SearchMessagesResponse,
} from './message-types.js'; } from './message-types.js';
import type { RawReactionMessageInfo } from './messages/reaction.js'; import type { RawReactionMessageInfo } from './messages/reaction.js';
import type { RawTextMessageInfo } from './messages/text.js'; import type { RawTextMessageInfo } from './messages/text.js';
import type { BaseNavInfo } from './nav-types.js'; import type { BaseNavInfo, WebNavInfo } from './nav-types.js';
import { import {
type ForcePolicyAcknowledgmentPayload, type ForcePolicyAcknowledgmentPayload,
type PolicyAcknowledgmentPayload, type PolicyAcknowledgmentPayload,
type UserPolicies, type UserPolicies,
} from './policy-types.js'; } from './policy-types.js';
import type { RelationshipErrors } from './relationship-types.js'; import type { RelationshipErrors } from './relationship-types.js';
import type { import type {
EnabledReports, EnabledReports,
Show All 24 Lines
import type { ThreadActivityStore } from './thread-activity-types.js'; import type { ThreadActivityStore } from './thread-activity-types.js';
import type { import type {
ThreadStore, ThreadStore,
ChangeThreadSettingsPayload, ChangeThreadSettingsPayload,
LeaveThreadPayload, LeaveThreadPayload,
NewThreadResult, NewThreadResult,
ThreadJoinPayload, ThreadJoinPayload,
ToggleMessagePinResult, ToggleMessagePinResult,
LegacyThreadStore,
RoleModificationPayload, RoleModificationPayload,
RoleDeletionPayload, RoleDeletionPayload,
} from './thread-types.js'; } from './thread-types.js';
import type { ClientUpdatesResultWithUserInfos } from './update-types.js'; import type { ClientUpdatesResultWithUserInfos } from './update-types.js';
import type { CurrentUserInfo, UserStore } from './user-types.js'; import type { CurrentUserInfo, UserInfos, UserStore } from './user-types.js';
import type { SetDeviceTokenActionPayload } from '../actions/device-actions.js'; import type { SetDeviceTokenActionPayload } from '../actions/device-actions.js';
import type { NotifPermissionAlertInfo } from '../utils/push-alerts.js'; import type { NotifPermissionAlertInfo } from '../utils/push-alerts.js';
export type BaseAppState<NavInfo: BaseNavInfo = BaseNavInfo> = { export type BaseAppState<NavInfo: BaseNavInfo = BaseNavInfo> = {
+navInfo: NavInfo, +navInfo: NavInfo,
+currentUserInfo: ?CurrentUserInfo, +currentUserInfo: ?CurrentUserInfo,
+draftStore: DraftStore, +draftStore: DraftStore,
+entryStore: EntryStore, +entryStore: EntryStore,
Show All 24 Lines
export type NativeAppState = BaseAppState<>; export type NativeAppState = BaseAppState<>;
export type WebAppState = BaseAppState<> & { export type WebAppState = BaseAppState<> & {
+cryptoStore: ?CryptoStore, +cryptoStore: ?CryptoStore,
+pushApiPublicKey: ?string, +pushApiPublicKey: ?string,
... ...
}; };
export type AppState = NativeAppState | WebAppState; export type AppState = NativeAppState | WebAppState;
export type WebInitialReduxStateResponse = {
+navInfo: WebNavInfo,
+currentUserInfo: CurrentUserInfo,
+entryStore: EntryStore,
+threadStore: LegacyThreadStore,
+userInfos: UserInfos,
+messageStore: MessageStore,
+pushApiPublicKey: ?string,
+commServicesAccessToken: null,
+inviteLinksStore: InviteLinksStore,
+keyserverInfo: WebInitialKeyserverInfo,
};
export type WebInitialKeyserverInfo = {
+sessionID: ?string,
+updatesCurrentAsOf: number,
};
export type BaseAction = export type BaseAction =
| { | {
+type: '@@redux/INIT', +type: '@@redux/INIT',
+payload?: void, +payload?: void,
} }
| { | {
+type: 'FETCH_ENTRIES_STARTED', +type: 'FETCH_ENTRIES_STARTED',
+payload?: void, +payload?: void,
▲ Show 20 Lines • Show All 1,154 Lines • Show Last 20 Lines
View Options

lib/types/request-types.js

Show First 20 Lines • Show All 72 Lines • ▼ Show 20 Linesimport type {
MessageStorePrunePayload, MessageStorePrunePayload,
LocallyComposedMessageInfo, LocallyComposedMessageInfo,
SimpleMessagesPayload, SimpleMessagesPayload,
FetchPinnedMessagesResult, FetchPinnedMessagesResult,
SearchMessagesResponse, SearchMessagesResponse,
} from './message-types.js'; } from './message-types.js';
import type { RawReactionMessageInfo } from './messages/reaction.js'; import type { RawReactionMessageInfo } from './messages/reaction.js';
import type { RawTextMessageInfo } from './messages/text.js'; import type { RawTextMessageInfo } from './messages/text.js';
import type { BaseNavInfo } from './nav-types.js'; import type { BaseNavInfo, WebNavInfo } from './nav-types.js';
import { import {
type ForcePolicyAcknowledgmentPayload, type ForcePolicyAcknowledgmentPayload,
type PolicyAcknowledgmentPayload, type PolicyAcknowledgmentPayload,
type UserPolicies, type UserPolicies,
} from './policy-types.js'; } from './policy-types.js';
import type { RelationshipErrors } from './relationship-types.js'; import type { RelationshipErrors } from './relationship-types.js';
import type { import type {
EnabledReports, EnabledReports,
Show All 24 Lines
import type { ThreadActivityStore } from './thread-activity-types.js'; import type { ThreadActivityStore } from './thread-activity-types.js';
import type { import type {
ThreadStore, ThreadStore,
ChangeThreadSettingsPayload, ChangeThreadSettingsPayload,
LeaveThreadPayload, LeaveThreadPayload,
NewThreadResult, NewThreadResult,
ThreadJoinPayload, ThreadJoinPayload,
ToggleMessagePinResult, ToggleMessagePinResult,
LegacyThreadStore,
RoleModificationPayload, RoleModificationPayload,
RoleDeletionPayload, RoleDeletionPayload,
} from './thread-types.js'; } from './thread-types.js';
import type { ClientUpdatesResultWithUserInfos } from './update-types.js'; import type { ClientUpdatesResultWithUserInfos } from './update-types.js';
import type { CurrentUserInfo, UserStore } from './user-types.js'; import type { CurrentUserInfo, UserInfos, UserStore } from './user-types.js';
import type { SetDeviceTokenActionPayload } from '../actions/device-actions.js'; import type { SetDeviceTokenActionPayload } from '../actions/device-actions.js';
import type { NotifPermissionAlertInfo } from '../utils/push-alerts.js'; import type { NotifPermissionAlertInfo } from '../utils/push-alerts.js';
export type BaseAppState<NavInfo: BaseNavInfo = BaseNavInfo> = { export type BaseAppState<NavInfo: BaseNavInfo = BaseNavInfo> = {
+navInfo: NavInfo, +navInfo: NavInfo,
+currentUserInfo: ?CurrentUserInfo, +currentUserInfo: ?CurrentUserInfo,
+draftStore: DraftStore, +draftStore: DraftStore,
+entryStore: EntryStore, +entryStore: EntryStore,
Show All 24 Lines
export type NativeAppState = BaseAppState<>; export type NativeAppState = BaseAppState<>;
export type WebAppState = BaseAppState<> & { export type WebAppState = BaseAppState<> & {
+cryptoStore: ?CryptoStore, +cryptoStore: ?CryptoStore,
+pushApiPublicKey: ?string, +pushApiPublicKey: ?string,
... ...
}; };
export type AppState = NativeAppState | WebAppState; export type AppState = NativeAppState | WebAppState;
export type WebInitialReduxStateResponse = {
+navInfo: WebNavInfo,
+currentUserInfo: CurrentUserInfo,
+entryStore: EntryStore,
+threadStore: LegacyThreadStore,
+userInfos: UserInfos,
+messageStore: MessageStore,
+pushApiPublicKey: ?string,
+commServicesAccessToken: null,
+inviteLinksStore: InviteLinksStore,
+keyserverInfo: WebInitialKeyserverInfo,
};
export type WebInitialKeyserverInfo = {
+sessionID: ?string,
+updatesCurrentAsOf: number,
};
export type BaseAction = export type BaseAction =
| { | {
+type: '@@redux/INIT', +type: '@@redux/INIT',
+payload?: void, +payload?: void,
} }
| { | {
+type: 'FETCH_ENTRIES_STARTED', +type: 'FETCH_ENTRIES_STARTED',
+payload?: void, +payload?: void,
▲ Show 20 Lines • Show All 1,154 Lines • Show Last 20 Lines
View Options

native/redux/action-types.js

Show First 20 Lines • Show All 72 Lines • ▼ Show 20 Linesimport type {
MessageStorePrunePayload, MessageStorePrunePayload,
LocallyComposedMessageInfo, LocallyComposedMessageInfo,
SimpleMessagesPayload, SimpleMessagesPayload,
FetchPinnedMessagesResult, FetchPinnedMessagesResult,
SearchMessagesResponse, SearchMessagesResponse,
} from './message-types.js'; } from './message-types.js';
import type { RawReactionMessageInfo } from './messages/reaction.js'; import type { RawReactionMessageInfo } from './messages/reaction.js';
import type { RawTextMessageInfo } from './messages/text.js'; import type { RawTextMessageInfo } from './messages/text.js';
import type { BaseNavInfo } from './nav-types.js'; import type { BaseNavInfo, WebNavInfo } from './nav-types.js';
import { import {
type ForcePolicyAcknowledgmentPayload, type ForcePolicyAcknowledgmentPayload,
type PolicyAcknowledgmentPayload, type PolicyAcknowledgmentPayload,
type UserPolicies, type UserPolicies,
} from './policy-types.js'; } from './policy-types.js';
import type { RelationshipErrors } from './relationship-types.js'; import type { RelationshipErrors } from './relationship-types.js';
import type { import type {
EnabledReports, EnabledReports,
Show All 24 Lines
import type { ThreadActivityStore } from './thread-activity-types.js'; import type { ThreadActivityStore } from './thread-activity-types.js';
import type { import type {
ThreadStore, ThreadStore,
ChangeThreadSettingsPayload, ChangeThreadSettingsPayload,
LeaveThreadPayload, LeaveThreadPayload,
NewThreadResult, NewThreadResult,
ThreadJoinPayload, ThreadJoinPayload,
ToggleMessagePinResult, ToggleMessagePinResult,
LegacyThreadStore,
RoleModificationPayload, RoleModificationPayload,
RoleDeletionPayload, RoleDeletionPayload,
} from './thread-types.js'; } from './thread-types.js';
import type { ClientUpdatesResultWithUserInfos } from './update-types.js'; import type { ClientUpdatesResultWithUserInfos } from './update-types.js';
import type { CurrentUserInfo, UserStore } from './user-types.js'; import type { CurrentUserInfo, UserInfos, UserStore } from './user-types.js';
import type { SetDeviceTokenActionPayload } from '../actions/device-actions.js'; import type { SetDeviceTokenActionPayload } from '../actions/device-actions.js';
import type { NotifPermissionAlertInfo } from '../utils/push-alerts.js'; import type { NotifPermissionAlertInfo } from '../utils/push-alerts.js';
export type BaseAppState<NavInfo: BaseNavInfo = BaseNavInfo> = { export type BaseAppState<NavInfo: BaseNavInfo = BaseNavInfo> = {
+navInfo: NavInfo, +navInfo: NavInfo,
+currentUserInfo: ?CurrentUserInfo, +currentUserInfo: ?CurrentUserInfo,
+draftStore: DraftStore, +draftStore: DraftStore,
+entryStore: EntryStore, +entryStore: EntryStore,
Show All 24 Lines
export type NativeAppState = BaseAppState<>; export type NativeAppState = BaseAppState<>;
export type WebAppState = BaseAppState<> & { export type WebAppState = BaseAppState<> & {
+cryptoStore: ?CryptoStore, +cryptoStore: ?CryptoStore,
+pushApiPublicKey: ?string, +pushApiPublicKey: ?string,
... ...
}; };
export type AppState = NativeAppState | WebAppState; export type AppState = NativeAppState | WebAppState;
export type WebInitialReduxStateResponse = {
+navInfo: WebNavInfo,
+currentUserInfo: CurrentUserInfo,
+entryStore: EntryStore,
+threadStore: LegacyThreadStore,
+userInfos: UserInfos,
+messageStore: MessageStore,
+pushApiPublicKey: ?string,
+commServicesAccessToken: null,
+inviteLinksStore: InviteLinksStore,
+keyserverInfo: WebInitialKeyserverInfo,
};
export type WebInitialKeyserverInfo = {
+sessionID: ?string,
+updatesCurrentAsOf: number,
};
export type BaseAction = export type BaseAction =
| { | {
+type: '@@redux/INIT', +type: '@@redux/INIT',
+payload?: void, +payload?: void,
} }
| { | {
+type: 'FETCH_ENTRIES_STARTED', +type: 'FETCH_ENTRIES_STARTED',
+payload?: void, +payload?: void,
▲ Show 20 Lines • Show All 1,154 Lines • Show Last 20 Lines
View Options

web/redux/redux-setup.js

Show First 20 Lines • Show All 72 Lines • ▼ Show 20 Linesimport type {
MessageStorePrunePayload, MessageStorePrunePayload,
LocallyComposedMessageInfo, LocallyComposedMessageInfo,
SimpleMessagesPayload, SimpleMessagesPayload,
FetchPinnedMessagesResult, FetchPinnedMessagesResult,
SearchMessagesResponse, SearchMessagesResponse,
} from './message-types.js'; } from './message-types.js';
import type { RawReactionMessageInfo } from './messages/reaction.js'; import type { RawReactionMessageInfo } from './messages/reaction.js';
import type { RawTextMessageInfo } from './messages/text.js'; import type { RawTextMessageInfo } from './messages/text.js';
import type { BaseNavInfo } from './nav-types.js'; import type { BaseNavInfo, WebNavInfo } from './nav-types.js';
import { import {
type ForcePolicyAcknowledgmentPayload, type ForcePolicyAcknowledgmentPayload,
type PolicyAcknowledgmentPayload, type PolicyAcknowledgmentPayload,
type UserPolicies, type UserPolicies,
} from './policy-types.js'; } from './policy-types.js';
import type { RelationshipErrors } from './relationship-types.js'; import type { RelationshipErrors } from './relationship-types.js';
import type { import type {
EnabledReports, EnabledReports,
Show All 24 Lines
import type { ThreadActivityStore } from './thread-activity-types.js'; import type { ThreadActivityStore } from './thread-activity-types.js';
import type { import type {
ThreadStore, ThreadStore,
ChangeThreadSettingsPayload, ChangeThreadSettingsPayload,
LeaveThreadPayload, LeaveThreadPayload,
NewThreadResult, NewThreadResult,
ThreadJoinPayload, ThreadJoinPayload,
ToggleMessagePinResult, ToggleMessagePinResult,
LegacyThreadStore,
RoleModificationPayload, RoleModificationPayload,
RoleDeletionPayload, RoleDeletionPayload,
} from './thread-types.js'; } from './thread-types.js';
import type { ClientUpdatesResultWithUserInfos } from './update-types.js'; import type { ClientUpdatesResultWithUserInfos } from './update-types.js';
import type { CurrentUserInfo, UserStore } from './user-types.js'; import type { CurrentUserInfo, UserInfos, UserStore } from './user-types.js';
import type { SetDeviceTokenActionPayload } from '../actions/device-actions.js'; import type { SetDeviceTokenActionPayload } from '../actions/device-actions.js';
import type { NotifPermissionAlertInfo } from '../utils/push-alerts.js'; import type { NotifPermissionAlertInfo } from '../utils/push-alerts.js';
export type BaseAppState<NavInfo: BaseNavInfo = BaseNavInfo> = { export type BaseAppState<NavInfo: BaseNavInfo = BaseNavInfo> = {
+navInfo: NavInfo, +navInfo: NavInfo,
+currentUserInfo: ?CurrentUserInfo, +currentUserInfo: ?CurrentUserInfo,
+draftStore: DraftStore, +draftStore: DraftStore,
+entryStore: EntryStore, +entryStore: EntryStore,
Show All 24 Lines
export type NativeAppState = BaseAppState<>; export type NativeAppState = BaseAppState<>;
export type WebAppState = BaseAppState<> & { export type WebAppState = BaseAppState<> & {
+cryptoStore: ?CryptoStore, +cryptoStore: ?CryptoStore,
+pushApiPublicKey: ?string, +pushApiPublicKey: ?string,
... ...
}; };
export type AppState = NativeAppState | WebAppState; export type AppState = NativeAppState | WebAppState;
export type WebInitialReduxStateResponse = {
+navInfo: WebNavInfo,
+currentUserInfo: CurrentUserInfo,
+entryStore: EntryStore,
+threadStore: LegacyThreadStore,
+userInfos: UserInfos,
+messageStore: MessageStore,
+pushApiPublicKey: ?string,
+commServicesAccessToken: null,
+inviteLinksStore: InviteLinksStore,
+keyserverInfo: WebInitialKeyserverInfo,
};
export type WebInitialKeyserverInfo = {
+sessionID: ?string,
+updatesCurrentAsOf: number,
};
export type BaseAction = export type BaseAction =
| { | {
+type: '@@redux/INIT', +type: '@@redux/INIT',
+payload?: void, +payload?: void,
} }
| { | {
+type: 'FETCH_ENTRIES_STARTED', +type: 'FETCH_ENTRIES_STARTED',
+payload?: void, +payload?: void,
▲ Show 20 Lines • Show All 1,154 Lines • Show Last 20 Lines