nodejs alt

Author: max-ostapenko

.github/workflows/pipeline.yaml

@@ -44,20 +44,20 @@ jobs:
           credentials_json: ${{ env.PIPELINE_SA_KEY }}
 
       - uses: hashicorp/setup-terraform@v3
-      
+
       - name: Terraform fmt
         id: fmt
         run: terraform fmt -check
         continue-on-error: true
-      
+
       - name: Terraform Init
         id: init
         run: terraform init
-      
+
       - name: Terraform Validate
         id: validate
         run: terraform validate -no-color
-      
+
       - name: Terraform Plan
         id: plan
         run: |
@@ -77,7 +77,7 @@ jobs:
                           -var="google_service_account_api_gateway=${{ env.PIPELINE_GOOGLE_SERVICE_ACCOUNT_API_GATEWAY }}" \
                           -var="project_database=${{ env.PIPELINE_PROJECT_DATABASE_DEV }}" \
                           -auto-approve
-        
+
   deploy_production:
     if: github.ref == 'refs/heads/main'
     runs-on: ubuntu-latest
@@ -94,20 +94,20 @@ jobs:
           credentials_json: ${{ env.PIPELINE_SA_KEY }}
 
       - uses: hashicorp/setup-terraform@v3
-      
+
       - name: Terraform fmt
         id: fmt
         run: terraform fmt -check
         continue-on-error: true
-      
+
       - name: Terraform Init
         id: init
         run: terraform init
-      
+
       - name: Terraform Validate
         id: validate
         run: terraform validate -no-color
-      
+
       - name: Terraform Plan
         id: plan
         run: |
@@ -127,5 +127,4 @@ jobs:
                           -var="google_service_account_api_gateway=${{ env.PIPELINE_GOOGLE_SERVICE_ACCOUNT_API_GATEWAY }}" \
                           -var="project_database=${{ env.PIPELINE_PROJECT_DATABASE_PROD }}" \
                           -auto-approve
-                                
-                        
+

.gitignore

@@ -34,3 +34,5 @@ __pycache__
 
 utils.txt
 logs
+
+node_modules/

README_node.md

@@ -0,0 +1,141 @@
+# Technology Reports API (Node.js)
+
+This is a unified Google Cloud Run function that provides technology metrics and information via various endpoints.
+
+## Setup
+
+### Prerequisites
+
+- Node.js 18+
+- npm
+- Google Cloud account with necessary permissions
+
+### Local Development
+
+1. Install dependencies:
+```bash
+npm install
+```
+
+2. Set environment variables:
+```bash
+export PROJECT=your-gcp-project-id
+export DATABASE=your-firestore-database
+```
+
+3. Run the application locally:
+```bash
+npm start
+```
+
+The API will be available at http://localhost:8080
+
+## Deployment
+
+### Using Google Cloud Build
+
+```bash
+gcloud builds submit --tag gcr.io/PROJECT_ID/tech-report-api
+gcloud run deploy tech-report-api --image gcr.io/PROJECT_ID/tech-report-api --platform managed
+```
+
+## API Endpoints
+
+### `GET /technologies`
+
+Lists available technologies with optional filtering.
+
+#### Parameters
+
+- `technology` (optional): Filter by technology name(s) - comma-separated list
+- `category` (optional): Filter by category - comma-separated list
+- `onlyname` (optional): If present, returns only technology names
+
+### `GET /categories`
+
+Lists available categories.
+
+#### Parameters
+
+- `category` (optional): Filter by category name(s) - comma-separated list
+- `onlyname` (optional): If present, returns only category names
+
+### `GET /adoption`
+
+Provides technology adoption data.
+
+#### Parameters
+
+- `technology` (required): Filter by technology name(s) - comma-separated list
+- `start` (optional): Filter by date range start (YYYY-MM-DD or 'latest')
+- `end` (optional): Filter by date range end (YYYY-MM-DD)
+- `geo` (optional): Filter by geographic location
+- `rank` (optional): Filter by rank
+
+### `GET /cwvtech` (Core Web Vitals)
+
+Provides Core Web Vitals metrics for technologies.
+
+#### Parameters
+
+- `technology` (required): Filter by technology name(s) - comma-separated list
+- `geo` (required): Filter by geographic location
+- `rank` (required): Filter by rank
+- `start` (optional): Filter by date range start (YYYY-MM-DD or 'latest')
+- `end` (optional): Filter by date range end (YYYY-MM-DD)
+
+### `GET /lighthouse`
+
+Provides Lighthouse scores for technologies.
+
+#### Parameters
+
+- `technology` (required): Filter by technology name(s) - comma-separated list
+- `geo` (required): Filter by geographic location
+- `rank` (required): Filter by rank
+- `start` (optional): Filter by date range start (YYYY-MM-DD or 'latest')
+- `end` (optional): Filter by date range end (YYYY-MM-DD)
+
+### `GET /page-weight`
+
+Provides Page Weight metrics for technologies.
+
+#### Parameters
+
+- `technology` (required): Filter by technology name(s) - comma-separated list
+- `geo` (optional): Filter by geographic location
+- `rank` (optional): Filter by rank
+- `start` (optional): Filter by date range start (YYYY-MM-DD or 'latest')
+- `end` (optional): Filter by date range end (YYYY-MM-DD)
+
+### `GET /ranks`
+
+Lists all available ranks.
+
+### `GET /geos`
+
+Lists all available geographic locations.
+
+## Response Format
+
+All API responses follow this format:
+
+```json
+{
+  "success": true,
+  "result": [
+    // Array of data objects
+  ]
+}
+```
+
+Or in case of an error:
+
+```json
+{
+  "success": false,
+  "errors": [
+    {"key": "error message"}
+  ]
+}
+```

