Merge pull request #36 from Mites-G/unique-relations

Only return unique values in relationship object response

Author: klerick

libs/json-api-nestjs/src/lib/mixin/service/transform/transform.mixin.ts

@@ -186,10 +186,21 @@ export class TransformMixinService<T> {
         const propsData = data[field];
         const typeName = getEntityName(this.relationTarget.get(field));
         if (Array.isArray(propsData)) {
-          builtData.data = propsData.map((i) => ({
-            type: camelToKebab(typeName),
-            id: i[this.relationPrimaryField.get(field)].toString(),
-          }));
+          const tmp = propsData.reduce((acum, item) => {
+            const key = `${camelToKebab(typeName)}:${item[
+              this.relationPrimaryField.get(field)
+            ].toString()}`;
+
+            if (!acum.has(key)) {
+              acum.set(key, {
+                type: camelToKebab(typeName),
+                id: item[this.relationPrimaryField.get(field)].toString(),
+              });
+            }
+
+            return acum;
+          }, new Map());
+          builtData.data = [...tmp.values()];
         }
 
         if (!Array.isArray(data[field]) && typeof data[field] !== 'undefined') {

libs/json-api-nestjs/src/lib/mixin/service/typeorm/methods/get-one/get-one.spec.ts

@@ -3,7 +3,14 @@ import { getDataSourceToken, getRepositoryToken } from '@nestjs/typeorm';
 import { BadRequestException, NotFoundException } from '@nestjs/common';
 
 import { TypeormMixinService } from '../../typeorm.mixin';
-import { mockDBTestModule, Users, Addresses } from '../../../../../mock-utils';
+import {
+  mockDBTestModule,
+  Users,
+  Addresses,
+  Notes,
+  Comments,
+  Roles,
+} from '../../../../../mock-utils';
 import { ConfigParam, QueryField, QueryParams } from '../../../../../types';
 import { DataSource, Repository } from 'typeorm';
 import {
@@ -84,11 +91,42 @@ describe('GetOne methode test', () => {
       })
     );
 
+    await repository.manager.getRepository(Roles).save(
+      Object.assign(new Roles(), {
+        name: 'user',
+        key: 'USER',
+        isDefault: true,
+      })
+    );
+
+    const comments = await repository.manager.getRepository(Comments).save([
+      Object.assign(new Comments(), {
+        kind: 'COMMENT',
+        text: 'text',
+      }),
+      Object.assign(new Comments(), {
+        kind: 'COMMENT',
+        text: 'text',
+      }),
+      Object.assign(new Comments(), {
+        kind: 'COMMENT',
+        text: 'text',
+      }),
+    ]);
+
+    const notes = await repository.manager.getRepository(Notes).save([
+      Object.assign(new Notes(), {
+        text: 'text',
+      }),
+    ]);
+
     const user = {
       login: 'login',
       lastName: 'lastName',
       isActive: true,
       addresses: addresses,
+      comments,
+      notes,
     };
     await repository.save(Object.assign(new Users(), user));
   });
@@ -188,6 +226,17 @@ describe('GetOne methode test', () => {
     expect(selectSpy).toBeCalledWith([...defaultField['include'], aliasString]);
   });
 
