Merge branch 'main' into tech-sort-and-versions

Author: max-ostapenko

.github/workflows/dependabot.yml

@@ -11,7 +11,7 @@ jobs:
     if: github.event.pull_request.user.login == 'dependabot[bot]' && github.repository == 'HTTPArchive/tech-report-apis'
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v5
+      - uses: actions/checkout@v6
       - run: |
           cd src
           npm ci

.github/workflows/deployment.yaml

@@ -13,7 +13,7 @@ jobs:
   test:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v5
+      - uses: actions/checkout@v6
       - run: |
           cd src
           npm ci
@@ -27,9 +27,9 @@ jobs:
       run:
         working-directory: ./terraform/dev
     steps:
-      - uses: actions/checkout@v5
+      - uses: actions/checkout@v6
       - name: Google Cloud Auth
-        uses: 'google-github-actions/auth@v2'
+        uses: 'google-github-actions/auth@v3'
         with:
           project_id: 'httparchive'
           credentials_json: ${{ env.PIPELINE_SA_KEY }}
@@ -72,9 +72,9 @@ jobs:
       run:
         working-directory: ./terraform/prod
     steps:
-      - uses: actions/checkout@v5
+      - uses: actions/checkout@v6
       - name: Google Cloud Auth
-        uses: 'google-github-actions/auth@v2'
+        uses: 'google-github-actions/auth@v3'
         with:
           project_id: 'httparchive'
           credentials_json: ${{ env.PIPELINE_SA_KEY }}

README.md

@@ -6,7 +6,7 @@ This is an HTTP Archive Reporting API that provides reporting data via various e
 
 ### Prerequisites
 
-- Node.js 18+
+- Node.js 22+
 - npm
 - Google Cloud account with necessary permissions
 - Set environment variables:
@@ -22,15 +22,14 @@ This is an HTTP Archive Reporting API that provides reporting data via various e
   npm run start
   ```
 
-The API will be available at <http://localhost:3000>
+The API will be available at <http://localhost:8080>
 
 ## API Endpoints
 
 - **CORS Enabled**: Cross-origin requests are supported
 - **Cache Headers**: 6-hour cache control for static data
 - **Health Check**: GET `/` returns health status
 - **RESTful API**: All endpoints follow REST conventions
-- **Backend caching**: Some responses are cached on the backend for 1 hours to improve latency
 
 ### `GET /`
 
@@ -501,51 +500,49 @@ Returns a JSON object with the following schema:
 ]
 ```
 
-### `GET /cache-stats`
+### `GET /static/*`
 
-Provides statistics about the API's cache.
+Proxy endpoint to serve files from the private Google Cloud Storage bucket. The request path after `/v1/static/` maps directly to the GCS object path.
 
-```bash
-curl --request GET \
-  --url 'https://{{HOST}}/v1/cache-stats'
-```
+#### Static File Features
 
-Returns a JSON object with the following schema:
+- **Conditional Requests**: Supports `If-None-Match` header for cache validation (returns 304 if unchanged)
+- **Content Type Detection**: Automatically detects MIME type based on file extension
+- **Streaming**: Files are streamed directly from GCS for efficient memory usage
+- **ETag Support**: Returns ETag header for cache validation
 
-```json
-{
-    "cache_hits": 12345,
-    "cache_misses": 6789,
-    "last_cleared": "2023-10-01T12:00:00Z"
-}
-```
+#### Supported File Types
 
-### `POST /v1/cache-reset`
+| Extension | MIME Type |
+|-----------|-----------|
+| `.json` | `application/json` |
+| `.js` | `application/javascript` |
+| `.png` | `image/png` |
+| `.svg` | `image/svg+xml` |
+| `.csv` | `text/csv` |
+| `.pdf` | `application/pdf` |
 
-Resets all caches in the API. This endpoint requires a POST request.
+#### Static File Response
 
 ```bash
-curl --request POST \
-  --url 'https://{{HOST}}/v1/cache-reset'
+curl --request GET \
+  --url 'https://{{HOST}}/v1/static/reports/2023/example.json'
 ```
 
-Returns a JSON object with the following schema:
+Returns the file content with appropriate headers:
 
-```json
-{
-    "success": true,
-    "message": "All caches have been reset",
-    "before": {
-        "queryCache": 150,
-        "dateCache": 12
-    },
-    "after": {
-        "queryCache": 0,
-        "dateCache": 0
-    }
-}
+```http
+Content-Type: application/json
+ETag: "abc123..."
+Content-Length: 1234
 ```
 
+#### Error Responses
+
+- **400 Bad Request**: Invalid file path (e.g., contains `..` or `//`)
+- **404 Not Found**: File does not exist in the bucket
+- **500 Internal Server Error**: Failed to retrieve or stream the file
+
 ## Testing
 
 ```bash
@@ -667,34 +664,4 @@ Response:
 }
 ```
 
-## Cache Stats Private Endpoint
-
-The Cache Stats private endpoint provides information about the API's cache performance, including cache hits, misses, and the last time the cache was cleared. This endpoint is useful for monitoring and debugging cache behavior.
-
-```bash
-curl "https://tech-report-api-dev-226352634162.us-central1.run.app/v1/cache-stats" \
-  -H "Authorization: bearer $(gcloud auth print-identity-token)"
-```
-
-Returns a JSON object with the following schema:
 
-```json
-{
-    "queryCache": {
-        "total": 3220,
-        "valid": 2437,
-        "expired": 783,
-        "ttl": 3600000
-    },
-    "dateCache": {
-        "total": 4,
-        "valid": 4,
-        "expired": 0,
-        "ttl": 3600000
-    },
-    "config": {
-        "maxCacheSize": 5000,
-        "cleanupStrategy": "size-based-lru"
-    }
-}
-```

src/.dockerignore

@@ -1,12 +1,11 @@
-node_modules
+node_modules/
 npm-debug.log
 .git
 .gitignore
 .env
 .nyc_output
-coverage
 *.md
 .DS_Store
 cloudbuild.yaml
-__tests__
-coverage
+__tests__/
+coverage/

src/Dockerfile

@@ -9,9 +9,11 @@ COPY package*.json ./
 # Install dependencies (this layer will be cached unless package files change)
 RUN npm ci --only=production --quiet --no-fund --no-audit && npm cache clean --force
 
-ENV DATABASE=tech-report-api-prod
-
 # Copy source code
 COPY . .
 
-CMD ["node", "index.js"]
+# Cloud Run expects the container to listen on PORT (default 8080)
+ENV PORT=8080
+
+# Use Functions Framework to serve the app
+CMD ["npx", "functions-framework", "--target=app"]