The Open Source DocuSign Alternative.
TypeScript digital-signaturedocument-signingdocusign-alternativee-signatureesignesignaturenext-authnextjsopen-sourcepades-standardpdfpdf-signpdf-signaturepostgresqlprismaself-hostedsigningtypescript
perf: add database indexes for insights queries (#2211)
Ephraim Duncan94646cd48ace
diff --git a/apps/remix/app/routes/_authenticated+/admin+/organisation-insights._index.tsx b/apps/remix/app/routes/_authenticated+/admin+/organisation-insights._index.tsxindex ed2908be6..1e8783599 100644--- a/apps/remix/app/routes/_authenticated+/admin+/organisation-insights._index.tsx+++ b/apps/remix/app/routes/_authenticated+/admin+/organisation-insights._index.tsx@@ -44,7 +44,7 @@ export async function loader({ request }: Route.LoaderArgs) {const typedOrganisations: OrganisationOverview[] = organisations.map((item) => ({id: String(item.id),name: item.name || '',- signingVolume: item.signingVolume,+ signingVolume: item.signingVolume || 0,createdAt: item.createdAt || new Date(),customerId: item.customerId || '',subscriptionStatus: item.subscriptionStatus,diff --git a/packages/lib/server-only/admin/get-organisation-detailed-insights.ts b/packages/lib/server-only/admin/get-organisation-detailed-insights.tsindex 342fa6b8e..100c32b31 100644--- a/packages/lib/server-only/admin/get-organisation-detailed-insights.ts+++ b/packages/lib/server-only/admin/get-organisation-detailed-insights.ts@@ -116,28 +116,28 @@ async function getTeamInsights(): Promise<OrganisationDetailedInsights> {const teamsQuery = kyselyPrisma.$kysely.selectFrom('Team as t')- .leftJoin('Envelope as e', (join) =>- join- .onRef('t.id', '=', 'e.teamId')- .on('e.deletedAt', 'is', null)- .on('e.type', '=', sql.lit(EnvelopeType.DOCUMENT)),- )- .leftJoin('TeamGroup as tg', 'tg.teamId', 't.id')- .leftJoin('OrganisationGroup as og', 'og.id', 'tg.organisationGroupId')- .leftJoin('OrganisationGroupMember as ogm', 'ogm.groupId', 'og.id')- .leftJoin('OrganisationMember as om', 'om.id', 'ogm.organisationMemberId').where('t.organisationId', '=', organisationId)- .select([- 't.id as id',- 't.name as name',- 't.createdAt as createdAt',- sql<number>`COUNT(DISTINCT om."userId")`.as('memberCount'),- (createdAtFrom- ? sql<number>`COUNT(DISTINCT CASE WHEN e.id IS NOT NULL AND e."createdAt" >= ${createdAtFrom} THEN e.id END)`- : sql<number>`COUNT(DISTINCT e.id)`- ).as('documentCount'),+ .select((eb) => [+ 't.id',+ 't.name',+ 't.createdAt',+ eb+ .selectFrom('TeamGroup as tg')+ .innerJoin('OrganisationGroup as og', 'og.id', 'tg.organisationGroupId')+ .innerJoin('OrganisationGroupMember as ogm', 'ogm.groupId', 'og.id')+ .innerJoin('OrganisationMember as om', 'om.id', 'ogm.organisationMemberId')+ .whereRef('tg.teamId', '=', 't.id')+ .select(sql<number>`count(distinct om."userId")`.as('count'))+ .as('memberCount'),+ eb+ .selectFrom('Envelope as e')+ .whereRef('e.teamId', '=', 't.id')+ .where('e.deletedAt', 'is', null)+ .where('e.type', '=', sql.lit(EnvelopeType.DOCUMENT))+ .$if(!!createdAtFrom, (qb) => qb.where('e.createdAt', '>=', createdAtFrom!))+ .select(sql<number>`count(e.id)`.as('count'))+ .as('documentCount'),])- .groupBy(['t.id', 't.name', 't.createdAt']).orderBy('documentCount', 'desc').limit(perPage).offset(offset);@@ -164,48 +164,38 @@ async function getUserInsights(perPage: number,createdAtFrom: Date | null,): Promise<OrganisationDetailedInsights> {- const usersBase = kyselyPrisma.$kysely+ const usersQuery = kyselyPrisma.$kysely.selectFrom('OrganisationMember as om').innerJoin('User as u', 'u.id', 'om.userId').where('om.organisationId', '=', organisationId)- .leftJoin('Envelope as e', (join) =>- join- .onRef('e.userId', '=', 'u.id')- .on('e.deletedAt', 'is', null)- .on('e.type', '=', sql.lit(EnvelopeType.DOCUMENT)),- )- .leftJoin('Team as td', (join) =>- join.onRef('td.id', '=', 'e.teamId').on('td.organisationId', '=', organisationId),- )- .leftJoin('Recipient as r', (join) =>- join.onRef('r.email', '=', 'u.email').on('r.signedAt', 'is not', null),- )- .leftJoin('Envelope as se', (join) =>- join- .onRef('se.id', '=', 'r.envelopeId')- .on('se.deletedAt', 'is', null)- .on('se.type', '=', sql.lit(EnvelopeType.DOCUMENT)),- )- .leftJoin('Team as ts', (join) =>- join.onRef('ts.id', '=', 'se.teamId').on('ts.organisationId', '=', organisationId),- );-- const usersQuery = usersBase- .select([- 'u.id as id',- 'u.name as name',- 'u.email as email',- 'u.createdAt as createdAt',- (createdAtFrom- ? sql<number>`COUNT(DISTINCT CASE WHEN e.id IS NOT NULL AND td.id IS NOT NULL AND e."createdAt" >= ${createdAtFrom} THEN e.id END)`- : sql<number>`COUNT(DISTINCT CASE WHEN td.id IS NOT NULL THEN e.id END)`- ).as('documentCount'),- (createdAtFrom- ? sql<number>`COUNT(DISTINCT CASE WHEN e.id IS NOT NULL AND td.id IS NOT NULL AND e.status = 'COMPLETED' AND e."createdAt" >= ${createdAtFrom} THEN e.id END)`- : sql<number>`COUNT(DISTINCT CASE WHEN e.id IS NOT NULL AND td.id IS NOT NULL AND e.status = 'COMPLETED' THEN e.id END)`- ).as('signedDocumentCount'),+ .select((eb) => [+ 'u.id',+ 'u.name',+ 'u.email',+ 'u.createdAt',+ eb+ .selectFrom('Envelope as e')+ .innerJoin('Team as t', 't.id', 'e.teamId')+ .whereRef('e.userId', '=', 'u.id')+ .where('t.organisationId', '=', organisationId)+ .where('e.deletedAt', 'is', null)+ .where('e.type', '=', sql.lit(EnvelopeType.DOCUMENT))+ .$if(!!createdAtFrom, (qb) => qb.where('e.createdAt', '>=', createdAtFrom!))+ .select(sql<number>`count(e.id)`.as('count'))+ .as('documentCount'),+ eb+ .selectFrom('Recipient as r')+ .innerJoin('Envelope as e', 'e.id', 'r.envelopeId')+ .innerJoin('Team as t', 't.id', 'e.teamId')+ .whereRef('r.email', '=', 'u.email')+ .where('r.signedAt', 'is not', null)+ .where('t.organisationId', '=', organisationId)+ .where('e.deletedAt', 'is', null)+ .where('e.type', '=', sql.lit(EnvelopeType.DOCUMENT))+ .$if(!!createdAtFrom, (qb) => qb.where('e.createdAt', '>=', createdAtFrom!))+ .select(sql<number>`count(e.id)`.as('count'))+ .as('signedDocumentCount'),])- .groupBy(['u.id', 'u.name', 'u.email', 'u.createdAt']).orderBy('u.createdAt', 'desc').limit(perPage).offset(offset);@@ -292,72 +282,51 @@ async function getOrganisationSummary(organisationId: string,createdAtFrom: Date | null,): Promise<OrganisationSummary> {- const summaryQuery = kyselyPrisma.$kysely- .selectFrom('Organisation as o')- .where('o.id', '=', organisationId)+ const teamCountQuery = kyselyPrisma.$kysely+ .selectFrom('Team')+ .where('organisationId', '=', organisationId)+ .select(sql<number>`count(id)`.as('count'))+ .executeTakeFirst();++ const memberCountQuery = kyselyPrisma.$kysely+ .selectFrom('OrganisationMember')+ .where('organisationId', '=', organisationId)+ .select(sql<number>`count(id)`.as('count'))+ .executeTakeFirst();++ const envelopeStatsQuery = kyselyPrisma.$kysely+ .selectFrom('Envelope as e')+ .innerJoin('Team as t', 't.id', 'e.teamId')+ .where('t.organisationId', '=', organisationId)+ .where('e.deletedAt', 'is', null)+ .where('e.type', '=', sql.lit(EnvelopeType.DOCUMENT)).select([- sql<number>`(SELECT COUNT(DISTINCT t2.id) FROM "Team" AS t2 WHERE t2."organisationId" = o.id)`.as(- 'totalTeams',- ),- sql<number>`(SELECT COUNT(DISTINCT om2."userId") FROM "OrganisationMember" AS om2 WHERE om2."organisationId" = o.id)`.as(- 'totalMembers',+ sql<number>`count(e.id)`.as('totalDocuments'),+ sql<number>`count(case when e.status in ('DRAFT', 'PENDING') then 1 end)`.as(+ 'activeDocuments',),- sql<number>`(- SELECT COUNT(DISTINCT e2.id)- FROM "Envelope" AS e2- INNER JOIN "Team" AS t2 ON t2.id = e2."teamId"- WHERE t2."organisationId" = o.id AND e2."deletedAt" IS NULL AND e2.type = 'DOCUMENT'- )`.as('totalDocuments'),- sql<number>`(- SELECT COUNT(DISTINCT e2.id)- FROM "Envelope" AS e2- INNER JOIN "Team" AS t2 ON t2.id = e2."teamId"- WHERE t2."organisationId" = o.id AND e2."deletedAt" IS NULL AND e2.type = 'DOCUMENT' AND e2.status IN ('DRAFT', 'PENDING')- )`.as('activeDocuments'),- sql<number>`(- SELECT COUNT(DISTINCT e2.id)- FROM "Envelope" AS e2- INNER JOIN "Team" AS t2 ON t2.id = e2."teamId"- WHERE t2."organisationId" = o.id AND e2."deletedAt" IS NULL AND e2.type = 'DOCUMENT' AND e2.status = 'COMPLETED'- )`.as('completedDocuments'),+ sql<number>`count(case when e.status = 'COMPLETED' then 1 end)`.as('completedDocuments'),+ sql<number>`count(case when e.status = 'COMPLETED' then 1 end)`.as('volumeAllTime'),(createdAtFrom- ? sql<number>`(- SELECT COUNT(DISTINCT e2.id)- FROM "Envelope" AS e2- INNER JOIN "Team" AS t2 ON t2.id = e2."teamId"- WHERE t2."organisationId" = o.id- AND e2."deletedAt" IS NULL- AND e2.type = 'DOCUMENT'- AND e2.status = 'COMPLETED'- AND e2."createdAt" >= ${createdAtFrom}- )`- : sql<number>`(- SELECT COUNT(DISTINCT e2.id)- FROM "Envelope" AS e2- INNER JOIN "Team" AS t2 ON t2.id = e2."teamId"- WHERE t2."organisationId" = o.id- AND e2."deletedAt" IS NULL- AND e2.type = 'DOCUMENT'- AND e2.status = 'COMPLETED'- )`+ ? sql<number>`count(case when e.status = 'COMPLETED' and e."createdAt" >= ${createdAtFrom} then 1 end)`+ : sql<number>`count(case when e.status = 'COMPLETED' then 1 end)`).as('volumeThisPeriod'),- sql<number>`(- SELECT COUNT(DISTINCT e2.id)- FROM "Envelope" AS e2- INNER JOIN "Team" AS t2 ON t2.id = e2."teamId"- WHERE t2."organisationId" = o.id AND e2."deletedAt" IS NULL AND e2.type = 'DOCUMENT' AND e2.status = 'COMPLETED'- )`.as('volumeAllTime'),- ]);+ ])+ .executeTakeFirst();- const result = await summaryQuery.executeTakeFirst();+ const [teamCount, memberCount, envelopeStats] = await Promise.all([+ teamCountQuery,+ memberCountQuery,+ envelopeStatsQuery,+ ]);return {- totalTeams: Number(result?.totalTeams || 0),- totalMembers: Number(result?.totalMembers || 0),- totalDocuments: Number(result?.totalDocuments || 0),- activeDocuments: Number(result?.activeDocuments || 0),- completedDocuments: Number(result?.completedDocuments || 0),- volumeThisPeriod: Number(result?.volumeThisPeriod || 0),- volumeAllTime: Number(result?.volumeAllTime || 0),+ totalTeams: Number(teamCount?.count || 0),+ totalMembers: Number(memberCount?.count || 0),+ totalDocuments: Number(envelopeStats?.totalDocuments || 0),+ activeDocuments: Number(envelopeStats?.activeDocuments || 0),+ completedDocuments: Number(envelopeStats?.completedDocuments || 0),+ volumeThisPeriod: Number(envelopeStats?.volumeThisPeriod || 0),+ volumeAllTime: Number(envelopeStats?.volumeAllTime || 0),};}diff --git a/packages/lib/server-only/admin/get-signing-volume.ts b/packages/lib/server-only/admin/get-signing-volume.tsindex 71edce8b5..e85fbf508 100644--- a/packages/lib/server-only/admin/get-signing-volume.ts+++ b/packages/lib/server-only/admin/get-signing-volume.ts@@ -33,25 +33,32 @@ export async function getSigningVolume({let findQuery = kyselyPrisma.$kysely.selectFrom('Organisation as o')- .leftJoin('Team as t', 'o.id', 't.organisationId')- .leftJoin('Envelope as e', (join) =>- join- .onRef('t.id', '=', 'e.teamId')- .on('e.status', '=', sql.lit(DocumentStatus.COMPLETED))- .on('e.deletedAt', 'is', null)- .on('e.type', '=', sql.lit(EnvelopeType.DOCUMENT)),- ).where((eb) =>- eb.or([eb('o.name', 'ilike', `%${search}%`), eb('t.name', 'ilike', `%${search}%`)]),+ eb.or([+ eb('o.name', 'ilike', `%${search}%`),+ eb.exists(+ eb+ .selectFrom('Team as t')+ .whereRef('t.organisationId', '=', 'o.id')+ .where('t.name', 'ilike', `%${search}%`),+ ),+ ]),)- .select([+ .select((eb) => ['o.id as id','o.createdAt as createdAt','o.customerId as customerId',sql<string>`COALESCE(o.name, 'Unknown')`.as('name'),- sql<number>`COUNT(DISTINCT e.id)`.as('signingVolume'),- ])- .groupBy(['o.id', 'o.name', 'o.customerId']);+ eb+ .selectFrom('Envelope as e')+ .innerJoin('Team as t', 't.id', 'e.teamId')+ .whereRef('t.organisationId', '=', 'o.id')+ .where('e.status', '=', sql.lit(DocumentStatus.COMPLETED))+ .where('e.deletedAt', 'is', null)+ .where('e.type', '=', sql.lit(EnvelopeType.DOCUMENT))+ .select(sql<number>`count(e.id)`.as('count'))+ .as('signingVolume'),+ ]);switch (sortBy) {case 'name':@@ -71,11 +78,18 @@ export async function getSigningVolume({const countQuery = kyselyPrisma.$kysely.selectFrom('Organisation as o')- .leftJoin('Team as t', 'o.id', 't.organisationId').where((eb) =>- eb.or([eb('o.name', 'ilike', `%${search}%`), eb('t.name', 'ilike', `%${search}%`)]),+ eb.or([+ eb('o.name', 'ilike', `%${search}%`),+ eb.exists(+ eb+ .selectFrom('Team as t')+ .whereRef('t.organisationId', '=', 'o.id')+ .where('t.name', 'ilike', `%${search}%`),+ ),+ ]),)- .select(() => [sql<number>`COUNT(DISTINCT o.id)`.as('count')]);+ .select(({ fn }) => [fn.countAll().as('count')]);const [results, [{ count }]] = await Promise.all([findQuery.execute(), countQuery.execute()]);@@ -104,64 +118,77 @@ export async function getOrganisationInsights({const offset = Math.max(page - 1, 0) * perPage;const now = new Date();- let dateCondition = sql`1=1`;+ let dateCondition = sql<boolean>`1=1`;if (startDate && endDate) {- dateCondition = sql`e."createdAt" >= ${startDate} AND e."createdAt" <= ${endDate}`;+ dateCondition = sql<boolean>`e."createdAt" >= ${startDate} AND e."createdAt" <= ${endDate}`;} else {switch (dateRange) {case 'last30days': {const thirtyDaysAgo = new Date(now.getTime() - 30 * 24 * 60 * 60 * 1000);- dateCondition = sql`e."createdAt" >= ${thirtyDaysAgo}`;+ dateCondition = sql<boolean>`e."createdAt" >= ${thirtyDaysAgo}`;break;}case 'last90days': {const ninetyDaysAgo = new Date(now.getTime() - 90 * 24 * 60 * 60 * 1000);- dateCondition = sql`e."createdAt" >= ${ninetyDaysAgo}`;+ dateCondition = sql<boolean>`e."createdAt" >= ${ninetyDaysAgo}`;break;}case 'lastYear': {const oneYearAgo = new Date(now.getFullYear() - 1, now.getMonth(), now.getDate());- dateCondition = sql`e."createdAt" >= ${oneYearAgo}`;+ dateCondition = sql<boolean>`e."createdAt" >= ${oneYearAgo}`;break;}case 'allTime':default:- dateCondition = sql`1=1`;+ dateCondition = sql<boolean>`1=1`;break;}}let findQuery = kyselyPrisma.$kysely.selectFrom('Organisation as o')- .leftJoin('Team as t', 'o.id', 't.organisationId')- .leftJoin('Envelope as e', (join) =>- join- .onRef('t.id', '=', 'e.teamId')- .on('e.status', '=', sql.lit(DocumentStatus.COMPLETED))- .on('e.deletedAt', 'is', null)- .on('e.type', '=', sql.lit(EnvelopeType.DOCUMENT)),- )- .leftJoin('OrganisationMember as om', 'o.id', 'om.organisationId').leftJoin('Subscription as s', 'o.id', 's.organisationId').where((eb) =>- eb.or([eb('o.name', 'ilike', `%${search}%`), eb('t.name', 'ilike', `%${search}%`)]),+ eb.or([+ eb('o.name', 'ilike', `%${search}%`),+ eb.exists(+ eb+ .selectFrom('Team as t')+ .whereRef('t.organisationId', '=', 'o.id')+ .where('t.name', 'ilike', `%${search}%`),+ ),+ ]),)- .select([+ .select((eb) => ['o.id as id','o.createdAt as createdAt','o.customerId as customerId',sql<string>`COALESCE(o.name, 'Unknown')`.as('name'),- sql<number>`COUNT(DISTINCT CASE WHEN e.id IS NOT NULL AND ${dateCondition} THEN e.id END)`.as(- 'signingVolume',- ),- sql<number>`GREATEST(COUNT(DISTINCT t.id), 1)`.as('teamCount'),- sql<number>`COUNT(DISTINCT om."userId")`.as('memberCount'),sql<string>`CASE WHEN s.status IS NOT NULL THEN s.status ELSE NULL END`.as('subscriptionStatus',),- ])- .groupBy(['o.id', 'o.name', 'o.customerId', 's.status']);+ eb+ .selectFrom('Team as t')+ .whereRef('t.organisationId', '=', 'o.id')+ .select(sql<number>`count(t.id)`.as('count'))+ .as('teamCount'),+ eb+ .selectFrom('OrganisationMember as om')+ .whereRef('om.organisationId', '=', 'o.id')+ .select(sql<number>`count(om.id)`.as('count'))+ .as('memberCount'),+ eb+ .selectFrom('Envelope as e')+ .innerJoin('Team as t', 't.id', 'e.teamId')+ .whereRef('t.organisationId', '=', 'o.id')+ .where('e.status', '=', sql.lit(DocumentStatus.COMPLETED))+ .where('e.deletedAt', 'is', null)+ .where('e.type', '=', sql.lit(EnvelopeType.DOCUMENT))+ .where(dateCondition)+ .select(sql<number>`count(e.id)`.as('count'))+ .as('signingVolume'),+ ]);switch (sortBy) {case 'name':@@ -181,11 +208,18 @@ export async function getOrganisationInsights({const countQuery = kyselyPrisma.$kysely.selectFrom('Organisation as o')- .leftJoin('Team as t', 'o.id', 't.organisationId').where((eb) =>- eb.or([eb('o.name', 'ilike', `%${search}%`), eb('t.name', 'ilike', `%${search}%`)]),+ eb.or([+ eb('o.name', 'ilike', `%${search}%`),+ eb.exists(+ eb+ .selectFrom('Team as t')+ .whereRef('t.organisationId', '=', 'o.id')+ .where('t.name', 'ilike', `%${search}%`),+ ),+ ]),)- .select(() => [sql<number>`COUNT(DISTINCT o.id)`.as('count')]);+ .select(({ fn }) => [fn.countAll().as('count')]);const [results, [{ count }]] = await Promise.all([findQuery.execute(), countQuery.execute()]);diff --git a/packages/prisma/migrations/20251126053402_add_insights_indexes/migration.sql b/packages/prisma/migrations/20251126053402_add_insights_indexes/migration.sqlnew file mode 100644index 000000000..1e4c3acc2--- /dev/null+++ b/packages/prisma/migrations/20251126053402_add_insights_indexes/migration.sql@@ -0,0 +1,26 @@+-- CreateIndex+CREATE INDEX "Envelope_type_idx" ON "Envelope"("type");++-- CreateIndex+CREATE INDEX "Envelope_status_idx" ON "Envelope"("status");++-- CreateIndex+CREATE INDEX "Envelope_createdAt_idx" ON "Envelope"("createdAt");++-- CreateIndex+CREATE INDEX "Organisation_name_idx" ON "Organisation"("name");++-- CreateIndex+CREATE INDEX "Organisation_ownerUserId_idx" ON "Organisation"("ownerUserId");++-- CreateIndex+CREATE INDEX "OrganisationMember_organisationId_idx" ON "OrganisationMember"("organisationId");++-- CreateIndex+CREATE INDEX "Recipient_email_idx" ON "Recipient"("email");++-- CreateIndex+CREATE INDEX "Recipient_signedAt_idx" ON "Recipient"("signedAt");++-- CreateIndex+CREATE INDEX "Team_name_idx" ON "Team"("name");diff --git a/packages/prisma/schema.prisma b/packages/prisma/schema.prismaindex 09e770e36..fecb3088c 100644--- a/packages/prisma/schema.prisma+++ b/packages/prisma/schema.prisma@@ -430,9 +430,12 @@ model Envelope {envelopeAttachments EnvelopeAttachment[]- @@index([folderId])- @@index([teamId])+ @@index([type])+ @@index([status])@@index([userId])+ @@index([teamId])+ @@index([folderId])+ @@index([createdAt])}model EnvelopeItem {@@ -583,8 +586,10 @@ model Recipient {fields Field[]signatures Signature[]- @@index([envelopeId])@@index([token])+ @@index([email])+ @@index([envelopeId])+ @@index([signedAt])}enum FieldType {@@ -694,6 +699,9 @@ model Organisation {organisationAuthenticationPortalId String @uniqueorganisationAuthenticationPortal OrganisationAuthenticationPortal @relation(fields: [organisationAuthenticationPortalId], references: [id])++ @@index([name])+ @@index([ownerUserId])}model OrganisationMember {@@ -710,6 +718,7 @@ model OrganisationMember {organisationGroupMembers OrganisationGroupMember[]@@unique([userId, organisationId])+ @@index([organisationId])}model OrganisationMemberInvite {@@ -883,6 +892,7 @@ model Team {teamGlobalSettingsId String @uniqueteamGlobalSettings TeamGlobalSettings @relation(fields: [teamGlobalSettingsId], references: [id], onDelete: Cascade)+ @@index([name])@@index([organisationId])}