fix: GeoIP Interceptor + Test Cases

.github/workflows/codeql.yml

@@ -0,0 +1,59 @@
+name: "CodeQL"
+
+on:
+  push:
+    branches: [ "main", "master" ]
+  pull_request:
+    branches: [ "main", "master" ]
+
+jobs:
+  analyze:
+    name: Analyze
+    runs-on: ubuntu-latest
+    permissions:
+      actions: read
+      contents: read
+      security-events: write
+
+    steps:
+    - name: Checkout repository
+      uses: actions/checkout@v3
+
+    - name: Find languages
+      id: findLanguages
+      run: |
+        countTS=$(find ./ -type f -name '*.ts' | wc -l)
+        countJS=$(find ./ -type f -name '*.js' | wc -l)
+        countPY=$(find ./ -type f -name '*.py' | wc -l)
+        countCPP=$(find ./ -type f -name '*.cpp' | wc -l)
+        countJAVA=$(find ./ -type f -name '*.java' | wc -l)
+        languages=""
+        if [ $countTS -gt 0 ]; then
+            languages+="typescript,"
+        fi
+        if [ $countJS -gt 0 ]; then
+            languages+="javascript,"
+        fi
+        if [ $countPY -gt 0 ]; then
+            languages+="python,"
+        fi
+        if [ $countCPP -gt 0 ]; then
+            languages+="cpp,"
+        fi
+        if [ $countJAVA -gt 0 ]; then
+            languages+="java,"
+        fi
+        # Remove the trailing comma
+        languages=${languages%,}
+        echo "languages=$languages" >> $GITHUB_ENV
+
+    - name: Initialize CodeQL
+      uses: github/codeql-action/init@v2
+      with:
+        languages: ${{ env.languages }}
+
+    - name: Autobuild
+      uses: github/codeql-action/autobuild@v2
+
+    - name: Perform CodeQL Analysis
+      uses: github/codeql-action/analyze@v2

README.md

@@ -1,44 +1,30 @@
 # Stencil
 
