@ -1,14 +1,21 @@
/* eslint-disable no-await-in-loop */
import { PayloadAction , createAsyncThunk , createSlice } from '@reduxjs/toolkit' ;
import { GroupInfoGet , GroupMemberGet , GroupPubkeyType } from 'libsession_util_nodejs' ;
import { createAsyncThunk , createSlice } from '@reduxjs/toolkit' ;
import {
GroupInfoGet ,
GroupMemberGet ,
GroupPubkeyType ,
UserGroupsGet ,
} from 'libsession_util_nodejs' ;
import { isEmpty , uniq } from 'lodash' ;
import { ConfigDumpData } from '../../data/configDump/configDump' ;
import { ConversationTypeEnum } from '../../models/conversationAttributes' ;
import { HexString } from '../../node/hexStrings' ;
import { getConversationController } from '../../session/conversations' ;
import { UserUtils } from '../../session/utils' ;
import { getUserED25519KeyPairBytes } from '../../session/utils/User' ;
import { PreConditionFailed } from '../../session/utils/errors' ;
import { GroupSync } from '../../session/utils/job_runners/jobs/GroupConfigJob' ;
import { toFixedUint8ArrayOfLength } from '../../types/sqlSharedTypes' ;
import { stringify, toFixedUint8ArrayOfLength } from '../../types/sqlSharedTypes' ;
import {
getGroupPubkeyFromWrapperType ,
isMetaWrapperType ,
@ -17,16 +24,22 @@ import {
MetaGroupWrapperActions ,
UserGroupsWrapperActions ,
} from '../../webworker/workers/browser/libsession_worker_interface' ;
import { PreConditionFailed } from '../../session/utils/errors' ;
import { getSwarmPollingInstance } from '../../session/apis/snode_api' ;
import { StateType } from '../reducer' ;
import { RunJobResult } from '../../session/utils/job_runners/PersistedJob' ;
import { resetOverlayMode } from './section' ;
import { openConversationWithMessages } from './conversations' ;
export type GroupState = {
infos : Record < GroupPubkeyType , GroupInfoGet > ;
members : Record < GroupPubkeyType , Array < GroupMemberGet > > ;
creationFromUIPending : boolean ;
} ;
export const initialGroupState : GroupState = {
infos : { } ,
members : { } ,
creationFromUIPending : false ,
} ;
type GroupDetailsUpdate = {
@ -35,17 +48,25 @@ type GroupDetailsUpdate = {
members : Array < GroupMemberGet > ;
} ;
/ * *
* Create a brand new group with a 03 prefix .
* To be called only when our current logged in user , through the UI , creates a brand new closed group given a name and a list of members .
*
* /
const initNewGroupInWrapper = createAsyncThunk (
'group/initNewGroupInWrapper' ,
async ( {
groupName ,
members ,
us ,
} : {
groupName : string ;
members : Array < string > ;
us : string ;
} ) : Promise < GroupDetailsUpdate > = > {
async (
{
groupName ,
members ,
us ,
} : {
groupName : string ;
members : Array < string > ;
us : string ;
} ,
{ dispatch }
) : Promise < GroupDetailsUpdate > = > {
if ( ! members . includes ( us ) ) {
throw new PreConditionFailed ( 'initNewGroupInWrapper needs us to be a member' ) ;
}
@ -54,8 +75,8 @@ const initNewGroupInWrapper = createAsyncThunk(
const groupPk = newGroup . pubkeyHex ;
newGroup . name = groupName ; // this will be used by the linked devices until they fetch the info from the groups swarm
// the `GroupSync` below will need the secretKey of the group to be saved in the wrapper. So save it!
await UserGroupsWrapperActions . setGroup ( newGroup ) ;
const ourEd25519KeypairBytes = await UserUtils . getUserED25519KeyPairBytes ( ) ;
if ( ! ourEd25519KeypairBytes ) {
throw new Error ( 'Current user has no priv ed25519 key?' ) ;
@ -100,70 +121,135 @@ const initNewGroupInWrapper = createAsyncThunk(
await convo . setIsApproved ( true , false ) ;
// console.warn('store the v3 identityPrivatekeypair as part of the wrapper only?');
// // the sync below will need the secretKey of the group to be saved in the wrapper. So save it!
await UserGroupsWrapperActions . setGroup ( newGroup ) ;
await GroupSync . queueNewJobIfNeeded ( groupPk ) ;
// const updateGroupDetails: ClosedGroup.GroupInfo = {
// id: newGroup.pubkeyHex,
// name: groupDetails.groupName,
// members,
// admins: [us],
// activeAt: Date.now(),
// expireTimer: 0,
// };
const result = await GroupSync . pushChangesToGroupSwarmIfNeeded ( groupPk ) ;
if ( result !== RunJobResult . Success ) {
window . log . warn ( 'GroupSync.pushChangesToGroupSwarmIfNeeded during create failed' ) ;
}
// // be sure to call this before sending the message.
// // the sending pipeline needs to know from GroupUtils when a message is for a medium group
// await ClosedGroup.updateOrCreateClosedGroup(updateGroupDetails);
await convo . unhideIfNeeded ( ) ;
convo . set ( { active_at : Date.now ( ) } ) ;
await convo . commit ( ) ;
convo . updateLastMessage ( ) ;
dispatch ( resetOverlayMode ( ) ) ;
await openConversationWithMessages ( { conversationKey : groupPk , messageId : null } ) ;
return { groupPk : newGroup.pubkeyHex , infos , members : membersFromWrapper } ;
}
) ;
const loadDumpsFromDB = createAsyncThunk (
'group/loadDumpsFromDB' ,
/ * *
* Create a brand new group with a 03 prefix .
* To be called only when our current logged in user , through the UI , creates a brand new closed group given a name and a list of members .
*
* /
const handleUserGroupUpdate = createAsyncThunk (
'group/handleUserGroupUpdate' ,
async ( userGroup : UserGroupsGet , payloadCreator ) : Promise < GroupDetailsUpdate > = > {
// if we already have a state for that group here, it means that group was already init, and the data should come from the groupInfos after.
const state = payloadCreator . getState ( ) as StateType ;
const groupPk = userGroup . pubkeyHex ;
if ( state . groups . infos [ groupPk ] && state . groups . members [ groupPk ] ) {
throw new Error ( 'handleUserGroupUpdate group already present in redux slice' ) ;
}
const ourEd25519KeypairBytes = await UserUtils . getUserED25519KeyPairBytes ( ) ;
if ( ! ourEd25519KeypairBytes ) {
throw new Error ( 'Current user has no priv ed25519 key?' ) ;
}
const userEd25519Secretkey = ourEd25519KeypairBytes . privKeyBytes ;
const groupEd2519Pk = HexString . fromHexString ( groupPk ) . slice ( 1 ) ; // remove the 03 prefix (single byte once in hex form)
// dump is always empty when creating a new groupInfo
try {
await MetaGroupWrapperActions . init ( groupPk , {
metaDumped : null ,
userEd25519Secretkey : toFixedUint8ArrayOfLength ( userEd25519Secretkey , 64 ) ,
groupEd25519Secretkey : userGroup.secretKey ,
groupEd25519Pubkey : toFixedUint8ArrayOfLength ( groupEd2519Pk , 32 ) ,
} ) ;
} catch ( e ) {
window . log . warn ( ` failed to init metawrapper ${ groupPk } ` ) ;
}
const convo = await getConversationController ( ) . getOrCreateAndWait (
groupPk ,
ConversationTypeEnum . GROUPV3
) ;
await convo . setIsApproved ( true , false ) ;
await convo . setPriorityFromWrapper ( userGroup . priority , false ) ;
convo . set ( {
active_at : Date.now ( ) ,
displayNameInProfile : userGroup.name || undefined ,
} ) ;
await convo . commit ( ) ;
return {
groupPk ,
infos : await MetaGroupWrapperActions . infoGet ( groupPk ) ,
members : await MetaGroupWrapperActions . memberGetAll ( groupPk ) ,
} ;
}
) ;
/ * *
* Called only when the app just loaded the SessionInbox ( i . e . user logged in and fully loaded ) .
* This function populates the slice with any meta - dumps we have in the DB , if they also are part of what is the usergroup wrapper tracking .
*
* /
const loadMetaDumpsFromDB = createAsyncThunk (
'group/loadMetaDumpsFromDB' ,
async ( ) : Promise < Array < GroupDetailsUpdate > > = > {
const variantsWithoutData = await ConfigDumpData . getAllDumpsWithoutData ( ) ;
const ed25519KeyPairBytes = await getUserED25519KeyPairBytes ( ) ;
if ( ! ed25519KeyPairBytes ? . privKeyBytes ) {
throw new Error ( 'user has no ed25519KeyPairBytes.' ) ;
}
const variantsWithData = await ConfigDumpData . getAllDumpsWithData ( ) ;
const allUserGroups = await UserGroupsWrapperActions . getAllGroups ( ) ;
const toReturn : Array < GroupDetailsUpdate > = [ ] ;
for ( let index = 0 ; index < variantsWithoutData . length ; index ++ ) {
const { variant } = variantsWithoutData [ index ] ;
for ( let index = 0 ; index < variantsWith Data. length ; index ++ ) {
const { variant , data } = variantsWith Data[ index ] ;
if ( ! isMetaWrapperType ( variant ) ) {
continue ;
}
const groupPk = getGroupPubkeyFromWrapperType ( variant ) ;
const groupEd25519Pubkey = HexString . fromHexString ( groupPk . substring ( 2 ) ) ;
const foundInUserWrapper = allUserGroups . find ( m = > m . pubkeyHex === groupPk ) ;
if ( ! foundInUserWrapper ) {
try {
window . log . info (
'metaGroup not found in userGroups. Deleting the corresponding dumps:' ,
groupPk
) ;
await ConfigDumpData . deleteDumpFor ( groupPk ) ;
} catch ( e ) {
window . log . warn ( ` ConfigDumpData.deleteDumpFor for ${ groupPk } failed with ` , e . message ) ;
}
continue ;
}
try {
window . log . debug (
'loadDumpsFromDB loading from metagroup variant: ' ,
variant ,
foundInUserWrapper . pubkeyHex
) ;
window . log . debug ( 'loadMetaDumpsFromDB initing from metagroup dump' , variant ) ;
await MetaGroupWrapperActions . init ( groupPk , {
groupEd25519Pubkey : toFixedUint8ArrayOfLength ( groupEd25519Pubkey , 32 ) ,
groupEd25519Secretkey : foundInUserWrapper?.secretKey || null ,
userEd25519Secretkey : toFixedUint8ArrayOfLength ( ed25519KeyPairBytes . privKeyBytes , 64 ) ,
metaDumped : data ,
} ) ;
const infos = await MetaGroupWrapperActions . infoGet ( groupPk ) ;
const members = await MetaGroupWrapperActions . memberGetAll ( groupPk ) ;
toReturn . push ( { groupPk , infos , members } ) ;
// Annoyingly, the redux store is not initialized when this current funciton is called,
// so we need to init the group wrappers here, but load them in their redux slice later
} catch ( e ) {
// TODO should not throw in this case? we should probably just try to load what we manage to load
window . log . warn (
// Note: Don't retrow here, we want to load everything we can
window . log . error (
` initGroup of Group wrapper of variant ${ variant } failed with ${ e . message } `
) ;
// throw new Error(`initializeLibSessionUtilWrappers failed with ${e.message}`);
}
}
@ -171,45 +257,141 @@ const loadDumpsFromDB = createAsyncThunk(
}
) ;
/ * *
* This action is to be called when we get a merge event from the network .
* It refreshes the state of that particular group ( info & members ) with the state from the wrapper after the merge is done .
*
* /
const refreshGroupDetailsFromWrapper = createAsyncThunk (
'group/refreshGroupDetailsFromWrapper' ,
async ( {
groupPk ,
} : {
groupPk : GroupPubkeyType ;
} ) : Promise <
GroupDetailsUpdate | ( { groupPk : GroupPubkeyType } & Partial < GroupDetailsUpdate > )
> = > {
try {
const infos = await MetaGroupWrapperActions . infoGet ( groupPk ) ;
const members = await MetaGroupWrapperActions . memberGetAll ( groupPk ) ;
return { groupPk , infos , members } ;
} catch ( e ) {
window . log . warn ( 'refreshGroupDetailsFromWrapper failed with ' , e . message ) ;
return { groupPk } ;
}
}
) ;
const destroyGroupDetails = createAsyncThunk (
'group/destroyGroupDetails' ,
async ( { groupPk } : { groupPk : GroupPubkeyType } ) = > {
try {
await UserGroupsWrapperActions . eraseGroup ( groupPk ) ;
await ConfigDumpData . deleteDumpFor ( groupPk ) ;
await MetaGroupWrapperActions . infoDestroy ( groupPk ) ;
getSwarmPollingInstance ( ) . removePubkey ( groupPk , 'destroyGroupDetails' ) ;
} catch ( e ) {
window . log . warn ( ` destroyGroupDetails for ${ groupPk } failed with ${ e . message } ` ) ;
}
return { groupPk } ;
}
) ;
/ * *
* This slice is the one holding the default joinable rooms fetched once in a while from the default opengroup v2 server .
* /
const groupSlice = createSlice ( {
name : 'group' ,
initialState : initialGroupState ,
reducers : {
updateGroupDetailsAfterMerge ( state , action : PayloadAction < GroupDetailsUpdate > ) {
const { groupPk , infos , members } = action . payload ;
state . infos [ groupPk ] = infos ;
state . members [ groupPk ] = members ;
} ,
} ,
reducers : { } ,
extraReducers : builder = > {
builder . addCase ( initNewGroupInWrapper . fulfilled , ( state , action ) = > {
const { groupPk , infos , members } = action . payload ;
state . infos [ groupPk ] = infos ;
state . members [ groupPk ] = members ;
state . creationFromUIPending = false ;
} ) ;
builder . addCase ( initNewGroupInWrapper . rejected , ( ) = > {
builder . addCase ( initNewGroupInWrapper . rejected , state = > {
window . log . error ( 'a initNewGroupInWrapper was rejected' ) ;
// FIXME delete the wrapper completely & correspondign dumps, and usergroups entry?
state . creationFromUIPending = false ;
throw new Error ( 'initNewGroupInWrapper.rejected' ) ;
// FIXME delete the wrapper completely & corresponding dumps, and usergroups entry?
} ) ;
builder . addCase ( initNewGroupInWrapper . pending , ( state , _action ) = > {
state . creationFromUIPending = true ;
window . log . error ( 'a initNewGroupInWrapper is pending' ) ;
} ) ;
builder . addCase ( loadDumpsFromDB . fulfilled , ( state , action ) = > {
builder . addCase ( load Meta DumpsFromDB. fulfilled , ( state , action ) = > {
const loaded = action . payload ;
loaded . forEach ( element = > {
state . infos [ element . groupPk ] = element . infos ;
state . members [ element . groupPk ] = element . members ;
} ) ;
} ) ;
builder . addCase ( loadDumpsFromDB . rejected , ( ) = > {
window . log . error ( 'a loadDumpsFromDB was rejected' ) ;
builder . addCase ( loadMetaDumpsFromDB . rejected , ( ) = > {
window . log . error ( 'a loadMetaDumpsFromDB was rejected' ) ;
} ) ;
builder . addCase ( refreshGroupDetailsFromWrapper . fulfilled , ( state , action ) = > {
const { infos , members , groupPk } = action . payload ;
if ( infos && members ) {
state . infos [ groupPk ] = infos ;
state . members [ groupPk ] = members ;
window . log . debug ( ` groupInfo after merge: ${ stringify ( infos ) } ` ) ;
window . log . debug ( ` groupMembers after merge: ${ stringify ( members ) } ` ) ;
} else {
window . log . debug (
` refreshGroupDetailsFromWrapper no details found, removing from slice: ${ groupPk } } `
) ;
delete state . infos [ groupPk ] ;
delete state . members [ groupPk ] ;
}
} ) ;
builder . addCase ( refreshGroupDetailsFromWrapper . rejected , ( ) = > {
window . log . error ( 'a refreshGroupDetailsFromWrapper was rejected' ) ;
} ) ;
builder . addCase ( destroyGroupDetails . fulfilled , ( state , action ) = > {
const { groupPk } = action . payload ;
// FIXME destroyGroupDetails marks the info as destroyed, but does not really remove the wrapper currently
delete state . infos [ groupPk ] ;
delete state . members [ groupPk ] ;
} ) ;
builder . addCase ( destroyGroupDetails . rejected , ( ) = > {
window . log . error ( 'a destroyGroupDetails was rejected' ) ;
} ) ;
builder . addCase ( handleUserGroupUpdate . fulfilled , ( state , action ) = > {
const { infos , members , groupPk } = action . payload ;
if ( infos && members ) {
state . infos [ groupPk ] = infos ;
state . members [ groupPk ] = members ;
window . log . debug ( ` groupInfo after handleUserGroupUpdate: ${ stringify ( infos ) } ` ) ;
window . log . debug ( ` groupMembers after handleUserGroupUpdate: ${ stringify ( members ) } ` ) ;
} else {
window . log . debug (
` handleUserGroupUpdate no details found, removing from slice: ${ groupPk } } `
) ;
delete state . infos [ groupPk ] ;
delete state . members [ groupPk ] ;
}
} ) ;
builder . addCase ( handleUserGroupUpdate . rejected , ( ) = > {
window . log . error ( 'a handleUserGroupUpdate was rejected' ) ;
} ) ;
} ,
} ) ;
export const groupInfoActions = {
initNewGroupInWrapper ,
loadDumpsFromDB ,
loadMetaDumpsFromDB ,
destroyGroupDetails ,
refreshGroupDetailsFromWrapper ,
handleUserGroupUpdate ,
. . . groupSlice . actions ,
} ;
export const groupReducer = groupSlice . reducer ;
Audric Ackermann
2 years ago