- Moved 2854-file-encoding-with-package over to new branch

elipe17 · elipe17 · commit f27da56a6ee7 · 2025-01-21T16:38:12.000-05:00
diff --git a/tdrs-frontend/package-lock.json b/tdrs-frontend/package-lock.json
diff --git a/tdrs-frontend/package.json b/tdrs-frontend/package.json
@@ -11,6 +11,7 @@
     "@uswds/uswds": "3.10.0",
     "axios": "^1.7.7",
     "classnames": "^2.5.1",
+    "detect-file-encoding-and-language": "^2.4.0",
     "file-type-checker": "^1.1.2",
     "history": "^5.3.0",
     "include-media": "^2.0.0",
diff --git a/tdrs-frontend/src/actions/reports.js b/tdrs-frontend/src/actions/reports.js
@@ -4,7 +4,6 @@ import axios from 'axios'
 import axiosInstance from '../axios-instance'
 import { logErrorToServer } from '../utils/eventLogger'
 import removeFileInputErrorState from '../utils/removeFileInputErrorState'
-import { fileUploadSections } from '../reducers/reports'
 
 const BACKEND_URL = process.env.REACT_APP_BACKEND_URL
 
diff --git a/tdrs-frontend/src/components/FileUpload/FileUpload.jsx b/tdrs-frontend/src/components/FileUpload/FileUpload.jsx
@@ -2,6 +2,7 @@ import React, { useRef, useEffect } from 'react'
 import PropTypes from 'prop-types'
 import { useDispatch, useSelector } from 'react-redux'
 import fileTypeChecker from 'file-type-checker'
