chore: project refactoring

przemyslawwalczak · przemyslawwalczak · commit 3fab7b7b2af1 · 2023-10-05T21:05:16.000+02:00
diff --git a/jest.config.json b/jest.config.json
@@ -1,18 +1,16 @@
 {
-    "moduleFileExtensions": [
-        "js",
-        "json",
-        "ts"
-    ],
-    "modulePaths": [
-        "<rootDir>",
-        "src"
-    ],
+    "moduleFileExtensions": ["js", "json", "ts"],
+    "modulePaths": ["<rootDir>", "src"],
+    "moduleNameMapper": {
+        "^lib/(.*)$": ["<rootDir>/src/lib/$1"],
+        "^nestjs/(.*)$": ["<rootDir>/src/nestjs/$1"],
+        "^test/(.*)$": ["<rootDir>/src/test/$1"]
+    },
     "rootDir": "./src",
     "testRegex": ".spec.ts$",
     "transform": {
         "^.+\\.(t|j)s$": "ts-jest"
     },
     "restoreMocks": true,
     "resetMocks": true
-}
+}
diff --git a/package.json b/package.json
@@ -11,14 +11,16 @@
         "build:package": "yarn tsc --declaration --project tsconfig.build.json",
         "build:replace-tspaths": "yarn tscpaths -p tsconfig.build.json -s ./src -o ./dist",
         "build": "rimraf dist && yarn build:package && yarn build:replace-tspaths",
-        "test": "jest --config=./jest.config.json"
+        "test": "jest --config=./jest.config.json",
+        "generate:random-data": "yarn ts-node ./src/test/scripts/generate-random-data.ts"
     },
     "keywords": [
         "nestjs",
         "pgds-common"
     ],
     "dependencies": {
         "@elastic/elasticsearch": "7.13.0",
+        "@faker-js/faker": "^8.1.0",
         "@nestjs/common": "10.2.6",
         "@nestjs/elasticsearch": "9.0.0",
         "class-validator": "0.14.0",
@@ -51,6 +53,7 @@
         "prettier": "3.0.3",
         "rimraf": "5.0.1",
         "ts-jest": "29.1.1",
+        "ts-node": "10.9.1",
         "tscpaths": "0.0.9",
         "typescript": "5.2.2"
     },
@@ -61,4 +64,4 @@
     "publishConfig": {
         "@propertyguru:registry": "https://npm.pkg.github.com/propertyguru"
     }
