dandri/simplex-chat
1
0
Fork 0
mirror of https://github.com/simplex-chat/simplex-chat.git synced 2026-08-26 05:10:07 +00:00
Code Issues Packages Projects Releases Wiki Activity

correct the stale line anchors in spec/api.md's user section

Browse Source 
Fixing only apiCreateActiveUser's anchor left the table self-contradictory,
with listUsers pointing above it despite coming after. The whole 2.1 section
was stale by ~30 lines; it is now monotonic and matches the file.

Also record why the 'the failed move is silent' finding, raised three times,
does not hold: offline gets the retry dialog, every other error alerts, and
only the user cancelling their own dialog is quiet.
This commit is contained in:
Narasimha-sc
2026-08-07 17:07:43 +00:00
parent 1f948bcab4
commit 077af35e19
2 changed files with 47 additions and 15 deletions
Download Patch File Download Diff File Expand all files Collapse all files
apps/multiplatform/spec/api.md
+15 -15
View File
@@ -89,22 +89,22 @@ All functions below are `suspend fun` members of `ChatController` ([SimpleXAPI.k
| Command | Parameters | Description | Line |
|---------|-----------|-------------|------|
| `apiGetActiveUser` | `rh: Long?, ctrl: ChatCtrl?` | Fetch the currently active user profile | [L841](../common/src/commonMain/kotlin/chat/simplex/common/model/SimpleXAPI.kt#L841) |
| `apiGetActiveUser` | `rh: Long?, ctrl: ChatCtrl?` | Fetch the currently active user profile | [L873](../common/src/commonMain/kotlin/chat/simplex/common/model/SimpleXAPI.kt#L873) |
| `apiCreateActiveUser` | `rh: Long?, p: Profile?, pastTimestamp: Boolean, keepActiveUser: Boolean, ctrl: ChatCtrl?` | Create a new user profile and set it as active, unless `keepActiveUser` | [L887](../common/src/commonMain/kotlin/chat/simplex/common/model/SimpleXAPI.kt#L887) |
| `listUsers` | `rh: Long?` | List all user profiles sorted by display name | [L871](../common/src/commonMain/kotlin/chat/simplex/common/model/SimpleXAPI.kt#L871) |
| `apiSetActiveUser` | `rh: Long?, userId: Long, viewPwd: String?` | Switch the active user to a different profile | [L881](../common/src/commonMain/kotlin/chat/simplex/common/model/SimpleXAPI.kt#L881) |
| `apiSetAllContactReceipts` | `rh: Long?, enable: Boolean` | Enable/disable delivery receipts for all contacts globally | [L888](../common/src/commonMain/kotlin/chat/simplex/common/model/SimpleXAPI.kt#L888) |
| `apiSetUserContactReceipts` | `u: User, userMsgReceiptSettings: UserMsgReceiptSettings` | Set delivery receipt settings for user contacts | [L894](../common/src/commonMain/kotlin/chat/simplex/common/model/SimpleXAPI.kt#L894) |
| `apiSetUserGroupReceipts` | `u: User, userMsgReceiptSettings: UserMsgReceiptSettings` | Set delivery receipt settings for user groups | [L900](../common/src/commonMain/kotlin/chat/simplex/common/model/SimpleXAPI.kt#L900) |
| `apiSetUserAutoAcceptMemberContacts` | `u: User, enable: Boolean` | Toggle auto-accept for member contact requests | [L906](../common/src/commonMain/kotlin/chat/simplex/common/model/SimpleXAPI.kt#L906) |
| `apiHideUser` | `u: User, viewPwd: String` | Hide a user profile behind a password | [L912](../common/src/commonMain/kotlin/chat/simplex/common/model/SimpleXAPI.kt#L912) |
| `apiUnhideUser` | `u: User, viewPwd: String` | Unhide a previously hidden user profile | [L915](../common/src/commonMain/kotlin/chat/simplex/common/model/SimpleXAPI.kt#L915) |
| `apiMuteUser` | `u: User` | Mute all notifications for a user profile | [L918](../common/src/commonMain/kotlin/chat/simplex/common/model/SimpleXAPI.kt#L918) |
| `apiUnmuteUser` | `u: User` | Unmute notifications for a user profile | [L921](../common/src/commonMain/kotlin/chat/simplex/common/model/SimpleXAPI.kt#L921) |
| `apiDeleteUser` | `u: User, delSMPQueues: Boolean, viewPwd: String?` | Delete a user profile and optionally its SMP queues | [L930](../common/src/commonMain/kotlin/chat/simplex/common/model/SimpleXAPI.kt#L930) |
| `apiUpdateProfile` | `rh: Long?, profile: Profile` | Update the active user's display profile | [L1682](../common/src/commonMain/kotlin/chat/simplex/common/model/SimpleXAPI.kt#L1682) |
| `apiSetProfileAddress` | `rh: Long?, on: Boolean` | Enable/disable including address in user profile | [L1694](../common/src/commonMain/kotlin/chat/simplex/common/model/SimpleXAPI.kt#L1694) |
| `apiSetUserUIThemes` | `rh: Long?, userId: Long, themes: ThemeModeOverrides?` | Set UI theme overrides for a user | [L1732](../common/src/commonMain/kotlin/chat/simplex/common/model/SimpleXAPI.kt#L1732) |
| `listUsers` | `rh: Long?` | List all user profiles sorted by display name | [L907](../common/src/commonMain/kotlin/chat/simplex/common/model/SimpleXAPI.kt#L907) |
| `apiSetActiveUser` | `rh: Long?, userId: Long, viewPwd: String?` | Switch the active user to a different profile | [L917](../common/src/commonMain/kotlin/chat/simplex/common/model/SimpleXAPI.kt#L917) |
| `apiSetAllContactReceipts` | `rh: Long?, enable: Boolean` | Enable/disable delivery receipts for all contacts globally | [L924](../common/src/commonMain/kotlin/chat/simplex/common/model/SimpleXAPI.kt#L924) |
| `apiSetUserContactReceipts` | `u: User, userMsgReceiptSettings: UserMsgReceiptSettings` | Set delivery receipt settings for user contacts | [L930](../common/src/commonMain/kotlin/chat/simplex/common/model/SimpleXAPI.kt#L930) |
| `apiSetUserGroupReceipts` | `u: User, userMsgReceiptSettings: UserMsgReceiptSettings` | Set delivery receipt settings for user groups | [L936](../common/src/commonMain/kotlin/chat/simplex/common/model/SimpleXAPI.kt#L936) |
| `apiSetUserAutoAcceptMemberContacts` | `u: User, enable: Boolean` | Toggle auto-accept for member contact requests | [L942](../common/src/commonMain/kotlin/chat/simplex/common/model/SimpleXAPI.kt#L942) |
| `apiHideUser` | `u: User, viewPwd: String` | Hide a user profile behind a password | [L948](../common/src/commonMain/kotlin/chat/simplex/common/model/SimpleXAPI.kt#L948) |
| `apiUnhideUser` | `u: User, viewPwd: String` | Unhide a previously hidden user profile | [L951](../common/src/commonMain/kotlin/chat/simplex/common/model/SimpleXAPI.kt#L951) |
| `apiMuteUser` | `u: User` | Mute all notifications for a user profile | [L954](../common/src/commonMain/kotlin/chat/simplex/common/model/SimpleXAPI.kt#L954) |
| `apiUnmuteUser` | `u: User` | Unmute notifications for a user profile | [L957](../common/src/commonMain/kotlin/chat/simplex/common/model/SimpleXAPI.kt#L957) |
| `apiDeleteUser` | `u: User, delSMPQueues: Boolean, viewPwd: String?` | Delete a user profile and optionally its SMP queues | [L966](../common/src/commonMain/kotlin/chat/simplex/common/model/SimpleXAPI.kt#L966) |
| `apiUpdateProfile` | `rh: Long?, profile: Profile` | Update the active user's display profile | [L1823](../common/src/commonMain/kotlin/chat/simplex/common/model/SimpleXAPI.kt#L1823) |
| `apiSetProfileAddress` | `rh: Long?, on: Boolean` | Enable/disable including address in user profile | [L1835](../common/src/commonMain/kotlin/chat/simplex/common/model/SimpleXAPI.kt#L1835) |
| `apiSetUserUIThemes` | `rh: Long?, userId: Long, themes: ThemeModeOverrides?` | Set UI theme overrides for a user | [L1905](../common/src/commonMain/kotlin/chat/simplex/common/model/SimpleXAPI.kt#L1905) |
### 2.2 Chat Lifecycle
plans/2026-07-30-new-profile-for-invitation.md
+32
View File
@@ -496,3 +496,35 @@ Also fixed in the same round, pre-existing and adjacent (like §9):
`profileSwitchStatus` directly. It is the exact twin of the `apiChangeConnectionUser`
-returns-nil case this branch already fixes, so it got the same `else`: reset the status
and roll the toggle back.
## 10. "The failed move is silent" — raised repeatedly, and not accurate
Review has flagged three times that `if (updatedConn == null) return` in `selectProfileAsync`
(and its iOS twin, and `changeProfileTo`'s `chatMoved` gate) leaves the user with a created
profile, an unmoved invitation and no message. The premise is wrong, and it is worth
recording why so the fourth reviewer does not re-derive it.
`apiChangeConnectionUser` returns null on exactly two paths:
- **An error came back.** `sendCmdWithRetry` asks `retryableNetworkErrorAlert`; for a
retryable one — `BROKER TIMEOUT`, `BROKER NETWORK`, the SMP cases — it shows a **retry
dialog**, which is what an offline device gets. For anything else it returns the error to
`apiChangeConnectionUser`, which alerts through `networkErrorAlert` or `apiErrorAlert`.
Either way the user is told.
- **The user cancelled that retry dialog** (or the coroutine was cancelled). Nothing further
is shown — because they just declined it themselves.
So the "offline, nothing happens" scenario does not exist: offline produces the retry
dialog. `changeProfileTo` is the same shape — `apiChangePrepared*User` alerts on failure,
which is why the code comment says the switch is skipped rather than reported again.
The state left behind is also recoverable, deliberately. The profile is registered in
`chatModel.users` before either early return (§8), and both pickers **stay open** on
failure, so the new profile is present as a row and tapping it retries the move through the
normal path. Adding another alert here would stack a second dialog on top of the one the
user just dismissed — the mistake fixed once already in this branch, where
`changeActiveUser` and the caller both reported the same failure.
What *is* true: pressing "Add profile" a second time with the same name fails as a
duplicate. That is the core refusing to create a profile that already exists, and the fix
is to tap the row rather than recreate it.