Service Design Specification

ebaycclone-notificationmanagement-service documentation -Version:1.0.0

Scope

This document provides a structured architectural overview of the notificationManagement microservice, detailing its configuration, data model, authorization logic, business rules, and API design. It has been automatically generated based on the service definition within Mindbricks, ensuring that the information reflects the source of truth used during code generation and deployment.

The document is intended to serve multiple audiences:

• Service architects can use it to validate design decisions and ensure alignment with broader architectural goals.
• Developers and maintainers will find it useful for understanding the structure and behavior of the service, facilitating easier debugging, feature extension, and integration with other systems.
• Stakeholders and reviewers can use it to gain a clear understanding of the service's capabilities and domain logic.

Note for Frontend Developers: While this document is valuable for understanding business logic and data interactions, please refer to the Service API Documentation for endpoint-level specifications and integration details.

Note for Backend Developers: Since the code for this service is automatically generated by Mindbricks, you typically won't need to implement or modify it manually. However, this document is especially valuable when you're building other services—whether within Mindbricks or externally—that need to interact with or depend on this service. It provides a clear reference to the service's data contracts, business rules, and API structure, helping ensure compatibility and correct integration.

NotificationManagement Service Settings Edit

Handles storage, management, and event-driven delivery of in-app and email notifications for user-impacting system events (bids, offers, orders, feedback, messaging, etc.). Supports marking notifications as read/unread, structured filtering by event type/channel, and always returns in-app notifications ordered by recency.

Service Overview

This service is configured to listen for HTTP requests on port 3000, serving both the main API interface and default administrative endpoints.

The following routes are available by default:

• API Test Interface (API Face): /
• Swagger Documentation: /swagger
• Postman Collection Download: /getPostmanCollection
• Health Checks: /health and /admin/health
• Current Session Info: /currentuser
• Favicon: /favicon.ico

The service uses a PostgreSQL database for data storage, with the database name set to ebaycclone-notificationmanagement-service.

This service is accessible via the following environment-specific URLs:

• Preview: https://ebaycclone.prw.mindbricks.com/notificationmanagement-api
• Staging: https://ebaycclone-stage.mindbricks.co/notificationmanagement-api
• Production: https://ebaycclone.mindbricks.co/notificationmanagement-api

Authentication & Security

• Login Required: Yes

This service requires user authentication for access. It supports both JWT and RSA-based authentication mechanisms, ensuring secure user sessions and data integrity. If a crud route also is configured to require login, it will check a valid JWT token in the request query/header/bearer/cookie. If the token is valid, it will extract the user information from the token and make the fetched session data available in the request context.

Service Data Objects

The service uses a PostgreSQL database for data storage, with the database name set to ebaycclone-notificationmanagement-service.

Data deletion is managed using a soft delete strategy. Instead of removing records from the database, they are flagged as inactive by setting the isActive field to false.

notification Data Object

Object Overview

Description: Stores and manages in-app and email notifications tied to user-facing events like bids, offers, orders, messaging, shipment, and feedback. Includes event type (notificationType) for filter/search, arbitrary event payload, and delivery channel. Soft-delete enforced. In-app notifications always sorted by createdAt DESC on retrieval.

This object represents a core data structure within the service and acts as the blueprint for database interaction, API generation, and business logic enforcement. It is defined using the ObjectSettings pattern, which governs its behavior, access control, caching strategy, and integration points with other systems such as Stripe and Redis.

Core Configuration

• Soft Delete: Enabled — Determines whether records are marked inactive (isActive = false) instead of being physically deleted.
• Public Access: accessPrivate — If enabled, anonymous users may access this object’s data depending on API-level rules.

Composite Indexes

• userTypeIsReadIndex: [userId, notificationType, isRead] This composite index is defined to optimize query performance for complex queries involving multiple fields.

The index also defines a conflict resolution strategy for duplicate key violations.

When a new record would violate this composite index, the following action will be taken:

On Duplicate: ``

Properties Schema

• Required properties are mandatory for creating objects and must be provided in the request body if no default value is set.

Default Values

Default values are automatically assigned to properties when a new object is created, if no value is provided in the request body. Since default values are applied on db level, they should be literal values, not expressions.If you want to use expressions, you can use transposed parameters in any business API to set default values dynamically.

• notificationType: "BID_UPDATED"
• userId: '00000000-0000-0000-0000-000000000000'
• channel: "IN_APP"
• payload: {}
• isRead: false

Constant Properties

notificationType userId channel

Constant properties are defined to be immutable after creation, meaning they cannot be updated or changed once set. They are typically used for properties that should remain constant throughout the object's lifecycle. A property is set to be constant if the Allow Update option is set to false.

Auto Update Properties

payload isRead

An update crud API created with the option Auto Params enabled will automatically update these properties with the provided values in the request body. If you want to update any property in your own business logic not by user input, you can set the Allow Auto Update option to false. These properties will be added to the update API's body parameters and can be updated by the user if any value is provided in the request body.

Enum Properties

