Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Count active browser sessions per user #8736

Merged
merged 10 commits into from
Nov 13, 2024
Merged
Changes from 6 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions src/lib/db/session-store.ts
Original file line number Diff line number Diff line change
@@ -110,6 +110,18 @@ export default class SessionStore implements ISessionStore {
expired: row.expired,
};
}

async getUserSessionsCount(): Promise<{ userId: number; count: number }[]> {
const rows = await this.db(TABLE)
.select(this.db.raw("sess->'user'->>'id' AS user_id"))
.count('* as count')
.groupBy('user_id');

return rows.map((row) => ({
userId: Number.parseInt(`${row.user_id}`, 10),
count: Number.parseInt(`${row.count}`, 10),
}));
}
}

module.exports = SessionStore;
6 changes: 6 additions & 0 deletions src/lib/openapi/spec/user-schema.ts
Original file line number Diff line number Diff line change
@@ -99,6 +99,12 @@ export const userSchema = {
nullable: true,
example: '01HTMEXAMPLESCIMID7SWWGHN6',
},
activeSessions: {
description: 'The number of active sessions for this user',
type: 'integer',
nullable: true,
example: 2,
},
},
components: {},
} as const;
8 changes: 8 additions & 0 deletions src/lib/services/session-service.ts
Original file line number Diff line number Diff line change
@@ -63,6 +63,14 @@ export default class SessionService {
}: Pick<ISession, 'sid' | 'sess'>): Promise<ISession> {
return this.sessionStore.insertSession({ sid, sess });
}

async getUserSessionsCount() {
return Object.fromEntries(
(await this.sessionStore.getUserSessionsCount()).map(
({ userId, count }) => [userId, count],
),
);
}
}

module.exports = SessionService;
10 changes: 10 additions & 0 deletions src/lib/services/user-service.ts
Original file line number Diff line number Diff line change
@@ -209,6 +209,16 @@ class UserService {
const roleId = rootRole ? rootRole.roleId : defaultRole.id;
return { ...u, rootRole: roleId };
});
if (this.flagResolver.isEnabled('showUserDeviceCount')) {
const sessionCounts =
await this.sessionService.getUserSessionsCount();
const usersWithSessionCounts = usersWithRootRole.map((u) => ({
...u,
activeSessions: sessionCounts[u.id] || 0,
}));
return usersWithSessionCounts;
}

return usersWithRootRole;
}

5 changes: 5 additions & 0 deletions src/lib/types/experimental.ts
Original file line number Diff line number Diff line change
@@ -59,6 +59,7 @@ export type IFlagKey =
| 'enterprise-payg'
| 'simplifyProjectOverview'
| 'flagOverviewRedesign'
| 'showUserDeviceCount'
| 'deleteStaleUserSessions';

export type IFlags = Partial<{ [key in IFlagKey]: boolean | Variant }>;
@@ -283,6 +284,10 @@ const flags: IFlags = {
process.env.UNLEASH_EXPERIMENTAL_FLAG_OVERVIEW_REDESIGN,
false,
),
showUserDeviceCount: parseEnvVarBoolean(
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

seems to be inconsistent. We have user session count not device count in the code

process.env.UNLEASH_EXPERIMENTAL_SHOW_USER_DEVICE_COUNT,
false,
),
};

export const defaultExperimentalOptions: IExperimentalOptions = {
1 change: 1 addition & 0 deletions src/lib/types/stores/session-store.ts
Original file line number Diff line number Diff line change
@@ -12,4 +12,5 @@ export interface ISessionStore extends Store<ISession, string> {
getSessionsForUser(userId: number): Promise<ISession[]>;
deleteSessionsForUser(userId: number): Promise<void>;
insertSession(data: Omit<ISession, 'createdAt'>): Promise<ISession>;
getUserSessionsCount(): Promise<{ userId: number; count: number }[]>;
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

maybe getSessionCount to be consistent with insertSessions? We have ForUser in the name only when there's a param userId

Copy link
Member Author

@Tymek Tymek Nov 13, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

getSessionsCount is OK

}
1 change: 1 addition & 0 deletions src/server-dev.ts
Original file line number Diff line number Diff line change
@@ -55,6 +55,7 @@ process.nextTick(async () => {
webhookDomainLogging: true,
releasePlans: false,
simplifyProjectOverview: true,
showUserDeviceCount: true,
flagOverviewRedesign: true,
},
},
34 changes: 34 additions & 0 deletions src/test/e2e/api/admin/user-admin.e2e.test.ts
Original file line number Diff line number Diff line change
@@ -38,6 +38,7 @@ beforeAll(async () => {
experimental: {
flags: {
strictSchemaValidation: true,
showUserDeviceCount: true,
},
},
});
@@ -428,3 +429,36 @@ test('creates user with email md5 hash', async () => {

expect(user.email_hash).toBe(expectedHash);
});

test('should return number of sessions per user', async () => {
const user = await userStore.insert({ email: 'tester@example.com' });
await sessionStore.insertSession({
sid: '1',
sess: { user: { id: user.id } },
});
await sessionStore.insertSession({
sid: '2',
sess: { user: { id: user.id } },
});

const user2 = await userStore.insert({ email: 'tester2@example.com' });
await sessionStore.insertSession({
sid: '3',
sess: { user: { id: user2.id } },
});

const response = await app.request.get(`/api/admin/user-admin`).expect(200);

expect(response.body).toMatchObject({
users: expect.arrayContaining([
expect.objectContaining({
email: 'tester@example.com',
activeSessions: 2,
}),
expect.objectContaining({
email: 'tester2@example.com',
activeSessions: 1,
}),
]),
});
});
4 changes: 4 additions & 0 deletions src/test/fixtures/fake-session-store.ts
Original file line number Diff line number Diff line change
@@ -52,4 +52,8 @@ export default class FakeSessionStore implements ISessionStore {
this.sessions.push(session);
return session;
}

async getUserSessionsCount(): Promise<{ userId: number; count: number }[]> {
return [];
}
}