Sunbird UCI
  • Overview of Sunbird UCI
  • 📙Learn
    • UCI use cases
    • UCI for Education(Case study)
    • Tech Overview
      • Glossary
      • High-level Architecture Design
      • Design Principles
      • Standards
  • 🚀Use
    • Choose your Persona
    • Adopter - Install and use UCI
      • Pre-requisites, Installation Setup, Post Setup
      • Setting up your very first conversation
      • API Documentation
      • Data Exhaust and Analytics
      • Posthog Event
      • Whatsapp (Netcore)
      • Environment Variables
    • Developer - Contribute to UCI
      • UCI Basics
        • XMessage Specification
        • Transformers
          • ODK Transformer
            • Interactive-Messages
            • Media Messages
            • Location
          • Broadcast Transformer
        • Adapters
          • Firebase Notification Adapter
        • User Segment
        • Schema Overview
          • UCI Core Schema
            • XMessage Schema
            • Assessment DB Schema
          • UCI API Schema
      • Development environment
        • Backend Setup
        • Setting up IDE
        • Environment variable setup
        • Debug services
        • Build and Execute UCI
        • Frontend Setup (Admin Console)
        • Frontend Setup (PWA)
        • Transport Socket
      • API Documentation
        • Bot Setup APIs
        • History APIs
        • Direct Message APIs
        • Vault APIs
      • Database Schema
        • Cassandra Xmessage Database
        • Postgres Forms Database
        • Postgres User Analytics Database
        • Postgres Comms Database
      • Contribution Guide
        • Your first PR
        • Contribute an Adapter
        • Adapter Implementation
        • Create a Transformer
    • Contact the administrator
  • ✅Releases
    • Release V2
  • 🤝Engage
    • Software License
    • Acceptable Use Policy
    • Terms of Service
    • Source Code
    • Discussion Forum
Powered by GitBook
On this page
  • Overview
  • New Features
  • Bug Fixes
  • Performance Improvements/Enhancements
  • Dependencies
  • Documentation
  • Breaking Changes
  • Contributors
  • Feedback

Was this helpful?

Edit on GitHub
  1. Releases

Release V2

PreviousContact the administratorNextSoftware License

Last updated 1 year ago

Was this helpful?

Overview

This release note contains all the feature additions, optimizations as well as changes that have been incorporated into the UCI ecosystem since the V1 version of UCI.

New Features

  • : Health endpoints now provide a more detailed result including all the dependent services.

  • : The notification process now fans out in chunks instead of one at a time. This enables the UCI system to perform better and faster. A bigger page size means faster performance but a more CPU and RAM intensive process.

  • : Conversation bots now support adding a display icon during the creation of bots.

  • : Admin panel now supports uploading media files while creating a bot directly from the admin panel.

  • : Segment URL queries now pass an auth token to retrieve users.

  • : Admin panel now supports a checkbox to create a broadcast bot along with a conversation bot.

  • : Web-Channel now highlights the previous options selected by users.

  • : Web-Channel now supports audio messages.

  • : Web-Channel now supports adding a caption to media.

  • : FusionAuth service now supports bulk insertion.

  • : Disabled bots now return ServiceUnavailableException when triggered.

  • : allContextual API now returns bots in sorted order.

  • : Update API now allows updation of fields such as purpose, description, endDate.

  • : Docker Compose has been updated for Cassandra so that it picks up env from docker-compose file.

  • : Cassandra xmessage table now contains additional column to store notification failure.

  • : UCI Web-Channel has now been dockerized.

  • : /admin/search/internal endpoint has been removed and only /admin/search is supported.

  • : Search API now also supports sorting by field.

  • : Admin Dashboard now supports editing a bot.

  • : Web Channel now shows a loader until bot is loaded.

  • : Expired bots now show an expired message in web channel.

  • : Direct message APIs can now send messages in broadcast mode.

  • : Bot Service now supports endpoint to get bot report data for notification.

  • : Endpoint added for bot health.

  • : UCI-API now supports an endpoint for the deletion of disabled bots.

Bug Fixes

Performance Improvements/Enhancements

Dependencies

Documentation

Breaking Changes

  • Old Admin Console is not compatible with V2 version of UCI.

  • V2 version of UCI depends on NL backend and will not work without it.

  • Gupshup provider has been removed from the pipeline.

Contributors

Feedback

Thank you for using UCI!

: Removed obsolete tests from outbound service.

: Removed obsolete tests from Broadcast service.

: Fixed failing tests in the utils package.

: Fixed failing tests in inbound service.

: Removed obsolete tests from Orchestrator service.

: Fixed failing tests on message-rosa package.

: Fixed failing tests on transformer

: FileCDN endpoints have been fixed to accept filename as a query parameter instead of static querying.

: Marshaller error while converting XMessages parallelly has been resolved.

: Null pointer exception on Kafka has been resolved.

: Duplicate message consumption from kafka in orchestrator service has been fixed.

: UCI-API now prevents bots with same name or starting message as that of an existing bot to be created.

: Service test cases fixed.

: Minio urls for media do not expire now.

: Conversation Logic controller tests have been fixed.

