Merge pull request #76 from open-template-hub/develop

Release/system info endpoint

Author: Furkan Yavuz

.github/workflows/cron-system-info-updater-workflow.yml

@@ -0,0 +1,14 @@
+name: Cron System Info Updater Workflow
+
+on:
+  schedule:
+    - cron: '0 5 * * *'
+
+jobs:
+  cron-system-info-updater:
+    name: 'Cron System Info Updater'
+    runs-on: ubuntu-latest
+    steps:
+      - name: Run System Info Updater Endpoint
+        run: |
+          curl -H "Origin: https://opentemplatehub.com" -H "Authorization: Bearer ${{ secrets.ADMIN_AUTH_TOKEN }}" https://oth-server-orchestra-live.herokuapp.com/analytics/system-info/update?key=npm-downloads

app/controller/system-info.controller.ts

@@ -5,6 +5,7 @@
 import { Context } from '@open-template-hub/common';
 import { Environment } from '../../environment';
 import { SystemInfoRepository } from '../repository/system-info.repository';
+import axios from 'axios';
 
 export class SystemInfoController {
 
@@ -14,11 +15,40 @@ export class SystemInfoController {
     this.environment = new Environment();
   }
 
-  getNpmDownloads = async ( context: Context, key: any ) => {
+  getSystemInfo = async ( context: Context, key: any ) => {
     const systemInfoRepository = await new SystemInfoRepository().initialize(
         context.mongodb_provider.getConnection()
     );
 
-    return systemInfoRepository.getNpmDownloads( key );
+    return systemInfoRepository.getSystemInfo( key );
   };
+
+  updateSystemInfo = async ( context: Context, key: any ) => {
+    const systemInfoRepository = await new SystemInfoRepository().initialize(
+        context.mongodb_provider.getConnection()
+    );
+
+    if ( key === 'npm-downloads' ) {
+      const count = await this.getNpmPackagesDownloadCount();
+      return systemInfoRepository.incrementSystemInfo( key, count );
+    }
+  };
+
+  getNpmPackagesDownloadCount = async () => {
+    let count = 0;
+
+    for ( const npmPackage of this.NPM_PACKAGES ) {
+      const url = `https://api.npmjs.org/downloads/point/last-day/@open-template-hub/${ npmPackage }`;
+      console.info( url );
+
+      const response = await axios.get<any>( url );
+      count += response.data.downloads;
+    }
+
+    return count;
+  };
+
+  NPM_PACKAGES: string[] = [
+    'server-generator', 'app-generator', 'animated-code-editor', 'led', 'card', 'button', 'hero', 'ui-library-template', 'common'
+  ];
 }

app/repository/event-config.repository.ts

@@ -36,8 +36,8 @@ export class EventConfigRepository {
         }
       ] );
 
-      let newMessagesArray: string[] = [];
       for ( const element of dataModel ) {
+        let newMessagesArray: string[] = [];
         if ( element.messages?.length > 1 ) {
           for ( let message of element.messages ) {
             if ( message.language === language ) {

app/repository/event.repository.ts

@@ -41,7 +41,7 @@ export class EventRepository {
     try {
       let queryResult = await this.dataModel.aggregate([
         { $match: query },
-        { $sort: { timestamp: -1 } },
+        { $sort: { timestamp: -1 } },
         { $facet: {
           data: [
             { $match: { } },
@@ -50,7 +50,7 @@ export class EventRepository {
           ],
           meta: [
             { $count: "count" },
-            { $addFields: {
+            { $addFields: {
               skip: skip,
               limit: limit
             }}
@@ -66,7 +66,7 @@ export class EventRepository {
         }
 
         return queryResult
-      } 
+      }
       return { }
     } catch ( error ) {
       console.error( '> filterEvents error: ', error );

app/repository/system-info.repository.ts

@@ -13,11 +13,29 @@ export class SystemInfoRepository {
     return this;
   };
 
-  getNpmDownloads = async ( key: any ) => {
+  getSystemInfo = async ( key: any ) => {
     try {
       return await this.dataModel.findOne( { key } );
     } catch ( error ) {
-      console.error( '> getNpmDownloads error: ', error );
+      console.error( '> getSystemInfo error: ', error );
+      throw error;
+    }
+  };
+
+  updateSystemInfo = async ( key: any, value: any ) => {
+    try {
+      return await this.dataModel.findOneAndUpdate( { key }, { value } );
+    } catch ( error ) {
+      console.error( '> updateSystemInfo error: ', error );
+      throw error;
+    }
+  };
+
+  incrementSystemInfo = async ( key: any, incrementBy: any ) => {
+    try {
+      return await this.dataModel.findOneAndUpdate( { key }, { $inc: { value: incrementBy } } );
+    } catch ( error ) {
+      console.error( '> incrementSystemInfo error: ', error );
       throw error;
     }
   };

app/route/system-info.route.ts

@@ -3,14 +3,16 @@
  */
 
 import {
-  ResponseCode,
+  authorizedBy,
+  ResponseCode, UserRole,
 } from '@open-template-hub/common';
 import { Request, Response } from 'express';
 import Router from 'express-promise-router';
 import { SystemInfoController } from '../controller/system-info.controller';
 
 const subRoutes = {
   root: '/',
+  update: '/update'
 };
 
 export const router = Router();
@@ -19,7 +21,17 @@ router.get(
     subRoutes.root,
     async ( req: Request, res: Response ) => {
       const systemInfoController = new SystemInfoController();
-      let response = await systemInfoController.getNpmDownloads( res.locals.ctx, req.query.key );
+      let response = await systemInfoController.getSystemInfo( res.locals.ctx, req.query.key );
+      res.status( ResponseCode.OK ).json( response.value );
+    }
+);
+
+router.get(
+    subRoutes.update,
+    authorizedBy( [ UserRole.ADMIN ] ),
+    async ( req: Request, res: Response ) => {
+      const systemInfoController = new SystemInfoController();
+      let response = await systemInfoController.updateSystemInfo( res.locals.ctx, req.query.key );
       res.status( ResponseCode.OK ).json( response.value );
     }
 );

assets/requests/system-info-requests.rest

@@ -1,3 +1,8 @@
 ### Get System Info
 GET http://localhost:4005/system-info?key=npm-downloads
 Content-Type: application/json
+
+### Update System Info
+GET http://localhost:4005/system-info/update?key=npm-downloads
+Content-Type: application/json
+Authorization: Bearer token

docs/OUTDATED.md

@@ -13,6 +13,9 @@ Open Template Hub - Analytics Server Template v4
 
 Following packages are not updated in the develop branch yet. So, if you want to update outdated packages on your own risk, update the package.json and install dependencies.
 
+| Package | Current | Wanted | Latest | Location |
+| --- | --- | --- | --- | --- |
+| axios | 0.27.2 | 0.27.2 | 1.1.3 | node_modules/axios |
 
 <table align="right"><tr><td><a href="https://opentemplatehub.com"><img src="https://raw.githubusercontent.com/open-template-hub/open-template-hub.github.io/master/assets/logo/brand-logo.png" width="50px" alt="oth"/></a></td><td><b>Open Template Hub © 2021</b></td></tr></table>
 

package.json

@@ -14,6 +14,7 @@
     "@types/cors": "^2.8.12",
     "@types/express": "^4.17.13",
     "@types/mongoose": "^5.11.97",
+    "axios": "^0.27.2",
     "body-parser": "^1.20.0",
     "cors": "^2.8.5",
     "dotenv": "^16.0.1",