Fix: Replace form-data with formdata-node (Issue #609)

package.json

@@ -40,7 +40,8 @@
   "license": "MIT",
   "dependencies": {
     "change-case": "^4.1.2",
-    "form-data": "^4.0.0",
+    "form-data-encoder": "^4.0.2",
+    "formdata-node": "^6.0.3",
     "mime-types": "^2.1.35",
     "node-fetch": "^2.6.12",
     "uuid": "^8.3.2"
@@ -56,8 +57,8 @@
     "eslint": "^5.14.0",
     "eslint-config-prettier": "^4.0.0",
     "eslint-plugin-custom-rules": "^0.0.0",
-    "eslint-plugin-prettier": "^3.0.1",
     "eslint-plugin-import": "^2.28.1",
+    "eslint-plugin-prettier": "^3.0.1",
     "jest": "^29.6.1",
     "prettier": "^1.19.1",
     "ts-jest": "^29.1.1",

src/apiClient.ts

@@ -7,7 +7,8 @@ import {
 } from './models/error.js';
 import { objKeysToCamelCase, objKeysToSnakeCase } from './utils.js';
 import { SDK_VERSION } from './version.js';
-import FormData from 'form-data';
+import { FormData } from 'formdata-node';
+import { FormDataEncoder } from 'form-data-encoder';
 import { snakeCase } from 'change-case';
 
 /**
@@ -26,7 +27,7 @@ export interface RequestOptionsParams {
   headers?: Record<string, string>;
   queryParams?: Record<string, any>;
   body?: any;
-  form?: FormData;
+  form?: FormData | any; // Support both formdata-node and legacy form-data types
   overrides?: OverridableNylasConfig;
 }
 
@@ -209,9 +210,10 @@ export default class APIClient {
 
     if (optionParams.form) {
       requestOptions.body = optionParams.form;
+      const encoder = new FormDataEncoder(optionParams.form);
       requestOptions.headers = {
         ...requestOptions.headers,
-        ...optionParams.form.getHeaders(),
+        'content-type': encoder.contentType,
       };
     }
 

src/resources/messages.ts

@@ -1,4 +1,5 @@
-import FormData from 'form-data';
+import { FormData, File } from 'formdata-node';
+import { ReadableStream } from 'node:stream/web';
 import APIClient, { RequestOptionsParams } from '../apiClient.js';
 import { Overrides } from '../config.js';
 import {
@@ -220,7 +221,7 @@ export class Messages extends Resource {
       }, 0) || 0;
 
     if (attachmentSize >= Messages.MAXIMUM_JSON_ATTACHMENT_SIZE) {
-      requestOptions.form = Messages._buildFormRequest(requestBody);
+      requestOptions.form = await Messages._buildFormRequest(requestBody);
     } else {
       if (requestBody.attachments) {
         const processedAttachments = await encodeAttachmentStreams(
@@ -308,13 +309,10 @@ export class Messages extends Resource {
     });
   }
 
-  static _buildFormRequest(
+  static async _buildFormRequest(
     requestBody: CreateDraftRequest | UpdateDraftRequest | SendMessageRequest
-  ): FormData {
-    // FormData imports are funky, cjs needs to use .default, es6 doesn't
-    const FD = require('form-data');
-    const FormDataConstructor = FD.default || FD;
-    const form: FormData = new FormDataConstructor();
+  ): Promise<FormData> {
+    const form = new FormData();
 
     // Split out the message payload from the attachments
     const messagePayload = {
@@ -324,13 +322,39 @@ export class Messages extends Resource {
     form.append('message', JSON.stringify(objKeysToSnakeCase(messagePayload)));
 
     // Add a separate form field for each attachment
-    requestBody.attachments?.forEach((attachment, index) => {
-      const contentId = attachment.contentId || `file${index}`;
-      form.append(contentId, attachment.content, {
-        filename: attachment.filename,
-        contentType: attachment.contentType,
-      });
-    });
+    if (requestBody.attachments) {
+      for (const [index, attachment] of requestBody.attachments.entries()) {
+        const contentId = attachment.contentId || `file${index}`;
+        // Handle different types of content (Buffer, ReadableStream, string)
+        let file;
+        // Type guard for Node.js streams
+        const isNodeStream = (value: unknown): value is { pipe: Function } => {
+          return (
+            value !== null &&
+            typeof value === 'object' &&
+            typeof (value as any).pipe === 'function'
+          );
+        };
+
+        if (attachment.content instanceof ReadableStream) {
+          // For web ReadableStream
+          file = attachment.content;
+        } else if (isNodeStream(attachment.content)) {
+          // For Node.js streams (which have pipe method)
+          file = attachment.content;
+        } else if (
+          attachment.content instanceof Buffer ||
+          typeof attachment.content === 'string'
+        ) {
+          file = new File([attachment.content], attachment.filename, {
+            type: attachment.contentType,
+          });
+        } else {
+          throw new Error('Unsupported attachment content type');
+        }
+        form.append(contentId, file);
+      }
+    }
 
     return form;
   }

tests/resources/drafts.spec.ts

@@ -6,16 +6,50 @@ import { createReadableStream, MockedFormData } from '../testUtils';
 jest.mock('../src/apiClient');
 
 // Mock the FormData constructor
-jest.mock('form-data', () => {
-  return jest.fn().mockImplementation(function(this: MockedFormData) {
-    const appendedData: Record<string, any> = {};
+jest.mock('formdata-node', () => {
+  return {
+    FormData: jest.fn().mockImplementation(() => {
+      const appendedData: Record<string, any> = {};
 
-    this.append = (key: string, value: any): void => {
-      appendedData[key] = value;
-    };
+      const getAppendedData = () => appendedData;
 
-    this._getAppendedData = (): Record<string, any> => appendedData;
-  });
+      const createMockFormData = () => {
+        const formData = {
+          append(key: string, value: any): void {
+            if (value && typeof value === 'object' && 'content' in value) {
+              // Handle File objects
+              appendedData[key] = value.content;
+            } else {
+              appendedData[key] = value;
+            }
+          },
+          _getAppendedData: getAppendedData,
+          form: {
+            _getAppendedData: getAppendedData,
+            append(key: string, value: any): void {
+              if (value && typeof value === 'object' && 'content' in value) {
+                // Handle File objects
+                appendedData[key] = value.content;
+              } else {
+                appendedData[key] = value;
+              }
+            },
+          },
+        };
+
+        return formData as MockedFormData;
+      };
+
+      const mockFormData = createMockFormData() as MockedFormData;
+
+      return mockFormData;
+    }),
+    File: jest.fn().mockImplementation((content: any[], name: string) => ({
+      content,
+      name,
+    })),
+    Blob: jest.fn(),
+  };
 });
 
 describe('Drafts', () => {

tests/resources/messages.spec.ts

@@ -5,16 +5,18 @@ import { CreateAttachmentRequest } from '../../src/models/attachments';
 jest.mock('../src/apiClient');
 
 // Mock the FormData constructor
-jest.mock('form-data', () => {
-  return jest.fn().mockImplementation(function(this: MockedFormData) {
-    const appendedData: Record<string, any> = {};
+jest.mock('formdata-node', () => {
+  return {
+    FormData: jest.fn().mockImplementation(function(this: MockedFormData) {
+      const appendedData: Record<string, any> = {};
 
-    this.append = (key: string, value: any): void => {
-      appendedData[key] = value;
-    };
+      this.append = (key: string, value: any): void => {
+        appendedData[key] = value;
+      };
 
-    this._getAppendedData = (): Record<string, any> => appendedData;
-  });
+      this._getAppendedData = (): Record<string, any> => appendedData;
+    }),
+  };
 });
 
 describe('Messages', () => {

tests/testUtils.ts

@@ -5,6 +5,9 @@ import { Readable } from 'stream';
 export interface MockedFormData {
   append(key: string, value: any): void;
   _getAppendedData(): Record<string, any>;
+  form: MockedFormData & {
+    _getAppendedData(): Record<string, any>;
+  };
 }
 
 export const mockedFetch = fetch as jest.MockedFunction<typeof fetch>;