Merge pull request #267 from jiho-kr/feature/search-offset-pagination

feat: support offset Pagination on search

.github/workflows/ci.yml

@@ -56,7 +56,6 @@ jobs:
 
             - name: Coveralls
               uses: coverallsapp/github-action@v2
-
 #  https://github.com/actions/typescript-action/blob/main/.github/workflows/codeql-analysis.yml
 
 #  https://github.com/actions/typescript-action/blob/main/.github/workflows/test.yml

.github/workflows/codeql-analysis.yml

@@ -1,61 +1,61 @@
 name: 'CodeQL'
 
 on:
-  push:
-    branches: [main]
-  pull_request:
-    # The branches below must be a subset of the branches above
-    branches: [main]
-  schedule:
-    - cron: "0 17 * * 4"
+    push:
+        branches: [main]
+    pull_request:
+        # The branches below must be a subset of the branches above
+        branches: [main]
+    schedule:
+        - cron: '0 17 * * 4'
 
 permissions:
-  contents: read
+    contents: read
 
 jobs:
-  analyse:
-    permissions:
-      security-events: write
-    name: Analyse
-    runs-on: ubuntu-latest
-
-    steps:
-      - name: Checkout repository
-        uses: actions/checkout@v3
-        with:
-          # We must fetch at least the immediate parents so that if this is
-          # a pull request then we can checkout the head.
-          fetch-depth: 2
-
-      # If this run was triggered by a pull request event, then checkout
-      # the head of the pull request instead of the merge commit.
-      - run: git checkout HEAD^2
-        if: ${{ github.event_name == 'pull_request' }}
-
-      # Initializes the CodeQL tools for scanning.
-      - name: Initialize CodeQL
-        uses: github/codeql-action/init@v2
-        with:
-          queries: +security-extended
-        # Override language selection by uncommenting this and choosing your languages
-        # with:
-        #   languages: go, javascript, csharp, python, cpp, java
-
-      # Autobuild attempts to build any compiled languages  (C/C++, C#, or Java).
-      # If this step fails, then you should remove it and run the build manually (see below)
-      - name: Autobuild
-        uses: github/codeql-action/autobuild@v2
-
-      # ℹ️ Command-line programs to run using the OS shell.
-      # 📚 https://git.io/JvXDl
-
-      # ✏️ If the Autobuild fails above, remove it and uncomment the following three lines
-      #    and modify them (or add more) to build your code if your project
-      #    uses a compiled language
-
-      #- run: |
-      #   make bootstrap
-      #   make release
-
-      - name: Perform CodeQL Analysis
-        uses: github/codeql-action/analyze@v2
+    analyse:
+        permissions:
+            security-events: write
+        name: Analyse
+        runs-on: ubuntu-latest
+
+        steps:
+            - name: Checkout repository
+              uses: actions/checkout@v3
+              with:
+                  # We must fetch at least the immediate parents so that if this is
+                  # a pull request then we can checkout the head.
+                  fetch-depth: 2
+
+            # If this run was triggered by a pull request event, then checkout
+            # the head of the pull request instead of the merge commit.
+            - run: git checkout HEAD^2
+              if: ${{ github.event_name == 'pull_request' }}
+
+            # Initializes the CodeQL tools for scanning.
+            - name: Initialize CodeQL
+              uses: github/codeql-action/init@v2
+              with:
+                  queries: +security-extended
+              # Override language selection by uncommenting this and choosing your languages
+              # with:
+              #   languages: go, javascript, csharp, python, cpp, java
+
+            # Autobuild attempts to build any compiled languages  (C/C++, C#, or Java).
+            # If this step fails, then you should remove it and run the build manually (see below)
+            - name: Autobuild
+              uses: github/codeql-action/autobuild@v2
+
+            # ℹ️ Command-line programs to run using the OS shell.
+            # 📚 https://git.io/JvXDl
+
+            # ✏️ If the Autobuild fails above, remove it and uncomment the following three lines
+            #    and modify them (or add more) to build your code if your project
+            #    uses a compiled language
+
+            #- run: |
+            #   make bootstrap
+            #   make release
+
+            - name: Perform CodeQL Analysis
+              uses: github/codeql-action/analyze@v2

