From db3f3a945209d55074542825797253567167f923 Mon Sep 17 00:00:00 2001 From: Mark Haines Date: Mon, 7 Aug 2017 15:02:02 +0100 Subject: [PATCH] Use clearer names for some of the variables --- .../dendrite/roomserver/input/membership.go | 14 +++---- .../roomserver/storage/invite_table.go | 18 ++++----- .../roomserver/storage/membership_table.go | 14 +++---- .../dendrite/roomserver/storage/storage.go | 38 +++++++++---------- .../dendrite/roomserver/types/types.go | 6 +-- 5 files changed, 45 insertions(+), 45 deletions(-) diff --git a/src/github.com/matrix-org/dendrite/roomserver/input/membership.go b/src/github.com/matrix-org/dendrite/roomserver/input/membership.go index ef5b1ce0e..b5b10dca1 100644 --- a/src/github.com/matrix-org/dendrite/roomserver/input/membership.go +++ b/src/github.com/matrix-org/dendrite/roomserver/input/membership.go @@ -45,22 +45,22 @@ func updateMemberships( for _, change := range changes { var ae *gomatrixserverlib.Event var re *gomatrixserverlib.Event - var targetNID types.EventStateKeyNID + var targetUserNID types.EventStateKeyNID if change.removed.EventNID != 0 { ev, _ := eventMap(events).lookup(change.removed.EventNID) if ev != nil { re = &ev.Event } - targetNID = change.removed.EventStateKeyNID + targetUserNID = change.removed.EventStateKeyNID } if change.added.EventNID != 0 { ev, _ := eventMap(events).lookup(change.added.EventNID) if ev != nil { ae = &ev.Event } - targetNID = change.added.EventStateKeyNID + targetUserNID = change.added.EventStateKeyNID } - if updates, err = updateMembership(updater, targetNID, re, ae, updates); err != nil { + if updates, err = updateMembership(updater, targetUserNID, re, ae, updates); err != nil { return nil, err } } @@ -68,8 +68,8 @@ func updateMemberships( } func updateMembership( - updater types.RoomRecentEventsUpdater, targetNID types.EventStateKeyNID, - remove *gomatrixserverlib.Event, add *gomatrixserverlib.Event, + updater types.RoomRecentEventsUpdater, targetUserNID types.EventStateKeyNID, + remove, add *gomatrixserverlib.Event, updates []api.OutputEvent, ) ([]api.OutputEvent, error) { var err error @@ -92,7 +92,7 @@ func updateMembership( return updates, nil } - mu, err := updater.MembershipUpdater(targetNID) + mu, err := updater.MembershipUpdater(targetUserNID) if err != nil { return nil, err } diff --git a/src/github.com/matrix-org/dendrite/roomserver/storage/invite_table.go b/src/github.com/matrix-org/dendrite/roomserver/storage/invite_table.go index e8738976b..193de4d14 100644 --- a/src/github.com/matrix-org/dendrite/roomserver/storage/invite_table.go +++ b/src/github.com/matrix-org/dendrite/roomserver/storage/invite_table.go @@ -91,11 +91,11 @@ func (s *inviteStatements) prepare(db *sql.DB) (err error) { func (s *inviteStatements) insertInviteEvent( txn *sql.Tx, inviteEventID string, roomNID types.RoomNID, - targetNID, senderNID types.EventStateKeyNID, + targetUserNID, senderUserNID types.EventStateKeyNID, inviteEventJSON []byte, ) (bool, error) { result, err := txn.Stmt(s.insertInviteEventStmt).Exec( - inviteEventID, roomNID, targetNID, senderNID, inviteEventJSON, + inviteEventID, roomNID, targetUserNID, senderUserNID, inviteEventJSON, ) if err != nil { return false, err @@ -108,9 +108,9 @@ func (s *inviteStatements) insertInviteEvent( } func (s *inviteStatements) updateInviteRetired( - txn *sql.Tx, roomNID types.RoomNID, targetNID types.EventStateKeyNID, + txn *sql.Tx, roomNID types.RoomNID, targetUserNID types.EventStateKeyNID, ) ([]string, error) { - rows, err := txn.Stmt(s.updateInviteRetiredStmt).Query(roomNID, targetNID) + rows, err := txn.Stmt(s.updateInviteRetiredStmt).Query(roomNID, targetUserNID) if err != nil { return nil, err } @@ -128,10 +128,10 @@ func (s *inviteStatements) updateInviteRetired( // selectInviteActiveForUserInRoom returns a list of sender state key NIDs func (s *inviteStatements) selectInviteActiveForUserInRoom( - targetNID types.EventStateKeyNID, roomNID types.RoomNID, + targetUserNID types.EventStateKeyNID, roomNID types.RoomNID, ) ([]types.EventStateKeyNID, error) { rows, err := s.selectInviteActiveForUserInRoomStmt.Query( - targetNID, roomNID, + targetUserNID, roomNID, ) if err != nil { return nil, err @@ -139,11 +139,11 @@ func (s *inviteStatements) selectInviteActiveForUserInRoom( defer rows.Close() var result []types.EventStateKeyNID for rows.Next() { - var senderNID int64 - if err := rows.Scan(&senderNID); err != nil { + var senderUserNID int64 + if err := rows.Scan(&senderUserNID); err != nil { return nil, err } - result = append(result, types.EventStateKeyNID(senderNID)) + result = append(result, types.EventStateKeyNID(senderUserNID)) } return result, nil } diff --git a/src/github.com/matrix-org/dendrite/roomserver/storage/membership_table.go b/src/github.com/matrix-org/dendrite/roomserver/storage/membership_table.go index d9eb5bad7..c3e092b19 100644 --- a/src/github.com/matrix-org/dendrite/roomserver/storage/membership_table.go +++ b/src/github.com/matrix-org/dendrite/roomserver/storage/membership_table.go @@ -80,27 +80,27 @@ func (s *membershipStatements) prepare(db *sql.DB) (err error) { } func (s *membershipStatements) insertMembership( - txn *sql.Tx, roomNID types.RoomNID, targetNID types.EventStateKeyNID, + txn *sql.Tx, roomNID types.RoomNID, targetUserNID types.EventStateKeyNID, ) error { - _, err := txn.Stmt(s.insertMembershipStmt).Exec(roomNID, targetNID) + _, err := txn.Stmt(s.insertMembershipStmt).Exec(roomNID, targetUserNID) return err } func (s *membershipStatements) selectMembershipForUpdate( - txn *sql.Tx, roomNID types.RoomNID, targetNID types.EventStateKeyNID, + txn *sql.Tx, roomNID types.RoomNID, targetUserNID types.EventStateKeyNID, ) (membership membershipState, err error) { err = txn.Stmt(s.selectMembershipForUpdateStmt).QueryRow( - roomNID, targetNID, + roomNID, targetUserNID, ).Scan(&membership) return } func (s *membershipStatements) updateMembership( - txn *sql.Tx, roomNID types.RoomNID, targetNID types.EventStateKeyNID, - senderNID types.EventStateKeyNID, membership membershipState, + txn *sql.Tx, roomNID types.RoomNID, targetUserNID types.EventStateKeyNID, + senderUserNID types.EventStateKeyNID, membership membershipState, ) error { _, err := txn.Stmt(s.updateMembershipStmt).Exec( - roomNID, targetNID, senderNID, membership, + roomNID, targetUserNID, senderUserNID, membership, ) return err } diff --git a/src/github.com/matrix-org/dendrite/roomserver/storage/storage.go b/src/github.com/matrix-org/dendrite/roomserver/storage/storage.go index c4a701e8c..a7c8b29fe 100644 --- a/src/github.com/matrix-org/dendrite/roomserver/storage/storage.go +++ b/src/github.com/matrix-org/dendrite/roomserver/storage/storage.go @@ -323,8 +323,8 @@ func (u *roomRecentEventsUpdater) MarkEventAsSent(eventNID types.EventNID) error return u.d.statements.updateEventSentToOutput(u.txn, eventNID) } -func (u *roomRecentEventsUpdater) MembershipUpdater(targetNID types.EventStateKeyNID) (types.MembershipUpdater, error) { - return u.d.membershipUpdaterTxn(u.txn, u.roomNID, targetNID) +func (u *roomRecentEventsUpdater) MembershipUpdater(targetUserNID types.EventStateKeyNID) (types.MembershipUpdater, error) { + return u.d.membershipUpdaterTxn(u.txn, u.roomNID, targetUserNID) } // RoomNID implements query.RoomserverQueryAPIDB @@ -382,27 +382,27 @@ func (d *Database) StateEntriesForTuples( type membershipUpdater struct { transaction - d *Database - roomNID types.RoomNID - targetNID types.EventStateKeyNID - membership membershipState + d *Database + roomNID types.RoomNID + targetUserNID types.EventStateKeyNID + membership membershipState } func (d *Database) membershipUpdaterTxn( - txn *sql.Tx, roomNID types.RoomNID, targetNID types.EventStateKeyNID, + txn *sql.Tx, roomNID types.RoomNID, targetUserNID types.EventStateKeyNID, ) (types.MembershipUpdater, error) { - if err := d.statements.insertMembership(txn, roomNID, targetNID); err != nil { + if err := d.statements.insertMembership(txn, roomNID, targetUserNID); err != nil { return nil, err } - membership, err := d.statements.selectMembershipForUpdate(txn, roomNID, targetNID) + membership, err := d.statements.selectMembershipForUpdate(txn, roomNID, targetUserNID) if err != nil { return nil, err } return &membershipUpdater{ - transaction{txn}, d, roomNID, targetNID, membership, + transaction{txn}, d, roomNID, targetUserNID, membership, }, nil } @@ -424,20 +424,20 @@ func (u *membershipUpdater) IsLeave() bool { // SetToInvite implements types.MembershipUpdater func (u *membershipUpdater) SetToInvite(event gomatrixserverlib.Event) (bool, error) { // TODO: assign the state key inside the transaction. - senderNID, err := u.d.assignStateKeyNID(event.Sender()) + senderUserNID, err := u.d.assignStateKeyNID(event.Sender()) if err != nil { return false, err } eventID := event.EventID() inserted, err := u.d.statements.insertInviteEvent( - u.txn, eventID, u.roomNID, u.targetNID, senderNID, event.JSON(), + u.txn, eventID, u.roomNID, u.targetUserNID, senderUserNID, event.JSON(), ) if err != nil { return false, err } if u.membership != membershipStateInvite { if err = u.d.statements.updateMembership( - u.txn, u.roomNID, u.targetNID, senderNID, membershipStateInvite, + u.txn, u.roomNID, u.targetUserNID, senderUserNID, membershipStateInvite, ); err != nil { return false, err } @@ -448,19 +448,19 @@ func (u *membershipUpdater) SetToInvite(event gomatrixserverlib.Event) (bool, er // SetToJoin implements types.MembershipUpdater func (u *membershipUpdater) SetToJoin(senderID string) ([]string, error) { // TODO: assign the state key inside the transaction. - senderNID, err := u.d.assignStateKeyNID(senderID) + senderUserNID, err := u.d.assignStateKeyNID(senderID) if err != nil { return nil, err } inviteEventIDs, err := u.d.statements.updateInviteRetired( - u.txn, u.roomNID, u.targetNID, + u.txn, u.roomNID, u.targetUserNID, ) if err != nil { return nil, err } if u.membership != membershipStateJoin { if err = u.d.statements.updateMembership( - u.txn, u.roomNID, u.targetNID, senderNID, membershipStateJoin, + u.txn, u.roomNID, u.targetUserNID, senderUserNID, membershipStateJoin, ); err != nil { return nil, err } @@ -471,19 +471,19 @@ func (u *membershipUpdater) SetToJoin(senderID string) ([]string, error) { // SetToLeave implements types.MembershipUpdater func (u *membershipUpdater) SetToLeave(senderID string) ([]string, error) { // TODO: assign the state key inside the transaction. - senderNID, err := u.d.assignStateKeyNID(senderID) + senderUserNID, err := u.d.assignStateKeyNID(senderID) if err != nil { return nil, err } inviteEventIDs, err := u.d.statements.updateInviteRetired( - u.txn, u.roomNID, u.targetNID, + u.txn, u.roomNID, u.targetUserNID, ) if err != nil { return nil, err } if u.membership != membershipStateLeaveOrBan { if err = u.d.statements.updateMembership( - u.txn, u.roomNID, u.targetNID, senderNID, membershipStateLeaveOrBan, + u.txn, u.roomNID, u.targetUserNID, senderUserNID, membershipStateLeaveOrBan, ); err != nil { return nil, err } diff --git a/src/github.com/matrix-org/dendrite/roomserver/types/types.go b/src/github.com/matrix-org/dendrite/roomserver/types/types.go index 5b7d48a2f..c908759b1 100644 --- a/src/github.com/matrix-org/dendrite/roomserver/types/types.go +++ b/src/github.com/matrix-org/dendrite/roomserver/types/types.go @@ -173,7 +173,7 @@ type RoomRecentEventsUpdater interface { MarkEventAsSent(eventNID EventNID) error // Build a membership updater for the target user in this room. // It will share the same transaction as this updater. - MembershipUpdater(targetNID EventStateKeyNID) (MembershipUpdater, error) + MembershipUpdater(targetUserNID EventStateKeyNID) (MembershipUpdater, error) // Implements Transaction so it can be committed or rolledback Transaction } @@ -192,10 +192,10 @@ type MembershipUpdater interface { // Returns whether this invite needs to be sent SetToInvite(event gomatrixserverlib.Event) (needsSending bool, err error) // Set the state to join. - SetToJoin(senderID string) (inviteIDs []string, err error) + SetToJoin(senderID string) (inviteEventIDs []string, err error) // Set the state to leave. // Returns a list of invite event IDs that this state change retired. - SetToLeave(senderID string) (inviteIDs []string, err error) + SetToLeave(senderID string) (inviteEventIDs []string, err error) // Implements Transaction so it can be committed or rolledback. Transaction }