From 45519accd338fa29010db6a9d31de6fe252256ae Mon Sep 17 00:00:00 2001 From: ABird Date: Sun, 13 Sep 2026 18:22:54 +0800 Subject: [PATCH] refactor: name packages by role and enforce import direction (#6317) --- .github/workflows/backend-tests.yml | 2 +- .github/workflows/build-canary-image.yml | 4 +- .github/workflows/release.yml | 6 +- .gitignore | 2 +- .golangci.yaml | 51 +++ AGENTS.md | 69 +-- core/README.md | 16 + {server => core}/access/memo.go | 0 {server => core}/access/memo_resolve.go | 0 {server => core}/access/memo_test.go | 0 {server/runner => core}/memopayload/runner.go | 2 +- {server => core}/notification/email.go | 0 {server => core}/notification/email_test.go | 0 {internal/filter => filter}/MAINTENANCE.md | 0 {internal/filter => filter}/README.md | 0 filter/doc.go | 9 + {internal/filter => filter}/engine.go | 0 {internal/filter => filter}/engine_test.go | 0 {internal/filter => filter}/functions_test.go | 0 {internal/filter => filter}/helpers.go | 0 {internal/filter => filter}/ir.go | 0 {internal/filter => filter}/parser.go | 0 {internal/filter => filter}/render.go | 0 {internal/filter => filter}/schema.go | 0 {internal/filter => filter}/time_test.go | 0 internal/README.md | 23 + internal/httpgetter/http_getter.go | 1 - .../{base => identifier}/resource_name.go | 2 +- .../resource_name_test.go | 2 +- internal/{base => identifier}/username.go | 2 +- .../{base => identifier}/username_test.go | 2 +- .../{httpgetter => linkmeta}/html_meta.go | 2 +- .../html_meta_extract.go | 2 +- .../html_meta_test.go | 2 +- internal/linkmeta/http_getter.go | 1 + internal/{httpgetter => linkmeta}/image.go | 2 +- internal/{httpgetter => linkmeta}/util.go | 2 +- internal/random/random.go | 33 ++ internal/scheduler/README.md | 367 ---------------- internal/scheduler/doc.go | 35 -- internal/scheduler/example_test.go | 165 -------- internal/scheduler/integration_test.go | 393 ------------------ internal/scheduler/job.go | 58 --- internal/scheduler/job_test.go | 90 ---- internal/scheduler/middleware.go | 121 ------ internal/scheduler/middleware_test.go | 146 ------- internal/scheduler/parser.go | 240 ----------- internal/scheduler/parser_calendar_test.go | 58 --- internal/scheduler/parser_test.go | 127 ------ internal/scheduler/scheduler.go | 202 --------- internal/scheduler/scheduler_test.go | 165 -------- internal/util/util.go | 98 ----- internal/webhook/webhook.go | 50 ++- internal/webhook/webhook_test.go | 23 +- .../markdown => markdown}/ast/gfm_email.go | 0 {internal/markdown => markdown}/ast/math.go | 0 .../markdown => markdown}/ast/mention.go | 0 {internal/markdown => markdown}/ast/tag.go | 0 markdown/doc.go | 8 + .../markdown => markdown}/extensions/gfm.go | 4 +- .../extensions/mention.go | 8 +- .../extensions/mention_test.go | 2 +- .../markdown => markdown}/extensions/tag.go | 4 +- .../markdown => markdown}/link_reference.go | 0 {internal/markdown => markdown}/markdown.go | 10 +- .../markdown => markdown}/markdown_test.go | 4 +- .../markdown => markdown}/parser/emoji.go | 0 .../markdown => markdown}/parser/gfm_email.go | 0 .../parser/gfm_email_test.go | 0 .../markdown => markdown}/parser/math.go | 2 +- .../markdown => markdown}/parser/math_test.go | 2 +- .../markdown => markdown}/parser/mention.go | 8 +- .../parser/mention_test.go | 6 +- {internal/markdown => markdown}/parser/tag.go | 0 .../markdown => markdown}/parser/tag_test.go | 2 +- .../parser/tag_unicode_tables.go | 0 .../parser/tagdata/main.go | 0 .../parser/tagdata/main_test.go | 0 .../renderer/markdown_renderer.go | 2 +- .../renderer/markdown_renderer_test.go | 2 +- provider/README.md | 15 + {internal => provider}/ai/ai.go | 0 {internal => provider}/ai/audio/webm.go | 0 {internal => provider}/ai/audio/webm_test.go | 0 .../ai/audiollm/audiollm.go | 2 +- .../ai/audiollm/gemini/gemini.go | 6 +- .../ai/audiollm/gemini/gemini_test.go | 6 +- {internal => provider}/ai/audiollm/options.go | 0 {internal => provider}/ai/errors.go | 0 {internal => provider}/ai/models.go | 0 {internal => provider}/ai/resolver.go | 0 .../ai/stt/openai/openai.go | 4 +- .../ai/stt/openai/openai_test.go | 6 +- {internal => provider}/ai/stt/options.go | 0 {internal => provider}/ai/stt/stt.go | 2 +- {internal => provider}/idp/idp.go | 0 {internal => provider}/idp/oauth2/oauth2.go | 2 +- .../idp/oauth2/oauth2_test.go | 2 +- {internal => provider}/storage/driver.go | 2 +- {internal => provider}/storage/driver_test.go | 0 {internal => provider}/storage/s3/s3.go | 0 {internal => provider}/storage/s3/s3_test.go | 0 scripts/release_smoke_test.sh | 2 +- server/{router => }/api/v1/acl_config.go | 0 server/{router => }/api/v1/acl_config_test.go | 0 server/{router => }/api/v1/ai_service.go | 10 +- .../api/v1/attachment_exif_test.go | 0 .../api/v1/attachment_media_metadata.go | 0 .../api/v1/attachment_media_metadata_test.go | 0 .../api/v1/attachment_mime_test.go | 0 .../{router => }/api/v1/attachment_motion.go | 0 .../{router => }/api/v1/attachment_service.go | 0 .../api/v1/attachment_service_image.go | 0 .../api/v1/attachment_service_storage.go | 4 +- .../api/v1/attachment_service_storage_test.go | 0 .../{router => }/api/v1/attachment_upload.go | 0 .../api/v1/attachment_upload_state.go | 0 .../api/v1/attachment_upload_test.go | 0 .../v1/attachment_upload_transport_test.go | 0 server/{router => }/api/v1/auth_service.go | 0 .../api/v1/auth_service_client_info_test.go | 0 .../api/v1/auth_service_session.go | 6 +- .../v1/auth_service_session_status_test.go | 0 .../{router => }/api/v1/auth_service_sso.go | 10 +- server/{router => }/api/v1/authz.go | 0 server/{router => }/api/v1/authz_test.go | 0 server/{router => }/api/v1/common.go | 0 server/{router => }/api/v1/common_test.go | 0 server/{router => }/api/v1/connect_handler.go | 0 .../api/v1/connect_handler_test.go | 0 .../api/v1/connect_interceptors.go | 0 .../api/v1/connect_interceptors_test.go | 0 .../{router => }/api/v1/connect_services.go | 0 server/{router => }/api/v1/filter_access.go | 2 +- .../api/v1/gateway_marshaler_test.go | 0 .../api/v1/gateway_route_resolver.go | 0 .../api/v1/gateway_route_resolver_test.go | 0 server/{router => }/api/v1/header_carrier.go | 0 server/{router => }/api/v1/health_service.go | 0 server/{router => }/api/v1/idp_service.go | 0 .../{router => }/api/v1/instance_service.go | 2 +- .../api/v1/instance_service_converters.go | 0 .../api/v1/instance_service_validation.go | 0 server/{router => }/api/v1/instance_stats.go | 0 .../api/v1/instance_stats_test.go | 0 .../{router => }/api/v1/link_metadata_test.go | 22 +- server/{router => }/api/v1/memo_access.go | 2 +- .../api/v1/memo_attachment_service.go | 2 +- .../{router => }/api/v1/memo_batch_helpers.go | 0 .../api/v1/memo_comment_relations_test.go | 0 .../api/v1/memo_create_helpers.go | 2 +- .../api/v1/memo_create_helpers_test.go | 0 .../api/v1/memo_delete_webhook_test.go | 2 +- .../api/v1/memo_mention_helpers.go | 2 +- .../api/v1/memo_relation_service.go | 0 server/{router => }/api/v1/memo_service.go | 2 +- .../api/v1/memo_service_comments.go | 0 .../api/v1/memo_service_converter.go | 2 +- .../api/v1/memo_service_filter.go | 0 .../api/v1/memo_service_link_metadata.go | 4 +- .../{router => }/api/v1/memo_service_query.go | 0 .../api/v1/memo_service_webhooks.go | 51 ++- .../{router => }/api/v1/memo_share_service.go | 2 +- .../api/v1/memo_update_helpers.go | 0 server/{router => }/api/v1/memo_view_icon.go | 0 .../{router => }/api/v1/notification_email.go | 2 +- server/{router => }/api/v1/ratelimit.go | 0 server/{router => }/api/v1/ratelimit_test.go | 0 .../{router => }/api/v1/reaction_service.go | 0 .../api/v1/reaction_service_policy_test.go | 0 server/{router => }/api/v1/resource_name.go | 25 +- .../{router => }/api/v1/resource_name_test.go | 0 server/{router => }/api/v1/space_icon_test.go | 0 server/{router => }/api/v1/space_service.go | 0 .../api/v1/space_service_converters.go | 0 .../api/v1/space_service_notifications.go | 0 .../{router => }/api/v1/space_service_test.go | 0 server/{router => }/api/v1/sse_handler.go | 0 server/{router => }/api/v1/sse_hub.go | 0 server/{router => }/api/v1/sse_hub_test.go | 0 .../{router => }/api/v1/sse_service_test.go | 0 server/{router => }/api/v1/sso_username.go | 4 +- .../{router => }/api/v1/sso_username_test.go | 0 .../api/v1/test/ai_service_test.go | 0 .../api/v1/test/attachment_service_s3_test.go | 4 +- .../api/v1/test/attachment_service_test.go | 2 +- .../v1/test/auth_service_sso_username_test.go | 2 +- .../api/v1/test/auth_service_test.go | 2 +- server/{router => }/api/v1/test/auth_test.go | 42 +- server/{router => }/api/v1/test/authz_test.go | 6 +- .../test/configuration_provisioning_test.go | 0 .../api/v1/test/idp_service_test.go | 2 +- .../api/v1/test/instance_admin_cache_test.go | 0 .../api/v1/test/instance_service_test.go | 0 .../api/v1/test/instance_stats_test.go | 0 .../v1/test/memo_attachment_markdown_test.go | 2 +- .../v1/test/memo_attachment_service_test.go | 0 .../api/v1/test/memo_move_test.go | 0 .../api/v1/test/memo_relation_service_test.go | 0 .../v1/test/memo_service_benchmark_test.go | 2 +- .../api/v1/test/memo_service_test.go | 0 .../api/v1/test/memo_share_service_test.go | 0 .../api/v1/test/memo_timestamp_test.go | 0 .../api/v1/test/memo_view_icon_test.go | 0 .../api/v1/test/memo_view_service_test.go | 0 .../api/v1/test/personal_access_token_test.go | 0 .../api/v1/test/ratelimit_test.go | 2 +- .../api/v1/test/reaction_service_test.go | 0 .../api/v1/test/sse_handler_test.go | 2 +- .../{router => }/api/v1/test/test_helper.go | 4 +- .../api/v1/test/user_email_visibility_test.go | 0 .../api/v1/test/user_notification_test.go | 0 .../api/v1/test/user_resource_name_test.go | 2 +- .../api/v1/test/user_search_test.go | 0 .../api/v1/test/user_service_delete_test.go | 2 +- .../test/user_service_email_username_test.go | 2 +- .../v1/test/user_service_pagination_test.go | 0 .../v1/test/user_service_registration_test.go | 2 +- .../api/v1/test/user_service_stats_test.go | 0 .../v1/test/user_service_unique_email_test.go | 0 .../api/v1/test/user_setting_test.go | 2 +- .../{router => }/api/v1/user_resource_name.go | 4 +- .../api/v1/user_resource_name_test.go | 0 server/{router => }/api/v1/user_service.go | 5 +- .../api/v1/user_service_access_tokens.go | 4 +- .../api/v1/user_service_converters.go | 0 .../api/v1/user_service_filter.go | 0 .../api/v1/user_service_identities.go | 0 .../api/v1/user_service_memo_views.go | 6 +- .../api/v1/user_service_notifications.go | 2 +- .../api/v1/user_service_settings.go | 0 .../{router => }/api/v1/user_service_stats.go | 0 .../api/v1/user_service_webhooks.go | 0 .../{router => }/api/v1/user_webhook_test.go | 0 server/{router => }/api/v1/v1.go | 8 +- server/auth/authenticator.go | 14 +- server/auth/token.go | 10 +- server/doc.go | 7 + server/{router => }/fileserver/README.md | 4 +- server/{router => }/fileserver/fileserver.go | 4 +- .../fileserver/fileserver_test.go | 12 +- server/{router => }/frontend/dist/index.html | 0 server/{router => }/frontend/frontend.go | 0 server/{router => }/frontend/frontend_test.go | 0 server/{router => }/mcp/README.md | 4 +- server/{router => }/mcp/adapter.go | 0 server/{router => }/mcp/adapter_test.go | 0 server/{router => }/mcp/catalog.go | 0 server/{router => }/mcp/catalog_test.go | 24 +- server/{router => }/mcp/evals/README.md | 2 +- server/{router => }/mcp/evals/memos_eval.xml | 0 server/{router => }/mcp/openapi.go | 0 server/{router => }/mcp/openapi_test.go | 2 +- server/{router => }/mcp/origin.go | 0 server/{router => }/mcp/result.go | 0 server/{router => }/mcp/service.go | 2 +- server/{router => }/mcp/service_test.go | 2 +- server/{router => }/mcp/validation.go | 0 server/{router => }/mcp/validation_test.go | 0 server/server.go | 8 +- server/test/startup_test.go | 2 +- store/attachment.go | 8 +- store/custom_icon.go | 2 +- store/db/mysql/attachment.go | 2 +- store/db/mysql/memo.go | 2 +- store/db/mysql/memo_relation.go | 2 +- store/db/postgres/attachment.go | 2 +- store/db/postgres/memo.go | 2 +- store/db/postgres/memo_relation.go | 2 +- store/db/sqlite/attachment.go | 2 +- store/db/sqlite/memo.go | 2 +- store/db/sqlite/memo_relation.go | 2 +- store/deployment_config.go | 4 +- store/doc.go | 8 + store/email.go | 40 ++ .../util/util_test.go => store/email_test.go | 2 +- store/memo.go | 6 +- store/migrator_email.go | 2 +- store/space.go | 4 +- store/storage.go | 2 +- store/storage_test.go | 2 +- store/store.go | 2 +- store/user.go | 4 +- web/package.json | 2 +- web/src/utils/managed-attachment.ts | 2 +- web/tests/tag-unicode-parity.test.ts | 2 +- 286 files changed, 569 insertions(+), 2595 deletions(-) create mode 100644 core/README.md rename {server => core}/access/memo.go (100%) rename {server => core}/access/memo_resolve.go (100%) rename {server => core}/access/memo_test.go (100%) rename {server/runner => core}/memopayload/runner.go (97%) rename {server => core}/notification/email.go (100%) rename {server => core}/notification/email_test.go (100%) rename {internal/filter => filter}/MAINTENANCE.md (100%) rename {internal/filter => filter}/README.md (100%) create mode 100644 filter/doc.go rename {internal/filter => filter}/engine.go (100%) rename {internal/filter => filter}/engine_test.go (100%) rename {internal/filter => filter}/functions_test.go (100%) rename {internal/filter => filter}/helpers.go (100%) rename {internal/filter => filter}/ir.go (100%) rename {internal/filter => filter}/parser.go (100%) rename {internal/filter => filter}/render.go (100%) rename {internal/filter => filter}/schema.go (100%) rename {internal/filter => filter}/time_test.go (100%) create mode 100644 internal/README.md delete mode 100644 internal/httpgetter/http_getter.go rename internal/{base => identifier}/resource_name.go (85%) rename internal/{base => identifier}/resource_name_test.go (97%) rename internal/{base => identifier}/username.go (98%) rename internal/{base => identifier}/username_test.go (98%) rename internal/{httpgetter => linkmeta}/html_meta.go (99%) rename internal/{httpgetter => linkmeta}/html_meta_extract.go (99%) rename internal/{httpgetter => linkmeta}/html_meta_test.go (99%) create mode 100644 internal/linkmeta/http_getter.go rename internal/{httpgetter => linkmeta}/image.go (97%) rename internal/{httpgetter => linkmeta}/util.go (93%) create mode 100644 internal/random/random.go delete mode 100644 internal/scheduler/README.md delete mode 100644 internal/scheduler/doc.go delete mode 100644 internal/scheduler/example_test.go delete mode 100644 internal/scheduler/integration_test.go delete mode 100644 internal/scheduler/job.go delete mode 100644 internal/scheduler/job_test.go delete mode 100644 internal/scheduler/middleware.go delete mode 100644 internal/scheduler/middleware_test.go delete mode 100644 internal/scheduler/parser.go delete mode 100644 internal/scheduler/parser_calendar_test.go delete mode 100644 internal/scheduler/parser_test.go delete mode 100644 internal/scheduler/scheduler.go delete mode 100644 internal/scheduler/scheduler_test.go delete mode 100644 internal/util/util.go rename {internal/markdown => markdown}/ast/gfm_email.go (100%) rename {internal/markdown => markdown}/ast/math.go (100%) rename {internal/markdown => markdown}/ast/mention.go (100%) rename {internal/markdown => markdown}/ast/tag.go (100%) create mode 100644 markdown/doc.go rename {internal/markdown => markdown}/extensions/gfm.go (98%) rename {internal/markdown => markdown}/extensions/mention.go (91%) rename {internal/markdown => markdown}/extensions/mention_test.go (91%) rename {internal/markdown => markdown}/extensions/tag.go (96%) rename {internal/markdown => markdown}/link_reference.go (100%) rename {internal/markdown => markdown}/markdown.go (98%) rename {internal/markdown => markdown}/markdown_test.go (99%) rename {internal/markdown => markdown}/parser/emoji.go (100%) rename {internal/markdown => markdown}/parser/gfm_email.go (100%) rename {internal/markdown => markdown}/parser/gfm_email_test.go (100%) rename {internal/markdown => markdown}/parser/math.go (98%) rename {internal/markdown => markdown}/parser/math_test.go (98%) rename {internal/markdown => markdown}/parser/mention.go (85%) rename {internal/markdown => markdown}/parser/mention_test.go (81%) rename {internal/markdown => markdown}/parser/tag.go (100%) rename {internal/markdown => markdown}/parser/tag_test.go (99%) rename {internal/markdown => markdown}/parser/tag_unicode_tables.go (100%) rename {internal/markdown => markdown}/parser/tagdata/main.go (100%) rename {internal/markdown => markdown}/parser/tagdata/main_test.go (100%) rename {internal/markdown => markdown}/renderer/markdown_renderer.go (99%) rename {internal/markdown => markdown}/renderer/markdown_renderer_test.go (98%) create mode 100644 provider/README.md rename {internal => provider}/ai/ai.go (100%) rename {internal => provider}/ai/audio/webm.go (100%) rename {internal => provider}/ai/audio/webm_test.go (100%) rename {internal => provider}/ai/audiollm/audiollm.go (98%) rename {internal => provider}/ai/audiollm/gemini/gemini.go (97%) rename {internal => provider}/ai/audiollm/gemini/gemini_test.go (95%) rename {internal => provider}/ai/audiollm/options.go (100%) rename {internal => provider}/ai/errors.go (100%) rename {internal => provider}/ai/models.go (100%) rename {internal => provider}/ai/resolver.go (100%) rename {internal => provider}/ai/stt/openai/openai.go (97%) rename {internal => provider}/ai/stt/openai/openai_test.go (92%) rename {internal => provider}/ai/stt/options.go (100%) rename {internal => provider}/ai/stt/stt.go (95%) rename {internal => provider}/idp/idp.go (100%) rename {internal => provider}/idp/oauth2/oauth2.go (99%) rename {internal => provider}/idp/oauth2/oauth2_test.go (99%) rename {internal => provider}/storage/driver.go (97%) rename {internal => provider}/storage/driver_test.go (100%) rename {internal => provider}/storage/s3/s3.go (100%) rename {internal => provider}/storage/s3/s3_test.go (100%) rename server/{router => }/api/v1/acl_config.go (100%) rename server/{router => }/api/v1/acl_config_test.go (100%) rename server/{router => }/api/v1/ai_service.go (96%) rename server/{router => }/api/v1/attachment_exif_test.go (100%) rename server/{router => }/api/v1/attachment_media_metadata.go (100%) rename server/{router => }/api/v1/attachment_media_metadata_test.go (100%) rename server/{router => }/api/v1/attachment_mime_test.go (100%) rename server/{router => }/api/v1/attachment_motion.go (100%) rename server/{router => }/api/v1/attachment_service.go (100%) rename server/{router => }/api/v1/attachment_service_image.go (100%) rename server/{router => }/api/v1/attachment_service_storage.go (99%) rename server/{router => }/api/v1/attachment_service_storage_test.go (100%) rename server/{router => }/api/v1/attachment_upload.go (100%) rename server/{router => }/api/v1/attachment_upload_state.go (100%) rename server/{router => }/api/v1/attachment_upload_test.go (100%) rename server/{router => }/api/v1/attachment_upload_transport_test.go (100%) rename server/{router => }/api/v1/auth_service.go (100%) rename server/{router => }/api/v1/auth_service_client_info_test.go (100%) rename server/{router => }/api/v1/auth_service_session.go (99%) rename server/{router => }/api/v1/auth_service_session_status_test.go (100%) rename server/{router => }/api/v1/auth_service_sso.go (98%) rename server/{router => }/api/v1/authz.go (100%) rename server/{router => }/api/v1/authz_test.go (100%) rename server/{router => }/api/v1/common.go (100%) rename server/{router => }/api/v1/common_test.go (100%) rename server/{router => }/api/v1/connect_handler.go (100%) rename server/{router => }/api/v1/connect_handler_test.go (100%) rename server/{router => }/api/v1/connect_interceptors.go (100%) rename server/{router => }/api/v1/connect_interceptors_test.go (100%) rename server/{router => }/api/v1/connect_services.go (100%) rename server/{router => }/api/v1/filter_access.go (98%) rename server/{router => }/api/v1/gateway_marshaler_test.go (100%) rename server/{router => }/api/v1/gateway_route_resolver.go (100%) rename server/{router => }/api/v1/gateway_route_resolver_test.go (100%) rename server/{router => }/api/v1/header_carrier.go (100%) rename server/{router => }/api/v1/health_service.go (100%) rename server/{router => }/api/v1/idp_service.go (100%) rename server/{router => }/api/v1/instance_service.go (99%) rename server/{router => }/api/v1/instance_service_converters.go (100%) rename server/{router => }/api/v1/instance_service_validation.go (100%) rename server/{router => }/api/v1/instance_stats.go (100%) rename server/{router => }/api/v1/instance_stats_test.go (100%) rename server/{router => }/api/v1/link_metadata_test.go (88%) rename server/{router => }/api/v1/memo_access.go (99%) rename server/{router => }/api/v1/memo_attachment_service.go (99%) rename server/{router => }/api/v1/memo_batch_helpers.go (100%) rename server/{router => }/api/v1/memo_comment_relations_test.go (100%) rename server/{router => }/api/v1/memo_create_helpers.go (98%) rename server/{router => }/api/v1/memo_create_helpers_test.go (100%) rename server/{router => }/api/v1/memo_delete_webhook_test.go (98%) rename server/{router => }/api/v1/memo_mention_helpers.go (99%) rename server/{router => }/api/v1/memo_relation_service.go (100%) rename server/{router => }/api/v1/memo_service.go (99%) rename server/{router => }/api/v1/memo_service_comments.go (100%) rename server/{router => }/api/v1/memo_service_converter.go (99%) rename server/{router => }/api/v1/memo_service_filter.go (100%) rename server/{router => }/api/v1/memo_service_link_metadata.go (95%) rename server/{router => }/api/v1/memo_service_query.go (100%) rename server/{router => }/api/v1/memo_service_webhooks.go (76%) rename server/{router => }/api/v1/memo_share_service.go (99%) rename server/{router => }/api/v1/memo_update_helpers.go (100%) rename server/{router => }/api/v1/memo_view_icon.go (100%) rename server/{router => }/api/v1/notification_email.go (94%) rename server/{router => }/api/v1/ratelimit.go (100%) rename server/{router => }/api/v1/ratelimit_test.go (100%) rename server/{router => }/api/v1/reaction_service.go (100%) rename server/{router => }/api/v1/reaction_service_policy_test.go (100%) rename server/{router => }/api/v1/resource_name.go (91%) rename server/{router => }/api/v1/resource_name_test.go (100%) rename server/{router => }/api/v1/space_icon_test.go (100%) rename server/{router => }/api/v1/space_service.go (100%) rename server/{router => }/api/v1/space_service_converters.go (100%) rename server/{router => }/api/v1/space_service_notifications.go (100%) rename server/{router => }/api/v1/space_service_test.go (100%) rename server/{router => }/api/v1/sse_handler.go (100%) rename server/{router => }/api/v1/sse_hub.go (100%) rename server/{router => }/api/v1/sse_hub_test.go (100%) rename server/{router => }/api/v1/sse_service_test.go (100%) rename server/{router => }/api/v1/sso_username.go (88%) rename server/{router => }/api/v1/sso_username_test.go (100%) rename server/{router => }/api/v1/test/ai_service_test.go (100%) rename server/{router => }/api/v1/test/attachment_service_s3_test.go (98%) rename server/{router => }/api/v1/test/attachment_service_test.go (99%) rename server/{router => }/api/v1/test/auth_service_sso_username_test.go (99%) rename server/{router => }/api/v1/test/auth_service_test.go (99%) rename server/{router => }/api/v1/test/auth_test.go (97%) rename server/{router => }/api/v1/test/authz_test.go (96%) rename server/{router => }/api/v1/test/configuration_provisioning_test.go (100%) rename server/{router => }/api/v1/test/idp_service_test.go (99%) rename server/{router => }/api/v1/test/instance_admin_cache_test.go (100%) rename server/{router => }/api/v1/test/instance_service_test.go (100%) rename server/{router => }/api/v1/test/instance_stats_test.go (100%) rename server/{router => }/api/v1/test/memo_attachment_markdown_test.go (99%) rename server/{router => }/api/v1/test/memo_attachment_service_test.go (100%) rename server/{router => }/api/v1/test/memo_move_test.go (100%) rename server/{router => }/api/v1/test/memo_relation_service_test.go (100%) rename server/{router => }/api/v1/test/memo_service_benchmark_test.go (99%) rename server/{router => }/api/v1/test/memo_service_test.go (100%) rename server/{router => }/api/v1/test/memo_share_service_test.go (100%) rename server/{router => }/api/v1/test/memo_timestamp_test.go (100%) rename server/{router => }/api/v1/test/memo_view_icon_test.go (100%) rename server/{router => }/api/v1/test/memo_view_service_test.go (100%) rename server/{router => }/api/v1/test/personal_access_token_test.go (100%) rename server/{router => }/api/v1/test/ratelimit_test.go (99%) rename server/{router => }/api/v1/test/reaction_service_test.go (100%) rename server/{router => }/api/v1/test/sse_handler_test.go (98%) rename server/{router => }/api/v1/test/test_helper.go (97%) rename server/{router => }/api/v1/test/user_email_visibility_test.go (100%) rename server/{router => }/api/v1/test/user_notification_test.go (100%) rename server/{router => }/api/v1/test/user_resource_name_test.go (98%) rename server/{router => }/api/v1/test/user_search_test.go (100%) rename server/{router => }/api/v1/test/user_service_delete_test.go (99%) rename server/{router => }/api/v1/test/user_service_email_username_test.go (99%) rename server/{router => }/api/v1/test/user_service_pagination_test.go (100%) rename server/{router => }/api/v1/test/user_service_registration_test.go (99%) rename server/{router => }/api/v1/test/user_service_stats_test.go (100%) rename server/{router => }/api/v1/test/user_service_unique_email_test.go (100%) rename server/{router => }/api/v1/test/user_setting_test.go (99%) rename server/{router => }/api/v1/user_resource_name.go (92%) rename server/{router => }/api/v1/user_resource_name_test.go (100%) rename server/{router => }/api/v1/user_service.go (99%) rename server/{router => }/api/v1/user_service_access_tokens.go (98%) rename server/{router => }/api/v1/user_service_converters.go (100%) rename server/{router => }/api/v1/user_service_filter.go (100%) rename server/{router => }/api/v1/user_service_identities.go (100%) rename server/{router => }/api/v1/user_service_memo_views.go (98%) rename server/{router => }/api/v1/user_service_notifications.go (99%) rename server/{router => }/api/v1/user_service_settings.go (100%) rename server/{router => }/api/v1/user_service_stats.go (100%) rename server/{router => }/api/v1/user_service_webhooks.go (100%) rename server/{router => }/api/v1/user_webhook_test.go (100%) rename server/{router => }/api/v1/v1.go (98%) create mode 100644 server/doc.go rename server/{router => }/fileserver/README.md (85%) rename server/{router => }/fileserver/fileserver.go (99%) rename server/{router => }/fileserver/fileserver_test.go (99%) rename server/{router => }/frontend/dist/index.html (100%) rename server/{router => }/frontend/frontend.go (100%) rename server/{router => }/frontend/frontend_test.go (100%) rename server/{router => }/mcp/README.md (99%) rename server/{router => }/mcp/adapter.go (100%) rename server/{router => }/mcp/adapter_test.go (100%) rename server/{router => }/mcp/catalog.go (100%) rename server/{router => }/mcp/catalog_test.go (95%) rename server/{router => }/mcp/evals/README.md (97%) rename server/{router => }/mcp/evals/memos_eval.xml (100%) rename server/{router => }/mcp/openapi.go (100%) rename server/{router => }/mcp/openapi_test.go (99%) rename server/{router => }/mcp/origin.go (100%) rename server/{router => }/mcp/result.go (100%) rename server/{router => }/mcp/service.go (99%) rename server/{router => }/mcp/service_test.go (99%) rename server/{router => }/mcp/validation.go (100%) rename server/{router => }/mcp/validation_test.go (100%) create mode 100644 store/doc.go create mode 100644 store/email.go rename internal/util/util_test.go => store/email_test.go (94%) diff --git a/.github/workflows/backend-tests.yml b/.github/workflows/backend-tests.yml index bfb62f0d5..a1eca1e56 100644 --- a/.github/workflows/backend-tests.yml +++ b/.github/workflows/backend-tests.yml @@ -78,7 +78,7 @@ jobs: ;; other) go test -v -race -coverprofile=coverage.out -covermode=atomic \ - ./cmd/... ./internal/... ./proto/... + ./cmd/... ./core/... ./markdown/... ./filter/... ./provider/... ./proto/... ;; esac env: diff --git a/.github/workflows/build-canary-image.yml b/.github/workflows/build-canary-image.yml index d38061617..a944cad04 100644 --- a/.github/workflows/build-canary-image.yml +++ b/.github/workflows/build-canary-image.yml @@ -45,7 +45,7 @@ jobs: uses: actions/upload-artifact@v6 with: name: frontend-dist - path: server/router/frontend/dist + path: server/frontend/dist retention-days: 1 build-push: @@ -75,7 +75,7 @@ jobs: uses: actions/download-artifact@v7 with: name: frontend-dist - path: server/router/frontend/dist + path: server/frontend/dist - name: Set up QEMU uses: docker/setup-qemu-action@v3 diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index 1428599c8..fb2a4399a 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -109,7 +109,7 @@ jobs: uses: actions/upload-artifact@v4 with: name: frontend-dist - path: server/router/frontend/dist + path: server/frontend/dist retention-days: 1 build-binaries: @@ -147,7 +147,7 @@ jobs: uses: actions/download-artifact@v4 with: name: frontend-dist - path: server/router/frontend/dist + path: server/frontend/dist - name: Build binary env: @@ -276,7 +276,7 @@ jobs: uses: actions/download-artifact@v4 with: name: frontend-dist - path: server/router/frontend/dist + path: server/frontend/dist - name: Set up QEMU uses: docker/setup-qemu-action@v3 diff --git a/.gitignore b/.gitignore index 1cfc6e0e6..240756f12 100644 --- a/.gitignore +++ b/.gitignore @@ -6,7 +6,7 @@ /memos.exe coverage.out # Frontend bundles: web/dist from `pnpm build`, and -# server/router/frontend/dist from `pnpm release`, which go:embed bakes +# server/frontend/dist from `pnpm release`, which go:embed bakes # into the binary. dist/ diff --git a/.golangci.yaml b/.golangci.yaml index b97938f08..cdbcf86d0 100644 --- a/.golangci.yaml +++ b/.golangci.yaml @@ -2,6 +2,7 @@ version: "2" linters: enable: + - depguard - revive - govet - staticcheck @@ -17,6 +18,56 @@ linters: disable: - errcheck settings: + # Import direction. Each rule names a layer by file path and lists the + # layers it must not import. See internal/README.md, core/README.md, + # provider/README.md, and the doc.go of server, store, markdown, filter. + depguard: + rules: + internal-has-no-app-imports: + files: + - "**/internal/**" + - "!**/internal/testutil/**" + deny: + - pkg: github.com/usememos/memos/store + desc: internal packages must not know the store; move the code to core or a root package + - pkg: github.com/usememos/memos/core + desc: internal packages must not import core + - pkg: github.com/usememos/memos/server + desc: internal packages must not import server + - pkg: github.com/usememos/memos/provider + desc: internal packages must not import provider + - pkg: github.com/usememos/memos/markdown + desc: internal packages must not import markdown + - pkg: github.com/usememos/memos/filter + desc: internal packages must not import filter + - pkg: github.com/usememos/memos/proto + desc: internal packages must not import generated protos; only internal/testutil may + engines-and-providers-sit-below-store: + files: + - "**/markdown/**" + - "**/filter/**" + - "**/provider/**" + deny: + - pkg: github.com/usememos/memos/store + desc: markdown, filter, and provider must not import store + - pkg: github.com/usememos/memos/core + desc: markdown, filter, and provider must not import core + - pkg: github.com/usememos/memos/server + desc: markdown, filter, and provider must not import server + store-sits-below-core: + files: + - "**/store/**" + deny: + - pkg: github.com/usememos/memos/core + desc: store must not import core; business rules that span store calls live in core + - pkg: github.com/usememos/memos/server + desc: store must not import server + core-sits-below-server: + files: + - "**/core/**" + deny: + - pkg: github.com/usememos/memos/server + desc: core must not import server; transports call core, not the reverse exhaustive: explicit-exhaustive-switch: false staticcheck: diff --git a/AGENTS.md b/AGENTS.md index efc3ff26b..1ecb963e8 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -18,7 +18,7 @@ Memos is a self-hosted note-taking app. - Keep diffs scoped. Do not do repo-wide cleanup, dependency churn, or generated-file rewrites unless the task requires it. - Do not hand-edit generated proto outputs. Change `.proto` files, then run `buf generate`. - Add migrations for all database drivers when schema changes, and update each driver's `LATEST.sql`. -- Add public API endpoints to `server/router/api/v1/acl_config.go`. +- Add public API endpoints to `server/api/v1/acl_config.go`. - Ask before adding heavy dependencies, changing auth/token behavior, or altering Docker/release workflows. ## Commands @@ -32,9 +32,9 @@ go test ./... # Run all Go tests go test -v ./store/... # Store tests, including DB drivers via TestContainers go test -v -race ./server/... # Server tests with race detector go test -v -race ./internal/... # Internal package tests with race detector -go test -v -run TestFoo ./pkg/... # Run matching Go tests +go test -v -run TestFoo ./core/... # Run matching Go tests in one tree go mod tidy -go=1.27.0 # Match CI tidy check -golangci-lint run # Go lint, config: .golangci.yaml +golangci-lint run # Go lint, config: .golangci.yaml (includes depguard layering rules) golangci-lint run --fix # Auto-fix lint, including goimports # Frontend @@ -43,7 +43,7 @@ cd web && pnpm dev # Dev server on :3001, proxying API to :8081 cd web && pnpm lint # Type check + Biome lint cd web && pnpm test # Vitest unit tests cd web && pnpm build # Production build -cd web && pnpm release # Build SPA into server/router/frontend/dist +cd web && pnpm release # Build SPA into server/frontend/dist # Protocol Buffers cd proto && buf generate # Regenerate Go + TypeScript + OpenAPI @@ -51,40 +51,52 @@ cd proto && buf lint # Lint proto files cd proto && buf format -w # Format proto files ``` -## Code Map +## Repository Layout -| Path | Purpose | -| --- | --- | -| `cmd/memos/main.go` | Cobra/Viper CLI setup and server startup | -| `server/server.go` | Echo HTTP server, router wiring, and graceful shutdown | -| `server/auth/` | JWT access tokens, refresh tokens, PAT handling | -| `server/router/api/v1/` | Connect/gRPC-Gateway services, ACL config, SSE hub | -| `server/router/frontend/` | Static SPA serving | -| `server/router/fileserver/` | Native HTTP file serving, thumbnails, range requests | -| `server/runner/` | Memo payload rebuilding | -| `store/` | Store facade, cache, migrations, driver interface | -| `store/db/{sqlite,mysql,postgres}/` | Database-specific drivers and SQL | -| `proto/api/v1/` | Public API service definitions | -| `proto/store/` | Internal storage proto messages | -| `internal/` | App-private packages: scheduler, cron, email, CEL filter, markdown, idp, S3 | -| `web/src/connect.ts` | Connect RPC clients, auth interceptor, access-token refresh | -| `web/src/auth-state.ts` | Token storage and BroadcastChannel cross-tab sync | -| `web/src/hooks/` | React Query hooks for server state | -| `web/src/contexts/` | React context for client/UI state | -| `web/src/components/` | Radix/Tailwind UI components and feature components | -| `web/src/themes/` | CSS themes using OKLch color tokens | +Every root folder is named for what it holds. Read the folder's `doc.go` or `README.md` before adding to it. + +| Path | Holds | May import | +| --- | --- | --- | +| `cmd/memos/` | Cobra/Viper CLI setup and server startup | anything | +| `server/` | The HTTP process: Echo bootstrap, graceful shutdown, every transport | core, store, provider, markdown, filter, internal | +| `server/api/v1/` | Connect/gRPC-Gateway services, ACL config, SSE hub. Thin handlers; rules go to `core/` | | +| `server/fileserver/` | Native HTTP file serving, thumbnails, range requests | | +| `server/frontend/` | Static SPA serving; `dist/` is the built SPA baked in by `go:embed` | | +| `server/mcp/` | Model Context Protocol server | | +| `server/auth/` | JWT access tokens, refresh tokens, PAT handling | | +| `core/` | Business rules with no HTTP and no SQL: `access`, `notification`, `memopayload` | store, provider, markdown, filter, internal | +| `store/` | Store facade, cache, migrations, `Driver` interface; `store/db/{sqlite,mysql,postgres}/` implement it | provider, markdown, filter, internal | +| `markdown/` | Markdown engine: parser, AST, memos syntax extensions, renderer, memo payload | proto/gen, internal | +| `filter/` | CEL filter compiler: parse to IR, render to SQL per driver, filterable field schema | internal | +| `provider/` | Backends configured by instance settings: `ai`, `idp`, `storage` | proto/gen, internal | +| `internal/` | Private plumbing with no memos vocabulary (`identifier`, `email`, `webhook`, `ratelimit`, …) | third party only | +| `proto/api/v1/`, `proto/store/` | Public API and internal storage proto sources; `proto/gen/` is generated | | +| `web/src/` | React SPA: `connect.ts` clients, `auth-state.ts`, `hooks/`, `contexts/`, `components/`, `themes/` | | + +Layering rules, enforced by `depguard` in `.golangci.yaml`: + +- Imports point downward only: `cmd` → `server` → `core` → `store` → {`provider`, `markdown`, `filter`} → `internal`. +- `internal/` packages import nothing from this module (except `internal/testutil`, which may import `proto/gen`). +- A package goes in `internal/` only if it could be published as a standalone module unchanged. If it knows what a Memo, Space, or instance setting is, it is a root package. +- Never create `util`, `common`, `base`, `helpers`, `misc`, or `pkg` packages. Name a package for the one thing it does, or put the code next to its only caller. +- New business rules extracted from `server/api/v1` go to `core//`, one package per resource. + +File convention inside `server/api/v1/`: `_service.go` holds the RPC handlers, `_service_converters.go` the +store↔proto conversion, and `_service_.go` further splits. Extend the matching file; do not add `*_helpers2.go`. +Black-box service tests live in `server/api/v1/test/`, unit tests next to the code. ## Change Routing | Change | Update | Verify | | --- | --- | --- | -| Go service or router behavior | Service code under `server/`, tests near package | `go test -v -race ./server/...` | +| Go service or router behavior | Handlers under `server/`, rules under `core/`, tests near package | `go test -v -race ./server/... ./core/...` | | Store or migration behavior | `store/`, all three DB driver migrations, `LATEST.sql` | `go test -v ./store/...` | +| Markdown, filter, or provider logic | `markdown/`, `filter/`, `provider/` | `go test -v -race ./markdown/... ./filter/... ./provider/...` | | Internal package logic | Relevant `internal/` package tests | `go test -v -race ./internal/...` | | Frontend behavior | Components/hooks/contexts under `web/src/` | `cd web && pnpm lint && pnpm test` | | Frontend production output | Vite config or release-sensitive UI | `cd web && pnpm build` or `pnpm release` | | Proto API | `.proto` source plus generated outputs | `cd proto && buf generate && buf lint` | -| Public unauthenticated route | `server/router/api/v1/acl_config.go` | Targeted server test or manual route check | +| Public unauthenticated route | `server/api/v1/acl_config.go` | Targeted server test or manual route check | ## Go Conventions @@ -119,7 +131,8 @@ cd proto && buf format -w # Format proto files ## CI Reference -- Backend CI: Go 1.27.0, `go mod tidy -go=1.27.0`, golangci-lint v2.13.1, test groups `store`, `server`, `internal`, `other`. +- Backend CI: Go 1.27.0, `go mod tidy -go=1.27.0`, golangci-lint v2.13.1, test groups `store`, `server`, `internal`, `other` + (`cmd`, `core`, `markdown`, `filter`, `provider`, `proto`). - Frontend CI: Node 24, pnpm 11.0.1, `pnpm lint`, `pnpm test`, `pnpm build`. - Proto CI: `buf lint` and `buf format` check. - Docker: `scripts/Dockerfile`, Alpine 3.21 runtime, non-root user, port 5230, multi-arch amd64/arm64/arm/v7. diff --git a/core/README.md b/core/README.md new file mode 100644 index 000000000..096e67893 --- /dev/null +++ b/core/README.md @@ -0,0 +1,16 @@ +# core + +Business rules that do not care about HTTP or SQL. A package lands here when it +needs several store calls, or a decision, that more than one transport must +apply the same way. + +| Package | Owns | +| --- | --- | +| `access/` | who may read a memo, given viewer, space membership, and share links | +| `notification/` | building and dispatching inbox and email notifications | +| `memopayload/` | rebuilding a memo's derived payload from its markdown | + +Layering: `core` may import `store`, `provider`, `markdown`, `filter`, +`proto/gen`, and `internal`. It must not import `server` or `cmd`. New +resource-specific rules extracted from `server/api/v1` belong here, one package +per resource. diff --git a/server/access/memo.go b/core/access/memo.go similarity index 100% rename from server/access/memo.go rename to core/access/memo.go diff --git a/server/access/memo_resolve.go b/core/access/memo_resolve.go similarity index 100% rename from server/access/memo_resolve.go rename to core/access/memo_resolve.go diff --git a/server/access/memo_test.go b/core/access/memo_test.go similarity index 100% rename from server/access/memo_test.go rename to core/access/memo_test.go diff --git a/server/runner/memopayload/runner.go b/core/memopayload/runner.go similarity index 97% rename from server/runner/memopayload/runner.go rename to core/memopayload/runner.go index 158748c74..db88b3ced 100644 --- a/server/runner/memopayload/runner.go +++ b/core/memopayload/runner.go @@ -6,7 +6,7 @@ import ( "github.com/pkg/errors" - "github.com/usememos/memos/internal/markdown" + "github.com/usememos/memos/markdown" storepb "github.com/usememos/memos/proto/gen/store" "github.com/usememos/memos/store" ) diff --git a/server/notification/email.go b/core/notification/email.go similarity index 100% rename from server/notification/email.go rename to core/notification/email.go diff --git a/server/notification/email_test.go b/core/notification/email_test.go similarity index 100% rename from server/notification/email_test.go rename to core/notification/email_test.go diff --git a/internal/filter/MAINTENANCE.md b/filter/MAINTENANCE.md similarity index 100% rename from internal/filter/MAINTENANCE.md rename to filter/MAINTENANCE.md diff --git a/internal/filter/README.md b/filter/README.md similarity index 100% rename from internal/filter/README.md rename to filter/README.md diff --git a/filter/doc.go b/filter/doc.go new file mode 100644 index 000000000..fdc65fc2a --- /dev/null +++ b/filter/doc.go @@ -0,0 +1,9 @@ +// Package filter compiles the CEL filter expressions accepted by the list +// endpoints into an intermediate representation and renders that IR into SQL +// for each database driver. The schema of filterable memo and user fields +// lives here. +// +// Layering: filter imports only third-party packages and internal. It must not +// import store, core, or server; the SQL drivers import filter, not the other +// way round. +package filter diff --git a/internal/filter/engine.go b/filter/engine.go similarity index 100% rename from internal/filter/engine.go rename to filter/engine.go diff --git a/internal/filter/engine_test.go b/filter/engine_test.go similarity index 100% rename from internal/filter/engine_test.go rename to filter/engine_test.go diff --git a/internal/filter/functions_test.go b/filter/functions_test.go similarity index 100% rename from internal/filter/functions_test.go rename to filter/functions_test.go diff --git a/internal/filter/helpers.go b/filter/helpers.go similarity index 100% rename from internal/filter/helpers.go rename to filter/helpers.go diff --git a/internal/filter/ir.go b/filter/ir.go similarity index 100% rename from internal/filter/ir.go rename to filter/ir.go diff --git a/internal/filter/parser.go b/filter/parser.go similarity index 100% rename from internal/filter/parser.go rename to filter/parser.go diff --git a/internal/filter/render.go b/filter/render.go similarity index 100% rename from internal/filter/render.go rename to filter/render.go diff --git a/internal/filter/schema.go b/filter/schema.go similarity index 100% rename from internal/filter/schema.go rename to filter/schema.go diff --git a/internal/filter/time_test.go b/filter/time_test.go similarity index 100% rename from internal/filter/time_test.go rename to filter/time_test.go diff --git a/internal/README.md b/internal/README.md new file mode 100644 index 000000000..d943a4324 --- /dev/null +++ b/internal/README.md @@ -0,0 +1,23 @@ +# internal + +Private plumbing with no memos vocabulary. A package belongs here only if it +could be published tomorrow as a standalone module without changes: it imports +nothing from `store`, `core`, `server`, `provider`, `markdown`, `filter`, or +`proto/gen`. The `depguard` rules in `.golangci.yaml` enforce that. + +| Package | Purpose | +| --- | --- | +| `clientip/` | trusted-proxy aware client IP resolution middleware | +| `email/` | SMTP client, config, and message types | +| `identifier/` | grammar of UIDs and usernames shared by parser, store, and API | +| `linkmeta/` | HTML metadata, oEmbed, and image fetching for link previews | +| `motionphoto/` | Live Photo and Motion Photo container parsing | +| `profile/` | process configuration parsed from flags and environment | +| `random/` | UUIDs and random strings from a secure source | +| `ratelimit/` | sliding-window rate limiter | +| `testutil/` | test fixtures and the fake S3 server (the one package allowed to import `proto/gen`) | +| `version/` | build version and version comparison | +| `webhook/` | signed webhook delivery with SSRF protection | + +Do not add `util`, `common`, `base`, or `helpers` packages. Name a package for +the one thing it does, or put the code next to its only caller. diff --git a/internal/httpgetter/http_getter.go b/internal/httpgetter/http_getter.go deleted file mode 100644 index 581acb741..000000000 --- a/internal/httpgetter/http_getter.go +++ /dev/null @@ -1 +0,0 @@ -package httpgetter diff --git a/internal/base/resource_name.go b/internal/identifier/resource_name.go similarity index 85% rename from internal/base/resource_name.go rename to internal/identifier/resource_name.go index 14e6fe2d7..98cf2b62b 100644 --- a/internal/base/resource_name.go +++ b/internal/identifier/resource_name.go @@ -1,4 +1,4 @@ -package base +package identifier import "regexp" diff --git a/internal/base/resource_name_test.go b/internal/identifier/resource_name_test.go similarity index 97% rename from internal/base/resource_name_test.go rename to internal/identifier/resource_name_test.go index 9fa926628..5a81a1454 100644 --- a/internal/base/resource_name_test.go +++ b/internal/identifier/resource_name_test.go @@ -1,4 +1,4 @@ -package base +package identifier import ( "testing" diff --git a/internal/base/username.go b/internal/identifier/username.go similarity index 98% rename from internal/base/username.go rename to internal/identifier/username.go index e5d3c32e7..eae43f792 100644 --- a/internal/base/username.go +++ b/internal/identifier/username.go @@ -1,4 +1,4 @@ -package base +package identifier // MaxUsernameLength is the maximum number of ASCII characters in a writable username. const MaxUsernameLength = 36 diff --git a/internal/base/username_test.go b/internal/identifier/username_test.go similarity index 98% rename from internal/base/username_test.go rename to internal/identifier/username_test.go index 16861c27c..3bbc1076b 100644 --- a/internal/base/username_test.go +++ b/internal/identifier/username_test.go @@ -1,4 +1,4 @@ -package base +package identifier import ( "strings" diff --git a/internal/httpgetter/html_meta.go b/internal/linkmeta/html_meta.go similarity index 99% rename from internal/httpgetter/html_meta.go rename to internal/linkmeta/html_meta.go index 8e72b4b83..3947476bb 100644 --- a/internal/httpgetter/html_meta.go +++ b/internal/linkmeta/html_meta.go @@ -1,4 +1,4 @@ -package httpgetter +package linkmeta import ( "context" diff --git a/internal/httpgetter/html_meta_extract.go b/internal/linkmeta/html_meta_extract.go similarity index 99% rename from internal/httpgetter/html_meta_extract.go rename to internal/linkmeta/html_meta_extract.go index 464d71b98..246a164b5 100644 --- a/internal/httpgetter/html_meta_extract.go +++ b/internal/linkmeta/html_meta_extract.go @@ -1,4 +1,4 @@ -package httpgetter +package linkmeta import ( "bytes" diff --git a/internal/httpgetter/html_meta_test.go b/internal/linkmeta/html_meta_test.go similarity index 99% rename from internal/httpgetter/html_meta_test.go rename to internal/linkmeta/html_meta_test.go index b3c02a540..252c46963 100644 --- a/internal/httpgetter/html_meta_test.go +++ b/internal/linkmeta/html_meta_test.go @@ -1,4 +1,4 @@ -package httpgetter +package linkmeta import ( "context" diff --git a/internal/linkmeta/http_getter.go b/internal/linkmeta/http_getter.go new file mode 100644 index 000000000..d7aacc4c2 --- /dev/null +++ b/internal/linkmeta/http_getter.go @@ -0,0 +1 @@ +package linkmeta diff --git a/internal/httpgetter/image.go b/internal/linkmeta/image.go similarity index 97% rename from internal/httpgetter/image.go rename to internal/linkmeta/image.go index 536afea80..b569045e4 100644 --- a/internal/httpgetter/image.go +++ b/internal/linkmeta/image.go @@ -1,4 +1,4 @@ -package httpgetter +package linkmeta import ( "errors" diff --git a/internal/httpgetter/util.go b/internal/linkmeta/util.go similarity index 93% rename from internal/httpgetter/util.go rename to internal/linkmeta/util.go index d83f5efb2..ea04c22d7 100644 --- a/internal/httpgetter/util.go +++ b/internal/linkmeta/util.go @@ -1,4 +1,4 @@ -package httpgetter +package linkmeta import ( "mime" diff --git a/internal/random/random.go b/internal/random/random.go new file mode 100644 index 000000000..a96574fc9 --- /dev/null +++ b/internal/random/random.go @@ -0,0 +1,33 @@ +// Package random generates identifiers and secrets from a cryptographically +// secure source. +package random + +import ( + "crypto/rand" + "math/big" + "strings" + "uuid" +) + +// UUID returns a new random (version 4) UUID in its canonical string form. +func UUID() string { + return uuid.NewV4().String() +} + +var alphabet = []rune("0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ") + +// String returns a random alphanumeric string of length n. +func String(n int) (string, error) { + var sb strings.Builder + sb.Grow(n) + for i := 0; i < n; i++ { + index, err := rand.Int(rand.Reader, big.NewInt(int64(len(alphabet)))) + if err != nil { + return "", err + } + if _, err := sb.WriteRune(alphabet[index.Uint64()]); err != nil { + return "", err + } + } + return sb.String(), nil +} diff --git a/internal/scheduler/README.md b/internal/scheduler/README.md deleted file mode 100644 index ae065580e..000000000 --- a/internal/scheduler/README.md +++ /dev/null @@ -1,367 +0,0 @@ -# Scheduler Plugin - -A production-ready, GitHub Actions-inspired cron job scheduler for Go. - -## Features - -- **Standard Cron Syntax**: Supports both 5-field and 6-field (with seconds) cron expressions -- **Timezone-Aware**: Explicit timezone handling to avoid DST surprises -- **Middleware Pattern**: Composable job wrappers for logging, metrics, panic recovery, timeouts -- **Graceful Shutdown**: Jobs complete cleanly or cancel when context expires -- **Zero Dependencies**: Core functionality uses only the standard library -- **Type-Safe**: Strong typing with clear error messages -- **Well-Tested**: Comprehensive test coverage - -## Installation - -This package is included with Memos. No separate installation required. - -## Quick Start - -```go -package main - -import ( - "context" - "fmt" - "github.com/usememos/memos/internal/scheduler" -) - -func main() { - s := scheduler.New() - - s.Register(&scheduler.Job{ - Name: "daily-cleanup", - Schedule: "0 2 * * *", // 2 AM daily - Handler: func(ctx context.Context) error { - fmt.Println("Running cleanup...") - return nil - }, - }) - - s.Start() - defer s.Stop(context.Background()) - - // Keep running... - select {} -} -``` - -## Cron Expression Format - -### 5-Field Format (Standard) -``` -┌───────────── minute (0 - 59) -│ ┌───────────── hour (0 - 23) -│ │ ┌───────────── day of month (1 - 31) -│ │ │ ┌───────────── month (1 - 12) -│ │ │ │ ┌───────────── day of week (0 - 7) (Sunday = 0 or 7) -│ │ │ │ │ -* * * * * -``` - -### 6-Field Format (With Seconds) -``` -┌───────────── second (0 - 59) -│ ┌───────────── minute (0 - 59) -│ │ ┌───────────── hour (0 - 23) -│ │ │ ┌───────────── day of month (1 - 31) -│ │ │ │ ┌───────────── month (1 - 12) -│ │ │ │ │ ┌───────────── day of week (0 - 7) -│ │ │ │ │ │ -* * * * * * -``` - -### Special Characters - -- `*` - Any value (every minute, every hour, etc.) -- `,` - List of values: `1,15,30` (1st, 15th, and 30th) -- `-` - Range: `9-17` (9 AM through 5 PM) -- `/` - Step: `*/15` (every 15 units) - -### Common Examples - -| Schedule | Description | -|----------|-------------| -| `* * * * *` | Every minute | -| `0 * * * *` | Every hour | -| `0 0 * * *` | Daily at midnight | -| `0 9 * * 1-5` | Weekdays at 9 AM | -| `*/15 * * * *` | Every 15 minutes | -| `0 0 1 * *` | First day of every month | -| `0 0 * * 0` | Every Sunday at midnight | -| `30 14 * * *` | Every day at 2:30 PM | - -## Timezone Support - -```go -// Global timezone for all jobs -s := scheduler.New( - scheduler.WithTimezone("America/New_York"), -) - -// Per-job timezone (overrides global) -s.Register(&scheduler.Job{ - Name: "tokyo-report", - Schedule: "0 9 * * *", // 9 AM Tokyo time - Timezone: "Asia/Tokyo", - Handler: func(ctx context.Context) error { - // Runs at 9 AM in Tokyo - return nil - }, -}) -``` - -**Important**: Always use IANA timezone names (`America/New_York`, not `EST`). - -## Middleware - -Middleware wraps job handlers to add cross-cutting behavior. Multiple middleware can be chained together. - -### Built-in Middleware - -#### Recovery (Panic Handling) - -```go -s := scheduler.New( - scheduler.WithMiddleware( - scheduler.Recovery(func(jobName string, r interface{}) { - log.Printf("Job %s panicked: %v", jobName, r) - }), - ), -) -``` - -#### Logging - -```go -type Logger interface { - Info(msg string, args ...interface{}) - Error(msg string, args ...interface{}) -} - -s := scheduler.New( - scheduler.WithMiddleware( - scheduler.Logging(myLogger), - ), -) -``` - -#### Timeout - -```go -s := scheduler.New( - scheduler.WithMiddleware( - scheduler.Timeout(5 * time.Minute), - ), -) -``` - -### Combining Middleware - -```go -s := scheduler.New( - scheduler.WithMiddleware( - scheduler.Recovery(panicHandler), - scheduler.Logging(logger), - scheduler.Timeout(10 * time.Minute), - ), -) -``` - -**Order matters**: Middleware are applied left-to-right. In the example above: -1. Recovery (outermost) catches panics from everything -2. Logging logs the execution -3. Timeout (innermost) wraps the actual handler - -### Custom Middleware - -```go -func Metrics(recorder MetricsRecorder) scheduler.Middleware { - return func(next scheduler.JobHandler) scheduler.JobHandler { - return func(ctx context.Context) error { - start := time.Now() - err := next(ctx) - duration := time.Since(start) - - jobName := scheduler.GetJobName(ctx) - recorder.Record(jobName, duration, err) - - return err - } - } -} -``` - -## Graceful Shutdown - -Always use `Stop()` with a context to allow jobs to finish cleanly: - -```go -// Give jobs up to 30 seconds to complete -ctx, cancel := context.WithTimeout(context.Background(), 30*time.Second) -defer cancel() - -if err := s.Stop(ctx); err != nil { - log.Printf("Shutdown error: %v", err) -} -``` - -Jobs should respect context cancellation: - -```go -Handler: func(ctx context.Context) error { - for i := 0; i < 100; i++ { - select { - case <-ctx.Done(): - return ctx.Err() // Canceled - default: - // Do work - } - } - return nil -} -``` - -## Best Practices - -### 1. Always Name Your Jobs - -Names are used for logging, metrics, and debugging: - -```go -Name: "user-cleanup-job" // Good -Name: "job1" // Bad -``` - -### 2. Add Descriptions and Tags - -```go -s.Register(&scheduler.Job{ - Name: "stale-session-cleanup", - Description: "Removes user sessions older than 30 days", - Tags: []string{"maintenance", "security"}, - Schedule: "0 3 * * *", - Handler: cleanupSessions, -}) -``` - -### 3. Use Appropriate Middleware - -Always include Recovery and Logging in production: - -```go -scheduler.New( - scheduler.WithMiddleware( - scheduler.Recovery(logPanic), - scheduler.Logging(logger), - ), -) -``` - -### 4. Avoid Scheduling Exactly on the Hour - -Many systems schedule jobs at `:00`, causing load spikes. Stagger your jobs: - -```go -"5 2 * * *" // 2:05 AM (good) -"0 2 * * *" // 2:00 AM (often overloaded) -``` - -### 5. Make Jobs Idempotent - -Jobs may run multiple times (crash recovery, etc.). Design them to be safely re-runnable: - -```go -Handler: func(ctx context.Context) error { - // Use unique constraint or check-before-insert - db.Exec("INSERT IGNORE INTO processed_items ...") - return nil -} -``` - -### 6. Handle Timezones Explicitly - -Always specify timezone for business-hour jobs: - -```go -Timezone: "America/New_York" // Good -// Timezone: "" // Bad (defaults to UTC) -``` - -### 7. Test Your Cron Expressions - -Use a cron expression calculator before deploying: -- [crontab.guru](https://crontab.guru/) -- Write unit tests with the parser - -## Testing Jobs - -Test job handlers independently of the scheduler: - -```go -func TestCleanupJob(t *testing.T) { - ctx := context.Background() - - err := cleanupHandler(ctx) - if err != nil { - t.Fatalf("cleanup failed: %v", err) - } - - // Verify cleanup occurred -} -``` - -Test schedule parsing: - -```go -func TestScheduleParsing(t *testing.T) { - job := &scheduler.Job{ - Name: "test", - Schedule: "0 2 * * *", - Handler: func(ctx context.Context) error { return nil }, - } - - if err := job.Validate(); err != nil { - t.Fatalf("invalid job: %v", err) - } -} -``` - -## Comparison to Other Solutions - -| Feature | scheduler | robfig/cron | github.com/go-co-op/gocron | -|---------|-----------|-------------|----------------------------| -| Standard cron syntax | ✅ | ✅ | ✅ | -| Seconds support | ✅ | ✅ | ✅ | -| Timezone support | ✅ | ✅ | ✅ | -| Middleware pattern | ✅ | ⚠️ (basic) | ❌ | -| Graceful shutdown | ✅ | ⚠️ (basic) | ✅ | -| Zero dependencies | ✅ | ❌ | ❌ | -| Job metadata | ✅ | ❌ | ⚠️ (limited) | - -## API Reference - -See [example_test.go](./example_test.go) for comprehensive examples. - -### Core Types - -- `Scheduler` - Manages scheduled jobs -- `Job` - Job definition with schedule and handler -- `Middleware` - Function that wraps job handlers - -### Functions - -- `New(opts ...Option) *Scheduler` - Create new scheduler -- `WithTimezone(tz string) Option` - Set default timezone -- `WithMiddleware(mw ...Middleware) Option` - Add middleware - -### Methods - -- `Register(job *Job) error` - Add job to scheduler -- `Start() error` - Begin executing jobs -- `Stop(ctx context.Context) error` - Graceful shutdown - -## License - -This package is part of the Memos project and shares its license. diff --git a/internal/scheduler/doc.go b/internal/scheduler/doc.go deleted file mode 100644 index 86ba92c61..000000000 --- a/internal/scheduler/doc.go +++ /dev/null @@ -1,35 +0,0 @@ -// Package scheduler provides a GitHub Actions-inspired cron job scheduler. -// -// Features: -// - Standard cron expression syntax (5-field and 6-field formats) -// - Timezone-aware scheduling -// - Middleware pattern for cross-cutting concerns (logging, metrics, recovery) -// - Graceful shutdown with context cancellation -// - Zero external dependencies -// -// Basic usage: -// -// s := scheduler.New() -// -// s.Register(&scheduler.Job{ -// Name: "daily-cleanup", -// Schedule: "0 2 * * *", // 2 AM daily -// Handler: func(ctx context.Context) error { -// // Your cleanup logic here -// return nil -// }, -// }) -// -// s.Start() -// defer s.Stop(context.Background()) -// -// With middleware: -// -// s := scheduler.New( -// scheduler.WithTimezone("America/New_York"), -// scheduler.WithMiddleware( -// scheduler.Recovery(), -// scheduler.Logging(), -// ), -// ) -package scheduler diff --git a/internal/scheduler/example_test.go b/internal/scheduler/example_test.go deleted file mode 100644 index 9f12ac5e1..000000000 --- a/internal/scheduler/example_test.go +++ /dev/null @@ -1,165 +0,0 @@ -package scheduler_test - -import ( - "context" - "fmt" - "log/slog" - "os" - "time" - - "github.com/usememos/memos/internal/scheduler" -) - -// Example demonstrates basic scheduler usage. -func Example_basic() { - s := scheduler.New() - - s.Register(&scheduler.Job{ - Name: "hello", - Schedule: "*/5 * * * *", // Every 5 minutes - Description: "Say hello", - Handler: func(_ context.Context) error { - fmt.Println("Hello from scheduler!") - return nil - }, - }) - - s.Start() - defer s.Stop(context.Background()) - - // Scheduler runs in background - time.Sleep(100 * time.Millisecond) -} - -// Example demonstrates timezone-aware scheduling. -func Example_timezone() { - s := scheduler.New( - scheduler.WithTimezone("America/New_York"), - ) - - s.Register(&scheduler.Job{ - Name: "daily-report", - Schedule: "0 9 * * *", // 9 AM in New York - Handler: func(_ context.Context) error { - fmt.Println("Generating daily report...") - return nil - }, - }) - - s.Start() - defer s.Stop(context.Background()) -} - -// Example demonstrates middleware usage. -func Example_middleware() { - logger := slog.New(slog.NewTextHandler(os.Stdout, nil)) - - s := scheduler.New( - scheduler.WithMiddleware( - scheduler.Recovery(func(jobName string, r interface{}) { - logger.Error("Job panicked", "job", jobName, "panic", r) - }), - scheduler.Logging(&slogAdapter{logger}), - scheduler.Timeout(5*time.Minute), - ), - ) - - s.Register(&scheduler.Job{ - Name: "data-sync", - Schedule: "0 */2 * * *", // Every 2 hours - Handler: func(_ context.Context) error { - // Your sync logic here - return nil - }, - }) - - s.Start() - defer s.Stop(context.Background()) -} - -// slogAdapter adapts slog.Logger to scheduler.Logger interface. -type slogAdapter struct { - logger *slog.Logger -} - -func (a *slogAdapter) Info(msg string, args ...interface{}) { - a.logger.Info(msg, args...) -} - -func (a *slogAdapter) Error(msg string, args ...interface{}) { - a.logger.Error(msg, args...) -} - -// Example demonstrates multiple jobs with different schedules. -func Example_multipleJobs() { - s := scheduler.New() - - // Cleanup old data every night at 2 AM - s.Register(&scheduler.Job{ - Name: "cleanup", - Schedule: "0 2 * * *", - Tags: []string{"maintenance"}, - Handler: func(_ context.Context) error { - fmt.Println("Cleaning up old data...") - return nil - }, - }) - - // Health check every 5 minutes - s.Register(&scheduler.Job{ - Name: "health-check", - Schedule: "*/5 * * * *", - Tags: []string{"monitoring"}, - Handler: func(_ context.Context) error { - fmt.Println("Running health check...") - return nil - }, - }) - - // Weekly backup on Sundays at 1 AM - s.Register(&scheduler.Job{ - Name: "weekly-backup", - Schedule: "0 1 * * 0", - Tags: []string{"backup"}, - Handler: func(_ context.Context) error { - fmt.Println("Creating weekly backup...") - return nil - }, - }) - - s.Start() - defer s.Stop(context.Background()) -} - -// Example demonstrates graceful shutdown with timeout. -func Example_gracefulShutdown() { - s := scheduler.New() - - s.Register(&scheduler.Job{ - Name: "long-running", - Schedule: "* * * * *", - Handler: func(ctx context.Context) error { - select { - case <-time.After(30 * time.Second): - fmt.Println("Job completed") - case <-ctx.Done(): - fmt.Println("Job canceled, cleaning up...") - return ctx.Err() - } - return nil - }, - }) - - s.Start() - - // Simulate shutdown signal - time.Sleep(5 * time.Second) - - // Give jobs 10 seconds to finish - shutdownCtx, cancel := context.WithTimeout(context.Background(), 10*time.Second) - defer cancel() - - if err := s.Stop(shutdownCtx); err != nil { - fmt.Printf("Shutdown error: %v\n", err) - } -} diff --git a/internal/scheduler/integration_test.go b/internal/scheduler/integration_test.go deleted file mode 100644 index 92c469f2c..000000000 --- a/internal/scheduler/integration_test.go +++ /dev/null @@ -1,393 +0,0 @@ -package scheduler_test - -import ( - "context" - "errors" - "fmt" - "strings" - "sync" - "sync/atomic" - "testing" - "time" - - "github.com/usememos/memos/internal/scheduler" -) - -// TestRealWorldScenario tests a realistic multi-job scenario. -func TestRealWorldScenario(t *testing.T) { - var ( - quickJobCount atomic.Int32 - hourlyJobCount atomic.Int32 - logEntries []string - logMu sync.Mutex - ) - - logger := &testLogger{ - onInfo: func(msg string, _ ...interface{}) { - logMu.Lock() - logEntries = append(logEntries, fmt.Sprintf("INFO: %s", msg)) - logMu.Unlock() - }, - onError: func(msg string, _ ...interface{}) { - logMu.Lock() - logEntries = append(logEntries, fmt.Sprintf("ERROR: %s", msg)) - logMu.Unlock() - }, - } - - s := scheduler.New( - scheduler.WithTimezone("UTC"), - scheduler.WithMiddleware( - scheduler.Recovery(func(jobName string, r interface{}) { - t.Logf("Job %s panicked: %v", jobName, r) - }), - scheduler.Logging(logger), - scheduler.Timeout(5*time.Second), - ), - ) - - // Quick job (every second) - s.Register(&scheduler.Job{ - Name: "quick-check", - Schedule: "* * * * * *", - Handler: func(_ context.Context) error { - quickJobCount.Add(1) - time.Sleep(100 * time.Millisecond) - return nil - }, - }) - - // Slower job (every 2 seconds) - s.Register(&scheduler.Job{ - Name: "slow-process", - Schedule: "*/2 * * * * *", - Handler: func(_ context.Context) error { - hourlyJobCount.Add(1) - time.Sleep(500 * time.Millisecond) - return nil - }, - }) - - // Start scheduler - if err := s.Start(); err != nil { - t.Fatalf("failed to start scheduler: %v", err) - } - - // Let it run for 5 seconds - time.Sleep(5 * time.Second) - - // Graceful shutdown - ctx, cancel := context.WithTimeout(context.Background(), 10*time.Second) - defer cancel() - - if err := s.Stop(ctx); err != nil { - t.Fatalf("failed to stop scheduler: %v", err) - } - - // Verify execution counts - quick := quickJobCount.Load() - slow := hourlyJobCount.Load() - - t.Logf("Quick job ran %d times", quick) - t.Logf("Slow job ran %d times", slow) - - if quick < 4 { - t.Errorf("expected quick job to run at least 4 times, ran %d", quick) - } - - if slow < 2 { - t.Errorf("expected slow job to run at least 2 times, ran %d", slow) - } - - // Verify logging - logMu.Lock() - defer logMu.Unlock() - - hasStartLog := false - hasCompleteLog := false - for _, entry := range logEntries { - if contains(entry, "Job started") { - hasStartLog = true - } - if contains(entry, "Job completed") { - hasCompleteLog = true - } - } - - if !hasStartLog { - t.Error("expected job start logs") - } - if !hasCompleteLog { - t.Error("expected job completion logs") - } -} - -// TestCancellationDuringExecution verifies jobs can be canceled mid-execution. -func TestCancellationDuringExecution(t *testing.T) { - var canceled atomic.Bool - var started atomic.Bool - - s := scheduler.New() - - s.Register(&scheduler.Job{ - Name: "long-job", - Schedule: "* * * * * *", - Handler: func(ctx context.Context) error { - started.Store(true) - // Simulate long-running work - for i := 0; i < 100; i++ { - select { - case <-ctx.Done(): - canceled.Store(true) - return ctx.Err() - case <-time.After(100 * time.Millisecond): - // Keep working - } - } - return nil - }, - }) - - if err := s.Start(); err != nil { - t.Fatalf("failed to start: %v", err) - } - - // Wait until job starts - for i := 0; i < 30; i++ { - if started.Load() { - break - } - time.Sleep(100 * time.Millisecond) - } - - if !started.Load() { - t.Fatal("job did not start within timeout") - } - - // Stop with reasonable timeout - ctx, cancel := context.WithTimeout(context.Background(), 5*time.Second) - defer cancel() - - if err := s.Stop(ctx); err != nil { - t.Logf("stop returned error (may be expected): %v", err) - } - - if !canceled.Load() { - t.Error("expected job to detect cancellation") - } -} - -// TestTimezoneHandling verifies timezone-aware scheduling. -func TestTimezoneHandling(t *testing.T) { - // Parse a schedule in a specific timezone - schedule, err := scheduler.ParseCronExpression("0 9 * * *") // 9 AM - if err != nil { - t.Fatalf("failed to parse schedule: %v", err) - } - - // Test in New York timezone - nyc, err := time.LoadLocation("America/New_York") - if err != nil { - t.Fatalf("failed to load timezone: %v", err) - } - - // Current time: 8:30 AM in New York - now := time.Date(2025, 1, 15, 8, 30, 0, 0, nyc) - - // Next run should be 9:00 AM same day - next := schedule.Next(now) - expected := time.Date(2025, 1, 15, 9, 0, 0, 0, nyc) - - if !next.Equal(expected) { - t.Errorf("next = %v, expected %v", next, expected) - } - - // If it's already past 9 AM - now = time.Date(2025, 1, 15, 9, 30, 0, 0, nyc) - next = schedule.Next(now) - expected = time.Date(2025, 1, 16, 9, 0, 0, 0, nyc) - - if !next.Equal(expected) { - t.Errorf("next = %v, expected %v", next, expected) - } -} - -// TestErrorPropagation verifies error handling. -func TestErrorPropagation(t *testing.T) { - var errorLogged atomic.Bool - - logger := &testLogger{ - onError: func(msg string, _ ...interface{}) { - if msg == "Job failed" { - errorLogged.Store(true) - } - }, - } - - s := scheduler.New( - scheduler.WithMiddleware( - scheduler.Logging(logger), - ), - ) - - s.Register(&scheduler.Job{ - Name: "failing-job", - Schedule: "* * * * * *", - Handler: func(_ context.Context) error { - return errors.New("intentional error") - }, - }) - - if err := s.Start(); err != nil { - t.Fatalf("failed to start: %v", err) - } - - // Let it run once - time.Sleep(1500 * time.Millisecond) - - ctx, cancel := context.WithTimeout(context.Background(), 5*time.Second) - defer cancel() - - if err := s.Stop(ctx); err != nil { - t.Fatalf("failed to stop: %v", err) - } - - if !errorLogged.Load() { - t.Error("expected error to be logged") - } -} - -// TestPanicRecovery verifies panic recovery middleware. -func TestPanicRecovery(t *testing.T) { - var panicRecovered atomic.Bool - - s := scheduler.New( - scheduler.WithMiddleware( - scheduler.Recovery(func(jobName string, r interface{}) { - panicRecovered.Store(true) - t.Logf("Recovered from panic in job %s: %v", jobName, r) - }), - ), - ) - - s.Register(&scheduler.Job{ - Name: "panicking-job", - Schedule: "* * * * * *", - Handler: func(_ context.Context) error { - panic("intentional panic for testing") - }, - }) - - if err := s.Start(); err != nil { - t.Fatalf("failed to start: %v", err) - } - - // Let it run once - time.Sleep(1500 * time.Millisecond) - - ctx, cancel := context.WithTimeout(context.Background(), 5*time.Second) - defer cancel() - - if err := s.Stop(ctx); err != nil { - t.Fatalf("failed to stop: %v", err) - } - - if !panicRecovered.Load() { - t.Error("expected panic to be recovered") - } -} - -// TestMultipleJobsWithDifferentSchedules verifies concurrent job execution. -func TestMultipleJobsWithDifferentSchedules(t *testing.T) { - var ( - job1Count atomic.Int32 - job2Count atomic.Int32 - job3Count atomic.Int32 - ) - - s := scheduler.New() - - // Job 1: Every second - s.Register(&scheduler.Job{ - Name: "job-1sec", - Schedule: "* * * * * *", - Handler: func(_ context.Context) error { - job1Count.Add(1) - return nil - }, - }) - - // Job 2: Every 2 seconds - s.Register(&scheduler.Job{ - Name: "job-2sec", - Schedule: "*/2 * * * * *", - Handler: func(_ context.Context) error { - job2Count.Add(1) - return nil - }, - }) - - // Job 3: Every 3 seconds - s.Register(&scheduler.Job{ - Name: "job-3sec", - Schedule: "*/3 * * * * *", - Handler: func(_ context.Context) error { - job3Count.Add(1) - return nil - }, - }) - - if err := s.Start(); err != nil { - t.Fatalf("failed to start: %v", err) - } - - // Let them run for 6 seconds - time.Sleep(6 * time.Second) - - ctx, cancel := context.WithTimeout(context.Background(), 5*time.Second) - defer cancel() - - if err := s.Stop(ctx); err != nil { - t.Fatalf("failed to stop: %v", err) - } - - // Verify counts (allowing for timing variance) - c1 := job1Count.Load() - c2 := job2Count.Load() - c3 := job3Count.Load() - - t.Logf("Job 1 ran %d times, Job 2 ran %d times, Job 3 ran %d times", c1, c2, c3) - - if c1 < 5 { - t.Errorf("expected job1 to run at least 5 times, ran %d", c1) - } - if c2 < 2 { - t.Errorf("expected job2 to run at least 2 times, ran %d", c2) - } - if c3 < 1 { - t.Errorf("expected job3 to run at least 1 time, ran %d", c3) - } -} - -// Helpers - -type testLogger struct { - onInfo func(msg string, args ...interface{}) - onError func(msg string, args ...interface{}) -} - -func (l *testLogger) Info(msg string, args ...interface{}) { - if l.onInfo != nil { - l.onInfo(msg, args...) - } -} - -func (l *testLogger) Error(msg string, args ...interface{}) { - if l.onError != nil { - l.onError(msg, args...) - } -} - -func contains(s, substr string) bool { - return strings.Contains(s, substr) -} diff --git a/internal/scheduler/job.go b/internal/scheduler/job.go deleted file mode 100644 index 7ea605110..000000000 --- a/internal/scheduler/job.go +++ /dev/null @@ -1,58 +0,0 @@ -package scheduler - -import ( - "context" - - "github.com/pkg/errors" -) - -// JobHandler is the function signature for scheduled job handlers. -// The context passed to the handler will be canceled if the scheduler is shutting down. -type JobHandler func(ctx context.Context) error - -// Job represents a scheduled task. -type Job struct { - // Name is a unique identifier for this job (required). - // Used for logging and metrics. - Name string - - // Schedule is a cron expression defining when this job runs (required). - // Supports standard 5-field format: "minute hour day month weekday" - // Examples: "0 * * * *" (hourly), "0 0 * * *" (daily at midnight) - Schedule string - - // Timezone for schedule evaluation (optional, defaults to UTC). - // Use IANA timezone names: "America/New_York", "Europe/London", etc. - Timezone string - - // Handler is the function to execute when the job triggers (required). - Handler JobHandler - - // Description provides human-readable context about what this job does (optional). - Description string - - // Tags allow categorizing jobs for filtering/monitoring (optional). - Tags []string -} - -// Validate checks if the job definition is valid. -func (j *Job) Validate() error { - if j.Name == "" { - return errors.New("job name is required") - } - - if j.Schedule == "" { - return errors.New("job schedule is required") - } - - // Validate cron expression using parser - if _, err := ParseCronExpression(j.Schedule); err != nil { - return errors.Wrap(err, "invalid cron expression") - } - - if j.Handler == nil { - return errors.New("job handler is required") - } - - return nil -} diff --git a/internal/scheduler/job_test.go b/internal/scheduler/job_test.go deleted file mode 100644 index 140847720..000000000 --- a/internal/scheduler/job_test.go +++ /dev/null @@ -1,90 +0,0 @@ -package scheduler - -import ( - "context" - "testing" -) - -func TestJobDefinition(t *testing.T) { - callCount := 0 - job := &Job{ - Name: "test-job", - Handler: func(_ context.Context) error { - callCount++ - return nil - }, - } - - if job.Name != "test-job" { - t.Errorf("expected name 'test-job', got %s", job.Name) - } - - // Test handler execution - if err := job.Handler(context.Background()); err != nil { - t.Fatalf("handler failed: %v", err) - } - - if callCount != 1 { - t.Errorf("expected handler to be called once, called %d times", callCount) - } -} - -func TestJobValidation(t *testing.T) { - tests := []struct { - name string - job *Job - wantErr bool - }{ - { - name: "valid job", - job: &Job{ - Name: "valid", - Schedule: "0 * * * *", - Handler: func(_ context.Context) error { return nil }, - }, - wantErr: false, - }, - { - name: "missing name", - job: &Job{ - Schedule: "0 * * * *", - Handler: func(_ context.Context) error { return nil }, - }, - wantErr: true, - }, - { - name: "missing schedule", - job: &Job{ - Name: "test", - Handler: func(_ context.Context) error { return nil }, - }, - wantErr: true, - }, - { - name: "invalid cron expression", - job: &Job{ - Name: "test", - Schedule: "invalid cron", - Handler: func(_ context.Context) error { return nil }, - }, - wantErr: true, - }, - { - name: "missing handler", - job: &Job{ - Name: "test", - Schedule: "0 * * * *", - }, - wantErr: true, - }, - } - - for _, tt := range tests { - t.Run(tt.name, func(t *testing.T) { - err := tt.job.Validate() - if (err != nil) != tt.wantErr { - t.Errorf("Validate() error = %v, wantErr %v", err, tt.wantErr) - } - }) - } -} diff --git a/internal/scheduler/middleware.go b/internal/scheduler/middleware.go deleted file mode 100644 index 52356d007..000000000 --- a/internal/scheduler/middleware.go +++ /dev/null @@ -1,121 +0,0 @@ -package scheduler - -import ( - "context" - "slices" - "time" - - "github.com/pkg/errors" -) - -// Middleware wraps a JobHandler to add cross-cutting behavior. -type Middleware func(JobHandler) JobHandler - -// Chain combines multiple middleware into a single middleware. -// Middleware are applied in the order they're provided (left to right). -func Chain(middlewares ...Middleware) Middleware { - return func(handler JobHandler) JobHandler { - // Apply middleware in reverse order so first middleware wraps outermost - for _, middleware := range slices.Backward(middlewares) { - handler = middleware(handler) - } - return handler - } -} - -// Recovery recovers from panics in job handlers and converts them to errors. -func Recovery(onPanic func(jobName string, recovered interface{})) Middleware { - return func(next JobHandler) JobHandler { - return func(ctx context.Context) (err error) { - defer func() { - if r := recover(); r != nil { - jobName := getJobName(ctx) - if onPanic != nil { - onPanic(jobName, r) - } - err = errors.Errorf("job %q panicked: %v", jobName, r) - } - }() - return next(ctx) - } - } -} - -// Logger is a minimal logging interface. -type Logger interface { - Info(msg string, args ...interface{}) - Error(msg string, args ...interface{}) -} - -// Logging adds execution logging to jobs. -func Logging(logger Logger) Middleware { - return func(next JobHandler) JobHandler { - return func(ctx context.Context) error { - jobName := getJobName(ctx) - start := time.Now() - - logger.Info("Job started", "job", jobName) - - err := next(ctx) - duration := time.Since(start) - - if err != nil { - logger.Error("Job failed", "job", jobName, "duration", duration, "error", err) - } else { - logger.Info("Job completed", "job", jobName, "duration", duration) - } - - return err - } - } -} - -// Timeout wraps a job handler with a timeout. -func Timeout(duration time.Duration) Middleware { - return func(next JobHandler) JobHandler { - return func(ctx context.Context) error { - ctx, cancel := context.WithTimeout(ctx, duration) - defer cancel() - - done := make(chan error, 1) - go func() { - done <- next(ctx) - }() - - select { - case err := <-done: - return err - case <-ctx.Done(): - return errors.Errorf("job %q timed out after %v", getJobName(ctx), duration) - } - } - } -} - -// Context keys for job metadata. -type contextKey int - -const ( - jobNameKey contextKey = iota -) - -// withJobName adds the job name to the context. -func withJobName(ctx context.Context, name string) context.Context { - return context.WithValue(ctx, jobNameKey, name) -} - -// getJobName retrieves the job name from the context. -func getJobName(ctx context.Context) string { - if name, ok := ctx.Value(jobNameKey).(string); ok { - return name - } - return "unknown" -} - -// GetJobName retrieves the job name from the context (public API). -// Returns empty string if not found. -// -//nolint:revive // GetJobName is the public API, getJobName is internal -func GetJobName(ctx context.Context) string { - return getJobName(ctx) -} diff --git a/internal/scheduler/middleware_test.go b/internal/scheduler/middleware_test.go deleted file mode 100644 index 257ac5177..000000000 --- a/internal/scheduler/middleware_test.go +++ /dev/null @@ -1,146 +0,0 @@ -package scheduler - -import ( - "context" - "errors" - "sync/atomic" - "testing" -) - -func TestMiddlewareChaining(t *testing.T) { - var order []string - - mw1 := func(next JobHandler) JobHandler { - return func(ctx context.Context) error { - order = append(order, "before-1") - err := next(ctx) - order = append(order, "after-1") - return err - } - } - - mw2 := func(next JobHandler) JobHandler { - return func(ctx context.Context) error { - order = append(order, "before-2") - err := next(ctx) - order = append(order, "after-2") - return err - } - } - - handler := func(_ context.Context) error { - order = append(order, "handler") - return nil - } - - chain := Chain(mw1, mw2) - wrapped := chain(handler) - - if err := wrapped(context.Background()); err != nil { - t.Fatalf("wrapped handler failed: %v", err) - } - - expected := []string{"before-1", "before-2", "handler", "after-2", "after-1"} - if len(order) != len(expected) { - t.Fatalf("expected %d calls, got %d", len(expected), len(order)) - } - - for i, want := range expected { - if order[i] != want { - t.Errorf("order[%d] = %q, want %q", i, order[i], want) - } - } -} - -func TestRecoveryMiddleware(t *testing.T) { - var panicRecovered atomic.Bool - - onPanic := func(_ string, _ interface{}) { - panicRecovered.Store(true) - } - - handler := func(_ context.Context) error { - panic("simulated panic") - } - - recovery := Recovery(onPanic) - wrapped := recovery(handler) - - // Should not panic, error should be returned - err := wrapped(withJobName(context.Background(), "test-job")) - if err == nil { - t.Error("expected error from recovered panic") - } - - if !panicRecovered.Load() { - t.Error("panic handler was not called") - } -} - -func TestLoggingMiddleware(t *testing.T) { - var loggedStart, loggedEnd atomic.Bool - var loggedError atomic.Bool - - logger := &testLogger{ - onInfo: func(msg string, _ ...interface{}) { - if msg == "Job started" { - loggedStart.Store(true) - } else if msg == "Job completed" { - loggedEnd.Store(true) - } - }, - onError: func(msg string, _ ...interface{}) { - if msg == "Job failed" { - loggedError.Store(true) - } - }, - } - - // Test successful execution - handler := func(_ context.Context) error { - return nil - } - - logging := Logging(logger) - wrapped := logging(handler) - - if err := wrapped(withJobName(context.Background(), "test-job")); err != nil { - t.Fatalf("handler failed: %v", err) - } - - if !loggedStart.Load() { - t.Error("start was not logged") - } - if !loggedEnd.Load() { - t.Error("end was not logged") - } - - // Test error handling - handlerErr := func(_ context.Context) error { - return errors.New("job error") - } - - wrappedErr := logging(handlerErr) - _ = wrappedErr(withJobName(context.Background(), "test-job-error")) - - if !loggedError.Load() { - t.Error("error was not logged") - } -} - -type testLogger struct { - onInfo func(msg string, args ...interface{}) - onError func(msg string, args ...interface{}) -} - -func (l *testLogger) Info(msg string, args ...interface{}) { - if l.onInfo != nil { - l.onInfo(msg, args...) - } -} - -func (l *testLogger) Error(msg string, args ...interface{}) { - if l.onError != nil { - l.onError(msg, args...) - } -} diff --git a/internal/scheduler/parser.go b/internal/scheduler/parser.go deleted file mode 100644 index 96a837b26..000000000 --- a/internal/scheduler/parser.go +++ /dev/null @@ -1,240 +0,0 @@ -package scheduler - -import ( - "slices" - "strconv" - "strings" - "time" - - "github.com/pkg/errors" -) - -// Schedule represents a parsed cron expression. -type Schedule struct { - seconds fieldMatcher // 0-59 (optional, for 6-field format) - minutes fieldMatcher // 0-59 - hours fieldMatcher // 0-23 - days fieldMatcher // 1-31 - months fieldMatcher // 1-12 - weekdays fieldMatcher // 0-7 (0 and 7 are Sunday) - hasSecs bool - dayWildcard bool -} - -// fieldMatcher determines if a field value matches. -type fieldMatcher interface { - matches(value int) bool -} - -// ParseCronExpression parses a cron expression and returns a Schedule. -// Supports both 5-field (minute hour day month weekday) and 6-field (second minute hour day month weekday) formats. -func ParseCronExpression(expr string) (*Schedule, error) { - if expr == "" { - return nil, errors.New("empty cron expression") - } - - fields := strings.Fields(expr) - if len(fields) != 5 && len(fields) != 6 { - return nil, errors.Errorf("invalid cron expression: expected 5 or 6 fields, got %d", len(fields)) - } - - s := &Schedule{ - hasSecs: len(fields) == 6, - } - - var err error - offset := 0 - - // Parse seconds (if 6-field format) - if s.hasSecs { - s.seconds, err = parseField(fields[0], 0, 59) - if err != nil { - return nil, errors.Wrap(err, "invalid seconds field") - } - offset = 1 - } else { - s.seconds = &exactMatcher{value: 0} // Default to 0 seconds - } - - // Parse minutes - s.minutes, err = parseField(fields[offset], 0, 59) - if err != nil { - return nil, errors.Wrap(err, "invalid minutes field") - } - - // Parse hours - s.hours, err = parseField(fields[offset+1], 0, 23) - if err != nil { - return nil, errors.Wrap(err, "invalid hours field") - } - - // Parse days - s.days, err = parseField(fields[offset+2], 1, 31) - if err != nil { - return nil, errors.Wrap(err, "invalid days field") - } - - // Parse months - s.months, err = parseField(fields[offset+3], 1, 12) - if err != nil { - return nil, errors.Wrap(err, "invalid months field") - } - - // Parse weekdays (0-7, where both 0 and 7 represent Sunday) - s.weekdays, err = parseField(fields[offset+4], 0, 7) - if err != nil { - return nil, errors.Wrap(err, "invalid weekdays field") - } - s.dayWildcard = strings.HasPrefix(fields[offset+2], "*") || strings.HasPrefix(fields[offset+4], "*") - - return s, nil -} - -// Next returns the next time the schedule should run after the given time. -func (s *Schedule) Next(from time.Time) time.Time { - // Start from the next second/minute - if s.hasSecs { - from = from.Add(1 * time.Second).Truncate(time.Second) - } else { - from = from.Add(1 * time.Minute).Truncate(time.Minute) - } - - // Cap search at 4 years to prevent infinite loops - maxTime := from.AddDate(4, 0, 0) - - for from.Before(maxTime) { - if s.matches(from) { - return from - } - - // Advance to next potential match - if s.hasSecs { - from = from.Add(1 * time.Second) - } else { - from = from.Add(1 * time.Minute) - } - } - - // Should never reach here with valid cron expressions - return time.Time{} -} - -// matches checks if the given time matches the schedule. -func (s *Schedule) matches(t time.Time) bool { - if !s.seconds.matches(t.Second()) || !s.minutes.matches(t.Minute()) || - !s.hours.matches(t.Hour()) || !s.months.matches(int(t.Month())) { - return false - } - - dayMatches := s.days.matches(t.Day()) - weekdayMatches := s.weekdays.matches(int(t.Weekday())) - if t.Weekday() == time.Sunday { - weekdayMatches = weekdayMatches || s.weekdays.matches(7) - } - - // Cron combines restricted day fields with OR, but wildcard fields (including steps) use AND. - calendarMatches := dayMatches || weekdayMatches - if s.dayWildcard { - calendarMatches = dayMatches && weekdayMatches - } - - return calendarMatches -} - -// parseField parses a single cron field (supports *, ranges, lists, steps). -func parseField(field string, min, max int) (fieldMatcher, error) { - // Wildcard - if field == "*" { - return &wildcardMatcher{}, nil - } - - // Step values (*/N) - if strings.HasPrefix(field, "*/") { - step, err := strconv.Atoi(field[2:]) - if err != nil || step < 1 || step > max { - return nil, errors.Errorf("invalid step value: %s", field) - } - return &stepMatcher{step: step, min: min, max: max}, nil - } - - // List (1,2,3) - if strings.Contains(field, ",") { - parts := strings.Split(field, ",") - values := make([]int, 0, len(parts)) - for _, p := range parts { - val, err := strconv.Atoi(strings.TrimSpace(p)) - if err != nil || val < min || val > max { - return nil, errors.Errorf("invalid list value: %s", p) - } - values = append(values, val) - } - return &listMatcher{values: values}, nil - } - - // Range (1-5) - if strings.Contains(field, "-") { - parts := strings.Split(field, "-") - if len(parts) != 2 { - return nil, errors.Errorf("invalid range: %s", field) - } - start, err1 := strconv.Atoi(strings.TrimSpace(parts[0])) - end, err2 := strconv.Atoi(strings.TrimSpace(parts[1])) - if err1 != nil || err2 != nil || start < min || end > max || start > end { - return nil, errors.Errorf("invalid range: %s", field) - } - return &rangeMatcher{start: start, end: end}, nil - } - - // Exact value - val, err := strconv.Atoi(field) - if err != nil || val < min || val > max { - return nil, errors.Errorf("invalid value: %s (must be between %d and %d)", field, min, max) - } - return &exactMatcher{value: val}, nil -} - -// wildcardMatcher matches any value. -type wildcardMatcher struct{} - -func (*wildcardMatcher) matches(_ int) bool { - return true -} - -// exactMatcher matches a specific value. -type exactMatcher struct { - value int -} - -func (m *exactMatcher) matches(value int) bool { - return value == m.value -} - -// rangeMatcher matches values in a range. -type rangeMatcher struct { - start, end int -} - -func (m *rangeMatcher) matches(value int) bool { - return value >= m.start && value <= m.end -} - -// listMatcher matches any value in a list. -type listMatcher struct { - values []int -} - -func (m *listMatcher) matches(value int) bool { - return slices.Contains(m.values, value) -} - -// stepMatcher matches values at regular intervals. -type stepMatcher struct { - step, min, max int -} - -func (m *stepMatcher) matches(value int) bool { - if value < m.min || value > m.max { - return false - } - return (value-m.min)%m.step == 0 -} diff --git a/internal/scheduler/parser_calendar_test.go b/internal/scheduler/parser_calendar_test.go deleted file mode 100644 index beaf44ea1..000000000 --- a/internal/scheduler/parser_calendar_test.go +++ /dev/null @@ -1,58 +0,0 @@ -package scheduler - -import ( - "testing" - "time" - - "github.com/stretchr/testify/require" -) - -func TestScheduleNextCalendarDays(t *testing.T) { - tests := []struct { - name string - expr string - from string - want string - }{ - {"weekly", "0 0 * * 0", "2025-01-01T10:00:00Z", "2025-01-05T00:00:00Z"}, - {"monthly", "0 0 1 * *", "2025-01-02T00:00:00Z", "2025-02-01T00:00:00Z"}, - {"weekdays skip weekend", "0 9 * * 1-5", "2025-01-03T09:00:00Z", "2025-01-06T09:00:00Z"}, - {"day step with weekday", "0 0 */2 * 3", "2025-01-01T00:00:00Z", "2025-01-15T00:00:00Z"}, - {"weekday step with day", "0 0 13 * */2", "2025-01-01T00:00:00Z", "2025-02-13T00:00:00Z"}, - {"both day steps", "0 0 */2 * */2", "2025-01-01T00:00:00Z", "2025-01-05T00:00:00Z"}, - {"restricted fields match day", "0 0 15 * 1", "2025-01-13T00:00:00Z", "2025-01-15T00:00:00Z"}, - {"restricted fields match weekday", "0 0 15 * 1", "2025-01-15T00:00:00Z", "2025-01-20T00:00:00Z"}, - {"explicit full range uses OR", "0 0 1-31 * 1", "2025-01-01T00:00:00Z", "2025-01-02T00:00:00Z"}, - {"Sunday zero with restricted day", "0 0 31 * 0", "2025-01-04T00:00:00Z", "2025-01-05T00:00:00Z"}, - {"Sunday seven with restricted day", "0 0 31 * 7", "2025-01-04T00:00:00Z", "2025-01-05T00:00:00Z"}, - {"Sunday seven with wildcard day", "0 0 * * 7", "2025-01-06T00:00:00Z", "2025-01-12T00:00:00Z"}, - {"Sunday seven in list", "0 0 31 * 1,7", "2025-01-04T00:00:00Z", "2025-01-05T00:00:00Z"}, - {"Sunday seven in range", "0 0 31 * 5-7", "2025-01-04T00:00:00Z", "2025-01-05T00:00:00Z"}, - {"Sunday aliases do not repeat", "0 0 * * 0,7", "2025-01-05T00:00:00Z", "2025-01-12T00:00:00Z"}, - } - - for _, format := range []struct { - name string - prefix string - }{ - {"five fields", ""}, - {"six fields", "0 "}, - } { - t.Run(format.name, func(t *testing.T) { - for _, tt := range tests { - t.Run(tt.name, func(t *testing.T) { - from, err := time.Parse(time.RFC3339, tt.from) - require.NoError(t, err) - want, err := time.Parse(time.RFC3339, tt.want) - require.NoError(t, err) - schedule, err := ParseCronExpression(format.prefix + tt.expr) - require.NoError(t, err) - - next := schedule.Next(from) - - require.Equal(t, want, next) - }) - } - }) - } -} diff --git a/internal/scheduler/parser_test.go b/internal/scheduler/parser_test.go deleted file mode 100644 index 2fe120d9e..000000000 --- a/internal/scheduler/parser_test.go +++ /dev/null @@ -1,127 +0,0 @@ -package scheduler - -import ( - "testing" - "time" -) - -func TestParseCronExpression(t *testing.T) { - tests := []struct { - name string - expr string - wantErr bool - }{ - // Standard 5-field format - {"every minute", "* * * * *", false}, - {"hourly", "0 * * * *", false}, - {"daily midnight", "0 0 * * *", false}, - {"weekly sunday", "0 0 * * 0", false}, - {"monthly", "0 0 1 * *", false}, - {"specific time", "30 14 * * *", false}, // 2:30 PM daily - {"range", "0 9-17 * * *", false}, // Every hour 9 AM - 5 PM - {"step", "*/15 * * * *", false}, // Every 15 minutes - {"list", "0 8,12,18 * * *", false}, // 8 AM, 12 PM, 6 PM - - // 6-field format with seconds - {"with seconds", "0 * * * * *", false}, - {"every 30 seconds", "*/30 * * * * *", false}, - - // Invalid expressions - {"empty", "", true}, - {"too few fields", "* * *", true}, - {"too many fields", "* * * * * * *", true}, - {"invalid minute", "60 * * * *", true}, - {"invalid hour", "0 24 * * *", true}, - {"invalid day", "0 0 32 * *", true}, - {"invalid month", "0 0 1 13 *", true}, - {"invalid weekday", "0 0 * * 8", true}, - {"garbage", "not a cron expression", true}, - } - - for _, tt := range tests { - t.Run(tt.name, func(t *testing.T) { - schedule, err := ParseCronExpression(tt.expr) - if (err != nil) != tt.wantErr { - t.Errorf("ParseCronExpression(%q) error = %v, wantErr %v", tt.expr, err, tt.wantErr) - return - } - if !tt.wantErr && schedule == nil { - t.Errorf("ParseCronExpression(%q) returned nil schedule without error", tt.expr) - } - }) - } -} - -func TestScheduleNext(t *testing.T) { - tests := []struct { - name string - expr string - from time.Time - expected time.Time - }{ - { - name: "every minute from start of hour", - expr: "* * * * *", - from: time.Date(2025, 1, 1, 10, 0, 0, 0, time.UTC), - expected: time.Date(2025, 1, 1, 10, 1, 0, 0, time.UTC), - }, - { - name: "hourly at minute 30", - expr: "30 * * * *", - from: time.Date(2025, 1, 1, 10, 0, 0, 0, time.UTC), - expected: time.Date(2025, 1, 1, 10, 30, 0, 0, time.UTC), - }, - { - name: "hourly at minute 30 (already past)", - expr: "30 * * * *", - from: time.Date(2025, 1, 1, 10, 45, 0, 0, time.UTC), - expected: time.Date(2025, 1, 1, 11, 30, 0, 0, time.UTC), - }, - { - name: "daily at 2 AM", - expr: "0 2 * * *", - from: time.Date(2025, 1, 1, 10, 0, 0, 0, time.UTC), - expected: time.Date(2025, 1, 2, 2, 0, 0, 0, time.UTC), - }, - { - name: "every 15 minutes", - expr: "*/15 * * * *", - from: time.Date(2025, 1, 1, 10, 7, 0, 0, time.UTC), - expected: time.Date(2025, 1, 1, 10, 15, 0, 0, time.UTC), - }, - } - - for _, tt := range tests { - t.Run(tt.name, func(t *testing.T) { - schedule, err := ParseCronExpression(tt.expr) - if err != nil { - t.Fatalf("failed to parse expression: %v", err) - } - - next := schedule.Next(tt.from) - if !next.Equal(tt.expected) { - t.Errorf("Next(%v) = %v, expected %v", tt.from, next, tt.expected) - } - }) - } -} - -func TestScheduleNextWithTimezone(t *testing.T) { - nyc, _ := time.LoadLocation("America/New_York") - - // Schedule for 9 AM in New York - schedule, err := ParseCronExpression("0 9 * * *") - if err != nil { - t.Fatalf("failed to parse expression: %v", err) - } - - // Current time: 8 AM in New York - from := time.Date(2025, 1, 1, 8, 0, 0, 0, nyc) - next := schedule.Next(from) - - // Should be 9 AM same day in New York - expected := time.Date(2025, 1, 1, 9, 0, 0, 0, nyc) - if !next.Equal(expected) { - t.Errorf("Next(%v) = %v, expected %v", from, next, expected) - } -} diff --git a/internal/scheduler/scheduler.go b/internal/scheduler/scheduler.go deleted file mode 100644 index b795dd1e8..000000000 --- a/internal/scheduler/scheduler.go +++ /dev/null @@ -1,202 +0,0 @@ -package scheduler - -import ( - "context" - "sync" - "time" - - "github.com/pkg/errors" -) - -// Scheduler manages scheduled jobs. -type Scheduler struct { - jobs map[string]*registeredJob - jobsMu sync.RWMutex - timezone *time.Location - middleware Middleware - running bool - runningMu sync.RWMutex - stopCh chan struct{} - wg sync.WaitGroup -} - -// registeredJob wraps a Job with runtime state. -type registeredJob struct { - job *Job - cancelFn context.CancelFunc -} - -// Option configures a Scheduler. -type Option func(*Scheduler) - -// WithTimezone sets the default timezone for all jobs. -func WithTimezone(tz string) Option { - return func(s *Scheduler) { - loc, err := time.LoadLocation(tz) - if err != nil { - // Default to UTC on invalid timezone - loc = time.UTC - } - s.timezone = loc - } -} - -// WithMiddleware sets middleware to wrap all job handlers. -func WithMiddleware(mw ...Middleware) Option { - return func(s *Scheduler) { - if len(mw) > 0 { - s.middleware = Chain(mw...) - } - } -} - -// New creates a new Scheduler with optional configuration. -func New(opts ...Option) *Scheduler { - s := &Scheduler{ - jobs: make(map[string]*registeredJob), - timezone: time.UTC, - stopCh: make(chan struct{}), - } - - for _, opt := range opts { - opt(s) - } - - return s -} - -// Register adds a job to the scheduler. -// Jobs must be registered before calling Start(). -func (s *Scheduler) Register(job *Job) error { - if job == nil { - return errors.New("job cannot be nil") - } - - if err := job.Validate(); err != nil { - return errors.Wrap(err, "invalid job") - } - - s.jobsMu.Lock() - defer s.jobsMu.Unlock() - - if _, exists := s.jobs[job.Name]; exists { - return errors.Errorf("job with name %q already registered", job.Name) - } - - s.jobs[job.Name] = ®isteredJob{job: job} - return nil -} - -// Start begins executing scheduled jobs. -func (s *Scheduler) Start() error { - s.runningMu.Lock() - defer s.runningMu.Unlock() - - if s.running { - return errors.New("scheduler already running") - } - - s.jobsMu.RLock() - defer s.jobsMu.RUnlock() - - // Parse and schedule all jobs - for _, rj := range s.jobs { - schedule, err := ParseCronExpression(rj.job.Schedule) - if err != nil { - return errors.Wrapf(err, "failed to parse schedule for job %q", rj.job.Name) - } - - ctx, cancel := context.WithCancel(context.Background()) - rj.cancelFn = cancel - - s.wg.Add(1) - go s.runJobWithSchedule(ctx, rj, schedule) - } - - s.running = true - return nil -} - -// runJobWithSchedule executes a job according to its cron schedule. -func (s *Scheduler) runJobWithSchedule(ctx context.Context, rj *registeredJob, schedule *Schedule) { - defer s.wg.Done() - - // Apply middleware to handler - handler := rj.job.Handler - if s.middleware != nil { - handler = s.middleware(handler) - } - - for { - // Calculate next run time - now := time.Now() - if rj.job.Timezone != "" { - loc, err := time.LoadLocation(rj.job.Timezone) - if err == nil { - now = now.In(loc) - } - } else if s.timezone != nil { - now = now.In(s.timezone) - } - - next := schedule.Next(now) - duration := time.Until(next) - - timer := time.NewTimer(duration) - - select { - case <-timer.C: - // Add job name to context and execute - jobCtx := withJobName(ctx, rj.job.Name) - if err := handler(jobCtx); err != nil { - // Error already handled by middleware (if any) - _ = err - } - case <-ctx.Done(): - // Stop the timer to prevent it from firing. The timer will be garbage collected. - timer.Stop() - return - case <-s.stopCh: - // Stop the timer to prevent it from firing. The timer will be garbage collected. - timer.Stop() - return - } - } -} - -// Stop gracefully shuts down the scheduler. -// It waits for all running jobs to complete or until the context is canceled. -func (s *Scheduler) Stop(ctx context.Context) error { - s.runningMu.Lock() - if !s.running { - s.runningMu.Unlock() - return errors.New("scheduler not running") - } - s.running = false - s.runningMu.Unlock() - - // Cancel all job contexts - s.jobsMu.RLock() - for _, rj := range s.jobs { - if rj.cancelFn != nil { - rj.cancelFn() - } - } - s.jobsMu.RUnlock() - - // Signal stop and wait for jobs to finish - close(s.stopCh) - - done := make(chan struct{}) - go func() { - s.wg.Wait() - close(done) - }() - - select { - case <-done: - return nil - case <-ctx.Done(): - return ctx.Err() - } -} diff --git a/internal/scheduler/scheduler_test.go b/internal/scheduler/scheduler_test.go deleted file mode 100644 index b8409c969..000000000 --- a/internal/scheduler/scheduler_test.go +++ /dev/null @@ -1,165 +0,0 @@ -package scheduler - -import ( - "context" - "fmt" - "strings" - "sync" - "sync/atomic" - "testing" - "time" -) - -func TestSchedulerCreation(t *testing.T) { - s := New() - if s == nil { - t.Fatal("New() returned nil") - } -} - -func TestSchedulerWithTimezone(t *testing.T) { - s := New(WithTimezone("America/New_York")) - if s == nil { - t.Fatal("New() with timezone returned nil") - } -} - -func TestJobRegistration(t *testing.T) { - s := New() - - job := &Job{ - Name: "test-registration", - Schedule: "0 * * * *", - Handler: func(_ context.Context) error { return nil }, - } - - if err := s.Register(job); err != nil { - t.Fatalf("failed to register valid job: %v", err) - } - - // Registering duplicate name should fail - if err := s.Register(job); err == nil { - t.Error("expected error when registering duplicate job name") - } -} - -func TestSchedulerStartStop(t *testing.T) { - s := New() - - var runCount atomic.Int32 - job := &Job{ - Name: "test-start-stop", - Schedule: "* * * * * *", // Every second (6-field format) - Handler: func(_ context.Context) error { - runCount.Add(1) - return nil - }, - } - - if err := s.Register(job); err != nil { - t.Fatalf("failed to register job: %v", err) - } - - // Start scheduler - if err := s.Start(); err != nil { - t.Fatalf("failed to start scheduler: %v", err) - } - - // Let it run for 2.5 seconds - time.Sleep(2500 * time.Millisecond) - - // Stop scheduler - ctx, cancel := context.WithTimeout(context.Background(), 5*time.Second) - defer cancel() - - if err := s.Stop(ctx); err != nil { - t.Fatalf("failed to stop scheduler: %v", err) - } - - count := runCount.Load() - // Should have run at least twice (at 0s and 1s, maybe 2s) - if count < 2 { - t.Errorf("expected job to run at least 2 times, ran %d times", count) - } - - // Verify it stopped (count shouldn't increase) - finalCount := count - time.Sleep(1500 * time.Millisecond) - if runCount.Load() != finalCount { - t.Error("scheduler did not stop - job continued running") - } -} - -func TestSchedulerWithMiddleware(t *testing.T) { - var executionLog []string - var logMu sync.Mutex - - logger := &testLogger{ - onInfo: func(msg string, _ ...interface{}) { - logMu.Lock() - executionLog = append(executionLog, fmt.Sprintf("INFO: %s", msg)) - logMu.Unlock() - }, - onError: func(msg string, _ ...interface{}) { - logMu.Lock() - executionLog = append(executionLog, fmt.Sprintf("ERROR: %s", msg)) - logMu.Unlock() - }, - } - - s := New(WithMiddleware( - Recovery(func(jobName string, r interface{}) { - logMu.Lock() - executionLog = append(executionLog, fmt.Sprintf("PANIC: %s - %v", jobName, r)) - logMu.Unlock() - }), - Logging(logger), - )) - - job := &Job{ - Name: "test-middleware", - Schedule: "* * * * * *", // Every second - Handler: func(_ context.Context) error { - return nil - }, - } - - if err := s.Register(job); err != nil { - t.Fatalf("failed to register job: %v", err) - } - - if err := s.Start(); err != nil { - t.Fatalf("failed to start: %v", err) - } - - time.Sleep(1500 * time.Millisecond) - - ctx, cancel := context.WithTimeout(context.Background(), 5*time.Second) - defer cancel() - - if err := s.Stop(ctx); err != nil { - t.Fatalf("failed to stop: %v", err) - } - - logMu.Lock() - defer logMu.Unlock() - - // Should have at least one start and one completion log - hasStart := false - hasCompletion := false - for _, log := range executionLog { - if strings.Contains(log, "Job started") { - hasStart = true - } - if strings.Contains(log, "Job completed") { - hasCompletion = true - } - } - - if !hasStart { - t.Error("expected job start log") - } - if !hasCompletion { - t.Error("expected job completion log") - } -} diff --git a/internal/util/util.go b/internal/util/util.go deleted file mode 100644 index c1309f8b3..000000000 --- a/internal/util/util.go +++ /dev/null @@ -1,98 +0,0 @@ -package util //nolint:revive // util namespace is intentional for shared helpers - -import ( - "crypto/rand" - "math/big" - "net/mail" - "strconv" - "strings" - "uuid" - - "github.com/pkg/errors" -) - -// ConvertStringToInt32 converts a string to int32. -func ConvertStringToInt32(src string) (int32, error) { - parsed, err := strconv.ParseInt(src, 10, 32) - if err != nil { - return 0, err - } - return int32(parsed), nil -} - -// HasPrefixes returns true if the string s has any of the given prefixes. -func HasPrefixes(src string, prefixes ...string) bool { - for _, prefix := range prefixes { - if strings.HasPrefix(src, prefix) { - return true - } - } - return false -} - -// maxEmailLength is the longest address accepted for storage. RFC 5321 caps a -// forward path at 256 octets including the angle brackets, so 254 is the -// widely used practical limit. -const maxEmailLength = 254 - -// NormalizeEmail validates an email address and returns its canonical stored -// form: surrounding whitespace removed and every character lowercased. An -// empty input (after trimming) is valid and returns "", meaning no address. -// -// Display-name forms such as "Alice " are rejected even -// though the mail parser accepts them, because the stored value must be the -// bare address. The local part is lowercased along with the domain: every -// mainstream provider treats it case-insensitively, and folding both halves -// is what makes the instance-wide uniqueness rule match what users expect. -func NormalizeEmail(email string) (string, error) { - email = strings.TrimSpace(email) - if email == "" { - return "", nil - } - if len(email) > maxEmailLength { - return "", errors.Errorf("email must be at most %d characters", maxEmailLength) - } - address, err := mail.ParseAddress(email) - if err != nil { - return "", errors.New("email is not a valid address") - } - if address.Address != email { - return "", errors.New("email must be a bare address without a display name") - } - return strings.ToLower(email), nil -} - -func GenUUID() string { - return uuid.NewV4().String() -} - -var letters = []rune("0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ") - -// RandomString returns a random string with length n. -func RandomString(n int) (string, error) { - var sb strings.Builder - sb.Grow(n) - for i := 0; i < n; i++ { - // The reason for using crypto/rand instead of math/rand is that - // the former relies on hardware to generate random numbers and - // thus has a stronger source of random numbers. - randNum, err := rand.Int(rand.Reader, big.NewInt(int64(len(letters)))) - if err != nil { - return "", err - } - if _, err := sb.WriteRune(letters[randNum.Uint64()]); err != nil { - return "", err - } - } - return sb.String(), nil -} - -// ReplaceString replaces all occurrences of old in slice with new. -func ReplaceString(slice []string, old, new string) []string { - for i, s := range slice { - if s == old { - slice[i] = new - } - } - return slice -} diff --git a/internal/webhook/webhook.go b/internal/webhook/webhook.go index 36005d967..e2213cb1e 100644 --- a/internal/webhook/webhook.go +++ b/internal/webhook/webhook.go @@ -19,8 +19,6 @@ import ( "uuid" "github.com/pkg/errors" - - v1pb "github.com/usememos/memos/proto/gen/api/v1" ) var ( @@ -37,17 +35,17 @@ var ( }, } - asyncPostQueue = make(chan *WebhookRequestPayload, 128) + asyncPostQueue = make(chan *Request, 128) ) func init() { for range 4 { go func() { - for payload := range asyncPostQueue { - if err := Post(payload); err != nil { + for request := range asyncPostQueue { + if err := Post(request); err != nil { slog.Warn("Failed to dispatch webhook asynchronously", - slog.String("url", payload.URL), - slog.String("activityType", payload.ActivityType), + slog.String("url", request.URL), + slog.String("label", request.Label), slog.Any("err", err)) } } @@ -99,17 +97,17 @@ func safeDialContext(ctx context.Context, network, addr string) (net.Conn, error return nil, errors.Errorf("webhook: host %q resolved to no IP addresses", host) } -type WebhookRequestPayload struct { - // The target URL for the webhook request. - URL string `json:"url"` - // The type of activity that triggered this webhook. - ActivityType string `json:"activityType"` - // The resource name of the creator. Format: users/{user} - Creator string `json:"creator"` - // The memo that triggered this webhook (if applicable). - Memo *v1pb.Memo `json:"memo"` - // Optional signing secret for HMAC-SHA256 signature. Not serialized to JSON. - SigningSecret string `json:"-"` +// Request is one webhook delivery: Payload is JSON-encoded and posted to URL, +// signed with SigningSecret when one is set. +type Request struct { + // URL is the destination endpoint. + URL string + // Label identifies the delivery in logs, for example an activity type. + Label string + // SigningSecret enables Standard Webhooks HMAC-SHA256 signing when non-empty. + SigningSecret string + // Payload is the value encoded as the JSON request body. + Payload any } // resolveSigningKey returns the raw HMAC key for a signing secret. Secrets using @@ -139,9 +137,9 @@ func GenerateSigningSecret() (string, error) { return "whsec_" + base64.StdEncoding.EncodeToString(buf), nil } -// Post posts the message to webhook endpoint. -func Post(requestPayload *WebhookRequestPayload) error { - body, err := json.Marshal(requestPayload) +// Post delivers the request synchronously and returns the receiver's verdict. +func Post(requestPayload *Request) error { + body, err := json.Marshal(requestPayload.Payload) if err != nil { return errors.Wrapf(err, "failed to marshal webhook request to %s", requestPayload.URL) } @@ -202,11 +200,11 @@ func Post(requestPayload *WebhookRequestPayload) error { return nil } -// PostAsync posts the message to webhook endpoint asynchronously. -// It enqueues the request for bounded asynchronous dispatch and does not wait for the response. -func PostAsync(requestPayload *WebhookRequestPayload) { +// PostAsync enqueues the request for bounded asynchronous delivery and does +// not wait for the response. +func PostAsync(requestPayload *Request) { if requestPayload == nil { - slog.Warn("Dropped webhook dispatch because payload is nil") + slog.Warn("Dropped webhook dispatch because request is nil") return } select { @@ -214,6 +212,6 @@ func PostAsync(requestPayload *WebhookRequestPayload) { default: slog.Warn("Dropped webhook dispatch because the async queue is full", slog.String("url", requestPayload.URL), - slog.String("activityType", requestPayload.ActivityType)) + slog.String("label", requestPayload.Label)) } } diff --git a/internal/webhook/webhook_test.go b/internal/webhook/webhook_test.go index 092b279ad..0d1896fb1 100644 --- a/internal/webhook/webhook_test.go +++ b/internal/webhook/webhook_test.go @@ -125,7 +125,7 @@ func TestPostChecksRedirectDestinationAtDialTime(t *testing.T) { defer redirectSource.Close() sourceURL := strings.Replace(redirectSource.URL, "127.0.0.1", "localhost", 1) - err := Post(&WebhookRequestPayload{URL: sourceURL}) + err := Post(&Request{URL: sourceURL}) require.ErrorContains(t, err, "connection to reserved/private IP address is not allowed") require.False(t, redirectedRequestReceived.Load()) } @@ -149,7 +149,7 @@ func TestPostAllowsExplicitPrivateIPPolicyAtDialTime(t *testing.T) { })) defer server.Close() - require.NoError(t, Post(&WebhookRequestPayload{URL: server.URL})) + require.NoError(t, Post(&Request{URL: server.URL})) }) } } @@ -255,10 +255,9 @@ func TestPostSignsRequest(t *testing.T) { })) defer server.Close() - err := Post(&WebhookRequestPayload{ + err := Post(&Request{ URL: server.URL, - ActivityType: "memos.memo.created", - Creator: "users/1", + Label: "memos.memo.created", SigningSecret: tc.secret, }) require.NoError(t, err) @@ -292,10 +291,9 @@ func TestPostWithoutSecretSetsNoSignatureHeaders(t *testing.T) { })) defer server.Close() - err := Post(&WebhookRequestPayload{ - URL: server.URL, - ActivityType: "memos.memo.created", - Creator: "users/1", + err := Post(&Request{ + URL: server.URL, + Label: "memos.memo.created", }) require.NoError(t, err) require.False(t, hasSignatureHeaders, "no signature headers should be set when no secret is configured") @@ -316,10 +314,9 @@ func TestPostRejectsUnspecifiedAddressDestination(t *testing.T) { _, port, err := net.SplitHostPort(strings.TrimPrefix(server.URL, "http://")) require.NoError(t, err) - err = Post(&WebhookRequestPayload{ - URL: "http://0.0.0.0:" + port, - ActivityType: "memos.memo.created", - Creator: "users/1", + err = Post(&Request{ + URL: "http://0.0.0.0:" + port, + Label: "memos.memo.created", }) require.Error(t, err) require.False(t, receivedRequest.Load(), "the webhook must not reach a local service through the unspecified address") diff --git a/internal/markdown/ast/gfm_email.go b/markdown/ast/gfm_email.go similarity index 100% rename from internal/markdown/ast/gfm_email.go rename to markdown/ast/gfm_email.go diff --git a/internal/markdown/ast/math.go b/markdown/ast/math.go similarity index 100% rename from internal/markdown/ast/math.go rename to markdown/ast/math.go diff --git a/internal/markdown/ast/mention.go b/markdown/ast/mention.go similarity index 100% rename from internal/markdown/ast/mention.go rename to markdown/ast/mention.go diff --git a/internal/markdown/ast/tag.go b/markdown/ast/tag.go similarity index 100% rename from internal/markdown/ast/tag.go rename to markdown/ast/tag.go diff --git a/markdown/doc.go b/markdown/doc.go new file mode 100644 index 000000000..01df9afcf --- /dev/null +++ b/markdown/doc.go @@ -0,0 +1,8 @@ +// Package markdown is the markdown engine: parsing memo content into the AST +// in markdown/ast, the memos-specific syntax in markdown/extensions and +// markdown/parser (tags, mentions, math, GFM extras), rendering, and the +// derived memo payload (tags, properties, snippet). +// +// Layering: markdown may import proto/gen and internal. It must not import +// store, core, or server. +package markdown diff --git a/internal/markdown/extensions/gfm.go b/markdown/extensions/gfm.go similarity index 98% rename from internal/markdown/extensions/gfm.go rename to markdown/extensions/gfm.go index cb279c9b6..56eb78cb6 100644 --- a/internal/markdown/extensions/gfm.go +++ b/markdown/extensions/gfm.go @@ -13,8 +13,8 @@ import ( "github.com/yuin/goldmark/text" "github.com/yuin/goldmark/util" - mast "github.com/usememos/memos/internal/markdown/ast" - mparser "github.com/usememos/memos/internal/markdown/parser" + mast "github.com/usememos/memos/markdown/ast" + mparser "github.com/usememos/memos/markdown/parser" ) const gfmDomainPattern = `(?:[\p{L}\p{N}_-]+\.)*[\p{L}\p{N}-]+\.[\p{L}\p{N}-]+` diff --git a/internal/markdown/extensions/mention.go b/markdown/extensions/mention.go similarity index 91% rename from internal/markdown/extensions/mention.go rename to markdown/extensions/mention.go index 5eb241365..33be06142 100644 --- a/internal/markdown/extensions/mention.go +++ b/markdown/extensions/mention.go @@ -7,9 +7,9 @@ import ( "github.com/yuin/goldmark/text" "github.com/yuin/goldmark/util" - "github.com/usememos/memos/internal/base" - mast "github.com/usememos/memos/internal/markdown/ast" - mparser "github.com/usememos/memos/internal/markdown/parser" + "github.com/usememos/memos/internal/identifier" + mast "github.com/usememos/memos/markdown/ast" + mparser "github.com/usememos/memos/markdown/parser" ) type mentionExtension struct{} @@ -43,7 +43,7 @@ func (*mentionASTTransformer) Transform(document *ast.Document, reader text.Read func replaceMentionsInText(textNode *ast.Text, source []byte) { segment := textNode.Segment - runHasLeftBoundary := segment.Padding > 0 || segment.Start == 0 || !base.IsUsernameCharacter(source[segment.Start-1]) + runHasLeftBoundary := segment.Padding > 0 || segment.Start == 0 || !identifier.IsUsernameCharacter(source[segment.Start-1]) matches := mparser.FindMentionMatches(segment.Value(source), runHasLeftBoundary) if len(matches) == 0 { return diff --git a/internal/markdown/extensions/mention_test.go b/markdown/extensions/mention_test.go similarity index 91% rename from internal/markdown/extensions/mention_test.go rename to markdown/extensions/mention_test.go index 3cc986c0f..075d35c89 100644 --- a/internal/markdown/extensions/mention_test.go +++ b/markdown/extensions/mention_test.go @@ -8,7 +8,7 @@ import ( "github.com/yuin/goldmark/ast" "github.com/yuin/goldmark/text" - mast "github.com/usememos/memos/internal/markdown/ast" + mast "github.com/usememos/memos/markdown/ast" ) func TestReplaceMentionsInPaddedText(t *testing.T) { diff --git a/internal/markdown/extensions/tag.go b/markdown/extensions/tag.go similarity index 96% rename from internal/markdown/extensions/tag.go rename to markdown/extensions/tag.go index 6d41ec971..2466302be 100644 --- a/internal/markdown/extensions/tag.go +++ b/markdown/extensions/tag.go @@ -8,8 +8,8 @@ import ( "github.com/yuin/goldmark/text" "github.com/yuin/goldmark/util" - mast "github.com/usememos/memos/internal/markdown/ast" - mparser "github.com/usememos/memos/internal/markdown/parser" + mast "github.com/usememos/memos/markdown/ast" + mparser "github.com/usememos/memos/markdown/parser" ) type tagExtension struct{} diff --git a/internal/markdown/link_reference.go b/markdown/link_reference.go similarity index 100% rename from internal/markdown/link_reference.go rename to markdown/link_reference.go diff --git a/internal/markdown/markdown.go b/markdown/markdown.go similarity index 98% rename from internal/markdown/markdown.go rename to markdown/markdown.go index bd66ace9b..91fa4ae6d 100644 --- a/internal/markdown/markdown.go +++ b/markdown/markdown.go @@ -14,10 +14,10 @@ import ( "github.com/yuin/goldmark/parser" "github.com/yuin/goldmark/text" - "github.com/usememos/memos/internal/base" - mast "github.com/usememos/memos/internal/markdown/ast" - "github.com/usememos/memos/internal/markdown/extensions" - "github.com/usememos/memos/internal/markdown/renderer" + "github.com/usememos/memos/internal/identifier" + mast "github.com/usememos/memos/markdown/ast" + "github.com/usememos/memos/markdown/extensions" + "github.com/usememos/memos/markdown/renderer" storepb "github.com/usememos/memos/proto/gen/store" ) @@ -506,7 +506,7 @@ func ParseManagedAttachmentImageURL(raw string) (uid string, managed, valid bool } parts := strings.Split(strings.TrimPrefix(parsed.Path, "/file/attachments/"), "/") - if (len(parts) != 1 && len(parts) != 2) || !base.UIDMatcher.MatchString(parts[0]) { + if (len(parts) != 1 && len(parts) != 2) || !identifier.UIDMatcher.MatchString(parts[0]) { return "", true, false } if len(parts) == 2 && parts[1] == "" { diff --git a/internal/markdown/markdown_test.go b/markdown/markdown_test.go similarity index 99% rename from internal/markdown/markdown_test.go rename to markdown/markdown_test.go index 961f74ca4..f8227ed9e 100644 --- a/internal/markdown/markdown_test.go +++ b/markdown/markdown_test.go @@ -7,7 +7,7 @@ import ( "github.com/stretchr/testify/assert" "github.com/stretchr/testify/require" - "github.com/usememos/memos/internal/base" + "github.com/usememos/memos/internal/identifier" ) func TestNewService(t *testing.T) { @@ -351,7 +351,7 @@ func TestExtractAllMentions(t *testing.T) { assert.ElementsMatch(t, []string{"Alice", "bob"}, data.Mentions) assert.ElementsMatch(t, []string{"tag"}, data.Tags) - maxLengthUsername := "a" + strings.Repeat("b", base.MaxUsernameLength-1) + maxLengthUsername := "a" + strings.Repeat("b", identifier.MaxUsernameLength-1) data, err = svc.ExtractAll([]byte("@" + maxLengthUsername)) require.NoError(t, err) assert.Equal(t, []string{maxLengthUsername}, data.Mentions) diff --git a/internal/markdown/parser/emoji.go b/markdown/parser/emoji.go similarity index 100% rename from internal/markdown/parser/emoji.go rename to markdown/parser/emoji.go diff --git a/internal/markdown/parser/gfm_email.go b/markdown/parser/gfm_email.go similarity index 100% rename from internal/markdown/parser/gfm_email.go rename to markdown/parser/gfm_email.go diff --git a/internal/markdown/parser/gfm_email_test.go b/markdown/parser/gfm_email_test.go similarity index 100% rename from internal/markdown/parser/gfm_email_test.go rename to markdown/parser/gfm_email_test.go diff --git a/internal/markdown/parser/math.go b/markdown/parser/math.go similarity index 98% rename from internal/markdown/parser/math.go rename to markdown/parser/math.go index 2af3ee2c3..6d9cfaed0 100644 --- a/internal/markdown/parser/math.go +++ b/markdown/parser/math.go @@ -10,7 +10,7 @@ import ( "github.com/yuin/goldmark/text" "github.com/yuin/goldmark/util" - mast "github.com/usememos/memos/internal/markdown/ast" + mast "github.com/usememos/memos/markdown/ast" ) type inlineMathParser struct{} diff --git a/internal/markdown/parser/math_test.go b/markdown/parser/math_test.go similarity index 98% rename from internal/markdown/parser/math_test.go rename to markdown/parser/math_test.go index 63f279b01..6e09826c8 100644 --- a/internal/markdown/parser/math_test.go +++ b/markdown/parser/math_test.go @@ -11,7 +11,7 @@ import ( "github.com/yuin/goldmark/text" "github.com/yuin/goldmark/util" - mast "github.com/usememos/memos/internal/markdown/ast" + mast "github.com/usememos/memos/markdown/ast" ) func TestInlineMathParserDollarBoundaries(t *testing.T) { diff --git a/internal/markdown/parser/mention.go b/markdown/parser/mention.go similarity index 85% rename from internal/markdown/parser/mention.go rename to markdown/parser/mention.go index a8adfb2e6..365c12ae4 100644 --- a/internal/markdown/parser/mention.go +++ b/markdown/parser/mention.go @@ -3,7 +3,7 @@ package parser import ( "github.com/yuin/goldmark/util" - "github.com/usememos/memos/internal/base" + "github.com/usememos/memos/internal/identifier" ) // MentionMatch is one username reference in an eligible literal-source run. @@ -20,7 +20,7 @@ func hasMentionLeftBoundary(source []byte, pos int, runHasLeftBoundary bool) boo if pos == 0 { return runHasLeftBoundary } - return !base.IsUsernameCharacter(source[pos-1]) + return !identifier.IsUsernameCharacter(source[pos-1]) } // FindMentionMatches enumerates username references in one eligible literal-source run. @@ -38,11 +38,11 @@ func FindMentionMatches(source []byte, runHasLeftBoundary bool) []MentionMatch { } end := pos + 1 - for end < len(source) && base.IsUsernameCharacter(source[end]) { + for end < len(source) && identifier.IsUsernameCharacter(source[end]) { end++ } username := source[pos+1 : end] - if base.IsValidUsername(string(username)) { + if identifier.IsValidUsername(string(username)) { matches = append(matches, MentionMatch{ Start: pos, End: end, diff --git a/internal/markdown/parser/mention_test.go b/markdown/parser/mention_test.go similarity index 81% rename from internal/markdown/parser/mention_test.go rename to markdown/parser/mention_test.go index d7f44dc1d..fc49c1067 100644 --- a/internal/markdown/parser/mention_test.go +++ b/markdown/parser/mention_test.go @@ -6,7 +6,7 @@ import ( "github.com/stretchr/testify/assert" - "github.com/usememos/memos/internal/base" + "github.com/usememos/memos/internal/identifier" ) func TestFindMentionMatches(t *testing.T) { @@ -17,8 +17,8 @@ func TestFindMentionMatches(t *testing.T) { want []string }{ {name: "valid", source: "@alice @Alice-2 @123 @123-456", runHasLeftBoundary: true, want: []string{"alice", "Alice-2", "123", "123-456"}}, - {name: "maximum length", source: "@a" + strings.Repeat("b", base.MaxUsernameLength-1), runHasLeftBoundary: true, want: []string{"a" + strings.Repeat("b", base.MaxUsernameLength-1)}}, - {name: "too long", source: "@a" + strings.Repeat("b", base.MaxUsernameLength), runHasLeftBoundary: true}, + {name: "maximum length", source: "@a" + strings.Repeat("b", identifier.MaxUsernameLength-1), runHasLeftBoundary: true, want: []string{"a" + strings.Repeat("b", identifier.MaxUsernameLength-1)}}, + {name: "too long", source: "@a" + strings.Repeat("b", identifier.MaxUsernameLength), runHasLeftBoundary: true}, {name: "invalid shapes", source: "@-alice @alice- @álîçé", runHasLeftBoundary: true}, {name: "username character left boundary", source: "hello@alice foo-@bob foo_@carol", runHasLeftBoundary: true, want: []string{"carol"}}, {name: "Unicode left boundary", source: "中文@alice", runHasLeftBoundary: true, want: []string{"alice"}}, diff --git a/internal/markdown/parser/tag.go b/markdown/parser/tag.go similarity index 100% rename from internal/markdown/parser/tag.go rename to markdown/parser/tag.go diff --git a/internal/markdown/parser/tag_test.go b/markdown/parser/tag_test.go similarity index 99% rename from internal/markdown/parser/tag_test.go rename to markdown/parser/tag_test.go index 0dd2e5f44..6c96f17d8 100644 --- a/internal/markdown/parser/tag_test.go +++ b/markdown/parser/tag_test.go @@ -7,7 +7,7 @@ import ( "github.com/stretchr/testify/assert" "github.com/stretchr/testify/require" - mast "github.com/usememos/memos/internal/markdown/ast" + mast "github.com/usememos/memos/markdown/ast" ) func TestFindTagMatches(t *testing.T) { diff --git a/internal/markdown/parser/tag_unicode_tables.go b/markdown/parser/tag_unicode_tables.go similarity index 100% rename from internal/markdown/parser/tag_unicode_tables.go rename to markdown/parser/tag_unicode_tables.go diff --git a/internal/markdown/parser/tagdata/main.go b/markdown/parser/tagdata/main.go similarity index 100% rename from internal/markdown/parser/tagdata/main.go rename to markdown/parser/tagdata/main.go diff --git a/internal/markdown/parser/tagdata/main_test.go b/markdown/parser/tagdata/main_test.go similarity index 100% rename from internal/markdown/parser/tagdata/main_test.go rename to markdown/parser/tagdata/main_test.go diff --git a/internal/markdown/renderer/markdown_renderer.go b/markdown/renderer/markdown_renderer.go similarity index 99% rename from internal/markdown/renderer/markdown_renderer.go rename to markdown/renderer/markdown_renderer.go index 4ade426cb..4d102a9e0 100644 --- a/internal/markdown/renderer/markdown_renderer.go +++ b/markdown/renderer/markdown_renderer.go @@ -8,7 +8,7 @@ import ( gast "github.com/yuin/goldmark/ast" east "github.com/yuin/goldmark/extension/ast" - mast "github.com/usememos/memos/internal/markdown/ast" + mast "github.com/usememos/memos/markdown/ast" ) // MarkdownRenderer renders goldmark AST back to markdown text. diff --git a/internal/markdown/renderer/markdown_renderer_test.go b/markdown/renderer/markdown_renderer_test.go similarity index 98% rename from internal/markdown/renderer/markdown_renderer_test.go rename to markdown/renderer/markdown_renderer_test.go index 3f237ef3c..3ded69ffb 100644 --- a/internal/markdown/renderer/markdown_renderer_test.go +++ b/markdown/renderer/markdown_renderer_test.go @@ -10,7 +10,7 @@ import ( "github.com/yuin/goldmark/parser" "github.com/yuin/goldmark/text" - "github.com/usememos/memos/internal/markdown/extensions" + "github.com/usememos/memos/markdown/extensions" ) func TestMarkdownRenderer(t *testing.T) { diff --git a/provider/README.md b/provider/README.md new file mode 100644 index 000000000..86d39248d --- /dev/null +++ b/provider/README.md @@ -0,0 +1,15 @@ +# provider + +Backends that memos talks to on behalf of an instance, each configured by an +instance setting and reached through an interface so the implementation can be +swapped. + +| Package | Backend | +| --- | --- | +| `ai/` | speech-to-text and audio-capable LLM providers (OpenAI, Gemini) | +| `idp/` | identity providers for SSO (OAuth2) | +| `storage/` | attachment object storage (local disk, S3) | + +Layering: `provider` may import `proto/gen` and `internal`. It must not import +`store`, `core`, or `server`; `store` resolves the configured provider and hands +it to callers. diff --git a/internal/ai/ai.go b/provider/ai/ai.go similarity index 100% rename from internal/ai/ai.go rename to provider/ai/ai.go diff --git a/internal/ai/audio/webm.go b/provider/ai/audio/webm.go similarity index 100% rename from internal/ai/audio/webm.go rename to provider/ai/audio/webm.go diff --git a/internal/ai/audio/webm_test.go b/provider/ai/audio/webm_test.go similarity index 100% rename from internal/ai/audio/webm_test.go rename to provider/ai/audio/webm_test.go diff --git a/internal/ai/audiollm/audiollm.go b/provider/ai/audiollm/audiollm.go similarity index 98% rename from internal/ai/audiollm/audiollm.go rename to provider/ai/audiollm/audiollm.go index 72a1dda0e..1538f354f 100644 --- a/internal/ai/audiollm/audiollm.go +++ b/provider/ai/audiollm/audiollm.go @@ -1,6 +1,6 @@ // Package audiollm defines the multimodal-audio capability for AI providers. // Implementations call chat-completions or generate-content style APIs that -// accept audio as input. For deterministic transcription, prefer internal/ai/stt +// accept audio as input. For deterministic transcription, prefer provider/ai/stt // where a dedicated STT endpoint exists. package audiollm diff --git a/internal/ai/audiollm/gemini/gemini.go b/provider/ai/audiollm/gemini/gemini.go similarity index 97% rename from internal/ai/audiollm/gemini/gemini.go rename to provider/ai/audiollm/gemini/gemini.go index 9164825eb..79d6b8d23 100644 --- a/internal/ai/audiollm/gemini/gemini.go +++ b/provider/ai/audiollm/gemini/gemini.go @@ -13,9 +13,9 @@ import ( "github.com/pkg/errors" "google.golang.org/genai" - "github.com/usememos/memos/internal/ai" - "github.com/usememos/memos/internal/ai/audio" - "github.com/usememos/memos/internal/ai/audiollm" + "github.com/usememos/memos/provider/ai" + "github.com/usememos/memos/provider/ai/audio" + "github.com/usememos/memos/provider/ai/audiollm" ) const ( diff --git a/internal/ai/audiollm/gemini/gemini_test.go b/provider/ai/audiollm/gemini/gemini_test.go similarity index 95% rename from internal/ai/audiollm/gemini/gemini_test.go rename to provider/ai/audiollm/gemini/gemini_test.go index c3b9cb3d5..baaf48522 100644 --- a/internal/ai/audiollm/gemini/gemini_test.go +++ b/provider/ai/audiollm/gemini/gemini_test.go @@ -12,9 +12,9 @@ import ( "github.com/stretchr/testify/require" - "github.com/usememos/memos/internal/ai" - "github.com/usememos/memos/internal/ai/audiollm" - audiollmgemini "github.com/usememos/memos/internal/ai/audiollm/gemini" + "github.com/usememos/memos/provider/ai" + "github.com/usememos/memos/provider/ai/audiollm" + audiollmgemini "github.com/usememos/memos/provider/ai/audiollm/gemini" ) func TestGenerateFromAudio(t *testing.T) { diff --git a/internal/ai/audiollm/options.go b/provider/ai/audiollm/options.go similarity index 100% rename from internal/ai/audiollm/options.go rename to provider/ai/audiollm/options.go diff --git a/internal/ai/errors.go b/provider/ai/errors.go similarity index 100% rename from internal/ai/errors.go rename to provider/ai/errors.go diff --git a/internal/ai/models.go b/provider/ai/models.go similarity index 100% rename from internal/ai/models.go rename to provider/ai/models.go diff --git a/internal/ai/resolver.go b/provider/ai/resolver.go similarity index 100% rename from internal/ai/resolver.go rename to provider/ai/resolver.go diff --git a/internal/ai/stt/openai/openai.go b/provider/ai/stt/openai/openai.go similarity index 97% rename from internal/ai/stt/openai/openai.go rename to provider/ai/stt/openai/openai.go index 62555b3aa..8148f76ec 100644 --- a/internal/ai/stt/openai/openai.go +++ b/provider/ai/stt/openai/openai.go @@ -13,8 +13,8 @@ import ( openaioption "github.com/openai/openai-go/v3/option" "github.com/pkg/errors" - "github.com/usememos/memos/internal/ai" - "github.com/usememos/memos/internal/ai/stt" + "github.com/usememos/memos/provider/ai" + "github.com/usememos/memos/provider/ai/stt" ) const defaultEndpoint = "https://api.openai.com/v1" diff --git a/internal/ai/stt/openai/openai_test.go b/provider/ai/stt/openai/openai_test.go similarity index 92% rename from internal/ai/stt/openai/openai_test.go rename to provider/ai/stt/openai/openai_test.go index 682a79083..4ee52c579 100644 --- a/internal/ai/stt/openai/openai_test.go +++ b/provider/ai/stt/openai/openai_test.go @@ -11,9 +11,9 @@ import ( "github.com/stretchr/testify/require" - "github.com/usememos/memos/internal/ai" - "github.com/usememos/memos/internal/ai/stt" - sttopenai "github.com/usememos/memos/internal/ai/stt/openai" + "github.com/usememos/memos/provider/ai" + "github.com/usememos/memos/provider/ai/stt" + sttopenai "github.com/usememos/memos/provider/ai/stt/openai" ) func TestTranscribe(t *testing.T) { diff --git a/internal/ai/stt/options.go b/provider/ai/stt/options.go similarity index 100% rename from internal/ai/stt/options.go rename to provider/ai/stt/options.go diff --git a/internal/ai/stt/stt.go b/provider/ai/stt/stt.go similarity index 95% rename from internal/ai/stt/stt.go rename to provider/ai/stt/stt.go index 28db72294..5ceed82ac 100644 --- a/internal/ai/stt/stt.go +++ b/provider/ai/stt/stt.go @@ -1,7 +1,7 @@ // Package stt defines the speech-to-text capability for AI providers. // Implementations call dedicated STT endpoints (e.g. OpenAI /audio/transcriptions) // and return deterministic transcription output. For multimodal LLMs that -// happen to accept audio input, see internal/ai/audiollm. +// happen to accept audio input, see provider/ai/audiollm. package stt import ( diff --git a/internal/idp/idp.go b/provider/idp/idp.go similarity index 100% rename from internal/idp/idp.go rename to provider/idp/idp.go diff --git a/internal/idp/oauth2/oauth2.go b/provider/idp/oauth2/oauth2.go similarity index 99% rename from internal/idp/oauth2/oauth2.go rename to provider/idp/oauth2/oauth2.go index c281b6d50..150547df4 100644 --- a/internal/idp/oauth2/oauth2.go +++ b/provider/idp/oauth2/oauth2.go @@ -12,8 +12,8 @@ import ( "github.com/pkg/errors" "golang.org/x/oauth2" - "github.com/usememos/memos/internal/idp" storepb "github.com/usememos/memos/proto/gen/store" + "github.com/usememos/memos/provider/idp" ) // IdentityProvider represents an OAuth2 Identity Provider. diff --git a/internal/idp/oauth2/oauth2_test.go b/provider/idp/oauth2/oauth2_test.go similarity index 99% rename from internal/idp/oauth2/oauth2_test.go rename to provider/idp/oauth2/oauth2_test.go index 293a3e31c..6b4e8a386 100644 --- a/internal/idp/oauth2/oauth2_test.go +++ b/provider/idp/oauth2/oauth2_test.go @@ -13,8 +13,8 @@ import ( "github.com/stretchr/testify/assert" "github.com/stretchr/testify/require" - "github.com/usememos/memos/internal/idp" storepb "github.com/usememos/memos/proto/gen/store" + "github.com/usememos/memos/provider/idp" ) func TestNewIdentityProvider(t *testing.T) { diff --git a/internal/storage/driver.go b/provider/storage/driver.go similarity index 97% rename from internal/storage/driver.go rename to provider/storage/driver.go index 909509bee..f569e3ad6 100644 --- a/internal/storage/driver.go +++ b/provider/storage/driver.go @@ -6,8 +6,8 @@ import ( "github.com/pkg/errors" - "github.com/usememos/memos/internal/storage/s3" storepb "github.com/usememos/memos/proto/gen/store" + "github.com/usememos/memos/provider/storage/s3" ) // ErrRangeNotSatisfiable reports a ranged read whose byte range falls outside diff --git a/internal/storage/driver_test.go b/provider/storage/driver_test.go similarity index 100% rename from internal/storage/driver_test.go rename to provider/storage/driver_test.go diff --git a/internal/storage/s3/s3.go b/provider/storage/s3/s3.go similarity index 100% rename from internal/storage/s3/s3.go rename to provider/storage/s3/s3.go diff --git a/internal/storage/s3/s3_test.go b/provider/storage/s3/s3_test.go similarity index 100% rename from internal/storage/s3/s3_test.go rename to provider/storage/s3/s3_test.go diff --git a/scripts/release_smoke_test.sh b/scripts/release_smoke_test.sh index b5891b235..4d9e3ffec 100755 --- a/scripts/release_smoke_test.sh +++ b/scripts/release_smoke_test.sh @@ -90,7 +90,7 @@ upgrade_new_container="memos-smoke-upgrade-new-$run_id" fresh_volume="memos-smoke-fresh-$run_id" upgrade_volume="memos-smoke-upgrade-$run_id" temp_dir="$(mktemp -d)" -frontend_index="$REPO_ROOT/server/router/frontend/dist/index.html" +frontend_index="$REPO_ROOT/server/frontend/dist/index.html" frontend_index_backup="$temp_dir/frontend-index.html" frontend_index_existed=0 frontend_index_backed_up=0 diff --git a/server/router/api/v1/acl_config.go b/server/api/v1/acl_config.go similarity index 100% rename from server/router/api/v1/acl_config.go rename to server/api/v1/acl_config.go diff --git a/server/router/api/v1/acl_config_test.go b/server/api/v1/acl_config_test.go similarity index 100% rename from server/router/api/v1/acl_config_test.go rename to server/api/v1/acl_config_test.go diff --git a/server/router/api/v1/ai_service.go b/server/api/v1/ai_service.go similarity index 96% rename from server/router/api/v1/ai_service.go rename to server/api/v1/ai_service.go index d6df6a017..2ad0ee879 100644 --- a/server/router/api/v1/ai_service.go +++ b/server/api/v1/ai_service.go @@ -11,14 +11,14 @@ import ( "google.golang.org/grpc/codes" "google.golang.org/grpc/status" - "github.com/usememos/memos/internal/ai" - "github.com/usememos/memos/internal/ai/audiollm" - audiollmgemini "github.com/usememos/memos/internal/ai/audiollm/gemini" - "github.com/usememos/memos/internal/ai/stt" - sttopenai "github.com/usememos/memos/internal/ai/stt/openai" "github.com/usememos/memos/internal/ratelimit" v1pb "github.com/usememos/memos/proto/gen/api/v1" storepb "github.com/usememos/memos/proto/gen/store" + "github.com/usememos/memos/provider/ai" + "github.com/usememos/memos/provider/ai/audiollm" + audiollmgemini "github.com/usememos/memos/provider/ai/audiollm/gemini" + "github.com/usememos/memos/provider/ai/stt" + sttopenai "github.com/usememos/memos/provider/ai/stt/openai" ) const ( diff --git a/server/router/api/v1/attachment_exif_test.go b/server/api/v1/attachment_exif_test.go similarity index 100% rename from server/router/api/v1/attachment_exif_test.go rename to server/api/v1/attachment_exif_test.go diff --git a/server/router/api/v1/attachment_media_metadata.go b/server/api/v1/attachment_media_metadata.go similarity index 100% rename from server/router/api/v1/attachment_media_metadata.go rename to server/api/v1/attachment_media_metadata.go diff --git a/server/router/api/v1/attachment_media_metadata_test.go b/server/api/v1/attachment_media_metadata_test.go similarity index 100% rename from server/router/api/v1/attachment_media_metadata_test.go rename to server/api/v1/attachment_media_metadata_test.go diff --git a/server/router/api/v1/attachment_mime_test.go b/server/api/v1/attachment_mime_test.go similarity index 100% rename from server/router/api/v1/attachment_mime_test.go rename to server/api/v1/attachment_mime_test.go diff --git a/server/router/api/v1/attachment_motion.go b/server/api/v1/attachment_motion.go similarity index 100% rename from server/router/api/v1/attachment_motion.go rename to server/api/v1/attachment_motion.go diff --git a/server/router/api/v1/attachment_service.go b/server/api/v1/attachment_service.go similarity index 100% rename from server/router/api/v1/attachment_service.go rename to server/api/v1/attachment_service.go diff --git a/server/router/api/v1/attachment_service_image.go b/server/api/v1/attachment_service_image.go similarity index 100% rename from server/router/api/v1/attachment_service_image.go rename to server/api/v1/attachment_service_image.go diff --git a/server/router/api/v1/attachment_service_storage.go b/server/api/v1/attachment_service_storage.go similarity index 99% rename from server/router/api/v1/attachment_service_storage.go rename to server/api/v1/attachment_service_storage.go index dcbfc4c92..b516953e3 100644 --- a/server/router/api/v1/attachment_service_storage.go +++ b/server/api/v1/attachment_service_storage.go @@ -15,7 +15,7 @@ import ( "google.golang.org/protobuf/types/known/timestamppb" "github.com/usememos/memos/internal/profile" - "github.com/usememos/memos/internal/util" + "github.com/usememos/memos/internal/random" v1pb "github.com/usememos/memos/proto/gen/api/v1" storepb "github.com/usememos/memos/proto/gen/store" "github.com/usememos/memos/store" @@ -294,7 +294,7 @@ func replaceFilenameWithPathTemplate(path, filename string) string { case "{second}": return fmt.Sprintf("%02d", t.Second()) case "{uuid}": - return util.GenUUID() + return random.UUID() default: return s } diff --git a/server/router/api/v1/attachment_service_storage_test.go b/server/api/v1/attachment_service_storage_test.go similarity index 100% rename from server/router/api/v1/attachment_service_storage_test.go rename to server/api/v1/attachment_service_storage_test.go diff --git a/server/router/api/v1/attachment_upload.go b/server/api/v1/attachment_upload.go similarity index 100% rename from server/router/api/v1/attachment_upload.go rename to server/api/v1/attachment_upload.go diff --git a/server/router/api/v1/attachment_upload_state.go b/server/api/v1/attachment_upload_state.go similarity index 100% rename from server/router/api/v1/attachment_upload_state.go rename to server/api/v1/attachment_upload_state.go diff --git a/server/router/api/v1/attachment_upload_test.go b/server/api/v1/attachment_upload_test.go similarity index 100% rename from server/router/api/v1/attachment_upload_test.go rename to server/api/v1/attachment_upload_test.go diff --git a/server/router/api/v1/attachment_upload_transport_test.go b/server/api/v1/attachment_upload_transport_test.go similarity index 100% rename from server/router/api/v1/attachment_upload_transport_test.go rename to server/api/v1/attachment_upload_transport_test.go diff --git a/server/router/api/v1/auth_service.go b/server/api/v1/auth_service.go similarity index 100% rename from server/router/api/v1/auth_service.go rename to server/api/v1/auth_service.go diff --git a/server/router/api/v1/auth_service_client_info_test.go b/server/api/v1/auth_service_client_info_test.go similarity index 100% rename from server/router/api/v1/auth_service_client_info_test.go rename to server/api/v1/auth_service_client_info_test.go diff --git a/server/router/api/v1/auth_service_session.go b/server/api/v1/auth_service_session.go similarity index 99% rename from server/router/api/v1/auth_service_session.go rename to server/api/v1/auth_service_session.go index 27cb868cc..d92bb1c1e 100644 --- a/server/router/api/v1/auth_service_session.go +++ b/server/api/v1/auth_service_session.go @@ -15,7 +15,7 @@ import ( "google.golang.org/protobuf/types/known/timestamppb" "github.com/usememos/memos/internal/clientip" - "github.com/usememos/memos/internal/util" + "github.com/usememos/memos/internal/random" v1pb "github.com/usememos/memos/proto/gen/api/v1" storepb "github.com/usememos/memos/proto/gen/store" "github.com/usememos/memos/server/auth" @@ -24,7 +24,7 @@ import ( func (s *APIV1Service) doSignIn(ctx context.Context, user *store.User) (string, time.Time, error) { // Generate refresh token - tokenID := util.GenUUID() + tokenID := random.UUID() refreshToken, refreshExpiresAt, err := auth.GenerateRefreshToken(user.ID, tokenID, []byte(s.Secret)) if err != nil { return "", time.Time{}, status.Errorf(codes.Internal, "failed to generate refresh token: %v", err) @@ -133,7 +133,7 @@ func (s *APIV1Service) RefreshToken(ctx context.Context, _ *v1pb.RefreshTokenReq // --- Refresh Token Rotation --- // Generate new refresh token with fresh 30-day expiry (sliding window) - newTokenID := util.GenUUID() + newTokenID := random.UUID() newRefreshToken, newRefreshExpiresAt, err := auth.GenerateRefreshToken(user.ID, newTokenID, []byte(s.Secret)) if err != nil { return nil, status.Errorf(codes.Internal, "failed to generate refresh token: %v", err) diff --git a/server/router/api/v1/auth_service_session_status_test.go b/server/api/v1/auth_service_session_status_test.go similarity index 100% rename from server/router/api/v1/auth_service_session_status_test.go rename to server/api/v1/auth_service_session_status_test.go diff --git a/server/router/api/v1/auth_service_sso.go b/server/api/v1/auth_service_sso.go similarity index 98% rename from server/router/api/v1/auth_service_sso.go rename to server/api/v1/auth_service_sso.go index f02bda536..95e688806 100644 --- a/server/router/api/v1/auth_service_sso.go +++ b/server/api/v1/auth_service_sso.go @@ -10,10 +10,10 @@ import ( "google.golang.org/grpc/codes" "google.golang.org/grpc/status" - "github.com/usememos/memos/internal/idp" - "github.com/usememos/memos/internal/idp/oauth2" - "github.com/usememos/memos/internal/util" + "github.com/usememos/memos/internal/random" storepb "github.com/usememos/memos/proto/gen/store" + "github.com/usememos/memos/provider/idp" + "github.com/usememos/memos/provider/idp/oauth2" "github.com/usememos/memos/store" ) @@ -50,7 +50,7 @@ func (s *APIV1Service) resolveSSOUser(ctx context.Context, currentUser *store.Us return nil, status.Errorf(codes.PermissionDenied, "user registration is not allowed") } - password, err := util.RandomString(20) + password, err := random.String(20) if err != nil { return nil, status.Errorf(codes.Internal, "failed to generate random password, error: %v", err) } @@ -73,7 +73,7 @@ func (s *APIV1Service) resolveSSOUser(ctx context.Context, currentUser *store.Us // database index remains the guarantee; a concurrent claim between this check // and the insert is handled by createSSOUser. func (s *APIV1Service) resolveSSOEmail(ctx context.Context, rawEmail, provider, externUID string) string { - email, err := util.NormalizeEmail(rawEmail) + email, err := store.NormalizeEmail(rawEmail) if err != nil { slog.Warn("ignoring malformed email from identity provider", slog.String("provider", provider), diff --git a/server/router/api/v1/authz.go b/server/api/v1/authz.go similarity index 100% rename from server/router/api/v1/authz.go rename to server/api/v1/authz.go diff --git a/server/router/api/v1/authz_test.go b/server/api/v1/authz_test.go similarity index 100% rename from server/router/api/v1/authz_test.go rename to server/api/v1/authz_test.go diff --git a/server/router/api/v1/common.go b/server/api/v1/common.go similarity index 100% rename from server/router/api/v1/common.go rename to server/api/v1/common.go diff --git a/server/router/api/v1/common_test.go b/server/api/v1/common_test.go similarity index 100% rename from server/router/api/v1/common_test.go rename to server/api/v1/common_test.go diff --git a/server/router/api/v1/connect_handler.go b/server/api/v1/connect_handler.go similarity index 100% rename from server/router/api/v1/connect_handler.go rename to server/api/v1/connect_handler.go diff --git a/server/router/api/v1/connect_handler_test.go b/server/api/v1/connect_handler_test.go similarity index 100% rename from server/router/api/v1/connect_handler_test.go rename to server/api/v1/connect_handler_test.go diff --git a/server/router/api/v1/connect_interceptors.go b/server/api/v1/connect_interceptors.go similarity index 100% rename from server/router/api/v1/connect_interceptors.go rename to server/api/v1/connect_interceptors.go diff --git a/server/router/api/v1/connect_interceptors_test.go b/server/api/v1/connect_interceptors_test.go similarity index 100% rename from server/router/api/v1/connect_interceptors_test.go rename to server/api/v1/connect_interceptors_test.go diff --git a/server/router/api/v1/connect_services.go b/server/api/v1/connect_services.go similarity index 100% rename from server/router/api/v1/connect_services.go rename to server/api/v1/connect_services.go diff --git a/server/router/api/v1/filter_access.go b/server/api/v1/filter_access.go similarity index 98% rename from server/router/api/v1/filter_access.go rename to server/api/v1/filter_access.go index 9ebb28ce9..47784093d 100644 --- a/server/router/api/v1/filter_access.go +++ b/server/api/v1/filter_access.go @@ -8,7 +8,7 @@ import ( "google.golang.org/grpc/codes" "google.golang.org/grpc/status" - filterpkg "github.com/usememos/memos/internal/filter" + filterpkg "github.com/usememos/memos/filter" "github.com/usememos/memos/store" ) diff --git a/server/router/api/v1/gateway_marshaler_test.go b/server/api/v1/gateway_marshaler_test.go similarity index 100% rename from server/router/api/v1/gateway_marshaler_test.go rename to server/api/v1/gateway_marshaler_test.go diff --git a/server/router/api/v1/gateway_route_resolver.go b/server/api/v1/gateway_route_resolver.go similarity index 100% rename from server/router/api/v1/gateway_route_resolver.go rename to server/api/v1/gateway_route_resolver.go diff --git a/server/router/api/v1/gateway_route_resolver_test.go b/server/api/v1/gateway_route_resolver_test.go similarity index 100% rename from server/router/api/v1/gateway_route_resolver_test.go rename to server/api/v1/gateway_route_resolver_test.go diff --git a/server/router/api/v1/header_carrier.go b/server/api/v1/header_carrier.go similarity index 100% rename from server/router/api/v1/header_carrier.go rename to server/api/v1/header_carrier.go diff --git a/server/router/api/v1/health_service.go b/server/api/v1/health_service.go similarity index 100% rename from server/router/api/v1/health_service.go rename to server/api/v1/health_service.go diff --git a/server/router/api/v1/idp_service.go b/server/api/v1/idp_service.go similarity index 100% rename from server/router/api/v1/idp_service.go rename to server/api/v1/idp_service.go diff --git a/server/router/api/v1/instance_service.go b/server/api/v1/instance_service.go similarity index 99% rename from server/router/api/v1/instance_service.go rename to server/api/v1/instance_service.go index 3001fab8c..dc0a3ea46 100644 --- a/server/router/api/v1/instance_service.go +++ b/server/api/v1/instance_service.go @@ -10,9 +10,9 @@ import ( "google.golang.org/grpc/status" "google.golang.org/protobuf/types/known/emptypb" + "github.com/usememos/memos/core/notification" v1pb "github.com/usememos/memos/proto/gen/api/v1" storepb "github.com/usememos/memos/proto/gen/store" - "github.com/usememos/memos/server/notification" "github.com/usememos/memos/store" ) diff --git a/server/router/api/v1/instance_service_converters.go b/server/api/v1/instance_service_converters.go similarity index 100% rename from server/router/api/v1/instance_service_converters.go rename to server/api/v1/instance_service_converters.go diff --git a/server/router/api/v1/instance_service_validation.go b/server/api/v1/instance_service_validation.go similarity index 100% rename from server/router/api/v1/instance_service_validation.go rename to server/api/v1/instance_service_validation.go diff --git a/server/router/api/v1/instance_stats.go b/server/api/v1/instance_stats.go similarity index 100% rename from server/router/api/v1/instance_stats.go rename to server/api/v1/instance_stats.go diff --git a/server/router/api/v1/instance_stats_test.go b/server/api/v1/instance_stats_test.go similarity index 100% rename from server/router/api/v1/instance_stats_test.go rename to server/api/v1/instance_stats_test.go diff --git a/server/router/api/v1/link_metadata_test.go b/server/api/v1/link_metadata_test.go similarity index 88% rename from server/router/api/v1/link_metadata_test.go rename to server/api/v1/link_metadata_test.go index b3873333f..175178ea8 100644 --- a/server/router/api/v1/link_metadata_test.go +++ b/server/api/v1/link_metadata_test.go @@ -10,25 +10,25 @@ import ( "google.golang.org/grpc/codes" "google.golang.org/grpc/status" - "github.com/usememos/memos/internal/httpgetter" + "github.com/usememos/memos/internal/linkmeta" v1pb "github.com/usememos/memos/proto/gen/api/v1" ) -type fakeLinkMetadataFetcher func(context.Context, string) (*httpgetter.HTMLMeta, error) +type fakeLinkMetadataFetcher func(context.Context, string) (*linkmeta.HTMLMeta, error) type linkMetadataContextKey struct{} -func (fetch fakeLinkMetadataFetcher) Get(ctx context.Context, url string) (*httpgetter.HTMLMeta, error) { +func (fetch fakeLinkMetadataFetcher) Get(ctx context.Context, url string) (*linkmeta.HTMLMeta, error) { return fetch(ctx, url) } func TestGetLinkMetadata(t *testing.T) { requestContext := context.WithValue(context.Background(), linkMetadataContextKey{}, "context value") service := &APIV1Service{ - linkMetadataFetcher: fakeLinkMetadataFetcher(func(ctx context.Context, url string) (*httpgetter.HTMLMeta, error) { + linkMetadataFetcher: fakeLinkMetadataFetcher(func(ctx context.Context, url string) (*linkmeta.HTMLMeta, error) { require.Same(t, requestContext, ctx) require.Equal(t, "https://example.com/article", url) - return &httpgetter.HTMLMeta{ + return &linkmeta.HTMLMeta{ Title: "Example title", Description: "Example description", Image: "https://example.com/cover.png", @@ -54,7 +54,7 @@ func TestGetLinkMetadataEmptyURL(t *testing.T) { func TestGetLinkMetadataFetchError(t *testing.T) { service := &APIV1Service{ - linkMetadataFetcher: fakeLinkMetadataFetcher(func(context.Context, string) (*httpgetter.HTMLMeta, error) { + linkMetadataFetcher: fakeLinkMetadataFetcher(func(context.Context, string) (*linkmeta.HTMLMeta, error) { return nil, errors.New("fetch failed") }), } @@ -65,7 +65,7 @@ func TestGetLinkMetadataFetchError(t *testing.T) { } func TestGetLinkMetadataInternalURL(t *testing.T) { - service := &APIV1Service{linkMetadataFetcher: httpgetter.NewHTMLMetaFetcher()} + service := &APIV1Service{linkMetadataFetcher: linkmeta.NewHTMLMetaFetcher()} _, err := service.GetLinkMetadata(context.Background(), &v1pb.GetLinkMetadataRequest{ Url: "http://192.168.0.1", }) @@ -76,9 +76,9 @@ func TestGetLinkMetadataInternalURL(t *testing.T) { func TestBatchGetLinkMetadataPreservesOrder(t *testing.T) { var fetchedURLs []string service := &APIV1Service{ - linkMetadataFetcher: fakeLinkMetadataFetcher(func(_ context.Context, url string) (*httpgetter.HTMLMeta, error) { + linkMetadataFetcher: fakeLinkMetadataFetcher(func(_ context.Context, url string) (*linkmeta.HTMLMeta, error) { fetchedURLs = append(fetchedURLs, url) - return &httpgetter.HTMLMeta{ + return &linkmeta.HTMLMeta{ Title: fmt.Sprintf("Title for %s", url), Description: fmt.Sprintf("Description for %s", url), Image: fmt.Sprintf("%s/cover.png", url), @@ -104,12 +104,12 @@ func TestBatchGetLinkMetadataPreservesOrder(t *testing.T) { func TestBatchGetLinkMetadataStopsOnError(t *testing.T) { var fetchedURLs []string service := &APIV1Service{ - linkMetadataFetcher: fakeLinkMetadataFetcher(func(_ context.Context, url string) (*httpgetter.HTMLMeta, error) { + linkMetadataFetcher: fakeLinkMetadataFetcher(func(_ context.Context, url string) (*linkmeta.HTMLMeta, error) { fetchedURLs = append(fetchedURLs, url) if url == "https://example.com/two" { return nil, errors.New("fetch failed") } - return &httpgetter.HTMLMeta{Title: url}, nil + return &linkmeta.HTMLMeta{Title: url}, nil }), } diff --git a/server/router/api/v1/memo_access.go b/server/api/v1/memo_access.go similarity index 99% rename from server/router/api/v1/memo_access.go rename to server/api/v1/memo_access.go index 325ebd4b9..cd44b034a 100644 --- a/server/router/api/v1/memo_access.go +++ b/server/api/v1/memo_access.go @@ -8,7 +8,7 @@ import ( "google.golang.org/grpc/codes" "google.golang.org/grpc/status" - "github.com/usememos/memos/server/access" + "github.com/usememos/memos/core/access" "github.com/usememos/memos/store" ) diff --git a/server/router/api/v1/memo_attachment_service.go b/server/api/v1/memo_attachment_service.go similarity index 99% rename from server/router/api/v1/memo_attachment_service.go rename to server/api/v1/memo_attachment_service.go index 181769e73..fc53b8ef8 100644 --- a/server/router/api/v1/memo_attachment_service.go +++ b/server/api/v1/memo_attachment_service.go @@ -11,7 +11,7 @@ import ( "google.golang.org/grpc/status" "google.golang.org/protobuf/types/known/emptypb" - "github.com/usememos/memos/internal/markdown" + "github.com/usememos/memos/markdown" v1pb "github.com/usememos/memos/proto/gen/api/v1" storepb "github.com/usememos/memos/proto/gen/store" "github.com/usememos/memos/store" diff --git a/server/router/api/v1/memo_batch_helpers.go b/server/api/v1/memo_batch_helpers.go similarity index 100% rename from server/router/api/v1/memo_batch_helpers.go rename to server/api/v1/memo_batch_helpers.go diff --git a/server/router/api/v1/memo_comment_relations_test.go b/server/api/v1/memo_comment_relations_test.go similarity index 100% rename from server/router/api/v1/memo_comment_relations_test.go rename to server/api/v1/memo_comment_relations_test.go diff --git a/server/router/api/v1/memo_create_helpers.go b/server/api/v1/memo_create_helpers.go similarity index 98% rename from server/router/api/v1/memo_create_helpers.go rename to server/api/v1/memo_create_helpers.go index 47102c0aa..23698a1b4 100644 --- a/server/router/api/v1/memo_create_helpers.go +++ b/server/api/v1/memo_create_helpers.go @@ -7,8 +7,8 @@ import ( "google.golang.org/grpc/codes" "google.golang.org/grpc/status" + "github.com/usememos/memos/core/memopayload" v1pb "github.com/usememos/memos/proto/gen/api/v1" - "github.com/usememos/memos/server/runner/memopayload" "github.com/usememos/memos/store" ) diff --git a/server/router/api/v1/memo_create_helpers_test.go b/server/api/v1/memo_create_helpers_test.go similarity index 100% rename from server/router/api/v1/memo_create_helpers_test.go rename to server/api/v1/memo_create_helpers_test.go diff --git a/server/router/api/v1/memo_delete_webhook_test.go b/server/api/v1/memo_delete_webhook_test.go similarity index 98% rename from server/router/api/v1/memo_delete_webhook_test.go rename to server/api/v1/memo_delete_webhook_test.go index 309b49af7..b1d1f3174 100644 --- a/server/router/api/v1/memo_delete_webhook_test.go +++ b/server/api/v1/memo_delete_webhook_test.go @@ -102,7 +102,7 @@ func TestDeleteMemoWebhooksRespectCurrentReadAccess(t *testing.T) { case <-time.After(3 * time.Second): require.FailNow(t, "readable memo deletion webhook was not delivered") } - payload := &webhook.WebhookRequestPayload{} + payload := &memoWebhookPayload{} require.NoError(t, json.Unmarshal(body, payload)) require.Equal(t, "memos.memo.deleted", payload.ActivityType) require.NotNil(t, payload.Memo) diff --git a/server/router/api/v1/memo_mention_helpers.go b/server/api/v1/memo_mention_helpers.go similarity index 99% rename from server/router/api/v1/memo_mention_helpers.go rename to server/api/v1/memo_mention_helpers.go index f00a0b116..d3ee3ea88 100644 --- a/server/router/api/v1/memo_mention_helpers.go +++ b/server/api/v1/memo_mention_helpers.go @@ -6,8 +6,8 @@ import ( "github.com/pkg/errors" + "github.com/usememos/memos/core/access" storepb "github.com/usememos/memos/proto/gen/store" - "github.com/usememos/memos/server/access" "github.com/usememos/memos/store" ) diff --git a/server/router/api/v1/memo_relation_service.go b/server/api/v1/memo_relation_service.go similarity index 100% rename from server/router/api/v1/memo_relation_service.go rename to server/api/v1/memo_relation_service.go diff --git a/server/router/api/v1/memo_service.go b/server/api/v1/memo_service.go similarity index 99% rename from server/router/api/v1/memo_service.go rename to server/api/v1/memo_service.go index 4c6563a7d..35bb53e53 100644 --- a/server/router/api/v1/memo_service.go +++ b/server/api/v1/memo_service.go @@ -12,10 +12,10 @@ import ( "google.golang.org/protobuf/proto" "google.golang.org/protobuf/types/known/emptypb" + "github.com/usememos/memos/core/memopayload" "github.com/usememos/memos/internal/ratelimit" v1pb "github.com/usememos/memos/proto/gen/api/v1" storepb "github.com/usememos/memos/proto/gen/store" - "github.com/usememos/memos/server/runner/memopayload" "github.com/usememos/memos/store" ) diff --git a/server/router/api/v1/memo_service_comments.go b/server/api/v1/memo_service_comments.go similarity index 100% rename from server/router/api/v1/memo_service_comments.go rename to server/api/v1/memo_service_comments.go diff --git a/server/router/api/v1/memo_service_converter.go b/server/api/v1/memo_service_converter.go similarity index 99% rename from server/router/api/v1/memo_service_converter.go rename to server/api/v1/memo_service_converter.go index 720ecd46f..3221be153 100644 --- a/server/router/api/v1/memo_service_converter.go +++ b/server/api/v1/memo_service_converter.go @@ -12,9 +12,9 @@ import ( "google.golang.org/grpc/status" "google.golang.org/protobuf/types/known/timestamppb" + "github.com/usememos/memos/core/access" v1pb "github.com/usememos/memos/proto/gen/api/v1" storepb "github.com/usememos/memos/proto/gen/store" - "github.com/usememos/memos/server/access" "github.com/usememos/memos/store" ) diff --git a/server/router/api/v1/memo_service_filter.go b/server/api/v1/memo_service_filter.go similarity index 100% rename from server/router/api/v1/memo_service_filter.go rename to server/api/v1/memo_service_filter.go diff --git a/server/router/api/v1/memo_service_link_metadata.go b/server/api/v1/memo_service_link_metadata.go similarity index 95% rename from server/router/api/v1/memo_service_link_metadata.go rename to server/api/v1/memo_service_link_metadata.go index 682fb4523..a772f4e2b 100644 --- a/server/router/api/v1/memo_service_link_metadata.go +++ b/server/api/v1/memo_service_link_metadata.go @@ -7,13 +7,13 @@ import ( "google.golang.org/grpc/codes" "google.golang.org/grpc/status" - "github.com/usememos/memos/internal/httpgetter" + "github.com/usememos/memos/internal/linkmeta" "github.com/usememos/memos/internal/ratelimit" v1pb "github.com/usememos/memos/proto/gen/api/v1" ) type linkMetadataFetcher interface { - Get(context.Context, string) (*httpgetter.HTMLMeta, error) + Get(context.Context, string) (*linkmeta.HTMLMeta, error) } // GetLinkMetadata gets metadata for a link. diff --git a/server/router/api/v1/memo_service_query.go b/server/api/v1/memo_service_query.go similarity index 100% rename from server/router/api/v1/memo_service_query.go rename to server/api/v1/memo_service_query.go diff --git a/server/router/api/v1/memo_service_webhooks.go b/server/api/v1/memo_service_webhooks.go similarity index 76% rename from server/router/api/v1/memo_service_webhooks.go rename to server/api/v1/memo_service_webhooks.go index dd4419107..41830a147 100644 --- a/server/router/api/v1/memo_service_webhooks.go +++ b/server/api/v1/memo_service_webhooks.go @@ -7,9 +7,10 @@ import ( "google.golang.org/grpc/codes" "google.golang.org/grpc/status" + "github.com/usememos/memos/core/access" "github.com/usememos/memos/internal/webhook" v1pb "github.com/usememos/memos/proto/gen/api/v1" - "github.com/usememos/memos/server/access" + storepb "github.com/usememos/memos/proto/gen/store" "github.com/usememos/memos/server/auth" "github.com/usememos/memos/store" ) @@ -77,14 +78,7 @@ func (s *APIV1Service) DispatchMemoCommentCreatedWebhook( return err } for _, hook := range webhooks { - payload, err := convertMemoToWebhookPayload(commentMessage) - if err != nil { - return errors.Wrap(err, "failed to convert memo to webhook payload") - } - payload.ActivityType = "memos.memo.comment.created" - payload.URL = hook.Url - payload.SigningSecret = hook.SigningSecret - webhook.PostAsync(payload) + webhook.PostAsync(newMemoWebhookRequest(hook, "memos.memo.comment.created", commentMessage)) } return nil } @@ -103,23 +97,36 @@ func (s *APIV1Service) dispatchMemoRelatedWebhook(ctx context.Context, memo *v1p return err } for _, hook := range webhooks { - payload, err := convertMemoToWebhookPayload(memo) - if err != nil { - return errors.Wrap(err, "failed to convert memo to webhook payload") - } - payload.ActivityType = activityType - payload.URL = hook.Url - payload.SigningSecret = hook.SigningSecret - webhook.PostAsync(payload) + webhook.PostAsync(newMemoWebhookRequest(hook, activityType, memo)) } return nil } -func convertMemoToWebhookPayload(memo *v1pb.Memo) (*webhook.WebhookRequestPayload, error) { - return &webhook.WebhookRequestPayload{ - Creator: memo.Creator, - Memo: memo, - }, nil +// memoWebhookPayload is the JSON body delivered to user webhooks for memo +// activity. Field names are part of the webhook contract. +type memoWebhookPayload struct { + // URL is the destination the payload was sent to. + URL string `json:"url"` + // ActivityType names the event, for example "memos.memo.created". + ActivityType string `json:"activityType"` + // Creator is the resource name of the memo creator. Format: users/{user} + Creator string `json:"creator"` + // Memo is the memo that triggered the event. + Memo *v1pb.Memo `json:"memo"` +} + +func newMemoWebhookRequest(hook *storepb.WebhooksUserSetting_Webhook, activityType string, memo *v1pb.Memo) *webhook.Request { + return &webhook.Request{ + URL: hook.Url, + Label: activityType, + SigningSecret: hook.SigningSecret, + Payload: &memoWebhookPayload{ + URL: hook.Url, + ActivityType: activityType, + Creator: memo.Creator, + Memo: memo, + }, + } } func (s *APIV1Service) getMemoContentSnippet(content string) (string, error) { diff --git a/server/router/api/v1/memo_share_service.go b/server/api/v1/memo_share_service.go similarity index 99% rename from server/router/api/v1/memo_share_service.go rename to server/api/v1/memo_share_service.go index c03a46233..4deaf5296 100644 --- a/server/router/api/v1/memo_share_service.go +++ b/server/api/v1/memo_share_service.go @@ -14,9 +14,9 @@ import ( "github.com/lithammer/shortuuid/v4" "github.com/pkg/errors" + "github.com/usememos/memos/core/access" "github.com/usememos/memos/internal/ratelimit" v1pb "github.com/usememos/memos/proto/gen/api/v1" - "github.com/usememos/memos/server/access" "github.com/usememos/memos/store" ) diff --git a/server/router/api/v1/memo_update_helpers.go b/server/api/v1/memo_update_helpers.go similarity index 100% rename from server/router/api/v1/memo_update_helpers.go rename to server/api/v1/memo_update_helpers.go diff --git a/server/router/api/v1/memo_view_icon.go b/server/api/v1/memo_view_icon.go similarity index 100% rename from server/router/api/v1/memo_view_icon.go rename to server/api/v1/memo_view_icon.go diff --git a/server/router/api/v1/notification_email.go b/server/api/v1/notification_email.go similarity index 94% rename from server/router/api/v1/notification_email.go rename to server/api/v1/notification_email.go index f51033d44..9e705eeae 100644 --- a/server/router/api/v1/notification_email.go +++ b/server/api/v1/notification_email.go @@ -4,7 +4,7 @@ import ( "context" "log/slog" - "github.com/usememos/memos/server/notification" + "github.com/usememos/memos/core/notification" "github.com/usememos/memos/store" ) diff --git a/server/router/api/v1/ratelimit.go b/server/api/v1/ratelimit.go similarity index 100% rename from server/router/api/v1/ratelimit.go rename to server/api/v1/ratelimit.go diff --git a/server/router/api/v1/ratelimit_test.go b/server/api/v1/ratelimit_test.go similarity index 100% rename from server/router/api/v1/ratelimit_test.go rename to server/api/v1/ratelimit_test.go diff --git a/server/router/api/v1/reaction_service.go b/server/api/v1/reaction_service.go similarity index 100% rename from server/router/api/v1/reaction_service.go rename to server/api/v1/reaction_service.go diff --git a/server/router/api/v1/reaction_service_policy_test.go b/server/api/v1/reaction_service_policy_test.go similarity index 100% rename from server/router/api/v1/reaction_service_policy_test.go rename to server/api/v1/reaction_service_policy_test.go diff --git a/server/router/api/v1/resource_name.go b/server/api/v1/resource_name.go similarity index 91% rename from server/router/api/v1/resource_name.go rename to server/api/v1/resource_name.go index 9eb7f8702..6176ed5ad 100644 --- a/server/router/api/v1/resource_name.go +++ b/server/api/v1/resource_name.go @@ -2,6 +2,7 @@ package v1 import ( "fmt" + "strconv" "strings" "github.com/lithammer/shortuuid/v4" @@ -9,8 +10,8 @@ import ( "google.golang.org/grpc/codes" "google.golang.org/grpc/status" - "github.com/usememos/memos/internal/base" - "github.com/usememos/memos/internal/util" + "github.com/usememos/memos/internal/identifier" + "github.com/usememos/memos/internal/random" ) const ( @@ -73,7 +74,7 @@ func ExtractUserIDFromName(name string) (int32, error) { if err != nil { return 0, err } - id, err := util.ConvertStringToInt32(tokens[0]) + id, err := parseInt32(tokens[0]) if err != nil { return 0, errors.Errorf("invalid user ID %q", tokens[0]) } @@ -142,7 +143,7 @@ func ExtractMemoReactionIDFromName(name string) (string, int32, error) { return "", 0, err } memoUID := tokens[0] - reactionID, err := util.ConvertStringToInt32(tokens[1]) + reactionID, err := parseInt32(tokens[1]) if err != nil { return "", 0, errors.Errorf("invalid reaction ID %q", tokens[1]) } @@ -155,7 +156,7 @@ func ExtractInboxIDFromName(name string) (int32, error) { if err != nil { return 0, err } - id, err := util.ConvertStringToInt32(tokens[0]) + id, err := parseInt32(tokens[0]) if err != nil { return 0, errors.Errorf("invalid inbox ID %q", tokens[0]) } @@ -172,13 +173,13 @@ func ExtractIdentityProviderUIDFromName(name string) (string, error) { // ValidateAndGenerateUID validates a user-provided UID or generates a new one. // If provided is empty, a new shortuuid is generated. -// If provided is non-empty, it is validated against base.UIDMatcher. +// If provided is non-empty, it is validated against identifier.UIDMatcher. func ValidateAndGenerateUID(provided string) (string, error) { uid := strings.TrimSpace(provided) if uid == "" { return shortuuid.New(), nil } - if !base.UIDMatcher.MatchString(uid) { + if !identifier.UIDMatcher.MatchString(uid) { return "", status.Errorf(codes.InvalidArgument, "invalid UID: must be 1-36 characters, contain only letters, digits, or hyphens, and start and end with a letter or digit") } return uid, nil @@ -188,7 +189,15 @@ func ValidateAndGenerateUID(provided string) (string, error) { // Custom UIDs use the same format as other public-resource UIDs. func ValidateAndGenerateSpaceUID(provided string) (string, error) { if strings.TrimSpace(provided) == "" { - return util.GenUUID(), nil + return random.UUID(), nil } return ValidateAndGenerateUID(provided) } + +func parseInt32(src string) (int32, error) { + parsed, err := strconv.ParseInt(src, 10, 32) + if err != nil { + return 0, err + } + return int32(parsed), nil +} diff --git a/server/router/api/v1/resource_name_test.go b/server/api/v1/resource_name_test.go similarity index 100% rename from server/router/api/v1/resource_name_test.go rename to server/api/v1/resource_name_test.go diff --git a/server/router/api/v1/space_icon_test.go b/server/api/v1/space_icon_test.go similarity index 100% rename from server/router/api/v1/space_icon_test.go rename to server/api/v1/space_icon_test.go diff --git a/server/router/api/v1/space_service.go b/server/api/v1/space_service.go similarity index 100% rename from server/router/api/v1/space_service.go rename to server/api/v1/space_service.go diff --git a/server/router/api/v1/space_service_converters.go b/server/api/v1/space_service_converters.go similarity index 100% rename from server/router/api/v1/space_service_converters.go rename to server/api/v1/space_service_converters.go diff --git a/server/router/api/v1/space_service_notifications.go b/server/api/v1/space_service_notifications.go similarity index 100% rename from server/router/api/v1/space_service_notifications.go rename to server/api/v1/space_service_notifications.go diff --git a/server/router/api/v1/space_service_test.go b/server/api/v1/space_service_test.go similarity index 100% rename from server/router/api/v1/space_service_test.go rename to server/api/v1/space_service_test.go diff --git a/server/router/api/v1/sse_handler.go b/server/api/v1/sse_handler.go similarity index 100% rename from server/router/api/v1/sse_handler.go rename to server/api/v1/sse_handler.go diff --git a/server/router/api/v1/sse_hub.go b/server/api/v1/sse_hub.go similarity index 100% rename from server/router/api/v1/sse_hub.go rename to server/api/v1/sse_hub.go diff --git a/server/router/api/v1/sse_hub_test.go b/server/api/v1/sse_hub_test.go similarity index 100% rename from server/router/api/v1/sse_hub_test.go rename to server/api/v1/sse_hub_test.go diff --git a/server/router/api/v1/sse_service_test.go b/server/api/v1/sse_service_test.go similarity index 100% rename from server/router/api/v1/sse_service_test.go rename to server/api/v1/sse_service_test.go diff --git a/server/router/api/v1/sso_username.go b/server/api/v1/sso_username.go similarity index 88% rename from server/router/api/v1/sso_username.go rename to server/api/v1/sso_username.go index de5e45f86..fbd4c15bf 100644 --- a/server/router/api/v1/sso_username.go +++ b/server/api/v1/sso_username.go @@ -3,7 +3,7 @@ package v1 import ( "github.com/pkg/errors" - "github.com/usememos/memos/internal/util" + "github.com/usememos/memos/internal/random" ) const ssoUsernameFallbackAttempts = 5 @@ -14,7 +14,7 @@ const ssoUsernameFallbackAttempts = 5 // as the local username, such as when it is invalid or already belongs to // another local account. func deriveSSOUsername() (string, error) { - username := util.GenUUID() + username := random.UUID() if err := validateWritableUsername(username); err != nil { return "", errors.Wrap(err, "generated UUID did not satisfy username constraints") } diff --git a/server/router/api/v1/sso_username_test.go b/server/api/v1/sso_username_test.go similarity index 100% rename from server/router/api/v1/sso_username_test.go rename to server/api/v1/sso_username_test.go diff --git a/server/router/api/v1/test/ai_service_test.go b/server/api/v1/test/ai_service_test.go similarity index 100% rename from server/router/api/v1/test/ai_service_test.go rename to server/api/v1/test/ai_service_test.go diff --git a/server/router/api/v1/test/attachment_service_s3_test.go b/server/api/v1/test/attachment_service_s3_test.go similarity index 98% rename from server/router/api/v1/test/attachment_service_s3_test.go rename to server/api/v1/test/attachment_service_s3_test.go index f50008850..d7ad87f8e 100644 --- a/server/router/api/v1/test/attachment_service_s3_test.go +++ b/server/api/v1/test/attachment_service_s3_test.go @@ -7,11 +7,11 @@ import ( "github.com/stretchr/testify/require" - "github.com/usememos/memos/internal/storage/s3" "github.com/usememos/memos/internal/testutil/fakes3" 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/provider/storage/s3" + apiv1 "github.com/usememos/memos/server/api/v1" "github.com/usememos/memos/store" ) diff --git a/server/router/api/v1/test/attachment_service_test.go b/server/api/v1/test/attachment_service_test.go similarity index 99% rename from server/router/api/v1/test/attachment_service_test.go rename to server/api/v1/test/attachment_service_test.go index 393b185be..a0300b844 100644 --- a/server/router/api/v1/test/attachment_service_test.go +++ b/server/api/v1/test/attachment_service_test.go @@ -16,7 +16,7 @@ import ( "github.com/usememos/memos/internal/testutil" 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" + apiv1 "github.com/usememos/memos/server/api/v1" "github.com/usememos/memos/store" ) diff --git a/server/router/api/v1/test/auth_service_sso_username_test.go b/server/api/v1/test/auth_service_sso_username_test.go similarity index 99% rename from server/router/api/v1/test/auth_service_sso_username_test.go rename to server/api/v1/test/auth_service_sso_username_test.go index f8c83f1fe..a16e7f5a8 100644 --- a/server/router/api/v1/test/auth_service_sso_username_test.go +++ b/server/api/v1/test/auth_service_sso_username_test.go @@ -13,7 +13,7 @@ import ( 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" + apiv1 "github.com/usememos/memos/server/api/v1" "github.com/usememos/memos/store" ) diff --git a/server/router/api/v1/test/auth_service_test.go b/server/api/v1/test/auth_service_test.go similarity index 99% rename from server/router/api/v1/test/auth_service_test.go rename to server/api/v1/test/auth_service_test.go index 5f5928d7a..995cafbda 100644 --- a/server/router/api/v1/test/auth_service_test.go +++ b/server/api/v1/test/auth_service_test.go @@ -15,7 +15,7 @@ import ( 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" + apiv1 "github.com/usememos/memos/server/api/v1" "github.com/usememos/memos/store" ) diff --git a/server/router/api/v1/test/auth_test.go b/server/api/v1/test/auth_test.go similarity index 97% rename from server/router/api/v1/test/auth_test.go rename to server/api/v1/test/auth_test.go index 6e5952409..94f6ece7d 100644 --- a/server/router/api/v1/test/auth_test.go +++ b/server/api/v1/test/auth_test.go @@ -9,7 +9,7 @@ import ( "github.com/stretchr/testify/require" "google.golang.org/protobuf/types/known/timestamppb" - "github.com/usememos/memos/internal/util" + "github.com/usememos/memos/internal/random" storepb "github.com/usememos/memos/proto/gen/store" "github.com/usememos/memos/server/auth" "github.com/usememos/memos/store" @@ -119,7 +119,7 @@ func TestAuthenticatorRefreshToken(t *testing.T) { require.NoError(t, err) // Create refresh token record in store - tokenID := util.GenUUID() + tokenID := random.UUID() refreshTokenRecord := &storepb.RefreshTokensUserSetting_RefreshToken{ TokenId: tokenID, ExpiresAt: timestamppb.New(time.Now().Add(auth.RefreshTokenDuration)), @@ -148,7 +148,7 @@ func TestAuthenticatorRefreshToken(t *testing.T) { user, err := ts.CreateRegularUser(ctx, "testuser") require.NoError(t, err) - tokenID := util.GenUUID() + tokenID := random.UUID() // Generate refresh token JWT but don't store it in database (simulates revocation) token, _, err := auth.GenerateRefreshToken(user.ID, tokenID, []byte(ts.Secret)) @@ -169,7 +169,7 @@ func TestAuthenticatorRefreshToken(t *testing.T) { require.NoError(t, err) // Create expired refresh token record in store - tokenID := util.GenUUID() + tokenID := random.UUID() expiredToken := &storepb.RefreshTokensUserSetting_RefreshToken{ TokenId: tokenID, ExpiresAt: timestamppb.New(time.Now().Add(-1 * time.Hour)), // Expired @@ -197,7 +197,7 @@ func TestAuthenticatorRefreshToken(t *testing.T) { require.NoError(t, err) // Create valid refresh token - tokenID := util.GenUUID() + tokenID := random.UUID() refreshTokenRecord := &storepb.RefreshTokensUserSetting_RefreshToken{ TokenId: tokenID, ExpiresAt: timestamppb.New(time.Now().Add(auth.RefreshTokenDuration)), @@ -239,7 +239,7 @@ func TestAuthenticatorPAT(t *testing.T) { // Generate PAT token := auth.GeneratePersonalAccessToken() tokenHash := auth.HashPersonalAccessToken(token) - tokenID := util.GenUUID() + tokenID := random.UUID() // Store PAT in database patRecord := &storepb.PersonalAccessTokensUserSetting_PersonalAccessToken{ @@ -269,7 +269,7 @@ func TestAuthenticatorPAT(t *testing.T) { require.NoError(t, err) token := auth.GeneratePersonalAccessToken() - tokenID := util.GenUUID() + tokenID := random.UUID() err = ts.Store.AddUserPersonalAccessToken(ctx, user.ID, &storepb.PersonalAccessTokensUserSetting_PersonalAccessToken{ TokenId: tokenID, TokenHash: auth.HashPersonalAccessToken(token), @@ -322,7 +322,7 @@ func TestAuthenticatorPAT(t *testing.T) { // Generate and store expired PAT token := auth.GeneratePersonalAccessToken() tokenHash := auth.HashPersonalAccessToken(token) - tokenID := util.GenUUID() + tokenID := random.UUID() expiredPAT := &storepb.PersonalAccessTokensUserSetting_PersonalAccessToken{ TokenId: tokenID, @@ -351,7 +351,7 @@ func TestAuthenticatorPAT(t *testing.T) { // Generate and store PAT without expiration token := auth.GeneratePersonalAccessToken() tokenHash := auth.HashPersonalAccessToken(token) - tokenID := util.GenUUID() + tokenID := random.UUID() patRecord := &storepb.PersonalAccessTokensUserSetting_PersonalAccessToken{ TokenId: tokenID, @@ -382,7 +382,7 @@ func TestAuthenticatorPAT(t *testing.T) { // Generate and store PAT token := auth.GeneratePersonalAccessToken() tokenHash := auth.HashPersonalAccessToken(token) - tokenID := util.GenUUID() + tokenID := random.UUID() patRecord := &storepb.PersonalAccessTokensUserSetting_PersonalAccessToken{ TokenId: tokenID, @@ -419,7 +419,7 @@ func TestStoreRefreshTokenMethods(t *testing.T) { user, err := ts.CreateRegularUser(ctx, "testuser") require.NoError(t, err) - tokenID := util.GenUUID() + tokenID := random.UUID() token := &storepb.RefreshTokensUserSetting_RefreshToken{ TokenId: tokenID, ExpiresAt: timestamppb.New(time.Now().Add(30 * 24 * time.Hour)), @@ -443,7 +443,7 @@ func TestStoreRefreshTokenMethods(t *testing.T) { user, err := ts.CreateRegularUser(ctx, "testuser") require.NoError(t, err) - tokenID := util.GenUUID() + tokenID := random.UUID() token := &storepb.RefreshTokensUserSetting_RefreshToken{ TokenId: tokenID, ExpiresAt: timestamppb.New(time.Now().Add(30 * 24 * time.Hour)), @@ -467,7 +467,7 @@ func TestStoreRefreshTokenMethods(t *testing.T) { user, err := ts.CreateRegularUser(ctx, "testuser") require.NoError(t, err) - tokenID := util.GenUUID() + tokenID := random.UUID() token := &storepb.RefreshTokensUserSetting_RefreshToken{ TokenId: tokenID, ExpiresAt: timestamppb.New(time.Now().Add(30 * 24 * time.Hour)), @@ -495,8 +495,8 @@ func TestStoreRefreshTokenMethods(t *testing.T) { require.NoError(t, err) // Add multiple tokens - tokenID1 := util.GenUUID() - tokenID2 := util.GenUUID() + tokenID1 := random.UUID() + tokenID2 := random.UUID() token1 := &storepb.RefreshTokensUserSetting_RefreshToken{ TokenId: tokenID1, @@ -543,7 +543,7 @@ func TestStorePersonalAccessTokenMethods(t *testing.T) { token := auth.GeneratePersonalAccessToken() tokenHash := auth.HashPersonalAccessToken(token) - tokenID := util.GenUUID() + tokenID := random.UUID() pat := &storepb.PersonalAccessTokensUserSetting_PersonalAccessToken{ TokenId: tokenID, @@ -572,7 +572,7 @@ func TestStorePersonalAccessTokenMethods(t *testing.T) { token := auth.GeneratePersonalAccessToken() tokenHash := auth.HashPersonalAccessToken(token) - tokenID := util.GenUUID() + tokenID := random.UUID() pat := &storepb.PersonalAccessTokensUserSetting_PersonalAccessToken{ TokenId: tokenID, @@ -603,7 +603,7 @@ func TestStorePersonalAccessTokenMethods(t *testing.T) { token := auth.GeneratePersonalAccessToken() tokenHash := auth.HashPersonalAccessToken(token) - tokenID := util.GenUUID() + tokenID := random.UUID() pat := &storepb.PersonalAccessTokensUserSetting_PersonalAccessToken{ TokenId: tokenID, @@ -637,11 +637,11 @@ func TestStorePersonalAccessTokenMethods(t *testing.T) { // Add multiple PATs token1 := auth.GeneratePersonalAccessToken() tokenHash1 := auth.HashPersonalAccessToken(token1) - tokenID1 := util.GenUUID() + tokenID1 := random.UUID() token2 := auth.GeneratePersonalAccessToken() tokenHash2 := auth.HashPersonalAccessToken(token2) - tokenID2 := util.GenUUID() + tokenID2 := random.UUID() pat1 := &storepb.PersonalAccessTokensUserSetting_PersonalAccessToken{ TokenId: tokenID1, @@ -686,7 +686,7 @@ func TestStorePersonalAccessTokenMethods(t *testing.T) { token := auth.GeneratePersonalAccessToken() tokenHash := auth.HashPersonalAccessToken(token) - tokenID := util.GenUUID() + tokenID := random.UUID() pat := &storepb.PersonalAccessTokensUserSetting_PersonalAccessToken{ TokenId: tokenID, diff --git a/server/router/api/v1/test/authz_test.go b/server/api/v1/test/authz_test.go similarity index 96% rename from server/router/api/v1/test/authz_test.go rename to server/api/v1/test/authz_test.go index ea5e7f6ed..feb029f71 100644 --- a/server/router/api/v1/test/authz_test.go +++ b/server/api/v1/test/authz_test.go @@ -7,10 +7,10 @@ import ( "github.com/stretchr/testify/require" "google.golang.org/protobuf/types/known/timestamppb" - "github.com/usememos/memos/internal/util" + "github.com/usememos/memos/internal/random" storepb "github.com/usememos/memos/proto/gen/store" + apiv1 "github.com/usememos/memos/server/api/v1" "github.com/usememos/memos/server/auth" - apiv1 "github.com/usememos/memos/server/router/api/v1" ) // TestAuthorizerPrivateInstanceRegistration verifies that registration and other @@ -72,7 +72,7 @@ func TestAuthorizerAccessTokenAlwaysWorksOnPrivateInstance(t *testing.T) { token := auth.GeneratePersonalAccessToken() require.NoError(t, ts.Store.AddUserPersonalAccessToken(ctx, user.ID, &storepb.PersonalAccessTokensUserSetting_PersonalAccessToken{ - TokenId: util.GenUUID(), + TokenId: random.UUID(), TokenHash: auth.HashPersonalAccessToken(token), Description: "authz test PAT", CreatedAt: timestamppb.Now(), diff --git a/server/router/api/v1/test/configuration_provisioning_test.go b/server/api/v1/test/configuration_provisioning_test.go similarity index 100% rename from server/router/api/v1/test/configuration_provisioning_test.go rename to server/api/v1/test/configuration_provisioning_test.go diff --git a/server/router/api/v1/test/idp_service_test.go b/server/api/v1/test/idp_service_test.go similarity index 99% rename from server/router/api/v1/test/idp_service_test.go rename to server/api/v1/test/idp_service_test.go index a2e88a1f4..7b08851a7 100644 --- a/server/router/api/v1/test/idp_service_test.go +++ b/server/api/v1/test/idp_service_test.go @@ -8,7 +8,7 @@ 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" + apiv1 "github.com/usememos/memos/server/api/v1" "github.com/usememos/memos/store" ) diff --git a/server/router/api/v1/test/instance_admin_cache_test.go b/server/api/v1/test/instance_admin_cache_test.go similarity index 100% rename from server/router/api/v1/test/instance_admin_cache_test.go rename to server/api/v1/test/instance_admin_cache_test.go diff --git a/server/router/api/v1/test/instance_service_test.go b/server/api/v1/test/instance_service_test.go similarity index 100% rename from server/router/api/v1/test/instance_service_test.go rename to server/api/v1/test/instance_service_test.go diff --git a/server/router/api/v1/test/instance_stats_test.go b/server/api/v1/test/instance_stats_test.go similarity index 100% rename from server/router/api/v1/test/instance_stats_test.go rename to server/api/v1/test/instance_stats_test.go diff --git a/server/router/api/v1/test/memo_attachment_markdown_test.go b/server/api/v1/test/memo_attachment_markdown_test.go similarity index 99% rename from server/router/api/v1/test/memo_attachment_markdown_test.go rename to server/api/v1/test/memo_attachment_markdown_test.go index 8da2cd713..254a94e77 100644 --- a/server/router/api/v1/test/memo_attachment_markdown_test.go +++ b/server/api/v1/test/memo_attachment_markdown_test.go @@ -15,7 +15,7 @@ import ( "google.golang.org/protobuf/types/known/fieldmaskpb" v1pb "github.com/usememos/memos/proto/gen/api/v1" - api "github.com/usememos/memos/server/router/api/v1" + api "github.com/usememos/memos/server/api/v1" "github.com/usememos/memos/store" ) diff --git a/server/router/api/v1/test/memo_attachment_service_test.go b/server/api/v1/test/memo_attachment_service_test.go similarity index 100% rename from server/router/api/v1/test/memo_attachment_service_test.go rename to server/api/v1/test/memo_attachment_service_test.go diff --git a/server/router/api/v1/test/memo_move_test.go b/server/api/v1/test/memo_move_test.go similarity index 100% rename from server/router/api/v1/test/memo_move_test.go rename to server/api/v1/test/memo_move_test.go diff --git a/server/router/api/v1/test/memo_relation_service_test.go b/server/api/v1/test/memo_relation_service_test.go similarity index 100% rename from server/router/api/v1/test/memo_relation_service_test.go rename to server/api/v1/test/memo_relation_service_test.go diff --git a/server/router/api/v1/test/memo_service_benchmark_test.go b/server/api/v1/test/memo_service_benchmark_test.go similarity index 99% rename from server/router/api/v1/test/memo_service_benchmark_test.go rename to server/api/v1/test/memo_service_benchmark_test.go index e81de48ca..ab8eb16cf 100644 --- a/server/router/api/v1/test/memo_service_benchmark_test.go +++ b/server/api/v1/test/memo_service_benchmark_test.go @@ -9,8 +9,8 @@ import ( "github.com/usememos/memos/internal/profile" "github.com/usememos/memos/internal/version" v1pb "github.com/usememos/memos/proto/gen/api/v1" + apiv1 "github.com/usememos/memos/server/api/v1" "github.com/usememos/memos/server/auth" - apiv1 "github.com/usememos/memos/server/router/api/v1" "github.com/usememos/memos/store" "github.com/usememos/memos/store/db" ) diff --git a/server/router/api/v1/test/memo_service_test.go b/server/api/v1/test/memo_service_test.go similarity index 100% rename from server/router/api/v1/test/memo_service_test.go rename to server/api/v1/test/memo_service_test.go diff --git a/server/router/api/v1/test/memo_share_service_test.go b/server/api/v1/test/memo_share_service_test.go similarity index 100% rename from server/router/api/v1/test/memo_share_service_test.go rename to server/api/v1/test/memo_share_service_test.go diff --git a/server/router/api/v1/test/memo_timestamp_test.go b/server/api/v1/test/memo_timestamp_test.go similarity index 100% rename from server/router/api/v1/test/memo_timestamp_test.go rename to server/api/v1/test/memo_timestamp_test.go diff --git a/server/router/api/v1/test/memo_view_icon_test.go b/server/api/v1/test/memo_view_icon_test.go similarity index 100% rename from server/router/api/v1/test/memo_view_icon_test.go rename to server/api/v1/test/memo_view_icon_test.go diff --git a/server/router/api/v1/test/memo_view_service_test.go b/server/api/v1/test/memo_view_service_test.go similarity index 100% rename from server/router/api/v1/test/memo_view_service_test.go rename to server/api/v1/test/memo_view_service_test.go diff --git a/server/router/api/v1/test/personal_access_token_test.go b/server/api/v1/test/personal_access_token_test.go similarity index 100% rename from server/router/api/v1/test/personal_access_token_test.go rename to server/api/v1/test/personal_access_token_test.go diff --git a/server/router/api/v1/test/ratelimit_test.go b/server/api/v1/test/ratelimit_test.go similarity index 99% rename from server/router/api/v1/test/ratelimit_test.go rename to server/api/v1/test/ratelimit_test.go index a079b3774..dcee2813d 100644 --- a/server/router/api/v1/test/ratelimit_test.go +++ b/server/api/v1/test/ratelimit_test.go @@ -18,8 +18,8 @@ import ( "github.com/usememos/memos/internal/clientip" "github.com/usememos/memos/internal/ratelimit" apiv1 "github.com/usememos/memos/proto/gen/api/v1" + apiv1server "github.com/usememos/memos/server/api/v1" "github.com/usememos/memos/server/auth" - apiv1server "github.com/usememos/memos/server/router/api/v1" "github.com/usememos/memos/store" ) diff --git a/server/router/api/v1/test/reaction_service_test.go b/server/api/v1/test/reaction_service_test.go similarity index 100% rename from server/router/api/v1/test/reaction_service_test.go rename to server/api/v1/test/reaction_service_test.go diff --git a/server/router/api/v1/test/sse_handler_test.go b/server/api/v1/test/sse_handler_test.go similarity index 98% rename from server/router/api/v1/test/sse_handler_test.go rename to server/api/v1/test/sse_handler_test.go index d698c67d2..3f4c2e4fa 100644 --- a/server/router/api/v1/test/sse_handler_test.go +++ b/server/api/v1/test/sse_handler_test.go @@ -13,8 +13,8 @@ import ( "github.com/stretchr/testify/require" v1pb "github.com/usememos/memos/proto/gen/api/v1" + apiv1 "github.com/usememos/memos/server/api/v1" "github.com/usememos/memos/server/auth" - apiv1 "github.com/usememos/memos/server/router/api/v1" ) func TestSSEHandler_Authentication(t *testing.T) { diff --git a/server/router/api/v1/test/test_helper.go b/server/api/v1/test/test_helper.go similarity index 97% rename from server/router/api/v1/test/test_helper.go rename to server/api/v1/test/test_helper.go index 722454a6a..346f5e19c 100644 --- a/server/router/api/v1/test/test_helper.go +++ b/server/api/v1/test/test_helper.go @@ -5,11 +5,11 @@ import ( "strings" "testing" - "github.com/usememos/memos/internal/markdown" "github.com/usememos/memos/internal/profile" + "github.com/usememos/memos/markdown" storepb "github.com/usememos/memos/proto/gen/store" + apiv1 "github.com/usememos/memos/server/api/v1" "github.com/usememos/memos/server/auth" - apiv1 "github.com/usememos/memos/server/router/api/v1" "github.com/usememos/memos/store" teststore "github.com/usememos/memos/store/test" ) diff --git a/server/router/api/v1/test/user_email_visibility_test.go b/server/api/v1/test/user_email_visibility_test.go similarity index 100% rename from server/router/api/v1/test/user_email_visibility_test.go rename to server/api/v1/test/user_email_visibility_test.go diff --git a/server/router/api/v1/test/user_notification_test.go b/server/api/v1/test/user_notification_test.go similarity index 100% rename from server/router/api/v1/test/user_notification_test.go rename to server/api/v1/test/user_notification_test.go diff --git a/server/router/api/v1/test/user_resource_name_test.go b/server/api/v1/test/user_resource_name_test.go similarity index 98% rename from server/router/api/v1/test/user_resource_name_test.go rename to server/api/v1/test/user_resource_name_test.go index 9044b329f..7ffa6994c 100644 --- a/server/router/api/v1/test/user_resource_name_test.go +++ b/server/api/v1/test/user_resource_name_test.go @@ -8,7 +8,7 @@ import ( "google.golang.org/protobuf/types/known/fieldmaskpb" apiv1 "github.com/usememos/memos/proto/gen/api/v1" - apiv1server "github.com/usememos/memos/server/router/api/v1" + apiv1server "github.com/usememos/memos/server/api/v1" "github.com/usememos/memos/store" ) diff --git a/server/router/api/v1/test/user_search_test.go b/server/api/v1/test/user_search_test.go similarity index 100% rename from server/router/api/v1/test/user_search_test.go rename to server/api/v1/test/user_search_test.go diff --git a/server/router/api/v1/test/user_service_delete_test.go b/server/api/v1/test/user_service_delete_test.go similarity index 99% rename from server/router/api/v1/test/user_service_delete_test.go rename to server/api/v1/test/user_service_delete_test.go index bd26cc0de..10e880e0d 100644 --- a/server/router/api/v1/test/user_service_delete_test.go +++ b/server/api/v1/test/user_service_delete_test.go @@ -15,7 +15,7 @@ import ( 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" + apiv1 "github.com/usememos/memos/server/api/v1" "github.com/usememos/memos/store" ) diff --git a/server/router/api/v1/test/user_service_email_username_test.go b/server/api/v1/test/user_service_email_username_test.go similarity index 99% rename from server/router/api/v1/test/user_service_email_username_test.go rename to server/api/v1/test/user_service_email_username_test.go index 98fc5216f..258f780a9 100644 --- a/server/router/api/v1/test/user_service_email_username_test.go +++ b/server/api/v1/test/user_service_email_username_test.go @@ -9,7 +9,7 @@ import ( "google.golang.org/protobuf/types/known/fieldmaskpb" apiv1 "github.com/usememos/memos/proto/gen/api/v1" - apiv1server "github.com/usememos/memos/server/router/api/v1" + apiv1server "github.com/usememos/memos/server/api/v1" "github.com/usememos/memos/store" ) diff --git a/server/router/api/v1/test/user_service_pagination_test.go b/server/api/v1/test/user_service_pagination_test.go similarity index 100% rename from server/router/api/v1/test/user_service_pagination_test.go rename to server/api/v1/test/user_service_pagination_test.go diff --git a/server/router/api/v1/test/user_service_registration_test.go b/server/api/v1/test/user_service_registration_test.go similarity index 99% rename from server/router/api/v1/test/user_service_registration_test.go rename to server/api/v1/test/user_service_registration_test.go index 99fd2a720..307ed9801 100644 --- a/server/router/api/v1/test/user_service_registration_test.go +++ b/server/api/v1/test/user_service_registration_test.go @@ -11,7 +11,7 @@ import ( apiv1 "github.com/usememos/memos/proto/gen/api/v1" storepb "github.com/usememos/memos/proto/gen/store" - apiv1server "github.com/usememos/memos/server/router/api/v1" + apiv1server "github.com/usememos/memos/server/api/v1" "github.com/usememos/memos/store" ) diff --git a/server/router/api/v1/test/user_service_stats_test.go b/server/api/v1/test/user_service_stats_test.go similarity index 100% rename from server/router/api/v1/test/user_service_stats_test.go rename to server/api/v1/test/user_service_stats_test.go diff --git a/server/router/api/v1/test/user_service_unique_email_test.go b/server/api/v1/test/user_service_unique_email_test.go similarity index 100% rename from server/router/api/v1/test/user_service_unique_email_test.go rename to server/api/v1/test/user_service_unique_email_test.go diff --git a/server/router/api/v1/test/user_setting_test.go b/server/api/v1/test/user_setting_test.go similarity index 99% rename from server/router/api/v1/test/user_setting_test.go rename to server/api/v1/test/user_setting_test.go index b2761e9a8..b948311cc 100644 --- a/server/router/api/v1/test/user_setting_test.go +++ b/server/api/v1/test/user_setting_test.go @@ -10,7 +10,7 @@ import ( apiv1 "github.com/usememos/memos/proto/gen/api/v1" storepb "github.com/usememos/memos/proto/gen/store" - apiv1server "github.com/usememos/memos/server/router/api/v1" + apiv1server "github.com/usememos/memos/server/api/v1" ) func TestListUserSettingsOmitsInternalStoreSettings(t *testing.T) { diff --git a/server/router/api/v1/user_resource_name.go b/server/api/v1/user_resource_name.go similarity index 92% rename from server/router/api/v1/user_resource_name.go rename to server/api/v1/user_resource_name.go index f8fe4fc39..55a406e65 100644 --- a/server/router/api/v1/user_resource_name.go +++ b/server/api/v1/user_resource_name.go @@ -5,7 +5,7 @@ import ( "github.com/pkg/errors" - "github.com/usememos/memos/internal/base" + "github.com/usememos/memos/internal/identifier" "github.com/usememos/memos/store" ) @@ -27,7 +27,7 @@ func parseUsernameFromName(name string) (string, error) { } func validateWritableUsername(username string) error { - if !base.IsValidUsername(username) { + if !identifier.IsValidUsername(username) { return errors.Errorf("invalid username %q", username) } return nil diff --git a/server/router/api/v1/user_resource_name_test.go b/server/api/v1/user_resource_name_test.go similarity index 100% rename from server/router/api/v1/user_resource_name_test.go rename to server/api/v1/user_resource_name_test.go diff --git a/server/router/api/v1/user_service.go b/server/api/v1/user_service.go similarity index 99% rename from server/router/api/v1/user_service.go rename to server/api/v1/user_service.go index 943fdce0e..5ae637415 100644 --- a/server/router/api/v1/user_service.go +++ b/server/api/v1/user_service.go @@ -18,7 +18,6 @@ import ( "github.com/usememos/memos/internal/clientip" "github.com/usememos/memos/internal/ratelimit" - "github.com/usememos/memos/internal/util" v1pb "github.com/usememos/memos/proto/gen/api/v1" "github.com/usememos/memos/store" ) @@ -199,7 +198,7 @@ func (s *APIV1Service) CreateUser(ctx context.Context, request *v1pb.CreateUserR if err := validatePassword(request.User.Password); err != nil { return nil, status.Errorf(codes.InvalidArgument, "%v", err) } - email, err := util.NormalizeEmail(request.User.Email) + email, err := store.NormalizeEmail(request.User.Email) if err != nil { return nil, status.Errorf(codes.InvalidArgument, "%v", err) } @@ -376,7 +375,7 @@ func (s *APIV1Service) UpdateUser(ctx context.Context, request *v1pb.UpdateUserR } update.Nickname = &request.User.DisplayName case "email": - email, err := util.NormalizeEmail(request.User.Email) + email, err := store.NormalizeEmail(request.User.Email) if err != nil { return nil, status.Errorf(codes.InvalidArgument, "%v", err) } diff --git a/server/router/api/v1/user_service_access_tokens.go b/server/api/v1/user_service_access_tokens.go similarity index 98% rename from server/router/api/v1/user_service_access_tokens.go rename to server/api/v1/user_service_access_tokens.go index ceb7bf0b1..3cb8735cd 100644 --- a/server/router/api/v1/user_service_access_tokens.go +++ b/server/api/v1/user_service_access_tokens.go @@ -11,7 +11,7 @@ import ( "google.golang.org/protobuf/types/known/emptypb" "google.golang.org/protobuf/types/known/timestamppb" - "github.com/usememos/memos/internal/util" + "github.com/usememos/memos/internal/random" v1pb "github.com/usememos/memos/proto/gen/api/v1" storepb "github.com/usememos/memos/proto/gen/store" "github.com/usememos/memos/server/auth" @@ -81,7 +81,7 @@ func (s *APIV1Service) CreatePersonalAccessToken(ctx context.Context, request *v } // Generate PAT - tokenID := util.GenUUID() + tokenID := random.UUID() token := auth.GeneratePersonalAccessToken() tokenHash := auth.HashPersonalAccessToken(token) diff --git a/server/router/api/v1/user_service_converters.go b/server/api/v1/user_service_converters.go similarity index 100% rename from server/router/api/v1/user_service_converters.go rename to server/api/v1/user_service_converters.go diff --git a/server/router/api/v1/user_service_filter.go b/server/api/v1/user_service_filter.go similarity index 100% rename from server/router/api/v1/user_service_filter.go rename to server/api/v1/user_service_filter.go diff --git a/server/router/api/v1/user_service_identities.go b/server/api/v1/user_service_identities.go similarity index 100% rename from server/router/api/v1/user_service_identities.go rename to server/api/v1/user_service_identities.go diff --git a/server/router/api/v1/user_service_memo_views.go b/server/api/v1/user_service_memo_views.go similarity index 98% rename from server/router/api/v1/user_service_memo_views.go rename to server/api/v1/user_service_memo_views.go index 88bb609a5..680bfb49f 100644 --- a/server/router/api/v1/user_service_memo_views.go +++ b/server/api/v1/user_service_memo_views.go @@ -10,9 +10,9 @@ import ( "google.golang.org/grpc/status" "google.golang.org/protobuf/types/known/emptypb" - "github.com/usememos/memos/internal/filter" + "github.com/usememos/memos/filter" + "github.com/usememos/memos/internal/random" "github.com/usememos/memos/internal/ratelimit" - "github.com/usememos/memos/internal/util" v1pb "github.com/usememos/memos/proto/gen/api/v1" storepb "github.com/usememos/memos/proto/gen/store" "github.com/usememos/memos/server/auth" @@ -141,7 +141,7 @@ func (s *APIV1Service) CreateMemoView(ctx context.Context, request *v1pb.CreateM } newMemoView := &storepb.MemoViewsUserSetting_MemoView{ - Id: util.GenUUID(), + Id: random.UUID(), Title: request.GetMemoView().GetTitle(), Filter: request.GetMemoView().GetFilter(), Icon: convertMemoViewIconToStore(request.GetMemoView().GetIcon()), diff --git a/server/router/api/v1/user_service_notifications.go b/server/api/v1/user_service_notifications.go similarity index 99% rename from server/router/api/v1/user_service_notifications.go rename to server/api/v1/user_service_notifications.go index 6c6c13075..c35675993 100644 --- a/server/router/api/v1/user_service_notifications.go +++ b/server/api/v1/user_service_notifications.go @@ -12,9 +12,9 @@ import ( "google.golang.org/protobuf/types/known/emptypb" "google.golang.org/protobuf/types/known/timestamppb" + "github.com/usememos/memos/core/access" v1pb "github.com/usememos/memos/proto/gen/api/v1" storepb "github.com/usememos/memos/proto/gen/store" - "github.com/usememos/memos/server/access" "github.com/usememos/memos/store" ) diff --git a/server/router/api/v1/user_service_settings.go b/server/api/v1/user_service_settings.go similarity index 100% rename from server/router/api/v1/user_service_settings.go rename to server/api/v1/user_service_settings.go diff --git a/server/router/api/v1/user_service_stats.go b/server/api/v1/user_service_stats.go similarity index 100% rename from server/router/api/v1/user_service_stats.go rename to server/api/v1/user_service_stats.go diff --git a/server/router/api/v1/user_service_webhooks.go b/server/api/v1/user_service_webhooks.go similarity index 100% rename from server/router/api/v1/user_service_webhooks.go rename to server/api/v1/user_service_webhooks.go diff --git a/server/router/api/v1/user_webhook_test.go b/server/api/v1/user_webhook_test.go similarity index 100% rename from server/router/api/v1/user_webhook_test.go rename to server/api/v1/user_webhook_test.go diff --git a/server/router/api/v1/v1.go b/server/api/v1/v1.go similarity index 98% rename from server/router/api/v1/v1.go rename to server/api/v1/v1.go index ea6c7c8f8..75b7d9e9a 100644 --- a/server/router/api/v1/v1.go +++ b/server/api/v1/v1.go @@ -14,13 +14,13 @@ import ( "github.com/pkg/errors" "golang.org/x/sync/semaphore" - "github.com/usememos/memos/internal/httpgetter" - "github.com/usememos/memos/internal/markdown" + "github.com/usememos/memos/core/notification" + "github.com/usememos/memos/internal/linkmeta" "github.com/usememos/memos/internal/profile" "github.com/usememos/memos/internal/ratelimit" + "github.com/usememos/memos/markdown" v1pb "github.com/usememos/memos/proto/gen/api/v1" "github.com/usememos/memos/server/auth" - "github.com/usememos/memos/server/notification" "github.com/usememos/memos/store" ) @@ -92,7 +92,7 @@ func NewAPIV1Service(secret string, profile *profile.Profile, store *store.Store thumbnailSemaphore: semaphore.NewWeighted(3), // Limit to 3 concurrent thumbnail generations imageProcessingSemaphore: semaphore.NewWeighted(2), } - service.linkMetadataFetcher = httpgetter.NewHTMLMetaFetcher() + service.linkMetadataFetcher = linkmeta.NewHTMLMetaFetcher() return service } diff --git a/server/auth/authenticator.go b/server/auth/authenticator.go index c3208b188..f8a4afd44 100644 --- a/server/auth/authenticator.go +++ b/server/auth/authenticator.go @@ -3,13 +3,13 @@ package auth import ( "context" "log/slog" + "strconv" "strings" "time" "github.com/pkg/errors" "google.golang.org/protobuf/types/known/timestamppb" - "github.com/usememos/memos/internal/util" storepb "github.com/usememos/memos/proto/gen/store" "github.com/usememos/memos/store" ) @@ -44,7 +44,7 @@ func (a *Authenticator) AuthenticateByAccessTokenV2(accessToken string) (*UserCl return nil, errors.Wrap(err, "invalid access token") } - userID, err := util.ConvertStringToInt32(claims.Subject) + userID, err := parseInt32(claims.Subject) if err != nil { return nil, errors.Wrap(err, "invalid user ID in token") } @@ -64,7 +64,7 @@ func (a *Authenticator) AuthenticateByRefreshToken(ctx context.Context, refreshT return nil, "", errors.Wrap(err, "invalid refresh token") } - userID, err := util.ConvertStringToInt32(claims.Subject) + userID, err := parseInt32(claims.Subject) if err != nil { return nil, "", errors.Wrap(err, "invalid user ID in token") } @@ -223,3 +223,11 @@ func (a *Authenticator) Authenticate(ctx context.Context, authHeader string) *Au } return &AuthResult{Claims: bearer.claims, AccessToken: token} } + +func parseInt32(src string) (int32, error) { + parsed, err := strconv.ParseInt(src, 10, 32) + if err != nil { + return 0, err + } + return int32(parsed), nil +} diff --git a/server/auth/token.go b/server/auth/token.go index 0cfc71136..4a4cb8345 100644 --- a/server/auth/token.go +++ b/server/auth/token.go @@ -1,8 +1,8 @@ // Package auth provides authentication and authorization for the Memos server. // // This package is used by: -// - server/router/api/v1: gRPC and Connect API interceptors -// - server/router/fileserver: HTTP file server authentication +// - server/api/v1: gRPC and Connect API interceptors +// - server/fileserver: HTTP file server authentication // // Authentication methods supported: // - JWT access tokens: Short-lived tokens (15 minutes) for API access @@ -19,7 +19,7 @@ import ( "github.com/golang-jwt/jwt/v5" "github.com/pkg/errors" - "github.com/usememos/memos/internal/util" + "github.com/usememos/memos/internal/random" ) const ( @@ -184,10 +184,10 @@ func GenerateRefreshToken(userID int32, tokenID string, secret []byte) (string, // GeneratePersonalAccessToken generates a random PAT string. func GeneratePersonalAccessToken() string { - randomStr, err := util.RandomString(32) + randomStr, err := random.String(32) if err != nil { // Fallback to UUID if RandomString fails - return PersonalAccessTokenPrefix + util.GenUUID() + return PersonalAccessTokenPrefix + random.UUID() } return PersonalAccessTokenPrefix + randomStr } diff --git a/server/doc.go b/server/doc.go new file mode 100644 index 000000000..c673d616c --- /dev/null +++ b/server/doc.go @@ -0,0 +1,7 @@ +// Package server is the HTTP process: it boots the Echo server, mounts every +// transport (server/api/v1, server/fileserver, server/frontend, server/mcp), +// and owns HTTP-only concerns such as auth tokens and process configuration. +// +// Layering: server may import core, store, provider, markdown, filter, and +// internal. Nothing imports server except cmd. +package server diff --git a/server/router/fileserver/README.md b/server/fileserver/README.md similarity index 85% rename from server/router/fileserver/README.md rename to server/fileserver/README.md index 09b169811..5a6479cd0 100644 --- a/server/router/fileserver/README.md +++ b/server/fileserver/README.md @@ -14,11 +14,11 @@ GET /file/users/:identifier/avatar # user avatar (by username) ## Authentication -Handled by `server/auth` (see [authenticator.go](../../auth/authenticator.go) and [token.go](../../auth/token.go) for the constants and token formats). Priority: `Authorization: Bearer` header (access token or personal access token) first, then the refresh token cookie. See `getCurrentUser` in [fileserver.go](fileserver.go). +Handled by `server/auth` (see [authenticator.go](../auth/authenticator.go) and [token.go](../auth/token.go) for the constants and token formats). Priority: `Authorization: Bearer` header (access token or personal access token) first, then the refresh token cookie. See `getCurrentUser` in [fileserver.go](fileserver.go). ## Authorization -Attachment access follows memo visibility, evaluated by `server/access.CheckMemoRead`: +Attachment access follows memo visibility, evaluated by `core/access.CheckMemoReadContext`: - Public memo: no auth required (when the instance allows anonymous access) - Protected memo: any authenticated user diff --git a/server/router/fileserver/fileserver.go b/server/fileserver/fileserver.go similarity index 99% rename from server/router/fileserver/fileserver.go rename to server/fileserver/fileserver.go index da3e8c183..263ad634d 100644 --- a/server/router/fileserver/fileserver.go +++ b/server/fileserver/fileserver.go @@ -20,11 +20,11 @@ import ( "github.com/pkg/errors" "golang.org/x/sync/semaphore" + "github.com/usememos/memos/core/access" "github.com/usememos/memos/internal/motionphoto" "github.com/usememos/memos/internal/profile" - "github.com/usememos/memos/internal/storage" storepb "github.com/usememos/memos/proto/gen/store" - "github.com/usememos/memos/server/access" + "github.com/usememos/memos/provider/storage" "github.com/usememos/memos/server/auth" "github.com/usememos/memos/store" ) diff --git a/server/router/fileserver/fileserver_test.go b/server/fileserver/fileserver_test.go similarity index 99% rename from server/router/fileserver/fileserver_test.go rename to server/fileserver/fileserver_test.go index d632d30b2..0a04867ff 100644 --- a/server/router/fileserver/fileserver_test.go +++ b/server/fileserver/fileserver_test.go @@ -21,15 +21,15 @@ import ( "google.golang.org/protobuf/types/known/fieldmaskpb" "google.golang.org/protobuf/types/known/timestamppb" - "github.com/usememos/memos/internal/markdown" "github.com/usememos/memos/internal/profile" + "github.com/usememos/memos/internal/random" "github.com/usememos/memos/internal/testutil" "github.com/usememos/memos/internal/testutil/fakes3" - "github.com/usememos/memos/internal/util" + "github.com/usememos/memos/markdown" apiv1 "github.com/usememos/memos/proto/gen/api/v1" storepb "github.com/usememos/memos/proto/gen/store" + apiv1service "github.com/usememos/memos/server/api/v1" "github.com/usememos/memos/server/auth" - apiv1service "github.com/usememos/memos/server/router/api/v1" "github.com/usememos/memos/store" teststore "github.com/usememos/memos/store/test" ) @@ -770,7 +770,7 @@ func TestServeUserAvatar_PrivateInstanceRequiresAuth(t *testing.T) { // An authenticated private-instance response must not be stored by shared // or browser caches. - tokenID := util.GenUUID() + tokenID := random.UUID() require.NoError(t, stores.AddUserRefreshToken(ctx, owner.ID, &storepb.RefreshTokensUserSetting_RefreshToken{ TokenId: tokenID, ExpiresAt: timestamppb.New(time.Now().Add(auth.RefreshTokenDuration)), @@ -822,7 +822,7 @@ func TestServeAttachmentFile_RefreshCookieAuthenticatesOwner(t *testing.T) { require.NoError(t, err) // Mint a valid refresh token for the owner and store its record. - tokenID := util.GenUUID() + tokenID := random.UUID() require.NoError(t, svc.Store.AddUserRefreshToken(ctx, owner.ID, &storepb.RefreshTokensUserSetting_RefreshToken{ TokenId: tokenID, ExpiresAt: timestamppb.New(time.Now().Add(auth.RefreshTokenDuration)), @@ -851,7 +851,7 @@ func TestServeAttachmentFile_RefreshCookieAuthenticatesOwner(t *testing.T) { func newExpiredRefreshTokenCookie(ctx context.Context, t *testing.T, stores *store.Store, userID int32, secret string) *http.Cookie { t.Helper() - tokenID := util.GenUUID() + tokenID := random.UUID() require.NoError(t, stores.AddUserRefreshToken(ctx, userID, &storepb.RefreshTokensUserSetting_RefreshToken{ TokenId: tokenID, ExpiresAt: timestamppb.New(time.Now().Add(-time.Hour)), diff --git a/server/router/frontend/dist/index.html b/server/frontend/dist/index.html similarity index 100% rename from server/router/frontend/dist/index.html rename to server/frontend/dist/index.html diff --git a/server/router/frontend/frontend.go b/server/frontend/frontend.go similarity index 100% rename from server/router/frontend/frontend.go rename to server/frontend/frontend.go diff --git a/server/router/frontend/frontend_test.go b/server/frontend/frontend_test.go similarity index 100% rename from server/router/frontend/frontend_test.go rename to server/frontend/frontend_test.go diff --git a/server/router/mcp/README.md b/server/mcp/README.md similarity index 99% rename from server/router/mcp/README.md rename to server/mcp/README.md index 9ea1c6a48..e697b113a 100644 --- a/server/router/mcp/README.md +++ b/server/mcp/README.md @@ -215,7 +215,7 @@ own encoding is part of the tool contract: whatever it emits is validated agains the output schema resolved from the same OpenAPI spec. grpc-gateway's stock marshaler emits `null` for unset message fields, which no schema declares as nullable — `RegisterGateway` therefore installs a marshaler that omits them -(`newGatewayMarshaler` in `server/router/api/v1/v1.go`). That fixes +(`newGatewayMarshaler` in `server/api/v1/v1.go`). That fixes [#6139](https://github.com/usememos/memos/issues/6139), where `"motionMedia": null` failed every tool call returning an attachment. @@ -266,7 +266,7 @@ proto definitions and regenerate. ## Testing ```bash -go test ./server/router/mcp/... +go test ./server/mcp/... ``` - `openapi_test.go` — spec parsing, registry building, `$ref` resolution. diff --git a/server/router/mcp/adapter.go b/server/mcp/adapter.go similarity index 100% rename from server/router/mcp/adapter.go rename to server/mcp/adapter.go diff --git a/server/router/mcp/adapter_test.go b/server/mcp/adapter_test.go similarity index 100% rename from server/router/mcp/adapter_test.go rename to server/mcp/adapter_test.go diff --git a/server/router/mcp/catalog.go b/server/mcp/catalog.go similarity index 100% rename from server/router/mcp/catalog.go rename to server/mcp/catalog.go diff --git a/server/router/mcp/catalog_test.go b/server/mcp/catalog_test.go similarity index 95% rename from server/router/mcp/catalog_test.go rename to server/mcp/catalog_test.go index 03e48653e..d6a8b8dae 100644 --- a/server/router/mcp/catalog_test.go +++ b/server/mcp/catalog_test.go @@ -42,7 +42,7 @@ func TestToolNameFromOperationID(t *testing.T) { } func TestBuildToolFromOperationIncludesSchemasAndMetadata(t *testing.T) { - spec, err := loadOpenAPISpec("../../../proto/gen/openapi.yaml") + spec, err := loadOpenAPISpec("../../proto/gen/openapi.yaml") require.NoError(t, err) registry, err := buildOperationRegistry(spec) require.NoError(t, err) @@ -76,7 +76,7 @@ func TestBuildToolFromOperationIncludesSchemasAndMetadata(t *testing.T) { } func TestBuildToolFromOperationIncludesRequestBodySchema(t *testing.T) { - spec, err := loadOpenAPISpec("../../../proto/gen/openapi.yaml") + spec, err := loadOpenAPISpec("../../proto/gen/openapi.yaml") require.NoError(t, err) registry, err := buildOperationRegistry(spec) require.NoError(t, err) @@ -108,7 +108,7 @@ func TestBuildToolFromOperationIncludesRequestBodySchema(t *testing.T) { } func TestBuildToolFromOperationTailorsRequestBodySchemas(t *testing.T) { - spec, err := loadOpenAPISpec("../../../proto/gen/openapi.yaml") + spec, err := loadOpenAPISpec("../../proto/gen/openapi.yaml") require.NoError(t, err) registry, err := buildOperationRegistry(spec) require.NoError(t, err) @@ -187,7 +187,7 @@ func TestBuildToolFromOperationTailorsRequestBodySchemas(t *testing.T) { } func TestBuildToolFromOperationRejectsEmptyMemoUpdateBody(t *testing.T) { - spec, err := loadOpenAPISpec("../../../proto/gen/openapi.yaml") + spec, err := loadOpenAPISpec("../../proto/gen/openapi.yaml") require.NoError(t, err) registry, err := buildOperationRegistry(spec) require.NoError(t, err) @@ -234,7 +234,7 @@ func TestRequestBodySchemaOverridePreservesRequiredByDefault(t *testing.T) { } func TestBuildToolFromOperationExposesCreateAttachment(t *testing.T) { - spec, err := loadOpenAPISpec("../../../proto/gen/openapi.yaml") + spec, err := loadOpenAPISpec("../../proto/gen/openapi.yaml") require.NoError(t, err) registry, err := buildOperationRegistry(spec) require.NoError(t, err) @@ -270,7 +270,7 @@ func TestBuildToolFromOperationExposesCreateAttachment(t *testing.T) { } func TestBuildToolFromOperationExposesCurrentUser(t *testing.T) { - spec, err := loadOpenAPISpec("../../../proto/gen/openapi.yaml") + spec, err := loadOpenAPISpec("../../proto/gen/openapi.yaml") require.NoError(t, err) registry, err := buildOperationRegistry(spec) require.NoError(t, err) @@ -282,7 +282,7 @@ func TestBuildToolFromOperationExposesCurrentUser(t *testing.T) { } func TestBuildToolFromOperationExposesListMemoViews(t *testing.T) { - spec, err := loadOpenAPISpec("../../../proto/gen/openapi.yaml") + spec, err := loadOpenAPISpec("../../proto/gen/openapi.yaml") require.NoError(t, err) registry, err := buildOperationRegistry(spec) require.NoError(t, err) @@ -300,7 +300,7 @@ func TestBuildToolFromOperationExposesListMemoViews(t *testing.T) { } func TestBuildToolFromOperationMarksSetOperationsIdempotent(t *testing.T) { - spec, err := loadOpenAPISpec("../../../proto/gen/openapi.yaml") + spec, err := loadOpenAPISpec("../../proto/gen/openapi.yaml") require.NoError(t, err) registry, err := buildOperationRegistry(spec) require.NoError(t, err) @@ -317,7 +317,7 @@ func TestBuildToolFromOperationMarksSetOperationsIdempotent(t *testing.T) { } func TestBuildToolFromOperationMarksUpdateMemoDestructive(t *testing.T) { - spec, err := loadOpenAPISpec("../../../proto/gen/openapi.yaml") + spec, err := loadOpenAPISpec("../../proto/gen/openapi.yaml") require.NoError(t, err) registry, err := buildOperationRegistry(spec) require.NoError(t, err) @@ -330,7 +330,7 @@ func TestBuildToolFromOperationMarksUpdateMemoDestructive(t *testing.T) { } func TestBuildCuratedToolsHasUniqueNames(t *testing.T) { - spec, err := loadOpenAPISpec("../../../proto/gen/openapi.yaml") + spec, err := loadOpenAPISpec("../../proto/gen/openapi.yaml") require.NoError(t, err) registry, err := buildOperationRegistry(spec) require.NoError(t, err) @@ -364,7 +364,7 @@ func TestBuildCuratedToolsRejectsMissingOperation(t *testing.T) { } func TestValidateOperationOverridesRejectsStaleKey(t *testing.T) { - spec, err := loadOpenAPISpec("../../../proto/gen/openapi.yaml") + spec, err := loadOpenAPISpec("../../proto/gen/openapi.yaml") require.NoError(t, err) registry, err := buildOperationRegistry(spec) require.NoError(t, err) @@ -394,7 +394,7 @@ func TestBuildCuratedToolsRejectsDuplicateToolNames(t *testing.T) { } func TestBuildCuratedToolsUseStandardSchemaFormats(t *testing.T) { - spec, err := loadOpenAPISpec("../../../proto/gen/openapi.yaml") + spec, err := loadOpenAPISpec("../../proto/gen/openapi.yaml") require.NoError(t, err) registry, err := buildOperationRegistry(spec) require.NoError(t, err) diff --git a/server/router/mcp/evals/README.md b/server/mcp/evals/README.md similarity index 97% rename from server/router/mcp/evals/README.md rename to server/mcp/evals/README.md index 097f972a0..c4be9eab2 100644 --- a/server/router/mcp/evals/README.md +++ b/server/mcp/evals/README.md @@ -14,7 +14,7 @@ tool calls, and has a single string-comparable answer. ## Why a fresh seeded instance (not the public demo) Answers are pinned to the deterministic seed in -[`store/seed/sqlite/01__dump.sql`](../../../../store/seed/sqlite/01__dump.sql) +[`store/seed/sqlite/01__dump.sql`](../../../store/seed/sqlite/01__dump.sql) (10 memos — 7 top-level + 3 comments — 2 users, 12 reactions, no attachments, no memo views). diff --git a/server/router/mcp/evals/memos_eval.xml b/server/mcp/evals/memos_eval.xml similarity index 100% rename from server/router/mcp/evals/memos_eval.xml rename to server/mcp/evals/memos_eval.xml diff --git a/server/router/mcp/openapi.go b/server/mcp/openapi.go similarity index 100% rename from server/router/mcp/openapi.go rename to server/mcp/openapi.go diff --git a/server/router/mcp/openapi_test.go b/server/mcp/openapi_test.go similarity index 99% rename from server/router/mcp/openapi_test.go rename to server/mcp/openapi_test.go index 59424ce95..6f1d005d2 100644 --- a/server/router/mcp/openapi_test.go +++ b/server/mcp/openapi_test.go @@ -8,7 +8,7 @@ import ( ) func TestLoadOpenAPIOperationsIncludesCuratedIDs(t *testing.T) { - spec, err := loadOpenAPISpec("../../../proto/gen/openapi.yaml") + spec, err := loadOpenAPISpec("../../proto/gen/openapi.yaml") require.NoError(t, err) registry, err := buildOperationRegistry(spec) diff --git a/server/router/mcp/origin.go b/server/mcp/origin.go similarity index 100% rename from server/router/mcp/origin.go rename to server/mcp/origin.go diff --git a/server/router/mcp/result.go b/server/mcp/result.go similarity index 100% rename from server/router/mcp/result.go rename to server/mcp/result.go diff --git a/server/router/mcp/service.go b/server/mcp/service.go similarity index 99% rename from server/router/mcp/service.go rename to server/mcp/service.go index 6721ba97d..a1be93f5d 100644 --- a/server/router/mcp/service.go +++ b/server/mcp/service.go @@ -14,7 +14,7 @@ import ( "github.com/usememos/memos/internal/profile" memosproto "github.com/usememos/memos/proto" - apiv1 "github.com/usememos/memos/server/router/api/v1" + apiv1 "github.com/usememos/memos/server/api/v1" ) // maxMCPRequestBytes caps the /mcp request body. It tracks the API limit because diff --git a/server/router/mcp/service_test.go b/server/mcp/service_test.go similarity index 99% rename from server/router/mcp/service_test.go rename to server/mcp/service_test.go index 839eca118..e54f7483b 100644 --- a/server/router/mcp/service_test.go +++ b/server/mcp/service_test.go @@ -69,7 +69,7 @@ func TestNewMCPServiceUsesEmbeddedOpenAPISpec(t *testing.T) { } func TestEmbeddedOpenAPISpecMatchesGeneratedFile(t *testing.T) { - generated, err := os.ReadFile("../../../proto/gen/openapi.yaml") + generated, err := os.ReadFile("../../proto/gen/openapi.yaml") require.NoError(t, err) require.Equal(t, generated, memosproto.OpenAPIYAML()) } diff --git a/server/router/mcp/validation.go b/server/mcp/validation.go similarity index 100% rename from server/router/mcp/validation.go rename to server/mcp/validation.go diff --git a/server/router/mcp/validation_test.go b/server/mcp/validation_test.go similarity index 100% rename from server/router/mcp/validation_test.go rename to server/mcp/validation_test.go diff --git a/server/server.go b/server/server.go index 2850ab35b..531aea4c8 100644 --- a/server/server.go +++ b/server/server.go @@ -17,10 +17,10 @@ import ( "github.com/usememos/memos/internal/clientip" "github.com/usememos/memos/internal/profile" storepb "github.com/usememos/memos/proto/gen/store" - apiv1 "github.com/usememos/memos/server/router/api/v1" - "github.com/usememos/memos/server/router/fileserver" - "github.com/usememos/memos/server/router/frontend" - "github.com/usememos/memos/server/router/mcp" + apiv1 "github.com/usememos/memos/server/api/v1" + "github.com/usememos/memos/server/fileserver" + "github.com/usememos/memos/server/frontend" + "github.com/usememos/memos/server/mcp" "github.com/usememos/memos/store" ) diff --git a/server/test/startup_test.go b/server/test/startup_test.go index 493e658d1..a1cdd7d36 100644 --- a/server/test/startup_test.go +++ b/server/test/startup_test.go @@ -295,7 +295,7 @@ func TestStartupServesEveryRegisteredRouter(t *testing.T) { t.Run("mcp", func(t *testing.T) { // A bare POST is enough to prove the handler is mounted; the MCP - // protocol itself is covered by server/router/mcp tests. + // protocol itself is covered by server/mcp tests. status, _ := inst.do(t, http.MethodPost, "/mcp", "", map[string]any{ "jsonrpc": "2.0", "id": 1, diff --git a/store/attachment.go b/store/attachment.go index 182137539..d70071e20 100644 --- a/store/attachment.go +++ b/store/attachment.go @@ -8,9 +8,9 @@ import ( "github.com/pkg/errors" - "github.com/usememos/memos/internal/base" - "github.com/usememos/memos/internal/storage" + "github.com/usememos/memos/internal/identifier" storepb "github.com/usememos/memos/proto/gen/store" + "github.com/usememos/memos/provider/storage" ) type Attachment struct { @@ -112,7 +112,7 @@ func WithCreateAttachmentPostCommitFailpoint(ctx context.Context) context.Contex } func (s *Store) CreateAttachment(ctx context.Context, create *Attachment) (*Attachment, error) { - if !base.UIDMatcher.MatchString(create.UID) { + if !identifier.UIDMatcher.MatchString(create.UID) { return nil, errors.New("invalid uid") } if err := validateMemoWritePolicy(create.Policy); err != nil { @@ -175,7 +175,7 @@ func (s *Store) GetAttachment(ctx context.Context, find *FindAttachment) (*Attac } func (s *Store) UpdateAttachment(ctx context.Context, update *UpdateAttachment) error { - if update.UID != nil && !base.UIDMatcher.MatchString(*update.UID) { + if update.UID != nil && !identifier.UIDMatcher.MatchString(*update.UID) { return errors.New("invalid uid") } if err := validateMemoWritePolicy(update.Policy); err != nil { diff --git a/store/custom_icon.go b/store/custom_icon.go index 246613053..ee814ffe4 100644 --- a/store/custom_icon.go +++ b/store/custom_icon.go @@ -5,7 +5,7 @@ import ( "github.com/pkg/errors" - "github.com/usememos/memos/internal/markdown/parser" + "github.com/usememos/memos/markdown/parser" ) func validateEmojiIcon(emoji string) error { diff --git a/store/db/mysql/attachment.go b/store/db/mysql/attachment.go index 269f5b076..d8f1c09d0 100644 --- a/store/db/mysql/attachment.go +++ b/store/db/mysql/attachment.go @@ -9,7 +9,7 @@ import ( "github.com/pkg/errors" "google.golang.org/protobuf/encoding/protojson" - "github.com/usememos/memos/internal/filter" + "github.com/usememos/memos/filter" storepb "github.com/usememos/memos/proto/gen/store" "github.com/usememos/memos/store" ) diff --git a/store/db/mysql/memo.go b/store/db/mysql/memo.go index 0cec68581..5ed3d007d 100644 --- a/store/db/mysql/memo.go +++ b/store/db/mysql/memo.go @@ -9,7 +9,7 @@ import ( "github.com/pkg/errors" "google.golang.org/protobuf/encoding/protojson" - "github.com/usememos/memos/internal/filter" + "github.com/usememos/memos/filter" storepb "github.com/usememos/memos/proto/gen/store" "github.com/usememos/memos/store" ) diff --git a/store/db/mysql/memo_relation.go b/store/db/mysql/memo_relation.go index 81bb4f724..a35c68050 100644 --- a/store/db/mysql/memo_relation.go +++ b/store/db/mysql/memo_relation.go @@ -5,7 +5,7 @@ import ( "fmt" "strings" - "github.com/usememos/memos/internal/filter" + "github.com/usememos/memos/filter" "github.com/usememos/memos/store" ) diff --git a/store/db/postgres/attachment.go b/store/db/postgres/attachment.go index 9c549fe9a..330dfb305 100644 --- a/store/db/postgres/attachment.go +++ b/store/db/postgres/attachment.go @@ -9,7 +9,7 @@ import ( "github.com/pkg/errors" "google.golang.org/protobuf/encoding/protojson" - "github.com/usememos/memos/internal/filter" + "github.com/usememos/memos/filter" storepb "github.com/usememos/memos/proto/gen/store" "github.com/usememos/memos/store" ) diff --git a/store/db/postgres/memo.go b/store/db/postgres/memo.go index 550479b9b..a35f85ff4 100644 --- a/store/db/postgres/memo.go +++ b/store/db/postgres/memo.go @@ -9,7 +9,7 @@ import ( "github.com/pkg/errors" "google.golang.org/protobuf/encoding/protojson" - "github.com/usememos/memos/internal/filter" + "github.com/usememos/memos/filter" storepb "github.com/usememos/memos/proto/gen/store" "github.com/usememos/memos/store" ) diff --git a/store/db/postgres/memo_relation.go b/store/db/postgres/memo_relation.go index 6cff5cacb..3d63257a8 100644 --- a/store/db/postgres/memo_relation.go +++ b/store/db/postgres/memo_relation.go @@ -5,7 +5,7 @@ import ( "fmt" "strings" - "github.com/usememos/memos/internal/filter" + "github.com/usememos/memos/filter" "github.com/usememos/memos/store" ) diff --git a/store/db/sqlite/attachment.go b/store/db/sqlite/attachment.go index 9c92cb5cb..0cb7b2f98 100644 --- a/store/db/sqlite/attachment.go +++ b/store/db/sqlite/attachment.go @@ -9,7 +9,7 @@ import ( "github.com/pkg/errors" "google.golang.org/protobuf/encoding/protojson" - "github.com/usememos/memos/internal/filter" + "github.com/usememos/memos/filter" storepb "github.com/usememos/memos/proto/gen/store" "github.com/usememos/memos/store" ) diff --git a/store/db/sqlite/memo.go b/store/db/sqlite/memo.go index 3a27087ad..dc00bed3d 100644 --- a/store/db/sqlite/memo.go +++ b/store/db/sqlite/memo.go @@ -9,7 +9,7 @@ import ( "github.com/pkg/errors" "google.golang.org/protobuf/encoding/protojson" - "github.com/usememos/memos/internal/filter" + "github.com/usememos/memos/filter" storepb "github.com/usememos/memos/proto/gen/store" "github.com/usememos/memos/store" ) diff --git a/store/db/sqlite/memo_relation.go b/store/db/sqlite/memo_relation.go index fa251df95..56287c355 100644 --- a/store/db/sqlite/memo_relation.go +++ b/store/db/sqlite/memo_relation.go @@ -5,7 +5,7 @@ import ( "fmt" "strings" - "github.com/usememos/memos/internal/filter" + "github.com/usememos/memos/filter" "github.com/usememos/memos/store" ) diff --git a/store/deployment_config.go b/store/deployment_config.go index 4bc1f2bdd..0e25b3f86 100644 --- a/store/deployment_config.go +++ b/store/deployment_config.go @@ -15,7 +15,7 @@ import ( "google.golang.org/protobuf/encoding/protojson" "google.golang.org/protobuf/proto" - "github.com/usememos/memos/internal/base" + "github.com/usememos/memos/internal/identifier" storepb "github.com/usememos/memos/proto/gen/store" ) @@ -159,7 +159,7 @@ func validateDeploymentIdentityProvider(provider *storepb.IdentityProvider) erro if provider.Id != 0 { return errors.New("id must be omitted") } - if !base.UIDMatcher.MatchString(provider.Uid) { + if !identifier.UIDMatcher.MatchString(provider.Uid) { return errors.New("uid is invalid") } if strings.TrimSpace(provider.Name) == "" { diff --git a/store/doc.go b/store/doc.go new file mode 100644 index 000000000..616e17898 --- /dev/null +++ b/store/doc.go @@ -0,0 +1,8 @@ +// Package store is the persistence layer: the Store facade, the Driver +// interface implemented by store/db/{sqlite,mysql,postgres}, migrations, seed +// data, and the in-memory cache. +// +// Layering: store may import provider, markdown, filter, proto/gen, and +// internal. It must not import core or server; business rules that need +// several store calls live in core. +package store diff --git a/store/email.go b/store/email.go new file mode 100644 index 000000000..156e1aa36 --- /dev/null +++ b/store/email.go @@ -0,0 +1,40 @@ +package store + +import ( + "net/mail" + "strings" + + "github.com/pkg/errors" +) + +// maxEmailLength is the longest address accepted for storage. RFC 5321 caps a +// forward path at 256 octets including the angle brackets, so 254 is the +// widely used practical limit. +const maxEmailLength = 254 + +// NormalizeEmail validates an email address and returns its canonical stored +// form: surrounding whitespace removed and every character lowercased. An +// empty input (after trimming) is valid and returns "", meaning no address. +// +// Display-name forms such as "Alice " are rejected even +// though the mail parser accepts them, because the stored value must be the +// bare address. The local part is lowercased along with the domain: every +// mainstream provider treats it case-insensitively, and folding both halves +// is what makes the instance-wide uniqueness rule match what users expect. +func NormalizeEmail(email string) (string, error) { + email = strings.TrimSpace(email) + if email == "" { + return "", nil + } + if len(email) > maxEmailLength { + return "", errors.Errorf("email must be at most %d characters", maxEmailLength) + } + address, err := mail.ParseAddress(email) + if err != nil { + return "", errors.New("email is not a valid address") + } + if address.Address != email { + return "", errors.New("email must be a bare address without a display name") + } + return strings.ToLower(email), nil +} diff --git a/internal/util/util_test.go b/store/email_test.go similarity index 94% rename from internal/util/util_test.go rename to store/email_test.go index 08de814d2..c73d68513 100644 --- a/internal/util/util_test.go +++ b/store/email_test.go @@ -1,4 +1,4 @@ -package util //nolint:revive // util is an appropriate package name for utility functions +package store import ( "strings" diff --git a/store/memo.go b/store/memo.go index 052b83780..96ddfa5c9 100644 --- a/store/memo.go +++ b/store/memo.go @@ -5,7 +5,7 @@ import ( "database/sql" "errors" - "github.com/usememos/memos/internal/base" + "github.com/usememos/memos/internal/identifier" storepb "github.com/usememos/memos/proto/gen/store" ) @@ -194,7 +194,7 @@ func validateMemoCreate(create *Memo) error { if create == nil { return errors.New("memo is required") } - if !base.UIDMatcher.MatchString(create.UID) { + if !identifier.UIDMatcher.MatchString(create.UID) { return errors.New("invalid uid") } if !isValidVisibility(create.Visibility) { @@ -224,7 +224,7 @@ func (s *Store) GetMemo(ctx context.Context, find *FindMemo) (*Memo, error) { } func (s *Store) UpdateMemo(ctx context.Context, update *UpdateMemo) error { - if update.UID != nil && !base.UIDMatcher.MatchString(*update.UID) { + if update.UID != nil && !identifier.UIDMatcher.MatchString(*update.UID) { return errors.New("invalid uid") } if update.Visibility != nil && !isValidVisibility(*update.Visibility) { diff --git a/store/migrator_email.go b/store/migrator_email.go index 282c60244..be6c939b7 100644 --- a/store/migrator_email.go +++ b/store/migrator_email.go @@ -15,7 +15,7 @@ const uniqueEmailSchemaVersion = "0.31.8" // two things the SQL file cannot do on its own. // // First, it rewrites every stored address into the canonical form used by -// util.NormalizeEmail: trimmed and lowercased with Unicode rules. SQLite's +// store.NormalizeEmail: trimmed and lowercased with Unicode rules. SQLite's // LOWER folds ASCII only, and PostgreSQL does the same under a C locale, so // without this pass "Ä@example.com" and "ä@example.com" could both survive // the migration's deduplication and the unique index would then permit a diff --git a/store/space.go b/store/space.go index c509251d5..6e06cbca3 100644 --- a/store/space.go +++ b/store/space.go @@ -5,7 +5,7 @@ import ( "errors" "strings" - "github.com/usememos/memos/internal/base" + "github.com/usememos/memos/internal/identifier" storepb "github.com/usememos/memos/proto/gen/store" ) @@ -178,7 +178,7 @@ func (s *Store) CreateSpace(ctx context.Context, create *Space, creatorID int32) if create == nil { return nil, errors.New("space is required") } - if !base.UIDMatcher.MatchString(create.UID) { + if !identifier.UIDMatcher.MatchString(create.UID) { return nil, errors.New("invalid uid") } if strings.TrimSpace(create.Title) == "" { diff --git a/store/storage.go b/store/storage.go index 27cade3ed..0a643c1c5 100644 --- a/store/storage.go +++ b/store/storage.go @@ -9,8 +9,8 @@ import ( "github.com/pkg/errors" "google.golang.org/protobuf/proto" - "github.com/usememos/memos/internal/storage" storepb "github.com/usememos/memos/proto/gen/store" + "github.com/usememos/memos/provider/storage" ) const ( diff --git a/store/storage_test.go b/store/storage_test.go index ee781c6a0..09cf4df96 100644 --- a/store/storage_test.go +++ b/store/storage_test.go @@ -7,8 +7,8 @@ import ( "github.com/stretchr/testify/require" "google.golang.org/protobuf/proto" - "github.com/usememos/memos/internal/storage/s3" storepb "github.com/usememos/memos/proto/gen/store" + "github.com/usememos/memos/provider/storage/s3" "github.com/usememos/memos/store" ) diff --git a/store/store.go b/store/store.go index 7649b66de..03260eab3 100644 --- a/store/store.go +++ b/store/store.go @@ -5,8 +5,8 @@ import ( "time" "github.com/usememos/memos/internal/profile" - "github.com/usememos/memos/internal/storage" storepb "github.com/usememos/memos/proto/gen/store" + "github.com/usememos/memos/provider/storage" "github.com/usememos/memos/store/cache" ) diff --git a/store/user.go b/store/user.go index e6261311f..5f8bc008f 100644 --- a/store/user.go +++ b/store/user.go @@ -7,8 +7,6 @@ import ( "strings" "github.com/pkg/errors" - - "github.com/usememos/memos/internal/util" ) // ErrUserHasSpaceMembership blocks account deletion until its Space lifecycle @@ -101,7 +99,7 @@ func userCacheKey(userID int32) string { // The API layer validates first; this is the store's own guard so that seed // data, tests, and any future caller cannot bypass the canonical form. func normalizeUserEmail(email string) (string, error) { - normalized, err := util.NormalizeEmail(email) + normalized, err := NormalizeEmail(email) if err != nil { return "", errors.Wrap(err, "invalid email") } diff --git a/web/package.json b/web/package.json index 07d418026..d46c713a1 100644 --- a/web/package.json +++ b/web/package.json @@ -8,7 +8,7 @@ "scripts": { "dev": "vite", "build": "vite build", - "release": "vite build --mode release --outDir=../server/router/frontend/dist --emptyOutDir", + "release": "vite build --mode release --outDir=../server/frontend/dist --emptyOutDir", "lint": "tsc --noEmit --skipLibCheck && biome check src tests", "lint:fix": "biome check --write src tests", "format": "biome format --write src tests", diff --git a/web/src/utils/managed-attachment.ts b/web/src/utils/managed-attachment.ts index 336264f68..195e9a094 100644 --- a/web/src/utils/managed-attachment.ts +++ b/web/src/utils/managed-attachment.ts @@ -25,7 +25,7 @@ interface ManagedImageIndex { } /** - * Mirrors the server's three-way classification in `internal/markdown`: a URL is + * Mirrors the server's three-way classification in `markdown`: a URL is * either none of our business, a managed reference, or a managed reference the * API refuses. Collapsing the last two would leave the editor unable to warn * about content that cannot be saved. diff --git a/web/tests/tag-unicode-parity.test.ts b/web/tests/tag-unicode-parity.test.ts index c4ee6bd77..abf96fb75 100644 --- a/web/tests/tag-unicode-parity.test.ts +++ b/web/tests/tag-unicode-parity.test.ts @@ -7,7 +7,7 @@ const DIGEST_PATTERN = /Unicode data SHA-256: ([0-9a-f]{64})/; describe("tag Unicode data", () => { it("keeps the Go and TypeScript generated tables in sync", async () => { const [goSource, typeScriptSource] = await Promise.all([ - readFile(resolve(process.cwd(), "../internal/markdown/parser/tag_unicode_tables.go"), "utf8"), + readFile(resolve(process.cwd(), "../markdown/parser/tag_unicode_tables.go"), "utf8"), readFile(resolve(process.cwd(), "src/utils/tag-unicode-data.ts"), "utf8"), ]);