Feat:UTH-237 Get Published Lisings by RentalObjectCode (#42)

To be able to show the parking space detail page on mimer.nu we need to be able to retrieve published listings by RentalObjectCode.
* filter on RentalObjectCode has been added to GET /listings in both core and lesing

Author: mittistormen

core/src/adapters/leasing-adapter/listings.ts

@@ -208,6 +208,7 @@ type GetListingsParams = {
   listingCategory?: 'PARKING_SPACE' | 'APARTMENT' | 'STORAGE'
   published?: boolean
   rentalRule?: 'SCORED' | 'NON_SCORED'
+  rentalObjectCode?: string
 }
 
 const getListings = async (
@@ -219,6 +220,8 @@ const getListings = async (
   if (params.published !== undefined)
     queryParams.append('published', params.published.toString())
   if (params.rentalRule) queryParams.append('rentalRule', params.rentalRule)
+  if (params.rentalObjectCode)
+    queryParams.append('rentalObjectCode', params.rentalObjectCode)
 
   try {
     const response = await axios.get(

core/src/adapters/tests/leasing-adapter/listings.test.ts

@@ -217,4 +217,23 @@ describe(leasingAdapter.getListings, () => {
       ]),
     })
   })
+
+  it('returns a list listings filtered on published and rentalObjectCode', async () => {
+    nock(config.tenantsLeasesService.url)
+      .get('/listings')
+      .query({ rentalObjectCode: 'ABC1234', published: true })
+      .reply(200, { content: factory.listing.buildList(4) })
+
+    const result = await leasingAdapter.getListings({
+      rentalObjectCode: 'ABC1234',
+      published: true,
+    })
+
+    expect(result).toMatchObject({
+      ok: true,
+      data: expect.arrayContaining([
+        expect.objectContaining({ id: expect.any(Number) }),
+      ]),
+    })
+  })
 })

core/src/services/lease-service/listings.ts

@@ -49,6 +49,12 @@ export const routes = (router: KoaRouter) => {
    *         schema:
    *           type: string
    *         description: A contact code to filter out listings that are not valid to rent for the contact.
+   *       - in: query
+   *         name: rentalObjectCode
+   *         required: false
+   *         schema:
+   *           type: string
+   *         description: A Rental Object Code to filter the listings.
    *     responses:
    *       '200':
    *         description: Successful response with the requested list of listings.
@@ -73,6 +79,7 @@ export const routes = (router: KoaRouter) => {
           .transform((value) => (value ? value === 'true' : undefined)),
         rentalRule: z.enum(['SCORED', 'NON_SCORED']).optional(),
         validToRentForContactCode: z.string().optional(),
+        rentalObjectCode: z.string().optional(),
       })
       const query = querySchema.safeParse(ctx.query)
 
@@ -82,6 +89,7 @@ export const routes = (router: KoaRouter) => {
         listingCategory: query.data?.listingCategory,
         published: query.data?.published,
         rentalRule: query.data?.rentalRule,
+        rentalObjectCode: query.data?.rentalObjectCode,
       })
 
       if (!result.ok) {

core/src/services/lease-service/tests/listings.test.ts

@@ -64,6 +64,34 @@ describe('GET /listings', () => {
     })
   })
 