+  it('included relationships should only return unique values', async () => {
+    defaultField['include'] = ['comments', 'notes'];
+    const res = await typeormService.getOne({
+      query: defaultField,
+      route: { id: params },
+    });
+
+    expect(res.data['relationships'].comments.data.length).toBe(3);
+    expect(res.data['relationships'].notes.data.length).toBe(1);
+  });
+
   it('Should be correct query with params', async () => {
     let joinSpy;
     let selectSpy;

libs/json-api-nestjs/src/lib/mock-utils/db-for-test

@@ -98,6 +98,39 @@ CREATE SEQUENCE public.comments_id_seq
 ALTER SEQUENCE public.comments_id_seq OWNED BY public.comments.id;
 
 
+--
+-- Name: notes; Type: TABLE; Schema: public; Owner: -
+--
+
+CREATE TABLE public.notes (
+    id integer NOT NULL,
+    text text NOT NULL,
+    created_by integer,
+    created_at timestamp without time zone DEFAULT CURRENT_TIMESTAMP,
+    updated_at timestamp without time zone DEFAULT CURRENT_TIMESTAMP
+);
+
+
+--
+-- Name: notes_id_seq; Type: SEQUENCE; Schema: public; Owner: -
+--
+
+CREATE SEQUENCE public.notes_id_seq
+    AS integer
+    START WITH 1
+    INCREMENT BY 1
+    NO MINVALUE
+    NO MAXVALUE
+    CACHE 1;
+
+
+--
+-- Name: notes_id_seq; Type: SEQUENCE OWNED BY; Schema: public; Owner: -
+--
+
+ALTER SEQUENCE public.notes_id_seq OWNED BY public.notes.id;
+
+
 --
 -- Name: migrations; Type: TABLE; Schema: public; Owner: -
 --
@@ -388,6 +421,13 @@ ALTER TABLE ONLY public.addresses ALTER COLUMN id SET DEFAULT nextval('public.ad
 ALTER TABLE ONLY public.comments ALTER COLUMN id SET DEFAULT nextval('public.comments_id_seq'::regclass);
 
 
+--
+-- Name: notes id; Type: DEFAULT; Schema: public; Owner: -
+--
+
+ALTER TABLE ONLY public.notes ALTER COLUMN id SET DEFAULT nextval('public.notes_id_seq'::regclass);
+
+
 --
 -- Name: migrations id; Type: DEFAULT; Schema: public; Owner: -
 --
@@ -468,6 +508,13 @@ ALTER TABLE ONLY public.comments
     ADD CONSTRAINT "PK_8bf68bc960f2b69e818bdb90dcb" PRIMARY KEY (id);
 
 
+--
+-- Name: notes PK_notes; Type: CONSTRAINT; Schema: public; Owner: -
+--
+
+ALTER TABLE ONLY public.notes
+    ADD CONSTRAINT "PK_notes" PRIMARY KEY (id);
+
 --
 -- Name: migrations PK_8c82d7f526340ab734260ea46be; Type: CONSTRAINT; Schema: public; Owner: -
 --
@@ -584,6 +631,14 @@ ALTER TABLE ONLY public.comments
     ADD CONSTRAINT "FK_980bfefe00ed11685f325d0bd4c" FOREIGN KEY (created_by) REFERENCES public.users(id);
 
 
+--
+-- Name: notes FK_980bfefe00ed11685f325d0bd4c; Type: FK CONSTRAINT; Schema: public; Owner: -
+--
+
+ALTER TABLE ONLY public.notes
+    ADD CONSTRAINT "FK_notes" FOREIGN KEY (created_by) REFERENCES public.users(id);
+
+
 --
 -- Name: requests_have_pod_locks FK_c7531fe6bbb926bba3f69fcbb55; Type: FK CONSTRAINT; Schema: public; Owner: -
 --

libs/json-api-nestjs/src/lib/mock-utils/entities/index.ts

@@ -6,3 +6,4 @@ export * from './pods';
 export * from './comments';
 export * from './addresses';
 export * from './user-groups';
+export * from './notes';

libs/json-api-nestjs/src/lib/mock-utils/entities/notes.ts

@@ -0,0 +1,49 @@
+import {
+  PrimaryGeneratedColumn,
+  Column,
+  Entity,
+  JoinColumn,
+  ManyToOne,
+  UpdateDateColumn,
+} from 'typeorm';
+import { IsEmpty, IsNotEmpty } from 'class-validator';
+
+import { Users, IUsers } from '.';
+
+@Entity('notes')
+export class Notes {
+  @PrimaryGeneratedColumn()
+  public id: number;
+
+  @IsNotEmpty()
+  @Column({
+    type: 'text',
+    nullable: false,
+  })
+  public text: string;
+
+  @IsEmpty()
+  @Column({
+    name: 'created_at',
+    type: 'timestamp',
+    nullable: true,
+    default: 'CURRENT_TIMESTAMP',
+  })
+  public createdAt: Date;
+
+  @IsEmpty()
+  @UpdateDateColumn({
+    name: 'updated_at',
+    type: 'timestamp',
+    nullable: true,
+    default: 'CURRENT_TIMESTAMP',
+  })
+  public updatedAt: Date;
+
+  @ManyToOne(() => Users, (item) => item.notes)
+  @IsNotEmpty()
+  @JoinColumn({
+    name: 'created_by',
+  })
+  public createdBy: IUsers;
+}

libs/json-api-nestjs/src/lib/mock-utils/entities/users.ts

@@ -20,8 +20,7 @@ import {
 
 import { Exclude } from 'class-transformer';
 
-import { Addresses, Roles, Comments } from '.';
-import { UserGroups } from './user-groups';
+import { Addresses, Roles, Comments, Notes, UserGroups } from '.';
 
 export type IUsers = Users;
 
@@ -131,6 +130,9 @@ export class Users {
   @OneToMany(() => Comments, (item) => item.createdBy)
   public comments: Comments[];
 
+  @OneToMany(() => Notes, (item) => item.createdBy)
+  public notes: Notes[];
+
   @ManyToOne(() => UserGroups, (userGroup) => userGroup.id)
   @IsNotEmpty()
   @JoinColumn({ name: 'user_groups_id' })

libs/json-api-nestjs/src/lib/mock-utils/index.ts

@@ -13,6 +13,7 @@ import {
   Comments,
   Addresses,
   UserGroups,
+  Notes,
 } from './entities';
 import { DataSource } from 'typeorm';
 
@@ -27,6 +28,7 @@ export const entities = [
   Pods,
   Comments,
   Addresses,
+  Notes,
 ];
 
 const dump = readFileSync(join(__dirname, 'db-for-test'), { encoding: 'utf8' });
@@ -61,6 +63,7 @@ export function mockDBTestModule(): DynamicModule {
           Pods,
           Comments,
           Addresses,
+          Notes,
         ],
       };
     },