diff --git a/apps/tlon-mobile/ios/Podfile.lock b/apps/tlon-mobile/ios/Podfile.lock index 371482a783..5eff3ac2b6 100644 --- a/apps/tlon-mobile/ios/Podfile.lock +++ b/apps/tlon-mobile/ios/Podfile.lock @@ -1905,4 +1905,4 @@ SPEC CHECKSUMS: PODFILE CHECKSUM: 0cb7a78e5777e69c86c1bf4bb5135fd660376dbe -COCOAPODS: 1.16.2 +COCOAPODS: 1.15.2 diff --git a/packages/app/features/settings/FeatureFlagScreen.tsx b/packages/app/features/settings/FeatureFlagScreen.tsx index e0bac14293..34d3745cb4 100644 --- a/packages/app/features/settings/FeatureFlagScreen.tsx +++ b/packages/app/features/settings/FeatureFlagScreen.tsx @@ -29,7 +29,7 @@ export function FeatureFlagScreen({ navigation }: Props) { Object.entries(featureFlags.featureMeta) .filter(([name]) => { if (name === 'customChannelCreation') { - return isTlonEmployee; + return isTlonEmployee || __DEV__; } return true; }) diff --git a/packages/app/ui/components/ContactNameV2.tsx b/packages/app/ui/components/ContactNameV2.tsx index 280d6e4689..d1099bf31a 100644 --- a/packages/app/ui/components/ContactNameV2.tsx +++ b/packages/app/ui/components/ContactNameV2.tsx @@ -50,12 +50,20 @@ export const useContactNameProps = ({ ]); }; -export const useContactName = (options: string | ContactNameOptions) => { +export function useContactName(options: string | ContactNameOptions): string; +export function useContactName( + options: string | ContactNameOptions | null +): string | null; +export function useContactName( + options: string | ContactNameOptions | null +): string | null { const resolvedOptions = useMemo(() => { - return typeof options === 'string' ? { contactId: options } : options; + return typeof options === 'string' || options == null + ? { contactId: options ?? '' } + : options; }, [options]); return useContactNameProps(resolvedOptions).children; -}; +} const BaseContactName = RawText.styleable<{ contactId: string; diff --git a/packages/app/ui/components/postCollectionViews/shared.tsx b/packages/app/ui/components/postCollectionViews/shared.tsx index 0eaa1ce4b2..72200061da 100644 --- a/packages/app/ui/components/postCollectionViews/shared.tsx +++ b/packages/app/ui/components/postCollectionViews/shared.tsx @@ -29,7 +29,7 @@ export function ConnectedPostView({ return null; } return { - showAuthor: JSONValue.asBoolean(cfg.showAuthor, false), + showAuthor: JSONValue.asBoolean(cfg.showAuthors, false), showReplies: JSONValue.asBoolean(cfg.showReplies, false), }; }, [ctx.collectionConfiguration]); diff --git a/packages/app/ui/contexts/componentsKits.tsx b/packages/app/ui/contexts/componentsKits.tsx index 838e66ef5c..9725e9ad33 100644 --- a/packages/app/ui/contexts/componentsKits.tsx +++ b/packages/app/ui/contexts/componentsKits.tsx @@ -105,7 +105,7 @@ const BUILTIN_CONTENT_RENDERERS: { [id: string]: RenderItemType } = { [PostContentRendererId.audio]: AudioPost, [PostContentRendererId.color]: ColorPost, [PostContentRendererId.raw]: ({ post, contentRendererConfiguration }) => { - const contactName = useContactName(post.author!.id); + const contactName = useContactName(post.author?.id ?? null); return ( { return ParameterizedId.coerce(configuration.defaultPostCollectionRenderer); } -} -/** - * We use a channel's `description` field to store structured data. This - * module provides helpers for managing that data. - */ -// eslint-disable-next-line @typescript-eslint/no-namespace -export namespace StructuredChannelDescriptionPayload { - type Encoded = string | null | undefined; - interface Decoded { - channelContentConfiguration?: ChannelContentConfiguration; - description?: string; - } + export function toApiMeta(cfg: ChannelContentConfiguration): ChannelMetadata { + return { + version: 1, - export function encode(payload: Decoded): Encoded { - return JSON.stringify(payload); - } + postInput: ((x) => ({ + postType: x.id, - /** - * Attempts to decode a `description` string into a structured payload. - * - * - If `description` is null/undefined, returns a payload with no - * description nor configuration. - * - If `description` is not valid JSON, returns a payload with the - * description as the input string. - * - If `description` validates as the expected - * `StructuredChannelDescriptionPayload` JSON, returns the decoded payload. - */ - export function decode(encoded: Encoded): Decoded { - // TODO: This should be validated - we'll be deserializing untrusted data - if (encoded == null) { - return {}; - } - try { - const out = JSON.parse(encoded); - if ('channelContentConfiguration' in out) { - if (typeof out.channelContentConfiguration !== 'object') { - throw new Error('Invalid configuration'); - } - // add a little robustness - if the configuration is missing a field, - // just add a default in to avoid crashing - out.channelContentConfiguration = ((raw) => { - const cfg = { - draftInput: DraftInputId.chat, - defaultPostContentRenderer: PostContentRendererId.chat, - defaultPostCollectionRenderer: CollectionRendererId.chat, - ...raw, - } as ChannelContentConfiguration; + type: x.id, + configuration: x.configuration, + }))(ChannelContentConfiguration.draftInput(cfg)), - // add defaults to some standard params - const collCfgWithDefaults = ParameterizedId.coerce( - cfg.defaultPostCollectionRenderer - ); - collCfgWithDefaults.configuration = { - showAuthors: true, - showReplies: true, - ...collCfgWithDefaults.configuration, - }; + postCollectionRenderer: ((x) => ({ + id: x.id, + configuration: x.configuration, + }))(ChannelContentConfiguration.defaultPostCollectionRenderer(cfg)), - return cfg; - })(out.channelContentConfiguration); - } - return out; - } catch (_err) { - return { description: encoded.length === 0 ? undefined : encoded }; - } + defaultContentRenderer: ((x) => ({ + rendererId: x.id, + configuration: x.configuration, + }))(ChannelContentConfiguration.defaultPostContentRenderer(cfg)), + }; + } + + export function fromApiMeta( + meta: ChannelMetadata + ): ChannelContentConfiguration { + return { + draftInput: { + id: meta.postInput.type as DraftInputId, + configuration: meta.postInput.configuration, + }, + defaultPostContentRenderer: { + id: meta.defaultContentRenderer.rendererId as PostContentRendererId, + configuration: meta.defaultContentRenderer.configuration, + }, + defaultPostCollectionRenderer: { + id: meta.postCollectionRenderer.id as CollectionRendererId, + configuration: meta.postCollectionRenderer.configuration, + }, + }; } } diff --git a/packages/shared/src/api/channelsApi.ts b/packages/shared/src/api/channelsApi.ts index 2ab5b6f06b..a1fd7ca2a2 100644 --- a/packages/shared/src/api/channelsApi.ts +++ b/packages/shared/src/api/channelsApi.ts @@ -91,7 +91,8 @@ export type MarkChannelReadUpdate = { export type MetaUpdate = { type: 'channelMetaUpdate'; - meta: Stringified | null; + meta: Stringified | null; + channelId: string; }; export type ChannelsUpdate = @@ -129,14 +130,30 @@ export const createChannel = async ({ ); }; +export const setupChannelFromTemplate = async ( + exampleChannelId: string, + targetChannelId: string +) => { + return client.thread({ + desk: 'groups', + inputMark: 'hook-setup-template-args', + outputMark: 'json', + threadName: 'channel-setup-from-template', + body: { + example: exampleChannelId, + target: targetChannelId, + }, + }); +}; + export async function updateChannelMeta( channelId: string, - metaPayload: Stringified | null + metaPayload: Stringified | null ) { return trackedPoke( { app: 'channels', - mark: 'channel-action', + mark: 'channel-action-1', json: { channel: { nest: channelId, @@ -153,22 +170,6 @@ export async function updateChannelMeta( ); } -export const setupChannelFromTemplate = async ( - exampleChannelId: string, - targetChannelId: string -) => { - return client.thread({ - desk: 'groups', - inputMark: 'hook-setup-template-args', - outputMark: 'json', - threadName: 'channel-setup-from-template', - body: { - example: exampleChannelId, - target: targetChannelId, - }, - }); -}; - export const subscribeToChannelsUpdates = async ( eventHandler: (update: ChannelsUpdate) => void ) => { @@ -193,6 +194,7 @@ export type ChannelInit = { channelId: string; writers: string[]; readers: string[]; + meta: ub.ChannelMetadata | null; }; export function toClientChannelInit( @@ -200,7 +202,12 @@ export function toClientChannelInit( channel: ub.Channel, readers: string[] ): ChannelInit { - return { channelId: id, writers: channel.perms.writers ?? [], readers }; + return { + channelId: id, + writers: channel.perms.writers ?? [], + readers, + meta: channel.meta, + }; } export const toChannelsUpdate = ( @@ -240,6 +247,7 @@ export const toChannelsUpdate = ( return { type: 'channelMetaUpdate', meta: channelEvent.response.meta, + channelId, }; } diff --git a/packages/shared/src/api/chatApi.ts b/packages/shared/src/api/chatApi.ts index 7077d59e0e..ef0e4bdea4 100644 --- a/packages/shared/src/api/chatApi.ts +++ b/packages/shared/src/api/chatApi.ts @@ -8,10 +8,6 @@ import { getCanonicalPostId, toClientMeta, } from './apiUtils'; -import { - ChannelContentConfiguration, - StructuredChannelDescriptionPayload, -} from './channelContentConfig'; import { toPostData, toPostReplyData, toReplyMeta } from './postsApi'; import { getCurrentUserId, poke, scry, subscribe, trackedPoke } from './urbit'; @@ -339,21 +335,13 @@ export const toClientGroupDms = (groupDms: ub.Clubs): GetDmsResponse => { const metaFields = toClientMeta(club.meta); - // Channel meta is different from other metas, since we can overload the - // `description` to fit other channel-specific data. - // Attempt to decode that extra info here. - const decodedDesc = StructuredChannelDescriptionPayload.decode( - metaFields.description - ); - return { id, type: 'groupDm', ...metaFields, isDmInvite: !isJoined && isInvited, members: [...joinedMembers, ...invitedMembers], - contentConfiguration: decodedDesc.channelContentConfiguration, - description: decodedDesc.description, + description: metaFields.description, }; }) .filter(Boolean) as db.Channel[]; diff --git a/packages/shared/src/api/groupsApi.ts b/packages/shared/src/api/groupsApi.ts index b9b665475a..5b210c9c8a 100644 --- a/packages/shared/src/api/groupsApi.ts +++ b/packages/shared/src/api/groupsApi.ts @@ -13,7 +13,6 @@ import { getJoinStatusFromGang, } from '../urbit'; import { parseGroupChannelId, parseGroupId, toClientMeta } from './apiUtils'; -import { StructuredChannelDescriptionPayload } from './channelContentConfig'; import { getCurrentUserId, poke, @@ -1640,9 +1639,6 @@ function toClientChannel({ channel: ub.GroupChannel; groupId: string; }): db.Channel { - const { description, channelContentConfiguration } = - StructuredChannelDescriptionPayload.decode(channel.meta.description); - const readerRoles = (channel.readers ?? []).map((roleId) => ({ channelId: id, roleId, @@ -1663,8 +1659,7 @@ function toClientChannel({ iconImage: omitEmpty(channel.meta.image), title: omitEmpty(channel.meta.title), coverImage: omitEmpty(channel.meta.cover), - description, - contentConfiguration: channelContentConfiguration, + description: omitEmpty(channel.meta.description), currentUserIsHost: hostUserId === currentUserId, readerRoles, writerRoles, @@ -1680,9 +1675,6 @@ function toClientChannelFromPreview({ channel: ub.ChannelPreview; groupId: string; }): db.Channel { - const { description, channelContentConfiguration } = - StructuredChannelDescriptionPayload.decode(channel.meta.description); - return { id, groupId, @@ -1690,8 +1682,7 @@ function toClientChannelFromPreview({ iconImage: omitEmpty(channel.meta.image), title: omitEmpty(channel.meta.title), coverImage: omitEmpty(channel.meta.cover), - description, - contentConfiguration: channelContentConfiguration, + description: omitEmpty(channel.meta.description), }; } diff --git a/packages/shared/src/api/initApi.ts b/packages/shared/src/api/initApi.ts index 0818e6f298..00105cae95 100644 --- a/packages/shared/src/api/initApi.ts +++ b/packages/shared/src/api/initApi.ts @@ -1,5 +1,6 @@ import * as db from '../db'; import type * as ub from '../urbit'; +import { nullIfError } from '../utils'; import { ActivityInit, toClientUnreads } from './activityApi'; import { ChannelInit, toClientChannelsInit } from './channelsApi'; import { toClientDms, toClientGroupDms } from './chatApi'; @@ -18,7 +19,7 @@ export interface InitData { unjoinedGroups: db.Group[]; activity: ActivityInit; channels: db.Channel[]; - channelPerms: ChannelInit[]; + channelsInit: ChannelInit[]; joinedGroups: string[]; joinedChannels: string[]; hiddenPostIds: string[]; @@ -26,15 +27,23 @@ export interface InitData { } export const getInitData = async () => { - const response = await scry({ + const response = await scry({ app: 'groups-ui', - path: '/v4/init', + path: '/v5/init', }); const pins = toClientPinnedItems(response.pins); const channelReaders = extractChannelReaders(response.groups); const channelsInit = toClientChannelsInit( - response.channel.channels, + Object.entries(response.channel.channels).reduce((acc, [key, value]) => { + acc[key] = { + ...value, + meta: nullIfError(() => + value.meta == null ? null : JSON.parse(value.meta) + ), + }; + return acc; + }, {} as ub.Channels), channelReaders ); @@ -64,7 +73,7 @@ export const getInitData = async () => { unjoinedGroups, unreads, channels: [...dmChannels, ...groupDmChannels, ...invitedDms], - channelPerms: channelsInit, + channelsInit, joinedGroups, joinedChannels, hiddenPostIds, diff --git a/packages/shared/src/db/queries.ts b/packages/shared/src/db/queries.ts index cd01024281..27c1e6600e 100644 --- a/packages/shared/src/db/queries.ts +++ b/packages/shared/src/db/queries.ts @@ -623,8 +623,14 @@ export const insertGroups = createWriteQuery( $channels.description, $channels.addedToGroupAt, $channels.type, - $channels.isPendingChannel, - $channels.contentConfiguration + $channels.isPendingChannel + + // > Why not update `contentConfiguration` here? + // Because this codepath is coming from %groups, which does not + // know about a channel's `meta` - so we never want to + // overwrite the config with the missing config from %groups. + // + // $channels.contentConfiguration ), }); diff --git a/packages/shared/src/store/channelActions.ts b/packages/shared/src/store/channelActions.ts index 00e554470d..180a335cc6 100644 --- a/packages/shared/src/store/channelActions.ts +++ b/packages/shared/src/store/channelActions.ts @@ -1,34 +1,31 @@ import * as api from '../api'; -import { - ChannelContentConfiguration, - StructuredChannelDescriptionPayload, -} from '../api/channelContentConfig'; +import { ChannelContentConfiguration } from '../api/channelContentConfig'; import * as db from '../db'; import { createDevLogger } from '../debug'; import { AnalyticsEvent } from '../domain'; import * as logic from '../logic'; import { getRandomId } from '../logic'; -import { GroupChannel, getChannelKindFromType } from '../urbit'; +import { + ChannelMetadata, + GroupChannel, + getChannelKindFromType, +} from '../urbit'; const logger = createDevLogger('ChannelActions', false); export async function createChannel({ groupId, title, - // Alias to `rawDescription`, since we might need to synthesize a new - // `description` API value by merging with `contentConfiguration` below. - description: rawDescription, - channelType: rawChannelType, - contentConfiguration, + description, + channelType, }: { groupId: string; title: string; description?: string; - channelType: Omit | 'custom'; + channelType: Omit; contentConfiguration?: ChannelContentConfiguration; }) { const currentUserId = api.getCurrentUserId(); - const channelType = rawChannelType === 'custom' ? 'chat' : rawChannelType; const channelSlug = getRandomId(); const channelId = `${getChannelKindFromType(channelType)}/${currentUserId}/${channelSlug}`; @@ -44,27 +41,17 @@ export async function createChannel({ const newChannel: db.Channel = { id: channelId, title, - description: rawDescription, + description, type: channelType as db.ChannelType, groupId, addedToGroupAt: Date.now(), currentUserIsMember: true, - contentConfiguration: - contentConfiguration ?? - channelContentConfigurationForChannelType(channelType), }; await db.insertChannels([newChannel]); - // If we have a `contentConfiguration`, we need to merge these fields to make - // a `StructuredChannelDescriptionPayload`, and use that as the `description` - // on the API. - const encodedDescription = - contentConfiguration == null - ? rawDescription - : StructuredChannelDescriptionPayload.encode({ - description: rawDescription, - channelContentConfiguration: contentConfiguration, - }); + const cfg = ChannelContentConfiguration.toApiMeta( + channelContentConfigurationForChannelType(channelType) + ); try { await api.createChannel({ @@ -73,9 +60,10 @@ export async function createChannel({ group: groupId, name: channelSlug, title, - description: encodedDescription ?? '', + description: description ?? '', readers: [], writers: [], + meta: cfg == null ? null : JSON.stringify(cfg), }); return newChannel; } catch (e) { @@ -205,13 +193,6 @@ export async function updateChannel({ await db.updateChannel(updatedChannel); - // If we have a `contentConfiguration`, we need to merge these fields to make - // a `StructuredChannelDescriptionPayload`, and use that as the `description` - const structuredDescription = StructuredChannelDescriptionPayload.encode({ - description: channel.description ?? undefined, - channelContentConfiguration: channel.contentConfiguration ?? undefined, - }); - const groupChannel: GroupChannel = { added: channel.addedToGroupAt ?? 0, readers, @@ -220,7 +201,7 @@ export async function updateChannel({ join, meta: { title: channel.title ?? '', - description: structuredDescription ?? '', + description: channel.description ?? '', image: channel.coverImage ?? '', cover: channel.coverImage ?? '', }, @@ -234,6 +215,16 @@ export async function updateChannel({ channelId: channel.id, channel: groupChannel, }); + + const meta: ChannelMetadata | null = + channel.contentConfiguration == null + ? null + : ChannelContentConfiguration.toApiMeta(channel.contentConfiguration); + await api.updateChannelMeta( + channel.id, + meta == null ? null : JSON.stringify(meta) + ); + if (writersToAdd.length > 0) { logger.log('adding writers', writersToAdd); await api.addChannelWriters({ diff --git a/packages/shared/src/store/sync.test.ts b/packages/shared/src/store/sync.test.ts index c05ee58ec9..0995052f3f 100644 --- a/packages/shared/src/store/sync.test.ts +++ b/packages/shared/src/store/sync.test.ts @@ -1,14 +1,8 @@ import * as $ from 'drizzle-orm'; -import { pick } from 'lodash'; import { expect, test, vi } from 'vitest'; -import { StructuredChannelDescriptionPayload, toClientGroup } from '../api'; +import { toClientGroup } from '../api'; import '../api/channelContentConfig'; -import { - CollectionRendererId, - DraftInputId, - PostContentRendererId, -} from '../api/channelContentConfig'; import * as db from '../db'; import rawNewestPostData from '../test/channelNewestPost.json'; import rawChannelPostWithRepliesData from '../test/channelPostWithReplies.json'; @@ -327,31 +321,3 @@ test('syncs thread posts', async () => { Object.keys(channelPostWithRepliesData.seal.replies).length + 1 ); }); - -test('syncs groups, decoding structured description payloads', async () => { - const groupId = '~fabled-faster/new-york'; - const groupWithScdp = pick(groupsData, groupId); - const channelId = 'chat/~tormut-bolpub/nyc-housing-7361'; - const channel = groupWithScdp['~fabled-faster/new-york'].channels[channelId]; - const descriptionText = 'cheers'; - const channelContentConfiguration = { - draftInput: { id: DraftInputId.chat }, - defaultPostContentRenderer: { id: PostContentRendererId.notebook }, - defaultPostCollectionRenderer: { id: CollectionRendererId.gallery }, - }; - channel.meta.description = StructuredChannelDescriptionPayload.encode({ - description: descriptionText, - channelContentConfiguration, - })!; - setScryOutput(groupsData); - await syncGroups(); - const pins = Object.keys(groupsData).slice(0, 3); - setScryOutput(pins); - await syncPinnedItems(); - const channelFromDb = await db.getChannel({ id: channelId }); - expect(channelFromDb).toBeTruthy(); - expect(channelFromDb!.description).toEqual(descriptionText); - expect(channelFromDb!.contentConfiguration).toMatchObject( - channelContentConfiguration - ); -}); diff --git a/packages/shared/src/store/sync.ts b/packages/shared/src/store/sync.ts index b30c80b4e5..d00be2edc5 100644 --- a/packages/shared/src/store/sync.ts +++ b/packages/shared/src/store/sync.ts @@ -85,8 +85,19 @@ export const syncInitData = async ( .then(() => logger.crumb('inserted blocked users')); await db - .insertChannelPerms(initData.channelPerms, queryCtx) + .insertChannelPerms(initData.channelsInit, queryCtx) .then(() => logger.crumb('inserted channel perms')); + await Promise.all( + initData.channelsInit + .map((c) => ({ + id: c.channelId, + contentConfiguration: + c.meta == null + ? null + : api.ChannelContentConfiguration.fromApiMeta(c.meta), + })) + .map((c) => db.updateChannel(c)) + ).then(() => logger.crumb('inserted channel meta')); await db .setLeftGroups({ joinedGroupIds: initData.joinedGroups }, queryCtx) .then(() => logger.crumb('set left groups')); @@ -913,7 +924,16 @@ export const handleChannelsUpdate = async (update: api.ChannelsUpdate) => { case 'unknown': logger.log('unknown channels update', update); break; - default: + case 'channelMetaUpdate': + await db.updateChannel({ + id: update.channelId, + contentConfiguration: + update.meta == null + ? null + : api.ChannelContentConfiguration.fromApiMeta( + JSON.parse(update.meta) + ), + }); break; } }; diff --git a/packages/shared/src/urbit/channel.ts b/packages/shared/src/urbit/channel.ts index af2781de9c..77b1a0dd5f 100644 --- a/packages/shared/src/urbit/channel.ts +++ b/packages/shared/src/urbit/channel.ts @@ -350,9 +350,10 @@ export interface PostCollectionRenderer { export interface ContentRenderer { rendererId: string; + configuration?: Record; } -export interface ChannelMetadataSchemaV1 { +interface ChannelMetadataSchemaV1 { version: 1; postInput: PostInput; postCollectionRenderer: PostCollectionRenderer; @@ -367,7 +368,7 @@ export interface Channel { order: string[]; sort: SortMode; pending: PendingMessages; - meta: ChannelMetadata; + meta: ChannelMetadata | null; } export interface ChannelFromServer { diff --git a/packages/shared/src/urbit/ui.ts b/packages/shared/src/urbit/ui.ts index 36cb83647a..d8d329d736 100644 --- a/packages/shared/src/urbit/ui.ts +++ b/packages/shared/src/urbit/ui.ts @@ -1,5 +1,5 @@ import { Activity } from './activity'; -import { ChannelHeadsResponse, Channels } from './channel'; +import { ChannelFromServer, ChannelHeadsResponse, Channels } from './channel'; import { ChatHeadsResponse, DMInit, DMInit2 } from './dms'; import { Gangs, Groups } from './groups'; @@ -17,7 +17,7 @@ export interface GroupsInit4 { groups: Groups; gangs: Gangs; channel: { - channels: Channels; + channels: { [key: string]: ChannelFromServer }; 'hidden-posts': string[]; }; activity: Activity; @@ -25,6 +25,8 @@ export interface GroupsInit4 { chat: DMInit2; } +export type GroupsInit5 = GroupsInit4; + export interface CombinedHeads { dms: ChatHeadsResponse; channels: ChannelHeadsResponse; diff --git a/packages/shared/src/utils/errors.ts b/packages/shared/src/utils/errors.ts new file mode 100644 index 0000000000..5cf48e6e18 --- /dev/null +++ b/packages/shared/src/utils/errors.ts @@ -0,0 +1,7 @@ +export function nullIfError(fn: () => T): T | null { + try { + return fn(); + } catch (_e) { + return null; + } +} diff --git a/packages/shared/src/utils/index.ts b/packages/shared/src/utils/index.ts index b8a68360b5..3fc94e636e 100644 --- a/packages/shared/src/utils/index.ts +++ b/packages/shared/src/utils/index.ts @@ -4,3 +4,4 @@ */ export * from './object'; export type * from './utilityTypes'; +export * from './errors';