firecrawl 4.12.0__py3-none-any.whl

tests/test_api_key_handling.py

@@ -0,0 +1,44 @@
+import sys
+from pathlib import Path
+
+import pytest
+
+ROOT = Path(__file__).resolve().parents[1]
+if str(ROOT) not in sys.path:
+    sys.path.insert(0, str(ROOT))
+
+from firecrawl.v2.client import FirecrawlClient
+from firecrawl.v2.client_async import AsyncFirecrawlClient
+
+
+@pytest.fixture(autouse=True)
+def clear_firecrawl_api_key_env(monkeypatch):
+    monkeypatch.delenv("FIRECRAWL_API_KEY", raising=False)
+    yield
+
+
+def test_cloud_requires_api_key():
+    with pytest.raises(ValueError):
+        FirecrawlClient(api_url="https://api.firecrawl.dev")
+
+
+def test_self_host_allows_missing_api_key():
+    client = FirecrawlClient(api_url="http://localhost:3000")
+    assert client.http_client.api_key is None
+
+
+def test_async_cloud_requires_api_key():
+    with pytest.raises(ValueError):
+        AsyncFirecrawlClient(api_url="https://api.firecrawl.dev")
+
+
+@pytest.mark.asyncio
+async def test_async_self_host_allows_missing_api_key():
+    client = AsyncFirecrawlClient(api_url="http://localhost:3000")
+    try:
+        assert client.http_client.api_key is None
+        await client.async_http_client.close()
+    finally:
+        # Ensure the underlying HTTPX client is closed even if assertions fail
+        if not client.async_http_client._client.is_closed:
+            await client.async_http_client.close()

tests/test_change_tracking.py

@@ -0,0 +1,98 @@
+import unittest
+from unittest.mock import patch, MagicMock
+import json
+import os
+from firecrawl import FirecrawlApp
+
+class TestChangeTracking(unittest.TestCase):
+    @patch('requests.post')
+    def test_change_tracking_format(self, mock_post):
+        mock_response = MagicMock()
+        mock_response.status_code = 200
+        mock_response.json.return_value = {
+            'success': True,
+            'data': {
+                'markdown': 'Test markdown content',
+                'changeTracking': {
+                    'previousScrapeAt': '2023-01-01T00:00:00Z',
+                    'changeStatus': 'changed',
+                    'visibility': 'visible'
+                }
+            }
+        }
+        mock_post.return_value = mock_response
+
+        app = FirecrawlApp(api_key=os.environ.get('TEST_API_KEY', 'dummy-api-key-for-testing'))
+        result = app.scrape_url('https://example.com', {
+            'formats': ['markdown', 'changeTracking']
+        })
+
+        args, kwargs = mock_post.call_args
+        self.assertEqual(kwargs['json']['formats'], ['markdown', 'changeTracking'])
+        
+        self.assertEqual(result['changeTracking']['previousScrapeAt'], '2023-01-01T00:00:00Z')
+        self.assertEqual(result['changeTracking']['changeStatus'], 'changed')
+        self.assertEqual(result['changeTracking']['visibility'], 'visible')
+
+    @patch('requests.post')
+    def test_change_tracking_options(self, mock_post):
+        mock_response = MagicMock()
+        mock_response.status_code = 200
+        mock_response.json.return_value = {
+            'success': True,
+            'data': {
+                'markdown': 'Test markdown content',
+                'changeTracking': {
+                    'previousScrapeAt': '2023-01-01T00:00:00Z',
+                    'changeStatus': 'changed',
+                    'visibility': 'visible',
+                    'diff': {
+                        'text': '@@ -1,1 +1,1 @@\n-old content\n+new content',
+                        'json': {
+                            'files': [{
+                                'from': None,
+                                'to': None,
+                                'chunks': [{
+                                    'content': '@@ -1,1 +1,1 @@',
+                                    'changes': [{
+                                        'type': 'del',
+                                        'content': '-old content',
+                                        'del': True,
+                                        'ln': 1
+                                    }, {
+                                        'type': 'add',
+                                        'content': '+new content',
+                                        'add': True,
+                                        'ln': 1
+                                    }]
+                                }]
+                            }]
+                        }
+                    },
+                    'json': {
+                        'title': {
+                            'previous': 'Old Title',
+                            'current': 'New Title'
+                        }
+                    }
+                }
+            }
+        }
+        mock_post.return_value = mock_response
+
+        app = FirecrawlApp(api_key=os.environ.get('TEST_API_KEY', 'dummy-api-key-for-testing'))
+        result = app.scrape_url('https://example.com', {
+            'formats': ['markdown', 'changeTracking'],
+            'changeTrackingOptions': {
+                'modes': ['git-diff', 'json'],
+                'schema': {'type': 'object', 'properties': {'title': {'type': 'string'}}}
+            }
+        })
+
+        args, kwargs = mock_post.call_args
+        self.assertEqual(kwargs['json']['formats'], ['markdown', 'changeTracking'])
+        self.assertEqual(kwargs['json']['changeTrackingOptions']['modes'], ['git-diff', 'json'])
+        
+        self.assertEqual(result['changeTracking']['diff']['text'], '@@ -1,1 +1,1 @@\n-old content\n+new content')
+        self.assertEqual(result['changeTracking']['json']['title']['previous'], 'Old Title')
+        self.assertEqual(result['changeTracking']['json']['title']['current'], 'New Title')

