feat: test service for injection

Author: przemyslawwalczak

src/lib/decorators/inject-catalog.decorator.ts

@@ -1,4 +1,14 @@
 import { Inject } from '@nestjs/common'
+import { ELASTICSEARCH_CATALOG_NAME } from 'lib/constants'
+import { ClassConstructor, Document } from 'lib/types'
 import { getCatalogInjectionToken } from 'nestjs/utils'
 
-export const InjectCatalog = (index: string) => Inject(getCatalogInjectionToken(index))
+export const InjectCatalog = <TDocument extends Document>(document: ClassConstructor<TDocument>) => {
+    const index = Reflect.getMetadata(ELASTICSEARCH_CATALOG_NAME, document)
+
+    if (!index) {
+        throw new Error('Failed to find registered catalog index')
+    }
+
+    return Inject(getCatalogInjectionToken(index))
+}

src/test/features/2-querying-catalog-in-other-service.spec.ts

@@ -1,13 +1,11 @@
 import { setupNestApplication } from 'test/toolkit'
 import { ElasticsearchModule } from 'nestjs/elasticsearch.module'
-import { HomeDocument, PropertyType } from 'test/module'
-import { getBoolQuery, getTermQuery } from 'lib/queries'
+import { HomeDocument, TestService } from 'test/module'
 import { validateSync } from 'class-validator'
-import { getCatalogInjectionToken } from 'nestjs/utils'
-import { Catalog } from 'nestjs/injectables'
 
 describe('Making a search', () => {
     const { app } = setupNestApplication({
+        providers: [TestService],
         imports: [
             ElasticsearchModule.register({
                 node: 'http://localhost:9200'
@@ -19,24 +17,14 @@ describe('Making a search', () => {
     })
 
     it('has catalog available', () => {
-        const catalog = app.get<Catalog<HomeDocument>>(getCatalogInjectionToken('homes'))
+        const catalog = app.get(TestService)
 
         expect(catalog).toBeDefined()
     })
 
     it('makes a test search query', async () => {
-        const catalog = app.get<Catalog<HomeDocument>>(getCatalogInjectionToken('homes'))
-        const result = await catalog.search({
-            size: 10,
-            body: {
-                query: getBoolQuery({
-                    must: [
-                        getTermQuery('propertyType.keyword', PropertyType.Flat)
-                    ]
-                })
-            }
-        })
-
+        const service = app.get(TestService)
+        const result = await service.getHomeDocuments()
         const allDocumentsAreValid = result.documents.every(document => {
             const errors = validateSync(document)
 

src/test/module/index.ts

@@ -1,2 +1,3 @@
 export * from './homes.catalog'
 export * from './enums'
+export * from './test.service'

src/test/module/test.service.ts

@@ -0,0 +1,25 @@
+import { Injectable } from '@nestjs/common'
+import { InjectCatalog } from 'lib/decorators'
+import { getBoolQuery, getTermQuery } from 'lib/queries'
+import { Catalog } from 'nestjs/injectables'
+import { PropertyType } from './enums'
+import { HomeDocument } from './homes.catalog'
+
+@Injectable()
+export class TestService {
+    @InjectCatalog(HomeDocument)
+    private readonly homes: Catalog<HomeDocument>
+
+    getHomeDocuments() {
+        return this.homes.search({
+            size: 10,
+            body: {
+                query: getBoolQuery({
+                    must: [
+                        getTermQuery('propertyType.keyword', PropertyType.Flat)
+                    ]
+                })
+            }
+        })
+    }
+}