cchat
/
cchat
mirror of https://github.com/diamondburned/cchat.git
1
0
Fork 0
Code Issues Releases Wiki Activity

Clarified ID uniqueness 

This commit clarifies the rules regarding ID uniqueness and guarantees
when it comes to the backend and frontend. This piece of documentation
was added into the top package section.
This commit is contained in:
diamondburned 2020-10-26 21:48:28 -07:00
parent ea2c12d119
commit e59ab2dbf1
2 changed files with 21 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
cchat.go
View File

@ -6,6 +6,16 @@
//
// Backend
//
// Almost anything in the backend comes with an ID. For example, a Server must
// have an ID, or a Session must have a user ID. The backend is required to
// guarantee that IDs are somehow unique. This should already be the case for
// most chat services; for example, Discord provides IDs for guilds, channels,
// members, and more. The only time that the backend should not guarantee ID
// uniqueness is across Sessions, because it doesn't make sense to do so. In
// this case, the frontend should guarantee uniqueness instead, either by
// discarding duplicated items, overriding them, or anything reasonable and
// explicit.
//
// Methods implemented by the backend that have frontend containers as arguments
// can do IO. Frontends must NOT rely on individual backend states and should
// always assume that they will block.

11
repository/main.go
View File

@ -339,6 +339,17 @@ var Main = Packages{
Backend
Almost anything in the backend comes with an ID. For example, a
Server must have an ID, or a Session must have a user ID. The
backend is required to guarantee that IDs are somehow unique. This
should already be the case for most chat services; for example,
Discord provides IDs for guilds, channels, members, and more. The
only time that the backend should not guarantee ID uniqueness is
across Sessions, because it doesn't make sense to do so. In this
case, the frontend should guarantee uniqueness instead, either by
discarding duplicated items, overriding them, or anything
reasonable and explicit.
Methods implemented by the backend that have frontend containers as
arguments can do IO. Frontends must NOT rely on individual backend
states and should always assume that they will block.