Merge pull request #289 from rocboss/t/v0.3.0

v0.3.0 prepare release code review request

.github/workflows/go.yml

@@ -47,7 +47,7 @@ jobs:
     name: Test
     strategy:
       matrix:
-        go-version: [ 1.18.x, 1.19.x ]
+        go-version: [ 1.20.x ]
         platform: [ ubuntu-latest, macos-latest ]
     runs-on: ${{ matrix.platform }}
     steps:
@@ -66,7 +66,7 @@ jobs:
     name: TestOnWindows
     strategy:
       matrix:
-        go-version: [ 1.18.x, 1.19.x ]
+        go-version: [ 1.20.x ]
         platform: [ windows-latest ]
     runs-on: ${{ matrix.platform }}
     steps:

.gitignore

@@ -1,6 +1,6 @@
 .DS_Store
 .idea
-.vscode
+__debug_bin
 !*.example
 /config.yaml
 *.log

.vscode/.gitignore

@@ -0,0 +1,4 @@
+.DS_Store
+*.log
+__debug_bin
+settings.json

.vscode/launch.json

@@ -0,0 +1,14 @@
+{
+    "version": "0.2.0",
+    "configurations": [
+        {
+            "name": "paopao-ce [debug]",
+            "type": "go",
+            "request": "launch",
+            "mode": "exec",
+            "program": "${workspaceFolder}/.vscode/__debug_bin",
+            "preLaunchTask": "go: build (debug)",
+            "cwd": "${workspaceFolder}"
+        }
+    ]
+}

.vscode/sort_launch.js

@@ -0,0 +1,4 @@
+let launch = require('./launch.json');
+launch.configurations.sort((a, b) => a.name.localeCompare(b.name));
+let fs = require('fs');
+fs.writeFileSync('launch.json', JSON.stringify(launch, null, 4));

.vscode/tasks.json

@@ -0,0 +1,21 @@
+{
+    "version": "2.0.0",
+    "tasks": [
+        {
+            "label": "go: build (debug)",
+            "type": "shell",
+            "command": "go",
+            "args": [
+                "build",
+                "-gcflags=all=-N -l",
+                "-tags",
+                "'embed go_json'",
+                "-o",
+                "${workspaceFolder}/.vscode/__debug_bin"
+            ],
+            "options": {
+                "cwd": "${workspaceFolder}"
+            }
+        }
+    ]
+}

CHANGELOG.md

@@ -1,15 +1,114 @@
 # Changelog
 
 All notable changes to paopao-ce are documented in this file.
+## 0.4.0+dev ([`dev`](https://github.com/rocboss/paopao-ce/tree/dev))
 
