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
2023-12-14 21:19:19 +05:30
--- a/api/Makefile
+++ b/api/Makefile
@@ -50,6 +50,7 @@ build-v4: node_modules playbooks
 	@cat $(V4_SRC)/imports.yaml >> $(V4_YAML)
 	@cat $(V4_SRC)/exports.yaml >> $(V4_YAML)
 	@cat $(V4_SRC)/ip_filters.yaml >> $(V4_YAML)
+	@cat $(V4_SRC)/reports.yaml >> $(V4_YAML)
 	@if [ -r $(PLAYBOOKS_SRC)/paths.yaml ]; then cat $(PLAYBOOKS_SRC)/paths.yaml >> $(V4_YAML); fi
 	@if [ -r $(PLAYBOOKS_SRC)/merged-definitions.yaml ]; then cat $(PLAYBOOKS_SRC)/merged-definitions.yaml >> $(V4_YAML); else cat $(V4_SRC)/definitions.yaml >> $(V4_YAML); fi
 	@echo Extracting code samples
--- a/api/v4/source/reports.yaml
+++ b/api/v4/source/reports.yaml
@@ -0,0 +1,94 @@
+  /api/v4/reports/users:
+    get:
+      tags:
+        - users
+      summary: Get a list of paged and sorted users for admin reporting purposes
+      description: >
+        Get a list of paged users for admin reporting purposes, based on provided parameters.
+        
+        Must be a system admin to invoke this API.
+        
+        ##### Permissions
+        
+        Requires `sysconsole_read_user_management_users`.
+
+      operationId: GetUsersForReporting
+      parameters:
+        - name: sort_column
+          in: query
+          description: The column to sort the users by. Must be one of ("CreateAt", "Username", "FirstName", "LastName", "Nickname", "Email") or the API will return an error.
+          schema:
+            type: string
+            default: 'Username'
+        - name: sort_direction
+          in: query
+          description: The sorting direction. Must be one of ("asc", "desc"). Will default to 'asc' if not specified or the input is invalid.
+          schema:
+            type: string
+            default: 'asc'
+        - name: page_size
+          in: query
+          description: The maximum number of users to return.
+          schema:
+            type: integer
+            default: 50
+            minimum: 1
+            maximum: 100
+        - name: last_column_value
+          in: query
+          description: The value of the sorted column belonging to the last user returned in the page. Should be blank for the first page asked for.
+          schema:
+            type: string
+        - name: last_id
+          in: query
+          description: The value of the user id belonging to the last user returned in the page. Should be blank for the first page asked for.
+          schema:
+            type: string
+        - name: date_range
+          in: query
+          description: The date range of the post statistics to display. Must be one of ("last30days", "previousmonth", "last6months", "alltime"). Will default to 'alltime' if the input is not valid.
+          schema:
+            type: string
+            default: 'alltime'
+        - name: role_filter
+          in: query
+          description: Filter users by their role.
+          schema:
+            type: string
+        - name: team_filter
+          in: query
+          description: Filter users by a specified team ID.
+          schema:
+            type: string
+        - name: has_no_team
+          in: query
+          description: If true, show only users that have no team. Will ignore provided "team_filter" if true.
+          schema:
+            type: boolean
+        - name: hide_active
+          in: query
+          description: If true, show only users that are inactive. Cannot be used at the same time as "hide_inactive"
+          schema:
+            type: boolean
+        - name: hide_inactive
+          in: query
+          description: If true, show only users that are active. Cannot be used at the same time as "hide_active"
+          schema:
+            type: boolean
+      responses:
+        "200":
+          description: User page retrieval successful
+          content:
+            application/json:
+              schema:
+                type: array
+                items:
+                  $ref: "#/components/schemas/UserReport"
+        "400":
+          $ref: "#/components/responses/BadRequest"
+        "401":
+          $ref: "#/components/responses/Unauthorized"
+        "403":
+          $ref: "#/components/responses/Forbidden"
+        "500":
+          $ref: "#/components/responses/InternalServerError"
--- a/api/v4/source/users.yaml
+++ b/api/v4/source/users.yaml
@@ -3251,97 +3251,3 @@
          $ref: "#/components/responses/Unauthorized"
        "403":
          $ref: "#/components/responses/Forbidden"
-  /api/v4/users/report:
-    get:
-      tags:
-        - users
-      summary: Get a list of paged and sorted users for admin reporting purposes
-      description: >
-        Get a list of paged users for admin reporting purposes, based on provided parameters.
-
-        Must be a system admin to invoke this API.
-
-        ##### Permissions
-
-        Requires `sysconsole_read_user_management_users`.
-
-      operationId: GetUsersForReporting
-      parameters:
-        - name: sort_column
-          in: query
-          description: The column to sort the users by. Must be one of ("CreateAt", "Username", "FirstName", "LastName", "Nickname", "Email") or the API will return an error.
-          schema:
-            type: string
-            default: 'Username'
-        - name: sort_direction
-          in: query
-          description: The sorting direction. Must be one of ("asc", "desc"). Will default to 'asc' if not specified or the input is invalid.
-          schema:
-            type: string
-            default: 'asc'
-        - name: page_size
-          in: query
-          description: The maximum number of users to return.
-          schema:
-            type: integer
-            default: 50
-            minimum: 1
-            maximum: 100
-        - name: last_column_value
-          in: query
-          description: The value of the sorted column belonging to the last user returned in the page. Should be blank for the first page asked for.
-          schema:
-            type: string
-        - name: last_id
-          in: query
-          description: The value of the user id belonging to the last user returned in the page. Should be blank for the first page asked for.
-          schema:
-            type: string
-        - name: date_range
-          in: query
-          description: The date range of the post statistics to display. Must be one of ("last30days", "previousmonth", "last6months", "alltime"). Will default to 'alltime' if the input is not valid.
-          schema:
-            type: string
-            default: 'alltime'
-        - name: role_filter
-          in: query
-          description: Filter users by their role.
-          schema:
-            type: string
-        - name: team_filter
-          in: query
-          description: Filter users by a specified team ID.
-          schema:
-            type: string
-        - name: has_no_team
-          in: query
-          description: If true, show only users that have no team. Will ignore provided "team_filter" if true.
-          schema:
-            type: boolean
-        - name: hide_active
-          in: query
-          description: If true, show only users that are inactive. Cannot be used at the same time as "hide_inactive"
-          schema:
-            type: boolean
-        - name: hide_inactive
-          in: query
-          description: If true, show only users that are active. Cannot be used at the same time as "hide_active"
-          schema:
-            type: boolean
-      responses:
-        "200":
-          description: User page retrieval successful
-          content:
-            application/json:
-              schema:
-                type: array
-                items:
-                  $ref: "#/components/schemas/UserReport"
-        "400":
-          $ref: "#/components/responses/BadRequest"
-        "401":
-          $ref: "#/components/responses/Unauthorized"
-        "403":
-          $ref: "#/components/responses/Forbidden"
-        "500":
-          $ref: "#/components/responses/InternalServerError"