Test URL construction and query parameter encoding

Co-authored-by: aaron.d <[email protected]>

Author: cursoragent

tests/resources/events.spec.ts

@@ -588,4 +588,150 @@ describe('Events', () => {
       });
     });
   });
+
+  describe('URL construction and encoding (direct API client tests)', () => {
+    it('should construct URLs with properly encoded query parameters', async () => {
+      // Test the URL construction by creating a URL and manually calling setQueryStrings
+      const baseUrl = new URL('https://api.nylas.com/v3/grants/grant-id/events');
+      const queryParams = {
+        calendarId: '[email protected]',
+        start: '1640995200',
+        end: '1641081600',
+        limit: 50,
+        metadataPair: { 'custom-key': 'custom-value' },
+      };
+
+      // Create a real API client to test actual URL construction
+      const realApiClient = new APIClient({
+        apiKey: 'test-api-key',
+        apiUri: 'https://api.nylas.com',
+        timeout: 30,
+        headers: {},
+      });
+
+      // Access the private method through bracket notation for testing
+      const setQueryStrings = (realApiClient as any).setQueryStrings.bind(realApiClient);
+      const finalUrl = setQueryStrings(baseUrl, queryParams);
+
+      // Verify the actual URL that was constructed
+      const requestUrl = finalUrl.toString();
+      expect(requestUrl).toContain('?'); // Should have proper query separator
+      expect(requestUrl).not.toContain('%3F'); // Should not have encoded question mark
+      expect(requestUrl).toContain('calendar%40example.com'); // Email should be properly encoded
+      expect(requestUrl).toContain('start=1640995200');
+      expect(requestUrl).toContain('end=1641081600');
+      expect(requestUrl).toContain('limit=50');
+      expect(requestUrl).toContain('metadata_pair=custom-key%3Acustom-value'); // metadataPair should be properly formatted
+    });
+
+    it('should handle special characters in query parameters without double encoding', async () => {
+      const baseUrl = new URL('https://api.nylas.com/v3/grants/grant-id/events');
+      const queryParams = {
+        calendarId: '[email protected]',
+        title: 'meeting with ? special chars',
+        metadataPair: { 'key with spaces': 'value with & symbols' },
+      };
+
+      const realApiClient = new APIClient({
+        apiKey: 'test-api-key',
+        apiUri: 'https://api.nylas.com',
+        timeout: 30,
+        headers: {},
+      });
+
+      const setQueryStrings = (realApiClient as any).setQueryStrings.bind(realApiClient);
+      const finalUrl = setQueryStrings(baseUrl, queryParams);
+      const requestUrl = finalUrl.toString();
+      
+      // Verify proper encoding
+      expect(requestUrl).toContain('?'); // Should have proper query separator
+      expect(requestUrl).not.toContain('%3F'); // Should not have encoded question mark
+      expect(requestUrl).toContain('calendar%2Btest%40example.com'); // + and @ should be properly encoded
+      expect(requestUrl).toContain('title=meeting%20with%20%3F%20special%20chars'); // Space and ? should be encoded
+      expect(requestUrl).toContain('metadata_pair=key%20with%20spaces%3Avalue%20with%20%26%20symbols'); // Complex metadata
+    });
+
+    it('should not double-encode already encoded parameters', async () => {
+      const baseUrl = new URL('https://api.nylas.com/v3/grants/grant-id/events');
+      const queryParams = {
+        calendarId: 'calendar%40example.com', // Already URL encoded
+        title: 'meeting%20with%20special%20chars', // Already URL encoded
+      };
+
+      const realApiClient = new APIClient({
+        apiKey: 'test-api-key',
+        apiUri: 'https://api.nylas.com',
+        timeout: 30,
+        headers: {},
+      });
+
+      const setQueryStrings = (realApiClient as any).setQueryStrings.bind(realApiClient);
+      const finalUrl = setQueryStrings(baseUrl, queryParams);
+      const requestUrl = finalUrl.toString();
+      
+      // Verify no double encoding occurred
+      expect(requestUrl).toContain('?'); // Should have proper query separator
+      expect(requestUrl).not.toContain('%3F'); // Should not have encoded question mark
+      expect(requestUrl).toContain('calendar%40example.com'); // Should remain as provided (no double encoding)
+      expect(requestUrl).toContain('title=meeting%20with%20special%20chars'); // Should remain as provided
+    });
+
+    it('should handle array parameters correctly', async () => {
+      const baseUrl = new URL('https://api.nylas.com/v3/grants/grant-id/events');
+      const queryParams = {
+        calendarId: 'primary',
+        attendees: ['[email protected]', '[email protected]'],
+        eventType: ['default' as const, 'outOfOffice' as const],
+      };
+
+      const realApiClient = new APIClient({
+        apiKey: 'test-api-key',
+        apiUri: 'https://api.nylas.com',
+        timeout: 30,
+        headers: {},
+      });
+
+      const setQueryStrings = (realApiClient as any).setQueryStrings.bind(realApiClient);
+      const finalUrl = setQueryStrings(baseUrl, queryParams);
+      const requestUrl = finalUrl.toString();
+      
+      // Verify array parameters are handled correctly
+      expect(requestUrl).toContain('?'); // Should have proper query separator
+      expect(requestUrl).not.toContain('%3F'); // Should not have encoded question mark
+      expect(requestUrl).toContain('attendees=user1%40example.com');
+      expect(requestUrl).toContain('attendees=user2%40example.com');
+      expect(requestUrl).toContain('event_type=default');
+      expect(requestUrl).toContain('event_type=outOfOffice');
+    });
+
+    it('should handle complex metadata pairs correctly', async () => {
+      const baseUrl = new URL('https://api.nylas.com/v3/grants/grant-id/events');
+      const queryParams = {
+        calendarId: 'primary',
+        metadataPair: { 
+          'key with spaces': 'value with & symbols',
+          'another-key': 'another-value',
+          'special-chars': 'value with ? and = signs'
+        },
+      };
+
+      const realApiClient = new APIClient({
+        apiKey: 'test-api-key',
+        apiUri: 'https://api.nylas.com',
+        timeout: 30,
+        headers: {},
+      });
+
+      const setQueryStrings = (realApiClient as any).setQueryStrings.bind(realApiClient);
+      const finalUrl = setQueryStrings(baseUrl, queryParams);
+      const requestUrl = finalUrl.toString();
+      
+      // Verify metadata pairs are handled correctly
+      expect(requestUrl).toContain('?'); // Should have proper query separator
+      expect(requestUrl).not.toContain('%3F'); // Should not have encoded question mark
+      expect(requestUrl).toContain('metadata_pair=key%20with%20spaces%3Avalue%20with%20%26%20symbols');
+      expect(requestUrl).toContain('metadata_pair=another-key%3Aanother-value');
+      expect(requestUrl).toContain('metadata_pair=special-chars%3Avalue%20with%20%3F%20and%20%3D%20signs');
+    });
+  });
 });