[lib] Validate DM operations
ClosedPublic
Actions

Authored by tomek on Sep 26 2024, 3:14 AM.

Details

Reviewers

kamil
will

Commits

rCOMM23ee267213b4: [lib] Validate DM operations

Summary

Add an explicit validation with some logs.

https://linear.app/comm/issue/ENG-9190/alternative-solution-update-canbeprocessed-functions

Depends on D13464

Test Plan

Clicked through the app and verified that e.g. sending text messages, reacting, and creating sidebars work.
Created some invalid operations from code and checked if it is discarded.

Diff Detail

Repository

rCOMM Comm

Lint

No Lint Coverage

Unit

No Test Coverage

Event Timeline

tomek created this revision.Sep 26 2024, 3:14 AM

Herald added a subscriber: ashoat. · View Herald TranscriptSep 26 2024, 3:14 AM

Harbormaster completed remote builds in B31873: Diff 44591.Sep 26 2024, 3:31 AM

tomek requested review of this revision.Sep 26 2024, 3:31 AM

tomek added a child revision: D13490: [lib] Handle a case where viewer is added to a thread while being its member.Sep 26 2024, 4:16 AM

kamil accepted this revision.Sep 26 2024, 7:35 AM

This revision is now accepted and ready to land.Sep 26 2024, 7:35 AM

Rebase

Harbormaster completed remote builds in B31897: Diff 44622.Sep 27 2024, 3:39 AM

Closed by commit rCOMM23ee267213b4: [lib] Validate DM operations (authored by tomek). · Explain WhySep 27 2024, 3:54 AM

This revision was automatically updated to reflect the committed changes.

tomek added a commit: rCOMM23ee267213b4: [lib] Validate DM operations.

Revision Contents
Changeset List

Path

Size

lib/

shared/

dm-ops/

add-members-spec.js

6 lines

add-viewer-to-thread-members-spec.js

6 lines

change-thread-read-status-spec.js

8 lines

change-thread-settings-spec.js

10 lines

change-thread-subscription.js

6 lines

create-entry-spec.js

6 lines

create-sidebar-spec.js

6 lines

create-thread-spec.js

8 lines

6 lines

3 lines

6 lines

6 lines

6 lines

5 lines

remove-members-spec.js

6 lines

send-edit-message-spec.js

6 lines

send-multimedia-message-spec.js

8 lines

send-reaction-message-spec.js

6 lines

send-text-message-spec.js

6 lines

update-relationship-spec.js

6 lines

Diff 44622

View Options

lib/shared/dm-ops/add-members-spec.js

// @flow		// @flow

		import _keyBy from 'lodash/fp/keyBy.js';

import type { ClientDBMessageStoreOperation } from 'lib/ops/message-store-ops.js';		import type { ClientDBMessageStoreOperation } from 'lib/ops/message-store-ops.js';
		import type { ClientDBThreadStoreOperation } from 'lib/ops/thread-store-ops.js';
import type {		import type {
RawMessageInfo,		RawMessageInfo,
ClientDBMessageInfo,		ClientDBMessageInfo,
ClientDBThreadMessageInfo,		ClientDBThreadMessageInfo,
} from 'lib/types/message-types.js';		} from 'lib/types/message-types.js';
		import type {
		ClientDBThreadInfo,
		RawThreadInfos,
		} from 'lib/types/thread-types.js';