src/Dockerfile

@@ -0,0 +1,22 @@
+FROM node:24-slim
+
+WORKDIR /app
+
+# Copy package.json and package-lock.json
+COPY package*.json ./
+
+# Install dependencies
+RUN npm ci --only=production
+
+# Copy the rest of the application
+COPY . .
+
+# Set environment variables
+ENV PROJECT=httparchive
+ENV DATABASE=tech-report-apis-prod
+
+# Expose the port the app runs on
+EXPOSE 8080
+
+# Start the application
+CMD [ "npm", "start" ]

src/__tests__/routes.test.js

@@ -0,0 +1,70 @@
+const request = require('supertest');
+const app = require('../src/src/index');
+
+// Mock Firestore
+jest.mock('../src/utils/db', () => {
+  return {
+    collection: jest.fn().mockReturnThis(),
+    where: jest.fn().mockReturnThis(),
+    orderBy: jest.fn().mockReturnThis(),
+    limit: jest.fn().mockReturnThis(),
+    get: jest.fn().mockResolvedValue({
+      empty: false,
+      forEach: (callback) => {
+        callback({
+          data: () => ({
+            technology: 'Test Technology',
+            category: 'Test Category',
+            description: 'Test Description',
+            icon: 'test-icon.svg',
+            origins: 1000
+          }),
+          get: (field) => 'Test Value'
+        });
+      },
+      docs: [{
+        data: () => ({
+          technology: 'Test Technology',
+          category: 'Test Category',
+          description: 'Test Description',
+          icon: 'test-icon.svg',
+          origins: 1000,
+          date: '2023-01-01'
+        })
+      }]
+    })
+  };
+});
+
+describe('API Routes', () => {
+  describe('GET /', () => {
+    it('should return a health check response', async () => {
+      const res = await request(app).get('/');
+      expect(res.statusCode).toEqual(200);
+      expect(res.body).toHaveProperty('status', 'ok');
+    });
+  });
+
+  describe('GET /technologies', () => {
+    it('should return technologies', async () => {
+      const res = await request(app).get('/technologies');
+      expect(res.statusCode).toEqual(200);
+      expect(res.body).toHaveProperty('success', true);
+      expect(res.body).toHaveProperty('result');
+      expect(Array.isArray(res.body.result)).toBe(true);
+    });
+
+    it('should filter technologies by name', async () => {
+      const res = await request(app).get('/technologies?technology=Test');
+      expect(res.statusCode).toEqual(200);
+      expect(res.body).toHaveProperty('success', true);
+    });
+
+    it('should return only names when onlyname parameter is provided', async () => {
+      const res = await request(app).get('/technologies?onlyname=true');
+      expect(res.statusCode).toEqual(200);
+      expect(res.body).toHaveProperty('success', true);
+    });
+  });
+
+});

src/controllers/adoptionController.js

@@ -0,0 +1,82 @@
+const firestore = require('../utils/db');
+const { convertToArray, createSuccessResponse, createErrorResponse } = require('../utils/helpers');
+
+const TABLE = 'adoption';
+
+/**
+ * Get the latest date in the collection
+ */
+const getLatestDate = async () => {
+  const query = firestore.collection(TABLE).orderBy('date', 'desc').limit(1);
+  const snapshot = await query.get();
+  if (!snapshot.empty) {
+    return snapshot.docs[0].data().date;
+  }
+  return null;
+};
+
+/**
+ * List adoption data with filtering
+ */
+const listAdoptionData = async (req, res) => {
+  try {
+    const params = req.query;
+    const data = [];
+
+    // Technology is required
+    if (!params.technology) {
+      return res.status(400).send(createErrorResponse([
+        ['technology', 'missing technology parameter']
+      ]));
+    }
+
+    // Convert technology parameter to array
+    const techArray = convertToArray(params.technology);
+    
+    // Handle 'latest' special value for start parameter
+    if (params.start && params.start === 'latest') {
+      params.start = await getLatestDate();
+    }
+
+    // Query for each technology
+    for (const technology of techArray) {
+      let query = firestore.collection(TABLE);
+
+      // Apply filters
+      if (params.start) {
+        query = query.where('date', '>=', params.start);
+      }
+      
+      if (params.end) {
+        query = query.where('date', '<=', params.end);
+      }
+      
+      if (params.geo) {
+        query = query.where('geo', '==', params.geo);
+      }
+      
+      if (params.rank) {
+        query = query.where('rank', '==', params.rank);
+      }
+      
+      // Always filter by technology
+      query = query.where('technology', '==', technology);
+
+      // Execute query
+      const snapshot = await query.get();
+      snapshot.forEach(doc => {
+        data.push(doc.data());
+      });
+    }
+
+    // Send response
+    res.status(200).send(createSuccessResponse(data));
+  } catch (error) {
+    console.error('Error fetching adoption data:', error);
+    res.status(400).send(createErrorResponse([['query', error.message]]));
+  }
+};
+
+module.exports = {
+  listAdoptionData
+};