Service Design Specification

airbnb-reviewsystem-service documentation -Version:1.0.10

Scope

This document provides a structured architectural overview of the reviewSystem 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.

ReviewSystem Service Settings Edit

Handles double-blind, moderated reviews and rating aggregation for stays. Allows guests/hosts to review each other and listings, supports moderation, and exposes aggregate stats for listings/profiles...

Service Overview

This service is configured to listen for HTTP requests on port 3004, 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 airbnb-reviewsystem-service.

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

• Preview: https://airbnb3.prw.mindbricks.com/reviewsystem-api
• Staging: https://airbnb3-stage.mindbricks.co/reviewsystem-api
• Production: https://airbnb3.mindbricks.co/reviewsystem-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 airbnb-reviewsystem-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.

reviewAggregate Data Object

Object Overview

Description: Cached aggregate rating stats for a listing, host, or guest. Used for fast lookup and display of averages, counts, etc.

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: accessPublic — If enabled, anonymous users may access this object’s data depending on API-level rules.

Redis Entity Caching

This data object is configured for Redis entity caching, which improves data retrieval performance by storing frequently accessed data in Redis. Each time a new instance is created, updated or deleted, the cache is updated accordingly. Any get requests by id will first check the cache before querying the database. If you want to use the cache by other select criteria, you can configure any data property as a Redis cluster.

• Smart Caching is activated: A data object instance will only be cached when it is accessed for the first time. TTL (time-to-live) is dynamically calculated based on access frequency, which is useful for large datasets with volatile usage patterns. Each data instance has 15 minutes of TTL and in each access, the TTL is extended by 15 minutes. If the data is not accessed for 15 minutes, it will be removed from the cache.

• Cache Criteria:

{"visibilityStatus": "public"}

This object is only cached if this criteria is met.

The criteria is only checked during create and update operations, not during read operations. So if you want the criteria to be checked during read operations because it has checks about reading time context, you should deactivate the checkCriteriaOnlyInCreateAndUpdates option.

Composite Indexes

• uniqueListingOrProfile: [revieweeType, revieweeId] 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: throwError

An error will be thrown, preventing the insertion of conflicting data.

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.

• revieweeId: '00000000-0000-0000-0000-000000000000'
• revieweeType: listing
• visibilityStatus: public

Constant Properties

revieweeId revieweeType

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

revieweeId revieweeType averageRating reviewCount visibilityStatus

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.

• revieweeType: [host, guest, listing]

• visibilityStatus: [public, hidden]

Elastic Search Indexing

revieweeId revieweeType averageRating reviewCount visibilityStatus

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

revieweeId revieweeType

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.

Redis Cluster Properties

revieweeId revieweeType

Cluster properties are used to group related data in Redis, and used to invalidate the query cache more precisely. If no cluster property is set, the data object query cache will be invalidated for all instances of the data object when any instance is created, updated or deleted. For example, if you have a userId property that is used to cluster a task data query in Redis, when a new task is created, the query caches which have different userId filters will be reserved, and only the queries that have the same userId filter or have no filter at all will be invalidated.

Cache Select Properties

revieweeId revieweeType

Cache select properties are used to collect data from Redis entity cache with a different key than the data object id. This allows you to cache data that is not directly related to the data object id, but a frequently used filter.

Filter Properties

revieweeId revieweeType

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.

• revieweeId: ID has a filter named revieweeId

• revieweeType: Enum has a filter named revieweeType

review Data Object

Object Overview

Description: Review submitted by a guest or host after a completed stay. Enables double-blind, supports moderation, and links to reservation/listing and users.

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

• uniqueReviewPerReservationPerReviewer: [reservationId, reviewerId, revieweeType] 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: throwError

An error will be thrown, preventing the insertion of conflicting data.

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.

• moderationStatus: pending
• reviewText: 'text'
• rating: 0
• blindSubmissionCode: 'default'
• revieweeId: '00000000-0000-0000-0000-000000000000'
• reservationId: '00000000-0000-0000-0000-000000000000'
• reviewerId: '00000000-0000-0000-0000-000000000000'
• revieweeType: listing
• submittedAt: new Date()

Constant Properties

rating blindSubmissionCode revieweeId reservationId reviewerId revieweeType submittedAt

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

moderationStatus isPublished reviewText rating blindSubmissionCode revieweeId reservationId reviewerId revieweeType submittedAt

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.

Hashed Properties

blindSubmissionCode

Hashed properties are stored in the database as a hash value, providing an additional layer of security for sensitive data.

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.

• moderationStatus: [pending, approved, rejected]

• revieweeType: [host, guest, listing]

Elastic Search Indexing

moderationStatus isPublished reviewText rating blindSubmissionCode revieweeId reservationId reviewerId revieweeType submittedAt

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

revieweeId reservationId reviewerId submittedAt

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.

Relation Properties

reservationId reviewerId

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.

• reservationId: ID Relation to reservation.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

• reviewerId: 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

Session Data Properties

reviewerId

Session data properties are used to store data that is specific to the user session, allowing for personalized experiences and temporary data storage. If a property is configured as session data, it will be automatically mapped to the related field in the user session during CRUD operations. Note that session data properties can not be mutated by the user, but only by the system.

• reviewerId: ID property will be mapped to the session parameter userId.

This property is also used to store the owner of the session data, allowing for ownership checks and access control.

Formula Properties

blindSubmissionCode submittedAt

Formula properties are used to define calculated fields that derive their values from other properties or external data. These properties are automatically calculated based on the defined formula and can be used for dynamic data retrieval.

• blindSubmissionCode: String

  • Formula: LIB.generateBlindSubmissionCode(this.reservationId,this.reviewerId)

  • Calculate After Instance: No

• submittedAt: Date

  • Formula: new Date()

  • Calculate After Instance: No

Filter Properties

revieweeId reservationId reviewerId revieweeType

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.

• revieweeId: ID has a filter named revieweeId

• reservationId: ID has a filter named reservationId

• reviewerId: ID has a filter named reviewerId

• revieweeType: Enum has a filter named revieweeType

Business Logic

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

• Get Review

• List Reviewaggregates

• Create Review

• Delete Review

• Get Reviewaggregate

• List Reviews

• Update Review

Edge Controllers

No edge controllers defined for this service.

Service Library

Functions

generateBlindSubmissionCode.js

module.exports = function(reservationId,reviewerId) { return require('crypto').createHash('sha256').update(reservationId+':'+reviewerId+Date.now().toString()).digest('hex'); }

checkDoubleBlindReady.js

module.exports = async function(reservationId) { /* Checks if both guests/hosts have submitted reviews (or if time expired for double-blind). Should query reviewSystem:review for reservationId and return true/false. Stub logic for now: always returns true if at least 2 reviews exist for reservation, or if last eligible stay was >X days ago.*/ return true; }

computeAggregateRating.js

module.exports = async function(revieweeType,revieweeId) { /* Query all isPublished=true & moderationStatus=0 reviews for this type/entity, calc average. */ return 4.8; }

computeAggregateCount.js

module.exports = async function(revieweeType,revieweeId) { /* Count all published approved reviews. */ return 35; }

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: 3004
• 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.