feat(feature-manager): tear out AggregateStats feature

.template-env

@@ -31,7 +31,6 @@ FORMSG_SDK_MODE=
 # APP_NAME=FormSG
 # OTP_LIFE_SPAN=900000
 # BOUNCE_LIFE_SPAN=86400000
-# AGGREGATE_COLLECTION=
 
 # If provided, a banner with the provided message will show up in every form.
 # IS_GENERAL_MAINTENANCE=

docker-compose.yml

@@ -71,7 +71,6 @@ services:
       - CORPPASS_IDP_ID
       - IS_SP_MAINTENANCE
       - IS_CP_MAINTENANCE
-      - AGGREGATE_COLLECTION
 
   mockpass:
     build: https://github.com/opengovsg/mockpass.git

docs/DEPLOYMENT_SETUP.md

@@ -251,16 +251,6 @@ If this feature is enabled, client-side error events will be piped to [sentry.io
 | `SENTRY_CONFIG_URL` | Sentry.io URL for configuring the Raven SDK.                                                          |
 | `CSP_REPORT_URI`    | Reporting URL for Content Security Policy violdations. Can be configured to use a Sentry.io endpoint. |
 
-#### Examples page Using Pre-Computed Results
-
-If this feature is enabled, the submission statistics associated with forms loaded on the examples page will be fetched from the pre-computed values in the FormStatisticsTotal collection. The FormStatisticsTotal collection only exists if the [batch jobs](https://github.com/datagovsg/formsg-batch-jobs/) needed to calculate the submission statistics are run daily.
-
-If this feature is not enabled, the submission statistics associated with forms loaded on the examples page will be calculated on the fly from the Submissions collection. This may be sub-optimal when submissions are in the millions.
-
-| Variable               | Description                                                           |
-| :--------------------- | --------------------------------------------------------------------- |
-| `AGGREGATE_COLLECTION` | Has to be defined (i.e. =true) if FormStats collection is to be used. |
-
 #### SMS with Twilio
 
 If this feature is enabled, the Mobile Number field will support form-fillers verifying their mobile numbers via a One-Time-Pin sent to their mobile phones and will also support an SMS confirmation of successful submission being sent out to their said mobile numbers. All messages are sent using [twilio](https://www.twilio.com/) messaging APIs.

src/app/config/feature-manager/index.ts

@@ -1,5 +1,4 @@
 import FeatureManager from './util/FeatureManager.class'
-import aggregateStats from './aggregate-stats.config'
 import captcha from './captcha.config'
 import googleAnalytics from './google-analytics.config'
 import { intranetFeature } from './intranet.config'
@@ -17,7 +16,6 @@ const featureManager = new FeatureManager()
 featureManager.register(captcha)
 featureManager.register(sentry)
 featureManager.register(googleAnalytics)
-featureManager.register(aggregateStats)
 featureManager.register(spcpMyInfo)
 featureManager.register(webhookVerifiedContent)
 featureManager.register(sms)

src/app/config/feature-manager/types.ts

@@ -2,7 +2,6 @@ import { MyInfoMode } from '@opengovsg/myinfo-gov-client'
 import { Schema } from 'convict'
 
 export enum FeatureNames {
-  AggregateStats = 'aggregate-stats',
   Captcha = 'captcha',
   GoogleAnalytics = 'google-analytics',
   Sentry = 'sentry',
@@ -13,10 +12,6 @@ export enum FeatureNames {
   Intranet = 'intranet',
 }
 
-export interface IAggregateStats {
-  aggregateCollection: string
-}
-
 export interface ICaptcha {
   captchaPrivateKey: string
   captchaPublicKey: string
@@ -87,7 +82,6 @@ export interface IIntranet {
 }
 
 export interface IFeatureManager {
-  [FeatureNames.AggregateStats]: IAggregateStats
   [FeatureNames.Captcha]: ICaptcha
   [FeatureNames.GoogleAnalytics]: IGoogleAnalytics
   [FeatureNames.Sentry]: ISentry

src/app/modules/examples/__tests__/examples.controller.spec.ts

@@ -8,11 +8,11 @@ import expressHandler from 'tests/unit/backend/helpers/jest-express'
 import { DatabaseError } from '../../core/core.errors'
 import * as ExamplesController from '../examples.controller'
 import { ResultsNotFoundError } from '../examples.errors'
-import { ExamplesFactory } from '../examples.factory'
+import * as ExamplesService from '../examples.service'
 import { ExamplesQueryParams, SingleFormResult } from '../examples.types'
 
-jest.mock('../examples.factory')
-const MockExamplesFactory = mocked(ExamplesFactory)
+jest.mock('../examples.service')
+const MockExamplesService = mocked(ExamplesService)
 
 describe('examples.controller', () => {
   beforeEach(() => jest.clearAllMocks())
@@ -38,15 +38,15 @@ describe('examples.controller', () => {
         forms: [],
         totalNumResults: 0,
       }
-      MockExamplesFactory.getExampleForms.mockReturnValueOnce(
+      MockExamplesService.getExampleForms.mockReturnValueOnce(
         okAsync(mockResult),
       )
 
       // Act
       await ExamplesController.handleGetExamples(MOCK_REQ, mockRes, jest.fn())
 
       // Assert
-      expect(MockExamplesFactory.getExampleForms).toHaveBeenCalledWith(
+      expect(MockExamplesService.getExampleForms).toHaveBeenCalledWith(
         MOCK_REQ_QUERY,
       )
       expect(mockRes.status).toBeCalledWith(200)
@@ -57,15 +57,15 @@ describe('examples.controller', () => {
       // Arrange
       const mockRes = expressHandler.mockResponse()
       // Mock getExampleForms to return error.
-      MockExamplesFactory.getExampleForms.mockReturnValueOnce(
+      MockExamplesService.getExampleForms.mockReturnValueOnce(
         errAsync(new DatabaseError()),
       )
 
       // Act
       await ExamplesController.handleGetExamples(MOCK_REQ, mockRes, jest.fn())
 
       // Assert
-      expect(MockExamplesFactory.getExampleForms).toHaveBeenCalledWith(
+      expect(MockExamplesService.getExampleForms).toHaveBeenCalledWith(
         MOCK_REQ_QUERY,
       )
       expect(mockRes.status).toBeCalledWith(500)
@@ -106,7 +106,7 @@ describe('examples.controller', () => {
           title: 'mockTitle',
         },
       }
-      MockExamplesFactory.getSingleExampleForm.mockReturnValueOnce(
+      MockExamplesService.getSingleExampleForm.mockReturnValueOnce(
         okAsync(mockResult),
       )
 
@@ -118,7 +118,7 @@ describe('examples.controller', () => {
       )
 
       // Assert
-      expect(MockExamplesFactory.getSingleExampleForm).toHaveBeenCalledWith(
+      expect(MockExamplesService.getSingleExampleForm).toHaveBeenCalledWith(
         MOCK_REQ_PARAMS.formId,
       )
       expect(mockRes.status).toBeCalledWith(200)
@@ -130,7 +130,7 @@ describe('examples.controller', () => {
       const mockRes = expressHandler.mockResponse()
       // Mock getSingleExampleForm to return not found error.
       const mockErrorString = 'not found error!'
-      MockExamplesFactory.getSingleExampleForm.mockReturnValueOnce(
+      MockExamplesService.getSingleExampleForm.mockReturnValueOnce(
         errAsync(new ResultsNotFoundError(mockErrorString)),
       )
 
@@ -142,7 +142,7 @@ describe('examples.controller', () => {
       )
 
       // Assert
-      expect(MockExamplesFactory.getSingleExampleForm).toHaveBeenCalledWith(
+      expect(MockExamplesService.getSingleExampleForm).toHaveBeenCalledWith(
         MOCK_REQ_PARAMS.formId,
       )
       expect(mockRes.status).toBeCalledWith(404)
@@ -154,7 +154,7 @@ describe('examples.controller', () => {
       const mockRes = expressHandler.mockResponse()
       // Mock getSingleExampleForm to return database error.
       const mockErrorString = 'database error!'
-      MockExamplesFactory.getSingleExampleForm.mockReturnValueOnce(
+      MockExamplesService.getSingleExampleForm.mockReturnValueOnce(
         errAsync(new DatabaseError(mockErrorString)),
       )
 
@@ -166,7 +166,7 @@ describe('examples.controller', () => {
       )
 
       // Assert
-      expect(MockExamplesFactory.getSingleExampleForm).toHaveBeenCalledWith(
+      expect(MockExamplesService.getSingleExampleForm).toHaveBeenCalledWith(
         MOCK_REQ_PARAMS.formId,
       )
       expect(mockRes.status).toBeCalledWith(500)