Enum properties are defined with a set of allowed values, ensuring that only valid options can be assigned to them. The enum options value will be stored as strings in the database, but when a data object is created an addtional property with the same name plus an idx suffix will be created, which will hold the index of the selected enum option. You can use the index property to sort by the enum value or when your enum options represent a sequence of values.

• notificationType: [BID_UPDATED, BID_OUTBID, BID_WON, OFFER_PLACED, OFFER_ACCEPTED, OFFER_DECLINED, OFFER_COUNTERED, ORDER_PLACED, ORDER_PAID, ORDER_SHIPPED, ORDER_DELIVERED, ORDER_CANCELLED, FEEDBACK_RECEIVED, FEEDBACK_REQUESTED, MESSAGE_RECEIVED, MESSAGE_SENT, SYSTEM_ALERT]

• channel: [IN_APP, EMAIL]

Elastic Search Indexing

notificationType userId channel isRead

Properties that are indexed in Elastic Search will be searchable via the Elastic Search API. While all properties are stored in the elastic search index of the data object, only those marked for Elastic Search indexing will be available for search queries.

Database Indexing

notificationType userId channel isRead

Properties that are indexed in the database will be optimized for query performance, allowing for faster data retrieval. Make a property indexed in the database if you want to use it frequently in query filters or sorting.

Secondary Key Properties

userId

Secondary key properties are used to create an additional indexed identifiers for the data object, allowing for alternative access patterns. Different than normal indexed properties, secondary keys will act as primary keys and Mindbricks will provide automatic secondary key db utility functions to access the data object by the secondary key.

Relation Properties

userId

Mindbricks supports relations between data objects, allowing you to define how objects are linked together. You can define relations in the data object properties, which will be used to create foreign key constraints in the database. For complex joins operations, Mindbricks supportsa BFF pattern, where you can view dynamic and static views based on Elastic Search Indexes. Use db level relations for simple one-to-one or one-to-many relationships, and use BFF views for complex joins that require multiple data objects to be joined together.

• userId: ID Relation to user.id

The target object is a parent object, meaning that the relation is a one-to-many relationship from target to this object.

On Delete: Set Null Required: Yes

Filter Properties

notificationType userId channel isRead

Filter properties are used to define parameters that can be used in query filters, allowing for dynamic data retrieval based on user input or predefined criteria. These properties are automatically mapped as API parameters in the listing API's that have "Auto Params" enabled.

• notificationType: Enum has a filter named notificationType

• userId: ID has a filter named userId

• channel: Enum has a filter named channel

• isRead: Boolean has a filter named isRead

Business Logic

notificationManagement has got 5 Business APIs to manage its internal and crud logic. For the details of each business API refer to its chapter.

• Create Notification

• Update Notification

• List Notifications

• Delete Notification

• Get Notification

Edge Controllers

No edge controllers defined for this service.

Service Library

Functions

No general functions defined.

Hook Functions

No hook functions defined.

Edge Functions

No edge functions defined.

Templates

No templates defined.

Assets

No assets defined.

Public Assets

No public assets defined.

Event Emission

Integration Patterns

Deployment Considerations

Environment Configuration

• HTTP Port: 3000
• Database Type: MongoDB
• Global Soft Delete: Enabled

Implementation Guidelines

Development Workflow

1. Data Model Implementation: Generate database schema from data object definitions
2. CRUD Route Generation: Implement auto-generated routes with custom logic
3. Custom Logic Integration: Implement hook functions and edge functions
4. Authentication Integration: Configure with project-level authentication
5. Testing: Unit and integration testing for all components

Code Generation Expectations

• Database Schema: Auto-generated from data objects and relationships
• API Routes: REST endpoints with customizable behavior
• Validation Logic: Input validation from property definitions
• Access Control: Authentication and authorization middleware

Custom Code Integration Points

• Hook Functions: Lifecycle-specific custom logic
• Edge Functions: Full request/response control
• Library Functions: Reusable business logic
• Templates: Dynamic content rendering

Testing Strategy

Unit Testing

• Test all custom library functions
• Test validation logic and business rules
• Test hook function implementations

Integration Testing

• Test API endpoints with authentication scenarios
• Test database operations and transactions
• Test external integrations
• Test event emission and Kafka integration

Performance Testing

• Load test high-traffic endpoints
• Test caching effectiveness
• Monitor database query performance
• Test scalability under load

Appendices

Data Type Reference

Enum Value Mappings

Request Locations

• 0: Bearer token in Authorization header
• 1: Cookie value
• 2: Custom HTTP header
• 3: Query parameter
• 4: Request body property
• 5: URL path parameter
• 6: Session data
• 7: Root request object

HTTP Methods

• 0: GET
• 1: POST
• 2: PUT
• 3: PATCH
• 4: DELETE

Edge Function Signature

async function edgeFunction(request) {
  // Custom request processing
  // Return response object or throw error
  return {
    data: {},
    status: 200,
    message: "Success"
  };
}

This document was generated from the service architecture definition and should be kept in sync with implementation changes.