Fix encoding during file uploads (#13)

Need to support binary types

Author: evanfuller

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "nightfall-js",
-  "version": "1.1.0",
+  "version": "1.1.1",
   "description": "Build data classification and protection into your application or service with Nightfall.",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",

package.json

@@ -57,14 +57,15 @@ export class FileScanner extends Base {
       // Read the file in chunks
       const stream = fs.createReadStream(this.filePath, {
         highWaterMark: this.chunkSize,
-        encoding: 'utf8'
+        encoding: 'binary'
       })
 
       // Upload chunks
       let uploadOffset = 0
 
       for await (const chunk of stream) {
-        await axios.patch(`${this.API_HOST}/v3/upload/${this.fileId}`, chunk, {
+        let body = Buffer.from(chunk, 'binary')
+        await axios.patch(`${this.API_HOST}/v3/upload/${this.fileId}`, body, {
           headers: {
             ...this.AXIOS_HEADERS,
             'Content-Type': 'application/octet-stream',

src/filesScanner.ts

@@ -7,6 +7,7 @@ import { Nightfall } from '../nightfall'
 // Mock data
 const API_HOST = 'https://api.nightfall.ai'
 const FILE_PATH = path.join(__dirname, "./", "mySecrets.txt");
+const IMAGE_FILE_PATH = path.join(__dirname, "./", "test-image.png");
 const REQUEST_POLICY: ScanFile.ScanPolicy = {
   detectionRuleUUIDs: ['MOCK_RULE_UUID'],
   webhookURL: 'https://webhook.com'
@@ -52,6 +53,16 @@ describe('should test the file scanning method', () => {
     expect(response.isError).toBe(false)
   })
 
+  it('test binary upload data', async () => {
+    const nfClient = new Nightfall()
+    const scanFileSpy = jest.spyOn(nfClient, 'scanFile')
+
+    const response = await nfClient.scanFile(IMAGE_FILE_PATH, REQUEST_POLICY)
+    expect(scanFileSpy).toHaveBeenCalledWith(IMAGE_FILE_PATH, REQUEST_POLICY)
+    expect(response.data).toEqual(SCAN_RESPONSE)
+    expect(response.isError).toBe(false)
+  })
+
   it('test error path', async () => {
     // Reset mocks and force error response
     mock.reset()