@@ -44,7 +44,7 @@ Open-source, self-hosted note-taking tool built for quick capture. Markdown-nati
[**SSD Nodes** - Affordable VPS hosting for self-hosters](https://ssdnodes.com/?utm_source=memos&utm_medium=sponsor)
-
+
diff --git a/docs/issues/2026-03-24-user-resource-identifiers/definition.md b/docs/issues/2026-03-24-user-resource-identifiers/definition.md
new file mode 100644
index 000000000..2a822909c
--- /dev/null
+++ b/docs/issues/2026-03-24-user-resource-identifiers/definition.md
@@ -0,0 +1,41 @@
+## Background & Context
+
+User resources in Memos v1 are exposed through Connect/gRPC-Gateway handlers in `server/router/api/v1`, proto resource definitions in `proto/api/v1`, frontend profile flows in `web/src`, and MCP JSON helpers in `server/router/mcp`. The store schema already persists both an internal integer `id` and a unique `username` for each user. The GitHub issue reports that public user resource names such as `users/2` are still emitted across responses and nested user-scoped resources. Existing code already mixes identifier forms: `GetUser` accepts either `users/{id}` or `users/{username}`, the fileserver avatar route accepts either identifier, and the frontend profile page already enters the API through `users/{username}` before reusing the returned `user.name`.
+
+## Issue Statement
+
+Across the v1 API surface, canonical user resource names are currently constructed from `store.User.ID` rather than `store.User.Username`, and many handlers parse those emitted names back into integers for authorization and lookup. As a result, top-level user resources and nested user-scoped references in settings, stats, shortcuts, webhooks, notifications, memo creators, reactions, and MCP payloads expose sequential database IDs and couple downstream callers to integer-based user tokens in server-emitted names.
+
+## Current State
+
+- `store/user.go:26-42` defines `store.User` with both `ID int32` and `Username string`; `store/migration/sqlite/LATEST.sql:10-21` declares `username TEXT NOT NULL UNIQUE`.
+- `server/router/api/v1/user_service.go:72-102` handles `GetUser` by extracting `users/{id_or_username}` and resolving either a numeric ID or a username; `server/router/api/v1/user_service.go:914-937` still serializes `User.name` as `users/{id}` and derives avatar URLs from that name.
+- `server/router/api/v1/resource_name.go:67-89` has two different parsing paths: `ExtractUserIDFromName` only accepts numeric user tokens, while `extractUserIdentifierFromName` accepts either token and is currently only used by `GetUser`.
+- `server/router/api/v1/user_service.go:335-369`, `server/router/api/v1/user_service.go:372-460`, `server/router/api/v1/user_service.go:463-517`, `server/router/api/v1/user_service.go:536-676`, `server/router/api/v1/user_service.go:679-911`, and `server/router/api/v1/user_service.go:1400-1488` parse numeric user segments for settings, personal access tokens, webhooks, and notifications, and emit names such as `users/%d/settings/...`, `users/%d/webhooks/...`, and `users/%d/notifications/%d`.
+- `server/router/api/v1/shortcut_service.go:20-43` parses `users/{user}/shortcuts/{shortcut}` by converting the `user` segment to `int32`, and constructs shortcut names as `users/%d/shortcuts/%s`.
+- `server/router/api/v1/user_service_stats.go:63-65`, `server/router/api/v1/user_service_stats.go:113`, `server/router/api/v1/user_service_stats.go:132-145`, `server/router/api/v1/user_service_stats.go:214-223` emit `users/%d/stats` and `users/%d/memos/%d`, and resolve stats requests through numeric `ExtractUserIDFromName`.
+- `server/router/api/v1/memo_service_converter.go:26-37` serializes `Memo.creator` as `users/{id}`; `server/router/api/v1/reaction_service.go:154-164` serializes `Reaction.creator` as `users/{id}`; `server/router/api/v1/memo_service.go:636-643` and `server/router/api/v1/memo_service.go:815-845` parse `memo.Creator` through the numeric helper for inbox and webhook flows.
+- `server/router/mcp/tools_memo.go:75-86`, `server/router/mcp/tools_attachment.go:29-37`, and `server/router/mcp/tools_reaction.go:64-71` plus `server/router/mcp/tools_reaction.go:133-138` serialize creator fields as `users/{id}` in MCP tool output.
+- `server/router/fileserver/fileserver.go:153-181` and `server/router/fileserver/fileserver.go:533-539` currently resolve avatar requests by either numeric ID or username.
+- `proto/api/v1/user_service.proto:22-29` and `proto/api/v1/user_service.proto:247-256` document `GetUser` accepting both `users/{id}` and `users/{username}`. The same proto file defines the `User` resource at `proto/api/v1/user_service.proto:161-178` and nested user resource formats at `proto/api/v1/user_service.proto:307-317` and `proto/api/v1/user_service.proto:361-373`; example text still uses numeric user tokens such as `users/123/settings/GENERAL`.
+- `web/src/pages/UserProfile.tsx:74-86` requests `users/{username}` from the route param, and `web/src/layouts/MainLayout.tsx:37-48` stores the returned canonical `user.name` for later stats requests.
+
+## Non-Goals
+
+- Replacing internal `user.id` primary keys, foreign keys, or existing store schemas.
+- Introducing a new opaque UUID-based public user identifier.
+- Changing user discovery, public profile visibility, or authorization rules beyond how user resource names are parsed and emitted.
+- Adding username history, redirect, or alias preservation for old usernames after a rename.
+- Redesigning unrelated resource naming schemes such as memo, attachment, share, or identity-provider identifiers.
+
+## Open Questions
+
+- Which public surfaces are in scope for username-based canonical output? (default: all server-emitted v1 API and MCP payload fields that currently contain `users/{...}` resource names)
+- Should legacy numeric inputs continue to resolve on user-scoped endpoints beyond `GetUser`? (default: no, accept only username-based user resource names)
+- If a username changes, must previously emitted `users/{old-username}` names continue to resolve? (default: no additional alias or redirect layer; only the current username remains valid)
+- Should notification, webhook, shortcut, and personal-access-token child identifiers keep their existing child token formats while only the parent user token changes? (default: yes)
+- Does the issue include avatar URLs and other derived file paths that are built from `User.name`? (default: yes, because avatar URLs are emitted from the same canonical user name field)
+
+## Scope
+
+**L** — Current behavior spans `server/router/api/v1`, `server/router/mcp`, `server/router/fileserver`, `proto/api/v1`, frontend consumers in `web/src`, and the request parsers that turn user resource names back into internal IDs. Changing both emitted and accepted user resource names across those surfaces is a broad API contract change rather than a single local edit.
diff --git a/docs/issues/2026-03-24-user-resource-identifiers/design.md b/docs/issues/2026-03-24-user-resource-identifiers/design.md
new file mode 100644
index 000000000..f51a5120e
--- /dev/null
+++ b/docs/issues/2026-03-24-user-resource-identifiers/design.md
@@ -0,0 +1,63 @@
+## References
+
+- [AIP-122: Resource names](https://google.aip.dev/122)
+- [AIP-123: Resource types](https://google.aip.dev/123)
+- [AIP-148: Standard fields](https://google.aip.dev/148)
+- [AIP-180: Backwards compatibility](https://google.aip.dev/180)
+- [Insecure Direct Object Reference Prevention Cheat Sheet](https://cheatsheetseries.owasp.org/cheatsheets/Insecure_Direct_Object_Reference_Prevention_Cheat_Sheet.html)
+- [REST API endpoints for users - GitHub Docs](https://docs.github.com/en/enterprise-server%403.19/rest/users/users)
+- [Users API - GitLab Docs](https://docs.gitlab.com/api/users/)
+- [API Usage - Gitea Documentation](https://docs.gitea.com/next/development/api-usage)
+
+## Industry Baseline
+
+`AIP-122: Resource names` and `AIP-148: Standard fields` treat `name` as the canonical identifier that clients store and reuse, and expect request `name` and `parent` fields to accept the same resource-name vocabulary across a service. `AIP-122` also allows aliases for lookup, but requires responses to emit the canonical resource name.
+
+`REST API endpoints for users - GitHub Docs` and `API Usage - Gitea Documentation` use username-based public user paths and nested user-scoped routes, while keeping numeric or system-assigned identifiers as separate data or alternate endpoints when a durable internal identifier is required.
+
+`Users API - GitLab Docs` shows a mixed-input compatibility pattern on some endpoints with `id_or_username`, which keeps older callers working while allowing username-oriented public routes.
+
+`Insecure Direct Object Reference Prevention Cheat Sheet` treats enumerable numeric identifiers as a defense-in-depth concern, but not a substitute for authorization. Replacing `users/{id}` with `users/{username}` changes discoverability characteristics, but permission checks still have to enforce access from internal user IDs.
+
+`AIP-180: Backwards compatibility` treats changes to resource-name format and server-generated field construction as breaking. Any design that changes emitted `User.name` values inside `v1` has to preserve as much request compatibility as possible and document the remaining response-format risk explicitly.
+
+## Research Summary
+
+Memos already has most of the prerequisites for username-based canonical names. The schema stores a unique username, `GetUser` already resolves either ID or username, the fileserver avatar route already uses an `identifier` abstraction, and the frontend profile page already starts from `users/{username}`. No database migration is required to identify users by username at the API boundary.
+
+The current coupling problem is concentrated in two places. First, response builders serialize `users/{id}` in many modules, including memo conversion, stats, settings, shortcuts, notifications, webhooks, and MCP JSON helpers. Second, many request handlers assume they can parse a numeric ID back out of those names for authorization and storage lookups.
+
+Research points to a common pattern of canonical public resource names plus server-side resolution to internal IDs. In Memos, switching the canonical token from numeric ID to username can reuse the existing unique username column and existing username lookups, but `AIP-123: Resource types` and `AIP-180: Backwards compatibility` still make clear that changing accepted and emitted resource-name formats inside `v1` is a breaking API contract change. That makes this design a deliberate contract replacement rather than a compatibility layer.
+
+## Design Goals
+
+- All server-emitted v1 and MCP response fields that serialize user resource names under `users/{...}` use the current username token instead of the numeric database ID.
+- User-scoped request fields that reference `users/{...}` accept username-based resource names only.
+- Authorization, ownership checks, inbox/webhook dispatch, and other internal workflows continue to operate on `store.User.ID` after resolving the public resource name.
+- List and batch endpoints avoid introducing per-item user lookups when serializing username-based names.
+- No database schema, foreign-key, or storage-key redesign is required.
+
+## Non-Goals
+
+- Replacing internal `user.id` primary keys, foreign keys, or existing store schemas.
+- Introducing a new opaque UUID-based public user identifier.
+- Changing user discovery, public profile visibility, or authorization rules beyond how user resource names are parsed and emitted.
+- Adding username history, redirect, or alias preservation for old usernames after a rename.
+- Redesigning unrelated resource naming schemes such as memo, attachment, share, or identity-provider identifiers.
+- Adding a new API version as part of this issue.
+
+## Proposed Design
+
+Introduce a single canonical user-name builder in the v1 API layer that serializes `users/{username}` from resolved user data, and route every public user-name emitter through it. This includes `convertUserFromStore`, memo and reaction creator fields, user stats, settings, shortcuts, webhooks, notifications, personal-access-token names, webhook payloads, avatar URLs derived from `User.name`, and the MCP JSON helpers. This satisfies the first design goal and aligns the public resource shape with `AIP-122: Resource names`.
+
+Introduce a shared user-token resolver in `server/router/api/v1` that extracts the `users/{token}` segment, validates it as a username-form resource token, resolves the corresponding `store.User`, and then passes the resolved internal ID into permission checks and storage lookups. This replaces numeric-only parsing in helpers such as `ExtractUserIDFromName`, `ExtractUserIDAndSettingKeyFromName`, shortcut and webhook parsers, personal-access-token deletion, and notification parsing. The fileserver's current `getUserByIdentifier` behavior shows both lookup styles exist today, but the API-layer contract for this issue becomes username-only rather than dual-mode.
+
+Keep child resource tokens unchanged and only change the user segment. For names such as `users/{user}/settings/{setting}`, `users/{user}/webhooks/{webhook}`, `users/{user}/notifications/{notification}`, `users/{user}/shortcuts/{shortcut}`, and `users/{user}/personalAccessTokens/{token}`, the parent `user` token is resolved from the username, while the child token keeps its existing format and storage mapping. This is narrower than redesigning child identifiers and keeps the issue bounded to the user-resource segment.
+
+Use response-side user resolution strategies that match endpoint shape. Single-resource handlers can resolve one user directly and serialize the username immediately. List and batch handlers such as memo conversion, stats aggregation, notifications, and MCP list output should collect distinct user IDs first and resolve usernames once per response, reusing the store's existing user lookup path and cache where available. This keeps username-based output from turning into hidden N+1 query behavior and satisfies the performance goal without changing persistence.
+
+Replace the public user-resource contract rather than extending it. Server-emitted `name`, `parent`, `creator`, and `sender` fields become username-based canonical output, and handlers that currently accept `users/{id}` are updated to require `users/{username}`. `AIP-180: Backwards compatibility` indicates that changing both the construction and accepted format of an existing resource name is a breaking change for clients that persist, compare, or generate old `name` values. The design therefore requires updated proto comments, API examples, handler tests, and release notes to make the new canonical form and the removed numeric form explicit.
+
+Do not add a username alias table in this issue. If a username changes, newly serialized resource names use the current username, and previously emitted username-based names stop resolving unless they match the current username. This keeps the scope aligned with existing `UpdateUser` behavior and avoids introducing a new subsystem for historical username resolution. The alternative of adding permanent old-username aliases was rejected because it expands the problem from canonical serialization into identity-history management.
+
+Do not solve this by adding a second public identifier field and leaving `User.name` numeric. `AIP-122: Resource names` treats `name` as the canonical resource identifier, and the GitHub issue is specifically about the public names currently emitted under `users/{id}`. Adding a second field would preserve the exposed sequential identifier in the canonical slot and fail the primary design goal. Likewise, introducing a new opaque UUID-based public identifier was rejected because the repository already has a unique username field and the issue is scoped to replacing numeric user resource names with that existing identifier.
diff --git a/docs/issues/2026-03-24-user-resource-identifiers/execution.md b/docs/issues/2026-03-24-user-resource-identifiers/execution.md
new file mode 100644
index 000000000..d635d7397
--- /dev/null
+++ b/docs/issues/2026-03-24-user-resource-identifiers/execution.md
@@ -0,0 +1,62 @@
+## Execution Log
+
+### T1: Add username-only user resource helpers
+
+**Status**: Completed
+**Files Changed**:
+- `server/router/api/v1/user_resource_name.go`
+- `server/router/api/v1/resource_name.go`
+- `server/router/api/v1/user_service.go`
+- `server/router/api/v1/test/user_resource_name_test.go`
+**Validation**: `go test -v ./server/router/api/v1/test -run 'TestUserResourceName'` — PASS
+**Path Corrections**: Tightened username-token validation so numeric-only `users/1` fails at the resource-name layer instead of falling through to `NotFound`.
+**Deviations**: None
+
+### T2: Migrate user-scoped API handlers
+
+**Status**: Completed
+**Files Changed**:
+- `server/router/api/v1/user_service.go`
+- `server/router/api/v1/shortcut_service.go`
+- `server/router/api/v1/user_service_stats.go`
+- `server/router/api/v1/test/shortcut_service_test.go`
+- `server/router/api/v1/test/user_service_stats_test.go`
+- `server/router/api/v1/test/user_notification_test.go`
+- `server/router/api/v1/test/user_service_registration_test.go`
+**Validation**: `go test -v ./server/router/api/v1/test -run 'Test(ListShortcuts|GetShortcut|CreateShortcut|UpdateShortcut|DeleteShortcut|ShortcutFiltering|ShortcutCRUDComplete|GetUserStats_TagCount|ListUserNotifications|UserRegistration)'` — PASS
+**Path Corrections**: Updated test fixtures to use valid username-form resource names (`users/testuser`, `users/test-user`) and corrected one stale registration-name expectation during the later broader suite rerun.
+**Deviations**: None
+
+### T3: Migrate memo, reaction, MCP, and avatar user references
+
+**Status**: Completed
+**Files Changed**:
+- `server/router/api/v1/memo_service_converter.go`
+- `server/router/api/v1/memo_service.go`
+- `server/router/api/v1/reaction_service.go`
+- `server/router/mcp/tools_memo.go`
+- `server/router/mcp/tools_attachment.go`
+- `server/router/mcp/tools_reaction.go`
+- `server/router/fileserver/fileserver.go`
+- `server/router/api/v1/test/memo_service_test.go`
+- `server/router/api/v1/test/reaction_service_test.go`
+**Validation**: `go test ./server/router/api/v1/... ./server/router/mcp/... ./server/router/fileserver/...` — PASS
+**Path Corrections**: Removed an unused fileserver import after the first package build failed; kept MCP tool helper signatures stable for undeclared callers and switched tool call sites to username-aware wrappers.
+**Deviations**: None
+
+### T4: Update contract docs and regression tests
+
+**Status**: Completed
+**Files Changed**:
+- `proto/api/v1/user_service.proto`
+- `proto/api/v1/shortcut_service.proto`
+- `web/src/layouts/MainLayout.tsx`
+- `web/src/components/MemoExplorer/ShortcutsSection.tsx`
+- `server/router/fileserver/README.md`
+**Validation**: `go test -v ./server/router/api/v1/test/...` — PASS
+**Path Corrections**: None
+**Deviations**: None
+
+## Completion Declaration
+
+All tasks completed successfully
diff --git a/docs/issues/2026-03-24-user-resource-identifiers/plan.md b/docs/issues/2026-03-24-user-resource-identifiers/plan.md
new file mode 100644
index 000000000..cee94a289
--- /dev/null
+++ b/docs/issues/2026-03-24-user-resource-identifiers/plan.md
@@ -0,0 +1,106 @@
+## Task List
+
+Task Index
+T1: Add username-only user resource helpers [L] — T2: Migrate user-scoped API handlers [L] — T3: Migrate memo, reaction, MCP, and avatar user references [L] — T4: Update contract docs and regression tests [L]
+
+### T1: Add username-only user resource helpers [L]
+
+**Objective**: Establish one v1 API mechanism for serializing `users/{username}` and resolving username-based user resource names back to internal user records, including root `GetUser` handling.
+**Size**: L (multiple files, shared identifier logic used across handlers)
+**Files**:
+- Create: `server/router/api/v1/user_resource_name.go`
+- Modify: `server/router/api/v1/resource_name.go`
+- Modify: `server/router/api/v1/user_service.go`
+- Test: `server/router/api/v1/test/user_resource_name_test.go`
+**Implementation**:
+1. In `server/router/api/v1/user_resource_name.go`: add the shared helper surface for canonical user-name construction, extracting the `users/{token}` segment, validating the username-form token, and resolving the corresponding `store.User`.
+2. In `server/router/api/v1/resource_name.go`: replace `ExtractUserIDFromName()`’s numeric-only behavior with username-oriented resolution helpers or thin wrappers that delegate to the new shared module.
+3. In `server/router/api/v1/user_service.go`: update `GetUser()` (~lines 72-102) and `convertUserFromStore()` (~lines 914-937) to use username-only resource names and reject legacy numeric `users/{id}` requests.
+4. In `server/router/api/v1/test/user_resource_name_test.go`: add direct coverage for `GetUser users/{username}` success, canonical `User.name == users/{username}`, and rejection of `users/{id}`.
+**Boundaries**: Do not migrate nested user-scoped handlers, memo/reaction emitters, MCP output, or fileserver behavior in this task.
+**Dependencies**: None
+**Expected Outcome**: Shared username-only helper logic exists, root user resources serialize as `users/{username}`, and root numeric user-name requests fail.
+**Validation**: `go test -v ./server/router/api/v1/test -run 'TestUserResourceName'` — expected output includes `PASS` and `ok`
+
+### T2: Migrate user-scoped API handlers [L]
+
+**Objective**: Convert user-scoped v1 handlers and nested resource emitters to require `users/{username}` while continuing to authorize and store by resolved internal user ID.
+**Size**: L (multiple handlers in one large service plus shortcut and stats code)
+**Files**:
+- Modify: `server/router/api/v1/user_service.go`
+- Modify: `server/router/api/v1/shortcut_service.go`
+- Modify: `server/router/api/v1/user_service_stats.go`
+- Test: `server/router/api/v1/test/shortcut_service_test.go`
+- Test: `server/router/api/v1/test/user_service_stats_test.go`
+- Test: `server/router/api/v1/test/user_notification_test.go`
+- Test: `server/router/api/v1/test/user_service_registration_test.go`
+**Implementation**:
+1. In `server/router/api/v1/user_service.go`: update settings, PAT, webhook, and notification parsing/emission paths (~lines 335-911 and ~1400-1488) to resolve `users/{username}` and emit username-based parent/child resource names.
+2. In `server/router/api/v1/shortcut_service.go`: update shortcut name parsing and construction (~lines 20-43) plus handler entry points to use username parents and nested names.
+3. In `server/router/api/v1/user_service_stats.go`: update stats request parsing and `UserStats.name` / `PinnedMemos` serialization (~lines 63-65, 113, 132-145, 214-223) to use usernames.
+4. In the listed tests: replace numeric user-name inputs with username-based parents, assert username-based emitted names, and add numeric-request rejection coverage for representative user-scoped endpoints.
+**Boundaries**: Do not change memo/reaction creator fields, MCP JSON output, or fileserver avatar routing in this task.
+**Dependencies**: T1
+**Expected Outcome**: User settings, notifications, shortcuts, stats, PATs, and webhooks all accept only `users/{username}` and emit only username-based user resource names.
+**Validation**: `go test -v ./server/router/api/v1/test -run 'Test(ListShortcuts|GetShortcut|CreateShortcut|UpdateShortcut|DeleteShortcut|ShortcutFiltering|ShortcutCRUDComplete|GetUserStats_TagCount|ListUserNotifications|UserRegistration)'` — expected output includes `PASS` and `ok`
+
+### T3: Migrate memo, reaction, MCP, and avatar user references [L]
+
+**Objective**: Remove numeric user resource names from memo/reaction-related API responses, dependent webhook/inbox flows, MCP JSON output, and avatar URLs/routing.
+**Size**: L (cross-package serialization and lookup changes, including response-side user resolution)
+**Files**:
+- Modify: `server/router/api/v1/memo_service_converter.go`
+- Modify: `server/router/api/v1/memo_service.go`
+- Modify: `server/router/api/v1/reaction_service.go`
+- Modify: `server/router/mcp/tools_memo.go`
+- Modify: `server/router/mcp/tools_attachment.go`
+- Modify: `server/router/mcp/tools_reaction.go`
+- Modify: `server/router/fileserver/fileserver.go`
+- Test: `server/router/api/v1/test/memo_service_test.go`
+- Test: `server/router/api/v1/test/reaction_service_test.go`
+**Implementation**:
+1. In `server/router/api/v1/memo_service_converter.go`: update `convertMemoFromStore()` (~lines 16-73) to serialize `Memo.creator` from resolved usernames rather than numeric IDs, using response-side batching or shared lookup helpers so list responses do not regress into hidden per-item lookups.
+2. In `server/router/api/v1/reaction_service.go`: update `convertReactionFromStore()` (~lines 154-164) to emit username-based creators.
+3. In `server/router/api/v1/memo_service.go`: update memo comment, webhook dispatch, and webhook payload helpers (~lines 636-643 and 815-845) to resolve username-based memo creators before using internal IDs.
+4. In `server/router/mcp/tools_memo.go`, `server/router/mcp/tools_attachment.go`, and `server/router/mcp/tools_reaction.go`: replace `users/%d` creator serialization with username-based values.
+5. In `server/router/fileserver/fileserver.go`: change avatar lookup to accept username identifiers only and ensure avatar URLs derived from `User.name` continue to resolve under `users/{username}`.
+6. In the listed tests: update creator assertions to `users/{username}` and add representative rejection coverage where numeric user names previously flowed through memo/reaction-related paths.
+**Boundaries**: Do not update proto comments, README examples, or frontend comments in this task.
+**Dependencies**: T1
+**Expected Outcome**: Memo/reaction creators, webhook payload creators, MCP creator fields, and avatar-derived user paths no longer expose numeric user IDs.
+**Validation**: `go test ./server/router/api/v1/... ./server/router/mcp/... ./server/router/fileserver/...` — expected output includes `ok` for all touched packages
+
+### T4: Update contract docs and regression tests [L]
+
+**Objective**: Align public contract comments/examples and the final regression suite with the username-only user resource-name contract.
+**Size**: L (multiple contract/documentation files plus end-to-end regression coverage)
+**Files**:
+- Modify: `proto/api/v1/user_service.proto`
+- Modify: `proto/api/v1/shortcut_service.proto`
+- Modify: `web/src/layouts/MainLayout.tsx`
+- Modify: `web/src/components/MemoExplorer/ShortcutsSection.tsx`
+- Modify: `server/router/fileserver/README.md`
+- Modify: `server/router/api/v1/test/user_resource_name_test.go`
+- Modify: `server/router/api/v1/test/shortcut_service_test.go`
+- Modify: `server/router/api/v1/test/user_service_stats_test.go`
+- Modify: `server/router/api/v1/test/user_notification_test.go`
+- Modify: `server/router/api/v1/test/memo_service_test.go`
+- Modify: `server/router/api/v1/test/reaction_service_test.go`
+- Modify: `server/router/api/v1/test/user_service_registration_test.go`
+**Implementation**:
+1. In `proto/api/v1/user_service.proto` and `proto/api/v1/shortcut_service.proto`: rewrite resource-name comments and examples so they document username-only user resource names and remove `users/{id}` examples.
+2. In `web/src/layouts/MainLayout.tsx` and `web/src/components/MemoExplorer/ShortcutsSection.tsx`: update inline comments/examples that still describe numeric user resource names.
+3. In `server/router/fileserver/README.md`: replace numeric avatar examples with username-based examples.
+4. In the listed test files: finish any remaining request/response assertions so the suite consistently encodes the username-only contract and explicitly rejects numeric user resource names where that contract is externally visible.
+**Boundaries**: Do not add schema migrations, generated proto output refreshes, or username-history behavior.
+**Dependencies**: T2, T3
+**Expected Outcome**: Source comments, examples, and regression tests all describe and enforce a username-only `users/{username}` public contract.
+**Validation**: `go test -v ./server/router/api/v1/test/...` — expected output includes `PASS` and `ok`
+
+## Out-of-Scope Tasks
+
+- Database schema or migration changes for the `user` table or foreign keys.
+- Username history, alias, redirect, or backward-compatibility layers.
+- A new opaque public user identifier or a new API version.
+- Opportunistic refactors outside the files listed above.
+- Generated code refreshes (`buf generate`) unless a later approved plan revision explicitly requires schema changes.
diff --git a/plugin/filter/README.md b/plugin/filter/README.md
index 35961615f..ac1aec4b6 100644
--- a/plugin/filter/README.md
+++ b/plugin/filter/README.md
@@ -1,12 +1,14 @@
# Memo Filter Engine
-This package houses the memo-only filter engine that turns CEL expressions into
-SQL fragments. The engine follows a three phase pipeline inspired by systems
+This package houses the memo-only filter engine that turns standard CEL syntax
+into SQL fragments for the subset of expressions supported by the memo schema.
+The engine follows a three phase pipeline inspired by systems
such as Calcite or Prisma:
1. **Parsing** – CEL expressions are parsed with `cel-go` and validated against
the memo-specific environment declared in `schema.go`. Only fields that
- exist in the schema can surface in the filter.
+ exist in the schema can surface in the filter, and non-standard legacy
+ coercions are rejected.
2. **Normalization** – the raw CEL AST is converted into an intermediate
representation (IR) defined in `ir.go`. The IR is a dialect-agnostic tree of
conditions (logical operators, comparisons, list membership, etc.). This
diff --git a/plugin/filter/engine.go b/plugin/filter/engine.go
index c9fcfba7f..9dab7a0ba 100644
--- a/plugin/filter/engine.go
+++ b/plugin/filter/engine.go
@@ -2,7 +2,6 @@ package filter
import (
"context"
- "fmt"
"strings"
"sync"
@@ -45,8 +44,6 @@ func (e *Engine) Compile(_ context.Context, filter string) (*Program, error) {
return nil, errors.New("filter expression is empty")
}
- filter = normalizeLegacyFilter(filter)
-
ast, issues := e.env.Compile(filter)
if issues != nil && issues.Err() != nil {
return nil, errors.Wrap(issues.Err(), "failed to compile filter")
@@ -119,73 +116,3 @@ func DefaultAttachmentEngine() (*Engine, error) {
})
return defaultAttachmentInst, defaultAttachmentErr
}
-
-func normalizeLegacyFilter(expr string) string {
- expr = rewriteNumericLogicalOperand(expr, "&&")
- expr = rewriteNumericLogicalOperand(expr, "||")
- return expr
-}
-
-func rewriteNumericLogicalOperand(expr, op string) string {
- var builder strings.Builder
- n := len(expr)
- i := 0
- var inQuote rune
-
- for i < n {
- ch := expr[i]
-
- if inQuote != 0 {
- builder.WriteByte(ch)
- if ch == '\\' && i+1 < n {
- builder.WriteByte(expr[i+1])
- i += 2
- continue
- }
- if ch == byte(inQuote) {
- inQuote = 0
- }
- i++
- continue
- }
-
- if ch == '\'' || ch == '"' {
- inQuote = rune(ch)
- builder.WriteByte(ch)
- i++
- continue
- }
-
- if strings.HasPrefix(expr[i:], op) {
- builder.WriteString(op)
- i += len(op)
-
- // Preserve whitespace following the operator.
- wsStart := i
- for i < n && (expr[i] == ' ' || expr[i] == '\t') {
- i++
- }
- builder.WriteString(expr[wsStart:i])
-
- signStart := i
- if i < n && (expr[i] == '+' || expr[i] == '-') {
- i++
- }
- for i < n && expr[i] >= '0' && expr[i] <= '9' {
- i++
- }
- if i > signStart {
- numLiteral := expr[signStart:i]
- fmt.Fprintf(&builder, "(%s != 0)", numLiteral)
- } else {
- builder.WriteString(expr[signStart:i])
- }
- continue
- }
-
- builder.WriteByte(ch)
- i++
- }
-
- return builder.String()
-}
diff --git a/plugin/filter/engine_test.go b/plugin/filter/engine_test.go
new file mode 100644
index 000000000..f9e72c224
--- /dev/null
+++ b/plugin/filter/engine_test.go
@@ -0,0 +1,39 @@
+package filter
+
+import (
+ "context"
+ "testing"
+
+ "github.com/stretchr/testify/require"
+)
+
+func TestCompileAcceptsStandardTagEqualityPredicate(t *testing.T) {
+ t.Parallel()
+
+ engine, err := NewEngine(NewSchema())
+ require.NoError(t, err)
+
+ _, err = engine.Compile(context.Background(), `tags.exists(t, t == "1231")`)
+ require.NoError(t, err)
+}
+
+func TestCompileRejectsLegacyNumericLogicalOperand(t *testing.T) {
+ t.Parallel()
+
+ engine, err := NewEngine(NewSchema())
+ require.NoError(t, err)
+
+ _, err = engine.Compile(context.Background(), `pinned && 1`)
+ require.Error(t, err)
+ require.Contains(t, err.Error(), "failed to compile filter")
+}
+
+func TestCompileRejectsNonBooleanTopLevelConstant(t *testing.T) {
+ t.Parallel()
+
+ engine, err := NewEngine(NewSchema())
+ require.NoError(t, err)
+
+ _, err = engine.Compile(context.Background(), `1`)
+ require.EqualError(t, err, "filter must evaluate to a boolean value")
+}
diff --git a/plugin/filter/ir.go b/plugin/filter/ir.go
index 10cb13df1..b5a995dda 100644
--- a/plugin/filter/ir.go
+++ b/plugin/filter/ir.go
@@ -157,3 +157,10 @@ type ContainsPredicate struct {
}
func (*ContainsPredicate) isPredicateExpr() {}
+
+// EqualsPredicate represents t == "value".
+type EqualsPredicate struct {
+ Value string
+}
+
+func (*EqualsPredicate) isPredicateExpr() {}
diff --git a/plugin/filter/parser.go b/plugin/filter/parser.go
index 36e52d1db..2aff1074e 100644
--- a/plugin/filter/parser.go
+++ b/plugin/filter/parser.go
@@ -16,16 +16,10 @@ func buildCondition(expr *exprv1.Expr, schema Schema) (Condition, error) {
if err != nil {
return nil, err
}
- switch v := val.(type) {
- case bool:
+ if v, ok := val.(bool); ok {
return &ConstantCondition{Value: v}, nil
- case int64:
- return &ConstantCondition{Value: v != 0}, nil
- case float64:
- return &ConstantCondition{Value: v != 0}, nil
- default:
- return nil, errors.New("filter must evaluate to a boolean value")
}
+ return nil, errors.New("filter must evaluate to a boolean value")
case *exprv1.Expr_IdentExpr:
name := v.IdentExpr.GetName()
field, ok := schema.Field(name)
@@ -504,6 +498,8 @@ func extractPredicate(comp *exprv1.Expr_Comprehension, _ Schema) (PredicateExpr,
// Handle different predicate functions
switch predicateCall.Function {
+ case "_==_":
+ return buildEqualsPredicate(predicateCall, comp.IterVar)
case "startsWith":
return buildStartsWithPredicate(predicateCall, comp.IterVar)
case "endsWith":
@@ -511,10 +507,44 @@ func extractPredicate(comp *exprv1.Expr_Comprehension, _ Schema) (PredicateExpr,
case "contains":
return buildContainsPredicate(predicateCall, comp.IterVar)
default:
- return nil, errors.Errorf("unsupported predicate function %q in comprehension (supported: startsWith, endsWith, contains)", predicateCall.Function)
+ return nil, errors.Errorf(`unsupported predicate function %q in comprehension (supported: ==, startsWith, endsWith, contains)`, predicateCall.Function)
}
}
+// buildEqualsPredicate extracts the value from t == "value".
+func buildEqualsPredicate(call *exprv1.Expr_Call, iterVar string) (PredicateExpr, error) {
+ if len(call.Args) != 2 {
+ return nil, errors.New("equality predicate expects exactly two arguments")
+ }
+
+ var constExpr *exprv1.Expr
+ switch {
+ case isIterVarExpr(call.Args[0], iterVar):
+ constExpr = call.Args[1]
+ case isIterVarExpr(call.Args[1], iterVar):
+ constExpr = call.Args[0]
+ default:
+ return nil, errors.Errorf("equality predicate must compare against the iteration variable %q", iterVar)
+ }
+
+ value, err := getConstValue(constExpr)
+ if err != nil {
+ return nil, errors.Wrap(err, "equality argument must be a constant string")
+ }
+
+ valueStr, ok := value.(string)
+ if !ok {
+ return nil, errors.New("equality argument must be a string")
+ }
+
+ return &EqualsPredicate{Value: valueStr}, nil
+}
+
+func isIterVarExpr(expr *exprv1.Expr, iterVar string) bool {
+ target := expr.GetIdentExpr()
+ return target != nil && target.GetName() == iterVar
+}
+
// buildStartsWithPredicate extracts the pattern from t.startsWith("prefix").
func buildStartsWithPredicate(call *exprv1.Expr_Call, iterVar string) (PredicateExpr, error) {
// Verify the target is the iteration variable
diff --git a/plugin/filter/render.go b/plugin/filter/render.go
index c91096a7b..39eaaec01 100644
--- a/plugin/filter/render.go
+++ b/plugin/filter/render.go
@@ -480,6 +480,8 @@ func (r *renderer) renderListComprehension(cond *ListComprehensionCondition) (re
// Render based on predicate type
switch pred := cond.Predicate.(type) {
+ case *EqualsPredicate:
+ return r.renderTagEquals(field, pred.Value, cond.Kind)
case *StartsWithPredicate:
return r.renderTagStartsWith(field, pred.Prefix, cond.Kind)
case *EndsWithPredicate:
@@ -491,6 +493,22 @@ func (r *renderer) renderListComprehension(cond *ListComprehensionCondition) (re
}
}
+// renderTagEquals generates SQL for tags.exists(t, t == "value").
+func (r *renderer) renderTagEquals(field Field, value string, _ ComprehensionKind) (renderResult, error) {
+ arrayExpr := jsonArrayExpr(r.dialect, field)
+
+ switch r.dialect {
+ case DialectSQLite, DialectMySQL:
+ exactMatch := r.buildJSONArrayLike(arrayExpr, fmt.Sprintf(`%%"%s"%%`, value))
+ return renderResult{sql: r.wrapWithNullCheck(arrayExpr, exactMatch)}, nil
+ case DialectPostgres:
+ exactMatch := fmt.Sprintf("%s @> jsonb_build_array(%s::json)", arrayExpr, r.addArg(fmt.Sprintf(`"%s"`, value)))
+ return renderResult{sql: r.wrapWithNullCheck(arrayExpr, exactMatch)}, nil
+ default:
+ return renderResult{}, errors.Errorf("unsupported dialect %s", r.dialect)
+ }
+}
+
// renderTagStartsWith generates SQL for tags.exists(t, t.startsWith("prefix")).
func (r *renderer) renderTagStartsWith(field Field, prefix string, _ ComprehensionKind) (renderResult, error) {
arrayExpr := jsonArrayExpr(r.dialect, field)
diff --git a/plugin/filter/schema.go b/plugin/filter/schema.go
index f2f8b0e4a..ad70e1a35 100644
--- a/plugin/filter/schema.go
+++ b/plugin/filter/schema.go
@@ -108,6 +108,21 @@ func NewSchema() Schema {
SupportsContains: true,
Expressions: map[DialectName]string{},
},
+ "creator": {
+ Name: "creator",
+ Kind: FieldKindScalar,
+ Type: FieldTypeString,
+ Column: Column{Table: "memo_creator", Name: "username"},
+ Expressions: map[DialectName]string{
+ DialectSQLite: "('users/' || %s)",
+ DialectMySQL: "CONCAT('users/', %s)",
+ DialectPostgres: "('users/' || %s)",
+ },
+ AllowedComparisonOps: map[ComparisonOperator]bool{
+ CompareEq: true,
+ CompareNeq: true,
+ },
+ },
"creator_id": {
Name: "creator_id",
Kind: FieldKindScalar,
@@ -228,6 +243,7 @@ func NewSchema() Schema {
envOptions := []cel.EnvOption{
cel.Variable("content", cel.StringType),
+ cel.Variable("creator", cel.StringType),
cel.Variable("creator_id", cel.IntType),
cel.Variable("created_ts", cel.IntType),
cel.Variable("updated_ts", cel.IntType),
diff --git a/proto/api/v1/instance_service.proto b/proto/api/v1/instance_service.proto
index 836a2415e..4113e7760 100644
--- a/proto/api/v1/instance_service.proto
+++ b/proto/api/v1/instance_service.proto
@@ -167,7 +167,8 @@ message InstanceSetting {
// Metadata for a tag.
message TagMetadata {
- // Background color for the tag label.
+ // Optional background color for the tag label.
+ // When unset, the default tag color is used.
google.type.Color background_color = 1;
}
diff --git a/proto/api/v1/shortcut_service.proto b/proto/api/v1/shortcut_service.proto
index 7ebb87807..2e21845b6 100644
--- a/proto/api/v1/shortcut_service.proto
+++ b/proto/api/v1/shortcut_service.proto
@@ -52,13 +52,13 @@ service ShortcutService {
message Shortcut {
option (google.api.resource) = {
type: "memos.api.v1/Shortcut"
- pattern: "users/{user}/shortcuts/{shortcut}"
+ pattern: "users/{username}/shortcuts/{shortcut}"
singular: "shortcut"
plural: "shortcuts"
};
// The resource name of the shortcut.
- // Format: users/{user}/shortcuts/{shortcut}
+ // Format: users/{username}/shortcuts/{shortcut}
string name = 1 [(google.api.field_behavior) = IDENTIFIER];
// The title of the shortcut.
@@ -70,7 +70,7 @@ message Shortcut {
message ListShortcutsRequest {
// Required. The parent resource where shortcuts are listed.
- // Format: users/{user}
+ // Format: users/{username}
string parent = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {child_type: "memos.api.v1/Shortcut"}
@@ -84,7 +84,7 @@ message ListShortcutsResponse {
message GetShortcutRequest {
// Required. The resource name of the shortcut to retrieve.
- // Format: users/{user}/shortcuts/{shortcut}
+ // Format: users/{username}/shortcuts/{shortcut}
string name = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {type: "memos.api.v1/Shortcut"}
@@ -93,7 +93,7 @@ message GetShortcutRequest {
message CreateShortcutRequest {
// Required. The parent resource where this shortcut will be created.
- // Format: users/{user}
+ // Format: users/{username}
string parent = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {child_type: "memos.api.v1/Shortcut"}
@@ -116,7 +116,7 @@ message UpdateShortcutRequest {
message DeleteShortcutRequest {
// Required. The resource name of the shortcut to delete.
- // Format: users/{user}/shortcuts/{shortcut}
+ // Format: users/{username}/shortcuts/{shortcut}
string name = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {type: "memos.api.v1/Shortcut"}
diff --git a/proto/api/v1/user_service.proto b/proto/api/v1/user_service.proto
index e30a5cccd..ac24d6c9d 100644
--- a/proto/api/v1/user_service.proto
+++ b/proto/api/v1/user_service.proto
@@ -19,10 +19,8 @@ service UserService {
option (google.api.http) = {get: "/api/v1/users"};
}
- // GetUser gets a user by ID or username.
- // Supports both numeric IDs and username strings:
- // - users/{id} (e.g., users/101)
- // - users/{username} (e.g., users/steven)
+ // GetUser gets a user by username.
+ // Format: users/{username} (e.g., users/steven)
rpc GetUser(GetUserRequest) returns (User) {
option (google.api.http) = {get: "/api/v1/{name=users/*}"};
option (google.api.method_signature) = "name";
@@ -246,10 +244,7 @@ message ListUsersResponse {
message GetUserRequest {
// Required. The resource name of the user.
- // Supports both numeric IDs and username strings:
- // - users/{id} (e.g., users/101)
- // - users/{username} (e.g., users/steven)
- // Format: users/{id_or_username}
+ // Format: users/{username}
string name = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {type: "memos.api.v1/User"}
@@ -362,14 +357,14 @@ message ListAllUserStatsResponse {
message UserSetting {
option (google.api.resource) = {
type: "memos.api.v1/UserSetting"
- pattern: "users/{user}/settings/{setting}"
+ pattern: "users/{username}/settings/{setting}"
singular: "userSetting"
plural: "userSettings"
};
// The name of the user setting.
- // Format: users/{user}/settings/{setting}, {setting} is the key for the setting.
- // For example, "users/123/settings/GENERAL" for general settings.
+ // Format: users/{username}/settings/{setting}, {setting} is the key for the setting.
+ // For example, "users/steven/settings/GENERAL" for general settings.
string name = 1 [(google.api.field_behavior) = IDENTIFIER];
oneof value {
diff --git a/proto/gen/api/v1/apiv1connect/user_service.connect.go b/proto/gen/api/v1/apiv1connect/user_service.connect.go
index bad608ffb..d93b9bfa1 100644
--- a/proto/gen/api/v1/apiv1connect/user_service.connect.go
+++ b/proto/gen/api/v1/apiv1connect/user_service.connect.go
@@ -95,10 +95,8 @@ const (
type UserServiceClient interface {
// ListUsers returns a list of users.
ListUsers(context.Context, *connect.Request[v1.ListUsersRequest]) (*connect.Response[v1.ListUsersResponse], error)
- // GetUser gets a user by ID or username.
- // Supports both numeric IDs and username strings:
- // - users/{id} (e.g., users/101)
- // - users/{username} (e.g., users/steven)
+ // GetUser gets a user by username.
+ // Format: users/{username} (e.g., users/steven)
GetUser(context.Context, *connect.Request[v1.GetUserRequest]) (*connect.Response[v1.User], error)
// CreateUser creates a new user.
CreateUser(context.Context, *connect.Request[v1.CreateUserRequest]) (*connect.Response[v1.User], error)
@@ -402,10 +400,8 @@ func (c *userServiceClient) DeleteUserNotification(ctx context.Context, req *con
type UserServiceHandler interface {
// ListUsers returns a list of users.
ListUsers(context.Context, *connect.Request[v1.ListUsersRequest]) (*connect.Response[v1.ListUsersResponse], error)
- // GetUser gets a user by ID or username.
- // Supports both numeric IDs and username strings:
- // - users/{id} (e.g., users/101)
- // - users/{username} (e.g., users/steven)
+ // GetUser gets a user by username.
+ // Format: users/{username} (e.g., users/steven)
GetUser(context.Context, *connect.Request[v1.GetUserRequest]) (*connect.Response[v1.User], error)
// CreateUser creates a new user.
CreateUser(context.Context, *connect.Request[v1.CreateUserRequest]) (*connect.Response[v1.User], error)
diff --git a/proto/gen/api/v1/instance_service.pb.go b/proto/gen/api/v1/instance_service.pb.go
index 307e0aee1..b4ece2b78 100644
--- a/proto/gen/api/v1/instance_service.pb.go
+++ b/proto/gen/api/v1/instance_service.pb.go
@@ -759,7 +759,8 @@ func (x *InstanceSetting_MemoRelatedSetting) GetReactions() []string {
// Metadata for a tag.
type InstanceSetting_TagMetadata struct {
state protoimpl.MessageState `protogen:"open.v1"`
- // Background color for the tag label.
+ // Optional background color for the tag label.
+ // When unset, the default tag color is used.
BackgroundColor *color.Color `protobuf:"bytes,1,opt,name=background_color,json=backgroundColor,proto3" json:"background_color,omitempty"`
unknownFields protoimpl.UnknownFields
sizeCache protoimpl.SizeCache
diff --git a/proto/gen/api/v1/shortcut_service.pb.go b/proto/gen/api/v1/shortcut_service.pb.go
index 708078b93..6550fdbd9 100644
--- a/proto/gen/api/v1/shortcut_service.pb.go
+++ b/proto/gen/api/v1/shortcut_service.pb.go
@@ -27,7 +27,7 @@ const (
type Shortcut struct {
state protoimpl.MessageState `protogen:"open.v1"`
// The resource name of the shortcut.
- // Format: users/{user}/shortcuts/{shortcut}
+ // Format: users/{username}/shortcuts/{shortcut}
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// The title of the shortcut.
Title string `protobuf:"bytes,2,opt,name=title,proto3" json:"title,omitempty"`
@@ -91,7 +91,7 @@ func (x *Shortcut) GetFilter() string {
type ListShortcutsRequest struct {
state protoimpl.MessageState `protogen:"open.v1"`
// Required. The parent resource where shortcuts are listed.
- // Format: users/{user}
+ // Format: users/{username}
Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
unknownFields protoimpl.UnknownFields
sizeCache protoimpl.SizeCache
@@ -182,7 +182,7 @@ func (x *ListShortcutsResponse) GetShortcuts() []*Shortcut {
type GetShortcutRequest struct {
state protoimpl.MessageState `protogen:"open.v1"`
// Required. The resource name of the shortcut to retrieve.
- // Format: users/{user}/shortcuts/{shortcut}
+ // Format: users/{username}/shortcuts/{shortcut}
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
unknownFields protoimpl.UnknownFields
sizeCache protoimpl.SizeCache
@@ -228,7 +228,7 @@ func (x *GetShortcutRequest) GetName() string {
type CreateShortcutRequest struct {
state protoimpl.MessageState `protogen:"open.v1"`
// Required. The parent resource where this shortcut will be created.
- // Format: users/{user}
+ // Format: users/{username}
Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
// Required. The shortcut to create.
Shortcut *Shortcut `protobuf:"bytes,2,opt,name=shortcut,proto3" json:"shortcut,omitempty"`
@@ -346,7 +346,7 @@ func (x *UpdateShortcutRequest) GetUpdateMask() *fieldmaskpb.FieldMask {
type DeleteShortcutRequest struct {
state protoimpl.MessageState `protogen:"open.v1"`
// Required. The resource name of the shortcut to delete.
- // Format: users/{user}/shortcuts/{shortcut}
+ // Format: users/{username}/shortcuts/{shortcut}
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
unknownFields protoimpl.UnknownFields
sizeCache protoimpl.SizeCache
@@ -393,12 +393,12 @@ var File_api_v1_shortcut_service_proto protoreflect.FileDescriptor
const file_api_v1_shortcut_service_proto_rawDesc = "" +
"\n" +
- "\x1dapi/v1/shortcut_service.proto\x12\fmemos.api.v1\x1a\x1cgoogle/api/annotations.proto\x1a\x17google/api/client.proto\x1a\x1fgoogle/api/field_behavior.proto\x1a\x19google/api/resource.proto\x1a\x1bgoogle/protobuf/empty.proto\x1a google/protobuf/field_mask.proto\"\xaf\x01\n" +
+ "\x1dapi/v1/shortcut_service.proto\x12\fmemos.api.v1\x1a\x1cgoogle/api/annotations.proto\x1a\x17google/api/client.proto\x1a\x1fgoogle/api/field_behavior.proto\x1a\x19google/api/resource.proto\x1a\x1bgoogle/protobuf/empty.proto\x1a google/protobuf/field_mask.proto\"\xb3\x01\n" +
"\bShortcut\x12\x17\n" +
"\x04name\x18\x01 \x01(\tB\x03\xe0A\bR\x04name\x12\x19\n" +
"\x05title\x18\x02 \x01(\tB\x03\xe0A\x02R\x05title\x12\x1b\n" +
- "\x06filter\x18\x03 \x01(\tB\x03\xe0A\x01R\x06filter:R\xeaAO\n" +
- "\x15memos.api.v1/Shortcut\x12!users/{user}/shortcuts/{shortcut}*\tshortcuts2\bshortcut\"M\n" +
+ "\x06filter\x18\x03 \x01(\tB\x03\xe0A\x01R\x06filter:V\xeaAS\n" +
+ "\x15memos.api.v1/Shortcut\x12%users/{username}/shortcuts/{shortcut}*\tshortcuts2\bshortcut\"M\n" +
"\x14ListShortcutsRequest\x125\n" +
"\x06parent\x18\x01 \x01(\tB\x1d\xe0A\x02\xfaA\x17\x12\x15memos.api.v1/ShortcutR\x06parent\"M\n" +
"\x15ListShortcutsResponse\x124\n" +
diff --git a/proto/gen/api/v1/user_service.pb.go b/proto/gen/api/v1/user_service.pb.go
index bb210e8ab..3ecc78b60 100644
--- a/proto/gen/api/v1/user_service.pb.go
+++ b/proto/gen/api/v1/user_service.pb.go
@@ -506,11 +506,7 @@ func (x *ListUsersResponse) GetTotalSize() int32 {
type GetUserRequest struct {
state protoimpl.MessageState `protogen:"open.v1"`
// Required. The resource name of the user.
- // Supports both numeric IDs and username strings:
- // - users/{id} (e.g., users/101)
- // - users/{username} (e.g., users/steven)
- //
- // Format: users/{id_or_username}
+ // Format: users/{username}
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// Optional. The fields to return in the response.
// If not specified, all fields are returned.
@@ -979,8 +975,8 @@ func (x *ListAllUserStatsResponse) GetStats() []*UserStats {
type UserSetting struct {
state protoimpl.MessageState `protogen:"open.v1"`
// The name of the user setting.
- // Format: users/{user}/settings/{setting}, {setting} is the key for the setting.
- // For example, "users/123/settings/GENERAL" for general settings.
+ // Format: users/{username}/settings/{setting}, {setting} is the key for the setting.
+ // For example, "users/steven/settings/GENERAL" for general settings.
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// Types that are valid to be assigned to Value:
//
@@ -2658,7 +2654,7 @@ const file_api_v1_user_service_proto_rawDesc = "" +
"\x11memos.api.v1/UserR\x04name\"\x19\n" +
"\x17ListAllUserStatsRequest\"I\n" +
"\x18ListAllUserStatsResponse\x12-\n" +
- "\x05stats\x18\x01 \x03(\v2\x17.memos.api.v1.UserStatsR\x05stats\"\xb0\x04\n" +
+ "\x05stats\x18\x01 \x03(\v2\x17.memos.api.v1.UserStatsR\x05stats\"\xb4\x04\n" +
"\vUserSetting\x12\x17\n" +
"\x04name\x18\x01 \x01(\tB\x03\xe0A\bR\x04name\x12S\n" +
"\x0fgeneral_setting\x18\x02 \x01(\v2(.memos.api.v1.UserSetting.GeneralSettingH\x00R\x0egeneralSetting\x12V\n" +
@@ -2672,8 +2668,8 @@ const file_api_v1_user_service_proto_rawDesc = "" +
"\x03Key\x12\x13\n" +
"\x0fKEY_UNSPECIFIED\x10\x00\x12\v\n" +
"\aGENERAL\x10\x01\x12\f\n" +
- "\bWEBHOOKS\x10\x04:Y\xeaAV\n" +
- "\x18memos.api.v1/UserSetting\x12\x1fusers/{user}/settings/{setting}*\fuserSettings2\vuserSettingB\a\n" +
+ "\bWEBHOOKS\x10\x04:]\xeaAZ\n" +
+ "\x18memos.api.v1/UserSetting\x12#users/{username}/settings/{setting}*\fuserSettings2\vuserSettingB\a\n" +
"\x05value\"M\n" +
"\x15GetUserSettingRequest\x124\n" +
"\x04name\x18\x01 \x01(\tB \xe0A\x02\xfaA\x1a\n" +
diff --git a/proto/gen/api/v1/user_service_grpc.pb.go b/proto/gen/api/v1/user_service_grpc.pb.go
index 09d5274e7..332709d3f 100644
--- a/proto/gen/api/v1/user_service_grpc.pb.go
+++ b/proto/gen/api/v1/user_service_grpc.pb.go
@@ -48,10 +48,8 @@ const (
type UserServiceClient interface {
// ListUsers returns a list of users.
ListUsers(ctx context.Context, in *ListUsersRequest, opts ...grpc.CallOption) (*ListUsersResponse, error)
- // GetUser gets a user by ID or username.
- // Supports both numeric IDs and username strings:
- // - users/{id} (e.g., users/101)
- // - users/{username} (e.g., users/steven)
+ // GetUser gets a user by username.
+ // Format: users/{username} (e.g., users/steven)
GetUser(ctx context.Context, in *GetUserRequest, opts ...grpc.CallOption) (*User, error)
// CreateUser creates a new user.
CreateUser(ctx context.Context, in *CreateUserRequest, opts ...grpc.CallOption) (*User, error)
@@ -307,10 +305,8 @@ func (c *userServiceClient) DeleteUserNotification(ctx context.Context, in *Dele
type UserServiceServer interface {
// ListUsers returns a list of users.
ListUsers(context.Context, *ListUsersRequest) (*ListUsersResponse, error)
- // GetUser gets a user by ID or username.
- // Supports both numeric IDs and username strings:
- // - users/{id} (e.g., users/101)
- // - users/{username} (e.g., users/steven)
+ // GetUser gets a user by username.
+ // Format: users/{username} (e.g., users/steven)
GetUser(context.Context, *GetUserRequest) (*User, error)
// CreateUser creates a new user.
CreateUser(context.Context, *CreateUserRequest) (*User, error)
diff --git a/proto/gen/openapi.yaml b/proto/gen/openapi.yaml
index 6a1b89527..88a2bc8b3 100644
--- a/proto/gen/openapi.yaml
+++ b/proto/gen/openapi.yaml
@@ -1206,10 +1206,8 @@ paths:
tags:
- UserService
description: |-
- GetUser gets a user by ID or username.
- Supports both numeric IDs and username strings:
- - users/{id} (e.g., users/101)
- - users/{username} (e.g., users/steven)
+ GetUser gets a user by username.
+ Format: users/{username} (e.g., users/steven)
operationId: UserService_GetUser
parameters:
- name: user
@@ -2398,7 +2396,12 @@ components:
backgroundColor:
allOf:
- $ref: '#/components/schemas/Color'
- description: Background color for the tag label.
+ description: |-
+ Optional background color for the tag label.
+ When unset, the default tag color is used.
+ blurContent:
+ type: boolean
+ description: Whether memos with this tag should have their content blurred.
description: Metadata for a tag.
InstanceSetting_TagsSetting:
type: object
@@ -2931,7 +2934,7 @@ components:
type: string
description: |-
The resource name of the shortcut.
- Format: users/{user}/shortcuts/{shortcut}
+ Format: users/{username}/shortcuts/{shortcut}
title:
type: string
description: The title of the shortcut.
@@ -3170,8 +3173,8 @@ components:
type: string
description: |-
The name of the user setting.
- Format: users/{user}/settings/{setting}, {setting} is the key for the setting.
- For example, "users/123/settings/GENERAL" for general settings.
+ Format: users/{username}/settings/{setting}, {setting} is the key for the setting.
+ For example, "users/steven/settings/GENERAL" for general settings.
generalSetting:
$ref: '#/components/schemas/UserSetting_GeneralSetting'
webhooksSetting:
diff --git a/proto/gen/store/instance_setting.pb.go b/proto/gen/store/instance_setting.pb.go
index 8db4d15c1..9c7aa3ab2 100644
--- a/proto/gen/store/instance_setting.pb.go
+++ b/proto/gen/store/instance_setting.pb.go
@@ -754,7 +754,8 @@ func (x *InstanceMemoRelatedSetting) GetReactions() []string {
type InstanceTagMetadata struct {
state protoimpl.MessageState `protogen:"open.v1"`
- // Background color for the tag label.
+ // Optional background color for the tag label.
+ // When unset, the default tag color is used.
BackgroundColor *color.Color `protobuf:"bytes,1,opt,name=background_color,json=backgroundColor,proto3" json:"background_color,omitempty"`
unknownFields protoimpl.UnknownFields
sizeCache protoimpl.SizeCache
diff --git a/proto/store/instance_setting.proto b/proto/store/instance_setting.proto
index b06a11585..b52ecb5d7 100644
--- a/proto/store/instance_setting.proto
+++ b/proto/store/instance_setting.proto
@@ -111,7 +111,8 @@ message InstanceMemoRelatedSetting {
}
message InstanceTagMetadata {
- // Background color for the tag label.
+ // Optional background color for the tag label.
+ // When unset, the default tag color is used.
google.type.Color background_color = 1;
}
diff --git a/server/router/api/v1/attachment_service.go b/server/router/api/v1/attachment_service.go
index c56eec793..5bef72b79 100644
--- a/server/router/api/v1/attachment_service.go
+++ b/server/router/api/v1/attachment_service.go
@@ -360,7 +360,7 @@ func SaveAttachmentBlob(ctx context.Context, profile *profile.Profile, stores *s
}
if instanceStorageSetting.StorageType == storepb.InstanceStorageSetting_LOCAL {
- filepathTemplate := "assets/{timestamp}_{filename}"
+ filepathTemplate := "assets/{timestamp}_{uuid}_{filename}"
if instanceStorageSetting.FilepathTemplate != "" {
filepathTemplate = instanceStorageSetting.FilepathTemplate
}
@@ -377,6 +377,15 @@ func SaveAttachmentBlob(ctx context.Context, profile *profile.Profile, stores *s
if !filepath.IsAbs(osPath) {
osPath = filepath.Join(profile.Data, osPath)
}
+ osPath = ensureUniqueLocalAttachmentPath(osPath, create.UID)
+ internalPath = filepath.ToSlash(osPath)
+ if !filepath.IsAbs(filepath.FromSlash(internalPath)) {
+ internalPath, err = filepath.Rel(profile.Data, osPath)
+ if err != nil {
+ return errors.Wrap(err, "Failed to get relative path")
+ }
+ internalPath = filepath.ToSlash(internalPath)
+ }
dir := filepath.Dir(osPath)
if err = os.MkdirAll(dir, os.ModePerm); err != nil {
return errors.Wrap(err, "Failed to create directory")
@@ -514,6 +523,16 @@ func replaceFilenameWithPathTemplate(path, filename string) string {
return path
}
+func ensureUniqueLocalAttachmentPath(path, uid string) string {
+ if _, err := os.Stat(path); err != nil {
+ return path
+ }
+
+ ext := filepath.Ext(path)
+ base := strings.TrimSuffix(path, ext)
+ return base + "_" + uid + ext
+}
+
func validateFilename(filename string) bool {
// Reject path traversal attempts and make sure no additional directories are created
if !filepath.IsLocal(filename) || strings.ContainsAny(filename, "/\\") {
diff --git a/server/router/api/v1/auth_service.go b/server/router/api/v1/auth_service.go
index 87cc55a63..8f6b86310 100644
--- a/server/router/api/v1/auth_service.go
+++ b/server/router/api/v1/auth_service.go
@@ -48,7 +48,7 @@ func (s *APIV1Service) GetCurrentUser(ctx context.Context, _ *v1pb.GetCurrentUse
}
return &v1pb.GetCurrentUserResponse{
- User: convertUserFromStore(user),
+ User: convertUserFromStore(user, user),
}, nil
}
@@ -187,7 +187,7 @@ func (s *APIV1Service) SignIn(ctx context.Context, request *v1pb.SignInRequest)
}
return &v1pb.SignInResponse{
- User: convertUserFromStore(existingUser),
+ User: convertUserFromStore(existingUser, existingUser),
AccessToken: accessToken,
AccessTokenExpiresAt: timestamppb.New(accessExpiresAt),
}, nil
diff --git a/server/router/api/v1/idp_service.go b/server/router/api/v1/idp_service.go
index b6b65b283..e1db1191f 100644
--- a/server/router/api/v1/idp_service.go
+++ b/server/router/api/v1/idp_service.go
@@ -49,17 +49,8 @@ func (s *APIV1Service) ListIdentityProviders(ctx context.Context, _ *v1pb.ListId
response := &v1pb.ListIdentityProvidersResponse{
IdentityProviders: []*v1pb.IdentityProvider{},
}
-
- // Default to lowest-privilege role, update later based on real role
- currentUserRole := store.RoleUser
- currentUser, err := s.fetchCurrentUser(ctx)
- if err == nil && currentUser != nil {
- currentUserRole = currentUser.Role
- }
-
for _, identityProvider := range identityProviders {
- identityProviderConverted := convertIdentityProviderFromStore(identityProvider)
- response.IdentityProviders = append(response.IdentityProviders, redactIdentityProviderResponse(identityProviderConverted, currentUserRole))
+ response.IdentityProviders = append(response.IdentityProviders, convertIdentityProviderFromStore(identityProvider))
}
return response, nil
}
@@ -79,15 +70,7 @@ func (s *APIV1Service) GetIdentityProvider(ctx context.Context, request *v1pb.Ge
return nil, status.Errorf(codes.NotFound, "identity provider not found")
}
- // Default to lowest-privilege role, update later based on real role
- currentUserRole := store.RoleUser
- currentUser, err := s.fetchCurrentUser(ctx)
- if err == nil && currentUser != nil {
- currentUserRole = currentUser.Role
- }
-
- identityProviderConverted := convertIdentityProviderFromStore(identityProvider)
- return redactIdentityProviderResponse(identityProviderConverted, currentUserRole), nil
+ return convertIdentityProviderFromStore(identityProvider), nil
}
func (s *APIV1Service) UpdateIdentityProvider(ctx context.Context, request *v1pb.UpdateIdentityProviderRequest) (*v1pb.IdentityProvider, error) {
@@ -137,6 +120,15 @@ func (s *APIV1Service) UpdateIdentityProvider(ctx context.Context, request *v1pb
}
}
+ // Preserve write-only credential when the caller sends an empty value.
+ if update.Config != nil {
+ if oauth2Config := update.Config.GetOauth2Config(); oauth2Config != nil && oauth2Config.ClientSecret == "" {
+ if existingOAuth := existing.Config.GetOauth2Config(); existingOAuth != nil {
+ oauth2Config.ClientSecret = existingOAuth.ClientSecret
+ }
+ }
+ }
+
identityProvider, err := s.Store.UpdateIdentityProvider(ctx, update)
if err != nil {
return nil, status.Errorf(codes.Internal, "failed to update identity provider, error: %+v", err)
@@ -188,12 +180,12 @@ func convertIdentityProviderFromStore(identityProvider *storepb.IdentityProvider
temp.Config = &v1pb.IdentityProviderConfig{
Config: &v1pb.IdentityProviderConfig_Oauth2Config{
Oauth2Config: &v1pb.OAuth2Config{
- ClientId: oauth2Config.ClientId,
- ClientSecret: oauth2Config.ClientSecret,
- AuthUrl: oauth2Config.AuthUrl,
- TokenUrl: oauth2Config.TokenUrl,
- UserInfoUrl: oauth2Config.UserInfoUrl,
- Scopes: oauth2Config.Scopes,
+ ClientId: oauth2Config.ClientId,
+ // ClientSecret is write-only: never returned in responses.
+ AuthUrl: oauth2Config.AuthUrl,
+ TokenUrl: oauth2Config.TokenUrl,
+ UserInfoUrl: oauth2Config.UserInfoUrl,
+ Scopes: oauth2Config.Scopes,
FieldMapping: &v1pb.FieldMapping{
Identifier: oauth2Config.FieldMapping.Identifier,
DisplayName: oauth2Config.FieldMapping.DisplayName,
@@ -241,13 +233,3 @@ func convertIdentityProviderConfigToStore(identityProviderType v1pb.IdentityProv
}
return nil
}
-
-func redactIdentityProviderResponse(identityProvider *v1pb.IdentityProvider, userRole store.Role) *v1pb.IdentityProvider {
- if userRole != store.RoleAdmin {
- if identityProvider.Type == v1pb.IdentityProvider_OAUTH2 {
- identityProvider.Config.GetOauth2Config().ClientSecret = ""
- }
- }
-
- return identityProvider
-}
diff --git a/server/router/api/v1/instance_service.go b/server/router/api/v1/instance_service.go
index de123cfc6..f617e3d67 100644
--- a/server/router/api/v1/instance_service.go
+++ b/server/router/api/v1/instance_service.go
@@ -71,8 +71,9 @@ func (s *APIV1Service) GetInstanceSetting(ctx context.Context, request *v1pb.Get
return nil, status.Errorf(codes.NotFound, "instance setting not found")
}
- // For storage setting, only admin can get it.
- if instanceSetting.Key == storepb.InstanceSettingKey_STORAGE {
+ // Storage and notification settings contain credentials; restrict to admins only.
+ if instanceSetting.Key == storepb.InstanceSettingKey_STORAGE ||
+ instanceSetting.Key == storepb.InstanceSettingKey_NOTIFICATION {
user, err := s.fetchCurrentUser(ctx)
if err != nil {
return nil, status.Errorf(codes.Internal, "failed to get current user: %v", err)
@@ -108,6 +109,28 @@ func (s *APIV1Service) UpdateInstanceSetting(ctx context.Context, request *v1pb.
}
updateSetting := convertInstanceSettingToStore(request.Setting)
+
+ // Preserve write-only credential fields when the caller sends an empty value.
+ // An empty string means "no change", not "clear the credential".
+ switch updateSetting.Key {
+ case storepb.InstanceSettingKey_NOTIFICATION:
+ if notif := updateSetting.GetNotificationSetting(); notif != nil && notif.Email != nil && notif.Email.SmtpPassword == "" {
+ existing, err := s.Store.GetInstanceNotificationSetting(ctx)
+ if err == nil && existing != nil && existing.Email != nil {
+ notif.Email.SmtpPassword = existing.Email.SmtpPassword
+ }
+ }
+ case storepb.InstanceSettingKey_STORAGE:
+ if storage := updateSetting.GetStorageSetting(); storage != nil && storage.S3Config != nil && storage.S3Config.AccessKeySecret == "" {
+ existing, err := s.Store.GetInstanceStorageSetting(ctx)
+ if err == nil && existing != nil && existing.S3Config != nil {
+ storage.S3Config.AccessKeySecret = existing.S3Config.AccessKeySecret
+ }
+ }
+ default:
+ // No credential preservation needed for other setting types.
+ }
+
instanceSetting, err := s.Store.UpsertInstanceSetting(ctx, updateSetting)
if err != nil {
return nil, status.Errorf(codes.Internal, "failed to upsert instance setting: %v", err)
@@ -240,12 +263,12 @@ func convertInstanceStorageSettingFromStore(settingpb *storepb.InstanceStorageSe
}
if settingpb.S3Config != nil {
setting.S3Config = &v1pb.InstanceSetting_StorageSetting_S3Config{
- AccessKeyId: settingpb.S3Config.AccessKeyId,
- AccessKeySecret: settingpb.S3Config.AccessKeySecret,
- Endpoint: settingpb.S3Config.Endpoint,
- Region: settingpb.S3Config.Region,
- Bucket: settingpb.S3Config.Bucket,
- UsePathStyle: settingpb.S3Config.UsePathStyle,
+ AccessKeyId: settingpb.S3Config.AccessKeyId,
+ // AccessKeySecret is write-only: never returned in responses.
+ Endpoint: settingpb.S3Config.Endpoint,
+ Region: settingpb.S3Config.Region,
+ Bucket: settingpb.S3Config.Bucket,
+ UsePathStyle: settingpb.S3Config.UsePathStyle,
}
}
return setting
@@ -339,12 +362,12 @@ func convertInstanceNotificationSettingFromStore(setting *storepb.InstanceNotifi
SmtpHost: setting.Email.SmtpHost,
SmtpPort: setting.Email.SmtpPort,
SmtpUsername: setting.Email.SmtpUsername,
- SmtpPassword: setting.Email.SmtpPassword,
- FromEmail: setting.Email.FromEmail,
- FromName: setting.Email.FromName,
- ReplyTo: setting.Email.ReplyTo,
- UseTls: setting.Email.UseTls,
- UseSsl: setting.Email.UseSsl,
+ // SmtpPassword is write-only: never returned in responses.
+ FromEmail: setting.Email.FromEmail,
+ FromName: setting.Email.FromName,
+ ReplyTo: setting.Email.ReplyTo,
+ UseTls: setting.Email.UseTls,
+ UseSsl: setting.Email.UseSsl,
}
}
return notificationSetting
@@ -398,11 +421,10 @@ func validateInstanceTagsSetting(setting *v1pb.InstanceSetting_TagsSetting) erro
if metadata == nil {
return errors.Errorf("tag metadata is required for %q", tag)
}
- if metadata.GetBackgroundColor() == nil {
- return errors.Errorf("background_color is required for %q", tag)
- }
- if err := validateInstanceColor(metadata.GetBackgroundColor()); err != nil {
- return errors.Wrapf(err, "background_color for %q", tag)
+ if metadata.GetBackgroundColor() != nil {
+ if err := validateInstanceColor(metadata.GetBackgroundColor()); err != nil {
+ return errors.Wrapf(err, "background_color for %q", tag)
+ }
}
}
return nil
@@ -448,5 +470,6 @@ func (s *APIV1Service) GetInstanceAdmin(ctx context.Context) (*v1pb.User, error)
return nil, nil
}
- return convertUserFromStore(user), nil
+ currentUser, _ := s.fetchCurrentUser(ctx)
+ return convertUserFromStore(user, currentUser), nil
}
diff --git a/server/router/api/v1/memo_attachment_service.go b/server/router/api/v1/memo_attachment_service.go
index d9aa0a3ee..d687c59e9 100644
--- a/server/router/api/v1/memo_attachment_service.go
+++ b/server/router/api/v1/memo_attachment_service.go
@@ -35,20 +35,36 @@ func (s *APIV1Service) SetMemoAttachments(ctx context.Context, request *v1pb.Set
if memo.CreatorID != user.ID && !isSuperUser(user) {
return nil, status.Errorf(codes.PermissionDenied, "permission denied")
}
+ if err := s.setMemoAttachmentsInternal(ctx, memo, request.Attachments); err != nil {
+ return nil, err
+ }
+ if err := s.touchMemoUpdatedTimestamp(ctx, memo.ID); err != nil {
+ return nil, err
+ }
+ updatedMemo, parentMemo, memoMessage, err := s.buildUpdatedMemoState(ctx, memo.ID)
+ if err != nil {
+ return nil, status.Errorf(codes.Internal, "failed to build updated memo state")
+ }
+ s.dispatchMemoUpdatedSideEffects(ctx, updatedMemo, parentMemo, memoMessage)
+
+ return &emptypb.Empty{}, nil
+}
+
+func (s *APIV1Service) setMemoAttachmentsInternal(ctx context.Context, memo *store.Memo, requestAttachments []*v1pb.Attachment) error {
attachments, err := s.Store.ListAttachments(ctx, &store.FindAttachment{
MemoID: &memo.ID,
})
if err != nil {
- return nil, status.Errorf(codes.Internal, "failed to list attachments")
+ return status.Errorf(codes.Internal, "failed to list attachments")
}
// Delete attachments that are not in the request.
for _, attachment := range attachments {
found := false
- for _, requestAttachment := range request.Attachments {
+ for _, requestAttachment := range requestAttachments {
requestAttachmentUID, err := ExtractAttachmentUIDFromName(requestAttachment.Name)
if err != nil {
- return nil, status.Errorf(codes.InvalidArgument, "invalid attachment name: %v", err)
+ return status.Errorf(codes.InvalidArgument, "invalid attachment name: %v", err)
}
if attachment.UID == requestAttachmentUID {
found = true
@@ -60,24 +76,24 @@ func (s *APIV1Service) SetMemoAttachments(ctx context.Context, request *v1pb.Set
ID: int32(attachment.ID),
MemoID: &memo.ID,
}); err != nil {
- return nil, status.Errorf(codes.Internal, "failed to delete attachment")
+ return status.Errorf(codes.Internal, "failed to delete attachment")
}
}
}
- slices.Reverse(request.Attachments)
+ slices.Reverse(requestAttachments)
// Update attachments' memo_id in the request.
- for index, attachment := range request.Attachments {
+ for index, attachment := range requestAttachments {
attachmentUID, err := ExtractAttachmentUIDFromName(attachment.Name)
if err != nil {
- return nil, status.Errorf(codes.InvalidArgument, "invalid attachment name: %v", err)
+ return status.Errorf(codes.InvalidArgument, "invalid attachment name: %v", err)
}
tempAttachment, err := s.Store.GetAttachment(ctx, &store.FindAttachment{UID: &attachmentUID})
if err != nil {
- return nil, status.Errorf(codes.Internal, "failed to get attachment: %v", err)
+ return status.Errorf(codes.Internal, "failed to get attachment: %v", err)
}
if tempAttachment == nil {
- return nil, status.Errorf(codes.NotFound, "attachment not found: %s", attachmentUID)
+ return status.Errorf(codes.NotFound, "attachment not found: %s", attachmentUID)
}
updatedTs := time.Now().Unix() + int64(index)
if err := s.Store.UpdateAttachment(ctx, &store.UpdateAttachment{
@@ -85,11 +101,11 @@ func (s *APIV1Service) SetMemoAttachments(ctx context.Context, request *v1pb.Set
MemoID: &memo.ID,
UpdatedTs: &updatedTs,
}); err != nil {
- return nil, status.Errorf(codes.Internal, "failed to update attachment: %v", err)
+ return status.Errorf(codes.Internal, "failed to update attachment: %v", err)
}
}
- return &emptypb.Empty{}, nil
+ return nil
}
func (s *APIV1Service) ListMemoAttachments(ctx context.Context, request *v1pb.ListMemoAttachmentsRequest) (*v1pb.ListMemoAttachmentsResponse, error) {
diff --git a/server/router/api/v1/memo_relation_service.go b/server/router/api/v1/memo_relation_service.go
index 25d97f24a..382d72143 100644
--- a/server/router/api/v1/memo_relation_service.go
+++ b/server/router/api/v1/memo_relation_service.go
@@ -35,18 +35,34 @@ func (s *APIV1Service) SetMemoRelations(ctx context.Context, request *v1pb.SetMe
if memo.CreatorID != user.ID && !isSuperUser(user) {
return nil, status.Errorf(codes.PermissionDenied, "permission denied")
}
+ if err := s.setMemoRelationsInternal(ctx, memo, request.Relations); err != nil {
+ return nil, err
+ }
+ if err := s.touchMemoUpdatedTimestamp(ctx, memo.ID); err != nil {
+ return nil, err
+ }
+ updatedMemo, parentMemo, memoMessage, err := s.buildUpdatedMemoState(ctx, memo.ID)
+ if err != nil {
+ return nil, status.Errorf(codes.Internal, "failed to build updated memo state")
+ }
+ s.dispatchMemoUpdatedSideEffects(ctx, updatedMemo, parentMemo, memoMessage)
+
+ return &emptypb.Empty{}, nil
+}
+
+func (s *APIV1Service) setMemoRelationsInternal(ctx context.Context, memo *store.Memo, relations []*v1pb.MemoRelation) error {
referenceType := store.MemoRelationReference
// Delete all reference relations first.
if err := s.Store.DeleteMemoRelation(ctx, &store.DeleteMemoRelation{
MemoID: &memo.ID,
Type: &referenceType,
}); err != nil {
- return nil, status.Errorf(codes.Internal, "failed to delete memo relation")
+ return status.Errorf(codes.Internal, "failed to delete memo relation")
}
- for _, relation := range request.Relations {
+ for _, relation := range relations {
// Ignore reflexive relations.
- if request.Name == relation.RelatedMemo.Name {
+ if buildMemoName(memo.UID) == relation.RelatedMemo.Name {
continue
}
// Ignore comment relations as there's no need to update a comment's relation.
@@ -56,22 +72,22 @@ func (s *APIV1Service) SetMemoRelations(ctx context.Context, request *v1pb.SetMe
}
relatedMemoUID, err := ExtractMemoUIDFromName(relation.RelatedMemo.Name)
if err != nil {
- return nil, status.Errorf(codes.InvalidArgument, "invalid related memo name: %v", err)
+ return status.Errorf(codes.InvalidArgument, "invalid related memo name: %v", err)
}
relatedMemo, err := s.Store.GetMemo(ctx, &store.FindMemo{UID: &relatedMemoUID})
if err != nil {
- return nil, status.Errorf(codes.Internal, "failed to get related memo")
+ return status.Errorf(codes.Internal, "failed to get related memo")
}
if _, err := s.Store.UpsertMemoRelation(ctx, &store.MemoRelation{
MemoID: memo.ID,
RelatedMemoID: relatedMemo.ID,
Type: convertMemoRelationTypeToStore(relation.Type),
}); err != nil {
- return nil, status.Errorf(codes.Internal, "failed to upsert memo relation")
+ return status.Errorf(codes.Internal, "failed to upsert memo relation")
}
}
- return &emptypb.Empty{}, nil
+ return nil
}
func (s *APIV1Service) ListMemoRelations(ctx context.Context, request *v1pb.ListMemoRelationsRequest) (*v1pb.ListMemoRelationsResponse, error) {
diff --git a/server/router/api/v1/memo_service.go b/server/router/api/v1/memo_service.go
index 74c47f355..830ee1eb6 100644
--- a/server/router/api/v1/memo_service.go
+++ b/server/router/api/v1/memo_service.go
@@ -19,6 +19,19 @@ import (
"github.com/usememos/memos/store"
)
+// suppressSSEKey is a context key used to suppress the SSE broadcast from
+// CreateMemo when it is called internally (e.g., from CreateMemoComment).
+type suppressSSEKey struct{}
+
+func withSuppressSSE(ctx context.Context) context.Context {
+ return context.WithValue(ctx, suppressSSEKey{}, true)
+}
+
+func isSSESuppressed(ctx context.Context) bool {
+ v, ok := ctx.Value(suppressSSEKey{}).(bool)
+ return ok && v
+}
+
func (s *APIV1Service) CreateMemo(ctx context.Context, request *v1pb.CreateMemoRequest) (*v1pb.Memo, error) {
user, err := s.fetchCurrentUser(ctx)
if err != nil {
@@ -136,11 +149,15 @@ func (s *APIV1Service) CreateMemo(ctx context.Context, request *v1pb.CreateMemoR
slog.Warn("Failed to dispatch memo created webhook", slog.Any("err", err))
}
- // Broadcast live refresh event.
- s.SSEHub.Broadcast(&SSEEvent{
- Type: SSEEventMemoCreated,
- Name: memoMessage.Name,
- })
+ // Broadcast live refresh event (skipped when called from CreateMemoComment).
+ if !isSSESuppressed(ctx) {
+ s.SSEHub.Broadcast(&SSEEvent{
+ Type: SSEEventMemoCreated,
+ Name: memoMessage.Name,
+ Visibility: memo.Visibility,
+ CreatorID: resolveSSECreatorID(memo, nil),
+ })
+ }
return memoMessage, nil
}
@@ -278,6 +295,14 @@ func (s *APIV1Service) ListMemos(ctx context.Context, request *v1pb.ListMemosReq
if err != nil {
return nil, status.Errorf(codes.Internal, "failed to batch load memo relations")
}
+ creatorIDs := make([]int32, 0, len(memos))
+ for _, memo := range memos {
+ creatorIDs = append(creatorIDs, memo.CreatorID)
+ }
+ creatorMap, err := s.listUsersByID(ctx, creatorIDs)
+ if err != nil {
+ return nil, status.Errorf(codes.Internal, "failed to list memo creators: %v", err)
+ }
for _, memo := range memos {
memoName := fmt.Sprintf("%s%s", MemoNamePrefix, memo.UID)
@@ -285,7 +310,7 @@ func (s *APIV1Service) ListMemos(ctx context.Context, request *v1pb.ListMemosReq
attachments := attachmentMap[memo.ID]
relations := relationMap[memo.ID]
- memoMessage, err := s.convertMemoFromStore(ctx, memo, reactions, attachments, relations)
+ memoMessage, err := s.convertMemoFromStoreWithCreators(ctx, memo, reactions, attachments, relations, creatorMap)
if err != nil {
return nil, errors.Wrap(err, "failed to convert memo")
}
@@ -444,19 +469,11 @@ func (s *APIV1Service) UpdateMemo(ctx context.Context, request *v1pb.UpdateMemoR
payload.Location = convertLocationToStore(request.Memo.Location)
update.Payload = payload
} else if path == "attachments" {
- _, err := s.SetMemoAttachments(ctx, &v1pb.SetMemoAttachmentsRequest{
- Name: request.Memo.Name,
- Attachments: request.Memo.Attachments,
- })
- if err != nil {
+ if err := s.setMemoAttachmentsInternal(ctx, memo, request.Memo.Attachments); err != nil {
return nil, errors.Wrap(err, "failed to set memo attachments")
}
} else if path == "relations" {
- _, err := s.SetMemoRelations(ctx, &v1pb.SetMemoRelationsRequest{
- Name: request.Memo.Name,
- Relations: request.Memo.Relations,
- })
- if err != nil {
+ if err := s.setMemoRelationsInternal(ctx, memo, request.Memo.Relations); err != nil {
return nil, errors.Wrap(err, "failed to set memo relations")
}
}
@@ -472,37 +489,11 @@ func (s *APIV1Service) UpdateMemo(ctx context.Context, request *v1pb.UpdateMemoR
if err != nil {
return nil, errors.Wrap(err, "failed to get memo")
}
- reactions, err := s.Store.ListReactions(ctx, &store.FindReaction{
- ContentID: &request.Memo.Name,
- })
+ memo, parentMemo, memoMessage, err := s.buildUpdatedMemoState(ctx, memo.ID)
if err != nil {
- return nil, status.Errorf(codes.Internal, "failed to list reactions")
+ return nil, errors.Wrap(err, "failed to build updated memo state")
}
- attachments, err := s.Store.ListAttachments(ctx, &store.FindAttachment{
- MemoID: &memo.ID,
- })
- if err != nil {
- return nil, status.Errorf(codes.Internal, "failed to list attachments")
- }
-
- relations, err := s.loadMemoRelations(ctx, memo)
- if err != nil {
- return nil, errors.Wrap(err, "failed to load memo relations")
- }
- memoMessage, err := s.convertMemoFromStore(ctx, memo, reactions, attachments, relations)
- if err != nil {
- return nil, errors.Wrap(err, "failed to convert memo")
- }
- // Try to dispatch webhook when memo is updated.
- if err := s.DispatchMemoUpdatedWebhook(ctx, memoMessage); err != nil {
- slog.Warn("Failed to dispatch memo updated webhook", slog.Any("err", err))
- }
-
- // Broadcast live refresh event.
- s.SSEHub.Broadcast(&SSEEvent{
- Type: SSEEventMemoUpdated,
- Name: memoMessage.Name,
- })
+ s.dispatchMemoUpdatedSideEffects(ctx, memo, parentMemo, memoMessage)
return memoMessage, nil
}
@@ -575,8 +566,10 @@ func (s *APIV1Service) DeleteMemo(ctx context.Context, request *v1pb.DeleteMemoR
// Broadcast live refresh event.
s.SSEHub.Broadcast(&SSEEvent{
- Type: SSEEventMemoDeleted,
- Name: request.Name,
+ Type: SSEEventMemoDeleted,
+ Name: request.Name,
+ Visibility: memo.Visibility,
+ CreatorID: resolveSSECreatorID(memo, nil),
})
return &emptypb.Empty{}, nil
@@ -607,8 +600,9 @@ func (s *APIV1Service) CreateMemoComment(ctx context.Context, request *v1pb.Crea
return nil, status.Errorf(codes.PermissionDenied, "permission denied")
}
- // Create the memo comment first.
- memoComment, err := s.CreateMemo(ctx, &v1pb.CreateMemoRequest{
+ // Create the memo comment first; suppress the generic memo.created SSE event
+ // since CreateMemoComment broadcasts memo.comment.created for the parent instead.
+ memoComment, err := s.CreateMemo(withSuppressSSE(ctx), &v1pb.CreateMemoRequest{
Memo: request.Comment,
MemoId: request.CommentId,
})
@@ -633,10 +627,14 @@ func (s *APIV1Service) CreateMemoComment(ctx context.Context, request *v1pb.Crea
if err != nil {
return nil, status.Errorf(codes.Internal, "failed to create memo relation")
}
- creatorID, err := ExtractUserIDFromName(memoComment.Creator)
+ creator, err := ResolveUserByName(ctx, s.Store, memoComment.Creator)
if err != nil {
return nil, status.Errorf(codes.InvalidArgument, "invalid memo creator")
}
+ if creator == nil {
+ return nil, status.Errorf(codes.NotFound, "memo creator not found")
+ }
+ creatorID := creator.ID
if memoComment.Visibility != v1pb.Visibility_PRIVATE && creatorID != relatedMemo.CreatorID {
if _, err := s.Store.CreateInbox(ctx, &store.Inbox{
SenderID: creatorID,
@@ -662,8 +660,10 @@ func (s *APIV1Service) CreateMemoComment(ctx context.Context, request *v1pb.Crea
// Broadcast live refresh event for the parent memo so subscribers see the new comment.
s.SSEHub.Broadcast(&SSEEvent{
- Type: SSEEventMemoCommentCreated,
- Name: request.Name,
+ Type: SSEEventMemoCommentCreated,
+ Name: request.Name,
+ Visibility: relatedMemo.Visibility,
+ CreatorID: relatedMemo.CreatorID,
})
return memoComment, nil
@@ -749,6 +749,14 @@ func (s *APIV1Service) ListMemoComments(ctx context.Context, request *v1pb.ListM
if err != nil {
return nil, status.Errorf(codes.Internal, "failed to batch load memo relations")
}
+ creatorIDs := make([]int32, 0, len(memos))
+ for _, memo := range memos {
+ creatorIDs = append(creatorIDs, memo.CreatorID)
+ }
+ creatorMap, err := s.listUsersByID(ctx, creatorIDs)
+ if err != nil {
+ return nil, status.Errorf(codes.Internal, "failed to list memo creators: %v", err)
+ }
var memosResponse []*v1pb.Memo
for _, m := range memos {
@@ -757,7 +765,7 @@ func (s *APIV1Service) ListMemoComments(ctx context.Context, request *v1pb.ListM
attachments := attachmentMap[m.ID]
relations := relationMap[m.ID]
- memoMessage, err := s.convertMemoFromStore(ctx, m, reactions, attachments, relations)
+ memoMessage, err := s.convertMemoFromStoreWithCreators(ctx, m, reactions, attachments, relations, creatorMap)
if err != nil {
return nil, errors.Wrap(err, "failed to convert memo")
}
@@ -812,10 +820,14 @@ func (s *APIV1Service) DispatchMemoCommentCreatedWebhook(ctx context.Context, co
}
func (s *APIV1Service) dispatchMemoRelatedWebhook(ctx context.Context, memo *v1pb.Memo, activityType string) error {
- creatorID, err := ExtractUserIDFromName(memo.Creator)
+ creator, err := ResolveUserByName(ctx, s.Store, memo.Creator)
if err != nil {
return status.Errorf(codes.InvalidArgument, "invalid memo creator")
}
+ if creator == nil {
+ return status.Errorf(codes.NotFound, "memo creator not found")
+ }
+ creatorID := creator.ID
webhooks, err := s.Store.GetUserWebhooks(ctx, creatorID)
if err != nil {
return err
@@ -835,12 +847,8 @@ func (s *APIV1Service) dispatchMemoRelatedWebhook(ctx context.Context, memo *v1p
}
func convertMemoToWebhookPayload(memo *v1pb.Memo) (*webhook.WebhookRequestPayload, error) {
- creatorID, err := ExtractUserIDFromName(memo.Creator)
- if err != nil {
- return nil, errors.Wrap(err, "invalid memo creator")
- }
return &webhook.WebhookRequestPayload{
- Creator: fmt.Sprintf("%s%d", UserNamePrefix, creatorID),
+ Creator: memo.Creator,
Memo: memo,
}, nil
}
diff --git a/server/router/api/v1/memo_service_converter.go b/server/router/api/v1/memo_service_converter.go
index bedd7174c..d20588a7a 100644
--- a/server/router/api/v1/memo_service_converter.go
+++ b/server/router/api/v1/memo_service_converter.go
@@ -14,6 +14,14 @@ import (
)
func (s *APIV1Service) convertMemoFromStore(ctx context.Context, memo *store.Memo, reactions []*store.Reaction, attachments []*store.Attachment, relations []*v1pb.MemoRelation) (*v1pb.Memo, error) {
+ creatorMap, err := s.listUsersByID(ctx, []int32{memo.CreatorID})
+ if err != nil {
+ return nil, errors.Wrap(err, "failed to list memo creators")
+ }
+ return s.convertMemoFromStoreWithCreators(ctx, memo, reactions, attachments, relations, creatorMap)
+}
+
+func (s *APIV1Service) convertMemoFromStoreWithCreators(ctx context.Context, memo *store.Memo, reactions []*store.Reaction, attachments []*store.Attachment, relations []*v1pb.MemoRelation, creatorMap map[int32]*store.User) (*v1pb.Memo, error) {
displayTs := memo.CreatedTs
instanceMemoRelatedSetting, err := s.Store.GetInstanceMemoRelatedSetting(ctx)
if err != nil {
@@ -24,10 +32,14 @@ func (s *APIV1Service) convertMemoFromStore(ctx context.Context, memo *store.Mem
}
name := fmt.Sprintf("%s%s", MemoNamePrefix, memo.UID)
+ creator := creatorMap[memo.CreatorID]
+ if creator == nil {
+ return nil, errors.New("memo creator not found")
+ }
memoMessage := &v1pb.Memo{
Name: name,
State: convertStateFromStore(memo.RowStatus),
- Creator: fmt.Sprintf("%s%d", UserNamePrefix, memo.CreatorID),
+ Creator: BuildUserName(creator.Username),
CreateTime: timestamppb.New(time.Unix(memo.CreatedTs, 0)),
UpdateTime: timestamppb.New(time.Unix(memo.UpdatedTs, 0)),
DisplayTime: timestamppb.New(time.Unix(displayTs, 0)),
@@ -48,7 +60,10 @@ func (s *APIV1Service) convertMemoFromStore(ctx context.Context, memo *store.Mem
memoMessage.Reactions = []*v1pb.Reaction{}
for _, reaction := range reactions {
- reactionResponse := convertReactionFromStore(reaction)
+ reactionResponse, err := s.convertReactionFromStore(ctx, reaction)
+ if err != nil {
+ return nil, errors.Wrap(err, "failed to convert reaction")
+ }
memoMessage.Reactions = append(memoMessage.Reactions, reactionResponse)
}
diff --git a/server/router/api/v1/memo_update_helpers.go b/server/router/api/v1/memo_update_helpers.go
new file mode 100644
index 000000000..2c5f7e044
--- /dev/null
+++ b/server/router/api/v1/memo_update_helpers.go
@@ -0,0 +1,78 @@
+package v1
+
+import (
+ "context"
+ "log/slog"
+ "time"
+
+ "github.com/pkg/errors"
+ "google.golang.org/grpc/codes"
+ "google.golang.org/grpc/status"
+
+ v1pb "github.com/usememos/memos/proto/gen/api/v1"
+ "github.com/usememos/memos/store"
+)
+
+func (s *APIV1Service) touchMemoUpdatedTimestamp(ctx context.Context, memoID int32) error {
+ updatedTs := time.Now().Unix()
+ if err := s.Store.UpdateMemo(ctx, &store.UpdateMemo{
+ ID: memoID,
+ UpdatedTs: &updatedTs,
+ }); err != nil {
+ return status.Errorf(codes.Internal, "failed to update memo timestamp")
+ }
+ return nil
+}
+
+func (s *APIV1Service) buildUpdatedMemoState(ctx context.Context, memoID int32) (*store.Memo, *store.Memo, *v1pb.Memo, error) {
+ memo, err := s.Store.GetMemo(ctx, &store.FindMemo{ID: &memoID})
+ if err != nil {
+ return nil, nil, nil, errors.Wrap(err, "failed to get memo")
+ }
+ if memo == nil {
+ return nil, nil, nil, errors.New("memo not found")
+ }
+
+ memoName := buildMemoName(memo.UID)
+ reactions, err := s.Store.ListReactions(ctx, &store.FindReaction{
+ ContentID: &memoName,
+ })
+ if err != nil {
+ return nil, nil, nil, errors.Wrap(err, "failed to list reactions")
+ }
+ attachments, err := s.Store.ListAttachments(ctx, &store.FindAttachment{
+ MemoID: &memo.ID,
+ })
+ if err != nil {
+ return nil, nil, nil, errors.Wrap(err, "failed to list attachments")
+ }
+ relations, err := s.loadMemoRelations(ctx, memo)
+ if err != nil {
+ return nil, nil, nil, errors.Wrap(err, "failed to load memo relations")
+ }
+ memoMessage, err := s.convertMemoFromStore(ctx, memo, reactions, attachments, relations)
+ if err != nil {
+ return nil, nil, nil, errors.Wrap(err, "failed to convert memo")
+ }
+
+ var parentMemo *store.Memo
+ if memo.ParentUID != nil {
+ parentMemo, _ = s.Store.GetMemo(ctx, &store.FindMemo{UID: memo.ParentUID})
+ }
+
+ return memo, parentMemo, memoMessage, nil
+}
+
+func (s *APIV1Service) dispatchMemoUpdatedSideEffects(ctx context.Context, memo *store.Memo, parentMemo *store.Memo, memoMessage *v1pb.Memo) {
+ if err := s.DispatchMemoUpdatedWebhook(ctx, memoMessage); err != nil {
+ slog.Warn("Failed to dispatch memo updated webhook", slog.Any("err", err))
+ }
+
+ s.SSEHub.Broadcast(&SSEEvent{
+ Type: SSEEventMemoUpdated,
+ Name: memoMessage.Name,
+ Parent: memoMessage.GetParent(),
+ Visibility: memo.Visibility,
+ CreatorID: resolveSSECreatorID(memo, parentMemo),
+ })
+}
diff --git a/server/router/api/v1/reaction_service.go b/server/router/api/v1/reaction_service.go
index a4c521fe8..f25a44d4d 100644
--- a/server/router/api/v1/reaction_service.go
+++ b/server/router/api/v1/reaction_service.go
@@ -53,7 +53,10 @@ func (s *APIV1Service) ListMemoReactions(ctx context.Context, request *v1pb.List
Reactions: []*v1pb.Reaction{},
}
for _, reaction := range reactions {
- reactionMessage := convertReactionFromStore(reaction)
+ reactionMessage, err := s.convertReactionFromStore(ctx, reaction)
+ if err != nil {
+ return nil, status.Errorf(codes.Internal, "failed to convert reaction")
+ }
response.Reactions = append(response.Reactions, reactionMessage)
}
return response, nil
@@ -95,13 +98,17 @@ func (s *APIV1Service) UpsertMemoReaction(ctx context.Context, request *v1pb.Ups
return nil, status.Errorf(codes.Internal, "failed to upsert reaction")
}
- reactionMessage := convertReactionFromStore(reaction)
+ reactionMessage, err := s.convertReactionFromStore(ctx, reaction)
+ if err != nil {
+ return nil, status.Errorf(codes.Internal, "failed to convert reaction")
+ }
// Broadcast live refresh event (reaction belongs to a memo).
- s.SSEHub.Broadcast(&SSEEvent{
- Type: SSEEventReactionUpserted,
- Name: request.Reaction.ContentId,
- })
+ var parentMemo *store.Memo
+ if memo.ParentUID != nil {
+ parentMemo, _ = s.Store.GetMemo(ctx, &store.FindMemo{UID: memo.ParentUID})
+ }
+ s.SSEHub.Broadcast(buildMemoReactionSSEEvent(SSEEventReactionUpserted, request.Reaction.ContentId, memo, parentMemo))
return reactionMessage, nil
}
@@ -142,24 +149,41 @@ func (s *APIV1Service) DeleteMemoReaction(ctx context.Context, request *v1pb.Del
return nil, status.Errorf(codes.Internal, "failed to delete reaction")
}
+ memoUID, err := ExtractMemoUIDFromName(reaction.ContentID)
+ if err != nil {
+ return nil, status.Errorf(codes.InvalidArgument, "invalid memo name: %v", err)
+ }
+ memo, err := s.Store.GetMemo(ctx, &store.FindMemo{UID: &memoUID})
+ if err != nil {
+ return nil, status.Errorf(codes.Internal, "failed to get memo")
+ }
+
// Broadcast live refresh event (reaction belongs to a memo).
- s.SSEHub.Broadcast(&SSEEvent{
- Type: SSEEventReactionDeleted,
- Name: reaction.ContentID,
- })
+ var parentMemo *store.Memo
+ if memo != nil && memo.ParentUID != nil {
+ parentMemo, _ = s.Store.GetMemo(ctx, &store.FindMemo{UID: memo.ParentUID})
+ }
+ s.SSEHub.Broadcast(buildMemoReactionSSEEvent(SSEEventReactionDeleted, reaction.ContentID, memo, parentMemo))
return &emptypb.Empty{}, nil
}
-func convertReactionFromStore(reaction *store.Reaction) *v1pb.Reaction {
+func (s *APIV1Service) convertReactionFromStore(ctx context.Context, reaction *store.Reaction) (*v1pb.Reaction, error) {
reactionUID := fmt.Sprintf("%d", reaction.ID)
+ creator, err := s.Store.GetUser(ctx, &store.FindUser{ID: &reaction.CreatorID})
+ if err != nil {
+ return nil, status.Errorf(codes.Internal, "failed to get reaction creator")
+ }
+ if creator == nil {
+ return nil, status.Errorf(codes.NotFound, "reaction creator not found")
+ }
// Generate nested resource name: memos/{memo}/reactions/{reaction}
// reaction.ContentID already contains "memos/{memo}"
return &v1pb.Reaction{
Name: fmt.Sprintf("%s/%s%s", reaction.ContentID, ReactionNamePrefix, reactionUID),
- Creator: fmt.Sprintf("%s%d", UserNamePrefix, reaction.CreatorID),
+ Creator: BuildUserName(creator.Username),
ContentId: reaction.ContentID,
ReactionType: reaction.ReactionType,
CreateTime: timestamppb.New(time.Unix(reaction.CreatedTs, 0)),
- }
+ }, nil
}
diff --git a/server/router/api/v1/resource_name.go b/server/router/api/v1/resource_name.go
index 141b6748d..070a8440a 100644
--- a/server/router/api/v1/resource_name.go
+++ b/server/router/api/v1/resource_name.go
@@ -77,17 +77,6 @@ func ExtractUserIDFromName(name string) (int32, error) {
return id, nil
}
-// extractUserIdentifierFromName extracts the identifier (ID or username) from a user resource name.
-// Supports: "users/101" or "users/steven"
-// Returns the identifier string (e.g., "101" or "steven").
-func extractUserIdentifierFromName(name string) string {
- tokens, err := GetNameParentTokens(name, UserNamePrefix)
- if err != nil || len(tokens) == 0 {
- return ""
- }
- return tokens[0]
-}
-
// ExtractMemoUIDFromName returns the memo UID from a resource name.
// e.g., "memos/uuid" -> "uuid".
func ExtractMemoUIDFromName(name string) (string, error) {
diff --git a/server/router/api/v1/shortcut_service.go b/server/router/api/v1/shortcut_service.go
index aa2c4f6f7..f19263739 100644
--- a/server/router/api/v1/shortcut_service.go
+++ b/server/router/api/v1/shortcut_service.go
@@ -17,37 +17,44 @@ import (
"github.com/usememos/memos/store"
)
-// Helper function to extract user ID and shortcut ID from shortcut resource name.
+// Helper function to extract user and shortcut ID from shortcut resource name.
// Format: users/{user}/shortcuts/{shortcut}.
-func extractUserAndShortcutIDFromName(name string) (int32, string, error) {
+func (s *APIV1Service) extractUserAndShortcutIDFromName(ctx context.Context, name string) (*store.User, string, error) {
parts := strings.Split(name, "/")
if len(parts) != 4 || parts[0] != "users" || parts[2] != "shortcuts" {
- return 0, "", errors.Errorf("invalid shortcut name format: %s", name)
+ return nil, "", errors.Errorf("invalid shortcut name format: %s", name)
}
- userID, err := util.ConvertStringToInt32(parts[1])
+ user, err := ResolveUserByName(ctx, s.Store, BuildUserName(parts[1]))
if err != nil {
- return 0, "", errors.Errorf("invalid user ID %q", parts[1])
+ return nil, "", err
+ }
+ if user == nil {
+ return nil, "", errors.Errorf("user not found: %s", parts[1])
}
shortcutID := parts[3]
if shortcutID == "" {
- return 0, "", errors.Errorf("empty shortcut ID in name: %s", name)
+ return nil, "", errors.Errorf("empty shortcut ID in name: %s", name)
}
- return userID, shortcutID, nil
+ return user, shortcutID, nil
}
// Helper function to construct shortcut resource name.
-func constructShortcutName(userID int32, shortcutID string) string {
- return fmt.Sprintf("users/%d/shortcuts/%s", userID, shortcutID)
+func constructShortcutName(username string, shortcutID string) string {
+ return fmt.Sprintf("%s/shortcuts/%s", BuildUserName(username), shortcutID)
}
func (s *APIV1Service) ListShortcuts(ctx context.Context, request *v1pb.ListShortcutsRequest) (*v1pb.ListShortcutsResponse, error) {
- userID, err := ExtractUserIDFromName(request.Parent)
+ user, err := ResolveUserByName(ctx, s.Store, request.Parent)
if err != nil {
return nil, status.Errorf(codes.InvalidArgument, "invalid user name: %v", err)
}
+ if user == nil {
+ return nil, status.Errorf(codes.NotFound, "user not found")
+ }
+ userID := user.ID
currentUser, err := s.fetchCurrentUser(ctx)
if err != nil {
@@ -74,7 +81,7 @@ func (s *APIV1Service) ListShortcuts(ctx context.Context, request *v1pb.ListShor
shortcuts := []*v1pb.Shortcut{}
for _, shortcut := range shortcutsUserSetting.GetShortcuts() {
shortcuts = append(shortcuts, &v1pb.Shortcut{
- Name: constructShortcutName(userID, shortcut.GetId()),
+ Name: constructShortcutName(user.Username, shortcut.GetId()),
Title: shortcut.GetTitle(),
Filter: shortcut.GetFilter(),
})
@@ -86,10 +93,11 @@ func (s *APIV1Service) ListShortcuts(ctx context.Context, request *v1pb.ListShor
}
func (s *APIV1Service) GetShortcut(ctx context.Context, request *v1pb.GetShortcutRequest) (*v1pb.Shortcut, error) {
- userID, shortcutID, err := extractUserAndShortcutIDFromName(request.Name)
+ user, shortcutID, err := s.extractUserAndShortcutIDFromName(ctx, request.Name)
if err != nil {
return nil, status.Errorf(codes.InvalidArgument, "invalid shortcut name: %v", err)
}
+ userID := user.ID
currentUser, err := s.fetchCurrentUser(ctx)
if err != nil {
@@ -114,7 +122,7 @@ func (s *APIV1Service) GetShortcut(ctx context.Context, request *v1pb.GetShortcu
for _, shortcut := range shortcutsUserSetting.GetShortcuts() {
if shortcut.GetId() == shortcutID {
return &v1pb.Shortcut{
- Name: constructShortcutName(userID, shortcut.GetId()),
+ Name: constructShortcutName(user.Username, shortcut.GetId()),
Title: shortcut.GetTitle(),
Filter: shortcut.GetFilter(),
}, nil
@@ -125,10 +133,14 @@ func (s *APIV1Service) GetShortcut(ctx context.Context, request *v1pb.GetShortcu
}
func (s *APIV1Service) CreateShortcut(ctx context.Context, request *v1pb.CreateShortcutRequest) (*v1pb.Shortcut, error) {
- userID, err := ExtractUserIDFromName(request.Parent)
+ user, err := ResolveUserByName(ctx, s.Store, request.Parent)
if err != nil {
return nil, status.Errorf(codes.InvalidArgument, "invalid user name: %v", err)
}
+ if user == nil {
+ return nil, status.Errorf(codes.NotFound, "user not found")
+ }
+ userID := user.ID
currentUser, err := s.fetchCurrentUser(ctx)
if err != nil {
@@ -151,7 +163,7 @@ func (s *APIV1Service) CreateShortcut(ctx context.Context, request *v1pb.CreateS
}
if request.ValidateOnly {
return &v1pb.Shortcut{
- Name: constructShortcutName(userID, newShortcut.GetId()),
+ Name: constructShortcutName(user.Username, newShortcut.GetId()),
Title: newShortcut.GetTitle(),
Filter: newShortcut.GetFilter(),
}, nil
@@ -190,17 +202,18 @@ func (s *APIV1Service) CreateShortcut(ctx context.Context, request *v1pb.CreateS
}
return &v1pb.Shortcut{
- Name: constructShortcutName(userID, newShortcut.GetId()),
+ Name: constructShortcutName(user.Username, newShortcut.GetId()),
Title: newShortcut.GetTitle(),
Filter: newShortcut.GetFilter(),
}, nil
}
func (s *APIV1Service) UpdateShortcut(ctx context.Context, request *v1pb.UpdateShortcutRequest) (*v1pb.Shortcut, error) {
- userID, shortcutID, err := extractUserAndShortcutIDFromName(request.Shortcut.Name)
+ user, shortcutID, err := s.extractUserAndShortcutIDFromName(ctx, request.Shortcut.Name)
if err != nil {
return nil, status.Errorf(codes.InvalidArgument, "invalid shortcut name: %v", err)
}
+ userID := user.ID
currentUser, err := s.fetchCurrentUser(ctx)
if err != nil {
@@ -262,17 +275,18 @@ func (s *APIV1Service) UpdateShortcut(ctx context.Context, request *v1pb.UpdateS
}
return &v1pb.Shortcut{
- Name: constructShortcutName(userID, foundShortcut.GetId()),
+ Name: constructShortcutName(user.Username, foundShortcut.GetId()),
Title: foundShortcut.GetTitle(),
Filter: foundShortcut.GetFilter(),
}, nil
}
func (s *APIV1Service) DeleteShortcut(ctx context.Context, request *v1pb.DeleteShortcutRequest) (*emptypb.Empty, error) {
- userID, shortcutID, err := extractUserAndShortcutIDFromName(request.Name)
+ user, shortcutID, err := s.extractUserAndShortcutIDFromName(ctx, request.Name)
if err != nil {
return nil, status.Errorf(codes.InvalidArgument, "invalid shortcut name: %v", err)
}
+ userID := user.ID
currentUser, err := s.fetchCurrentUser(ctx)
if err != nil {
diff --git a/server/router/api/v1/sse_event_helpers.go b/server/router/api/v1/sse_event_helpers.go
new file mode 100644
index 000000000..40a527451
--- /dev/null
+++ b/server/router/api/v1/sse_event_helpers.go
@@ -0,0 +1,40 @@
+package v1
+
+import "github.com/usememos/memos/store"
+
+func buildMemoName(uid string) string {
+ return MemoNamePrefix + uid
+}
+
+// resolveSSECreatorID returns the CreatorID used for SSE delivery filtering.
+// For a comment memo, it returns the parent memo's CreatorID so that private
+// parent-memo events are scoped to the parent owner.
+func resolveSSECreatorID(memo *store.Memo, parentMemo *store.Memo) int32 {
+ if memo == nil {
+ return 0
+ }
+ if parentMemo != nil {
+ return parentMemo.CreatorID
+ }
+ return memo.CreatorID
+}
+
+// buildMemoReactionSSEEvent constructs an SSEEvent for a reaction on a memo.
+// Pass parentMemo when the memo is a comment (memo.ParentUID != nil).
+func buildMemoReactionSSEEvent(eventType SSEEventType, contentID string, memo *store.Memo, parentMemo *store.Memo) *SSEEvent {
+ parent := ""
+ if memo != nil && memo.ParentUID != nil {
+ parent = buildMemoName(*memo.ParentUID)
+ }
+ visibility := store.Visibility("")
+ if memo != nil {
+ visibility = memo.Visibility
+ }
+ return &SSEEvent{
+ Type: eventType,
+ Name: contentID,
+ Parent: parent,
+ Visibility: visibility,
+ CreatorID: resolveSSECreatorID(memo, parentMemo),
+ }
+}
diff --git a/server/router/api/v1/sse_handler.go b/server/router/api/v1/sse_handler.go
index 07b36d01c..a9f8f444f 100644
--- a/server/router/api/v1/sse_handler.go
+++ b/server/router/api/v1/sse_handler.go
@@ -17,10 +17,14 @@ const (
sseHeartbeatInterval = 30 * time.Second
)
-// RegisterSSERoutes registers the SSE endpoint on the given Echo instance.
-func RegisterSSERoutes(echoServer *echo.Echo, hub *SSEHub, storeInstance *store.Store, secret string) {
+type sseRouteRegistrar interface {
+ GET(path string, h echo.HandlerFunc, m ...echo.MiddlewareFunc) echo.RouteInfo
+}
+
+// RegisterSSERoutes registers the SSE endpoint on the given Echo router.
+func RegisterSSERoutes(router sseRouteRegistrar, hub *SSEHub, storeInstance *store.Store, secret string) {
authenticator := auth.NewAuthenticator(storeInstance, secret)
- echoServer.GET("/api/v1/sse", func(c *echo.Context) error {
+ router.GET("/api/v1/sse", func(c *echo.Context) error {
return handleSSE(c, hub, authenticator)
})
}
@@ -34,6 +38,10 @@ func handleSSE(c *echo.Context, hub *SSEHub, authenticator *auth.Authenticator)
if result == nil {
return c.JSON(http.StatusUnauthorized, map[string]string{"error": "authentication required"})
}
+ userID, role := getSSEClientIdentity(result)
+ if userID == 0 {
+ return c.JSON(http.StatusUnauthorized, map[string]string{"error": "authentication required"})
+ }
// Set SSE headers.
w := c.Response()
@@ -49,7 +57,7 @@ func handleSSE(c *echo.Context, hub *SSEHub, authenticator *auth.Authenticator)
}
// Subscribe to the hub.
- client := hub.Subscribe()
+ client := hub.Subscribe(userID, role)
defer hub.Unsubscribe(client)
// Create a ticker for heartbeat pings.
@@ -58,13 +66,13 @@ func handleSSE(c *echo.Context, hub *SSEHub, authenticator *auth.Authenticator)
ctx := c.Request().Context()
- slog.Debug("SSE client connected")
+ slog.Debug("SSE client connected", "userID", userID)
for {
select {
case <-ctx.Done():
// Client disconnected.
- slog.Debug("SSE client disconnected")
+ slog.Debug("SSE client disconnected", "userID", userID)
return nil
case data, ok := <-client.events:
@@ -91,3 +99,16 @@ func handleSSE(c *echo.Context, hub *SSEHub, authenticator *auth.Authenticator)
}
}
}
+
+func getSSEClientIdentity(result *auth.AuthResult) (int32, store.Role) {
+ if result == nil {
+ return 0, store.RoleUser
+ }
+ if result.Claims != nil {
+ return result.Claims.UserID, store.Role(result.Claims.Role)
+ }
+ if result.User != nil {
+ return result.User.ID, result.User.Role
+ }
+ return 0, store.RoleUser
+}
diff --git a/server/router/api/v1/sse_hub.go b/server/router/api/v1/sse_hub.go
index 1fecad8af..a04c2474c 100644
--- a/server/router/api/v1/sse_hub.go
+++ b/server/router/api/v1/sse_hub.go
@@ -4,6 +4,8 @@ import (
"encoding/json"
"log/slog"
"sync"
+
+ "github.com/usememos/memos/store"
)
// SSEEventType represents the type of change event.
@@ -24,6 +26,11 @@ type SSEEvent struct {
// Name is the affected resource name (e.g., "memos/xxxx").
// For reaction events, this is the memo resource name that the reaction belongs to.
Name string `json:"name"`
+ // Parent is the parent memo resource name when the affected resource is a comment.
+ Parent string `json:"parent,omitempty"`
+ // Visibility and CreatorID are used only for server-side delivery filtering.
+ Visibility store.Visibility `json:"-"`
+ CreatorID int32 `json:"-"`
}
// JSON returns the JSON representation of the event.
@@ -40,6 +47,8 @@ func (e *SSEEvent) JSON() []byte {
// SSEClient represents a single SSE connection.
type SSEClient struct {
events chan []byte
+ userID int32
+ role store.Role
}
// SSEHub manages SSE client connections and broadcasts events.
@@ -58,10 +67,12 @@ func NewSSEHub() *SSEHub {
// Subscribe registers a new client and returns it.
// The caller must call Unsubscribe when done.
-func (h *SSEHub) Subscribe() *SSEClient {
+func (h *SSEHub) Subscribe(userID int32, role store.Role) *SSEClient {
c := &SSEClient{
// Buffer a few events so a slow client doesn't block broadcasting.
events: make(chan []byte, 32),
+ userID: userID,
+ role: role,
}
h.mu.Lock()
h.clients[c] = struct{}{}
@@ -90,6 +101,9 @@ func (h *SSEHub) Broadcast(event *SSEEvent) {
h.mu.RLock()
defer h.mu.RUnlock()
for c := range h.clients {
+ if !c.canReceive(event) {
+ continue
+ }
select {
case c.events <- data:
default:
@@ -97,3 +111,15 @@ func (h *SSEHub) Broadcast(event *SSEEvent) {
}
}
}
+
+func (c *SSEClient) canReceive(event *SSEEvent) bool {
+ switch event.Visibility {
+ case store.Private:
+ return c.userID == event.CreatorID || c.role == store.RoleAdmin
+ case store.Public, store.Protected, "":
+ return true
+ default:
+ slog.Warn("SSE canReceive: unknown visibility type, denying event", "visibility", event.Visibility)
+ return false
+ }
+}
diff --git a/server/router/api/v1/sse_hub_test.go b/server/router/api/v1/sse_hub_test.go
index d7d6d2c8a..42e01091a 100644
--- a/server/router/api/v1/sse_hub_test.go
+++ b/server/router/api/v1/sse_hub_test.go
@@ -6,12 +6,36 @@ import (
"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"
+
+ "github.com/usememos/memos/store"
)
+// helpers shared by multiple tests in this file.
+
+func mustReceive(t *testing.T, ch <-chan []byte, within time.Duration) []byte {
+ t.Helper()
+ select {
+ case data := <-ch:
+ return data
+ case <-time.After(within):
+ t.Fatal("timed out waiting for SSE event")
+ return nil
+ }
+}
+
+func mustNotReceive(t *testing.T, ch <-chan []byte, within time.Duration) {
+ t.Helper()
+ select {
+ case data := <-ch:
+ t.Fatalf("unexpected SSE event received: %s", data)
+ case <-time.After(within):
+ }
+}
+
func TestSSEHub_SubscribeUnsubscribe(t *testing.T) {
hub := NewSSEHub()
- client := hub.Subscribe()
+ client := hub.Subscribe(1, store.RoleUser)
require.NotNil(t, client)
require.NotNil(t, client.events)
@@ -25,7 +49,7 @@ func TestSSEHub_SubscribeUnsubscribe(t *testing.T) {
func TestSSEHub_Broadcast(t *testing.T) {
hub := NewSSEHub()
- client := hub.Subscribe()
+ client := hub.Subscribe(1, store.RoleUser)
defer hub.Unsubscribe(client)
event := &SSEEvent{Type: SSEEventMemoCreated, Name: "memos/123"}
@@ -42,9 +66,9 @@ func TestSSEHub_Broadcast(t *testing.T) {
func TestSSEHub_BroadcastMultipleClients(t *testing.T) {
hub := NewSSEHub()
- c1 := hub.Subscribe()
+ c1 := hub.Subscribe(1, store.RoleUser)
defer hub.Unsubscribe(c1)
- c2 := hub.Subscribe()
+ c2 := hub.Subscribe(2, store.RoleUser)
defer hub.Unsubscribe(c2)
event := &SSEEvent{Type: SSEEventMemoDeleted, Name: "memos/456"}
@@ -62,9 +86,144 @@ func TestSSEHub_BroadcastMultipleClients(t *testing.T) {
}
func TestSSEEvent_JSON(t *testing.T) {
- e := &SSEEvent{Type: SSEEventMemoUpdated, Name: "memos/789"}
+ e := &SSEEvent{Type: SSEEventMemoUpdated, Name: "memos/789", Parent: "memos/123"}
data := e.JSON()
require.NotEmpty(t, data)
assert.Contains(t, string(data), `"type":"memo.updated"`)
assert.Contains(t, string(data), `"name":"memos/789"`)
+ assert.Contains(t, string(data), `"parent":"memos/123"`)
+}
+
+func TestSSEHub_PrivateEventsAreScoped(t *testing.T) {
+ hub := NewSSEHub()
+ owner := hub.Subscribe(1, store.RoleUser)
+ defer hub.Unsubscribe(owner)
+ other := hub.Subscribe(2, store.RoleUser)
+ defer hub.Unsubscribe(other)
+ admin := hub.Subscribe(3, store.RoleAdmin)
+ defer hub.Unsubscribe(admin)
+
+ hub.Broadcast(&SSEEvent{
+ Type: SSEEventMemoUpdated,
+ Name: "memos/private",
+ Visibility: store.Private,
+ CreatorID: 1,
+ })
+
+ select {
+ case <-owner.events:
+ case <-time.After(time.Second):
+ t.Fatal("owner should receive private event")
+ }
+
+ select {
+ case <-admin.events:
+ case <-time.After(time.Second):
+ t.Fatal("admin should receive private event")
+ }
+
+ select {
+ case <-other.events:
+ t.Fatal("non-owner should not receive private event")
+ case <-time.After(100 * time.Millisecond):
+ }
+}
+
+func TestSSEClient_CanReceive_UnknownVisibility(t *testing.T) {
+ hub := NewSSEHub()
+ client := hub.Subscribe(1, store.RoleUser)
+ defer hub.Unsubscribe(client)
+
+ // An event with an unrecognised visibility value should be denied (safe default).
+ hub.Broadcast(&SSEEvent{
+ Type: SSEEventMemoUpdated,
+ Name: "memos/unknown-vis",
+ Visibility: store.Visibility("CUSTOM"),
+ })
+
+ mustNotReceive(t, client.events, 100*time.Millisecond)
+}
+
+func TestSSEHub_SlowClientEventsDropped(t *testing.T) {
+ hub := NewSSEHub()
+ // Subscribe but never read, so the channel fills up.
+ slow := hub.Subscribe(1, store.RoleUser)
+ defer hub.Unsubscribe(slow)
+
+ event := &SSEEvent{Type: SSEEventMemoCreated, Name: "memos/x"}
+ // Send more events than the buffer capacity (32).
+ for range 40 {
+ hub.Broadcast(event) // must not block
+ }
+
+ // At most 32 events should have been queued; the rest were silently dropped.
+ assert.LessOrEqual(t, len(slow.events), 32)
+}
+
+func TestResolveSSECreatorID(t *testing.T) {
+ tests := []struct {
+ name string
+ memo *store.Memo
+ parentMemo *store.Memo
+ want int32
+ }{
+ {
+ name: "nil memo returns 0",
+ memo: nil, parentMemo: nil,
+ want: 0,
+ },
+ {
+ name: "memo without parent returns memo CreatorID",
+ memo: &store.Memo{CreatorID: 5},
+ parentMemo: nil,
+ want: 5,
+ },
+ {
+ name: "memo with parent returns parent CreatorID",
+ memo: &store.Memo{CreatorID: 5},
+ parentMemo: &store.Memo{CreatorID: 9},
+ want: 9,
+ },
+ }
+ for _, tc := range tests {
+ t.Run(tc.name, func(t *testing.T) {
+ assert.Equal(t, tc.want, resolveSSECreatorID(tc.memo, tc.parentMemo))
+ })
+ }
+}
+
+func TestBuildMemoReactionSSEEvent(t *testing.T) {
+ parentUID := "parent-uid"
+
+ t.Run("top-level memo reaction", func(t *testing.T) {
+ memo := &store.Memo{CreatorID: 10, Visibility: store.Public}
+ event := buildMemoReactionSSEEvent(SSEEventReactionUpserted, "memos/abc", memo, nil)
+ assert.Equal(t, SSEEventReactionUpserted, event.Type)
+ assert.Equal(t, "memos/abc", event.Name)
+ assert.Equal(t, "", event.Parent)
+ assert.Equal(t, store.Public, event.Visibility)
+ assert.Equal(t, int32(10), event.CreatorID)
+ })
+
+ t.Run("reaction on comment is scoped to parent owner", func(t *testing.T) {
+ memo := &store.Memo{
+ CreatorID: 10,
+ Visibility: store.Private,
+ ParentUID: &parentUID,
+ }
+ parentMemo := &store.Memo{CreatorID: 7}
+ event := buildMemoReactionSSEEvent(SSEEventReactionDeleted, "memos/abc", memo, parentMemo)
+ assert.Equal(t, SSEEventReactionDeleted, event.Type)
+ assert.Equal(t, MemoNamePrefix+parentUID, event.Parent)
+ assert.Equal(t, store.Private, event.Visibility)
+ assert.Equal(t, int32(7), event.CreatorID)
+ })
+
+ t.Run("nil memo produces a safe zero-value event", func(t *testing.T) {
+ event := buildMemoReactionSSEEvent(SSEEventReactionUpserted, "memos/abc", nil, nil)
+ assert.Equal(t, "memos/abc", event.Name)
+ assert.Equal(t, "", event.Parent)
+ assert.Equal(t, store.Visibility(""), event.Visibility)
+ assert.Equal(t, int32(0), event.CreatorID)
+ })
}
diff --git a/server/router/api/v1/sse_service_test.go b/server/router/api/v1/sse_service_test.go
new file mode 100644
index 000000000..689a35b31
--- /dev/null
+++ b/server/router/api/v1/sse_service_test.go
@@ -0,0 +1,272 @@
+package v1
+
+import (
+ "context"
+ "strings"
+ "testing"
+ "time"
+
+ "github.com/stretchr/testify/assert"
+ "github.com/stretchr/testify/require"
+
+ "github.com/usememos/memos/internal/profile"
+ v1pb "github.com/usememos/memos/proto/gen/api/v1"
+ "github.com/usememos/memos/server/auth"
+ "github.com/usememos/memos/store"
+ teststore "github.com/usememos/memos/store/test"
+)
+
+// newIntegrationService builds a minimal APIV1Service backed by an in-memory
+// SQLite database. The store is closed automatically via t.Cleanup.
+func newIntegrationService(t *testing.T) *APIV1Service {
+ t.Helper()
+ ctx := context.Background()
+ st := teststore.NewTestingStore(ctx, t)
+ t.Cleanup(func() { st.Close() })
+ p := &profile.Profile{Demo: true, Data: t.TempDir(), Driver: "sqlite", DSN: ":memory:"}
+ return NewAPIV1Service("test-secret", p, st)
+}
+
+// userCtx returns a context that authenticates as the given user.
+func userCtx(ctx context.Context, userID int32) context.Context {
+ return context.WithValue(ctx, auth.UserIDContextKey, userID)
+}
+
+// collectEventsFor reads events from ch for the given duration and returns them.
+func collectEventsFor(ch <-chan []byte, d time.Duration) []string {
+ var out []string
+ deadline := time.After(d)
+ for {
+ select {
+ case data := <-ch:
+ out = append(out, string(data))
+ case <-deadline:
+ return out
+ }
+ }
+}
+
+// ---- context suppression ----
+
+func TestSuppressSSEContext(t *testing.T) {
+ ctx := context.Background()
+
+ t.Run("default context is not suppressed", func(t *testing.T) {
+ assert.False(t, isSSESuppressed(ctx))
+ })
+
+ t.Run("withSuppressSSE marks context as suppressed", func(t *testing.T) {
+ assert.True(t, isSSESuppressed(withSuppressSSE(ctx)))
+ })
+
+ t.Run("suppression does not bleed into parent context", func(t *testing.T) {
+ suppressed := withSuppressSSE(ctx)
+ _ = suppressed
+ assert.False(t, isSSESuppressed(ctx))
+ })
+}
+
+// ---- CreateMemoComment double-broadcast fix ----
+
+func TestCreateMemoComment_NoDuplicateSSEBroadcast(t *testing.T) {
+ ctx := context.Background()
+ svc := newIntegrationService(t)
+
+ // Create an admin so the store is initialised, then a regular commenter.
+ author, err := svc.Store.CreateUser(ctx, &store.User{
+ Username: "author", Role: store.RoleAdmin, Email: "author@example.com",
+ })
+ require.NoError(t, err)
+ commenter, err := svc.Store.CreateUser(ctx, &store.User{
+ Username: "commenter", Role: store.RoleUser, Email: "commenter@example.com",
+ })
+ require.NoError(t, err)
+
+ authorCtx := userCtx(ctx, author.ID)
+ commenterCtx := userCtx(ctx, commenter.ID)
+
+ // Create a public memo so the commenter can react.
+ parent, err := svc.CreateMemo(authorCtx, &v1pb.CreateMemoRequest{
+ Memo: &v1pb.Memo{Content: "parent memo", Visibility: v1pb.Visibility_PUBLIC},
+ })
+ require.NoError(t, err)
+
+ // Subscribe after the parent memo is created so the memo.created event
+ // for the parent does not pollute the assertion window.
+ client := svc.SSEHub.Subscribe(author.ID, store.RoleAdmin)
+ defer svc.SSEHub.Unsubscribe(client)
+
+ // Create a comment. Before the fix, this fired both memo.created (for the
+ // comment memo) and memo.comment.created (for the parent).
+ _, err = svc.CreateMemoComment(commenterCtx, &v1pb.CreateMemoCommentRequest{
+ Name: parent.Name,
+ Comment: &v1pb.Memo{Content: "a comment", Visibility: v1pb.Visibility_PUBLIC},
+ })
+ require.NoError(t, err)
+
+ // Give the synchronous broadcast a moment to land in the buffer, then
+ // collect everything that arrived.
+ events := collectEventsFor(client.events, 150*time.Millisecond)
+
+ require.Len(t, events, 1, "expected exactly one SSE event for a comment creation, got: %v", events)
+ assert.True(t, strings.Contains(events[0], `"memo.comment.created"`),
+ "expected memo.comment.created, got: %s", events[0])
+}
+
+// ---- Reaction SSE events carry correct visibility / parent fields ----
+
+func TestUpsertMemoReaction_SSEEvent(t *testing.T) {
+ ctx := context.Background()
+ svc := newIntegrationService(t)
+
+ user, err := svc.Store.CreateUser(ctx, &store.User{
+ Username: "user", Role: store.RoleAdmin, Email: "user@example.com",
+ })
+ require.NoError(t, err)
+ uctx := userCtx(ctx, user.ID)
+
+ memo, err := svc.CreateMemo(uctx, &v1pb.CreateMemoRequest{
+ Memo: &v1pb.Memo{Content: "reacted memo", Visibility: v1pb.Visibility_PUBLIC},
+ })
+ require.NoError(t, err)
+
+ client := svc.SSEHub.Subscribe(user.ID, store.RoleAdmin)
+ defer svc.SSEHub.Unsubscribe(client)
+
+ _, err = svc.UpsertMemoReaction(uctx, &v1pb.UpsertMemoReactionRequest{
+ Name: memo.Name,
+ Reaction: &v1pb.Reaction{
+ ContentId: memo.Name,
+ ReactionType: "👍",
+ },
+ })
+ require.NoError(t, err)
+
+ data := mustReceive(t, client.events, time.Second)
+ payload := string(data)
+ assert.Contains(t, payload, `"reaction.upserted"`)
+ assert.Contains(t, payload, memo.Name)
+ mustNotReceive(t, client.events, 100*time.Millisecond)
+}
+
+func TestDeleteMemoReaction_SSEEvent(t *testing.T) {
+ ctx := context.Background()
+ svc := newIntegrationService(t)
+
+ user, err := svc.Store.CreateUser(ctx, &store.User{
+ Username: "user", Role: store.RoleAdmin, Email: "user@example.com",
+ })
+ require.NoError(t, err)
+ uctx := userCtx(ctx, user.ID)
+
+ memo, err := svc.CreateMemo(uctx, &v1pb.CreateMemoRequest{
+ Memo: &v1pb.Memo{Content: "reacted memo", Visibility: v1pb.Visibility_PUBLIC},
+ })
+ require.NoError(t, err)
+
+ reaction, err := svc.UpsertMemoReaction(uctx, &v1pb.UpsertMemoReactionRequest{
+ Name: memo.Name,
+ Reaction: &v1pb.Reaction{
+ ContentId: memo.Name,
+ ReactionType: "❤️",
+ },
+ })
+ require.NoError(t, err)
+
+ client := svc.SSEHub.Subscribe(user.ID, store.RoleAdmin)
+ defer svc.SSEHub.Unsubscribe(client)
+
+ _, err = svc.DeleteMemoReaction(uctx, &v1pb.DeleteMemoReactionRequest{
+ Name: reaction.Name,
+ })
+ require.NoError(t, err)
+
+ data := mustReceive(t, client.events, time.Second)
+ payload := string(data)
+ assert.Contains(t, payload, `"reaction.deleted"`)
+ assert.Contains(t, payload, memo.Name)
+ mustNotReceive(t, client.events, 100*time.Millisecond)
+}
+
+func TestSetMemoAttachments_EmitsMemoUpdatedSSEEvent(t *testing.T) {
+ ctx := context.Background()
+ svc := newIntegrationService(t)
+
+ user, err := svc.Store.CreateUser(ctx, &store.User{
+ Username: "user", Role: store.RoleAdmin, Email: "user@example.com",
+ })
+ require.NoError(t, err)
+ uctx := userCtx(ctx, user.ID)
+
+ memo, err := svc.CreateMemo(uctx, &v1pb.CreateMemoRequest{
+ Memo: &v1pb.Memo{Content: "memo with attachments", Visibility: v1pb.Visibility_PUBLIC},
+ })
+ require.NoError(t, err)
+
+ attachment, err := svc.CreateAttachment(uctx, &v1pb.CreateAttachmentRequest{
+ Attachment: &v1pb.Attachment{
+ Filename: "test.txt",
+ Size: 5,
+ Type: "text/plain",
+ Content: []byte("hello"),
+ },
+ })
+ require.NoError(t, err)
+
+ client := svc.SSEHub.Subscribe(user.ID, store.RoleAdmin)
+ defer svc.SSEHub.Unsubscribe(client)
+
+ _, err = svc.SetMemoAttachments(uctx, &v1pb.SetMemoAttachmentsRequest{
+ Name: memo.Name,
+ Attachments: []*v1pb.Attachment{
+ {Name: attachment.Name},
+ },
+ })
+ require.NoError(t, err)
+
+ data := mustReceive(t, client.events, time.Second)
+ payload := string(data)
+ assert.Contains(t, payload, `"memo.updated"`)
+ assert.Contains(t, payload, memo.Name)
+ mustNotReceive(t, client.events, 100*time.Millisecond)
+}
+
+func TestSetMemoRelations_EmitsMemoUpdatedSSEEvent(t *testing.T) {
+ ctx := context.Background()
+ svc := newIntegrationService(t)
+
+ user, err := svc.Store.CreateUser(ctx, &store.User{
+ Username: "user", Role: store.RoleAdmin, Email: "user@example.com",
+ })
+ require.NoError(t, err)
+ uctx := userCtx(ctx, user.ID)
+
+ memo1, err := svc.CreateMemo(uctx, &v1pb.CreateMemoRequest{
+ Memo: &v1pb.Memo{Content: "memo one", Visibility: v1pb.Visibility_PUBLIC},
+ })
+ require.NoError(t, err)
+ memo2, err := svc.CreateMemo(uctx, &v1pb.CreateMemoRequest{
+ Memo: &v1pb.Memo{Content: "memo two", Visibility: v1pb.Visibility_PUBLIC},
+ })
+ require.NoError(t, err)
+
+ client := svc.SSEHub.Subscribe(user.ID, store.RoleAdmin)
+ defer svc.SSEHub.Unsubscribe(client)
+
+ _, err = svc.SetMemoRelations(uctx, &v1pb.SetMemoRelationsRequest{
+ Name: memo1.Name,
+ Relations: []*v1pb.MemoRelation{
+ {
+ RelatedMemo: &v1pb.MemoRelation_Memo{Name: memo2.Name},
+ Type: v1pb.MemoRelation_REFERENCE,
+ },
+ },
+ })
+ require.NoError(t, err)
+
+ data := mustReceive(t, client.events, time.Second)
+ payload := string(data)
+ assert.Contains(t, payload, `"memo.updated"`)
+ assert.Contains(t, payload, memo1.Name)
+ mustNotReceive(t, client.events, 100*time.Millisecond)
+}
diff --git a/server/router/api/v1/test/attachment_service_test.go b/server/router/api/v1/test/attachment_service_test.go
index 2ef523bf1..9df22eb13 100644
--- a/server/router/api/v1/test/attachment_service_test.go
+++ b/server/router/api/v1/test/attachment_service_test.go
@@ -7,6 +7,9 @@ import (
"github.com/stretchr/testify/require"
v1pb "github.com/usememos/memos/proto/gen/api/v1"
+ storepb "github.com/usememos/memos/proto/gen/store"
+ apiv1 "github.com/usememos/memos/server/router/api/v1"
+ "github.com/usememos/memos/store"
)
func TestCreateAttachment(t *testing.T) {
@@ -56,4 +59,56 @@ func TestCreateAttachment(t *testing.T) {
require.NoError(t, err)
require.Equal(t, "application/octet-stream", attachment.Type)
})
+
+ t.Run("LocalStorage_PathCollisionUsesUniqueReference", func(t *testing.T) {
+ _, err := ts.Store.UpsertInstanceSetting(ctx, &storepb.InstanceSetting{
+ Key: storepb.InstanceSettingKey_STORAGE,
+ Value: &storepb.InstanceSetting_StorageSetting{
+ StorageSetting: &storepb.InstanceStorageSetting{
+ StorageType: storepb.InstanceStorageSetting_LOCAL,
+ FilepathTemplate: "assets/{filename}",
+ },
+ },
+ })
+ require.NoError(t, err)
+
+ first, err := ts.Service.CreateAttachment(userCtx, &v1pb.CreateAttachmentRequest{
+ Attachment: &v1pb.Attachment{
+ Filename: "screenshot.png",
+ Type: "image/png",
+ Content: []byte("first-image"),
+ },
+ })
+ require.NoError(t, err)
+
+ second, err := ts.Service.CreateAttachment(userCtx, &v1pb.CreateAttachmentRequest{
+ Attachment: &v1pb.Attachment{
+ Filename: "screenshot.png",
+ Type: "image/png",
+ Content: []byte("second-image"),
+ },
+ })
+ require.NoError(t, err)
+
+ firstUID, err := apiv1.ExtractAttachmentUIDFromName(first.Name)
+ require.NoError(t, err)
+ secondUID, err := apiv1.ExtractAttachmentUIDFromName(second.Name)
+ require.NoError(t, err)
+
+ firstStoreAttachment, err := ts.Store.GetAttachment(ctx, &store.FindAttachment{UID: &firstUID})
+ require.NoError(t, err)
+ secondStoreAttachment, err := ts.Store.GetAttachment(ctx, &store.FindAttachment{UID: &secondUID})
+ require.NoError(t, err)
+ require.NotNil(t, firstStoreAttachment)
+ require.NotNil(t, secondStoreAttachment)
+
+ require.NotEqual(t, firstStoreAttachment.Reference, secondStoreAttachment.Reference)
+
+ firstBlob, err := ts.Service.GetAttachmentBlob(firstStoreAttachment)
+ require.NoError(t, err)
+ secondBlob, err := ts.Service.GetAttachmentBlob(secondStoreAttachment)
+ require.NoError(t, err)
+ require.Equal(t, []byte("first-image"), firstBlob)
+ require.Equal(t, []byte("second-image"), secondBlob)
+ })
}
diff --git a/server/router/api/v1/test/idp_service_test.go b/server/router/api/v1/test/idp_service_test.go
index 302a2737e..a2e88a1f4 100644
--- a/server/router/api/v1/test/idp_service_test.go
+++ b/server/router/api/v1/test/idp_service_test.go
@@ -8,6 +8,8 @@ import (
"google.golang.org/protobuf/types/known/fieldmaskpb"
v1pb "github.com/usememos/memos/proto/gen/api/v1"
+ apiv1 "github.com/usememos/memos/server/router/api/v1"
+ "github.com/usememos/memos/store"
)
func TestCreateIdentityProvider(t *testing.T) {
@@ -233,7 +235,7 @@ func TestGetIdentityProvider(t *testing.T) {
Name: created.Name,
}
- // Test unauthenticated, should not contain client secret
+ // ClientSecret is write-only: never returned in responses, even to admins.
resp, err := ts.Service.GetIdentityProvider(ctx, getReq)
require.NoError(t, err)
require.NotNil(t, resp)
@@ -242,18 +244,16 @@ func TestGetIdentityProvider(t *testing.T) {
require.Equal(t, v1pb.IdentityProvider_OAUTH2, resp.Type)
require.NotNil(t, resp.Config.GetOauth2Config())
require.Equal(t, "test-client", resp.Config.GetOauth2Config().ClientId)
- require.Equal(t, "", resp.Config.GetOauth2Config().ClientSecret)
+ require.Empty(t, resp.Config.GetOauth2Config().ClientSecret,
+ "ClientSecret must never be returned in responses")
- // Test as host user, should contain client secret
- respHostUser, err := ts.Service.GetIdentityProvider(userCtx, getReq)
+ // Same for admin: secret is still write-only.
+ respAdmin, err := ts.Service.GetIdentityProvider(userCtx, getReq)
require.NoError(t, err)
- require.NotNil(t, respHostUser)
- require.Equal(t, created.Name, respHostUser.Name)
- require.Equal(t, "Test Provider", respHostUser.Title)
- require.Equal(t, v1pb.IdentityProvider_OAUTH2, respHostUser.Type)
- require.NotNil(t, respHostUser.Config.GetOauth2Config())
- require.Equal(t, "test-client", respHostUser.Config.GetOauth2Config().ClientId)
- require.Equal(t, "test-secret", respHostUser.Config.GetOauth2Config().ClientSecret)
+ require.NotNil(t, respAdmin)
+ require.Equal(t, "test-client", respAdmin.Config.GetOauth2Config().ClientId)
+ require.Empty(t, respAdmin.Config.GetOauth2Config().ClientSecret,
+ "ClientSecret must never be returned in responses, even to admins")
})
t.Run("GetIdentityProvider not found", func(t *testing.T) {
@@ -361,6 +361,67 @@ func TestUpdateIdentityProvider(t *testing.T) {
require.Equal(t, "updated-client", updated.Config.GetOauth2Config().ClientId)
})
+ t.Run("UpdateIdentityProvider empty ClientSecret preserves existing credential", func(t *testing.T) {
+ ts := NewTestService(t)
+ defer ts.Cleanup()
+
+ hostUser, err := ts.CreateHostUser(ctx, "admin")
+ require.NoError(t, err)
+ userCtx := ts.CreateUserContext(ctx, hostUser.ID)
+
+ // Create IDP with a real secret.
+ created, err := ts.Service.CreateIdentityProvider(userCtx, &v1pb.CreateIdentityProviderRequest{
+ IdentityProvider: &v1pb.IdentityProvider{
+ Title: "Preserve Secret Test",
+ Type: v1pb.IdentityProvider_OAUTH2,
+ Config: &v1pb.IdentityProviderConfig{
+ Config: &v1pb.IdentityProviderConfig_Oauth2Config{
+ Oauth2Config: &v1pb.OAuth2Config{
+ ClientId: "cid",
+ ClientSecret: "original-secret",
+ AuthUrl: "https://ex.com/auth",
+ TokenUrl: "https://ex.com/token",
+ UserInfoUrl: "https://ex.com/user",
+ FieldMapping: &v1pb.FieldMapping{Identifier: "id"},
+ },
+ },
+ },
+ },
+ })
+ require.NoError(t, err)
+
+ // Update with empty ClientSecret (simulating UI that doesn't resend the secret).
+ _, err = ts.Service.UpdateIdentityProvider(userCtx, &v1pb.UpdateIdentityProviderRequest{
+ IdentityProvider: &v1pb.IdentityProvider{
+ Name: created.Name,
+ Title: "Updated Title",
+ Type: v1pb.IdentityProvider_OAUTH2,
+ Config: &v1pb.IdentityProviderConfig{
+ Config: &v1pb.IdentityProviderConfig_Oauth2Config{
+ Oauth2Config: &v1pb.OAuth2Config{
+ ClientId: "cid",
+ ClientSecret: "", // empty = preserve existing
+ AuthUrl: "https://ex.com/auth",
+ TokenUrl: "https://ex.com/token",
+ UserInfoUrl: "https://ex.com/user",
+ FieldMapping: &v1pb.FieldMapping{Identifier: "id"},
+ },
+ },
+ },
+ },
+ UpdateMask: &fieldmaskpb.FieldMask{Paths: []string{"title", "config"}},
+ })
+ require.NoError(t, err)
+
+ // Verify the stored secret was preserved by reading from store directly.
+ uid, _ := apiv1.ExtractIdentityProviderUIDFromName(created.Name)
+ stored, err := ts.Store.GetIdentityProvider(ctx, &store.FindIdentityProvider{UID: &uid})
+ require.NoError(t, err)
+ require.Equal(t, "original-secret", stored.Config.GetOauth2Config().ClientSecret,
+ "existing ClientSecret must be preserved when an empty value is sent")
+ require.Equal(t, "Updated Title", stored.Name)
+ })
+
t.Run("UpdateIdentityProvider missing update mask", func(t *testing.T) {
ts := NewTestService(t)
defer ts.Cleanup()
diff --git a/server/router/api/v1/test/instance_service_test.go b/server/router/api/v1/test/instance_service_test.go
index 609989dab..eac97b58e 100644
--- a/server/router/api/v1/test/instance_service_test.go
+++ b/server/router/api/v1/test/instance_service_test.go
@@ -204,21 +204,38 @@ func TestGetInstanceSetting(t *testing.T) {
require.Empty(t, resp.GetTagsSetting().GetTags())
})
- t.Run("GetInstanceSetting - notification setting", func(t *testing.T) {
+ t.Run("GetInstanceSetting - notification setting requires admin", func(t *testing.T) {
ts := NewTestService(t)
defer ts.Cleanup()
- req := &v1pb.GetInstanceSettingRequest{
- Name: "instance/settings/NOTIFICATION",
- }
- resp, err := ts.Service.GetInstanceSetting(ctx, req)
+ admin, err := ts.CreateHostUser(ctx, "admin")
+ require.NoError(t, err)
+ adminCtx := ts.CreateUserContext(ctx, admin.ID)
+ regularUser, err := ts.CreateRegularUser(ctx, "user")
+ require.NoError(t, err)
+ userCtx := ts.CreateUserContext(ctx, regularUser.ID)
+
+ req := &v1pb.GetInstanceSettingRequest{Name: "instance/settings/NOTIFICATION"}
+
+ // Unauthenticated request must be rejected.
+ _, err = ts.Service.GetInstanceSetting(ctx, req)
+ require.Error(t, err)
+ require.Contains(t, err.Error(), "not authenticated")
+
+ // Non-admin request must be rejected.
+ _, err = ts.Service.GetInstanceSetting(userCtx, req)
+ require.Error(t, err)
+ require.Contains(t, err.Error(), "permission denied")
+
+ // Admin request succeeds and does NOT expose SmtpPassword.
+ resp, err := ts.Service.GetInstanceSetting(adminCtx, req)
require.NoError(t, err)
require.NotNil(t, resp)
require.Equal(t, "instance/settings/NOTIFICATION", resp.Name)
require.NotNil(t, resp.GetNotificationSetting())
- require.NotNil(t, resp.GetNotificationSetting().GetEmail())
- require.False(t, resp.GetNotificationSetting().GetEmail().GetEnabled())
+ require.Empty(t, resp.GetNotificationSetting().GetEmail().GetSmtpPassword(),
+ "SmtpPassword must never be returned in responses")
})
t.Run("GetInstanceSetting - invalid setting name", func(t *testing.T) {
@@ -301,7 +318,7 @@ func TestUpdateInstanceSetting(t *testing.T) {
require.Contains(t, err.Error(), "invalid instance setting")
})
- t.Run("UpdateInstanceSetting - notification setting", func(t *testing.T) {
+ t.Run("UpdateInstanceSetting - tags setting without color", func(t *testing.T) {
ts := NewTestService(t)
defer ts.Cleanup()
@@ -309,6 +326,36 @@ func TestUpdateInstanceSetting(t *testing.T) {
require.NoError(t, err)
resp, err := ts.Service.UpdateInstanceSetting(ts.CreateUserContext(ctx, hostUser.ID), &v1pb.UpdateInstanceSettingRequest{
+ Setting: &v1pb.InstanceSetting{
+ Name: "instance/settings/TAGS",
+ Value: &v1pb.InstanceSetting_TagsSetting_{
+ TagsSetting: &v1pb.InstanceSetting_TagsSetting{
+ Tags: map[string]*v1pb.InstanceSetting_TagMetadata{
+ "spoiler": {
+ BlurContent: true,
+ },
+ },
+ },
+ },
+ },
+ })
+ require.NoError(t, err)
+ require.NotNil(t, resp.GetTagsSetting())
+ require.Contains(t, resp.GetTagsSetting().GetTags(), "spoiler")
+ require.Nil(t, resp.GetTagsSetting().GetTags()["spoiler"].GetBackgroundColor())
+ require.True(t, resp.GetTagsSetting().GetTags()["spoiler"].GetBlurContent())
+ })
+
+ t.Run("UpdateInstanceSetting - notification setting password is write-only", func(t *testing.T) {
+ ts := NewTestService(t)
+ defer ts.Cleanup()
+
+ hostUser, err := ts.CreateHostUser(ctx, "admin")
+ require.NoError(t, err)
+ adminCtx := ts.CreateUserContext(ctx, hostUser.ID)
+
+ // Save notification setting with a password.
+ resp, err := ts.Service.UpdateInstanceSetting(adminCtx, &v1pb.UpdateInstanceSettingRequest{
Setting: &v1pb.InstanceSetting{
Name: "instance/settings/NOTIFICATION",
Value: &v1pb.InstanceSetting_NotificationSetting_{
@@ -330,9 +377,117 @@ func TestUpdateInstanceSetting(t *testing.T) {
UpdateMask: &fieldmaskpb.FieldMask{Paths: []string{"notification_setting"}},
})
require.NoError(t, err)
- require.NotNil(t, resp.GetNotificationSetting())
- require.NotNil(t, resp.GetNotificationSetting().GetEmail())
require.True(t, resp.GetNotificationSetting().GetEmail().GetEnabled())
require.Equal(t, "smtp.example.com", resp.GetNotificationSetting().GetEmail().GetSmtpHost())
+ // Password must not be returned even in the update response.
+ require.Empty(t, resp.GetNotificationSetting().GetEmail().GetSmtpPassword(),
+ "SmtpPassword must never be returned in responses")
+ })
+
+ t.Run("UpdateInstanceSetting - empty password preserves existing credential", func(t *testing.T) {
+ ts := NewTestService(t)
+ defer ts.Cleanup()
+
+ hostUser, err := ts.CreateHostUser(ctx, "admin")
+ require.NoError(t, err)
+ adminCtx := ts.CreateUserContext(ctx, hostUser.ID)
+
+ notificationSetting := &v1pb.InstanceSetting{
+ Name: "instance/settings/NOTIFICATION",
+ Value: &v1pb.InstanceSetting_NotificationSetting_{
+ NotificationSetting: &v1pb.InstanceSetting_NotificationSetting{
+ Email: &v1pb.InstanceSetting_NotificationSetting_EmailSetting{
+ Enabled: true,
+ SmtpHost: "smtp.example.com",
+ SmtpPort: 587,
+ SmtpUsername: "bot@example.com",
+ SmtpPassword: "original-password",
+ FromEmail: "bot@example.com",
+ },
+ },
+ },
+ }
+
+ // First save with a real password.
+ _, err = ts.Service.UpdateInstanceSetting(adminCtx, &v1pb.UpdateInstanceSettingRequest{
+ Setting: notificationSetting,
+ })
+ require.NoError(t, err)
+
+ // Second update with an empty password (simulating a UI that doesn't re-send the secret).
+ notificationSetting.GetNotificationSetting().GetEmail().SmtpPassword = ""
+ notificationSetting.GetNotificationSetting().GetEmail().SmtpHost = "smtp2.example.com"
+ _, err = ts.Service.UpdateInstanceSetting(adminCtx, &v1pb.UpdateInstanceSettingRequest{
+ Setting: notificationSetting,
+ })
+ require.NoError(t, err)
+
+ // The stored setting should have preserved the original password.
+ stored, err := ts.Store.GetInstanceNotificationSetting(ctx)
+ require.NoError(t, err)
+ require.Equal(t, "original-password", stored.GetEmail().GetSmtpPassword(),
+ "existing SmtpPassword must be preserved when an empty value is sent")
+ require.Equal(t, "smtp2.example.com", stored.GetEmail().GetSmtpHost())
+ })
+
+ t.Run("UpdateInstanceSetting - S3 secret is write-only and preserved on empty", func(t *testing.T) {
+ ts := NewTestService(t)
+ defer ts.Cleanup()
+
+ hostUser, err := ts.CreateHostUser(ctx, "admin")
+ require.NoError(t, err)
+ adminCtx := ts.CreateUserContext(ctx, hostUser.ID)
+
+ // Save storage setting with a real secret.
+ _, err = ts.Service.UpdateInstanceSetting(adminCtx, &v1pb.UpdateInstanceSettingRequest{
+ Setting: &v1pb.InstanceSetting{
+ Name: "instance/settings/STORAGE",
+ Value: &v1pb.InstanceSetting_StorageSetting_{
+ StorageSetting: &v1pb.InstanceSetting_StorageSetting{
+ S3Config: &v1pb.InstanceSetting_StorageSetting_S3Config{
+ AccessKeyId: "AKID",
+ AccessKeySecret: "super-secret",
+ Endpoint: "s3.example.com",
+ Region: "us-east-1",
+ Bucket: "memos",
+ },
+ },
+ },
+ },
+ })
+ require.NoError(t, err)
+
+ // Read back: secret must not be returned.
+ resp, err := ts.Service.GetInstanceSetting(adminCtx, &v1pb.GetInstanceSettingRequest{
+ Name: "instance/settings/STORAGE",
+ })
+ require.NoError(t, err)
+ require.Empty(t, resp.GetStorageSetting().GetS3Config().GetAccessKeySecret(),
+ "AccessKeySecret must never be returned in responses")
+
+ // Update with empty secret; original must be preserved in the store.
+ _, err = ts.Service.UpdateInstanceSetting(adminCtx, &v1pb.UpdateInstanceSettingRequest{
+ Setting: &v1pb.InstanceSetting{
+ Name: "instance/settings/STORAGE",
+ Value: &v1pb.InstanceSetting_StorageSetting_{
+ StorageSetting: &v1pb.InstanceSetting_StorageSetting{
+ S3Config: &v1pb.InstanceSetting_StorageSetting_S3Config{
+ AccessKeyId: "AKID",
+ AccessKeySecret: "", // omitted / not changed
+ Endpoint: "s3-v2.example.com",
+ Region: "us-east-1",
+ Bucket: "memos",
+ },
+ },
+ },
+ },
+ })
+ require.NoError(t, err)
+
+ stored, err := ts.Store.GetInstanceStorageSetting(ctx)
+ require.NoError(t, err)
+ require.Equal(t, "super-secret", stored.GetS3Config().GetAccessKeySecret(),
+ "existing AccessKeySecret must be preserved when an empty value is sent")
+ require.Equal(t, "s3-v2.example.com", stored.GetS3Config().GetEndpoint())
})
}
diff --git a/server/router/api/v1/test/memo_service_test.go b/server/router/api/v1/test/memo_service_test.go
index a88eb0258..1169a9311 100644
--- a/server/router/api/v1/test/memo_service_test.go
+++ b/server/router/api/v1/test/memo_service_test.go
@@ -154,7 +154,7 @@ func TestListMemos(t *testing.T) {
memoOneRes := memos.Memos[memoOneResIdx]
require.NotNil(t, memoOneRes)
- require.Equal(t, fmt.Sprintf("users/%d", userOne.ID), memoOneRes.GetCreator())
+ require.Equal(t, fmt.Sprintf("users/%s", userOne.Username), memoOneRes.GetCreator())
require.Equal(t, apiv1.Visibility_PROTECTED, memoOneRes.GetVisibility())
require.Equal(t, memoOne.Content, memoOneRes.GetContent())
require.Equal(t, memoOne.Content[:64]+"...", memoOneRes.GetSnippet(), "memoOne's content is snipped past the 64 char limit")
@@ -202,7 +202,7 @@ func TestListMemos(t *testing.T) {
memoTwoRes := memos.Memos[memoTwoResIdx]
require.NotNil(t, memoTwoRes)
- require.Equal(t, fmt.Sprintf("users/%d", userTwo.ID), memoTwoRes.GetCreator())
+ require.Equal(t, fmt.Sprintf("users/%s", userTwo.Username), memoTwoRes.GetCreator())
require.Equal(t, apiv1.Visibility_PROTECTED, memoTwoRes.GetVisibility())
require.Equal(t, memoTwo.Content, memoTwoRes.GetContent())
require.Empty(t, memoTwoRes.Attachments)
@@ -227,7 +227,7 @@ func TestListMemos(t *testing.T) {
memoThreeRes := memos.Memos[memoThreeResIdx]
require.NotNil(t, memoThreeRes)
- require.Equal(t, fmt.Sprintf("users/%d", userOne.ID), memoThreeRes.GetCreator())
+ require.Equal(t, fmt.Sprintf("users/%s", userOne.Username), memoThreeRes.GetCreator())
require.Equal(t, apiv1.Visibility_PROTECTED, memoThreeRes.GetVisibility())
require.Equal(t, memoThree.Content, memoThreeRes.GetContent())
require.Empty(t, memoThreeRes.Attachments)
@@ -237,7 +237,7 @@ func TestListMemos(t *testing.T) {
// verify memoThree's reactions
require.Len(t, memoThreeRes.Reactions, 2)
// userOne's reaction
- userOneReactionIdx := slices.IndexFunc(memoThreeRes.Reactions, func(r *apiv1.Reaction) bool { return r.GetCreator() == fmt.Sprintf("users/%d", userOne.ID) })
+ userOneReactionIdx := slices.IndexFunc(memoThreeRes.Reactions, func(r *apiv1.Reaction) bool { return r.GetCreator() == fmt.Sprintf("users/%s", userOne.Username) })
require.NotEqual(t, userOneReactionIdx, -1)
userOneReaction := memoThreeRes.Reactions[userOneReactionIdx]
@@ -245,7 +245,7 @@ func TestListMemos(t *testing.T) {
require.Equal(t, "❤️", userOneReaction.ReactionType)
// userTwo's reaction
- userTwoReactionIdx := slices.IndexFunc(memoThreeRes.Reactions, func(r *apiv1.Reaction) bool { return r.GetCreator() == fmt.Sprintf("users/%d", userTwo.ID) })
+ userTwoReactionIdx := slices.IndexFunc(memoThreeRes.Reactions, func(r *apiv1.Reaction) bool { return r.GetCreator() == fmt.Sprintf("users/%s", userTwo.Username) })
require.NotEqual(t, userTwoReactionIdx, -1)
userTwoReaction := memoThreeRes.Reactions[userTwoReactionIdx]
diff --git a/server/router/api/v1/test/memo_share_service_test.go b/server/router/api/v1/test/memo_share_service_test.go
index 110b83a35..946597d92 100644
--- a/server/router/api/v1/test/memo_share_service_test.go
+++ b/server/router/api/v1/test/memo_share_service_test.go
@@ -4,12 +4,14 @@ import (
"context"
"strings"
"testing"
+ "time"
"github.com/stretchr/testify/require"
"google.golang.org/grpc/codes"
"google.golang.org/grpc/status"
apiv1 "github.com/usememos/memos/proto/gen/api/v1"
+ "github.com/usememos/memos/store"
)
func TestDeleteMemoShare_VerifiesShareBelongsToMemo(t *testing.T) {
@@ -107,3 +109,107 @@ func TestGetMemoByShare_IncludesReactions(t *testing.T) {
require.Equal(t, "👍", sharedMemo.Reactions[0].ReactionType)
require.Equal(t, memo.Name, sharedMemo.Reactions[0].ContentId)
}
+
+func TestGetMemoByShare_ReturnsNotFoundForUnknownShare(t *testing.T) {
+ ctx := context.Background()
+
+ ts := NewTestService(t)
+ defer ts.Cleanup()
+
+ _, err := ts.Service.GetMemoByShare(ctx, &apiv1.GetMemoByShareRequest{
+ ShareId: "missing-share-token",
+ })
+ require.Error(t, err)
+ require.Equal(t, codes.NotFound, status.Code(err))
+}
+
+func TestGetMemoByShare_ReturnsNotFoundForExpiredShare(t *testing.T) {
+ ctx := context.Background()
+
+ ts := NewTestService(t)
+ defer ts.Cleanup()
+
+ user, err := ts.CreateRegularUser(ctx, "share-expired")
+ require.NoError(t, err)
+ userCtx := ts.CreateUserContext(ctx, user.ID)
+
+ memo, err := ts.Service.CreateMemo(userCtx, &apiv1.CreateMemoRequest{
+ Memo: &apiv1.Memo{
+ Content: "memo with expired share",
+ Visibility: apiv1.Visibility_PRIVATE,
+ },
+ })
+ require.NoError(t, err)
+
+ expiredTs := time.Now().Add(-time.Hour).Unix()
+ expiredShare, err := ts.Store.CreateMemoShare(ctx, &store.MemoShare{
+ UID: "expired-share-token",
+ MemoID: parseMemoIDFromNameForTest(t, ts, memo.Name),
+ CreatorID: user.ID,
+ ExpiresTs: &expiredTs,
+ })
+ require.NoError(t, err)
+
+ _, err = ts.Service.GetMemoByShare(ctx, &apiv1.GetMemoByShareRequest{
+ ShareId: expiredShare.UID,
+ })
+ require.Error(t, err)
+ require.Equal(t, codes.NotFound, status.Code(err))
+}
+
+func TestGetMemoByShare_ReturnsNotFoundForArchivedMemo(t *testing.T) {
+ ctx := context.Background()
+
+ ts := NewTestService(t)
+ defer ts.Cleanup()
+
+ user, err := ts.CreateRegularUser(ctx, "share-archived")
+ require.NoError(t, err)
+ userCtx := ts.CreateUserContext(ctx, user.ID)
+
+ memoResp, err := ts.Service.CreateMemo(userCtx, &apiv1.CreateMemoRequest{
+ Memo: &apiv1.Memo{
+ Content: "memo that will be archived",
+ Visibility: apiv1.Visibility_PRIVATE,
+ },
+ })
+ require.NoError(t, err)
+
+ share, err := ts.Service.CreateMemoShare(userCtx, &apiv1.CreateMemoShareRequest{
+ Parent: memoResp.Name,
+ MemoShare: &apiv1.MemoShare{},
+ })
+ require.NoError(t, err)
+
+ memoID := parseMemoIDFromNameForTest(t, ts, memoResp.Name)
+ memo, err := ts.Store.GetMemo(ctx, &store.FindMemo{ID: &memoID})
+ require.NoError(t, err)
+ require.NotNil(t, memo)
+
+ archived := store.Archived
+ err = ts.Store.UpdateMemo(ctx, &store.UpdateMemo{
+ ID: memo.ID,
+ RowStatus: &archived,
+ })
+ require.NoError(t, err)
+
+ shareToken := share.Name[strings.LastIndex(share.Name, "/")+1:]
+ _, err = ts.Service.GetMemoByShare(ctx, &apiv1.GetMemoByShareRequest{
+ ShareId: shareToken,
+ })
+ require.Error(t, err)
+ require.Equal(t, codes.NotFound, status.Code(err))
+}
+
+func parseMemoIDFromNameForTest(t *testing.T, ts *TestService, memoName string) int32 {
+ t.Helper()
+
+ memoUID, ok := strings.CutPrefix(memoName, "memos/")
+ require.True(t, ok, "memo name must start with memos/: %s", memoName)
+
+ memo, err := ts.Store.GetMemo(context.Background(), &store.FindMemo{UID: &memoUID})
+ require.NoError(t, err)
+ require.NotNil(t, memo)
+
+ return memo.ID
+}
diff --git a/server/router/api/v1/test/reaction_service_test.go b/server/router/api/v1/test/reaction_service_test.go
index 4d3435545..41a95c151 100644
--- a/server/router/api/v1/test/reaction_service_test.go
+++ b/server/router/api/v1/test/reaction_service_test.go
@@ -41,6 +41,7 @@ func TestDeleteMemoReaction(t *testing.T) {
})
require.NoError(t, err)
require.NotNil(t, reaction)
+ require.Equal(t, "users/user", reaction.Creator)
// Delete reaction - should succeed
_, err = ts.Service.DeleteMemoReaction(userCtx, &apiv1.DeleteMemoReactionRequest{
diff --git a/server/router/api/v1/test/shortcut_service_test.go b/server/router/api/v1/test/shortcut_service_test.go
index 880426f39..bc695c451 100644
--- a/server/router/api/v1/test/shortcut_service_test.go
+++ b/server/router/api/v1/test/shortcut_service_test.go
@@ -27,7 +27,7 @@ func TestListShortcuts(t *testing.T) {
// List shortcuts (should be empty initially)
req := &v1pb.ListShortcutsRequest{
- Parent: fmt.Sprintf("users/%d", user.ID),
+ Parent: fmt.Sprintf("users/%s", user.Username),
}
resp, err := ts.Service.ListShortcuts(userCtx, req)
@@ -50,7 +50,7 @@ func TestListShortcuts(t *testing.T) {
userCtx := ts.CreateUserContext(ctx, user1.ID)
req := &v1pb.ListShortcutsRequest{
- Parent: fmt.Sprintf("users/%d", user2.ID),
+ Parent: fmt.Sprintf("users/%s", user2.Username),
}
_, err = ts.Service.ListShortcuts(userCtx, req)
@@ -82,14 +82,33 @@ func TestListShortcuts(t *testing.T) {
ts := NewTestService(t)
defer ts.Cleanup()
+ _, err := ts.CreateRegularUser(ctx, "testuser")
+ require.NoError(t, err)
+
req := &v1pb.ListShortcutsRequest{
- Parent: "users/1",
+ Parent: "users/testuser",
}
- _, err := ts.Service.ListShortcuts(ctx, req)
+ _, err = ts.Service.ListShortcuts(ctx, req)
require.Error(t, err)
require.Contains(t, err.Error(), "permission denied")
})
+
+ t.Run("ListShortcuts rejects numeric parent", func(t *testing.T) {
+ ts := NewTestService(t)
+ defer ts.Cleanup()
+
+ user, err := ts.CreateRegularUser(ctx, "testuser")
+ require.NoError(t, err)
+
+ userCtx := ts.CreateUserContext(ctx, user.ID)
+
+ _, err = ts.Service.ListShortcuts(userCtx, &v1pb.ListShortcutsRequest{
+ Parent: "users/1",
+ })
+ require.Error(t, err)
+ require.Contains(t, err.Error(), "invalid user name")
+ })
}
func TestGetShortcut(t *testing.T) {
@@ -108,7 +127,7 @@ func TestGetShortcut(t *testing.T) {
// First create a shortcut
createReq := &v1pb.CreateShortcutRequest{
- Parent: fmt.Sprintf("users/%d", user.ID),
+ Parent: fmt.Sprintf("users/%s", user.Username),
Shortcut: &v1pb.Shortcut{
Title: "Test Shortcut",
Filter: "tag in [\"test\"]",
@@ -144,7 +163,7 @@ func TestGetShortcut(t *testing.T) {
// Create shortcut as user1
user1Ctx := ts.CreateUserContext(ctx, user1.ID)
createReq := &v1pb.CreateShortcutRequest{
- Parent: fmt.Sprintf("users/%d", user1.ID),
+ Parent: fmt.Sprintf("users/%s", user1.Username),
Shortcut: &v1pb.Shortcut{
Title: "User1 Shortcut",
Filter: "tag in [\"user1\"]",
@@ -197,7 +216,7 @@ func TestGetShortcut(t *testing.T) {
userCtx := ts.CreateUserContext(ctx, user.ID)
req := &v1pb.GetShortcutRequest{
- Name: fmt.Sprintf("users/%d", user.ID) + "/shortcuts/nonexistent",
+ Name: fmt.Sprintf("users/%s", user.Username) + "/shortcuts/nonexistent",
}
_, err = ts.Service.GetShortcut(userCtx, req)
@@ -221,7 +240,7 @@ func TestCreateShortcut(t *testing.T) {
userCtx := ts.CreateUserContext(ctx, user.ID)
req := &v1pb.CreateShortcutRequest{
- Parent: fmt.Sprintf("users/%d", user.ID),
+ Parent: fmt.Sprintf("users/%s", user.Username),
Shortcut: &v1pb.Shortcut{
Title: "My Shortcut",
Filter: "tag in [\"important\"]",
@@ -233,11 +252,11 @@ func TestCreateShortcut(t *testing.T) {
require.NotNil(t, resp)
require.Equal(t, "My Shortcut", resp.Title)
require.Equal(t, "tag in [\"important\"]", resp.Filter)
- require.Contains(t, resp.Name, fmt.Sprintf("users/%d/shortcuts/", user.ID))
+ require.Contains(t, resp.Name, fmt.Sprintf("users/%s/shortcuts/", user.Username))
// Verify the shortcut was created by listing
listReq := &v1pb.ListShortcutsRequest{
- Parent: fmt.Sprintf("users/%d", user.ID),
+ Parent: fmt.Sprintf("users/%s", user.Username),
}
listResp, err := ts.Service.ListShortcuts(userCtx, listReq)
@@ -260,7 +279,7 @@ func TestCreateShortcut(t *testing.T) {
userCtx := ts.CreateUserContext(ctx, user1.ID)
req := &v1pb.CreateShortcutRequest{
- Parent: fmt.Sprintf("users/%d", user2.ID),
+ Parent: fmt.Sprintf("users/%s", user2.Username),
Shortcut: &v1pb.Shortcut{
Title: "Forbidden Shortcut",
Filter: "tag in [\"forbidden\"]",
@@ -308,7 +327,7 @@ func TestCreateShortcut(t *testing.T) {
userCtx := ts.CreateUserContext(ctx, user.ID)
req := &v1pb.CreateShortcutRequest{
- Parent: fmt.Sprintf("users/%d", user.ID),
+ Parent: fmt.Sprintf("users/%s", user.Username),
Shortcut: &v1pb.Shortcut{
Title: "Invalid Filter Shortcut",
Filter: "invalid||filter))syntax",
@@ -332,7 +351,7 @@ func TestCreateShortcut(t *testing.T) {
userCtx := ts.CreateUserContext(ctx, user.ID)
req := &v1pb.CreateShortcutRequest{
- Parent: fmt.Sprintf("users/%d", user.ID),
+ Parent: fmt.Sprintf("users/%s", user.Username),
Shortcut: &v1pb.Shortcut{
Filter: "tag in [\"test\"]",
},
@@ -360,7 +379,7 @@ func TestUpdateShortcut(t *testing.T) {
// Create a shortcut first
createReq := &v1pb.CreateShortcutRequest{
- Parent: fmt.Sprintf("users/%d", user.ID),
+ Parent: fmt.Sprintf("users/%s", user.Username),
Shortcut: &v1pb.Shortcut{
Title: "Original Title",
Filter: "tag in [\"original\"]",
@@ -403,7 +422,7 @@ func TestUpdateShortcut(t *testing.T) {
// Create shortcut as user1
user1Ctx := ts.CreateUserContext(ctx, user1.ID)
createReq := &v1pb.CreateShortcutRequest{
- Parent: fmt.Sprintf("users/%d", user1.ID),
+ Parent: fmt.Sprintf("users/%s", user1.Username),
Shortcut: &v1pb.Shortcut{
Title: "User1 Shortcut",
Filter: "tag in [\"user1\"]",
@@ -442,7 +461,7 @@ func TestUpdateShortcut(t *testing.T) {
req := &v1pb.UpdateShortcutRequest{
Shortcut: &v1pb.Shortcut{
- Name: fmt.Sprintf("users/%d/shortcuts/test", user.ID),
+ Name: fmt.Sprintf("users/%s/shortcuts/test", user.Username),
Title: "Updated Title",
},
}
@@ -484,7 +503,7 @@ func TestUpdateShortcut(t *testing.T) {
// Create a shortcut first
createReq := &v1pb.CreateShortcutRequest{
- Parent: fmt.Sprintf("users/%d", user.ID),
+ Parent: fmt.Sprintf("users/%s", user.Username),
Shortcut: &v1pb.Shortcut{
Title: "Test Shortcut",
Filter: "tag in [\"test\"]",
@@ -527,7 +546,7 @@ func TestDeleteShortcut(t *testing.T) {
// Create a shortcut first
createReq := &v1pb.CreateShortcutRequest{
- Parent: fmt.Sprintf("users/%d", user.ID),
+ Parent: fmt.Sprintf("users/%s", user.Username),
Shortcut: &v1pb.Shortcut{
Title: "Shortcut to Delete",
Filter: "tag in [\"delete\"]",
@@ -547,7 +566,7 @@ func TestDeleteShortcut(t *testing.T) {
// Verify deletion by listing shortcuts
listReq := &v1pb.ListShortcutsRequest{
- Parent: fmt.Sprintf("users/%d", user.ID),
+ Parent: fmt.Sprintf("users/%s", user.Username),
}
listResp, err := ts.Service.ListShortcuts(userCtx, listReq)
@@ -577,7 +596,7 @@ func TestDeleteShortcut(t *testing.T) {
// Create shortcut as user1
user1Ctx := ts.CreateUserContext(ctx, user1.ID)
createReq := &v1pb.CreateShortcutRequest{
- Parent: fmt.Sprintf("users/%d", user1.ID),
+ Parent: fmt.Sprintf("users/%s", user1.Username),
Shortcut: &v1pb.Shortcut{
Title: "User1 Shortcut",
Filter: "tag in [\"user1\"]",
@@ -623,7 +642,7 @@ func TestDeleteShortcut(t *testing.T) {
userCtx := ts.CreateUserContext(ctx, user.ID)
req := &v1pb.DeleteShortcutRequest{
- Name: fmt.Sprintf("users/%d", user.ID) + "/shortcuts/nonexistent",
+ Name: fmt.Sprintf("users/%s", user.Username) + "/shortcuts/nonexistent",
}
_, err = ts.Service.DeleteShortcut(userCtx, req)
@@ -660,7 +679,7 @@ func TestShortcutFiltering(t *testing.T) {
for i, filter := range validFilters {
req := &v1pb.CreateShortcutRequest{
- Parent: fmt.Sprintf("users/%d", user.ID),
+ Parent: fmt.Sprintf("users/%s", user.Username),
Shortcut: &v1pb.Shortcut{
Title: "Valid Filter " + string(rune(i)),
Filter: filter,
@@ -697,7 +716,7 @@ func TestShortcutFiltering(t *testing.T) {
for _, filter := range invalidFilters {
req := &v1pb.CreateShortcutRequest{
- Parent: fmt.Sprintf("users/%d", user.ID),
+ Parent: fmt.Sprintf("users/%s", user.Username),
Shortcut: &v1pb.Shortcut{
Title: "Invalid Filter Test",
Filter: filter,
@@ -727,7 +746,7 @@ func TestShortcutCRUDComplete(t *testing.T) {
// 1. Create multiple shortcuts
shortcut1Req := &v1pb.CreateShortcutRequest{
- Parent: fmt.Sprintf("users/%d", user.ID),
+ Parent: fmt.Sprintf("users/%s", user.Username),
Shortcut: &v1pb.Shortcut{
Title: "Work Notes",
Filter: "tag in [\"work\"]",
@@ -735,7 +754,7 @@ func TestShortcutCRUDComplete(t *testing.T) {
}
shortcut2Req := &v1pb.CreateShortcutRequest{
- Parent: fmt.Sprintf("users/%d", user.ID),
+ Parent: fmt.Sprintf("users/%s", user.Username),
Shortcut: &v1pb.Shortcut{
Title: "Personal Notes",
Filter: "tag in [\"personal\"]",
@@ -752,7 +771,7 @@ func TestShortcutCRUDComplete(t *testing.T) {
// 2. List shortcuts and verify both exist
listReq := &v1pb.ListShortcutsRequest{
- Parent: fmt.Sprintf("users/%d", user.ID),
+ Parent: fmt.Sprintf("users/%s", user.Username),
}
listResp, err := ts.Service.ListShortcuts(userCtx, listReq)
diff --git a/server/router/api/v1/test/user_email_visibility_test.go b/server/router/api/v1/test/user_email_visibility_test.go
new file mode 100644
index 000000000..40e69f4e5
--- /dev/null
+++ b/server/router/api/v1/test/user_email_visibility_test.go
@@ -0,0 +1,113 @@
+package test
+
+import (
+ "context"
+ "testing"
+
+ "github.com/stretchr/testify/require"
+
+ apiv1 "github.com/usememos/memos/proto/gen/api/v1"
+)
+
+func TestUserEmailVisibility(t *testing.T) {
+ ctx := context.Background()
+
+ t.Run("GetUser redacts email for anonymous callers", func(t *testing.T) {
+ ts := NewTestService(t)
+ defer ts.Cleanup()
+
+ user, err := ts.CreateRegularUser(ctx, "targetuser")
+ require.NoError(t, err)
+
+ got, err := ts.Service.GetUser(ctx, &apiv1.GetUserRequest{
+ Name: "users/targetuser",
+ })
+ require.NoError(t, err)
+ require.NotNil(t, got)
+ require.Equal(t, user.Username, got.Username)
+ require.Empty(t, got.Email)
+ })
+
+ t.Run("GetUser redacts email for other regular users", func(t *testing.T) {
+ ts := NewTestService(t)
+ defer ts.Cleanup()
+
+ targetUser, err := ts.CreateRegularUser(ctx, "targetuser")
+ require.NoError(t, err)
+ viewer, err := ts.CreateRegularUser(ctx, "vieweruser")
+ require.NoError(t, err)
+
+ viewerCtx := ts.CreateUserContext(ctx, viewer.ID)
+ got, err := ts.Service.GetUser(viewerCtx, &apiv1.GetUserRequest{
+ Name: "users/targetuser",
+ })
+ require.NoError(t, err)
+ require.NotNil(t, got)
+ require.Equal(t, targetUser.Username, got.Username)
+ require.Empty(t, got.Email)
+ })
+
+ t.Run("GetUser returns email for the same user", func(t *testing.T) {
+ ts := NewTestService(t)
+ defer ts.Cleanup()
+
+ user, err := ts.CreateRegularUser(ctx, "selfuser")
+ require.NoError(t, err)
+
+ userCtx := ts.CreateUserContext(ctx, user.ID)
+ got, err := ts.Service.GetUser(userCtx, &apiv1.GetUserRequest{
+ Name: "users/selfuser",
+ })
+ require.NoError(t, err)
+ require.NotNil(t, got)
+ require.Equal(t, user.Email, got.Email)
+ })
+
+ t.Run("GetUser returns email for admins", func(t *testing.T) {
+ ts := NewTestService(t)
+ defer ts.Cleanup()
+
+ targetUser, err := ts.CreateRegularUser(ctx, "targetuser")
+ require.NoError(t, err)
+ admin, err := ts.CreateHostUser(ctx, "admin")
+ require.NoError(t, err)
+
+ adminCtx := ts.CreateUserContext(ctx, admin.ID)
+ got, err := ts.Service.GetUser(adminCtx, &apiv1.GetUserRequest{
+ Name: "users/targetuser",
+ })
+ require.NoError(t, err)
+ require.NotNil(t, got)
+ require.Equal(t, targetUser.Email, got.Email)
+ })
+
+ t.Run("GetCurrentUser returns email for the authenticated user", func(t *testing.T) {
+ ts := NewTestService(t)
+ defer ts.Cleanup()
+
+ user, err := ts.CreateRegularUser(ctx, "currentuser")
+ require.NoError(t, err)
+
+ userCtx := ts.CreateUserContext(ctx, user.ID)
+ got, err := ts.Service.GetCurrentUser(userCtx, &apiv1.GetCurrentUserRequest{})
+ require.NoError(t, err)
+ require.NotNil(t, got)
+ require.NotNil(t, got.User)
+ require.Equal(t, user.Email, got.User.Email)
+ })
+
+ t.Run("GetInstanceProfile redacts admin email for anonymous callers", func(t *testing.T) {
+ ts := NewTestService(t)
+ defer ts.Cleanup()
+
+ admin, err := ts.CreateHostUser(ctx, "admin")
+ require.NoError(t, err)
+
+ got, err := ts.Service.GetInstanceProfile(ctx, &apiv1.GetInstanceProfileRequest{})
+ require.NoError(t, err)
+ require.NotNil(t, got)
+ require.NotNil(t, got.Admin)
+ require.Equal(t, admin.Username, got.Admin.Username)
+ require.Empty(t, got.Admin.Email)
+ })
+}
diff --git a/server/router/api/v1/test/user_notification_test.go b/server/router/api/v1/test/user_notification_test.go
index 5adeed5d4..2ffc1b706 100644
--- a/server/router/api/v1/test/user_notification_test.go
+++ b/server/router/api/v1/test/user_notification_test.go
@@ -43,12 +43,14 @@ func TestListUserNotificationsIncludesMemoCommentPayload(t *testing.T) {
require.NoError(t, err)
resp, err := ts.Service.ListUserNotifications(ownerCtx, &apiv1.ListUserNotificationsRequest{
- Parent: fmt.Sprintf("users/%d", owner.ID),
+ Parent: fmt.Sprintf("users/%s", owner.Username),
})
require.NoError(t, err)
require.Len(t, resp.Notifications, 1)
notification := resp.Notifications[0]
+ require.Contains(t, notification.Name, fmt.Sprintf("users/%s/notifications/", owner.Username))
+ require.Equal(t, fmt.Sprintf("users/%s", commenter.Username), notification.Sender)
require.Equal(t, apiv1.UserNotification_MEMO_COMMENT, notification.Type)
require.NotNil(t, notification.GetMemoComment())
require.Equal(t, comment.Name, notification.GetMemoComment().Memo)
@@ -134,10 +136,26 @@ func TestListUserNotificationsOmitsPayloadWhenMemosDeleted(t *testing.T) {
require.NoError(t, err)
resp, err := ts.Service.ListUserNotifications(ownerCtx, &apiv1.ListUserNotificationsRequest{
- Parent: fmt.Sprintf("users/%d", owner.ID),
+ Parent: fmt.Sprintf("users/%s", owner.Username),
})
require.NoError(t, err)
require.Len(t, resp.Notifications, 1)
require.Equal(t, apiv1.UserNotification_MEMO_COMMENT, resp.Notifications[0].Type)
require.Nil(t, resp.Notifications[0].GetMemoComment())
}
+
+func TestListUserNotificationsRejectsNumericParent(t *testing.T) {
+ ctx := context.Background()
+ ts := NewTestService(t)
+ defer ts.Cleanup()
+
+ owner, err := ts.CreateRegularUser(ctx, "notification-owner")
+ require.NoError(t, err)
+ ownerCtx := ts.CreateUserContext(ctx, owner.ID)
+
+ _, err = ts.Service.ListUserNotifications(ownerCtx, &apiv1.ListUserNotificationsRequest{
+ Parent: "users/1",
+ })
+ require.Error(t, err)
+ require.Contains(t, err.Error(), "invalid user name")
+}
diff --git a/server/router/api/v1/test/user_resource_name_test.go b/server/router/api/v1/test/user_resource_name_test.go
new file mode 100644
index 000000000..544c13452
--- /dev/null
+++ b/server/router/api/v1/test/user_resource_name_test.go
@@ -0,0 +1,60 @@
+package test
+
+import (
+ "context"
+ "testing"
+
+ "github.com/stretchr/testify/require"
+
+ apiv1 "github.com/usememos/memos/proto/gen/api/v1"
+)
+
+func TestUserResourceName(t *testing.T) {
+ ctx := context.Background()
+
+ t.Run("GetUser returns username-based canonical name", func(t *testing.T) {
+ ts := NewTestService(t)
+ defer ts.Cleanup()
+
+ user, err := ts.CreateRegularUser(ctx, "testuser")
+ require.NoError(t, err)
+
+ got, err := ts.Service.GetUser(ctx, &apiv1.GetUserRequest{
+ Name: "users/testuser",
+ })
+ require.NoError(t, err)
+ require.NotNil(t, got)
+ require.Equal(t, "users/testuser", got.Name)
+ require.Equal(t, user.Username, got.Username)
+ })
+
+ t.Run("CreateUser returns username-based canonical name", func(t *testing.T) {
+ ts := NewTestService(t)
+ defer ts.Cleanup()
+
+ created, err := ts.Service.CreateUser(ctx, &apiv1.CreateUserRequest{
+ User: &apiv1.User{
+ Username: "newuser",
+ Email: "newuser@example.com",
+ Password: "password123",
+ },
+ })
+ require.NoError(t, err)
+ require.NotNil(t, created)
+ require.Equal(t, "users/newuser", created.Name)
+ })
+
+ t.Run("GetUser rejects numeric user resource names", func(t *testing.T) {
+ ts := NewTestService(t)
+ defer ts.Cleanup()
+
+ _, err := ts.CreateRegularUser(ctx, "testuser")
+ require.NoError(t, err)
+
+ _, err = ts.Service.GetUser(ctx, &apiv1.GetUserRequest{
+ Name: "users/1",
+ })
+ require.Error(t, err)
+ require.Contains(t, err.Error(), "invalid user name")
+ })
+}
diff --git a/server/router/api/v1/test/user_service_registration_test.go b/server/router/api/v1/test/user_service_registration_test.go
index ac9dba6cb..e2a5e7e09 100644
--- a/server/router/api/v1/test/user_service_registration_test.go
+++ b/server/router/api/v1/test/user_service_registration_test.go
@@ -143,6 +143,7 @@ func TestCreateUserRegistration(t *testing.T) {
},
})
require.NoError(t, err)
+ require.Equal(t, "users/newadmin", createdUser.Name)
require.NotNil(t, createdUser)
require.Equal(t, apiv1.User_ADMIN, createdUser.Role)
})
@@ -168,6 +169,7 @@ func TestCreateUserRegistration(t *testing.T) {
})
require.NoError(t, err)
require.NotNil(t, createdUser)
+ require.Equal(t, "users/wannabeadmin", createdUser.Name)
require.Equal(t, apiv1.User_USER, createdUser.Role, "Unauthenticated users can only create USER role")
})
}
diff --git a/server/router/api/v1/test/user_service_stats_test.go b/server/router/api/v1/test/user_service_stats_test.go
index 4c593367a..3e92013bf 100644
--- a/server/router/api/v1/test/user_service_stats_test.go
+++ b/server/router/api/v1/test/user_service_stats_test.go
@@ -20,7 +20,7 @@ func TestGetUserStats_TagCount(t *testing.T) {
defer ts.Cleanup()
// Create a test host user
- user, err := ts.CreateHostUser(ctx, "test_user")
+ user, err := ts.CreateHostUser(ctx, "test-user")
require.NoError(t, err)
// Create user context for authentication
@@ -40,12 +40,13 @@ func TestGetUserStats_TagCount(t *testing.T) {
require.NotNil(t, memo)
// Test GetUserStats
- userName := fmt.Sprintf("users/%d", user.ID)
+ userName := fmt.Sprintf("users/%s", user.Username)
response, err := ts.Service.GetUserStats(userCtx, &v1pb.GetUserStatsRequest{
Name: userName,
})
require.NoError(t, err)
require.NotNil(t, response)
+ require.Equal(t, fmt.Sprintf("users/%s/stats", user.Username), response.Name)
// Check that the tag count is exactly 1, not 2
require.Contains(t, response.TagCount, "test")
@@ -102,4 +103,10 @@ func TestGetUserStats_TagCount(t *testing.T) {
// The original test tag should still be 2
require.Contains(t, response3.TagCount, "test")
require.Equal(t, int32(2), response3.TagCount["test"], "Original tag count should remain 2")
+
+ _, err = ts.Service.GetUserStats(userCtx, &v1pb.GetUserStatsRequest{
+ Name: "users/1",
+ })
+ require.Error(t, err)
+ require.Contains(t, err.Error(), "invalid user name")
}
diff --git a/server/router/api/v1/user_resource_name.go b/server/router/api/v1/user_resource_name.go
new file mode 100644
index 000000000..cf91e5be4
--- /dev/null
+++ b/server/router/api/v1/user_resource_name.go
@@ -0,0 +1,49 @@
+package v1
+
+import (
+ "context"
+ "strconv"
+ "strings"
+
+ "github.com/pkg/errors"
+
+ "github.com/usememos/memos/internal/base"
+ "github.com/usememos/memos/store"
+)
+
+// BuildUserName returns the canonical public resource name for a user.
+func BuildUserName(username string) string {
+ return UserNamePrefix + username
+}
+
+// ExtractUsernameFromName extracts the username token from a user resource name.
+func ExtractUsernameFromName(name string) (string, error) {
+ tokens, err := GetNameParentTokens(name, UserNamePrefix)
+ if err != nil {
+ return "", err
+ }
+ username := tokens[0]
+ if username == "" {
+ return "", errors.Errorf("invalid user name %q", name)
+ }
+ if _, err := strconv.ParseInt(username, 10, 32); err == nil {
+ return "", errors.Errorf("invalid username %q", username)
+ }
+ if username != strings.ToLower(username) || !base.UIDMatcher.MatchString(username) {
+ return "", errors.Errorf("invalid username %q", username)
+ }
+ return username, nil
+}
+
+// ResolveUserByName resolves a username-based user resource name to a store user.
+func ResolveUserByName(ctx context.Context, stores *store.Store, name string) (*store.User, error) {
+ username, err := ExtractUsernameFromName(name)
+ if err != nil {
+ return nil, err
+ }
+ user, err := stores.GetUser(ctx, &store.FindUser{Username: &username})
+ if err != nil {
+ return nil, errors.Wrap(err, "resolve user by name: GetUser failed")
+ }
+ return user, nil
+}
diff --git a/server/router/api/v1/user_service.go b/server/router/api/v1/user_service.go
index 072d3efb3..93c5fc8d9 100644
--- a/server/router/api/v1/user_service.go
+++ b/server/router/api/v1/user_service.go
@@ -64,42 +64,21 @@ func (s *APIV1Service) ListUsers(ctx context.Context, request *v1pb.ListUsersReq
TotalSize: int32(len(users)),
}
for _, user := range users {
- response.Users = append(response.Users, convertUserFromStore(user))
+ response.Users = append(response.Users, convertUserFromStore(user, currentUser))
}
return response, nil
}
func (s *APIV1Service) GetUser(ctx context.Context, request *v1pb.GetUserRequest) (*v1pb.User, error) {
- // Extract identifier from "users/{id_or_username}"
- identifier := extractUserIdentifierFromName(request.Name)
- if identifier == "" {
- return nil, status.Errorf(codes.InvalidArgument, "invalid user name: %s", request.Name)
- }
-
- var user *store.User
- var err error
-
- // Try to parse as numeric ID first
- if userID, parseErr := strconv.ParseInt(identifier, 10, 32); parseErr == nil {
- // It's a numeric ID
- userID32 := int32(userID)
- user, err = s.Store.GetUser(ctx, &store.FindUser{
- ID: &userID32,
- })
- } else {
- // It's a username
- user, err = s.Store.GetUser(ctx, &store.FindUser{
- Username: &identifier,
- })
- }
-
+ user, err := ResolveUserByName(ctx, s.Store, request.Name)
if err != nil {
- return nil, status.Errorf(codes.Internal, "failed to get user: %v", err)
+ return nil, status.Errorf(codes.InvalidArgument, "invalid user name: %s", request.Name)
}
if user == nil {
return nil, status.Errorf(codes.NotFound, "user not found")
}
- return convertUserFromStore(user), nil
+ currentUser, _ := s.fetchCurrentUser(ctx)
+ return convertUserFromStore(user, currentUser), nil
}
func (s *APIV1Service) CreateUser(ctx context.Context, request *v1pb.CreateUserRequest) (*v1pb.User, error) {
@@ -176,17 +155,24 @@ func (s *APIV1Service) CreateUser(ctx context.Context, request *v1pb.CreateUserR
return nil, status.Errorf(codes.Internal, "failed to create user: %v", err)
}
- return convertUserFromStore(user), nil
+ return convertUserFromStore(user, user), nil
}
func (s *APIV1Service) UpdateUser(ctx context.Context, request *v1pb.UpdateUserRequest) (*v1pb.User, error) {
if request.UpdateMask == nil || len(request.UpdateMask.Paths) == 0 {
return nil, status.Errorf(codes.InvalidArgument, "update mask is empty")
}
- userID, err := ExtractUserIDFromName(request.User.Name)
+ user, err := ResolveUserByName(ctx, s.Store, request.User.Name)
if err != nil {
return nil, status.Errorf(codes.InvalidArgument, "invalid user name: %v", err)
}
+ if user == nil {
+ if request.AllowMissing {
+ return nil, status.Errorf(codes.NotFound, "user not found")
+ }
+ return nil, status.Errorf(codes.NotFound, "user not found")
+ }
+ userID := user.ID
currentUser, err := s.fetchCurrentUser(ctx)
if err != nil {
return nil, status.Errorf(codes.Internal, "failed to get user: %v", err)
@@ -200,19 +186,6 @@ func (s *APIV1Service) UpdateUser(ctx context.Context, request *v1pb.UpdateUserR
return nil, status.Errorf(codes.PermissionDenied, "permission denied")
}
- user, err := s.Store.GetUser(ctx, &store.FindUser{ID: &userID})
- if err != nil {
- return nil, status.Errorf(codes.Internal, "failed to get user: %v", err)
- }
- if user == nil {
- // Handle allow_missing field
- if request.AllowMissing {
- // Could create user if missing, but for now return not found
- return nil, status.Errorf(codes.NotFound, "user not found")
- }
- return nil, status.Errorf(codes.NotFound, "user not found")
- }
-
currentTs := time.Now().Unix()
update := &store.UpdateUser{
ID: user.ID,
@@ -288,14 +261,18 @@ func (s *APIV1Service) UpdateUser(ctx context.Context, request *v1pb.UpdateUserR
return nil, status.Errorf(codes.Internal, "failed to update user: %v", err)
}
- return convertUserFromStore(updatedUser), nil
+ return convertUserFromStore(updatedUser, currentUser), nil
}
func (s *APIV1Service) DeleteUser(ctx context.Context, request *v1pb.DeleteUserRequest) (*emptypb.Empty, error) {
- userID, err := ExtractUserIDFromName(request.Name)
+ user, err := ResolveUserByName(ctx, s.Store, request.Name)
if err != nil {
return nil, status.Errorf(codes.InvalidArgument, "invalid user name: %v", err)
}
+ if user == nil {
+ return nil, status.Errorf(codes.NotFound, "user not found")
+ }
+ userID := user.ID
currentUser, err := s.fetchCurrentUser(ctx)
if err != nil {
return nil, status.Errorf(codes.Internal, "failed to get user: %v", err)
@@ -307,14 +284,6 @@ func (s *APIV1Service) DeleteUser(ctx context.Context, request *v1pb.DeleteUserR
return nil, status.Errorf(codes.PermissionDenied, "permission denied")
}
- user, err := s.Store.GetUser(ctx, &store.FindUser{ID: &userID})
- if err != nil {
- return nil, status.Errorf(codes.Internal, "failed to get user: %v", err)
- }
- if user == nil {
- return nil, status.Errorf(codes.NotFound, "user not found")
- }
-
if err := s.Store.DeleteUser(ctx, &store.DeleteUser{
ID: user.ID,
}); err != nil {
@@ -332,12 +301,69 @@ func getDefaultUserGeneralSetting() *v1pb.UserSetting_GeneralSetting {
}
}
+func (s *APIV1Service) resolveUserFromName(ctx context.Context, name string) (*store.User, error) {
+ user, err := ResolveUserByName(ctx, s.Store, name)
+ if err != nil {
+ return nil, err
+ }
+ if user == nil {
+ return nil, errors.Errorf("user not found: %s", name)
+ }
+ return user, nil
+}
+
+func (s *APIV1Service) resolveUserAndSettingKeyFromName(ctx context.Context, name string) (*store.User, string, error) {
+ parts := strings.Split(name, "/")
+ if len(parts) != 4 || parts[0] != "users" || parts[2] != "settings" {
+ return nil, "", errors.Errorf("invalid resource name format: %s", name)
+ }
+
+ user, err := s.resolveUserFromName(ctx, BuildUserName(parts[1]))
+ if err != nil {
+ return nil, "", err
+ }
+ return user, parts[3], nil
+}
+
+func (s *APIV1Service) resolveUserAndWebhookIDFromName(ctx context.Context, name string) (*store.User, string, error) {
+ parts := strings.Split(name, "/")
+ if len(parts) != 4 || parts[0] != "users" || parts[2] != "webhooks" {
+ return nil, "", errors.New("invalid webhook name format")
+ }
+
+ user, err := s.resolveUserFromName(ctx, BuildUserName(parts[1]))
+ if err != nil {
+ return nil, "", err
+ }
+ return user, parts[3], nil
+}
+
+func (s *APIV1Service) resolveUserAndNotificationIDFromName(ctx context.Context, name string) (*store.User, int32, error) {
+ parts := strings.Split(name, "/")
+ if len(parts) != 4 || parts[0] != "users" || parts[2] != "notifications" {
+ return nil, 0, errors.Errorf("invalid notification name: %s", name)
+ }
+
+ user, err := s.resolveUserFromName(ctx, BuildUserName(parts[1]))
+ if err != nil {
+ return nil, 0, err
+ }
+
+ id, err := strconv.Atoi(parts[3])
+ if err != nil {
+ return nil, 0, errors.Errorf("invalid notification id: %s", parts[3])
+ }
+
+ return user, int32(id), nil
+}
+
func (s *APIV1Service) GetUserSetting(ctx context.Context, request *v1pb.GetUserSettingRequest) (*v1pb.UserSetting, error) {
// Parse resource name: users/{user}/settings/{setting}
- userID, settingKey, err := ExtractUserIDAndSettingKeyFromName(request.Name)
+ user, settingKey, err := s.resolveUserAndSettingKeyFromName(ctx, request.Name)
if err != nil {
return nil, status.Errorf(codes.InvalidArgument, "invalid resource name: %v", err)
}
+ userID := user.ID
currentUser, err := s.fetchCurrentUser(ctx)
if err != nil {
@@ -366,15 +392,16 @@ func (s *APIV1Service) GetUserSetting(ctx context.Context, request *v1pb.GetUser
return nil, status.Errorf(codes.Internal, "failed to get user setting: %v", err)
}
- return convertUserSettingFromStore(userSetting, userID, storeKey), nil
+ return convertUserSettingFromStore(userSetting, user, storeKey), nil
}
func (s *APIV1Service) UpdateUserSetting(ctx context.Context, request *v1pb.UpdateUserSettingRequest) (*v1pb.UserSetting, error) {
// Parse resource name: users/{user}/settings/{setting}
- userID, settingKey, err := ExtractUserIDAndSettingKeyFromName(request.Setting.Name)
+ user, settingKey, err := s.resolveUserAndSettingKeyFromName(ctx, request.Setting.Name)
if err != nil {
return nil, status.Errorf(codes.InvalidArgument, "invalid resource name: %v", err)
}
+ userID := user.ID
currentUser, err := s.fetchCurrentUser(ctx)
if err != nil {
@@ -461,10 +488,11 @@ func (s *APIV1Service) UpdateUserSetting(ctx context.Context, request *v1pb.Upda
}
func (s *APIV1Service) ListUserSettings(ctx context.Context, request *v1pb.ListUserSettingsRequest) (*v1pb.ListUserSettingsResponse, error) {
- userID, err := ExtractUserIDFromName(request.Parent)
+ user, err := s.resolveUserFromName(ctx, request.Parent)
if err != nil {
return nil, status.Errorf(codes.InvalidArgument, "invalid parent name: %v", err)
}
+ userID := user.ID
currentUser, err := s.fetchCurrentUser(ctx)
if err != nil {
@@ -488,7 +516,7 @@ func (s *APIV1Service) ListUserSettings(ctx context.Context, request *v1pb.ListU
settings := make([]*v1pb.UserSetting, 0, len(userSettings))
for _, storeSetting := range userSettings {
- apiSetting := convertUserSettingFromStore(storeSetting, userID, storeSetting.Key)
+ apiSetting := convertUserSettingFromStore(storeSetting, user, storeSetting.Key)
if apiSetting != nil {
settings = append(settings, apiSetting)
}
@@ -502,7 +530,7 @@ func (s *APIV1Service) ListUserSettings(ctx context.Context, request *v1pb.ListU
}
if !hasGeneral {
defaultGeneral := &v1pb.UserSetting{
- Name: fmt.Sprintf("users/%d/settings/%s", userID, convertSettingKeyFromStore(storepb.UserSetting_GENERAL)),
+ Name: fmt.Sprintf("%s/settings/%s", BuildUserName(user.Username), convertSettingKeyFromStore(storepb.UserSetting_GENERAL)),
Value: &v1pb.UserSetting_GeneralSetting_{
GeneralSetting: getDefaultUserGeneralSetting(),
},
@@ -533,10 +561,11 @@ func (s *APIV1Service) ListUserSettings(ctx context.Context, request *v1pb.ListU
// Authentication: Required (session cookie or access token)
// Authorization: User can only list their own tokens.
func (s *APIV1Service) ListPersonalAccessTokens(ctx context.Context, request *v1pb.ListPersonalAccessTokensRequest) (*v1pb.ListPersonalAccessTokensResponse, error) {
- userID, err := ExtractUserIDFromName(request.Parent)
+ user, err := s.resolveUserFromName(ctx, request.Parent)
if err != nil {
return nil, status.Errorf(codes.InvalidArgument, "invalid user name: %v", err)
}
+ userID := user.ID
// Verify permission
claims := auth.GetUserClaims(ctx)
@@ -555,7 +584,7 @@ func (s *APIV1Service) ListPersonalAccessTokens(ctx context.Context, request *v1
personalAccessTokens := make([]*v1pb.PersonalAccessToken, len(tokens))
for i, token := range tokens {
personalAccessTokens[i] = &v1pb.PersonalAccessToken{
- Name: fmt.Sprintf("%s/personalAccessTokens/%s", request.Parent, token.TokenId),
+ Name: fmt.Sprintf("%s/personalAccessTokens/%s", BuildUserName(user.Username), token.TokenId),
Description: token.Description,
ExpiresAt: token.ExpiresAt,
CreatedAt: token.CreatedAt,
@@ -587,10 +616,11 @@ func (s *APIV1Service) ListPersonalAccessTokens(ctx context.Context, request *v1
// Authentication: Required (session cookie or access token)
// Authorization: User can only create tokens for themselves.
func (s *APIV1Service) CreatePersonalAccessToken(ctx context.Context, request *v1pb.CreatePersonalAccessTokenRequest) (*v1pb.CreatePersonalAccessTokenResponse, error) {
- userID, err := ExtractUserIDFromName(request.Parent)
+ user, err := s.resolveUserFromName(ctx, request.Parent)
if err != nil {
return nil, status.Errorf(codes.InvalidArgument, "invalid user name: %v", err)
}
+ userID := user.ID
// Verify permission
claims := auth.GetUserClaims(ctx)
@@ -625,7 +655,7 @@ func (s *APIV1Service) CreatePersonalAccessToken(ctx context.Context, request *v
return &v1pb.CreatePersonalAccessTokenResponse{
PersonalAccessToken: &v1pb.PersonalAccessToken{
- Name: fmt.Sprintf("%s/personalAccessTokens/%s", request.Parent, tokenID),
+ Name: fmt.Sprintf("%s/personalAccessTokens/%s", BuildUserName(user.Username), tokenID),
Description: request.Description,
ExpiresAt: expiresAt,
CreatedAt: patRecord.CreatedAt,
@@ -648,16 +678,16 @@ func (s *APIV1Service) CreatePersonalAccessToken(ctx context.Context, request *v
// Authentication: Required (session cookie or access token)
// Authorization: User can only delete their own tokens.
func (s *APIV1Service) DeletePersonalAccessToken(ctx context.Context, request *v1pb.DeletePersonalAccessTokenRequest) (*emptypb.Empty, error) {
- // Parse name: users/{user_id}/personalAccessTokens/{token_id}
parts := strings.Split(request.Name, "/")
if len(parts) != 4 || parts[0] != "users" || parts[2] != "personalAccessTokens" {
return nil, status.Errorf(codes.InvalidArgument, "invalid personal access token name")
}
- userID, err := util.ConvertStringToInt32(parts[1])
+ user, err := s.resolveUserFromName(ctx, BuildUserName(parts[1]))
if err != nil {
- return nil, status.Errorf(codes.InvalidArgument, "invalid user ID: %v", err)
+ return nil, status.Errorf(codes.InvalidArgument, "invalid user name: %v", err)
}
+ userID := user.ID
tokenID := parts[3]
// Verify permission
@@ -677,10 +707,11 @@ func (s *APIV1Service) DeletePersonalAccessToken(ctx context.Context, request *v
}
func (s *APIV1Service) ListUserWebhooks(ctx context.Context, request *v1pb.ListUserWebhooksRequest) (*v1pb.ListUserWebhooksResponse, error) {
- userID, err := ExtractUserIDFromName(request.Parent)
+ user, err := s.resolveUserFromName(ctx, request.Parent)
if err != nil {
return nil, status.Errorf(codes.InvalidArgument, "invalid parent: %v", err)
}
+ userID := user.ID
currentUser, err := s.fetchCurrentUser(ctx)
if err != nil {
@@ -700,7 +731,7 @@ func (s *APIV1Service) ListUserWebhooks(ctx context.Context, request *v1pb.ListU
userWebhooks := make([]*v1pb.UserWebhook, 0, len(webhooks))
for _, webhook := range webhooks {
- userWebhooks = append(userWebhooks, convertUserWebhookFromUserSetting(webhook, userID))
+ userWebhooks = append(userWebhooks, convertUserWebhookFromUserSetting(webhook, user))
}
return &v1pb.ListUserWebhooksResponse{
@@ -709,10 +740,11 @@ func (s *APIV1Service) ListUserWebhooks(ctx context.Context, request *v1pb.ListU
}
func (s *APIV1Service) CreateUserWebhook(ctx context.Context, request *v1pb.CreateUserWebhookRequest) (*v1pb.UserWebhook, error) {
- userID, err := ExtractUserIDFromName(request.Parent)
+ user, err := s.resolveUserFromName(ctx, request.Parent)
if err != nil {
return nil, status.Errorf(codes.InvalidArgument, "invalid parent: %v", err)
}
+ userID := user.ID
currentUser, err := s.fetchCurrentUser(ctx)
if err != nil {
@@ -744,7 +776,7 @@ func (s *APIV1Service) CreateUserWebhook(ctx context.Context, request *v1pb.Crea
return nil, status.Errorf(codes.Internal, "failed to create webhook: %v", err)
}
- return convertUserWebhookFromUserSetting(webhook, userID), nil
+ return convertUserWebhookFromUserSetting(webhook, user), nil
}
func (s *APIV1Service) UpdateUserWebhook(ctx context.Context, request *v1pb.UpdateUserWebhookRequest) (*v1pb.UserWebhook, error) {
@@ -752,10 +784,11 @@ func (s *APIV1Service) UpdateUserWebhook(ctx context.Context, request *v1pb.Upda
return nil, status.Errorf(codes.InvalidArgument, "webhook is required")
}
- webhookID, userID, err := parseUserWebhookName(request.Webhook.Name)
+ user, webhookID, err := s.resolveUserAndWebhookIDFromName(ctx, request.Webhook.Name)
if err != nil {
return nil, status.Errorf(codes.InvalidArgument, "invalid webhook name: %v", err)
}
+ userID := user.ID
currentUser, err := s.fetchCurrentUser(ctx)
if err != nil {
@@ -828,14 +861,15 @@ func (s *APIV1Service) UpdateUserWebhook(ctx context.Context, request *v1pb.Upda
return nil, status.Errorf(codes.Internal, "failed to update webhook: %v", err)
}
- return convertUserWebhookFromUserSetting(updatedWebhook, userID), nil
+ return convertUserWebhookFromUserSetting(updatedWebhook, user), nil
}
func (s *APIV1Service) DeleteUserWebhook(ctx context.Context, request *v1pb.DeleteUserWebhookRequest) (*emptypb.Empty, error) {
- webhookID, userID, err := parseUserWebhookName(request.Name)
+ user, webhookID, err := s.resolveUserAndWebhookIDFromName(ctx, request.Name)
if err != nil {
return nil, status.Errorf(codes.InvalidArgument, "invalid webhook name: %v", err)
}
+ userID := user.ID
currentUser, err := s.fetchCurrentUser(ctx)
if err != nil {
@@ -884,26 +918,10 @@ func generateUserWebhookID() string {
return hex.EncodeToString(b)
}
-// parseUserWebhookName parses a webhook name and returns the webhook ID and user ID.
-// Format: users/{user}/webhooks/{webhook}.
-func parseUserWebhookName(name string) (string, int32, error) {
- parts := strings.Split(name, "/")
- if len(parts) != 4 || parts[0] != "users" || parts[2] != "webhooks" {
- return "", 0, errors.New("invalid webhook name format")
- }
-
- userID, err := strconv.ParseInt(parts[1], 10, 32)
- if err != nil {
- return "", 0, errors.New("invalid user ID in webhook name")
- }
-
- return parts[3], int32(userID), nil
-}
-
// convertUserWebhookFromUserSetting converts a storepb webhook to a v1pb UserWebhook.
-func convertUserWebhookFromUserSetting(webhook *storepb.WebhooksUserSetting_Webhook, userID int32) *v1pb.UserWebhook {
+func convertUserWebhookFromUserSetting(webhook *storepb.WebhooksUserSetting_Webhook, user *store.User) *v1pb.UserWebhook {
return &v1pb.UserWebhook{
- Name: fmt.Sprintf("users/%d/webhooks/%s", userID, webhook.Id),
+ Name: fmt.Sprintf("%s/webhooks/%s", BuildUserName(user.Username), webhook.Id),
Url: webhook.Url,
DisplayName: webhook.Title,
// Note: create_time and update_time are not available in the user setting webhook structure
@@ -911,19 +929,21 @@ func convertUserWebhookFromUserSetting(webhook *storepb.WebhooksUserSetting_Webh
}
}
-func convertUserFromStore(user *store.User) *v1pb.User {
+func convertUserFromStore(user *store.User, viewer *store.User) *v1pb.User {
userpb := &v1pb.User{
- Name: fmt.Sprintf("%s%d", UserNamePrefix, user.ID),
+ Name: BuildUserName(user.Username),
State: convertStateFromStore(user.RowStatus),
CreateTime: timestamppb.New(time.Unix(user.CreatedTs, 0)),
UpdateTime: timestamppb.New(time.Unix(user.UpdatedTs, 0)),
Role: convertUserRoleFromStore(user.Role),
Username: user.Username,
- Email: user.Email,
DisplayName: user.Nickname,
AvatarUrl: user.AvatarURL,
Description: user.Description,
}
+ if canViewerAccessUserEmail(viewer, user) {
+ userpb.Email = user.Email
+ }
// Use the avatar URL instead of raw base64 image data to reduce the response size.
if user.AvatarURL != "" {
// Check if avatar url is base64 format.
@@ -937,6 +957,13 @@ func convertUserFromStore(user *store.User) *v1pb.User {
return userpb
}
+func canViewerAccessUserEmail(viewer, user *store.User) bool {
+ if viewer == nil || user == nil {
+ return false
+ }
+ return viewer.Role == store.RoleAdmin || viewer.ID == user.ID
+}
+
func convertUserRoleFromStore(role store.Role) v1pb.User_Role {
switch role {
case store.RoleAdmin:
@@ -970,26 +997,6 @@ func extractImageInfo(dataURI string) (string, string, error) {
return imageType, base64Data, nil
}
-// Helper functions for user settings
-
-// ExtractUserIDAndSettingKeyFromName extracts user ID and setting key from resource name.
-// e.g., "users/123/settings/general" -> 123, "general".
-func ExtractUserIDAndSettingKeyFromName(name string) (int32, string, error) {
- // Expected format: users/{user}/settings/{setting}
- parts := strings.Split(name, "/")
- if len(parts) != 4 || parts[0] != "users" || parts[2] != "settings" {
- return 0, "", errors.Errorf("invalid resource name format: %s", name)
- }
-
- userID, err := util.ConvertStringToInt32(parts[1])
- if err != nil {
- return 0, "", errors.Errorf("invalid user ID: %s", parts[1])
- }
-
- settingKey := parts[3]
- return userID, settingKey, nil
-}
-
// convertSettingKeyToStore converts API setting key to store enum.
func convertSettingKeyToStore(key string) (storepb.UserSetting_Key, error) {
switch key {
@@ -1017,12 +1024,12 @@ func convertSettingKeyFromStore(key storepb.UserSetting_Key) string {
}
// convertUserSettingFromStore converts store UserSetting to API UserSetting.
-func convertUserSettingFromStore(storeSetting *storepb.UserSetting, userID int32, key storepb.UserSetting_Key) *v1pb.UserSetting {
+func convertUserSettingFromStore(storeSetting *storepb.UserSetting, user *store.User, key storepb.UserSetting_Key) *v1pb.UserSetting {
if storeSetting == nil {
// Return default setting if none exists
settingKey := convertSettingKeyFromStore(key)
setting := &v1pb.UserSetting{
- Name: fmt.Sprintf("users/%d/settings/%s", userID, settingKey),
+ Name: fmt.Sprintf("%s/settings/%s", BuildUserName(user.Username), settingKey),
}
switch key {
@@ -1043,7 +1050,7 @@ func convertUserSettingFromStore(storeSetting *storepb.UserSetting, userID int32
settingKey := convertSettingKeyFromStore(storeSetting.Key)
setting := &v1pb.UserSetting{
- Name: fmt.Sprintf("users/%d/settings/%s", userID, settingKey),
+ Name: fmt.Sprintf("%s/settings/%s", BuildUserName(user.Username), settingKey),
}
switch storeSetting.Key {
@@ -1063,14 +1070,17 @@ func convertUserSettingFromStore(storeSetting *storepb.UserSetting, userID int32
}
case storepb.UserSetting_WEBHOOKS:
webhooks := storeSetting.GetWebhooks()
- apiWebhooks := make([]*v1pb.UserWebhook, 0, len(webhooks.Webhooks))
- for _, webhook := range webhooks.Webhooks {
- apiWebhook := &v1pb.UserWebhook{
- Name: fmt.Sprintf("users/%d/webhooks/%s", userID, webhook.Id),
- Url: webhook.Url,
- DisplayName: webhook.Title,
+ apiWebhooks := make([]*v1pb.UserWebhook, 0)
+ if webhooks != nil {
+ apiWebhooks = make([]*v1pb.UserWebhook, 0, len(webhooks.Webhooks))
+ for _, webhook := range webhooks.Webhooks {
+ apiWebhook := &v1pb.UserWebhook{
+ Name: fmt.Sprintf("%s/webhooks/%s", BuildUserName(user.Username), webhook.Id),
+ Url: webhook.Url,
+ DisplayName: webhook.Title,
+ }
+ apiWebhooks = append(apiWebhooks, apiWebhook)
}
- apiWebhooks = append(apiWebhooks, apiWebhook)
}
setting.Value = &v1pb.UserSetting_WebhooksSetting_{
WebhooksSetting: &v1pb.UserSetting_WebhooksSetting{
@@ -1240,10 +1250,11 @@ func extractUsernameFromComparison(left, right ast.Expr) (string, bool) {
// Notifications are backed by the inbox storage layer and represent activities
// that require user attention (e.g., memo comments).
func (s *APIV1Service) ListUserNotifications(ctx context.Context, request *v1pb.ListUserNotificationsRequest) (*v1pb.ListUserNotificationsResponse, error) {
- userID, err := ExtractUserIDFromName(request.Parent)
+ user, err := s.resolveUserFromName(ctx, request.Parent)
if err != nil {
return nil, status.Errorf(codes.InvalidArgument, "invalid user name: %v", err)
}
+ userID := user.ID
// Verify the requesting user has permission to view these notifications
currentUser, err := s.fetchCurrentUser(ctx)
@@ -1268,10 +1279,19 @@ func (s *APIV1Service) ListUserNotifications(ctx context.Context, request *v1pb.
return nil, status.Errorf(codes.Internal, "failed to list inboxes: %v", err)
}
- // Convert storage layer inboxes to API notifications
+ // Convert storage layer inboxes to API notifications.
+ userIDs := make([]int32, 0, len(inboxes)*2)
+ for _, inbox := range inboxes {
+ userIDs = append(userIDs, inbox.ReceiverID, inbox.SenderID)
+ }
+ usersByID, err := s.listUsersByID(ctx, userIDs)
+ if err != nil {
+ return nil, status.Errorf(codes.Internal, "failed to list notification users: %v", err)
+ }
+
notifications := []*v1pb.UserNotification{}
for _, inbox := range inboxes {
- notification, err := s.convertInboxToUserNotification(ctx, inbox)
+ notification, err := s.convertInboxToUserNotificationWithUsers(ctx, inbox, usersByID)
if err != nil {
return nil, status.Errorf(codes.Internal, "failed to convert inbox: %v", err)
}
@@ -1290,7 +1310,7 @@ func (s *APIV1Service) UpdateUserNotification(ctx context.Context, request *v1pb
return nil, status.Errorf(codes.InvalidArgument, "notification is required")
}
- notificationID, err := ExtractNotificationIDFromName(request.Notification.Name)
+ user, notificationID, err := s.resolveUserAndNotificationIDFromName(ctx, request.Notification.Name)
if err != nil {
return nil, status.Errorf(codes.InvalidArgument, "invalid notification name: %v", err)
}
@@ -1303,6 +1323,9 @@ func (s *APIV1Service) UpdateUserNotification(ctx context.Context, request *v1pb
if currentUser == nil {
return nil, status.Errorf(codes.Unauthenticated, "user not authenticated")
}
+ if currentUser.ID != user.ID {
+ return nil, status.Errorf(codes.PermissionDenied, "permission denied")
+ }
// Verify ownership before updating
inboxes, err := s.Store.ListInboxes(ctx, &store.FindInbox{
ID: ¬ificationID,
@@ -1358,7 +1381,7 @@ func (s *APIV1Service) UpdateUserNotification(ctx context.Context, request *v1pb
// DeleteUserNotification permanently deletes a notification.
// Only the notification owner can delete their notifications.
func (s *APIV1Service) DeleteUserNotification(ctx context.Context, request *v1pb.DeleteUserNotificationRequest) (*emptypb.Empty, error) {
- notificationID, err := ExtractNotificationIDFromName(request.Name)
+ user, notificationID, err := s.resolveUserAndNotificationIDFromName(ctx, request.Name)
if err != nil {
return nil, status.Errorf(codes.InvalidArgument, "invalid notification name: %v", err)
}
@@ -1371,6 +1394,9 @@ func (s *APIV1Service) DeleteUserNotification(ctx context.Context, request *v1pb
if currentUser == nil {
return nil, status.Errorf(codes.Unauthenticated, "user not authenticated")
}
+ if currentUser.ID != user.ID {
+ return nil, status.Errorf(codes.PermissionDenied, "permission denied")
+ }
// Verify ownership before deletion
inboxes, err := s.Store.ListInboxes(ctx, &store.FindInbox{
ID: ¬ificationID,
@@ -1398,9 +1424,26 @@ func (s *APIV1Service) DeleteUserNotification(ctx context.Context, request *v1pb
// convertInboxToUserNotification converts a storage-layer inbox to an API notification.
// This handles the mapping between the internal inbox representation and the public API.
func (s *APIV1Service) convertInboxToUserNotification(ctx context.Context, inbox *store.Inbox) (*v1pb.UserNotification, error) {
+ usersByID, err := s.listUsersByID(ctx, []int32{inbox.ReceiverID, inbox.SenderID})
+ if err != nil {
+ return nil, status.Errorf(codes.Internal, "failed to list notification users: %v", err)
+ }
+ return s.convertInboxToUserNotificationWithUsers(ctx, inbox, usersByID)
+}
+
+func (s *APIV1Service) convertInboxToUserNotificationWithUsers(ctx context.Context, inbox *store.Inbox, usersByID map[int32]*store.User) (*v1pb.UserNotification, error) {
+ receiver := usersByID[inbox.ReceiverID]
+ if receiver == nil {
+ return nil, status.Errorf(codes.NotFound, "notification receiver not found")
+ }
+ sender := usersByID[inbox.SenderID]
+ if sender == nil {
+ return nil, status.Errorf(codes.NotFound, "notification sender not found")
+ }
+
notification := &v1pb.UserNotification{
- Name: fmt.Sprintf("users/%d/notifications/%d", inbox.ReceiverID, inbox.ID),
- Sender: fmt.Sprintf("%s%d", UserNamePrefix, inbox.SenderID),
+ Name: fmt.Sprintf("%s/notifications/%d", BuildUserName(receiver.Username), inbox.ID),
+ Sender: BuildUserName(sender.Username),
CreateTime: timestamppb.New(time.Unix(inbox.CreatedTs, 0)),
}
@@ -1470,20 +1513,3 @@ func (s *APIV1Service) convertUserNotificationPayload(ctx context.Context, messa
RelatedMemo: fmt.Sprintf("%s%s", MemoNamePrefix, relatedMemo.UID),
}, nil
}
-
-// ExtractNotificationIDFromName extracts the notification ID from a resource name.
-// Expected format: users/{user_id}/notifications/{notification_id}.
-func ExtractNotificationIDFromName(name string) (int32, error) {
- pattern := regexp.MustCompile(`^users/(\d+)/notifications/(\d+)$`)
- matches := pattern.FindStringSubmatch(name)
- if len(matches) != 3 {
- return 0, errors.Errorf("invalid notification name: %s", name)
- }
-
- id, err := strconv.Atoi(matches[2])
- if err != nil {
- return 0, errors.Errorf("invalid notification id: %s", matches[2])
- }
-
- return int32(id), nil
-}
diff --git a/server/router/api/v1/user_service_stats.go b/server/router/api/v1/user_service_stats.go
index a2009ab5a..c953d8b32 100644
--- a/server/router/api/v1/user_service_stats.go
+++ b/server/router/api/v1/user_service_stats.go
@@ -14,6 +14,46 @@ import (
"github.com/usememos/memos/store"
)
+func (s *APIV1Service) listUsersByID(ctx context.Context, userIDs []int32) (map[int32]*store.User, error) {
+ if len(userIDs) == 0 {
+ return map[int32]*store.User{}, nil
+ }
+
+ uniqueUserIDs := make([]int32, 0, len(userIDs))
+ seenUserIDs := make(map[int32]struct{}, len(userIDs))
+ for _, userID := range userIDs {
+ if _, seen := seenUserIDs[userID]; seen {
+ continue
+ }
+ seenUserIDs[userID] = struct{}{}
+ uniqueUserIDs = append(uniqueUserIDs, userID)
+ }
+
+ users, err := s.Store.ListUsers(ctx, &store.FindUser{IDList: uniqueUserIDs})
+ if err != nil {
+ return nil, err
+ }
+
+ usersByID := make(map[int32]*store.User, len(users))
+ for _, user := range users {
+ usersByID[user.ID] = user
+ }
+ return usersByID, nil
+}
+
+func (s *APIV1Service) listUsernamesByID(ctx context.Context, userIDs []int32) (map[int32]string, error) {
+ usersByID, err := s.listUsersByID(ctx, userIDs)
+ if err != nil {
+ return nil, err
+ }
+
+ usernamesByID := make(map[int32]string, len(usersByID))
+ for _, user := range usersByID {
+ usernamesByID[user.ID] = user.Username
+ }
+ return usernamesByID, nil
+}
+
func (s *APIV1Service) ListAllUserStats(ctx context.Context, _ *v1pb.ListAllUserStatsRequest) (*v1pb.ListAllUserStatsResponse, error) {
instanceMemoRelatedSetting, err := s.Store.GetInstanceMemoRelatedSetting(ctx)
if err != nil {
@@ -44,6 +84,7 @@ func (s *APIV1Service) ListAllUserStats(ctx context.Context, _ *v1pb.ListAllUser
}
userMemoStatMap := make(map[int32]*v1pb.UserStats)
+ pinnedMemoIDsByUserID := make(map[int32][]int32)
limit := 1000
offset := 0
memoFind.Limit = &limit
@@ -62,7 +103,7 @@ func (s *APIV1Service) ListAllUserStats(ctx context.Context, _ *v1pb.ListAllUser
// Initialize user stats if not exists
if _, exists := userMemoStatMap[memo.CreatorID]; !exists {
userMemoStatMap[memo.CreatorID] = &v1pb.UserStats{
- Name: fmt.Sprintf("users/%d/stats", memo.CreatorID),
+ Name: "",
TagCount: make(map[string]int32),
MemoDisplayTimestamps: []*timestamppb.Timestamp{},
PinnedMemos: []string{},
@@ -110,7 +151,7 @@ func (s *APIV1Service) ListAllUserStats(ctx context.Context, _ *v1pb.ListAllUser
// Track pinned memos
if memo.Pinned {
- stats.PinnedMemos = append(stats.PinnedMemos, fmt.Sprintf("users/%d/memos/%d", memo.CreatorID, memo.ID))
+ pinnedMemoIDsByUserID[memo.CreatorID] = append(pinnedMemoIDsByUserID[memo.CreatorID], memo.ID)
}
}
@@ -118,7 +159,23 @@ func (s *APIV1Service) ListAllUserStats(ctx context.Context, _ *v1pb.ListAllUser
}
userMemoStats := []*v1pb.UserStats{}
- for _, userMemoStat := range userMemoStatMap {
+ userIDs := make([]int32, 0, len(userMemoStatMap))
+ for userID := range userMemoStatMap {
+ userIDs = append(userIDs, userID)
+ }
+ usernamesByID, err := s.listUsernamesByID(ctx, userIDs)
+ if err != nil {
+ return nil, status.Errorf(codes.Internal, "failed to list users: %v", err)
+ }
+ for userID, userMemoStat := range userMemoStatMap {
+ username, ok := usernamesByID[userID]
+ if !ok {
+ return nil, status.Errorf(codes.Internal, "failed to resolve user stats name")
+ }
+ userMemoStat.Name = fmt.Sprintf("%s/stats", BuildUserName(username))
+ for _, memoID := range pinnedMemoIDsByUserID[userID] {
+ userMemoStat.PinnedMemos = append(userMemoStat.PinnedMemos, fmt.Sprintf("%s/memos/%d", BuildUserName(username), memoID))
+ }
userMemoStats = append(userMemoStats, userMemoStat)
}
@@ -129,10 +186,14 @@ func (s *APIV1Service) ListAllUserStats(ctx context.Context, _ *v1pb.ListAllUser
}
func (s *APIV1Service) GetUserStats(ctx context.Context, request *v1pb.GetUserStatsRequest) (*v1pb.UserStats, error) {
- userID, err := ExtractUserIDFromName(request.Name)
+ user, err := ResolveUserByName(ctx, s.Store, request.Name)
if err != nil {
return nil, status.Errorf(codes.InvalidArgument, "invalid user name: %v", err)
}
+ if user == nil {
+ return nil, status.Errorf(codes.NotFound, "user not found")
+ }
+ userID := user.ID
currentUser, err := s.fetchCurrentUser(ctx)
if err != nil {
@@ -211,7 +272,7 @@ func (s *APIV1Service) GetUserStats(ctx context.Context, request *v1pb.GetUserSt
}
}
if memo.Pinned {
- pinnedMemos = append(pinnedMemos, fmt.Sprintf("users/%d/memos/%d", userID, memo.ID))
+ pinnedMemos = append(pinnedMemos, fmt.Sprintf("%s/memos/%d", BuildUserName(user.Username), memo.ID))
}
}
@@ -219,7 +280,7 @@ func (s *APIV1Service) GetUserStats(ctx context.Context, request *v1pb.GetUserSt
}
userStats := &v1pb.UserStats{
- Name: fmt.Sprintf("users/%d/stats", userID),
+ Name: fmt.Sprintf("%s/stats", BuildUserName(user.Username)),
MemoDisplayTimestamps: displayTimestamps,
TagCount: tagCount,
PinnedMemos: pinnedMemos,
diff --git a/server/router/api/v1/v1.go b/server/router/api/v1/v1.go
index 4d5e5c329..cb0f0a289 100644
--- a/server/router/api/v1/v1.go
+++ b/server/router/api/v1/v1.go
@@ -114,9 +114,7 @@ func (s *APIV1Service) RegisterGateway(ctx context.Context, echoServer *echo.Ech
AllowOrigins: []string{"*"},
}))
// Register SSE endpoint with same CORS as rest of /api/v1.
- gwGroup.GET("/api/v1/sse", func(c *echo.Context) error {
- return handleSSE(c, s.SSEHub, auth.NewAuthenticator(s.Store, s.Secret))
- })
+ RegisterSSERoutes(gwGroup, s.SSEHub, s.Store, s.Secret)
handler := echo.WrapHandler(gwMux)
gwGroup.Any("/api/v1/*", handler)
diff --git a/server/router/fileserver/README.md b/server/router/fileserver/README.md
index 984d41eaa..b0ad78dea 100644
--- a/server/router/fileserver/README.md
+++ b/server/router/fileserver/README.md
@@ -286,9 +286,6 @@ See SAFARI_FIX.md for recommended test coverage.
# Test attachment
curl "http://localhost:8081/file/attachments/{uid}/file.jpg"
-# Test avatar by ID
-curl "http://localhost:8081/file/users/1/avatar"
-
# Test avatar by username
curl "http://localhost:8081/file/users/steven/avatar"
diff --git a/server/router/fileserver/fileserver.go b/server/router/fileserver/fileserver.go
index cf4f7c147..fc1a8d80f 100644
--- a/server/router/fileserver/fileserver.go
+++ b/server/router/fileserver/fileserver.go
@@ -20,7 +20,6 @@ import (
"golang.org/x/sync/semaphore"
"github.com/usememos/memos/internal/profile"
- "github.com/usememos/memos/internal/util"
"github.com/usememos/memos/plugin/storage/s3"
storepb "github.com/usememos/memos/proto/gen/store"
"github.com/usememos/memos/server/auth"
@@ -154,7 +153,7 @@ func (s *FileServerService) serveUserAvatar(c *echo.Context) error {
ctx := c.Request().Context()
identifier := c.Param("identifier")
- user, err := s.getUserByIdentifier(ctx, identifier)
+ user, err := s.getUserByUsername(ctx, identifier)
if err != nil {
return echo.NewHTTPError(http.StatusInternalServerError, "failed to get user").Wrap(err)
}
@@ -530,11 +529,8 @@ func (s *FileServerService) getCurrentUser(ctx context.Context, c *echo.Context)
return s.authenticator.AuthenticateToUser(ctx, authHeader, cookieHeader)
}
-// getUserByIdentifier finds a user by either ID or username.
-func (s *FileServerService) getUserByIdentifier(ctx context.Context, identifier string) (*store.User, error) {
- if userID, err := util.ConvertStringToInt32(identifier); err == nil {
- return s.Store.GetUser(ctx, &store.FindUser{ID: &userID})
- }
+// getUserByUsername finds a user by username only.
+func (s *FileServerService) getUserByUsername(ctx context.Context, identifier string) (*store.User, error) {
return s.Store.GetUser(ctx, &store.FindUser{Username: &identifier})
}
diff --git a/server/router/mcp/README.md b/server/router/mcp/README.md
index 86cb16b1e..0af991fc0 100644
--- a/server/router/mcp/README.md
+++ b/server/router/mcp/README.md
@@ -7,6 +7,7 @@ This package implements a [Model Context Protocol (MCP)](https://modelcontextpro
```
POST /mcp (tool calls, initialize)
GET /mcp (optional SSE stream for server-to-client messages)
+DELETE /mcp (optional session termination)
```
Transport: [Streamable HTTP](https://modelcontextprotocol.io/specification/2025-03-26/basic/transports) (single endpoint, MCP spec 2025-03-26).
@@ -24,13 +25,22 @@ The server advertises the following MCP capabilities:
## Authentication
-Every request must include a Personal Access Token (PAT):
+Public reads can be used without authentication. Personal Access Tokens (PATs) or short-lived JWT session tokens are required for:
+
+- Reading non-public memos or attachments
+- Any tool that mutates data
+
+When authenticating, send a Bearer token:
```
Authorization: Bearer {t("setting.tags.tag-pattern-hint")}
+ {!newTagColor &&{t("setting.tags.using-default-color")}
}