From 20dd3e17f7a1ea5a90e4377dff62256e2456b638 Mon Sep 17 00:00:00 2001 From: Steven Date: Wed, 1 May 2024 10:28:32 +0800 Subject: [PATCH] chore: rename router package --- Dockerfile | 2 +- go.mod | 2 - go.sum | 5 - scripts/gen-api-v1-docs.cfg | 13 --- scripts/gen-api-v1-docs.ps1 | 73 ------------ scripts/gen-api-v1-docs.sh | 108 ------------------ server/route/frontend/dist/index.html | 11 -- server/{route => router}/api/v1/acl.go | 0 server/{route => router}/api/v1/acl_config.go | 0 .../api/v1/activity_service.go | 0 server/{route => router}/api/v1/auth.go | 0 .../{route => router}/api/v1/auth_service.go | 0 server/{route => router}/api/v1/common.go | 0 .../{route => router}/api/v1/idp_service.go | 0 .../{route => router}/api/v1/inbox_service.go | 0 .../api/v1/logger_interceptor.go | 0 .../api/v1/markdown_service.go | 0 .../api/v1/memo_relation_service.go | 0 .../api/v1/memo_resource_service.go | 0 .../{route => router}/api/v1/memo_service.go | 0 .../api/v1/reaction_service.go | 0 .../{route => router}/api/v1/resource_name.go | 0 .../api/v1/resource_service.go | 0 .../{route => router}/api/v1/tag_service.go | 0 .../{route => router}/api/v1/user_service.go | 0 server/{route => router}/api/v1/v1.go | 0 .../api/v1/webhook_service.go | 0 .../api/v1/workspace_service.go | 0 .../api/v1/workspace_setting_service.go | 0 server/{route => router}/frontend/frontend.go | 0 server/{route => router}/rss/rss.go | 0 server/server.go | 6 +- 32 files changed, 4 insertions(+), 216 deletions(-) delete mode 100644 scripts/gen-api-v1-docs.cfg delete mode 100644 scripts/gen-api-v1-docs.ps1 delete mode 100755 scripts/gen-api-v1-docs.sh delete mode 100644 server/route/frontend/dist/index.html rename server/{route => router}/api/v1/acl.go (100%) rename server/{route => router}/api/v1/acl_config.go (100%) rename server/{route => router}/api/v1/activity_service.go (100%) rename server/{route => router}/api/v1/auth.go (100%) rename server/{route => router}/api/v1/auth_service.go (100%) rename server/{route => router}/api/v1/common.go (100%) rename server/{route => router}/api/v1/idp_service.go (100%) rename server/{route => router}/api/v1/inbox_service.go (100%) rename server/{route => router}/api/v1/logger_interceptor.go (100%) rename server/{route => router}/api/v1/markdown_service.go (100%) rename server/{route => router}/api/v1/memo_relation_service.go (100%) rename server/{route => router}/api/v1/memo_resource_service.go (100%) rename server/{route => router}/api/v1/memo_service.go (100%) rename server/{route => router}/api/v1/reaction_service.go (100%) rename server/{route => router}/api/v1/resource_name.go (100%) rename server/{route => router}/api/v1/resource_service.go (100%) rename server/{route => router}/api/v1/tag_service.go (100%) rename server/{route => router}/api/v1/user_service.go (100%) rename server/{route => router}/api/v1/v1.go (100%) rename server/{route => router}/api/v1/webhook_service.go (100%) rename server/{route => router}/api/v1/workspace_service.go (100%) rename server/{route => router}/api/v1/workspace_setting_service.go (100%) rename server/{route => router}/frontend/frontend.go (100%) rename server/{route => router}/rss/rss.go (100%) diff --git a/Dockerfile b/Dockerfile index 9a1a9f5e..93697eb5 100644 --- a/Dockerfile +++ b/Dockerfile @@ -15,7 +15,7 @@ FROM golang:1.22-alpine AS backend WORKDIR /backend-build COPY . . -COPY --from=frontend /frontend-build/web/dist /backend-build/server/route/frontend/dist +COPY --from=frontend /frontend-build/web/dist /backend-build/server/router/frontend/dist RUN CGO_ENABLED=0 go build -o memos ./bin/memos/main.go diff --git a/go.mod b/go.mod index f4521faf..ed2fdffa 100644 --- a/go.mod +++ b/go.mod @@ -10,7 +10,6 @@ require ( github.com/aws/aws-sdk-go-v2/credentials v1.17.11 github.com/aws/aws-sdk-go-v2/feature/s3/manager v1.16.15 github.com/aws/aws-sdk-go-v2/service/s3 v1.53.1 - github.com/disintegration/imaging v1.6.2 github.com/go-sql-driver/mysql v1.8.1 github.com/google/cel-go v0.20.1 github.com/google/uuid v1.6.0 @@ -51,7 +50,6 @@ require ( github.com/sourcegraph/conc v0.3.0 // indirect github.com/stoewer/go-strcase v1.3.0 // indirect golang.org/x/exp v0.0.0-20240409090435-93d18d7e34b8 // indirect - golang.org/x/image v0.15.0 // indirect google.golang.org/genproto/googleapis/rpc v0.0.0-20240415180920-8c6c420018be // indirect gopkg.in/yaml.v2 v2.4.0 // indirect modernc.org/gc/v3 v3.0.0-20240304020402-f0dba7c97c2b // indirect diff --git a/go.sum b/go.sum index d8fd754e..94e910a4 100644 --- a/go.sum +++ b/go.sum @@ -93,8 +93,6 @@ github.com/davecgh/go-spew v1.1.2-0.20180830191138-d8f796af33cc/go.mod h1:J7Y8Yc github.com/desertbit/timer v0.0.0-20180107155436-c41aec40b27f h1:U5y3Y5UE0w7amNe7Z5G/twsBW0KEalRQXZzf8ufSh9I= github.com/desertbit/timer v0.0.0-20180107155436-c41aec40b27f/go.mod h1:xH/i4TFMt8koVQZ6WFms69WAsDWr2XsYL3Hkl7jkoLE= github.com/dgrijalva/jwt-go v3.2.0+incompatible/go.mod h1:E3ru+11k8xSBh+hMPgOLZmtrrCbhqsmaPHjLKYnJCaQ= -github.com/disintegration/imaging v1.6.2 h1:w1LecBlG2Lnp8B3jk5zSuNqd7b4DXhcjwek1ei82L+c= -github.com/disintegration/imaging v1.6.2/go.mod h1:44/5580QXChDfwIclfc/PCwrr44amcmDAg8hxG0Ewe4= github.com/dustin/go-humanize v0.0.0-20171111073723-bb3d318650d4/go.mod h1:HtrtbFcZ19U5GC7JDqmcUSB87Iq5E25KnS6fMYU6eOk= github.com/dustin/go-humanize v1.0.1 h1:GzkhY7T5VNhEkwH0PVJgjz+fX1rhBrR7pRT3mDkpeCY= github.com/dustin/go-humanize v1.0.1/go.mod h1:Mu1zIs6XwVuF/gI1OepvI0qD18qycQx+mFykh5fBlto= @@ -477,9 +475,6 @@ golang.org/x/exp v0.0.0-20240409090435-93d18d7e34b8 h1:ESSUROHIBHg7USnszlcdmjBEw golang.org/x/exp v0.0.0-20240409090435-93d18d7e34b8/go.mod h1:/lliqkxwWAhPjf5oSOIJup2XcqJaw8RGS6k3TGEc7GI= golang.org/x/image v0.0.0-20190227222117-0694c2d4d067/go.mod h1:kZ7UVZpmo3dzQBMxlp+ypCbDeSB+sBbTgSJuh5dn5js= golang.org/x/image v0.0.0-20190802002840-cff245a6509b/go.mod h1:FeLwcggjj3mMvU+oOTbSwawSJRM1uh48EjtB4UJZlP0= -golang.org/x/image v0.0.0-20191009234506-e7c1f5e7dbb8/go.mod h1:FeLwcggjj3mMvU+oOTbSwawSJRM1uh48EjtB4UJZlP0= -golang.org/x/image v0.15.0 h1:kOELfmgrmJlw4Cdb7g/QGuB3CvDrXbqEIww/pNtNBm8= -golang.org/x/image v0.15.0/go.mod h1:HUYqC05R2ZcZ3ejNQsIHQDQiwWM4JBqmm6MKANTp4LE= golang.org/x/lint v0.0.0-20181026193005-c67002cb31c3/go.mod h1:UVdnD1Gm6xHRNCYTkRU2/jEulfH38KcIWyp/GAMgvoE= golang.org/x/lint v0.0.0-20190227174305-5b3e6a55c961/go.mod h1:wehouNa3lNwaWXcvxsM5YxQ5yQlVC4a0KAMCusXpPoU= golang.org/x/lint v0.0.0-20190301231843-5614ed5bae6f/go.mod h1:UVdnD1Gm6xHRNCYTkRU2/jEulfH38KcIWyp/GAMgvoE= diff --git a/scripts/gen-api-v1-docs.cfg b/scripts/gen-api-v1-docs.cfg deleted file mode 100644 index 05dbea0f..00000000 --- a/scripts/gen-api-v1-docs.cfg +++ /dev/null @@ -1,13 +0,0 @@ -# This file is used by gen-api-v1-docs.ps1 and gen-api-v1-docs.sh - -# You should list additional dirs here if the API grows -SWAG_API_DIRS=./server/route/api/v1 - -# Where general API info is documented -SWAG_GENERAL_INFO=./server/route/api/v1/v1.go - -# Possible output files: go (docs.go), json (swagger.json), yaml (swagger.yaml) -SWAG_OUTPUT_TYPES=go,yaml - -# Where generated files are outputted -SWAG_OUTPUT=./server/route/api/v1 diff --git a/scripts/gen-api-v1-docs.ps1 b/scripts/gen-api-v1-docs.ps1 deleted file mode 100644 index 4b80c10f..00000000 --- a/scripts/gen-api-v1-docs.ps1 +++ /dev/null @@ -1,73 +0,0 @@ -# This script generates API documentation using swaggo/swag - -# For more details, check the docs: -# * https://usememos.com/docs/contribution/development -# * https://github.com/usememos/memos/blob/main/docs/api/documentation.md - -# Requirements: -# * go - -# swag is configured mainly via gen-api-v1-docs.cfg file. - -# Usage: -# ./scripts/gen-api-v1-docs.ps1 - -foreach ($dir in @(".", "../")) { - if (Test-Path (Join-Path $dir ".gitignore")) { - $repoRoot = (Resolve-Path $dir).Path - break - } -} -Set-Location $repoRoot - -Write-Host "Parsing gen-api-v1-docs.cfg..." -foreach ($line in (Get-Content "$repoRoot\scripts\gen-api-v1-docs.cfg" )) { - if ($line.Trim().StartsWith('#')) { - continue - } - $name, $value = $line.split('=') - if ([string]::IsNullOrWhiteSpace($name)) { - continue - } - Set-Content env:\$name $value -} - -Write-Host "API directories: $env:SWAG_API_DIRS" -f Cyan -Write-Host "Output directory: $env:SWAG_OUTPUT" -f Cyan -Write-Host "General info: $env:SWAG_GENERAL_INFO" -f Cyan - -$swag = (Get-Command swag -ErrorAction SilentlyContinue).Path -if (-not $swag) { - foreach ($path in @((Join-Path $HOME "go/bin"), (Join-Path $env:GOPATH "/bin"))) { - $swag = Join-Path (Resolve-Path $path).Path "swag.exe" - if (Test-Path $swag) { - break - } - } -} -if (-not (Test-Path $swag)) { - Write-Host "Swag is not installed. Installing..." -f Magenta - go install github.com/swaggo/swag/cmd/swag@latest -} - -$generalInfoPath = (Split-Path (Resolve-Path $env:SWAG_GENERAL_INFO -Relative) -Parent) -$apiDirs = $env:SWAG_API_DIRS -split ',' | ForEach-Object { "$(Resolve-Path $_ -Relative)" } -$swagFmtDirs = $generalInfoPath + "," + $($apiDirs -join ",") - -Write-Host "Formatting comments via ``swag fmt --dir `"$swagFmtDirs`"``..." -f Magenta -&$swag fmt --dir "`"${swagFmtDirs}`"" - -$goFmtDirs = $swagFmtDirs -split ',' | ForEach-Object { "`"$($_)`"" } - -# This is just in case swag fmt do something non-conforming to go fmt -Write-Host "Formatting code via ``go fmt ${goFmtDirs}``..." -f Magenta -go fmt ${goFmtDirs} - -Write-Host "Generating Swagger API documentation..." -f Magenta -&$swag init --output $env:SWAG_OUTPUT --outputTypes $env:SWAG_OUTPUT_TYPES --generalInfo $env:SWAG_GENERAL_INFO --dir "./,${env:SWAG_API_DIRS}" - -if ($LASTEXITCODE -ne 0) { - Write-Host "Failed to generate API documentation!" -f Red - exit $LASTEXITCODE -} -Write-Host "API documentation updated!" -f Green diff --git a/scripts/gen-api-v1-docs.sh b/scripts/gen-api-v1-docs.sh deleted file mode 100755 index 69236850..00000000 --- a/scripts/gen-api-v1-docs.sh +++ /dev/null @@ -1,108 +0,0 @@ -#!/bin/bash - -# This script generates API documentation using swaggo/swag - -# For more details, check the docs: -# * https://usememos.com/docs/contribution/development -# * https://github.com/usememos/memos/blob/main/docs/api/documentation.md - -# Requirements: -# * go - -# swag is configured via gen-api-v1-docs.cfg file. - -# Usage: -# chmod +x ./scripts/gen-api-v1-docs.sh -# ./scripts/gen-api-v1-docs.sh - -find_repo_root() { - # Usage: find_repo_root ... - local looking_for="${1:-".gitignore"}" - shift - local default_dirs=("." "../") - local dirs=("${@:-${default_dirs[@]}}") - for dir in "${dirs[@]}"; do - if [ -f "$dir/$looking_for" ]; then - echo $(realpath "$dir") - return - fi - done -} - -find_binary() { - # Usage: find_binary ... - local looking_for="$1" - shift - local default_dirs=(".") - - local binary=$(command -v $looking_for) - if [ ! -z "$binary" ]; then - echo "$binary" - return - fi - - local dirs=("${@:-${default_dirs[@]}}") - for dir in "${dirs[@]}"; do - if [ -f "$dir/$looking_for" ]; then - echo $(realpath "$dir")/$looking_for - return - fi - done -} - -repo_root=$(find_repo_root) -if [ -z "$repo_root" ]; then - echo -e "\033[0;31mRepository root not found! Exiting.\033[0m" - exit 1 -else - echo -e "Repository root: \033[0;34m$repo_root\033[0m" -fi -cd $repo_root - -echo "Parsing gen-api-v1-docs.cfg..." -source "$repo_root/scripts/gen-api-v1-docs.cfg" - -echo -e "API directories: \033[0;34m$SWAG_API_DIRS\033[0m" -echo -e "Output directory: \033[0;34m$SWAG_OUTPUT\033[0m" -echo -e "General info: \033[0;34m$SWAG_GENERAL_INFO\033[0m" - -if [ -z "$SWAG_API_DIRS" ]; then - echo -e "\033[0;31mAPI directories not set! Exiting.\033[0m" - exit 1 -fi - -swag=$(find_binary swag "$HOME/go/bin" "$GOPATH/bin") -if [ -z "$swag" ]; then - echo "Swag is not installed. Installing..." - go install github.com/swaggo/swag/cmd/swag@latest - swag=$(find_binary swag "$HOME/go/bin" "$GOPATH/bin") -fi - -if [ -z "$swag" ]; then - echo -e "\033[0;31mSwag binary not found! Exiting.\033[0m" - exit 1 -fi -echo -e "Swag binary: \033[0;34m$swag\033[0m" - -general_info_path=$(dirname "$SWAG_GENERAL_INFO") -if [ ! -d "$general_info_path" ]; then - echo -e "\033[0;31mGeneral info directory does not exist!\033[0m" - exit 1 -fi - -echo -e "\e[35mFormatting comments via \`swag fmt --dir "$general_info_path,$SWAG_API_DIRS"\`...\e[0m" -$swag fmt --dir "$general_info_path,$SWAG_API_DIRS" - -# This is just in case "swag fmt" do something non-conforming to "go fmt" -go_fmt_dirs=$(echo $general_info_path $SWAG_API_DIRS | tr "," " ") -echo -e "\e[35mFormatting code via \`go fmt $go_fmt_dirs\`...\e[0m" -go fmt $go_fmt_dirs - -echo -e "\e[35mGenerating Swagger API documentation...\e[0m" -$swag init --output "$SWAG_OUTPUT" --outputTypes "$SWAG_OUTPUT_TYPES" --generalInfo "$SWAG_GENERAL_INFO" --dir "./,$SWAG_API_DIRS" - -if [ $? -ne 0 ]; then - echo -e "\033[0;31mFailed to generate Swagger API documentation!\033[0m" - exit 1 -fi -echo -e "\033[0;32mSwagger API documentation updated!\033[0m" diff --git a/server/route/frontend/dist/index.html b/server/route/frontend/dist/index.html deleted file mode 100644 index a612ed1f..00000000 --- a/server/route/frontend/dist/index.html +++ /dev/null @@ -1,11 +0,0 @@ - - - - - - Memos - - - No embeddable frontend found. - - diff --git a/server/route/api/v1/acl.go b/server/router/api/v1/acl.go similarity index 100% rename from server/route/api/v1/acl.go rename to server/router/api/v1/acl.go diff --git a/server/route/api/v1/acl_config.go b/server/router/api/v1/acl_config.go similarity index 100% rename from server/route/api/v1/acl_config.go rename to server/router/api/v1/acl_config.go diff --git a/server/route/api/v1/activity_service.go b/server/router/api/v1/activity_service.go similarity index 100% rename from server/route/api/v1/activity_service.go rename to server/router/api/v1/activity_service.go diff --git a/server/route/api/v1/auth.go b/server/router/api/v1/auth.go similarity index 100% rename from server/route/api/v1/auth.go rename to server/router/api/v1/auth.go diff --git a/server/route/api/v1/auth_service.go b/server/router/api/v1/auth_service.go similarity index 100% rename from server/route/api/v1/auth_service.go rename to server/router/api/v1/auth_service.go diff --git a/server/route/api/v1/common.go b/server/router/api/v1/common.go similarity index 100% rename from server/route/api/v1/common.go rename to server/router/api/v1/common.go diff --git a/server/route/api/v1/idp_service.go b/server/router/api/v1/idp_service.go similarity index 100% rename from server/route/api/v1/idp_service.go rename to server/router/api/v1/idp_service.go diff --git a/server/route/api/v1/inbox_service.go b/server/router/api/v1/inbox_service.go similarity index 100% rename from server/route/api/v1/inbox_service.go rename to server/router/api/v1/inbox_service.go diff --git a/server/route/api/v1/logger_interceptor.go b/server/router/api/v1/logger_interceptor.go similarity index 100% rename from server/route/api/v1/logger_interceptor.go rename to server/router/api/v1/logger_interceptor.go diff --git a/server/route/api/v1/markdown_service.go b/server/router/api/v1/markdown_service.go similarity index 100% rename from server/route/api/v1/markdown_service.go rename to server/router/api/v1/markdown_service.go diff --git a/server/route/api/v1/memo_relation_service.go b/server/router/api/v1/memo_relation_service.go similarity index 100% rename from server/route/api/v1/memo_relation_service.go rename to server/router/api/v1/memo_relation_service.go diff --git a/server/route/api/v1/memo_resource_service.go b/server/router/api/v1/memo_resource_service.go similarity index 100% rename from server/route/api/v1/memo_resource_service.go rename to server/router/api/v1/memo_resource_service.go diff --git a/server/route/api/v1/memo_service.go b/server/router/api/v1/memo_service.go similarity index 100% rename from server/route/api/v1/memo_service.go rename to server/router/api/v1/memo_service.go diff --git a/server/route/api/v1/reaction_service.go b/server/router/api/v1/reaction_service.go similarity index 100% rename from server/route/api/v1/reaction_service.go rename to server/router/api/v1/reaction_service.go diff --git a/server/route/api/v1/resource_name.go b/server/router/api/v1/resource_name.go similarity index 100% rename from server/route/api/v1/resource_name.go rename to server/router/api/v1/resource_name.go diff --git a/server/route/api/v1/resource_service.go b/server/router/api/v1/resource_service.go similarity index 100% rename from server/route/api/v1/resource_service.go rename to server/router/api/v1/resource_service.go diff --git a/server/route/api/v1/tag_service.go b/server/router/api/v1/tag_service.go similarity index 100% rename from server/route/api/v1/tag_service.go rename to server/router/api/v1/tag_service.go diff --git a/server/route/api/v1/user_service.go b/server/router/api/v1/user_service.go similarity index 100% rename from server/route/api/v1/user_service.go rename to server/router/api/v1/user_service.go diff --git a/server/route/api/v1/v1.go b/server/router/api/v1/v1.go similarity index 100% rename from server/route/api/v1/v1.go rename to server/router/api/v1/v1.go diff --git a/server/route/api/v1/webhook_service.go b/server/router/api/v1/webhook_service.go similarity index 100% rename from server/route/api/v1/webhook_service.go rename to server/router/api/v1/webhook_service.go diff --git a/server/route/api/v1/workspace_service.go b/server/router/api/v1/workspace_service.go similarity index 100% rename from server/route/api/v1/workspace_service.go rename to server/router/api/v1/workspace_service.go diff --git a/server/route/api/v1/workspace_setting_service.go b/server/router/api/v1/workspace_setting_service.go similarity index 100% rename from server/route/api/v1/workspace_setting_service.go rename to server/router/api/v1/workspace_setting_service.go diff --git a/server/route/frontend/frontend.go b/server/router/frontend/frontend.go similarity index 100% rename from server/route/frontend/frontend.go rename to server/router/frontend/frontend.go diff --git a/server/route/rss/rss.go b/server/router/rss/rss.go similarity index 100% rename from server/route/rss/rss.go rename to server/router/rss/rss.go diff --git a/server/server.go b/server/server.go index 6b21b15e..eea51dd1 100644 --- a/server/server.go +++ b/server/server.go @@ -16,9 +16,9 @@ import ( storepb "github.com/usememos/memos/proto/gen/store" "github.com/usememos/memos/server/profile" - apiv1 "github.com/usememos/memos/server/route/api/v1" - "github.com/usememos/memos/server/route/frontend" - "github.com/usememos/memos/server/route/rss" + apiv1 "github.com/usememos/memos/server/router/api/v1" + "github.com/usememos/memos/server/router/frontend" + "github.com/usememos/memos/server/router/rss" versionchecker "github.com/usememos/memos/server/service/version_checker" "github.com/usememos/memos/store" )