-Stencil is an opinionated backend framework based on [NestJS](https://nestjs.com) with a lot of required tooling setup right out of the box or possible to setup with just one CLI command so that you can dive directly into writing business logic.
+Stencil is an opinionated backend framework based on [NestJS](https://nestjs.com), built keeping Developer Experience and Developer Productivity in mind. 
+Stencil aims to reduce the development setup times so that the developers writing backend services can spend more time writing business logic unique to the service rather than setting up common tooling which is shared across projects. 
 
-## Supported Tooling
-
-- [Prisma ORM](https://prisma.io)
-  - Don't deal with the hassle of setting up a prisma instance, start writing schemas directly.
-- [User-Service](https://github.com/Samagra-Development/user-service)
-  - User Management is just as simple as calling a decorator over your API Controller.
-- [Monitoring](https://github.com/ChakshuGautam/nestjs-monitor)
-  - Get Prometheus and Grafana dashboards setup right out of the box with beautifully a programatically generated dashboard monitoring your API response times.
-- [Temporal](https://temporal.io)
-  - Focus on implementing the activity and workflow we have got the setup covered.
-- [Response formatting]
-  - Enfore response format standards throughout the app with a single interceptor
-- [File Uploads]
-  - Require handling file uploads and downloads via your service? Get a service setup right out of the box.
-
-**If you have request for a specific tool to be setup automatically, please open a issue ticket and we'll try to get it added at the earliest.**
 
 ## Getting started
 
-### Installation
+### Usage
 
-1. Install the stencil-cli
+1. Install the stencil-cli globally on your system
 ```bash
 npm i -g @samagra-x/stencil-cli
 ```
 
-2. To scaffold a new project run this:
+2. Bootstrap a new project using:
 ```bash
 stencil new <PROJECT_NAME> 
 ```
-During the setup the CLI help you setup all the toolings you want by letting you pick and choose between what you want to have in your service.
+During the setup the CLI will prompt you to select all the toolings you want by letting you pick and choose between what you want to have in your service.
 
 ### Demo
 
 A demo video depicting how to use stencil-cli can be found [here](https://drive.google.com/file/d/1RaafplnJMlfKgYB-WwyfINREjqoRQSLb/view?usp=sharing)
 
 ## Local Setup
+
 1. Clone the repository locally
 ```bash
 git clone https://github.com/SamagraX-Stencil/stencil
@@ -49,4 +35,23 @@ git clone https://github.com/SamagraX-Stencil/stencil
 yarn 
 ```
 
-3. Navigate to the required directory where you want to hack around and refer directory level READMEs to understand more about the code stored there.
+3. Navigate to the required directory where you want to hack around and refer directory level READMEs to understand more about the code stored there.
+
+## Documentation
+
+You can refer to the technical documentation which lists all the available functionality [here](https://stencil-docs.vercel.app/)
+
+**If you have request for a specific tool to be setup automatically, please open a issue ticket and we'll try to get it added at the earliest.**
+
+## Acknowledgements
+
+- [NestJS](https://nestjs.com/) 
+- [Prisma ORM](https://prisma.io/) 
+- [Postgres](https://www.postgresql.org/) 
+- [FusionAuth](https://fusionauth.io/)
+- [Prometheus](https://prometheus.io/) 
+- [Grafana](https://grafana.com) 
+- [Elastic Search](https://www.elastic.co/)
+- [Logstash](https://www.elastic.co/logstash)
+- [Kibana](https://www.elastic.co/kibana)
+- [Temporal](https://temporal.io)

packages/common/src/interceptors/geoip.interceptor.ts

@@ -0,0 +1,88 @@
+import {
+  Injectable,
+  NestInterceptor,
+  ExecutionContext,
+  CallHandler,
+  Logger,
+  HttpStatus,
+  InternalServerErrorException,
+  HttpException,
+} from '@nestjs/common';
+import { ConfigService } from '@nestjs/config';
+import { Observable } from 'rxjs';
+import { HttpService } from '@nestjs/axios';
+
+@Injectable()
+export class GeoIPInterceptor implements NestInterceptor {
+  private readonly httpService: HttpService;
+  private readonly allowedCountries: string[];
+  private readonly configService: ConfigService;
+  private readonly logger : Logger;
+  private readonly accessDeniedMessage: string;
+  private readonly accessDeniedStatus: number;
+
+  constructor(allowedCountries: string[], accessDeniedStatus: number = HttpStatus.FORBIDDEN) {
+    this.logger = new Logger('GeoIPInterceptor');
+    this.httpService = new HttpService();
+    this.allowedCountries = allowedCountries;
+    this.configService = new ConfigService();
+    this.accessDeniedMessage = 'Access Denied'; 
+    this.accessDeniedStatus = accessDeniedStatus;
+  }
+
+  async intercept(
+    context: ExecutionContext,
+    next: CallHandler,
+  ): Promise<Observable<any>> {
+    const request = context.switchToHttp().getRequest();
+
+    // Log all headers to see what is being received
+    this.logger.log('Request Headers:', request.headers);
+
+    // Extract IP address
+    const clientIp = request.headers['request.ip'] || request.headers['x-forwarded-for'] || request.ip;
+    this.logger.log('Using IP address for geolocation:', clientIp);
+
+    try {
+      // Call the geolocation service to get the country from the IP
+      const { country, regionName } = await this.getLocation(clientIp);
+
+      if (
+        this.allowedCountries.length > 0 &&
+        !this.allowedCountries.includes(country)
+      ) {
+        this.logger.error(
+          'Denying request from IP: ' + clientIp + ' country: ' + country,
+        );
+        throw new HttpException(this.accessDeniedMessage, this.accessDeniedStatus);
+      }
+
+      this.logger.log(
+        'Allowed request from IP: ' + clientIp + ' region: ' + regionName,
+      );
+    } catch (err) {
+      this.logger.error('Error occurred while reading the geoip database', err);
+      throw new InternalServerErrorException(
+        'Error occurred while reading the geoip database',
+      );
+    }
+
+    // Continue handling the request
+    return next.handle();
+  }
+
+  private async getLocation(ip: string): Promise<any> {
+    try {
+      const geoIp = this.configService.get<string>('GEO_IP');
+      const resp = await this.httpService.axiosRef.get(
+        `http://geoip.samagra.io/city/${ip}`
+      );
+      return { country: resp.data.country, regionName: resp.data.regionName };
+    } catch (err) {
+      this.logger.error('Error occurred while reading the geoip database', err);
+      throw new InternalServerErrorException(
+        'Error occurred while reading the geoip database',
+      );
+    }
+  }
+}

packages/common/src/interceptors/index.ts

@@ -2,3 +2,4 @@ export * from './response-time.interceptor';
 export * from './response-format.interceptor';
 export * from './file-upload.interceptor';
 export * from './utils';
+export * from './geoip.interceptor';

sample/06-file-upload/nest-cli.json

@@ -1,6 +1,6 @@
 {
   "$schema": "https://json.schemastore.org/nest-cli",
-  "collection": "@samagra-x/schematics",
+  "collection": "@nestjs/schematics",
   "sourceRoot": "src",
   "compilerOptions": {
     "deleteOutDir": true

sample/06-file-upload/package.json

@@ -24,6 +24,7 @@
     "@nestjs/core": "^10.0.0",
     "@nestjs/platform-express": "^10.0.0",
     "@nestjs/platform-fastify": "^10.3.0",
+    "@samagra-x/stencil": "^0.0.6",
     "@types/multer": "^1.4.11",
     "fastify": "^4.25.2",
     "fastify-multer": "^2.0.3",
@@ -33,9 +34,9 @@
     "rxjs": "^7.8.1"
   },
   "devDependencies": {
-    "@samagra-x/stencil-cli": "^0.0.5",
-    "@samagra-x/schematics": "^0.0.5",
     "@nestjs/testing": "^10.0.0",
+    "@samagra-x/schematics": "^0.0.5",
+    "@samagra-x/stencil-cli": "^0.0.5",
     "@types/express": "^4.17.17",
     "@types/jest": "^29.5.2",
     "@types/node": "^20.3.1",
@@ -45,9 +46,9 @@
     "eslint": "^8.42.0",
     "eslint-config-prettier": "^9.0.0",
     "eslint-plugin-prettier": "^5.0.0",
+    "husky": "^9.0.11",
     "jest": "^29.5.0",
     "prettier": "^3.0.0",
-    "husky": "^9.0.11",
     "source-map-support": "^0.5.21",
     "supertest": "^6.3.3",
     "ts-jest": "^29.1.0",