Unverified Commit ea728d23 authored by boojack's avatar boojack Committed by GitHub

refactor: memo store (#1741)

parent 43819b02
package api
// MaxContentLength means the max memo content bytes is 1MB.
const MaxContentLength = 1 << 30
// Visibility is the type of a visibility.
type Visibility string
......@@ -15,8 +12,8 @@ const (
Private Visibility = "PRIVATE"
)
func (e Visibility) String() string {
switch e {
func (v Visibility) String() string {
switch v {
case Public:
return "PUBLIC"
case Protected:
......@@ -27,7 +24,7 @@ func (e Visibility) String() string {
return "PRIVATE"
}
type Memo struct {
type MemoResponse struct {
ID int `json:"id"`
// Standard fields
......@@ -42,12 +39,13 @@ type Memo struct {
Pinned bool `json:"pinned"`
// Related fields
CreatorName string `json:"creatorName"`
ResourceList []*Resource `json:"resourceList"`
RelationList []*MemoRelation `json:"relationList"`
CreatorName string `json:"creatorName"`
ResourceIDList []int
ResourceList []*Resource `json:"resourceList"`
RelationList []*MemoRelation `json:"relationList"`
}
type MemoCreate struct {
type CreateMemoRequest struct {
// Standard fields
CreatorID int `json:"-"`
CreatedTs *int64 `json:"createdTs"`
......@@ -61,7 +59,7 @@ type MemoCreate struct {
RelationList []*MemoRelationUpsert `json:"relationList"`
}
type MemoPatch struct {
type PatchMemoRequest struct {
ID int `json:"-"`
// Standard fields
......@@ -78,7 +76,7 @@ type MemoPatch struct {
RelationList []*MemoRelationUpsert `json:"relationList"`
}
type MemoFind struct {
type FindMemoRequest struct {
ID *int
// Standard fields
......@@ -94,7 +92,3 @@ type MemoFind struct {
Limit *int
Offset *int
}
type MemoDelete struct {
ID int
}
This diff is collapsed.
......@@ -74,3 +74,11 @@ func (s *Server) registerMemoRelationRoutes(g *echo.Group) {
return c.JSON(http.StatusOK, true)
})
}
func convertMemoRelationMessageToMemoRelation(memoRelation *store.MemoRelationMessage) *api.MemoRelation {
return &api.MemoRelation{
MemoID: memoRelation.MemoID,
RelatedMemoID: memoRelation.RelatedMemoID,
Type: api.MemoRelationType(memoRelation.Type),
}
}
......@@ -8,6 +8,7 @@ import (
"time"
"github.com/usememos/memos/api"
"github.com/usememos/memos/store"
"github.com/labstack/echo/v4"
)
......@@ -82,7 +83,7 @@ func (s *Server) registerMemoResourceRoutes(g *echo.Group) {
return echo.NewHTTPError(http.StatusBadRequest, fmt.Sprintf("Resource ID is not a number: %s", c.Param("resourceId"))).SetInternal(err)
}
memo, err := s.Store.FindMemo(ctx, &api.MemoFind{
memo, err := s.Store.GetMemo(ctx, &store.FindMemoMessage{
ID: &memoID,
})
if err != nil {
......
......@@ -13,6 +13,7 @@ import (
"github.com/labstack/echo/v4"
"github.com/usememos/memos/api"
"github.com/usememos/memos/common"
"github.com/usememos/memos/store"
"github.com/yuin/goldmark"
)
......@@ -24,12 +25,12 @@ func (s *Server) registerRSSRoutes(g *echo.Group) {
return echo.NewHTTPError(http.StatusInternalServerError, "Failed to get system customized profile").SetInternal(err)
}
normalStatus := api.Normal
memoFind := api.MemoFind{
normalStatus := store.Normal
memoFind := store.FindMemoMessage{
RowStatus: &normalStatus,
VisibilityList: []api.Visibility{api.Public},
VisibilityList: []store.Visibility{store.Public},
}
memoList, err := s.Store.FindMemoList(ctx, &memoFind)
memoList, err := s.Store.ListMemos(ctx, &memoFind)
if err != nil {
return echo.NewHTTPError(http.StatusInternalServerError, "Failed to find memo list").SetInternal(err)
}
......@@ -55,13 +56,13 @@ func (s *Server) registerRSSRoutes(g *echo.Group) {
return echo.NewHTTPError(http.StatusInternalServerError, "Failed to get system customized profile").SetInternal(err)
}
normalStatus := api.Normal
memoFind := api.MemoFind{
normalStatus := store.Normal
memoFind := store.FindMemoMessage{
CreatorID: &id,
RowStatus: &normalStatus,
VisibilityList: []api.Visibility{api.Public},
VisibilityList: []store.Visibility{store.Public},
}
memoList, err := s.Store.FindMemoList(ctx, &memoFind)
memoList, err := s.Store.ListMemos(ctx, &memoFind)
if err != nil {
return echo.NewHTTPError(http.StatusInternalServerError, "Failed to find memo list").SetInternal(err)
}
......@@ -79,7 +80,7 @@ func (s *Server) registerRSSRoutes(g *echo.Group) {
const MaxRSSItemCount = 100
const MaxRSSItemTitleLength = 100
func (s *Server) generateRSSFromMemoList(ctx context.Context, memoList []*api.Memo, baseURL string, profile *api.CustomizedProfile) (string, error) {
func (s *Server) generateRSSFromMemoList(ctx context.Context, memoList []*store.MemoMessage, baseURL string, profile *api.CustomizedProfile) (string, error) {
feed := &feeds.Feed{
Title: profile.Name,
Link: &feeds.Link{Href: baseURL},
......@@ -98,15 +99,15 @@ func (s *Server) generateRSSFromMemoList(ctx context.Context, memoList []*api.Me
Created: time.Unix(memo.CreatedTs, 0),
Enclosure: &feeds.Enclosure{Url: baseURL + "/m/" + strconv.Itoa(memo.ID) + "/image"},
}
resourceList, err := s.Store.FindResourceList(ctx, &api.ResourceFind{
MemoID: &memo.ID,
})
if err != nil {
return "", err
}
if len(resourceList) > 0 {
if len(memo.ResourceIDList) > 0 {
resourceID := memo.ResourceIDList[0]
resource, err := s.Store.FindResource(ctx, &api.ResourceFind{
ID: &resourceID,
})
if err != nil {
return "", err
}
enclosure := feeds.Enclosure{}
resource := resourceList[0]
if resource.ExternalLink != "" {
enclosure.Url = resource.ExternalLink
} else {
......
......@@ -10,6 +10,7 @@ import (
"github.com/pkg/errors"
"github.com/usememos/memos/api"
"github.com/usememos/memos/common"
"github.com/usememos/memos/store"
"golang.org/x/exp/slices"
"github.com/labstack/echo/v4"
......@@ -71,14 +72,14 @@ func (s *Server) registerTagRoutes(g *echo.Group) {
return echo.NewHTTPError(http.StatusBadRequest, "Missing user session")
}
contentSearch := "#"
normalRowStatus := api.Normal
memoFind := api.MemoFind{
normalRowStatus := store.Normal
memoFind := &store.FindMemoMessage{
CreatorID: &userID,
ContentSearch: &contentSearch,
RowStatus: &normalRowStatus,
}
memoList, err := s.Store.FindMemoList(ctx, &memoFind)
memoMessageList, err := s.Store.ListMemos(ctx, memoFind)
if err != nil {
return echo.NewHTTPError(http.StatusInternalServerError, "Failed to find memo list").SetInternal(err)
}
......@@ -96,7 +97,7 @@ func (s *Server) registerTagRoutes(g *echo.Group) {
}
tagMapSet := make(map[string]bool)
for _, memo := range memoList {
for _, memo := range memoMessageList {
for _, tag := range findTagListFromMemoContent(memo.Content) {
if !slices.Contains(tagNameList, tag) {
tagMapSet[tag] = true
......
package store
// RowStatus is the status for a row.
type RowStatus string
const (
// Normal is the status for a normal row.
Normal RowStatus = "NORMAL"
// Archived is the status for an archived row.
Archived RowStatus = "ARCHIVED"
)
func (r RowStatus) String() string {
switch r {
case Normal:
return "NORMAL"
case Archived:
return "ARCHIVED"
}
return ""
}
This diff is collapsed.
......@@ -6,30 +6,9 @@ import (
"fmt"
"strings"
"github.com/usememos/memos/api"
"github.com/usememos/memos/common"
)
func (s *Store) ComposeMemoRelationList(ctx context.Context, memo *api.Memo) error {
memoRelationList, err := s.ListMemoRelations(ctx, &FindMemoRelationMessage{
MemoID: &memo.ID,
})
if err != nil {
return err
}
memo.RelationList = []*api.MemoRelation{}
for _, memoRelation := range memoRelationList {
memo.RelationList = append(memo.RelationList, &api.MemoRelation{
MemoID: memoRelation.MemoID,
RelatedMemoID: memoRelation.RelatedMemoID,
Type: api.MemoRelationType(memoRelation.Type),
})
}
return nil
}
type MemoRelationType string
const (
......
......@@ -4,7 +4,6 @@ import (
"context"
"database/sql"
"fmt"
"sort"
"strings"
"github.com/usememos/memos/api"
......@@ -53,40 +52,6 @@ func (raw *resourceRaw) toResource() *api.Resource {
}
}
func (s *Store) ComposeMemoResourceList(ctx context.Context, memo *api.Memo) error {
resourceList, err := s.FindResourceList(ctx, &api.ResourceFind{
MemoID: &memo.ID,
})
if err != nil {
return err
}
for _, resource := range resourceList {
memoResource, err := s.FindMemoResource(ctx, &api.MemoResourceFind{
MemoID: &memo.ID,
ResourceID: &resource.ID,
})
if err != nil {
return err
}
resource.CreatedTs = memoResource.CreatedTs
resource.UpdatedTs = memoResource.UpdatedTs
}
sort.Slice(resourceList, func(i, j int) bool {
if resourceList[i].CreatedTs != resourceList[j].CreatedTs {
return resourceList[i].CreatedTs < resourceList[j].CreatedTs
}
return resourceList[i].ID < resourceList[j].ID
})
memo.ResourceList = resourceList
return nil
}
func (s *Store) CreateResource(ctx context.Context, create *api.ResourceCreate) (*api.Resource, error) {
tx, err := s.db.BeginTx(ctx, nil)
if err != nil {
......
......@@ -15,7 +15,6 @@ type Store struct {
systemSettingCache sync.Map // map[string]*systemSettingRaw
userCache sync.Map // map[int]*userRaw
userSettingCache sync.Map // map[string]*userSettingRaw
memoCache sync.Map // map[int]*memoRaw
shortcutCache sync.Map // map[int]*shortcutRaw
idpCache sync.Map // map[int]*identityProviderMessage
}
......
......@@ -11,34 +11,20 @@ import (
)
func (s *Store) SeedDataForNewUser(ctx context.Context, user *api.User) error {
tx, err := s.db.BeginTx(ctx, nil)
if err != nil {
return FormatError(err)
}
defer tx.Rollback()
// Create a memo for the user.
_, err = createMemoRaw(ctx, tx, &api.MemoCreate{
_, err := s.CreateMemo(ctx, &MemoMessage{
CreatorID: user.ID,
Content: "#inbox Welcome to Memos!",
Visibility: api.Private,
Visibility: Private,
})
if err != nil {
return err
}
_, err = upsertTag(ctx, tx, &api.TagUpsert{
_, err = s.UpsertTag(ctx, &api.TagUpsert{
CreatorID: user.ID,
Name: "inbox",
})
if err != nil {
return err
}
if err := tx.Commit(); err != nil {
return FormatError(err)
}
return nil
return err
}
// userRaw is the store model for an User.
......@@ -79,22 +65,6 @@ func (raw *userRaw) toUser() *api.User {
}
}
func (s *Store) ComposeMemoCreator(ctx context.Context, memo *api.Memo) error {
user, err := s.FindUser(ctx, &api.UserFind{
ID: &memo.CreatorID,
})
if err != nil {
return err
}
if user.Nickname != "" {
memo.CreatorName = user.Nickname
} else {
memo.CreatorName = user.Username
}
return nil
}
func (s *Store) CreateUser(ctx context.Context, create *api.UserCreate) (*api.User, error) {
tx, err := s.db.BeginTx(ctx, nil)
if err != nil {
......
......@@ -28,12 +28,12 @@ func TestMemoRelationServer(t *testing.T) {
memoList, err := s.getMemoList()
require.NoError(t, err)
require.Len(t, memoList, 1)
memo, err := s.postMemoCreate(&api.MemoCreate{
memo, err := s.postMemoCreate(&api.CreateMemoRequest{
Content: "test memo",
})
require.NoError(t, err)
require.Equal(t, "test memo", memo.Content)
memo2, err := s.postMemoCreate(&api.MemoCreate{
memo2, err := s.postMemoCreate(&api.CreateMemoRequest{
Content: "test memo2",
RelationList: []*api.MemoRelationUpsert{
{
......
......@@ -28,7 +28,7 @@ func TestMemoServer(t *testing.T) {
memoList, err := s.getMemoList()
require.NoError(t, err)
require.Len(t, memoList, 1)
memo, err := s.postMemoCreate(&api.MemoCreate{
memo, err := s.postMemoCreate(&api.CreateMemoRequest{
Content: "test memo",
})
require.NoError(t, err)
......@@ -37,7 +37,7 @@ func TestMemoServer(t *testing.T) {
require.NoError(t, err)
require.Len(t, memoList, 2)
updatedContent := "updated memo"
memo, err = s.patchMemo(&api.MemoPatch{
memo, err = s.patchMemo(&api.PatchMemoRequest{
ID: memo.ID,
Content: &updatedContent,
})
......@@ -50,23 +50,21 @@ func TestMemoServer(t *testing.T) {
Pinned: true,
})
require.NoError(t, err)
memo, err = s.patchMemo(&api.MemoPatch{
memo, err = s.patchMemo(&api.PatchMemoRequest{
ID: memo.ID,
Content: &updatedContent,
})
require.NoError(t, err)
require.Equal(t, updatedContent, memo.Content)
require.Equal(t, true, memo.Pinned)
err = s.deleteMemo(&api.MemoDelete{
ID: memo.ID,
})
err = s.deleteMemo(memo.ID)
require.NoError(t, err)
memoList, err = s.getMemoList()
require.NoError(t, err)
require.Len(t, memoList, 1)
}
func (s *TestingServer) getMemo(memoID int) (*api.Memo, error) {
func (s *TestingServer) getMemo(memoID int) (*api.MemoResponse, error) {
body, err := s.get(fmt.Sprintf("/api/memo/%d", memoID), nil)
if err != nil {
return nil, err
......@@ -79,7 +77,7 @@ func (s *TestingServer) getMemo(memoID int) (*api.Memo, error) {
}
type MemoCreateResponse struct {
Data *api.Memo `json:"data"`
Data *api.MemoResponse `json:"data"`
}
res := new(MemoCreateResponse)
if err = json.Unmarshal(buf.Bytes(), res); err != nil {
......@@ -88,7 +86,7 @@ func (s *TestingServer) getMemo(memoID int) (*api.Memo, error) {
return res.Data, nil
}
func (s *TestingServer) getMemoList() ([]*api.Memo, error) {
func (s *TestingServer) getMemoList() ([]*api.MemoResponse, error) {
body, err := s.get("/api/memo", nil)
if err != nil {
return nil, err
......@@ -101,7 +99,7 @@ func (s *TestingServer) getMemoList() ([]*api.Memo, error) {
}
type MemoCreateResponse struct {
Data []*api.Memo `json:"data"`
Data []*api.MemoResponse `json:"data"`
}
res := new(MemoCreateResponse)
if err = json.Unmarshal(buf.Bytes(), res); err != nil {
......@@ -110,7 +108,7 @@ func (s *TestingServer) getMemoList() ([]*api.Memo, error) {
return res.Data, nil
}
func (s *TestingServer) postMemoCreate(memoCreate *api.MemoCreate) (*api.Memo, error) {
func (s *TestingServer) postMemoCreate(memoCreate *api.CreateMemoRequest) (*api.MemoResponse, error) {
rawData, err := json.Marshal(&memoCreate)
if err != nil {
return nil, errors.Wrap(err, "failed to marshal memo create")
......@@ -128,7 +126,7 @@ func (s *TestingServer) postMemoCreate(memoCreate *api.MemoCreate) (*api.Memo, e
}
type MemoCreateResponse struct {
Data *api.Memo `json:"data"`
Data *api.MemoResponse `json:"data"`
}
res := new(MemoCreateResponse)
if err = json.Unmarshal(buf.Bytes(), res); err != nil {
......@@ -137,7 +135,7 @@ func (s *TestingServer) postMemoCreate(memoCreate *api.MemoCreate) (*api.Memo, e
return res.Data, nil
}
func (s *TestingServer) patchMemo(memoPatch *api.MemoPatch) (*api.Memo, error) {
func (s *TestingServer) patchMemo(memoPatch *api.PatchMemoRequest) (*api.MemoResponse, error) {
rawData, err := json.Marshal(&memoPatch)
if err != nil {
return nil, errors.Wrap(err, "failed to marshal memo patch")
......@@ -155,7 +153,7 @@ func (s *TestingServer) patchMemo(memoPatch *api.MemoPatch) (*api.Memo, error) {
}
type MemoPatchResponse struct {
Data *api.Memo `json:"data"`
Data *api.MemoResponse `json:"data"`
}
res := new(MemoPatchResponse)
if err = json.Unmarshal(buf.Bytes(), res); err != nil {
......@@ -164,12 +162,12 @@ func (s *TestingServer) patchMemo(memoPatch *api.MemoPatch) (*api.Memo, error) {
return res.Data, nil
}
func (s *TestingServer) deleteMemo(memoDelete *api.MemoDelete) error {
_, err := s.delete(fmt.Sprintf("/api/memo/%d", memoDelete.ID), nil)
func (s *TestingServer) deleteMemo(memoID int) error {
_, err := s.delete(fmt.Sprintf("/api/memo/%d", memoID), nil)
return err
}
func (s *TestingServer) postMemosOrganizer(memosOrganizer *api.MemoOrganizerUpsert) (*api.Memo, error) {
func (s *TestingServer) postMemosOrganizer(memosOrganizer *api.MemoOrganizerUpsert) (*api.MemoResponse, error) {
rawData, err := json.Marshal(&memosOrganizer)
if err != nil {
return nil, errors.Wrap(err, "failed to marshal memos organizer")
......@@ -187,7 +185,7 @@ func (s *TestingServer) postMemosOrganizer(memosOrganizer *api.MemoOrganizerUpse
}
type MemoOrganizerResponse struct {
Data *api.Memo `json:"data"`
Data *api.MemoResponse `json:"data"`
}
res := new(MemoOrganizerResponse)
if err = json.Unmarshal(buf.Bytes(), res); err != nil {
......
......@@ -5,7 +5,6 @@ import (
"testing"
"github.com/stretchr/testify/require"
"github.com/usememos/memos/api"
"github.com/usememos/memos/store"
)
......@@ -14,22 +13,22 @@ func TestMemoRelationStore(t *testing.T) {
ts := NewTestingStore(ctx, t)
user, err := createTestingHostUser(ctx, ts)
require.NoError(t, err)
memoCreate := &api.MemoCreate{
memoCreate := &store.MemoMessage{
CreatorID: user.ID,
Content: "test_content",
Visibility: api.Public,
Visibility: store.Public,
}
memo, err := ts.CreateMemo(ctx, memoCreate)
require.NoError(t, err)
require.Equal(t, memoCreate.Content, memo.Content)
memoCreate = &api.MemoCreate{
memo2Create := &store.MemoMessage{
CreatorID: user.ID,
Content: "test_content_2",
Visibility: api.Public,
Visibility: store.Public,
}
memo2, err := ts.CreateMemo(ctx, memoCreate)
memo2, err := ts.CreateMemo(ctx, memo2Create)
require.NoError(t, err)
require.Equal(t, memoCreate.Content, memo2.Content)
require.Equal(t, memo2Create.Content, memo2.Content)
memoRelationMessage := &store.MemoRelationMessage{
MemoID: memo.ID,
RelatedMemoID: memo2.ID,
......@@ -45,7 +44,7 @@ func TestMemoRelationStore(t *testing.T) {
require.Equal(t, memo2.ID, memoRelation[0].RelatedMemoID)
require.Equal(t, memo.ID, memoRelation[0].MemoID)
require.Equal(t, store.MemoRelationReference, memoRelation[0].Type)
err = ts.DeleteMemo(ctx, &api.MemoDelete{
err = ts.DeleteMemo(ctx, &store.DeleteMemoMessage{
ID: memo2.ID,
})
require.NoError(t, err)
......
......@@ -5,37 +5,40 @@ import (
"testing"
"github.com/stretchr/testify/require"
"github.com/usememos/memos/api"
"github.com/usememos/memos/store"
)
func TestMemoStore(t *testing.T) {
ctx := context.Background()
store := NewTestingStore(ctx, t)
user, err := createTestingHostUser(ctx, store)
ts := NewTestingStore(ctx, t)
user, err := createTestingHostUser(ctx, ts)
require.NoError(t, err)
memoCreate := &api.MemoCreate{
memoCreate := &store.MemoMessage{
CreatorID: user.ID,
Content: "test_content",
Visibility: api.Public,
Visibility: store.Public,
}
memo, err := store.CreateMemo(ctx, memoCreate)
memo, err := ts.CreateMemo(ctx, memoCreate)
require.NoError(t, err)
require.Equal(t, memoCreate.Content, memo.Content)
memoPatchContent := "test_content_2"
memoPatch := &api.MemoPatch{
memoPatch := &store.UpdateMemoMessage{
ID: memo.ID,
Content: &memoPatchContent,
}
memo, err = store.PatchMemo(ctx, memoPatch)
err = ts.UpdateMemo(ctx, memoPatch)
require.NoError(t, err)
require.Equal(t, memoPatchContent, memo.Content)
memoList, err := store.FindMemoList(ctx, &api.MemoFind{
memo, err = ts.GetMemo(ctx, &store.FindMemoMessage{
ID: &memo.ID,
})
require.NoError(t, err)
memoList, err := ts.ListMemos(ctx, &store.FindMemoMessage{
CreatorID: &user.ID,
})
require.NoError(t, err)
require.Equal(t, 2, len(memoList))
require.Equal(t, memo, memoList[1])
err = store.DeleteMemo(ctx, &api.MemoDelete{
err = ts.DeleteMemo(ctx, &store.DeleteMemoMessage{
ID: memo.ID,
})
require.NoError(t, err)
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment