Contribution page

README.md

@@ -64,6 +64,18 @@
 
 - Generate a Client Secret ID from GitHub and use it to replace the value of `GITHUB_SECRET` within your `.env.local`
 
+## Setting up the Github Access Token
+
+- Login to github, then at the top right click on the icon and go to settings.
+
+- Find the developer settings, then click on Personal access tokens, and create a new access token.
+
+- Name the token something descriptive, no additional options need to be selected.
+
+- Click the Generate token button.
+
+- Next, copy the token and replace the value of `GITHUB_TOKEN` within your `.env.local`
+
 ## Setting up Discord OAuth
 
 - Go to the [Discord Develop Portal](https://discord.com/developers/applications) and log in.

packages/api/src/__mocks__/env.ts

@@ -3,6 +3,7 @@ export const env = {
   port: '3000',
   githubId: 'mock-client-id',
   githubSecretId: 'Secrete_secret',
+  githubToken: 'mock-token',
   discordClientId: 'mock-discord-id',
   discordSecretId: 'discord-secret',
 };

packages/api/src/api/contributions.ts

@@ -0,0 +1,233 @@
+import express, { Router } from 'express';
+import { env } from '../env';
+import { Contribution } from '../entities/Contribution';
+import { User } from '../entities/User';
+import logger from '../logger';
+import { Project } from '../entities/Project';
+
+export const contributions = Router();
+contributions.use(express.json());
+
+export interface PullRequestContribution {
+  id: string;
+  title: string;
+  permalink: string;
+  mergedAt: string;
+  author: {
+    login: string;
+  };
+}
+
+export interface Repository {
+  id: string;
+  nameWithOwner: string;
+}
+
+interface ContributionResponse {
+  data: {
+    search: {
+      pageInfo: {
+        hasNextPage: boolean;
+        endCursor: string | null;
+      };
+      nodes: PullRequestContribution[];
+    };
+  };
+}
+
+interface RepositoryResponse {
+  data: {
+    nodes: Repository[];
+  };
+}
+
+const buildProjectsQuery = async (projects: Project[]) => {
+  let idString = '';
+
+  projects.forEach((p) => {
+    idString += `"${p.nodeID}",`;
+  });
+
+  idString = idString.substring(0, idString.length - 1);
+
+  const repoQueryString = `
+    query { 
+      nodes(ids: [${idString}]){
+        ... on Repository {
+          id
+          nameWithOwner
+        }    
+      }
+    }
+  `;
+
+  const fetchRes = await fetch('https://api.github.com/graphql', {
+    method: 'POST',
+    headers: {
+      'Content-Type': 'application/json',
+      Authorization: `bearer ${env.githubToken}`,
+    },
+    body: JSON.stringify({
+      query: repoQueryString,
+    }),
+  });
+
+  const { data: responseData }: RepositoryResponse = await fetchRes.json();
+
+  let queryString = '';
+
+  responseData.nodes.forEach((repo) => {
+    queryString += `repo:${repo.nameWithOwner} `;
+  });
+
+  return queryString;
+};
+
+const buildUsersQuery = (users: User[]) => {
+  let queryString = '';
+
+  users.forEach((u) => {
+    queryString += `author:${u.githubUsername} `;
+  });
+
+  return queryString;
+};
+
+const buildDateQuery = (startDate: Date, endDate: Date) => {
+  const locale = 'en-US';
+  const queryString = `${startDate.getFullYear()}-${(startDate.getMonth() + 1).toLocaleString(
+    locale,
+    { minimumIntegerDigits: 2 },
+  )}-${startDate
+    .getDate()
+    .toLocaleString(locale, { minimumIntegerDigits: 2 })}..${endDate.getFullYear()}-${(
+    endDate.getMonth() + 1
+  ).toLocaleString(locale, { minimumIntegerDigits: 2 })}-${endDate
+    .getDate()
+    .toLocaleString(locale, { minimumIntegerDigits: 2 })}`;
+  return queryString;
+};
+
+const buildQueryString = (
+  projectsString: string,
+  dateString: string,
+  userString: string,
+  cursor: string | null,
+) => {
+  const afterString = cursor ? `after:"${cursor}",` : '';
+
+  const queryString = `
+    {
+      search (first: 2, ${afterString} query: "${projectsString} is:pr is:merged merged:${dateString} ${userString}", type: ISSUE) {
+        pageInfo {
+          hasNextPage
+          endCursor
+        }
+        nodes {
+          ... on PullRequest {
+            id
+            title
+            permalink
+            mergedAt
+            author {
+              login
+            }
+          }
+        }
+      }
+    }
+        `;
+
+  return queryString;
+};
+
+contributions.get('', async (req, res) => {
+  try {
+    const timeRange = new Date();
+    const today = new Date();
+    const yesterday = new Date(today);
+    yesterday.setDate(today.getDate() - 100);
+    timeRange.setHours(timeRange.getHours() - 5);
+
+    const userList = await req.entityManager.find(User, {
+      $or: [
+        {
+          contributionsLastCheckedAt: {
+            $lt: timeRange,
+          },
+        },
+        {
+          contributionsLastCheckedAt: {
+            $eq: null,
+          },
+        },
+      ],
+    });
+
+    if (userList.length === 0) {
+      res.sendStatus(200);
+      return;
+    }
+
+    const projectList = await req.entityManager.find(Project, {});
+    const projectsString = await buildProjectsQuery(projectList);
+    const dateString = buildDateQuery(yesterday, today);
+    const usersString = buildUsersQuery(userList);
+    let cursor = null;
+    let hasNextPage = true;
+
+    while (hasNextPage) {
+      const queryString = buildQueryString(projectsString, dateString, usersString, cursor);
+
+      const fetchRes = await fetch('https://api.github.com/graphql', {
+        method: 'POST',
+        headers: {
+          'Content-Type': 'application/json',
+          Authorization: `bearer ${env.githubToken}`,
+        },
+        body: JSON.stringify({
+          query: queryString,
+        }),
+      });
+
+      const { data: responseData }: ContributionResponse = await fetchRes.json();
+      for (const pr of responseData.search.nodes.entries()) {
+        // Only Add new contributions
+        if (
+          (await req.entityManager.find(Contribution, { nodeID: { $eq: pr[1].id } })).length === 0
+        ) {
+          const user = await req.entityManager.findOne(User, {
+            githubUsername: { $eq: pr[1].author.login },
+          });
+          if (user) {
+            const newContribution = new Contribution({
+              nodeID: pr[1].id,
+              authorGithubId: user.githubId,
+              type: 'Pull Request',
+              description: pr[1].title,
+              contributedAt: new Date(Date.parse(pr[1].mergedAt)),
+              score: 100,
+            });
+            req.entityManager.persist(newContribution);
+          }
+        }
+      }
+      hasNextPage = responseData.search.pageInfo.hasNextPage;
+      cursor = responseData.search.pageInfo.endCursor;
+    }
+
+    for (const user of userList) {
+      user.contributionsLastCheckedAt = new Date();
+      req.entityManager.persist(user);
+    }
+
+    // Save new info in the db
+    void req.entityManager.flush();
+
+    res.sendStatus(200);
+  } catch (error) {
+    res.sendStatus(500);
+    const errorMessage = 'There was an issue saving contribution data to the database';
+    logger.error(errorMessage, error);
+  }
+});

packages/api/src/api/index.ts

@@ -5,6 +5,7 @@ import { health } from './health';
 import { users } from './users';
 import { videos } from './videos';
 import { project } from './project';
+import { contributions } from './contributions';
 
 export const api = Router();
 
@@ -13,3 +14,4 @@ api.use('/users', users);
 api.use('/videos', videos);
 api.use('/auth', auth);
 api.use('/project', project);
+api.use('/contributions', contributions);

packages/api/src/api/videos.ts

@@ -4,9 +4,17 @@ import logger from '../logger';
 
 export const videos = Router();
 
-videos.get('', async (req, res) => {
+videos.get('', async (req, res) => { 
+  const query = req.query.q || '';
+  if(typeof query !== 'string'){
+    res.status(400).send('query must be string');
+    return;
+  }
   try {
-    const videosList = await req.entityManager.find(Video, {});
+    const videosList = await req.entityManager.find(Video, { title: {
+      $ilike: `%${query.trim()}%`,
+    }
+  });
 
     res.status(200).send(videosList);
   } catch (error) {
@@ -15,6 +23,7 @@ videos.get('', async (req, res) => {
   }
 });
 
+
 videos.get('/:videoId', async (req, res) => {
   const { videoId } = req.params;
 

packages/api/src/entities/Contribution.ts

@@ -7,9 +7,12 @@ export type ContributionConstructorValues = ConstructorValues<Contribution>;
 
 @Entity()
 export class Contribution extends Node<Contribution> {
-  @Property({ columnType: 'text' })
+  @Property({ columnType: 'text', unique: true })
   nodeID: string;
 
+  @Property({ columnType: 'text' })
+  authorGithubId: string;
+
   @Property({ columnType: 'text' })
   description: string;
 
@@ -24,6 +27,7 @@ export class Contribution extends Node<Contribution> {
 
   constructor({
     nodeID,
+    authorGithubId,
     description,
     type,
     score,
@@ -32,6 +36,7 @@ export class Contribution extends Node<Contribution> {
   }: ContributionConstructorValues) {
     super(extraValues);
     this.nodeID = nodeID;
+    this.authorGithubId = authorGithubId;
     this.description = description;
     this.type = type;
     this.score = score;

packages/api/src/entities/User.ts

@@ -13,6 +13,9 @@ export class User extends Node<User> {
   @Property({ columnType: 'text' })
   githubId: string;
 
+  @Property({ columnType: 'text' })
+  githubUsername: string;
+
   @Property({ columnType: 'text', nullable: true })
   discordId?: string;
 
@@ -49,6 +52,7 @@ export class User extends Node<User> {
   constructor({
     name,
     githubId,
+    githubUsername,
     hireable,
     purpose,
     isAdmin,
@@ -61,6 +65,7 @@ export class User extends Node<User> {
     this.hireable = hireable;
     this.purpose = purpose;
     this.githubId = githubId;
+    this.githubUsername = githubUsername;
     this.isAdmin = isAdmin ?? false;
     this.email = email;
   }

packages/api/src/env.ts

@@ -13,6 +13,7 @@ export const env = setEnv({
     discordSecretId: 'DISCORD_SECRET_ID',
     githubClientId: 'GITHUB_CLIENT_ID',
     githubSecret: 'GITHUB_SECRET',
+    githubToken: 'GITHUB_TOKEN',
     appUrl: 'APP_URL',
   },
   optional: {

packages/api/src/index.ts

@@ -18,6 +18,14 @@ app.use(express.json());
 
 const GitHubStrategy = require('passport-github2');
 
+const contributionPollTimer = (milliseconds: number) => {
+  logger.info(`Starting new contribution poll timer: ${milliseconds}ms`);
+  setTimeout(async () => {
+    await fetch(`${env.appUrl}/api/contributions`);
+    contributionPollTimer(milliseconds);
+  }, milliseconds);
+};
+
 const authRequired: Handler = (req, res, next) => {
   if (req.user) {
     next();
@@ -129,6 +137,7 @@ void (async () => {
   .then(() => {
     app.listen(port, () => {
       logger.info(`🚀 Listening at http://localhost:${port}`);
+      contributionPollTimer(3600000);
     });
   })
   .catch((err) => {