tests/test_timeout_conversion.py

@@ -0,0 +1,117 @@
+import unittest
+from unittest.mock import patch, MagicMock
+import os
+from firecrawl import FirecrawlApp
+
+
+class TestTimeoutConversion(unittest.TestCase):
+    
+    @patch('requests.post')
+    def test_scrape_url_timeout_conversion(self, mock_post):
+        mock_response = MagicMock()
+        mock_response.status_code = 200
+        mock_response.json.return_value = {
+            'success': True,
+            'data': {
+                'markdown': 'Test content'
+            }
+        }
+        mock_post.return_value = mock_response
+
+        app = FirecrawlApp(api_key=os.environ.get('TEST_API_KEY', 'dummy-api-key-for-testing'))
+        app.scrape_url('https://example.com', timeout=60000)
+
+        args, kwargs = mock_post.call_args
+        self.assertEqual(kwargs['timeout'], 65.0)
+
+    @patch('requests.post')
+    def test_scrape_url_default_timeout(self, mock_post):
+        mock_response = MagicMock()
+        mock_response.status_code = 200
+        mock_response.json.return_value = {
+            'success': True,
+            'data': {
+                'markdown': 'Test content'
+            }
+        }
+        mock_post.return_value = mock_response
+
+        app = FirecrawlApp(api_key=os.environ.get('TEST_API_KEY', 'dummy-api-key-for-testing'))
+        app.scrape_url('https://example.com')
+
+        args, kwargs = mock_post.call_args
+        self.assertEqual(kwargs['timeout'], 35.0)
+
+    @patch('requests.post')
+    def test_post_request_timeout_conversion(self, mock_post):
+        mock_response = MagicMock()
+        mock_response.status_code = 200
+        mock_post.return_value = mock_response
+
+        app = FirecrawlApp(api_key=os.environ.get('TEST_API_KEY', 'dummy-api-key-for-testing'))
+        
+        data = {'timeout': 30000}
+        headers = {'Content-Type': 'application/json'}
+        
+        app._post_request('https://example.com/api', data, headers)
+
+        args, kwargs = mock_post.call_args
+        self.assertEqual(kwargs['timeout'], 35.0)
+
+    @patch('requests.post')
+    def test_post_request_default_timeout(self, mock_post):
+        mock_response = MagicMock()
+        mock_response.status_code = 200
+        mock_post.return_value = mock_response
+
+        app = FirecrawlApp(api_key=os.environ.get('TEST_API_KEY', 'dummy-api-key-for-testing'))
+        
+        data = {'timeout': 30000, 'url': 'https://example.com'}
+        headers = {'Content-Type': 'application/json'}
+        
+        app._post_request('https://example.com/api', data, headers)
+
+        args, kwargs = mock_post.call_args
+        self.assertEqual(kwargs['timeout'], 35.0)
+
+    @patch('requests.post')
+    def test_timeout_edge_cases(self, mock_post):
+        mock_response = MagicMock()
+        mock_response.status_code = 200
+        mock_response.json.return_value = {
+            'success': True,
+            'data': {
+                'markdown': 'Test content'
+            }
+        }
+        mock_post.return_value = mock_response
+
+        app = FirecrawlApp(api_key=os.environ.get('TEST_API_KEY', 'dummy-api-key-for-testing'))
+        
+        app.scrape_url('https://example.com', timeout=1000)
+        args, kwargs = mock_post.call_args
+        self.assertEqual(kwargs['timeout'], 6.0)
+        
+        app.scrape_url('https://example.com', timeout=0)
+        args, kwargs = mock_post.call_args
+        self.assertEqual(kwargs['timeout'], 5.0)
+
+    @patch('requests.post')
+    def test_post_request_no_timeout_key(self, mock_post):
+        mock_response = MagicMock()
+        mock_response.status_code = 200
+        mock_post.return_value = mock_response
+
+        app = FirecrawlApp(api_key=os.environ.get('TEST_API_KEY', 'dummy-api-key-for-testing'))
+        
+        data = {'url': 'https://example.com'}
+        headers = {'Content-Type': 'application/json'}
+        
+        app._post_request('https://example.com/api', data, headers)
+
+        args, kwargs = mock_post.call_args
+        self.assertIsNone(kwargs['timeout'])
+
+
+if __name__ == '__main__':
+    unittest.main()