Merge pull request #316 from Sunbird-Knowlg/release-8.1.0

Release 8.1.0

Author: pallakartheekreddy

.circleci/config.yml

@@ -0,0 +1,47 @@
+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
+        with:
+          submodules: 'recursive'
+          token: ${{ secrets.GITHUB_TOKEN }}
+
+      - 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 Docker image
+        run: docker build -t $IMAGE_NAME:$IMAGE_TAG .
+
+      - name: Push Docker image
+        run: docker push $IMAGE_NAME:$IMAGE_TAG

.github/workflows/ghcr-publish.yml

@@ -1,22 +1,13 @@
-FROM circleci/node:8.11.2-stretch
-MAINTAINER "Manojvv" "manojv@ilimi.in"
-USER root
-COPY src /opt/content/
+FROM node:22.17.1-bookworm
+RUN useradd -m sunbird-dev
+USER sunbird-dev
+COPY --chown=sunbird-dev src /opt/content/
 WORKDIR /opt/content/
-RUN npm install --unsafe-perm
+RUN npm install
 
-FROM node:8.11-slim
-MAINTAINER "Manojvv" "manojv@ilimi.in"
-RUN sed -i '/jessie-updates/d' /etc/apt/sources.list \
-    && apt update && apt install openssl imagemagick -y \
-    && apt-get clean \
-    && useradd -m sunbird
-USER sunbird
-ADD ImageMagick-i386-pc-solaris2.11.tar.gz /home/sunbird
-ENV GRAPH_HOME "/home/sunbird/ImageMagick-6.9.3"
-ENV PATH "$GRAPH_HOME/bin:$PATH"
-ENV MAGICK_HOME "/home/sunbird/ImageMagick-6.9.3"
-ENV PATH "$MAGICK_HOME/bin:$PATH"
+FROM node:22.17.1-bookworm
+
+RUN useradd -m sunbird
 COPY --from=0 --chown=sunbird /opt/content /home/sunbird/mw/content
 WORKDIR /home/sunbird/mw/content/
-CMD ["node", "app.js", "&"]
+CMD ["node", "app.js"]

Dockerfile