import {		import {
translateClientDBMessageInfoToRawMessageInfo,		translateClientDBMessageInfoToRawMessageInfo,
translateRawMessageInfoToClientDBMessageInfo,		translateRawMessageInfoToClientDBMessageInfo,
translateClientDBThreadMessageInfos,		translateClientDBThreadMessageInfos,
translateThreadMessageInfoToClientDBThreadMessageInfo,		translateThreadMessageInfoToClientDBThreadMessageInfo,
type TranslatedThreadMessageInfos,		type TranslatedThreadMessageInfos,
} from 'lib/utils/message-ops-utils.js';		} from 'lib/utils/message-ops-utils.js';
import { entries } from 'lib/utils/objects.js';		import { entries, values } from 'lib/utils/objects.js';
		import {
		convertClientDBThreadInfoToRawThreadInfo,
		convertRawThreadInfoToClientDBThreadInfo,
		} from 'lib/utils/thread-ops-utils.js';

		function createUpdateDBOpsForThreadStoreThreadInfos(
		clientDBThreadInfos: $ReadOnlyArray<ClientDBThreadInfo>,
		migrationFunc: RawThreadInfos => RawThreadInfos,
		): $ReadOnlyArray<ClientDBThreadStoreOperation> {
		// 1. Translate `ClientDBThreadInfo`s to `RawThreadInfo`s.
		const rawThreadInfos = clientDBThreadInfos.map(
		convertClientDBThreadInfoToRawThreadInfo,
		);

		// 2. Convert `RawThreadInfo`s to a map of `threadID` => `threadInfo`.
		const keyedRawThreadInfos = _keyBy('id')(rawThreadInfos);

		// 3. Apply `migrationFunc` to `ThreadInfo`s.
		const updatedKeyedRawThreadInfos = migrationFunc(keyedRawThreadInfos);

		// 4. Convert the updated `RawThreadInfos` back into an array.
		const updatedKeyedRawThreadInfosArray = values(updatedKeyedRawThreadInfos);

		// 5. Translate `RawThreadInfo`s back to `ClientDBThreadInfo`s.
		const updatedClientDBThreadInfos = updatedKeyedRawThreadInfosArray.map(
		convertRawThreadInfoToClientDBThreadInfo,
		);

		// 6. Construct `replace` `ClientDBThreadStoreOperation`s.
		const replaceThreadOperations = updatedClientDBThreadInfos.map(thread => ({
		type: 'replace',
		payload: thread,
		}));

		// 7. Prepend `replaceThreadOperations` with `remove_all` op and return.
		return [{ type: 'remove_all' }, ...replaceThreadOperations];
		}

function createUpdateDBOpsForMessageStoreMessages(		function createUpdateDBOpsForMessageStoreMessages(
clientDBMessageInfos: $ReadOnlyArray<ClientDBMessageInfo>,		clientDBMessageInfos: $ReadOnlyArray<ClientDBMessageInfo>,
migrationFunc: (		migrationFunc: (
$ReadOnlyArray<RawMessageInfo>,		$ReadOnlyArray<RawMessageInfo>,
) => $ReadOnlyArray<RawMessageInfo>,		) => $ReadOnlyArray<RawMessageInfo>,
): $ReadOnlyArray<ClientDBMessageStoreOperation> {		): $ReadOnlyArray<ClientDBMessageStoreOperation> {
const rawMessageInfos = clientDBMessageInfos.map(		const rawMessageInfos = clientDBMessageInfos.map(
Show All 39 Lines	return [
translateThreadMessageInfoToClientDBThreadMessageInfo(id, thread),		translateThreadMessageInfoToClientDBThreadMessageInfo(id, thread),
),		),
},		},
},		},
];		];
}		}

export {		export {
		createUpdateDBOpsForThreadStoreThreadInfos,
createUpdateDBOpsForMessageStoreMessages,		createUpdateDBOpsForMessageStoreMessages,
createUpdateDBOpsForMessageStoreThreads,		createUpdateDBOpsForMessageStoreThreads,
};		};

View Options

lib/shared/dm-ops/add-viewer-to-thread-members-spec.js

// @flow		// @flow

		import _keyBy from 'lodash/fp/keyBy.js';

import type { ClientDBMessageStoreOperation } from 'lib/ops/message-store-ops.js';		import type { ClientDBMessageStoreOperation } from 'lib/ops/message-store-ops.js';
		import type { ClientDBThreadStoreOperation } from 'lib/ops/thread-store-ops.js';
import type {		import type {
RawMessageInfo,		RawMessageInfo,
ClientDBMessageInfo,		ClientDBMessageInfo,
ClientDBThreadMessageInfo,		ClientDBThreadMessageInfo,
} from 'lib/types/message-types.js';		} from 'lib/types/message-types.js';
		import type {
		ClientDBThreadInfo,
		RawThreadInfos,
		} from 'lib/types/thread-types.js';
