Merge pull request #44 from amosproj/first-test-with-analysis-module

First test with analysis module

Author: heskil

apps/analyzer/main.py

@@ -0,0 +1,4 @@
+from metadata_analyzer.main import main
+
+if __name__ == "__main__":
+    main()

apps/analyzer/metadata_analyzer/database.py

@@ -0,0 +1,20 @@
+import pg8000.dbapi
+from sqlalchemy import create_engine, select
+from sqlalchemy.orm import Session
+from metadata_analyzer.models import BackupData
+import os
+
+
+class Database:
+    def __init__(self):
+        self.engine = create_engine("postgresql+pg8000://postgres:postgres@localhost:5432/postgres")
+        
+
+def get_data(self):
+    session = Session(self.engine)
+    stmt = select(BackupData)
+
+    result = session.scalars(stmt)
+    return result
+
+

apps/analyzer/metadata_analyzer/main.py

@@ -1,10 +1,11 @@
-from flask import Flask, request
+from flask import Flask, request, jsonify
 from dotenv import load_dotenv
+from metadata_analyzer.database import Database, get_data
+from metadata_analyzer.simple_analyzer import SimpleAnalyzer
 import os
 
 app = Flask(__name__)
 
-
 @app.route("/")
 def hello_world():
     return "Hello, world!"
@@ -24,8 +25,19 @@ def echo():
         newBody = '{ "output": "' + newData + '" }'
         return newBody
 
+@app.route("/analyze", methods=["GET"])
+def analyze():
+    data = list(get_data(database))
+    result = simple_analyzer.analyze(data)
+
+    return jsonify(result)
+
+def main():
+    global database
+    global simple_analyzer
+    database = Database()
+    simple_analyzer = SimpleAnalyzer()
 
-if __name__ == "__main__":
     new_port = os.getenv("FLASK_RUN_PORT")
     int_port = int(new_port or 5000)
     print("int_port: " + str(int_port))

apps/analyzer/metadata_analyzer/models.py

@@ -0,0 +1,19 @@
+from sqlalchemy.orm import mapped_column, Mapped
+from sqlalchemy.ext.declarative import declarative_base
+from datetime import datetime
+
+Base = declarative_base()
+
+class BackupData(Base):
+    __tablename__ = "BackupData"
+
+    id: Mapped[str] = mapped_column(primary_key=True)
+    sizeMB: Mapped[int]
+    creationDate: Mapped[datetime]
+    bio: Mapped[str]
+
+    def __repr__(self):
+        return f"""BackupData(id={self.id}, sizeMB={self.sizeMB}, creationDate={self.creationDate}, bio={self.bio!r})"""
+
+    def __str__(self):
+        return repr(self)

apps/analyzer/metadata_analyzer/simple_analyzer.py

@@ -0,0 +1,15 @@
+class SimpleAnalyzer:
+    def __init__(self):
+        pass
+
+    def analyze(self, data):
+        count = len(data)
+        dates = list(map(lambda backup_data: backup_data.creationDate, data))
+        sizes = list(map(lambda backup_data: backup_data.sizeMB, data))
+        return {
+            "count": count,
+            "firstBackup": min(dates),
+            "lastBackup": max(dates),
+            "minSize": min(sizes),
+            "maxSize": max(sizes),
+        }

apps/analyzer/poetry.lock

@@ -14,7 +14,7 @@
     "serve": {
       "executor": "@nxlv/python:run-commands",
       "options": {
-        "command": "./.venv/bin/python3.11 ./metadata_analyzer/main.py",
+        "command": "./.venv/bin/python3.11 ./main.py",
         "cwd": "apps/analyzer"
       }
     },

apps/analyzer/project.json

@@ -24,6 +24,8 @@ readme = 'README.md'
   python = ">=3.9,<3.12"
   flask = "^3.0.3"
   python-dotenv = "^1.0.1"
+  sqlalchemy = "^2.0.36"
+  pg8000 = "^1.31.2"
 
   [tool.poetry.group.dev.dependencies]
   autopep8 = "2.0.2"

apps/analyzer/pyproject.toml

@@ -1,10 +1,12 @@
 import { HttpModule } from '@nestjs/axios';
 import { Module } from '@nestjs/common';
 import { AnalyzerServiceService } from './analyzer-service.service';
