Skip to content

armgit / memos

Public Imported from GitHub
0

Memos is an open-source, self-hosted note-taking app that brings your everyday thoughts together in a personal timeline. Your data stays yours, and you choose what to keep private or share.

8.1 KB
Raw Blame
package test

import (
	"context"
	"testing"

	"github.com/stretchr/testify/require"
	"golang.org/x/crypto/bcrypt"
	"google.golang.org/protobuf/types/known/fieldmaskpb"

	apipb "github.com/usememos/memos/proto/gen/api"
	"github.com/usememos/memos/server/api"
	"github.com/usememos/memos/store"
)

func TestUserServiceWithEmailLikeUsername(t *testing.T) {
	ctx := context.Background()

	t.Run("SignIn accepts email-like legacy username", func(t *testing.T) {
		ts := NewTestService(t)
		defer ts.Cleanup()

		user := createLegacyPasswordUser(ctx, t, ts, "[email protected]", "password123")

		signInCtx := api.WithHeaderCarrier(ctx)
		resp, err := ts.Service.SignIn(signInCtx, &apipb.SignInRequest{
			Credentials: &apipb.SignInRequest_PasswordCredentials_{
				PasswordCredentials: &apipb.SignInRequest_PasswordCredentials{
					Username: user.Username,
					Password: "password123",
				},
			},
		})
		require.NoError(t, err)
		require.Equal(t, user.Username, resp.User.Username)
		require.NotEmpty(t, resp.AccessToken)
	})

	t.Run("GetUser accepts email-like username in resource name", func(t *testing.T) {
		ts := NewTestService(t)
		defer ts.Cleanup()

		user, err := ts.CreateRegularUser(ctx, "[email protected]")
		require.NoError(t, err)

		got, err := ts.Service.GetUser(ctx, &apipb.GetUserRequest{
			Name: "users/[email protected]",
		})
		require.NoError(t, err)
		require.NotNil(t, got)
		require.Equal(t, user.Username, got.Username)
		require.Equal(t, "users/[email protected]", got.Name)
	})

	t.Run("BatchGetUsers accepts email-like legacy username", func(t *testing.T) {
		ts := NewTestService(t)
		defer ts.Cleanup()

		user, err := ts.CreateRegularUser(ctx, "[email protected]")
		require.NoError(t, err)

		resp, err := ts.Service.BatchGetUsers(ctx, &apipb.BatchGetUsersRequest{
			Names: []string{"users/ [email protected] ", "users/[email protected]", "users/[email protected]"},
		})
		require.NoError(t, err)
		require.Len(t, resp.Users, 1)
		require.Equal(t, user.Username, resp.Users[0].Username)
		require.Equal(t, "users/[email protected]", resp.Users[0].Name)
	})

	t.Run("BatchGetUsers accepts underscore legacy username", func(t *testing.T) {
		ts := NewTestService(t)
		defer ts.Cleanup()

		user, err := ts.CreateRegularUser(ctx, "legacy_batch")
		require.NoError(t, err)

		resp, err := ts.Service.BatchGetUsers(ctx, &apipb.BatchGetUsersRequest{
			Names: []string{"users/legacy_batch"},
		})
		require.NoError(t, err)
		require.Len(t, resp.Users, 1)
		require.Equal(t, user.Username, resp.Users[0].Username)
		require.Equal(t, "users/legacy_batch", resp.Users[0].Name)
	})

	t.Run("ListUserSettings accepts email-like username in parent", func(t *testing.T) {
		ts := NewTestService(t)
		defer ts.Cleanup()

		user, err := ts.CreateRegularUser(ctx, "[email protected]")
		require.NoError(t, err)

		userCtx := ts.CreateUserContext(ctx, user.ID)
		resp, err := ts.Service.ListUserSettings(userCtx, &apipb.ListUserSettingsRequest{
			Parent: "users/[email protected]",
		})
		require.NoError(t, err)
		require.NotNil(t, resp)
		require.NotEmpty(t, resp.UserSettings)
	})

	t.Run("UpdateUser can change non-username fields for email-like username", func(t *testing.T) {
		ts := NewTestService(t)
		defer ts.Cleanup()

		user, err := ts.CreateRegularUser(ctx, "[email protected]")
		require.NoError(t, err)

		authCtx := ts.CreateUserContext(ctx, user.ID)
		updated, err := ts.Service.UpdateUser(authCtx, &apipb.UpdateUserRequest{
			User: &apipb.User{
				Name:        "users/[email protected]",
				DisplayName: "Alice Example",
			},
			UpdateMask: &fieldmaskpb.FieldMask{Paths: []string{"display_name"}},
		})
		require.NoError(t, err)
		require.Equal(t, "Alice Example", updated.DisplayName)
		require.Equal(t, "users/[email protected]", updated.Name)
	})

	t.Run("UpdateUser can rename email-like username to valid username", func(t *testing.T) {
		ts := NewTestService(t)
		defer ts.Cleanup()

		user, err := ts.CreateRegularUser(ctx, "[email protected]")
		require.NoError(t, err)

		authCtx := ts.CreateUserContext(ctx, user.ID)
		updated, err := ts.Service.UpdateUser(authCtx, &apipb.UpdateUserRequest{
			User: &apipb.User{
				Name:     "users/[email protected]",
				Username: "bob",
			},
			UpdateMask: &fieldmaskpb.FieldMask{Paths: []string{"username"}},
		})
		require.NoError(t, err)
		require.Equal(t, "bob", updated.Username)
		require.Equal(t, api.BuildUserName("bob"), updated.Name)

		stored, err := ts.Store.GetUser(ctx, &store.FindUser{ID: &user.ID})
		require.NoError(t, err)
		require.NotNil(t, stored)
		require.Equal(t, "bob", stored.Username)
	})

	t.Run("UpdateUser rejects writing invalid username values", func(t *testing.T) {
		for _, username := range []string{"[email protected]", "legacy_user"} {
			t.Run(username, func(t *testing.T) {
				ts := NewTestService(t)
				defer ts.Cleanup()

				user, err := ts.CreateRegularUser(ctx, "[email protected]")
				require.NoError(t, err)

				authCtx := ts.CreateUserContext(ctx, user.ID)
				_, err = ts.Service.UpdateUser(authCtx, &apipb.UpdateUserRequest{
					User: &apipb.User{
						Name:     "users/[email protected]",
						Username: username,
					},
					UpdateMask: &fieldmaskpb.FieldMask{Paths: []string{"username"}},
				})
				require.Error(t, err)
				require.Contains(t, err.Error(), "invalid username")

				stored, err := ts.Store.GetUser(ctx, &store.FindUser{ID: &user.ID})
				require.NoError(t, err)
				require.NotNil(t, stored)
				require.Equal(t, "[email protected]", stored.Username)
			})
		}
	})

	t.Run("admin cannot rename user to invalid username", func(t *testing.T) {
		ts := NewTestService(t)
		defer ts.Cleanup()

		user, err := ts.CreateRegularUser(ctx, "admin-rename-target")
		require.NoError(t, err)
		admin, err := ts.CreateHostUser(ctx, "rename-admin")
		require.NoError(t, err)

		adminCtx := ts.CreateUserContext(ctx, admin.ID)
		_, err = ts.Service.UpdateUser(adminCtx, &apipb.UpdateUserRequest{
			User: &apipb.User{
				Name:     api.BuildUserName(user.Username),
				Username: "[email protected]",
			},
			UpdateMask: &fieldmaskpb.FieldMask{Paths: []string{"username"}},
		})
		require.Error(t, err)
		require.Contains(t, err.Error(), "invalid username")

		stored, err := ts.Store.GetUser(ctx, &store.FindUser{ID: &user.ID})
		require.NoError(t, err)
		require.NotNil(t, stored)
		require.Equal(t, "admin-rename-target", stored.Username)
	})

	t.Run("UpdateUser can archive email-like username account", func(t *testing.T) {
		ts := NewTestService(t)
		defer ts.Cleanup()

		user, err := ts.CreateRegularUser(ctx, "[email protected]")
		require.NoError(t, err)
		admin, err := ts.CreateHostUser(ctx, "email-admin")
		require.NoError(t, err)

		authCtx := ts.CreateUserContext(ctx, admin.ID)
		updated, err := ts.Service.UpdateUser(authCtx, &apipb.UpdateUserRequest{
			User: &apipb.User{
				Name:  "users/[email protected]",
				State: apipb.State_ARCHIVED,
			},
			UpdateMask: &fieldmaskpb.FieldMask{Paths: []string{"state"}},
		})
		require.NoError(t, err)
		require.Equal(t, apipb.State_ARCHIVED, updated.State)

		stored, err := ts.Store.GetUser(ctx, &store.FindUser{ID: &user.ID})
		require.NoError(t, err)
		require.NotNil(t, stored)
		require.Equal(t, store.Archived, stored.RowStatus)
	})

	t.Run("DeleteUser can remove email-like username account", func(t *testing.T) {
		ts := NewTestService(t)
		defer ts.Cleanup()

		user, err := ts.CreateRegularUser(ctx, "[email protected]")
		require.NoError(t, err)

		authCtx := ts.CreateUserContext(api.WithHeaderCarrier(ctx), user.ID)
		_, err = ts.Service.DeleteUser(authCtx, &apipb.DeleteUserRequest{
			Name: "users/[email protected]",
		})
		require.NoError(t, err)

		deleted, err := ts.Store.GetUser(ctx, &store.FindUser{ID: &user.ID})
		require.NoError(t, err)
		require.Nil(t, deleted)
	})
}

func createLegacyPasswordUser(ctx context.Context, t *testing.T, ts *TestService, username, password string) *store.User {
	passwordHash, err := bcrypt.GenerateFromPassword([]byte(password), bcrypt.DefaultCost)
	require.NoError(t, err)

	user, err := ts.Store.CreateUser(ctx, &store.User{
		Username:     username,
		Role:         store.RoleUser,
		Email:        username,
		PasswordHash: string(passwordHash),
	})
	require.NoError(t, err)
	return user
}