import {		import {
translateClientDBMessageInfoToRawMessageInfo,		translateClientDBMessageInfoToRawMessageInfo,
translateRawMessageInfoToClientDBMessageInfo,		translateRawMessageInfoToClientDBMessageInfo,
translateClientDBThreadMessageInfos,		translateClientDBThreadMessageInfos,
translateThreadMessageInfoToClientDBThreadMessageInfo,		translateThreadMessageInfoToClientDBThreadMessageInfo,
type TranslatedThreadMessageInfos,		type TranslatedThreadMessageInfos,
} from 'lib/utils/message-ops-utils.js';		} from 'lib/utils/message-ops-utils.js';
import { entries } from 'lib/utils/objects.js';		import { entries, values } from 'lib/utils/objects.js';
		import {
		convertClientDBThreadInfoToRawThreadInfo,
		convertRawThreadInfoToClientDBThreadInfo,
		} from 'lib/utils/thread-ops-utils.js';

		function createUpdateDBOpsForThreadStoreThreadInfos(
		clientDBThreadInfos: $ReadOnlyArray<ClientDBThreadInfo>,
		migrationFunc: RawThreadInfos => RawThreadInfos,
		): $ReadOnlyArray<ClientDBThreadStoreOperation> {
		// 1. Translate `ClientDBThreadInfo`s to `RawThreadInfo`s.
		const rawThreadInfos = clientDBThreadInfos.map(
		convertClientDBThreadInfoToRawThreadInfo,
		);

		// 2. Convert `RawThreadInfo`s to a map of `threadID` => `threadInfo`.
		const keyedRawThreadInfos = _keyBy('id')(rawThreadInfos);

		// 3. Apply `migrationFunc` to `ThreadInfo`s.
		const updatedKeyedRawThreadInfos = migrationFunc(keyedRawThreadInfos);

		// 4. Convert the updated `RawThreadInfos` back into an array.
		const updatedKeyedRawThreadInfosArray = values(updatedKeyedRawThreadInfos);

		// 5. Translate `RawThreadInfo`s back to `ClientDBThreadInfo`s.
		const updatedClientDBThreadInfos = updatedKeyedRawThreadInfosArray.map(
		convertRawThreadInfoToClientDBThreadInfo,
		);

		// 6. Construct `replace` `ClientDBThreadStoreOperation`s.
		const replaceThreadOperations = updatedClientDBThreadInfos.map(thread => ({
		type: 'replace',
		payload: thread,
		}));

		// 7. Prepend `replaceThreadOperations` with `remove_all` op and return.
		return [{ type: 'remove_all' }, ...replaceThreadOperations];
		}

function createUpdateDBOpsForMessageStoreMessages(		function createUpdateDBOpsForMessageStoreMessages(
clientDBMessageInfos: $ReadOnlyArray<ClientDBMessageInfo>,		clientDBMessageInfos: $ReadOnlyArray<ClientDBMessageInfo>,
migrationFunc: (		migrationFunc: (
$ReadOnlyArray<RawMessageInfo>,		$ReadOnlyArray<RawMessageInfo>,
) => $ReadOnlyArray<RawMessageInfo>,		) => $ReadOnlyArray<RawMessageInfo>,
): $ReadOnlyArray<ClientDBMessageStoreOperation> {		): $ReadOnlyArray<ClientDBMessageStoreOperation> {
const rawMessageInfos = clientDBMessageInfos.map(		const rawMessageInfos = clientDBMessageInfos.map(
Show All 39 Lines	return [
translateThreadMessageInfoToClientDBThreadMessageInfo(id, thread),		translateThreadMessageInfoToClientDBThreadMessageInfo(id, thread),
),		),
},		},
},		},
];		];
}		}

export {		export {
		createUpdateDBOpsForThreadStoreThreadInfos,
createUpdateDBOpsForMessageStoreMessages,		createUpdateDBOpsForMessageStoreMessages,
createUpdateDBOpsForMessageStoreThreads,		createUpdateDBOpsForMessageStoreThreads,
};		};

View Options

lib/shared/dm-ops/change-thread-read-status-spec.js

// @flow		// @flow

		import _keyBy from 'lodash/fp/keyBy.js';

import type { ClientDBMessageStoreOperation } from 'lib/ops/message-store-ops.js';		import type { ClientDBMessageStoreOperation } from 'lib/ops/message-store-ops.js';
		import type { ClientDBThreadStoreOperation } from 'lib/ops/thread-store-ops.js';
import type {		import type {
RawMessageInfo,		RawMessageInfo,
ClientDBMessageInfo,		ClientDBMessageInfo,
ClientDBThreadMessageInfo,		ClientDBThreadMessageInfo,
} from 'lib/types/message-types.js';		} from 'lib/types/message-types.js';
		import type {
		ClientDBThreadInfo,
		RawThreadInfos,
		} from 'lib/types/thread-types.js';
