Skip to content

Commit

Permalink
Pull in related events into the conflicted control events (#308)
Browse files Browse the repository at this point in the history 
* Pull in related events into the conflicted control events

* Use t.Log

* Give the test a sensible name

* Don't visit the same auth event more than once when working out the full control set
  • Loading branch information
@neilalexander
neilalexander committed May 13, 2022
1 parent 8d81804 commit eee8fd5
Show file tree
Hide file tree
Showing 2 changed files with 114 additions and 12 deletions.
72 changes: 60 additions & 12 deletions stateresolutionv2.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,7 @@ const (

type stateResolverV2 struct {
authEventMap map[string]*Event // Map of all provided auth events
conflictedEventMap map[string]*Event // Map of all provided conflicted events
authPowerLevels map[string]int64 // A cache of user power levels
powerLevelMainline []*Event // Power level events in mainline ordering
powerLevelMainlinePos map[string]int // Power level event positions in mainline
Expand Down Expand Up @@ -81,6 +82,7 @@ func ResolveStateConflictsV2(
conflictedOthers := make([]*Event, 0, len(conflicted))
r := stateResolverV2{
authEventMap: eventMapFromEvents(authEvents),
conflictedEventMap: eventMapFromEvents(conflicted),
authPowerLevels: make(map[string]int64, len(conflicted)+len(unconflicted)),
powerLevelMainlinePos: make(map[string]int),
resolvedThirdPartyInvites: make(map[string]*Event, len(conflicted)),
Expand All @@ -97,17 +99,57 @@ func ResolveStateConflictsV2(
isUnconflicted[u.EventID()] = struct{}{}
}

// Separate out control events from the rest of the events. This is necessary
// because we perform topological ordering of the control events separately,
// and then the mainline ordering of all other events depends on that
// ordering.
for _, p := range append(conflicted, authDifference...) {
if _, unconflicted := isUnconflicted[p.EventID()]; !unconflicted {
if isControlEvent(p) {
conflictedControlEvents = append(conflictedControlEvents, p)
} else {
conflictedOthers = append(conflictedOthers, p)
// Get the full conflicted set, that is the conflicted events and the
// auth difference (events that don't appear in all auth chains).
fullConflictedSet := append(conflicted, authDifference...)

// The full power set function returns the event and all of its auth
// events that also happen to appear in the conflicted set. This will
// effectively allow us to pull in all related events for any control
// event, even if those related events are themselves not control events.
visited := make(map[string]struct{}, len(conflicted)+len(authEvents))
var fullControlSet func(event *Event) []*Event
fullControlSet = func(event *Event) []*Event {
events := []*Event{event}
for _, authEventID := range event.AuthEventIDs() {
if _, ok := visited[authEventID]; ok {
continue
}
if event, ok := r.conflictedEventMap[authEventID]; ok {
events = append(events, fullControlSet(event)...)
}
visited[authEventID] = struct{}{}
}
return events
}

// First of all, work through the full conflicted set. Ignoring any
// events which are unconflicted (from the auth difference, for example),
// pull in the control events and any events directly related to them.
conflictedPulledIn := make(map[string]struct{}, len(conflicted)+len(authEvents))
for _, p := range fullConflictedSet {
if _, unconflicted := isUnconflicted[p.EventID()]; unconflicted {
continue
}
if isControlEvent(p) {
relatedEvents := fullControlSet(p)
for _, event := range relatedEvents {
conflictedPulledIn[event.EventID()] = struct{}{}
}
conflictedControlEvents = append(conflictedControlEvents, relatedEvents...)
}
}

// Then work through the set again, this time looking for any events
// that were left over from the last loop — that is, events that are
// either not control events or weren't pulled in to the control set.
for _, p := range fullConflictedSet {
eventID := p.EventID()
if _, unconflicted := isUnconflicted[eventID]; unconflicted || isControlEvent(p) {
continue
}
if _, ok := conflictedPulledIn[eventID]; !ok {
conflictedOthers = append(conflictedOthers, p)
}
}

Expand Down Expand Up @@ -251,7 +293,7 @@ func (r *stateResolverV2) createPowerLevelMainline() []*Event {
// that we can look up the event type.
if authEvent, ok := r.authEventMap[authEventID]; ok {
// Is the event a power event?
if authEvent.Type() == MRoomPowerLevels {
if authEvent.Type() == MRoomPowerLevels && authEvent.StateKeyEquals("") {
// We found a power level event in the event's auth events - start
// the iterator from this new event.
iter(authEvent)
Expand Down Expand Up @@ -300,7 +342,7 @@ func (r *stateResolverV2) getFirstPowerLevelMainlineEvent(event *Event) (
// that we can look up the event type.
if authEvent, ok := r.authEventMap[authEventID]; ok {
// Is the event a power level event?
if authEvent.Type() == MRoomPowerLevels {
if authEvent.Type() == MRoomPowerLevels && authEvent.StateKeyEquals("") {
// Is the event in the mainline?
if isIn, pos := isInMainline(authEvent); isIn {
// It is - take a note of the event and position and stop the
Expand Down Expand Up @@ -343,6 +385,12 @@ func (r *stateResolverV2) authAndApplyEvents(events []*Event) {
// Apply the newly authed event to the partial state. We need to do this
// here so that the next loop will have partial state to auth against.
r.applyEvents([]*Event{event})
// If we've just applied an event that is going to change the contents of
// the allower then we will need to update that too.
switch event.Type() {
case MRoomCreate, MRoomPowerLevels, MRoomJoinRules, MRoomMember:
allower = newAllowerContext(r)
}
}
}

Expand Down
54 changes: 54 additions & 0 deletions stateresolutionv2_test.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -450,6 +450,60 @@ func TestReverseTopologicalEventSorting(t *testing.T) {
}
}

func TestStateResolutionOtherEventDoesntOverpowerPowerEvent(t *testing.T) {
eventJSONs := []string{
/* create event */ `{"auth_events":[],"content":{"creator":"@anon-20220512_124253-1:localhost:8800","room_version":"6"},"depth":1,"hashes":{"sha256":"ej3MHt4EnQemwqnfLhgwN6RBArYc5JnWcZt1PI3m4hE"},"origin":"localhost:8800","origin_server_ts":1652359375504,"prev_events":[],"prev_state":[],"room_id":"!3CHu7khd0phWyTm5:localhost:8800","sender":"@anon-20220512_124253-1:localhost:8800","signatures":{"localhost:8800":{"ed25519:rhNBRg":"7Pu9f39yDWJtl8msrnz+sPSBEA2jOJ4tJsZ1Zb6Bi+vZQMzMWwT/U6GZipxQqaeJr0TpVMa7zq/YhivArRRbAA"}},"state_key":"","type":"m.room.create"}`,
/* first user joins */ `{"auth_events":["$497roGiLBBI5Q2ZKPCoSegSi8f8sSfWJW9JLPGnlGw8"],"content":{"displayname":"anon-20220512_124253-1","membership":"join"},"depth":2,"hashes":{"sha256":"L3aLzAakLKWzl9IlhjO6CAqAaANjyV6W5mI8XlD8XR8"},"origin":"localhost:8800","origin_server_ts":1652359375504,"prev_events":["$497roGiLBBI5Q2ZKPCoSegSi8f8sSfWJW9JLPGnlGw8"],"prev_state":[],"room_id":"!3CHu7khd0phWyTm5:localhost:8800","sender":"@anon-20220512_124253-1:localhost:8800","signatures":{"localhost:8800":{"ed25519:rhNBRg":"1lRHwVx5kFAfeUdndh3/hhAe5S3uugA+FwPR2ZiXBxr4DkjcfDb4TRCobEv3G9IBWPPbQxKw20x3LlTsstunAw"}},"state_key":"@anon-20220512_124253-1:localhost:8800","type":"m.room.member"}`,
/* power levels */ `{"auth_events":["$497roGiLBBI5Q2ZKPCoSegSi8f8sSfWJW9JLPGnlGw8","$00fae_PeYsZWsrtXYTSfauzH51QfRVe43ADCUIjtN1E"],"content":{"ban":50,"events":{"m.room.avatar":50,"m.room.canonical_alias":50,"m.room.history_visibility":100,"m.room.name":50,"m.room.power_levels":100},"events_default":0,"invite":50,"kick":50,"notifications":{"room":50},"redact":50,"state_default":50,"users":{"@anon-20220512_124253-1:localhost:8800":100},"users_default":0},"depth":3,"hashes":{"sha256":"6yG8CSKC31H0GJlUdSuML3XGZLrIL/hS5aF8n6kLWaU"},"origin":"localhost:8800","origin_server_ts":1652359375504,"prev_events":["$00fae_PeYsZWsrtXYTSfauzH51QfRVe43ADCUIjtN1E"],"prev_state":[],"room_id":"!3CHu7khd0phWyTm5:localhost:8800","sender":"@anon-20220512_124253-1:localhost:8800","signatures":{"localhost:8800":{"ed25519:rhNBRg":"4chQhuq4KYyJdQDA+ym/SswbSwtQYACvdFUPravvLHSzkJISCQ+6t76Hj90AgWo0TTiOIkJxsgmakkUiWQnYAg"}},"state_key":"","type":"m.room.power_levels"}`,
/* join rules = public */ `{"auth_events":["$497roGiLBBI5Q2ZKPCoSegSi8f8sSfWJW9JLPGnlGw8","$i2hsVdh5QxBroLmgpo91TxPcHQzd9VnQKgoYwY66SxI","$00fae_PeYsZWsrtXYTSfauzH51QfRVe43ADCUIjtN1E"],"content":{"join_rule":"public"},"depth":4,"hashes":{"sha256":"YqSmumeFsCepwGoOFzcdQoHHM1aY8Ddk9r2XhYOM9wY"},"origin":"localhost:8800","origin_server_ts":1652359375504,"prev_events":["$i2hsVdh5QxBroLmgpo91TxPcHQzd9VnQKgoYwY66SxI"],"prev_state":[],"room_id":"!3CHu7khd0phWyTm5:localhost:8800","sender":"@anon-20220512_124253-1:localhost:8800","signatures":{"localhost:8800":{"ed25519:rhNBRg":"C2k2CVlsgXYYDI8XQtwR0su/e9ujrp4hVjZ9zI1f7EEGDV8r6BLR46Y0I858vuA+kkGNiOz+HxutxcZY26OFDw"}},"state_key":"","type":"m.room.join_rules"}`,
/* history vis = shared */ `{"auth_events":["$497roGiLBBI5Q2ZKPCoSegSi8f8sSfWJW9JLPGnlGw8","$i2hsVdh5QxBroLmgpo91TxPcHQzd9VnQKgoYwY66SxI","$00fae_PeYsZWsrtXYTSfauzH51QfRVe43ADCUIjtN1E"],"content":{"history_visibility":"shared"},"depth":5,"hashes":{"sha256":"+PfJAGh4ZC2h44a91vvIjC1atM9zUqSUhX1P6n1o0hM"},"origin":"localhost:8800","origin_server_ts":1652359375504,"prev_events":["$RTbObai9XOoujyGg2pz90sbOZHJ1807sF9ic-mqSGL8"],"prev_state":[],"room_id":"!3CHu7khd0phWyTm5:localhost:8800","sender":"@anon-20220512_124253-1:localhost:8800","signatures":{"localhost:8800":{"ed25519:rhNBRg":"Kmvs8/Mh4LllCO5BqJLmq7deRPb8UM07MOK9RYdZYSoqn0vhTOEet2zkPHVi8kFXCQR0Fwlx2qfN5RYSk1d/CA"}},"state_key":"","type":"m.room.history_visibility"}`,
/* aliases */ `{"auth_events":["$497roGiLBBI5Q2ZKPCoSegSi8f8sSfWJW9JLPGnlGw8","$i2hsVdh5QxBroLmgpo91TxPcHQzd9VnQKgoYwY66SxI","$00fae_PeYsZWsrtXYTSfauzH51QfRVe43ADCUIjtN1E"],"content":{"alias":"#test-20220512_124253-2:localhost:8800"},"depth":6,"hashes":{"sha256":"PRniKNpqRwT8OhqqGLlWohAZwlBAW/Ls+tfzkFwWGWo"},"origin":"localhost:8800","origin_server_ts":1652359375504,"prev_events":["$NfX__HuszWh6DvwNaUZBY0ZYhEoYHRnkF4yJT3dfaww"],"prev_state":[],"room_id":"!3CHu7khd0phWyTm5:localhost:8800","sender":"@anon-20220512_124253-1:localhost:8800","signatures":{"localhost:8800":{"ed25519:rhNBRg":"NPZw/aGT+NykXTloRi/1SxalTdJBYmgwiy+SbsQkRGyKkAIqo3JkSgvUBb618ZtGxfJwgvsvQlBu53Tu+SAUCQ"}},"state_key":"","type":"m.room.canonical_alias"}`,
/* second user joins */ `{"auth_events":["$497roGiLBBI5Q2ZKPCoSegSi8f8sSfWJW9JLPGnlGw8","$RTbObai9XOoujyGg2pz90sbOZHJ1807sF9ic-mqSGL8","$i2hsVdh5QxBroLmgpo91TxPcHQzd9VnQKgoYwY66SxI"],"content":{"avatar_url":"","displayname":"anon-20220512_124253-2","membership":"join"},"depth":7,"hashes":{"sha256":"BLec3G4mLa99dr8K1NaVvGh1pDWCOHZd10/mcVc7hMA"},"origin":"localhost:8800","origin_server_ts":1652359375689,"prev_events":["$oUu8vxS4Sikr6tUITnHbnMrW-8fQpJWnLfO0sNB7kW4"],"prev_state":[],"room_id":"!3CHu7khd0phWyTm5:localhost:8800","sender":"@anon-20220512_124253-2:localhost:8800","signatures":{"localhost:8800":{"ed25519:rhNBRg":"gyF1Qph/s1Z94Ne3QI42FsOLjiZs7DbEB6+vAu59XEY5SkoCdm5THqXfrIkbOIcebKcE2HntSjNZOyhGXSETBQ"}},"state_key":"@anon-20220512_124253-2:localhost:8800","type":"m.room.member","unsigned":{}}`,
/* first user kicks second */ `{"auth_events":["$497roGiLBBI5Q2ZKPCoSegSi8f8sSfWJW9JLPGnlGw8","$i2hsVdh5QxBroLmgpo91TxPcHQzd9VnQKgoYwY66SxI","$00fae_PeYsZWsrtXYTSfauzH51QfRVe43ADCUIjtN1E","$Djpz6XCVAF39psdQSwgZdiYyDDwKEPBgs9M6Bmbw11s"],"content":{"displayname":"anon-20220512_124253-2","membership":"leave","reason":"testing"},"depth":8,"hashes":{"sha256":"I9EXGDXtPo6WRVpbr06ppeQYEJtEkx/pxsveNR8pmj0"},"origin":"localhost:8800","origin_server_ts":1652359375738,"prev_events":["$Djpz6XCVAF39psdQSwgZdiYyDDwKEPBgs9M6Bmbw11s"],"prev_state":[],"room_id":"!3CHu7khd0phWyTm5:localhost:8800","sender":"@anon-20220512_124253-1:localhost:8800","signatures":{"localhost:8800":{"ed25519:rhNBRg":"ho7JrdMV3FgFD94grYNmdgS7lbuenE180ATVGYlae14IH7IsS071Vg7HMjihGc+2KXiaM5Njwy9+9VUXvbiJBA"}},"state_key":"@anon-20220512_124253-2:localhost:8800","type":"m.room.member"}`,
}
events := make([]*Event, 0, len(eventJSONs))
for _, eventJSON := range eventJSONs {
event, err := NewEventFromTrustedJSON([]byte(eventJSON), false, RoomVersionV6)
if err != nil {
t.Fatal(err)
}
events = append(events, event)
}
conflicted, unconflicted := separate(events)
t.Log("Unconflicted:")
for _, v := range unconflicted {
t.Log("-", v.EventID())
t.Log(" ", v.Type(), *v.StateKey())
t.Log(" ", string(v.Content()))
}
t.Log("Conflicted:")
for _, v := range conflicted {
t.Log("-", v.EventID())
t.Log(" ", v.Type(), *v.StateKey())
t.Log(" ", string(v.Content()))
}
result := ResolveStateConflictsV2(
conflicted, // conflicted set
unconflicted, // unconflicted set
events, // full auth set
nil, // auth difference
)
t.Log("Resolved:")
for k, v := range result {
t.Log("-", k, v.EventID())
}
found := false
for _, v := range result {
if v.EventID() == events[len(eventJSONs)-1].eventID {
found = true
break
}
}
if !found {
t.Fatal("Expected to find the last event in the resolved set")
}
}

func runStateResolutionV2(t *testing.T, additional []*Event, expected []string) {
input := append(getBaseStateResV2Graph(), additional...)
conflicted, unconflicted := separate(input)
Expand Down

0 comments on commit eee8fd5

Please sign in to comment.