: App controller tests have been fixed.

: Upading a bot now invalidates cache on transaction layer.

: Removes manual instance creation of NetcoreWhatsappAdapter and uses dependency injection instead.

: Added retry mechanism to FusionAuth to prevent the abrupt failing of requests.

: The notification pipeline has been revamped to process more than 2L notifications without crashing services.

: Cassandra load issue was resolved by optimizing the queries.

: Adds caching to allContextual API to enhance response time.

: Service level logs have been added to all the endpoints along with the total response time of functions.

: Dockerfile of java services have been modified to cap total memory usage and to use Semeru JVM instead of openjdk-jvm.

: UCI-API service now returns proper error messages on upload failure.

: User conversation history from Cassandra is now being cached to improve performance.

: getLatestXMessage query has been optimized to perform better.

: Removed mittwald vault package dependency due to errors.

: Aggregate db postgres connection pool has been added to prevent too many clients error.

: Notifications and Conversations now use separate topics for Kafka.

: UCI docker deploy now provides a single script setup which automatically configures a test bot and other dependencies.

: NL backend systems that are responsible for managing users.

: Updated Firebase adapter docs to include a table explaining all the required fields in the request.

: The UCI documentation now also includes a manual for the admin panel.

: Documentation has been updated to explain all the relevant query fields in conversation creation API.

: Documentation now consists of Draw.io diagrams of different flows.

: Documentation for bot history api has been updated for v2.

: Bot setup api has been updated in documentation to match v2.

: Documentation updated for setting up first conversation.

: Documentation added for database schema.

: Documentation has been updated with the latest setup guide which provides a more streamlined and hassle free installation process.

: Abhishek Kumar Pal

: Abhishek Mishra

: Anvansh Singh

: Ayush Dubey

: Chakshu Gautam

: Chinmoy Chakraborty

: Karan Trehan

: Pankaj Jangid

: Tushar Gupta

: Varun Agarwal

: Yuvraj Sablania

We welcome your feedback! If you encounter any issues or have suggestions for improvements, please on our issue tracker.

✅
Extend /health endpoints to make them async and detailed
Making query URL paginated
In bot details API, add icon image URL parameter
Media upload API
Add headers to query url being sent with broadcast conversation logic
Add a checkbox to create broadcast bot
Selected option highlighted
[C4GT] Add Audio support to web channel
Add Bot Icon and Media caption to the chatbot
Bulk Data Insertion in Fusion Auth
Create a bot with status as disabled by default
Return bot list in sorted order by name in allContextual endpoint
Return purpose and description in botDetails API
Cassandra Server Configuration Pick from Docker-Compose
Add New Column in Cassandra for Notification Failure Reason
Dockerize the web-channel to onboard to the one script deployment plan
Unify specs across UCI APIs
Add order by parameter in search API
Integrate Edit Bot in Admin Panel
Add loader to conversation-NL App
Handling of expired bots
Broadcast Direct Message APIs
Add endpoint to get bot report data
Setup monitoring for bot health
Provide endpoints for deletion of bots
Some tests are failing on stable branch (outbound)
Some test cases failing on stable branch (Broadcast transformer)
Some tests are failing in stable branch (utils)
Some test cases failing on stable branch (inbound)
Some tests are failing on stable branch (orchestrator)
Some tests are failing on stable branch (message-rosa)
Some tests are failing on stable branch (transformer)
Fix {FileCDN}/getSignedUrl endpoints to accept fileName
[Bug] - Getting Exception Related to Unmarshaller
[Bug] - Getting Exception Related to Kafka
[Bug] Duplication of Kafka topics from Orchestrator
Prevent same bot same starting message to be created
Fix src/modules/service/service.service.spec.ts test
Increase Minio Signed URL Expiry Time for NL-APP
[Fix Test] src/modules/conversation-logic/conversation-logic.controller.spec.ts
Fix src/app.controller.spec.ts test
Invalidate cache on transaction layer on bot update
Remove manual instance creation of NetcoreWhatsappAdapter
Add retry to FusionAuth in updateUser
Notification Pipeline
[Bug] - Cassandra Related Issues in Inbound
Add Cache in allContextual API
Add logging to UCI-APIS
Reduce JVM memory usage
Improve error logging in UCI-APIs
Cache cassandra result in conversation history
Remove old implementation of getLatestXMessage
vault dependency removal
[Bug] - Getting Error in Aggregate Postgres
Create a separate Kafka topic for notifications in each service
Fix conversation flow in the setup by install.py
NL backend
Document changes done to Outbound
Modify Admin Console Manual
Added a table explaining all the different fields that are used while creating a new conversation logic
Create flow diagram of message flow in UCI on Draw.io
[Docs] Update documentation of bot history api to match v2
[Docs] Update documentation of bot setup api to match v2
[Docs] Update Setting up first conversation according to v2
[Doc] - Documentation for Database Schema
Update UCI Setup Docs
geeky-abhishek
choxx
RyanWalker277
devAyushDubey
ChakshuGautam
chinmoy12c
karntrehan
pankajjangid05
tushar5526
1010varun
yuvrajsab
submit an issue