@@ -5,38 +5,34 @@ This is the repository for content management micro-service.
 The code in this repository is licensed under MIT unless otherwise noted. Please see the [LICENSE](https://github.com/project-sunbird/sunbird-content-service/blob/master/LICENSE) file for details.
 
 ## Pre Requirements
-1. Node
-2. Install imagemagick, graphicsmagick ref:https://www.npmjs.com/package/gm
+1. Node JS
 
 ## Environment Variables:
-* sunbird_content_provider_api_base_url: content provider API base url. e.g.: https://qa.ekstep.in or https://api.ekstep.in
 * sunbird_content_repo_api_key:  API key for the  content provider URL
 * sunbird_search_service_api_key:  API key for the  search provider URL
 * sunbird_dial_repo_api_key : API key for the dial URL
 * sunbird_plugin_repo_api_key: API key for the plugin URL 
 * sunbird_data_service_api_key: API key for the data service URL
-* sunbird_content_service_log_level : sets the log level e.g debug , info etc.
+* sunbird_content_service_log_level : sets the log level Example debug , info etc.
 * sunbird_language_service_api_key: API key for the language service 
-* sunbird_default_channel: Default channel. e.g. sunbird (string)  
-* sunbird_content_plugin_base_url: Content plugin base url. e.g.: https://qa.ekstep.in or https://community.ekstep.in
-* sunbird_environment: e.g : sunbird.env (string)
-* sunbird_instance : e.g : sunbird.ins(string)
-* sunbird_keycloak_auth_server_url: Sunbird keycloak auth server url e.g.: https://dev.open-sunbird.org/auth (string)
-* sunbird_keycloak_realm: Sunbird keycloak realm e.g.: sunbird (string)
-* sunbird_keycloak_client_id: Sunbird keycloak client id e.g: portal (string)
-* sunbird_keycloak_public: Sunbird keycloak public e.g.: true (boolean)
-* sunbird_cache_store: Sunbird cache store e.g.: memory (string)
-* sunbird_cache_ttl: Sunbird cachec time to live e.g.: 1800(number)
-* sunbird_image_storage_url
-* sunbird_azure_account_name 
-* sunbird_azure_account_key 
+* sunbird_default_channel: Default channel. Example. sunbird (string)  
+* sunbird_content_plugin_base_url: Content plugin base url. Example.: https://qa.ekstep.in or https://community.ekstep.in
+* sunbird_environment: Example : sunbird.env (string)
+* sunbird_instance : Example : sunbird.ins(string)
+* sunbird_keycloak_auth_server_url: Sunbird keycloak auth server url Example.: https://dev.open-sunbird.org/auth (string)
+* sunbird_keycloak_realm: Sunbird keycloak realm Example.: sunbird (string)
+* sunbird_keycloak_client_id: Sunbird keycloak client id Example: portal (string)
+* sunbird_keycloak_public: Sunbird keycloak public Example.: true (boolean)
+* sunbird_cache_store: Sunbird cache store Example.: memory (string)
+* sunbird_cache_ttl: Sunbird cachec time to live Example.: 1800(number)
 * sunbird_dial_code_registry_url eg: staging.open-sunbird.org/dial/
-* sunbird_cassandra_ips  e.g : 127.0.0.1,127.0.0.2
-* sunbird_cassandra_port e.g: 9042
-* sunbird_telemetry_sync_batch_size e.g: 20
-* sunbird_learner_service_local_base_url e.g: 'http://learner-service:9000'
-* sunbird_content_service_local_base_url e.g: 'http://localhost:5000'
-* sunbird_content_upload_data_limit: Content upload data limit e.g.: 50mb (string)
+* sunbird_cassandra_urls  Example : 127.0.0.1,127.0.0.2
+* sunbird_cassandra_consistency_level Example: 9042
+* sunbird_cassandra_replication_strategy  Example: '{"class":"SimpleStrategy","replication_factor":1}'
+* sunbird_telemetry_sync_batch_size Example: 20
+* sunbird_learner_service_local_base_url Example: 'http://learner-service:9000'
+* sunbird_content_service_local_base_url Example: 'http://localhost:5000'
+* sunbird_content_upload_data_limit: Content upload data limit Example.: 50mb (string)
 
 ## Setup Instructions
 * Clone the project.eg .(git clone --recursive  url)

README.md

@@ -6,6 +6,6 @@ name=knowledge-mw-service
 node=$2
 org=$3
 
-[[ -f ImageMagick-i386-pc-solaris2.11.tar.gz ]] || wget https://www.imagemagick.org/download/binaries/ImageMagick-i386-pc-solaris2.11.tar.gz
 docker build -f ./Dockerfile --label commitHash=$(git rev-parse --short HEAD) -t ${org}/${name}:${build_tag} .
 echo {\"image_name\" : \"${name}\", \"image_tag\" : \"${build_tag}\", \"node_name\" : \"$node\"} > metadata.json
+

build.sh

@@ -1,11 +1,25 @@
 {
     "extends": "standard",
     "globals": {
-        "globalEkstepProxyBaseUrl": true
+        "globalEkstepProxyBaseUrl": "readonly"
     },
     "rules": {
-        "indent": ["error", 2],
-        "max-len": ["error", 120, 2, {"ignoreUrls": true, "ignoreComments": true}],
-        "quotes": ["error", "single"]
+        "indent": [
+            "error",
+            2
+        ],
+        "max-len": [
+            "error",
+            120,
+            2,
+            {
+                "ignoreUrls": true,
+                "ignoreComments": true
+            }
+        ],
+        "quotes": [
+            "error",
+            "single"
+        ]
     }
-}
+}

setup.md

@@ -44,6 +44,7 @@ const dialRepoBaseUrl = process.env.sunbird_dial_repo_api_base_url || 'https://q
 const pluginRepoBaseUrl = process.env.sunbird_plugin_repo_api_base_url || 'https://qa.ekstep.in/api'
 const dataServiceBaseUrl = process.env.sunbird_data_service_api_base_url || 'https://qa.ekstep.in/api'
 const languageServiceBaseUrl = process.env.sunbird_language_service_api_base_url || 'https://qa.ekstep.in/api/language'
+const taxonomyServiceBaseUrl = process.env.sunbird_taxonomy_service_api_base_url || 'http://taxonomy-service:9000'
 
 const searchServiceApiKey = process.env.sunbird_search_service_api_key
 const dialRepoApiKey = process.env.sunbird_dial_repo_api_key
@@ -59,6 +60,7 @@ const isHealthCheckEnabled = process.env.sunbird_health_check_enable || 'true'
 const contentServiceLocalBaseUrl = process.env.sunbird_content_service_local_base_url ? process.env.sunbird_content_service_local_base_url : 'http://knowledge-mw-service:5000'
 const sunbirdGzipEnable = process.env.sunbird_gzip_enable || 'true'
 const kidTokenPublicKeyBasePath = process.env.sunbird_kid_public_key_base_path || '/keys/'
+const userTokenValidateEnable = process.env.enable_user_token_validation || 'true'
 
 configUtil.setContentProviderApi(contentProviderApiConfig.API)
 configUtil.setConfig('CONTENT_SERVICE_BASE_URL', contentServiceBaseUrl)
@@ -88,6 +90,8 @@ configUtil.setConfig('CASSANDRA_DB_HEALTH_STATUS', 'true')
 configUtil.setConfig('EKSTEP_HEALTH_STATUS', 'true')
 configUtil.setConfig('CONTENT_SERVICE_LOCAL_BASE_URL', contentServiceLocalBaseUrl)
 configUtil.setConfig('ENABLE_GZIP', sunbirdGzipEnable)
+configUtil.setConfig('ENABLE_USER_TOKEN_VALIDATION', userTokenValidateEnable)
+configUtil.setConfig('TAXONOMY_SERVICE_BASE_URL', taxonomyServiceBaseUrl)
 
 process.env.sunbird_cassandra_urls = process.env.sunbird_cassandra_urls || '127.0.0.1'
 process.env.dial_code_image_temp_folder = 'temp'
@@ -151,8 +155,7 @@ app.use(methodOverride())
 app.use(function (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, *')
+  res.header('Access-Control-Allow-Headers', '*')
 
   if (req.method === 'OPTIONS') {
     res.sendStatus(200)

src/.eslintrc

@@ -40,6 +40,7 @@
         "UPDATE_COLLABORATOR": "/content/v1/collaborator/update",
         "RESERVE_DIALCODE": "/content/v3/dialcode/reserve",
         "RELEASE_DIALCODE": "/content/v3/dialcode/release",
+        "GET_DIALCODE_BATCH": "/dialcode/v4/batch/read",
 
         "CHANNEL_URI": "/channel/v3/read",
         "CHANNEL_LIST_URI": "/channel/v3/list",
@@ -78,6 +79,8 @@
         "CREATE_LOCK": "/lock/v1/create",
         "REFRESH_LOCK": "/lock/v1/refresh",
         "RETIRE_LOCK": "/lock/v1/retire",
-        "LIST_LOCK": "/lock/v1/list"
+        "LIST_LOCK": "/lock/v1/list",
+
+        "UPDATE_QUESTION_SET_URI": "/questionset/v2/update"
     }
 }   

src/app.js

@@ -16,17 +16,18 @@ gulp.task('clean-coverage-report', function (cb) {
 })
 
 // Below task is used setup source files
-gulp.task('pre-test-node', function () {
+gulp.task('pre-test-node', function (done) {
   return gulp.src(paths.scripts)
-    .pipe(istanbul({includeUntested: true}))
+    .pipe(istanbul({ includeUntested: true }))
     .pipe(istanbul.hookRequire())
+    .on('finish', done)
 })
 
 // Below task used to run the test cases
-gulp.task('test', ['clean-coverage-report', 'pre-test-node'], function () {
+gulp.task('test', gulp.series('clean-coverage-report', 'pre-test-node', function () {
   return gulp.src(paths.tests)
     .pipe(jasmineNode({
       timeout: 10000
     }))
-    .pipe(istanbul.writeReports({dir: paths.coverage, reporters: ['html', 'text-summary']}))
-})
+    .pipe(istanbul.writeReports({ dir: paths.coverage, reporters: ['html', 'text-summary'] }))
+}))