feat: add activity types filter to backend API [IN-721] (#691)

Signed-off-by: Raúl Santos <[email protected]>

Author: borfast

frontend/server/api/organization/commit.ts

@@ -32,6 +32,8 @@ export default defineEventHandler(async (event): Promise<OrgDashCommit[]> => {
         granularity,
         activity_type: 'authored-commit',
         onlyContributions: false,
+        includeCodeContributions: true,
+        includeCollaborations: true,
       },
     )
 

frontend/server/api/organization/pr-opened.ts

@@ -32,6 +32,8 @@ export default defineEventHandler(async (event): Promise<OrgDashPrOpened[]> => {
         granularity,
         activity_type: 'pull_request-opened',
         onlyContributions: false,
+        includeCodeContributions: true,
+        includeCollaborations: true,
       },
     )
 

frontend/server/api/project/[slug]/contributors/active-contributors.get.ts

@@ -30,6 +30,7 @@ import { DateTime } from 'luxon'
 import { createDataSource } from '~~/server/data/data-sources'
 import type { ActiveContributorsFilter } from '~~/server/data/types'
 import { Granularity } from '~~/types/shared/granularity'
+import { getBooleanQueryParam } from '~~/server/utils/common'
 
 export default defineEventHandler(async (event) => {
   // TODO: Check the project configuration to determine whether to show the data.
@@ -39,11 +40,16 @@ export default defineEventHandler(async (event) => {
 
   const repos = Array.isArray(query.repos) ? query.repos : query.repos ? [query.repos] : undefined
 
+  const includeCodeContributions = getBooleanQueryParam(query, 'includeCodeContributions', true)
+  const includeCollaborations = getBooleanQueryParam(query, 'includeCollaborations', false)
+
   // TODO: Validate the query params
   const filter: ActiveContributorsFilter = {
     granularity: (query.granularity as Granularity) || Granularity.QUARTERLY,
     project,
     repos,
+    includeCodeContributions,
+    includeCollaborations,
     startDate: undefined,
     endDate: undefined,
   }

frontend/server/api/project/[slug]/contributors/active-organizations.get.ts

@@ -22,6 +22,7 @@ import { DateTime } from 'luxon'
 import type { ActiveOrganizationsFilter } from '~~/server/data/types'
 import { createDataSource } from '~~/server/data/data-sources'
 import { Granularity } from '~~/types/shared/granularity'
+import { getBooleanQueryParam } from '~~/server/utils/common'
 
 /**
  * Query params:
@@ -38,11 +39,16 @@ export default defineEventHandler(async (event) => {
 
   const repos = Array.isArray(query.repos) ? query.repos : query.repos ? [query.repos] : undefined
 
+  const includeCodeContributions = getBooleanQueryParam(query, 'includeCodeContributions', true)
+  const includeCollaborations = getBooleanQueryParam(query, 'includeCollaborations', false)
+
   // TODO: Validate the query params
   const filter: ActiveOrganizationsFilter = {
     granularity: (query.granularity as Granularity) || Granularity.QUARTERLY,
     project,
     repos,
+    includeCodeContributions,
+    includeCollaborations,
     startDate: undefined,
     endDate: undefined,
   }

frontend/server/api/project/[slug]/contributors/contributor-dependency.get.ts

@@ -5,6 +5,7 @@ import { createDataSource } from '~~/server/data/data-sources'
 import type { ContributorDependencyFilter } from '~~/server/data/types'
 import { ActivityTypes } from '~~/types/shared/activity-types'
 import { ActivityPlatforms } from '~~/types/shared/activity-platforms'
+import { getBooleanQueryParam } from '~~/server/utils/common'
 
 /**
  * Frontend expects the data to be in the following format:
@@ -42,12 +43,16 @@ export default defineEventHandler(async (event) => {
 
   const activityPlatform = query.platform as ActivityPlatforms
   const activityType = query.activityType as ActivityTypes
+  const includeCodeContributions = getBooleanQueryParam(query, 'includeCodeContributions', true)
+  const includeCollaborations = getBooleanQueryParam(query, 'includeCollaborations', false)
   const repos = Array.isArray(query.repos) ? query.repos : query.repos ? [query.repos] : undefined
 
   const filter: ContributorDependencyFilter = {
     project,
     platform: activityPlatform !== ActivityPlatforms.ALL ? activityPlatform : undefined,
     activity_type: activityType !== ActivityTypes.ALL ? activityType : undefined,
+    includeCodeContributions,
+    includeCollaborations,
     repos,
     startDate: query.startDate ? DateTime.fromISO(query.startDate as string) : undefined,
     endDate: query.endDate ? DateTime.fromISO(query.endDate as string) : undefined,

frontend/server/api/project/[slug]/contributors/contributor-leaderboard.get.ts

@@ -5,6 +5,7 @@ import { createDataSource } from '~~/server/data/data-sources'
 import type { ContributorsLeaderboardFilter } from '~~/server/data/types'
 import { ActivityTypes } from '~~/types/shared/activity-types'
 import { ActivityPlatforms } from '~~/types/shared/activity-platforms'
+import { getBooleanQueryParam } from '~~/server/utils/common'
 
 /**
  * Frontend expects the data to be in the following format:
@@ -41,6 +42,8 @@ export default defineEventHandler(async (event) => {
   const project = (event.context.params as { slug: string }).slug
   const activityPlatform = query.platform as ActivityPlatforms
   const activityType = query.activityType as ActivityTypes
+  const includeCodeContributions = getBooleanQueryParam(query, 'includeCodeContributions', true)
+  const includeCollaborations = getBooleanQueryParam(query, 'includeCollaborations', false)
   const limit = query.limit ? parseInt(query.limit as string, 10) : 10
   const offset = query.offset ? parseInt(query.offset as string, 10) : 0
   const repos = Array.isArray(query.repos) ? query.repos : query.repos ? [query.repos] : undefined
@@ -49,6 +52,8 @@ export default defineEventHandler(async (event) => {
     project,
     platform: activityPlatform !== ActivityPlatforms.ALL ? activityPlatform : undefined,
     activity_type: activityType !== ActivityTypes.ALL ? activityType : undefined,
+    includeCodeContributions,
+    includeCollaborations,
     repos,
     startDate: query.startDate ? DateTime.fromISO(query.startDate as string) : undefined,
     endDate: query.endDate ? DateTime.fromISO(query.endDate as string) : undefined,

frontend/server/api/project/[slug]/contributors/geographical-distribution.get.ts

@@ -44,6 +44,8 @@ export default defineEventHandler(async (event) => {
     project,
     platform: activityPlatform !== ActivityPlatforms.ALL ? activityPlatform : undefined,
     activity_type: activityType !== ActivityTypes.ALL ? activityType : undefined,
+    includeCodeContributions: true,
+    includeCollaborations: false,
     repos,
     type: (query.type as DemographicType) || DemographicType.CONTRIBUTORS,
     startDate: query.startDate ? DateTime.fromISO(query.startDate as string) : undefined,

frontend/server/api/project/[slug]/contributors/organization-dependency.get.ts

@@ -5,6 +5,7 @@ import type { OrganizationDependencyFilter } from '~~/server/data/types'
 import { createDataSource } from '~~/server/data/data-sources'
 import { ActivityTypes } from '~~/types/shared/activity-types'
 import { ActivityPlatforms } from '~~/types/shared/activity-platforms'
+import { getBooleanQueryParam } from '~~/server/utils/common'
 
 /**
  * Frontend expects the data to be in the following format:
@@ -43,12 +44,17 @@ export default defineEventHandler(async (event) => {
   const activityPlatform = query.platform as ActivityPlatforms
   const activityType = query.activityType as ActivityTypes
 
+  const includeCodeContributions = getBooleanQueryParam(query, 'includeCodeContributions', true)
+  const includeCollaborations = getBooleanQueryParam(query, 'includeCollaborations', false)
+
   const repos = Array.isArray(query.repos) ? query.repos : query.repos ? [query.repos] : undefined
 
   const filter: OrganizationDependencyFilter = {
     project,
     platform: activityPlatform !== ActivityPlatforms.ALL ? activityPlatform : undefined,
     activity_type: activityType !== ActivityTypes.ALL ? activityType : undefined,
+    includeCodeContributions,
+    includeCollaborations,
     repos,
     startDate: query.startDate ? DateTime.fromISO(query.startDate as string) : undefined,
     endDate: query.endDate ? DateTime.fromISO(query.endDate as string) : undefined,

frontend/server/api/project/[slug]/contributors/organization-leaderboard.get.ts

@@ -5,6 +5,7 @@ import { createDataSource } from '~~/server/data/data-sources'
 import type { OrganizationsLeaderboardFilter } from '~~/server/data/types'
 import { ActivityTypes } from '~~/types/shared/activity-types'
 import { ActivityPlatforms } from '~~/types/shared/activity-platforms'
+import { getBooleanQueryParam } from '~~/server/utils/common'
 
 /**
  * Frontend expects the data to be in the following format:
@@ -40,6 +41,8 @@ export default defineEventHandler(async (event) => {
   const project = (event.context.params as { slug: string }).slug
   const activityPlatform = query.platform as ActivityPlatforms
   const activityType = query.activityType as ActivityTypes
+  const includeCodeContributions = getBooleanQueryParam(query, 'includeCodeContributions', true)
+  const includeCollaborations = getBooleanQueryParam(query, 'includeCollaborations', false)
   const limit = query.limit ? parseInt(query.limit as string, 10) : 10
   const offset = query.offset ? parseInt(query.offset as string, 10) : 0
 
@@ -55,6 +58,8 @@ export default defineEventHandler(async (event) => {
     project,
     platform: activityPlatform !== ActivityPlatforms.ALL ? activityPlatform : undefined,
     activity_type: activityType !== ActivityTypes.ALL ? activityType : undefined,
+    includeCodeContributions,
+    includeCollaborations,
     repos,
     startDate: query.startDate ? DateTime.fromISO(query.startDate as string) : undefined,
     endDate: query.endDate ? DateTime.fromISO(query.endDate as string) : undefined,

frontend/server/api/project/[slug]/contributors/retention.get.ts

@@ -6,6 +6,7 @@ import { DemographicType } from '~~/server/data/types'
 import { createDataSource } from '~~/server/data/data-sources'
 import { ActivityTypes } from '~~/types/shared/activity-types'
 import { Granularity } from '~~/types/shared/granularity'
+import { getBooleanQueryParam } from '~~/server/utils/common'
 
 /**
  * Frontend expects the data to be in the following format:
@@ -28,12 +29,17 @@ export default defineEventHandler(async (event) => {
   const project = (event.context.params as { slug: string }).slug
   const activityType = query.activityType as ActivityTypes
 
+  const includeCodeContributions = getBooleanQueryParam(query, 'includeCodeContributions', true)
+  const includeCollaborations = getBooleanQueryParam(query, 'includeCollaborations', false)
+
   const repos = Array.isArray(query.repos) ? query.repos : query.repos ? [query.repos] : undefined
 
   const filter: RetentionFilter = {
     project,
     granularity: query.granularity as Granularity,
     activity_type: activityType !== ActivityTypes.ALL ? activityType : undefined,
+    includeCodeContributions,
+    includeCollaborations,
     repos,
     demographicType: (query.type as DemographicType) || DemographicType.CONTRIBUTORS,
     onlyContributions: false, // forks and stars are non-contribution activities, but we want to count them.