feat: Make technology, geo, rank, and category parameters optional with 'ALL' default and enhance API filter tests. (#83)

Signed-off-by: Max Ostapenko <1611259+max-ostapenko@users.noreply.github.com>

Author: max-ostapenko

README.md

@@ -54,7 +54,7 @@ Lists available categories.
 
 #### Categories Parameters
 
-- `category` (optional): Filter by category name(s) - comma-separated list
+- `category` (optional): Filter by category name(s) - comma-separated list (defaults to 'ALL')
 - `onlyname` (optional): If present, returns only category names
 - `fields` (optional): Comma-separated list of fields to include in the response (see [Field Selection API Documentation](#field-selection-api-documentation) for details)
 
@@ -117,7 +117,7 @@ Lists available technologies with optional filtering.
 
 #### Parameters
 
-- `technology` (optional): Filter by technology name(s) - comma-separated list
+- `technology` (optional): Filter by technology name(s) - comma-separated list (defaults to 'ALL')
 - `category` (optional): Filter by category - comma-separated list
 - `onlyname` (optional): If present, returns only technology names
 - `fields` (optional): Comma-separated list of fields to include in the response (see [Field Selection API Documentation](#field-selection-api-documentation) for details)
@@ -173,7 +173,7 @@ Lists available versions.
 
 #### Versions Parameters
 
-- `technology` (optional): Filter by technology name(s) - comma-separated list
+- `technology` (optional): Filter by technology name(s) - comma-separated list (defaults to 'ALL')
 - `category` (optional): Filter by category - comma-separated list
 - `version` (optional): Filter by version name(s) - comma-separated list
 - `onlyname` (optional): If present, returns only version names
@@ -207,9 +207,9 @@ Provides technology adoption data.
 
 #### Adoption Parameters
 
-- `technology` (required): Filter by technology name(s) - comma-separated list
-- `geo` (required): Filter by geographic location
-- `rank` (required): Filter by rank
+- `technology` (optional): Filter by technology name(s) - comma-separated list (defaults to 'ALL')
+- `geo` (optional): Filter by geographic location (defaults to 'ALL')
+- `rank` (optional): Filter by rank (defaults to 'ALL')
 - `start` (optional): Filter by date range start (YYYY-MM-DD or 'latest')
 - `end` (optional): Filter by date range end (YYYY-MM-DD)
 
@@ -242,9 +242,9 @@ Provides Core Web Vitals metrics for technologies.
 
 #### CWV Parameters
 
-- `technology` (required): Filter by technology name(s) - comma-separated list
-- `geo` (required): Filter by geographic location
-- `rank` (required): Filter by rank
+- `technology` (optional): Filter by technology name(s) - comma-separated list (defaults to 'ALL')
+- `geo` (optional): Filter by geographic location (defaults to 'ALL')
+- `rank` (optional): Filter by rank (defaults to 'ALL')
 - `start` (optional): Filter by date range start (YYYY-MM-DD or 'latest')
 - `end` (optional): Filter by date range end (YYYY-MM-DD)
 
@@ -285,9 +285,9 @@ Provides Lighthouse scores for technologies.
 
 #### Lighthouse Parameters
 
-- `technology` (required): Filter by technology name(s) - comma-separated list
-- `geo` (required): Filter by geographic location
-- `rank` (required): Filter by rank
+- `technology` (optional): Filter by technology name(s) - comma-separated list (defaults to 'ALL')
+- `geo` (optional): Filter by geographic location (defaults to 'ALL')
+- `rank` (optional): Filter by rank (defaults to 'ALL')
 - `start` (optional): Filter by date range start (YYYY-MM-DD or 'latest')
 - `end` (optional): Filter by date range end (YYYY-MM-DD)
 
@@ -332,9 +332,9 @@ Provides Page Weight metrics for technologies.
 
 #### Page Weight Parameters
 
-- `technology` (required): Filter by technology name(s) - comma-separated list
-- `geo` (required): Filter by geographic location
-- `rank` (required): Filter by rank
+- `technology` (optional): Filter by technology name(s) - comma-separated list (defaults to 'ALL')
+- `geo` (optional): Filter by geographic location (defaults to 'ALL')
+- `rank` (optional): Filter by rank (defaults to 'ALL')
 - `start` (optional): Filter by date range start (YYYY-MM-DD or 'latest')
 - `end` (optional): Filter by date range end (YYYY-MM-DD)
 
@@ -393,9 +393,9 @@ Provides Lighthouse audits for technologies.
 
 #### Audits Parameters
 
-- `technology` (required): Filter by technology name(s) - comma-separated list
-- `geo` (required): Filter by geographic location
-- `rank` (required): Filter by rank
+- `technology` (optional): Filter by technology name(s) - comma-separated list (defaults to 'ALL')
+- `geo` (optional): Filter by geographic location (defaults to 'ALL')
+- `rank` (optional): Filter by rank (defaults to 'ALL')
 - `start` (optional): Filter by date range start (YYYY-MM-DD or 'latest')
 - `end` (optional): Filter by date range end (YYYY-MM-DD)
 
@@ -513,14 +513,14 @@ Proxy endpoint to serve files from the private Google Cloud Storage bucket. The
 
 #### Supported File Types
 
-| Extension | MIME Type |
-|-----------|-----------|
-| `.json` | `application/json` |
-| `.js` | `application/javascript` |
-| `.png` | `image/png` |
-| `.svg` | `image/svg+xml` |
-| `.csv` | `text/csv` |
-| `.pdf` | `application/pdf` |
+| Extension | MIME Type                |
+| --------- | ------------------------ |
+| `.json`   | `application/json`       |
+| `.js`     | `application/javascript` |
+| `.png`    | `image/png`              |
+| `.svg`    | `image/svg+xml`          |
+| `.csv`    | `text/csv`               |
+| `.pdf`    | `application/pdf`        |
 
 #### Static File Response
 

src/controllers/categoriesController.js

@@ -25,8 +25,9 @@ const listCategories = async (req, res) => {
     let query = firestore.collection('categories').orderBy('category', 'asc');
 
     // Apply category filter with validation
-    if (params.category) {
-      const categories = validateArrayParameter(params.category, 'category');
+    const categoryParam = params.category || 'ALL';
+    if (categoryParam !== 'ALL') {
+      const categories = validateArrayParameter(categoryParam, 'category');
       if (categories.length > 0) {
         query = query.where('category', 'in', categories);
       }

src/controllers/reportController.js

@@ -64,19 +64,20 @@ const createReportController = (reportType) => {
             */
 
             // Validate required parameters using shared utility
-            const errors = validateRequiredParams(params, [
-                REQUIRED_PARAMS.GEO,
-                REQUIRED_PARAMS.RANK,
-                REQUIRED_PARAMS.TECHNOLOGY
-            ]);
+            const errors = validateRequiredParams(params, []);
 
             if (errors) {
                 sendValidationError(res, errors);
                 return;
             }
 
+            // Default technology, geo, and rank to 'ALL' if missing or empty
+            const technologyParam = params.technology || 'ALL';
+            const geoParam = params.geo || 'ALL';
+            const rankParam = params.rank || 'ALL';
+
             // Validate and process technology array
-            const techArray = validateArrayParameter(params.technology, 'technology');
+            const techArray = validateArrayParameter(technologyParam, 'technology');
 
             // Handle 'latest' date substitution
             let startDate = params.start;
@@ -88,8 +89,8 @@ const createReportController = (reportType) => {
             let query = firestore.collection(config.table);
 
             // Apply required filters
-            query = query.where('geo', '==', params.geo);
-            query = query.where('rank', '==', params.rank);
+            query = query.where('geo', '==', geoParam);
+            query = query.where('rank', '==', rankParam);
 
             // Apply technology filter with batch processing
             query = query.where('technology', 'in', techArray);

src/controllers/technologiesController.js

@@ -25,8 +25,9 @@ const listTechnologies = async (req, res) => {
     let query = firestore.collection('technologies').orderBy('technology', 'asc');
 
     // Apply technology filter with validation
-    if (params.technology) {
-      const technologies = validateTechnologyArray(params.technology);
+    const technologyParam = params.technology || 'ALL';
+    if (technologyParam !== 'ALL') {
+      const technologies = validateTechnologyArray(technologyParam);
       if (technologies === null) {
         throw new Error(`Too many technologies specified. Maximum ${FIRESTORE_IN_LIMIT} allowed.`);
       }

src/controllers/versionsController.js

@@ -22,8 +22,9 @@ const listVersions = async (req, res) => {
     let query = firestore.collection('versions');
 
     // Apply technology filter with validation
-    if (params.technology) {
-      const technologies = validateTechnologyArray(params.technology);
+    const technologyParam = params.technology || 'ALL';
+    if (technologyParam !== 'ALL') {
+      const technologies = validateTechnologyArray(technologyParam);
       if (technologies === null) {
         throw new Error(`Too many technologies specified. Maximum ${FIRESTORE_IN_LIMIT} allowed.`);
       }

src/tests/routes.test.js

@@ -106,12 +106,18 @@ describe('API Routes', () => {
   });
 
   describe('GET /v1/technologies', () => {
-    it('should return technologies', async () => {
+    it('should return technologies (defaults to ALL technology)', async () => {
       const res = await request(app).get('/v1/technologies');
       expect(res.statusCode).toEqual(200);
       expect(Array.isArray(res.body)).toBe(true);
     });
 
+    it('should handle empty technology parameter', async () => {
+      const res = await request(app).get('/v1/technologies?technology=');
+      expect(res.statusCode).toEqual(200);
+      expect(Array.isArray(res.body)).toBe(true);
+    });
+
     it('should filter technologies by name', async () => {
       const res = await request(app).get('/v1/technologies?technology=WordPress');
       expect(res.statusCode).toEqual(200);
@@ -224,12 +230,18 @@ describe('API Routes', () => {
   });
 
   describe('GET /v1/versions', () => {
-    it('should return versions', async () => {
+    it('should return versions (defaults to ALL technology)', async () => {
       const res = await request(app).get('/v1/versions');
       expect(res.statusCode).toEqual(200);
       expect(Array.isArray(res.body)).toBe(true);
     });
 
+    it('should handle empty technology parameter', async () => {
+      const res = await request(app).get('/v1/versions?technology=');
+      expect(res.statusCode).toEqual(200);
+      expect(Array.isArray(res.body)).toBe(true);
+    });
+
     it('should filter versions by technology', async () => {
       const res = await request(app).get('/v1/versions?technology=WordPress');
       expect(res.statusCode).toEqual(200);
@@ -255,10 +267,21 @@ describe('API Routes', () => {
       expect(Array.isArray(res.body)).toBe(true);
     });
 
-    it('should handle missing required parameters', async () => {
-      const res = await request(app).get('/v1/adoption');
-      expect(res.statusCode).toEqual(400);
-      expect(res.body).toHaveProperty('errors');
+    it('should handle missing or empty parameters (defaults to ALL)', async () => {
+      // All missing
+      const res1 = await request(app).get('/v1/adoption');
+      expect(res1.statusCode).toEqual(200);
+      expect(Array.isArray(res1.body)).toBe(true);
+
+      // Technology empty, others missing
+      const res2 = await request(app).get('/v1/adoption?technology=');
+      expect(res2.statusCode).toEqual(200);
+      expect(Array.isArray(res2.body)).toBe(true);
+
+      // Geo and Rank empty
+      const res3 = await request(app).get('/v1/adoption?technology=WordPress&geo=&rank=');
+      expect(res3.statusCode).toEqual(200);
+      expect(Array.isArray(res3.body)).toBe(true);
     });
 
     it('should handle CORS preflight requests', async () => {
@@ -280,10 +303,10 @@ describe('API Routes', () => {
       expect(Array.isArray(res.body)).toBe(true);
     });
 
-    it('should handle missing required parameters', async () => {
+    it('should handle optional parameters being omitted', async () => {
       const res = await request(app).get('/v1/cwv');
-      expect(res.statusCode).toEqual(400);
-      expect(res.body).toHaveProperty('errors');
+      expect(res.statusCode).toEqual(200);
+      expect(Array.isArray(res.body)).toBe(true);
     });
 
     it('should handle CORS preflight requests', async () => {
@@ -305,10 +328,10 @@ describe('API Routes', () => {
       expect(Array.isArray(res.body)).toBe(true);
     });
 
-    it('should handle missing required parameters', async () => {
+    it('should handle optional parameters being omitted', async () => {
       const res = await request(app).get('/v1/lighthouse');
-      expect(res.statusCode).toEqual(400);
-      expect(res.body).toHaveProperty('errors');
+      expect(res.statusCode).toEqual(200);
+      expect(Array.isArray(res.body)).toBe(true);
     });
 
     it('should handle CORS preflight requests', async () => {
@@ -330,10 +353,10 @@ describe('API Routes', () => {
       expect(Array.isArray(res.body)).toBe(true);
     });
 
-    it('should handle missing required parameters', async () => {
+    it('should handle optional parameters being omitted', async () => {
       const res = await request(app).get('/v1/page-weight');
-      expect(res.statusCode).toEqual(400);
-      expect(res.body).toHaveProperty('errors');
+      expect(res.statusCode).toEqual(200);
+      expect(Array.isArray(res.body)).toBe(true);
     });
 
     it('should handle CORS preflight requests', async () => {

test-api.sh

@@ -24,6 +24,46 @@ test_endpoint() {
   echo ""
 }
 
+# Function to test an endpoint with filter verification
+test_filter() {
+  local endpoint=$1
+  local params=$2
+  local filter_check=$3
+  local description=$4
+  local url="http://localhost:8080${endpoint}${params}"
+
+  echo "Testing filter: ${description}"
+  echo "URL: ${url}"
+  
+  response=$(curl -s -w "\n%{http_code}" "${url}")
+  http_code=$(echo "$response" | tail -n1)
+  body=$(echo "$response" | sed '$d')
+
+  if [[ $http_code -ne 200 ]]; then
+    echo "Error: Endpoint returned status code $http_code"
+    echo "$body" | jq .
+    exit 1
+  fi
+
+  # Run the verification check using jq
+  # The check should return "true" if it passes
+  check_result=$(echo "$body" | jq "${filter_check}")
+  
+  if [[ "$check_result" != "true" ]]; then
+    echo "Error: Filter verification failed for ${description}"
+    echo "Verification expression: ${filter_check}"
+    echo "Actual result: ${check_result}"
+    echo "Sample data:"
+    echo "$body" | jq . | head -20
+    exit 1
+  fi
+
+  echo "✓ Filter verification passed"
+  echo ""
+  echo "----------------------"
+  echo ""
+}
+
 # Function to test CORS preflight with OPTIONS request
 test_cors_preflight() {
   local endpoint=$1
@@ -101,19 +141,39 @@ test_endpoint "/v1/ranks" ""
 # Test geos endpoint
 test_endpoint "/v1/geos" ""
 
-# Test adoption endpoint
-test_endpoint "/v1/adoption" "?technology=WordPress&geo=ALL&rank=ALL&start=latest"
-
-# Test cwv endpoint
-test_endpoint "/v1/cwv" "?technology=WordPress,Drupal&geo=ALL&rank=ALL&start=latest"
-
-# Test lighthouse endpoint
-test_endpoint "/v1/lighthouse" "?technology=WordPress&geo=ALL&rank=ALL&start=latest"
-
-# Test page-weight endpoint
-test_endpoint "/v1/page-weight" "?technology=WordPress&geo=ALL&rank=ALL&start=latest"
-
-# Test audits endpoint
-test_endpoint "/v1/audits" "?technology=WordPress&geo=ALL&rank=ALL&start=latest"
+# Test filter correspondences
+echo "Testing Filter Correspondences..."
+echo "----------------------"
+echo ""
 
-echo "API tests complete! All endpoints returned 200 status code and CORS is properly configured."
+# Test adoption defaults (tech=ALL)
+test_filter "/v1/adoption" "" \
+  "all(.[]; .technology == \"ALL\") and length > 0" \
+  "Adoption defaults (technology=ALL)"
+
+# Test adoption specific technology
+test_filter "/v1/adoption" "?technology=WordPress" \
+  "all(.[]; .technology == \"WordPress\") and length > 0" \
+  "Adoption specific technology (WordPress)"
+
+# Test adoption specific geo and rank (verifying it returns data)
+test_filter "/v1/adoption" "?technology=WordPress&geo=Mexico&rank=Top%201M" \
+  "all(.[]; .technology == \"WordPress\") and length > 0" \
+  "Adoption specific geo and rank (returns WordPress data)"
+
+# Test CWV defaults (tech=ALL)
+test_filter "/v1/cwv" "" \
+  "all(.[]; .technology == \"ALL\") and length > 0" \
+  "CWV defaults (technology=ALL)"
+
+# Test technologies default
+test_filter "/v1/technologies" "" \
+  "length > 0" \
+  "Technologies list is not empty"
+
+# Test categories default
+test_filter "/v1/categories" "" \
+  "length > 0" \
+  "Categories list is not empty"
+
+echo "API tests complete! All endpoints returned 200 and data corresponds to filters."