Merge pull request #885 from isomerpages/release/0.38.0

Release/0.38.0

CHANGELOG.md

@@ -4,9 +4,20 @@ All notable changes to this project will be documented in this file. Dates are d
 
 Generated by [`auto-changelog`](https://github.com/CookPete/auto-changelog).
 
+#### [v0.38.0](https://github.com/isomerpages/isomercms-backend/compare/v0.37.0...v0.38.0)
+
+- fix(GGs): return sha of commit made instead of path to repository [`#884`](https://github.com/isomerpages/isomercms-backend/pull/884)
+- fix(authservice): update import [`#883`](https://github.com/isomerpages/isomercms-backend/pull/883)
+- feat(GGs): Add drop-in replacement RepoService [`#874`](https://github.com/isomerpages/isomercms-backend/pull/874)
+- Fix axios method type to return string [`#879`](https://github.com/isomerpages/isomercms-backend/pull/879)
+- fix: upgrade axios from 0.25.0 to 0.27.2 [`#850`](https://github.com/isomerpages/isomercms-backend/pull/850)
+- release(0.37.0): merge to develop [`#875`](https://github.com/isomerpages/isomercms-backend/pull/875)
+- fix(package.json): update build script [`#878`](https://github.com/isomerpages/isomercms-backend/pull/878)
+
 #### [v0.37.0](https://github.com/isomerpages/isomercms-backend/compare/v0.36.0...v0.37.0)
 
-- fix(package.json): update build script [`#878`](https://github.com/isomerpages/isomercms-backend/pull/878)
+> 3 August 2023
+
 - feat(siteLaunch): restrict to admin [`#873`](https://github.com/isomerpages/isomercms-backend/pull/873)
 - feat(GGs): introduce GitFileSystemService as middleman interface [`#867`](https://github.com/isomerpages/isomercms-backend/pull/867)
 - feat(stats): add metrics endpoint [`#863`](https://github.com/isomerpages/isomercms-backend/pull/863)
@@ -26,12 +37,12 @@ Generated by [`auto-changelog`](https://github.com/CookPete/auto-changelog).
 - feat(axios): add method to github api logs [`#862`](https://github.com/isomerpages/isomercms-backend/pull/862)
 - chore(e2e): change naming for clarity [`#857`](https://github.com/isomerpages/isomercms-backend/pull/857)
 - 0.35.0 [`#846`](https://github.com/isomerpages/isomercms-backend/pull/846)
-- fix: review request placeholder files [`#847`](https://github.com/isomerpages/isomercms-backend/pull/847)
 
 #### [v0.35.0](https://github.com/isomerpages/isomercms-backend/compare/v0.34.0...v0.35.0)
 
-> 19 July 2023
+> 20 July 2023
 
+- fix: review request placeholder files [`#847`](https://github.com/isomerpages/isomercms-backend/pull/847)
 - Feat: add site lastUpdated with caching [`#830`](https://github.com/isomerpages/isomercms-backend/pull/830)
 - Feat/is 21 repo privatisation [`#806`](https://github.com/isomerpages/isomercms-backend/pull/806)
 - ref(errors): migrate existing legacy errors to ts [`#836`](https://github.com/isomerpages/isomercms-backend/pull/836)
@@ -169,14 +180,7 @@ Generated by [`auto-changelog`](https://github.com/CookPete/auto-changelog).
 
 - fix: token capacity alarm message ordering [`43ac12b`](https://github.com/isomerpages/isomercms-backend/commit/43ac12bab0114f7563428ce90cc9f55584a43422)
 
-#### [v0.24.1](https://github.com/isomerpages/isomercms-backend/compare/v0.24.0...v0.24.1)
-
-> 27 April 2023
-
-- fix(review request service): use repo name rather than site name [`a323551`](https://github.com/isomerpages/isomercms-backend/commit/a323551feda7b077a7d5d6c2d11ae841ece9bf8d)
-- fix(test cases): fix failing tests [`c843865`](https://github.com/isomerpages/isomercms-backend/commit/c84386549a28602e1af10cd2eda9f056212afaa7)
-
-#### [v0.24.0](https://github.com/isomerpages/isomercms-backend/compare/v0.23.1...v0.24.0)
+#### [v0.24.1](https://github.com/isomerpages/isomercms-backend/compare/v0.23.1...v0.24.1)
 
 > 27 April 2023
 
@@ -188,6 +192,8 @@ Generated by [`auto-changelog`](https://github.com/CookPete/auto-changelog).
 - build(deps): bump vm2 from 3.9.16 to 3.9.17 [`#725`](https://github.com/isomerpages/isomercms-backend/pull/725)
 - build(deps): bump vm2 from 3.9.16 to 3.9.17 in /microservices [`#724`](https://github.com/isomerpages/isomercms-backend/pull/724)
 - 0.23.0 (develop) [`#722`](https://github.com/isomerpages/isomercms-backend/pull/722)
+- fix(review request service): use repo name rather than site name [`a323551`](https://github.com/isomerpages/isomercms-backend/commit/a323551feda7b077a7d5d6c2d11ae841ece9bf8d)
+- fix(test cases): fix failing tests [`c843865`](https://github.com/isomerpages/isomercms-backend/commit/c84386549a28602e1af10cd2eda9f056212afaa7)
 
 #### [v0.23.1](https://github.com/isomerpages/isomercms-backend/compare/v0.23.0...v0.23.1)
 

package.json

@@ -1,6 +1,6 @@
 {
   "name": "isomercms",
-  "version": "0.37.0",
+  "version": "0.38.0",
   "private": true,
   "scripts": {
     "build": "tsc -p tsconfig.build.json",
@@ -35,7 +35,7 @@
     "auto-bind": "^4.0.0",
     "aws-lambda": "^1.0.7",
     "aws-sdk": "^2.1416.0",
-    "axios": "~0.25.0",
+    "axios": "~0.27.2",
     "axios-cache-interceptor": "^0.9.2",
     "base-64": "^0.1.0",
     "bcrypt": "^5.1.0",

src/config/config.ts

@@ -405,6 +405,14 @@ const config = convict({
       default: "",
     },
   },
+  featureFlags: {
+    ggsWhitelistedRepos: {
+      doc: "Comma-separated list of whitelisted repos for local Git service",
+      env: "WHITELISTED_GIT_SERVICE_REPOS",
+      format: String,
+      default: "",
+    },
+  },
 })
 
 // Perform validation

src/integration/NotificationOnEditHandler.spec.ts

@@ -44,7 +44,7 @@ import { FooterYmlService } from "@root/services/fileServices/YmlFileServices/Fo
 import PreviewService from "@root/services/identity/PreviewService"
 import { SitesCacheService } from "@root/services/identity/SitesCacheService"
 import { GitHubService } from "@services/db/GitHubService"
-import * as ReviewApi from "@services/db/review"
+import RepoService from "@services/db/RepoService"
 import { ConfigYmlService } from "@services/fileServices/YmlFileServices/ConfigYmlService"
 import { getUsersService, notificationsService } from "@services/identity"
 import CollaboratorsService from "@services/identity/CollaboratorsService"
@@ -112,7 +112,7 @@ const pageService = new PageService({
 })
 const configService = new ConfigService()
 const reviewRequestService = new ReviewRequestService(
-  (mockGithubService as unknown) as typeof ReviewApi,
+  (mockGithubService as unknown) as RepoService,
   User,
   ReviewRequest,
   Reviewer,

src/integration/Notifications.spec.ts

@@ -51,7 +51,7 @@ import PreviewService from "@root/services/identity/PreviewService"
 import { SitesCacheService } from "@root/services/identity/SitesCacheService"
 import SitesService from "@root/services/identity/SitesService"
 import ReviewRequestService from "@root/services/review/ReviewRequestService"
-import * as ReviewApi from "@services/db/review"
+import RepoService from "@services/db/RepoService"
 import {
   getIdentityAuthService,
   getUsersService,
@@ -105,7 +105,7 @@ const pageService = new PageService({
 })
 const configService = new ConfigService()
 const reviewRequestService = new ReviewRequestService(
-  (gitHubService as unknown) as typeof ReviewApi,
+  (gitHubService as unknown) as RepoService,
   User,
   ReviewRequest,
   Reviewer,

src/integration/Privatisation.spec.ts

@@ -62,7 +62,7 @@ import PreviewService from "@root/services/identity/PreviewService"
 import { SitesCacheService } from "@root/services/identity/SitesCacheService"
 import AuthorizationMiddlewareService from "@root/services/middlewareServices/AuthorizationMiddlewareService"
 import { GitHubService } from "@services/db/GitHubService"
-import * as ReviewApi from "@services/db/review"
+import RepoService from "@services/db/RepoService"
 import { ConfigYmlService } from "@services/fileServices/YmlFileServices/ConfigYmlService"
 import { getIdentityAuthService, getUsersService } from "@services/identity"
 import IsomerAdminsService from "@services/identity/IsomerAdminsService"
@@ -134,7 +134,7 @@ const pageService = new PageService({
 })
 const configService = new ConfigService()
 const reviewRequestService = new ReviewRequestService(
-  (gitHubService as unknown) as typeof ReviewApi,
+  (gitHubService as unknown) as RepoService,
   User,
   ReviewRequest,
   Reviewer,

src/integration/Reviews.spec.ts

@@ -89,7 +89,7 @@ import PreviewService from "@root/services/identity/PreviewService"
 import { SitesCacheService } from "@root/services/identity/SitesCacheService"
 import { ReviewRequestDto } from "@root/types/dto/review"
 import { GitHubService } from "@services/db/GitHubService"
-import * as ReviewApi from "@services/db/review"
+import RepoService from "@services/db/RepoService"
 import { ConfigYmlService } from "@services/fileServices/YmlFileServices/ConfigYmlService"
 import { getUsersService, notificationsService } from "@services/identity"
 import CollaboratorsService from "@services/identity/CollaboratorsService"
@@ -137,7 +137,7 @@ const pageService = new PageService({
 })
 const configService = new ConfigService()
 const reviewRequestService = new ReviewRequestService(
-  (gitHubService as unknown) as typeof ReviewApi,
+  (gitHubService as unknown) as RepoService,
   User,
   ReviewRequest,
   Reviewer,

src/integration/Sites.spec.ts

@@ -1,5 +1,6 @@
 import express from "express"
 import mockAxios from "jest-mock-axios"
+import simpleGit from "simple-git"
 import request from "supertest"
 
 import {
@@ -24,7 +25,6 @@ import { getAuthorizationMiddleware } from "@root/middleware"
 import { statsMiddleware } from "@root/middleware/stats"
 import { SitesRouter as _SitesRouter } from "@root/routes/v2/authenticated/sites"
 import { isomerRepoAxiosInstance } from "@root/services/api/AxiosInstance"
-import { GitHubService } from "@root/services/db/GitHubService"
 import { BaseDirectoryService } from "@root/services/directoryServices/BaseDirectoryService"
 import { ResourceRoomDirectoryService } from "@root/services/directoryServices/ResourceRoomDirectoryService"
 import { CollectionPageService } from "@root/services/fileServices/MdPageServices/CollectionPageService"
@@ -51,6 +51,8 @@ import DynamoDBService from "@root/services/infra/DynamoDBService"
 import InfraService from "@root/services/infra/InfraService"
 import StepFunctionsService from "@root/services/infra/StepFunctionsService"
 import ReviewRequestService from "@root/services/review/ReviewRequestService"
+import GitFileSystemService from "@services/db/GitFileSystemService"
+import RepoService from "@services/db/RepoService"
 import { getIdentityAuthService, getUsersService } from "@services/identity"
 import CollaboratorsService from "@services/identity/CollaboratorsService"
 import { sequelize } from "@tests/database"
@@ -62,9 +64,11 @@ const mockUpdatedAt = "now"
 const mockPermissions = { push: true }
 const mockPrivate = true
 
-const gitHubService = new GitHubService({
-  axiosInstance: isomerRepoAxiosInstance,
-})
+const gitFileSystemService = new GitFileSystemService(simpleGit())
+const gitHubService = new RepoService(
+  isomerRepoAxiosInstance,
+  gitFileSystemService
+)
 const configYmlService = new ConfigYmlService({ gitHubService })
 const usersService = getUsersService(sequelize)
 const isomerAdminsService = new IsomerAdminsService({ repository: IsomerAdmin })

src/server.js

@@ -6,6 +6,7 @@ import { SgidClient } from "@opengovsg/sgid-client"
 import SequelizeStoreFactory from "connect-session-sequelize"
 import session from "express-session"
 import nocache from "nocache"
+import simpleGit from "simple-git"
 
 import { config } from "@config/config"
 
@@ -72,6 +73,8 @@ import getAuthenticatedSubrouter from "./routes/v2/authenticated"
 import { ReviewsRouter } from "./routes/v2/authenticated/review"
 import getAuthenticatedSitesSubrouter from "./routes/v2/authenticatedSites"
 import { SgidAuthRouter } from "./routes/v2/sgidAuth"
+import GitFileSystemService from "./services/db/GitFileSystemService"
+import RepoService from "./services/db/RepoService"
 import { PageService } from "./services/fileServices/MdPageServices/PageService"
 import { ConfigService } from "./services/fileServices/YmlFileServices/ConfigService"
 import CollaboratorsService from "./services/identity/CollaboratorsService"
@@ -144,13 +147,14 @@ const { FormsgRouter } = require("@routes/formsgSiteCreation")
 const { FormsgSiteLaunchRouter } = require("@routes/formsgSiteLaunch")
 const { AuthRouter } = require("@routes/v2/auth")
 
-const { GitHubService } = require("@services/db/GitHubService")
 const { AuthService } = require("@services/utilServices/AuthService")
 
 const authService = new AuthService({ usersService })
-const gitHubService = new GitHubService({
-  axiosInstance: isomerRepoAxiosInstance,
-})
+const gitFileSystemService = new GitFileSystemService(new simpleGit())
+const gitHubService = new RepoService(
+  isomerRepoAxiosInstance,
+  gitFileSystemService
+)
 const configYmlService = new ConfigYmlService({ gitHubService })
 const footerYmlService = new FooterYmlService({ gitHubService })
 const collectionYmlService = new CollectionYmlService({ gitHubService })