chore(api-service,dashboard): Replace create_at sorting with _id for …

…subscribers
novuhq · Jan 29, 2025 · b600c92 · b600c92
1 parent 94ef255
commit b600c92
Show file tree

Hide file tree

Showing 10 changed files with 193 additions and 227 deletions.
diff --git a/apps/api/src/app/subscribers-v2/subscriber.controller.e2e.ts b/apps/api/src/app/subscribers-v2/subscriber.controller.e2e.ts
diff --git a/apps/api/src/app/subscribers-v2/subscriber.controller.ts b/apps/api/src/app/subscribers-v2/subscriber.controller.ts
@@ -28,7 +28,7 @@ export class SubscriberController {
         after: query.after,
         before: query.before,
         orderDirection: query.orderDirection || DirectionEnum.DESC,
-        orderBy: query.orderBy || 'createdAt',
+        orderBy: query.orderBy || '_id',
         email: query.email,
         phone: query.phone,
         subscriberId: query.subscriberId,

diff --git a/apps/api/src/app/subscribers-v2/usecases/list-subscribers/list-subscribers.command.ts b/apps/api/src/app/subscribers-v2/usecases/list-subscribers/list-subscribers.command.ts
@@ -7,9 +7,9 @@ export class ListSubscribersCommand extends CursorBasedPaginatedCommand {
   @IsOptional()
   orderDirection: DirectionEnum = DirectionEnum.DESC;
 
-  @IsEnum(['updatedAt', 'createdAt'])
+  @IsEnum(['updatedAt', '_id'])
   @IsOptional()
-  orderBy: 'updatedAt' | 'createdAt' = 'createdAt';
+  orderBy: 'updatedAt' | '_id' = '_id';
 
   @IsString()
   @IsOptional()

diff --git a/apps/dashboard/src/components/subscribers/subscriber-list.tsx b/apps/dashboard/src/components/subscribers/subscriber-list.tsx
@@ -50,8 +50,8 @@ const SubscriberListTable = (props: SubscriberListTableProps) => {
           <TableHead>Phone number</TableHead>
           <TableHead
             sortable
-            sortDirection={orderBy === 'createdAt' ? orderDirection : false}
-            onSort={() => toggleSort('createdAt')}
+            sortDirection={orderBy === '_id' ? orderDirection : false}
+            onSort={() => toggleSort('_id')}
           >
             Created at
           </TableHead>

diff --git a/apps/dashboard/src/hooks/use-fetch-subscribers.ts b/apps/dashboard/src/hooks/use-fetch-subscribers.ts
@@ -25,7 +25,7 @@ export function useFetchSubscribers(
     email = '',
     phone = '',
     orderDirection = DirectionEnum.DESC,
-    orderBy = 'createdAt',
+    orderBy = '_id',
     name = '',
     subscriberId = '',
     limit = 10,

diff --git a/apps/dashboard/src/hooks/use-subscribers-url-state.ts b/apps/dashboard/src/hooks/use-subscribers-url-state.ts
@@ -3,7 +3,7 @@ import { useCallback, useMemo } from 'react';
 import { useNavigate, useSearchParams } from 'react-router-dom';
 import { useDebounce } from '../hooks/use-debounce';
 
-export type SubscribersSortableColumn = 'createdAt' | 'updatedAt';
+export type SubscribersSortableColumn = '_id' | 'updatedAt';
 export interface SubscribersFilter {
   email?: string;
   phone?: string;
@@ -16,15 +16,15 @@ export interface SubscribersFilter {
   orderDirection?: DirectionEnum;
 }
 
-export const defaultSubscribersFilter: SubscribersFilter = {
+export const defaultSubscribersFilter: Required<SubscribersFilter> = {
   email: '',
   phone: '',
   name: '',
   subscriberId: '',
   limit: 10,
   after: '',
   before: '',
-  orderBy: 'createdAt',
+  orderBy: '_id',
   orderDirection: DirectionEnum.DESC,
 };
 
@@ -54,10 +54,10 @@ export function useSubscribersUrlState(props: UseSubscribersUrlStateProps): Subs
       phone: searchParams.get('phone') || '',
       name: searchParams.get('name') || '',
       subscriberId: searchParams.get('subscriberId') || '',
-      limit: parseInt(searchParams.get('limit') || '10', 10),
+      limit: parseInt(searchParams.get('limit') || defaultSubscribersFilter.limit.toString(), 10),
       after: searchParams.get('after') || '',
       before: searchParams.get('before') || '',
-      orderBy: (searchParams.get('orderBy') as SubscribersSortableColumn) || 'createdAt',
+      orderBy: (searchParams.get('orderBy') as SubscribersSortableColumn) || defaultSubscribersFilter.orderBy,
       orderDirection: (searchParams.get('orderDirection') as DirectionEnum) || DirectionEnum.DESC,
     }),
     [searchParams]

diff --git a/libs/dal/src/repositories/subscriber/subscriber.repository.ts b/libs/dal/src/repositories/subscriber/subscriber.repository.ts
@@ -165,7 +165,7 @@ export class SubscriberRepository extends BaseRepository<SubscriberDBModel, Subs
     environmentId: string;
     organizationId: string;
     limit: number;
-    sortBy: 'updatedAt' | 'createdAt';
+    sortBy: 'updatedAt' | '_id';
     sortDirection: DirectionEnum;
     after?: string;
     before?: string;
@@ -187,7 +187,11 @@ export class SubscriberRepository extends BaseRepository<SubscriberDBModel, Subs
         _id: id,
       });
       if (!subscriber) {
-        throw new DalException('Subscriber not found');
+        return {
+          subscribers: [],
+          next: null,
+          previous: null,
+        };
       }
     }
 

diff --git a/libs/dal/src/repositories/subscriber/subscriber.schema.ts b/libs/dal/src/repositories/subscriber/subscriber.schema.ts
@@ -193,20 +193,6 @@ subscriberSchema.index({
   deleted: 1,
 });
 
-subscriberSchema.index({
-  _environmentId: 1,
-  _organizationId: 1,
-  createdAt: 1,
-  _id: 1,
-});
-
-subscriberSchema.index({
-  _environmentId: 1,
-  _organizationId: 1,
-  createdAt: -1,
-  _id: -1,
-});
-
 subscriberSchema.index({
   _environmentId: 1,
   _organizationId: 1,
@@ -217,8 +203,7 @@ subscriberSchema.index({
 subscriberSchema.index({
   _environmentId: 1,
   _organizationId: 1,
-  updatedAt: -1,
-  _id: -1,
+  _id: 1,
 });
 
 subscriberSchema.plugin(mongooseDelete, { deletedAt: true, deletedBy: true, overrideMethods: 'all' });

diff --git a/libs/testing/src/user.session.ts b/libs/testing/src/user.session.ts
@@ -41,6 +41,7 @@ import { ClerkJwtPayload } from './ee/types';
 type UserSessionOptions = {
   noOrganization?: boolean;
   noEnvironment?: boolean;
+  noWidgetSession?: boolean;
   showOnBoardingTour?: boolean;
   ee?: {
     userId: 'clerk_user_1' | 'clerk_user_2';
@@ -125,7 +126,7 @@ export class UserSession {
       await this.addOrganizationCommunity();
     }
 
-    if (!options.noOrganization && !options?.noEnvironment) {
+    if (!options.noOrganization && !options?.noEnvironment && !options.noWidgetSession) {
       await this.createEnvironmentsAndFeeds();
     }
 
@@ -137,7 +138,7 @@ export class UserSession {
       }
     }
 
-    if (!options.noOrganization && !options.noEnvironment) {
+    if (!options.noOrganization && !options.noEnvironment && !options.noWidgetSession) {
       const { token, profile } = await this.initializeWidgetSession();
       this.subscriberToken = token;
       this.subscriberProfile = profile;
@@ -179,7 +180,7 @@ export class UserSession {
       }
     }
 
-    if (!options.noOrganization && !options.noEnvironment) {
+    if (!options.noOrganization && !options.noEnvironment && !options.noWidgetSession) {
       const { token, profile } = await this.initializeWidgetSession();
       this.subscriberToken = token;
       this.subscriberProfile = profile;

diff --git a/packages/shared/src/dto/subscriber/list-subscribers.dto.ts b/packages/shared/src/dto/subscriber/list-subscribers.dto.ts
@@ -10,7 +10,7 @@ export interface IListSubscribersRequestDto {
 
   orderDirection: DirectionEnum;
 
-  orderBy: 'updatedAt' | 'createdAt';
+  orderBy: 'updatedAt' | '_id';
 
   email?: string;