import {		import {
translateClientDBMessageInfoToRawMessageInfo,		translateClientDBMessageInfoToRawMessageInfo,
translateRawMessageInfoToClientDBMessageInfo,		translateRawMessageInfoToClientDBMessageInfo,
translateClientDBThreadMessageInfos,		translateClientDBThreadMessageInfos,
translateThreadMessageInfoToClientDBThreadMessageInfo,		translateThreadMessageInfoToClientDBThreadMessageInfo,
type TranslatedThreadMessageInfos,		type TranslatedThreadMessageInfos,
} from 'lib/utils/message-ops-utils.js';		} from 'lib/utils/message-ops-utils.js';
import { entries } from 'lib/utils/objects.js';		import { entries, values } from 'lib/utils/objects.js';
		import {
		convertClientDBThreadInfoToRawThreadInfo,
		convertRawThreadInfoToClientDBThreadInfo,
		} from 'lib/utils/thread-ops-utils.js';

		function createUpdateDBOpsForThreadStoreThreadInfos(
		clientDBThreadInfos: $ReadOnlyArray<ClientDBThreadInfo>,
		migrationFunc: RawThreadInfos => RawThreadInfos,
		): $ReadOnlyArray<ClientDBThreadStoreOperation> {
		// 1. Translate `ClientDBThreadInfo`s to `RawThreadInfo`s.
		const rawThreadInfos = clientDBThreadInfos.map(
		convertClientDBThreadInfoToRawThreadInfo,
		);

		// 2. Convert `RawThreadInfo`s to a map of `threadID` => `threadInfo`.
		const keyedRawThreadInfos = _keyBy('id')(rawThreadInfos);

		// 3. Apply `migrationFunc` to `ThreadInfo`s.
		const updatedKeyedRawThreadInfos = migrationFunc(keyedRawThreadInfos);

		// 4. Convert the updated `RawThreadInfos` back into an array.
		const updatedKeyedRawThreadInfosArray = values(updatedKeyedRawThreadInfos);

		// 5. Translate `RawThreadInfo`s back to `ClientDBThreadInfo`s.
		const updatedClientDBThreadInfos = updatedKeyedRawThreadInfosArray.map(
		convertRawThreadInfoToClientDBThreadInfo,
		);

		// 6. Construct `replace` `ClientDBThreadStoreOperation`s.
		const replaceThreadOperations = updatedClientDBThreadInfos.map(thread => ({
		type: 'replace',
		payload: thread,
		}));

		// 7. Prepend `replaceThreadOperations` with `remove_all` op and return.
		return [{ type: 'remove_all' }, ...replaceThreadOperations];
		}

function createUpdateDBOpsForMessageStoreMessages(		function createUpdateDBOpsForMessageStoreMessages(
clientDBMessageInfos: $ReadOnlyArray<ClientDBMessageInfo>,		clientDBMessageInfos: $ReadOnlyArray<ClientDBMessageInfo>,
migrationFunc: (		migrationFunc: (
$ReadOnlyArray<RawMessageInfo>,		$ReadOnlyArray<RawMessageInfo>,
) => $ReadOnlyArray<RawMessageInfo>,		) => $ReadOnlyArray<RawMessageInfo>,
): $ReadOnlyArray<ClientDBMessageStoreOperation> {		): $ReadOnlyArray<ClientDBMessageStoreOperation> {
const rawMessageInfos = clientDBMessageInfos.map(		const rawMessageInfos = clientDBMessageInfos.map(
Show All 39 Lines	return [
translateThreadMessageInfoToClientDBThreadMessageInfo(id, thread),		translateThreadMessageInfoToClientDBThreadMessageInfo(id, thread),
),		),
},		},
},		},
];		];
}		}

export {		export {
		createUpdateDBOpsForThreadStoreThreadInfos,
createUpdateDBOpsForMessageStoreMessages,		createUpdateDBOpsForMessageStoreMessages,
createUpdateDBOpsForMessageStoreThreads,		createUpdateDBOpsForMessageStoreThreads,
};		};

View Options

lib/shared/dm-ops/change-thread-settings-spec.js

// @flow		// @flow

		import _keyBy from 'lodash/fp/keyBy.js';

import type { ClientDBMessageStoreOperation } from 'lib/ops/message-store-ops.js';		import type { ClientDBMessageStoreOperation } from 'lib/ops/message-store-ops.js';
		import type { ClientDBThreadStoreOperation } from 'lib/ops/thread-store-ops.js';
