Skip to main content

GSB Service

Purpose​

mvp3-gsb-service is the backend service for GSB-related workflows.

Local runtime facts​

  • default local port: 3000
  • swagger docs: /gsb/docs
  • metrics endpoint: /gsb/metrics
  • env template: .env.example

Owned modules​

  • gsb

Dependencies​

  • MariaDB
  • Redis
  • RabbitMQ
  • vendor or integration credentials for ALU, ZTE, Fiberhome, Huawei
  • APIM, NIG, and TMFORCE endpoints

Required config groups​

  • PORT
  • DB_*
  • TOKEN_EXPIRED_PER_SECONDS, JWT_ISSUER, JWT_ALGORITHM
  • REDIS_*
  • RABBITMQ_*
  • ALU_*, FIBERHOME_*, ZTE_*, HUAWEI_*
  • NIG_URL, TMFORCE_URL, APIM_URL, APIM_KEY, APIM_SECRET

Upstream and downstream​

  • upstream callers: portal and mobile GSB actions
  • downstream systems: RabbitMQ queues intt_gsb_queue, intt_alu_queue, intt_zte_queue, intt_fiberhome_queue, intt_huawei_queue
  • external integrations: APIM, vendor endpoints, NIG, TMFORCE

Local commands​

Install:

git submodule update --init --recursive
cd share-entity
git checkout development
cd ..
pnpm install

Run locally:

pnpm run start:dev

Build and run production mode:

pnpm run build
pnpm run start:prod

Test:

pnpm run test
pnpm run test:e2e
pnpm run test:cov

Local testing​

  • unit tests: pnpm run test
  • e2e tests: pnpm run test:e2e
  • coverage: pnpm run test:cov