-## 0.3.0+dev ([`dev`](https://github.com/rocboss/paopao-ce/tree/dev))
+## 0.3.0
+### Added
+
+- add custom comment sort strategy support [#243](https://github.com/rocboss/paopao-ce/pull/243)
+- add `RedisCacheIndex` feature [#250](https://github.com/rocboss/paopao-ce/pull/250)
+- add `Sentry` feature [#258](https://github.com/rocboss/paopao-ce/pull/258)
+- add simple tweet share feature(just copy tweet link to clipboard now) support [#264](https://github.com/rocboss/paopao-ce/pull/264)
+- add default tweet max length configure in web/.env support. [&a1160ca](https://github.com/rocboss/paopao-ce/commit/a1160ca79380445157146d9eae1710543c153cce 'commit a1160ca')   
+ Set the value of `VITE_DEFAULT_TWEET_MAX_LENGTH` in file web/.env to change the tweet max default length.
+ - add custom whether provide user register configure in web/.env support. [#267](https://github.com/rocboss/paopao-ce/pull/267)   
+    Set the value of `VITE_ALLOW_USER_REGISTER` in file web/.env to custom whether provide user register feature.
+    ```
+    # file: web/.env or web/.env.local
+    ...
+    # 局部参数
+    VITE_ALLOW_USER_REGISTER=true
+    ...
+    ```
+    and disallow user register in backend(add `Web:DisallowUserRegister` feature in `config.yaml`):
+    ```yaml
+    # file config.yaml
+    ...
+    Features:
+      Default: ["Base", "Postgres", "Zinc", "LocalOSS", "LoggerZinc", "BigCacheIndex", "Friendship", "Service", "Web:DisallowUserRegister"]
+    ...
+    ```
+- add topic follow feature support [#273](https://github.com/rocboss/paopao-ce/pull/273)   
+  mirgration database first(sql ddl file in `scripts/migration/**/*_topic_follow.up.sql`):
+    ```sql
+      CREATE TABLE `p_topic_user` (
+	      `id` BIGINT UNSIGNED NOT NULL AUTO_INCREMENT,
+	      `topic_id` BIGINT UNSIGNED NOT NULL COMMENT '标签ID',
+	      `user_id` BIGINT UNSIGNED NOT NULL COMMENT '创建者ID',
+	      `alias_name` VARCHAR ( 255 ) COMMENT '别名',
+	      `remark` VARCHAR ( 512 ) COMMENT '备注',
+	      `quote_num` BIGINT UNSIGNED COMMENT '引用数',
+	      `is_top` TINYINT UNSIGNED NOT NULL DEFAULT '0' COMMENT '是否置顶 0 为未置顶、1 为已置顶',
+	      `created_on` BIGINT UNSIGNED NOT NULL DEFAULT '0' COMMENT '创建时间',
+	      `modified_on` BIGINT UNSIGNED NOT NULL DEFAULT '0' COMMENT '修改时间',
+	      `deleted_on` BIGINT UNSIGNED NOT NULL DEFAULT '0' COMMENT '删除时间',
+	      `is_del` TINYINT UNSIGNED NOT NULL DEFAULT '0' COMMENT '是否删除 0 为未删除、1 为已删除',
+	      `reserve_a` VARCHAR ( 255 ) COMMENT '保留字段a',
+	      `reserve_b` VARCHAR ( 255 ) COMMENT '保留字段b',
+	      PRIMARY KEY ( `id` ) USING BTREE,
+        UNIQUE KEY `idx_topic_user_uid_tid` ( `topic_id`, `user_id` ) USING BTREE 
+      ) ENGINE = INNODB DEFAULT CHARSET = utf8mb4 COLLATE = utf8mb4_general_ci COMMENT = '用户话题';
+    ```
+- add tweet comment thumbs up/down feature support [#275](https://github.com/rocboss/paopao-ce/pull/275)   
+  mirgration database first(sql ddl file in `scripts/migration/**/*_comment_thumbs.up.sql`):
+- add load more comments feature support [&60b217b](https://github.com/rocboss/paopao-ce/commit/60b217bcd950c69ba45cebcaa17efdf8048d5a4f 'commit 60b217b')  
+
+### Fixed
+
+- fixed sql ddl p_contact's column `is_delete` define error (change to `is_del`) in scripts/paopao-mysql.sql [&afd8fe1](https://github.com/rocboss/paopao-ce/commit/afd8fe18d2dce08a4af846c2f822379d99a3d3b3 'commit afd8fe1')
+- fixed cache index not expire in delete/add tweet error [#266](https://github.com/rocboss/paopao-ce/pull/266)
+- fixed tweet's owner not allow star/collection action when tweet is private error [#274](https://github.com/rocboss/paopao-ce/pull/274)
+- fixed user not list owner's collectioned private tweet error [#274](https://github.com/rocboss/paopao-ce/pull/274)
+- fixed comments thumbs up/down state incorrect error [#283](https://github.com/rocboss/paopao-ce/pull/283)
+
+### Changed
+
+- use [github.com/rueian/rueidis](https://github.com/rueian/rueidis) as Redis client [#249](https://github.com/rocboss/paopao-ce/pull/249)   
+    the **Old** redis client configure field
+    ```yaml
+    ...
+    Redis:
+      Host: redis:6379
+      Password: 
+      DB: 
+    ```
+    the **New** redis client configure field
+    ```yaml
+    ...
+    Redis:
+      InitAddress:
+      - redis:6379
+      Username:
+      Password:
+      SelectDB:
+      ConnWriteTimeout: 60   # 连接写超时时间 多少秒 默认 60秒
+    ```
+- optimize web frontend dark theme [&b082a8f](https://github.com/rocboss/paopao-ce/commit/b082a8fa5e43dd6dacf459df93fa7e243dd901ea 'commit b082a8f')
+- change web frontend main content layout default size to 544px [&b082a8f](https://github.com/rocboss/paopao-ce/commit/b082a8fa5e43dd6dacf459df93fa7e243dd901ea 'commit b082a8f')
+- optimize web frontend in mobile environment use Drawer to display menu [#265](https://github.com/rocboss/paopao-ce/pull/265)   
+- optimize Dockerfile use pre-build builder/runner image to prevent network latency problem (`bitbus/paopao-ce-backend-builder` `bitbus/paopao-ce-backend-runner`) [#265](https://github.com/rocboss/paopao-ce/pull/265)  
+- optimize web ui in mobile environment [#280](https://github.com/rocboss/paopao-ce/pull/280)  
+- optimize upload zip attachment compatible with different browsers for uploading zip mimetype [#286](https://github.com/rocboss/paopao-ce/pull/286)  
+- adapte meilisearch to version v1.1 [#288](https://github.com/rocboss/paopao-ce/pull/288)  
+
+### Removed
+
+- remove `Deprecated:OldWeb` feature  [#256](https://github.com/rocboss/paopao-ce/pull/256)   
+
+## 0.2.5
+
+### Changed
+
+- fixed sql ddl error for contact table [#281](https://github.com/rocboss/paopao-ce/pull/281)
 
 ## 0.2.4
 
 ### Added
 
 -  add PWA support for web frontend [#242](https://github.com/rocboss/paopao-ce/pull/242)
 
+
 ## 0.2.3
 
 ### Added

Dockerfile

@@ -1,3 +1,5 @@
+# syntax=docker/dockerfile:experimental
+
 # build frontend
 FROM node:19-alpine as frontend
 ARG API_HOST
@@ -11,15 +13,11 @@ RUN [ $EMBED_UI != yes ] || [ $USE_DIST != no ] || (yarn && yarn build)
 RUN [ $EMBED_UI = yes ] || mkdir dist || echo ""
 
 # build backend
-FROM golang:1.20-alpine AS backend
+FROM bitbus/paopao-ce-backend-builder:latest AS backend
 ARG API_HOST
 ARG USE_API_HOST=yes
 ARG EMBED_UI=yes
 ARG USE_DIST=no
-RUN apk --no-cache --no-progress add --virtual \
-  build-deps \
-  build-base \
-  git
 
 WORKDIR /paopao-ce
 COPY . .
@@ -28,13 +26,12 @@ ENV GOPROXY=https://goproxy.cn
 RUN [ $EMBED_UI != yes ] || make build TAGS='embed go_json'
 RUN [ $EMBED_UI = yes ] || make build TAGS='go_json'
 
-FROM alpine:3.17
+FROM bitbus/paopao-ce-backend-runner:latest
 ARG API_HOST
 ARG USE_API_HOST=yes
 ARG EMBED_UI=yes
 ARG USE_DIST=no
 ENV TZ=Asia/Shanghai
-RUN apk update && apk add --no-cache ca-certificates && update-ca-certificates
 
 WORKDIR /app/paopao-ce
 COPY --from=backend /paopao-ce/release/paopao-ce .

Makefile

@@ -4,9 +4,10 @@ TARGET = paopao-ce
 ifeq ($(OS),Windows_NT)
 TARGET := $(TARGET).exe
 endif
+TARGET_BIN = $(basename $(TARGET))
 
 ifeq (n$(CGO_ENABLED),n)
-CGO_ENABLED := 1
+CGO_ENABLED := 0
 endif
 
 RELEASE_ROOT = release
@@ -16,15 +17,15 @@ RELEASE_DARWIN_AMD64 = $(RELEASE_ROOT)/darwin-amd64/$(TARGET)
 RELEASE_DARWIN_ARM64 = $(RELEASE_ROOT)/darwin-arm64/$(TARGET)
 RELEASE_WINDOWS_AMD64 = $(RELEASE_ROOT)/windows-amd64/$(TARGET)
 
-BUILD_VERSION := $(shell git describe --tags | cut -f 1 -d "-")
+BUILD_VERSION := $(shell git describe --tags --always | cut -f1 -f2 -d "-")
 BUILD_DATE := $(shell date +'%Y-%m-%d %H:%M:%S')
 SHA_SHORT := $(shell git rev-parse --short HEAD)
 
 TAGS = ""
 MOD_NAME = github.com/rocboss/paopao-ce
-LDFLAGS = -X "${MOD_NAME}/pkg/debug.version=${BUILD_VERSION}" \
-          -X "${MOD_NAME}/pkg/debug.buildDate=${BUILD_DATE}" \
-          -X "${MOD_NAME}/pkg/debug.commitID=${SHA_SHORT}" -w -s
+LDFLAGS = -X "${MOD_NAME}/pkg/version.version=${BUILD_VERSION}" \
+          -X "${MOD_NAME}/pkg/version.buildDate=${BUILD_DATE}" \
+          -X "${MOD_NAME}/pkg/version.commitID=${SHA_SHORT}" -w -s
 
 all: fmt build
 
@@ -50,23 +51,23 @@ release: linux-amd64 darwin-amd64 darwin-arm64 windows-x64
 
 .PHONY: linux-amd64
 linux-amd64:
-	@echo Build paopao-ce [linux-amd64] CGO_ENABLED=$(CGO_ENABLED)
-	@CGO_ENABLED=$(CGO_ENABLED) GOOS=linux GOARCH=amd64 go build -trimpath -tags '$(TAGS)' -ldflags '$(LDFLAGS)' -o $(RELEASE_LINUX_AMD64)/$(TARGET)
+	@echo Build paopao-ce [linux-amd64] CGO_ENABLED=$(CGO_ENABLED) TAGS="'$(TAGS)'"
+	@CGO_ENABLED=$(CGO_ENABLED) GOOS=linux GOARCH=amd64 go build -trimpath -tags '$(TAGS)' -ldflags '$(LDFLAGS)' -o $(RELEASE_LINUX_AMD64)/$(TARGET_BIN)
 
 .PHONY: darwin-amd64
 darwin-amd64:
-	@echo Build paopao-ce [darwin-amd64] CGO_ENABLED=$(CGO_ENABLED)
-	@CGO_ENABLED=$(CGO_ENABLED) GOOS=darwin GOARCH=amd64 go build -trimpath  -tags '$(TAGS)' -ldflags '$(LDFLAGS)' -o $(RELEASE_DARWIN_AMD64)/$(TARGET)
+	@echo Build paopao-ce [darwin-amd64] CGO_ENABLED=$(CGO_ENABLED) TAGS="'$(TAGS)'"
+	@CGO_ENABLED=$(CGO_ENABLED) GOOS=darwin GOARCH=amd64 go build -trimpath  -tags '$(TAGS)' -ldflags '$(LDFLAGS)' -o $(RELEASE_DARWIN_AMD64)/$(TARGET_BIN)
 
 .PHONY: darwin-arm64
 darwin-arm64:
-	@echo Build paopao-ce [darwin-arm64] CGO_ENABLED=$(CGO_ENABLED)
-	@CGO_ENABLED=$(CGO_ENABLED) GOOS=darwin GOARCH=arm64 go build -trimpath -tags '$(TAGS)' -ldflags '$(LDFLAGS)' -o $(RELEASE_DARWIN_ARM64)/$(TARGET)
+	@echo Build paopao-ce [darwin-arm64] CGO_ENABLED=$(CGO_ENABLED) TAGS="'$(TAGS)'"
+	@CGO_ENABLED=$(CGO_ENABLED) GOOS=darwin GOARCH=arm64 go build -trimpath -tags '$(TAGS)' -ldflags '$(LDFLAGS)' -o $(RELEASE_DARWIN_ARM64)/$(TARGET_BIN)
 
 .PHONY: windows-x64
 windows-x64:
-	@echo Build paopao-ce [windows-x64] CGO_ENABLED=$(CGO_ENABLED)
-	@CGO_ENABLED=$(CGO_ENABLED) GOOS=windows GOARCH=amd64 go build -trimpath  -tags '$(TAGS)' -ldflags '$(LDFLAGS)' -o $(RELEASE_WINDOWS_AMD64)/$(basename $(TARGET)).exe
+	@echo Build paopao-ce [windows-x64] CGO_ENABLED=$(CGO_ENABLED) TAGS="'$(TAGS)'"
+	@CGO_ENABLED=$(CGO_ENABLED) GOOS=windows GOARCH=amd64 go build -trimpath  -tags '$(TAGS)' -ldflags '$(LDFLAGS)' -o $(RELEASE_WINDOWS_AMD64)/$(TARGET_BIN).exe
 
 .PHONY: generate
 generate: gen-mir gen-grpc
@@ -109,9 +110,9 @@ pre-commit: fmt
 
 .PHONY: install-protobuf-plugins
 install-protobuf-plugins:
-	@go install github.com/bufbuild/buf/cmd/buf@v1.11.0
-	@go install github.com/bufbuild/buf/cmd/protoc-gen-buf-breaking@v1.11.0
-	@go install github.com/bufbuild/buf/cmd/protoc-gen-buf-lint@v1.11.0
+	@go install github.com/bufbuild/buf/cmd/buf@v1.15.1
+	@go install github.com/bufbuild/buf/cmd/protoc-gen-buf-breaking@v1.15.1
+	@go install github.com/bufbuild/buf/cmd/protoc-gen-buf-lint@v1.15.1
 	@go install google.golang.org/protobuf/cmd/protoc-gen-go@latest
 	@go install google.golang.org/grpc/cmd/protoc-gen-go-grpc@latest