fix(typeorm): fixed left join by default

Fixed using left join by default. Added "required" param to the join options fix #31, #98
nestjsx · Oct 2, 2019 · 3307348 · 3307348
1 parent f54ea53
commit 3307348
Show file tree

Hide file tree

Showing 4 changed files with 60 additions and 19 deletions.
diff --git a/integration/crud-typeorm/seeds.ts b/integration/crud-typeorm/seeds.ts
@@ -89,7 +89,8 @@ export class Seeds1544303473346 implements MigrationInterface {
       ('[email protected]', false, 2, 17, NULL, NULL),
       ('[email protected]', false, 2, 18, NULL, NULL),
       ('[email protected]', false, 2, 19, NULL, NULL),
-      ('[email protected]', false, 2, 20, NULL, NULL);
+      ('[email protected]', false, 2, 20, NULL, NULL),
+      ('[email protected]', false, 2, NULL, NULL, NULL);
     `);
   }
 

diff --git a/packages/crud-typeorm/src/typeorm-crud.service.ts b/packages/crud-typeorm/src/typeorm-crud.service.ts
@@ -395,7 +395,6 @@ export class TypeOrmCrudService<T> extends CrudService<T> {
         ...hash,
         [curr.propertyName]: {
           name: curr.propertyName,
-          type: this.getJoinType(curr.relationType),
           columns: curr.inverseEntityMetadata.columns.map((col) => col.propertyName),
           referencedColumn: (curr.joinColumns.length
             ? curr.joinColumns[0]
@@ -407,17 +406,6 @@ export class TypeOrmCrudService<T> extends CrudService<T> {
     );
   }
 
-  private getJoinType(relationType: string): string {
-    switch (relationType) {
-      case 'many-to-one':
-      case 'one-to-one':
-        return 'innerJoin';
-
-      default:
-        return 'leftJoin';
-    }
-  }
-
   private async getOneOrFail(req: CrudRequest): Promise<T> {
     const { parsed, options } = req;
     const builder = await this.createBuilder(parsed, options);
@@ -539,7 +527,6 @@ export class TypeOrmCrudService<T> extends CrudService<T> {
 
       this.entityRelationsHash[cond.field] = {
         name: curr.propertyName,
-        type: this.getJoinType(curr.relationType),
         columns: curr.inverseEntityMetadata.columns.map((col) => col.propertyName),
         referencedColumn: (curr.joinColumns.length
           ? /* istanbul ignore next */ curr.joinColumns[0]
@@ -572,8 +559,9 @@ export class TypeOrmCrudService<T> extends CrudService<T> {
       ].map((col) => `${relation.name}.${col}`);
 
       const relationPath = relation.nestedRelation || `${this.alias}.${relation.name}`;
+      const relationType = options.required ? 'innerJoin' : 'leftJoin';
 
-      builder[relation.type](relationPath, relation.name);
+      builder[relationType](relationPath, relation.name);
       builder.addSelect(select);
     }
 

diff --git a/packages/crud-typeorm/test/0.basic-crud.spec.ts b/packages/crud-typeorm/test/0.basic-crud.spec.ts
@@ -62,13 +62,49 @@ describe('#crud-typeorm', () => {
       constructor(public service: UsersService) {}
     }
 
+    @Crud({
+      model: { type: User },
+      query: {
+        join: {
+          profile: {
+            eager: true,
+            required: true,
+          },
+        },
+      },
+    })
+    @Controller('/users2')
+    class UsersController2 {
+      constructor(public service: UsersService) {}
+    }
+
+    @Crud({
+      model: { type: User },
+      query: {
+        join: {
+          profile: {
+            eager: true,
+          },
+        },
+      },
+    })
+    @Controller('/users3')
+    class UsersController3 {
+      constructor(public service: UsersService) {}
+    }
+
     beforeAll(async () => {
       const fixture = await Test.createTestingModule({
         imports: [
           TypeOrmModule.forRoot({ ...withCache, logging: false }),
           TypeOrmModule.forFeature([Company, Project, User, UserProfile]),
         ],
-        controllers: [CompaniesController, UsersController],
+        controllers: [
+          CompaniesController,
+          UsersController,
+          UsersController2,
+          UsersController3,
+        ],
         providers: [
           { provide: APP_FILTER, useClass: HttpExceptionFilter },
           CompaniesService,
@@ -328,7 +364,7 @@ describe('#crud-typeorm', () => {
       it('should return updated entity, 2', (done) => {
         const dto = { isActive: false, companyId: 5 };
         return request(server)
-          .patch('/companies/1/users/21')
+          .patch('/companies/1/users/22')
           .send(dto)
           .end((_, res) => {
             expect(res.status).toBe(200);
@@ -375,14 +411,29 @@ describe('#crud-typeorm', () => {
       });
       it('should return deleted entity', (done) => {
         return request(server)
-          .delete('/companies/1/users/21')
+          .delete('/companies/1/users/22')
           .end((_, res) => {
             expect(res.status).toBe(200);
-            expect(res.body.id).toBe(21);
+            expect(res.body.id).toBe(22);
             expect(res.body.companyId).toBe(1);
             done();
           });
       });
     });
+
+    describe('join options: required', () => {
+      const users2 = () => request(server).get('/users2/21');
+      const users3 = () => request(server).get('/users3/21');
+
+      it('should return status 404', async () => {
+        await users2().expect(404);
+      });
+
+      it('should return status 200', async () => {
+        const res = await users3().expect(200);
+        expect(res.body.id).toBe(21);
+        expect(res.body.profile).toBe(null);
+      });
+    });
   });
 });
diff --git a/packages/crud/src/interfaces/query-options.interface.ts b/packages/crud/src/interfaces/query-options.interface.ts
@@ -26,4 +26,5 @@ export interface JoinOption {
   exclude?: QueryFields;
   persist?: QueryFields;
   eager?: boolean;
+  required?: boolean;
 }