Merge pull request #38 from project-sunbird/release-8.1.0

Release 8.1.0

Author: pallakartheekreddy

.github/workflows/on_push.yml

@@ -0,0 +1,51 @@
+name: Build and Publish Docker Image
+
+on:
+  push:
+    tags:
+      - '*'
+
+jobs:
+  build-and-push:
+    runs-on: ubuntu-latest
+
+    permissions:
+      contents: read
+      packages: write
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v3
+
+      - name: Log in to GitHub Container Registry
+        uses: docker/login-action@v3
+        with:
+          registry: ghcr.io
+          username: ${{ github.actor }}
+          password: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Get short commit hash
+        id: vars
+        run: echo "commit_hash=$(git rev-parse --short HEAD)" >> $GITHUB_OUTPUT
+
+      - name: Prepare Docker image name and tag
+        run: |
+          REPO_NAME_LOWERCASE=$(echo "${GITHUB_REPOSITORY}" | tr '[:upper:]' '[:lower:]')
+          TAG_NAME=$(echo "${GITHUB_REF_NAME}" | tr '[:upper:]' '[:lower:]')
+          BUILD_TAG="${TAG_NAME}_${{ steps.vars.outputs.commit_hash }}_${GITHUB_RUN_NUMBER}"
+
+          echo "IMAGE_NAME=ghcr.io/${REPO_NAME_LOWERCASE}" >> $GITHUB_ENV
+          echo "IMAGE_TAG=${BUILD_TAG}" >> $GITHUB_ENV
+
+      - name: Build ZIP file with Dockerfile.Build
+        run: |
+          docker build -t telemetry-build -f Dockerfile.Build .       
+          docker run --name telemetry-builder telemetry-build        
+          docker cp telemetry-builder:/opt/telemetry-service.zip ./    
+          docker rm telemetry-builder
+
+      - name: Build Docker image
+        run: docker build -t $IMAGE_NAME:$IMAGE_TAG .
+
+      - name: Push Docker image
+        run: docker push $IMAGE_NAME:$IMAGE_TAG

.github/workflows/pull_request.yml

@@ -0,0 +1,44 @@
+name: PR Check
+
+on:
+  pull_request:
+   branches:
+      - '**'
+   
+jobs:
+  code-quality:
+    name: Run Code Quality Checks
+    runs-on: ubuntu-latest
+
+    steps:
+    - name: Checkout code
+      uses: actions/checkout@v3
+
+    - name: Setup Node.js
+      uses: actions/setup-node@v3
+      with:
+        node-version: '22.15'
+
+    - name: Restore node_modules cache
+      id: cache
+      uses: actions/cache@v3
+      with:
+        path: src/node_modules
+        key: ${{ runner.os }}-node-modules-${{ hashFiles('src/package-lock.json') }}
+        restore-keys: |
+            ${{ runner.os }}-node-modules-
+
+    - name: Install dependencies
+      run: npm ci
+      working-directory: ./src
+
+    - name: Save node_modules cache
+      if: steps.cache.outputs.cache-hit != 'true'
+      uses: actions/cache@v3
+      with:
+        path: src/node_modules
+        key: ${{ runner.os }}-node-modules-${{ hashFiles('src/package-lock.json') }}
+
+    - name: Lint
+      run: npm run lint
+      working-directory: ./src

.gitignore

@@ -1,4 +1,3 @@
-package-lock.json
 node_modules
 .nyc_output
 coverage

Dockerfile

@@ -1,14 +1,13 @@
 FROM node:22.15-slim
 MAINTAINER "Mahesh" "mahesh@ilimi.in"
 RUN useradd -rm -d /home/sunbird -s /bin/bash -g root -G sudo -u 1001 sunbird
