Nick: fixed prettier

apps/api/.prettierrc

@@ -0,0 +1,3 @@
+{
+    "trailingComma": "none"
+}

apps/api/package.json

@@ -6,7 +6,7 @@
   "scripts": {
     "start": "nodemon --exec ts-node src/index.ts",
     "start:production": "tsc && node dist/src/index.js",
-    "format": "prettier --write \"src/**/*.(js|ts)\"",
+    "format": "npx prettier --write \"src/**/*.(js|ts)\"",
     "flyio": "node dist/src/index.js",
     "start:dev": "nodemon --exec ts-node src/index.ts",
     "build": "tsc && pnpm sentry:sourcemaps",

apps/api/src/__tests__/e2e_extract/index.test.ts

@@ -3,264 +3,305 @@ import dotenv from "dotenv";
 import {
   FirecrawlCrawlResponse,
   FirecrawlCrawlStatusResponse,
-  FirecrawlScrapeResponse,
+  FirecrawlScrapeResponse
 } from "../../types";
 
 dotenv.config();
 const TEST_URL = "http://127.0.0.1:3002";
 
 describe("E2E Tests for Extract API Routes", () => {
-  it.concurrent("should return authors of blog posts on firecrawl.dev", async () => {
+  it.concurrent(
-    const response = await request(TEST_URL)
+    "should return authors of blog posts on firecrawl.dev",
-      .post("/v1/extract")
+    async () => {
-      .set("Authorization", `Bearer ${process.env.TEST_API_KEY}`)
+      const response = await request(TEST_URL)
-      .set("Content-Type", "application/json")
+        .post("/v1/extract")
-      .send({
+        .set("Authorization", `Bearer ${process.env.TEST_API_KEY}`)
-        urls: ["https://firecrawl.dev/*"],
+        .set("Content-Type", "application/json")
-        prompt: "Who are the authors of the blog posts?",
+        .send({
-        schema: {
+          urls: ["https://firecrawl.dev/*"],
-          type: "object",
+          prompt: "Who are the authors of the blog posts?",
-          properties: { authors: { type: "array", items: { type: "string" } } },
+          schema: {
-        },
-      });
-
-    console.log(response.body);
-    expect(response.statusCode).toBe(200);
-    expect(response.body).toHaveProperty("data");
-    expect(response.body.data).toHaveProperty("authors");
-
-    let gotItRight = 0;
-    for (const author of response.body.data?.authors) {
-      if (author.includes("Caleb Peffer")) gotItRight++;
-      if (author.includes("Gergő Móricz")) gotItRight++;
-      if (author.includes("Eric Ciarla")) gotItRight++;
-      if (author.includes("Nicolas Camara")) gotItRight++;
-      if (author.includes("Jon")) gotItRight++;
-      if (author.includes("Wendong")) gotItRight++;
-
-    }
-
-    expect(gotItRight).toBeGreaterThan(1);
-  }, 60000);
-
-  it.concurrent("should return founders of firecrawl.dev (allowExternalLinks = true)", async () => {
-    const response = await request(TEST_URL)
-      .post("/v1/extract")
-      .set("Authorization", `Bearer ${process.env.TEST_API_KEY}`)
-      .set("Content-Type", "application/json")
-      .send({
-        urls: ["firecrawl.dev/*"],
-        prompt: "Who are the founders of the company?",
-        allowExternalLinks: true,
-        schema: {
-          type: "object",
-          properties: { founders: { type: "array", items: { type: "string" } } },
-        },
-      });
-    expect(response.statusCode).toBe(200);
-    expect(response.body).toHaveProperty("data");
-    expect(response.body.data).toHaveProperty("founders");
-
-    console.log(response.body.data?.founders);
-    let gotItRight = 0;
-    for (const founder of response.body.data?.founders) {
-      if (founder.includes("Caleb")) gotItRight++;
-      if (founder.includes("Eric")) gotItRight++;
-      if (founder.includes("Nicolas")) gotItRight++;
-      if (founder.includes("nick")) gotItRight++;
-      if (founder.includes("eric")) gotItRight++;
-      if (founder.includes("jon-noronha")) gotItRight++;
-
-    }
-
-    expect(gotItRight).toBeGreaterThanOrEqual(2);
-  }, 60000);
-
-  it.concurrent("should return hiring opportunities on firecrawl.dev (allowExternalLinks = true)", async () => {
-    const response = await request(TEST_URL)
-      .post("/v1/extract")
-      .set("Authorization", `Bearer ${process.env.TEST_API_KEY}`)
-      .set("Content-Type", "application/json")
-      .send({
-        urls: ["https://firecrawl.dev/*"],
-        prompt: "What are they hiring for?",
-        allowExternalLinks: true,
-        schema: {
-          type: "array",
-          items: {
-            type: "string"
-          },
-          required: ["items"]
-        },
-      });
-    expect(response.statusCode).toBe(200);
-    expect(response.body).toHaveProperty("data");
-    console.log(response.body.data);
-
-    let gotItRight = 0;
-    for (const hiring of response.body.data?.items) {
-      if (hiring.includes("Developer Support Engineer")) gotItRight++;
-      if (hiring.includes("Dev Ops Engineer")) gotItRight++;
-      if (hiring.includes("Founding Web Automation Engineer")) gotItRight++;
-    }
-
-    expect(gotItRight).toBeGreaterThan(2);
-  }, 60000);
-
-  it.concurrent("should return PCI DSS compliance for Fivetran", async () => {
-    const response = await request(TEST_URL)
-      .post("/v1/extract")
-      .set("Authorization", `Bearer ${process.env.TEST_API_KEY}`)
-      .set("Content-Type", "application/json")
-      .send({
-        urls: ["fivetran.com/*"],
-        prompt: "Does Fivetran have PCI DSS compliance?",
-        allowExternalLinks: true,
-        schema: {
-          type: "object",
-          properties: {
-            pciDssCompliance: { type: "boolean" }
-          }
-        },
-      });
-    expect(response.statusCode).toBe(200);
-    expect(response.body).toHaveProperty("data");
-    expect(response.body.data?.pciDssCompliance).toBe(true);
-  }, 60000);
-
-  it.concurrent("should return Azure Data Connectors for Fivetran", async () => {
-    const response = await request(TEST_URL)
-      .post("/v1/extract")
-      .set("Authorization", `Bearer ${process.env.TEST_API_KEY}`)
-      .set("Content-Type", "application/json")
-      .send({
-        urls: ["fivetran.com/*"],
-        prompt: "What are the Azure Data Connectors they offer?",
-        schema: {
-          type: "array",
-          items: {
             type: "object",
             properties: {
-              connector: { type: "string" },
+              authors: { type: "array", items: { type: "string" } }
-              description: { type: "string" },
-              supportsCaptureDelete: { type: "boolean" }
             }
           }
-        }
+        });
-      })
 
-    console.log(response.body);
+      console.log(response.body);
-    // expect(response.statusCode).toBe(200);
+      expect(response.statusCode).toBe(200);
-    // expect(response.body).toHaveProperty("data");
+      expect(response.body).toHaveProperty("data");
-    // expect(response.body.data?.pciDssCompliance).toBe(true);
+      expect(response.body.data).toHaveProperty("authors");
-  }, 60000);
 
-  it.concurrent("should return Greenhouse Applicant Tracking System for Abnormal Security", async () => {
+      let gotItRight = 0;
-    const response = await request(TEST_URL)
+      for (const author of response.body.data?.authors) {
-      .post("/v1/extract")
+        if (author.includes("Caleb Peffer")) gotItRight++;
-      .set("Authorization", `Bearer ${process.env.TEST_API_KEY}`)
+        if (author.includes("Gergő Móricz")) gotItRight++;
-      .set("Content-Type", "application/json")
+        if (author.includes("Eric Ciarla")) gotItRight++;
-      .send({
+        if (author.includes("Nicolas Camara")) gotItRight++;
-        urls: ["https://careers.abnormalsecurity.com/jobs/6119456003?gh_jid=6119456003"],
+        if (author.includes("Jon")) gotItRight++;
-        prompt: "what applicant tracking system is this company using?",
+        if (author.includes("Wendong")) gotItRight++;
-        schema: {
+      }
-          type: "object",
-          properties: {
-            isGreenhouseATS: { type: "boolean" },
-            answer: { type: "string" }
-          }
-        },
-        allowExternalLinks: true
-      })
 
-    console.log(response.body);
+      expect(gotItRight).toBeGreaterThan(1);
-    expect(response.statusCode).toBe(200);
+    },
-    expect(response.body).toHaveProperty("data");
+    60000
-    expect(response.body.data?.isGreenhouseATS).toBe(true);
+  );
-  }, 60000);
 
-  it.concurrent("should return mintlify api components", async () => {
+  it.concurrent(
-    const response = await request(TEST_URL)
+    "should return founders of firecrawl.dev (allowExternalLinks = true)",
-      .post("/v1/extract")
+    async () => {
-      .set("Authorization", `Bearer ${process.env.TEST_API_KEY}`)
+      const response = await request(TEST_URL)
-      .set("Content-Type", "application/json")
+        .post("/v1/extract")
-      .send({
+        .set("Authorization", `Bearer ${process.env.TEST_API_KEY}`)
-        urls: ["https://mintlify.com/docs/*"],
+        .set("Content-Type", "application/json")
-        prompt: "what are the 4 API components?",
+        .send({
-        schema: {
+          urls: ["firecrawl.dev/*"],
-          type: "array",
+          prompt: "Who are the founders of the company?",
-          items: {
+          allowExternalLinks: true,
+          schema: {
             type: "object",
             properties: {
-              component: { type: "string" }
+              founders: { type: "array", items: { type: "string" } }
+            }
+          }
+        });
+      expect(response.statusCode).toBe(200);
+      expect(response.body).toHaveProperty("data");
+      expect(response.body.data).toHaveProperty("founders");
+
+      console.log(response.body.data?.founders);
+      let gotItRight = 0;
+      for (const founder of response.body.data?.founders) {
+        if (founder.includes("Caleb")) gotItRight++;
+        if (founder.includes("Eric")) gotItRight++;
+        if (founder.includes("Nicolas")) gotItRight++;
+        if (founder.includes("nick")) gotItRight++;
+        if (founder.includes("eric")) gotItRight++;
+        if (founder.includes("jon-noronha")) gotItRight++;
+      }
+
+      expect(gotItRight).toBeGreaterThanOrEqual(2);
+    },
+    60000
+  );
+
+  it.concurrent(
+    "should return hiring opportunities on firecrawl.dev (allowExternalLinks = true)",
+    async () => {
+      const response = await request(TEST_URL)
+        .post("/v1/extract")
+        .set("Authorization", `Bearer ${process.env.TEST_API_KEY}`)
+        .set("Content-Type", "application/json")
+        .send({
+          urls: ["https://firecrawl.dev/*"],
+          prompt: "What are they hiring for?",
+          allowExternalLinks: true,
+          schema: {
+            type: "array",
+            items: {
+              type: "string"
+            },
+            required: ["items"]
+          }
+        });
+      expect(response.statusCode).toBe(200);
+      expect(response.body).toHaveProperty("data");
+      console.log(response.body.data);
+
+      let gotItRight = 0;
+      for (const hiring of response.body.data?.items) {
+        if (hiring.includes("Developer Support Engineer")) gotItRight++;
+        if (hiring.includes("Dev Ops Engineer")) gotItRight++;
+        if (hiring.includes("Founding Web Automation Engineer")) gotItRight++;
+      }
+
+      expect(gotItRight).toBeGreaterThan(2);
+    },
+    60000
+  );
+
+  it.concurrent(
+    "should return PCI DSS compliance for Fivetran",
+    async () => {
+      const response = await request(TEST_URL)
+        .post("/v1/extract")
+        .set("Authorization", `Bearer ${process.env.TEST_API_KEY}`)
+        .set("Content-Type", "application/json")
+        .send({
+          urls: ["fivetran.com/*"],
+          prompt: "Does Fivetran have PCI DSS compliance?",
+          allowExternalLinks: true,
+          schema: {
+            type: "object",
+            properties: {
+              pciDssCompliance: { type: "boolean" }
+            }
+          }
+        });
+      expect(response.statusCode).toBe(200);
+      expect(response.body).toHaveProperty("data");
+      expect(response.body.data?.pciDssCompliance).toBe(true);
+    },
+    60000
+  );
+
+  it.concurrent(
+    "should return Azure Data Connectors for Fivetran",
+    async () => {
+      const response = await request(TEST_URL)
+        .post("/v1/extract")
+        .set("Authorization", `Bearer ${process.env.TEST_API_KEY}`)
+        .set("Content-Type", "application/json")
+        .send({
+          urls: ["fivetran.com/*"],
+          prompt: "What are the Azure Data Connectors they offer?",
+          schema: {
+            type: "array",
+            items: {
+              type: "object",
+              properties: {
+                connector: { type: "string" },
+                description: { type: "string" },
+                supportsCaptureDelete: { type: "boolean" }
+              }
+            }
+          }
+        });
+
+      console.log(response.body);
+      // expect(response.statusCode).toBe(200);
+      // expect(response.body).toHaveProperty("data");
+      // expect(response.body.data?.pciDssCompliance).toBe(true);
+    },
+    60000
+  );
+
+  it.concurrent(
+    "should return Greenhouse Applicant Tracking System for Abnormal Security",
+    async () => {
+      const response = await request(TEST_URL)
+        .post("/v1/extract")
+        .set("Authorization", `Bearer ${process.env.TEST_API_KEY}`)
+        .set("Content-Type", "application/json")
+        .send({
+          urls: [
+            "https://careers.abnormalsecurity.com/jobs/6119456003?gh_jid=6119456003"
+          ],
+          prompt: "what applicant tracking system is this company using?",
+          schema: {
+            type: "object",
+            properties: {
+              isGreenhouseATS: { type: "boolean" },
+              answer: { type: "string" }
             }
           },
-          required: ["items"]
+          allowExternalLinks: true
-        },
+        });
-        allowExternalLinks: true
-      })
 
-    console.log(response.body.data?.items);
+      console.log(response.body);
-    expect(response.statusCode).toBe(200);
+      expect(response.statusCode).toBe(200);
-    expect(response.body).toHaveProperty("data");
+      expect(response.body).toHaveProperty("data");
-    expect(response.body.data?.items.length).toBe(4);
+      expect(response.body.data?.isGreenhouseATS).toBe(true);
-    let gotItRight = 0;
+    },
-    for (const component of response.body.data?.items) {
+    60000
-      if (component.component.toLowerCase().includes("parameter")) gotItRight++;
+  );
-      if (component.component.toLowerCase().includes("response")) gotItRight++;
-      if (component.component.toLowerCase().includes("expandable")) gotItRight++;
-      if (component.component.toLowerCase().includes("sticky")) gotItRight++;
-      if (component.component.toLowerCase().includes("examples")) gotItRight++;
 
-    }
+  it.concurrent(
-    expect(gotItRight).toBeGreaterThan(2);
+    "should return mintlify api components",
-  }, 60000);
+    async () => {
-
+      const response = await request(TEST_URL)
-  it.concurrent("should return information about Eric Ciarla", async () => {
+        .post("/v1/extract")
-    const response = await request(TEST_URL)
+        .set("Authorization", `Bearer ${process.env.TEST_API_KEY}`)
-      .post("/v1/extract")
+        .set("Content-Type", "application/json")
-      .set("Authorization", `Bearer ${process.env.TEST_API_KEY}`)
+        .send({
-      .set("Content-Type", "application/json")
+          urls: ["https://mintlify.com/docs/*"],
-      .send({
+          prompt: "what are the 4 API components?",
-        urls: ["https://ericciarla.com/"],
+          schema: {
-        prompt: "Who is Eric Ciarla? Where does he work? Where did he go to school?",
+            type: "array",
-        schema: {
+            items: {
-          type: "object",
+              type: "object",
-          properties: {
+              properties: {
-            name: { type: "string" },
+                component: { type: "string" }
-            work: { type: "string" },
+              }
-            education: { type: "string" }
+            },
+            required: ["items"]
           },
-          required: ["name", "work", "education"]
+          allowExternalLinks: true
-        },
+        });
-        allowExternalLinks: true
-      })
 
-    console.log(response.body.data);
+      console.log(response.body.data?.items);
-    expect(response.statusCode).toBe(200);
+      expect(response.statusCode).toBe(200);
-    expect(response.body).toHaveProperty("data");
+      expect(response.body).toHaveProperty("data");
-    expect(response.body.data?.name).toBe("Eric Ciarla");
+      expect(response.body.data?.items.length).toBe(4);
-    expect(response.body.data?.work).toBeDefined();
+      let gotItRight = 0;
-    expect(response.body.data?.education).toBeDefined();
+      for (const component of response.body.data?.items) {
-  }, 60000);
+        if (component.component.toLowerCase().includes("parameter"))
+          gotItRight++;
+        if (component.component.toLowerCase().includes("response"))
+          gotItRight++;
+        if (component.component.toLowerCase().includes("expandable"))
+          gotItRight++;
+        if (component.component.toLowerCase().includes("sticky")) gotItRight++;
+        if (component.component.toLowerCase().includes("examples"))
+          gotItRight++;
+      }
+      expect(gotItRight).toBeGreaterThan(2);
+    },
+    60000
+  );
 
-  it.concurrent("should extract information without a schema", async () => {
+  it.concurrent(
-    const response = await request(TEST_URL)
+    "should return information about Eric Ciarla",
-      .post("/v1/extract")
+    async () => {
-      .set("Authorization", `Bearer ${process.env.TEST_API_KEY}`)
+      const response = await request(TEST_URL)
-      .set("Content-Type", "application/json")
+        .post("/v1/extract")
-      .send({
+        .set("Authorization", `Bearer ${process.env.TEST_API_KEY}`)
-        urls: ["https://docs.firecrawl.dev"],
+        .set("Content-Type", "application/json")
-        prompt: "What is the title and description of the page?"
+        .send({
-      });
+          urls: ["https://ericciarla.com/"],
+          prompt:
+            "Who is Eric Ciarla? Where does he work? Where did he go to school?",
+          schema: {
+            type: "object",
+            properties: {
+              name: { type: "string" },
+              work: { type: "string" },
+              education: { type: "string" }
+            },
+            required: ["name", "work", "education"]
+          },
+          allowExternalLinks: true
+        });
 
-    console.log(response.body.data);
+      console.log(response.body.data);
-    expect(response.statusCode).toBe(200);
+      expect(response.statusCode).toBe(200);
-    expect(response.body).toHaveProperty("data");
+      expect(response.body).toHaveProperty("data");
-    expect(typeof response.body.data).toBe("object");
+      expect(response.body.data?.name).toBe("Eric Ciarla");
-    expect(Object.keys(response.body.data).length).toBeGreaterThan(0);
+      expect(response.body.data?.work).toBeDefined();
-  }, 60000);
+      expect(response.body.data?.education).toBeDefined();
+    },
+    60000
+  );
 
-  
+  it.concurrent(
+    "should extract information without a schema",
+    async () => {
+      const response = await request(TEST_URL)
+        .post("/v1/extract")
+        .set("Authorization", `Bearer ${process.env.TEST_API_KEY}`)
+        .set("Content-Type", "application/json")
+        .send({
+          urls: ["https://docs.firecrawl.dev"],
+          prompt: "What is the title and description of the page?"
+        });
 
+      console.log(response.body.data);
+      expect(response.statusCode).toBe(200);
+      expect(response.body).toHaveProperty("data");
+      expect(typeof response.body.data).toBe("object");
+      expect(Object.keys(response.body.data).length).toBeGreaterThan(0);
+    },
+    60000
+  );
 });

apps/api/src/__tests__/e2e_map/index.test.ts

@@ -15,7 +15,7 @@ describe("E2E Tests for Map API Routes", () => {
         .send({
           url: "https://firecrawl.dev",
           sitemapOnly: false,
-          search: "smart-crawl",
+          search: "smart-crawl"
         });
 
       console.log(response.body);
@@ -37,7 +37,7 @@ describe("E2E Tests for Map API Routes", () => {
         .send({
           url: "https://firecrawl.dev",
           sitemapOnly: false,
-          includeSubdomains: true,
+          includeSubdomains: true
         });
 
       console.log(response.body);
@@ -60,7 +60,7 @@ describe("E2E Tests for Map API Routes", () => {
         .set("Content-Type", "application/json")
         .send({
           url: "https://firecrawl.dev",
-          sitemapOnly: true,
+          sitemapOnly: true
         });
 
       console.log(response.body);
@@ -84,7 +84,7 @@ describe("E2E Tests for Map API Routes", () => {
         .send({
           url: "https://firecrawl.dev",
           sitemapOnly: false,
-          limit: 10,
+          limit: 10
         });
 
       console.log(response.body);
@@ -104,7 +104,7 @@ describe("E2E Tests for Map API Routes", () => {
         .set("Content-Type", "application/json")
         .send({
           url: "https://geekflare.com/sitemap_index.xml",
-          sitemapOnly: true,
+          sitemapOnly: true
         });
 
       console.log(response.body);

apps/api/src/__tests__/e2e_noAuth/index.test.ts

@@ -32,7 +32,6 @@ describe("E2E Tests for API Routes with No Authentication", () => {
     process.env = originalEnv;
   });
 
-
   describe("GET /", () => {
     it("should return Hello, world! message", async () => {
       const response = await request(TEST_URL).get("/");
@@ -62,7 +61,9 @@ describe("E2E Tests for API Routes with No Authentication", () => {
         .set("Content-Type", "application/json")
         .send({ url: blocklistedUrl });
       expect(response.statusCode).toBe(403);
-      expect(response.body.error).toContain("Firecrawl currently does not support social media scraping due to policy restrictions. We're actively working on building support for it.");
+      expect(response.body.error).toContain(
+        "Firecrawl currently does not support social media scraping due to policy restrictions. We're actively working on building support for it."
+      );
     });
 
     it("should return a successful response", async () => {
@@ -87,7 +88,9 @@ describe("E2E Tests for API Routes with No Authentication", () => {
         .set("Content-Type", "application/json")
         .send({ url: blocklistedUrl });
       expect(response.statusCode).toBe(403);
-      expect(response.body.error).toContain("Firecrawl currently does not support social media scraping due to policy restrictions. We're actively working on building support for it.");
+      expect(response.body.error).toContain(
+        "Firecrawl currently does not support social media scraping due to policy restrictions. We're actively working on building support for it."
+      );
     });
 
     it("should return a successful response", async () => {
@@ -116,7 +119,9 @@ describe("E2E Tests for API Routes with No Authentication", () => {
         .set("Content-Type", "application/json")
         .send({ url: blocklistedUrl });
       expect(response.statusCode).toBe(403);
-      expect(response.body.error).toContain("Firecrawl currently does not support social media scraping due to policy restrictions. We're actively working on building support for it.");
+      expect(response.body.error).toContain(
+        "Firecrawl currently does not support social media scraping due to policy restrictions. We're actively working on building support for it."
+      );
     });
 
     it("should return a successful response", async () => {
@@ -199,8 +204,6 @@ describe("E2E Tests for API Routes with No Authentication", () => {
       expect(completedResponse.body.data[0]).toHaveProperty("content");
       expect(completedResponse.body.data[0]).toHaveProperty("markdown");
       expect(completedResponse.body.data[0]).toHaveProperty("metadata");
-   
-      
     }, 60000); // 60 seconds
   });
 

apps/api/src/__tests__/e2e_v1_withAuth_all_params/index.test.ts

@@ -2,7 +2,7 @@ import request from "supertest";
 import { configDotenv } from "dotenv";
 import {
   ScrapeRequest,
-  ScrapeResponseRequestTest,
+  ScrapeResponseRequestTest
 } from "../../controllers/v1/types";
 
 configDotenv();
@@ -10,31 +10,39 @@ const FIRECRAWL_API_URL = "http://127.0.0.1:3002";
 const E2E_TEST_SERVER_URL = "http://firecrawl-e2e-test.vercel.app"; // @rafaelsideguide/firecrawl-e2e-test
 
 describe("E2E Tests for v1 API Routes", () => {
+  it.concurrent(
+    "should return a successful response for a scrape with 403 page",
+    async () => {
+      const response: ScrapeResponseRequestTest = await request(
+        FIRECRAWL_API_URL
+      )
+        .post("/v1/scrape")
+        .set("Authorization", `Bearer ${process.env.TEST_API_KEY}`)
+        .set("Content-Type", "application/json")
+        .send({ url: "https://httpstat.us/403" });
 
-  it.concurrent('should return a successful response for a scrape with 403 page', async () => {
+      expect(response.statusCode).toBe(200);
-    const response: ScrapeResponseRequestTest = await request(FIRECRAWL_API_URL)
+      expect(response.body).toHaveProperty("data");
-      .post('/v1/scrape')
+      if (!("data" in response.body)) {
-      .set('Authorization', `Bearer ${process.env.TEST_API_KEY}`)
+        throw new Error("Expected response body to have 'data' property");
-      .set('Content-Type', 'application/json')
+      }
-      .send({ url: 'https://httpstat.us/403' });
+      expect(response.body.data).toHaveProperty("markdown");
+      expect(response.body.data).toHaveProperty("metadata");
+      expect(response.body.data.metadata.statusCode).toBe(403);
+    },
+    30000
+  );
 
-    expect(response.statusCode).toBe(200);
+  it.concurrent(
-    expect(response.body).toHaveProperty('data');
+    "should handle 'formats:markdown (default)' parameter correctly",
-    if (!("data" in response.body)) {
-      throw new Error("Expected response body to have 'data' property");
-    }
-    expect(response.body.data).toHaveProperty('markdown');
-    expect(response.body.data).toHaveProperty('metadata');
-    expect(response.body.data.metadata.statusCode).toBe(403);
-  }, 30000);
-
-  it.concurrent("should handle 'formats:markdown (default)' parameter correctly",
     async () => {
       const scrapeRequest = {
         url: E2E_TEST_SERVER_URL
       } as ScrapeRequest;
 
-      const response: ScrapeResponseRequestTest = await request(FIRECRAWL_API_URL)
+      const response: ScrapeResponseRequestTest = await request(
+        FIRECRAWL_API_URL
+      )
         .post("/v1/scrape")
         .set("Authorization", `Bearer ${process.env.TEST_API_KEY}`)
         .set("Content-Type", "application/json")
@@ -47,27 +55,41 @@ describe("E2E Tests for v1 API Routes", () => {
       }
 
       expect(response.body.data).toHaveProperty("markdown");
-      
+
-      expect(response.body.data.markdown).toContain("This page is used for end-to-end (e2e) testing with Firecrawl.");
+      expect(response.body.data.markdown).toContain(
-      expect(response.body.data.markdown).toContain("Content with id #content-1");
+        "This page is used for end-to-end (e2e) testing with Firecrawl."
+      );
+      expect(response.body.data.markdown).toContain(
+        "Content with id #content-1"
+      );
       // expect(response.body.data.markdown).toContain("Loading...");
       expect(response.body.data.markdown).toContain("Click me!");
-      expect(response.body.data.markdown).toContain("Power your AI apps with clean data crawled from any website. It's also open-source."); // firecrawl.dev inside an iframe
+      expect(response.body.data.markdown).toContain(
-      expect(response.body.data.markdown).toContain("This content loads only when you see it. Don't blink! 👼"); // the browser always scroll to the bottom
+        "Power your AI apps with clean data crawled from any website. It's also open-source."
+      ); // firecrawl.dev inside an iframe
+      expect(response.body.data.markdown).toContain(
+        "This content loads only when you see it. Don't blink! 👼"
+      ); // the browser always scroll to the bottom
       expect(response.body.data.markdown).not.toContain("Header"); // Only main content is returned by default
       expect(response.body.data.markdown).not.toContain("footer"); // Only main content is returned by default
-      expect(response.body.data.markdown).not.toContain("This content is only visible on mobile");
+      expect(response.body.data.markdown).not.toContain(
+        "This content is only visible on mobile"
+      );
     },
-  30000);
+    30000
+  );
 
-  it.concurrent("should handle 'formats:html' parameter correctly",
+  it.concurrent(
+    "should handle 'formats:html' parameter correctly",
     async () => {
       const scrapeRequest = {
         url: E2E_TEST_SERVER_URL,
         formats: ["html"]
       } as ScrapeRequest;
 
-      const response: ScrapeResponseRequestTest = await request(FIRECRAWL_API_URL)
+      const response: ScrapeResponseRequestTest = await request(
+        FIRECRAWL_API_URL
+      )
         .post("/v1/scrape")
         .set("Authorization", `Bearer ${process.env.TEST_API_KEY}`)
         .set("Content-Type", "application/json")
@@ -79,23 +101,30 @@ describe("E2E Tests for v1 API Routes", () => {
         throw new Error("Expected response body to have 'data' property");
       }
 
-
       expect(response.body.data).not.toHaveProperty("markdown");
       expect(response.body.data).toHaveProperty("html");
 
-      expect(response.body.data.html).not.toContain("<header class=\"row-start-1\" style=\"\">Header</header>");
+      expect(response.body.data.html).not.toContain(
-      expect(response.body.data.html).toContain("<p style=\"\">This page is used for end-to-end (e2e) testing with Firecrawl.</p>");
+        '<header class="row-start-1" style="">Header</header>'
+      );
+      expect(response.body.data.html).toContain(
+        '<p style="">This page is used for end-to-end (e2e) testing with Firecrawl.</p>'
+      );
     },
-  30000);
+    30000
+  );
 
-  it.concurrent("should handle 'rawHtml' in 'formats' parameter correctly",
+  it.concurrent(
+    "should handle 'rawHtml' in 'formats' parameter correctly",
     async () => {
       const scrapeRequest = {
         url: E2E_TEST_SERVER_URL,
         formats: ["rawHtml"]
       } as ScrapeRequest;
 
-      const response: ScrapeResponseRequestTest = await request(FIRECRAWL_API_URL)
+      const response: ScrapeResponseRequestTest = await request(
+        FIRECRAWL_API_URL
+      )
         .post("/v1/scrape")
         .set("Authorization", `Bearer ${process.env.TEST_API_KEY}`)
         .set("Content-Type", "application/json")
@@ -110,45 +139,30 @@ describe("E2E Tests for v1 API Routes", () => {
       expect(response.body.data).not.toHaveProperty("markdown");
       expect(response.body.data).toHaveProperty("rawHtml");
 
-      expect(response.body.data.rawHtml).toContain(">This page is used for end-to-end (e2e) testing with Firecrawl.</p>");
+      expect(response.body.data.rawHtml).toContain(
+        ">This page is used for end-to-end (e2e) testing with Firecrawl.</p>"
+      );
       expect(response.body.data.rawHtml).toContain(">Header</header>");
     },
-  30000);
+    30000
-  
+  );
+
   // - TODO: tests for links
   // - TODO: tests for screenshot
   // - TODO: tests for screenshot@fullPage
 
-  it.concurrent("should handle 'headers' parameter correctly", async () => {
+  it.concurrent(
-    // @ts-ignore
+    "should handle 'headers' parameter correctly",
-    const scrapeRequest = {
-      url: E2E_TEST_SERVER_URL,
-      headers: { "e2e-header-test": "firecrawl" }
-    } as ScrapeRequest;
-
-    const response: ScrapeResponseRequestTest = await request(FIRECRAWL_API_URL)
-      .post("/v1/scrape")
-      .set("Authorization", `Bearer ${process.env.TEST_API_KEY}`)
-      .set("Content-Type", "application/json")
-      .send(scrapeRequest);
-
-    expect(response.statusCode).toBe(200);
-    expect(response.body).toHaveProperty("data");
-    if (!("data" in response.body)) {
-      throw new Error("Expected response body to have 'data' property");
-    }
-
-    expect(response.body.data.markdown).toContain("e2e-header-test: firecrawl");
-  }, 30000);
-  
-  it.concurrent("should handle 'includeTags' parameter correctly",
     async () => {
+      // @ts-ignore
       const scrapeRequest = {
         url: E2E_TEST_SERVER_URL,
-        includeTags: ['#content-1']
+        headers: { "e2e-header-test": "firecrawl" }
       } as ScrapeRequest;
 
-      const response: ScrapeResponseRequestTest = await request(FIRECRAWL_API_URL)
+      const response: ScrapeResponseRequestTest = await request(
+        FIRECRAWL_API_URL
+      )
         .post("/v1/scrape")
         .set("Authorization", `Bearer ${process.env.TEST_API_KEY}`)
         .set("Content-Type", "application/json")
@@ -160,73 +174,126 @@ describe("E2E Tests for v1 API Routes", () => {
         throw new Error("Expected response body to have 'data' property");
       }
 
-      expect(response.body.data.markdown).not.toContain("<p>This page is used for end-to-end (e2e) testing with Firecrawl.</p>");
+      expect(response.body.data.markdown).toContain(
-      expect(response.body.data.markdown).toContain("Content with id #content-1");
+        "e2e-header-test: firecrawl"
+      );
     },
-  30000);
+    30000
-  
+  );
-  it.concurrent("should handle 'excludeTags' parameter correctly",
+
+  it.concurrent(
+    "should handle 'includeTags' parameter correctly",
     async () => {
       const scrapeRequest = {
         url: E2E_TEST_SERVER_URL,
-        excludeTags: ['#content-1']
+        includeTags: ["#content-1"]
       } as ScrapeRequest;
-  
+
-      const response: ScrapeResponseRequestTest = await request(FIRECRAWL_API_URL)
+      const response: ScrapeResponseRequestTest = await request(
+        FIRECRAWL_API_URL
+      )
         .post("/v1/scrape")
         .set("Authorization", `Bearer ${process.env.TEST_API_KEY}`)
         .set("Content-Type", "application/json")
         .send(scrapeRequest);
-  
+
       expect(response.statusCode).toBe(200);
       expect(response.body).toHaveProperty("data");
       if (!("data" in response.body)) {
         throw new Error("Expected response body to have 'data' property");
       }
 
-      expect(response.body.data.markdown).toContain("This page is used for end-to-end (e2e) testing with Firecrawl.");
+      expect(response.body.data.markdown).not.toContain(
-      expect(response.body.data.markdown).not.toContain("Content with id #content-1");
+        "<p>This page is used for end-to-end (e2e) testing with Firecrawl.</p>"
+      );
+      expect(response.body.data.markdown).toContain(
+        "Content with id #content-1"
+      );
     },
-  30000);
+    30000
-  
+  );
-  it.concurrent("should handle 'onlyMainContent' parameter correctly",
+
+  it.concurrent(
+    "should handle 'excludeTags' parameter correctly",
+    async () => {
+      const scrapeRequest = {
+        url: E2E_TEST_SERVER_URL,
+        excludeTags: ["#content-1"]
+      } as ScrapeRequest;
+
+      const response: ScrapeResponseRequestTest = await request(
+        FIRECRAWL_API_URL
+      )
+        .post("/v1/scrape")
+        .set("Authorization", `Bearer ${process.env.TEST_API_KEY}`)
+        .set("Content-Type", "application/json")
+        .send(scrapeRequest);
+
+      expect(response.statusCode).toBe(200);
+      expect(response.body).toHaveProperty("data");
+      if (!("data" in response.body)) {
+        throw new Error("Expected response body to have 'data' property");
+      }
+
+      expect(response.body.data.markdown).toContain(
+        "This page is used for end-to-end (e2e) testing with Firecrawl."
+      );
+      expect(response.body.data.markdown).not.toContain(
+        "Content with id #content-1"
+      );
+    },
+    30000
+  );
+
+  it.concurrent(
+    "should handle 'onlyMainContent' parameter correctly",
     async () => {
       const scrapeRequest = {
         url: E2E_TEST_SERVER_URL,
         formats: ["html", "markdown"],
         onlyMainContent: false
       } as ScrapeRequest;
-  
+
-      const response: ScrapeResponseRequestTest = await request(FIRECRAWL_API_URL)
+      const response: ScrapeResponseRequestTest = await request(
+        FIRECRAWL_API_URL
+      )
         .post("/v1/scrape")
         .set("Authorization", `Bearer ${process.env.TEST_API_KEY}`)
         .set("Content-Type", "application/json")
         .send(scrapeRequest);
-  
+
       expect(response.statusCode).toBe(200);
       expect(response.body).toHaveProperty("data");
       if (!("data" in response.body)) {
         throw new Error("Expected response body to have 'data' property");
       }
-      
+
-      expect(response.body.data.markdown).toContain("This page is used for end-to-end (e2e) testing with Firecrawl.");
+      expect(response.body.data.markdown).toContain(
-      expect(response.body.data.html).toContain("<header class=\"row-start-1\" style=\"\">Header</header>");
+        "This page is used for end-to-end (e2e) testing with Firecrawl."
+      );
+      expect(response.body.data.html).toContain(
+        '<header class="row-start-1" style="">Header</header>'
+      );
     },
-  30000);
+    30000
-  
+  );
-  it.concurrent("should handle 'timeout' parameter correctly",
+
+  it.concurrent(
+    "should handle 'timeout' parameter correctly",
     async () => {
       const scrapeRequest = {
         url: E2E_TEST_SERVER_URL,
         timeout: 500
       } as ScrapeRequest;
-  
+
-      const response: ScrapeResponseRequestTest = await request(FIRECRAWL_API_URL)
+      const response: ScrapeResponseRequestTest = await request(
+        FIRECRAWL_API_URL
+      )
         .post("/v1/scrape")
         .set("Authorization", `Bearer ${process.env.TEST_API_KEY}`)
         .set("Content-Type", "application/json")
         .send(scrapeRequest);
-  
+
       expect(response.statusCode).toBe(408);
 
       if (!("error" in response.body)) {
@@ -234,65 +301,87 @@ describe("E2E Tests for v1 API Routes", () => {
       }
       expect(response.body.error).toBe("Request timed out");
       expect(response.body.success).toBe(false);
-    }, 30000);
+    },
+    30000
+  );
 
-  
+  it.concurrent(
-  it.concurrent("should handle 'mobile' parameter correctly",
+    "should handle 'mobile' parameter correctly",
     async () => {
       const scrapeRequest = {
         url: E2E_TEST_SERVER_URL,
         mobile: true
       } as ScrapeRequest;
-  
+
-      const response: ScrapeResponseRequestTest = await request(FIRECRAWL_API_URL)
+      const response: ScrapeResponseRequestTest = await request(
+        FIRECRAWL_API_URL
+      )
         .post("/v1/scrape")
         .set("Authorization", `Bearer ${process.env.TEST_API_KEY}`)
         .set("Content-Type", "application/json")
         .send(scrapeRequest);
-  
+
       expect(response.statusCode).toBe(200);
 
       if (!("data" in response.body)) {
         throw new Error("Expected response body to have 'data' property");
       }
-      expect(response.body.data.markdown).toContain("This content is only visible on mobile");
+      expect(response.body.data.markdown).toContain(
+        "This content is only visible on mobile"
+      );
     },
-  30000);
+    30000
-  
+  );
-  it.concurrent("should handle 'parsePDF' parameter correctly",
+
-    async () => {  
+  it.concurrent(
-      const response: ScrapeResponseRequestTest = await request(FIRECRAWL_API_URL)
+    "should handle 'parsePDF' parameter correctly",
+    async () => {
+      const response: ScrapeResponseRequestTest = await request(
+        FIRECRAWL_API_URL
+      )
         .post("/v1/scrape")
         .set("Authorization", `Bearer ${process.env.TEST_API_KEY}`)
         .set("Content-Type", "application/json")
-        .send({ url: 'https://arxiv.org/pdf/astro-ph/9301001.pdf'});
+        .send({ url: "https://arxiv.org/pdf/astro-ph/9301001.pdf" });
       await new Promise((r) => setTimeout(r, 6000));
 
       expect(response.statusCode).toBe(200);
-      expect(response.body).toHaveProperty('data');
+      expect(response.body).toHaveProperty("data");
       if (!("data" in response.body)) {
         throw new Error("Expected response body to have 'data' property");
       }
 
-      expect(response.body.data.markdown).toContain('arXiv:astro-ph/9301001v1 7 Jan 1993');
+      expect(response.body.data.markdown).toContain(
-      expect(response.body.data.markdown).not.toContain('h7uKu14adDL6yGfnGf2qycY5uq8kC3OKCWkPxm');
+        "arXiv:astro-ph/9301001v1 7 Jan 1993"
+      );
+      expect(response.body.data.markdown).not.toContain(
+        "h7uKu14adDL6yGfnGf2qycY5uq8kC3OKCWkPxm"
+      );
 
-      const responseNoParsePDF: ScrapeResponseRequestTest = await request(FIRECRAWL_API_URL)
+      const responseNoParsePDF: ScrapeResponseRequestTest = await request(
+        FIRECRAWL_API_URL
+      )
         .post("/v1/scrape")
         .set("Authorization", `Bearer ${process.env.TEST_API_KEY}`)
         .set("Content-Type", "application/json")
-        .send({ url: 'https://arxiv.org/pdf/astro-ph/9301001.pdf', parsePDF: false });
+        .send({
+          url: "https://arxiv.org/pdf/astro-ph/9301001.pdf",
+          parsePDF: false
+        });
       await new Promise((r) => setTimeout(r, 6000));
 
       expect(responseNoParsePDF.statusCode).toBe(200);
-      expect(responseNoParsePDF.body).toHaveProperty('data');
+      expect(responseNoParsePDF.body).toHaveProperty("data");
       if (!("data" in responseNoParsePDF.body)) {
         throw new Error("Expected response body to have 'data' property");
       }
-      expect(responseNoParsePDF.body.data.markdown).toContain('h7uKu14adDL6yGfnGf2qycY5uq8kC3OKCWkPxm');
+      expect(responseNoParsePDF.body.data.markdown).toContain(
+        "h7uKu14adDL6yGfnGf2qycY5uq8kC3OKCWkPxm"
+      );
     },
-  30000);
+    30000
-  
+  );
+
   // it.concurrent("should handle 'location' parameter correctly",
   //   async () => {
   //     const scrapeRequest: ScrapeRequest = {
@@ -302,76 +391,85 @@ describe("E2E Tests for v1 API Routes", () => {
   //         languages: ["en"]
   //       }
   //     };
-  
+
   //     const response: ScrapeResponseRequestTest = await request(FIRECRAWL_API_URL)
   //       .post("/v1/scrape")
   //       .set("Authorization", `Bearer ${process.env.TEST_API_KEY}`)
   //       .set("Content-Type", "application/json")
   //       .send(scrapeRequest);
-  
+
   //     expect(response.statusCode).toBe(200);
   //     // Add assertions to verify location is handled correctly
   //   },
   // 30000);
-  
+
-  it.concurrent("should handle 'skipTlsVerification' parameter correctly",
+  it.concurrent(
+    "should handle 'skipTlsVerification' parameter correctly",
     async () => {
       const scrapeRequest = {
         url: "https://expired.badssl.com/",
         timeout: 120000
       } as ScrapeRequest;
-  
+
-      const response: ScrapeResponseRequestTest = await request(FIRECRAWL_API_URL)
+      const response: ScrapeResponseRequestTest = await request(
+        FIRECRAWL_API_URL
+      )
         .post("/v1/scrape")
         .set("Authorization", `Bearer ${process.env.TEST_API_KEY}`)
         .set("Content-Type", "application/json")
         .send(scrapeRequest);
-        console.log("Error1a")
+      console.log("Error1a");
-        // console.log(response.body)
+      // console.log(response.body)
       expect(response.statusCode).toBe(200);
       if (!("data" in response.body)) {
         throw new Error("Expected response body to have 'data' property");
       }
       expect(response.body.data.metadata.pageStatusCode).toBe(500);
-      console.log("Error?")
+      console.log("Error?");
-      
+
       const scrapeRequestWithSkipTlsVerification = {
         url: "https://expired.badssl.com/",
         skipTlsVerification: true,
         timeout: 120000
-
       } as ScrapeRequest;
-  
+
-      const responseWithSkipTlsVerification: ScrapeResponseRequestTest = await request(FIRECRAWL_API_URL)
+      const responseWithSkipTlsVerification: ScrapeResponseRequestTest =
-        .post("/v1/scrape")
+        await request(FIRECRAWL_API_URL)
-        .set("Authorization", `Bearer ${process.env.TEST_API_KEY}`)
+          .post("/v1/scrape")
-        .set("Content-Type", "application/json")
+          .set("Authorization", `Bearer ${process.env.TEST_API_KEY}`)
-        .send(scrapeRequestWithSkipTlsVerification);
+          .set("Content-Type", "application/json")
-  
+          .send(scrapeRequestWithSkipTlsVerification);
-      console.log("Error1b")
+
+      console.log("Error1b");
       // console.log(responseWithSkipTlsVerification.body)
       expect(responseWithSkipTlsVerification.statusCode).toBe(200);
       if (!("data" in responseWithSkipTlsVerification.body)) {
         throw new Error("Expected response body to have 'data' property");
       }
       // console.log(responseWithSkipTlsVerification.body.data)
-      expect(responseWithSkipTlsVerification.body.data.markdown).toContain("badssl.com");
+      expect(responseWithSkipTlsVerification.body.data.markdown).toContain(
+        "badssl.com"
+      );
     },
-  60000);
+    60000
-  
+  );
-  it.concurrent("should handle 'removeBase64Images' parameter correctly",
+
+  it.concurrent(
+    "should handle 'removeBase64Images' parameter correctly",
     async () => {
       const scrapeRequest = {
         url: E2E_TEST_SERVER_URL,
         removeBase64Images: true
       } as ScrapeRequest;
-  
+
-      const response: ScrapeResponseRequestTest = await request(FIRECRAWL_API_URL)
+      const response: ScrapeResponseRequestTest = await request(
+        FIRECRAWL_API_URL
+      )
         .post("/v1/scrape")
         .set("Authorization", `Bearer ${process.env.TEST_API_KEY}`)
         .set("Content-Type", "application/json")
         .send(scrapeRequest);
-  
+
       expect(response.statusCode).toBe(200);
       if (!("data" in response.body)) {
         throw new Error("Expected response body to have 'data' property");
@@ -380,49 +478,63 @@ describe("E2E Tests for v1 API Routes", () => {
       // - TODO: not working for every image
       // expect(response.body.data.markdown).toContain("Image-Removed");
     },
-  30000);
+    30000
+  );
 
-  it.concurrent("should handle 'action wait' parameter correctly",
+  it.concurrent(
+    "should handle 'action wait' parameter correctly",
     async () => {
       const scrapeRequest = {
         url: E2E_TEST_SERVER_URL,
-        actions: [{
+        actions: [
-          type: "wait",
+          {
-          milliseconds: 10000
+            type: "wait",
-        }]
+            milliseconds: 10000
+          }
+        ]
       } as ScrapeRequest;
-  
+
-      const response: ScrapeResponseRequestTest = await request(FIRECRAWL_API_URL)
+      const response: ScrapeResponseRequestTest = await request(
+        FIRECRAWL_API_URL
+      )
         .post("/v1/scrape")
         .set("Authorization", `Bearer ${process.env.TEST_API_KEY}`)
         .set("Content-Type", "application/json")
         .send(scrapeRequest);
-  
+
       expect(response.statusCode).toBe(200);
       if (!("data" in response.body)) {
         throw new Error("Expected response body to have 'data' property");
       }
       expect(response.body.data.markdown).not.toContain("Loading...");
-      expect(response.body.data.markdown).toContain("Content loaded after 5 seconds!");
+      expect(response.body.data.markdown).toContain(
+        "Content loaded after 5 seconds!"
+      );
     },
-  30000);
+    30000
+  );
 
   // screenshot
-  it.concurrent("should handle 'action screenshot' parameter correctly",
+  it.concurrent(
+    "should handle 'action screenshot' parameter correctly",
     async () => {
       const scrapeRequest = {
         url: E2E_TEST_SERVER_URL,
-        actions: [{
+        actions: [
-          type: "screenshot"
+          {
-        }]
+            type: "screenshot"
+          }
+        ]
       } as ScrapeRequest;
-  
+
-      const response: ScrapeResponseRequestTest = await request(FIRECRAWL_API_URL)
+      const response: ScrapeResponseRequestTest = await request(
+        FIRECRAWL_API_URL
+      )
         .post("/v1/scrape")
         .set("Authorization", `Bearer ${process.env.TEST_API_KEY}`)
         .set("Content-Type", "application/json")
         .send(scrapeRequest);
-  
+
       expect(response.statusCode).toBe(200);
       if (!("data" in response.body)) {
         throw new Error("Expected response body to have 'data' property");
@@ -430,32 +542,42 @@ describe("E2E Tests for v1 API Routes", () => {
       if (!response.body.data.actions?.screenshots) {
         throw new Error("Expected response body to have screenshots array");
       }
-      expect(response.body.data.actions.screenshots[0].length).toBeGreaterThan(0);
+      expect(response.body.data.actions.screenshots[0].length).toBeGreaterThan(
-      expect(response.body.data.actions.screenshots[0]).toContain("https://service.firecrawl.dev/storage/v1/object/public/media/screenshot-");
+        0
+      );
+      expect(response.body.data.actions.screenshots[0]).toContain(
+        "https://service.firecrawl.dev/storage/v1/object/public/media/screenshot-"
+      );
 
       // TODO compare screenshot with expected screenshot
     },
-  30000);
+    30000
+  );
 
-  it.concurrent("should handle 'action screenshot@fullPage' parameter correctly",
+  it.concurrent(
+    "should handle 'action screenshot@fullPage' parameter correctly",
     async () => {
       const scrapeRequest = {
         url: E2E_TEST_SERVER_URL,
-        actions: [{
+        actions: [
-          type: "screenshot",
+          {
-          fullPage: true
+            type: "screenshot",
-        },
+            fullPage: true
-      {
+          },
-        type:"scrape"
+          {
-      }]
+            type: "scrape"
+          }
+        ]
       } as ScrapeRequest;
-  
+
-      const response: ScrapeResponseRequestTest = await request(FIRECRAWL_API_URL)
+      const response: ScrapeResponseRequestTest = await request(
+        FIRECRAWL_API_URL
+      )
         .post("/v1/scrape")
         .set("Authorization", `Bearer ${process.env.TEST_API_KEY}`)
         .set("Content-Type", "application/json")
         .send(scrapeRequest);
-  
+
       expect(response.statusCode).toBe(200);
       if (!("data" in response.body)) {
         throw new Error("Expected response body to have 'data' property");
@@ -464,77 +586,101 @@ describe("E2E Tests for v1 API Routes", () => {
       if (!response.body.data.actions?.screenshots) {
         throw new Error("Expected response body to have screenshots array");
       }
-      expect(response.body.data.actions.screenshots[0].length).toBeGreaterThan(0);
+      expect(response.body.data.actions.screenshots[0].length).toBeGreaterThan(
-      expect(response.body.data.actions.screenshots[0]).toContain("https://service.firecrawl.dev/storage/v1/object/public/media/screenshot-");
+        0
+      );
+      expect(response.body.data.actions.screenshots[0]).toContain(
+        "https://service.firecrawl.dev/storage/v1/object/public/media/screenshot-"
+      );
 
       if (!response.body.data.actions?.scrapes) {
-        throw new Error("Expected response body to have scrapes array"); 
+        throw new Error("Expected response body to have scrapes array");
       }
-      expect(response.body.data.actions.scrapes[0].url).toBe("https://firecrawl-e2e-test.vercel.app/");
+      expect(response.body.data.actions.scrapes[0].url).toBe(
-      expect(response.body.data.actions.scrapes[0].html).toContain("This page is used for end-to-end (e2e) testing with Firecrawl.</p>");
+        "https://firecrawl-e2e-test.vercel.app/"
+      );
+      expect(response.body.data.actions.scrapes[0].html).toContain(
+        "This page is used for end-to-end (e2e) testing with Firecrawl.</p>"
+      );
       // TODO compare screenshot with expected full page screenshot
     },
-  30000);
+    30000
+  );
 
-  it.concurrent("should handle 'action click' parameter correctly",
+  it.concurrent(
+    "should handle 'action click' parameter correctly",
     async () => {
       const scrapeRequest = {
         url: E2E_TEST_SERVER_URL,
-        actions: [{
+        actions: [
-          type: "click",
+          {
-          selector: "#click-me"
+            type: "click",
-        }]
+            selector: "#click-me"
+          }
+        ]
       } as ScrapeRequest;
-  
+
-      const response: ScrapeResponseRequestTest = await request(FIRECRAWL_API_URL)
+      const response: ScrapeResponseRequestTest = await request(
+        FIRECRAWL_API_URL
+      )
         .post("/v1/scrape")
         .set("Authorization", `Bearer ${process.env.TEST_API_KEY}`)
         .set("Content-Type", "application/json")
         .send(scrapeRequest);
-  
+
       expect(response.statusCode).toBe(200);
       if (!("data" in response.body)) {
         throw new Error("Expected response body to have 'data' property");
       }
       expect(response.body.data.markdown).not.toContain("Click me!");
-      expect(response.body.data.markdown).toContain("Text changed after click!");
+      expect(response.body.data.markdown).toContain(
+        "Text changed after click!"
+      );
     },
-  30000);
+    30000
+  );
 
-  it.concurrent("should handle 'action write' parameter correctly",
+  it.concurrent(
+    "should handle 'action write' parameter correctly",
     async () => {
       const scrapeRequest = {
         url: E2E_TEST_SERVER_URL,
         formats: ["html"],
-        actions: [{
+        actions: [
-          type: "click",
+          {
-          selector: "#input-1"
+            type: "click",
-        },
+            selector: "#input-1"
-        {
+          },
-          type: "write",
+          {
-          text: "Hello, world!"
+            type: "write",
-        }
+            text: "Hello, world!"
-      ]} as ScrapeRequest;
+          }
-  
+        ]
-      const response: ScrapeResponseRequestTest = await request(FIRECRAWL_API_URL)
+      } as ScrapeRequest;
+
+      const response: ScrapeResponseRequestTest = await request(
+        FIRECRAWL_API_URL
+      )
         .post("/v1/scrape")
         .set("Authorization", `Bearer ${process.env.TEST_API_KEY}`)
         .set("Content-Type", "application/json")
         .send(scrapeRequest);
-  
+
       expect(response.statusCode).toBe(200);
       if (!("data" in response.body)) {
         throw new Error("Expected response body to have 'data' property");
       }
-      
+
       // TODO: fix this test (need to fix fire-engine first)
       // uncomment the following line:
       // expect(response.body.data.html).toContain("<input id=\"input-1\" type=\"text\" placeholder=\"Enter text here...\" style=\"padding:8px;margin:10px;border:1px solid #ccc;border-radius:4px;background-color:#000\" value=\"Hello, world!\">");
     },
-  30000);
+    30000
+  );
 
   // TODO: fix this test (need to fix fire-engine first)
-  it.concurrent("should handle 'action pressKey' parameter correctly",
+  it.concurrent(
+    "should handle 'action pressKey' parameter correctly",
     async () => {
       const scrapeRequest = {
         url: E2E_TEST_SERVER_URL,
@@ -546,13 +692,15 @@ describe("E2E Tests for v1 API Routes", () => {
           }
         ]
       } as ScrapeRequest;
-  
+
-      const response: ScrapeResponseRequestTest = await request(FIRECRAWL_API_URL)
+      const response: ScrapeResponseRequestTest = await request(
+        FIRECRAWL_API_URL
+      )
         .post("/v1/scrape")
         .set("Authorization", `Bearer ${process.env.TEST_API_KEY}`)
         .set("Content-Type", "application/json")
         .send(scrapeRequest);
-  
+
       // // TODO: fix this test (need to fix fire-engine first)
       // // right now response.body is: { success: false, error: '(Internal server error) - null' }
       // expect(response.statusCode).toBe(200);
@@ -561,10 +709,12 @@ describe("E2E Tests for v1 API Routes", () => {
       // }
       // expect(response.body.data.markdown).toContain("Last Key Clicked: ArrowDown")
     },
-  30000);
+    30000
+  );
 
   // TODO: fix this test (need to fix fire-engine first)
-  it.concurrent("should handle 'action scroll' parameter correctly",
+  it.concurrent(
+    "should handle 'action scroll' parameter correctly",
     async () => {
       const scrapeRequest = {
         url: E2E_TEST_SERVER_URL,
@@ -581,23 +731,25 @@ describe("E2E Tests for v1 API Routes", () => {
           }
         ]
       } as ScrapeRequest;
-  
+
-      const response: ScrapeResponseRequestTest = await request(FIRECRAWL_API_URL)
+      const response: ScrapeResponseRequestTest = await request(
+        FIRECRAWL_API_URL
+      )
         .post("/v1/scrape")
         .set("Authorization", `Bearer ${process.env.TEST_API_KEY}`)
         .set("Content-Type", "application/json")
         .send(scrapeRequest);
-  
+
       // TODO: uncomment this tests
       // expect(response.statusCode).toBe(200);
       // if (!("data" in response.body)) {
       //   throw new Error("Expected response body to have 'data' property");
       // }
-      // 
+      //
       // expect(response.body.data.markdown).toContain("You have reached the bottom!")
     },
-  30000);
+    30000
+  );
 
   // TODO: test scrape action
-
+});
-});

apps/api/src/__tests__/e2e_withAuth/index.test.ts

@@ -3,7 +3,7 @@ import dotenv from "dotenv";
 import {
   FirecrawlCrawlResponse,
   FirecrawlCrawlStatusResponse,
-  FirecrawlScrapeResponse,
+  FirecrawlScrapeResponse
 } from "../../types";
 
 dotenv.config();
@@ -28,9 +28,8 @@ describe("E2E Tests for v0 API Routes", () => {
 
   describe("POST /v0/scrape", () => {
     it.concurrent("should require authorization", async () => {
-      const response: FirecrawlScrapeResponse = await request(TEST_URL).post(
+      const response: FirecrawlScrapeResponse =
-        "/v0/scrape"
+        await request(TEST_URL).post("/v0/scrape");
-      );
       expect(response.statusCode).toBe(401);
     });
 
@@ -99,7 +98,7 @@ describe("E2E Tests for v0 API Routes", () => {
           .set("Content-Type", "application/json")
           .send({
             url: "https://roastmywebsite.ai",
-            pageOptions: { includeHtml: true },
+            pageOptions: { includeHtml: true }
           });
         expect(response.statusCode).toBe(200);
         expect(response.body).toHaveProperty("data");
@@ -196,7 +195,7 @@ describe("E2E Tests for v0 API Routes", () => {
           .set("Content-Type", "application/json")
           .send({
             url: "https://www.scrapethissite.com/",
-            pageOptions: { removeTags: [".nav", "#footer", "strong"] },
+            pageOptions: { removeTags: [".nav", "#footer", "strong"] }
           });
         expect(response.statusCode).toBe(200);
         expect(response.body).toHaveProperty("data");
@@ -338,9 +337,8 @@ describe("E2E Tests for v0 API Routes", () => {
 
   describe("POST /v0/crawl", () => {
     it.concurrent("should require authorization", async () => {
-      const response: FirecrawlCrawlResponse = await request(TEST_URL).post(
+      const response: FirecrawlCrawlResponse =
-        "/v0/crawl"
+        await request(TEST_URL).post("/v0/crawl");
-      );
       expect(response.statusCode).toBe(401);
     });
 
@@ -383,8 +381,8 @@ describe("E2E Tests for v0 API Routes", () => {
             url: "https://mendable.ai",
             limit: 10,
             crawlerOptions: {
-              includes: ["blog/*"],
+              includes: ["blog/*"]
-            },
+            }
           });
 
         let response: FirecrawlCrawlStatusResponse;
@@ -446,8 +444,8 @@ describe("E2E Tests for v0 API Routes", () => {
             url: "https://mendable.ai",
             limit: 10,
             crawlerOptions: {
-              excludes: ["blog/*"],
+              excludes: ["blog/*"]
-            },
+            }
           });
 
         let isFinished = false;
@@ -494,7 +492,7 @@ describe("E2E Tests for v0 API Routes", () => {
           .set("Content-Type", "application/json")
           .send({
             url: "https://www.scrapethissite.com",
-            crawlerOptions: { maxDepth: 1 },
+            crawlerOptions: { maxDepth: 1 }
           });
         expect(crawlResponse.statusCode).toBe(200);
 
@@ -690,7 +688,9 @@ describe("E2E Tests for v0 API Routes", () => {
         expect(completedResponse.body.data[0]).toHaveProperty("markdown");
         expect(completedResponse.body.data[0]).toHaveProperty("metadata");
         expect(completedResponse.body.data[0].content).toContain("Firecrawl");
-        expect(completedResponse.body.data[0].metadata.pageStatusCode).toBe(200);
+        expect(completedResponse.body.data[0].metadata.pageStatusCode).toBe(
+          200
+        );
         expect(
           completedResponse.body.data[0].metadata.pageError
         ).toBeUndefined();
@@ -760,7 +760,10 @@ describe("E2E Tests for v0 API Routes", () => {
           .post("/v0/crawl")
           .set("Authorization", `Bearer ${process.env.TEST_API_KEY}`)
           .set("Content-Type", "application/json")
-          .send({ url: "https://docs.tatum.io", crawlerOptions: { limit: 200 } });
+          .send({
+            url: "https://docs.tatum.io",
+            crawlerOptions: { limit: 200 }
+          });
 
         expect(crawlResponse.statusCode).toBe(200);
 
@@ -825,7 +828,7 @@ describe("E2E Tests for v0 API Routes", () => {
           .send({
             url: "https://mendable.ai",
             pageOptions: {
-              onlyMainContent: true,
+              onlyMainContent: true
             },
             extractorOptions: {
               mode: "llm-extraction",
@@ -835,18 +838,18 @@ describe("E2E Tests for v0 API Routes", () => {
                 type: "object",
                 properties: {
                   company_mission: {
-                    type: "string",
+                    type: "string"
                   },
                   supports_sso: {
-                    type: "boolean",
+                    type: "boolean"
                   },
                   is_open_source: {
-                    type: "boolean",
+                    type: "boolean"
-                  },
+                  }
                 },
-                required: ["company_mission", "supports_sso", "is_open_source"],
+                required: ["company_mission", "supports_sso", "is_open_source"]
-              },
+              }
-            },
+            }
           });
 
         // Ensure that the job was successfully created before proceeding with LLM extraction

apps/api/src/controllers/__tests__/crawl.test.ts

@@ -1,30 +1,30 @@
-import { crawlController } from '../v0/crawl'
+import { crawlController } from "../v0/crawl";
-import { Request, Response } from 'express';
+import { Request, Response } from "express";
-import { authenticateUser } from '../auth'; // Ensure this import is correct
+import { authenticateUser } from "../auth"; // Ensure this import is correct
-import { createIdempotencyKey } from '../../services/idempotency/create';
+import { createIdempotencyKey } from "../../services/idempotency/create";
-import { validateIdempotencyKey } from '../../services/idempotency/validate';
+import { validateIdempotencyKey } from "../../services/idempotency/validate";
-import { v4 as uuidv4 } from 'uuid';
+import { v4 as uuidv4 } from "uuid";
 
-jest.mock('../auth', () => ({
+jest.mock("../auth", () => ({
   authenticateUser: jest.fn().mockResolvedValue({
     success: true,
-    team_id: 'team123',
+    team_id: "team123",
     error: null,
     status: 200
   }),
   reduce: jest.fn()
 }));
-jest.mock('../../services/idempotency/validate');
+jest.mock("../../services/idempotency/validate");
 
-describe('crawlController', () => {
+describe("crawlController", () => {
-  it('should prevent duplicate requests using the same idempotency key', async () => {
+  it("should prevent duplicate requests using the same idempotency key", async () => {
     const req = {
       headers: {
-        'x-idempotency-key': await uuidv4(),
+        "x-idempotency-key": await uuidv4(),
-        'Authorization': `Bearer ${process.env.TEST_API_KEY}`
+        Authorization: `Bearer ${process.env.TEST_API_KEY}`
       },
       body: {
-        url: 'https://mendable.ai'
+        url: "https://mendable.ai"
       }
     } as unknown as Request;
     const res = {
@@ -33,7 +33,9 @@ describe('crawlController', () => {
     } as unknown as Response;
 
     // Mock the idempotency key validation to return false for the second call
-    (validateIdempotencyKey as jest.Mock).mockResolvedValueOnce(true).mockResolvedValueOnce(false);
+    (validateIdempotencyKey as jest.Mock)
+      .mockResolvedValueOnce(true)
+      .mockResolvedValueOnce(false);
 
     // First request should succeed
     await crawlController(req, res);
@@ -42,6 +44,8 @@ describe('crawlController', () => {
     // Second request with the same key should fail
     await crawlController(req, res);
     expect(res.status).toHaveBeenCalledWith(409);
-    expect(res.json).toHaveBeenCalledWith({ error: 'Idempotency key already used' });
+    expect(res.json).toHaveBeenCalledWith({
+      error: "Idempotency key already used"
+    });
   });
-});
+});

apps/api/src/controllers/auth.ts

@@ -4,7 +4,7 @@ import {
   AuthResponse,
   NotificationType,
   PlanType,
-  RateLimiterMode,
+  RateLimiterMode
 } from "../types";
 import { supabase_service } from "../services/supabase";
 import { withAuth } from "../lib/withAuth";
@@ -39,7 +39,8 @@ function normalizedApiIsUuid(potentialUuid: string): boolean {
 export async function setCachedACUC(
   api_key: string,
   acuc:
-    | AuthCreditUsageChunk | null
+    | AuthCreditUsageChunk
+    | null
     | ((acuc: AuthCreditUsageChunk) => AuthCreditUsageChunk | null)
 ) {
   const cacheKeyACUC = `acuc_${api_key}`;
@@ -48,7 +49,7 @@ export async function setCachedACUC(
   try {
     await redlock.using([redLockKey], 10000, {}, async (signal) => {
       if (typeof acuc === "function") {
-        acuc = acuc(JSON.parse(await getValue(cacheKeyACUC) ?? "null"));
+        acuc = acuc(JSON.parse((await getValue(cacheKeyACUC)) ?? "null"));
 
         if (acuc === null) {
           if (signal.aborted) {
@@ -125,7 +126,7 @@ export async function getACUC(
     if (chunk !== null && useCache) {
       setCachedACUC(api_key, chunk);
     }
-    
+
     // console.log(chunk);
 
     return chunk;
@@ -134,9 +135,7 @@ export async function getACUC(
   }
 }
 
-export async function clearACUC(
+export async function clearACUC(api_key: string): Promise<void> {
-  api_key: string,
-): Promise<void> {
   const cacheKeyACUC = `acuc_${api_key}`;
   await deleteKey(cacheKeyACUC);
 }
@@ -146,7 +145,11 @@ export async function authenticateUser(
   res,
   mode?: RateLimiterMode
 ): Promise<AuthResponse> {
-  return withAuth(supaAuthenticateUser, { success: true, chunk: null, team_id: "bypass" })(req, res, mode);
+  return withAuth(supaAuthenticateUser, {
+    success: true,
+    chunk: null,
+    team_id: "bypass"
+  })(req, res, mode);
 }
 
 export async function supaAuthenticateUser(
@@ -167,7 +170,7 @@ export async function supaAuthenticateUser(
     return {
       success: false,
       error: "Unauthorized: Token missing",
-      status: 401,
+      status: 401
     };
   }
 
@@ -196,7 +199,7 @@ export async function supaAuthenticateUser(
       return {
         success: false,
         error: "Unauthorized: Invalid token",
-        status: 401,
+        status: 401
       };
     }
 
@@ -206,7 +209,7 @@ export async function supaAuthenticateUser(
       return {
         success: false,
         error: "Unauthorized: Invalid token",
-        status: 401,
+        status: 401
       };
     }
 
@@ -216,7 +219,7 @@ export async function supaAuthenticateUser(
     const plan = getPlanByPriceId(priceId);
     subscriptionData = {
       team_id: teamId,
-      plan,
+      plan
     };
     switch (mode) {
       case RateLimiterMode.Crawl:
@@ -270,7 +273,13 @@ export async function supaAuthenticateUser(
   try {
     await rateLimiter.consume(team_endpoint_token);
   } catch (rateLimiterRes) {
-    logger.error(`Rate limit exceeded: ${rateLimiterRes}`, { teamId, priceId, plan: subscriptionData?.plan, mode, rateLimiterRes });
+    logger.error(`Rate limit exceeded: ${rateLimiterRes}`, {
+      teamId,
+      priceId,
+      plan: subscriptionData?.plan,
+      mode,
+      rateLimiterRes
+    });
     const secs = Math.round(rateLimiterRes.msBeforeNext / 1000) || 1;
     const retryDate = new Date(Date.now() + rateLimiterRes.msBeforeNext);
 
@@ -284,7 +293,7 @@ export async function supaAuthenticateUser(
     return {
       success: false,
       error: `Rate limit exceeded. Consumed (req/min): ${rateLimiterRes.consumedPoints}, Remaining (req/min): ${rateLimiterRes.remainingPoints}. Upgrade your plan at https://firecrawl.dev/pricing for increased rate limits or please retry after ${secs}s, resets at ${retryDate}`,
-      status: 429,
+      status: 429
     };
   }
 
@@ -314,7 +323,7 @@ export async function supaAuthenticateUser(
     success: true,
     team_id: teamId ?? undefined,
     plan: (subscriptionData?.plan ?? "") as PlanType,
-    chunk,
+    chunk
   };
 }
 function getPlanByPriceId(price_id: string | null): PlanType {

apps/api/src/controllers/v0/admin/queue.ts

@@ -31,7 +31,9 @@ export async function cleanBefore24hCompleteJobsController(
     ).flat();
     const before24hJobs =
       completedJobs.filter(
-        (job) => job.finishedOn !== undefined && job.finishedOn < Date.now() - 24 * 60 * 60 * 1000
+        (job) =>
+          job.finishedOn !== undefined &&
+          job.finishedOn < Date.now() - 24 * 60 * 60 * 1000
       ) || [];
 
     let count = 0;
@@ -71,14 +73,14 @@ export async function queuesController(req: Request, res: Response) {
     const scrapeQueue = getScrapeQueue();
 
     const [webScraperActive] = await Promise.all([
-      scrapeQueue.getActiveCount(),
+      scrapeQueue.getActiveCount()
     ]);
 
     const noActiveJobs = webScraperActive === 0;
     // 200 if no active jobs, 503 if there are active jobs
     return res.status(noActiveJobs ? 200 : 500).json({
       webScraperActive,
-      noActiveJobs,
+      noActiveJobs
     });
   } catch (error) {
     logger.error(error);
@@ -97,7 +99,7 @@ export async function autoscalerController(req: Request, res: Response) {
       await Promise.all([
         scrapeQueue.getActiveCount(),
         scrapeQueue.getWaitingCount(),
-        scrapeQueue.getPrioritizedCount(),
+        scrapeQueue.getPrioritizedCount()
       ]);
 
     let waitingAndPriorityCount = webScraperWaiting + webScraperPriority;
@@ -107,8 +109,8 @@ export async function autoscalerController(req: Request, res: Response) {
       "https://api.machines.dev/v1/apps/firecrawl-scraper-js/machines",
       {
         headers: {
-          Authorization: `Bearer ${process.env.FLY_API_TOKEN}`,
+          Authorization: `Bearer ${process.env.FLY_API_TOKEN}`
-        },
+        }
       }
     );
     const machines = await request.json();
@@ -184,13 +186,13 @@ export async function autoscalerController(req: Request, res: Response) {
       }
       return res.status(200).json({
         mode: "scale-descale",
-        count: targetMachineCount,
+        count: targetMachineCount
       });
     }
 
     return res.status(200).json({
       mode: "normal",
-      count: activeMachines,
+      count: activeMachines
     });
   } catch (error) {
     logger.error(error);

apps/api/src/controllers/v0/admin/redis-health.ts

@@ -49,7 +49,7 @@ export async function redisHealthController(req: Request, res: Response) {
     const healthStatus = {
       queueRedis: queueRedisHealth === testValue ? "healthy" : "unhealthy",
       redisRateLimitClient:
-        redisRateLimitHealth === testValue ? "healthy" : "unhealthy",
+        redisRateLimitHealth === testValue ? "healthy" : "unhealthy"
     };
 
     if (

apps/api/src/controllers/v0/crawl-cancel.ts

@@ -10,13 +10,9 @@ configDotenv();
 
 export async function crawlCancelController(req: Request, res: Response) {
   try {
-    const useDbAuthentication = process.env.USE_DB_AUTHENTICATION === 'true';
+    const useDbAuthentication = process.env.USE_DB_AUTHENTICATION === "true";
 
-    const auth = await authenticateUser(
+    const auth = await authenticateUser(req, res, RateLimiterMode.CrawlStatus);
-      req,
-      res,
-      RateLimiterMode.CrawlStatus
-    );
     if (!auth.success) {
       return res.status(auth.status).json({ error: auth.error });
     }

apps/api/src/controllers/v0/crawl-status.ts

@@ -12,21 +12,25 @@ import { toLegacyDocument } from "../v1/types";
 configDotenv();
 
 export async function getJobs(crawlId: string, ids: string[]) {
-  const jobs = (await Promise.all(ids.map(x => getScrapeQueue().getJob(x)))).filter(x => x) as Job[];
+  const jobs = (
-  
+    await Promise.all(ids.map((x) => getScrapeQueue().getJob(x)))
+  ).filter((x) => x) as Job[];
+
   if (process.env.USE_DB_AUTHENTICATION === "true") {
     const supabaseData = await supabaseGetJobsByCrawlId(crawlId);
 
-    supabaseData.forEach(x => {
+    supabaseData.forEach((x) => {
-      const job = jobs.find(y => y.id === x.job_id);
+      const job = jobs.find((y) => y.id === x.job_id);
       if (job) {
         job.returnvalue = x.docs;
       }
-    })
+    });
   }
 
-  jobs.forEach(job => {
+  jobs.forEach((job) => {
-    job.returnvalue = Array.isArray(job.returnvalue) ? job.returnvalue[0] : job.returnvalue;
+    job.returnvalue = Array.isArray(job.returnvalue)
+      ? job.returnvalue[0]
+      : job.returnvalue;
   });
 
   return jobs;
@@ -34,11 +38,7 @@ export async function getJobs(crawlId: string, ids: string[]) {
 
 export async function crawlStatusController(req: Request, res: Response) {
   try {
-    const auth = await authenticateUser(
+    const auth = await authenticateUser(req, res, RateLimiterMode.CrawlStatus);
-      req,
-      res,
-      RateLimiterMode.CrawlStatus
-    );
     if (!auth.success) {
       return res.status(auth.status).json({ error: auth.error });
     }
@@ -55,7 +55,7 @@ export async function crawlStatusController(req: Request, res: Response) {
     }
     let jobIDs = await getCrawlJobs(req.params.jobId);
     let jobs = await getJobs(req.params.jobId, jobIDs);
-    let jobStatuses = await Promise.all(jobs.map(x => x.getState()));
+    let jobStatuses = await Promise.all(jobs.map((x) => x.getState()));
 
     // Combine jobs and jobStatuses into a single array of objects
     let jobsWithStatuses = jobs.map((job, index) => ({
@@ -64,18 +64,31 @@ export async function crawlStatusController(req: Request, res: Response) {
     }));
 
     // Filter out failed jobs
-    jobsWithStatuses = jobsWithStatuses.filter(x => x.status !== "failed" && x.status !== "unknown");
+    jobsWithStatuses = jobsWithStatuses.filter(
+      (x) => x.status !== "failed" && x.status !== "unknown"
+    );
 
     // Sort jobs by timestamp
     jobsWithStatuses.sort((a, b) => a.job.timestamp - b.job.timestamp);
 
     // Extract sorted jobs and statuses
-    jobs = jobsWithStatuses.map(x => x.job);
+    jobs = jobsWithStatuses.map((x) => x.job);
-    jobStatuses = jobsWithStatuses.map(x => x.status);
+    jobStatuses = jobsWithStatuses.map((x) => x.status);
 
-    const jobStatus = sc.cancelled ? "failed" : jobStatuses.every(x => x === "completed") ? "completed" : "active";
+    const jobStatus = sc.cancelled
+      ? "failed"
+      : jobStatuses.every((x) => x === "completed")
+        ? "completed"
+        : "active";
 
-    const data = jobs.filter(x => x.failedReason !== "Concurreny limit hit" && x.returnvalue !== null).map(x => Array.isArray(x.returnvalue) ? x.returnvalue[0] : x.returnvalue);
+    const data = jobs
+      .filter(
+        (x) =>
+          x.failedReason !== "Concurreny limit hit" && x.returnvalue !== null
+      )
+      .map((x) =>
+        Array.isArray(x.returnvalue) ? x.returnvalue[0] : x.returnvalue
+      );
 
     if (
       jobs.length > 0 &&
@@ -83,7 +96,7 @@ export async function crawlStatusController(req: Request, res: Response) {
       jobs[0].data.pageOptions &&
       !jobs[0].data.pageOptions.includeRawHtml
     ) {
-      data.forEach(item => {
+      data.forEach((item) => {
         if (item) {
           delete item.rawHtml;
         }
@@ -92,10 +105,19 @@ export async function crawlStatusController(req: Request, res: Response) {
 
     res.json({
       status: jobStatus,
-      current: jobStatuses.filter(x => x === "completed" || x === "failed").length,
+      current: jobStatuses.filter((x) => x === "completed" || x === "failed")
+        .length,
       total: jobs.length,
-      data: jobStatus === "completed" ? data.map(x => toLegacyDocument(x, sc.internalOptions)) : null,
+      data:
-      partial_data: jobStatus === "completed" ? [] : data.filter(x => x !== null).map(x => toLegacyDocument(x, sc.internalOptions)),
+        jobStatus === "completed"
+          ? data.map((x) => toLegacyDocument(x, sc.internalOptions))
+          : null,
+      partial_data:
+        jobStatus === "completed"
+          ? []
+          : data
+              .filter((x) => x !== null)
+              .map((x) => toLegacyDocument(x, sc.internalOptions))
     });
   } catch (error) {
     Sentry.captureException(error);

apps/api/src/controllers/v0/crawl.ts

@@ -7,10 +7,22 @@ import { isUrlBlocked } from "../../../src/scraper/WebScraper/utils/blocklist";
 import { logCrawl } from "../../../src/services/logging/crawl_log";
 import { validateIdempotencyKey } from "../../../src/services/idempotency/validate";
 import { createIdempotencyKey } from "../../../src/services/idempotency/create";
-import { defaultCrawlPageOptions, defaultCrawlerOptions, defaultOrigin } from "../../../src/lib/default-values";
+import {
+  defaultCrawlPageOptions,
+  defaultCrawlerOptions,
+  defaultOrigin
+} from "../../../src/lib/default-values";
 import { v4 as uuidv4 } from "uuid";
 import { logger } from "../../../src/lib/logger";
-import { addCrawlJob, addCrawlJobs, crawlToCrawler, lockURL, lockURLs, saveCrawl, StoredCrawl } from "../../../src/lib/crawl-redis";
+import {
+  addCrawlJob,
+  addCrawlJobs,
+  crawlToCrawler,
+  lockURL,
+  lockURLs,
+  saveCrawl,
+  StoredCrawl
+} from "../../../src/lib/crawl-redis";
 import { getScrapeQueue } from "../../../src/services/queue-service";
 import { checkAndUpdateURL } from "../../../src/lib/validateUrl";
 import * as Sentry from "@sentry/node";
@@ -20,11 +32,7 @@ import { ZodError } from "zod";
 
 export async function crawlController(req: Request, res: Response) {
   try {
-    const auth = await authenticateUser(
+    const auth = await authenticateUser(req, res, RateLimiterMode.Crawl);
-      req,
-      res,
-      RateLimiterMode.Crawl
-    );
     if (!auth.success) {
       return res.status(auth.status).json({ error: auth.error });
     }
@@ -46,7 +54,7 @@ export async function crawlController(req: Request, res: Response) {
 
     const crawlerOptions = {
       ...defaultCrawlerOptions,
-      ...req.body.crawlerOptions,
+      ...req.body.crawlerOptions
     };
     const pageOptions = { ...defaultCrawlPageOptions, ...req.body.pageOptions };
 
@@ -71,16 +79,24 @@ export async function crawlController(req: Request, res: Response) {
     }
 
     const limitCheck = req.body?.crawlerOptions?.limit ?? 1;
-    const { success: creditsCheckSuccess, message: creditsCheckMessage, remainingCredits } =
+    const {
-      await checkTeamCredits(chunk, team_id, limitCheck);
+      success: creditsCheckSuccess,
+      message: creditsCheckMessage,
+      remainingCredits
+    } = await checkTeamCredits(chunk, team_id, limitCheck);
 
     if (!creditsCheckSuccess) {
-      return res.status(402).json({ error: "Insufficient credits. You may be requesting with a higher limit than the amount of credits you have left. If not, upgrade your plan at https://firecrawl.dev/pricing or contact us at help@firecrawl.com" });
+      return res
+        .status(402)
+        .json({
+          error:
+            "Insufficient credits. You may be requesting with a higher limit than the amount of credits you have left. If not, upgrade your plan at https://firecrawl.dev/pricing or contact us at help@firecrawl.com"
+        });
     }
 
     // TODO: need to do this to v1
     crawlerOptions.limit = Math.min(remainingCredits, crawlerOptions.limit);
-    
+
     let url = urlSchema.parse(req.body.url);
     if (!url) {
       return res.status(400).json({ error: "Url is required" });
@@ -99,7 +115,7 @@ export async function crawlController(req: Request, res: Response) {
     if (isUrlBlocked(url)) {
       return res.status(403).json({
         error:
-          "Firecrawl currently does not support social media scraping due to policy restrictions. We're actively working on building support for it.",
+          "Firecrawl currently does not support social media scraping due to policy restrictions. We're actively working on building support for it."
       });
     }
 
@@ -136,7 +152,11 @@ export async function crawlController(req: Request, res: Response) {
 
     await logCrawl(id, team_id);
 
-    const { scrapeOptions, internalOptions } = fromLegacyScrapeOptions(pageOptions, undefined, undefined);
+    const { scrapeOptions, internalOptions } = fromLegacyScrapeOptions(
+      pageOptions,
+      undefined,
+      undefined
+    );
     internalOptions.disableSmartWaitCache = true; // NOTE: smart wait disabled for crawls to ensure contentful scrape, speed does not matter
 
     delete (scrapeOptions as any).timeout;
@@ -148,7 +168,7 @@ export async function crawlController(req: Request, res: Response) {
       internalOptions,
       team_id,
       plan,
-      createdAt: Date.now(),
+      createdAt: Date.now()
     };
 
     const crawler = crawlToCrawler(id, sc);
@@ -163,14 +183,13 @@ export async function crawlController(req: Request, res: Response) {
       ? null
       : await crawler.tryGetSitemap();
 
-
     if (sitemap !== null && sitemap.length > 0) {
       let jobPriority = 20;
       // If it is over 1000, we need to get the job priority,
       // otherwise we can use the default priority of 20
-      if(sitemap.length > 1000){
+      if (sitemap.length > 1000) {
         // set base to 21
-        jobPriority = await getJobPriority({plan, team_id, basePriority: 21})
+        jobPriority = await getJobPriority({ plan, team_id, basePriority: 21 });
       }
       const jobs = sitemap.map((x) => {
         const url = x.url;
@@ -187,12 +206,12 @@ export async function crawlController(req: Request, res: Response) {
             plan,
             origin: req.body.origin ?? defaultOrigin,
             crawl_id: id,
-            sitemapped: true,
+            sitemapped: true
           },
           opts: {
             jobId: uuid,
-            priority: jobPriority,
+            priority: jobPriority
-          },
+          }
         };
       });
 
@@ -226,12 +245,12 @@ export async function crawlController(req: Request, res: Response) {
           team_id,
           plan: plan!,
           origin: req.body.origin ?? defaultOrigin,
-          crawl_id: id,
+          crawl_id: id
         },
         {
-          priority: 15, // prioritize request 0 of crawl jobs same as scrape jobs
+          priority: 15 // prioritize request 0 of crawl jobs same as scrape jobs
         },
-        jobId,
+        jobId
       );
       await addCrawlJob(id, jobId);
     }
@@ -240,8 +259,10 @@ export async function crawlController(req: Request, res: Response) {
   } catch (error) {
     Sentry.captureException(error);
     logger.error(error);
-    return res.status(500).json({ error: error instanceof ZodError
+    return res
-      ? "Invalid URL"
+      .status(500)
-      : error.message });
+      .json({
+        error: error instanceof ZodError ? "Invalid URL" : error.message
+      });
   }
 }

apps/api/src/controllers/v0/crawlPreview.ts

@@ -4,7 +4,13 @@ import { RateLimiterMode } from "../../../src/types";
 import { isUrlBlocked } from "../../../src/scraper/WebScraper/utils/blocklist";
 import { v4 as uuidv4 } from "uuid";
 import { logger } from "../../../src/lib/logger";
-import { addCrawlJob, crawlToCrawler, lockURL, saveCrawl, StoredCrawl } from "../../../src/lib/crawl-redis";
+import {
+  addCrawlJob,
+  crawlToCrawler,
+  lockURL,
+  saveCrawl,
+  StoredCrawl
+} from "../../../src/lib/crawl-redis";
 import { addScrapeJob } from "../../../src/services/queue-jobs";
 import { checkAndUpdateURL } from "../../../src/lib/validateUrl";
 import * as Sentry from "@sentry/node";
@@ -12,11 +18,7 @@ import { fromLegacyScrapeOptions } from "../v1/types";
 
 export async function crawlPreviewController(req: Request, res: Response) {
   try {
-    const auth = await authenticateUser(
+    const auth = await authenticateUser(req, res, RateLimiterMode.Preview);
-      req,
-      res,
-      RateLimiterMode.Preview
-    );
 
     const team_id = "preview";
 
@@ -39,16 +41,18 @@ export async function crawlPreviewController(req: Request, res: Response) {
     }
 
     if (isUrlBlocked(url)) {
-      return res
+      return res.status(403).json({
-        .status(403)
+        error:
-        .json({
+          "Firecrawl currently does not support social media scraping due to policy restrictions. We're actively working on building support for it."
-          error:
+      });
-            "Firecrawl currently does not support social media scraping due to policy restrictions. We're actively working on building support for it.",
-        });
     }
 
     const crawlerOptions = req.body.crawlerOptions ?? {};
-    const pageOptions = req.body.pageOptions ?? { onlyMainContent: false, includeHtml: false, removeTags: [] };
+    const pageOptions = req.body.pageOptions ?? {
+      onlyMainContent: false,
+      includeHtml: false,
+      removeTags: []
+    };
 
     // if (mode === "single_urls" && !url.includes(",")) { // NOTE: do we need this?
     //   try {
@@ -87,7 +91,11 @@ export async function crawlPreviewController(req: Request, res: Response) {
       robots = await this.getRobotsTxt();
     } catch (_) {}
 
-    const { scrapeOptions, internalOptions } = fromLegacyScrapeOptions(pageOptions, undefined, undefined);
+    const { scrapeOptions, internalOptions } = fromLegacyScrapeOptions(
+      pageOptions,
+      undefined,
+      undefined
+    );
 
     const sc: StoredCrawl = {
       originUrl: url,
@@ -97,20 +105,44 @@ export async function crawlPreviewController(req: Request, res: Response) {
       team_id,
       plan,
       robots,
-      createdAt: Date.now(),
+      createdAt: Date.now()
     };
 
     await saveCrawl(id, sc);
 
     const crawler = crawlToCrawler(id, sc);
 
-    const sitemap = sc.crawlerOptions?.ignoreSitemap ? null : await crawler.tryGetSitemap();
+    const sitemap = sc.crawlerOptions?.ignoreSitemap
+      ? null
+      : await crawler.tryGetSitemap();
 
     if (sitemap !== null) {
-      for (const url of sitemap.map(x => x.url)) {
+      for (const url of sitemap.map((x) => x.url)) {
         await lockURL(id, sc, url);
         const jobId = uuidv4();
-        await addScrapeJob({
+        await addScrapeJob(
+          {
+            url,
+            mode: "single_urls",
+            team_id,
+            plan: plan!,
+            crawlerOptions,
+            scrapeOptions,
+            internalOptions,
+            origin: "website-preview",
+            crawl_id: id,
+            sitemapped: true
+          },
+          {},
+          jobId
+        );
+        await addCrawlJob(id, jobId);
+      }
+    } else {
+      await lockURL(id, sc, url);
+      const jobId = uuidv4();
+      await addScrapeJob(
+        {
           url,
           mode: "single_urls",
           team_id,
@@ -119,25 +151,11 @@ export async function crawlPreviewController(req: Request, res: Response) {
           scrapeOptions,
           internalOptions,
           origin: "website-preview",
-          crawl_id: id,
+          crawl_id: id
-          sitemapped: true,
+        },
-        }, {}, jobId);
+        {},
-        await addCrawlJob(id, jobId);
+        jobId
-      }
+      );
-    } else {
-      await lockURL(id, sc, url);
-      const jobId = uuidv4();
-      await addScrapeJob({
-        url,
-        mode: "single_urls",
-        team_id,
-        plan: plan!,
-        crawlerOptions,
-        scrapeOptions,
-        internalOptions,
-        origin: "website-preview",
-        crawl_id: id,
-      }, {}, jobId);
       await addCrawlJob(id, jobId);
     }
 

apps/api/src/controllers/v0/keyAuth.ts

@@ -1,17 +1,12 @@
-
 import { AuthResponse, RateLimiterMode } from "../../types";
 
 import { Request, Response } from "express";
 import { authenticateUser } from "../auth";
 
-
 export const keyAuthController = async (req: Request, res: Response) => {
   try {
     // make sure to authenticate user first, Bearer <token>
-    const auth = await authenticateUser(
+    const auth = await authenticateUser(req, res);
-      req,
-      res
-    );
     if (!auth.success) {
       return res.status(auth.status).json({ error: auth.error });
     }
@@ -22,4 +17,3 @@ export const keyAuthController = async (req: Request, res: Response) => {
     return res.status(500).json({ error: error.message });
   }
 };
-

apps/api/src/controllers/v0/scrape.ts

@@ -2,19 +2,24 @@ import { ExtractorOptions, PageOptions } from "./../../lib/entities";
 import { Request, Response } from "express";
 import {
   billTeam,
-  checkTeamCredits,
+  checkTeamCredits
 } from "../../services/billing/credit_billing";
 import { authenticateUser } from "../auth";
 import { PlanType, RateLimiterMode } from "../../types";
 import { logJob } from "../../services/logging/log_job";
-import { Document, fromLegacyCombo, toLegacyDocument, url as urlSchema } from "../v1/types";
+import {
+  Document,
+  fromLegacyCombo,
+  toLegacyDocument,
+  url as urlSchema
+} from "../v1/types";
 import { isUrlBlocked } from "../../scraper/WebScraper/utils/blocklist"; // Import the isUrlBlocked function
 import { numTokensFromString } from "../../lib/LLM-extraction/helpers";
 import {
   defaultPageOptions,
   defaultExtractorOptions,
   defaultTimeout,
-  defaultOrigin,
+  defaultOrigin
 } from "../../lib/default-values";
 import { addScrapeJob, waitForJob } from "../../services/queue-jobs";
 import { getScrapeQueue } from "../../services/queue-service";
@@ -50,13 +55,18 @@ export async function scrapeHelper(
       success: false,
       error:
         "Firecrawl currently does not support social media scraping due to policy restrictions. We're actively working on building support for it.",
-      returnCode: 403,
+      returnCode: 403
     };
   }
 
   const jobPriority = await getJobPriority({ plan, team_id, basePriority: 10 });
 
-  const { scrapeOptions, internalOptions } = fromLegacyCombo(pageOptions, extractorOptions, timeout, crawlerOptions);
+  const { scrapeOptions, internalOptions } = fromLegacyCombo(
+    pageOptions,
+    extractorOptions,
+    timeout,
+    crawlerOptions
+  );
 
   await addScrapeJob(
     {
@@ -67,7 +77,7 @@ export async function scrapeHelper(
       internalOptions,
       plan: plan!,
       origin: req.body.origin ?? defaultOrigin,
-      is_scrape: true,
+      is_scrape: true
     },
     {},
     jobId,
@@ -80,18 +90,21 @@ export async function scrapeHelper(
     {
       name: "Wait for job to finish",
       op: "bullmq.wait",
-      attributes: { job: jobId },
+      attributes: { job: jobId }
     },
     async (span) => {
       try {
-        doc = (await waitForJob<Document>(jobId, timeout));
+        doc = await waitForJob<Document>(jobId, timeout);
       } catch (e) {
-        if (e instanceof Error && (e.message.startsWith("Job wait") || e.message === "timeout")) {
+        if (
+          e instanceof Error &&
+          (e.message.startsWith("Job wait") || e.message === "timeout")
+        ) {
           span.setAttribute("timedOut", true);
           return {
             success: false,
             error: "Request timed out",
-            returnCode: 408,
+            returnCode: 408
           };
         } else if (
           typeof e === "string" &&
@@ -104,7 +117,7 @@ export async function scrapeHelper(
           return {
             success: false,
             error: e,
-            returnCode: 500,
+            returnCode: 500
           };
         } else {
           throw e;
@@ -127,7 +140,7 @@ export async function scrapeHelper(
       success: true,
       error: "No page found",
       returnCode: 200,
-      data: doc,
+      data: doc
     };
   }
 
@@ -153,7 +166,7 @@ export async function scrapeHelper(
   return {
     success: true,
     data: toLegacyDocument(doc, internalOptions),
-    returnCode: 200,
+    returnCode: 200
   };
 }
 
@@ -161,11 +174,7 @@ export async function scrapeController(req: Request, res: Response) {
   try {
     let earlyReturn = false;
     // make sure to authenticate user first, Bearer <token>
-    const auth = await authenticateUser(
+    const auth = await authenticateUser(req, res, RateLimiterMode.Scrape);
-      req,
-      res,
-      RateLimiterMode.Scrape
-    );
     if (!auth.success) {
       return res.status(auth.status).json({ error: auth.error });
     }
@@ -176,7 +185,7 @@ export async function scrapeController(req: Request, res: Response) {
     const pageOptions = { ...defaultPageOptions, ...req.body.pageOptions };
     const extractorOptions = {
       ...defaultExtractorOptions,
-      ...req.body.extractorOptions,
+      ...req.body.extractorOptions
     };
     const origin = req.body.origin ?? defaultOrigin;
     let timeout = req.body.timeout ?? defaultTimeout;
@@ -188,7 +197,7 @@ export async function scrapeController(req: Request, res: Response) {
       ) {
         return res.status(400).json({
           error:
-            "extractorOptions.extractionSchema must be an object if llm-extraction mode is specified",
+            "extractorOptions.extractionSchema must be an object if llm-extraction mode is specified"
         });
       }
 
@@ -202,14 +211,19 @@ export async function scrapeController(req: Request, res: Response) {
         await checkTeamCredits(chunk, team_id, 1);
       if (!creditsCheckSuccess) {
         earlyReturn = true;
-        return res.status(402).json({ error: "Insufficient credits. For more credits, you can upgrade your plan at https://firecrawl.dev/pricing" });
+        return res
+          .status(402)
+          .json({
+            error:
+              "Insufficient credits. For more credits, you can upgrade your plan at https://firecrawl.dev/pricing"
+          });
       }
     } catch (error) {
       logger.error(error);
       earlyReturn = true;
       return res.status(500).json({
         error:
-          "Error checking team credits. Please contact help@firecrawl.com for help.",
+          "Error checking team credits. Please contact help@firecrawl.com for help."
       });
     }
 
@@ -230,7 +244,10 @@ export async function scrapeController(req: Request, res: Response) {
     const timeTakenInSeconds = (endTime - startTime) / 1000;
     const numTokens =
       result.data && (result.data as Document).markdown
-        ? numTokensFromString((result.data as Document).markdown!, "gpt-3.5-turbo")
+        ? numTokensFromString(
+            (result.data as Document).markdown!,
+            "gpt-3.5-turbo"
+          )
         : 0;
 
     if (result.success) {
@@ -250,27 +267,33 @@ export async function scrapeController(req: Request, res: Response) {
       }
       if (creditsToBeBilled > 0) {
         // billing for doc done on queue end, bill only for llm extraction
-        billTeam(team_id, chunk?.sub_id, creditsToBeBilled).catch(error => {
+        billTeam(team_id, chunk?.sub_id, creditsToBeBilled).catch((error) => {
-          logger.error(`Failed to bill team ${team_id} for ${creditsToBeBilled} credits: ${error}`);
+          logger.error(
+            `Failed to bill team ${team_id} for ${creditsToBeBilled} credits: ${error}`
+          );
           // Optionally, you could notify an admin or add to a retry queue here
         });
       }
     }
-    
+
     let doc = result.data;
     if (!pageOptions || !pageOptions.includeRawHtml) {
       if (doc && (doc as Document).rawHtml) {
         delete (doc as Document).rawHtml;
       }
     }
-  
+
-    if(pageOptions && pageOptions.includeExtract) {
+    if (pageOptions && pageOptions.includeExtract) {
-      if(!pageOptions.includeMarkdown && doc && (doc as Document).markdown) {
+      if (!pageOptions.includeMarkdown && doc && (doc as Document).markdown) {
         delete (doc as Document).markdown;
       }
     }
 
-    const { scrapeOptions } = fromLegacyScrapeOptions(pageOptions, extractorOptions, timeout);
+    const { scrapeOptions } = fromLegacyScrapeOptions(
+      pageOptions,
+      extractorOptions,
+      timeout
+    );
 
     logJob({
       job_id: jobId,
@@ -285,7 +308,7 @@ export async function scrapeController(req: Request, res: Response) {
       crawlerOptions: crawlerOptions,
       scrapeOptions,
       origin: origin,
-      num_tokens: numTokens,
+      num_tokens: numTokens
     });
 
     return res.status(result.returnCode).json(result);
@@ -298,7 +321,7 @@ export async function scrapeController(req: Request, res: Response) {
           ? "Invalid URL"
           : typeof error === "string"
             ? error
-            : error?.message ?? "Internal Server Error",
+            : (error?.message ?? "Internal Server Error")
     });
   }
 }

apps/api/src/controllers/v0/search.ts

@@ -1,5 +1,8 @@
 import { Request, Response } from "express";
-import { billTeam, checkTeamCredits } from "../../services/billing/credit_billing";
+import {
+  billTeam,
+  checkTeamCredits
+} from "../../services/billing/credit_billing";
 import { authenticateUser } from "../auth";
 import { PlanType, RateLimiterMode } from "../../types";
 import { logJob } from "../../services/logging/log_job";
@@ -13,7 +16,12 @@ import { addScrapeJob, waitForJob } from "../../services/queue-jobs";
 import * as Sentry from "@sentry/node";
 import { getJobPriority } from "../../lib/job-priority";
 import { Job } from "bullmq";
-import { Document, fromLegacyCombo, fromLegacyScrapeOptions, toLegacyDocument } from "../v1/types";
+import {
+  Document,
+  fromLegacyCombo,
+  fromLegacyScrapeOptions,
+  toLegacyDocument
+} from "../v1/types";
 
 export async function searchHelper(
   jobId: string,
@@ -54,16 +62,23 @@ export async function searchHelper(
     filter: filter,
     lang: searchOptions.lang ?? "en",
     country: searchOptions.country ?? "us",
-    location: searchOptions.location,
+    location: searchOptions.location
   });
 
   let justSearch = pageOptions.fetchPageContent === false;
 
-  const { scrapeOptions, internalOptions } = fromLegacyCombo(pageOptions, undefined, 60000, crawlerOptions);
+  const { scrapeOptions, internalOptions } = fromLegacyCombo(
+    pageOptions,
+    undefined,
+    60000,
+    crawlerOptions
+  );
 
   if (justSearch) {
-    billTeam(team_id, subscription_id, res.length).catch(error => {
+    billTeam(team_id, subscription_id, res.length).catch((error) => {
-      logger.error(`Failed to bill team ${team_id} for ${res.length} credits: ${error}`);
+      logger.error(
+        `Failed to bill team ${team_id} for ${res.length} credits: ${error}`
+      );
       // Optionally, you could notify an admin or add to a retry queue here
     });
     return { success: true, data: res, returnCode: 200 };
@@ -78,11 +93,11 @@ export async function searchHelper(
     return { success: true, error: "No search results found", returnCode: 200 };
   }
 
-  const jobPriority = await getJobPriority({plan, team_id, basePriority: 20});
+  const jobPriority = await getJobPriority({ plan, team_id, basePriority: 20 });
-  
+
   // filter out social media links
 
-  const jobDatas = res.map(x => {
+  const jobDatas = res.map((x) => {
     const url = x.url;
     const uuid = uuidv4();
     return {
@@ -92,28 +107,32 @@ export async function searchHelper(
         mode: "single_urls",
         team_id: team_id,
         scrapeOptions,
-        internalOptions,
+        internalOptions
       },
       opts: {
         jobId: uuid,
-        priority: jobPriority,
+        priority: jobPriority
       }
     };
-  })
+  });
 
   // TODO: addScrapeJobs
   for (const job of jobDatas) {
-    await addScrapeJob(job.data as any, {}, job.opts.jobId, job.opts.priority)
+    await addScrapeJob(job.data as any, {}, job.opts.jobId, job.opts.priority);
   }
 
-  const docs = (await Promise.all(jobDatas.map(x => waitForJob<Document>(x.opts.jobId, 60000)))).map(x => toLegacyDocument(x, internalOptions));
+  const docs = (
-  
+    await Promise.all(
+      jobDatas.map((x) => waitForJob<Document>(x.opts.jobId, 60000))
+    )
+  ).map((x) => toLegacyDocument(x, internalOptions));
+
   if (docs.length === 0) {
     return { success: true, error: "No search results found", returnCode: 200 };
   }
 
   const sq = getScrapeQueue();
-  await Promise.all(jobDatas.map(x => sq.remove(x.opts.jobId)));
+  await Promise.all(jobDatas.map((x) => sq.remove(x.opts.jobId)));
 
   // make sure doc.content is not empty
   const filteredDocs = docs.filter(
@@ -121,24 +140,25 @@ export async function searchHelper(
   );
 
   if (filteredDocs.length === 0) {
-    return { success: true, error: "No page found", returnCode: 200, data: docs };
+    return {
+      success: true,
+      error: "No page found",
+      returnCode: 200,
+      data: docs
+    };
   }
 
   return {
     success: true,
     data: filteredDocs,
-    returnCode: 200,
+    returnCode: 200
   };
 }
 
 export async function searchController(req: Request, res: Response) {
   try {
     // make sure to authenticate user first, Bearer <token>
-    const auth = await authenticateUser(
+    const auth = await authenticateUser(req, res, RateLimiterMode.Search);
-      req,
-      res,
-      RateLimiterMode.Search
-    );
     if (!auth.success) {
       return res.status(auth.status).json({ error: auth.error });
     }
@@ -149,12 +169,12 @@ export async function searchController(req: Request, res: Response) {
       onlyMainContent: req.body.pageOptions?.onlyMainContent ?? false,
       fetchPageContent: req.body.pageOptions?.fetchPageContent ?? true,
       removeTags: req.body.pageOptions?.removeTags ?? [],
-      fallback: req.body.pageOptions?.fallback ?? false,
+      fallback: req.body.pageOptions?.fallback ?? false
     };
     const origin = req.body.origin ?? "api";
 
     const searchOptions = req.body.searchOptions ?? { limit: 5 };
-    
+
     const jobId = uuidv4();
 
     try {
@@ -192,11 +212,14 @@ export async function searchController(req: Request, res: Response) {
       mode: "search",
       url: req.body.query,
       crawlerOptions: crawlerOptions,
-      origin: origin,
+      origin: origin
     });
     return res.status(result.returnCode).json(result);
   } catch (error) {
-    if (error instanceof Error && (error.message.startsWith("Job wait") || error.message === "timeout")) {
+    if (
+      error instanceof Error &&
+      (error.message.startsWith("Job wait") || error.message === "timeout")
+    ) {
       return res.status(408).json({ error: "Request timed out" });
     }
 

apps/api/src/controllers/v0/status.ts

@@ -4,7 +4,10 @@ import { getCrawl, getCrawlJobs } from "../../../src/lib/crawl-redis";
 import { getJobs } from "./crawl-status";
 import * as Sentry from "@sentry/node";
 
-export async function crawlJobStatusPreviewController(req: Request, res: Response) {
+export async function crawlJobStatusPreviewController(
+  req: Request,
+  res: Response
+) {
   try {
     const sc = await getCrawl(req.params.jobId);
     if (!sc) {
@@ -22,18 +25,30 @@ export async function crawlJobStatusPreviewController(req: Request, res: Respons
     //   }
     // }
 
-    const jobs = (await getJobs(req.params.jobId, jobIDs)).sort((a, b) => a.timestamp - b.timestamp);
+    const jobs = (await getJobs(req.params.jobId, jobIDs)).sort(
-    const jobStatuses = await Promise.all(jobs.map(x => x.getState()));
+      (a, b) => a.timestamp - b.timestamp
-    const jobStatus = sc.cancelled ? "failed" : jobStatuses.every(x => x === "completed") ? "completed" : jobStatuses.some(x => x === "failed") ? "failed" : "active";
+    );
+    const jobStatuses = await Promise.all(jobs.map((x) => x.getState()));
+    const jobStatus = sc.cancelled
+      ? "failed"
+      : jobStatuses.every((x) => x === "completed")
+        ? "completed"
+        : jobStatuses.some((x) => x === "failed")
+          ? "failed"
+          : "active";
 
-    const data = jobs.map(x => Array.isArray(x.returnvalue) ? x.returnvalue[0] : x.returnvalue);
+    const data = jobs.map((x) =>
+      Array.isArray(x.returnvalue) ? x.returnvalue[0] : x.returnvalue
+    );
 
     res.json({
       status: jobStatus,
-      current: jobStatuses.filter(x => x === "completed" || x === "failed").length,
+      current: jobStatuses.filter((x) => x === "completed" || x === "failed")
+        .length,
       total: jobs.length,
       data: jobStatus === "completed" ? data : null,
-      partial_data: jobStatus === "completed" ? [] : data.filter(x => x !== null),
+      partial_data:
+        jobStatus === "completed" ? [] : data.filter((x) => x !== null)
     });
   } catch (error) {
     Sentry.captureException(error);

apps/api/src/controllers/v1/__tests__/urlValidation.test.ts

@@ -24,11 +24,15 @@ describe("URL Schema Validation", () => {
   });
 
   it("should reject URLs without a valid top-level domain", () => {
-    expect(() => url.parse("http://example")).toThrow("URL must have a valid top-level domain or be a valid path");
+    expect(() => url.parse("http://example")).toThrow(
+      "URL must have a valid top-level domain or be a valid path"
+    );
   });
 
   it("should reject blocked URLs", () => {
-    expect(() => url.parse("https://facebook.com")).toThrow("Firecrawl currently does not support social media scraping due to policy restrictions. We're actively working on building support for it.");
+    expect(() => url.parse("https://facebook.com")).toThrow(
+      "Firecrawl currently does not support social media scraping due to policy restrictions. We're actively working on building support for it."
+    );
   });
 
   it("should handle URLs with subdomains correctly", () => {
@@ -42,23 +46,33 @@ describe("URL Schema Validation", () => {
   });
 
   it("should handle URLs with subdomains that are blocked", () => {
-    expect(() => url.parse("https://sub.facebook.com")).toThrow("Firecrawl currently does not support social media scraping due to policy restrictions. We're actively working on building support for it.");
+    expect(() => url.parse("https://sub.facebook.com")).toThrow(
+      "Firecrawl currently does not support social media scraping due to policy restrictions. We're actively working on building support for it."
+    );
   });
 
   it("should handle URLs with paths that are blocked", () => {
-    expect(() => url.parse("http://facebook.com/path")).toThrow("Firecrawl currently does not support social media scraping due to policy restrictions. We're actively working on building support for it.");
+    expect(() => url.parse("http://facebook.com/path")).toThrow(
-    expect(() => url.parse("https://facebook.com/another/path")).toThrow("Firecrawl currently does not support social media scraping due to policy restrictions. We're actively working on building support for it.");
+      "Firecrawl currently does not support social media scraping due to policy restrictions. We're actively working on building support for it."
+    );
+    expect(() => url.parse("https://facebook.com/another/path")).toThrow(
+      "Firecrawl currently does not support social media scraping due to policy restrictions. We're actively working on building support for it."
+    );
   });
-  
+
   it("should reject malformed URLs starting with 'http://http'", () => {
-    expect(() => url.parse("http://http://example.com")).toThrow("Invalid URL. Invalid protocol.");
+    expect(() => url.parse("http://http://example.com")).toThrow(
+      "Invalid URL. Invalid protocol."
+    );
   });
 
   it("should reject malformed URLs containing multiple 'http://'", () => {
-    expect(() => url.parse("http://example.com/http://example.com")).not.toThrow();
+    expect(() =>
+      url.parse("http://example.com/http://example.com")
+    ).not.toThrow();
   });
 
   it("should reject malformed URLs containing multiple 'http://'", () => {
     expect(() => url.parse("http://ex ample.com/")).toThrow("Invalid URL");
   });
-})
+});

apps/api/src/controllers/v1/batch-scrape.ts

@@ -5,14 +5,14 @@ import {
   batchScrapeRequestSchema,
   CrawlResponse,
   RequestWithAuth,
-  ScrapeOptions,
+  ScrapeOptions
 } from "./types";
 import {
   addCrawlJobs,
   getCrawl,
   lockURLs,
   saveCrawl,
-  StoredCrawl,
+  StoredCrawl
 } from "../../lib/crawl-redis";
 import { logCrawl } from "../../services/logging/crawl_log";
 import { getJobPriority } from "../../lib/job-priority";
@@ -27,27 +27,40 @@ export async function batchScrapeController(
   req.body = batchScrapeRequestSchema.parse(req.body);
 
   const id = req.body.appendToId ?? uuidv4();
-  const logger = _logger.child({ crawlId: id, batchScrapeId: id, module: "api/v1", method: "batchScrapeController", teamId: req.auth.team_id, plan: req.auth.plan });
+  const logger = _logger.child({
-  logger.debug("Batch scrape " + id + " starting", { urlsLength: req.body.urls, appendToId: req.body.appendToId, account: req.account });
+    crawlId: id,
+    batchScrapeId: id,
+    module: "api/v1",
+    method: "batchScrapeController",
+    teamId: req.auth.team_id,
+    plan: req.auth.plan
+  });
+  logger.debug("Batch scrape " + id + " starting", {
+    urlsLength: req.body.urls,
+    appendToId: req.body.appendToId,
+    account: req.account
+  });
 
   if (!req.body.appendToId) {
     await logCrawl(id, req.auth.team_id);
   }
 
   let { remainingCredits } = req.account!;
-  const useDbAuthentication = process.env.USE_DB_AUTHENTICATION === 'true';
+  const useDbAuthentication = process.env.USE_DB_AUTHENTICATION === "true";
-  if(!useDbAuthentication){
+  if (!useDbAuthentication) {
     remainingCredits = Infinity;
   }
 
-  const sc: StoredCrawl = req.body.appendToId ? await getCrawl(req.body.appendToId) as StoredCrawl : {
+  const sc: StoredCrawl = req.body.appendToId
-    crawlerOptions: null,
+    ? ((await getCrawl(req.body.appendToId)) as StoredCrawl)
-    scrapeOptions: req.body,
+    : {
-    internalOptions: { disableSmartWaitCache: true }, // NOTE: smart wait disabled for batch scrapes to ensure contentful scrape, speed does not matter
+        crawlerOptions: null,
-    team_id: req.auth.team_id,
+        scrapeOptions: req.body,
-    createdAt: Date.now(),
+        internalOptions: { disableSmartWaitCache: true }, // NOTE: smart wait disabled for batch scrapes to ensure contentful scrape, speed does not matter
-    plan: req.auth.plan,
+        team_id: req.auth.team_id,
-  };
+        createdAt: Date.now(),
+        plan: req.auth.plan
+      };
 
   if (!req.body.appendToId) {
     await saveCrawl(id, sc);
@@ -57,9 +70,13 @@ export async function batchScrapeController(
 
   // If it is over 1000, we need to get the job priority,
   // otherwise we can use the default priority of 20
-  if(req.body.urls.length > 1000){
+  if (req.body.urls.length > 1000) {
     // set base to 21
-    jobPriority = await getJobPriority({plan: req.auth.plan, team_id: req.auth.team_id, basePriority: 21})
+    jobPriority = await getJobPriority({
+      plan: req.auth.plan,
+      team_id: req.auth.team_id,
+      basePriority: 21
+    });
   }
   logger.debug("Using job priority " + jobPriority, { jobPriority });
 
@@ -80,12 +97,12 @@ export async function batchScrapeController(
         crawl_id: id,
         sitemapped: true,
         v1: true,
-        webhook: req.body.webhook,
+        webhook: req.body.webhook
       },
       opts: {
         jobId: uuidv4(),
-        priority: 20,
+        priority: 20
-      },
+      }
     };
   });
 
@@ -103,18 +120,25 @@ export async function batchScrapeController(
   logger.debug("Adding scrape jobs to BullMQ...");
   await addScrapeJobs(jobs);
 
-  if(req.body.webhook) {
+  if (req.body.webhook) {
-    logger.debug("Calling webhook with batch_scrape.started...", { webhook: req.body.webhook });
+    logger.debug("Calling webhook with batch_scrape.started...", {
-    await callWebhook(req.auth.team_id, id, null, req.body.webhook, true, "batch_scrape.started");
+      webhook: req.body.webhook
+    });
+    await callWebhook(
+      req.auth.team_id,
+      id,
+      null,
+      req.body.webhook,
+      true,
+      "batch_scrape.started"
+    );
   }
 
   const protocol = process.env.ENV === "local" ? req.protocol : "https";
-  
+
   return res.status(200).json({
     success: true,
     id,
-    url: `${protocol}://${req.get("host")}/v1/batch/scrape/${id}`,
+    url: `${protocol}://${req.get("host")}/v1/batch/scrape/${id}`
   });
 }
-
-

apps/api/src/controllers/v1/concurrency-check.ts

@@ -2,7 +2,7 @@ import { authenticateUser } from "../auth";
 import {
   ConcurrencyCheckParams,
   ConcurrencyCheckResponse,
-  RequestWithAuth,
+  RequestWithAuth
 } from "./types";
 import { RateLimiterMode } from "../../types";
 import { Response } from "express";

apps/api/src/controllers/v1/crawl-cancel.ts

@@ -7,9 +7,12 @@ import { configDotenv } from "dotenv";
 import { RequestWithAuth } from "./types";
 configDotenv();
 
-export async function crawlCancelController(req: RequestWithAuth<{ jobId: string }>, res: Response) {
+export async function crawlCancelController(
+  req: RequestWithAuth<{ jobId: string }>,
+  res: Response
+) {
   try {
-    const useDbAuthentication = process.env.USE_DB_AUTHENTICATION === 'true';
+    const useDbAuthentication = process.env.USE_DB_AUTHENTICATION === "true";
 
     const sc = await getCrawl(req.params.jobId);
     if (!sc) {

apps/api/src/controllers/v1/crawl-status-ws.ts

@@ -1,32 +1,47 @@
 import { authMiddleware } from "../../routes/v1";
 import { RateLimiterMode } from "../../types";
 import { authenticateUser } from "../auth";
-import { CrawlStatusParams, CrawlStatusResponse, Document, ErrorResponse, RequestWithAuth } from "./types";
+import {
+  CrawlStatusParams,
+  CrawlStatusResponse,
+  Document,
+  ErrorResponse,
+  RequestWithAuth
+} from "./types";
 import { WebSocket } from "ws";
 import { v4 as uuidv4 } from "uuid";
 import { logger } from "../../lib/logger";
-import { getCrawl, getCrawlExpiry, getCrawlJobs, getDoneJobsOrdered, getDoneJobsOrderedLength, getThrottledJobs, isCrawlFinished, isCrawlFinishedLocked } from "../../lib/crawl-redis";
+import {
+  getCrawl,
+  getCrawlExpiry,
+  getCrawlJobs,
+  getDoneJobsOrdered,
+  getDoneJobsOrderedLength,
+  getThrottledJobs,
+  isCrawlFinished,
+  isCrawlFinishedLocked
+} from "../../lib/crawl-redis";
 import { getScrapeQueue } from "../../services/queue-service";
 import { getJob, getJobs } from "./crawl-status";
 import * as Sentry from "@sentry/node";
 import { Job, JobState } from "bullmq";
 
 type ErrorMessage = {
-  type: "error",
+  type: "error";
-  error: string,
+  error: string;
-}
+};
 
 type CatchupMessage = {
-  type: "catchup",
+  type: "catchup";
-  data: CrawlStatusResponse,
+  data: CrawlStatusResponse;
-}
+};
 
 type DocumentMessage = {
-  type: "document",
+  type: "document";
-  data: Document,
+  data: Document;
-}
+};
 
-type DoneMessage = { type: "done" }
+type DoneMessage = { type: "done" };
 
 type Message = ErrorMessage | CatchupMessage | DoneMessage | DocumentMessage;
 
@@ -47,7 +62,10 @@ function close(ws: WebSocket, code: number, msg: Message) {
   }
 }
 
-async function crawlStatusWS(ws: WebSocket, req: RequestWithAuth<CrawlStatusParams, undefined, undefined>) {
+async function crawlStatusWS(
+  ws: WebSocket,
+  req: RequestWithAuth<CrawlStatusParams, undefined, undefined>
+) {
   const sc = await getCrawl(req.params.jobId);
   if (!sc) {
     return close(ws, 1008, { type: "error", error: "Job not found" });
@@ -69,17 +87,23 @@ async function crawlStatusWS(ws: WebSocket, req: RequestWithAuth<CrawlStatusPara
       return close(ws, 1000, { type: "done" });
     }
 
-    const notDoneJobIDs = jobIDs.filter(x => !doneJobIDs.includes(x));
+    const notDoneJobIDs = jobIDs.filter((x) => !doneJobIDs.includes(x));
-    const jobStatuses = await Promise.all(notDoneJobIDs.map(async x => [x, await getScrapeQueue().getJobState(x)]));
+    const jobStatuses = await Promise.all(
-    const newlyDoneJobIDs: string[] = jobStatuses.filter(x => x[1] === "completed" || x[1] === "failed").map(x => x[0]);
+      notDoneJobIDs.map(async (x) => [x, await getScrapeQueue().getJobState(x)])
-    const newlyDoneJobs: Job[] = (await Promise.all(newlyDoneJobIDs.map(x => getJob(x)))).filter(x => x !== undefined) as Job[]
+    );
+    const newlyDoneJobIDs: string[] = jobStatuses
+      .filter((x) => x[1] === "completed" || x[1] === "failed")
+      .map((x) => x[0]);
+    const newlyDoneJobs: Job[] = (
+      await Promise.all(newlyDoneJobIDs.map((x) => getJob(x)))
+    ).filter((x) => x !== undefined) as Job[];
 
     for (const job of newlyDoneJobs) {
       if (job.returnvalue) {
         send(ws, {
           type: "document",
-          data: job.returnvalue,
+          data: job.returnvalue
-        })
+        });
       } else {
         return close(ws, 3000, { type: "error", error: job.failedReason });
       }
@@ -95,8 +119,10 @@ async function crawlStatusWS(ws: WebSocket, req: RequestWithAuth<CrawlStatusPara
   doneJobIDs = await getDoneJobsOrdered(req.params.jobId);
 
   let jobIDs = await getCrawlJobs(req.params.jobId);
-  let jobStatuses = await Promise.all(jobIDs.map(async x => [x, await getScrapeQueue().getJobState(x)] as const));
+  let jobStatuses = await Promise.all(
-  const throttledJobs = new Set(...await getThrottledJobs(req.auth.team_id));
+    jobIDs.map(async (x) => [x, await getScrapeQueue().getJobState(x)] as const)
+  );
+  const throttledJobs = new Set(...(await getThrottledJobs(req.auth.team_id)));
 
   const throttledJobsSet = new Set(throttledJobs);
 
@@ -104,18 +130,27 @@ async function crawlStatusWS(ws: WebSocket, req: RequestWithAuth<CrawlStatusPara
   const validJobIDs: string[] = [];
 
   for (const [id, status] of jobStatuses) {
-    if (!throttledJobsSet.has(id) && status !== "failed" && status !== "unknown") {
+    if (
+      !throttledJobsSet.has(id) &&
+      status !== "failed" &&
+      status !== "unknown"
+    ) {
       validJobStatuses.push([id, status]);
       validJobIDs.push(id);
     }
   }
 
-  const status: Exclude<CrawlStatusResponse, ErrorResponse>["status"] = sc.cancelled ? "cancelled" : validJobStatuses.every(x => x[1] === "completed") ? "completed" : "scraping";
+  const status: Exclude<CrawlStatusResponse, ErrorResponse>["status"] =
+    sc.cancelled
+      ? "cancelled"
+      : validJobStatuses.every((x) => x[1] === "completed")
+        ? "completed"
+        : "scraping";
 
   jobIDs = validJobIDs; // Use validJobIDs instead of jobIDs for further processing
 
   const doneJobs = await getJobs(doneJobIDs);
-  const data = doneJobs.map(x => x.returnvalue);
+  const data = doneJobs.map((x) => x.returnvalue);
 
   send(ws, {
     type: "catchup",
@@ -126,7 +161,7 @@ async function crawlStatusWS(ws: WebSocket, req: RequestWithAuth<CrawlStatusPara
       completed: doneJobIDs.length,
       creditsUsed: jobIDs.length,
       expiresAt: (await getCrawlExpiry(req.params.jobId)).toISOString(),
-      data: data,
+      data: data
     }
   });
 
@@ -137,18 +172,17 @@ async function crawlStatusWS(ws: WebSocket, req: RequestWithAuth<CrawlStatusPara
 }
 
 // Basically just middleware and error wrapping
-export async function crawlStatusWSController(ws: WebSocket, req: RequestWithAuth<CrawlStatusParams, undefined, undefined>) {
+export async function crawlStatusWSController(
+  ws: WebSocket,
+  req: RequestWithAuth<CrawlStatusParams, undefined, undefined>
+) {
   try {
-    const auth = await authenticateUser(
+    const auth = await authenticateUser(req, null, RateLimiterMode.CrawlStatus);
-      req,
-      null,
-      RateLimiterMode.CrawlStatus,
-    );
 
     if (!auth.success) {
       return close(ws, 3000, {
         type: "error",
-        error: auth.error,
+        error: auth.error
       });
     }
 
@@ -167,15 +201,24 @@ export async function crawlStatusWSController(ws: WebSocket, req: RequestWithAut
         verbose = JSON.stringify({
           message: err.message,
           name: err.name,
-          stack: err.stack,
+          stack: err.stack
         });
       }
     }
 
-    logger.error("Error occurred in WebSocket! (" + req.path + ") -- ID " + id + " -- " + verbose);
+    logger.error(
+      "Error occurred in WebSocket! (" +
+        req.path +
+        ") -- ID " +
+        id +
+        " -- " +
+        verbose
+    );
     return close(ws, 1011, {
       type: "error",
-      error: "An unexpected error occurred. Please contact help@firecrawl.com for help. Your exception ID is " + id
+      error:
+        "An unexpected error occurred. Please contact help@firecrawl.com for help. Your exception ID is " +
+        id
     });
   }
 }

apps/api/src/controllers/v1/crawl-status.ts

@@ -1,8 +1,23 @@
 import { Response } from "express";
-import { CrawlStatusParams, CrawlStatusResponse, ErrorResponse, RequestWithAuth } from "./types";
+import {
-import { getCrawl, getCrawlExpiry, getCrawlJobs, getDoneJobsOrdered, getDoneJobsOrderedLength, getThrottledJobs } from "../../lib/crawl-redis";
+  CrawlStatusParams,
+  CrawlStatusResponse,
+  ErrorResponse,
+  RequestWithAuth
+} from "./types";
+import {
+  getCrawl,
+  getCrawlExpiry,
+  getCrawlJobs,
+  getDoneJobsOrdered,
+  getDoneJobsOrderedLength,
+  getThrottledJobs
+} from "../../lib/crawl-redis";
 import { getScrapeQueue } from "../../services/queue-service";
-import { supabaseGetJobById, supabaseGetJobsById } from "../../lib/supabase-jobs";
+import {
+  supabaseGetJobById,
+  supabaseGetJobsById
+} from "../../lib/supabase-jobs";
 import { configDotenv } from "dotenv";
 import { Job, JobState } from "bullmq";
 import { logger } from "../../lib/logger";
@@ -11,7 +26,7 @@ configDotenv();
 export async function getJob(id: string) {
   const job = await getScrapeQueue().getJob(id);
   if (!job) return job;
-  
+
   if (process.env.USE_DB_AUTHENTICATION === "true") {
     const supabaseData = await supabaseGetJobById(id);
 
@@ -20,33 +35,43 @@ export async function getJob(id: string) {
     }
   }
 
-  job.returnvalue = Array.isArray(job.returnvalue) ? job.returnvalue[0] : job.returnvalue;
+  job.returnvalue = Array.isArray(job.returnvalue)
+    ? job.returnvalue[0]
+    : job.returnvalue;
 
   return job;
 }
 
 export async function getJobs(ids: string[]) {
-  const jobs: (Job & { id: string })[] = (await Promise.all(ids.map(x => getScrapeQueue().getJob(x)))).filter(x => x) as (Job & {id: string})[];
+  const jobs: (Job & { id: string })[] = (
-  
+    await Promise.all(ids.map((x) => getScrapeQueue().getJob(x)))
+  ).filter((x) => x) as (Job & { id: string })[];
+
   if (process.env.USE_DB_AUTHENTICATION === "true") {
     const supabaseData = await supabaseGetJobsById(ids);
 
-    supabaseData.forEach(x => {
+    supabaseData.forEach((x) => {
-      const job = jobs.find(y => y.id === x.job_id);
+      const job = jobs.find((y) => y.id === x.job_id);
       if (job) {
         job.returnvalue = x.docs;
       }
-    })
+    });
   }
 
-  jobs.forEach(job => {
+  jobs.forEach((job) => {
-    job.returnvalue = Array.isArray(job.returnvalue) ? job.returnvalue[0] : job.returnvalue;
+    job.returnvalue = Array.isArray(job.returnvalue)
+      ? job.returnvalue[0]
+      : job.returnvalue;
   });
 
   return jobs;
 }
 
-export async function crawlStatusController(req: RequestWithAuth<CrawlStatusParams, undefined, CrawlStatusResponse>, res: Response<CrawlStatusResponse>, isBatch = false) {
+export async function crawlStatusController(
+  req: RequestWithAuth<CrawlStatusParams, undefined, CrawlStatusResponse>,
+  res: Response<CrawlStatusResponse>,
+  isBatch = false
+) {
   const sc = await getCrawl(req.params.jobId);
   if (!sc) {
     return res.status(404).json({ success: false, error: "Job not found" });
@@ -56,12 +81,18 @@ export async function crawlStatusController(req: RequestWithAuth<CrawlStatusPara
     return res.status(403).json({ success: false, error: "Forbidden" });
   }
 
-  const start = typeof req.query.skip === "string" ? parseInt(req.query.skip, 10) : 0;
+  const start =
-  const end = typeof req.query.limit === "string" ? (start + parseInt(req.query.limit, 10) - 1) : undefined;
+    typeof req.query.skip === "string" ? parseInt(req.query.skip, 10) : 0;
+  const end =
+    typeof req.query.limit === "string"
+      ? start + parseInt(req.query.limit, 10) - 1
+      : undefined;
 
   let jobIDs = await getCrawlJobs(req.params.jobId);
-  let jobStatuses = await Promise.all(jobIDs.map(async x => [x, await getScrapeQueue().getJobState(x)] as const));
+  let jobStatuses = await Promise.all(
-  const throttledJobs = new Set(...await getThrottledJobs(req.auth.team_id));
+    jobIDs.map(async (x) => [x, await getScrapeQueue().getJobState(x)] as const)
+  );
+  const throttledJobs = new Set(...(await getThrottledJobs(req.auth.team_id)));
 
   const throttledJobsSet = new Set(throttledJobs);
 
@@ -69,30 +100,48 @@ export async function crawlStatusController(req: RequestWithAuth<CrawlStatusPara
   const validJobIDs: string[] = [];
 
   for (const [id, status] of jobStatuses) {
-    if (!throttledJobsSet.has(id) && status !== "failed" && status !== "unknown") {
+    if (
+      !throttledJobsSet.has(id) &&
+      status !== "failed" &&
+      status !== "unknown"
+    ) {
       validJobStatuses.push([id, status]);
       validJobIDs.push(id);
     }
   }
 
-  const status: Exclude<CrawlStatusResponse, ErrorResponse>["status"] = sc.cancelled ? "cancelled" : validJobStatuses.every(x => x[1] === "completed") ? "completed" : "scraping";
+  const status: Exclude<CrawlStatusResponse, ErrorResponse>["status"] =
+    sc.cancelled
+      ? "cancelled"
+      : validJobStatuses.every((x) => x[1] === "completed")
+        ? "completed"
+        : "scraping";
 
   // Use validJobIDs instead of jobIDs for further processing
   jobIDs = validJobIDs;
 
   const doneJobsLength = await getDoneJobsOrderedLength(req.params.jobId);
-  const doneJobsOrder = await getDoneJobsOrdered(req.params.jobId, start, end ?? -1);
+  const doneJobsOrder = await getDoneJobsOrdered(
+    req.params.jobId,
+    start,
+    end ?? -1
+  );
 
   let doneJobs: Job[] = [];
 
-  if (end === undefined) { // determine 10 megabyte limit
+  if (end === undefined) {
+    // determine 10 megabyte limit
     let bytes = 0;
     const bytesLimit = 10485760; // 10 MiB in bytes
     const factor = 100; // chunking for faster retrieval
 
-    for (let i = 0; i < doneJobsOrder.length && bytes < bytesLimit; i += factor) {
+    for (
+      let i = 0;
+      i < doneJobsOrder.length && bytes < bytesLimit;
+      i += factor
+    ) {
       // get current chunk and retrieve jobs
-      const currentIDs = doneJobsOrder.slice(i, i+factor);
+      const currentIDs = doneJobsOrder.slice(i, i + factor);
       const jobs = await getJobs(currentIDs);
 
       // iterate through jobs and add them one them one to the byte counter
@@ -101,12 +150,16 @@ export async function crawlStatusController(req: RequestWithAuth<CrawlStatusPara
         const job = jobs[ii];
         const state = await job.getState();
 
-        if (state === "failed" || state === "active") { // TODO: why is active here? race condition? shouldn't matter tho - MG
+        if (state === "failed" || state === "active") {
+          // TODO: why is active here? race condition? shouldn't matter tho - MG
           continue;
         }
 
         if (job.returnvalue === undefined) {
-          logger.warn("Job was considered done, but returnvalue is undefined!", { jobId: job.id, state });
+          logger.warn(
+            "Job was considered done, but returnvalue is undefined!",
+            { jobId: job.id, state }
+          );
           continue;
         }
         doneJobs.push(job);
@@ -119,13 +172,21 @@ export async function crawlStatusController(req: RequestWithAuth<CrawlStatusPara
       doneJobs.splice(doneJobs.length - 1, 1);
     }
   } else {
-    doneJobs = (await Promise.all((await getJobs(doneJobsOrder)).map(async x => (await x.getState()) === "failed" ? null : x))).filter(x => x !== null) as Job[];
+    doneJobs = (
+      await Promise.all(
+        (await getJobs(doneJobsOrder)).map(async (x) =>
+          (await x.getState()) === "failed" ? null : x
+        )
+      )
+    ).filter((x) => x !== null) as Job[];
   }
 
-  const data = doneJobs.map(x => x.returnvalue);
+  const data = doneJobs.map((x) => x.returnvalue);
 
   const protocol = process.env.ENV === "local" ? req.protocol : "https";
-  const nextURL = new URL(`${protocol}://${req.get("host")}/v1/${isBatch ? "batch/scrape" : "crawl"}/${req.params.jobId}`);
+  const nextURL = new URL(
+    `${protocol}://${req.get("host")}/v1/${isBatch ? "batch/scrape" : "crawl"}/${req.params.jobId}`
+  );
 
   nextURL.searchParams.set("skip", (start + data.length).toString());
 
@@ -151,10 +212,9 @@ export async function crawlStatusController(req: RequestWithAuth<CrawlStatusPara
     creditsUsed: jobIDs.length,
     expiresAt: (await getCrawlExpiry(req.params.jobId)).toISOString(),
     next:
-      status !== "scraping" && (start + data.length) === doneJobsLength // if there's not gonna be any documents after this
+      status !== "scraping" && start + data.length === doneJobsLength // if there's not gonna be any documents after this
         ? undefined
         : nextURL.href,
-    data: data,
+    data: data
   });
 }
-

apps/api/src/controllers/v1/crawl.ts

@@ -5,7 +5,7 @@ import {
   crawlRequestSchema,
   CrawlResponse,
   RequestWithAuth,
-  toLegacyCrawlerOptions,
+  toLegacyCrawlerOptions
 } from "./types";
 import {
   addCrawlJob,
@@ -14,7 +14,7 @@ import {
   lockURL,
   lockURLs,
   saveCrawl,
-  StoredCrawl,
+  StoredCrawl
 } from "../../lib/crawl-redis";
 import { logCrawl } from "../../services/logging/crawl_log";
 import { getScrapeQueue } from "../../services/queue-service";
@@ -32,21 +32,31 @@ export async function crawlController(
   req.body = crawlRequestSchema.parse(req.body);
 
   const id = uuidv4();
-  const logger = _logger.child({ crawlId: id, module: "api/v1", method: "crawlController", teamId: req.auth.team_id, plan: req.auth.plan });
+  const logger = _logger.child({
-  logger.debug("Crawl " + id + " starting", { request: req.body, originalRequest: preNormalizedBody, account: req.account });
+    crawlId: id,
+    module: "api/v1",
+    method: "crawlController",
+    teamId: req.auth.team_id,
+    plan: req.auth.plan
+  });
+  logger.debug("Crawl " + id + " starting", {
+    request: req.body,
+    originalRequest: preNormalizedBody,
+    account: req.account
+  });
 
   await logCrawl(id, req.auth.team_id);
 
   let { remainingCredits } = req.account!;
-  const useDbAuthentication = process.env.USE_DB_AUTHENTICATION === 'true';
+  const useDbAuthentication = process.env.USE_DB_AUTHENTICATION === "true";
-  if(!useDbAuthentication){
+  if (!useDbAuthentication) {
     remainingCredits = Infinity;
   }
 
   const crawlerOptions = {
     ...req.body,
     url: undefined,
-    scrapeOptions: undefined,
+    scrapeOptions: undefined
   };
   const scrapeOptions = req.body.scrapeOptions;
 
@@ -73,8 +83,12 @@ export async function crawlController(
 
   const originalLimit = crawlerOptions.limit;
   crawlerOptions.limit = Math.min(remainingCredits, crawlerOptions.limit);
-  logger.debug("Determined limit: " + crawlerOptions.limit, { remainingCredits, bodyLimit: originalLimit, originalBodyLimit: preNormalizedBody.limit });
+  logger.debug("Determined limit: " + crawlerOptions.limit, {
-  
+    remainingCredits,
+    bodyLimit: originalLimit,
+    originalBodyLimit: preNormalizedBody.limit
+  });
+
   const sc: StoredCrawl = {
     originUrl: req.body.url,
     crawlerOptions: toLegacyCrawlerOptions(crawlerOptions),
@@ -82,7 +96,7 @@ export async function crawlController(
     internalOptions: { disableSmartWaitCache: true }, // NOTE: smart wait disabled for crawls to ensure contentful scrape, speed does not matter
     team_id: req.auth.team_id,
     createdAt: Date.now(),
-    plan: req.auth.plan,
+    plan: req.auth.plan
   };
 
   const crawler = crawlToCrawler(id, sc);
@@ -90,7 +104,9 @@ export async function crawlController(
   try {
     sc.robots = await crawler.getRobotsTxt(scrapeOptions.skipTlsVerification);
   } catch (e) {
-    logger.debug("Failed to get robots.txt (this is probably fine!)", { error: e });
+    logger.debug("Failed to get robots.txt (this is probably fine!)", {
+      error: e
+    });
   }
 
   await saveCrawl(id, sc);
@@ -98,15 +114,21 @@ export async function crawlController(
   const sitemap = sc.crawlerOptions.ignoreSitemap
     ? null
     : await crawler.tryGetSitemap();
-  
+
   if (sitemap !== null && sitemap.length > 0) {
-    logger.debug("Using sitemap of length " + sitemap.length, { sitemapLength: sitemap.length });
+    logger.debug("Using sitemap of length " + sitemap.length, {
+      sitemapLength: sitemap.length
+    });
     let jobPriority = 20;
     // If it is over 1000, we need to get the job priority,
     // otherwise we can use the default priority of 20
-    if(sitemap.length > 1000){
+    if (sitemap.length > 1000) {
       // set base to 21
-      jobPriority = await getJobPriority({plan: req.auth.plan, team_id: req.auth.team_id, basePriority: 21})
+      jobPriority = await getJobPriority({
+        plan: req.auth.plan,
+        team_id: req.auth.team_id,
+        basePriority: 21
+      });
     }
     logger.debug("Using job priority " + jobPriority, { jobPriority });
 
@@ -127,14 +149,14 @@ export async function crawlController(
           crawl_id: id,
           sitemapped: true,
           webhook: req.body.webhook,
-          v1: true,
+          v1: true
         },
         opts: {
           jobId: uuid,
-          priority: 20,
+          priority: 20
-        },
+        }
       };
-    })
+    });
 
     logger.debug("Locking URLs...");
     await lockURLs(
@@ -150,7 +172,9 @@ export async function crawlController(
     logger.debug("Adding scrape jobs to BullMQ...");
     await getScrapeQueue().addBulk(jobs);
   } else {
-    logger.debug("Sitemap not found or ignored.", { ignoreSitemap: sc.crawlerOptions.ignoreSitemap });
+    logger.debug("Sitemap not found or ignored.", {
+      ignoreSitemap: sc.crawlerOptions.ignoreSitemap
+    });
 
     logger.debug("Locking URL...");
     await lockURL(id, sc, req.body.url);
@@ -168,30 +192,37 @@ export async function crawlController(
         origin: "api",
         crawl_id: id,
         webhook: req.body.webhook,
-        v1: true,
+        v1: true
       },
       {
-        priority: 15,
+        priority: 15
       },
-      jobId,
+      jobId
     );
     logger.debug("Adding scrape job to BullMQ...", { jobId });
     await addCrawlJob(id, jobId);
   }
   logger.debug("Done queueing jobs!");
 
-  if(req.body.webhook) {
+  if (req.body.webhook) {
-    logger.debug("Calling webhook with crawl.started...", { webhook: req.body.webhook });
+    logger.debug("Calling webhook with crawl.started...", {
-    await callWebhook(req.auth.team_id, id, null, req.body.webhook, true, "crawl.started");
+      webhook: req.body.webhook
+    });
+    await callWebhook(
+      req.auth.team_id,
+      id,
+      null,
+      req.body.webhook,
+      true,
+      "crawl.started"
+    );
   }
 
   const protocol = process.env.ENV === "local" ? req.protocol : "https";
-  
+
   return res.status(200).json({
     success: true,
     id,
-    url: `${protocol}://${req.get("host")}/v1/crawl/${id}`,
+    url: `${protocol}://${req.get("host")}/v1/crawl/${id}`
   });
 }
-
-

apps/api/src/controllers/v1/extract.ts

@@ -6,7 +6,7 @@ import {
   extractRequestSchema,
   ExtractResponse,
   MapDocument,
-  scrapeOptions,
+  scrapeOptions
 } from "./types";
 import { Document } from "../../lib/entities";
 import Redis from "ioredis";
@@ -46,7 +46,7 @@ export async function extractController(
   res: Response<ExtractResponse>
 ) {
   const selfHosted = process.env.USE_DB_AUTHENTICATION !== "true";
-  
+
   req.body = extractRequestSchema.parse(req.body);
 
   const id = crypto.randomUUID();
@@ -56,17 +56,19 @@ export async function extractController(
 
   // Process all URLs in parallel
   const urlPromises = req.body.urls.map(async (url) => {
-    if (url.includes('/*') || req.body.allowExternalLinks) {
+    if (url.includes("/*") || req.body.allowExternalLinks) {
       // Handle glob pattern URLs
-      const baseUrl = url.replace('/*', '');
+      const baseUrl = url.replace("/*", "");
       // const pathPrefix = baseUrl.split('/').slice(3).join('/'); // Get path after domain if any
 
       const allowExternalLinks = req.body.allowExternalLinks ?? true;
       let urlWithoutWww = baseUrl.replace("www.", "");
-      let mapUrl = req.body.prompt && allowExternalLinks
+      let mapUrl =
-        ? `${req.body.prompt} ${urlWithoutWww}`
+        req.body.prompt && allowExternalLinks
-        : req.body.prompt ? `${req.body.prompt} site:${urlWithoutWww}`
+          ? `${req.body.prompt} ${urlWithoutWww}`
-        : `site:${urlWithoutWww}`;
+          : req.body.prompt
+            ? `${req.body.prompt} site:${urlWithoutWww}`
+            : `site:${urlWithoutWww}`;
 
       const mapResults = await getMapResults({
         url: baseUrl,
@@ -79,15 +81,17 @@ export async function extractController(
         // If we're self-hosted, we don't want to ignore the sitemap, due to our fire-engine mapping
         ignoreSitemap: !selfHosted ? true : false,
         includeMetadata: true,
-        includeSubdomains: req.body.includeSubdomains,
+        includeSubdomains: req.body.includeSubdomains
       });
 
       let mappedLinks = mapResults.links as MapDocument[];
       // Limit number of links to MAX_EXTRACT_LIMIT
       mappedLinks = mappedLinks.slice(0, MAX_EXTRACT_LIMIT);
 
-      let mappedLinksRerank = mappedLinks.map(x => `url: ${x.url}, title: ${x.title}, description: ${x.description}`);
+      let mappedLinksRerank = mappedLinks.map(
-      
+        (x) => `url: ${x.url}, title: ${x.title}, description: ${x.description}`
+      );
+
       // Filter by path prefix if present
       // wrong
       // if (pathPrefix) {
@@ -96,32 +100,50 @@ export async function extractController(
 
       if (req.body.prompt) {
         // Get similarity scores between the search query and each link's context
-        const linksAndScores = await performRanking(mappedLinksRerank, mappedLinks.map(l => l.url), mapUrl);
+        const linksAndScores = await performRanking(
-        
+          mappedLinksRerank,
+          mappedLinks.map((l) => l.url),
+          mapUrl
+        );
+
         // First try with high threshold
-        let filteredLinks = filterAndProcessLinks(mappedLinks, linksAndScores, INITIAL_SCORE_THRESHOLD);
+        let filteredLinks = filterAndProcessLinks(
-        
+          mappedLinks,
+          linksAndScores,
+          INITIAL_SCORE_THRESHOLD
+        );
+
         // If we don't have enough high-quality links, try with lower threshold
         if (filteredLinks.length < MIN_REQUIRED_LINKS) {
-          logger.info(`Only found ${filteredLinks.length} links with score > ${INITIAL_SCORE_THRESHOLD}. Trying lower threshold...`);
+          logger.info(
-          filteredLinks = filterAndProcessLinks(mappedLinks, linksAndScores, FALLBACK_SCORE_THRESHOLD);
+            `Only found ${filteredLinks.length} links with score > ${INITIAL_SCORE_THRESHOLD}. Trying lower threshold...`
-          
+          );
+          filteredLinks = filterAndProcessLinks(
+            mappedLinks,
+            linksAndScores,
+            FALLBACK_SCORE_THRESHOLD
+          );
+
           if (filteredLinks.length === 0) {
             // If still no results, take top N results regardless of score
-            logger.warn(`No links found with score > ${FALLBACK_SCORE_THRESHOLD}. Taking top ${MIN_REQUIRED_LINKS} results.`);
+            logger.warn(
+              `No links found with score > ${FALLBACK_SCORE_THRESHOLD}. Taking top ${MIN_REQUIRED_LINKS} results.`
+            );
             filteredLinks = linksAndScores
               .sort((a, b) => b.score - a.score)
               .slice(0, MIN_REQUIRED_LINKS)
-              .map(x => mappedLinks.find(link => link.url === x.link))
+              .map((x) => mappedLinks.find((link) => link.url === x.link))
-              .filter((x): x is MapDocument => x !== undefined && x.url !== undefined && !isUrlBlocked(x.url));
+              .filter(
+                (x): x is MapDocument =>
+                  x !== undefined && x.url !== undefined && !isUrlBlocked(x.url)
+              );
           }
         }
 
         mappedLinks = filteredLinks.slice(0, MAX_RANKING_LIMIT);
       }
 
-      return mappedLinks.map(x => x.url) as string[];
+      return mappedLinks.map((x) => x.url) as string[];
-
     } else {
       // Handle direct URLs without glob pattern
       if (!isUrlBlocked(url)) {
@@ -138,7 +160,8 @@ export async function extractController(
   if (links.length === 0) {
     return res.status(400).json({
       success: false,
-      error: "No valid URLs found to scrape. Try adjusting your search criteria or including more URLs."
+      error:
+        "No valid URLs found to scrape. Try adjusting your search criteria or including more URLs."
     });
   }
 
@@ -151,19 +174,19 @@ export async function extractController(
     const jobPriority = await getJobPriority({
       plan: req.auth.plan as PlanType,
       team_id: req.auth.team_id,
-      basePriority: 10,
+      basePriority: 10
     });
 
     await addScrapeJob(
       {
         url,
-        mode: "single_urls", 
+        mode: "single_urls",
         team_id: req.auth.team_id,
         scrapeOptions: scrapeOptions.parse({}),
         internalOptions: {},
         plan: req.auth.plan!,
         origin,
-        is_scrape: true,
+        is_scrape: true
       },
       {},
       jobId,
@@ -179,7 +202,10 @@ export async function extractController(
       return doc;
     } catch (e) {
       logger.error(`Error in scrapeController: ${e}`);
-      if (e instanceof Error && (e.message.startsWith("Job wait") || e.message === "timeout")) {
+      if (
+        e instanceof Error &&
+        (e.message.startsWith("Job wait") || e.message === "timeout")
+      ) {
         throw {
           status: 408,
           error: "Request timed out"
@@ -187,7 +213,7 @@ export async function extractController(
       } else {
         throw {
           status: 500,
-          error: `(Internal server error) - ${(e && e.message) ? e.message : e}`
+          error: `(Internal server error) - ${e && e.message ? e.message : e}`
         };
       }
     }
@@ -195,7 +221,7 @@ export async function extractController(
 
   try {
     const results = await Promise.all(scrapePromises);
-    docs.push(...results.filter(doc => doc !== null).map(x => x!));
+    docs.push(...results.filter((doc) => doc !== null).map((x) => x!));
   } catch (e) {
     return res.status(e.status).json({
       success: false,
@@ -207,20 +233,26 @@ export async function extractController(
     logger.child({ method: "extractController/generateOpenAICompletions" }),
     {
       mode: "llm",
-      systemPrompt: "Always prioritize using the provided content to answer the question. Do not make up an answer. Be concise and follow the schema if provided. Here are the urls the user provided of which he wants to extract information from: " + links.join(", "),
+      systemPrompt:
+        "Always prioritize using the provided content to answer the question. Do not make up an answer. Be concise and follow the schema if provided. Here are the urls the user provided of which he wants to extract information from: " +
+        links.join(", "),
       prompt: req.body.prompt,
-      schema: req.body.schema,
+      schema: req.body.schema
     },
-    docs.map(x => buildDocument(x)).join('\n'),
+    docs.map((x) => buildDocument(x)).join("\n"),
     undefined,
     true // isExtractEndpoint
   );
 
   // TODO: change this later
   // While on beta, we're billing 5 credits per link discovered/scraped.
-  billTeam(req.auth.team_id, req.acuc?.sub_id, links.length * 5).catch(error => {
+  billTeam(req.auth.team_id, req.acuc?.sub_id, links.length * 5).catch(
-    logger.error(`Failed to bill team ${req.auth.team_id} for ${links.length * 5} credits: ${error}`);
+    (error) => {
-  });
+      logger.error(
+        `Failed to bill team ${req.auth.team_id} for ${links.length * 5} credits: ${error}`
+      );
+    }
+  );
 
   let data = completions.extract ?? {};
   let warning = completions.warning;
@@ -256,12 +288,20 @@ export async function extractController(
  * @returns The filtered list of links.
  */
 function filterAndProcessLinks(
-  mappedLinks: MapDocument[], 
+  mappedLinks: MapDocument[],
-  linksAndScores: { link: string, linkWithContext: string, score: number, originalIndex: number }[],
+  linksAndScores: {
+    link: string;
+    linkWithContext: string;
+    score: number;
+    originalIndex: number;
+  }[],
   threshold: number
 ): MapDocument[] {
   return linksAndScores
-    .filter(x => x.score > threshold)
+    .filter((x) => x.score > threshold)
-    .map(x => mappedLinks.find(link => link.url === x.link))
+    .map((x) => mappedLinks.find((link) => link.url === x.link))
-    .filter((x): x is MapDocument => x !== undefined && x.url !== undefined && !isUrlBlocked(x.url));
+    .filter(
-}
+      (x): x is MapDocument =>
+        x !== undefined && x.url !== undefined && !isUrlBlocked(x.url)
+    );
+}

apps/api/src/controllers/v1/map.ts

@@ -1,6 +1,11 @@
 import { Response } from "express";
 import { v4 as uuidv4 } from "uuid";
-import { MapDocument, mapRequestSchema, RequestWithAuth, scrapeOptions } from "./types";
+import {
+  MapDocument,
+  mapRequestSchema,
+  RequestWithAuth,
+  scrapeOptions
+} from "./types";
 import { crawlToCrawler, StoredCrawl } from "../../lib/crawl-redis";
 import { MapResponse, MapRequest } from "./types";
 import { configDotenv } from "dotenv";
@@ -8,7 +13,7 @@ import {
   checkAndUpdateURLForMap,
   isSameDomain,
   isSameSubdomain,
-  removeDuplicateUrls,
+  removeDuplicateUrls
 } from "../../lib/validateUrl";
 import { fireEngineMap } from "../../search/fireEngine";
 import { billTeam } from "../../services/billing/credit_billing";
@@ -67,13 +72,13 @@ export async function getMapResults({
     crawlerOptions: {
       ...crawlerOptions,
       limit: crawlerOptions.sitemapOnly ? 10000000 : limit,
-      scrapeOptions: undefined,
+      scrapeOptions: undefined
     },
     scrapeOptions: scrapeOptions.parse({}),
     internalOptions: {},
     team_id: teamId,
     createdAt: Date.now(),
-    plan: plan,
+    plan: plan
   };
 
   const crawler = crawlToCrawler(id, sc);
@@ -85,7 +90,8 @@ export async function getMapResults({
       sitemap.forEach((x) => {
         links.push(x.url);
       });
-      links = links.slice(1)
+      links = links
+        .slice(1)
         .map((x) => {
           try {
             return checkAndUpdateURLForMap(x).url.trim();
@@ -99,13 +105,17 @@ export async function getMapResults({
   } else {
     let urlWithoutWww = url.replace("www.", "");
 
-    let mapUrl = search && allowExternalLinks
+    let mapUrl =
-      ? `${search} ${urlWithoutWww}`
+      search && allowExternalLinks
-      : search ? `${search} site:${urlWithoutWww}`
+        ? `${search} ${urlWithoutWww}`
-      : `site:${url}`;
+        : search
+          ? `${search} site:${urlWithoutWww}`
+          : `site:${url}`;
 
     const resultsPerPage = 100;
-    const maxPages = Math.ceil(Math.min(MAX_FIRE_ENGINE_RESULTS, limit) / resultsPerPage);
+    const maxPages = Math.ceil(
+      Math.min(MAX_FIRE_ENGINE_RESULTS, limit) / resultsPerPage
+    );
 
     const cacheKey = `fireEngineMap:${mapUrl}`;
     const cachedResult = await redis.get(cacheKey);
@@ -119,7 +129,7 @@ export async function getMapResults({
       const fetchPage = async (page: number) => {
         return fireEngineMap(mapUrl, {
           numResults: resultsPerPage,
-          page: page,
+          page: page
         });
       };
 
@@ -134,7 +144,7 @@ export async function getMapResults({
     // Parallelize sitemap fetch with serper search
     const [sitemap, ...searchResults] = await Promise.all([
       ignoreSitemap ? null : crawler.tryGetSitemap(true),
-      ...(cachedResult ? [] : pagePromises),
+      ...(cachedResult ? [] : pagePromises)
     ]);
 
     if (!cachedResult) {
@@ -162,7 +172,7 @@ export async function getMapResults({
         links = [
           mapResults[0].url,
           ...mapResults.slice(1).map((x) => x.url),
-          ...links,
+          ...links
         ];
       } else {
         mapResults.map((x) => {
@@ -199,14 +209,16 @@ export async function getMapResults({
     links = removeDuplicateUrls(links);
   }
 
-  const linksToReturn = crawlerOptions.sitemapOnly ? links : links.slice(0, limit);
+  const linksToReturn = crawlerOptions.sitemapOnly
+    ? links
+    : links.slice(0, limit);
 
   return {
     success: true,
     links: includeMetadata ? mapResults : linksToReturn,
     scrape_id: origin?.includes("website") ? id : undefined,
     job_id: id,
-    time_taken: (new Date().getTime() - Date.now()) / 1000,
+    time_taken: (new Date().getTime() - Date.now()) / 1000
   };
 }
 
@@ -225,7 +237,7 @@ export async function mapController(
     crawlerOptions: req.body,
     origin: req.body.origin,
     teamId: req.auth.team_id,
-    plan: req.auth.plan,
+    plan: req.auth.plan
   });
 
   // Bill the team
@@ -244,12 +256,12 @@ export async function mapController(
     docs: result.links,
     time_taken: result.time_taken,
     team_id: req.auth.team_id,
-    mode: "map", 
+    mode: "map",
     url: req.body.url,
     crawlerOptions: {},
     scrapeOptions: {},
     origin: req.body.origin ?? "api",
-    num_tokens: 0,
+    num_tokens: 0
   });
 
   const response = {
@@ -259,4 +271,4 @@ export async function mapController(
   };
 
   return res.status(200).json(response);
-}
+}

apps/api/src/controllers/v1/scrape-status.ts

@@ -12,30 +12,30 @@ export async function scrapeStatusController(req: any, res: any) {
 
     const job = await supabaseGetJobByIdOnlyData(req.params.jobId);
     const allowedTeams = [
-      "41bdbfe1-0579-4d9b-b6d5-809f16be12f5", 
+      "41bdbfe1-0579-4d9b-b6d5-809f16be12f5",
       "511544f2-2fce-4183-9c59-6c29b02c69b5"
     ];
 
-    if(!allowedTeams.includes(job?.team_id)){
+    if (!allowedTeams.includes(job?.team_id)) {
       return res.status(403).json({
         success: false,
-        error: "You are not allowed to access this resource.",
+        error: "You are not allowed to access this resource."
       });
     }
     return res.status(200).json({
       success: true,
-      data: job?.docs[0],
+      data: job?.docs[0]
     });
   } catch (error) {
     if (error instanceof Error && error.message == "Too Many Requests") {
       return res.status(429).json({
         success: false,
-        error: "Rate limit exceeded. Please try again later.",
+        error: "Rate limit exceeded. Please try again later."
       });
     } else {
       return res.status(500).json({
         success: false,
-        error: "An unexpected error occurred.",
+        error: "An unexpected error occurred."
       });
     }
   }

apps/api/src/controllers/v1/scrape.ts

@@ -5,7 +5,7 @@ import {
   RequestWithAuth,
   ScrapeRequest,
   scrapeRequestSchema,
-  ScrapeResponse,
+  ScrapeResponse
 } from "./types";
 import { billTeam } from "../../services/billing/credit_billing";
 import { v4 as uuidv4 } from "uuid";
@@ -30,7 +30,7 @@ export async function scrapeController(
   const jobPriority = await getJobPriority({
     plan: req.auth.plan as PlanType,
     team_id: req.auth.team_id,
-    basePriority: 10,
+    basePriority: 10
   });
 
   await addScrapeJob(
@@ -42,29 +42,37 @@ export async function scrapeController(
       internalOptions: {},
       plan: req.auth.plan!,
       origin: req.body.origin,
-      is_scrape: true,
+      is_scrape: true
     },
     {},
     jobId,
     jobPriority
   );
 
-  const totalWait = (req.body.waitFor ?? 0) + (req.body.actions ?? []).reduce((a,x) => (x.type === "wait" ? x.milliseconds ?? 0 : 0) + a, 0);
+  const totalWait =
+    (req.body.waitFor ?? 0) +
+    (req.body.actions ?? []).reduce(
+      (a, x) => (x.type === "wait" ? (x.milliseconds ?? 0) : 0) + a,
+      0
+    );
 
   let doc: Document;
   try {
     doc = await waitForJob<Document>(jobId, timeout + totalWait); // TODO: better types for this
   } catch (e) {
     logger.error(`Error in scrapeController: ${e}`);
-    if (e instanceof Error && (e.message.startsWith("Job wait") || e.message === "timeout")) {
+    if (
+      e instanceof Error &&
+      (e.message.startsWith("Job wait") || e.message === "timeout")
+    ) {
       return res.status(408).json({
         success: false,
-        error: "Request timed out",
+        error: "Request timed out"
       });
     } else {
       return res.status(500).json({
         success: false,
-        error: `(Internal server error) - ${(e && e.message) ? e.message : e}`,
+        error: `(Internal server error) - ${e && e.message ? e.message : e}`
       });
     }
   }
@@ -75,8 +83,8 @@ export async function scrapeController(
   const timeTakenInSeconds = (endTime - startTime) / 1000;
   const numTokens =
     doc && doc.extract
-      // ? numTokensFromString(doc.markdown, "gpt-3.5-turbo")
+      ? // ? numTokensFromString(doc.markdown, "gpt-3.5-turbo")
-      ? 0 // TODO: fix
+        0 // TODO: fix
       : 0;
 
   let creditsToBeBilled = 1; // Assuming 1 credit per document
@@ -84,14 +92,18 @@ export async function scrapeController(
     // Don't bill if we're early returning
     return;
   }
-  if(req.body.extract && req.body.formats.includes("extract")) {
+  if (req.body.extract && req.body.formats.includes("extract")) {
     creditsToBeBilled = 5;
   }
 
-  billTeam(req.auth.team_id, req.acuc?.sub_id, creditsToBeBilled).catch(error => {
+  billTeam(req.auth.team_id, req.acuc?.sub_id, creditsToBeBilled).catch(
-    logger.error(`Failed to bill team ${req.auth.team_id} for ${creditsToBeBilled} credits: ${error}`);
+    (error) => {
-    // Optionally, you could notify an admin or add to a retry queue here
+      logger.error(
-  });
+        `Failed to bill team ${req.auth.team_id} for ${creditsToBeBilled} credits: ${error}`
+      );
+      // Optionally, you could notify an admin or add to a retry queue here
+    }
+  );
 
   if (!req.body.formats.includes("rawHtml")) {
     if (doc && doc.rawHtml) {
@@ -111,12 +123,12 @@ export async function scrapeController(
     url: req.body.url,
     scrapeOptions: req.body,
     origin: origin,
-    num_tokens: numTokens,
+    num_tokens: numTokens
   });
 
   return res.status(200).json({
     success: true,
     data: doc,
-    scrape_id: origin?.includes("website") ? jobId : undefined,
+    scrape_id: origin?.includes("website") ? jobId : undefined
   });
 }

apps/api/src/controllers/v1/types.ts

@@ -4,7 +4,12 @@ import { isUrlBlocked } from "../../scraper/WebScraper/utils/blocklist";
 import { protocolIncluded, checkUrl } from "../../lib/validateUrl";
 import { PlanType } from "../../types";
 import { countries } from "../../lib/validate-country";
-import { ExtractorOptions, PageOptions, ScrapeActionContent, Document as V0Document } from "../../lib/entities";
+import {
+  ExtractorOptions,
+  PageOptions,
+  ScrapeActionContent,
+  Document as V0Document
+} from "../../lib/entities";
 import { InternalOptions } from "../../scraper/scrapeURL";
 
 export type Format =
@@ -31,212 +36,265 @@ export const url = z.preprocess(
       (x) => /\.[a-z]{2,}([\/?#]|$)/i.test(x),
       "URL must have a valid top-level domain or be a valid path"
     )
-    .refine(
+    .refine((x) => {
-      (x) => {
+      try {
-        try {
+        checkUrl(x as string);
-          checkUrl(x as string)
+        return true;
-          return true;
+      } catch (_) {
-        } catch (_) {
+        return false;
-          return false;
+      }
-        }
+    }, "Invalid URL")
-      },
-      "Invalid URL"
-    )
     .refine(
       (x) => !isUrlBlocked(x as string),
       "Firecrawl currently does not support social media scraping due to policy restrictions. We're actively working on building support for it."
     )
 );
 
-const strictMessage = "Unrecognized key in body -- please review the v1 API documentation for request body changes";
+const strictMessage =
+  "Unrecognized key in body -- please review the v1 API documentation for request body changes";
 
-export const extractOptions = z.object({
+export const extractOptions = z
-  mode: z.enum(["llm"]).default("llm"),
+  .object({
-  schema: z.any().optional(),
+    mode: z.enum(["llm"]).default("llm"),
-  systemPrompt: z.string().default("Based on the information on the page, extract all the information from the schema in JSON format. Try to extract all the fields even those that might not be marked as required."),
+    schema: z.any().optional(),
-  prompt: z.string().optional()
+    systemPrompt: z
-}).strict(strictMessage);
+      .string()
+      .default(
+        "Based on the information on the page, extract all the information from the schema in JSON format. Try to extract all the fields even those that might not be marked as required."
+      ),
+    prompt: z.string().optional()
+  })
+  .strict(strictMessage);
 
 export type ExtractOptions = z.infer<typeof extractOptions>;
 
-export const actionsSchema = z.array(z.union([
+export const actionsSchema = z.array(
-  z.object({
+  z.union([
-    type: z.literal("wait"),
+    z
-    milliseconds: z.number().int().positive().finite().optional(),
+      .object({
-    selector: z.string().optional(),
+        type: z.literal("wait"),
-  }).refine(
+        milliseconds: z.number().int().positive().finite().optional(),
-    (data) => (data.milliseconds !== undefined || data.selector !== undefined) && !(data.milliseconds !== undefined && data.selector !== undefined),
+        selector: z.string().optional()
-    {
+      })
-      message: "Either 'milliseconds' or 'selector' must be provided, but not both.",
+      .refine(
-    }
+        (data) =>
-  ),
+          (data.milliseconds !== undefined || data.selector !== undefined) &&
-  z.object({
+          !(data.milliseconds !== undefined && data.selector !== undefined),
-    type: z.literal("click"),
+        {
-    selector: z.string(),
+          message:
-  }),
+            "Either 'milliseconds' or 'selector' must be provided, but not both."
-  z.object({
+        }
-    type: z.literal("screenshot"),
+      ),
-    fullPage: z.boolean().default(false),
+    z.object({
-  }),
+      type: z.literal("click"),
-  z.object({
+      selector: z.string()
-    type: z.literal("write"),
+    }),
-    text: z.string(),
+    z.object({
-  }),
+      type: z.literal("screenshot"),
-  z.object({
+      fullPage: z.boolean().default(false)
-    type: z.literal("press"),
+    }),
-    key: z.string(),
+    z.object({
-  }),
+      type: z.literal("write"),
-  z.object({
+      text: z.string()
-    type: z.literal("scroll"),
+    }),
-    direction: z.enum(["up", "down"]).optional().default("down"),
+    z.object({
-    selector: z.string().optional(),
+      type: z.literal("press"),
-  }),
+      key: z.string()
-  z.object({
+    }),
-    type: z.literal("scrape"),
+    z.object({
-  }),
+      type: z.literal("scroll"),
-  z.object({
+      direction: z.enum(["up", "down"]).optional().default("down"),
-    type: z.literal("executeJavascript"),
+      selector: z.string().optional()
-    script: z.string()
+    }),
-  }),
+    z.object({
-]));
+      type: z.literal("scrape")
-
+    }),
-export const scrapeOptions = z.object({
+    z.object({
-  formats: z
+      type: z.literal("executeJavascript"),
-    .enum([
+      script: z.string()
-      "markdown",
+    })
-      "html",
+  ])
-      "rawHtml",
+);
-      "links",
-      "screenshot",
-      "screenshot@fullPage",
-      "extract"
-    ])
-    .array()
-    .optional()
-    .default(["markdown"])
-    .refine(x => !(x.includes("screenshot") && x.includes("screenshot@fullPage")), "You may only specify either screenshot or screenshot@fullPage"),
-  headers: z.record(z.string(), z.string()).optional(),
-  includeTags: z.string().array().optional(),
-  excludeTags: z.string().array().optional(),
-  onlyMainContent: z.boolean().default(true),
-  timeout: z.number().int().positive().finite().safe().optional(),
-  waitFor: z.number().int().nonnegative().finite().safe().default(0),
-  extract: extractOptions.optional(),
-  mobile: z.boolean().default(false),
-  parsePDF: z.boolean().default(true),
-  actions: actionsSchema.optional(),
-  // New
-  location: z.object({
-    country: z.string().optional().refine(
-      (val) => !val || Object.keys(countries).includes(val.toUpperCase()),
-      {
-        message: "Invalid country code. Please use a valid ISO 3166-1 alpha-2 country code.",
-      }
-    ).transform(val => val ? val.toUpperCase() : 'US'),
-    languages: z.string().array().optional(),
-  }).optional(),
-  
-  // Deprecated
-  geolocation: z.object({
-    country: z.string().optional().refine(
-      (val) => !val || Object.keys(countries).includes(val.toUpperCase()),
-      {
-        message: "Invalid country code. Please use a valid ISO 3166-1 alpha-2 country code.",
-      }
-    ).transform(val => val ? val.toUpperCase() : 'US'),
-    languages: z.string().array().optional(),
-  }).optional(),
-  skipTlsVerification: z.boolean().default(false),
-  removeBase64Images: z.boolean().default(true),
-}).strict(strictMessage)
 
+export const scrapeOptions = z
+  .object({
+    formats: z
+      .enum([
+        "markdown",
+        "html",
+        "rawHtml",
+        "links",
+        "screenshot",
+        "screenshot@fullPage",
+        "extract"
+      ])
+      .array()
+      .optional()
+      .default(["markdown"])
+      .refine(
+        (x) => !(x.includes("screenshot") && x.includes("screenshot@fullPage")),
+        "You may only specify either screenshot or screenshot@fullPage"
+      ),
+    headers: z.record(z.string(), z.string()).optional(),
+    includeTags: z.string().array().optional(),
+    excludeTags: z.string().array().optional(),
+    onlyMainContent: z.boolean().default(true),
+    timeout: z.number().int().positive().finite().safe().optional(),
+    waitFor: z.number().int().nonnegative().finite().safe().default(0),
+    extract: extractOptions.optional(),
+    mobile: z.boolean().default(false),
+    parsePDF: z.boolean().default(true),
+    actions: actionsSchema.optional(),
+    // New
+    location: z
+      .object({
+        country: z
+          .string()
+          .optional()
+          .refine(
+            (val) => !val || Object.keys(countries).includes(val.toUpperCase()),
+            {
+              message:
+                "Invalid country code. Please use a valid ISO 3166-1 alpha-2 country code."
+            }
+          )
+          .transform((val) => (val ? val.toUpperCase() : "US")),
+        languages: z.string().array().optional()
+      })
+      .optional(),
 
+    // Deprecated
+    geolocation: z
+      .object({
+        country: z
+          .string()
+          .optional()
+          .refine(
+            (val) => !val || Object.keys(countries).includes(val.toUpperCase()),
+            {
+              message:
+                "Invalid country code. Please use a valid ISO 3166-1 alpha-2 country code."
+            }
+          )
+          .transform((val) => (val ? val.toUpperCase() : "US")),
+        languages: z.string().array().optional()
+      })
+      .optional(),
+    skipTlsVerification: z.boolean().default(false),
+    removeBase64Images: z.boolean().default(true)
+  })
+  .strict(strictMessage);
 
 export type ScrapeOptions = z.infer<typeof scrapeOptions>;
 
-export const extractV1Options = z.object({
+export const extractV1Options = z
-  urls: url.array().max(10, "Maximum of 10 URLs allowed per request while in beta."),
+  .object({
-  prompt: z.string().optional(),
+    urls: url
-  schema: z.any().optional(),
+      .array()
-  limit: z.number().int().positive().finite().safe().optional(),
+      .max(10, "Maximum of 10 URLs allowed per request while in beta."),
-  ignoreSitemap: z.boolean().default(false),
+    prompt: z.string().optional(),
-  includeSubdomains: z.boolean().default(true),
+    schema: z.any().optional(),
-  allowExternalLinks: z.boolean().default(false),
+    limit: z.number().int().positive().finite().safe().optional(),
-  origin: z.string().optional().default("api"),
+    ignoreSitemap: z.boolean().default(false),
-  timeout: z.number().int().positive().finite().safe().default(60000)
+    includeSubdomains: z.boolean().default(true),
-}).strict(strictMessage)
+    allowExternalLinks: z.boolean().default(false),
+    origin: z.string().optional().default("api"),
+    timeout: z.number().int().positive().finite().safe().default(60000)
+  })
+  .strict(strictMessage);
 
 export type ExtractV1Options = z.infer<typeof extractV1Options>;
 export const extractRequestSchema = extractV1Options;
 export type ExtractRequest = z.infer<typeof extractRequestSchema>;
 
-export const scrapeRequestSchema = scrapeOptions.omit({ timeout: true }).extend({
+export const scrapeRequestSchema = scrapeOptions
-  url,
+  .omit({ timeout: true })
-  origin: z.string().optional().default("api"),
+  .extend({
-  timeout: z.number().int().positive().finite().safe().default(30000),
+    url,
-}).strict(strictMessage).refine(
+    origin: z.string().optional().default("api"),
-  (obj) => {
+    timeout: z.number().int().positive().finite().safe().default(30000)
-    const hasExtractFormat = obj.formats?.includes("extract");
+  })
-    const hasExtractOptions = obj.extract !== undefined;
+  .strict(strictMessage)
-    return (hasExtractFormat && hasExtractOptions) || (!hasExtractFormat && !hasExtractOptions);
+  .refine(
-  },
+    (obj) => {
-  {
+      const hasExtractFormat = obj.formats?.includes("extract");
-    message: "When 'extract' format is specified, 'extract' options must be provided, and vice versa",
+      const hasExtractOptions = obj.extract !== undefined;
-  }
+      return (
-).transform((obj) => {
+        (hasExtractFormat && hasExtractOptions) ||
-  if ((obj.formats?.includes("extract") || obj.extract) && !obj.timeout) {
+        (!hasExtractFormat && !hasExtractOptions)
-    return { ...obj, timeout: 60000 };
+      );
-  }
+    },
-  return obj;
+    {
-});
+      message:
-
+        "When 'extract' format is specified, 'extract' options must be provided, and vice versa"
-
+    }
+  )
+  .transform((obj) => {
+    if ((obj.formats?.includes("extract") || obj.extract) && !obj.timeout) {
+      return { ...obj, timeout: 60000 };
+    }
+    return obj;
+  });
 
 export type ScrapeRequest = z.infer<typeof scrapeRequestSchema>;
 export type ScrapeRequestInput = z.input<typeof scrapeRequestSchema>;
 
-export const webhookSchema = z.preprocess(x => {
+export const webhookSchema = z.preprocess(
-  if (typeof x === "string") {
+  (x) => {
-    return { url: x };
+    if (typeof x === "string") {
-  } else {
+      return { url: x };
-    return x;
+    } else {
-  }
+      return x;
-}, z.object({
+    }
-  url: z.string().url(),
-  headers: z.record(z.string(), z.string()).default({}),
-}).strict(strictMessage))
-
-export const batchScrapeRequestSchema = scrapeOptions.extend({
-  urls: url.array(),
-  origin: z.string().optional().default("api"),
-  webhook: webhookSchema.optional(),
-  appendToId: z.string().uuid().optional(),
-}).strict(strictMessage).refine(
-  (obj) => {
-    const hasExtractFormat = obj.formats?.includes("extract");
-    const hasExtractOptions = obj.extract !== undefined;
-    return (hasExtractFormat && hasExtractOptions) || (!hasExtractFormat && !hasExtractOptions);
   },
-  {
+  z
-    message: "When 'extract' format is specified, 'extract' options must be provided, and vice versa",
+    .object({
-  }
+      url: z.string().url(),
+      headers: z.record(z.string(), z.string()).default({})
+    })
+    .strict(strictMessage)
 );
 
+export const batchScrapeRequestSchema = scrapeOptions
+  .extend({
+    urls: url.array(),
+    origin: z.string().optional().default("api"),
+    webhook: webhookSchema.optional(),
+    appendToId: z.string().uuid().optional()
+  })
+  .strict(strictMessage)
+  .refine(
+    (obj) => {
+      const hasExtractFormat = obj.formats?.includes("extract");
+      const hasExtractOptions = obj.extract !== undefined;
+      return (
+        (hasExtractFormat && hasExtractOptions) ||
+        (!hasExtractFormat && !hasExtractOptions)
+      );
+    },
+    {
+      message:
+        "When 'extract' format is specified, 'extract' options must be provided, and vice versa"
+    }
+  );
+
 export type BatchScrapeRequest = z.infer<typeof batchScrapeRequestSchema>;
 
-const crawlerOptions = z.object({
+const crawlerOptions = z
-  includePaths: z.string().array().default([]),
+  .object({
-  excludePaths: z.string().array().default([]),
+    includePaths: z.string().array().default([]),
-  maxDepth: z.number().default(10), // default?
+    excludePaths: z.string().array().default([]),
-  limit: z.number().default(10000), // default?
+    maxDepth: z.number().default(10), // default?
-  allowBackwardLinks: z.boolean().default(false), // >> TODO: CHANGE THIS NAME???
+    limit: z.number().default(10000), // default?
-  allowExternalLinks: z.boolean().default(false),
+    allowBackwardLinks: z.boolean().default(false), // >> TODO: CHANGE THIS NAME???
-  allowSubdomains: z.boolean().default(false),
+    allowExternalLinks: z.boolean().default(false),
-  ignoreRobotsTxt: z.boolean().default(false),
+    allowSubdomains: z.boolean().default(false),
-  ignoreSitemap: z.boolean().default(false),
+    ignoreRobotsTxt: z.boolean().default(false),
-  deduplicateSimilarURLs: z.boolean().default(true),
+    ignoreSitemap: z.boolean().default(false),
-  ignoreQueryParameters: z.boolean().default(false),
+    deduplicateSimilarURLs: z.boolean().default(true),
-}).strict(strictMessage);
+    ignoreQueryParameters: z.boolean().default(false)
+  })
+  .strict(strictMessage);
 
 // export type CrawlerOptions = {
 //   includePaths?: string[];
@@ -250,13 +308,15 @@ const crawlerOptions = z.object({
 
 export type CrawlerOptions = z.infer<typeof crawlerOptions>;
 
-export const crawlRequestSchema = crawlerOptions.extend({
+export const crawlRequestSchema = crawlerOptions
-  url,
+  .extend({
-  origin: z.string().optional().default("api"),
+    url,
-  scrapeOptions: scrapeOptions.default({}),
+    origin: z.string().optional().default("api"),
-  webhook: webhookSchema.optional(),
+    scrapeOptions: scrapeOptions.default({}),
-  limit: z.number().default(10000),
+    webhook: webhookSchema.optional(),
-}).strict(strictMessage);
+    limit: z.number().default(10000)
+  })
+  .strict(strictMessage);
 
 // export type CrawlRequest = {
 //   url: string;
@@ -270,18 +330,19 @@ export const crawlRequestSchema = crawlerOptions.extend({
 //   extractionSchema?: Record<string, any>;
 // }
 
-
 export type CrawlRequest = z.infer<typeof crawlRequestSchema>;
 
-export const mapRequestSchema = crawlerOptions.extend({
+export const mapRequestSchema = crawlerOptions
-  url,
+  .extend({
-  origin: z.string().optional().default("api"),
+    url,
-  includeSubdomains: z.boolean().default(true),
+    origin: z.string().optional().default("api"),
-  search: z.string().optional(),
+    includeSubdomains: z.boolean().default(true),
-  ignoreSitemap: z.boolean().default(false),
+    search: z.string().optional(),
-  sitemapOnly: z.boolean().default(false),
+    ignoreSitemap: z.boolean().default(false),
-  limit: z.number().min(1).max(5000).default(5000),
+    sitemapOnly: z.boolean().default(false),
-}).strict(strictMessage);
+    limit: z.number().min(1).max(5000).default(5000)
+  })
+  .strict(strictMessage);
 
 // export type MapRequest = {
 //   url: string;
@@ -451,7 +512,7 @@ export interface RequestWithMaybeACUC<
   ReqBody = undefined,
   ResBody = undefined
 > extends Request<ReqParams, ReqBody, ResBody> {
-  acuc?: AuthCreditUsageChunk,
+  acuc?: AuthCreditUsageChunk;
 }
 
 export interface RequestWithACUC<
@@ -459,13 +520,13 @@ export interface RequestWithACUC<
   ReqBody = undefined,
   ResBody = undefined
 > extends Request<ReqParams, ReqBody, ResBody> {
-  acuc: AuthCreditUsageChunk,
+  acuc: AuthCreditUsageChunk;
 }
 
 export interface RequestWithAuth<
   ReqParams = {},
   ReqBody = undefined,
-  ResBody = undefined,
+  ResBody = undefined
 > extends Request<ReqParams, ReqBody, ResBody> {
   auth: AuthObject;
   account?: Account;
@@ -483,16 +544,15 @@ export interface RequestWithMaybeAuth<
 export interface RequestWithAuth<
   ReqParams = {},
   ReqBody = undefined,
-  ResBody = undefined,
+  ResBody = undefined
 > extends RequestWithACUC<ReqParams, ReqBody, ResBody> {
   auth: AuthObject;
   account?: Account;
 }
 
-export interface ResponseWithSentry<
+export interface ResponseWithSentry<ResBody = undefined>
-  ResBody = undefined,
+  extends Response<ResBody> {
-> extends Response<ResBody> {
+  sentry?: string;
-  sentry?: string,
 }
 
 export function toLegacyCrawlerOptions(x: CrawlerOptions) {
@@ -509,11 +569,14 @@ export function toLegacyCrawlerOptions(x: CrawlerOptions) {
     ignoreRobotsTxt: x.ignoreRobotsTxt,
     ignoreSitemap: x.ignoreSitemap,
     deduplicateSimilarURLs: x.deduplicateSimilarURLs,
-    ignoreQueryParameters: x.ignoreQueryParameters,
+    ignoreQueryParameters: x.ignoreQueryParameters
   };
 }
 
-export function fromLegacyCrawlerOptions(x: any): { crawlOptions: CrawlerOptions; internalOptions: InternalOptions } {
+export function fromLegacyCrawlerOptions(x: any): {
+  crawlOptions: CrawlerOptions;
+  internalOptions: InternalOptions;
+} {
   return {
     crawlOptions: crawlerOptions.parse({
       includePaths: x.includes,
@@ -526,37 +589,50 @@ export function fromLegacyCrawlerOptions(x: any): { crawlOptions: CrawlerOptions
       ignoreRobotsTxt: x.ignoreRobotsTxt,
       ignoreSitemap: x.ignoreSitemap,
       deduplicateSimilarURLs: x.deduplicateSimilarURLs,
-      ignoreQueryParameters: x.ignoreQueryParameters,
+      ignoreQueryParameters: x.ignoreQueryParameters
     }),
     internalOptions: {
-      v0CrawlOnlyUrls: x.returnOnlyUrls,
+      v0CrawlOnlyUrls: x.returnOnlyUrls
-    },
+    }
   };
 }
 
-
-
 export interface MapDocument {
   url: string;
   title?: string;
   description?: string;
-}   
+}
-export function fromLegacyScrapeOptions(pageOptions: PageOptions, extractorOptions: ExtractorOptions | undefined, timeout: number | undefined): { scrapeOptions: ScrapeOptions, internalOptions: InternalOptions } {
+export function fromLegacyScrapeOptions(
+  pageOptions: PageOptions,
+  extractorOptions: ExtractorOptions | undefined,
+  timeout: number | undefined
+): { scrapeOptions: ScrapeOptions; internalOptions: InternalOptions } {
   return {
     scrapeOptions: scrapeOptions.parse({
       formats: [
-        (pageOptions.includeMarkdown ?? true) ? "markdown" as const : null,
+        (pageOptions.includeMarkdown ?? true) ? ("markdown" as const) : null,
-        (pageOptions.includeHtml ?? false) ? "html" as const : null,
+        (pageOptions.includeHtml ?? false) ? ("html" as const) : null,
-        (pageOptions.includeRawHtml ?? false) ? "rawHtml" as const : null,
+        (pageOptions.includeRawHtml ?? false) ? ("rawHtml" as const) : null,
-        (pageOptions.screenshot ?? false) ? "screenshot" as const : null,
+        (pageOptions.screenshot ?? false) ? ("screenshot" as const) : null,
-        (pageOptions.fullPageScreenshot ?? false) ? "screenshot@fullPage" as const : null,
+        (pageOptions.fullPageScreenshot ?? false)
-        (extractorOptions !== undefined && extractorOptions.mode.includes("llm-extraction")) ? "extract" as const : null,
+          ? ("screenshot@fullPage" as const)
+          : null,
+        extractorOptions !== undefined &&
+        extractorOptions.mode.includes("llm-extraction")
+          ? ("extract" as const)
+          : null,
         "links"
-      ].filter(x => x !== null),
+      ].filter((x) => x !== null),
       waitFor: pageOptions.waitFor,
       headers: pageOptions.headers,
-      includeTags: (typeof pageOptions.onlyIncludeTags === "string" ? [pageOptions.onlyIncludeTags] : pageOptions.onlyIncludeTags),
+      includeTags:
-      excludeTags: (typeof pageOptions.removeTags === "string" ? [pageOptions.removeTags] : pageOptions.removeTags),
+        typeof pageOptions.onlyIncludeTags === "string"
+          ? [pageOptions.onlyIncludeTags]
+          : pageOptions.onlyIncludeTags,
+      excludeTags:
+        typeof pageOptions.removeTags === "string"
+          ? [pageOptions.removeTags]
+          : pageOptions.removeTags,
       onlyMainContent: pageOptions.onlyMainContent ?? false,
       timeout: timeout,
       parsePDF: pageOptions.parsePDF,
@@ -564,29 +640,45 @@ export function fromLegacyScrapeOptions(pageOptions: PageOptions, extractorOptio
       location: pageOptions.geolocation,
       skipTlsVerification: pageOptions.skipTlsVerification,
       removeBase64Images: pageOptions.removeBase64Images,
-      extract: extractorOptions !== undefined && extractorOptions.mode.includes("llm-extraction") ? {
+      extract:
-        systemPrompt: extractorOptions.extractionPrompt,
+        extractorOptions !== undefined &&
-        prompt: extractorOptions.userPrompt,
+        extractorOptions.mode.includes("llm-extraction")
-        schema: extractorOptions.extractionSchema,
+          ? {
-      } : undefined,
+              systemPrompt: extractorOptions.extractionPrompt,
-      mobile: pageOptions.mobile,
+              prompt: extractorOptions.userPrompt,
+              schema: extractorOptions.extractionSchema
+            }
+          : undefined,
+      mobile: pageOptions.mobile
     }),
     internalOptions: {
       atsv: pageOptions.atsv,
       v0DisableJsDom: pageOptions.disableJsDom,
-      v0UseFastMode: pageOptions.useFastMode,
+      v0UseFastMode: pageOptions.useFastMode
-    },
+    }
     // TODO: fallback, fetchPageContent, replaceAllPathsWithAbsolutePaths, includeLinks
-  }
+  };
 }
 
-export function fromLegacyCombo(pageOptions: PageOptions, extractorOptions: ExtractorOptions | undefined, timeout: number | undefined, crawlerOptions: any): { scrapeOptions: ScrapeOptions, internalOptions: InternalOptions} {
+export function fromLegacyCombo(
-  const { scrapeOptions, internalOptions: i1 } = fromLegacyScrapeOptions(pageOptions, extractorOptions, timeout);
+  pageOptions: PageOptions,
+  extractorOptions: ExtractorOptions | undefined,
+  timeout: number | undefined,
+  crawlerOptions: any
+): { scrapeOptions: ScrapeOptions; internalOptions: InternalOptions } {
+  const { scrapeOptions, internalOptions: i1 } = fromLegacyScrapeOptions(
+    pageOptions,
+    extractorOptions,
+    timeout
+  );
   const { internalOptions: i2 } = fromLegacyCrawlerOptions(crawlerOptions);
   return { scrapeOptions, internalOptions: Object.assign(i1, i2) };
 }
 
-export function toLegacyDocument(document: Document, internalOptions: InternalOptions): V0Document | { url: string; } {
+export function toLegacyDocument(
+  document: Document,
+  internalOptions: InternalOptions
+): V0Document | { url: string } {
   if (internalOptions.v0CrawlOnlyUrls) {
     return { url: document.metadata.sourceURL! };
   }
@@ -604,9 +696,9 @@ export function toLegacyDocument(document: Document, internalOptions: InternalOp
       statusCode: undefined,
       pageError: document.metadata.error,
       pageStatusCode: document.metadata.statusCode,
-      screenshot: document.screenshot,
+      screenshot: document.screenshot
     },
-    actions: document.actions ,
+    actions: document.actions,
-    warning: document.warning,
+    warning: document.warning
-  }
+  };
 }

apps/api/src/index.ts

@@ -1,5 +1,5 @@
 import "dotenv/config";
-import "./services/sentry"
+import "./services/sentry";
 import * as Sentry from "@sentry/node";
 import express, { NextFunction, Request, Response } from "express";
 import bodyParser from "body-parser";
@@ -9,9 +9,9 @@ import { v0Router } from "./routes/v0";
 import os from "os";
 import { logger } from "./lib/logger";
 import { adminRouter } from "./routes/admin";
-import http from 'node:http';
+import http from "node:http";
-import https from 'node:https';
+import https from "node:https";
-import CacheableLookup  from 'cacheable-lookup';
+import CacheableLookup from "cacheable-lookup";
 import { v1Router } from "./routes/v1";
 import expressWs from "express-ws";
 import { ErrorResponse, ResponseWithSentry } from "./controllers/v1/types";
@@ -25,14 +25,12 @@ const { ExpressAdapter } = require("@bull-board/express");
 const numCPUs = process.env.ENV === "local" ? 2 : os.cpus().length;
 logger.info(`Number of CPUs: ${numCPUs} available`);
 
-const cacheable = new CacheableLookup()
+const cacheable = new CacheableLookup();
-
 
 // Install cacheable lookup for all other requests
 cacheable.install(http.globalAgent);
 cacheable.install(https.globalAgent);
 
-
 const ws = expressWs(express());
 const app = ws.app;
 
@@ -48,7 +46,7 @@ serverAdapter.setBasePath(`/admin/${process.env.BULL_AUTH_KEY}/queues`);
 
 const { addQueue, removeQueue, setQueues, replaceQueues } = createBullBoard({
   queues: [new BullAdapter(getScrapeQueue())],
-  serverAdapter: serverAdapter,
+  serverAdapter: serverAdapter
 });
 
 app.use(
@@ -82,15 +80,15 @@ function startServer(port = DEFAULT_PORT) {
   });
 
   const exitHandler = () => {
-    logger.info('SIGTERM signal received: closing HTTP server')
+    logger.info("SIGTERM signal received: closing HTTP server");
     server.close(() => {
       logger.info("Server closed.");
       process.exit(0);
     });
   };
 
-  process.on('SIGTERM', exitHandler);
+  process.on("SIGTERM", exitHandler);
-  process.on('SIGINT', exitHandler);
+  process.on("SIGINT", exitHandler);
   return server;
 }
 
@@ -101,13 +99,11 @@ if (require.main === module) {
 app.get(`/serverHealthCheck`, async (req, res) => {
   try {
     const scrapeQueue = getScrapeQueue();
-    const [waitingJobs] = await Promise.all([
+    const [waitingJobs] = await Promise.all([scrapeQueue.getWaitingCount()]);
-      scrapeQueue.getWaitingCount(),
-    ]);
     const noWaitingJobs = waitingJobs === 0;
     // 200 if no active jobs, 503 if there are active jobs
     return res.status(noWaitingJobs ? 200 : 500).json({
-      waitingJobs,
+      waitingJobs
     });
   } catch (error) {
     Sentry.captureException(error);
@@ -124,7 +120,7 @@ app.get("/serverHealthCheck/notify", async (req, res) => {
     const getWaitingJobsCount = async () => {
       const scrapeQueue = getScrapeQueue();
       const [waitingJobsCount] = await Promise.all([
-        scrapeQueue.getWaitingCount(),
+        scrapeQueue.getWaitingCount()
       ]);
 
       return waitingJobsCount;
@@ -144,15 +140,15 @@ app.get("/serverHealthCheck/notify", async (req, res) => {
               const message = {
                 text: `⚠️ Warning: The number of active jobs (${waitingJobsCount}) has exceeded the threshold (${treshold}) for more than ${
                   timeout / 60000
-                } minute(s).`,
+                } minute(s).`
               };
 
               const response = await fetch(slackWebhookUrl, {
                 method: "POST",
                 headers: {
-                  "Content-Type": "application/json",
+                  "Content-Type": "application/json"
                 },
-                body: JSON.stringify(message),
+                body: JSON.stringify(message)
               });
 
               if (!response.ok) {
@@ -175,40 +171,80 @@ app.get("/is-production", (req, res) => {
   res.send({ isProduction: global.isProduction });
 });
 
-app.use((err: unknown, req: Request<{}, ErrorResponse, undefined>, res: Response<ErrorResponse>, next: NextFunction) => {
+app.use(
-  if (err instanceof ZodError) {
+  (
-      if (Array.isArray(err.errors) && err.errors.find(x => x.message === "URL uses unsupported protocol")) {
+    err: unknown,
+    req: Request<{}, ErrorResponse, undefined>,
+    res: Response<ErrorResponse>,
+    next: NextFunction
+  ) => {
+    if (err instanceof ZodError) {
+      if (
+        Array.isArray(err.errors) &&
+        err.errors.find((x) => x.message === "URL uses unsupported protocol")
+      ) {
         logger.warn("Unsupported protocol error: " + JSON.stringify(req.body));
       }
 
-      res.status(400).json({ success: false, error: "Bad Request", details: err.errors });
+      res
-  } else {
+        .status(400)
+        .json({ success: false, error: "Bad Request", details: err.errors });
+    } else {
       next(err);
+    }
   }
-});
+);
 
 Sentry.setupExpressErrorHandler(app);
 
-app.use((err: unknown, req: Request<{}, ErrorResponse, undefined>, res: ResponseWithSentry<ErrorResponse>, next: NextFunction) => {
+app.use(
-  if (err instanceof SyntaxError && 'status' in err && err.status === 400 && 'body' in err) {
+  (
-    return res.status(400).json({ success: false, error: 'Bad request, malformed JSON' });
+    err: unknown,
-  }
+    req: Request<{}, ErrorResponse, undefined>,
-
+    res: ResponseWithSentry<ErrorResponse>,
-  const id = res.sentry ?? uuidv4();
+    next: NextFunction
-  let verbose = JSON.stringify(err);
+  ) => {
-  if (verbose === "{}") {
+    if (
-    if (err instanceof Error) {
+      err instanceof SyntaxError &&
-      verbose = JSON.stringify({
+      "status" in err &&
-        message: err.message,
+      err.status === 400 &&
-        name: err.name,
+      "body" in err
-        stack: err.stack,
+    ) {
-      });
+      return res
+        .status(400)
+        .json({ success: false, error: "Bad request, malformed JSON" });
     }
-  }
 
-  logger.error("Error occurred in request! (" + req.path + ") -- ID " + id  + " -- " + verbose);
+    const id = res.sentry ?? uuidv4();
-  res.status(500).json({ success: false, error: "An unexpected error occurred. Please contact help@firecrawl.com for help. Your exception ID is " + id });
+    let verbose = JSON.stringify(err);
-});
+    if (verbose === "{}") {
+      if (err instanceof Error) {
+        verbose = JSON.stringify({
+          message: err.message,
+          name: err.name,
+          stack: err.stack
+        });
+      }
+    }
+
+    logger.error(
+      "Error occurred in request! (" +
+        req.path +
+        ") -- ID " +
+        id +
+        " -- " +
+        verbose
+    );
+    res
+      .status(500)
+      .json({
+        success: false,
+        error:
+          "An unexpected error occurred. Please contact help@firecrawl.com for help. Your exception ID is " +
+          id
+      });
+  }
+);
 
 logger.info(`Worker ${process.pid} started`);
 
@@ -220,6 +256,3 @@ logger.info(`Worker ${process.pid} started`);
 // sq.on("paused", j => ScrapeEvents.logJobEvent(j, "paused"));
 // sq.on("resumed", j => ScrapeEvents.logJobEvent(j, "resumed"));
 // sq.on("removed", j => ScrapeEvents.logJobEvent(j, "removed"));
-
-
-

apps/api/src/lib/LLM-extraction/index.ts

@@ -32,7 +32,7 @@ export async function generateCompletions(
               schema: schema,
               prompt: prompt,
               systemPrompt: systemPrompt,
-              mode: mode,
+              mode: mode
             });
             // Validate the JSON output against the schema using AJV
             if (schema) {

apps/api/src/lib/LLM-extraction/models.ts

@@ -50,7 +50,7 @@ export async function generateOpenAICompletions({
   systemPrompt = defaultPrompt,
   prompt,
   temperature,
-  mode,
+  mode
 }: {
   client: OpenAI;
   model?: string;
@@ -68,7 +68,7 @@ export async function generateOpenAICompletions({
     return {
       ...document,
       warning:
-        "LLM extraction was not performed since the document's content is empty or missing.",
+        "LLM extraction was not performed since the document's content is empty or missing."
     };
   }
   const [content, numTokens] = preparedDoc;
@@ -81,16 +81,16 @@ export async function generateOpenAICompletions({
       messages: [
         {
           role: "system",
-          content: systemPrompt,
+          content: systemPrompt
         },
         { role: "user", content },
         {
           role: "user",
-          content: `Transform the above content into structured json output based on the following user request: ${prompt}`,
+          content: `Transform the above content into structured json output based on the following user request: ${prompt}`
-        },
+        }
       ],
       response_format: { type: "json_object" },
-      temperature,
+      temperature
     });
 
     try {
@@ -106,9 +106,9 @@ export async function generateOpenAICompletions({
       messages: [
         {
           role: "system",
-          content: systemPrompt,
+          content: systemPrompt
         },
-        { role: "user", content },
+        { role: "user", content }
       ],
       tools: [
         {
@@ -116,12 +116,12 @@ export async function generateOpenAICompletions({
           function: {
             name: "extract_content",
             description: "Extracts the content from the given webpage(s)",
-            parameters: schema,
+            parameters: schema
-          },
+          }
-        },
+        }
       ],
       tool_choice: { type: "function", function: { name: "extract_content" } },
-      temperature,
+      temperature
     });
     const c = completion.choices[0].message.tool_calls[0].function.arguments;
 
@@ -140,6 +140,6 @@ export async function generateOpenAICompletions({
     warning:
       numTokens > maxTokens
         ? `Page was trimmed to fit the maximum token limit defined by the LLM model (Max: ${maxTokens} tokens, Attemped: ${numTokens} tokens). If results are not good, email us at help@mendable.ai so we can help you.`
-        : undefined,
+        : undefined
   };
 }

apps/api/src/lib/__tests__/html-to-markdown.test.ts

@@ -1,36 +1,46 @@
-import { parseMarkdown } from '../html-to-markdown';
+import { parseMarkdown } from "../html-to-markdown";
 
-describe('parseMarkdown', () => {
+describe("parseMarkdown", () => {
-  it('should correctly convert simple HTML to Markdown', async () => {
+  it("should correctly convert simple HTML to Markdown", async () => {
-    const html = '<p>Hello, world!</p>';
+    const html = "<p>Hello, world!</p>";
-    const expectedMarkdown = 'Hello, world!';
+    const expectedMarkdown = "Hello, world!";
     await expect(parseMarkdown(html)).resolves.toBe(expectedMarkdown);
   });
 
-  it('should convert complex HTML with nested elements to Markdown', async () => {
+  it("should convert complex HTML with nested elements to Markdown", async () => {
-    const html = '<div><p>Hello <strong>bold</strong> world!</p><ul><li>List item</li></ul></div>';
+    const html =
-    const expectedMarkdown = 'Hello **bold** world!\n\n- List item';
+      "<div><p>Hello <strong>bold</strong> world!</p><ul><li>List item</li></ul></div>";
+    const expectedMarkdown = "Hello **bold** world!\n\n- List item";
     await expect(parseMarkdown(html)).resolves.toBe(expectedMarkdown);
   });
 
-  it('should return empty string when input is empty', async () => {
+  it("should return empty string when input is empty", async () => {
-    const html = '';
+    const html = "";
-    const expectedMarkdown = '';
+    const expectedMarkdown = "";
     await expect(parseMarkdown(html)).resolves.toBe(expectedMarkdown);
   });
 
-  it('should handle null input gracefully', async () => {
+  it("should handle null input gracefully", async () => {
     const html = null;
-    const expectedMarkdown = '';
+    const expectedMarkdown = "";
     await expect(parseMarkdown(html)).resolves.toBe(expectedMarkdown);
   });
 
-  it('should handle various types of invalid HTML gracefully', async () => {
+  it("should handle various types of invalid HTML gracefully", async () => {
     const invalidHtmls = [
-      { html: '<html><p>Unclosed tag', expected: 'Unclosed tag' },
+      { html: "<html><p>Unclosed tag", expected: "Unclosed tag" },
-      { html: '<div><span>Missing closing div', expected: 'Missing closing div' },
+      {
-      { html: '<p><strong>Wrong nesting</em></strong></p>', expected: '**Wrong nesting**' },
+        html: "<div><span>Missing closing div",
-      { html: '<a href="http://example.com">Link without closing tag', expected: '[Link without closing tag](http://example.com)' }
+        expected: "Missing closing div"
+      },
+      {
+        html: "<p><strong>Wrong nesting</em></strong></p>",
+        expected: "**Wrong nesting**"
+      },
+      {
+        html: '<a href="http://example.com">Link without closing tag',
+        expected: "[Link without closing tag](http://example.com)"
+      }
     ];
 
     for (const { html, expected } of invalidHtmls) {

apps/api/src/lib/__tests__/job-priority.test.ts

@@ -1,7 +1,7 @@
 import {
   getJobPriority,
   addJobPriority,
-  deleteJobPriority,
+  deleteJobPriority
 } from "../job-priority";
 import { redisConnection } from "../../services/queue-service";
 import { PlanType } from "../../types";
@@ -11,8 +11,8 @@ jest.mock("../../services/queue-service", () => ({
     sadd: jest.fn(),
     srem: jest.fn(),
     scard: jest.fn(),
-    expire: jest.fn(),
+    expire: jest.fn()
-  },
+  }
 }));
 
 describe("Job Priority Tests", () => {

apps/api/src/lib/batch-process.ts

@@ -1,16 +1,15 @@
 export async function batchProcess<T>(
-    array: T[],
+  array: T[],
-    batchSize: number,
+  batchSize: number,
-    asyncFunction: (item: T, index: number) => Promise<void>
+  asyncFunction: (item: T, index: number) => Promise<void>
-  ): Promise<void> {
+): Promise<void> {
-    const batches: T[][] = [];
+  const batches: T[][] = [];
-    for (let i = 0; i < array.length; i += batchSize) {
+  for (let i = 0; i < array.length; i += batchSize) {
-      const batch = array.slice(i, i + batchSize);
+    const batch = array.slice(i, i + batchSize);
-      batches.push(batch);
+    batches.push(batch);
-    }
-  
-    for (const batch of batches) {
-      await Promise.all(batch.map((item, i) => asyncFunction(item, i)));
-    }
   }
-  
+
+  for (const batch of batches) {
+    await Promise.all(batch.map((item, i) => asyncFunction(item, i)));
+  }
+}

apps/api/src/lib/cache.ts

@@ -2,49 +2,61 @@ import IORedis from "ioredis";
 import { ScrapeOptions } from "../controllers/v1/types";
 import { InternalOptions } from "../scraper/scrapeURL";
 import { logger as _logger } from "./logger";
-const logger = _logger.child({module: "cache"});
+const logger = _logger.child({ module: "cache" });
 
-export const cacheRedis = process.env.CACHE_REDIS_URL ? new IORedis(process.env.CACHE_REDIS_URL, {
+export const cacheRedis = process.env.CACHE_REDIS_URL
-    maxRetriesPerRequest: null,
+  ? new IORedis(process.env.CACHE_REDIS_URL, {
-}) : null;
+      maxRetriesPerRequest: null
+    })
+  : null;
 
-export function cacheKey(url: string, scrapeOptions: ScrapeOptions, internalOptions: InternalOptions): string | null {
+export function cacheKey(
-    if (!cacheRedis) return null;
+  url: string,
+  scrapeOptions: ScrapeOptions,
+  internalOptions: InternalOptions
+): string | null {
+  if (!cacheRedis) return null;
 
-    // these options disqualify a cache
+  // these options disqualify a cache
-    if (internalOptions.v0CrawlOnlyUrls || internalOptions.forceEngine || internalOptions.v0UseFastMode || internalOptions.atsv
+  if (
-        || (scrapeOptions.actions && scrapeOptions.actions.length > 0)
+    internalOptions.v0CrawlOnlyUrls ||
-    ) {
+    internalOptions.forceEngine ||
-        return null;
+    internalOptions.v0UseFastMode ||
-    }
+    internalOptions.atsv ||
+    (scrapeOptions.actions && scrapeOptions.actions.length > 0)
+  ) {
+    return null;
+  }
 
-    return "cache:" + url + ":waitFor:" + scrapeOptions.waitFor;
+  return "cache:" + url + ":waitFor:" + scrapeOptions.waitFor;
 }
 
 export type CacheEntry = {
-    url: string;
+  url: string;
-    html: string;
+  html: string;
-    statusCode: number;
+  statusCode: number;
-    error?: string;
+  error?: string;
 };
 
 export async function saveEntryToCache(key: string, entry: CacheEntry) {
-    if (!cacheRedis) return;
+  if (!cacheRedis) return;
 
-    try {
+  try {
-        await cacheRedis.set(key, JSON.stringify(entry));
+    await cacheRedis.set(key, JSON.stringify(entry));
-    } catch (error) {
+  } catch (error) {
-        logger.warn("Failed to save to cache", { key, error });
+    logger.warn("Failed to save to cache", { key, error });
-    }
+  }
 }
 
-export async function getEntryFromCache(key: string): Promise<CacheEntry | null> {
+export async function getEntryFromCache(
-    if (!cacheRedis) return null;
+  key: string
+): Promise<CacheEntry | null> {
+  if (!cacheRedis) return null;
 
-    try {
+  try {
-        return JSON.parse(await cacheRedis.get(key) ?? "null");
+    return JSON.parse((await cacheRedis.get(key)) ?? "null");
-    } catch (error) {
+  } catch (error) {
-        logger.warn("Failed to get from cache", { key, error });
+    logger.warn("Failed to get from cache", { key, error });
-        return null;
+    return null;
-    }
+  }
 }

apps/api/src/lib/concurrency-limit.ts

@@ -4,45 +4,76 @@ import { RateLimiterMode } from "../types";
 import { JobsOptions } from "bullmq";
 
 const constructKey = (team_id: string) => "concurrency-limiter:" + team_id;
-const constructQueueKey = (team_id: string) => "concurrency-limit-queue:" + team_id;
+const constructQueueKey = (team_id: string) =>
+  "concurrency-limit-queue:" + team_id;
 const stalledJobTimeoutMs = 2 * 60 * 1000;
 
 export function getConcurrencyLimitMax(plan: string): number {
-    return getRateLimiterPoints(RateLimiterMode.Scrape, undefined, plan);
+  return getRateLimiterPoints(RateLimiterMode.Scrape, undefined, plan);
 }
 
-export async function cleanOldConcurrencyLimitEntries(team_id: string, now: number = Date.now()) {
+export async function cleanOldConcurrencyLimitEntries(
-    await redisConnection.zremrangebyscore(constructKey(team_id), -Infinity, now);
+  team_id: string,
+  now: number = Date.now()
+) {
+  await redisConnection.zremrangebyscore(constructKey(team_id), -Infinity, now);
 }
 
-export async function getConcurrencyLimitActiveJobs(team_id: string, now: number = Date.now()): Promise<string[]> {
+export async function getConcurrencyLimitActiveJobs(
-    return await redisConnection.zrangebyscore(constructKey(team_id), now, Infinity);
+  team_id: string,
+  now: number = Date.now()
+): Promise<string[]> {
+  return await redisConnection.zrangebyscore(
+    constructKey(team_id),
+    now,
+    Infinity
+  );
 }
 
-export async function pushConcurrencyLimitActiveJob(team_id: string, id: string, now: number = Date.now()) {
+export async function pushConcurrencyLimitActiveJob(
-    await redisConnection.zadd(constructKey(team_id), now + stalledJobTimeoutMs, id);
+  team_id: string,
+  id: string,
+  now: number = Date.now()
+) {
+  await redisConnection.zadd(
+    constructKey(team_id),
+    now + stalledJobTimeoutMs,
+    id
+  );
 }
 
-export async function removeConcurrencyLimitActiveJob(team_id: string, id: string) {
+export async function removeConcurrencyLimitActiveJob(
-    await redisConnection.zrem(constructKey(team_id), id);
+  team_id: string,
+  id: string
+) {
+  await redisConnection.zrem(constructKey(team_id), id);
 }
 
 export type ConcurrencyLimitedJob = {
-    id: string;
+  id: string;
-    data: any;
+  data: any;
-    opts: JobsOptions;
+  opts: JobsOptions;
-    priority?: number;
+  priority?: number;
+};
+
+export async function takeConcurrencyLimitedJob(
+  team_id: string
+): Promise<ConcurrencyLimitedJob | null> {
+  const res = await redisConnection.zmpop(1, constructQueueKey(team_id), "MIN");
+  if (res === null || res === undefined) {
+    return null;
+  }
+
+  return JSON.parse(res[1][0][0]);
 }
 
-export async function takeConcurrencyLimitedJob(team_id: string): Promise<ConcurrencyLimitedJob | null> {
+export async function pushConcurrencyLimitedJob(
-    const res = await redisConnection.zmpop(1, constructQueueKey(team_id), "MIN");
+  team_id: string,
-    if (res === null || res === undefined) {
+  job: ConcurrencyLimitedJob
-        return null;
+) {
-    }
+  await redisConnection.zadd(
-
+    constructQueueKey(team_id),
-    return JSON.parse(res[1][0][0]);
+    job.priority ?? 1,
-}
+    JSON.stringify(job)
-
+  );
-export async function pushConcurrencyLimitedJob(team_id: string, job: ConcurrencyLimitedJob) {
-    await redisConnection.zadd(constructQueueKey(team_id), job.priority ?? 1, JSON.stringify(job));
 }

apps/api/src/lib/crawl-redis.test.ts

@@ -1,33 +1,41 @@
 import { generateURLPermutations } from "./crawl-redis";
 
 describe("generateURLPermutations", () => {
-    it("generates permutations correctly", () => {
+  it("generates permutations correctly", () => {
-        const bareHttps = generateURLPermutations("https://firecrawl.dev").map(x => x.href);
+    const bareHttps = generateURLPermutations("https://firecrawl.dev").map(
-        expect(bareHttps.length).toBe(4);
+      (x) => x.href
-        expect(bareHttps.includes("https://firecrawl.dev/")).toBe(true);
+    );
-        expect(bareHttps.includes("https://www.firecrawl.dev/")).toBe(true);
+    expect(bareHttps.length).toBe(4);
-        expect(bareHttps.includes("http://firecrawl.dev/")).toBe(true);
+    expect(bareHttps.includes("https://firecrawl.dev/")).toBe(true);
-        expect(bareHttps.includes("http://www.firecrawl.dev/")).toBe(true);
+    expect(bareHttps.includes("https://www.firecrawl.dev/")).toBe(true);
+    expect(bareHttps.includes("http://firecrawl.dev/")).toBe(true);
+    expect(bareHttps.includes("http://www.firecrawl.dev/")).toBe(true);
 
-        const bareHttp = generateURLPermutations("http://firecrawl.dev").map(x => x.href);
+    const bareHttp = generateURLPermutations("http://firecrawl.dev").map(
-        expect(bareHttp.length).toBe(4);
+      (x) => x.href
-        expect(bareHttp.includes("https://firecrawl.dev/")).toBe(true);
+    );
-        expect(bareHttp.includes("https://www.firecrawl.dev/")).toBe(true);
+    expect(bareHttp.length).toBe(4);
-        expect(bareHttp.includes("http://firecrawl.dev/")).toBe(true);
+    expect(bareHttp.includes("https://firecrawl.dev/")).toBe(true);
-        expect(bareHttp.includes("http://www.firecrawl.dev/")).toBe(true);
+    expect(bareHttp.includes("https://www.firecrawl.dev/")).toBe(true);
+    expect(bareHttp.includes("http://firecrawl.dev/")).toBe(true);
+    expect(bareHttp.includes("http://www.firecrawl.dev/")).toBe(true);
 
-        const wwwHttps = generateURLPermutations("https://www.firecrawl.dev").map(x => x.href);
+    const wwwHttps = generateURLPermutations("https://www.firecrawl.dev").map(
-        expect(wwwHttps.length).toBe(4);
+      (x) => x.href
-        expect(wwwHttps.includes("https://firecrawl.dev/")).toBe(true);
+    );
-        expect(wwwHttps.includes("https://www.firecrawl.dev/")).toBe(true);
+    expect(wwwHttps.length).toBe(4);
-        expect(wwwHttps.includes("http://firecrawl.dev/")).toBe(true);
+    expect(wwwHttps.includes("https://firecrawl.dev/")).toBe(true);
-        expect(wwwHttps.includes("http://www.firecrawl.dev/")).toBe(true);
+    expect(wwwHttps.includes("https://www.firecrawl.dev/")).toBe(true);
+    expect(wwwHttps.includes("http://firecrawl.dev/")).toBe(true);
+    expect(wwwHttps.includes("http://www.firecrawl.dev/")).toBe(true);
 
-        const wwwHttp = generateURLPermutations("http://www.firecrawl.dev").map(x => x.href);
+    const wwwHttp = generateURLPermutations("http://www.firecrawl.dev").map(
-        expect(wwwHttp.length).toBe(4);
+      (x) => x.href
-        expect(wwwHttp.includes("https://firecrawl.dev/")).toBe(true);
+    );
-        expect(wwwHttp.includes("https://www.firecrawl.dev/")).toBe(true);
+    expect(wwwHttp.length).toBe(4);
-        expect(wwwHttp.includes("http://firecrawl.dev/")).toBe(true);
+    expect(wwwHttp.includes("https://firecrawl.dev/")).toBe(true);
-        expect(wwwHttp.includes("http://www.firecrawl.dev/")).toBe(true);
+    expect(wwwHttp.includes("https://www.firecrawl.dev/")).toBe(true);
-    })
+    expect(wwwHttp.includes("http://firecrawl.dev/")).toBe(true);
-});
+    expect(wwwHttp.includes("http://www.firecrawl.dev/")).toBe(true);
+  });
+});

apps/api/src/lib/crawl-redis.ts

@@ -6,222 +6,331 @@ import { logger as _logger } from "./logger";
 import { getAdjustedMaxDepth } from "../scraper/WebScraper/utils/maxDepthUtils";
 
 export type StoredCrawl = {
-    originUrl?: string;
+  originUrl?: string;
-    crawlerOptions: any;
+  crawlerOptions: any;
-    scrapeOptions: Omit<ScrapeOptions, "timeout">;
+  scrapeOptions: Omit<ScrapeOptions, "timeout">;
-    internalOptions: InternalOptions;
+  internalOptions: InternalOptions;
-    team_id: string;
+  team_id: string;
-    plan?: string;
+  plan?: string;
-    robots?: string;
+  robots?: string;
-    cancelled?: boolean;
+  cancelled?: boolean;
-    createdAt: number;
+  createdAt: number;
 };
 
 export async function saveCrawl(id: string, crawl: StoredCrawl) {
-    _logger.debug("Saving crawl " + id + " to Redis...", { crawl, module: "crawl-redis", method: "saveCrawl", crawlId: id, teamId: crawl.team_id, plan: crawl.plan });
+  _logger.debug("Saving crawl " + id + " to Redis...", {
-    await redisConnection.set("crawl:" + id, JSON.stringify(crawl));
+    crawl,
-    await redisConnection.expire("crawl:" + id, 24 * 60 * 60, "NX");
+    module: "crawl-redis",
+    method: "saveCrawl",
+    crawlId: id,
+    teamId: crawl.team_id,
+    plan: crawl.plan
+  });
+  await redisConnection.set("crawl:" + id, JSON.stringify(crawl));
+  await redisConnection.expire("crawl:" + id, 24 * 60 * 60, "NX");
 }
 
 export async function getCrawl(id: string): Promise<StoredCrawl | null> {
-    const x = await redisConnection.get("crawl:" + id);
+  const x = await redisConnection.get("crawl:" + id);
 
-    if (x === null) {
+  if (x === null) {
-        return null;
+    return null;
-    }
+  }
 
-    return JSON.parse(x);
+  return JSON.parse(x);
 }
 
 export async function getCrawlExpiry(id: string): Promise<Date> {
-    const d = new Date();
+  const d = new Date();
-    const ttl = await redisConnection.pttl("crawl:" + id);
+  const ttl = await redisConnection.pttl("crawl:" + id);
-    d.setMilliseconds(d.getMilliseconds() + ttl);
+  d.setMilliseconds(d.getMilliseconds() + ttl);
-    d.setMilliseconds(0);
+  d.setMilliseconds(0);
-    return d;
+  return d;
 }
 
 export async function addCrawlJob(id: string, job_id: string) {
-    _logger.debug("Adding crawl job " + job_id + " to Redis...", { jobId: job_id, module: "crawl-redis", method: "addCrawlJob", crawlId: id });
+  _logger.debug("Adding crawl job " + job_id + " to Redis...", {
-    await redisConnection.sadd("crawl:" + id + ":jobs", job_id);
+    jobId: job_id,
-    await redisConnection.expire("crawl:" + id + ":jobs", 24 * 60 * 60, "NX");
+    module: "crawl-redis",
+    method: "addCrawlJob",
+    crawlId: id
+  });
+  await redisConnection.sadd("crawl:" + id + ":jobs", job_id);
+  await redisConnection.expire("crawl:" + id + ":jobs", 24 * 60 * 60, "NX");
 }
 
 export async function addCrawlJobs(id: string, job_ids: string[]) {
-    _logger.debug("Adding crawl jobs to Redis...", { jobIds: job_ids, module: "crawl-redis", method: "addCrawlJobs", crawlId: id });
+  _logger.debug("Adding crawl jobs to Redis...", {
-    await redisConnection.sadd("crawl:" + id + ":jobs", ...job_ids);
+    jobIds: job_ids,
-    await redisConnection.expire("crawl:" + id + ":jobs", 24 * 60 * 60, "NX");
+    module: "crawl-redis",
+    method: "addCrawlJobs",
+    crawlId: id
+  });
+  await redisConnection.sadd("crawl:" + id + ":jobs", ...job_ids);
+  await redisConnection.expire("crawl:" + id + ":jobs", 24 * 60 * 60, "NX");
 }
 
-export async function addCrawlJobDone(id: string, job_id: string, success: boolean) {
+export async function addCrawlJobDone(
-    _logger.debug("Adding done crawl job to Redis...", { jobId: job_id, module: "crawl-redis", method: "addCrawlJobDone", crawlId: id });
+  id: string,
-    await redisConnection.sadd("crawl:" + id + ":jobs_done", job_id);
+  job_id: string,
-    await redisConnection.expire("crawl:" + id + ":jobs_done", 24 * 60 * 60, "NX");
+  success: boolean
+) {
+  _logger.debug("Adding done crawl job to Redis...", {
+    jobId: job_id,
+    module: "crawl-redis",
+    method: "addCrawlJobDone",
+    crawlId: id
+  });
+  await redisConnection.sadd("crawl:" + id + ":jobs_done", job_id);
+  await redisConnection.expire(
+    "crawl:" + id + ":jobs_done",
+    24 * 60 * 60,
+    "NX"
+  );
 
-    if (success) {
+  if (success) {
-        await redisConnection.rpush("crawl:" + id + ":jobs_done_ordered", job_id);
+    await redisConnection.rpush("crawl:" + id + ":jobs_done_ordered", job_id);
-        await redisConnection.expire("crawl:" + id + ":jobs_done_ordered", 24 * 60 * 60, "NX");
+    await redisConnection.expire(
-    }
+      "crawl:" + id + ":jobs_done_ordered",
+      24 * 60 * 60,
+      "NX"
+    );
+  }
 }
 
 export async function getDoneJobsOrderedLength(id: string): Promise<number> {
-    return await redisConnection.llen("crawl:" + id + ":jobs_done_ordered");
+  return await redisConnection.llen("crawl:" + id + ":jobs_done_ordered");
 }
 
-export async function getDoneJobsOrdered(id: string, start = 0, end = -1): Promise<string[]> {
+export async function getDoneJobsOrdered(
-    return await redisConnection.lrange("crawl:" + id + ":jobs_done_ordered", start, end);
+  id: string,
+  start = 0,
+  end = -1
+): Promise<string[]> {
+  return await redisConnection.lrange(
+    "crawl:" + id + ":jobs_done_ordered",
+    start,
+    end
+  );
 }
 
 export async function isCrawlFinished(id: string) {
-    return (await redisConnection.scard("crawl:" + id + ":jobs_done")) === (await redisConnection.scard("crawl:" + id + ":jobs"));
+  return (
+    (await redisConnection.scard("crawl:" + id + ":jobs_done")) ===
+    (await redisConnection.scard("crawl:" + id + ":jobs"))
+  );
 }
 
 export async function isCrawlFinishedLocked(id: string) {
-    return (await redisConnection.exists("crawl:" + id + ":finish"));
+  return await redisConnection.exists("crawl:" + id + ":finish");
 }
 
 export async function finishCrawl(id: string) {
-    if (await isCrawlFinished(id)) {
+  if (await isCrawlFinished(id)) {
-        _logger.debug("Marking crawl as finished.", { module: "crawl-redis", method: "finishCrawl", crawlId: id });
+    _logger.debug("Marking crawl as finished.", {
-        const set = await redisConnection.setnx("crawl:" + id + ":finish", "yes");
+      module: "crawl-redis",
-        if (set === 1) {
+      method: "finishCrawl",
-            await redisConnection.expire("crawl:" + id + ":finish", 24 * 60 * 60);
+      crawlId: id
-        }
+    });
-        return set === 1
+    const set = await redisConnection.setnx("crawl:" + id + ":finish", "yes");
-    } else {
+    if (set === 1) {
-        _logger.debug("Crawl can not be finished yet, not marking as finished.", { module: "crawl-redis", method: "finishCrawl", crawlId: id });
+      await redisConnection.expire("crawl:" + id + ":finish", 24 * 60 * 60);
     }
+    return set === 1;
+  } else {
+    _logger.debug("Crawl can not be finished yet, not marking as finished.", {
+      module: "crawl-redis",
+      method: "finishCrawl",
+      crawlId: id
+    });
+  }
 }
 
 export async function getCrawlJobs(id: string): Promise<string[]> {
-    return await redisConnection.smembers("crawl:" + id + ":jobs");
+  return await redisConnection.smembers("crawl:" + id + ":jobs");
 }
 
 export async function getThrottledJobs(teamId: string): Promise<string[]> {
-    return await redisConnection.zrangebyscore("concurrency-limiter:" + teamId + ":throttled", Date.now(), Infinity);
+  return await redisConnection.zrangebyscore(
+    "concurrency-limiter:" + teamId + ":throttled",
+    Date.now(),
+    Infinity
+  );
 }
 
 export function normalizeURL(url: string, sc: StoredCrawl): string {
-    const urlO = new URL(url);
+  const urlO = new URL(url);
-    if (!sc.crawlerOptions || sc.crawlerOptions.ignoreQueryParameters) {
+  if (!sc.crawlerOptions || sc.crawlerOptions.ignoreQueryParameters) {
-        urlO.search = "";
+    urlO.search = "";
-    }
+  }
-    urlO.hash = "";
+  urlO.hash = "";
-    return urlO.href;
+  return urlO.href;
 }
 
 export function generateURLPermutations(url: string | URL): URL[] {
-    const urlO = new URL(url);
+  const urlO = new URL(url);
 
-    // Construct two versions, one with www., one without
+  // Construct two versions, one with www., one without
-    const urlWithWWW = new URL(urlO);
+  const urlWithWWW = new URL(urlO);
-    const urlWithoutWWW = new URL(urlO);
+  const urlWithoutWWW = new URL(urlO);
-    if (urlO.hostname.startsWith("www.")) {
+  if (urlO.hostname.startsWith("www.")) {
-        urlWithoutWWW.hostname = urlWithWWW.hostname.slice(4);
+    urlWithoutWWW.hostname = urlWithWWW.hostname.slice(4);
-    } else {
+  } else {
-        urlWithWWW.hostname = "www." + urlWithoutWWW.hostname;
+    urlWithWWW.hostname = "www." + urlWithoutWWW.hostname;
+  }
+
+  let permutations = [urlWithWWW, urlWithoutWWW];
+
+  // Construct more versions for http/https
+  permutations = permutations.flatMap((urlO) => {
+    if (!["http:", "https:"].includes(urlO.protocol)) {
+      return [urlO];
     }
 
-    let permutations = [urlWithWWW, urlWithoutWWW];
+    const urlWithHTTP = new URL(urlO);
+    const urlWithHTTPS = new URL(urlO);
+    urlWithHTTP.protocol = "http:";
+    urlWithHTTPS.protocol = "https:";
 
-    // Construct more versions for http/https
+    return [urlWithHTTP, urlWithHTTPS];
-    permutations = permutations.flatMap(urlO => {
+  });
-        if (!["http:", "https:"].includes(urlO.protocol)) {
-            return [urlO];
-        }
 
-        const urlWithHTTP = new URL(urlO);
+  return permutations;
-        const urlWithHTTPS = new URL(urlO);
-        urlWithHTTP.protocol = "http:";
-        urlWithHTTPS.protocol = "https:";
-
-        return [urlWithHTTP, urlWithHTTPS];
-    });
-
-    return permutations;
 }
 
-export async function lockURL(id: string, sc: StoredCrawl, url: string): Promise<boolean> {
+export async function lockURL(
-    let logger = _logger.child({ crawlId: id, module: "crawl-redis", method: "lockURL", preNormalizedURL: url, teamId: sc.team_id, plan: sc.plan });
+  id: string,
+  sc: StoredCrawl,
+  url: string
+): Promise<boolean> {
+  let logger = _logger.child({
+    crawlId: id,
+    module: "crawl-redis",
+    method: "lockURL",
+    preNormalizedURL: url,
+    teamId: sc.team_id,
+    plan: sc.plan
+  });
 
-    if (typeof sc.crawlerOptions?.limit === "number") {
+  if (typeof sc.crawlerOptions?.limit === "number") {
-        if (await redisConnection.scard("crawl:" + id + ":visited_unique") >= sc.crawlerOptions.limit) {
+    if (
-            logger.debug("Crawl has already hit visited_unique limit, not locking URL.");
+      (await redisConnection.scard("crawl:" + id + ":visited_unique")) >=
-            return false;
+      sc.crawlerOptions.limit
-        }
+    ) {
+      logger.debug(
+        "Crawl has already hit visited_unique limit, not locking URL."
+      );
+      return false;
     }
+  }
 
-    url = normalizeURL(url, sc);
+  url = normalizeURL(url, sc);
-    logger = logger.child({ url });
+  logger = logger.child({ url });
 
-    await redisConnection.sadd("crawl:" + id + ":visited_unique", url);
+  await redisConnection.sadd("crawl:" + id + ":visited_unique", url);
-    await redisConnection.expire("crawl:" + id + ":visited_unique", 24 * 60 * 60, "NX");
+  await redisConnection.expire(
+    "crawl:" + id + ":visited_unique",
+    24 * 60 * 60,
+    "NX"
+  );
 
-    let res: boolean;
+  let res: boolean;
-    if (!sc.crawlerOptions?.deduplicateSimilarURLs) {
+  if (!sc.crawlerOptions?.deduplicateSimilarURLs) {
-        res = (await redisConnection.sadd("crawl:" + id + ":visited", url)) !== 0
+    res = (await redisConnection.sadd("crawl:" + id + ":visited", url)) !== 0;
-    } else {
+  } else {
-        const permutations = generateURLPermutations(url).map(x => x.href);
+    const permutations = generateURLPermutations(url).map((x) => x.href);
-        // logger.debug("Adding URL permutations for URL " + JSON.stringify(url) + "...", { permutations });
+    // logger.debug("Adding URL permutations for URL " + JSON.stringify(url) + "...", { permutations });
-        const x = (await redisConnection.sadd("crawl:" + id + ":visited", ...permutations));
+    const x = await redisConnection.sadd(
-        res = x === permutations.length;
+      "crawl:" + id + ":visited",
-    }
+      ...permutations
+    );
+    res = x === permutations.length;
+  }
 
-    await redisConnection.expire("crawl:" + id + ":visited", 24 * 60 * 60, "NX");
+  await redisConnection.expire("crawl:" + id + ":visited", 24 * 60 * 60, "NX");
 
-    logger.debug("Locking URL " + JSON.stringify(url) + "... result: " + res, { res });
+  logger.debug("Locking URL " + JSON.stringify(url) + "... result: " + res, {
-    return res;
+    res
+  });
+  return res;
 }
 
 /// NOTE: does not check limit. only use if limit is checked beforehand e.g. with sitemap
-export async function lockURLs(id: string, sc: StoredCrawl, urls: string[]): Promise<boolean> {
+export async function lockURLs(
-    urls = urls.map(url => normalizeURL(url, sc));
+  id: string,
-    const logger = _logger.child({ crawlId: id, module: "crawl-redis", method: "lockURL", teamId: sc.team_id, plan: sc.plan });
+  sc: StoredCrawl,
+  urls: string[]
+): Promise<boolean> {
+  urls = urls.map((url) => normalizeURL(url, sc));
+  const logger = _logger.child({
+    crawlId: id,
+    module: "crawl-redis",
+    method: "lockURL",
+    teamId: sc.team_id,
+    plan: sc.plan
+  });
 
-    // Add to visited_unique set
+  // Add to visited_unique set
-    logger.debug("Locking " + urls.length + " URLs...");
+  logger.debug("Locking " + urls.length + " URLs...");
-    await redisConnection.sadd("crawl:" + id + ":visited_unique", ...urls);
+  await redisConnection.sadd("crawl:" + id + ":visited_unique", ...urls);
-    await redisConnection.expire("crawl:" + id + ":visited_unique", 24 * 60 * 60, "NX");
+  await redisConnection.expire(
+    "crawl:" + id + ":visited_unique",
+    24 * 60 * 60,
+    "NX"
+  );
 
-    let res: boolean;
+  let res: boolean;
-    if (!sc.crawlerOptions?.deduplicateSimilarURLs) {
+  if (!sc.crawlerOptions?.deduplicateSimilarURLs) {
-        const x = await redisConnection.sadd("crawl:" + id + ":visited", ...urls);
+    const x = await redisConnection.sadd("crawl:" + id + ":visited", ...urls);
-        res = x === urls.length;
+    res = x === urls.length;
-    } else {
+  } else {
-        const allPermutations = urls.flatMap(url => generateURLPermutations(url).map(x => x.href));
+    const allPermutations = urls.flatMap((url) =>
-        logger.debug("Adding " + allPermutations.length + " URL permutations...");
+      generateURLPermutations(url).map((x) => x.href)
-        const x = await redisConnection.sadd("crawl:" + id + ":visited", ...allPermutations);
+    );
-        res = x === allPermutations.length;
+    logger.debug("Adding " + allPermutations.length + " URL permutations...");
-    }
+    const x = await redisConnection.sadd(
+      "crawl:" + id + ":visited",
+      ...allPermutations
+    );
+    res = x === allPermutations.length;
+  }
 
-    await redisConnection.expire("crawl:" + id + ":visited", 24 * 60 * 60, "NX");
+  await redisConnection.expire("crawl:" + id + ":visited", 24 * 60 * 60, "NX");
 
-    logger.debug("lockURLs final result: " + res, { res });
+  logger.debug("lockURLs final result: " + res, { res });
-    return res;
+  return res;
 }
 
-export function crawlToCrawler(id: string, sc: StoredCrawl, newBase?: string): WebCrawler {
+export function crawlToCrawler(
-    const crawler = new WebCrawler({
+  id: string,
-        jobId: id,
+  sc: StoredCrawl,
-        initialUrl: sc.originUrl!,
+  newBase?: string
-        baseUrl: newBase ? new URL(newBase).origin : undefined,
+): WebCrawler {
-        includes: sc.crawlerOptions?.includes ?? [],
+  const crawler = new WebCrawler({
-        excludes: sc.crawlerOptions?.excludes ?? [],
+    jobId: id,
-        maxCrawledLinks: sc.crawlerOptions?.maxCrawledLinks ?? 1000,
+    initialUrl: sc.originUrl!,
-        maxCrawledDepth: getAdjustedMaxDepth(sc.originUrl!, sc.crawlerOptions?.maxDepth ?? 10),
+    baseUrl: newBase ? new URL(newBase).origin : undefined,
-        limit: sc.crawlerOptions?.limit ?? 10000,
+    includes: sc.crawlerOptions?.includes ?? [],
-        generateImgAltText: sc.crawlerOptions?.generateImgAltText ?? false,
+    excludes: sc.crawlerOptions?.excludes ?? [],
-        allowBackwardCrawling: sc.crawlerOptions?.allowBackwardCrawling ?? false,
+    maxCrawledLinks: sc.crawlerOptions?.maxCrawledLinks ?? 1000,
-        allowExternalContentLinks: sc.crawlerOptions?.allowExternalContentLinks ?? false,
+    maxCrawledDepth: getAdjustedMaxDepth(
-        allowSubdomains: sc.crawlerOptions?.allowSubdomains ?? false,
+      sc.originUrl!,
-        ignoreRobotsTxt: sc.crawlerOptions?.ignoreRobotsTxt ?? false,
+      sc.crawlerOptions?.maxDepth ?? 10
-    });
+    ),
+    limit: sc.crawlerOptions?.limit ?? 10000,
+    generateImgAltText: sc.crawlerOptions?.generateImgAltText ?? false,
+    allowBackwardCrawling: sc.crawlerOptions?.allowBackwardCrawling ?? false,
+    allowExternalContentLinks:
+      sc.crawlerOptions?.allowExternalContentLinks ?? false,
+    allowSubdomains: sc.crawlerOptions?.allowSubdomains ?? false,
+    ignoreRobotsTxt: sc.crawlerOptions?.ignoreRobotsTxt ?? false
+  });
 
-    if (sc.robots !== undefined) {
+  if (sc.robots !== undefined) {
-        try {
+    try {
-            crawler.importRobotsTxt(sc.robots);
+      crawler.importRobotsTxt(sc.robots);
-        } catch (_) {}
+    } catch (_) {}
-    }
+  }
 
-    return crawler;
+  return crawler;
 }

apps/api/src/lib/custom-error.ts

@@ -8,7 +8,7 @@ export class CustomError extends Error {
     statusCode: number,
     status: string,
     message: string = "",
-    dataIngestionJob?: any,
+    dataIngestionJob?: any
   ) {
     super(message);
     this.statusCode = statusCode;
@@ -19,4 +19,3 @@ export class CustomError extends Error {
     Object.setPrototypeOf(this, CustomError.prototype);
   }
 }
-

apps/api/src/lib/default-values.ts

@@ -14,15 +14,15 @@ export const defaultPageOptions = {
 export const defaultCrawlerOptions = {
   allowBackwardCrawling: false,
   limit: 10000
-}
+};
 
 export const defaultCrawlPageOptions = {
   onlyMainContent: false,
   includeHtml: false,
   removeTags: [],
   parsePDF: true
-}
+};
 
 export const defaultExtractorOptions = {
   mode: "markdown"
-}
+};

apps/api/src/lib/entities.ts

@@ -12,32 +12,40 @@ export interface Progress {
   currentDocument?: Document;
 }
 
-export type Action = {
+export type Action =
-  type: "wait",
+  | {
-  milliseconds?: number,
+      type: "wait";
-  selector?: string,
+      milliseconds?: number;
-} | {
+      selector?: string;
-  type: "click",
+    }
-  selector: string,
+  | {
-} | {
+      type: "click";
-  type: "screenshot",
+      selector: string;
-  fullPage?: boolean,
+    }
-} | {
+  | {
-  type: "write",
+      type: "screenshot";
-  text: string,
+      fullPage?: boolean;
-} | {
+    }
-  type: "press",
+  | {
-  key: string,
+      type: "write";
-} | {
+      text: string;
-  type: "scroll",
+    }
-  direction?: "up" | "down",
+  | {
-  selector?: string,
+      type: "press";
-} | {
+      key: string;
-  type: "scrape",
+    }
-} | {
+  | {
-  type: "executeJavascript",
+      type: "scroll";
-  script: string,
+      direction?: "up" | "down";
-}
+      selector?: string;
+    }
+  | {
+      type: "scrape";
+    }
+  | {
+      type: "executeJavascript";
+      script: string;
+    };
 
 export type PageOptions = {
   includeMarkdown?: boolean;
@@ -69,11 +77,15 @@ export type PageOptions = {
 };
 
 export type ExtractorOptions = {
-  mode: "markdown" | "llm-extraction" | "llm-extraction-from-markdown" | "llm-extraction-from-raw-html";
+  mode:
+    | "markdown"
+    | "llm-extraction"
+    | "llm-extraction-from-markdown"
+    | "llm-extraction-from-raw-html";
   extractionPrompt?: string;
   extractionSchema?: Record<string, any>;
   userPrompt?: string;
-}
+};
 
 export type SearchOptions = {
   limit?: number;
@@ -97,7 +109,7 @@ export type CrawlerOptions = {
   mode?: "default" | "fast"; // have a mode of some sort
   allowBackwardCrawling?: boolean;
   allowExternalContentLinks?: boolean;
-}
+};
 
 export type WebScraperOptions = {
   jobId: string;
@@ -137,11 +149,11 @@ export class Document {
   actions?: {
     screenshots?: string[];
     scrapes?: ScrapeActionContent[];
-  }
+  };
 
   index?: number;
   linksOnPage?: string[]; // Add this new field as a separate property
-  
+
   constructor(data: Partial<Document>) {
     if (!data.content) {
       throw new Error("Missing required fields");
@@ -158,20 +170,19 @@ export class Document {
   }
 }
 
-
 export class SearchResult {
   url: string;
   title: string;
   description: string;
 
   constructor(url: string, title: string, description: string) {
-      this.url = url;
+    this.url = url;
-      this.title = title;
+    this.title = title;
-      this.description = description;
+    this.description = description;
   }
 
   toString(): string {
-      return `SearchResult(url=${this.url}, title=${this.title}, description=${this.description})`;
+    return `SearchResult(url=${this.url}, title=${this.title}, description=${this.description})`;
   }
 }
 
@@ -188,8 +199,7 @@ export interface FireEngineResponse {
   scrapeActionContent?: ScrapeActionContent[];
 }
 
-
+export interface FireEngineOptions {
-export interface FireEngineOptions{
   mobileProxy?: boolean;
   method?: string;
   engine?: string;

apps/api/src/lib/extract/build-document.ts

@@ -5,9 +5,11 @@ export function buildDocument(document: Document): string {
   const markdown = document.markdown;
 
   // for each key in the metadata allow up to 250 characters
-  const metadataString = Object.entries(metadata).map(([key, value]) => {
+  const metadataString = Object.entries(metadata)
-    return `${key}: ${value?.toString().slice(0, 250)}`;
+    .map(([key, value]) => {
-  }).join('\n');
+      return `${key}: ${value?.toString().slice(0, 250)}`;
+    })
+    .join("\n");
 
   const documentMetadataString = `\n- - - - - Page metadata - - - - -\n${metadataString}`;
   const documentString = `${markdown}${documentMetadataString}`;

apps/api/src/lib/extract/reranker.ts

@@ -1,7 +1,7 @@
 import { CohereClient } from "cohere-ai";
 import { MapDocument } from "../../controllers/v1/types";
 const cohere = new CohereClient({
-  token: process.env.COHERE_API_KEY,
+  token: process.env.COHERE_API_KEY
 });
 
 export async function rerankDocuments(
@@ -15,8 +15,14 @@ export async function rerankDocuments(
     query,
     topN,
     model,
-    returnDocuments: true,
+    returnDocuments: true
   });
 
-  return rerank.results.sort((a, b) => b.relevanceScore - a.relevanceScore).map(x => ({ document: x.document, index: x.index, relevanceScore: x.relevanceScore }));
+  return rerank.results
+    .sort((a, b) => b.relevanceScore - a.relevanceScore)
+    .map((x) => ({
+      document: x.document,
+      index: x.index,
+      relevanceScore: x.relevanceScore
+    }));
 }

apps/api/src/lib/html-to-markdown.ts

@@ -1,16 +1,20 @@
-
+import koffi from "koffi";
-import koffi from 'koffi';
+import { join } from "path";
-import { join } from 'path';
+import "../services/sentry";
-import "../services/sentry"
 import * as Sentry from "@sentry/node";
 
-import dotenv from 'dotenv';
+import dotenv from "dotenv";
-import { logger } from './logger';
+import { logger } from "./logger";
-import { stat } from 'fs/promises';
+import { stat } from "fs/promises";
 dotenv.config();
 
 // TODO: add a timeout to the Go parser
-const goExecutablePath = join(process.cwd(), 'sharedLibs', 'go-html-to-md', 'html-to-markdown.so');
+const goExecutablePath = join(
+  process.cwd(),
+  "sharedLibs",
+  "go-html-to-md",
+  "html-to-markdown.so"
+);
 
 class GoMarkdownConverter {
   private static instance: GoMarkdownConverter;
@@ -18,7 +22,7 @@ class GoMarkdownConverter {
 
   private constructor() {
     const lib = koffi.load(goExecutablePath);
-    this.convert = lib.func('ConvertHTMLToMarkdown', 'string', ['string']);
+    this.convert = lib.func("ConvertHTMLToMarkdown", "string", ["string"]);
   }
 
   public static async getInstance(): Promise<GoMarkdownConverter> {
@@ -46,9 +50,11 @@ class GoMarkdownConverter {
   }
 }
 
-export async function parseMarkdown(html: string | null | undefined): Promise<string> {
+export async function parseMarkdown(
+  html: string | null | undefined
+): Promise<string> {
   if (!html) {
-    return '';
+    return "";
   }
 
   try {
@@ -62,17 +68,25 @@ export async function parseMarkdown(html: string | null | undefined): Promise<st
       return markdownContent;
     }
   } catch (error) {
-    if (!(error instanceof Error) || error.message !== "Go shared library not found") {
+    if (
+      !(error instanceof Error) ||
+      error.message !== "Go shared library not found"
+    ) {
       Sentry.captureException(error);
-      logger.error(`Error converting HTML to Markdown with Go parser: ${error}`);
+      logger.error(
+        `Error converting HTML to Markdown with Go parser: ${error}`
+      );
     } else {
-      logger.warn("Tried to use Go parser, but it doesn't exist in the file system.", { goExecutablePath });
+      logger.warn(
+        "Tried to use Go parser, but it doesn't exist in the file system.",
+        { goExecutablePath }
+      );
     }
   }
 
   // Fallback to TurndownService if Go parser fails or is not enabled
   var TurndownService = require("turndown");
-  var turndownPluginGfm = require('joplin-turndown-plugin-gfm');
+  var turndownPluginGfm = require("joplin-turndown-plugin-gfm");
 
   const turndownService = new TurndownService();
   turndownService.addRule("inlineLink", {
@@ -87,7 +101,7 @@ export async function parseMarkdown(html: string | null | undefined): Promise<st
       var href = node.getAttribute("href").trim();
       var title = node.title ? ' "' + node.title + '"' : "";
       return "[" + content.trim() + "](" + href + title + ")\n";
-    },
+    }
   });
   var gfm = turndownPluginGfm.gfm;
   turndownService.use(gfm);
@@ -99,7 +113,7 @@ export async function parseMarkdown(html: string | null | undefined): Promise<st
 
     return markdownContent;
   } catch (error) {
-    logger.error("Error converting HTML to Markdown", {error});
+    logger.error("Error converting HTML to Markdown", { error });
     return ""; // Optionally return an empty string or handle the error as needed
   }
 }
@@ -134,4 +148,4 @@ function removeSkipToContentLinks(markdownContent: string): string {
     ""
   );
   return newMarkdownContent;
-}
+}

apps/api/src/lib/job-priority.ts

@@ -31,7 +31,7 @@ export async function deleteJobPriority(team_id, job_id) {
 export async function getJobPriority({
   plan,
   team_id,
-  basePriority = 10,
+  basePriority = 10
 }: {
   plan: PlanType | undefined;
   team_id: string;

apps/api/src/lib/logger.ts

@@ -3,24 +3,26 @@ import * as winston from "winston";
 import { configDotenv } from "dotenv";
 configDotenv();
 
-const logFormat = winston.format.printf(info => 
+const logFormat = winston.format.printf(
-  `${info.timestamp} ${info.level} [${info.metadata.module ?? ""}:${info.metadata.method ?? ""}]: ${info.message} ${info.level.includes("error") || info.level.includes("warn") ? JSON.stringify(
+  (info) =>
-    info.metadata,
+    `${info.timestamp} ${info.level} [${info.metadata.module ?? ""}:${info.metadata.method ?? ""}]: ${info.message} ${
-    (_, value) => {
+      info.level.includes("error") || info.level.includes("warn")
-      if (value instanceof Error) {
+        ? JSON.stringify(info.metadata, (_, value) => {
-        return {
+            if (value instanceof Error) {
-          ...value,
+              return {
-          name: value.name,
+                ...value,
-          message: value.message,
+                name: value.name,
-          stack: value.stack,
+                message: value.message,
-          cause: value.cause,
+                stack: value.stack,
-        }
+                cause: value.cause
-      } else {
+              };
-        return value;
+            } else {
-      }
+              return value;
-    }
+            }
-  ) : ""}`
+          })
-)
+        : ""
+    }`
+);
 
 export const logger = winston.createLogger({
   level: process.env.LOGGING_LEVEL?.toLowerCase() ?? "debug",
@@ -32,8 +34,8 @@ export const logger = winston.createLogger({
           name: value.name,
           message: value.message,
           stack: value.stack,
-          cause: value.cause,
+          cause: value.cause
-        }
+        };
       } else {
         return value;
       }
@@ -43,9 +45,15 @@ export const logger = winston.createLogger({
     new winston.transports.Console({
       format: winston.format.combine(
         winston.format.timestamp({ format: "YYYY-MM-DD HH:mm:ss" }),
-        winston.format.metadata({ fillExcept: ["message", "level", "timestamp"] }),
+        winston.format.metadata({
-        ...(((process.env.ENV === "production" && process.env.SENTRY_ENVIRONMENT === "dev") || (process.env.ENV !== "production")) ? [winston.format.colorize(), logFormat] : []),
+          fillExcept: ["message", "level", "timestamp"]
-      ),
+        }),
-    }),
+        ...((process.env.ENV === "production" &&
-  ],
+          process.env.SENTRY_ENVIRONMENT === "dev") ||
+        process.env.ENV !== "production"
+          ? [winston.format.colorize(), logFormat]
+          : [])
+      )
+    })
+  ]
 });

apps/api/src/lib/parseApi.ts

@@ -13,7 +13,6 @@ export function parseApi(api: string) {
   return uuid;
 }
 
-
 export function uuidToFcUuid(uuid: string) {
   const uuidWithoutDashes = uuid.replace(/-/g, "");
   return `fc-${uuidWithoutDashes}`;

apps/api/src/lib/ranker.test.ts

@@ -1,64 +1,61 @@
-import { performRanking } from './ranker';
+import { performRanking } from "./ranker";
 
-describe('performRanking', () => {
+describe("performRanking", () => {
-  it('should rank links based on similarity to search query', async () => {
+  it("should rank links based on similarity to search query", async () => {
     const linksWithContext = [
-      'url: https://example.com/dogs, title: All about dogs, description: Learn about different dog breeds',
+      "url: https://example.com/dogs, title: All about dogs, description: Learn about different dog breeds",
-      'url: https://example.com/cats, title: Cat care guide, description: Everything about cats',
+      "url: https://example.com/cats, title: Cat care guide, description: Everything about cats",
-      'url: https://example.com/pets, title: General pet care, description: Care for all types of pets'
+      "url: https://example.com/pets, title: General pet care, description: Care for all types of pets"
     ];
 
     const links = [
-      'https://example.com/dogs',
+      "https://example.com/dogs",
-      'https://example.com/cats', 
+      "https://example.com/cats",
-      'https://example.com/pets'
+      "https://example.com/pets"
     ];
 
-    const searchQuery = 'cats training';
+    const searchQuery = "cats training";
 
     const result = await performRanking(linksWithContext, links, searchQuery);
 
     // Should return array of objects with link, linkWithContext, score, originalIndex
     expect(result).toBeInstanceOf(Array);
     expect(result.length).toBe(3);
-    
+
     // First result should be the dogs page since query is about dogs
-    expect(result[0].link).toBe('https://example.com/cats');
+    expect(result[0].link).toBe("https://example.com/cats");
-    
+
     // Each result should have required properties
-    result.forEach(item => {
+    result.forEach((item) => {
-      expect(item).toHaveProperty('link');
+      expect(item).toHaveProperty("link");
-      expect(item).toHaveProperty('linkWithContext');
+      expect(item).toHaveProperty("linkWithContext");
-      expect(item).toHaveProperty('score');
+      expect(item).toHaveProperty("score");
-      expect(item).toHaveProperty('originalIndex');
+      expect(item).toHaveProperty("originalIndex");
-      expect(typeof item.score).toBe('number');
+      expect(typeof item.score).toBe("number");
       expect(item.score).toBeGreaterThanOrEqual(0);
       expect(item.score).toBeLessThanOrEqual(1);
     });
 
     // Scores should be in descending order
     for (let i = 1; i < result.length; i++) {
-      expect(result[i].score).toBeLessThanOrEqual(result[i-1].score);
+      expect(result[i].score).toBeLessThanOrEqual(result[i - 1].score);
     }
   });
 
-  it('should handle empty inputs', async () => {
+  it("should handle empty inputs", async () => {
-    const result = await performRanking([], [], '');
+    const result = await performRanking([], [], "");
     expect(result).toEqual([]);
   });
 
-  it('should maintain original order for equal scores', async () => {
+  it("should maintain original order for equal scores", async () => {
     const linksWithContext = [
-      'url: https://example.com/1, title: Similar content A, description: test',
+      "url: https://example.com/1, title: Similar content A, description: test",
-      'url: https://example.com/2, title: Similar content B, description: test'
+      "url: https://example.com/2, title: Similar content B, description: test"
     ];
 
-    const links = [
+    const links = ["https://example.com/1", "https://example.com/2"];
-      'https://example.com/1',
-      'https://example.com/2'
-    ];
 
-    const searchQuery = 'test';
+    const searchQuery = "test";
 
     const result = await performRanking(linksWithContext, links, searchQuery);
 

apps/api/src/lib/ranker.ts

@@ -1,18 +1,18 @@
-import axios from 'axios';
+import axios from "axios";
-import { configDotenv } from 'dotenv';
+import { configDotenv } from "dotenv";
 import OpenAI from "openai";
 
 configDotenv();
 
 const openai = new OpenAI({
-  apiKey: process.env.OPENAI_API_KEY,
+  apiKey: process.env.OPENAI_API_KEY
 });
 
 async function getEmbedding(text: string) {
   const embedding = await openai.embeddings.create({
     model: "text-embedding-ada-002",
     input: text,
-    encoding_format: "float",
+    encoding_format: "float"
   });
 
   return embedding.data[0].embedding;
@@ -20,12 +20,8 @@ async function getEmbedding(text: string) {
 
 const cosineSimilarity = (vec1: number[], vec2: number[]): number => {
   const dotProduct = vec1.reduce((sum, val, i) => sum + val * vec2[i], 0);
-  const magnitude1 = Math.sqrt(
+  const magnitude1 = Math.sqrt(vec1.reduce((sum, val) => sum + val * val, 0));
-    vec1.reduce((sum, val) => sum + val * val, 0)
+  const magnitude2 = Math.sqrt(vec2.reduce((sum, val) => sum + val * val, 0));
-  );
-  const magnitude2 = Math.sqrt(
-    vec2.reduce((sum, val) => sum + val * val, 0)
-  );
   if (magnitude1 === 0 || magnitude2 === 0) return 0;
   return dotProduct / (magnitude1 * magnitude2);
 };
@@ -40,7 +36,11 @@ const textToVector = (searchQuery: string, text: string): number[] => {
   });
 };
 
-async function performRanking(linksWithContext: string[], links: string[], searchQuery: string) {
+async function performRanking(
+  linksWithContext: string[],
+  links: string[],
+  searchQuery: string
+) {
   try {
     // Handle invalid inputs
     if (!searchQuery || !linksWithContext.length || !links.length) {
@@ -54,27 +54,29 @@ async function performRanking(linksWithContext: string[], links: string[], searc
     const queryEmbedding = await getEmbedding(sanitizedQuery);
 
     // Generate embeddings for each link and calculate similarity
-    const linksAndScores = await Promise.all(linksWithContext.map(async (linkWithContext, index) => {
+    const linksAndScores = await Promise.all(
-      try {
+      linksWithContext.map(async (linkWithContext, index) => {
-        const linkEmbedding = await getEmbedding(linkWithContext);
+        try {
-        const score = cosineSimilarity(queryEmbedding, linkEmbedding);
+          const linkEmbedding = await getEmbedding(linkWithContext);
-        
+          const score = cosineSimilarity(queryEmbedding, linkEmbedding);
-        return { 
+
-          link: links[index],
+          return {
-          linkWithContext,
+            link: links[index],
-          score,
+            linkWithContext,
-          originalIndex: index
+            score,
-        };
+            originalIndex: index
-      } catch (err) {
+          };
-        // If embedding fails for a link, return with score 0
+        } catch (err) {
-        return {
+          // If embedding fails for a link, return with score 0
-          link: links[index],
+          return {
-          linkWithContext,
+            link: links[index],
-          score: 0,
+            linkWithContext,
-          originalIndex: index
+            score: 0,
-        };
+            originalIndex: index
-      }
+          };
-    }));
+        }
+      })
+    );
 
     // Sort links based on similarity scores while preserving original order for equal scores
     linksAndScores.sort((a, b) => {

apps/api/src/lib/scrape-events.ts

@@ -6,47 +6,61 @@ import { Engine } from "../scraper/scrapeURL/engines";
 configDotenv();
 
 export type ScrapeErrorEvent = {
-  type: "error",
+  type: "error";
-  message: string,
+  message: string;
-  stack?: string,
+  stack?: string;
-}
+};
 
 export type ScrapeScrapeEvent = {
-  type: "scrape",
+  type: "scrape";
-  url: string,
+  url: string;
-  worker?: string,
+  worker?: string;
-  method: Engine,
+  method: Engine;
   result: null | {
-    success: boolean,
+    success: boolean;
-    response_code?: number,
+    response_code?: number;
-    response_size?: number,
+    response_size?: number;
-    error?: string | object,
+    error?: string | object;
     // proxy?: string,
-    time_taken: number,
+    time_taken: number;
-  },
+  };
-}
+};
 
 export type ScrapeQueueEvent = {
-  type: "queue",
+  type: "queue";
-  event: "waiting" | "active" | "completed" | "paused" | "resumed" | "removed" | "failed",
+  event:
-  worker?: string,
+    | "waiting"
-}
+    | "active"
+    | "completed"
+    | "paused"
+    | "resumed"
+    | "removed"
+    | "failed";
+  worker?: string;
+};
 
-export type ScrapeEvent = ScrapeErrorEvent | ScrapeScrapeEvent | ScrapeQueueEvent;
+export type ScrapeEvent =
+  | ScrapeErrorEvent
+  | ScrapeScrapeEvent
+  | ScrapeQueueEvent;
 
 export class ScrapeEvents {
   static async insert(jobId: string, content: ScrapeEvent) {
     if (jobId === "TEST") return null;
-    
+
-    const useDbAuthentication = process.env.USE_DB_AUTHENTICATION === 'true';
+    const useDbAuthentication = process.env.USE_DB_AUTHENTICATION === "true";
     if (useDbAuthentication) {
       try {
-        const result = await supabase.from("scrape_events").insert({
+        const result = await supabase
-          job_id: jobId,
+          .from("scrape_events")
-          type: content.type,
+          .insert({
-          content: content,
+            job_id: jobId,
-          // created_at
+            type: content.type,
-        }).select().single();
+            content: content
+            // created_at
+          })
+          .select()
+          .single();
         return (result.data as any).id;
       } catch (error) {
         // logger.error(`Error inserting scrape event: ${error}`);
@@ -57,17 +71,25 @@ export class ScrapeEvents {
     return null;
   }
 
-  static async updateScrapeResult(logId: number | null, result: ScrapeScrapeEvent["result"]) {
+  static async updateScrapeResult(
+    logId: number | null,
+    result: ScrapeScrapeEvent["result"]
+  ) {
     if (logId === null) return;
 
     try {
-      const previousLog = (await supabase.from("scrape_events").select().eq("id", logId).single()).data as any;
+      const previousLog = (
-      await supabase.from("scrape_events").update({
+        await supabase.from("scrape_events").select().eq("id", logId).single()
-        content: {
+      ).data as any;
-          ...previousLog.content,
+      await supabase
-          result,
+        .from("scrape_events")
-        }
+        .update({
-      }).eq("id", logId);
+          content: {
+            ...previousLog.content,
+            result
+          }
+        })
+        .eq("id", logId);
     } catch (error) {
       logger.error(`Error updating scrape result: ${error}`);
     }
@@ -78,7 +100,7 @@ export class ScrapeEvents {
       await this.insert(((job as any).id ? (job as any).id : job) as string, {
         type: "queue",
         event,
-        worker: process.env.FLY_MACHINE_ID,
+        worker: process.env.FLY_MACHINE_ID
       });
     } catch (error) {
       logger.error(`Error logging job event: ${error}`);

apps/api/src/lib/supabase-jobs.ts

@@ -58,7 +58,7 @@ export const supabaseGetJobsByCrawlId = async (crawlId: string) => {
   const { data, error } = await supabase_service
     .from("firecrawl_jobs")
     .select()
-    .eq("crawl_id", crawlId)
+    .eq("crawl_id", crawlId);
 
   if (error) {
     logger.error(`Error in supabaseGetJobsByCrawlId: ${error}`);
@@ -73,7 +73,6 @@ export const supabaseGetJobsByCrawlId = async (crawlId: string) => {
   return data;
 };
 
-
 export const supabaseGetJobByIdOnlyData = async (jobId: string) => {
   const { data, error } = await supabase_service
     .from("firecrawl_jobs")
@@ -90,4 +89,4 @@ export const supabaseGetJobByIdOnlyData = async (jobId: string) => {
   }
 
   return data;
-};
+};

apps/api/src/lib/timeout.ts

@@ -1 +1 @@
-export const axiosTimeout = 5000;
+export const axiosTimeout = 5000;

apps/api/src/lib/validateUrl.test.ts

@@ -18,7 +18,10 @@ describe("isSameDomain", () => {
   });
 
   it("should return true for a subdomain with different protocols", () => {
-    const result = isSameDomain("https://sub.example.com", "http://example.com");
+    const result = isSameDomain(
+      "https://sub.example.com",
+      "http://example.com"
+    );
     expect(result).toBe(true);
   });
 
@@ -30,32 +33,44 @@ describe("isSameDomain", () => {
   });
 
   it("should return true for a subdomain with www prefix", () => {
-    const result = isSameDomain("http://www.sub.example.com", "http://example.com");
+    const result = isSameDomain(
+      "http://www.sub.example.com",
+      "http://example.com"
+    );
     expect(result).toBe(true);
   });
 
   it("should return true for the same domain with www prefix", () => {
-    const result = isSameDomain("http://docs.s.s.example.com", "http://example.com");
+    const result = isSameDomain(
+      "http://docs.s.s.example.com",
+      "http://example.com"
+    );
     expect(result).toBe(true);
   });
 });
 
-
-    
-
 describe("isSameSubdomain", () => {
   it("should return false for a subdomain", () => {
-    const result = isSameSubdomain("http://example.com", "http://docs.example.com");
+    const result = isSameSubdomain(
+      "http://example.com",
+      "http://docs.example.com"
+    );
     expect(result).toBe(false);
   });
 
   it("should return true for the same subdomain", () => {
-    const result = isSameSubdomain("http://docs.example.com", "http://docs.example.com");
+    const result = isSameSubdomain(
+      "http://docs.example.com",
+      "http://docs.example.com"
+    );
     expect(result).toBe(true);
   });
 
   it("should return false for different subdomains", () => {
-    const result = isSameSubdomain("http://docs.example.com", "http://blog.example.com");
+    const result = isSameSubdomain(
+      "http://docs.example.com",
+      "http://blog.example.com"
+    );
     expect(result).toBe(false);
   });
 
@@ -72,17 +87,26 @@ describe("isSameSubdomain", () => {
   });
 
   it("should return true for the same subdomain with different protocols", () => {
-    const result = isSameSubdomain("https://docs.example.com", "http://docs.example.com");
+    const result = isSameSubdomain(
+      "https://docs.example.com",
+      "http://docs.example.com"
+    );
     expect(result).toBe(true);
   });
 
   it("should return true for the same subdomain with www prefix", () => {
-    const result = isSameSubdomain("http://www.docs.example.com", "http://docs.example.com");
+    const result = isSameSubdomain(
+      "http://www.docs.example.com",
+      "http://docs.example.com"
+    );
     expect(result).toBe(true);
   });
 
   it("should return false for a subdomain with www prefix and different subdomain", () => {
-    const result = isSameSubdomain("http://www.docs.example.com", "http://blog.example.com");
+    const result = isSameSubdomain(
+      "http://www.docs.example.com",
+      "http://blog.example.com"
+    );
     expect(result).toBe(false);
   });
 });
@@ -116,19 +140,13 @@ describe("removeDuplicateUrls", () => {
   });
 
   it("should prefer https over http", () => {
-    const urls = [
+    const urls = ["http://example.com", "https://example.com"];
-      "http://example.com",
-      "https://example.com"
-    ];
     const result = removeDuplicateUrls(urls);
     expect(result).toEqual(["https://example.com"]);
   });
 
   it("should prefer non-www over www", () => {
-    const urls = [
+    const urls = ["https://www.example.com", "https://example.com"];
-      "https://www.example.com",
-      "https://example.com"
-    ];
     const result = removeDuplicateUrls(urls);
     expect(result).toEqual(["https://example.com"]);
   });
@@ -140,19 +158,13 @@ describe("removeDuplicateUrls", () => {
   });
 
   it("should handle URLs with different cases", () => {
-    const urls = [
+    const urls = ["https://EXAMPLE.com", "https://example.com"];
-      "https://EXAMPLE.com",
-      "https://example.com"
-    ];
     const result = removeDuplicateUrls(urls);
     expect(result).toEqual(["https://EXAMPLE.com"]);
   });
 
   it("should handle URLs with trailing slashes", () => {
-    const urls = [
+    const urls = ["https://example.com", "https://example.com/"];
-      "https://example.com",
-      "https://example.com/"
-    ];
     const result = removeDuplicateUrls(urls);
     expect(result).toEqual(["https://example.com"]);
   });

apps/api/src/lib/validateUrl.ts

@@ -58,9 +58,9 @@ export const checkUrl = (url: string) => {
  * Same domain check
  * It checks if the domain of the url is the same as the base url
  * It accounts true for subdomains and www.subdomains
- * @param url 
+ * @param url
- * @param baseUrl 
+ * @param baseUrl
- * @returns 
+ * @returns
  */
 export function isSameDomain(url: string, baseUrl: string) {
   const { urlObj: urlObj1, error: error1 } = getURLobj(url);
@@ -74,16 +74,21 @@ export function isSameDomain(url: string, baseUrl: string) {
   const typedUrlObj2 = urlObj2 as URL;
 
   const cleanHostname = (hostname: string) => {
-    return hostname.startsWith('www.') ? hostname.slice(4) : hostname;
+    return hostname.startsWith("www.") ? hostname.slice(4) : hostname;
   };
 
-  const domain1 = cleanHostname(typedUrlObj1.hostname).split('.').slice(-2).join('.');
+  const domain1 = cleanHostname(typedUrlObj1.hostname)
-  const domain2 = cleanHostname(typedUrlObj2.hostname).split('.').slice(-2).join('.');
+    .split(".")
+    .slice(-2)
+    .join(".");
+  const domain2 = cleanHostname(typedUrlObj2.hostname)
+    .split(".")
+    .slice(-2)
+    .join(".");
 
   return domain1 === domain2;
 }
 
-
 export function isSameSubdomain(url: string, baseUrl: string) {
   const { urlObj: urlObj1, error: error1 } = getURLobj(url);
   const { urlObj: urlObj2, error: error2 } = getURLobj(baseUrl);
@@ -96,20 +101,31 @@ export function isSameSubdomain(url: string, baseUrl: string) {
   const typedUrlObj2 = urlObj2 as URL;
 
   const cleanHostname = (hostname: string) => {
-    return hostname.startsWith('www.') ? hostname.slice(4) : hostname;
+    return hostname.startsWith("www.") ? hostname.slice(4) : hostname;
   };
 
-  const domain1 = cleanHostname(typedUrlObj1.hostname).split('.').slice(-2).join('.');
+  const domain1 = cleanHostname(typedUrlObj1.hostname)
-  const domain2 = cleanHostname(typedUrlObj2.hostname).split('.').slice(-2).join('.');
+    .split(".")
+    .slice(-2)
+    .join(".");
+  const domain2 = cleanHostname(typedUrlObj2.hostname)
+    .split(".")
+    .slice(-2)
+    .join(".");
 
-  const subdomain1 = cleanHostname(typedUrlObj1.hostname).split('.').slice(0, -2).join('.');
+  const subdomain1 = cleanHostname(typedUrlObj1.hostname)
-  const subdomain2 = cleanHostname(typedUrlObj2.hostname).split('.').slice(0, -2).join('.');
+    .split(".")
+    .slice(0, -2)
+    .join(".");
+  const subdomain2 = cleanHostname(typedUrlObj2.hostname)
+    .split(".")
+    .slice(0, -2)
+    .join(".");
 
   // Check if the domains are the same and the subdomains are the same
   return domain1 === domain2 && subdomain1 === subdomain2;
 }
 
-
 export const checkAndUpdateURLForMap = (url: string) => {
   if (!protocolIncluded(url)) {
     url = `http://${url}`;
@@ -119,7 +135,6 @@ export const checkAndUpdateURLForMap = (url: string) => {
     url = url.slice(0, -1);
   }
 
-
   const { error, urlObj } = getURLobj(url);
   if (error) {
     throw new Error("Invalid URL");
@@ -137,34 +152,34 @@ export const checkAndUpdateURLForMap = (url: string) => {
   return { urlObj: typedUrlObj, url: url };
 };
 
-
-
-
-
 export function removeDuplicateUrls(urls: string[]): string[] {
   const urlMap = new Map<string, string>();
 
   for (const url of urls) {
     const parsedUrl = new URL(url);
     const protocol = parsedUrl.protocol;
-    const hostname = parsedUrl.hostname.replace(/^www\./, '');
+    const hostname = parsedUrl.hostname.replace(/^www\./, "");
     const path = parsedUrl.pathname + parsedUrl.search + parsedUrl.hash;
-    
+
     const key = `${hostname}${path}`;
-    
+
     if (!urlMap.has(key)) {
       urlMap.set(key, url);
     } else {
       const existingUrl = new URL(urlMap.get(key)!);
       const existingProtocol = existingUrl.protocol;
-      
+
-      if (protocol === 'https:' && existingProtocol === 'http:') {
+      if (protocol === "https:" && existingProtocol === "http:") {
         urlMap.set(key, url);
-      } else if (protocol === existingProtocol && !parsedUrl.hostname.startsWith('www.') && existingUrl.hostname.startsWith('www.')) {
+      } else if (
+        protocol === existingProtocol &&
+        !parsedUrl.hostname.startsWith("www.") &&
+        existingUrl.hostname.startsWith("www.")
+      ) {
         urlMap.set(key, url);
       }
     }
   }
 
   return [...new Set(Array.from(urlMap.values()))];
-}
+}

apps/api/src/lib/withAuth.ts

@@ -8,10 +8,10 @@ let warningCount = 0;
 
 export function withAuth<T, U extends any[]>(
   originalFunction: (...args: U) => Promise<T>,
-  mockSuccess: T,
+  mockSuccess: T
 ) {
   return async function (...args: U): Promise<T> {
-    const useDbAuthentication = process.env.USE_DB_AUTHENTICATION === 'true';
+    const useDbAuthentication = process.env.USE_DB_AUTHENTICATION === "true";
     if (!useDbAuthentication) {
       if (warningCount < 5) {
         logger.warn("You're bypassing authentication");

apps/api/src/main/runWebScraper.ts

@@ -2,7 +2,7 @@ import { Job } from "bullmq";
 import {
   WebScraperOptions,
   RunWebScraperParams,
-  RunWebScraperResult,
+  RunWebScraperResult
 } from "../types";
 import { billTeam } from "../services/billing/credit_billing";
 import { Document } from "../controllers/v1/types";
@@ -10,25 +10,31 @@ import { supabase_service } from "../services/supabase";
 import { logger } from "../lib/logger";
 import { ScrapeEvents } from "../lib/scrape-events";
 import { configDotenv } from "dotenv";
-import { EngineResultsTracker, scrapeURL, ScrapeUrlResponse } from "../scraper/scrapeURL";
+import {
+  EngineResultsTracker,
+  scrapeURL,
+  ScrapeUrlResponse
+} from "../scraper/scrapeURL";
 import { Engine } from "../scraper/scrapeURL/engines";
 configDotenv();
 
 export async function startWebScraperPipeline({
   job,
-  token,
+  token
 }: {
   job: Job<WebScraperOptions> & { id: string };
   token: string;
 }) {
-  return (await runWebScraper({
+  return await runWebScraper({
     url: job.data.url,
     mode: job.data.mode,
     scrapeOptions: {
       ...job.data.scrapeOptions,
-      ...(job.data.crawl_id ? ({
+      ...(job.data.crawl_id
-        formats: job.data.scrapeOptions.formats.concat(["rawHtml"]),
+        ? {
-      }): {}),
+            formats: job.data.scrapeOptions.formats.concat(["rawHtml"])
+          }
+        : {})
     },
     internalOptions: job.data.internalOptions,
     // onSuccess: (result, mode) => {
@@ -42,8 +48,8 @@ export async function startWebScraperPipeline({
     team_id: job.data.team_id,
     bull_job_id: job.id.toString(),
     priority: job.opts.priority,
-    is_scrape: job.data.is_scrape ?? false,
+    is_scrape: job.data.is_scrape ?? false
-  }));
+  });
 }
 
 export async function runWebScraper({
@@ -56,28 +62,40 @@ export async function runWebScraper({
   team_id,
   bull_job_id,
   priority,
-  is_scrape=false,
+  is_scrape = false
 }: RunWebScraperParams): Promise<ScrapeUrlResponse> {
   let response: ScrapeUrlResponse | undefined = undefined;
   let engines: EngineResultsTracker = {};
   try {
-    response = await scrapeURL(bull_job_id, url, scrapeOptions, { priority, ...internalOptions });
+    response = await scrapeURL(bull_job_id, url, scrapeOptions, {
+      priority,
+      ...internalOptions
+    });
     if (!response.success) {
       if (response.error instanceof Error) {
         throw response.error;
       } else {
-        throw new Error("scrapeURL error: " + (Array.isArray(response.error) ? JSON.stringify(response.error) : typeof response.error === "object" ? JSON.stringify({ ...response.error }) : response.error));
+        throw new Error(
+          "scrapeURL error: " +
+            (Array.isArray(response.error)
+              ? JSON.stringify(response.error)
+              : typeof response.error === "object"
+                ? JSON.stringify({ ...response.error })
+                : response.error)
+        );
       }
     }
 
-    if(is_scrape === false) {
+    if (is_scrape === false) {
       let creditsToBeBilled = 1; // Assuming 1 credit per document
       if (scrapeOptions.extract) {
         creditsToBeBilled = 5;
       }
 
-      billTeam(team_id, undefined, creditsToBeBilled).catch(error => {
+      billTeam(team_id, undefined, creditsToBeBilled).catch((error) => {
-        logger.error(`Failed to bill team ${team_id} for ${creditsToBeBilled} credits: ${error}`);
+        logger.error(
+          `Failed to bill team ${team_id} for ${creditsToBeBilled} credits: ${error}`
+        );
         // Optionally, you could notify an admin or add to a retry queue here
       });
     }
@@ -88,42 +106,70 @@ export async function runWebScraper({
     engines = response.engines;
     return response;
   } catch (error) {
-    engines = response !== undefined ? response.engines : ((typeof error === "object" && error !== null ? (error as any).results ?? {} : {}));
+    engines =
+      response !== undefined
+        ? response.engines
+        : typeof error === "object" && error !== null
+          ? ((error as any).results ?? {})
+          : {};
 
     if (response !== undefined) {
       return {
         ...response,
         success: false,
-        error,
+        error
-      }
+      };
     } else {
-      return { success: false, error, logs: ["no logs -- error coming from runWebScraper"], engines };
+      return {
+        success: false,
+        error,
+        logs: ["no logs -- error coming from runWebScraper"],
+        engines
+      };
     }
     // onError(error);
   } finally {
-    const engineOrder = Object.entries(engines).sort((a, b) => a[1].startedAt - b[1].startedAt).map(x => x[0]) as Engine[];
+    const engineOrder = Object.entries(engines)
+      .sort((a, b) => a[1].startedAt - b[1].startedAt)
+      .map((x) => x[0]) as Engine[];
 
     for (const engine of engineOrder) {
-      const result = engines[engine] as Exclude<EngineResultsTracker[Engine], undefined>;
+      const result = engines[engine] as Exclude<
+        EngineResultsTracker[Engine],
+        undefined
+      >;
       ScrapeEvents.insert(bull_job_id, {
         type: "scrape",
         url,
         method: engine,
         result: {
           success: result.state === "success",
-          response_code: (result.state === "success" ? result.result.statusCode : undefined),
+          response_code:
-          response_size: (result.state === "success" ? result.result.html.length : undefined),
+            result.state === "success" ? result.result.statusCode : undefined,
-          error: (result.state === "error" ? result.error : result.state === "timeout" ? "Timed out" : undefined),
+          response_size:
-          time_taken: result.finishedAt - result.startedAt,
+            result.state === "success" ? result.result.html.length : undefined,
-        },
+          error:
+            result.state === "error"
+              ? result.error
+              : result.state === "timeout"
+                ? "Timed out"
+                : undefined,
+          time_taken: result.finishedAt - result.startedAt
+        }
       });
     }
   }
 }
 
-const saveJob = async (job: Job, result: any, token: string, mode: string, engines?: EngineResultsTracker) => {
+const saveJob = async (
+  job: Job,
+  result: any,
+  token: string,
+  mode: string,
+  engines?: EngineResultsTracker
+) => {
   try {
-    const useDbAuthentication = process.env.USE_DB_AUTHENTICATION === 'true';
+    const useDbAuthentication = process.env.USE_DB_AUTHENTICATION === "true";
     if (useDbAuthentication) {
       const { data, error } = await supabase_service
         .from("firecrawl_jobs")
@@ -140,12 +186,12 @@ const saveJob = async (job: Job, result: any, token: string, mode: string, engin
       // } catch (error) {
       //   // I think the job won't exist here anymore
       // }
-    // } else {
+      // } else {
-    //   try {
+      //   try {
-    //     await job.moveToCompleted(result, token, false);
+      //     await job.moveToCompleted(result, token, false);
-    //   } catch (error) {
+      //   } catch (error) {
-    //     // I think the job won't exist here anymore
+      //     // I think the job won't exist here anymore
-    //   }
+      //   }
     }
     ScrapeEvents.logJobEvent(job, "completed");
   } catch (error) {

apps/api/src/routes/admin.ts

@@ -4,7 +4,7 @@ import {
   autoscalerController,
   checkQueuesController,
   cleanBefore24hCompleteJobsController,
-  queuesController,
+  queuesController
 } from "../controllers/v0/admin/queue";
 import { wrap } from "./v1";
 import { acucCacheClearController } from "../controllers/v0/admin/acuc-cache-clear";
@@ -26,10 +26,7 @@ adminRouter.get(
   checkQueuesController
 );
 
-adminRouter.get(
+adminRouter.get(`/admin/${process.env.BULL_AUTH_KEY}/queues`, queuesController);
-  `/admin/${process.env.BULL_AUTH_KEY}/queues`,
-  queuesController
-);
 
 adminRouter.get(
   `/admin/${process.env.BULL_AUTH_KEY}/autoscaler`,
@@ -38,5 +35,5 @@ adminRouter.get(
 
 adminRouter.post(
   `/admin/${process.env.BULL_AUTH_KEY}/acuc-cache-clear`,
-  wrap(acucCacheClearController),
+  wrap(acucCacheClearController)
 );

apps/api/src/routes/v0.ts

@@ -27,4 +27,4 @@ v0Router.post("/v0/search", searchController);
 
 // Health/Probe routes
 v0Router.get("/v0/health/liveness", livenessController);
-v0Router.get("/v0/health/readiness", readinessController);
+v0Router.get("/v0/health/readiness", readinessController);

apps/api/src/routes/v1.ts

@@ -4,7 +4,12 @@ import { crawlController } from "../controllers/v1/crawl";
 import { scrapeController } from "../../src/controllers/v1/scrape";
 import { crawlStatusController } from "../controllers/v1/crawl-status";
 import { mapController } from "../controllers/v1/map";
-import { ErrorResponse, RequestWithACUC, RequestWithAuth, RequestWithMaybeAuth } from "../controllers/v1/types";
+import {
+  ErrorResponse,
+  RequestWithACUC,
+  RequestWithAuth,
+  RequestWithMaybeAuth
+} from "../controllers/v1/types";
 import { RateLimiterMode } from "../types";
 import { authenticateUser } from "../controllers/auth";
 import { createIdempotencyKey } from "../services/idempotency/create";
@@ -27,89 +32,114 @@ import { extractController } from "../controllers/v1/extract";
 // import { livenessController } from "../controllers/v1/liveness";
 // import { readinessController } from "../controllers/v1/readiness";
 
-function checkCreditsMiddleware(minimum?: number): (req: RequestWithAuth, res: Response, next: NextFunction) => void {
+function checkCreditsMiddleware(
-    return (req, res, next) => {
+  minimum?: number
-        (async () => {
+): (req: RequestWithAuth, res: Response, next: NextFunction) => void {
-            if (!minimum && req.body) {
+  return (req, res, next) => {
-                minimum = (req.body as any)?.limit ?? (req.body as any)?.urls?.length ?? 1;
-            }
-            const { success, remainingCredits, chunk } = await checkTeamCredits(req.acuc, req.auth.team_id, minimum ?? 1);
-            if (chunk) {
-                req.acuc = chunk;
-            }
-            if (!success) {
-                logger.error(`Insufficient credits: ${JSON.stringify({ team_id: req.auth.team_id, minimum, remainingCredits })}`);
-                if (!res.headersSent) {
-                    return res.status(402).json({ success: false, error: "Insufficient credits to perform this request. For more credits, you can upgrade your plan at https://firecrawl.dev/pricing or try changing the request limit to a lower value." });
-                }
-            }
-            req.account = { remainingCredits };
-            next();
-        })()
-            .catch(err => next(err));
-    };
-}
-
-export function authMiddleware(rateLimiterMode: RateLimiterMode): (req: RequestWithMaybeAuth, res: Response, next: NextFunction) => void {
-    return (req, res, next) => {
-        (async () => {
-            const auth = await authenticateUser(
-                req,
-                res,
-                rateLimiterMode,
-            );
-
-            if (!auth.success) {
-                if (!res.headersSent) {
-                    return res.status(auth.status).json({ success: false, error: auth.error });
-                } else {
-                    return;
-                }
-            }
-
-            const { team_id, plan, chunk } = auth;
-
-            req.auth = { team_id, plan };
-            req.acuc = chunk ?? undefined;
-            if (chunk) {
-                req.account = { remainingCredits: chunk.remaining_credits };
-            }
-            next();
-        })()
-            .catch(err => next(err));
-    }
-}
-
-function idempotencyMiddleware(req: Request, res: Response, next: NextFunction) {
     (async () => {
-        if (req.headers["x-idempotency-key"]) {
+      if (!minimum && req.body) {
-            const isIdempotencyValid = await validateIdempotencyKey(req);
+        minimum =
-            if (!isIdempotencyValid) {
+          (req.body as any)?.limit ?? (req.body as any)?.urls?.length ?? 1;
-                if (!res.headersSent) {
+      }
-                    return res.status(409).json({ success: false, error: "Idempotency key already used" });
+      const { success, remainingCredits, chunk } = await checkTeamCredits(
-                }
+        req.acuc,
-            }
+        req.auth.team_id,
-            createIdempotencyKey(req);
+        minimum ?? 1
+      );
+      if (chunk) {
+        req.acuc = chunk;
+      }
+      if (!success) {
+        logger.error(
+          `Insufficient credits: ${JSON.stringify({ team_id: req.auth.team_id, minimum, remainingCredits })}`
+        );
+        if (!res.headersSent) {
+          return res
+            .status(402)
+            .json({
+              success: false,
+              error:
+                "Insufficient credits to perform this request. For more credits, you can upgrade your plan at https://firecrawl.dev/pricing or try changing the request limit to a lower value."
+            });
         }
-        next();
+      }
-    })()
+      req.account = { remainingCredits };
-        .catch(err => next(err));
+      next();
+    })().catch((err) => next(err));
+  };
+}
+
+export function authMiddleware(
+  rateLimiterMode: RateLimiterMode
+): (req: RequestWithMaybeAuth, res: Response, next: NextFunction) => void {
+  return (req, res, next) => {
+    (async () => {
+      const auth = await authenticateUser(req, res, rateLimiterMode);
+
+      if (!auth.success) {
+        if (!res.headersSent) {
+          return res
+            .status(auth.status)
+            .json({ success: false, error: auth.error });
+        } else {
+          return;
+        }
+      }
+
+      const { team_id, plan, chunk } = auth;
+
+      req.auth = { team_id, plan };
+      req.acuc = chunk ?? undefined;
+      if (chunk) {
+        req.account = { remainingCredits: chunk.remaining_credits };
+      }
+      next();
+    })().catch((err) => next(err));
+  };
+}
+
+function idempotencyMiddleware(
+  req: Request,
+  res: Response,
+  next: NextFunction
+) {
+  (async () => {
+    if (req.headers["x-idempotency-key"]) {
+      const isIdempotencyValid = await validateIdempotencyKey(req);
+      if (!isIdempotencyValid) {
+        if (!res.headersSent) {
+          return res
+            .status(409)
+            .json({ success: false, error: "Idempotency key already used" });
+        }
+      }
+      createIdempotencyKey(req);
+    }
+    next();
+  })().catch((err) => next(err));
 }
 
 function blocklistMiddleware(req: Request, res: Response, next: NextFunction) {
-    if (typeof req.body.url === "string" && isUrlBlocked(req.body.url)) {
+  if (typeof req.body.url === "string" && isUrlBlocked(req.body.url)) {
-        if (!res.headersSent) {
+    if (!res.headersSent) {
-            return res.status(403).json({ success: false, error: "URL is blocked intentionally. Firecrawl currently does not support social media scraping due to policy restrictions." });
+      return res
-        }
+        .status(403)
+        .json({
+          success: false,
+          error:
+            "URL is blocked intentionally. Firecrawl currently does not support social media scraping due to policy restrictions."
+        });
     }
-    next();
+  }
+  next();
 }
 
-export function wrap(controller: (req: Request, res: Response) => Promise<any>): (req: Request, res: Response, next: NextFunction) => any {
+export function wrap(
-    return (req, res, next) => {
+  controller: (req: Request, res: Response) => Promise<any>
-        controller(req, res)
+): (req: Request, res: Response, next: NextFunction) => any {
-            .catch(err => next(err))
+  return (req, res, next) => {
-    }
+    controller(req, res).catch((err) => next(err));
+  };
 }
 
 expressWs(express());
@@ -117,80 +147,71 @@ expressWs(express());
 export const v1Router = express.Router();
 
 v1Router.post(
-    "/scrape",
+  "/scrape",
-    authMiddleware(RateLimiterMode.Scrape),
+  authMiddleware(RateLimiterMode.Scrape),
-    checkCreditsMiddleware(1),
+  checkCreditsMiddleware(1),
-    blocklistMiddleware,
+  blocklistMiddleware,
-    wrap(scrapeController)
+  wrap(scrapeController)
 );
 
 v1Router.post(
-    "/crawl",
+  "/crawl",
-    authMiddleware(RateLimiterMode.Crawl),
+  authMiddleware(RateLimiterMode.Crawl),
-    checkCreditsMiddleware(),
+  checkCreditsMiddleware(),
-    blocklistMiddleware,
+  blocklistMiddleware,
-    idempotencyMiddleware,
+  idempotencyMiddleware,
-    wrap(crawlController)
+  wrap(crawlController)
 );
 
 v1Router.post(
-    "/batch/scrape",
+  "/batch/scrape",
-    authMiddleware(RateLimiterMode.Crawl),
+  authMiddleware(RateLimiterMode.Crawl),
-    checkCreditsMiddleware(),
+  checkCreditsMiddleware(),
-    blocklistMiddleware,
+  blocklistMiddleware,
-    idempotencyMiddleware,
+  idempotencyMiddleware,
-    wrap(batchScrapeController)
+  wrap(batchScrapeController)
 );
 
 v1Router.post(
-    "/map",
+  "/map",
-    authMiddleware(RateLimiterMode.Map),
+  authMiddleware(RateLimiterMode.Map),
-    checkCreditsMiddleware(1),
+  checkCreditsMiddleware(1),
-    blocklistMiddleware,
+  blocklistMiddleware,
-    wrap(mapController)
+  wrap(mapController)
 );
 
 v1Router.get(
-    "/crawl/:jobId",
+  "/crawl/:jobId",
-    authMiddleware(RateLimiterMode.CrawlStatus),
+  authMiddleware(RateLimiterMode.CrawlStatus),
-    wrap(crawlStatusController)
+  wrap(crawlStatusController)
 );
 
 v1Router.get(
-    "/batch/scrape/:jobId",
+  "/batch/scrape/:jobId",
-    authMiddleware(RateLimiterMode.CrawlStatus),
+  authMiddleware(RateLimiterMode.CrawlStatus),
-    // Yes, it uses the same controller as the normal crawl status controller
+  // Yes, it uses the same controller as the normal crawl status controller
-    wrap((req:any, res):any => crawlStatusController(req, res, true))
+  wrap((req: any, res): any => crawlStatusController(req, res, true))
 );
 
+v1Router.get("/scrape/:jobId", wrap(scrapeStatusController));
+
 v1Router.get(
-    "/scrape/:jobId",
+  "/concurrency-check",
-    wrap(scrapeStatusController)
+  authMiddleware(RateLimiterMode.CrawlStatus),
+  wrap(concurrencyCheckController)
 );
 
-v1Router.get(
+v1Router.ws("/crawl/:jobId", crawlStatusWSController);
-    "/concurrency-check",
-    authMiddleware(RateLimiterMode.CrawlStatus),
-    wrap(concurrencyCheckController)
-);
-
-v1Router.ws(
-    "/crawl/:jobId",
-    crawlStatusWSController
-);
 
 v1Router.post(
-    "/extract",
+  "/extract",
-    authMiddleware(RateLimiterMode.Scrape),
+  authMiddleware(RateLimiterMode.Scrape),
-    checkCreditsMiddleware(1),
+  checkCreditsMiddleware(1),
-    wrap(extractController)
+  wrap(extractController)
 );
 
-
-
 // v1Router.post("/crawlWebsitePreview", crawlPreviewController);
 
-
 v1Router.delete(
   "/crawl/:jobId",
   authMiddleware(RateLimiterMode.CrawlStatus),
@@ -207,4 +228,3 @@ v1Router.delete(
 // Health/Probe routes
 // v1Router.get("/health/liveness", livenessController);
 // v1Router.get("/health/readiness", readinessController);
-

apps/api/src/run-req.ts

@@ -18,19 +18,19 @@ async function sendCrawl(result: Result): Promise<string | undefined> {
       {
         url: url,
         crawlerOptions: {
-          limit: 75,
+          limit: 75
         },
         pageOptions: {
           includeHtml: true,
           replaceAllPathsWithAbsolutePaths: true,
-          waitFor: 1000,
+          waitFor: 1000
-        },
+        }
       },
       {
         headers: {
           "Content-Type": "application/json",
-          Authorization: `Bearer `,
+          Authorization: `Bearer `
-        },
+        }
       }
     );
     result.idempotency_key = idempotencyKey;
@@ -51,8 +51,8 @@ async function getContent(result: Result): Promise<boolean> {
         {
           headers: {
             "Content-Type": "application/json",
-            Authorization: `Bearer `,
+            Authorization: `Bearer `
-          },
+          }
         }
       );
       if (response.data.status === "completed") {
@@ -95,9 +95,9 @@ async function processResults(results: Result[]): Promise<void> {
       // Save the result to the file
       try {
         // Save job id along with the start_url
-        const resultWithJobId = results.map(r => ({
+        const resultWithJobId = results.map((r) => ({
           start_url: r.start_url,
-          job_id: r.job_id,
+          job_id: r.job_id
         }));
         await fs.writeFile(
           "results_with_job_id_4000_6000.json",

apps/api/src/scraper/WebScraper/__tests__/crawler.test.ts

@@ -1,27 +1,29 @@
 // crawler.test.ts
-import { WebCrawler } from '../crawler';
+import { WebCrawler } from "../crawler";
-import axios from 'axios';
+import axios from "axios";
-import robotsParser from 'robots-parser';
+import robotsParser from "robots-parser";
 
-jest.mock('axios');
+jest.mock("axios");
-jest.mock('robots-parser');
+jest.mock("robots-parser");
 
-describe('WebCrawler', () => {
+describe("WebCrawler", () => {
   let crawler: WebCrawler;
   const mockAxios = axios as jest.Mocked<typeof axios>;
-  const mockRobotsParser = robotsParser as jest.MockedFunction<typeof robotsParser>;
+  const mockRobotsParser = robotsParser as jest.MockedFunction<
+    typeof robotsParser
+  >;
 
   let maxCrawledDepth: number;
 
   beforeEach(() => {
     // Setup default mocks
     mockAxios.get.mockImplementation((url) => {
-      if (url.includes('robots.txt')) {
+      if (url.includes("robots.txt")) {
-        return Promise.resolve({ data: 'User-agent: *\nAllow: /' });
+        return Promise.resolve({ data: "User-agent: *\nAllow: /" });
-      } else if (url.includes('sitemap.xml')) {
+      } else if (url.includes("sitemap.xml")) {
-        return Promise.resolve({ data: 'sitemap content' }); // You would normally parse this to URLs
+        return Promise.resolve({ data: "sitemap content" }); // You would normally parse this to URLs
       }
-      return Promise.resolve({ data: '<html></html>' });
+      return Promise.resolve({ data: "<html></html>" });
     });
 
     mockRobotsParser.mockReturnValue({
@@ -30,42 +32,45 @@ describe('WebCrawler', () => {
       getMatchingLineNumber: jest.fn().mockReturnValue(0),
       getCrawlDelay: jest.fn().mockReturnValue(0),
       getSitemaps: jest.fn().mockReturnValue([]),
-      getPreferredHost: jest.fn().mockReturnValue('example.com')
+      getPreferredHost: jest.fn().mockReturnValue("example.com")
     });
   });
 
-  it('should respect the limit parameter by not returning more links than specified', async () => {
+  it("should respect the limit parameter by not returning more links than specified", async () => {
-    const initialUrl = 'http://example.com';
+    const initialUrl = "http://example.com";
-    const limit = 2;  // Set a limit for the number of links
+    const limit = 2; // Set a limit for the number of links
 
     crawler = new WebCrawler({
       jobId: "TEST",
       initialUrl: initialUrl,
       includes: [],
       excludes: [],
-      limit: limit,  // Apply the limit
+      limit: limit, // Apply the limit
       maxCrawledDepth: 10
     });
 
     // Mock sitemap fetching function to return more links than the limit
-    crawler['tryFetchSitemapLinks'] = jest.fn().mockResolvedValue([
+    crawler["tryFetchSitemapLinks"] = jest
-      initialUrl,
+      .fn()
-      initialUrl + '/page1',
+      .mockResolvedValue([
-      initialUrl + '/page2',
+        initialUrl,
-      initialUrl + '/page3'
+        initialUrl + "/page1",
-    ]);
+        initialUrl + "/page2",
+        initialUrl + "/page3"
+      ]);
 
-    const filteredLinks = crawler['filterLinks'](
+    const filteredLinks = crawler["filterLinks"](
-      [initialUrl, initialUrl + '/page1', initialUrl + '/page2', initialUrl + '/page3'],
+      [
+        initialUrl,
+        initialUrl + "/page1",
+        initialUrl + "/page2",
+        initialUrl + "/page3"
+      ],
       limit,
       10
     );
 
-    expect(filteredLinks.length).toBe(limit);  // Check if the number of results respects the limit
+    expect(filteredLinks.length).toBe(limit); // Check if the number of results respects the limit
-    expect(filteredLinks).toEqual([
+    expect(filteredLinks).toEqual([initialUrl, initialUrl + "/page1"]);
-      initialUrl,
-      initialUrl + '/page1'
-    ]);
   });
 });
-

apps/api/src/scraper/WebScraper/__tests__/dns.test.ts

@@ -1,5 +1,5 @@
-import CacheableLookup  from 'cacheable-lookup';
+import CacheableLookup from "cacheable-lookup";
-import https from 'node:https';
+import https from "node:https";
 import axios from "axios";
 
 describe("DNS", () => {

apps/api/src/scraper/WebScraper/crawler.ts

@@ -40,7 +40,7 @@ export class WebCrawler {
     allowBackwardCrawling = false,
     allowExternalContentLinks = false,
     allowSubdomains = false,
-    ignoreRobotsTxt = false,
+    ignoreRobotsTxt = false
   }: {
     jobId: string;
     initialUrl: string;
@@ -75,9 +75,14 @@ export class WebCrawler {
     this.logger = _logger.child({ crawlId: this.jobId, module: "WebCrawler" });
   }
 
-  public filterLinks(sitemapLinks: string[], limit: number, maxDepth: number, fromMap: boolean = false): string[] {
+  public filterLinks(
+    sitemapLinks: string[],
+    limit: number,
+    maxDepth: number,
+    fromMap: boolean = false
+  ): string[] {
     // If the initial URL is a sitemap.xml, skip filtering
-    if (this.initialUrl.endsWith('sitemap.xml') && fromMap) {
+    if (this.initialUrl.endsWith("sitemap.xml") && fromMap) {
       return sitemapLinks.slice(0, limit);
     }
 
@@ -87,14 +92,17 @@ export class WebCrawler {
         try {
           url = new URL(link.trim(), this.baseUrl);
         } catch (error) {
-          this.logger.debug(`Error processing link: ${link}`, { link, error, method: "filterLinks" });
+          this.logger.debug(`Error processing link: ${link}`, {
+            link,
+            error,
+            method: "filterLinks"
+          });
           return false;
         }
         const path = url.pathname;
-        
+
         const depth = getURLDepth(url.toString());
 
-        
         // Check if the link exceeds the maximum depth allowed
         if (depth > maxDepth) {
           return false;
@@ -113,9 +121,11 @@ export class WebCrawler {
 
         // Check if the link matches the include patterns, if any are specified
         if (this.includes.length > 0 && this.includes[0] !== "") {
-          if (!this.includes.some((includePattern) =>
+          if (
-            new RegExp(includePattern).test(path)
+            !this.includes.some((includePattern) =>
-          )) {
+              new RegExp(includePattern).test(path)
+            )
+          ) {
             return false;
           }
         }
@@ -128,8 +138,11 @@ export class WebCrawler {
         } catch (_) {
           return false;
         }
-        const initialHostname = normalizedInitialUrl.hostname.replace(/^www\./, '');
+        const initialHostname = normalizedInitialUrl.hostname.replace(
-        const linkHostname = normalizedLink.hostname.replace(/^www\./, '');
+          /^www\./,
+          ""
+        );
+        const linkHostname = normalizedLink.hostname.replace(/^www\./, "");
 
         // Ensure the protocol and hostname match, and the path starts with the initial URL's path
         // commented to able to handling external link on allowExternalContentLinks
@@ -138,15 +151,22 @@ export class WebCrawler {
         // }
 
         if (!this.allowBackwardCrawling) {
-          if (!normalizedLink.pathname.startsWith(normalizedInitialUrl.pathname)) {
+          if (
+            !normalizedLink.pathname.startsWith(normalizedInitialUrl.pathname)
+          ) {
             return false;
           }
         }
 
-        const isAllowed = this.ignoreRobotsTxt ? true : (this.robots.isAllowed(link, "FireCrawlAgent") ?? true);
+        const isAllowed = this.ignoreRobotsTxt
+          ? true
+          : (this.robots.isAllowed(link, "FireCrawlAgent") ?? true);
         // Check if the link is disallowed by robots.txt
         if (!isAllowed) {
-          this.logger.debug(`Link disallowed by robots.txt: ${link}`, { method: "filterLinks", link });
+          this.logger.debug(`Link disallowed by robots.txt: ${link}`, {
+            method: "filterLinks",
+            link
+          });
           return false;
         }
 
@@ -161,12 +181,15 @@ export class WebCrawler {
 
   public async getRobotsTxt(skipTlsVerification = false): Promise<string> {
     let extraArgs = {};
-    if(skipTlsVerification) {
+    if (skipTlsVerification) {
       extraArgs["httpsAgent"] = new https.Agent({
         rejectUnauthorized: false
       });
     }
-    const response = await axios.get(this.robotsTxtUrl, { timeout: axiosTimeout, ...extraArgs });
+    const response = await axios.get(this.robotsTxtUrl, {
+      timeout: axiosTimeout,
+      ...extraArgs
+    });
     return response.data;
   }
 
@@ -174,15 +197,25 @@ export class WebCrawler {
     this.robots = robotsParser(this.robotsTxtUrl, txt);
   }
 
-  public async tryGetSitemap(fromMap: boolean = false, onlySitemap: boolean = false): Promise<{ url: string; html: string; }[] | null> {
+  public async tryGetSitemap(
-    this.logger.debug(`Fetching sitemap links from ${this.initialUrl}`, { method: "tryGetSitemap" });
+    fromMap: boolean = false,
+    onlySitemap: boolean = false
+  ): Promise<{ url: string; html: string }[] | null> {
+    this.logger.debug(`Fetching sitemap links from ${this.initialUrl}`, {
+      method: "tryGetSitemap"
+    });
     const sitemapLinks = await this.tryFetchSitemapLinks(this.initialUrl);
-    if(fromMap && onlySitemap) {
+    if (fromMap && onlySitemap) {
-      return sitemapLinks.map(link => ({ url: link, html: "" }));
+      return sitemapLinks.map((link) => ({ url: link, html: "" }));
     }
     if (sitemapLinks.length > 0) {
-      let filteredLinks = this.filterLinks(sitemapLinks, this.limit, this.maxCrawledDepth, fromMap);
+      let filteredLinks = this.filterLinks(
-      return filteredLinks.map(link => ({ url: link, html: "" }));
+        sitemapLinks,
+        this.limit,
+        this.maxCrawledDepth,
+        fromMap
+      );
+      return filteredLinks.map((link) => ({ url: link, html: "" }));
     }
     return null;
   }
@@ -204,15 +237,18 @@ export class WebCrawler {
     }
     const path = urlObj.pathname;
 
-    if (this.isInternalLink(fullUrl)) { // INTERNAL LINKS
+    if (this.isInternalLink(fullUrl)) {
-      if (this.isInternalLink(fullUrl) &&
+      // INTERNAL LINKS
+      if (
+        this.isInternalLink(fullUrl) &&
         this.noSections(fullUrl) &&
         !this.matchesExcludes(path) &&
         this.isRobotsAllowed(fullUrl, this.ignoreRobotsTxt)
       ) {
         return fullUrl;
       }
-    } else { // EXTERNAL LINKS
+    } else {
+      // EXTERNAL LINKS
       if (
         this.isInternalLink(url) &&
         this.allowExternalContentLinks &&
@@ -224,7 +260,11 @@ export class WebCrawler {
       }
     }
 
-    if (this.allowSubdomains && !this.isSocialMediaOrEmail(fullUrl) && this.isSubdomain(fullUrl)) {
+    if (
+      this.allowSubdomains &&
+      !this.isSocialMediaOrEmail(fullUrl) &&
+      this.isSubdomain(fullUrl)
+    ) {
       return fullUrl;
     }
 
@@ -261,14 +301,20 @@ export class WebCrawler {
     return links;
   }
 
-  private isRobotsAllowed(url: string, ignoreRobotsTxt: boolean = false): boolean {
+  private isRobotsAllowed(
-    return (ignoreRobotsTxt ? true : (this.robots ? (this.robots.isAllowed(url, "FireCrawlAgent") ?? true) : true))
+    url: string,
+    ignoreRobotsTxt: boolean = false
+  ): boolean {
+    return ignoreRobotsTxt
+      ? true
+      : this.robots
+        ? (this.robots.isAllowed(url, "FireCrawlAgent") ?? true)
+        : true;
   }
 
   private matchesExcludes(url: string, onlyDomains: boolean = false): boolean {
     return this.excludes.some((pattern) => {
-      if (onlyDomains)
+      if (onlyDomains) return this.matchesExcludesExternalDomains(url);
-        return this.matchesExcludesExternalDomains(url);
 
       return this.excludes.some((pattern) => new RegExp(pattern).test(url));
     });
@@ -282,11 +328,14 @@ export class WebCrawler {
       const pathname = urlObj.pathname;
 
       for (let domain of this.excludes) {
-        let domainObj = new URL('http://' + domain.replace(/^https?:\/\//, ''));
+        let domainObj = new URL("http://" + domain.replace(/^https?:\/\//, ""));
         let domainHostname = domainObj.hostname;
         let domainPathname = domainObj.pathname;
 
-        if (hostname === domainHostname || hostname.endsWith(`.${domainHostname}`)) {
+        if (
+          hostname === domainHostname ||
+          hostname.endsWith(`.${domainHostname}`)
+        ) {
           if (pathname.startsWith(domainPathname)) {
             return true;
           }
@@ -298,8 +347,13 @@ export class WebCrawler {
     }
   }
 
-  private isExternalMainPage(url:string):boolean {
+  private isExternalMainPage(url: string): boolean {
-    return !Boolean(url.split("/").slice(3).filter(subArray => subArray.length > 0).length)
+    return !Boolean(
+      url
+        .split("/")
+        .slice(3)
+        .filter((subArray) => subArray.length > 0).length
+    );
   }
 
   private noSections(link: string): boolean {
@@ -308,14 +362,19 @@ export class WebCrawler {
 
   private isInternalLink(link: string): boolean {
     const urlObj = new URL(link, this.baseUrl);
-    const baseDomain = this.baseUrl.replace(/^https?:\/\//, "").replace(/^www\./, "").trim();
+    const baseDomain = this.baseUrl
+      .replace(/^https?:\/\//, "")
+      .replace(/^www\./, "")
+      .trim();
     const linkDomain = urlObj.hostname.replace(/^www\./, "").trim();
-    
+
     return linkDomain === baseDomain;
   }
 
   private isSubdomain(link: string): boolean {
-    return new URL(link, this.baseUrl).hostname.endsWith("." + new URL(this.baseUrl).hostname.split(".").slice(-2).join("."));
+    return new URL(link, this.baseUrl).hostname.endsWith(
+      "." + new URL(this.baseUrl).hostname.split(".").slice(-2).join(".")
+    );
   }
 
   public isFile(url: string): boolean {
@@ -329,7 +388,7 @@ export class WebCrawler {
       ".ico",
       ".svg",
       ".tiff",
-      // ".pdf", 
+      // ".pdf",
       ".zip",
       ".exe",
       ".dmg",
@@ -350,10 +409,13 @@ export class WebCrawler {
     ];
 
     try {
-      const urlWithoutQuery = url.split('?')[0].toLowerCase();
+      const urlWithoutQuery = url.split("?")[0].toLowerCase();
       return fileExtensions.some((ext) => urlWithoutQuery.endsWith(ext));
     } catch (error) {
-      this.logger.error(`Error processing URL in isFile`, { method: "isFile", error });
+      this.logger.error(`Error processing URL in isFile`, {
+        method: "isFile",
+        error
+      });
       return false;
     }
   }
@@ -369,7 +431,7 @@ export class WebCrawler {
       "github.com",
       "calendly.com",
       "discord.gg",
-      "discord.com",
+      "discord.com"
     ];
     return socialMediaOrEmail.some((ext) => url.includes(ext));
   }
@@ -383,10 +445,7 @@ export class WebCrawler {
       return url;
     };
 
-
+    const sitemapUrl = url.endsWith(".xml") ? url : `${url}/sitemap.xml`;
-    const sitemapUrl = url.endsWith(".xml")
-      ? url
-      : `${url}/sitemap.xml`;
 
     let sitemapLinks: string[] = [];
 
@@ -395,12 +454,18 @@ export class WebCrawler {
       if (response.status === 200) {
         sitemapLinks = await getLinksFromSitemap({ sitemapUrl }, this.logger);
       }
-    } catch (error) { 
+    } catch (error) {
-      this.logger.debug(`Failed to fetch sitemap with axios from ${sitemapUrl}`, { method: "tryFetchSitemapLinks", sitemapUrl, error });
+      this.logger.debug(
+        `Failed to fetch sitemap with axios from ${sitemapUrl}`,
+        { method: "tryFetchSitemapLinks", sitemapUrl, error }
+      );
       if (error instanceof AxiosError && error.response?.status === 404) {
         // ignore 404
       } else {
-        const response = await getLinksFromSitemap({ sitemapUrl, mode: 'fire-engine' }, this.logger);
+        const response = await getLinksFromSitemap(
+          { sitemapUrl, mode: "fire-engine" },
+          this.logger
+        );
         if (response) {
           sitemapLinks = response;
         }
@@ -410,24 +475,41 @@ export class WebCrawler {
     if (sitemapLinks.length === 0) {
       const baseUrlSitemap = `${this.baseUrl}/sitemap.xml`;
       try {
-        const response = await axios.get(baseUrlSitemap, { timeout: axiosTimeout });
+        const response = await axios.get(baseUrlSitemap, {
+          timeout: axiosTimeout
+        });
         if (response.status === 200) {
-          sitemapLinks = await getLinksFromSitemap({ sitemapUrl: baseUrlSitemap, mode: 'fire-engine' }, this.logger);
+          sitemapLinks = await getLinksFromSitemap(
+            { sitemapUrl: baseUrlSitemap, mode: "fire-engine" },
+            this.logger
+          );
         }
       } catch (error) {
-        this.logger.debug(`Failed to fetch sitemap from ${baseUrlSitemap}`, { method: "tryFetchSitemapLinks", sitemapUrl: baseUrlSitemap, error });
+        this.logger.debug(`Failed to fetch sitemap from ${baseUrlSitemap}`, {
+          method: "tryFetchSitemapLinks",
+          sitemapUrl: baseUrlSitemap,
+          error
+        });
         if (error instanceof AxiosError && error.response?.status === 404) {
           // ignore 404
         } else {
-          sitemapLinks = await getLinksFromSitemap({ sitemapUrl: baseUrlSitemap, mode: 'fire-engine' }, this.logger);
+          sitemapLinks = await getLinksFromSitemap(
+            { sitemapUrl: baseUrlSitemap, mode: "fire-engine" },
+            this.logger
+          );
         }
       }
     }
 
     const normalizedUrl = normalizeUrl(url);
-    const normalizedSitemapLinks = sitemapLinks.map(link => normalizeUrl(link));
+    const normalizedSitemapLinks = sitemapLinks.map((link) =>
+      normalizeUrl(link)
+    );
     // has to be greater than 0 to avoid adding the initial URL to the sitemap links, and preventing crawler to crawl
-    if (!normalizedSitemapLinks.includes(normalizedUrl) && sitemapLinks.length > 0) {
+    if (
+      !normalizedSitemapLinks.includes(normalizedUrl) &&
+      sitemapLinks.length > 0
+    ) {
       sitemapLinks.push(url);
     }
     return sitemapLinks;

apps/api/src/scraper/WebScraper/custom/handleCustomScraping.ts

@@ -3,9 +3,17 @@ import { logger } from "../../../lib/logger";
 export async function handleCustomScraping(
   text: string,
   url: string
-): Promise<{ scraper: string; url: string; waitAfterLoad?: number, pageOptions?: { scrollXPaths?: string[] } } | null> {
+): Promise<{
+  scraper: string;
+  url: string;
+  waitAfterLoad?: number;
+  pageOptions?: { scrollXPaths?: string[] };
+} | null> {
   // Check for Readme Docs special case
-  if (text.includes('<meta name="readme-deploy"') && !url.includes('developers.notion.com')) {
+  if (
+    text.includes('<meta name="readme-deploy"') &&
+    !url.includes("developers.notion.com")
+  ) {
     logger.debug(
       `Special use case detected for ${url}, using Fire Engine with wait time 1000ms`
     );
@@ -14,7 +22,9 @@ export async function handleCustomScraping(
       url: url,
       waitAfterLoad: 1000,
       pageOptions: {
-        scrollXPaths: ['//*[@id="ReferencePlayground"]/section[3]/div/pre/div/div/div[5]']
+        scrollXPaths: [
+          '//*[@id="ReferencePlayground"]/section[3]/div/pre/div/div/div[5]'
+        ]
       }
     };
   }
@@ -27,18 +37,21 @@ export async function handleCustomScraping(
     return {
       scraper: "fire-engine",
       url: url,
-      waitAfterLoad: 3000,
+      waitAfterLoad: 3000
     };
   }
 
   // Check for Google Drive PDF links in meta tags
-  const googleDriveMetaPattern = /<meta itemprop="url" content="(https:\/\/drive\.google\.com\/file\/d\/[^"]+)"/;
+  const googleDriveMetaPattern =
+    /<meta itemprop="url" content="(https:\/\/drive\.google\.com\/file\/d\/[^"]+)"/;
   const googleDriveMetaMatch = text.match(googleDriveMetaPattern);
   if (googleDriveMetaMatch) {
     const url = googleDriveMetaMatch[1];
     logger.debug(`Google Drive PDF link detected: ${url}`);
 
-    const fileIdMatch = url.match(/https:\/\/drive\.google\.com\/file\/d\/([^\/]+)\/view/);
+    const fileIdMatch = url.match(
+      /https:\/\/drive\.google\.com\/file\/d\/([^\/]+)\/view/
+    );
     if (fileIdMatch) {
       const fileId = fileIdMatch[1];
       const pdfUrl = `https://drive.google.com/uc?export=download&id=${fileId}`;
@@ -49,6 +62,6 @@ export async function handleCustomScraping(
       };
     }
   }
-  
+
   return null;
 }

apps/api/src/scraper/WebScraper/sitemap.ts

@@ -10,29 +10,39 @@ export async function getLinksFromSitemap(
   {
     sitemapUrl,
     allUrls = [],
-    mode = 'axios'
+    mode = "axios"
   }: {
-    sitemapUrl: string,
+    sitemapUrl: string;
-    allUrls?: string[],
+    allUrls?: string[];
-    mode?: 'axios' | 'fire-engine'
+    mode?: "axios" | "fire-engine";
   },
-  logger: Logger,
+  logger: Logger
 ): Promise<string[]> {
   try {
     let content: string = "";
     try {
-      if (mode === 'axios' || process.env.FIRE_ENGINE_BETA_URL === '') {
+      if (mode === "axios" || process.env.FIRE_ENGINE_BETA_URL === "") {
         const response = await axios.get(sitemapUrl, { timeout: axiosTimeout });
         content = response.data;
-      } else if (mode === 'fire-engine') {
+      } else if (mode === "fire-engine") {
-        const response = await scrapeURL("sitemap", sitemapUrl, scrapeOptions.parse({ formats: ["rawHtml"] }), { forceEngine: "fire-engine;tlsclient", v0DisableJsDom: true });
+        const response = await scrapeURL(
+          "sitemap",
+          sitemapUrl,
+          scrapeOptions.parse({ formats: ["rawHtml"] }),
+          { forceEngine: "fire-engine;tlsclient", v0DisableJsDom: true }
+        );
         if (!response.success) {
           throw response.error;
         }
         content = response.document.rawHtml!;
       }
     } catch (error) {
-      logger.error(`Request failed for ${sitemapUrl}`, { method: "getLinksFromSitemap", mode, sitemapUrl, error });
+      logger.error(`Request failed for ${sitemapUrl}`, {
+        method: "getLinksFromSitemap",
+        mode,
+        sitemapUrl,
+        error
+      });
 
       return allUrls;
     }
@@ -42,26 +52,46 @@ export async function getLinksFromSitemap(
 
     if (root && root.sitemap) {
       const sitemapPromises = root.sitemap
-        .filter(sitemap => sitemap.loc && sitemap.loc.length > 0)
+        .filter((sitemap) => sitemap.loc && sitemap.loc.length > 0)
-        .map(sitemap => getLinksFromSitemap({ sitemapUrl: sitemap.loc[0], allUrls, mode }, logger));
+        .map((sitemap) =>
+          getLinksFromSitemap(
+            { sitemapUrl: sitemap.loc[0], allUrls, mode },
+            logger
+          )
+        );
       await Promise.all(sitemapPromises);
     } else if (root && root.url) {
       const validUrls = root.url
-        .filter(url => url.loc && url.loc.length > 0 && !WebCrawler.prototype.isFile(url.loc[0]))
+        .filter(
-        .map(url => url.loc[0]);
+          (url) =>
+            url.loc &&
+            url.loc.length > 0 &&
+            !WebCrawler.prototype.isFile(url.loc[0])
+        )
+        .map((url) => url.loc[0]);
       allUrls.push(...validUrls);
     }
   } catch (error) {
-    logger.debug(`Error processing sitemapUrl: ${sitemapUrl}`, { method: "getLinksFromSitemap", mode, sitemapUrl, error });
+    logger.debug(`Error processing sitemapUrl: ${sitemapUrl}`, {
+      method: "getLinksFromSitemap",
+      mode,
+      sitemapUrl,
+      error
+    });
   }
 
   return allUrls;
 }
 
-export const fetchSitemapData = async (url: string, timeout?: number): Promise<SitemapEntry[] | null> => {
+export const fetchSitemapData = async (
+  url: string,
+  timeout?: number
+): Promise<SitemapEntry[] | null> => {
   const sitemapUrl = url.endsWith("/sitemap.xml") ? url : `${url}/sitemap.xml`;
   try {
-    const response = await axios.get(sitemapUrl, { timeout: timeout || axiosTimeout });
+    const response = await axios.get(sitemapUrl, {
+      timeout: timeout || axiosTimeout
+    });
     if (response.status === 200) {
       const xml = response.data;
       const parsedXml = await parseStringPromise(xml);
@@ -71,8 +101,10 @@ export const fetchSitemapData = async (url: string, timeout?: number): Promise<S
         for (const urlElement of parsedXml.urlset.url) {
           const sitemapEntry: SitemapEntry = { loc: urlElement.loc[0] };
           if (urlElement.lastmod) sitemapEntry.lastmod = urlElement.lastmod[0];
-          if (urlElement.changefreq) sitemapEntry.changefreq = urlElement.changefreq[0];
+          if (urlElement.changefreq)
-          if (urlElement.priority) sitemapEntry.priority = Number(urlElement.priority[0]);
+            sitemapEntry.changefreq = urlElement.changefreq[0];
+          if (urlElement.priority)
+            sitemapEntry.priority = Number(urlElement.priority[0]);
           sitemapData.push(sitemapEntry);
         }
       }
@@ -84,11 +116,11 @@ export const fetchSitemapData = async (url: string, timeout?: number): Promise<S
     // Error handling for failed sitemap fetch
   }
   return [];
-}
+};
 
 export interface SitemapEntry {
   loc: string;
   lastmod?: string;
   changefreq?: string;
   priority?: number;
-}
+}

apps/api/src/scraper/WebScraper/utils/__tests__/blocklist.test.ts

@@ -1,88 +1,94 @@
-import { isUrlBlocked } from '../blocklist';
+import { isUrlBlocked } from "../blocklist";
 
-describe('Blocklist Functionality', () => {
+describe("Blocklist Functionality", () => {
-  describe('isUrlBlocked', () => {
+  describe("isUrlBlocked", () => {
     test.each([
-      'https://facebook.com/fake-test',
+      "https://facebook.com/fake-test",
-      'https://x.com/user-profile',
+      "https://x.com/user-profile",
-      'https://twitter.com/home',
+      "https://twitter.com/home",
-      'https://instagram.com/explore',
+      "https://instagram.com/explore",
-      'https://linkedin.com/in/johndoe',
+      "https://linkedin.com/in/johndoe",
-      'https://snapchat.com/add/johndoe',
+      "https://snapchat.com/add/johndoe",
-      'https://tiktok.com/@johndoe',
+      "https://tiktok.com/@johndoe",
-      'https://reddit.com/r/funny',
+      "https://reddit.com/r/funny",
-      'https://tumblr.com/dashboard',
+      "https://tumblr.com/dashboard",
-      'https://flickr.com/photos/johndoe',
+      "https://flickr.com/photos/johndoe",
-      'https://whatsapp.com/download',
+      "https://whatsapp.com/download",
-      'https://wechat.com/features',
+      "https://wechat.com/features",
-      'https://telegram.org/apps'
+      "https://telegram.org/apps"
-    ])('should return true for blocklisted URL %s', (url) => {
+    ])("should return true for blocklisted URL %s", (url) => {
       expect(isUrlBlocked(url)).toBe(true);
     });
 
     test.each([
-      'https://facebook.com/policy',
+      "https://facebook.com/policy",
-      'https://twitter.com/tos',
+      "https://twitter.com/tos",
-      'https://instagram.com/about/legal/terms',
+      "https://instagram.com/about/legal/terms",
-      'https://linkedin.com/legal/privacy-policy',
+      "https://linkedin.com/legal/privacy-policy",
-      'https://pinterest.com/about/privacy',
+      "https://pinterest.com/about/privacy",
-      'https://snapchat.com/legal/terms',
+      "https://snapchat.com/legal/terms",
-      'https://tiktok.com/legal/privacy-policy',
+      "https://tiktok.com/legal/privacy-policy",
-      'https://reddit.com/policies',
+      "https://reddit.com/policies",
-      'https://tumblr.com/policy/en/privacy',
+      "https://tumblr.com/policy/en/privacy",
-      'https://flickr.com/help/terms',
+      "https://flickr.com/help/terms",
-      'https://whatsapp.com/legal',
+      "https://whatsapp.com/legal",
-      'https://wechat.com/en/privacy-policy',
+      "https://wechat.com/en/privacy-policy",
-      'https://telegram.org/tos'
+      "https://telegram.org/tos"
-    ])('should return false for allowed URLs with keywords %s', (url) => {
+    ])("should return false for allowed URLs with keywords %s", (url) => {
       expect(isUrlBlocked(url)).toBe(false);
     });
 
-    test('should return false for non-blocklisted domain', () => {
+    test("should return false for non-blocklisted domain", () => {
-      const url = 'https://example.com';
+      const url = "https://example.com";
       expect(isUrlBlocked(url)).toBe(false);
     });
 
-    test('should handle invalid URLs gracefully', () => {
+    test("should handle invalid URLs gracefully", () => {
-      const url = 'htp://invalid-url';
+      const url = "htp://invalid-url";
       expect(isUrlBlocked(url)).toBe(false);
     });
   });
 
   test.each([
-    'https://subdomain.facebook.com',
+    "https://subdomain.facebook.com",
-    'https://facebook.com.someotherdomain.com',
+    "https://facebook.com.someotherdomain.com",
-    'https://www.facebook.com/profile',
+    "https://www.facebook.com/profile",
-    'https://api.twitter.com/info',
+    "https://api.twitter.com/info",
-    'https://instagram.com/accounts/login'
+    "https://instagram.com/accounts/login"
-  ])('should return true for URLs with blocklisted domains in subdomains or paths %s', (url) => {
+  ])(
+    "should return true for URLs with blocklisted domains in subdomains or paths %s",
+    (url) => {
+      expect(isUrlBlocked(url)).toBe(true);
+    }
+  );
+
+  test.each([
+    "https://example.com/facebook.com",
+    "https://example.com/redirect?url=https://twitter.com",
+    "https://facebook.com.policy.example.com"
+  ])(
+    "should return false for URLs where blocklisted domain is part of another domain or path %s",
+    (url) => {
+      expect(isUrlBlocked(url)).toBe(false);
+    }
+  );
+
+  test.each(["https://FACEBOOK.com", "https://INSTAGRAM.com/@something"])(
+    "should handle case variations %s",
+    (url) => {
+      expect(isUrlBlocked(url)).toBe(true);
+    }
+  );
+
+  test.each([
+    "https://facebook.com?redirect=https://example.com",
+    "https://twitter.com?query=something"
+  ])("should handle query parameters %s", (url) => {
     expect(isUrlBlocked(url)).toBe(true);
   });
 
-  test.each([
+  test("should handle internationalized domain names", () => {
-    'https://example.com/facebook.com',
+    const url = "https://xn--d1acpjx3f.xn--p1ai";
-    'https://example.com/redirect?url=https://twitter.com',
-    'https://facebook.com.policy.example.com'
-  ])('should return false for URLs where blocklisted domain is part of another domain or path %s', (url) => {
     expect(isUrlBlocked(url)).toBe(false);
   });
-
+});
-  test.each([
-    'https://FACEBOOK.com',
-    'https://INSTAGRAM.com/@something'
-  ])('should handle case variations %s', (url) => {
-    expect(isUrlBlocked(url)).toBe(true);
-  });
-
-  test.each([
-    'https://facebook.com?redirect=https://example.com',
-    'https://twitter.com?query=something'
-  ])('should handle query parameters %s', (url) => {
-    expect(isUrlBlocked(url)).toBe(true);
-  });
-
-  test('should handle internationalized domain names', () => {
-    const url = 'https://xn--d1acpjx3f.xn--p1ai';
-    expect(isUrlBlocked(url)).toBe(false);
-  });
-});

apps/api/src/scraper/WebScraper/utils/__tests__/maxDepthUtils.test.ts

@@ -1,47 +1,42 @@
-import { getURLDepth, getAdjustedMaxDepth } from '../maxDepthUtils';
+import { getURLDepth, getAdjustedMaxDepth } from "../maxDepthUtils";
 
-describe('Testing getURLDepth and getAdjustedMaxDepth', () => {
+describe("Testing getURLDepth and getAdjustedMaxDepth", () => {
-  it('should return 0 for root - mendable.ai', () => {
+  it("should return 0 for root - mendable.ai", () => {
-    const enteredURL = "https://www.mendable.ai/"
+    const enteredURL = "https://www.mendable.ai/";
     expect(getURLDepth(enteredURL)).toBe(0);
   });
 
-  it('should return 0 for root - scrapethissite.com', () => {
+  it("should return 0 for root - scrapethissite.com", () => {
-    const enteredURL = "https://scrapethissite.com/"
+    const enteredURL = "https://scrapethissite.com/";
     expect(getURLDepth(enteredURL)).toBe(0);
   });
 
-  it('should return 1 for scrapethissite.com/pages', () => {
+  it("should return 1 for scrapethissite.com/pages", () => {
-    const enteredURL = "https://scrapethissite.com/pages"
+    const enteredURL = "https://scrapethissite.com/pages";
     expect(getURLDepth(enteredURL)).toBe(1);
   });
 
-  it('should return 2 for scrapethissite.com/pages/articles', () => {
+  it("should return 2 for scrapethissite.com/pages/articles", () => {
-    const enteredURL = "https://scrapethissite.com/pages/articles"
+    const enteredURL = "https://scrapethissite.com/pages/articles";
     expect(getURLDepth(enteredURL)).toBe(2);
-
   });
 
-  it('Adjusted maxDepth should return 1 for scrapethissite.com and max depth param of 1', () => {
+  it("Adjusted maxDepth should return 1 for scrapethissite.com and max depth param of 1", () => {
-    const enteredURL = "https://scrapethissite.com"
+    const enteredURL = "https://scrapethissite.com";
     expect(getAdjustedMaxDepth(enteredURL, 1)).toBe(1);
-
   });
-  it('Adjusted maxDepth should return 0 for scrapethissite.com and max depth param of 0', () => {
+  it("Adjusted maxDepth should return 0 for scrapethissite.com and max depth param of 0", () => {
-    const enteredURL = "https://scrapethissite.com"
+    const enteredURL = "https://scrapethissite.com";
-    expect(getAdjustedMaxDepth(enteredURL, 0)).toBe(0);
-
-  });
-
-  it('Adjusted maxDepth should return 0 for mendable.ai and max depth param of 0', () => {
-    const enteredURL = "https://mendable.ai"
     expect(getAdjustedMaxDepth(enteredURL, 0)).toBe(0);
   });
 
-  it('Adjusted maxDepth should return 4 for scrapethissite.com/pages/articles and max depth param of 2', () => {
+  it("Adjusted maxDepth should return 0 for mendable.ai and max depth param of 0", () => {
-    const enteredURL = "https://scrapethissite.com/pages/articles"
+    const enteredURL = "https://mendable.ai";
+    expect(getAdjustedMaxDepth(enteredURL, 0)).toBe(0);
+  });
+
+  it("Adjusted maxDepth should return 4 for scrapethissite.com/pages/articles and max depth param of 2", () => {
+    const enteredURL = "https://scrapethissite.com/pages/articles";
     expect(getAdjustedMaxDepth(enteredURL, 2)).toBe(4);
   });
-
-  
 });

apps/api/src/scraper/WebScraper/utils/blocklist.ts

@@ -1,68 +1,75 @@
 import { logger } from "../../../lib/logger";
 
 const socialMediaBlocklist = [
-  'facebook.com',
+  "facebook.com",
-  'x.com',
+  "x.com",
-  'twitter.com',
+  "twitter.com",
-  'instagram.com',
+  "instagram.com",
-  'linkedin.com',
+  "linkedin.com",
-  'snapchat.com',
+  "snapchat.com",
-  'tiktok.com',
+  "tiktok.com",
-  'reddit.com',
+  "reddit.com",
-  'tumblr.com',
+  "tumblr.com",
-  'flickr.com',
+  "flickr.com",
-  'whatsapp.com',
+  "whatsapp.com",
-  'wechat.com',
+  "wechat.com",
-  'telegram.org',
+  "telegram.org",
-  'researchhub.com',
+  "researchhub.com",
-  'youtube.com',
+  "youtube.com",
-  'corterix.com',
+  "corterix.com",
-  'southwest.com',
+  "southwest.com",
-  'ryanair.com'
+  "ryanair.com"
 ];
 
 const allowedKeywords = [
-  'pulse',
+  "pulse",
-  'privacy',
+  "privacy",
-  'terms',
+  "terms",
-  'policy',
+  "policy",
-  'user-agreement',
+  "user-agreement",
-  'legal',
+  "legal",
-  'help',
+  "help",
-  'policies',
+  "policies",
-  'support',
+  "support",
-  'contact',
+  "contact",
-  'about',
+  "about",
-  'careers',
+  "careers",
-  'blog',
+  "blog",
-  'press',
+  "press",
-  'conditions',
+  "conditions",
-  'tos',
+  "tos",
-  '://library.tiktok.com',
+  "://library.tiktok.com",
-  '://ads.tiktok.com',
+  "://ads.tiktok.com",
-  '://tiktok.com/business',
+  "://tiktok.com/business",
-  '://developers.facebook.com'
+  "://developers.facebook.com"
 ];
 
 export function isUrlBlocked(url: string): boolean {
   const lowerCaseUrl = url.toLowerCase();
 
   // Check if the URL contains any allowed keywords as whole words
-  if (allowedKeywords.some(keyword => new RegExp(`\\b${keyword}\\b`, 'i').test(lowerCaseUrl))) {
+  if (
+    allowedKeywords.some((keyword) =>
+      new RegExp(`\\b${keyword}\\b`, "i").test(lowerCaseUrl)
+    )
+  ) {
     return false;
   }
 
   try {
-    if (!url.startsWith('http://') && !url.startsWith('https://')) {
+    if (!url.startsWith("http://") && !url.startsWith("https://")) {
-      url = 'https://' + url;
+      url = "https://" + url;
     }
-    
+
     const urlObj = new URL(url);
     const hostname = urlObj.hostname.toLowerCase();
 
     // Check if the URL matches any domain in the blocklist
-    const isBlocked = socialMediaBlocklist.some(domain => {
+    const isBlocked = socialMediaBlocklist.some((domain) => {
-      const domainPattern = new RegExp(`(^|\\.)${domain.replace('.', '\\.')}(\\.|$)`, 'i');
+      const domainPattern = new RegExp(
+        `(^|\\.)${domain.replace(".", "\\.")}(\\.|$)`,
+        "i"
+      );
       return domainPattern.test(hostname);
     });
 

apps/api/src/scraper/WebScraper/utils/maxDepthUtils.ts

@@ -1,12 +1,15 @@
-
+export function getAdjustedMaxDepth(
-
+  url: string,
-export function getAdjustedMaxDepth(url: string, maxCrawlDepth: number): number {
+  maxCrawlDepth: number
+): number {
   const baseURLDepth = getURLDepth(url);
   const adjustedMaxDepth = maxCrawlDepth + baseURLDepth;
   return adjustedMaxDepth;
 }
 
 export function getURLDepth(url: string): number {
-  const pathSplits = new URL(url).pathname.split('/').filter(x => x !== "" && x !== "index.php" && x !== "index.html");
+  const pathSplits = new URL(url).pathname
+    .split("/")
+    .filter((x) => x !== "" && x !== "index.php" && x !== "index.html");
   return pathSplits.length;
 }

apps/api/src/scraper/WebScraper/utils/removeBase64Images.ts

@@ -1,7 +1,5 @@
-export const removeBase64Images = async (
+export const removeBase64Images = async (markdown: string) => {
-  markdown: string,
-) => {
   const regex = /(!\[.*?\])\(data:image\/.*?;base64,.*?\)/g;
-  markdown = markdown.replace(regex, '$1(<Base64-Image-Removed>)');
+  markdown = markdown.replace(regex, "$1(<Base64-Image-Removed>)");
   return markdown;
 };

apps/api/src/scraper/scrapeURL/engines/cache/index.ts

@@ -4,16 +4,16 @@ import { Meta } from "../..";
 import { EngineError } from "../../error";
 
 export async function scrapeCache(meta: Meta): Promise<EngineScrapeResult> {
-    const key = cacheKey(meta.url, meta.options, meta.internalOptions);
+  const key = cacheKey(meta.url, meta.options, meta.internalOptions);
-    if (key === null) throw new EngineError("Scrape not eligible for caching");
+  if (key === null) throw new EngineError("Scrape not eligible for caching");
 
-    const entry = await getEntryFromCache(key);
+  const entry = await getEntryFromCache(key);
-    if (entry === null) throw new EngineError("Cache missed");
+  if (entry === null) throw new EngineError("Cache missed");
 
-    return {
+  return {
-        url: entry.url,
+    url: entry.url,
-        html: entry.html,
+    html: entry.html,
-        statusCode: entry.statusCode,
+    statusCode: entry.statusCode,
-        error: entry.error,
+    error: entry.error
-    };
+  };
-}
+}

apps/api/src/scraper/scrapeURL/engines/docx/index.ts

@@ -4,12 +4,12 @@ import { downloadFile } from "../utils/downloadFile";
 import mammoth from "mammoth";
 
 export async function scrapeDOCX(meta: Meta): Promise<EngineScrapeResult> {
-    const { response, tempFilePath } = await downloadFile(meta.id, meta.url);
+  const { response, tempFilePath } = await downloadFile(meta.id, meta.url);
 
-    return {
+  return {
-        url: response.url,
+    url: response.url,
-        statusCode: response.status,
+    statusCode: response.status,
 
-        html: (await mammoth.convertToHtml({ path: tempFilePath })).value,
+    html: (await mammoth.convertToHtml({ path: tempFilePath })).value
-    }
+  };
 }

apps/api/src/scraper/scrapeURL/engines/fetch/index.ts

@@ -3,26 +3,34 @@ import { Meta } from "../..";
 import { TimeoutError } from "../../error";
 import { specialtyScrapeCheck } from "../utils/specialtyHandler";
 
-export async function scrapeURLWithFetch(meta: Meta): Promise<EngineScrapeResult> {
+export async function scrapeURLWithFetch(
-    const timeout = 20000;
+  meta: Meta
+): Promise<EngineScrapeResult> {
+  const timeout = 20000;
 
-    const response = await Promise.race([
+  const response = await Promise.race([
-        fetch(meta.url, {
+    fetch(meta.url, {
-            redirect: "follow",
+      redirect: "follow",
-            headers: meta.options.headers,
+      headers: meta.options.headers
-        }),
+    }),
-        (async () => {
+    (async () => {
-            await new Promise((resolve) => setTimeout(() => resolve(null), timeout));
+      await new Promise((resolve) => setTimeout(() => resolve(null), timeout));
-            throw new TimeoutError("Fetch was unable to scrape the page before timing out", { cause: { timeout } });
+      throw new TimeoutError(
-        })()
+        "Fetch was unable to scrape the page before timing out",
-    ]);
+        { cause: { timeout } }
+      );
+    })()
+  ]);
 
-    specialtyScrapeCheck(meta.logger.child({ method: "scrapeURLWithFetch/specialtyScrapeCheck" }), Object.fromEntries(response.headers as any));
+  specialtyScrapeCheck(
+    meta.logger.child({ method: "scrapeURLWithFetch/specialtyScrapeCheck" }),
+    Object.fromEntries(response.headers as any)
+  );
 
-    return {
+  return {
-        url: response.url,
+    url: response.url,
-        html: await response.text(),
+    html: await response.text(),
-        statusCode: response.status,
+    statusCode: response.status
-        // TODO: error?
+    // TODO: error?
-    };
+  };
 }

apps/api/src/scraper/scrapeURL/engines/fire-engine/checkStatus.ts

@@ -6,105 +6,132 @@ import { robustFetch } from "../../lib/fetch";
 import { EngineError, SiteError } from "../../error";
 
 const successSchema = z.object({
-    jobId: z.string(),
+  jobId: z.string(),
-    state: z.literal("completed"),
+  state: z.literal("completed"),
-    processing: z.literal(false),
+  processing: z.literal(false),
 
-    // timeTaken: z.number(),
+  // timeTaken: z.number(),
-    content: z.string(),
+  content: z.string(),
-    url: z.string().optional(),
+  url: z.string().optional(),
 
-    pageStatusCode: z.number(),
+  pageStatusCode: z.number(),
-    pageError: z.string().optional(),
+  pageError: z.string().optional(),
 
-    // TODO: this needs to be non-optional, might need fixes on f-e side to ensure reliability
+  // TODO: this needs to be non-optional, might need fixes on f-e side to ensure reliability
-    responseHeaders: z.record(z.string(), z.string()).optional(),
+  responseHeaders: z.record(z.string(), z.string()).optional(),
 
-    // timeTakenCookie: z.number().optional(),
+  // timeTakenCookie: z.number().optional(),
-    // timeTakenRequest: z.number().optional(),
+  // timeTakenRequest: z.number().optional(),
 
-    // legacy: playwright only
+  // legacy: playwright only
-    screenshot: z.string().optional(),
+  screenshot: z.string().optional(),
 
-    // new: actions
+  // new: actions
-    screenshots: z.string().array().optional(),
+  screenshots: z.string().array().optional(),
-    actionContent: z.object({
+  actionContent: z
-        url: z.string(),
+    .object({
-        html: z.string(),
+      url: z.string(),
-    }).array().optional(),
+      html: z.string()
-})
+    })
+    .array()
+    .optional()
+});
 
 export type FireEngineCheckStatusSuccess = z.infer<typeof successSchema>;
 
 const processingSchema = z.object({
-    jobId: z.string(),
+  jobId: z.string(),
-    state: z.enum(["delayed", "active", "waiting", "waiting-children", "unknown", "prioritized"]),
+  state: z.enum([
-    processing: z.boolean(),
+    "delayed",
+    "active",
+    "waiting",
+    "waiting-children",
+    "unknown",
+    "prioritized"
+  ]),
+  processing: z.boolean()
 });
 
 const failedSchema = z.object({
-    jobId: z.string(),
+  jobId: z.string(),
-    state: z.literal("failed"),
+  state: z.literal("failed"),
-    processing: z.literal(false),
+  processing: z.literal(false),
-    error: z.string(),
+  error: z.string()
 });
 
 export class StillProcessingError extends Error {
-    constructor(jobId: string) {
+  constructor(jobId: string) {
-        super("Job is still under processing", { cause: { jobId } })
+    super("Job is still under processing", { cause: { jobId } });
-    }
+  }
 }
 
-export async function fireEngineCheckStatus(logger: Logger, jobId: string): Promise<FireEngineCheckStatusSuccess> {
+export async function fireEngineCheckStatus(
-    const fireEngineURL = process.env.FIRE_ENGINE_BETA_URL!;
+  logger: Logger,
+  jobId: string
+): Promise<FireEngineCheckStatusSuccess> {
+  const fireEngineURL = process.env.FIRE_ENGINE_BETA_URL!;
 
-    const status = await Sentry.startSpan({
+  const status = await Sentry.startSpan(
-        name: "fire-engine: Check status",
+    {
-        attributes: {
+      name: "fire-engine: Check status",
-            jobId,
+      attributes: {
+        jobId
+      }
+    },
+    async (span) => {
+      return await robustFetch({
+        url: `${fireEngineURL}/scrape/${jobId}`,
+        method: "GET",
+        logger: logger.child({ method: "fireEngineCheckStatus/robustFetch" }),
+        headers: {
+          ...(Sentry.isInitialized()
+            ? {
+                "sentry-trace": Sentry.spanToTraceHeader(span),
+                baggage: Sentry.spanToBaggageHeader(span)
+              }
+            : {})
         }
-    }, async span => {
+      });
-        return await robustFetch(
+    }
-            {
+  );
-                url: `${fireEngineURL}/scrape/${jobId}`,
-                method: "GET",
-                logger: logger.child({ method: "fireEngineCheckStatus/robustFetch" }),
-                headers: {
-                    ...(Sentry.isInitialized() ? ({
-                        "sentry-trace": Sentry.spanToTraceHeader(span),
-                        "baggage": Sentry.spanToBaggageHeader(span),
-                    }) : {}),
-                },
-            }
-        )
-    });
 
-    const successParse = successSchema.safeParse(status);
+  const successParse = successSchema.safeParse(status);
-    const processingParse = processingSchema.safeParse(status);
+  const processingParse = processingSchema.safeParse(status);
-    const failedParse = failedSchema.safeParse(status);
+  const failedParse = failedSchema.safeParse(status);
 
-    if (successParse.success) {
+  if (successParse.success) {
-        logger.debug("Scrape succeeded!", { jobId });
+    logger.debug("Scrape succeeded!", { jobId });
-        return successParse.data;
+    return successParse.data;
-    } else if (processingParse.success) {
+  } else if (processingParse.success) {
-        throw new StillProcessingError(jobId);
+    throw new StillProcessingError(jobId);
-    } else if (failedParse.success) {
+  } else if (failedParse.success) {
-        logger.debug("Scrape job failed", { status, jobId });
+    logger.debug("Scrape job failed", { status, jobId });
-        if (typeof status.error === "string" && status.error.includes("Chrome error: ")) {
+    if (
-            throw new SiteError(status.error.split("Chrome error: ")[1]);
+      typeof status.error === "string" &&
-        } else {
+      status.error.includes("Chrome error: ")
-            throw new EngineError("Scrape job failed", {
+    ) {
-                cause: {
+      throw new SiteError(status.error.split("Chrome error: ")[1]);
-                    status, jobId
-                }
-            });
-        }
     } else {
-        logger.debug("Check status returned response not matched by any schema", { status, jobId });
+      throw new EngineError("Scrape job failed", {
-        throw new Error("Check status returned response not matched by any schema", {
+        cause: {
-            cause: {
+          status,
-                status, jobId
+          jobId
-            }
+        }
-        });
+      });
     }
+  } else {
+    logger.debug("Check status returned response not matched by any schema", {
+      status,
+      jobId
+    });
+    throw new Error(
+      "Check status returned response not matched by any schema",
+      {
+        cause: {
+          status,
+          jobId
+        }
+      }
+    );
+  }
 }

apps/api/src/scraper/scrapeURL/engines/fire-engine/delete.ts

@@ -4,30 +4,33 @@ import * as Sentry from "@sentry/node";
 import { robustFetch } from "../../lib/fetch";
 
 export async function fireEngineDelete(logger: Logger, jobId: string) {
-    const fireEngineURL = process.env.FIRE_ENGINE_BETA_URL!;
+  const fireEngineURL = process.env.FIRE_ENGINE_BETA_URL!;
 
-    await Sentry.startSpan({
+  await Sentry.startSpan(
-        name: "fire-engine: Delete scrape",
+    {
-        attributes: {
+      name: "fire-engine: Delete scrape",
-            jobId,
+      attributes: {
-        }
+        jobId
-    }, async span => {
+      }
-        await robustFetch(
+    },
-            {
+    async (span) => {
-                url: `${fireEngineURL}/scrape/${jobId}`,
+      await robustFetch({
-                method: "DELETE",
+        url: `${fireEngineURL}/scrape/${jobId}`,
-                headers: {
+        method: "DELETE",
-                    ...(Sentry.isInitialized() ? ({
+        headers: {
-                        "sentry-trace": Sentry.spanToTraceHeader(span),
+          ...(Sentry.isInitialized()
-                        "baggage": Sentry.spanToBaggageHeader(span),
+            ? {
-                    }) : {}),
+                "sentry-trace": Sentry.spanToTraceHeader(span),
-                },
+                baggage: Sentry.spanToBaggageHeader(span)
-                ignoreResponse: true,
+              }
-                ignoreFailure: true,
+            : {})
-                logger: logger.child({ method: "fireEngineDelete/robustFetch", jobId }),
+        },
-            }
+        ignoreResponse: true,
-        )
+        ignoreFailure: true,
-    });
+        logger: logger.child({ method: "fireEngineDelete/robustFetch", jobId })
+      });
+    }
+  );
 
-    // We do not care whether this fails or not.
+  // We do not care whether this fails or not.
-}
+}

apps/api/src/scraper/scrapeURL/engines/fire-engine/index.ts

@@ -1,8 +1,18 @@
 import { Logger } from "winston";
 import { Meta } from "../..";
-import { fireEngineScrape, FireEngineScrapeRequestChromeCDP, FireEngineScrapeRequestCommon, FireEngineScrapeRequestPlaywright, FireEngineScrapeRequestTLSClient } from "./scrape";
+import {
+  fireEngineScrape,
+  FireEngineScrapeRequestChromeCDP,
+  FireEngineScrapeRequestCommon,
+  FireEngineScrapeRequestPlaywright,
+  FireEngineScrapeRequestTLSClient
+} from "./scrape";
 import { EngineScrapeResult } from "..";
-import { fireEngineCheckStatus, FireEngineCheckStatusSuccess, StillProcessingError } from "./checkStatus";
+import {
+  fireEngineCheckStatus,
+  FireEngineCheckStatusSuccess,
+  StillProcessingError
+} from "./checkStatus";
 import { EngineError, SiteError, TimeoutError } from "../../error";
 import * as Sentry from "@sentry/node";
 import { Action } from "../../../../lib/entities";
@@ -13,203 +23,293 @@ export const defaultTimeout = 10000;
 // This function does not take `Meta` on purpose. It may not access any
 // meta values to construct the request -- that must be done by the
 // `scrapeURLWithFireEngine*` functions.
-async function performFireEngineScrape<Engine extends FireEngineScrapeRequestChromeCDP | FireEngineScrapeRequestPlaywright | FireEngineScrapeRequestTLSClient>(
+async function performFireEngineScrape<
-    logger: Logger,
+  Engine extends
-    request: FireEngineScrapeRequestCommon & Engine,
+    | FireEngineScrapeRequestChromeCDP
-    timeout = defaultTimeout,
+    | FireEngineScrapeRequestPlaywright
+    | FireEngineScrapeRequestTLSClient
+>(
+  logger: Logger,
+  request: FireEngineScrapeRequestCommon & Engine,
+  timeout = defaultTimeout
 ): Promise<FireEngineCheckStatusSuccess> {
-    const scrape = await fireEngineScrape(logger.child({ method: "fireEngineScrape" }), request);
+  const scrape = await fireEngineScrape(
+    logger.child({ method: "fireEngineScrape" }),
+    request
+  );
 
-    const startTime = Date.now();
+  const startTime = Date.now();
-    const errorLimit = 3;
+  const errorLimit = 3;
-    let errors: any[] = [];
+  let errors: any[] = [];
-    let status: FireEngineCheckStatusSuccess | undefined = undefined;
+  let status: FireEngineCheckStatusSuccess | undefined = undefined;
 
-    while (status === undefined) {
+  while (status === undefined) {
-        if (errors.length >= errorLimit) {
+    if (errors.length >= errorLimit) {
-            logger.error("Error limit hit.", { errors });
+      logger.error("Error limit hit.", { errors });
-            throw new Error("Error limit hit. See e.cause.errors for errors.", { cause: { errors } });
+      throw new Error("Error limit hit. See e.cause.errors for errors.", {
-        }
+        cause: { errors }
-
+      });
-        if (Date.now() - startTime > timeout) {
-            logger.info("Fire-engine was unable to scrape the page before timing out.", { errors, timeout });
-            throw new TimeoutError("Fire-engine was unable to scrape the page before timing out", { cause: { errors, timeout } });
-        }
-
-        try {
-            status = await fireEngineCheckStatus(logger.child({ method: "fireEngineCheckStatus" }), scrape.jobId)
-        } catch (error) {
-            if (error instanceof StillProcessingError) {
-                // nop
-            } else if (error instanceof EngineError || error instanceof SiteError) {
-                logger.debug("Fire-engine scrape job failed.", { error, jobId: scrape.jobId });
-                throw error;
-            } else {
-                Sentry.captureException(error);
-                errors.push(error);
-                logger.debug(`An unexpeceted error occurred while calling checkStatus. Error counter is now at ${errors.length}.`, { error, jobId: scrape.jobId });
-            }
-        }
-
-        await new Promise((resolve) => setTimeout(resolve, 250));
     }
 
-    return status;
+    if (Date.now() - startTime > timeout) {
+      logger.info(
+        "Fire-engine was unable to scrape the page before timing out.",
+        { errors, timeout }
+      );
+      throw new TimeoutError(
+        "Fire-engine was unable to scrape the page before timing out",
+        { cause: { errors, timeout } }
+      );
+    }
+
+    try {
+      status = await fireEngineCheckStatus(
+        logger.child({ method: "fireEngineCheckStatus" }),
+        scrape.jobId
+      );
+    } catch (error) {
+      if (error instanceof StillProcessingError) {
+        // nop
+      } else if (error instanceof EngineError || error instanceof SiteError) {
+        logger.debug("Fire-engine scrape job failed.", {
+          error,
+          jobId: scrape.jobId
+        });
+        throw error;
+      } else {
+        Sentry.captureException(error);
+        errors.push(error);
+        logger.debug(
+          `An unexpeceted error occurred while calling checkStatus. Error counter is now at ${errors.length}.`,
+          { error, jobId: scrape.jobId }
+        );
+      }
+    }
+
+    await new Promise((resolve) => setTimeout(resolve, 250));
+  }
+
+  return status;
 }
 
-export async function scrapeURLWithFireEngineChromeCDP(meta: Meta): Promise<EngineScrapeResult> {
+export async function scrapeURLWithFireEngineChromeCDP(
-    const actions: Action[] = [
+  meta: Meta
-        // Transform waitFor option into an action (unsupported by chrome-cdp)
+): Promise<EngineScrapeResult> {
-        ...(meta.options.waitFor !== 0 ? [{
+  const actions: Action[] = [
+    // Transform waitFor option into an action (unsupported by chrome-cdp)
+    ...(meta.options.waitFor !== 0
+      ? [
+          {
             type: "wait" as const,
-            milliseconds: meta.options.waitFor,
+            milliseconds: meta.options.waitFor
-        }] : []),
+          }
+        ]
+      : []),
 
-        // Transform screenshot format into an action (unsupported by chrome-cdp)
+    // Transform screenshot format into an action (unsupported by chrome-cdp)
-        ...(meta.options.formats.includes("screenshot") || meta.options.formats.includes("screenshot@fullPage") ? [{
+    ...(meta.options.formats.includes("screenshot") ||
+    meta.options.formats.includes("screenshot@fullPage")
+      ? [
+          {
             type: "screenshot" as const,
-            fullPage: meta.options.formats.includes("screenshot@fullPage"),
+            fullPage: meta.options.formats.includes("screenshot@fullPage")
-        }] : []),
+          }
+        ]
+      : []),
 
-        // Include specified actions
+    // Include specified actions
-        ...(meta.options.actions ?? []),
+    ...(meta.options.actions ?? [])
-    ];
+  ];
 
-    const request: FireEngineScrapeRequestCommon & FireEngineScrapeRequestChromeCDP = {
+  const request: FireEngineScrapeRequestCommon &
-        url: meta.url,
+    FireEngineScrapeRequestChromeCDP = {
-        engine: "chrome-cdp",
+    url: meta.url,
-        instantReturn: true,
+    engine: "chrome-cdp",
-        skipTlsVerification: meta.options.skipTlsVerification,
+    instantReturn: true,
-        headers: meta.options.headers,
+    skipTlsVerification: meta.options.skipTlsVerification,
-        ...(actions.length > 0 ? ({
+    headers: meta.options.headers,
-            actions,
+    ...(actions.length > 0
-        }) : {}),
+      ? {
-        priority: meta.internalOptions.priority,
+          actions
-        geolocation: meta.options.geolocation,
+        }
-        mobile: meta.options.mobile,
+      : {}),
-        timeout: meta.options.timeout === undefined ? 300000 : undefined, // TODO: better timeout logic
+    priority: meta.internalOptions.priority,
-        disableSmartWaitCache: meta.internalOptions.disableSmartWaitCache,
+    geolocation: meta.options.geolocation,
-        // TODO: scrollXPaths
+    mobile: meta.options.mobile,
-    };
+    timeout: meta.options.timeout === undefined ? 300000 : undefined, // TODO: better timeout logic
+    disableSmartWaitCache: meta.internalOptions.disableSmartWaitCache
+    // TODO: scrollXPaths
+  };
 
-    const totalWait = actions.reduce((a,x) => x.type === "wait" ? (x.milliseconds ?? 1000) + a : a, 0);
+  const totalWait = actions.reduce(
+    (a, x) => (x.type === "wait" ? (x.milliseconds ?? 1000) + a : a),
+    0
+  );
 
-    let response = await performFireEngineScrape(
+  let response = await performFireEngineScrape(
-        meta.logger.child({ method: "scrapeURLWithFireEngineChromeCDP/callFireEngine", request }),
+    meta.logger.child({
-        request,
+      method: "scrapeURLWithFireEngineChromeCDP/callFireEngine",
-        meta.options.timeout !== undefined
+      request
-            ? defaultTimeout + totalWait
+    }),
-            : Infinity, // TODO: better timeout handling
+    request,
+    meta.options.timeout !== undefined ? defaultTimeout + totalWait : Infinity // TODO: better timeout handling
+  );
+
+  specialtyScrapeCheck(
+    meta.logger.child({
+      method: "scrapeURLWithFireEngineChromeCDP/specialtyScrapeCheck"
+    }),
+    response.responseHeaders
+  );
+
+  if (
+    meta.options.formats.includes("screenshot") ||
+    meta.options.formats.includes("screenshot@fullPage")
+  ) {
+    meta.logger.debug(
+      "Transforming screenshots from actions into screenshot field",
+      { screenshots: response.screenshots }
     );
+    response.screenshot = (response.screenshots ?? [])[0];
+    (response.screenshots ?? []).splice(0, 1);
+    meta.logger.debug("Screenshot transformation done", {
+      screenshots: response.screenshots,
+      screenshot: response.screenshot
+    });
+  }
 
-    specialtyScrapeCheck(meta.logger.child({ method: "scrapeURLWithFireEngineChromeCDP/specialtyScrapeCheck" }), response.responseHeaders);
+  if (!response.url) {
+    meta.logger.warn("Fire-engine did not return the response's URL", {
+      response,
+      sourceURL: meta.url
+    });
+  }
 
-    if (meta.options.formats.includes("screenshot") || meta.options.formats.includes("screenshot@fullPage")) {
+  return {
-        meta.logger.debug("Transforming screenshots from actions into screenshot field", { screenshots: response.screenshots });
+    url: response.url ?? meta.url,
-        response.screenshot = (response.screenshots ?? [])[0];
-        (response.screenshots ?? []).splice(0, 1);
-        meta.logger.debug("Screenshot transformation done", { screenshots: response.screenshots, screenshot: response.screenshot });
-    }
 
-    if (!response.url) {
+    html: response.content,
-        meta.logger.warn("Fire-engine did not return the response's URL", { response, sourceURL: meta.url });
+    error: response.pageError,
-    }
+    statusCode: response.pageStatusCode,
 
-    return {
+    screenshot: response.screenshot,
-        url: response.url ?? meta.url,
+    ...(actions.length > 0
-
+      ? {
-        html: response.content,
+          actions: {
-        error: response.pageError,
+            screenshots: response.screenshots ?? [],
-        statusCode: response.pageStatusCode,
+            scrapes: response.actionContent ?? []
-
+          }
-        screenshot: response.screenshot,
+        }
-        ...(actions.length > 0 ? {
+      : {})
-            actions: {
+  };
-                screenshots: response.screenshots ?? [],
-                scrapes: response.actionContent ?? [],
-            }
-        } : {}),
-    };
 }
 
-export async function scrapeURLWithFireEnginePlaywright(meta: Meta): Promise<EngineScrapeResult> {
+export async function scrapeURLWithFireEnginePlaywright(
-    const request: FireEngineScrapeRequestCommon & FireEngineScrapeRequestPlaywright = {
+  meta: Meta
-        url: meta.url,
+): Promise<EngineScrapeResult> {
-        engine: "playwright",
+  const request: FireEngineScrapeRequestCommon &
-        instantReturn: true,
+    FireEngineScrapeRequestPlaywright = {
+    url: meta.url,
+    engine: "playwright",
+    instantReturn: true,
 
-        headers: meta.options.headers,
+    headers: meta.options.headers,
-        priority: meta.internalOptions.priority,
+    priority: meta.internalOptions.priority,
-        screenshot: meta.options.formats.includes("screenshot"),
+    screenshot: meta.options.formats.includes("screenshot"),
-        fullPageScreenshot: meta.options.formats.includes("screenshot@fullPage"),
+    fullPageScreenshot: meta.options.formats.includes("screenshot@fullPage"),
-        wait: meta.options.waitFor,
+    wait: meta.options.waitFor,
-        geolocation: meta.options.geolocation,
+    geolocation: meta.options.geolocation,
 
-        timeout: meta.options.timeout === undefined ? 300000 : undefined, // TODO: better timeout logic
+    timeout: meta.options.timeout === undefined ? 300000 : undefined // TODO: better timeout logic
-    };
+  };
 
-    let response = await performFireEngineScrape(
+  let response = await performFireEngineScrape(
-        meta.logger.child({ method: "scrapeURLWithFireEngineChromeCDP/callFireEngine", request }),
+    meta.logger.child({
-        request,
+      method: "scrapeURLWithFireEngineChromeCDP/callFireEngine",
-        meta.options.timeout !== undefined
+      request
-            ? defaultTimeout + meta.options.waitFor
+    }),
-            : Infinity, // TODO: better timeout handling
+    request,
-    );
+    meta.options.timeout !== undefined
-    
+      ? defaultTimeout + meta.options.waitFor
-    specialtyScrapeCheck(meta.logger.child({ method: "scrapeURLWithFireEnginePlaywright/specialtyScrapeCheck" }), response.responseHeaders);
+      : Infinity // TODO: better timeout handling
+  );
 
-    if (!response.url) {
+  specialtyScrapeCheck(
-        meta.logger.warn("Fire-engine did not return the response's URL", { response, sourceURL: meta.url });
+    meta.logger.child({
-    }
+      method: "scrapeURLWithFireEnginePlaywright/specialtyScrapeCheck"
+    }),
+    response.responseHeaders
+  );
 
-    return {
+  if (!response.url) {
-        url: response.url ?? meta.url,
+    meta.logger.warn("Fire-engine did not return the response's URL", {
+      response,
+      sourceURL: meta.url
+    });
+  }
 
-        html: response.content,
+  return {
-        error: response.pageError,
+    url: response.url ?? meta.url,
-        statusCode: response.pageStatusCode,
 
-        ...(response.screenshots !== undefined && response.screenshots.length > 0 ? ({
+    html: response.content,
-            screenshot: response.screenshots[0],
+    error: response.pageError,
-        }) : {}),
+    statusCode: response.pageStatusCode,
-    };
+
+    ...(response.screenshots !== undefined && response.screenshots.length > 0
+      ? {
+          screenshot: response.screenshots[0]
+        }
+      : {})
+  };
 }
 
-export async function scrapeURLWithFireEngineTLSClient(meta: Meta): Promise<EngineScrapeResult> {
+export async function scrapeURLWithFireEngineTLSClient(
-    const request: FireEngineScrapeRequestCommon & FireEngineScrapeRequestTLSClient = {
+  meta: Meta
-        url: meta.url,
+): Promise<EngineScrapeResult> {
-        engine: "tlsclient",
+  const request: FireEngineScrapeRequestCommon &
-        instantReturn: true,
+    FireEngineScrapeRequestTLSClient = {
+    url: meta.url,
+    engine: "tlsclient",
+    instantReturn: true,
 
-        headers: meta.options.headers,
+    headers: meta.options.headers,
-        priority: meta.internalOptions.priority,
+    priority: meta.internalOptions.priority,
 
-        atsv: meta.internalOptions.atsv,
+    atsv: meta.internalOptions.atsv,
-        geolocation: meta.options.geolocation,
+    geolocation: meta.options.geolocation,
-        disableJsDom: meta.internalOptions.v0DisableJsDom,
+    disableJsDom: meta.internalOptions.v0DisableJsDom,
 
-        timeout: meta.options.timeout === undefined ? 300000 : undefined, // TODO: better timeout logic
+    timeout: meta.options.timeout === undefined ? 300000 : undefined // TODO: better timeout logic
-    };
+  };
 
-    let response = await performFireEngineScrape(
+  let response = await performFireEngineScrape(
-        meta.logger.child({ method: "scrapeURLWithFireEngineChromeCDP/callFireEngine", request }),
+    meta.logger.child({
-        request,
+      method: "scrapeURLWithFireEngineChromeCDP/callFireEngine",
-        meta.options.timeout !== undefined
+      request
-            ? defaultTimeout
+    }),
-            : Infinity, // TODO: better timeout handling
+    request,
-    );
+    meta.options.timeout !== undefined ? defaultTimeout : Infinity // TODO: better timeout handling
+  );
 
-    specialtyScrapeCheck(meta.logger.child({ method: "scrapeURLWithFireEngineTLSClient/specialtyScrapeCheck" }), response.responseHeaders);
+  specialtyScrapeCheck(
+    meta.logger.child({
+      method: "scrapeURLWithFireEngineTLSClient/specialtyScrapeCheck"
+    }),
+    response.responseHeaders
+  );
 
-    if (!response.url) {
+  if (!response.url) {
-        meta.logger.warn("Fire-engine did not return the response's URL", { response, sourceURL: meta.url });
+    meta.logger.warn("Fire-engine did not return the response's URL", {
-    }
+      response,
+      sourceURL: meta.url
+    });
+  }
 
-    return {
+  return {
-        url: response.url ?? meta.url,
+    url: response.url ?? meta.url,
 
-        html: response.content,
+    html: response.content,
-        error: response.pageError,
+    error: response.pageError,
-        statusCode: response.pageStatusCode,
+    statusCode: response.pageStatusCode
-    };
+  };
 }

apps/api/src/scraper/scrapeURL/engines/fire-engine/scrape.ts

@@ -6,92 +6,100 @@ import { Action } from "../../../../lib/entities";
 import { robustFetch } from "../../lib/fetch";
 
 export type FireEngineScrapeRequestCommon = {
-    url: string;
+  url: string;
-    
-    headers?: { [K: string]: string };
 
-    blockMedia?: boolean; // default: true
+  headers?: { [K: string]: string };
-    blockAds?: boolean; // default: true
-    // pageOptions?: any; // unused, .scrollXPaths is considered on FE side
 
-    // useProxy?: boolean; // unused, default: true
+  blockMedia?: boolean; // default: true
-    // customProxy?: string; // unused
+  blockAds?: boolean; // default: true
+  // pageOptions?: any; // unused, .scrollXPaths is considered on FE side
 
-    // disableSmartWaitCache?: boolean; // unused, default: false
+  // useProxy?: boolean; // unused, default: true
-    // skipDnsCheck?: boolean; // unused, default: false
+  // customProxy?: string; // unused
 
-    priority?: number; // default: 1
+  // disableSmartWaitCache?: boolean; // unused, default: false
-    // team_id?: string; // unused
+  // skipDnsCheck?: boolean; // unused, default: false
-    logRequest?: boolean; // default: true
-    instantReturn?: boolean; // default: false
-    geolocation?: { country?: string; languages?: string[]; };
 
-    timeout?: number;
+  priority?: number; // default: 1
-}
+  // team_id?: string; // unused
+  logRequest?: boolean; // default: true
+  instantReturn?: boolean; // default: false
+  geolocation?: { country?: string; languages?: string[] };
+
+  timeout?: number;
+};
 
 export type FireEngineScrapeRequestChromeCDP = {
-    engine: "chrome-cdp";
+  engine: "chrome-cdp";
-    skipTlsVerification?: boolean;
+  skipTlsVerification?: boolean;
-    actions?: Action[];
+  actions?: Action[];
-    blockMedia?: true; // cannot be false
+  blockMedia?: true; // cannot be false
-    mobile?: boolean;
+  mobile?: boolean;
-    disableSmartWaitCache?: boolean;
+  disableSmartWaitCache?: boolean;
 };
 
 export type FireEngineScrapeRequestPlaywright = {
-    engine: "playwright";
+  engine: "playwright";
-    blockAds?: boolean; // default: true
+  blockAds?: boolean; // default: true
 
-    // mutually exclusive, default: false
+  // mutually exclusive, default: false
-    screenshot?: boolean;
+  screenshot?: boolean;
-    fullPageScreenshot?: boolean;
+  fullPageScreenshot?: boolean;
 
-    wait?: number; // default: 0
+  wait?: number; // default: 0
 };
 
 export type FireEngineScrapeRequestTLSClient = {
-    engine: "tlsclient";
+  engine: "tlsclient";
-    atsv?: boolean; // v0 only, default: false
+  atsv?: boolean; // v0 only, default: false
-    disableJsDom?: boolean; // v0 only, default: false
+  disableJsDom?: boolean; // v0 only, default: false
-    // blockAds?: boolean; // default: true
+  // blockAds?: boolean; // default: true
 };
 
 const schema = z.object({
-    jobId: z.string(),
+  jobId: z.string(),
-    processing: z.boolean(),
+  processing: z.boolean()
 });
 
-export async function fireEngineScrape<Engine extends FireEngineScrapeRequestChromeCDP | FireEngineScrapeRequestPlaywright | FireEngineScrapeRequestTLSClient> (
+export async function fireEngineScrape<
-    logger: Logger,
+  Engine extends
-    request: FireEngineScrapeRequestCommon & Engine,
+    | FireEngineScrapeRequestChromeCDP
+    | FireEngineScrapeRequestPlaywright
+    | FireEngineScrapeRequestTLSClient
+>(
+  logger: Logger,
+  request: FireEngineScrapeRequestCommon & Engine
 ): Promise<z.infer<typeof schema>> {
-    const fireEngineURL = process.env.FIRE_ENGINE_BETA_URL!;
+  const fireEngineURL = process.env.FIRE_ENGINE_BETA_URL!;
 
-    // TODO: retries
+  // TODO: retries
 
-    const scrapeRequest = await Sentry.startSpan({
+  const scrapeRequest = await Sentry.startSpan(
-        name: "fire-engine: Scrape",
+    {
-        attributes: {
+      name: "fire-engine: Scrape",
-            url: request.url,
+      attributes: {
+        url: request.url
+      }
+    },
+    async (span) => {
+      return await robustFetch({
+        url: `${fireEngineURL}/scrape`,
+        method: "POST",
+        headers: {
+          ...(Sentry.isInitialized()
+            ? {
+                "sentry-trace": Sentry.spanToTraceHeader(span),
+                baggage: Sentry.spanToBaggageHeader(span)
+              }
+            : {})
         },
-    }, async span => {
+        body: request,
-        return await robustFetch(
+        logger: logger.child({ method: "fireEngineScrape/robustFetch" }),
-            {
+        schema,
-                url: `${fireEngineURL}/scrape`,
+        tryCount: 3
-                method: "POST",
+      });
-                headers: {
+    }
-                    ...(Sentry.isInitialized() ? ({
+  );
-                        "sentry-trace": Sentry.spanToTraceHeader(span),
-                        "baggage": Sentry.spanToBaggageHeader(span),
-                    }) : {}),
-                },
-                body: request,
-                logger: logger.child({ method: "fireEngineScrape/robustFetch" }),
-                schema,
-                tryCount: 3,
-            }
-        );
-    });
 
-    return scrapeRequest;
+  return scrapeRequest;
-}
+}

apps/api/src/scraper/scrapeURL/engines/index.ts

@@ -1,316 +1,387 @@
 import { ScrapeActionContent } from "../../../lib/entities";
 import { Meta } from "..";
 import { scrapeDOCX } from "./docx";
-import { scrapeURLWithFireEngineChromeCDP, scrapeURLWithFireEnginePlaywright, scrapeURLWithFireEngineTLSClient } from "./fire-engine";
+import {
+  scrapeURLWithFireEngineChromeCDP,
+  scrapeURLWithFireEnginePlaywright,
+  scrapeURLWithFireEngineTLSClient
+} from "./fire-engine";
 import { scrapePDF } from "./pdf";
 import { scrapeURLWithScrapingBee } from "./scrapingbee";
 import { scrapeURLWithFetch } from "./fetch";
 import { scrapeURLWithPlaywright } from "./playwright";
 import { scrapeCache } from "./cache";
 
-export type Engine = "fire-engine;chrome-cdp" | "fire-engine;playwright" | "fire-engine;tlsclient" | "scrapingbee" | "scrapingbeeLoad" | "playwright" | "fetch" | "pdf" | "docx" | "cache";
+export type Engine =
-
+  | "fire-engine;chrome-cdp"
-const useScrapingBee = process.env.SCRAPING_BEE_API_KEY !== '' && process.env.SCRAPING_BEE_API_KEY !== undefined;
+  | "fire-engine;playwright"
-const useFireEngine = process.env.FIRE_ENGINE_BETA_URL !== '' && process.env.FIRE_ENGINE_BETA_URL !== undefined;
+  | "fire-engine;tlsclient"
-const usePlaywright = process.env.PLAYWRIGHT_MICROSERVICE_URL !== '' && process.env.PLAYWRIGHT_MICROSERVICE_URL !== undefined;
+  | "scrapingbee"
-const useCache = process.env.CACHE_REDIS_URL !== '' && process.env.CACHE_REDIS_URL !== undefined;
+  | "scrapingbeeLoad"
+  | "playwright"
+  | "fetch"
+  | "pdf"
+  | "docx"
+  | "cache";
 
+const useScrapingBee =
+  process.env.SCRAPING_BEE_API_KEY !== "" &&
+  process.env.SCRAPING_BEE_API_KEY !== undefined;
+const useFireEngine =
+  process.env.FIRE_ENGINE_BETA_URL !== "" &&
+  process.env.FIRE_ENGINE_BETA_URL !== undefined;
+const usePlaywright =
+  process.env.PLAYWRIGHT_MICROSERVICE_URL !== "" &&
+  process.env.PLAYWRIGHT_MICROSERVICE_URL !== undefined;
+const useCache =
+  process.env.CACHE_REDIS_URL !== "" &&
+  process.env.CACHE_REDIS_URL !== undefined;
 
 export const engines: Engine[] = [
-    // ...(useCache ? [ "cache" as const ] : []),
+  // ...(useCache ? [ "cache" as const ] : []),
-    ...(useFireEngine ? [ "fire-engine;chrome-cdp" as const, "fire-engine;playwright" as const, "fire-engine;tlsclient" as const ] : []),
+  ...(useFireEngine
-    ...(useScrapingBee ? [ "scrapingbee" as const, "scrapingbeeLoad" as const ] : []),
+    ? [
-    ...(usePlaywright ? [ "playwright" as const ] : []),
+        "fire-engine;chrome-cdp" as const,
-    "fetch",
+        "fire-engine;playwright" as const,
-    "pdf",
+        "fire-engine;tlsclient" as const
-    "docx",
+      ]
+    : []),
+  ...(useScrapingBee
+    ? ["scrapingbee" as const, "scrapingbeeLoad" as const]
+    : []),
+  ...(usePlaywright ? ["playwright" as const] : []),
+  "fetch",
+  "pdf",
+  "docx"
 ];
 
 export const featureFlags = [
-    "actions",
+  "actions",
-    "waitFor",
+  "waitFor",
-    "screenshot",
+  "screenshot",
-    "screenshot@fullScreen",
+  "screenshot@fullScreen",
-    "pdf",
+  "pdf",
-    "docx",
+  "docx",
-    "atsv",
+  "atsv",
-    "location",
+  "location",
-    "mobile",
+  "mobile",
-    "skipTlsVerification",
+  "skipTlsVerification",
-    "useFastMode",
+  "useFastMode"
 ] as const;
 
-export type FeatureFlag = typeof featureFlags[number];
+export type FeatureFlag = (typeof featureFlags)[number];
 
 export const featureFlagOptions: {
-    [F in FeatureFlag]: {
+  [F in FeatureFlag]: {
-        priority: number;
+    priority: number;
-    }
+  };
 } = {
-    "actions": { priority: 20 },
+  actions: { priority: 20 },
-    "waitFor": { priority: 1 },
+  waitFor: { priority: 1 },
-    "screenshot": { priority: 10 },
+  screenshot: { priority: 10 },
-    "screenshot@fullScreen": { priority: 10 },
+  "screenshot@fullScreen": { priority: 10 },
-    "pdf": { priority: 100 },
+  pdf: { priority: 100 },
-    "docx": { priority: 100 },
+  docx: { priority: 100 },
-    "atsv": { priority: 90 }, // NOTE: should atsv force to tlsclient? adjust priority if not
+  atsv: { priority: 90 }, // NOTE: should atsv force to tlsclient? adjust priority if not
-    "useFastMode": { priority: 90 },
+  useFastMode: { priority: 90 },
-    "location": { priority: 10 },
+  location: { priority: 10 },
-    "mobile": { priority: 10 },
+  mobile: { priority: 10 },
-    "skipTlsVerification": { priority: 10 },
+  skipTlsVerification: { priority: 10 }
 } as const;
 
 export type EngineScrapeResult = {
-    url: string;
+  url: string;
 
-    html: string;
+  html: string;
-    markdown?: string;
+  markdown?: string;
-    statusCode: number;
+  statusCode: number;
-    error?: string;
+  error?: string;
 
-    screenshot?: string;
+  screenshot?: string;
-    actions?: {
+  actions?: {
-        screenshots: string[];
+    screenshots: string[];
-        scrapes: ScrapeActionContent[];
+    scrapes: ScrapeActionContent[];
-    };
+  };
-}
+};
 
 const engineHandlers: {
-    [E in Engine]: (meta: Meta) => Promise<EngineScrapeResult>
+  [E in Engine]: (meta: Meta) => Promise<EngineScrapeResult>;
 } = {
-    "cache": scrapeCache,
+  cache: scrapeCache,
-    "fire-engine;chrome-cdp": scrapeURLWithFireEngineChromeCDP,
+  "fire-engine;chrome-cdp": scrapeURLWithFireEngineChromeCDP,
-    "fire-engine;playwright": scrapeURLWithFireEnginePlaywright,
+  "fire-engine;playwright": scrapeURLWithFireEnginePlaywright,
-    "fire-engine;tlsclient": scrapeURLWithFireEngineTLSClient,
+  "fire-engine;tlsclient": scrapeURLWithFireEngineTLSClient,
-    "scrapingbee": scrapeURLWithScrapingBee("domcontentloaded"),
+  scrapingbee: scrapeURLWithScrapingBee("domcontentloaded"),
-    "scrapingbeeLoad": scrapeURLWithScrapingBee("networkidle2"),
+  scrapingbeeLoad: scrapeURLWithScrapingBee("networkidle2"),
-    "playwright": scrapeURLWithPlaywright,
+  playwright: scrapeURLWithPlaywright,
-    "fetch": scrapeURLWithFetch,
+  fetch: scrapeURLWithFetch,
-    "pdf": scrapePDF,
+  pdf: scrapePDF,
-    "docx": scrapeDOCX,
+  docx: scrapeDOCX
 };
 
 export const engineOptions: {
-    [E in Engine]: {
+  [E in Engine]: {
-        // A list of feature flags the engine supports.
+    // A list of feature flags the engine supports.
-        features: { [F in FeatureFlag]: boolean },
+    features: { [F in FeatureFlag]: boolean };
 
-        // This defines the order of engines in general. The engine with the highest quality will be used the most.
+    // This defines the order of engines in general. The engine with the highest quality will be used the most.
-        // Negative quality numbers are reserved for specialty engines, e.g. PDF and DOCX
+    // Negative quality numbers are reserved for specialty engines, e.g. PDF and DOCX
-        quality: number,
+    quality: number;
-    }
+  };
 } = {
-    "cache": {
+  cache: {
-        features: {
+    features: {
-            "actions": false,
+      actions: false,
-            "waitFor": true,
+      waitFor: true,
-            "screenshot": false,
+      screenshot: false,
-            "screenshot@fullScreen": false,
+      "screenshot@fullScreen": false,
-            "pdf": false, // TODO: figure this out
+      pdf: false, // TODO: figure this out
-            "docx": false, // TODO: figure this out
+      docx: false, // TODO: figure this out
-            "atsv": false,
+      atsv: false,
-            "location": false,
+      location: false,
-            "mobile": false,
+      mobile: false,
-            "skipTlsVerification": false,
+      skipTlsVerification: false,
-            "useFastMode": false,
+      useFastMode: false
-        },
-        quality: 1000, // cache should always be tried first
     },
-    "fire-engine;chrome-cdp": {
+    quality: 1000 // cache should always be tried first
-        features: {
+  },
-            "actions": true,
+  "fire-engine;chrome-cdp": {
-            "waitFor": true, // through actions transform
+    features: {
-            "screenshot": true, // through actions transform
+      actions: true,
-            "screenshot@fullScreen": true, // through actions transform
+      waitFor: true, // through actions transform
-            "pdf": false,
+      screenshot: true, // through actions transform
-            "docx": false,
+      "screenshot@fullScreen": true, // through actions transform
-            "atsv": false,
+      pdf: false,
-            "location": true,
+      docx: false,
-            "mobile": true,
+      atsv: false,
-            "skipTlsVerification": true,
+      location: true,
-            "useFastMode": false,
+      mobile: true,
-        },
+      skipTlsVerification: true,
-        quality: 50,
+      useFastMode: false
     },
-    "fire-engine;playwright": {
+    quality: 50
-        features: {
+  },
-            "actions": false,
+  "fire-engine;playwright": {
-            "waitFor": true,
+    features: {
-            "screenshot": true,
+      actions: false,
-            "screenshot@fullScreen": true,
+      waitFor: true,
-            "pdf": false,
+      screenshot: true,
-            "docx": false,
+      "screenshot@fullScreen": true,
-            "atsv": false,
+      pdf: false,
-            "location": false,
+      docx: false,
-            "mobile": false,
+      atsv: false,
-            "skipTlsVerification": false,
+      location: false,
-            "useFastMode": false,
+      mobile: false,
-        },
+      skipTlsVerification: false,
-        quality: 40,
+      useFastMode: false
     },
-    "scrapingbee": {
+    quality: 40
-        features: {
+  },
-            "actions": false,
+  scrapingbee: {
-            "waitFor": true,
+    features: {
-            "screenshot": true,
+      actions: false,
-            "screenshot@fullScreen": true,
+      waitFor: true,
-            "pdf": false,
+      screenshot: true,
-            "docx": false,
+      "screenshot@fullScreen": true,
-            "atsv": false,
+      pdf: false,
-            "location": false,
+      docx: false,
-            "mobile": false,
+      atsv: false,
-            "skipTlsVerification": false,
+      location: false,
-            "useFastMode": false,
+      mobile: false,
-        },
+      skipTlsVerification: false,
-        quality: 30,
+      useFastMode: false
     },
-    "scrapingbeeLoad": {
+    quality: 30
-        features: {
+  },
-            "actions": false,
+  scrapingbeeLoad: {
-            "waitFor": true,
+    features: {
-            "screenshot": true,
+      actions: false,
-            "screenshot@fullScreen": true,
+      waitFor: true,
-            "pdf": false,
+      screenshot: true,
-            "docx": false,
+      "screenshot@fullScreen": true,
-            "atsv": false,
+      pdf: false,
-            "location": false,
+      docx: false,
-            "mobile": false,
+      atsv: false,
-            "skipTlsVerification": false,
+      location: false,
-            "useFastMode": false,
+      mobile: false,
-        },
+      skipTlsVerification: false,
-        quality: 29,
+      useFastMode: false
     },
-    "playwright": {
+    quality: 29
-        features: {
+  },
-            "actions": false,
+  playwright: {
-            "waitFor": true,
+    features: {
-            "screenshot": false,
+      actions: false,
-            "screenshot@fullScreen": false,
+      waitFor: true,
-            "pdf": false,
+      screenshot: false,
-            "docx": false,
+      "screenshot@fullScreen": false,
-            "atsv": false,
+      pdf: false,
-            "location": false,
+      docx: false,
-            "mobile": false,
+      atsv: false,
-            "skipTlsVerification": false,
+      location: false,
-            "useFastMode": false,
+      mobile: false,
-        },
+      skipTlsVerification: false,
-        quality: 20,
+      useFastMode: false
     },
-    "fire-engine;tlsclient": {
+    quality: 20
-        features: {
+  },
-            "actions": false,
+  "fire-engine;tlsclient": {
-            "waitFor": false,
+    features: {
-            "screenshot": false,
+      actions: false,
-            "screenshot@fullScreen": false,
+      waitFor: false,
-            "pdf": false,
+      screenshot: false,
-            "docx": false,
+      "screenshot@fullScreen": false,
-            "atsv": true,
+      pdf: false,
-            "location": true,
+      docx: false,
-            "mobile": false,
+      atsv: true,
-            "skipTlsVerification": false,
+      location: true,
-            "useFastMode": true,
+      mobile: false,
-        },
+      skipTlsVerification: false,
-        quality: 10,
+      useFastMode: true
     },
-    "fetch": {
+    quality: 10
-        features: {
+  },
-            "actions": false,
+  fetch: {
-            "waitFor": false,
+    features: {
-            "screenshot": false,
+      actions: false,
-            "screenshot@fullScreen": false,
+      waitFor: false,
-            "pdf": false,
+      screenshot: false,
-            "docx": false,
+      "screenshot@fullScreen": false,
-            "atsv": false,
+      pdf: false,
-            "location": false,
+      docx: false,
-            "mobile": false,
+      atsv: false,
-            "skipTlsVerification": false,
+      location: false,
-            "useFastMode": true,
+      mobile: false,
-        },
+      skipTlsVerification: false,
-        quality: 5,
+      useFastMode: true
     },
-    "pdf": {
+    quality: 5
-        features: {
+  },
-            "actions": false,
+  pdf: {
-            "waitFor": false,
+    features: {
-            "screenshot": false,
+      actions: false,
-            "screenshot@fullScreen": false,
+      waitFor: false,
-            "pdf": true,
+      screenshot: false,
-            "docx": false,
+      "screenshot@fullScreen": false,
-            "atsv": false,
+      pdf: true,
-            "location": false,
+      docx: false,
-            "mobile": false,
+      atsv: false,
-            "skipTlsVerification": false,
+      location: false,
-            "useFastMode": true,
+      mobile: false,
-        },
+      skipTlsVerification: false,
-        quality: -10,
+      useFastMode: true
     },
-    "docx": {
+    quality: -10
-        features: {
+  },
-            "actions": false,
+  docx: {
-            "waitFor": false,
+    features: {
-            "screenshot": false,
+      actions: false,
-            "screenshot@fullScreen": false,
+      waitFor: false,
-            "pdf": false,
+      screenshot: false,
-            "docx": true,
+      "screenshot@fullScreen": false,
-            "atsv": false,
+      pdf: false,
-            "location": false,
+      docx: true,
-            "mobile": false,
+      atsv: false,
-            "skipTlsVerification": false,
+      location: false,
-            "useFastMode": true,
+      mobile: false,
-        },
+      skipTlsVerification: false,
-        quality: -10,
+      useFastMode: true
     },
+    quality: -10
+  }
 };
 
 export function buildFallbackList(meta: Meta): {
-    engine: Engine,
+  engine: Engine;
-    unsupportedFeatures: Set<FeatureFlag>,
+  unsupportedFeatures: Set<FeatureFlag>;
 }[] {
-    const prioritySum = [...meta.featureFlags].reduce((a, x) => a + featureFlagOptions[x].priority, 0);
+  const prioritySum = [...meta.featureFlags].reduce(
-    const priorityThreshold = Math.floor(prioritySum / 2);
+    (a, x) => a + featureFlagOptions[x].priority,
-    let selectedEngines: {
+    0
-        engine: Engine,
+  );
-        supportScore: number,
+  const priorityThreshold = Math.floor(prioritySum / 2);
-        unsupportedFeatures: Set<FeatureFlag>,
+  let selectedEngines: {
-    }[] = [];
+    engine: Engine;
+    supportScore: number;
+    unsupportedFeatures: Set<FeatureFlag>;
+  }[] = [];
 
-    const currentEngines = meta.internalOptions.forceEngine !== undefined ? [meta.internalOptions.forceEngine] : engines;
+  const currentEngines =
+    meta.internalOptions.forceEngine !== undefined
+      ? [meta.internalOptions.forceEngine]
+      : engines;
 
-    for (const engine of currentEngines) {
+  for (const engine of currentEngines) {
-        const supportedFlags = new Set([...Object.entries(engineOptions[engine].features).filter(([k, v]) => meta.featureFlags.has(k as FeatureFlag) && v === true).map(([k, _]) => k)]);
+    const supportedFlags = new Set([
-        const supportScore = [...supportedFlags].reduce((a, x) => a + featureFlagOptions[x].priority, 0);
+      ...Object.entries(engineOptions[engine].features)
+        .filter(
+          ([k, v]) => meta.featureFlags.has(k as FeatureFlag) && v === true
+        )
+        .map(([k, _]) => k)
+    ]);
+    const supportScore = [...supportedFlags].reduce(
+      (a, x) => a + featureFlagOptions[x].priority,
+      0
+    );
 
-        const unsupportedFeatures = new Set([...meta.featureFlags]);
+    const unsupportedFeatures = new Set([...meta.featureFlags]);
-            for (const flag of meta.featureFlags) {
+    for (const flag of meta.featureFlags) {
-                if (supportedFlags.has(flag)) {
+      if (supportedFlags.has(flag)) {
-                    unsupportedFeatures.delete(flag);
+        unsupportedFeatures.delete(flag);
-                }
+      }
-            }
+    }
 
-        if (supportScore >= priorityThreshold) {
+    if (supportScore >= priorityThreshold) {
-            selectedEngines.push({ engine, supportScore, unsupportedFeatures });
+      selectedEngines.push({ engine, supportScore, unsupportedFeatures });
-            meta.logger.debug(`Engine ${engine} meets feature priority threshold`, { supportScore, prioritySum, priorityThreshold, featureFlags: [...meta.featureFlags], unsupportedFeatures });
+      meta.logger.debug(`Engine ${engine} meets feature priority threshold`, {
-        } else {
+        supportScore,
-            meta.logger.debug(`Engine ${engine} does not meet feature priority threshold`, { supportScore, prioritySum, priorityThreshold, featureFlags: [...meta.featureFlags], unsupportedFeatures});
+        prioritySum,
+        priorityThreshold,
+        featureFlags: [...meta.featureFlags],
+        unsupportedFeatures
+      });
+    } else {
+      meta.logger.debug(
+        `Engine ${engine} does not meet feature priority threshold`,
+        {
+          supportScore,
+          prioritySum,
+          priorityThreshold,
+          featureFlags: [...meta.featureFlags],
+          unsupportedFeatures
         }
+      );
     }
+  }
 
-    if (selectedEngines.some(x => engineOptions[x.engine].quality > 0)) {
+  if (selectedEngines.some((x) => engineOptions[x.engine].quality > 0)) {
-        selectedEngines = selectedEngines.filter(x => engineOptions[x.engine].quality > 0);
+    selectedEngines = selectedEngines.filter(
-    }
+      (x) => engineOptions[x.engine].quality > 0
+    );
+  }
 
-    selectedEngines.sort((a,b) => b.supportScore - a.supportScore || engineOptions[b.engine].quality - engineOptions[a.engine].quality);
+  selectedEngines.sort(
+    (a, b) =>
+      b.supportScore - a.supportScore ||
+      engineOptions[b.engine].quality - engineOptions[a.engine].quality
+  );
 
-    return selectedEngines;
+  return selectedEngines;
 }
 
-export async function scrapeURLWithEngine(meta: Meta, engine: Engine): Promise<EngineScrapeResult> {
+export async function scrapeURLWithEngine(
-    const fn = engineHandlers[engine];
+  meta: Meta,
-    const logger = meta.logger.child({ method: fn.name ?? "scrapeURLWithEngine", engine });
+  engine: Engine
-    const _meta = {
+): Promise<EngineScrapeResult> {
-        ...meta,
+  const fn = engineHandlers[engine];
-        logger,
+  const logger = meta.logger.child({
-    };
+    method: fn.name ?? "scrapeURLWithEngine",
+    engine
+  });
+  const _meta = {
+    ...meta,
+    logger
+  };
 
-    return await fn(_meta);
+  return await fn(_meta);
 }

apps/api/src/scraper/scrapeURL/engines/pdf/index.ts

@@ -10,152 +10,179 @@ import PdfParse from "pdf-parse";
 import { downloadFile, fetchFileToBuffer } from "../utils/downloadFile";
 import { RemoveFeatureError } from "../../error";
 
-type PDFProcessorResult = {html: string, markdown?: string};
+type PDFProcessorResult = { html: string; markdown?: string };
 
-async function scrapePDFWithLlamaParse(meta: Meta, tempFilePath: string): Promise<PDFProcessorResult> {
+async function scrapePDFWithLlamaParse(
-    meta.logger.debug("Processing PDF document with LlamaIndex", { tempFilePath });
+  meta: Meta,
+  tempFilePath: string
+): Promise<PDFProcessorResult> {
+  meta.logger.debug("Processing PDF document with LlamaIndex", {
+    tempFilePath
+  });
 
-    const uploadForm = new FormData();
+  const uploadForm = new FormData();
 
-    // This is utterly stupid but it works! - mogery
+  // This is utterly stupid but it works! - mogery
-    uploadForm.append("file", {
+  uploadForm.append("file", {
-        [Symbol.toStringTag]: "Blob",
+    [Symbol.toStringTag]: "Blob",
-        name: tempFilePath,
+    name: tempFilePath,
-        stream() {
+    stream() {
-            return createReadStream(tempFilePath) as unknown as ReadableStream<Uint8Array>
+      return createReadStream(
-        },
+        tempFilePath
-        arrayBuffer() {
+      ) as unknown as ReadableStream<Uint8Array>;
-            throw Error("Unimplemented in mock Blob: arrayBuffer")
+    },
-        },
+    arrayBuffer() {
-        size: (await fs.stat(tempFilePath)).size,
+      throw Error("Unimplemented in mock Blob: arrayBuffer");
-        text() {
+    },
-            throw Error("Unimplemented in mock Blob: text")
+    size: (await fs.stat(tempFilePath)).size,
-        },
+    text() {
-        slice(start, end, contentType) {
+      throw Error("Unimplemented in mock Blob: text");
-            throw Error("Unimplemented in mock Blob: slice")
+    },
-        },
+    slice(start, end, contentType) {
-        type: "application/pdf",
+      throw Error("Unimplemented in mock Blob: slice");
-    } as Blob);
+    },
+    type: "application/pdf"
+  } as Blob);
 
-    const upload = await robustFetch({
+  const upload = await robustFetch({
-        url: "https://api.cloud.llamaindex.ai/api/parsing/upload",
+    url: "https://api.cloud.llamaindex.ai/api/parsing/upload",
-        method: "POST",
+    method: "POST",
+    headers: {
+      Authorization: `Bearer ${process.env.LLAMAPARSE_API_KEY}`
+    },
+    body: uploadForm,
+    logger: meta.logger.child({
+      method: "scrapePDFWithLlamaParse/upload/robustFetch"
+    }),
+    schema: z.object({
+      id: z.string()
+    })
+  });
+
+  const jobId = upload.id;
+
+  // TODO: timeout, retries
+  const startedAt = Date.now();
+
+  while (Date.now() <= startedAt + (meta.options.timeout ?? 300000)) {
+    try {
+      const result = await robustFetch({
+        url: `https://api.cloud.llamaindex.ai/api/parsing/job/${jobId}/result/markdown`,
+        method: "GET",
         headers: {
-            "Authorization": `Bearer ${process.env.LLAMAPARSE_API_KEY}`,
+          Authorization: `Bearer ${process.env.LLAMAPARSE_API_KEY}`
         },
-        body: uploadForm,
+        logger: meta.logger.child({
-        logger: meta.logger.child({ method: "scrapePDFWithLlamaParse/upload/robustFetch" }),
+          method: "scrapePDFWithLlamaParse/result/robustFetch"
-        schema: z.object({
-            id: z.string(),
         }),
-    });
+        schema: z.object({
-
+          markdown: z.string()
-    const jobId = upload.id;
+        })
-
+      });
-    // TODO: timeout, retries
+      return {
-    const startedAt = Date.now();
+        markdown: result.markdown,
-
+        html: await marked.parse(result.markdown, { async: true })
-    while (Date.now() <= startedAt + (meta.options.timeout ?? 300000)) {
+      };
-        try {
+    } catch (e) {
-            const result = await robustFetch({
+      if (e instanceof Error && e.message === "Request sent failure status") {
-                url: `https://api.cloud.llamaindex.ai/api/parsing/job/${jobId}/result/markdown`,
+        if ((e.cause as any).response.status === 404) {
-                method: "GET",
+          // no-op, result not up yet
-                headers: {
+        } else if ((e.cause as any).response.body.includes("PDF_IS_BROKEN")) {
-                    "Authorization": `Bearer ${process.env.LLAMAPARSE_API_KEY}`,
+          // URL is not a PDF, actually!
-                },
+          meta.logger.debug("URL is not actually a PDF, signalling...");
-                logger: meta.logger.child({ method: "scrapePDFWithLlamaParse/result/robustFetch" }),
+          throw new RemoveFeatureError(["pdf"]);
-                schema: z.object({
+        } else {
-                    markdown: z.string(),
+          throw new Error("LlamaParse threw an error", {
-                }),
+            cause: e.cause
-            });
+          });
-            return {
-                markdown: result.markdown,
-                html: await marked.parse(result.markdown, { async: true }),
-            };
-        } catch (e) {
-            if (e instanceof Error && e.message === "Request sent failure status") {
-                if ((e.cause as any).response.status === 404) {
-                    // no-op, result not up yet
-                } else if ((e.cause as any).response.body.includes("PDF_IS_BROKEN")) {
-                    // URL is not a PDF, actually!
-                    meta.logger.debug("URL is not actually a PDF, signalling...");
-                    throw new RemoveFeatureError(["pdf"]);
-                } else {
-                    throw new Error("LlamaParse threw an error", {
-                        cause: e.cause,
-                    });
-                }
-            } else {
-                throw e;
-            }
         }
-
+      } else {
-        await new Promise<void>((resolve) => setTimeout(() => resolve(), 250));
+        throw e;
+      }
     }
 
-    throw new Error("LlamaParse timed out");
+    await new Promise<void>((resolve) => setTimeout(() => resolve(), 250));
+  }
+
+  throw new Error("LlamaParse timed out");
 }
 
-async function scrapePDFWithParsePDF(meta: Meta, tempFilePath: string): Promise<PDFProcessorResult> {
+async function scrapePDFWithParsePDF(
-    meta.logger.debug("Processing PDF document with parse-pdf", { tempFilePath });
+  meta: Meta,
+  tempFilePath: string
+): Promise<PDFProcessorResult> {
+  meta.logger.debug("Processing PDF document with parse-pdf", { tempFilePath });
 
-    const result = await PdfParse(await fs.readFile(tempFilePath));
+  const result = await PdfParse(await fs.readFile(tempFilePath));
-    const escaped = escapeHtml(result.text);
+  const escaped = escapeHtml(result.text);
 
-    return {
+  return {
-        markdown: escaped,
+    markdown: escaped,
-        html: escaped,
+    html: escaped
-    };
+  };
 }
 
 export async function scrapePDF(meta: Meta): Promise<EngineScrapeResult> {
-    if (!meta.options.parsePDF) {
+  if (!meta.options.parsePDF) {
-        const file = await fetchFileToBuffer(meta.url);
+    const file = await fetchFileToBuffer(meta.url);
-        const content = file.buffer.toString("base64");
+    const content = file.buffer.toString("base64");
-        return {
-            url: file.response.url,
-            statusCode: file.response.status,
-
-            html: content,
-            markdown: content,
-        };
-    }
-
-    const { response, tempFilePath } = await downloadFile(meta.id, meta.url);
-
-    let result: PDFProcessorResult | null = null;
-    if (process.env.LLAMAPARSE_API_KEY) {
-        try {
-            result = await scrapePDFWithLlamaParse({
-                ...meta,
-                logger: meta.logger.child({ method: "scrapePDF/scrapePDFWithLlamaParse" }),
-            }, tempFilePath);
-        } catch (error) {
-            if (error instanceof Error && error.message === "LlamaParse timed out") {
-                meta.logger.warn("LlamaParse timed out -- falling back to parse-pdf", { error });
-            } else if (error instanceof RemoveFeatureError) {
-                throw error;
-            } else {
-                meta.logger.warn("LlamaParse failed to parse PDF -- falling back to parse-pdf", { error });
-                Sentry.captureException(error);
-            }
-        }
-    }
-
-    if (result === null) {
-        result = await scrapePDFWithParsePDF({
-            ...meta,
-            logger: meta.logger.child({ method: "scrapePDF/scrapePDFWithParsePDF" }),
-        }, tempFilePath);
-    }
-
-    await fs.unlink(tempFilePath);
-
     return {
-        url: response.url,
+      url: file.response.url,
-        statusCode: response.status,
+      statusCode: file.response.status,
 
-        html: result.html,
+      html: content,
-        markdown: result.markdown,
+      markdown: content
+    };
+  }
+
+  const { response, tempFilePath } = await downloadFile(meta.id, meta.url);
+
+  let result: PDFProcessorResult | null = null;
+  if (process.env.LLAMAPARSE_API_KEY) {
+    try {
+      result = await scrapePDFWithLlamaParse(
+        {
+          ...meta,
+          logger: meta.logger.child({
+            method: "scrapePDF/scrapePDFWithLlamaParse"
+          })
+        },
+        tempFilePath
+      );
+    } catch (error) {
+      if (error instanceof Error && error.message === "LlamaParse timed out") {
+        meta.logger.warn("LlamaParse timed out -- falling back to parse-pdf", {
+          error
+        });
+      } else if (error instanceof RemoveFeatureError) {
+        throw error;
+      } else {
+        meta.logger.warn(
+          "LlamaParse failed to parse PDF -- falling back to parse-pdf",
+          { error }
+        );
+        Sentry.captureException(error);
+      }
     }
+  }
+
+  if (result === null) {
+    result = await scrapePDFWithParsePDF(
+      {
+        ...meta,
+        logger: meta.logger.child({ method: "scrapePDF/scrapePDFWithParsePDF" })
+      },
+      tempFilePath
+    );
+  }
+
+  await fs.unlink(tempFilePath);
+
+  return {
+    url: response.url,
+    statusCode: response.status,
+
+    html: result.html,
+    markdown: result.markdown
+  };
 }

apps/api/src/scraper/scrapeURL/engines/playwright/index.ts

@@ -4,39 +4,44 @@ import { Meta } from "../..";
 import { TimeoutError } from "../../error";
 import { robustFetch } from "../../lib/fetch";
 
-export async function scrapeURLWithPlaywright(meta: Meta): Promise<EngineScrapeResult> {
+export async function scrapeURLWithPlaywright(
-    const timeout = 20000 + meta.options.waitFor;
+  meta: Meta
+): Promise<EngineScrapeResult> {
+  const timeout = 20000 + meta.options.waitFor;
 
-    const response = await Promise.race([
+  const response = await Promise.race([
-        await robustFetch({
+    await robustFetch({
-            url: process.env.PLAYWRIGHT_MICROSERVICE_URL!,
+      url: process.env.PLAYWRIGHT_MICROSERVICE_URL!,
-            headers: {
+      headers: {
-                "Content-Type": "application/json",
+        "Content-Type": "application/json"
-            },
+      },
-            body: {
+      body: {
-                url: meta.url,
+        url: meta.url,
-                wait_after_load: meta.options.waitFor,
+        wait_after_load: meta.options.waitFor,
-                timeout,
+        timeout,
-                headers: meta.options.headers,
+        headers: meta.options.headers
-            },
+      },
-            method: "POST",
+      method: "POST",
-            logger: meta.logger.child("scrapeURLWithPlaywright/robustFetch"),
+      logger: meta.logger.child("scrapeURLWithPlaywright/robustFetch"),
-            schema: z.object({
+      schema: z.object({
-                content: z.string(),
+        content: z.string(),
-                pageStatusCode: z.number(),
+        pageStatusCode: z.number(),
-                pageError: z.string().optional(),
+        pageError: z.string().optional()
-            }),
+      })
-        }),
+    }),
-        (async () => {
+    (async () => {
-            await new Promise((resolve) => setTimeout(() => resolve(null), 20000));
+      await new Promise((resolve) => setTimeout(() => resolve(null), 20000));
-            throw new TimeoutError("Playwright was unable to scrape the page before timing out", { cause: { timeout } });
+      throw new TimeoutError(
-        })(),
+        "Playwright was unable to scrape the page before timing out",
-    ]);
+        { cause: { timeout } }
+      );
+    })()
+  ]);
 
-    return {
+  return {
-        url: meta.url, // TODO: impove redirect following
+    url: meta.url, // TODO: impove redirect following
-        html: response.content,
+    html: response.content,
-        statusCode: response.pageStatusCode,
+    statusCode: response.pageStatusCode,
-        error: response.pageError,
+    error: response.pageError
-    }
+  };
 }

apps/api/src/scraper/scrapeURL/engines/scrapingbee/index.ts

@@ -7,60 +7,82 @@ import { EngineError } from "../../error";
 
 const client = new ScrapingBeeClient(process.env.SCRAPING_BEE_API_KEY!);
 
-export function scrapeURLWithScrapingBee(wait_browser: "domcontentloaded" | "networkidle2"): ((meta: Meta) => Promise<EngineScrapeResult>) {
+export function scrapeURLWithScrapingBee(
-    return async (meta: Meta): Promise<EngineScrapeResult> => {
+  wait_browser: "domcontentloaded" | "networkidle2"
-        let response: AxiosResponse<any>;
+): (meta: Meta) => Promise<EngineScrapeResult> {
-        try {
+  return async (meta: Meta): Promise<EngineScrapeResult> => {
-            response = await client.get({
+    let response: AxiosResponse<any>;
-                url: meta.url,
+    try {
-                params: {
+      response = await client.get({
-                    timeout: 15000, // TODO: dynamic timeout based on request timeout
+        url: meta.url,
-                    wait_browser: wait_browser,
+        params: {
-                    wait: Math.min(meta.options.waitFor, 35000),
+          timeout: 15000, // TODO: dynamic timeout based on request timeout
-                    transparent_status_code: true,
+          wait_browser: wait_browser,
-                    json_response: true,
+          wait: Math.min(meta.options.waitFor, 35000),
-                    screenshot: meta.options.formats.includes("screenshot"),
+          transparent_status_code: true,
-                    screenshot_full_page: meta.options.formats.includes("screenshot@fullPage"),             
+          json_response: true,
-                },
+          screenshot: meta.options.formats.includes("screenshot"),
-                headers: {
+          screenshot_full_page: meta.options.formats.includes(
-                    "ScrapingService-Request": "TRUE", // this is sent to the page, not to ScrapingBee - mogery
+            "screenshot@fullPage"
-                },
+          )
-            });
+        },
-        } catch (error) {
+        headers: {
-            if (error instanceof AxiosError && error.response !== undefined) {
+          "ScrapingService-Request": "TRUE" // this is sent to the page, not to ScrapingBee - mogery
-                response = error.response;
-            } else {
-                throw error;
-            }
         }
+      });
+    } catch (error) {
+      if (error instanceof AxiosError && error.response !== undefined) {
+        response = error.response;
+      } else {
+        throw error;
+      }
+    }
 
-        const data: Buffer = response.data;
+    const data: Buffer = response.data;
-        const body = JSON.parse(new TextDecoder().decode(data));
+    const body = JSON.parse(new TextDecoder().decode(data));
 
-        const headers = body.headers ?? {};
+    const headers = body.headers ?? {};
-        const isHiddenEngineError = !(headers["Date"] ?? headers["date"] ?? headers["Content-Type"] ?? headers["content-type"]);
+    const isHiddenEngineError = !(
+      headers["Date"] ??
+      headers["date"] ??
+      headers["Content-Type"] ??
+      headers["content-type"]
+    );
 
-        if (body.errors || body.body?.error || isHiddenEngineError) {
+    if (body.errors || body.body?.error || isHiddenEngineError) {
-            meta.logger.error("ScrapingBee threw an error", { body: body.body?.error ?? body.errors ?? body.body ?? body });
+      meta.logger.error("ScrapingBee threw an error", {
-            throw new EngineError("Engine error #34", { cause: { body, statusCode: response.status } });
+        body: body.body?.error ?? body.errors ?? body.body ?? body
-        }
+      });
+      throw new EngineError("Engine error #34", {
+        cause: { body, statusCode: response.status }
+      });
+    }
 
-        if (typeof body.body !== "string") {
+    if (typeof body.body !== "string") {
-            meta.logger.error("ScrapingBee: Body is not string??", { body });
+      meta.logger.error("ScrapingBee: Body is not string??", { body });
-            throw new EngineError("Engine error #35", { cause: { body, statusCode: response.status } });
+      throw new EngineError("Engine error #35", {
-        }
+        cause: { body, statusCode: response.status }
+      });
+    }
 
-        specialtyScrapeCheck(meta.logger.child({ method: "scrapeURLWithScrapingBee/specialtyScrapeCheck" }), body.headers);
+    specialtyScrapeCheck(
+      meta.logger.child({
+        method: "scrapeURLWithScrapingBee/specialtyScrapeCheck"
+      }),
+      body.headers
+    );
 
-        return {
+    return {
-            url: body["resolved-url"] ?? meta.url,
+      url: body["resolved-url"] ?? meta.url,
 
-            html: body.body,
+      html: body.body,
-            error: response.status >= 300 ? response.statusText : undefined,
+      error: response.status >= 300 ? response.statusText : undefined,
-            statusCode: response.status,
+      statusCode: response.status,
-            ...(body.screenshot ? ({
+      ...(body.screenshot
-                screenshot: `data:image/png;base64,${body.screenshot}`,
+        ? {
-            }) : {}),
+            screenshot: `data:image/png;base64,${body.screenshot}`
-        };
+          }
+        : {})
     };
+  };
 }

apps/api/src/scraper/scrapeURL/engines/utils/downloadFile.ts

@@ -7,48 +7,53 @@ import { v4 as uuid } from "uuid";
 import * as undici from "undici";
 
 export async function fetchFileToBuffer(url: string): Promise<{
-    response: Response,
+  response: Response;
-    buffer: Buffer
+  buffer: Buffer;
 }> {
-    const response = await fetch(url); // TODO: maybe we could use tlsclient for this? for proxying
+  const response = await fetch(url); // TODO: maybe we could use tlsclient for this? for proxying
-    return {
+  return {
-        response,
+    response,
-        buffer: Buffer.from(await response.arrayBuffer()),
+    buffer: Buffer.from(await response.arrayBuffer())
-    };
+  };
 }
 
-export async function downloadFile(id: string, url: string): Promise<{
+export async function downloadFile(
-    response: undici.Response
+  id: string,
-    tempFilePath: string
+  url: string
+): Promise<{
+  response: undici.Response;
+  tempFilePath: string;
 }> {
-    const tempFilePath = path.join(os.tmpdir(), `tempFile-${id}--${uuid()}`);
+  const tempFilePath = path.join(os.tmpdir(), `tempFile-${id}--${uuid()}`);
-    const tempFileWrite = createWriteStream(tempFilePath);
+  const tempFileWrite = createWriteStream(tempFilePath);
 
-    // TODO: maybe we could use tlsclient for this? for proxying
+  // TODO: maybe we could use tlsclient for this? for proxying
-    // use undici to ignore SSL for now
+  // use undici to ignore SSL for now
-    const response = await undici.fetch(url, {
+  const response = await undici.fetch(url, {
-        dispatcher: new undici.Agent({
+    dispatcher: new undici.Agent({
-            connect: {
+      connect: {
-                rejectUnauthorized: false,
+        rejectUnauthorized: false
-            },
+      }
-        })
-    });
-
-    // This should never happen in the current state of JS (2024), but let's check anyways.
-    if (response.body === null) {
-        throw new EngineError("Response body was null", { cause: { response } });
-    }
-
-    response.body.pipeTo(Writable.toWeb(tempFileWrite));
-    await new Promise((resolve, reject) => {
-        tempFileWrite.on("finish", () => resolve(null));
-        tempFileWrite.on("error", (error) => {
-            reject(new EngineError("Failed to write to temp file", { cause: { error } }));
-        });
     })
+  });
 
-    return {
+  // This should never happen in the current state of JS (2024), but let's check anyways.
-        response,
+  if (response.body === null) {
-        tempFilePath,
+    throw new EngineError("Response body was null", { cause: { response } });
-    };
+  }
+
+  response.body.pipeTo(Writable.toWeb(tempFileWrite));
+  await new Promise((resolve, reject) => {
+    tempFileWrite.on("finish", () => resolve(null));
+    tempFileWrite.on("error", (error) => {
+      reject(
+        new EngineError("Failed to write to temp file", { cause: { error } })
+      );
+    });
+  });
+
+  return {
+    response,
+    tempFilePath
+  };
 }

apps/api/src/scraper/scrapeURL/engines/utils/specialtyHandler.ts

@@ -1,14 +1,32 @@
 import { Logger } from "winston";
 import { AddFeatureError } from "../../error";
 
-export function specialtyScrapeCheck(logger: Logger, headers: Record<string, string> | undefined) {
+export function specialtyScrapeCheck(
-    const contentType = (Object.entries(headers ?? {}).find(x => x[0].toLowerCase() === "content-type") ?? [])[1];
+  logger: Logger,
+  headers: Record<string, string> | undefined
+) {
+  const contentType = (Object.entries(headers ?? {}).find(
+    (x) => x[0].toLowerCase() === "content-type"
+  ) ?? [])[1];
 
-    if (contentType === undefined) {
+  if (contentType === undefined) {
-        logger.warn("Failed to check contentType -- was not present in headers", { headers });
+    logger.warn("Failed to check contentType -- was not present in headers", {
-    } else if (contentType === "application/pdf" || contentType.startsWith("application/pdf;")) { // .pdf
+      headers
-        throw new AddFeatureError(["pdf"]);
+    });
-    } else if (contentType === "application/vnd.openxmlformats-officedocument.wordprocessingml.document" || contentType.startsWith("application/vnd.openxmlformats-officedocument.wordprocessingml.document;")) { // .docx
+  } else if (
-        throw new AddFeatureError(["docx"]);
+    contentType === "application/pdf" ||
-    }
+    contentType.startsWith("application/pdf;")
+  ) {
+    // .pdf
+    throw new AddFeatureError(["pdf"]);
+  } else if (
+    contentType ===
+      "application/vnd.openxmlformats-officedocument.wordprocessingml.document" ||
+    contentType.startsWith(
+      "application/vnd.openxmlformats-officedocument.wordprocessingml.document;"
+    )
+  ) {
+    // .docx
+    throw new AddFeatureError(["docx"]);
+  }
 }

apps/api/src/scraper/scrapeURL/error.ts

@@ -1,51 +1,57 @@
-import { EngineResultsTracker } from "."
+import { EngineResultsTracker } from ".";
-import { Engine, FeatureFlag } from "./engines"
+import { Engine, FeatureFlag } from "./engines";
 
 export class EngineError extends Error {
-    constructor(message?: string, options?: ErrorOptions) {
+  constructor(message?: string, options?: ErrorOptions) {
-        super(message, options)
+    super(message, options);
-    }
+  }
 }
 
 export class TimeoutError extends Error {
-    constructor(message?: string, options?: ErrorOptions) {
+  constructor(message?: string, options?: ErrorOptions) {
-        super(message, options)
+    super(message, options);
-    }
+  }
 }
 
 export class NoEnginesLeftError extends Error {
-    public fallbackList: Engine[];
+  public fallbackList: Engine[];
-    public results: EngineResultsTracker;
+  public results: EngineResultsTracker;
 
-    constructor(fallbackList: Engine[], results: EngineResultsTracker) {
+  constructor(fallbackList: Engine[], results: EngineResultsTracker) {
-        super("All scraping engines failed! -- Double check the URL to make sure it's not broken. If the issue persists, contact us at help@firecrawl.com.");
+    super(
-        this.fallbackList = fallbackList;
+      "All scraping engines failed! -- Double check the URL to make sure it's not broken. If the issue persists, contact us at help@firecrawl.com."
-        this.results = results;
+    );
-    }
+    this.fallbackList = fallbackList;
+    this.results = results;
+  }
 }
 
 export class AddFeatureError extends Error {
-    public featureFlags: FeatureFlag[];
+  public featureFlags: FeatureFlag[];
 
-    constructor(featureFlags: FeatureFlag[]) {
+  constructor(featureFlags: FeatureFlag[]) {
-        super("New feature flags have been discovered: " + featureFlags.join(", "));
+    super("New feature flags have been discovered: " + featureFlags.join(", "));
-        this.featureFlags = featureFlags;
+    this.featureFlags = featureFlags;
-    }
+  }
 }
 
 export class RemoveFeatureError extends Error {
-    public featureFlags: FeatureFlag[];
+  public featureFlags: FeatureFlag[];
 
-    constructor(featureFlags: FeatureFlag[]) {
+  constructor(featureFlags: FeatureFlag[]) {
-        super("Incorrect feature flags have been discovered: " + featureFlags.join(", "));
+    super(
-        this.featureFlags = featureFlags;
+      "Incorrect feature flags have been discovered: " + featureFlags.join(", ")
-    }
+    );
+    this.featureFlags = featureFlags;
+  }
 }
 
 export class SiteError extends Error {
-    public code: string;
+  public code: string;
-    constructor(code: string) {
+  constructor(code: string) {
-        super("Specified URL is failing to load in the browser. Error code: " + code)
+    super(
-        this.code = code;
+      "Specified URL is failing to load in the browser. Error code: " + code
-    }
+    );
+    this.code = code;
+  }
 }

apps/api/src/scraper/scrapeURL/index.ts

@@ -3,84 +3,104 @@ import * as Sentry from "@sentry/node";
 
 import { Document, ScrapeOptions } from "../../controllers/v1/types";
 import { logger } from "../../lib/logger";
-import { buildFallbackList, Engine, EngineScrapeResult, FeatureFlag, scrapeURLWithEngine } from "./engines";
+import {
+  buildFallbackList,
+  Engine,
+  EngineScrapeResult,
+  FeatureFlag,
+  scrapeURLWithEngine
+} from "./engines";
 import { parseMarkdown } from "../../lib/html-to-markdown";
-import { AddFeatureError, EngineError, NoEnginesLeftError, RemoveFeatureError, SiteError, TimeoutError } from "./error";
+import {
+  AddFeatureError,
+  EngineError,
+  NoEnginesLeftError,
+  RemoveFeatureError,
+  SiteError,
+  TimeoutError
+} from "./error";
 import { executeTransformers } from "./transformers";
 import { LLMRefusalError } from "./transformers/llmExtract";
 import { urlSpecificParams } from "./lib/urlSpecificParams";
 
-export type ScrapeUrlResponse = ({
+export type ScrapeUrlResponse = (
-    success: true,
+  | {
-    document: Document,
+      success: true;
-} | {
+      document: Document;
-    success: false,
+    }
-    error: any,
+  | {
-}) & {
+      success: false;
-    logs: any[],
+      error: any;
-    engines: EngineResultsTracker,
+    }
-}
+) & {
+  logs: any[];
+  engines: EngineResultsTracker;
+};
 
 export type Meta = {
-    id: string;
+  id: string;
-    url: string;
+  url: string;
-    options: ScrapeOptions;
+  options: ScrapeOptions;
-    internalOptions: InternalOptions;
+  internalOptions: InternalOptions;
-    logger: Logger;
+  logger: Logger;
-    logs: any[];
+  logs: any[];
-    featureFlags: Set<FeatureFlag>;
+  featureFlags: Set<FeatureFlag>;
-}
+};
 
-function buildFeatureFlags(url: string, options: ScrapeOptions, internalOptions: InternalOptions): Set<FeatureFlag> {
+function buildFeatureFlags(
-    const flags: Set<FeatureFlag> = new Set();
+  url: string,
+  options: ScrapeOptions,
+  internalOptions: InternalOptions
+): Set<FeatureFlag> {
+  const flags: Set<FeatureFlag> = new Set();
 
-    if (options.actions !== undefined) {
+  if (options.actions !== undefined) {
-        flags.add("actions");
+    flags.add("actions");
-    }
+  }
 
-    if (options.formats.includes("screenshot")) {
+  if (options.formats.includes("screenshot")) {
-        flags.add("screenshot");
+    flags.add("screenshot");
-    }
+  }
 
-    if (options.formats.includes("screenshot@fullPage")) {
+  if (options.formats.includes("screenshot@fullPage")) {
-        flags.add("screenshot@fullScreen");
+    flags.add("screenshot@fullScreen");
-    }
+  }
 
-    if (options.waitFor !== 0) {
+  if (options.waitFor !== 0) {
-        flags.add("waitFor");
+    flags.add("waitFor");
-    }
+  }
 
-    if (internalOptions.atsv) {
+  if (internalOptions.atsv) {
-        flags.add("atsv");
+    flags.add("atsv");
-    }
+  }
 
-    if (options.location || options.geolocation) {
+  if (options.location || options.geolocation) {
-        flags.add("location");
+    flags.add("location");
-    }
+  }
 
-    if (options.mobile) {
+  if (options.mobile) {
-        flags.add("mobile");
+    flags.add("mobile");
-    }
+  }
-    
-    if (options.skipTlsVerification) {
-        flags.add("skipTlsVerification");
-    }
 
-    if (internalOptions.v0UseFastMode) {
+  if (options.skipTlsVerification) {
-        flags.add("useFastMode");
+    flags.add("skipTlsVerification");
-    }
+  }
 
-    const urlO = new URL(url);
+  if (internalOptions.v0UseFastMode) {
+    flags.add("useFastMode");
+  }
 
-    if (urlO.pathname.endsWith(".pdf")) {
+  const urlO = new URL(url);
-        flags.add("pdf");
-    }
 
-    if (urlO.pathname.endsWith(".docx")) {
+  if (urlO.pathname.endsWith(".pdf")) {
-        flags.add("docx");
+    flags.add("pdf");
-    }
+  }
 
-    return flags;
+  if (urlO.pathname.endsWith(".docx")) {
+    flags.add("docx");
+  }
+
+  return flags;
 }
 
 // The meta object contains all required information to perform a scrape.
@@ -88,244 +108,314 @@ function buildFeatureFlags(url: string, options: ScrapeOptions, internalOptions:
 // The meta object is usually immutable, except for the logs array, and in edge cases (e.g. a new feature is suddenly required)
 // Having a meta object that is treated as immutable helps the code stay clean and easily tracable,
 // while also retaining the benefits that WebScraper had from its OOP design.
-function buildMetaObject(id: string, url: string, options: ScrapeOptions, internalOptions: InternalOptions): Meta {
+function buildMetaObject(
-    const specParams = urlSpecificParams[new URL(url).hostname.replace(/^www\./, "")];
+  id: string,
-    if (specParams !== undefined) {
+  url: string,
-        options = Object.assign(options, specParams.scrapeOptions);
+  options: ScrapeOptions,
-        internalOptions = Object.assign(internalOptions, specParams.internalOptions);
+  internalOptions: InternalOptions
-    }
+): Meta {
+  const specParams =
+    urlSpecificParams[new URL(url).hostname.replace(/^www\./, "")];
+  if (specParams !== undefined) {
+    options = Object.assign(options, specParams.scrapeOptions);
+    internalOptions = Object.assign(
+      internalOptions,
+      specParams.internalOptions
+    );
+  }
 
-    const _logger = logger.child({ module: "ScrapeURL", scrapeId: id, scrapeURL: url });
+  const _logger = logger.child({
-    const logs: any[] = [];
+    module: "ScrapeURL",
+    scrapeId: id,
+    scrapeURL: url
+  });
+  const logs: any[] = [];
 
-    return {
+  return {
-        id, url, options, internalOptions,
+    id,
-        logger: _logger,
+    url,
-        logs,
+    options,
-        featureFlags: buildFeatureFlags(url, options, internalOptions),
+    internalOptions,
-    };
+    logger: _logger,
+    logs,
+    featureFlags: buildFeatureFlags(url, options, internalOptions)
+  };
 }
 
 export type InternalOptions = {
-    priority?: number; // Passed along to fire-engine
+  priority?: number; // Passed along to fire-engine
-    forceEngine?: Engine;
+  forceEngine?: Engine;
-    atsv?: boolean; // anti-bot solver, beta
+  atsv?: boolean; // anti-bot solver, beta
 
-    v0CrawlOnlyUrls?: boolean;
+  v0CrawlOnlyUrls?: boolean;
-    v0UseFastMode?: boolean;
+  v0UseFastMode?: boolean;
-    v0DisableJsDom?: boolean;
+  v0DisableJsDom?: boolean;
 
-    disableSmartWaitCache?: boolean; // Passed along to fire-engine
+  disableSmartWaitCache?: boolean; // Passed along to fire-engine
 };
 
-export type EngineResultsTracker = { [E in Engine]?: ({
+export type EngineResultsTracker = {
-    state: "error",
+  [E in Engine]?: (
-    error: any,
+    | {
-    unexpected: boolean,
+        state: "error";
-} | {
+        error: any;
-    state: "success",
+        unexpected: boolean;
-    result: EngineScrapeResult & { markdown: string },
+      }
-    factors: Record<string, boolean>,
+    | {
-    unsupportedFeatures: Set<FeatureFlag>,
+        state: "success";
-} | {
+        result: EngineScrapeResult & { markdown: string };
-    state: "timeout",
+        factors: Record<string, boolean>;
-}) & {
+        unsupportedFeatures: Set<FeatureFlag>;
-    startedAt: number,
+      }
-    finishedAt: number,
+    | {
-} };
+        state: "timeout";
+      }
+  ) & {
+    startedAt: number;
+    finishedAt: number;
+  };
+};
 
 export type EngineScrapeResultWithContext = {
-    engine: Engine,
+  engine: Engine;
-    unsupportedFeatures: Set<FeatureFlag>,
+  unsupportedFeatures: Set<FeatureFlag>;
-    result: (EngineScrapeResult & { markdown: string }),
+  result: EngineScrapeResult & { markdown: string };
 };
 
 function safeguardCircularError<T>(error: T): T {
-    if (typeof error === "object" && error !== null && (error as any).results) {
+  if (typeof error === "object" && error !== null && (error as any).results) {
-        const newError = structuredClone(error);
+    const newError = structuredClone(error);
-        delete (newError as any).results;
+    delete (newError as any).results;
-        return newError;
+    return newError;
-    } else {
+  } else {
-        return error;
+    return error;
-    }
+  }
 }
 
-async function scrapeURLLoop(
+async function scrapeURLLoop(meta: Meta): Promise<ScrapeUrlResponse> {
-    meta: Meta
+  meta.logger.info(`Scraping URL ${JSON.stringify(meta.url)}...`);
-): Promise<ScrapeUrlResponse> {
-    meta.logger.info(`Scraping URL ${JSON.stringify(meta.url)}...`,);
 
-    // TODO: handle sitemap data, see WebScraper/index.ts:280
+  // TODO: handle sitemap data, see WebScraper/index.ts:280
-    // TODO: ScrapeEvents
+  // TODO: ScrapeEvents
 
-    const fallbackList = buildFallbackList(meta);
+  const fallbackList = buildFallbackList(meta);
 
-    const results: EngineResultsTracker = {};
+  const results: EngineResultsTracker = {};
-    let result: EngineScrapeResultWithContext | null = null;
+  let result: EngineScrapeResultWithContext | null = null;
 
-    for (const { engine, unsupportedFeatures } of fallbackList) {
+  for (const { engine, unsupportedFeatures } of fallbackList) {
-        const startedAt = Date.now();
+    const startedAt = Date.now();
-        try {
+    try {
-            meta.logger.info("Scraping via " + engine + "...");
+      meta.logger.info("Scraping via " + engine + "...");
-            const _engineResult = await scrapeURLWithEngine(meta, engine);
+      const _engineResult = await scrapeURLWithEngine(meta, engine);
-            if (_engineResult.markdown === undefined) { // Some engines emit Markdown directly.
+      if (_engineResult.markdown === undefined) {
-                _engineResult.markdown = await parseMarkdown(_engineResult.html);
+        // Some engines emit Markdown directly.
-            }
+        _engineResult.markdown = await parseMarkdown(_engineResult.html);
-            const engineResult = _engineResult as EngineScrapeResult & { markdown: string };
+      }
+      const engineResult = _engineResult as EngineScrapeResult & {
+        markdown: string;
+      };
 
-            // Success factors
+      // Success factors
-            const isLongEnough = engineResult.markdown.length >= 20;
+      const isLongEnough = engineResult.markdown.length >= 20;
-            const isGoodStatusCode = (engineResult.statusCode >= 200 && engineResult.statusCode < 300) || engineResult.statusCode === 304;
+      const isGoodStatusCode =
-            const hasNoPageError = engineResult.error === undefined;
+        (engineResult.statusCode >= 200 && engineResult.statusCode < 300) ||
+        engineResult.statusCode === 304;
+      const hasNoPageError = engineResult.error === undefined;
 
-            results[engine] = {
+      results[engine] = {
-                state: "success",
+        state: "success",
-                result: engineResult,
+        result: engineResult,
-                factors: { isLongEnough, isGoodStatusCode, hasNoPageError },
+        factors: { isLongEnough, isGoodStatusCode, hasNoPageError },
-                unsupportedFeatures,
+        unsupportedFeatures,
-                startedAt,
+        startedAt,
-                finishedAt: Date.now(),
+        finishedAt: Date.now()
-            };
+      };
 
-            // NOTE: TODO: what to do when status code is bad is tough...
+      // NOTE: TODO: what to do when status code is bad is tough...
-            // we cannot just rely on text because error messages can be brief and not hit the limit
+      // we cannot just rely on text because error messages can be brief and not hit the limit
-            // should we just use all the fallbacks and pick the one with the longest text? - mogery
+      // should we just use all the fallbacks and pick the one with the longest text? - mogery
-            if (isLongEnough || !isGoodStatusCode) {
+      if (isLongEnough || !isGoodStatusCode) {
-                meta.logger.info("Scrape via " + engine + " deemed successful.", { factors: { isLongEnough, isGoodStatusCode, hasNoPageError } });
+        meta.logger.info("Scrape via " + engine + " deemed successful.", {
-                result = {
+          factors: { isLongEnough, isGoodStatusCode, hasNoPageError }
-                    engine,
+        });
-                    unsupportedFeatures,
+        result = {
-                    result: engineResult as EngineScrapeResult & { markdown: string }
+          engine,
-                };
+          unsupportedFeatures,
-                break;
+          result: engineResult as EngineScrapeResult & { markdown: string }
-            }
+        };
-        } catch (error) {
+        break;
-            if (error instanceof EngineError) {
+      }
-                meta.logger.info("Engine " + engine + " could not scrape the page.", { error });
+    } catch (error) {
-                results[engine] = {
+      if (error instanceof EngineError) {
-                    state: "error",
+        meta.logger.info("Engine " + engine + " could not scrape the page.", {
-                    error: safeguardCircularError(error),
+          error
-                    unexpected: false,
+        });
-                    startedAt,
+        results[engine] = {
-                    finishedAt: Date.now(),
+          state: "error",
-                };
+          error: safeguardCircularError(error),
-            } else if (error instanceof TimeoutError) {
+          unexpected: false,
-                meta.logger.info("Engine " + engine + " timed out while scraping.", { error });
+          startedAt,
-                results[engine] = {
+          finishedAt: Date.now()
-                    state: "timeout",
+        };
-                    startedAt,
+      } else if (error instanceof TimeoutError) {
-                    finishedAt: Date.now(),
+        meta.logger.info("Engine " + engine + " timed out while scraping.", {
-                };
+          error
-            } else if (error instanceof AddFeatureError || error instanceof RemoveFeatureError) {
+        });
-                throw error;
+        results[engine] = {
-            } else if (error instanceof LLMRefusalError) {
+          state: "timeout",
-                results[engine] = {
+          startedAt,
-                    state: "error",
+          finishedAt: Date.now()
-                    error: safeguardCircularError(error),
+        };
-                    unexpected: true,
+      } else if (
-                    startedAt,
+        error instanceof AddFeatureError ||
-                    finishedAt: Date.now(),
+        error instanceof RemoveFeatureError
-                }
+      ) {
-                error.results = results;
+        throw error;
-                meta.logger.warn("LLM refusal encountered", { error });
+      } else if (error instanceof LLMRefusalError) {
-                throw error;
+        results[engine] = {
-            } else if (error instanceof SiteError) {
+          state: "error",
-                throw error;
+          error: safeguardCircularError(error),
-            } else {
+          unexpected: true,
-                Sentry.captureException(error);
+          startedAt,
-                meta.logger.info("An unexpected error happened while scraping with " + engine + ".", { error });
+          finishedAt: Date.now()
-                results[engine] = {
+        };
-                    state: "error",
+        error.results = results;
-                    error: safeguardCircularError(error),
+        meta.logger.warn("LLM refusal encountered", { error });
-                    unexpected: true,
+        throw error;
-                    startedAt,
+      } else if (error instanceof SiteError) {
-                    finishedAt: Date.now(),
+        throw error;
-                }
+      } else {
-            }
+        Sentry.captureException(error);
-        }
+        meta.logger.info(
+          "An unexpected error happened while scraping with " + engine + ".",
+          { error }
+        );
+        results[engine] = {
+          state: "error",
+          error: safeguardCircularError(error),
+          unexpected: true,
+          startedAt,
+          finishedAt: Date.now()
+        };
+      }
     }
+  }
 
-    if (result === null) {
+  if (result === null) {
-        throw new NoEnginesLeftError(fallbackList.map(x => x.engine), results);
+    throw new NoEnginesLeftError(
+      fallbackList.map((x) => x.engine),
+      results
+    );
+  }
+
+  let document: Document = {
+    markdown: result.result.markdown,
+    rawHtml: result.result.html,
+    screenshot: result.result.screenshot,
+    actions: result.result.actions,
+    metadata: {
+      sourceURL: meta.url,
+      url: result.result.url,
+      statusCode: result.result.statusCode,
+      error: result.result.error
     }
+  };
 
-    let document: Document = {
+  if (result.unsupportedFeatures.size > 0) {
-        markdown: result.result.markdown,
+    const warning = `The engine used does not support the following features: ${[...result.unsupportedFeatures].join(", ")} -- your scrape may be partial.`;
-        rawHtml: result.result.html,
+    meta.logger.warn(warning, {
-        screenshot: result.result.screenshot,
+      engine: result.engine,
-        actions: result.result.actions,
+      unsupportedFeatures: result.unsupportedFeatures
-        metadata: {
+    });
-            sourceURL: meta.url,
+    document.warning =
-            url: result.result.url,
+      document.warning !== undefined
-            statusCode: result.result.statusCode,
+        ? document.warning + " " + warning
-            error: result.result.error,
+        : warning;
-        },
+  }
-    }
 
-    if (result.unsupportedFeatures.size > 0) {
+  document = await executeTransformers(meta, document);
-        const warning = `The engine used does not support the following features: ${[...result.unsupportedFeatures].join(", ")} -- your scrape may be partial.`;
-        meta.logger.warn(warning, { engine: result.engine, unsupportedFeatures: result.unsupportedFeatures });
-        document.warning = document.warning !== undefined ? document.warning + " " + warning : warning;
-    }
 
-    document = await executeTransformers(meta, document);
+  return {
-
+    success: true,
-    return {
+    document,
-        success: true,
+    logs: meta.logs,
-        document,
+    engines: results
-        logs: meta.logs,
+  };
-        engines: results,
-    };
 }
 
 export async function scrapeURL(
-    id: string,
+  id: string,
-    url: string,
+  url: string,
-    options: ScrapeOptions,
+  options: ScrapeOptions,
-    internalOptions: InternalOptions = {},
+  internalOptions: InternalOptions = {}
 ): Promise<ScrapeUrlResponse> {
-    const meta = buildMetaObject(id, url, options, internalOptions);
+  const meta = buildMetaObject(id, url, options, internalOptions);
-    try {
+  try {
-        while (true) {
+    while (true) {
-            try {
+      try {
-                return await scrapeURLLoop(meta);
+        return await scrapeURLLoop(meta);
-            } catch (error) {
+      } catch (error) {
-                if (error instanceof AddFeatureError && meta.internalOptions.forceEngine === undefined) {
+        if (
-                    meta.logger.debug("More feature flags requested by scraper: adding " + error.featureFlags.join(", "), { error, existingFlags: meta.featureFlags });
+          error instanceof AddFeatureError &&
-                    meta.featureFlags = new Set([...meta.featureFlags].concat(error.featureFlags));
+          meta.internalOptions.forceEngine === undefined
-                } else if (error instanceof RemoveFeatureError && meta.internalOptions.forceEngine === undefined) {
+        ) {
-                    meta.logger.debug("Incorrect feature flags reported by scraper: removing " + error.featureFlags.join(","), { error, existingFlags: meta.featureFlags });
+          meta.logger.debug(
-                    meta.featureFlags = new Set([...meta.featureFlags].filter(x => !error.featureFlags.includes(x)));
+            "More feature flags requested by scraper: adding " +
-                } else {
+              error.featureFlags.join(", "),
-                    throw error;
+            { error, existingFlags: meta.featureFlags }
-                }
+          );
-            }
+          meta.featureFlags = new Set(
-        }
+            [...meta.featureFlags].concat(error.featureFlags)
-    } catch (error) {
+          );
-        let results: EngineResultsTracker = {};
+        } else if (
-
+          error instanceof RemoveFeatureError &&
-        if (error instanceof NoEnginesLeftError) {
+          meta.internalOptions.forceEngine === undefined
-            meta.logger.warn("scrapeURL: All scraping engines failed!", { error });
+        ) {
-            results = error.results;
+          meta.logger.debug(
-        } else if (error instanceof LLMRefusalError) {
+            "Incorrect feature flags reported by scraper: removing " +
-            meta.logger.warn("scrapeURL: LLM refused to extract content", { error });
+              error.featureFlags.join(","),
-            results = error.results!;
+            { error, existingFlags: meta.featureFlags }
-        } else if (error instanceof Error && error.message.includes("Invalid schema for response_format")) { // TODO: seperate into custom error
+          );
-            meta.logger.warn("scrapeURL: LLM schema error", { error });
+          meta.featureFlags = new Set(
-            // TODO: results?
+            [...meta.featureFlags].filter(
-        } else if (error instanceof SiteError) {
+              (x) => !error.featureFlags.includes(x)
-            meta.logger.warn("scrapeURL: Site failed to load in browser", { error });
+            )
+          );
         } else {
-            Sentry.captureException(error);
+          throw error;
-            meta.logger.error("scrapeURL: Unexpected error happened", { error });
-            // TODO: results?
-        }
-
-        return {
-            success: false,
-            error,
-            logs: meta.logs,
-            engines: results,
         }
+      }
     }
+  } catch (error) {
+    let results: EngineResultsTracker = {};
+
+    if (error instanceof NoEnginesLeftError) {
+      meta.logger.warn("scrapeURL: All scraping engines failed!", { error });
+      results = error.results;
+    } else if (error instanceof LLMRefusalError) {
+      meta.logger.warn("scrapeURL: LLM refused to extract content", { error });
+      results = error.results!;
+    } else if (
+      error instanceof Error &&
+      error.message.includes("Invalid schema for response_format")
+    ) {
+      // TODO: seperate into custom error
+      meta.logger.warn("scrapeURL: LLM schema error", { error });
+      // TODO: results?
+    } else if (error instanceof SiteError) {
+      meta.logger.warn("scrapeURL: Site failed to load in browser", { error });
+    } else {
+      Sentry.captureException(error);
+      meta.logger.error("scrapeURL: Unexpected error happened", { error });
+      // TODO: results?
+    }
+
+    return {
+      success: false,
+      error,
+      logs: meta.logs,
+      engines: results
+    };
+  }
 }

apps/api/src/scraper/scrapeURL/lib/extractLinks.ts

@@ -3,33 +3,36 @@ import { load } from "cheerio";
 import { logger } from "../../../lib/logger";
 
 export function extractLinks(html: string, baseUrl: string): string[] {
-    const $ = load(html);
+  const $ = load(html);
-    const links: string[] = [];
+  const links: string[] = [];
-  
+
-    $('a').each((_, element) => {
+  $("a").each((_, element) => {
-        const href = $(element).attr('href');
+    const href = $(element).attr("href");
-        if (href) {
+    if (href) {
-            try {
+      try {
-                if (href.startsWith('http://') || href.startsWith('https://')) {
+        if (href.startsWith("http://") || href.startsWith("https://")) {
-                    // Absolute URL, add as is
+          // Absolute URL, add as is
-                    links.push(href);
+          links.push(href);
-                } else if (href.startsWith('/')) {
+        } else if (href.startsWith("/")) {
-                    // Relative URL starting with '/', append to origin
+          // Relative URL starting with '/', append to origin
-                    links.push(new URL(href, baseUrl).href);
+          links.push(new URL(href, baseUrl).href);
-                } else if (!href.startsWith('#') && !href.startsWith('mailto:')) {
+        } else if (!href.startsWith("#") && !href.startsWith("mailto:")) {
-                    // Relative URL not starting with '/', append to base URL
+          // Relative URL not starting with '/', append to base URL
-                    links.push(new URL(href, baseUrl).href);
+          links.push(new URL(href, baseUrl).href);
-                } else if (href.startsWith('mailto:')) {
+        } else if (href.startsWith("mailto:")) {
-                    // mailto: links, add as is
+          // mailto: links, add as is
-                    links.push(href);
+          links.push(href);
-                }
-                // Fragment-only links (#) are ignored
-            } catch (error) {
-                logger.error(`Failed to construct URL for href: ${href} with base: ${baseUrl}`, { error });
-            }
         }
-    });
+        // Fragment-only links (#) are ignored
-  
+      } catch (error) {
-    // Remove duplicates and return
+        logger.error(
-    return [...new Set(links)];
+          `Failed to construct URL for href: ${href} with base: ${baseUrl}`,
-}
+          { error }
+        );
+      }
+    }
+  });
+
+  // Remove duplicates and return
+  return [...new Set(links)];
+}

apps/api/src/scraper/scrapeURL/lib/extractMetadata.ts

@@ -2,7 +2,10 @@ import { load } from "cheerio";
 import { Document } from "../../../controllers/v1/types";
 import { Meta } from "..";
 
-export function extractMetadata(meta: Meta, html: string): Document["metadata"] {
+export function extractMetadata(
+  meta: Meta,
+  html: string
+): Document["metadata"] {
   let title: string | undefined = undefined;
   let description: string | undefined = undefined;
   let language: string | undefined = undefined;
@@ -39,36 +42,54 @@ export function extractMetadata(meta: Meta, html: string): Document["metadata"]
   try {
     title = soup("title").text() || undefined;
     description = soup('meta[name="description"]').attr("content") || undefined;
-    
+
     // Assuming the language is part of the URL as per the regex pattern
-    language = soup('html').attr('lang') || undefined;
+    language = soup("html").attr("lang") || undefined;
 
     keywords = soup('meta[name="keywords"]').attr("content") || undefined;
     robots = soup('meta[name="robots"]').attr("content") || undefined;
     ogTitle = soup('meta[property="og:title"]').attr("content") || undefined;
-    ogDescription = soup('meta[property="og:description"]').attr("content") || undefined;
+    ogDescription =
+      soup('meta[property="og:description"]').attr("content") || undefined;
     ogUrl = soup('meta[property="og:url"]').attr("content") || undefined;
     ogImage = soup('meta[property="og:image"]').attr("content") || undefined;
     ogAudio = soup('meta[property="og:audio"]').attr("content") || undefined;
-    ogDeterminer = soup('meta[property="og:determiner"]').attr("content") || undefined;
+    ogDeterminer =
+      soup('meta[property="og:determiner"]').attr("content") || undefined;
     ogLocale = soup('meta[property="og:locale"]').attr("content") || undefined;
-    ogLocaleAlternate = soup('meta[property="og:locale:alternate"]').map((i, el) => soup(el).attr("content")).get() || undefined;
+    ogLocaleAlternate =
-    ogSiteName = soup('meta[property="og:site_name"]').attr("content") || undefined;
+      soup('meta[property="og:locale:alternate"]')
+        .map((i, el) => soup(el).attr("content"))
+        .get() || undefined;
+    ogSiteName =
+      soup('meta[property="og:site_name"]').attr("content") || undefined;
     ogVideo = soup('meta[property="og:video"]').attr("content") || undefined;
-    articleSection = soup('meta[name="article:section"]').attr("content") || undefined;
+    articleSection =
+      soup('meta[name="article:section"]').attr("content") || undefined;
     articleTag = soup('meta[name="article:tag"]').attr("content") || undefined;
-    publishedTime = soup('meta[property="article:published_time"]').attr("content") || undefined;
+    publishedTime =
-    modifiedTime = soup('meta[property="article:modified_time"]').attr("content") || undefined;
+      soup('meta[property="article:published_time"]').attr("content") ||
-    dcTermsKeywords = soup('meta[name="dcterms.keywords"]').attr("content") || undefined;
+      undefined;
-    dcDescription = soup('meta[name="dc.description"]').attr("content") || undefined;
+    modifiedTime =
+      soup('meta[property="article:modified_time"]').attr("content") ||
+      undefined;
+    dcTermsKeywords =
+      soup('meta[name="dcterms.keywords"]').attr("content") || undefined;
+    dcDescription =
+      soup('meta[name="dc.description"]').attr("content") || undefined;
     dcSubject = soup('meta[name="dc.subject"]').attr("content") || undefined;
-    dcTermsSubject = soup('meta[name="dcterms.subject"]').attr("content") || undefined;
+    dcTermsSubject =
-    dcTermsAudience = soup('meta[name="dcterms.audience"]').attr("content") || undefined;
+      soup('meta[name="dcterms.subject"]').attr("content") || undefined;
+    dcTermsAudience =
+      soup('meta[name="dcterms.audience"]').attr("content") || undefined;
     dcType = soup('meta[name="dc.type"]').attr("content") || undefined;
-    dcTermsType = soup('meta[name="dcterms.type"]').attr("content") || undefined;
+    dcTermsType =
+      soup('meta[name="dcterms.type"]').attr("content") || undefined;
     dcDate = soup('meta[name="dc.date"]').attr("content") || undefined;
-    dcDateCreated = soup('meta[name="dc.date.created"]').attr("content") || undefined;
+    dcDateCreated =
-    dcTermsCreated = soup('meta[name="dcterms.created"]').attr("content") || undefined;
+      soup('meta[name="dc.date.created"]').attr("content") || undefined;
+    dcTermsCreated =
+      soup('meta[name="dcterms.created"]').attr("content") || undefined;
 
     try {
       // Extract all meta tags for custom metadata
@@ -127,6 +148,6 @@ export function extractMetadata(meta: Meta, html: string): Document["metadata"]
     publishedTime,
     articleTag,
     articleSection,
-    ...customMetadata,
+    ...customMetadata
   };
 }

apps/api/src/scraper/scrapeURL/lib/fetch.ts

@@ -4,143 +4,210 @@ import { v4 as uuid } from "uuid";
 import * as Sentry from "@sentry/node";
 
 export type RobustFetchParams<Schema extends z.Schema<any>> = {
-    url: string;
+  url: string;
-    logger: Logger,
+  logger: Logger;
-    method: "GET" | "POST" | "DELETE" | "PUT";
+  method: "GET" | "POST" | "DELETE" | "PUT";
-    body?: any;
+  body?: any;
-    headers?: Record<string, string>;
+  headers?: Record<string, string>;
-    schema?: Schema;
+  schema?: Schema;
-    dontParseResponse?: boolean;
+  dontParseResponse?: boolean;
-    ignoreResponse?: boolean;
+  ignoreResponse?: boolean;
-    ignoreFailure?: boolean;
+  ignoreFailure?: boolean;
-    requestId?: string;
+  requestId?: string;
-    tryCount?: number;
+  tryCount?: number;
-    tryCooldown?: number;
+  tryCooldown?: number;
 };
 
-export async function robustFetch<Schema extends z.Schema<any>, Output = z.infer<Schema>>({
+export async function robustFetch<
+  Schema extends z.Schema<any>,
+  Output = z.infer<Schema>
+>({
+  url,
+  logger,
+  method = "GET",
+  body,
+  headers,
+  schema,
+  ignoreResponse = false,
+  ignoreFailure = false,
+  requestId = uuid(),
+  tryCount = 1,
+  tryCooldown
+}: RobustFetchParams<Schema>): Promise<Output> {
+  const params = {
     url,
     logger,
-    method = "GET",
+    method,
     body,
     headers,
     schema,
-    ignoreResponse = false,
+    ignoreResponse,
-    ignoreFailure = false,
+    ignoreFailure,
-    requestId = uuid(),
+    tryCount,
-    tryCount = 1,
+    tryCooldown
-    tryCooldown,
+  };
-}: RobustFetchParams<Schema>): Promise<Output> {
-    const params = { url, logger, method, body, headers, schema, ignoreResponse, ignoreFailure, tryCount, tryCooldown };
 
-    let request: Response;
+  let request: Response;
-    try {
+  try {
-        request = await fetch(url, {
+    request = await fetch(url, {
-            method,
+      method,
-            headers: {
+      headers: {
-                ...(body instanceof FormData
+        ...(body instanceof FormData
-                ? ({})
+          ? {}
-                : body !== undefined ? ({
+          : body !== undefined
-                    "Content-Type": "application/json",
+            ? {
-                }) : {}),
+                "Content-Type": "application/json"
-                ...(headers !== undefined ? headers : {}),
+              }
-            },
+            : {}),
-            ...(body instanceof FormData ? ({
+        ...(headers !== undefined ? headers : {})
-                body,
+      },
-            }) : body !== undefined ? ({
+      ...(body instanceof FormData
-                body: JSON.stringify(body),
+        ? {
-            }) : {}),
+            body
+          }
+        : body !== undefined
+          ? {
+              body: JSON.stringify(body)
+            }
+          : {})
+    });
+  } catch (error) {
+    if (!ignoreFailure) {
+      Sentry.captureException(error);
+      if (tryCount > 1) {
+        logger.debug(
+          "Request failed, trying " + (tryCount - 1) + " more times",
+          { params, error, requestId }
+        );
+        return await robustFetch({
+          ...params,
+          requestId,
+          tryCount: tryCount - 1
         });
-    } catch (error) {
+      } else {
-        if (!ignoreFailure) {
+        logger.debug("Request failed", { params, error, requestId });
-            Sentry.captureException(error);
+        throw new Error("Request failed", {
-            if (tryCount > 1) {
+          cause: {
-                logger.debug("Request failed, trying " + (tryCount - 1) + " more times", { params, error, requestId });
+            params,
-                return await robustFetch({
+            requestId,
-                    ...params,
+            error
-                    requestId,
+          }
-                    tryCount: tryCount - 1,
-                });
-            } else {
-                logger.debug("Request failed", { params, error, requestId });
-                throw new Error("Request failed", {
-                    cause: {
-                        params, requestId, error,
-                    },
-                });
-            }
-           
-        } else {
-            return null as Output;
-        }
-    }
-
-    if (ignoreResponse === true) {
-        return null as Output;
-    }
-
-    const response = {
-        status: request.status,
-        headers: request.headers,
-        body: await request.text(), // NOTE: can this throw an exception?
-    };
-
-    if (request.status >= 300) {
-        if (tryCount > 1) {
-            logger.debug("Request sent failure status, trying " + (tryCount - 1) + " more times", { params, request, response, requestId });
-            if (tryCooldown !== undefined) {
-                await new Promise((resolve) => setTimeout(() => resolve(null), tryCooldown));
-            }
-            return await robustFetch({
-                ...params,
-                requestId,
-                tryCount: tryCount - 1,
-            });
-        } else {
-            logger.debug("Request sent failure status", { params, request, response, requestId });
-            throw new Error("Request sent failure status", {
-                cause: {
-                    params, request, response, requestId,
-                },
-            });
-        }
-    }
-
-    let data: Output;
-    try {
-        data = JSON.parse(response.body);
-    } catch (error) {
-        logger.debug("Request sent malformed JSON", { params, request, response, requestId });
-        throw new Error("Request sent malformed JSON", {
-            cause: {
-                params, request, response, requestId,
-            },
         });
+      }
+    } else {
+      return null as Output;
     }
+  }
 
-    if (schema) {
+  if (ignoreResponse === true) {
-        try {
+    return null as Output;
-            data = schema.parse(data);
+  }
-        } catch (error) {
+
-            if (error instanceof ZodError) {
+  const response = {
-                logger.debug("Response does not match provided schema", { params, request, response, requestId, error, schema });
+    status: request.status,
-                throw new Error("Response does not match provided schema", {
+    headers: request.headers,
-                    cause: {
+    body: await request.text() // NOTE: can this throw an exception?
-                        params, request, response, requestId,
+  };
-                        error, schema,
+
-                    }
+  if (request.status >= 300) {
-                });
+    if (tryCount > 1) {
-            } else {
+      logger.debug(
-                logger.debug("Parsing response with provided schema failed", { params, request, response, requestId, error, schema });
+        "Request sent failure status, trying " + (tryCount - 1) + " more times",
-                throw new Error("Parsing response with provided schema failed", {
+        { params, request, response, requestId }
-                    cause: {
+      );
-                        params, request, response, requestId,
+      if (tryCooldown !== undefined) {
-                        error, schema
+        await new Promise((resolve) =>
-                    }
+          setTimeout(() => resolve(null), tryCooldown)
-                });
+        );
-            }
+      }
+      return await robustFetch({
+        ...params,
+        requestId,
+        tryCount: tryCount - 1
+      });
+    } else {
+      logger.debug("Request sent failure status", {
+        params,
+        request,
+        response,
+        requestId
+      });
+      throw new Error("Request sent failure status", {
+        cause: {
+          params,
+          request,
+          response,
+          requestId
         }
+      });
     }
+  }
 
-    return data;
+  let data: Output;
-}
+  try {
+    data = JSON.parse(response.body);
+  } catch (error) {
+    logger.debug("Request sent malformed JSON", {
+      params,
+      request,
+      response,
+      requestId
+    });
+    throw new Error("Request sent malformed JSON", {
+      cause: {
+        params,
+        request,
+        response,
+        requestId
+      }
+    });
+  }
+
+  if (schema) {
+    try {
+      data = schema.parse(data);
+    } catch (error) {
+      if (error instanceof ZodError) {
+        logger.debug("Response does not match provided schema", {
+          params,
+          request,
+          response,
+          requestId,
+          error,
+          schema
+        });
+        throw new Error("Response does not match provided schema", {
+          cause: {
+            params,
+            request,
+            response,
+            requestId,
+            error,
+            schema
+          }
+        });
+      } else {
+        logger.debug("Parsing response with provided schema failed", {
+          params,
+          request,
+          response,
+          requestId,
+          error,
+          schema
+        });
+        throw new Error("Parsing response with provided schema failed", {
+          cause: {
+            params,
+            request,
+            response,
+            requestId,
+            error,
+            schema
+          }
+        });
+      }
+    }
+  }
+
+  return data;
+}

apps/api/src/scraper/scrapeURL/lib/removeUnwantedElements.ts

@@ -4,55 +4,53 @@ import { AnyNode, Cheerio, load } from "cheerio";
 import { ScrapeOptions } from "../../../controllers/v1/types";
 
 const excludeNonMainTags = [
-    "header",
+  "header",
-    "footer",
+  "footer",
-    "nav",
+  "nav",
-    "aside",
+  "aside",
-    ".header",
+  ".header",
-    ".top",
+  ".top",
-    ".navbar",
+  ".navbar",
-    "#header",
+  "#header",
-    ".footer",
+  ".footer",
-    ".bottom",
+  ".bottom",
-    "#footer",
+  "#footer",
-    ".sidebar",
+  ".sidebar",
-    ".side",
+  ".side",
-    ".aside",
+  ".aside",
-    "#sidebar",
+  "#sidebar",
-    ".modal",
+  ".modal",
-    ".popup",
+  ".popup",
-    "#modal",
+  "#modal",
-    ".overlay",
+  ".overlay",
-    ".ad",
+  ".ad",
-    ".ads",
+  ".ads",
-    ".advert",
+  ".advert",
-    "#ad",
+  "#ad",
-    ".lang-selector",
+  ".lang-selector",
-    ".language",
+  ".language",
-    "#language-selector",
+  "#language-selector",
-    ".social",
+  ".social",
-    ".social-media",
+  ".social-media",
-    ".social-links",
+  ".social-links",
-    "#social",
+  "#social",
-    ".menu",
+  ".menu",
-    ".navigation",
+  ".navigation",
-    "#nav",
+  "#nav",
-    ".breadcrumbs",
+  ".breadcrumbs",
-    "#breadcrumbs",
+  "#breadcrumbs",
-    "#search-form",
+  "#search-form",
-    ".search",
+  ".search",
-    "#search",
+  "#search",
-    ".share",
+  ".share",
-    "#share",
+  "#share",
-    ".widget",
+  ".widget",
-    "#widget",
+  "#widget",
-    ".cookie",
+  ".cookie",
-    "#cookie"
+  "#cookie"
 ];
 
-const forceIncludeMainTags = [
+const forceIncludeMainTags = ["#main"];
-    "#main"
-];
 
 export const removeUnwantedElements = (
   html: string,
@@ -60,58 +58,65 @@ export const removeUnwantedElements = (
 ) => {
   const soup = load(html);
 
-  if (scrapeOptions.includeTags && scrapeOptions.includeTags.filter(x => x.trim().length !== 0).length > 0) {
+  if (
+    scrapeOptions.includeTags &&
+    scrapeOptions.includeTags.filter((x) => x.trim().length !== 0).length > 0
+  ) {
     // Create a new root element to hold the tags to keep
     const newRoot = load("<div></div>")("div");
     scrapeOptions.includeTags.forEach((tag) => {
-        soup(tag).each((_, element) => {
+      soup(tag).each((_, element) => {
-            newRoot.append(soup(element).clone());
+        newRoot.append(soup(element).clone());
-        });
+      });
     });
     return newRoot.html() ?? "";
   }
 
   soup("script, style, noscript, meta, head").remove();
 
-  if (scrapeOptions.excludeTags && scrapeOptions.excludeTags.filter(x => x.trim().length !== 0).length > 0) {
+  if (
-        scrapeOptions.excludeTags.forEach((tag) => {
+    scrapeOptions.excludeTags &&
-            let elementsToRemove: Cheerio<AnyNode>;
+    scrapeOptions.excludeTags.filter((x) => x.trim().length !== 0).length > 0
-            if (tag.startsWith("*") && tag.endsWith("*")) {
+  ) {
-                let classMatch = false;
+    scrapeOptions.excludeTags.forEach((tag) => {
+      let elementsToRemove: Cheerio<AnyNode>;
+      if (tag.startsWith("*") && tag.endsWith("*")) {
+        let classMatch = false;
 
-                const regexPattern = new RegExp(tag.slice(1, -1), "i");
+        const regexPattern = new RegExp(tag.slice(1, -1), "i");
-                elementsToRemove = soup("*").filter((i, element) => {
+        elementsToRemove = soup("*").filter((i, element) => {
-                    if (element.type === "tag") {
+          if (element.type === "tag") {
-                    const attributes = element.attribs;
+            const attributes = element.attribs;
-                    const tagNameMatches = regexPattern.test(element.name);
+            const tagNameMatches = regexPattern.test(element.name);
-                    const attributesMatch = Object.keys(attributes).some((attr) =>
+            const attributesMatch = Object.keys(attributes).some((attr) =>
-                        regexPattern.test(`${attr}="${attributes[attr]}"`)
+              regexPattern.test(`${attr}="${attributes[attr]}"`)
-                    );
+            );
-                    if (tag.startsWith("*.")) {
+            if (tag.startsWith("*.")) {
-                        classMatch = Object.keys(attributes).some((attr) =>
+              classMatch = Object.keys(attributes).some((attr) =>
-                        regexPattern.test(`class="${attributes[attr]}"`)
+                regexPattern.test(`class="${attributes[attr]}"`)
-                        );
+              );
-                    }
-                    return tagNameMatches || attributesMatch || classMatch;
-                    }
-                    return false;
-                });
-            } else {
-                elementsToRemove = soup(tag);
             }
-            elementsToRemove.remove();
+            return tagNameMatches || attributesMatch || classMatch;
+          }
+          return false;
         });
-    }
+      } else {
+        elementsToRemove = soup(tag);
+      }
+      elementsToRemove.remove();
+    });
+  }
 
-    if (scrapeOptions.onlyMainContent) {
+  if (scrapeOptions.onlyMainContent) {
-        excludeNonMainTags.forEach((tag) => {
+    excludeNonMainTags.forEach((tag) => {
-            const elementsToRemove = soup(tag)
+      const elementsToRemove = soup(tag).filter(
-                .filter(forceIncludeMainTags.map(x => ":not(:has(" + x + "))").join(""));
+        forceIncludeMainTags.map((x) => ":not(:has(" + x + "))").join("")
-            
+      );
-            elementsToRemove.remove();
+
-        });
+      elementsToRemove.remove();
-    }
+    });
-    
+  }
-    const cleanedHtml = soup.html();
+
-    return cleanedHtml;
+  const cleanedHtml = soup.html();
+  return cleanedHtml;
 };

apps/api/src/scraper/scrapeURL/lib/urlSpecificParams.ts

@@ -2,8 +2,8 @@ import { InternalOptions } from "..";
 import { ScrapeOptions } from "../../../controllers/v1/types";
 
 export type UrlSpecificParams = {
-    scrapeOptions: Partial<ScrapeOptions>,
+  scrapeOptions: Partial<ScrapeOptions>;
-    internalOptions: Partial<InternalOptions>,
+  internalOptions: Partial<InternalOptions>;
 };
 
 // const docsParam: UrlSpecificParams = {
@@ -12,40 +12,40 @@ export type UrlSpecificParams = {
 // }
 
 export const urlSpecificParams: Record<string, UrlSpecificParams> = {
-    // "support.greenpay.me": docsParam,
+  // "support.greenpay.me": docsParam,
-    // "docs.pdw.co": docsParam,
+  // "docs.pdw.co": docsParam,
-    // "developers.notion.com": docsParam,
+  // "developers.notion.com": docsParam,
-    // "docs2.hubitat.com": docsParam,
+  // "docs2.hubitat.com": docsParam,
-    // "rsseau.fr": docsParam,
+  // "rsseau.fr": docsParam,
-    // "help.salesforce.com": docsParam,
+  // "help.salesforce.com": docsParam,
-    // "scrapethissite.com": {
+  // "scrapethissite.com": {
-    //     scrapeOptions: {},
+  //     scrapeOptions: {},
-    //     internalOptions: { forceEngine: "fetch" },
+  //     internalOptions: { forceEngine: "fetch" },
-    // },
+  // },
-    // "eonhealth.com": {
+  // "eonhealth.com": {
-    //     defaultScraper: "fire-engine",
+  //     defaultScraper: "fire-engine",
-    //     params: {
+  //     params: {
-    //         fireEngineOptions: {
+  //         fireEngineOptions: {
-    //             mobileProxy: true,
+  //             mobileProxy: true,
-    //             method: "get",
+  //             method: "get",
-    //             engine: "request",
+  //             engine: "request",
-    //         },
+  //         },
-    //     },
+  //     },
-    // },
+  // },
-    // "notion.com": {
+  // "notion.com": {
-    //     scrapeOptions: { waitFor: 2000 },
+  //     scrapeOptions: { waitFor: 2000 },
-    //     internalOptions: { forceEngine: "fire-engine;playwright" }
+  //     internalOptions: { forceEngine: "fire-engine;playwright" }
-    // },
+  // },
-    // "developer.apple.com": {
+  // "developer.apple.com": {
-    //     scrapeOptions: { waitFor: 2000 },
+  //     scrapeOptions: { waitFor: 2000 },
-    //     internalOptions: { forceEngine: "fire-engine;playwright" }
+  //     internalOptions: { forceEngine: "fire-engine;playwright" }
-    // },
+  // },
-    "digikey.com": {
+  "digikey.com": {
-        scrapeOptions: {},
+    scrapeOptions: {},
-        internalOptions: { forceEngine: "fire-engine;tlsclient" }
+    internalOptions: { forceEngine: "fire-engine;tlsclient" }
-    },
+  },
-    "lorealparis.hu": {
+  "lorealparis.hu": {
-        scrapeOptions: {},
+    scrapeOptions: {},
-        internalOptions: { forceEngine: "fire-engine;tlsclient" },
+    internalOptions: { forceEngine: "fire-engine;tlsclient" }
-    }
+  }
 };

apps/api/src/scraper/scrapeURL/scrapeURL.test.ts

@@ -7,384 +7,485 @@ import { scrapeOptions } from "../../controllers/v1/types";
 import { Engine } from "./engines";
 
 const testEngines: (Engine | undefined)[] = [
-    undefined,
+  undefined,
-    "fire-engine;chrome-cdp",
+  "fire-engine;chrome-cdp",
-    "fire-engine;playwright",
+  "fire-engine;playwright",
-    "fire-engine;tlsclient",
+  "fire-engine;tlsclient",
-    "scrapingbee",
+  "scrapingbee",
-    "scrapingbeeLoad",
+  "scrapingbeeLoad",
-    "fetch",
+  "fetch"
 ];
 
 const testEnginesScreenshot: (Engine | undefined)[] = [
-    undefined,
+  undefined,
-    "fire-engine;chrome-cdp",
+  "fire-engine;chrome-cdp",
-    "fire-engine;playwright",
+  "fire-engine;playwright",
-    "scrapingbee",
+  "scrapingbee",
-    "scrapingbeeLoad",
+  "scrapingbeeLoad"
 ];
 
 describe("Standalone scrapeURL tests", () => {
-    describe.each(testEngines)("Engine %s", (forceEngine: Engine | undefined) => {
+  describe.each(testEngines)("Engine %s", (forceEngine: Engine | undefined) => {
-        it("Basic scrape", async () => {
+    it("Basic scrape", async () => {
-            const out = await scrapeURL("test:scrape-basic", "https://www.roastmywebsite.ai/", scrapeOptions.parse({}), { forceEngine });
+      const out = await scrapeURL(
-        
+        "test:scrape-basic",
-            // expect(out.logs.length).toBeGreaterThan(0);
+        "https://www.roastmywebsite.ai/",
-            expect(out.success).toBe(true);
+        scrapeOptions.parse({}),
-            if (out.success) {
+        { forceEngine }
-                expect(out.document.warning).toBeUndefined();
+      );
-                expect(out.document).not.toHaveProperty("content");
-                expect(out.document).toHaveProperty("markdown");
-                expect(out.document).toHaveProperty("metadata");
-                expect(out.document).not.toHaveProperty("html");
-                expect(out.document.markdown).toContain("_Roast_");
-                expect(out.document.metadata.error).toBeUndefined();
-                expect(out.document.metadata.title).toBe("Roast My Website");
-                expect(out.document.metadata.description).toBe(
-                    "Welcome to Roast My Website, the ultimate tool for putting your website through the wringer! This repository harnesses the power of Firecrawl to scrape and capture screenshots of websites, and then unleashes the latest LLM vision models to mercilessly roast them. 🌶️"
-                );
-                expect(out.document.metadata.keywords).toBe(
-                    "Roast My Website,Roast,Website,GitHub,Firecrawl"
-                );
-                expect(out.document.metadata.robots).toBe("follow, index");
-                expect(out.document.metadata.ogTitle).toBe("Roast My Website");
-                expect(out.document.metadata.ogDescription).toBe(
-                    "Welcome to Roast My Website, the ultimate tool for putting your website through the wringer! This repository harnesses the power of Firecrawl to scrape and capture screenshots of websites, and then unleashes the latest LLM vision models to mercilessly roast them. 🌶️"
-                );
-                expect(out.document.metadata.ogUrl).toBe(
-                    "https://www.roastmywebsite.ai"
-                );
-                expect(out.document.metadata.ogImage).toBe(
-                    "https://www.roastmywebsite.ai/og.png"
-                );
-                expect(out.document.metadata.ogLocaleAlternate).toStrictEqual([]);
-                expect(out.document.metadata.ogSiteName).toBe("Roast My Website");
-                expect(out.document.metadata.sourceURL).toBe(
-                    "https://www.roastmywebsite.ai/"
-                );
-                expect(out.document.metadata.statusCode).toBe(200);
-            }
-        
-        }, 30000);
-    
-        it("Scrape with formats markdown and html", async () => {
-            const out = await scrapeURL("test:scrape-formats-markdown-html", "https://roastmywebsite.ai", scrapeOptions.parse({
-                formats: ["markdown", "html"],
-            }), { forceEngine });
-        
-            // expect(out.logs.length).toBeGreaterThan(0);
-            expect(out.success).toBe(true);
-            if (out.success) {
-                expect(out.document.warning).toBeUndefined();
-                expect(out.document).toHaveProperty("markdown");
-                expect(out.document).toHaveProperty("html");
-                expect(out.document).toHaveProperty("metadata");
-                expect(out.document.markdown).toContain("_Roast_");
-                expect(out.document.html).toContain("<h1");
-                expect(out.document.metadata.statusCode).toBe(200);
-                expect(out.document.metadata.error).toBeUndefined();
-            }
-        
-        }, 30000);
-    
-        it("Scrape with onlyMainContent disabled", async () => {
-            const out = await scrapeURL("test:scrape-onlyMainContent-false", "https://www.scrapethissite.com/", scrapeOptions.parse({
-                onlyMainContent: false,
-            }), { forceEngine });
-    
-            // expect(out.logs.length).toBeGreaterThan(0);
-            expect(out.success).toBe(true);
-            if (out.success) {
-                expect(out.document.warning).toBeUndefined();
-                expect(out.document).toHaveProperty("markdown");
-                expect(out.document).toHaveProperty("metadata");
-                expect(out.document).not.toHaveProperty("html");
-                expect(out.document.markdown).toContain("[FAQ](/faq/)"); // .nav
-                expect(out.document.markdown).toContain("Hartley Brody 2023"); // #footer
-            }
-        }, 30000);
-    
-        it("Scrape with excludeTags", async () => {
-            const out = await scrapeURL("test:scrape-excludeTags", "https://www.scrapethissite.com/", scrapeOptions.parse({
-                onlyMainContent: false,
-                excludeTags: ['.nav', '#footer', 'strong'],
-            }), { forceEngine });
-    
-            // expect(out.logs.length).toBeGreaterThan(0);
-            expect(out.success).toBe(true);
-            if (out.success) {
-                expect(out.document.warning).toBeUndefined();
-                expect(out.document).toHaveProperty("markdown");
-                expect(out.document).toHaveProperty("metadata");
-                expect(out.document).not.toHaveProperty("html");
-                expect(out.document.markdown).not.toContain("Hartley Brody 2023");
-                expect(out.document.markdown).not.toContain("[FAQ](/faq/)");
-            }
-        }, 30000);
-    
-        it("Scrape of a page with 400 status code", async () => {
-            const out = await scrapeURL("test:scrape-400", "https://httpstat.us/400", scrapeOptions.parse({}), { forceEngine });
-    
-            // expect(out.logs.length).toBeGreaterThan(0);
-            expect(out.success).toBe(true);
-            if (out.success) {
-                expect(out.document.warning).toBeUndefined();
-                expect(out.document).toHaveProperty('markdown');
-                expect(out.document).toHaveProperty('metadata');
-                expect(out.document.metadata.statusCode).toBe(400);
-            }
-        }, 30000);
-    
-        it("Scrape of a page with 401 status code", async () => {
-            const out = await scrapeURL("test:scrape-401", "https://httpstat.us/401", scrapeOptions.parse({}), { forceEngine });
-    
-            // expect(out.logs.length).toBeGreaterThan(0);
-            expect(out.success).toBe(true);
-            if (out.success) {
-                expect(out.document.warning).toBeUndefined();
-                expect(out.document).toHaveProperty('markdown');
-                expect(out.document).toHaveProperty('metadata');
-                expect(out.document.metadata.statusCode).toBe(401);
-            }
-        }, 30000);
-    
-        it("Scrape of a page with 403 status code", async () => {
-            const out = await scrapeURL("test:scrape-403", "https://httpstat.us/403", scrapeOptions.parse({}), { forceEngine });
-    
-            // expect(out.logs.length).toBeGreaterThan(0);
-            expect(out.success).toBe(true);
-            if (out.success) {
-                expect(out.document.warning).toBeUndefined();
-                expect(out.document).toHaveProperty('markdown');
-                expect(out.document).toHaveProperty('metadata');
-                expect(out.document.metadata.statusCode).toBe(403);
-            }
-        }, 30000);
-    
-        it("Scrape of a page with 404 status code", async () => {
-            const out = await scrapeURL("test:scrape-404", "https://httpstat.us/404", scrapeOptions.parse({}), { forceEngine });
-    
-            // expect(out.logs.length).toBeGreaterThan(0);
-            expect(out.success).toBe(true);
-            if (out.success) {
-                expect(out.document.warning).toBeUndefined();
-                expect(out.document).toHaveProperty('markdown');
-                expect(out.document).toHaveProperty('metadata');
-                expect(out.document.metadata.statusCode).toBe(404);
-            }
-        }, 30000);
-    
-        it("Scrape of a page with 405 status code", async () => {
-            const out = await scrapeURL("test:scrape-405", "https://httpstat.us/405", scrapeOptions.parse({}), { forceEngine });
-    
-            // expect(out.logs.length).toBeGreaterThan(0);
-            expect(out.success).toBe(true);
-            if (out.success) {
-                expect(out.document.warning).toBeUndefined();
-                expect(out.document).toHaveProperty('markdown');
-                expect(out.document).toHaveProperty('metadata');
-                expect(out.document.metadata.statusCode).toBe(405);
-            }
-        }, 30000);
-    
-        it("Scrape of a page with 500 status code", async () => {
-            const out = await scrapeURL("test:scrape-500", "https://httpstat.us/500", scrapeOptions.parse({}), { forceEngine });
-    
-            // expect(out.logs.length).toBeGreaterThan(0);
-            expect(out.success).toBe(true);
-            if (out.success) {
-                expect(out.document.warning).toBeUndefined();
-                expect(out.document).toHaveProperty('markdown');
-                expect(out.document).toHaveProperty('metadata');
-                expect(out.document.metadata.statusCode).toBe(500);
-            }
-        }, 30000);
 
-        it("Scrape a redirected page", async () => {
+      // expect(out.logs.length).toBeGreaterThan(0);
-            const out = await scrapeURL("test:scrape-redirect", "https://scrapethissite.com/", scrapeOptions.parse({}), { forceEngine });
+      expect(out.success).toBe(true);
-    
+      if (out.success) {
-            // expect(out.logs.length).toBeGreaterThan(0);
+        expect(out.document.warning).toBeUndefined();
-            expect(out.success).toBe(true);
+        expect(out.document).not.toHaveProperty("content");
-            if (out.success) {
+        expect(out.document).toHaveProperty("markdown");
-                expect(out.document.warning).toBeUndefined();
+        expect(out.document).toHaveProperty("metadata");
-                expect(out.document).toHaveProperty('markdown');
+        expect(out.document).not.toHaveProperty("html");
-                expect(out.document.markdown).toContain("Explore Sandbox");
+        expect(out.document.markdown).toContain("_Roast_");
-                expect(out.document).toHaveProperty('metadata');
+        expect(out.document.metadata.error).toBeUndefined();
-                expect(out.document.metadata.sourceURL).toBe("https://scrapethissite.com/");
+        expect(out.document.metadata.title).toBe("Roast My Website");
-                expect(out.document.metadata.url).toBe("https://www.scrapethissite.com/");
+        expect(out.document.metadata.description).toBe(
-                expect(out.document.metadata.statusCode).toBe(200);
+          "Welcome to Roast My Website, the ultimate tool for putting your website through the wringer! This repository harnesses the power of Firecrawl to scrape and capture screenshots of websites, and then unleashes the latest LLM vision models to mercilessly roast them. 🌶️"
-                expect(out.document.metadata.error).toBeUndefined();
+        );
-            }
+        expect(out.document.metadata.keywords).toBe(
-        }, 30000);
+          "Roast My Website,Roast,Website,GitHub,Firecrawl"
-    });
+        );
-
+        expect(out.document.metadata.robots).toBe("follow, index");
-    describe.each(testEnginesScreenshot)("Screenshot on engine %s", (forceEngine: Engine | undefined) => {
+        expect(out.document.metadata.ogTitle).toBe("Roast My Website");
-        it("Scrape with screenshot", async () => {
+        expect(out.document.metadata.ogDescription).toBe(
-            const out = await scrapeURL("test:scrape-screenshot", "https://www.scrapethissite.com/", scrapeOptions.parse({
+          "Welcome to Roast My Website, the ultimate tool for putting your website through the wringer! This repository harnesses the power of Firecrawl to scrape and capture screenshots of websites, and then unleashes the latest LLM vision models to mercilessly roast them. 🌶️"
-                formats: ["screenshot"],
+        );
-            }), { forceEngine });
+        expect(out.document.metadata.ogUrl).toBe(
-    
+          "https://www.roastmywebsite.ai"
-            // expect(out.logs.length).toBeGreaterThan(0);
+        );
-            expect(out.success).toBe(true);
+        expect(out.document.metadata.ogImage).toBe(
-            if (out.success) {
+          "https://www.roastmywebsite.ai/og.png"
-                expect(out.document.warning).toBeUndefined();
+        );
-                expect(out.document).toHaveProperty('screenshot');
+        expect(out.document.metadata.ogLocaleAlternate).toStrictEqual([]);
-                expect(typeof out.document.screenshot).toBe("string");
+        expect(out.document.metadata.ogSiteName).toBe("Roast My Website");
-                expect(out.document.screenshot!.startsWith("https://service.firecrawl.dev/storage/v1/object/public/media/"));
+        expect(out.document.metadata.sourceURL).toBe(
-                // TODO: attempt to fetch screenshot
+          "https://www.roastmywebsite.ai/"
-                expect(out.document).toHaveProperty('metadata');
+        );
-                expect(out.document.metadata.statusCode).toBe(200);
+        expect(out.document.metadata.statusCode).toBe(200);
-                expect(out.document.metadata.error).toBeUndefined();
+      }
-            }
-        }, 30000);
-    
-        it("Scrape with full-page screenshot", async () => {
-            const out = await scrapeURL("test:scrape-screenshot-fullPage", "https://www.scrapethissite.com/", scrapeOptions.parse({
-                formats: ["screenshot@fullPage"],
-            }), { forceEngine });
-    
-            // expect(out.logs.length).toBeGreaterThan(0);
-            expect(out.success).toBe(true);
-            if (out.success) {
-                expect(out.document.warning).toBeUndefined();
-                expect(out.document).toHaveProperty('screenshot');
-                expect(typeof out.document.screenshot).toBe("string");
-                expect(out.document.screenshot!.startsWith("https://service.firecrawl.dev/storage/v1/object/public/media/"));
-                // TODO: attempt to fetch screenshot
-                expect(out.document).toHaveProperty('metadata');
-                expect(out.document.metadata.statusCode).toBe(200);
-                expect(out.document.metadata.error).toBeUndefined();
-            }
-        }, 30000);
-    });
-
-    it("Scrape of a PDF file", async () => {
-        const out = await scrapeURL("test:scrape-pdf", "https://arxiv.org/pdf/astro-ph/9301001.pdf", scrapeOptions.parse({}));
-
-        // expect(out.logs.length).toBeGreaterThan(0);
-        expect(out.success).toBe(true);
-        if (out.success) {
-            expect(out.document.warning).toBeUndefined();
-            expect(out.document).toHaveProperty('metadata');
-            expect(out.document.markdown).toContain('Broad Line Radio Galaxy');
-            expect(out.document.metadata.statusCode).toBe(200);
-            expect(out.document.metadata.error).toBeUndefined();
-        }
-    }, 60000);
-
-    it("Scrape a DOCX file", async () => {
-        const out = await scrapeURL("test:scrape-docx", "https://nvca.org/wp-content/uploads/2019/06/NVCA-Model-Document-Stock-Purchase-Agreement.docx", scrapeOptions.parse({}));
-
-        // expect(out.logs.length).toBeGreaterThan(0);
-        expect(out.success).toBe(true);
-        if (out.success) {
-            expect(out.document.warning).toBeUndefined();
-            expect(out.document).toHaveProperty('metadata');
-            expect(out.document.markdown).toContain('SERIES A PREFERRED STOCK PURCHASE AGREEMENT');
-            expect(out.document.metadata.statusCode).toBe(200);
-            expect(out.document.metadata.error).toBeUndefined();
-        }
-    }, 60000)
-
-    it("LLM extract with prompt and schema", async () => {
-        const out = await scrapeURL("test:llm-extract-prompt-schema", "https://firecrawl.dev", scrapeOptions.parse({
-            formats: ["extract"],
-            extract: {
-                prompt: "Based on the information on the page, find what the company's mission is and whether it supports SSO, and whether it is open source",
-                schema: {
-                    type: "object",
-                    properties: {
-                        company_mission: { type: "string" },
-                        supports_sso: { type: "boolean" },
-                        is_open_source: { type: "boolean" },
-                    },
-                    required: ["company_mission", "supports_sso", "is_open_source"],
-                    additionalProperties: false,
-                },
-            },
-        }));
-
-        // expect(out.logs.length).toBeGreaterThan(0);
-        expect(out.success).toBe(true);
-        if (out.success) {
-            expect(out.document.warning).toBeUndefined();
-            expect(out.document).toHaveProperty("extract");
-            expect(out.document.extract).toHaveProperty("company_mission");
-            expect(out.document.extract).toHaveProperty("supports_sso");
-            expect(out.document.extract).toHaveProperty("is_open_source");
-            expect(typeof out.document.extract.company_mission).toBe("string");
-            expect(out.document.extract.supports_sso).toBe(false);
-            expect(out.document.extract.is_open_source).toBe(true);
-        }
-    }, 120000)
-
-    it("LLM extract with schema only", async () => {
-        const out = await scrapeURL("test:llm-extract-schema", "https://firecrawl.dev", scrapeOptions.parse({
-            formats: ["extract"],
-            extract: {
-                schema: {
-                    type: "object",
-                    properties: {
-                        company_mission: { type: "string" },
-                        supports_sso: { type: "boolean" },
-                        is_open_source: { type: "boolean" },
-                    },
-                    required: ["company_mission", "supports_sso", "is_open_source"],
-                    additionalProperties: false,
-                },
-            },
-        }));
-
-        // expect(out.logs.length).toBeGreaterThan(0);
-        expect(out.success).toBe(true);
-        if (out.success) {
-            expect(out.document.warning).toBeUndefined();
-            expect(out.document).toHaveProperty("extract");
-            expect(out.document.extract).toHaveProperty("company_mission");
-            expect(out.document.extract).toHaveProperty("supports_sso");
-            expect(out.document.extract).toHaveProperty("is_open_source");
-            expect(typeof out.document.extract.company_mission).toBe("string");
-            expect(out.document.extract.supports_sso).toBe(false);
-            expect(out.document.extract.is_open_source).toBe(true);
-        }
-    }, 120000)
-
-    test.concurrent.each(new Array(100).fill(0).map((_, i) => i))("Concurrent scrape #%i", async (i) => {
-        const url = "https://www.scrapethissite.com/?i=" + i;
-        const id = "test:concurrent:" + url;
-        const out = await scrapeURL(id, url, scrapeOptions.parse({}));
-
-        const replacer = (key: string, value: any) => {
-            if (value instanceof Error) {
-                return {
-                    ...value,
-                    message: value.message,
-                    name: value.name,
-                    cause: value.cause,
-                    stack: value.stack,
-                }
-            } else {
-                return value;
-            }
-        }
-
-        // verify that log collection works properly while concurrency is happening
-        // expect(out.logs.length).toBeGreaterThan(0);
-        const weirdLogs = out.logs.filter(x => x.scrapeId !== id);
-        if (weirdLogs.length > 0) {
-            console.warn(JSON.stringify(weirdLogs, replacer));
-        }
-        expect(weirdLogs.length).toBe(0); 
-
-        if (!out.success) console.error(JSON.stringify(out, replacer));
-        expect(out.success).toBe(true);
-        
-        if (out.success) {
-            expect(out.document.warning).toBeUndefined();
-            expect(out.document).toHaveProperty('markdown');
-            expect(out.document).toHaveProperty('metadata');
-            expect(out.document.metadata.error).toBeUndefined();
-            expect(out.document.metadata.statusCode).toBe(200);
-        }
     }, 30000);
-})
+
+    it("Scrape with formats markdown and html", async () => {
+      const out = await scrapeURL(
+        "test:scrape-formats-markdown-html",
+        "https://roastmywebsite.ai",
+        scrapeOptions.parse({
+          formats: ["markdown", "html"]
+        }),
+        { forceEngine }
+      );
+
+      // expect(out.logs.length).toBeGreaterThan(0);
+      expect(out.success).toBe(true);
+      if (out.success) {
+        expect(out.document.warning).toBeUndefined();
+        expect(out.document).toHaveProperty("markdown");
+        expect(out.document).toHaveProperty("html");
+        expect(out.document).toHaveProperty("metadata");
+        expect(out.document.markdown).toContain("_Roast_");
+        expect(out.document.html).toContain("<h1");
+        expect(out.document.metadata.statusCode).toBe(200);
+        expect(out.document.metadata.error).toBeUndefined();
+      }
+    }, 30000);
+
+    it("Scrape with onlyMainContent disabled", async () => {
+      const out = await scrapeURL(
+        "test:scrape-onlyMainContent-false",
+        "https://www.scrapethissite.com/",
+        scrapeOptions.parse({
+          onlyMainContent: false
+        }),
+        { forceEngine }
+      );
+
+      // expect(out.logs.length).toBeGreaterThan(0);
+      expect(out.success).toBe(true);
+      if (out.success) {
+        expect(out.document.warning).toBeUndefined();
+        expect(out.document).toHaveProperty("markdown");
+        expect(out.document).toHaveProperty("metadata");
+        expect(out.document).not.toHaveProperty("html");
+        expect(out.document.markdown).toContain("[FAQ](/faq/)"); // .nav
+        expect(out.document.markdown).toContain("Hartley Brody 2023"); // #footer
+      }
+    }, 30000);
+
+    it("Scrape with excludeTags", async () => {
+      const out = await scrapeURL(
+        "test:scrape-excludeTags",
+        "https://www.scrapethissite.com/",
+        scrapeOptions.parse({
+          onlyMainContent: false,
+          excludeTags: [".nav", "#footer", "strong"]
+        }),
+        { forceEngine }
+      );
+
+      // expect(out.logs.length).toBeGreaterThan(0);
+      expect(out.success).toBe(true);
+      if (out.success) {
+        expect(out.document.warning).toBeUndefined();
+        expect(out.document).toHaveProperty("markdown");
+        expect(out.document).toHaveProperty("metadata");
+        expect(out.document).not.toHaveProperty("html");
+        expect(out.document.markdown).not.toContain("Hartley Brody 2023");
+        expect(out.document.markdown).not.toContain("[FAQ](/faq/)");
+      }
+    }, 30000);
+
+    it("Scrape of a page with 400 status code", async () => {
+      const out = await scrapeURL(
+        "test:scrape-400",
+        "https://httpstat.us/400",
+        scrapeOptions.parse({}),
+        { forceEngine }
+      );
+
+      // expect(out.logs.length).toBeGreaterThan(0);
+      expect(out.success).toBe(true);
+      if (out.success) {
+        expect(out.document.warning).toBeUndefined();
+        expect(out.document).toHaveProperty("markdown");
+        expect(out.document).toHaveProperty("metadata");
+        expect(out.document.metadata.statusCode).toBe(400);
+      }
+    }, 30000);
+
+    it("Scrape of a page with 401 status code", async () => {
+      const out = await scrapeURL(
+        "test:scrape-401",
+        "https://httpstat.us/401",
+        scrapeOptions.parse({}),
+        { forceEngine }
+      );
+
+      // expect(out.logs.length).toBeGreaterThan(0);
+      expect(out.success).toBe(true);
+      if (out.success) {
+        expect(out.document.warning).toBeUndefined();
+        expect(out.document).toHaveProperty("markdown");
+        expect(out.document).toHaveProperty("metadata");
+        expect(out.document.metadata.statusCode).toBe(401);
+      }
+    }, 30000);
+
+    it("Scrape of a page with 403 status code", async () => {
+      const out = await scrapeURL(
+        "test:scrape-403",
+        "https://httpstat.us/403",
+        scrapeOptions.parse({}),
+        { forceEngine }
+      );
+
+      // expect(out.logs.length).toBeGreaterThan(0);
+      expect(out.success).toBe(true);
+      if (out.success) {
+        expect(out.document.warning).toBeUndefined();
+        expect(out.document).toHaveProperty("markdown");
+        expect(out.document).toHaveProperty("metadata");
+        expect(out.document.metadata.statusCode).toBe(403);
+      }
+    }, 30000);
+
+    it("Scrape of a page with 404 status code", async () => {
+      const out = await scrapeURL(
+        "test:scrape-404",
+        "https://httpstat.us/404",
+        scrapeOptions.parse({}),
+        { forceEngine }
+      );
+
+      // expect(out.logs.length).toBeGreaterThan(0);
+      expect(out.success).toBe(true);
+      if (out.success) {
+        expect(out.document.warning).toBeUndefined();
+        expect(out.document).toHaveProperty("markdown");
+        expect(out.document).toHaveProperty("metadata");
+        expect(out.document.metadata.statusCode).toBe(404);
+      }
+    }, 30000);
+
+    it("Scrape of a page with 405 status code", async () => {
+      const out = await scrapeURL(
+        "test:scrape-405",
+        "https://httpstat.us/405",
+        scrapeOptions.parse({}),
+        { forceEngine }
+      );
+
+      // expect(out.logs.length).toBeGreaterThan(0);
+      expect(out.success).toBe(true);
+      if (out.success) {
+        expect(out.document.warning).toBeUndefined();
+        expect(out.document).toHaveProperty("markdown");
+        expect(out.document).toHaveProperty("metadata");
+        expect(out.document.metadata.statusCode).toBe(405);
+      }
+    }, 30000);
+
+    it("Scrape of a page with 500 status code", async () => {
+      const out = await scrapeURL(
+        "test:scrape-500",
+        "https://httpstat.us/500",
+        scrapeOptions.parse({}),
+        { forceEngine }
+      );
+
+      // expect(out.logs.length).toBeGreaterThan(0);
+      expect(out.success).toBe(true);
+      if (out.success) {
+        expect(out.document.warning).toBeUndefined();
+        expect(out.document).toHaveProperty("markdown");
+        expect(out.document).toHaveProperty("metadata");
+        expect(out.document.metadata.statusCode).toBe(500);
+      }
+    }, 30000);
+
+    it("Scrape a redirected page", async () => {
+      const out = await scrapeURL(
+        "test:scrape-redirect",
+        "https://scrapethissite.com/",
+        scrapeOptions.parse({}),
+        { forceEngine }
+      );
+
+      // expect(out.logs.length).toBeGreaterThan(0);
+      expect(out.success).toBe(true);
+      if (out.success) {
+        expect(out.document.warning).toBeUndefined();
+        expect(out.document).toHaveProperty("markdown");
+        expect(out.document.markdown).toContain("Explore Sandbox");
+        expect(out.document).toHaveProperty("metadata");
+        expect(out.document.metadata.sourceURL).toBe(
+          "https://scrapethissite.com/"
+        );
+        expect(out.document.metadata.url).toBe(
+          "https://www.scrapethissite.com/"
+        );
+        expect(out.document.metadata.statusCode).toBe(200);
+        expect(out.document.metadata.error).toBeUndefined();
+      }
+    }, 30000);
+  });
+
+  describe.each(testEnginesScreenshot)(
+    "Screenshot on engine %s",
+    (forceEngine: Engine | undefined) => {
+      it("Scrape with screenshot", async () => {
+        const out = await scrapeURL(
+          "test:scrape-screenshot",
+          "https://www.scrapethissite.com/",
+          scrapeOptions.parse({
+            formats: ["screenshot"]
+          }),
+          { forceEngine }
+        );
+
+        // expect(out.logs.length).toBeGreaterThan(0);
+        expect(out.success).toBe(true);
+        if (out.success) {
+          expect(out.document.warning).toBeUndefined();
+          expect(out.document).toHaveProperty("screenshot");
+          expect(typeof out.document.screenshot).toBe("string");
+          expect(
+            out.document.screenshot!.startsWith(
+              "https://service.firecrawl.dev/storage/v1/object/public/media/"
+            )
+          );
+          // TODO: attempt to fetch screenshot
+          expect(out.document).toHaveProperty("metadata");
+          expect(out.document.metadata.statusCode).toBe(200);
+          expect(out.document.metadata.error).toBeUndefined();
+        }
+      }, 30000);
+
+      it("Scrape with full-page screenshot", async () => {
+        const out = await scrapeURL(
+          "test:scrape-screenshot-fullPage",
+          "https://www.scrapethissite.com/",
+          scrapeOptions.parse({
+            formats: ["screenshot@fullPage"]
+          }),
+          { forceEngine }
+        );
+
+        // expect(out.logs.length).toBeGreaterThan(0);
+        expect(out.success).toBe(true);
+        if (out.success) {
+          expect(out.document.warning).toBeUndefined();
+          expect(out.document).toHaveProperty("screenshot");
+          expect(typeof out.document.screenshot).toBe("string");
+          expect(
+            out.document.screenshot!.startsWith(
+              "https://service.firecrawl.dev/storage/v1/object/public/media/"
+            )
+          );
+          // TODO: attempt to fetch screenshot
+          expect(out.document).toHaveProperty("metadata");
+          expect(out.document.metadata.statusCode).toBe(200);
+          expect(out.document.metadata.error).toBeUndefined();
+        }
+      }, 30000);
+    }
+  );
+
+  it("Scrape of a PDF file", async () => {
+    const out = await scrapeURL(
+      "test:scrape-pdf",
+      "https://arxiv.org/pdf/astro-ph/9301001.pdf",
+      scrapeOptions.parse({})
+    );
+
+    // expect(out.logs.length).toBeGreaterThan(0);
+    expect(out.success).toBe(true);
+    if (out.success) {
+      expect(out.document.warning).toBeUndefined();
+      expect(out.document).toHaveProperty("metadata");
+      expect(out.document.markdown).toContain("Broad Line Radio Galaxy");
+      expect(out.document.metadata.statusCode).toBe(200);
+      expect(out.document.metadata.error).toBeUndefined();
+    }
+  }, 60000);
+
+  it("Scrape a DOCX file", async () => {
+    const out = await scrapeURL(
+      "test:scrape-docx",
+      "https://nvca.org/wp-content/uploads/2019/06/NVCA-Model-Document-Stock-Purchase-Agreement.docx",
+      scrapeOptions.parse({})
+    );
+
+    // expect(out.logs.length).toBeGreaterThan(0);
+    expect(out.success).toBe(true);
+    if (out.success) {
+      expect(out.document.warning).toBeUndefined();
+      expect(out.document).toHaveProperty("metadata");
+      expect(out.document.markdown).toContain(
+        "SERIES A PREFERRED STOCK PURCHASE AGREEMENT"
+      );
+      expect(out.document.metadata.statusCode).toBe(200);
+      expect(out.document.metadata.error).toBeUndefined();
+    }
+  }, 60000);
+
+  it("LLM extract with prompt and schema", async () => {
+    const out = await scrapeURL(
+      "test:llm-extract-prompt-schema",
+      "https://firecrawl.dev",
+      scrapeOptions.parse({
+        formats: ["extract"],
+        extract: {
+          prompt:
+            "Based on the information on the page, find what the company's mission is and whether it supports SSO, and whether it is open source",
+          schema: {
+            type: "object",
+            properties: {
+              company_mission: { type: "string" },
+              supports_sso: { type: "boolean" },
+              is_open_source: { type: "boolean" }
+            },
+            required: ["company_mission", "supports_sso", "is_open_source"],
+            additionalProperties: false
+          }
+        }
+      })
+    );
+
+    // expect(out.logs.length).toBeGreaterThan(0);
+    expect(out.success).toBe(true);
+    if (out.success) {
+      expect(out.document.warning).toBeUndefined();
+      expect(out.document).toHaveProperty("extract");
+      expect(out.document.extract).toHaveProperty("company_mission");
+      expect(out.document.extract).toHaveProperty("supports_sso");
+      expect(out.document.extract).toHaveProperty("is_open_source");
+      expect(typeof out.document.extract.company_mission).toBe("string");
+      expect(out.document.extract.supports_sso).toBe(false);
+      expect(out.document.extract.is_open_source).toBe(true);
+    }
+  }, 120000);
+
+  it("LLM extract with schema only", async () => {
+    const out = await scrapeURL(
+      "test:llm-extract-schema",
+      "https://firecrawl.dev",
+      scrapeOptions.parse({
+        formats: ["extract"],
+        extract: {
+          schema: {
+            type: "object",
+            properties: {
+              company_mission: { type: "string" },
+              supports_sso: { type: "boolean" },
+              is_open_source: { type: "boolean" }
+            },
+            required: ["company_mission", "supports_sso", "is_open_source"],
+            additionalProperties: false
+          }
+        }
+      })
+    );
+
+    // expect(out.logs.length).toBeGreaterThan(0);
+    expect(out.success).toBe(true);
+    if (out.success) {
+      expect(out.document.warning).toBeUndefined();
+      expect(out.document).toHaveProperty("extract");
+      expect(out.document.extract).toHaveProperty("company_mission");
+      expect(out.document.extract).toHaveProperty("supports_sso");
+      expect(out.document.extract).toHaveProperty("is_open_source");
+      expect(typeof out.document.extract.company_mission).toBe("string");
+      expect(out.document.extract.supports_sso).toBe(false);
+      expect(out.document.extract.is_open_source).toBe(true);
+    }
+  }, 120000);
+
+  test.concurrent.each(new Array(100).fill(0).map((_, i) => i))(
+    "Concurrent scrape #%i",
+    async (i) => {
+      const url = "https://www.scrapethissite.com/?i=" + i;
+      const id = "test:concurrent:" + url;
+      const out = await scrapeURL(id, url, scrapeOptions.parse({}));
+
+      const replacer = (key: string, value: any) => {
+        if (value instanceof Error) {
+          return {
+            ...value,
+            message: value.message,
+            name: value.name,
+            cause: value.cause,
+            stack: value.stack
+          };
+        } else {
+          return value;
+        }
+      };
+
+      // verify that log collection works properly while concurrency is happening
+      // expect(out.logs.length).toBeGreaterThan(0);
+      const weirdLogs = out.logs.filter((x) => x.scrapeId !== id);
+      if (weirdLogs.length > 0) {
+        console.warn(JSON.stringify(weirdLogs, replacer));
+      }
+      expect(weirdLogs.length).toBe(0);
+
+      if (!out.success) console.error(JSON.stringify(out, replacer));
+      expect(out.success).toBe(true);
+
+      if (out.success) {
+        expect(out.document.warning).toBeUndefined();
+        expect(out.document).toHaveProperty("markdown");
+        expect(out.document).toHaveProperty("metadata");
+        expect(out.document.metadata.error).toBeUndefined();
+        expect(out.document.metadata.statusCode).toBe(200);
+      }
+    },
+    30000
+  );
+});

apps/api/src/scraper/scrapeURL/transformers/cache.ts

@@ -3,24 +3,30 @@ import { Meta } from "..";
 import { CacheEntry, cacheKey, saveEntryToCache } from "../../../lib/cache";
 
 export function saveToCache(meta: Meta, document: Document): Document {
-    if (document.metadata.statusCode! < 200 || document.metadata.statusCode! >= 300) return document;
+  if (
-
+    document.metadata.statusCode! < 200 ||
-    if (document.rawHtml === undefined) {
+    document.metadata.statusCode! >= 300
-        throw new Error("rawHtml is undefined -- this transformer is being called out of order");
+  )
-    }
-
-    const key = cacheKey(meta.url, meta.options, meta.internalOptions);
-
-    if (key !== null) {
-        const entry: CacheEntry = {
-            html: document.rawHtml!,
-            statusCode: document.metadata.statusCode!,
-            url: document.metadata.url ?? document.metadata.sourceURL!,
-            error: document.metadata.error ?? undefined,
-        };
-
-        saveEntryToCache(key, entry);
-    }
-
     return document;
-}
+
+  if (document.rawHtml === undefined) {
+    throw new Error(
+      "rawHtml is undefined -- this transformer is being called out of order"
+    );
+  }
+
+  const key = cacheKey(meta.url, meta.options, meta.internalOptions);
+
+  if (key !== null) {
+    const entry: CacheEntry = {
+      html: document.rawHtml!,
+      statusCode: document.metadata.statusCode!,
+      url: document.metadata.url ?? document.metadata.sourceURL!,
+      error: document.metadata.error ?? undefined
+    };
+
+    saveEntryToCache(key, entry);
+  }
+
+  return document;
+}

apps/api/src/scraper/scrapeURL/transformers/index.ts

@@ -9,127 +9,180 @@ import { uploadScreenshot } from "./uploadScreenshot";
 import { removeBase64Images } from "./removeBase64Images";
 import { saveToCache } from "./cache";
 
-export type Transformer = (meta: Meta, document: Document) => Document | Promise<Document>;
+export type Transformer = (
+  meta: Meta,
+  document: Document
+) => Document | Promise<Document>;
 
-export function deriveMetadataFromRawHTML(meta: Meta, document: Document): Document {
+export function deriveMetadataFromRawHTML(
-    if (document.rawHtml === undefined) {
+  meta: Meta,
-        throw new Error("rawHtml is undefined -- this transformer is being called out of order");
+  document: Document
-    }
+): Document {
+  if (document.rawHtml === undefined) {
+    throw new Error(
+      "rawHtml is undefined -- this transformer is being called out of order"
+    );
+  }
 
-    document.metadata = {
+  document.metadata = {
-        ...extractMetadata(meta, document.rawHtml),
+    ...extractMetadata(meta, document.rawHtml),
-        ...document.metadata,
+    ...document.metadata
-    };
+  };
-    return document;
+  return document;
 }
 
-export function deriveHTMLFromRawHTML(meta: Meta, document: Document): Document {
+export function deriveHTMLFromRawHTML(
-    if (document.rawHtml === undefined) {
+  meta: Meta,
-        throw new Error("rawHtml is undefined -- this transformer is being called out of order");
+  document: Document
-    }
+): Document {
+  if (document.rawHtml === undefined) {
+    throw new Error(
+      "rawHtml is undefined -- this transformer is being called out of order"
+    );
+  }
 
-    document.html = removeUnwantedElements(document.rawHtml, meta.options);
+  document.html = removeUnwantedElements(document.rawHtml, meta.options);
-    return document;
+  return document;
 }
 
-export async function deriveMarkdownFromHTML(_meta: Meta, document: Document): Promise<Document> {
+export async function deriveMarkdownFromHTML(
-    if (document.html === undefined) {
+  _meta: Meta,
-        throw new Error("html is undefined -- this transformer is being called out of order");
+  document: Document
-    }
+): Promise<Document> {
+  if (document.html === undefined) {
+    throw new Error(
+      "html is undefined -- this transformer is being called out of order"
+    );
+  }
 
-    document.markdown = await parseMarkdown(document.html);
+  document.markdown = await parseMarkdown(document.html);
-    return document;
+  return document;
 }
 
 export function deriveLinksFromHTML(meta: Meta, document: Document): Document {
-    // Only derive if the formats has links
+  // Only derive if the formats has links
-    if (meta.options.formats.includes("links")) {
+  if (meta.options.formats.includes("links")) {
-        if (document.html === undefined) {
+    if (document.html === undefined) {
-            throw new Error("html is undefined -- this transformer is being called out of order");
+      throw new Error(
-        }
+        "html is undefined -- this transformer is being called out of order"
-
+      );
-        document.links = extractLinks(document.html, meta.url);
     }
 
-    return document;
+    document.links = extractLinks(document.html, meta.url);
+  }
+
+  return document;
 }
 
-export function coerceFieldsToFormats(meta: Meta, document: Document): Document {
+export function coerceFieldsToFormats(
-    const formats = new Set(meta.options.formats);
+  meta: Meta,
+  document: Document
+): Document {
+  const formats = new Set(meta.options.formats);
 
-    if (!formats.has("markdown") && document.markdown !== undefined) {
+  if (!formats.has("markdown") && document.markdown !== undefined) {
-        delete document.markdown;
+    delete document.markdown;
-    } else if (formats.has("markdown") && document.markdown === undefined) {
+  } else if (formats.has("markdown") && document.markdown === undefined) {
-        meta.logger.warn("Request had format: markdown, but there was no markdown field in the result.");
+    meta.logger.warn(
-    }
+      "Request had format: markdown, but there was no markdown field in the result."
+    );
+  }
 
-    if (!formats.has("rawHtml") && document.rawHtml !== undefined) {
+  if (!formats.has("rawHtml") && document.rawHtml !== undefined) {
-        delete document.rawHtml;
+    delete document.rawHtml;
-    } else if (formats.has("rawHtml") && document.rawHtml === undefined) {
+  } else if (formats.has("rawHtml") && document.rawHtml === undefined) {
-        meta.logger.warn("Request had format: rawHtml, but there was no rawHtml field in the result.");
+    meta.logger.warn(
-    }
+      "Request had format: rawHtml, but there was no rawHtml field in the result."
+    );
+  }
 
-    if (!formats.has("html") && document.html !== undefined) {
+  if (!formats.has("html") && document.html !== undefined) {
-        delete document.html;
+    delete document.html;
-    } else if (formats.has("html") && document.html === undefined) {
+  } else if (formats.has("html") && document.html === undefined) {
-        meta.logger.warn("Request had format: html, but there was no html field in the result.");
+    meta.logger.warn(
-    }
+      "Request had format: html, but there was no html field in the result."
+    );
+  }
 
-    if (!formats.has("screenshot") && !formats.has("screenshot@fullPage") && document.screenshot !== undefined) {
+  if (
-        meta.logger.warn("Removed screenshot from Document because it wasn't in formats -- this is very wasteful and indicates a bug.");
+    !formats.has("screenshot") &&
-        delete document.screenshot;
+    !formats.has("screenshot@fullPage") &&
-    } else if ((formats.has("screenshot") || formats.has("screenshot@fullPage")) && document.screenshot === undefined) {
+    document.screenshot !== undefined
-        meta.logger.warn("Request had format: screenshot / screenshot@fullPage, but there was no screenshot field in the result.");
+  ) {
-    }
+    meta.logger.warn(
+      "Removed screenshot from Document because it wasn't in formats -- this is very wasteful and indicates a bug."
+    );
+    delete document.screenshot;
+  } else if (
+    (formats.has("screenshot") || formats.has("screenshot@fullPage")) &&
+    document.screenshot === undefined
+  ) {
+    meta.logger.warn(
+      "Request had format: screenshot / screenshot@fullPage, but there was no screenshot field in the result."
+    );
+  }
 
-    if (!formats.has("links") && document.links !== undefined) {
+  if (!formats.has("links") && document.links !== undefined) {
-        meta.logger.warn("Removed links from Document because it wasn't in formats -- this is wasteful and indicates a bug.");
+    meta.logger.warn(
-        delete document.links;
+      "Removed links from Document because it wasn't in formats -- this is wasteful and indicates a bug."
-    } else if (formats.has("links") && document.links === undefined) {
+    );
-        meta.logger.warn("Request had format: links, but there was no links field in the result.");
+    delete document.links;
-    }
+  } else if (formats.has("links") && document.links === undefined) {
+    meta.logger.warn(
+      "Request had format: links, but there was no links field in the result."
+    );
+  }
 
-    if (!formats.has("extract") && document.extract !== undefined) {
+  if (!formats.has("extract") && document.extract !== undefined) {
-        meta.logger.warn("Removed extract from Document because it wasn't in formats -- this is extremely wasteful and indicates a bug.");
+    meta.logger.warn(
-        delete document.extract;
+      "Removed extract from Document because it wasn't in formats -- this is extremely wasteful and indicates a bug."
-    } else if (formats.has("extract") && document.extract === undefined) {
+    );
-        meta.logger.warn("Request had format: extract, but there was no extract field in the result.");
+    delete document.extract;
-    }
+  } else if (formats.has("extract") && document.extract === undefined) {
+    meta.logger.warn(
+      "Request had format: extract, but there was no extract field in the result."
+    );
+  }
 
-    if (meta.options.actions === undefined || meta.options.actions.length === 0) {
+  if (meta.options.actions === undefined || meta.options.actions.length === 0) {
-        delete document.actions;
+    delete document.actions;
-    }
+  }
 
-    return document;
+  return document;
 }
 
 // TODO: allow some of these to run in parallel
 export const transformerStack: Transformer[] = [
-    saveToCache,
+  saveToCache,
-    deriveHTMLFromRawHTML,
+  deriveHTMLFromRawHTML,
-    deriveMarkdownFromHTML,
+  deriveMarkdownFromHTML,
-    deriveLinksFromHTML,
+  deriveLinksFromHTML,
-    deriveMetadataFromRawHTML,
+  deriveMetadataFromRawHTML,
-    uploadScreenshot,
+  uploadScreenshot,
-    performLLMExtract,
+  performLLMExtract,
-    coerceFieldsToFormats,
+  coerceFieldsToFormats,
-    removeBase64Images, 
+  removeBase64Images
 ];
 
-export async function executeTransformers(meta: Meta, document: Document): Promise<Document> {
+export async function executeTransformers(
-    const executions: [string, number][] = [];
+  meta: Meta,
+  document: Document
+): Promise<Document> {
+  const executions: [string, number][] = [];
 
-    for (const transformer of transformerStack) {
+  for (const transformer of transformerStack) {
-        const _meta = {
+    const _meta = {
-            ...meta,
+      ...meta,
-            logger: meta.logger.child({ method: "executeTransformers/" + transformer.name }),
+      logger: meta.logger.child({
-        };
+        method: "executeTransformers/" + transformer.name
-        const start = Date.now();
+      })
-        document = await transformer(_meta, document);
+    };
-        executions.push([transformer.name, Date.now() - start]);
+    const start = Date.now();
-    }
+    document = await transformer(_meta, document);
+    executions.push([transformer.name, Date.now() - start]);
+  }
 
-    meta.logger.debug("Executed transformers.", { executions });
+  meta.logger.debug("Executed transformers.", { executions });
 
-    return document;
+  return document;
 }

apps/api/src/scraper/scrapeURL/transformers/llmExtract.ts

@@ -9,186 +9,226 @@ const maxTokens = 32000;
 const modifier = 4;
 
 export class LLMRefusalError extends Error {
-    public refusal: string;
+  public refusal: string;
-    public results: EngineResultsTracker | undefined;
+  public results: EngineResultsTracker | undefined;
 
-    constructor(refusal: string) {
+  constructor(refusal: string) {
-        super("LLM refused to extract the website's content")
+    super("LLM refused to extract the website's content");
-        this.refusal = refusal;
+    this.refusal = refusal;
-    }
+  }
 }
 
 function normalizeSchema(x: any): any {
-    if (typeof x !== "object" || x === null) return x;
+  if (typeof x !== "object" || x === null) return x;
 
-    if (x["$defs"] !== null && typeof x["$defs"] === "object") {
+  if (x["$defs"] !== null && typeof x["$defs"] === "object") {
-        x["$defs"] = Object.fromEntries(Object.entries(x["$defs"]).map(([name, schema]) => [name, normalizeSchema(schema)]));
+    x["$defs"] = Object.fromEntries(
-    }
+      Object.entries(x["$defs"]).map(([name, schema]) => [
+        name,
+        normalizeSchema(schema)
+      ])
+    );
+  }
 
-    if (x && x.anyOf) {
+  if (x && x.anyOf) {
-        x.anyOf = x.anyOf.map(x => normalizeSchema(x));
+    x.anyOf = x.anyOf.map((x) => normalizeSchema(x));
-    }
+  }
 
-    if (x && x.oneOf) {
+  if (x && x.oneOf) {
-        x.oneOf = x.oneOf.map(x => normalizeSchema(x));
+    x.oneOf = x.oneOf.map((x) => normalizeSchema(x));
-    }
+  }
 
-    if (x && x.allOf) {
+  if (x && x.allOf) {
-        x.allOf = x.allOf.map(x => normalizeSchema(x));
+    x.allOf = x.allOf.map((x) => normalizeSchema(x));
-    }
+  }
 
-    if (x && x.not) {
+  if (x && x.not) {
-        x.not = normalizeSchema(x.not);
+    x.not = normalizeSchema(x.not);
-    }
+  }
 
-    if (x && x.type === "object") {
+  if (x && x.type === "object") {
-        return {
+    return {
-            ...x,
+      ...x,
-            properties: Object.fromEntries(Object.entries(x.properties).map(([k, v]) => [k, normalizeSchema(v)])),
+      properties: Object.fromEntries(
-            required: Object.keys(x.properties),
+        Object.entries(x.properties).map(([k, v]) => [k, normalizeSchema(v)])
-            additionalProperties: false,
+      ),
-        }
+      required: Object.keys(x.properties),
-    } else if (x && x.type === "array") {
+      additionalProperties: false
-        return {
+    };
-            ...x,
+  } else if (x && x.type === "array") {
-            items: normalizeSchema(x.items),
+    return {
-        }
+      ...x,
-    } else {
+      items: normalizeSchema(x.items)
-        return x;
+    };
-    }
+  } else {
+    return x;
+  }
 }
 
-export async function generateOpenAICompletions(logger: Logger, options: ExtractOptions, markdown?: string, previousWarning?: string, isExtractEndpoint?: boolean): Promise<{ extract: any, numTokens: number, warning: string | undefined }> {
+export async function generateOpenAICompletions(
-    let extract: any;
+  logger: Logger,
-    let warning: string | undefined;
+  options: ExtractOptions,
+  markdown?: string,
+  previousWarning?: string,
+  isExtractEndpoint?: boolean
+): Promise<{ extract: any; numTokens: number; warning: string | undefined }> {
+  let extract: any;
+  let warning: string | undefined;
 
-    const openai = new OpenAI();
+  const openai = new OpenAI();
-    const model: TiktokenModel = (process.env.MODEL_NAME as TiktokenModel) ?? "gpt-4o-mini";
+  const model: TiktokenModel =
+    (process.env.MODEL_NAME as TiktokenModel) ?? "gpt-4o-mini";
 
-    if (markdown === undefined) {
+  if (markdown === undefined) {
-        throw new Error("document.markdown is undefined -- this is unexpected");
+    throw new Error("document.markdown is undefined -- this is unexpected");
-    }
+  }
 
-    // count number of tokens
+  // count number of tokens
-    let numTokens = 0;
+  let numTokens = 0;
-    const encoder = encoding_for_model(model as TiktokenModel);
+  const encoder = encoding_for_model(model as TiktokenModel);
+  try {
+    // Encode the message into tokens
+    const tokens = encoder.encode(markdown);
+
+    // Return the number of tokens
+    numTokens = tokens.length;
+  } catch (error) {
+    logger.warn("Calculating num tokens of string failed", { error, markdown });
+
+    markdown = markdown.slice(0, maxTokens * modifier);
+
+    let w =
+      "Failed to derive number of LLM tokens the extraction might use -- the input has been automatically trimmed to the maximum number of tokens (" +
+      maxTokens +
+      ") we support.";
+    warning = previousWarning === undefined ? w : w + " " + previousWarning;
+  } finally {
+    // Free the encoder resources after use
+    encoder.free();
+  }
+
+  if (numTokens > maxTokens) {
+    // trim the document to the maximum number of tokens, tokens != characters
+    markdown = markdown.slice(0, maxTokens * modifier);
+
+    const w =
+      "The extraction content would have used more tokens (" +
+      numTokens +
+      ") than the maximum we allow (" +
+      maxTokens +
+      "). -- the input has been automatically trimmed.";
+    warning = previousWarning === undefined ? w : w + " " + previousWarning;
+  }
+
+  let schema = options.schema;
+  if (schema && schema.type === "array") {
+    schema = {
+      type: "object",
+      properties: {
+        items: options.schema
+      },
+      required: ["items"],
+      additionalProperties: false
+    };
+  } else if (schema && typeof schema === "object" && !schema.type) {
+    schema = {
+      type: "object",
+      properties: Object.fromEntries(
+        Object.entries(schema).map(([key, value]) => [key, { type: value }])
+      ),
+      required: Object.keys(schema),
+      additionalProperties: false
+    };
+  }
+
+  schema = normalizeSchema(schema);
+
+  const jsonCompletion = await openai.beta.chat.completions.parse({
+    model,
+    temperature: 0,
+    messages: [
+      {
+        role: "system",
+        content: options.systemPrompt
+      },
+      {
+        role: "user",
+        content: [{ type: "text", text: markdown }]
+      },
+      {
+        role: "user",
+        content:
+          options.prompt !== undefined
+            ? `Transform the above content into structured JSON output based on the following user request: ${options.prompt}`
+            : "Transform the above content into structured JSON output."
+      }
+    ],
+    response_format: options.schema
+      ? {
+          type: "json_schema",
+          json_schema: {
+            name: "websiteContent",
+            schema: schema,
+            strict: true
+          }
+        }
+      : { type: "json_object" }
+  });
+
+  if (jsonCompletion.choices[0].message.refusal !== null) {
+    throw new LLMRefusalError(jsonCompletion.choices[0].message.refusal);
+  }
+
+  extract = jsonCompletion.choices[0].message.parsed;
+
+  if (extract === null && jsonCompletion.choices[0].message.content !== null) {
     try {
-        // Encode the message into tokens
+      if (!isExtractEndpoint) {
-        const tokens = encoder.encode(markdown);
+        extract = JSON.parse(jsonCompletion.choices[0].message.content);
-    
+      } else {
-        // Return the number of tokens
+        const extractData = JSON.parse(
-        numTokens = tokens.length;
+          jsonCompletion.choices[0].message.content
-    } catch (error) {
-        logger.warn("Calculating num tokens of string failed", { error, markdown });
-
-        markdown = markdown.slice(0, maxTokens * modifier);
-
-        let w = "Failed to derive number of LLM tokens the extraction might use -- the input has been automatically trimmed to the maximum number of tokens (" + maxTokens + ") we support.";
-        warning = previousWarning === undefined ? w : w + " " + previousWarning;
-    } finally {
-        // Free the encoder resources after use
-        encoder.free();
-    }
-
-    if (numTokens > maxTokens) {
-        // trim the document to the maximum number of tokens, tokens != characters
-        markdown = markdown.slice(0, maxTokens * modifier);
-
-        const w = "The extraction content would have used more tokens (" + numTokens + ") than the maximum we allow (" + maxTokens + "). -- the input has been automatically trimmed.";
-        warning = previousWarning === undefined ? w : w + " " + previousWarning;
-    }
-
-    let schema = options.schema;
-    if (schema && schema.type === "array") {
-        schema = {
-            type: "object",
-            properties: {
-                items: options.schema,
-            },
-            required: ["items"],
-            additionalProperties: false,
-        };
-    } else if (schema && typeof schema === 'object' && !schema.type) {
-      schema = {
-          type: "object",
-          properties: Object.fromEntries(
-              Object.entries(schema).map(([key, value]) => [key, { type: value }])
-          ),
-          required: Object.keys(schema),
-          additionalProperties: false
-      };
-    }
-
-    schema = normalizeSchema(schema);
-
-    const jsonCompletion = await openai.beta.chat.completions.parse({
-        model,
-        temperature: 0,
-        messages: [
-            {
-                role: "system",
-                content: options.systemPrompt,
-            },
-            {
-                role: "user",
-                content: [{ type: "text", text: markdown }],
-            },
-            {
-                role: "user",
-                content: options.prompt !== undefined
-                    ? `Transform the above content into structured JSON output based on the following user request: ${options.prompt}`
-                    : "Transform the above content into structured JSON output.",
-            },
-        ],
-        response_format: options.schema ? {
-            type: "json_schema",
-            json_schema: {
-                name: "websiteContent",
-                schema: schema,
-                strict: true,
-            }
-        } : { type: "json_object" },
-    });
-
-    if (jsonCompletion.choices[0].message.refusal !== null) {
-        throw new LLMRefusalError(jsonCompletion.choices[0].message.refusal);
-    }
-
-    extract = jsonCompletion.choices[0].message.parsed;
-
-    if (extract === null && jsonCompletion.choices[0].message.content !== null) {
-        try {
-            if (!isExtractEndpoint) {
-                extract = JSON.parse(jsonCompletion.choices[0].message.content);
-            } else {
-                const extractData = JSON.parse(jsonCompletion.choices[0].message.content);
-                extract = options.schema ? extractData.data.extract : extractData;
-            }
-        } catch (e) {
-            logger.error("Failed to parse returned JSON, no schema specified.", { error: e });
-            throw new LLMRefusalError("Failed to parse returned JSON. Please specify a schema in the extract object.");
-        }
-    }
-
-    // If the users actually wants the items object, they can specify it as 'required' in the schema
-    // otherwise, we just return the items array
-    if (options.schema && options.schema.type === "array" && !schema?.required?.includes("items")) {
-        extract = extract?.items;
-    }
-    return { extract, warning, numTokens };
-}
-
-export async function performLLMExtract(meta: Meta, document: Document): Promise<Document> {
-    if (meta.options.formats.includes("extract")) {
-        const { extract, warning } = await generateOpenAICompletions(
-          meta.logger.child({ method: "performLLMExtract/generateOpenAICompletions" }),
-          meta.options.extract!,
-          document.markdown,
-          document.warning,
         );
-        document.extract = extract;
+        extract = options.schema ? extractData.data.extract : extractData;
-        document.warning = warning;
+      }
+    } catch (e) {
+      logger.error("Failed to parse returned JSON, no schema specified.", {
+        error: e
+      });
+      throw new LLMRefusalError(
+        "Failed to parse returned JSON. Please specify a schema in the extract object."
+      );
     }
+  }
 
-    return document;
+  // If the users actually wants the items object, they can specify it as 'required' in the schema
+  // otherwise, we just return the items array
+  if (
+    options.schema &&
+    options.schema.type === "array" &&
+    !schema?.required?.includes("items")
+  ) {
+    extract = extract?.items;
+  }
+  return { extract, warning, numTokens };
+}
+
+export async function performLLMExtract(
+  meta: Meta,
+  document: Document
+): Promise<Document> {
+  if (meta.options.formats.includes("extract")) {
+    const { extract, warning } = await generateOpenAICompletions(
+      meta.logger.child({
+        method: "performLLMExtract/generateOpenAICompletions"
+      }),
+      meta.options.extract!,
+      document.markdown,
+      document.warning
+    );
+    document.extract = extract;
+    document.warning = warning;
+  }
+
+  return document;
 }