+import { AnalyzerController } from './analyzer.controller';
 
 @Module({
   providers: [AnalyzerServiceService],
   imports: [HttpModule],
+  controllers: [AnalyzerController],
   exports: [AnalyzerServiceService],
 })
-export class AnalyzerServiceModule {}
+export class AnalyzerServiceModule {}

apps/backend/src/app/analyzerService/analyzer-service.module.ts

@@ -1,7 +1,7 @@
 import { Inject, Injectable, Logger } from '@nestjs/common';
 import { ConfigService } from '@nestjs/config';
 import { HttpService } from '@nestjs/axios';
-import { map, Observable } from 'rxjs';
+import { firstValueFrom, map, Observable } from 'rxjs';
 
 /**
  * Service to connect to the Analyzer service.
@@ -23,12 +23,39 @@ export class AnalyzerServiceService {
    * @param text The text to echo.
    * @returns The echoed text.
    */
-  echo(text: string): Observable<string> {
+  sendEcho(text: string): Observable<string> {
     this.logger.debug(`Sending echo request to Analyzer service`);
     return this.httpService
       .post<string>(`${this.analyzerServiceUrl}/echo`, {
         body: { text },
       })
       .pipe(map((response) => response.data));
   }
+
+  /**
+   * Echo the given text.
+   * @param text
+   */
+  async echo(text: string): Promise<string> {
+    return await firstValueFrom(this.sendEcho(text));
+  }
+
+  /**
+   * Gets the first entry of a dummy dataset in the database using the Analyzer service. (Used for Demo purposes)
+   *
+   * @returns The first entry.
+   */
+  getAnalyzerDemo(): Observable<string> {
+    this.logger.debug(`Sending demo analyzer request to Analyzer service`);
+    return this.httpService
+      .get(`${this.analyzerServiceUrl}/analyze`)
+      .pipe(map((response) => response.data));
+  }
+
+  /**
+   * Return the "analyzed" data.
+   */
+  async analyzerDemo(): Promise<string> {
+    return await firstValueFrom(this.getAnalyzerDemo());
+  }
 }

apps/backend/src/app/analyzerService/analyzer-service.service.ts

@@ -0,0 +1,29 @@
+import {
+    Controller,
+    Get,
+    Logger,
+    Param,
+  } from '@nestjs/common';
+  import { ApiOkResponse, ApiOperation } from '@nestjs/swagger';
+  import { AnalyzerServiceService } from './analyzer-service.service';
+  
+  @Controller('analyzer')
+  export class AnalyzerController {
+    readonly logger = new Logger(AnalyzerController.name);
+  
+    constructor(private readonly analyzerServiceService: AnalyzerServiceService) {}
+  
+    @Get('echo/:text')
+    @ApiOperation({ summary: 'Echo the given text.' })
+    @ApiOkResponse({ type: String })
+    async echo(@Param('text') text: string): Promise<string> {
+      return await this.analyzerServiceService.echo(text);
+    }
+  
+    @Get('analyzerDemo/')
+    @ApiOperation({ summary: 'Demos getting analyzed data from analyzer using the database.' })
+    @ApiOkResponse({ type: String })
+    async analyzerDemo(): Promise<string> {
+      return this.analyzerServiceService.analyzerDemo();
+    }
+  }

apps/backend/src/app/analyzerService/analyzer.controller.ts

@@ -35,10 +35,4 @@ export class DemoController {
     return await this.demoService.createEntry(createEntryDto.text);
   }
 
-  @Get('echo/:text')
-  @ApiOperation({ summary: 'Echo the given text.' })
-  @ApiOkResponse({ type: String })
-  async echo(@Param('text') text: string): Promise<string> {
-    return await this.demoService.echo(text);
-  }
 }

apps/backend/src/app/demo/demo.controller.ts

@@ -31,11 +31,4 @@ export class DemoService {
     return this.demoRepository.save(entry);
   }
 
-  /**
-   * Echo the given text.
-   * @param text
-   */
-  async echo(text: string): Promise<string> {
-    return await firstValueFrom(this.analyzerService.echo(text));
-  }
 }