New report router and user reporting refactoring (#25713)

* Added materialized view migration

* Renamed mat view

* Added channel membership mat view and indexes

* Added channel membership mat view and indexes

* Added new index

* WIP

* Simplifying user reporting code

* Created app and API layer for cahnnel reporting, reporting refactoring in general

* New router

* Remobved channel reporting meanwhile

* Upodated autogenerated stuff

* Lint fix

* Fixed typo

* api vet

* i18n fix

* Fixed API vetting and removed channel reporting constants

* yaml

* removed app pagination tests

server/channels/app/report.go

@@ -0,0 +1,32 @@
+// Copyright (c) 2015-present Mattermost, Inc. All Rights Reserved.
+// See LICENSE.txt for license information.
+
+package app
+
+import (
+	"net/http"
+
+	"github.com/mattermost/mattermost/server/public/model"
+)
+
+func (a *App) GetUsersForReporting(filter *model.UserReportOptions) ([]*model.UserReport, *model.AppError) {
+	if appErr := filter.IsValid(); appErr != nil {
+		return nil, appErr
+	}
+
+	return a.getUserReport(filter)
+}
+
+func (a *App) getUserReport(filter *model.UserReportOptions) ([]*model.UserReport, *model.AppError) {
+	userReportQuery, err := a.Srv().Store().User().GetUserReport(filter)
+	if err != nil {
+		return nil, model.NewAppError("GetUsersForReporting", "app.report.get_user_report.store_error", nil, "", http.StatusInternalServerError).Wrap(err)
+	}
+
+	userReports := make([]*model.UserReport, len(userReportQuery))
+	for i, user := range userReportQuery {
+		userReports[i] = user.ToReport()
+	}
+
+	return userReports, nil
+}

server/channels/app/user.go

@@ -24,7 +24,6 @@ import (
 	"github.com/mattermost/mattermost/server/public/shared/i18n"
 	"github.com/mattermost/mattermost/server/public/shared/mlog"
 	"github.com/mattermost/mattermost/server/public/shared/request"
-	pUtils "github.com/mattermost/mattermost/server/public/utils"
 	"github.com/mattermost/mattermost/server/v8/channels/app/email"
 	"github.com/mattermost/mattermost/server/v8/channels/app/imaging"
 	"github.com/mattermost/mattermost/server/v8/channels/app/users"
@@ -2818,36 +2817,3 @@ func (a *App) UserIsFirstAdmin(user *model.User) bool {
 
 	return true
 }
-
-func (a *App) GetUsersForReporting(filter *model.UserReportOptions) ([]*model.UserReport, *model.AppError) {
-	// Don't allow fetching more than 100 users at a time from the normal query endpoint
-	if filter.PageSize <= 0 || filter.PageSize > 100 {
-		return nil, model.NewAppError("GetUsersForReporting", "app.user.get_users_for_reporting.invalid_page_size", nil, "", http.StatusBadRequest)
-	}
-
-	// Validate date range
-	if filter.EndAt > 0 && filter.StartAt > filter.EndAt {
-		return nil, model.NewAppError("GetUsersForReporting", "app.user.get_users_for_reporting.bad_date_range", nil, "", http.StatusBadRequest)
-	}
-
-	return a.getUserReport(filter)
-}
-
-func (a *App) getUserReport(filter *model.UserReportOptions) ([]*model.UserReport, *model.AppError) {
-	// Validate against the columns we allow sorting for
-	if !pUtils.Contains(model.UserReportSortColumns, filter.SortColumn) {
-		return nil, model.NewAppError("GetUsersForReporting", "app.user.get_user_report.invalid_sort_column", nil, "", http.StatusBadRequest)
-	}
-
-	userReportQuery, err := a.Srv().Store().User().GetUserReport(filter)
-	if err != nil {
-		return nil, model.NewAppError("GetUsersForReporting", "app.user.get_user_report.store_error", nil, "", http.StatusInternalServerError).Wrap(err)
-	}
-
-	userReports := make([]*model.UserReport, len(userReportQuery))
-	for i, user := range userReportQuery {
-		userReports[i] = user.ToReport()
-	}
-
-	return userReports, nil
-}

server/channels/app/user_test.go

@@ -1934,31 +1934,17 @@ func TestSendSubscriptionHistoryEvent(t *testing.T) {
 }
 
 func TestGetUsersForReporting(t *testing.T) {
-	t.Run("should throw error on invalid page size", func(t *testing.T) {
-		th := Setup(t).InitBasic()
-		defer th.TearDown()
-
-		userReports, err := th.App.GetUsersForReporting(&model.UserReportOptions{
-			UserReportOptionsWithoutDateRange: model.UserReportOptionsWithoutDateRange{
-				SortColumn: "Username",
-				PageSize:   999,
-			},
-		})
-		require.Error(t, err)
-		require.Nil(t, userReports)
-	})
-
 	t.Run("should throw error on invalid date range", func(t *testing.T) {
 		th := Setup(t).InitBasic()
 		defer th.TearDown()
 
 		userReports, err := th.App.GetUsersForReporting(&model.UserReportOptions{
-			UserReportOptionsWithoutDateRange: model.UserReportOptionsWithoutDateRange{
+			ReportingBaseOptions: model.ReportingBaseOptions{
 				SortColumn: "Username",
 				PageSize:   50,
+				StartAt:    1000,
+				EndAt:      500,
 			},
-			StartAt: 1000,
-			EndAt:   500,
 		})
 		require.Error(t, err)
 		require.Nil(t, userReports)
@@ -1969,7 +1955,7 @@ func TestGetUsersForReporting(t *testing.T) {
 		defer th.TearDown()
 
 		userReports, err := th.App.GetUsersForReporting(&model.UserReportOptions{
-			UserReportOptionsWithoutDateRange: model.UserReportOptionsWithoutDateRange{
+			ReportingBaseOptions: model.ReportingBaseOptions{
 				SortColumn: "FakeColumn",
 				PageSize:   50,
 			},
@@ -2015,7 +2001,7 @@ func TestGetUsersForReporting(t *testing.T) {
 		mockStore.On("User").Return(&mockUserStore)
 
 		userReports, err := th.App.GetUsersForReporting(&model.UserReportOptions{
-			UserReportOptionsWithoutDateRange: model.UserReportOptionsWithoutDateRange{
+			ReportingBaseOptions: model.ReportingBaseOptions{
 				SortColumn: "Username",
 				PageSize:   50,
 			},