.vscode/settings.json

@@ -1,4 +1,4 @@
 {
-    "cSpell.words": ["Denormalized", "ILIKE", "nestjs", "Pgsql", "typeorm"],
+    "cSpell.words": ["Denormalized", "ILIKE", "metatype", "nestjs", "Pgsql", "typeorm"],
     "typescript.tsdk": "node_modules/typescript/lib"
 }

docker-compose.test.yml

@@ -12,8 +12,6 @@ services:
             - --collation-server=utf8mb4_unicode_ci
         ports:
             - '3306:3306'
-        volumes:
-            - 'mysql_data:/var/lib/mysql'
 
     postgresql:
         image: postgres:latest
@@ -24,10 +22,3 @@ services:
             POSTGRES_PASSWORD: $POSTGRESQL_DATABASE_PASSWORD
         ports:
             - '5432:5432'
-        volumes:
-            - postgresql_data:/var/lib/postgresql/data
-volumes:
-    mysql_data:
-        driver: local
-    postgresql_data:
-        driver: local

spec/auth-guard/auth-guard.spec.ts

@@ -9,7 +9,7 @@ import { TestHelper } from '../test.helper';
 describe('AuthGuard', () => {
     let app: INestApplication;
 
-    beforeEach(async () => {
+    beforeAll(async () => {
         const moduleFixture: TestingModule = await Test.createTestingModule({
             imports: [AuthGuardModule, TestHelper.getTypeOrmMysqlModule([BaseEntity])],
         }).compile();
@@ -19,7 +19,7 @@ describe('AuthGuard', () => {
         await app.init();
     });
 
-    afterEach(async () => {
+    afterAll(async () => {
         await TestHelper.dropTypeOrmEntityTables();
         await app?.close();
     });

spec/author/author-object.spec.ts

@@ -8,15 +8,15 @@ import { TestHelper } from '../test.helper';
 describe('Author - object', () => {
     let app: INestApplication;
 
-    beforeEach(async () => {
+    beforeAll(async () => {
         const moduleFixture: TestingModule = await Test.createTestingModule({
             imports: [TestModule, TestHelper.getTypeOrmPgsqlModule([TestEntity])],
         }).compile();
         app = moduleFixture.createNestApplication();
         await app.init();
     });
 
-    afterEach(async () => {
+    afterAll(async () => {
         await TestHelper.dropTypeOrmEntityTables();
         await app?.close();
     });

spec/author/author-value.spec.ts

@@ -8,15 +8,15 @@ import { TestHelper } from '../test.helper';
 describe('Author', () => {
     let app: INestApplication;
 
-    beforeEach(async () => {
+    beforeAll(async () => {
         const moduleFixture: TestingModule = await Test.createTestingModule({
             imports: [TestModule, TestHelper.getTypeOrmMysqlModule([TestEntity])],
         }).compile();
         app = moduleFixture.createNestApplication();
         await app.init();
     });
 
-    afterEach(async () => {
+    afterAll(async () => {
         await TestHelper.dropTypeOrmEntityTables();
         await app?.close();
     });

spec/author/author.interceptor.ts

@@ -1,6 +1,5 @@
 import { CallHandler, ExecutionContext, Injectable, NestInterceptor } from '@nestjs/common';
 import { Request } from 'express';
-import _ from 'lodash';
 
 @Injectable()
 export class AuthorInterceptor implements NestInterceptor {

spec/author/author.spec.ts

@@ -8,15 +8,15 @@ import { TestHelper } from '../test.helper';
 describe('Author', () => {
     let app: INestApplication;
 
-    beforeEach(async () => {
+    beforeAll(async () => {
         const moduleFixture: TestingModule = await Test.createTestingModule({
             imports: [TestModule, TestHelper.getTypeOrmMysqlModule([TestEntity])],
         }).compile();
         app = moduleFixture.createNestApplication();
         await app.init();
     });
 
-    afterEach(async () => {
+    afterAll(async () => {
         await TestHelper.dropTypeOrmEntityTables();
         await app?.close();
     });

spec/base/base.controller.create.spec.ts

@@ -4,26 +4,25 @@ import request from 'supertest';
 
 import { BaseEntity } from './base.entity';
 import { BaseModule } from './base.module';
-import { BaseService } from './base.service';
 import { TestHelper } from '../test.helper';
 
 describe('BaseController', () => {
     let app: INestApplication;
-    let service: BaseService;
 
-    beforeEach(async () => {
+    beforeAll(async () => {
         const moduleFixture: TestingModule = await Test.createTestingModule({
             imports: [BaseModule, TestHelper.getTypeOrmMysqlModule([BaseEntity])],
         }).compile();
         app = moduleFixture.createNestApplication();
 
-        service = moduleFixture.get<BaseService>(BaseService);
-        await Promise.all(['name1', 'name2'].map((name: string) => service.repository.save(service.repository.create({ name }))));
-
         await app.init();
     });
 
-    afterEach(async () => {
+    beforeEach(async () => {
+        await BaseEntity.delete({});
+    });
+
+    afterAll(async () => {
         await TestHelper.dropTypeOrmEntityTables();
         await app?.close();
     });

spec/base/base.controller.delete.spec.ts

@@ -9,7 +9,7 @@ import { TestHelper } from '../test.helper';
 describe('BaseController', () => {
     let app: INestApplication;
 
-    beforeEach(async () => {
+    beforeAll(async () => {
         const moduleFixture: TestingModule = await Test.createTestingModule({
             imports: [BaseModule, TestHelper.getTypeOrmMysqlModule([BaseEntity])],
         }).compile();
@@ -18,7 +18,11 @@ describe('BaseController', () => {
         await app.init();
     });
 
-    afterEach(async () => {
+    beforeEach(async () => {
+        await BaseEntity.delete({});
+    });
+
+    afterAll(async () => {
         await TestHelper.dropTypeOrmEntityTables();
         await app?.close();
     });

spec/base/base.controller.read-many.spec.ts

@@ -8,7 +8,7 @@ import { TestHelper } from '../test.helper';
 describe('BaseController', () => {
     let app: INestApplication;
 
-    beforeEach(async () => {
+    beforeAll(async () => {
         const moduleFixture: TestingModule = await Test.createTestingModule({
             imports: [BaseModule, TestHelper.getTypeOrmMysqlModule([BaseEntity])],
         }).compile();
@@ -17,7 +17,7 @@ describe('BaseController', () => {
         await app.init();
     });
 
-    afterEach(async () => {
+    afterAll(async () => {
         await TestHelper.dropTypeOrmEntityTables();
         await app?.close();
     });

spec/base/base.controller.read-one.spec.ts

@@ -11,7 +11,7 @@ describe('BaseController', () => {
     let app: INestApplication;
     let service: BaseService;
 
-    beforeEach(async () => {
+    beforeAll(async () => {
         const moduleFixture: TestingModule = await Test.createTestingModule({
             imports: [BaseModule, TestHelper.getTypeOrmMysqlModule([BaseEntity])],
         }).compile();
@@ -23,7 +23,7 @@ describe('BaseController', () => {
         await app.init();
     });
 
-    afterEach(async () => {
+    afterAll(async () => {
         await TestHelper.dropTypeOrmEntityTables();
         await app?.close();
     });
@@ -36,14 +36,14 @@ describe('BaseController', () => {
         });
 
         it('should be returned only one entity', async () => {
-            const response = await request(app.getHttpServer())
+            const { body } = await request(app.getHttpServer())
                 .get(`/base/${id}`)
-                .query({ fields: ['id', 'name', 'createdAt'] });
+                .query({ fields: ['id', 'name', 'createdAt'] })
+                .expect(HttpStatus.OK);
 
-            expect(response.statusCode).toEqual(HttpStatus.OK);
-            expect(response.body.id).toEqual(id);
-            expect(response.body.name).toEqual(expect.any(String));
-            expect(response.body.lastModifiedAt).toBeUndefined();
+            expect(body.id).toEqual(id);
+            expect(body.name).toEqual(expect.any(String));
+            expect(body.lastModifiedAt).toBeUndefined();
         });
 
         it('should be fields feature with multiple options', async () => {