Revert "Replace stop callbacks with contexts"

This reverts commit 410ac73469.

The rationale is that the frontend can wrap its own components with a
disposable thread-safe wrapper that doesn't work once it's invalidated
if it wants the guarantee that the component doesn't work anymore once
the context is stopped.

cchat.go

@@ -176,7 +176,7 @@ type Actioner interface {
 	// Do executes a message action on the given messageID, which would be taken
 	// from MessageHeader.ID(). This method is allowed to do IO; the frontend should
 	// take care of running it asynchronously.
-	Do(action string, id ID) error // Blocking
+	Do(ctx context.Context, action string, id ID) error // Blocking
 	// MessageActions returns a list of possible actions to a message in pretty
 	// strings that the frontend will use to directly display. This method must not
 	// do IO.
@@ -217,7 +217,7 @@ type AuthenticateError interface {
 type Authenticator interface {
 	// Authenticate will be called with a list of values with indices correspond to
 	// the returned slice of AuthenticateEntry.
-	Authenticate([]string) (Session, AuthenticateError) // Blocking
+	Authenticate(context.Context, []string) (Session, AuthenticateError) // Blocking
 	// AuthenticateForm should return a list of authentication entries for the
 	// frontend to render.
 	AuthenticateForm() []AuthenticateEntry
@@ -295,7 +295,7 @@ type Commander interface {
 	// A helper function for this kind of behavior is available in package split,
 	// under the ArgsIndexed function. This implementation also provides the rough
 	// specifications.
-	Run(words []string) ([]byte, error) // Blocking
+	Run(ctx context.Context, words []string) ([]byte, error) // Blocking
 
 	// Asserters.
 
@@ -318,19 +318,17 @@ type Completer interface {
 }
 
 // Configurator is an interface which the backend can implement for a primitive
-// configuration API. Since these methods do return an error, they are allowed
-// to do IO. The frontend should handle this appropriately, including running
-// them asynchronously.
+// configuration API.
 type Configurator interface {
-	SetConfiguration(map[string]string) error  // Blocking
-	Configuration() (map[string]string, error) // Blocking
+	SetConfiguration(map[string]string) error
+	Configuration() map[string]string
 }
 
 // Editor adds message editing to the messenger. Only EditMessage can do IO.
 type Editor interface {
 	// Edit edits the message with the given ID to the given content, which is the
 	// edited string from RawMessageContent. This method can do IO.
-	Edit(id ID, content string) error // Blocking
+	Edit(ctx context.Context, id ID, content string) error // Blocking
 	// RawContent gets the original message text for editing. This method must not
 	// do IO.
 	RawContent(id ID) (string, error)
@@ -357,17 +355,17 @@ type Identifier interface {
 // Labels given to the frontend may contain images or avatars, and the frontend
 // has the choice to display them or not.
 type LabelContainer interface {
-	SetLabel(text.Rich)
+	SetLabel(context.Context, text.Rich)
 }
 
-// ListMember represents a single member in the member list. This is a base
-// interface that may implement more interfaces, such as Iconer for the user's
-// avatar.
+// ListMember represents a single member in the member list. Note that this
+// interface should be treated as a static container: updating a member will
+// involve a completely new ListMember instance with the same ID.
 //
 // Note that the frontend may give everyone an avatar regardless, or it may not
 // show any avatars at all.
 type ListMember interface {
-	User
+	Identifier
 
 	// Secondary returns the subtext of this member. This could be anything, such as
 	// a user's custom status or away reason.
@@ -376,6 +374,9 @@ type ListMember interface {
 	// offline members with the offline status if it doesn't want to show offline
 	// menbers at all.
 	Status() Status
+	// Name returns the username or the nickname of the member, whichever the
+	// backend should prefer.
+	Name() text.Rich
 }
 
 // Lister is for servers that contain children servers. This is similar to
@@ -418,14 +419,14 @@ type MemberDynamicSection interface {
 	// The client can call this method exactly as many times as it has called
 	// LoadMore. However, false should be returned if the client should stop, and
 	// future calls without LoadMore should still return false.
-	LoadLess() bool // Blocking
+	LoadLess(context.Context) bool // Blocking
 	// LoadMore is a method which the client can call to ask for more members. This
 	// method can do IO.
 	//
 	// Clients may call this method on the last section in the section slice;
 	// however, calling this method on any section is allowed. Clients may not call
 	// this method if the number of members in this section is equal to Total.
-	LoadMore() bool // Blocking
+	LoadMore(context.Context) bool // Blocking
 }
 
 // MemberListContainer is a generic interface for any container that can display
@@ -451,7 +452,7 @@ type MemberDynamicSection interface {
 type MemberListContainer interface {
 	// RemoveMember removes a member from a section. If neither the member nor the
 	// section exists, then the client should ignore it.
-	RemoveMember(sectionID ID, memberID ID)
+	RemoveMember(ctx context.Context, sectionID ID, memberID ID)
 	// SetMember adds or updates (or upsert) a member into a section. This operation
 	// must not change the section's member count. As such, changes should be done
 	// separately in SetSection. If the section does not exist, then the client
@@ -461,12 +462,12 @@ type MemberListContainer interface {
 	// Typically, the backend should try and avoid calling this method and instead
 	// update the labeler in the name. This method should only be used for adding
 	// members.
-	SetMember(sectionID ID, member ListMember)
+	SetMember(ctx context.Context, sectionID ID, member ListMember)
 	// SetSections (re)sets the list of sections to be the given slice. Members from
 	// the old section list should be transferred over to the new section entry if
 	// the section name's content is the same. Old sections that don't appear in the
 	// new slice should be removed.
-	SetSections(sections []MemberSection)
+	SetSections(ctx context.Context, sections []MemberSection)
 }
 
 // MemberLister adds a member list into a message server.
@@ -519,11 +520,13 @@ type MessageHeader interface {
 	Time() time.Time
 }
 
-// MessageUpdate is the interface for a message update (or edit) event. It
-// behaves similarly to MessageCreate, except all fields are optional. The
-// frontend is responsible for checking which field is not empty and check it.
+// MessageUpdate is the interface for a message update (or edit) event. It is
+// only responsible for updating a message's content. The author's name should
+// be updated using MessageCreate's Author.
 type MessageUpdate interface {
-	MessageCreate
+	MessageHeader
+
+	Content() text.Rich
 }
 
 // MessagesContainer is a view implementation that displays a list of messages
@@ -534,12 +537,12 @@ type MessageUpdate interface {
 // allowed to have multiple views. This is usually done with tabs or splits, but
 // the backend should update them all nonetheless.
 type MessagesContainer interface {
-	DeleteMessage(MessageDelete)
-	UpdateMessage(MessageUpdate)
+	DeleteMessage(context.Context, MessageDelete)
+	UpdateMessage(context.Context, MessageUpdate)
 	// CreateMessage inserts a message into the container. The frontend must
 	// guarantee that the messages are in order based on what's returned from
 	// Time().
-	CreateMessage(MessageCreate)
+	CreateMessage(context.Context, MessageCreate)
 }
 
 // Messenger is for servers that contain messages. This is similar to Discord or
@@ -615,10 +618,10 @@ type ReadContainer interface {
 	// their read indicators. The backend can use this to free up users/authors that
 	// are no longer in the server, for example when they are offline or have left
 	// the server.
-	DeleteIndications(authorIDs []ID)
+	DeleteIndications(ctx context.Context, authorIDs []ID)
 	// AddIndications adds a map of users/authors to the respective message ID of
 	// the server that implements ReadIndicator.
-	AddIndications([]ReadIndication)
+	AddIndications(context.Context, []ReadIndication)
 }
 
 // ReadIndicator adds a read indicator API for frontends to show. An example of
@@ -629,7 +632,7 @@ type ReadIndicator interface {
 	// must keep track of which read states to send over to not overwhelm the
 	// frontend, and the frontend must either keep track of them, or it should not
 	// display it at all.
-	ReadIndicate(ReadContainer) (stop func(), err error)
+	ReadIndicate(context.Context, ReadContainer) (stop func(), err error)
 }
 
 // Replier indicates that the message being sent is a reply to something.
@@ -663,7 +666,7 @@ type Sender interface {
 	// CanAttach returns whether or not the client is allowed to upload files.
 	CanAttach() bool
 	// Send is called by the frontend to send a message to this channel.
-	Send(SendableMessage) error // Blocking
+	Send(context.Context, SendableMessage) error // Blocking
 
 	// Asserters.
 
@@ -718,7 +721,7 @@ type ServerUpdate interface {
 // as servers can be infinitely nested. Frontends should also reset the entire
 // node and its children when SetServers is called again.
 type ServersContainer interface {
-	UpdateServer(ServerUpdate)
+	UpdateServer(context.Context, ServerUpdate)
 	// SetServer is called by the backend service to request a reset of the server
 	// list. The frontend can choose to call Servers() on each of the given servers,
 	// or it can call that later. The backend should handle both cases.
@@ -728,7 +731,7 @@ type ServersContainer interface {
 	// should only be considered empty if it's an empty non-nil slice. An
 	// unavailable list, on the other hand, can be treated as backend issues, e.g. a
 	// connection issue.
-	SetServers([]Server)
+	SetServers(context.Context, []Server)
 }
 
 // Service is a complete service that's capable of multiple sessions. It has to
@@ -791,7 +794,7 @@ type Session interface {
 	// When this function fails, the frontend may display the error upfront.
 	// However, it will treat the session as actually disconnected. If needed, the
 	// backend must implement reconnection by itself.
-	Disconnect() error // Blocking, Disposer
+	Disconnect(context.Context) error // Blocking, Disposer
 
 	// Asserters.
 
@@ -805,7 +808,7 @@ type Session interface {
 //
 // To save a session, refer to SessionSaver.
 type SessionRestorer interface {
-	RestoreSession(map[string]string) (Session, error) // Blocking
+	RestoreSession(context.Context, map[string]string) (Session, error) // Blocking
 }
 
 // SessionSaver extends Session and is called by the frontend to save the
@@ -832,11 +835,11 @@ type TypingContainer interface {
 	// of typers. This function is usually not needed, as the client will take care
 	// of removing them after TypingTimeout has been reached or other conditions
 	// listed in ServerMessageTypingIndicator are met.
-	RemoveTyper(authorID ID)
+	RemoveTyper(ctx context.Context, authorID ID)
 	// AddTyper appends the typer (author) into the frontend's list of typers, or it
 	// pushes this typer on top of others. The frontend should assume current time
 	// every time AddTyper is called.
-	AddTyper(User)
+	AddTyper(context.Context, User)
 }
 
 // TypingIndicator optionally extends ServerMessage to provide bidirectional
@@ -854,7 +857,7 @@ type TypingIndicator interface {
 	// This method does not take in a context, as it's supposed to only use event
 	// handlers and not do any IO calls. Nonetheless, the client must treat it like
 	// it does and call it asynchronously.
-	TypingSubscribe(TypingContainer) (stop func(), err error)
+	TypingSubscribe(context.Context, TypingContainer) (stop func(), err error)
 	// TypingTimeout returns the interval between typing events sent by the client
 	// as well as the timeout before the client should remove the typer. Typically,
 	// a constant should be returned.
@@ -863,7 +866,7 @@ type TypingIndicator interface {
 	// function can do IO calls, and the client must take care of calling it in a
 	// goroutine (or an asynchronous queue) as well as throttling it to
 	// TypingTimeout.
-	Typing() error // Blocking
+	Typing(context.Context) error // Blocking
 }
 
 // UnreadContainer is an interface that a single server container (such as a
@@ -882,7 +885,7 @@ type TypingIndicator interface {
 type UnreadContainer interface {
 	// SetUnread sets the container's unread state to the given boolean. The
 	// frontend may choose how to represent this.
-	SetUnread(unread bool, mentioned bool)
+	SetUnread(ctx context.Context, unread bool, mentioned bool)
 }
 
 // UnreadIndicator adds an unread state API for frontends to use. The unread
@@ -896,7 +899,7 @@ type UnreadIndicator interface {
 	//
 	// This function must provide a way to remove callbacks, as clients must call
 	// this when the old server is destroyed, such as when Servers is called.
-	UnreadIndicate(UnreadContainer) (stop func(), err error)
+	UnreadIndicate(context.Context, UnreadContainer) (stop func(), err error)
 	// MarkRead marks a message in the server messenger as read. Backends that
 	// implement the UnreadIndicator interface must give control of marking messages
 	// as read to the frontend if possible.
@@ -905,7 +908,7 @@ type UnreadIndicator interface {
 	// the frontend has no use in knowing the error. As such, marking messages as
 	// read is best-effort. The backend is in charge of synchronizing the read state
 	// with the server and coordinating it with reasonable rate limits, if needed.
-	MarkRead(messageID ID)
+	MarkRead(ctx context.Context, messageID ID)
 }
 
 // User is the interface for an identifiable author. The interface defines that

cmd/internal/cchat-generator/generate_interface.go

@@ -66,9 +66,13 @@ func generateInterfaces(ifaces []repository.Interface) jen.Code {
 					stmt.Params(generateFuncParams(method.Returns, method.ErrorType)...)
 				case repository.SetterMethod:
 					stmt.Params(generateFuncParams(method.Parameters, "")...)
+					stmt.Params(generateFuncParamsErr(repository.NamedType{}, method.ErrorType)...)
+				case repository.ContainerUpdaterMethod:
+					stmt.Params(generateFuncParamsCtx(method.Parameters, "")...)
+					stmt.Params(generateFuncParamsErr(repository.NamedType{}, method.ErrorType)...)
 				case repository.IOMethod:
-					stmt.Params(generateFuncParams(method.Parameters, "")...)
-					stmt.Params(generateFuncParamErr(method.ReturnValue, method.ErrorType)...)
+					stmt.Params(generateFuncParamsCtx(method.Parameters, "")...)
+					stmt.Params(generateFuncParamsErr(method.ReturnValue, method.ErrorType)...)
 					var comment = "Blocking"
 					if method.Disposer {
 						comment += ", Disposer"
@@ -96,7 +100,7 @@ func generateInterfaces(ifaces []repository.Interface) jen.Code {
 	return stmt
 }
 
-func generateFuncParamErr(param repository.NamedType, errorType string) []jen.Code {
+func generateFuncParamsErr(param repository.NamedType, errorType string) []jen.Code {
 	stmt := make([]jen.Code, 0, 2)
 
 	if !param.IsZero() {
@@ -121,6 +125,18 @@ func generateFuncParam(param repository.NamedType) jen.Code {
 	return jen.Id(param.Name).Add(genutils.GenerateType(param))
 }
 
+func generateFuncParamsCtx(params []repository.NamedType, errorType string) []jen.Code {
+	var name string
+	if len(params) > 0 && params[0].Name != "" {
+		name = "ctx"
+	}
+
+	p := []repository.NamedType{{Name: name, Type: "context.Context"}}
+	p = append(p, params...)
+
+	return generateFuncParams(p, errorType)
+}
+
 func generateFuncParams(params []repository.NamedType, errorType string) []jen.Code {
 	if len(params) == 0 {
 		return nil

repository/interface.go

@@ -10,6 +10,7 @@ func init() {
 	gob.Register(AsserterMethod{})
 	gob.Register(GetterMethod{})
 	gob.Register(SetterMethod{})
+	gob.Register(ContainerUpdaterMethod{})
 	gob.Register(IOMethod{})
 }
 
@@ -67,21 +68,39 @@ func (m GetterMethod) ReturnError() bool {
 }
 
 // SetterMethod is a method that sets values. These methods must not do IO, and
-// they have to be non-blocking. They're used only for containers. Actual setter
-// methods implemented by the backend belongs to IOMethods.
-//
-// Clients should always keep track of the values given to setters and free them
-// once the setters are called again with new values.
+// they have to be non-blocking.
 type SetterMethod struct {
 	method
 
 	// Parameters is the list of parameters in the function. These parameters
 	// should be the parameters to set.
 	Parameters []NamedType
+	// ErrorType is non-empty if the function returns an error at the end of
+	// returns. An error may be returned from the backend if the input is
+	// invalid, but it must not do IO. Frontend setters must never error.
+	ErrorType string
+}
+
+// ContainerUpdaterMethod is a SetterMethod that passes to the container the
+// current context to prevent race conditions when synchronizing.
+// The rule of thumb is that any setter method done inside a method with a
+// context is usually this type of method.
+type ContainerUpdaterMethod struct {
+	method
+
+	// Parameters is the list of parameters in the function. These parameters
+	// should be the parameters to set.
+	Parameters []NamedType
+	// ErrorType is non-empty if the function returns an error at the end of
+	// returns. An error may be returned from the backend if the input is
+	// invalid, but it must not do IO. Frontend setters must never error.
+	ErrorType string
 }
 
 // IOMethod is a regular method that can do IO and thus is blocking. These
-// methods usually always return errors.
+// methods usually always return errors. IOMethods must always have means of
+// cancelling them in the API, but implementations don't have to use it; as
+// such, the user should always have a timeout to gracefully wait.
 type IOMethod struct {
 	method
 

repository/main.go

@@ -817,18 +817,15 @@ var Main = Packages{
 		}, {
 			Comment: Comment{`
 				Configurator is an interface which the backend can implement for a
-				primitive configuration API. Since these methods do return an error,
-				they are allowed to do IO. The frontend should handle this
-				appropriately, including running them asynchronously.
+				primitive configuration API.
 			`},
 			Name: "Configurator",
 			Methods: []Method{
-				IOMethod{
-					method:      method{Name: "Configuration"},
-					ReturnValue: NamedType{Type: "map[string]string"},
-					ErrorType:   "error",
+				GetterMethod{
+					method:  method{Name: "Configuration"},
+					Returns: []NamedType{{Type: "map[string]string"}},
 				},
-				IOMethod{
+				SetterMethod{
 					method:     method{Name: "SetConfiguration"},
 					Parameters: []NamedType{{Type: "map[string]string"}},
 					ErrorType:  "error",
@@ -1251,7 +1248,6 @@ var Main = Packages{
 						Name: "Backlog",
 					},
 					Parameters: []NamedType{
-						{"ctx", "context.Context"},
 						{"before", "ID"},
 						{"msgc", "MessagesContainer"},
 					},
@@ -1302,6 +1298,7 @@ var Main = Packages{
 						`},
 						Name: "ReadIndicate",
 					},
+					HasContext:    true,
 					ContainerType: "ReadContainer",
 				},
 			},
@@ -1314,7 +1311,7 @@ var Main = Packages{
 			`},
 			Name: "UnreadIndicator",
 			Methods: []Method{
-				SetterMethod{
+				ContainerUpdaterMethod{
 					method: method{
 						Comment: Comment{`
 							MarkRead marks a message in the server messenger as
@@ -1348,6 +1345,7 @@ var Main = Packages{
 						`},
 						Name: "UnreadIndicate",
 					},
+					HasContext:    true,
 					ContainerType: "UnreadContainer",
 				},
 			},
@@ -1403,6 +1401,7 @@ var Main = Packages{
 						`},
 						Name: "TypingSubscribe",
 					},
+					HasContext:    true,
 					ContainerType: "TypingContainer",
 				},
 			},
@@ -1453,7 +1452,7 @@ var Main = Packages{
 			`},
 			Name: "ServersContainer",
 			Methods: []Method{
-				SetterMethod{
+				ContainerUpdaterMethod{
 					method: method{
 						Comment: Comment{`
 							SetServer is called by the backend service to
@@ -1474,7 +1473,7 @@ var Main = Packages{
 					},
 					Parameters: []NamedType{{Type: "[]Server"}},
 				},
-				SetterMethod{
+				ContainerUpdaterMethod{
 					method:     method{Name: "UpdateServer"},
 					Parameters: []NamedType{{Type: "ServerUpdate"}},
 				},
@@ -1534,7 +1533,7 @@ var Main = Packages{
 			`},
 			Name: "MessagesContainer",
 			Methods: []Method{
-				SetterMethod{
+				ContainerUpdaterMethod{
 					method: method{
 						Comment: Comment{`
 							CreateMessage inserts a message into the container.
@@ -1545,11 +1544,11 @@ var Main = Packages{
 					},
 					Parameters: []NamedType{{Type: "MessageCreate"}},
 				},
-				SetterMethod{
+				ContainerUpdaterMethod{
 					method:     method{Name: "UpdateMessage"},
 					Parameters: []NamedType{{Type: "MessageUpdate"}},
 				},
-				SetterMethod{
+				ContainerUpdaterMethod{
 					method:     method{Name: "DeleteMessage"},
 					Parameters: []NamedType{{Type: "MessageDelete"}},
 				},
@@ -1602,12 +1601,20 @@ var Main = Packages{
 		}, {
 			Comment: Comment{`
 				MessageUpdate is the interface for a message update (or edit)
-				event. It behaves similarly to MessageCreate, except all fields
-				are optional. The frontend is responsible for checking which
-				field is not empty and check it.
+				event. It is only responsible for updating a message's content.
+				The author's name should be updated using MessageCreate's
+				Author.
 			`},
 			Name:   "MessageUpdate",
-			Embeds: []EmbeddedInterface{{InterfaceName: "MessageCreate"}},
+			Embeds: []EmbeddedInterface{{InterfaceName: "MessageHeader"}},
+			Methods: []Method{
+				GetterMethod{
+					method: method{Name: "Content"},
+					Returns: []NamedType{{
+						Type: MakeQual("text", "Rich"),
+					}},
+				},
+			},
 		}, {
 			Comment: Comment{`
 				MessageDelete is the interface for a message delete event.
@@ -1630,7 +1637,7 @@ var Main = Packages{
 			`},
 			Name: "LabelContainer",
 			Methods: []Method{
-				SetterMethod{
+				ContainerUpdaterMethod{
 					method: method{Name: "SetLabel"},
 					Parameters: []NamedType{{
 						Type: MakeQual("text", "Rich"),
@@ -1646,7 +1653,7 @@ var Main = Packages{
 			`},
 			Name: "ReadContainer",
 			Methods: []Method{
-				SetterMethod{
+				ContainerUpdaterMethod{
 					method: method{
 						Comment: Comment{`
 							AddIndications adds a map of users/authors to the
@@ -1657,7 +1664,7 @@ var Main = Packages{
 					},
 					Parameters: []NamedType{{"", "[]ReadIndication"}},
 				},
-				SetterMethod{
+				ContainerUpdaterMethod{
 					method: method{
 						Comment: Comment{`
 							DeleteIndications deletes a list of unused
@@ -1691,7 +1698,7 @@ var Main = Packages{
 			`},
 			Name: "UnreadContainer",
 			Methods: []Method{
-				SetterMethod{
+				ContainerUpdaterMethod{
 					method: method{
 						Comment: Comment{`
 							SetUnread sets the container's unread state to the
@@ -1717,7 +1724,7 @@ var Main = Packages{
 			`},
 			Name: "TypingContainer",
 			Methods: []Method{
-				SetterMethod{
+				ContainerUpdaterMethod{
 					method: method{
 						Comment: Comment{`
 							AddTyper appends the typer (author) into the
@@ -1729,7 +1736,7 @@ var Main = Packages{
 					},
 					Parameters: []NamedType{{"", "User"}},
 				},
-				SetterMethod{
+				ContainerUpdaterMethod{
 					method: method{
 						Comment: Comment{`
 							RemoveTyper explicitly removes the typer with the
@@ -1769,7 +1776,7 @@ var Main = Packages{
 			`},
 			Name: "MemberListContainer",
 			Methods: []Method{
-				SetterMethod{
+				ContainerUpdaterMethod{
 					method: method{
 						Comment: Comment{`
 							SetSections (re)sets the list of sections to be the
@@ -1785,7 +1792,7 @@ var Main = Packages{
 						{Name: "sections", Type: "[]MemberSection"},
 					},
 				},
-				SetterMethod{
+				ContainerUpdaterMethod{
 					method: method{
 						Comment: Comment{`
 							SetMember adds or updates (or upsert) a member into
@@ -1808,7 +1815,7 @@ var Main = Packages{
 						{"member", "ListMember"},
 					},
 				},
-				SetterMethod{
+				ContainerUpdaterMethod{
 					method: method{
 						Comment: Comment{`
 							RemoveMember removes a member from a section. If
@@ -1825,18 +1832,29 @@ var Main = Packages{
 			},
 		}, {
 			Comment: Comment{`
-				ListMember represents a single member in the member list. This
-				is a base interface that may implement more interfaces, such as
-				Iconer for the user's avatar.
+				ListMember represents a single member in the member list. Note
+				that this interface should be treated as a static container:
+				updating a member will involve a completely new ListMember
+				instance with the same ID.
 
 				Note that the frontend may give everyone an avatar regardless,
 				or it may not show any avatars at all.
 			`},
 			Name: "ListMember",
 			Embeds: []EmbeddedInterface{
-				{InterfaceName: "User"},
+				{InterfaceName: "Identifier"},
 			},
 			Methods: []Method{
+				GetterMethod{
+					method: method{
+						Name: "Name",
+						Comment: Comment{`
+							Name returns the username or the nickname of the
+							member, whichever the backend should prefer.
+						`},
+					},
+					Returns: []NamedType{{Type: MakeQual("text", "Rich")}},
+				},
 				GetterMethod{
 					method: method{
 						Comment: Comment{`

text/text_extras.go

@@ -11,7 +11,9 @@ func SolidColor(rgb uint32) uint32 {
 	return (rgb << 8) | 0xFF
 }
 
-// IsEmpty returns true if the given rich segment's content is empty.
+// IsEmpty returns true if the given rich segment's content is empty. Note that
+// a rich text is not necessarily empty if the content is empty, because there
+// may be images within the segments.
 func (r Rich) IsEmpty() bool {
-	return r.Content == ""
+	return r.Content == "" && len(r.Segments) == 0
 }