1+ import { beforeEach , describe , expect , test } from "vitest" ;
2+ import type { Review , Product , ProductProjection } from "@commercetools/platform-sdk" ;
3+ import { CommercetoolsMock } from "~src/index" ;
4+ import supertest from "supertest" ;
5+
6+ describe ( "Product Review Statistics" , ( ) => {
7+ let ctMock : CommercetoolsMock ;
8+ let product : Product ;
9+
10+ beforeEach ( async ( ) => {
11+ ctMock = new CommercetoolsMock ( ) ;
12+
13+ // Create a product
14+ const productResponse = await supertest ( ctMock . app )
15+ . post ( "/dummy/products" )
16+ . send ( {
17+ name : { en : "Test Product" } ,
18+ slug : { en : "test-product" } ,
19+ productType : {
20+ typeId : "product-type" ,
21+ key : "dummy-product-type" ,
22+ } ,
23+ masterVariant : {
24+ sku : "test-sku-1" ,
25+ prices : [
26+ {
27+ value : {
28+ currencyCode : "EUR" ,
29+ centAmount : 1000 ,
30+ } ,
31+ } ,
32+ ] ,
33+ } ,
34+ } ) ;
35+ expect ( productResponse . status ) . toBe ( 201 ) ;
36+ product = productResponse . body ;
37+ } ) ;
38+
39+ test ( "product has no review statistics when no reviews exist" , async ( ) => {
40+ const response = await supertest ( ctMock . app ) . get ( `/dummy/products/${ product . id } ) ;
41+
42+ expect ( response . status ) . toBe ( 200 ) ;
43+ expect ( response . body . reviewRatingStatistics ) . toBeUndefined ( ) ;
44+ } ) ;
45+
46+ test ( "product has review statistics when reviews exist" , async ( ) => {
47+ // Create reviews for the product
48+ await supertest ( ctMock . app )
49+ . post ( "/dummy/reviews" )
50+ . send ( {
51+ authorName : "John Doe" ,
52+ title : "Great product!" ,
53+ text : "I really love this product." ,
54+ rating : 5 ,
55+ target : {
56+ typeId : "product" ,
57+ id : product . id ,
58+ } ,
59+ } ) ;
60+
61+ await supertest ( ctMock . app )
62+ . post ( "/dummy/reviews" )
63+ . send ( {
64+ authorName : "Jane Smith" ,
65+ title : "Good product" ,
66+ text : "Pretty good overall." ,
67+ rating : 4 ,
68+ target : {
69+ typeId : "product" ,
70+ id : product . id ,
71+ } ,
72+ } ) ;
73+
74+ await supertest ( ctMock . app )
75+ . post ( "/dummy/reviews" )
76+ . send ( {
77+ authorName : "Bob Wilson" ,
78+ title : "Excellent!" ,
79+ text : "Amazing quality." ,
80+ rating : 5 ,
81+ target : {
82+ typeId : "product" ,
83+ id : product . id ,
84+ } ,
85+ } ) ;
86+
87+ const response = await supertest ( ctMock . app ) . get ( `/dummy/products/${ product . id } ) ;
88+
89+ expect ( response . status ) . toBe ( 200 ) ;
90+ expect ( response . body . reviewRatingStatistics ) . toBeDefined ( ) ;
91+ expect ( response . body . reviewRatingStatistics . count ) . toBe ( 3 ) ;
92+ expect ( response . body . reviewRatingStatistics . averageRating ) . toBe ( 4.66667 ) ;
93+ expect ( response . body . reviewRatingStatistics . highestRating ) . toBe ( 5 ) ;
94+ expect ( response . body . reviewRatingStatistics . lowestRating ) . toBe ( 4 ) ;
95+ expect ( response . body . reviewRatingStatistics . ratingsDistribution ) . toEqual ( {
96+ "4" : 1 ,
97+ "5" : 2 ,
98+ } ) ;
99+ } ) ;
100+
101+ test ( "product projection has review statistics" , async ( ) => {
102+ // Create a review for the product
103+ await supertest ( ctMock . app )
104+ . post ( "/dummy/reviews" )
105+ . send ( {
106+ authorName : "Test User" ,
107+ title : "Test Review" ,
108+ text : "Test review text." ,
109+ rating : 3 ,
110+ target : {
111+ typeId : "product" ,
112+ id : product . id ,
113+ } ,
114+ } ) ;
115+
116+ const response = await supertest ( ctMock . app ) . get ( `/dummy/product-projections/${ product . id } ) ;
117+
118+ expect ( response . status ) . toBe ( 200 ) ;
119+ expect ( response . body . reviewRatingStatistics ) . toBeDefined ( ) ;
120+ expect ( response . body . reviewRatingStatistics . count ) . toBe ( 1 ) ;
121+ expect ( response . body . reviewRatingStatistics . averageRating ) . toBe ( 3 ) ;
122+ expect ( response . body . reviewRatingStatistics . highestRating ) . toBe ( 3 ) ;
123+ expect ( response . body . reviewRatingStatistics . lowestRating ) . toBe ( 3 ) ;
124+ expect ( response . body . reviewRatingStatistics . ratingsDistribution ) . toEqual ( {
125+ "3" : 1 ,
126+ } ) ;
127+ } ) ;
128+
129+ test ( "product query includes review statistics" , async ( ) => {
130+ // Create reviews for the product
131+ await supertest ( ctMock . app )
132+ . post ( "/dummy/reviews" )
133+ . send ( {
134+ authorName : "Reviewer 1" ,
135+ rating : 2 ,
136+ target : {
137+ typeId : "product" ,
138+ id : product . id ,
139+ } ,
140+ } ) ;
141+
142+ await supertest ( ctMock . app )
143+ . post ( "/dummy/reviews" )
144+ . send ( {
145+ authorName : "Reviewer 2" ,
146+ rating : 4 ,
147+ target : {
148+ typeId : "product" ,
149+ id : product . id ,
150+ } ,
151+ } ) ;
152+
153+ const response = await supertest ( ctMock . app ) . get ( "/dummy/products" ) ;
154+
155+ expect ( response . status ) . toBe ( 200 ) ;
156+ expect ( response . body . results ) . toHaveLength ( 1 ) ;
157+ expect ( response . body . results [ 0 ] . reviewRatingStatistics ) . toBeDefined ( ) ;
158+ expect ( response . body . results [ 0 ] . reviewRatingStatistics . count ) . toBe ( 2 ) ;
159+ expect ( response . body . results [ 0 ] . reviewRatingStatistics . averageRating ) . toBe ( 3 ) ;
160+ expect ( response . body . results [ 0 ] . reviewRatingStatistics . highestRating ) . toBe ( 4 ) ;
161+ expect ( response . body . results [ 0 ] . reviewRatingStatistics . lowestRating ) . toBe ( 2 ) ;
162+ } ) ;
163+
164+ test ( "only reviews with includedInStatistics=true are counted" , async ( ) => {
165+ // Create reviews - both will be included by default
166+ const review1Response = await supertest ( ctMock . app )
167+ . post ( "/dummy/reviews" )
168+ . send ( {
169+ authorName : "Reviewer 1" ,
170+ rating : 5 ,
171+ target : {
172+ typeId : "product" ,
173+ id : product . id ,
174+ } ,
175+ } ) ;
176+
177+ const review2Response = await supertest ( ctMock . app )
178+ . post ( "/dummy/reviews" )
179+ . send ( {
180+ authorName : "Reviewer 2" ,
181+ rating : 1 ,
182+ target : {
183+ typeId : "product" ,
184+ id : product . id ,
185+ } ,
186+ } ) ;
187+
188+ // Check that both reviews are included by default
189+ let response = await supertest ( ctMock . app ) . get ( `/dummy/products/${ product . id } ) ;
190+
191+ expect ( response . status ) . toBe ( 200 ) ;
192+ expect ( response . body . reviewRatingStatistics ) . toBeDefined ( ) ;
193+ expect ( response . body . reviewRatingStatistics . count ) . toBe ( 2 ) ;
194+ expect ( response . body . reviewRatingStatistics . averageRating ) . toBe ( 3 ) ;
195+
196+ // Now exclude one review from statistics by updating it
197+ // (Note: In a real implementation, this would be done via state transitions,
198+ // but for now we can test the filtering works with includedInStatistics directly)
199+ } ) ;
200+
201+ test ( "reviews without ratings are not included in statistics" , async ( ) => {
202+ // Create a review without rating
203+ await supertest ( ctMock . app )
204+ . post ( "/dummy/reviews" )
205+ . send ( {
206+ authorName : "No Rating User" ,
207+ title : "No rating review" ,
208+ text : "This review has no rating." ,
209+ target : {
210+ typeId : "product" ,
211+ id : product . id ,
212+ } ,
213+ } ) ;
214+
215+ // Create a review with rating
216+ await supertest ( ctMock . app )
217+ . post ( "/dummy/reviews" )
218+ . send ( {
219+ authorName : "Rated User" ,
220+ title : "Rated review" ,
221+ rating : 4 ,
222+ target : {
223+ typeId : "product" ,
224+ id : product . id ,
225+ } ,
226+ } ) ;
227+
228+ const response = await supertest ( ctMock . app ) . get ( `/dummy/products/${ product . id } ) ;
229+
230+ expect ( response . status ) . toBe ( 200 ) ;
231+ // Only the review with rating should be counted
232+ expect ( response . body . reviewRatingStatistics ) . toBeDefined ( ) ;
233+ expect ( response . body . reviewRatingStatistics . count ) . toBe ( 1 ) ;
234+ expect ( response . body . reviewRatingStatistics . averageRating ) . toBe ( 4 ) ;
235+ } ) ;
236+ } ) ;
0 commit comments