+import languageEncoding from 'detect-file-encoding-and-language'
 
 import {
   clearError,
@@ -34,6 +35,87 @@ const INVALID_EXT_ERROR = (
   </>
 )
 
+// The package author suggests using a minimum of 500 words to determine the encoding. However, datafiles don't have
+// "words" so we're using bytes instead to determine the encoding. See: https://www.npmjs.com/package/detect-file-encoding-and-language
+const MIN_BYTES = 500
+
+/* istanbul ignore next */
+const tryGetUTF8EncodedFile = async function (fileBytes, file) {
+  // Create a small view of the file to determine the encoding.
+  const btyesView = new Uint8Array(fileBytes.slice(0, MIN_BYTES))
+  const blobView = new Blob([btyesView], { type: 'text/plain' })
+  try {
+    const fileInfo = await languageEncoding(blobView)
+    const bom = btyesView.slice(0, 3)
+    const hasBom = bom[0] === 0xef && bom[1] === 0xbb && bom[2] === 0xbf
+    if ((fileInfo && fileInfo.encoding !== 'UTF-8') || hasBom) {
+      const utf8Encoder = new TextEncoder()
+      const decoder = new TextDecoder(fileInfo.encoding)
+      const decodedString = decoder.decode(
+        hasBom ? fileBytes.slice(3) : fileBytes
+      )
+      const utf8Bytes = utf8Encoder.encode(decodedString)
+      return new File([utf8Bytes], file.name, file.options)
+    }
+    return file
+  } catch (error) {
+    // This is a last ditch fallback to ensure consistent functionality and also allows the unit tests to work in the
+    // same way they did before this change. When the unit tests (i.e. Node environment) call `languageEncoding` it
+    // expects a Buffer/string/URL object. When the browser calls `languageEncoding`, it expects a Blob/File object.
+    // There is not a convenient way or universal object to handle both cases. Thus, when the tests run the call to
+    // `languageEncoding`, it raises an exception and we return the file as is which is then dispatched as it would
+    // have been before this change.
+    console.error('Caught error while handling file encoding. Error:', error)
+    return file
+  }
+}
+
+const load = (file, section, input, dropTarget, dispatch) => {
+  const filereader = new FileReader()
+  const types = ['png', 'gif', 'jpeg']
+
+  return new Promise((resolve, reject) => {
+    filereader.onerror = () => {
+      filereader.abort()
+      reject()
+    }
+
+    filereader.onload = () => {
+      const re = /(\.txt|\.ms\d{2}|\.ts\d{2,3})$/i
+      if (!re.exec(file.name)) {
+        dispatch({
+          type: FILE_EXT_ERROR,
+          payload: {
+            error: { message: INVALID_EXT_ERROR },
+            section,
+          },
+        })
+        reject()
+        return
+      }
+
+      const isImg = fileTypeChecker.validateFileType(filereader.result, types)
+
+      if (isImg) {
+        createFileInputErrorState(input, dropTarget)
+
+        dispatch({
+          type: SET_FILE_ERROR,
+          payload: {
+            error: { message: INVALID_FILE_ERROR },
+            section,
+          },
+        })
+        reject()
+        return
+      }
+
+      resolve({ result: filereader.result })
+    }
+    filereader.readAsArrayBuffer(file)
+  })
+}
+
 function FileUpload({ section, setLocalAlertState }) {
   // e.g. 'Aggregate Case Data' => 'aggregate-case-data'
   // The set of uploaded files in our Redux state
@@ -86,7 +168,7 @@ function FileUpload({ section, setLocalAlertState }) {
   }
   const inputRef = useRef(null)
 
-  const validateAndUploadFile = (event) => {
+  const validateAndUploadFile = async (event) => {
     setLocalAlertState({
       active: false,
       type: null,
@@ -101,51 +183,14 @@ function FileUpload({ section, setLocalAlertState }) {
     dispatch(clearError({ section }))
     dispatch(clearFile({ section }))
 
-    // Get the the first 4 bytes of the file with which to check file signatures
-    const blob = file.slice(0, 4)
-
     const input = inputRef.current
     const dropTarget = inputRef.current.parentNode
 
-    const filereader = new FileReader()
-
-    const types = ['png', 'gif', 'jpeg']
-    filereader.onload = () => {
-      const re = /(\.txt|\.ms\d{2}|\.ts\d{2,3})$/i
-      if (!re.exec(file.name)) {
-        dispatch({
-          type: FILE_EXT_ERROR,
-          payload: {
-            error: { message: INVALID_EXT_ERROR },
-            section,
-          },
-        })
-        return
-      }
-
-      const isImg = fileTypeChecker.validateFileType(filereader.result, types)
-
-      if (isImg) {
-        createFileInputErrorState(input, dropTarget)
-
-        dispatch({
-          type: SET_FILE_ERROR,
-          payload: {
-            error: { message: INVALID_FILE_ERROR },
-            section,
-          },
-        })
-      } else {
-        dispatch(
-          upload({
-            section,
-            file,
-          })
-        )
-      }
-    }
+    const { result } = await load(file, section, input, dropTarget, dispatch)
 
-    filereader.readAsArrayBuffer(blob)
+    // Get the correctly encoded file
+    const encodedFile = await tryGetUTF8EncodedFile(result, file)
+    dispatch(upload({ file: encodedFile, section }))
   }
 
   return (
diff --git a/tdrs-frontend/src/components/UploadReport/UploadReport.test.js b/tdrs-frontend/src/components/UploadReport/UploadReport.test.js
@@ -2,7 +2,7 @@ import React from 'react'
 import { thunk } from 'redux-thunk'
 import { Provider } from 'react-redux'
 import configureStore from 'redux-mock-store'
-import { fireEvent, render } from '@testing-library/react'
+import { fireEvent, render, waitFor } from '@testing-library/react'
 import axios from 'axios'
 
 import { v4 as uuidv4 } from 'uuid'
@@ -59,7 +59,7 @@ describe('UploadReport', () => {
     expect(inputs.length).toEqual(4)
   })
 
-  it('should dispatch the `clearError` and `upload` actions when submit button is clicked', () => {
+  it('should dispatch the `clearError` and `upload` actions when submit button is clicked', async () => {
     const store = mockStore(initialState)
     const origDispatch = store.dispatch
     store.dispatch = jest.fn(origDispatch)
@@ -74,16 +74,18 @@ describe('UploadReport', () => {
 
     const newFile = new File(['test'], 'test.txt', { type: 'text/plain' })
 
-    fireEvent.change(fileInput, {
-      target: {
-        files: [newFile],
-      },
+    await waitFor(() => {
+      fireEvent.change(fileInput, {
+        target: {
+          files: [newFile],
+        },
+      })
     })
 
     expect(store.dispatch).toHaveBeenCalledTimes(2)
     expect(container.querySelectorAll('.has-invalid-file').length).toBe(0)
   })
-  it('should prevent upload of file with invalid extension', () => {
+  it('should prevent upload of file with invalid extension', async () => {
     const store = mockStore(initialState)
     const origDispatch = store.dispatch
     store.dispatch = jest.fn(origDispatch)
@@ -101,10 +103,12 @@ describe('UploadReport', () => {
     })
 
     expect(container.querySelectorAll('.has-invalid-file').length).toBe(0)
-    fireEvent.change(fileInput, {
-      target: {
-        files: [newFile],
-      },
+    await waitFor(() => {
+      fireEvent.change(fileInput, {
+        target: {
+          files: [newFile],
+        },
+      })
     })
 
     expect(store.dispatch).toHaveBeenCalledTimes(2)
@@ -223,7 +227,7 @@ describe('UploadReport', () => {
     expect(formGroup.classList.contains('usa-form-group--error')).toBeFalsy()
   })
 
-  it('should clear input value if there is an error', () => {
+  it('should clear input value if there is an error', async () => {
     const store = mockStore(initialState)
     axios.post.mockImplementationOnce(() =>
       Promise.resolve({ data: { id: 1 } })
@@ -240,11 +244,13 @@ describe('UploadReport', () => {
     const newFile = new File(['test'], 'test.txt', { type: 'text/plain' })
     const fileList = [newFile]
 
-    fireEvent.change(fileInput, {
-      target: {
-        name: 'Active Case Data',
-        files: fileList,
-      },
+    await waitFor(() => {
+      fireEvent.change(fileInput, {
+        target: {
+          name: 'Active Case Data',
+          files: fileList,
+        },
+      })
     })
 
     expect(fileInput.value).toStrictEqual('')
diff --git a/tdrs-frontend/src/setupTests.js b/tdrs-frontend/src/setupTests.js
@@ -7,6 +7,9 @@ import 'jest-enzyme'
 import Enzyme from 'enzyme'
 import Adapter from '@cfaester/enzyme-adapter-react-18'
 import startMirage from './mirage'
+import { TextEncoder, TextDecoder } from 'util'
+
+Object.assign(global, { TextDecoder, TextEncoder })
 
 Enzyme.configure({ adapter: new Adapter() })
 