import type {		import type {
RawMessageInfo,		RawMessageInfo,
ClientDBMessageInfo,		ClientDBMessageInfo,
ClientDBThreadMessageInfo,		ClientDBThreadMessageInfo,
} from 'lib/types/message-types.js';		} from 'lib/types/message-types.js';
		import type {
		ClientDBThreadInfo,
		RawThreadInfos,
		} from 'lib/types/thread-types.js';
import {		import {
translateClientDBMessageInfoToRawMessageInfo,		translateClientDBMessageInfoToRawMessageInfo,
translateRawMessageInfoToClientDBMessageInfo,		translateRawMessageInfoToClientDBMessageInfo,
translateClientDBThreadMessageInfos,		translateClientDBThreadMessageInfos,
translateThreadMessageInfoToClientDBThreadMessageInfo,		translateThreadMessageInfoToClientDBThreadMessageInfo,
type TranslatedThreadMessageInfos,		type TranslatedThreadMessageInfos,
} from 'lib/utils/message-ops-utils.js';		} from 'lib/utils/message-ops-utils.js';
import { entries } from 'lib/utils/objects.js';		import { entries, values } from 'lib/utils/objects.js';
		import {
		convertClientDBThreadInfoToRawThreadInfo,
		convertRawThreadInfoToClientDBThreadInfo,
		} from 'lib/utils/thread-ops-utils.js';

		function createUpdateDBOpsForThreadStoreThreadInfos(
		clientDBThreadInfos: $ReadOnlyArray<ClientDBThreadInfo>,
		migrationFunc: RawThreadInfos => RawThreadInfos,
		): $ReadOnlyArray<ClientDBThreadStoreOperation> {
		// 1. Translate `ClientDBThreadInfo`s to `RawThreadInfo`s.
		const rawThreadInfos = clientDBThreadInfos.map(
		convertClientDBThreadInfoToRawThreadInfo,
		);

		// 2. Convert `RawThreadInfo`s to a map of `threadID` => `threadInfo`.
		const keyedRawThreadInfos = _keyBy('id')(rawThreadInfos);

		// 3. Apply `migrationFunc` to `ThreadInfo`s.
		const updatedKeyedRawThreadInfos = migrationFunc(keyedRawThreadInfos);

		// 4. Convert the updated `RawThreadInfos` back into an array.
		const updatedKeyedRawThreadInfosArray = values(updatedKeyedRawThreadInfos);

		// 5. Translate `RawThreadInfo`s back to `ClientDBThreadInfo`s.
		const updatedClientDBThreadInfos = updatedKeyedRawThreadInfosArray.map(
		convertRawThreadInfoToClientDBThreadInfo,
		);

		// 6. Construct `replace` `ClientDBThreadStoreOperation`s.
		const replaceThreadOperations = updatedClientDBThreadInfos.map(thread => ({
		type: 'replace',
		payload: thread,
		}));

		// 7. Prepend `replaceThreadOperations` with `remove_all` op and return.
		return [{ type: 'remove_all' }, ...replaceThreadOperations];
		}

function createUpdateDBOpsForMessageStoreMessages(		function createUpdateDBOpsForMessageStoreMessages(
clientDBMessageInfos: $ReadOnlyArray<ClientDBMessageInfo>,		clientDBMessageInfos: $ReadOnlyArray<ClientDBMessageInfo>,
migrationFunc: (		migrationFunc: (
$ReadOnlyArray<RawMessageInfo>,		$ReadOnlyArray<RawMessageInfo>,
) => $ReadOnlyArray<RawMessageInfo>,		) => $ReadOnlyArray<RawMessageInfo>,
): $ReadOnlyArray<ClientDBMessageStoreOperation> {		): $ReadOnlyArray<ClientDBMessageStoreOperation> {
const rawMessageInfos = clientDBMessageInfos.map(		const rawMessageInfos = clientDBMessageInfos.map(
Show All 39 Lines	return [
translateThreadMessageInfoToClientDBThreadMessageInfo(id, thread),		translateThreadMessageInfoToClientDBThreadMessageInfo(id, thread),
),		),
},		},
},		},
];		];
}		}

export {		export {
		createUpdateDBOpsForThreadStoreThreadInfos,
createUpdateDBOpsForMessageStoreMessages,		createUpdateDBOpsForMessageStoreMessages,
createUpdateDBOpsForMessageStoreThreads,		createUpdateDBOpsForMessageStoreThreads,
};		};