feat: introduce a new site info API endpoint

src/__mocks__/axios.ts

@@ -1,3 +1,24 @@
 import mockAxios from "jest-mock-axios"
 
+const getMockAxiosInstance = () => {
+  const mockAxiosInstance = mockAxios.create()
+  mockAxiosInstance.get.mockResolvedValue({ data: [] })
+  mockAxiosInstance.post.mockResolvedValue({ data: [] })
+  mockAxiosInstance.put.mockResolvedValue({ data: [] })
+  mockAxiosInstance.delete.mockResolvedValue({ data: [] })
+  return mockAxiosInstance
+}
+
+export const mockAxiosInstance = getMockAxiosInstance()
+
+export const prepareAxiosMock = () => {
+  // NOTE: We need to mock the axios instance using es5 named exports
+  // to ensure that the calls for .get() on the instance will actually
+  // return a value and not fail.
+  jest.mock("../services/api/AxiosInstance.ts", () => ({
+    __esModule: true, // this property makes it work
+    mockAxiosInstance,
+  }))
+}
+
 export default mockAxios

src/constants/constants.ts

@@ -18,3 +18,27 @@ export enum CollaboratorRoles {
 export const E2E_ISOMER_ID = "-1"
 export const E2E_TEST_EMAIL = "test@e2e"
 export const E2E_TEST_CONTACT = "12345678"
+
+export const GH_MAX_REPO_COUNT = 100
+export const ISOMERPAGES_REPO_PAGE_COUNT =
+  (process.env.ISOMERPAGES_REPO_PAGE_COUNT &&
+    parseInt(process.env.ISOMERPAGES_REPO_PAGE_COUNT, 10)) ||
+  3
+export const ISOMER_GITHUB_ORG_NAME = process.env.GITHUB_ORG_NAME
+export const ISOMER_ADMIN_REPOS = [
+  "isomercms-backend",
+  "isomercms-frontend",
+  "isomer-redirection",
+  "isomerpages-template",
+  "isomer-conversion-scripts",
+  "isomer-wysiwyg",
+  "isomer-slackbot",
+  "isomer-tooling",
+  "generate-site",
+  "travisci-scripts",
+  "recommender-train",
+  "editor",
+  "ci-test",
+  "infra",
+  "markdown-helper",
+]

src/fixtures/identity.ts

@@ -2,6 +2,8 @@ import { Attributes } from "sequelize/types"
 
 import { User, SiteMember } from "@database/models"
 
+import { mockIsomerUserId } from "./sessionData"
+
 export const mockRecipient = "[email protected]"
 export const mockSubject = "mock subject"
 export const mockBody = "somebody"
@@ -138,3 +140,23 @@ export const mockSiteOrmResponseWithNoCollaborators = {
   id: 1,
   site_members: "",
 }
+
+export const mockCommitMessage1 = "Update file: Example.md"
+export const mockCommitFileName1 = "Example.md"
+export const mockGitHubEmailAddress1 = "[email protected]"
+export const mockGitHubDate1 = "2022-09-22T04:07:53Z"
+export const mockCommitMessageObject1 = {
+  message: mockCommitMessage1,
+  fileName: mockCommitFileName1,
+  userId: mockIsomerUserId,
+}
+
+export const mockCommitMessage2 = "Update file: Test.md"
+export const mockCommitFileName2 = "Test.md"
+export const mockGitHubEmailAddress2 = "[email protected]"
+export const mockGitHubDate2 = "2022-09-28T06:25:14Z"
+export const mockCommitMessageObject2 = {
+  message: mockCommitMessage2,
+  fileName: mockCommitFileName2,
+  userId: mockIsomerUserId,
+}

src/fixtures/repoInfo.js → src/fixtures/repoInfo.ts

@@ -1,4 +1,6 @@
-const repoInfo = {
+import { GitHubRepositoryData } from "@root/types/repoInfo"
+
+export const repoInfo: GitHubRepositoryData = {
   name: "repo",
   private: false,
   description:
@@ -13,7 +15,7 @@ const repoInfo = {
   },
 }
 
-const repoInfo2 = {
+export const repoInfo2: GitHubRepositoryData = {
   name: "repo2",
   private: false,
   description:
@@ -28,7 +30,7 @@ const repoInfo2 = {
   },
 }
 
-const adminRepo = {
+export const adminRepo: GitHubRepositoryData = {
   name: "isomercms-backend",
   private: false,
   description:
@@ -43,7 +45,7 @@ const adminRepo = {
   },
 }
 
-const noAccessRepo = {
+export const noAccessRepo: GitHubRepositoryData = {
   name: "noaccess",
   private: false,
   description:
@@ -57,10 +59,3 @@ const noAccessRepo = {
     pull: true,
   },
 }
-
-module.exports = {
-  repoInfo,
-  repoInfo2,
-  adminRepo,
-  noAccessRepo,
-}

src/integration/Sites.spec.ts

@@ -1,16 +1,17 @@
 import express from "express"
-import mockAxios from "jest-mock-axios"
 import request from "supertest"
 
 import { IsomerAdmin, Repo, Site, SiteMember, User } from "@database/models"
 import { generateRouter } from "@fixtures/app"
+import { mockAxiosInstance, prepareAxiosMock } from "@mocks/axios"
 import UserSessionData from "@root/classes/UserSessionData"
 import { mockEmail, mockIsomerUserId } from "@root/fixtures/sessionData"
 import { SitesRouter as _SitesRouter } from "@root/routes/v2/authenticated/sites"
 import { GitHubService } from "@root/services/db/GitHubService"
 import { ConfigYmlService } from "@root/services/fileServices/YmlFileServices/ConfigYmlService"
 import IsomerAdminsService from "@root/services/identity/IsomerAdminsService"
-import { SitesService } from "@root/services/utilServices/SitesService"
+import SitesService from "@root/services/identity/SitesService"
+import TokenStore from "@root/services/identity/TokenStore"
 import { getUsersService } from "@services/identity"
 import { sequelize } from "@tests/database"
 
@@ -21,15 +22,18 @@ const mockUpdatedAt = "now"
 const mockPermissions = { push: true }
 const mockPrivate = true
 
-const gitHubService = new GitHubService({ axiosInstance: mockAxios.create() })
+const gitHubService = new GitHubService({ axiosInstance: mockAxiosInstance })
 const configYmlService = new ConfigYmlService({ gitHubService })
 const usersService = getUsersService(sequelize)
 const isomerAdminsService = new IsomerAdminsService({ repository: IsomerAdmin })
+const tokenStore = new TokenStore()
 const sitesService = new SitesService({
+  siteRepository: Site,
   gitHubService,
   configYmlService,
   usersService,
   isomerAdminsService,
+  tokenStore,
 })
 
 const SitesRouter = new _SitesRouter({ sitesService })
@@ -51,21 +55,9 @@ subrouter.use((req, res, next) => {
 subrouter.use(sitesSubrouter)
 const app = generateRouter(subrouter)
 
-const mockGenericAxios = mockAxios.create()
-mockGenericAxios.get.mockResolvedValue({
-  data: [],
-})
-
 describe("Sites Router", () => {
   beforeAll(() => {
-    // NOTE: Because SitesService uses an axios instance,
-    // we need to mock the axios instance using es5 named exports
-    // to ensure that the calls for .get() on the instance
-    // will actually return a value and not fail.
-    jest.mock("../services/api/AxiosInstance.ts", () => ({
-      __esModule: true, // this property makes it work
-      genericGitHubAxiosInstance: mockGenericAxios,
-    }))
+    prepareAxiosMock()
   })
 
   describe("/", () => {
@@ -121,7 +113,7 @@ describe("Sites Router", () => {
         ],
       }
 
-      mockGenericAxios.get.mockResolvedValueOnce({
+      mockAxiosInstance.get.mockResolvedValueOnce({
         data: [
           {
             pushed_at: mockUpdatedAt,
@@ -165,7 +157,7 @@ describe("Sites Router", () => {
           },
         ],
       }
-      mockGenericAxios.get.mockResolvedValueOnce({
+      mockAxiosInstance.get.mockResolvedValueOnce({
         data: [
           {
             pushed_at: mockUpdatedAt,

src/routes/v2/authenticated/index.js

@@ -3,7 +3,6 @@ const express = require("express")
 const {
   NetlifyTomlService,
 } = require("@services/configServices/NetlifyTomlService")
-const { SitesService } = require("@services/utilServices/SitesService")
 
 const { CollaboratorsRouter } = require("./collaborators")
 const { NetlifyTomlRouter } = require("./netlifyToml")
@@ -12,19 +11,11 @@ const { UsersRouter } = require("./users")
 
 const getAuthenticatedSubrouter = ({
   authenticationMiddleware,
-  gitHubService,
-  configYmlService,
+  sitesService,
   usersService,
-  isomerAdminsService,
   collaboratorsService,
   authorizationMiddleware,
 }) => {
-  const sitesService = new SitesService({
-    gitHubService,
-    configYmlService,
-    usersService,
-    isomerAdminsService,
-  })
   const netlifyTomlService = new NetlifyTomlService()
 
   const sitesV2Router = new SitesRouter({ sitesService })