-}
+}
diff --git a/src/lib/aggregations/get-avg.spec.ts b/src/lib/aggregations/get-avg.spec.ts
@@ -1,24 +1,23 @@
-import { describe } from 'node:test'
-import { ExampleCatalogDocument } from 'test/module'
+import { HomeDocument } from 'test/module'
 import { getAvgAggregation } from './get-avg'
 
 describe('getAvgAggregation', () => {
-    it('accepts only schema fields', () => {
-        const query = getAvgAggregation<ExampleCatalogDocument>('field')
+    it('accepts only schema field', () => {
+        const query = getAvgAggregation<HomeDocument>('address')
 
         expect(query).toEqual({
             avg: {
-                field: 'field'
+                field: 'address'
             }
         })
     })
 
-    it('accepts only schema fields with keyword', () => {
-        const query = getAvgAggregation<ExampleCatalogDocument>('field.keyword')
+    it('accepts only schema field with keyword', () => {
+        const query = getAvgAggregation<HomeDocument>('address.keyword')
 
         expect(query).toEqual({
             avg: {
-                field: 'field.keyword'
+                field: 'address.keyword'
             }
         })
     })
diff --git a/src/lib/aggregations/get-sum.spec.ts b/src/lib/aggregations/get-sum.spec.ts
@@ -1,24 +1,23 @@
-import { describe } from 'node:test'
-import { ExampleCatalogDocument } from 'test/module'
+import { HomeDocument } from 'test/module'
 import { getSumAggregation } from './get-sum'
 
 describe('getSumAggregation', () => {
-    it('accepts only schema fields', () => {
-        const query = getSumAggregation<ExampleCatalogDocument>('field')
+    it('accepts only schema field', () => {
+        const query = getSumAggregation<HomeDocument>('address')
 
         expect(query).toEqual({
             sum: {
-                field: 'field'
+                field: 'address'
             }
         })
     })
 
-    it('accepts only schema fields with keyword', () => {
-        const query = getSumAggregation<ExampleCatalogDocument>('field.keyword')
+    it('accepts only schema field with keyword', () => {
+        const query = getSumAggregation<HomeDocument>('address.keyword')
 
         expect(query).toEqual({
             sum: {
-                field: 'field.keyword'
+                field: 'address.keyword'
             }
         })
     })
diff --git a/src/lib/queries/get-bool-should.ts b/src/lib/queries/get-bool-should.ts
diff --git a/src/lib/queries/get-bool.spec.ts b/src/lib/queries/get-bool.spec.ts
@@ -0,0 +1,4 @@
+describe('getBoolQuery', () => {
+    test.todo('accepts optional must query')
+    test.todo('accepts optional should query')
+})
diff --git a/src/lib/queries/get-bool.ts b/src/lib/queries/get-bool.ts
@@ -1,10 +1,10 @@
 import { Document } from 'lib/types'
-import { getBoolMustQuery } from './get-bool-must'
-import { getBoolShouldQuery } from './get-bool-should'
+import { getMustQuery } from './get-must'
+import { getShouldQuery } from './get-should'
 
 export type BoolQuery<TDocument extends Document> = {
-    must?: ReturnType<typeof getBoolMustQuery<TDocument>>
-    should?: ReturnType<typeof getBoolShouldQuery<TDocument>>
+    must?: ReturnType<typeof getMustQuery<TDocument>>
+    should?: ReturnType<typeof getShouldQuery<TDocument>>
 }
 
 export const getBoolQuery = <TDocument extends Document>(bool: BoolQuery<TDocument>) => ({
diff --git a/src/lib/queries/get-must.spec.ts b/src/lib/queries/get-must.spec.ts
@@ -0,0 +1,4 @@
+describe('getMustQuery', () => {
+    test.todo('accepts optional term query')
+    test.todo('accepts optional terms query')
+})
diff --git a/src/lib/queries/get-must.ts b/src/lib/queries/get-must.ts
@@ -2,9 +2,9 @@ import { Document } from 'lib/types'
 import { getTermQuery } from './get-term'
 import { getTermsQuery } from './get-terms'
 
-export type BoolMustQuery<TDocument extends Document> = {
+export type MustQuery<TDocument extends Document> = {
     term?: ReturnType<typeof getTermQuery<TDocument>>
     terms?: ReturnType<typeof getTermsQuery<TDocument>>
 }
 
-export const getBoolMustQuery = <TDocument extends Document>(query: BoolMustQuery<TDocument> | Array<BoolMustQuery<TDocument>>) => query
+export const getMustQuery = <TDocument extends Document>(query: MustQuery<TDocument> | Array<MustQuery<TDocument>>) => query
diff --git a/src/lib/queries/get-should.spec.ts b/src/lib/queries/get-should.spec.ts
@@ -0,0 +1,4 @@
+describe('getShouldQuery', () => {
+    test.todo('accepts optional term query')
+    test.todo('accepts optional terms query')
+})
diff --git a/src/lib/queries/get-should.ts b/src/lib/queries/get-should.ts
@@ -0,0 +1,9 @@
+import { Document } from 'lib/types'
+import { getTermQuery } from './get-term'
+import { getTermsQuery } from './get-terms'
+
+export type ShouldQuery<TDocument extends Document> = ReturnType<typeof getTermQuery<TDocument>> | ReturnType<typeof getTermsQuery<TDocument>>
+
+export const getShouldQuery = <TDocument extends Document>(should: ShouldQuery<TDocument> | Array<ShouldQuery<TDocument>>) => ({
+    should
+})
diff --git a/src/lib/queries/get-term.spec.ts b/src/lib/queries/get-term.spec.ts
@@ -1,26 +1,25 @@
-import { describe } from 'node:test'
 import { getTermQuery } from './get-term'
-import { ExampleCatalogDocument } from 'test/module'
+import { HomeDocument } from 'test/module'
 
 describe('getTermQuery', () => {
     it('accepts only schema fields', () => {
-        const query = getTermQuery<ExampleCatalogDocument>('field', 'test')
+        const query = getTermQuery<HomeDocument>('address', 'test')
 
         expect(query).toEqual({
             term: {
-                field: {
+                address: {
                     value: 'test'
                 }
             }
         })
     })
 
     it('accepts only schema fields with keyword', () => {
-        const query = getTermQuery<ExampleCatalogDocument>('field.keyword', 'test')
+        const query = getTermQuery<HomeDocument>('address.keyword', 'test')
 
         expect(query).toEqual({
             term: {
-                'field.keyword': {
+                'address.keyword': {
                     value: 'test'
                 }
             }
diff --git a/src/lib/queries/get-terms.spec.ts b/src/lib/queries/get-terms.spec.ts
@@ -1,24 +1,23 @@
-import { describe } from 'node:test'
 import { getTermsQuery } from './get-terms'
-import { ExampleCatalogDocument } from 'test/module'
+import { HomeDocument } from 'test/module'
 
 describe('getTermsQuery', () => {
     it('accepts only schema fields', () => {
-        const query = getTermsQuery<ExampleCatalogDocument>('field', ['one', 'two', 'three'])
+        const query = getTermsQuery<HomeDocument>('address', ['one', 'two', 'three'])
 
         expect(query).toEqual({
             terms: {
-                field: ['one', 'two', 'three']
+                address: ['one', 'two', 'three']
             }
         })
     })
 
     it('accepts only schema field with keyword', () => {
-        const query = getTermsQuery<ExampleCatalogDocument>('field.keyword', ['one', 'two', 'three'])
+        const query = getTermsQuery<HomeDocument>('address.keyword', ['one', 'two', 'three'])
 
         expect(query).toEqual({
             terms: {
-                'field.keyword': ['one', 'two', 'three']
+                'address.keyword': ['one', 'two', 'three']
             }
         })
     })
diff --git a/src/test/module/enums.ts b/src/test/module/enums.ts
@@ -0,0 +1,4 @@
+export enum PropertyType {
+    Apartment = 'Apartment',
+    Flat = 'Flat'
+}
diff --git a/src/test/module/example.catalog.ts b/src/test/module/example.catalog.ts
diff --git a/src/test/module/homes.catalog.ts b/src/test/module/homes.catalog.ts
@@ -0,0 +1,39 @@
+import { IsString, IsEnum, IsNumber, IsBoolean, IsOptional } from 'class-validator'
+import { Catalog } from 'nestjs/decorators'
+import { PropertyType } from './enums'
+
+@Catalog('homes')
+export class HomeDocument {
+    @IsString()
+    readonly id: string
+
+    @IsString()
+    readonly fullName: string
+
+    @IsString()
+    readonly ownerEmail: string
+
+    @IsString()
+    readonly address: string
+
+    @IsString()
+    readonly city: string
+
+    @IsBoolean()
+    readonly hasProperty: boolean
+
+    @IsEnum(PropertyType)
+    readonly propertyType: PropertyType
+
+    @IsNumber()
+    @IsOptional()
+    readonly builtInYear?: number
+
+    @IsString()
+    @IsOptional()
+    readonly propertyAreaSquared?: number
+
+    @IsString()
+    @IsOptional()
+    readonly propertyAreaSquaredAsString?: number
+}
diff --git a/src/test/module/index.ts b/src/test/module/index.ts
@@ -1 +1 @@
-export * from './example.catalog'
+export * from './homes.catalog'
diff --git a/src/test/scripts/es-seed.ts b/src/test/scripts/es-seed.ts
diff --git a/src/test/scripts/generate-random-data.ts b/src/test/scripts/generate-random-data.ts
@@ -0,0 +1,33 @@
+import { faker } from '@faker-js/faker'
+import { writeFileSync } from 'node:fs'
+import { join } from 'node:path'
+
+const ELASTICSEARCH_SEED_CATALOG_FILENAME = join(process.cwd(), 'src/test/seeds/homes.seed.json')
+const DOCUMENTS_COUNT = 100
+
+const data = new Array(DOCUMENTS_COUNT).fill(null).map(() => {
+    const id = faker.string.uuid()
+    const name = faker.person.fullName()
+    const builtInYear = faker.number.int({ min: 1995, max: 2015 })
+    const ownerEmail = faker.internet.email()
+    const address = faker.location.streetAddress()
+    const city = faker.location.city()
+
+    const hasProperty = faker.number.int({ min: 0, max: 1 })
+    const hasPropertyAreaSquared = faker.number.int({ min: 0, max: 1 })
+    const areaSquared = faker.number.int({ min: 1, max: 1_000_000 })
+
+    return {
+        id,
+        fullName: name,
+        ownerEmail,
+        address,
+        city,
+        hasProperty: hasProperty ? true : false,
+        builtInYear: hasProperty ? builtInYear : null,
+        propertyAreaSquared: hasProperty && hasPropertyAreaSquared ? areaSquared : null,
+        propertyAreaSquaredAsString: hasProperty && hasPropertyAreaSquared ? areaSquared.toString() : null
+    }
+})
+
+writeFileSync(ELASTICSEARCH_SEED_CATALOG_FILENAME, JSON.stringify(data, null, 4))
diff --git a/src/test/seeds/homes.seed.json b/src/test/seeds/homes.seed.json
diff --git a/yarn.lock b/yarn.lock
