refactor: ensure consistent filesize const (#2079)

* refactor: move MB to shared/constants and use MB throughout app

* ref: lint attachmentValidator and use relative import

Co-authored-by: Kar Rui Lau <[email protected]>

src/app/models/form.server.model.ts

@@ -9,6 +9,7 @@ import mongoose, {
 } from 'mongoose'
 import validator from 'validator'
 
+import { MB } from '../../shared/constants'
 import { reorder } from '../../shared/util/immutable-array-fns'
 import {
   AuthType,
@@ -41,7 +42,6 @@ import {
   Status,
 } from '../../types'
 import { IPopulatedUser, IUserSchema } from '../../types/user'
-import { MB } from '../constants/filesize'
 import { OverrideProps } from '../modules/form/admin-form/admin-form.types'
 import { getFormFieldById, transformEmails } from '../modules/form/form.utils'
 import { validateWebhookUrl } from '../modules/webhook/webhook.validation'

src/app/modules/submission/email-submission/__tests__/email-submission.receiver.spec.ts

@@ -5,7 +5,7 @@ import { IncomingHttpHeaders } from 'http'
 import { pick } from 'lodash'
 import { mocked } from 'ts-jest/utils'
 
-import { MB } from 'src/app/constants/filesize'
+import { MB } from 'src/shared/constants'
 import { BasicField } from 'src/types'
 
 import {
@@ -52,8 +52,8 @@ describe('email-submission.receiver', () => {
       expect(MockBusboy).toHaveBeenCalledWith({
         headers: MOCK_HEADERS,
         limits: {
-          fieldSize: 3 * 1048576,
-          fileSize: 7 * 1048576,
+          fieldSize: 3 * MB,
+          fileSize: 7 * MB,
         },
       })
       expect(result._unsafeUnwrap()).toEqual(MOCK_BUSBOY)
@@ -71,8 +71,8 @@ describe('email-submission.receiver', () => {
       expect(MockBusboy).toHaveBeenCalledWith({
         headers: MOCK_HEADERS,
         limits: {
-          fieldSize: 3 * 1048576,
-          fileSize: 7 * 1048576,
+          fieldSize: 3 * MB,
+          fileSize: 7 * MB,
         },
       })
       expect(result._unsafeUnwrapErr()).toEqual(

src/app/modules/submission/email-submission/email-submission.receiver.ts

@@ -2,9 +2,9 @@ import Busboy from 'busboy'
 import { IncomingHttpHeaders } from 'http'
 import { err, ok, Result, ResultAsync } from 'neverthrow'
 
+import { MB } from '../../../../shared/constants'
 import { IAttachmentInfo } from '../../../../types'
 import { createLoggerWithLabel } from '../../../config/logger'
-import { MB } from '../../../constants/filesize'
 
 import {
   InitialiseMultipartReceiverError,

src/app/utils/field-validation/validators/attachmentValidator.ts

@@ -5,7 +5,7 @@ import { ProcessedAttachmentResponse } from 'src/app/modules/submission/submissi
 import { IAttachmentField } from 'src/types/field'
 import { ResponseValidator } from 'src/types/field/utils/validation'
 
-const MILLION = 1000000
+import { MB } from '../../../../shared/constants'
 
 type AttachmentValidator = ResponseValidator<ProcessedAttachmentResponse>
 type AttachmentValidatorConstructor = (
@@ -41,7 +41,7 @@ const attachmentContentValidator: AttachmentValidator = (response) => {
 const makeAttachmentSizeValidator: AttachmentValidatorConstructor =
   (attachmentField) => (response) => {
     const { attachmentSize } = attachmentField
-    const byteSizeLimit = parseInt(attachmentSize) * MILLION
+    const byteSizeLimit = parseInt(attachmentSize) * MB
     return response.content.byteLength < byteSizeLimit
       ? right(response)
       : left(`AttachmentValidator:\t File size more than limit`)

src/public/modules/forms/admin/controllers/edit-fields-modal.client.controller.js

@@ -9,6 +9,7 @@ const UserService = require('../../../../services/UserService')
 const {
   VALID_UPLOAD_FILE_TYPES,
   MAX_UPLOAD_FILE_SIZE,
+  MB,
 } = require('shared/constants')
 const { UPDATE_FORM_TYPES } = require('../constants/update-form-types')
 const { uploadImage } = require('../../../../services/FileHandlerService')
@@ -546,8 +547,8 @@ function EditFieldsModalController(
       field.uploadedFile = ''
       switch (ngfError.$error) {
         case 'maxSize':
-          vm.uploadError = `${(ngfError.size / 1000000).toFixed(2)} MB / ${
-            vm.maxImageSize / 1000000
+          vm.uploadError = `${(ngfError.size / MB).toFixed(2)} MB / ${
+            vm.maxImageSize / MB
           } MB: File size exceeded`
           break
         case 'resize':
@@ -572,7 +573,7 @@ function EditFieldsModalController(
           field.url = result.url
           field.fileMd5Hash = result.fileMd5Hash
           field.name = result.name
-          field.size = `${(result.size / 1000000).toFixed(2)} MB`
+          field.size = `${(result.size / MB).toFixed(2)} MB`
         })
         .catch((uploadError) => {
           // This is a reference to the ng-model of the upload button, which points to the uploaded file

src/public/modules/forms/admin/controllers/edit-start-page-modal.client.controller.js

@@ -4,6 +4,7 @@ const axios = require('axios').default
 const {
   MAX_UPLOAD_FILE_SIZE,
   VALID_UPLOAD_FILE_TYPES,
+  MB,
 } = require('shared/constants')
 const { uploadLogo } = require('../../../../services/FileHandlerService')
 const { FormLogoState } = require('../../../../../types')
@@ -32,6 +33,7 @@ function EditStartPageController(
 
   vm.maxLogoSize = MAX_UPLOAD_FILE_SIZE
   vm.validLogoExtensions = VALID_UPLOAD_FILE_TYPES
+  vm.MB = MB
   vm.FormLogoState = FormLogoState
 
   vm.logoUrl = getFormLogo(myform)
@@ -116,8 +118,8 @@ function EditStartPageController(
       vm.uploaded.file = ''
       switch (ngfError.$error) {
         case 'maxSize':
-          vm.uploadError = `${(ngfError.size / 1000000).toFixed(2)} MB / ${
-            vm.maxLogoSize / 1000000
+          vm.uploadError = `${(ngfError.size / MB).toFixed(2)} MB / ${
+            vm.maxLogoSize / MB
           } MB: File size exceeded`
           break
         case 'resize':

src/public/modules/forms/admin/views/edit-start-page.client.modal.html

@@ -79,7 +79,7 @@ <h2 class="modal-title">Edit Welcome</h2>
                   >
                   <span id="image-size"
                     >{{
-                    (vm.myform.startPage.logo.fileSizeInBytes/1000000).toFixed(2)
+                    (vm.myform.startPage.logo.fileSizeInBytes/vm.MB).toFixed(2)
                     }} MB</span
                   >
                 </div>

src/public/modules/forms/base/componentViews/field-attachment.client.view.html

@@ -47,7 +47,7 @@
         ngf-resize="{width: 1024, centerCrop: false}"
         ngf-validate-after-resize="true"
         ngf-max-files="1"
-        ngf-max-size="vm.field.attachmentSize * 1000000"
+        ngf-max-size="{{ vm.field.attachmentSize * vm.MB }}"
         ngf-select="vm.uploadFile($file, $invalidFiles, vm.field._id)"
         ng-model="vm.field.fieldValue"
       />

src/public/modules/forms/base/components/field-attachment.client.component.js

@@ -5,7 +5,7 @@ const {
   isInvalidFileExtension,
   getInvalidFileExtensionsInZip,
 } = require('../../../../../shared/util/file-validation')
-const { FilePlatforms } = require('../../../../../shared/constants')
+const { FilePlatforms, KB, MB } = require('../../../../../shared/constants')
 
 angular.module('forms').component('attachmentFieldComponent', {
   templateUrl:
@@ -22,6 +22,8 @@ angular.module('forms').component('attachmentFieldComponent', {
 function attachmentFieldComponentController($timeout) {
   const vm = this
 
+  vm.MB = MB
+
   vm.isAttachmentTouched = false
   vm.touchAttachment = function () {
     vm.isAttachmentTouched = true
@@ -37,7 +39,7 @@ function attachmentFieldComponentController($timeout) {
     if (errFiles.length > 0) {
       err = errFiles[0].$error
       if (err === 'maxSize') {
-        const currentSize = (errFiles[0].size / 1000000).toFixed(2)
+        const currentSize = (errFiles[0].size / MB).toFixed(2)
         showAttachmentError(
           `${currentSize} MB / ${vm.field.attachmentSize} MB: File size exceeded`,
         )
@@ -136,11 +138,11 @@ function attachmentFieldComponentController($timeout) {
         vm.fileAttached = true
         vm.fileError = false
         vm.fileName = file.name
-        vm.fileSize = file.size / 1000
-        if (file.size / 1000 > 1000) {
-          vm.fileSize = String((file.size / 1000000).toFixed(2)) + ' MB'
+        vm.fileSize = file.size / KB
+        if (file.size / KB > KB) {
+          vm.fileSize = String((file.size / MB).toFixed(2)) + ' MB'
         } else {
-          vm.fileSize = String((file.size / 1000).toFixed(2)) + ' KB'
+          vm.fileSize = String((file.size / KB).toFixed(2)) + ' KB'
         }
         vm.isLoading = false
       })

src/shared/constants.ts

@@ -22,8 +22,11 @@ export enum DateSelectedValidation {
 // File types that can be uploaded for form image/logo
 export const VALID_UPLOAD_FILE_TYPES = ['image/jpeg', 'image/png', 'image/gif']
 
+export const KB = 1000
+export const MB = 1000 * KB
+
 // Define max file size as 2MB
-export const MAX_UPLOAD_FILE_SIZE = 2 * 1000 * 1000 // 2 Million/Mega Bytes, or 2 MB
+export const MAX_UPLOAD_FILE_SIZE = 2 * MB // 2 Million/Mega Bytes, or 2 MB
 
 export const LINKS = {
   supportFormLink: 'https://go.gov.sg/formsg-support',