+  it('responds with 200 on success with filter on published', async () => {
+    const listing = factory.listing.build({
+      id: 1337,
+      publishedFrom: new Date(),
+      publishedTo: new Date(),
+      rentalObjectCode: '12345',
+    })
+    const parkingSpace = factory.vacantParkingSpace.build({
+      rentalObjectCode: '12345',
+    })
+
+    const getListingsSpy = jest
+      .spyOn(tenantLeaseAdapter, 'getListings')
+      .mockResolvedValueOnce({ ok: true, data: [listing] })
+
+    jest
+      .spyOn(tenantLeaseAdapter, 'getParkingSpaces')
+      .mockResolvedValueOnce({ ok: true, data: [parkingSpace] })
+
+    const res = await request(app.callback()).get('/listings?published=true')
+
+    expect(getListingsSpy).toHaveBeenCalledWith({ published: true })
+    expect(res.status).toBe(200)
+    expect(res.body).toEqual({
+      content: [expect.objectContaining({ id: 1337 })],
+    })
+  })
+
   it('responds with 200 on success with filter on rentalRule', async () => {
     const listing = factory.listing.build({
       id: 1337,
@@ -96,6 +124,40 @@ describe('GET /listings', () => {
     })
   })
 
+  it('responds with 200 on success with filter on rentalObjectCode', async () => {
+    const listing = factory.listing.build({
+      id: 1337,
+      rentalRule: 'SCORED',
+      rentalObjectCode: '12345',
+    })
+    const parkingSpace = factory.vacantParkingSpace.build({
+      rentalObjectCode: '12345',
+    })
+
+    const getListingsSpy = jest
+      .spyOn(tenantLeaseAdapter, 'getListings')
+      .mockResolvedValueOnce({ ok: true, data: [listing] })
+
+    jest
+      .spyOn(tenantLeaseAdapter, 'getParkingSpaces')
+      .mockResolvedValueOnce({ ok: true, data: [parkingSpace] })
+
+    const res = await request(app.callback()).get(
+      '/listings?rentalObjectCode=12345'
+    )
+
+    expect(getListingsSpy).toHaveBeenCalledWith({
+      rentalObjectCode: '12345',
+      published: undefined,
+      listingCategory: undefined,
+      validToRentForContactCode: undefined,
+    })
+    expect(res.status).toBe(200)
+    expect(res.body).toEqual({
+      content: [expect.objectContaining({ id: 1337 })],
+    })
+  })
+
   it('responds with 200 on success with filter on validToRentForContactCode', async () => {
     const listing = factory.listing.build({
       id: 1337,

services/leasing/src/services/lease-service/adapters/listing-adapter.ts

@@ -342,6 +342,7 @@ type GetListingsParams = {
   listingCategory?: 'PARKING_SPACE' | 'APARTMENT' | 'STORAGE'
   published?: boolean
   rentalRule?: 'SCORED' | 'NON_SCORED'
+  rentalObjectCode?: string
 }
 
 const getListings = async (
@@ -364,6 +365,9 @@ const getListings = async (
       if (params.listingCategory) {
         builder.andWhere('ListingCategory', '=', params.listingCategory)
       }
+      if (params.rentalObjectCode) {
+        builder.andWhere('RentalObjectCode', '=', params.rentalObjectCode)
+      }
     })
 
     return { ok: true, data: listings.map(transformFromDbListing) }

services/leasing/src/services/lease-service/routes/listings.ts

@@ -51,6 +51,12 @@ export const routes = (router: KoaRouter) => {
    *         schema:
    *           type: string
    *         description: The rental rule for the listings, either SCORED or NON_SCORED.
+   *       - in: query
+   *         name: rentalObjectCode
+   *         required: false
+   *         schema:
+   *           type: string
+   *         description: The rental object code for the listings.
    *     responses:
    *       '200':
    *         description: Successful response with the requested list of listings.
@@ -73,17 +79,17 @@ export const routes = (router: KoaRouter) => {
         .optional()
         .transform((value) => value === 'true'),
       rentalRule: z.enum(['SCORED', 'NON_SCORED']).optional(),
+      rentalObjectCode: z.string().optional(),
     })
     const query = querySchema.safeParse(ctx.query)
 
     const result = await listingAdapter.getListings({
       listingCategory: query.data?.listingCategory,
       published: query.data?.published,
       rentalRule: query.data?.rentalRule,
+      rentalObjectCode: query.data?.rentalObjectCode,
     })
 
-    //TODO: get correponding rental objects from xpand-adapter and add them to the listings
-
     if (!result.ok) {
       ctx.status = 500
       ctx.body = {

services/leasing/src/services/lease-service/tests/adapters/listing-adapter/get-listings.test.ts

@@ -94,6 +94,38 @@ describe(listingAdapter.getListings, () => {
       }
     }))
 
+  it('should filter on rentalObjectCode', () =>
+    withContext(async (ctx) => {
+      // Create listings
+      await listingAdapter.createListing(
+        factory.listing.build({
+          rentalObjectCode: '1',
+          rentalRule: 'SCORED',
+          status: ListingStatus.Active,
+        }),
+        ctx.db
+      )
+
+      await listingAdapter.createListing(
+        factory.listing.build({
+          rentalObjectCode: '2',
+          rentalRule: 'NON_SCORED',
+          status: ListingStatus.Active,
+        }),
+        ctx.db
+      )
+
+      const result = await listingAdapter.getListings(
+        { rentalObjectCode: '1' },
+        ctx.db
+      )
+
+      expect(result.ok).toBe(true)
+      if (result.ok) {
+        expect(result.data).toHaveLength(1)
+        expect(result.data[0].rentalObjectCode).toEqual('1')
+      }
+    }))
   it('should return a list of listings', () =>
     withContext(async (ctx) => {
       // Create listings

services/leasing/src/services/lease-service/tests/routes/listings.test.ts

@@ -129,6 +129,33 @@ describe('GET /listings', () => {
     })
   })
 
+  it('responds with 200 and listings with filter for a published rentalObjectCode', async () => {
+    const getListingsSpy = jest
+      .spyOn(listingAdapter, 'getListings')
+      .mockResolvedValueOnce({
+        ok: true,
+        data: factory.listing.buildList(1),
+      })
+
+    const res = await request(app.callback()).get(
+      '/listings?rentalObjectCode=1&published=true'
+    )
+
+    expect(getListingsSpy).toHaveBeenCalledWith({
+      rentalObjectCode: '1',
+      published: true,
+      rentalRule: undefined,
+      listingCategory: undefined,
+    })
+
+    expect(res.status).toBe(200)
+    expect(res.body).toEqual({
+      content: expect.arrayContaining([
+        expect.objectContaining({ id: expect.any(Number) }),
+      ]),
+    })
+  })
+
   it('responds with 500 on unknown error', async () => {
     jest.spyOn(listingAdapter, 'getListings').mockResolvedValueOnce({
       ok: false,