Page MenuHomePhabricator
Differential D4003

[services] Document base reactor
ClosedPublic
Actions

Authored by • karol on May 11 2022, 7:37 AM.
Tags
None
Referenced Files
Unknown Object (File)
Tue, Apr 8, 6:00 PM
Unknown Object (File)
Tue, Apr 8, 5:14 PM
Unknown Object (File)
Tue, Apr 8, 8:56 AM
Unknown Object (File)
Tue, Apr 8, 8:31 AM
Unknown Object (File)
Tue, Apr 8, 7:28 AM
Unknown Object (File)
Wed, Apr 2, 6:13 AM
Unknown Object (File)
Wed, Apr 2, 6:13 AM
Unknown Object (File)
Tue, Apr 1, 12:33 PM
View All Files
Subscribers
• abosh
• adrian
ashoat
atul
tomek

Details

Reviewers
ashoat
tomek
Commits
rCOMM0c347d82e6df: [services] Document base reactor
Summary

Depends on D4002

https://linear.app/comm/issue/ENG-969/add-documentation-for-the-reactor-base-classes

Test Plan

None - there are just comments

Diff Detail

Repository
rCOMM Comm
Lint
Lint Not Applicable
Unit
Tests Not Applicable

Event Timeline

• karol created this revision.May 11 2022, 7:37 AM
Herald added subscribers: • abosh, atul, • adrian and 2 others. · View Herald TranscriptMay 11 2022, 7:37 AM
• karol edited the summary of this revision. (Show Details)May 11 2022, 7:41 AM
• karol edited the test plan for this revision. (Show Details)
• karol added reviewers: ashoat, tomek.
• karol added a parent revision: D4002: [services] Fix reactor status holder.
• karol added a child revision: D4004: [services] Add documentation for base reactors.
Harbormaster completed remote builds in B9006: Diff 12544.May 11 2022, 7:46 AM
• karol requested review of this revision.May 11 2022, 7:46 AM
ashoat accepted this revision.May 11 2022, 6:06 PM
ashoat added 1 blocking reviewer(s): tomek.
ashoat added inline comments.
services/lib/src/BaseReactor.h
28 ↗(On Diff #12544)

Typo

• karol added inline comments.May 12 2022, 2:11 AM
services/lib/src/BaseReactor.h
28 ↗(On Diff #12544)

right, thx

tomek accepted this revision.May 12 2022, 3:18 AM

Looks ok, but could you modify it a bit by starting your sentences with uppercase letters and ending with dots?

This revision is now accepted and ready to land.May 12 2022, 3:18 AM
• karol updated this revision to Diff 12634.May 13 2022, 3:21 AM

Improve style, fix typo

Harbormaster completed remote builds in B9088: Diff 12634.May 13 2022, 3:26 AM
Closed by commit rCOMM0c347d82e6df: [services] Document base reactor (authored by • karol). · Explain WhyMay 13 2022, 4:09 AM
This revision was automatically updated to reflect the committed changes.
• karol added a commit: rCOMM0c347d82e6df: [services] Document base reactor.

Revision Contents
Changeset List

PathSize
services/
lib/
src/
10 lines

Diff 12644

View Options

services/lib/src/BaseReactor.h

// @flow // @flow
import invariant from 'invariant'; import invariant from 'invariant';
import { import {
pushTypes, pushTypes,
type CreateMessageInfoParams, type CreateMessageInfoParams,
type MessageSpec, type MessageSpec,
type NotificationTextsParams,
} from './message-spec.js'; } from './message-spec.js';
import { joinResult } from './utils.js'; import { joinResult } from './utils.js';
import type { PlatformDetails } from '../../types/device-types.js'; import type { PlatformDetails } from '../../types/device-types.js';
import { messageTypes } from '../../types/message-types.js'; import { messageTypes } from '../../types/message-types.js';
import type { import type {
MessageInfo, MessageInfo,
ClientDBMessageInfo, ClientDBMessageInfo,
} from '../../types/message-types.js'; } from '../../types/message-types.js';
import type { import type {
CreateSidebarMessageData, CreateSidebarMessageData,
CreateSidebarMessageInfo, CreateSidebarMessageInfo,
RawCreateSidebarMessageInfo, RawCreateSidebarMessageInfo,
} from '../../types/messages/create-sidebar.js'; } from '../../types/messages/create-sidebar.js';
import type { RawUnsupportedMessageInfo } from '../../types/messages/unsupported.js'; import type { RawUnsupportedMessageInfo } from '../../types/messages/unsupported.js';
import type { NotifTexts } from '../../types/notif-types.js'; import type { NotifTexts } from '../../types/notif-types.js';
import type { ThreadInfo } from '../../types/thread-types.js'; import type { ThreadInfo } from '../../types/thread-types.js';
import type { RelativeUserInfo } from '../../types/user-types.js'; import type { RelativeUserInfo } from '../../types/user-types.js';
import { import {
ET, ET,
type EntityText, type EntityText,
pluralizeEntityText, pluralizeEntityText,
} from '../../utils/entity-text.js'; } from '../../utils/entity-text.js';
import { isMentioned } from '../mention-utils.js';
import { hasMinCodeVersion } from '../version-utils.js'; import { hasMinCodeVersion } from '../version-utils.js';
export const createSidebarMessageSpec: MessageSpec< export const createSidebarMessageSpec: MessageSpec<
CreateSidebarMessageData, CreateSidebarMessageData,
RawCreateSidebarMessageInfo, RawCreateSidebarMessageInfo,
CreateSidebarMessageInfo, CreateSidebarMessageInfo,
> = Object.freeze({ > = Object.freeze({
messageContentForServerDB( messageContentForServerDB(
▲ Show 20 Lines • Show All 134 Lines • ▼ Show 20 Lines unshimMessageInfo(
unwrapped: RawCreateSidebarMessageInfo, unwrapped: RawCreateSidebarMessageInfo,
): RawCreateSidebarMessageInfo { ): RawCreateSidebarMessageInfo {
return unwrapped; return unwrapped;
}, },
async notificationTexts( async notificationTexts(
messageInfos: $ReadOnlyArray<MessageInfo>, messageInfos: $ReadOnlyArray<MessageInfo>,
threadInfo: ThreadInfo, threadInfo: ThreadInfo,
params: NotificationTextsParams,
): Promise<NotifTexts> { ): Promise<NotifTexts> {
const firstMessageInfo = messageInfos[0]; const firstMessageInfo = messageInfos[0];
invariant( invariant(
firstMessageInfo.type === messageTypes.CREATE_SIDEBAR, firstMessageInfo.type === messageTypes.CREATE_SIDEBAR,
'firstMessageInfo should be messageTypes.CREATE_SIDEBAR!', 'firstMessageInfo should be messageTypes.CREATE_SIDEBAR!',
); );
const creator = ET.user({ userInfo: firstMessageInfo.creator }); const creator = ET.user({ userInfo: firstMessageInfo.creator });
const prefix = ET`${creator}`; const prefix = ET`${creator}`;
const initialName = firstMessageInfo.initialThreadState.name; const initialName = firstMessageInfo.initialThreadState.name;
const sourceMessageAuthorPossessive = ET.user({ const sourceMessageAuthorPossessive = ET.user({
userInfo: firstMessageInfo.sourceMessageAuthor, userInfo: firstMessageInfo.sourceMessageAuthor,
possessive: true, possessive: true,
}); });
let body = `started a thread in response to `; let body = `started a thread in response to `;
body = ET`${body} ${sourceMessageAuthorPossessive} message`; body = ET`${body} ${sourceMessageAuthorPossessive} message`;
if (initialName) {
const { username } = params.notifTargetUserInfo;
const secondMessageInfo = messageInfos[1];
if (
username &&
secondMessageInfo &&
secondMessageInfo.type === messageTypes.SIDEBAR_SOURCE &&
secondMessageInfo.sourceMessage.type === messageTypes.TEXT &&
isMentioned(username, secondMessageInfo.sourceMessage.text)
) {
body = ET`${body} that tagged you`;
} else if (initialName) {
body = ET`${body} "${initialName}"`; body = ET`${body} "${initialName}"`;
} }
return { return {
merged: ET`${prefix} ${body}`, merged: ET`${prefix} ${body}`,
body, body,
title: threadInfo.uiName, title: threadInfo.uiName,
prefix, prefix,
Show All 20 Lines