-RUN apt-get update
-RUN apt-get install unzip -y \
-    && apt-get install curl -y \
-    && apt-get install ca-certificates openssl -y
+RUN apt-get update \
+ && apt-get install -y unzip curl ca-certificates openssl libsnappy-dev \
+ && rm -rf /var/lib/apt/lists/*
 USER sunbird
 RUN mkdir -p /home/sunbird/telemetry
 WORKDIR /home/sunbird/telemetry
-COPY ./telemetry-service.zip  /home/sunbird/telemetry/
+COPY ./telemetry-service.zip /home/sunbird/telemetry/
 RUN unzip /home/sunbird/telemetry/telemetry-service.zip
 RUN ls -all /home/sunbird/telemetry
 WORKDIR /home/sunbird/telemetry/telemetry/

Dockerfile.Build

@@ -1,7 +1,13 @@
 FROM node:22.15-slim
 MAINTAINER "Mahesh" "mahesh@ilimi.in"
-RUN apt-get update
-RUN apt-get install zip -y
+RUN apt-get update && apt-get install -y \
+    python3 \
+    make \
+    g++ \
+    libsnappy-dev \
+    libsnappy1v5 \
+    zip \
+ && rm -rf /var/lib/apt/lists/*
 RUN mkdir -p /opt/telemetry
 ADD src /opt/telemetry/
 WORKDIR /opt/telemetry/

README.md

@@ -3,3 +3,79 @@
 This is the repository for Sunbird telemetry microservice. It provides APIs for Sunbird telemetry.
 
 The code in this repository is licensed under MIT License unless otherwise noted. Please see the [LICENSE](https://github.com/project-sunbird/sunbird-telemetry-service/blob/master/LICENSE) file for details.
+
+## Development Setup
+
+### Prerequisites
+- Node.js v22.15
+- Kafka 
+
+### Local Development
+To set up the project locally:
+
+1. Fork the repository on GitHub
+
+2. Clone your fork:
+```bash
+git clone https://github.com/your-username/sunbird-telemetry-service.git
+cd sunbird-telemetry-service
+cd src
+```
+
+3. Install dependencies:
+```bash
+npm i
+```
+
+4. Start the service:
+```bash
+npm run start
+```
+
+5. Run Kafka and Zookeeper
+
+### Code Quality
+
+The project maintains code quality through automated checks that run on every pull request:
+
+1. **Linting**
+   - ESLint for code style and quality
+   - Command: `npm run lint`
+
+2. **Dependencies**
+   - Uses `npm ci` for deterministic installations
+   - GitHub Actions cache for faster builds
+
+3. **Code Formatting**
+   - Ensures consistent code formatting
+   - Can be automatically fixed using `npm run lint:fix`
+
+These checks ensure consistent code style and secure dependency management.
+
+## Container Image Publishing
+
+This repository uses GitHub Actions to automatically build and publish Docker container images to GitHub Container Registry (GHCR) whenever a new tag is pushed to the repository.
+
+### Build and Publish Workflow
+
+The workflow is triggered on:
+- creation of any tag
+
+Key features of the workflow:
+1. Automatically builds Docker images
+2. Tags images with a combination of:
+   - The tag name (lowercased)
+   - Short commit hash
+   - GitHub run number
+3. Publishes images to `ghcr.io` using the repository name
+4. Uses GitHub Actions for secure authentication to GHCR
+
+### Image Naming Convention
+The Docker images follow this naming convention:
+- Repository: `ghcr.io/${OWNER_NAME}/${REPO_NAME_LOWERCASE}`
+- Tag: `${TAG_NAME}_${COMMIT_HASH}_${RUN_NUMBER}`
+
+For example, if you push a tag `v1.0.0` on commit `abc123`, the resulting image would be:
+```
+ghcr.io/project-sunbird/sunbird-telemetry-service:v1.0.0_abc123_1
+```

src/.eslintignore

@@ -0,0 +1,6 @@
+/node_modules
+coverage/
+.nyc_output/
+mochawesome-report/
+.audit.json
+telemetry*.log

src/.eslintrc.js

@@ -0,0 +1,17 @@
+module.exports = {
+  env: {
+    node: true,
+    es2021: true
+  },
+  parserOptions: {
+    ecmaVersion: 'latest'
+  },
+  rules: {
+    'no-console': 'warn',
+    'no-debugger': 'error',
+    'no-unused-vars': 'warn',
+    'semi': ['error', 'always'],
+    'quotes': ['error', 'single'],
+    'indent': ['error', 2]
+  }
+};

src/app.js

@@ -10,12 +10,12 @@ const express = require('express'),
 const createAppServer = () => {
   const app = express();
   app.use((req, res, next) => {
-    res.header('Access-Control-Allow-Origin', '*')
-    res.header('Access-Control-Allow-Methods', 'GET,PUT,POST,PATCH,DELETE,OPTIONS')
-    res.header('Access-Control-Allow-Headers', 'Content-Type, Authorization,' + 'cid, user-id, x-auth, Cache-Control, X-Requested-With, datatype, *')
-    if (req.method === 'OPTIONS') res.sendStatus(200)
-    else next()
-  })
+    res.header('Access-Control-Allow-Origin', '*');
+    res.header('Access-Control-Allow-Methods', 'GET,PUT,POST,PATCH,DELETE,OPTIONS');
+    res.header('Access-Control-Allow-Headers', 'Content-Type, Authorization,' + 'cid, user-id, x-auth, Cache-Control, X-Requested-With, datatype, *');
+    if (req.method === 'OPTIONS') res.sendStatus(200);
+    else next();
+  });
   app.use(bodyParser.json({ limit: '5mb' }));
   app.use(logger('dev'));
   app.use(express.json());
@@ -24,7 +24,7 @@ const createAppServer = () => {
   app.use('/', require('./routes'));
   module.exports = app;
   return app;
-}
+};
 
 if (process.env.node_env !== 'test') {
   cluster((worker) => {

src/dispatcher/cassandra-dispatcher.js

@@ -3,37 +3,37 @@ var util = require('util');
 var Cassandra = require('winston-cassandra');
 
 Cassandra.prototype._createSchema = function (callback) {
-    var createQuery = 'CREATE TABLE ' + this.options.table +
+  var createQuery = 'CREATE TABLE ' + this.options.table +
       ' (key text, mid text, date timestamp, level text, message text, meta text, PRIMARY KEY(key, mid));';
-    var self = this;
+  var self = this;
 
-    this.client.metadata.getTable(this.options.keyspace, this.options.table, function (err, tableInfo) {
-      if (err) return callback(err);
-      if (tableInfo) {
-        //table is already created
-        self.schemaStatus.created = true;
-        return callback();
-      }
+  this.client.metadata.getTable(this.options.keyspace, this.options.table, function (err, tableInfo) {
+    if (err) return callback(err);
+    if (tableInfo) {
+      //table is already created
+      self.schemaStatus.created = true;
+      return callback();
+    }
 
-      return self.client.execute(createQuery, function (err) {
-        self.schemaStatus.created = !err;
-        return callback(err);
-      });
+    return self.client.execute(createQuery, function (err) {
+      self.schemaStatus.created = !err;
+      return callback(err);
     });
+  });
 };
 
 Cassandra.prototype._insertLog = function (level, msg, meta, callback) {
-    var key = this.getKey();
-    if (!key) {
-      return callback(new Error('Partition ' + this.options.partitionBy + ' not supported'), false);
-    }
-    var query = 'INSERT INTO ' + this.options.table + ' (key, mid, date, level, message, meta) VALUES (?, ?, ?, ?, ?, ?)' + (this.options.cassandraTtl ? (' USING TTL ' + this.options.cassandraTtl) : '');
-    //execute as a prepared query as it would be executed multiple times
-    return this.client.execute(
-      query,
-      [key, meta.mid, new Date(), level, msg, util.inspect(meta)],
-      {prepare: true, consistency: this.options.consistency},
-      callback);
+  var key = this.getKey();
+  if (!key) {
+    return callback(new Error('Partition ' + this.options.partitionBy + ' not supported'), false);
+  }
+  var query = 'INSERT INTO ' + this.options.table + ' (key, mid, date, level, message, meta) VALUES (?, ?, ?, ?, ?, ?)' + (this.options.cassandraTtl ? (' USING TTL ' + this.options.cassandraTtl) : '');
+  //execute as a prepared query as it would be executed multiple times
+  return this.client.execute(
+    query,
+    [key, meta.mid, new Date(), level, msg, util.inspect(meta)],
+    {prepare: true, consistency: this.options.consistency},
+    callback);
 };
 
 winston.transports.Cassandra = Cassandra;