@loopback/repository-tests 0.20.2 → 0.21.2

package/src/crud/relations/acceptance/belongs-to.inclusion-resolver.polymorphic.relation.acceptance.ts

@@ -0,0 +1,221 @@
+// Copyright IBM Corp. and LoopBack contributors 2019,2020. All Rights Reserved.
+// Node module: @loopback/repository-tests
+// This file is licensed under the MIT License.
+// License text available at https://opensource.org/licenses/MIT
+
+import {expect, skipIf, toJSON} from '@loopback/testlab';
+import {Suite} from 'mocha';
+import {
+  CrudFeatures,
+  CrudRepositoryCtor,
+  CrudTestContext,
+  DataSourceOptions,
+} from '../../..';
+import {
+  deleteAllModelsInDefaultDataSource,
+  withCrudCtx,
+} from '../../../helpers.repository-tests';
+import {
+  Contact,
+  ContactRepository,
+  Customer,
+  CustomerRepository,
+  Supplier,
+  SupplierRepository,
+} from '../fixtures/models';
+import {givenBoundCrudRepositories} from '../helpers';
+
+export function belongsToInclusionResolverPolymorphicAcceptance(
+  dataSourceOptions: DataSourceOptions,
+  repositoryClass: CrudRepositoryCtor,
+  features: CrudFeatures,
+) {
+  skipIf<[(this: Suite) => void], void>(
+    !features.supportsInclusionResolvers,
+    describe,
+    'BelongsTo inclusion resolvers - polymorphic - acceptance',
+    suite,
+  );
+  function suite() {
+    before(deleteAllModelsInDefaultDataSource);
+    let customerRepo: CustomerRepository;
+    let supplierRepo: SupplierRepository;
+    let contactRepo: ContactRepository;
+
+    before(
+      withCrudCtx(async function setupRepository(ctx: CrudTestContext) {
+        // this helper should create the inclusion resolvers and also
+        // register inclusion resolvers for us
+        ({customerRepo, supplierRepo, contactRepo} = givenBoundCrudRepositories(
+          ctx.dataSource,
+          repositoryClass,
+          features,
+        ));
+        expect(customerRepo.contact.inclusionResolver).to.be.Function();
+        expect(supplierRepo.contact.inclusionResolver).to.be.Function();
+        expect(contactRepo.stakeholder.inclusionResolver).to.be.Function();
+
+        await ctx.dataSource.automigrate([
+          Customer.name,
+          Supplier.name,
+          Contact.name,
+        ]);
+      }),
+    );
+
+    beforeEach(async () => {
+      await customerRepo.deleteAll();
+      await supplierRepo.deleteAll();
+      await contactRepo.deleteAll();
+    });
+
+    it('throws an error if it tries to query nonexistent relation names', async () => {
+      const customer = await customerRepo.create({name: 'customer'});
+      await contactRepo.create({
+        stakeholderId: customer.id,
+      });
+      await expect(
+        contactRepo.find({include: ['shipment']}),
+      ).to.be.rejectedWith(`Invalid "filter.include" entries: "shipment"`);
+    });
+
+    it('returns single model instance including single related instance', async () => {
+      const thor = await customerRepo.create({name: 'Thor'});
+      const contact = await contactRepo.create({
+        stakeholderId: thor.id,
+      });
+      const result = await contactRepo.find({
+        include: ['stakeholder'],
+      });
+
+      const expected = {
+        ...contact,
+        isShipped: features.emptyValue,
+        shipmentInfo: features.emptyValue,
+        stakeholder: {
+          ...thor,
+          parentId: features.emptyValue,
+        },
+      };
+      expect(toJSON(result)).to.deepEqual([toJSON(expected)]);
+    });
+
+    it('returns multiple model instances including related instances', async () => {
+      const thor = await customerRepo.create({
+        name: 'Thor',
+        paymentMethodType: 'CreditCard',
+      });
+      const odin = await supplierRepo.create({name: 'Odin'});
+      const thorContact = await contactRepo.create({
+        stakeholderId: thor.id,
+      });
+      const odinContact = await contactRepo.create({
+        stakeholderId: odin.id,
+        stakeholderType: 'Supplier',
+      });
+
+      const result = await contactRepo.find({
+        include: ['stakeholder'],
+      });
+
+      const expected = [
+        {
+          ...thorContact,
+          isShipped: features.emptyValue,
+          shipmentInfo: features.emptyValue,
+          stakeholder: {
+            ...thor,
+            parentId: features.emptyValue,
+          },
+        },
+        {
+          ...odinContact,
+          isShipped: features.emptyValue,
+          shipmentInfo: features.emptyValue,
+          stakeholder: {
+            ...odin,
+            parentId: features.emptyValue,
+          },
+        },
+      ];
+      expect(toJSON(result)).to.deepEqual(toJSON(expected));
+    });
+
+    it('returns a specified instance including its related model instances', async () => {
+      const thor = await customerRepo.create({name: 'Thor'});
+      const odin = await supplierRepo.create({name: 'Odin'});
+      const bella = await supplierRepo.create({name: 'Bella'});
+      await contactRepo.create({
+        stakeholderId: thor.id,
+      });
+      await contactRepo.create({
+        stakeholderId: bella.id,
+        stakeholderType: 'Supplier',
+      });
+      const odinContact = await contactRepo.create({
+        stakeholderId: odin.id,
+        stakeholderType: 'Supplier',
+      });
+
+      const result = await contactRepo.findById(odinContact.id, {
+        include: ['stakeholder'],
+      });
+      const expected = {
+        ...odinContact,
+        isShipped: features.emptyValue,
+        shipmentInfo: features.emptyValue,
+        stakeholder: {
+          ...odin,
+          parentId: features.emptyValue,
+        },
+      };
+      expect(toJSON(result)).to.deepEqual(toJSON(expected));
+    });
+
+    it('queries entities with null foreign key', async () => {
+      const customer = await customerRepo.create({
+        name: 'Thor',
+      });
+
+      const contact1 = await contactRepo.create({
+        stakeholderId: customer.id,
+      });
+
+      const contact2 = await contactRepo.create({});
+
+      const expected = [
+        {
+          ...contact1,
+          isShipped: features.emptyValue,
+          shipmentInfo: features.emptyValue,
+          stakeholder: {
+            ...customer,
+            parentId: features.emptyValue,
+          },
+        },
+        {
+          ...contact2,
+          stakeholderId: features.emptyValue,
+          isShipped: features.emptyValue,
+          shipmentInfo: features.emptyValue,
+        },
+      ];
+
+      const result = await contactRepo.find({include: ['stakeholder']});
+      expect(toJSON(result)).to.deepEqual(toJSON(expected));
+    });
+
+    it('throws error if the target repository does not have the registered resolver', async () => {
+      const customer = await customerRepo.create({name: 'customer'});
+      await contactRepo.create({
+        stakeholderId: customer.id,
+      });
+      // unregister the resolver
+      contactRepo.inclusionResolvers.delete('stakeholder');
+
+      await expect(
+        contactRepo.find({include: ['stakeholder']}),
+      ).to.be.rejectedWith(`Invalid "filter.include" entries: "stakeholder"`);
+    });
+  }
+}

package/src/crud/relations/acceptance/belongs-to.inclusion-resolver.relation.acceptance.ts

@@ -1,4 +1,4 @@
-// Copyright IBM Corp. 2019,2020. All Rights Reserved.
+// Copyright IBM Corp. and LoopBack contributors 2019,2020. All Rights Reserved.
 // Node module: @loopback/repository-tests
 // This file is licensed under the MIT License.
 // License text available at https://opensource.org/licenses/MIT

package/src/crud/relations/acceptance/belongs-to.polymorphic.relation.acceptance.ts

@@ -0,0 +1,88 @@
+// Copyright IBM Corp. and LoopBack contributors 2019,2020. All Rights Reserved.
+// Node module: @loopback/repository-tests
+// This file is licensed under the MIT License.
+// License text available at https://opensource.org/licenses/MIT
+
+import {expect, toJSON} from '@loopback/testlab';
+import {
+  deleteAllModelsInDefaultDataSource,
+  withCrudCtx,
+} from '../../../helpers.repository-tests';
+import {
+  CrudFeatures,
+  CrudRepositoryCtor,
+  CrudTestContext,
+  DataSourceOptions,
+} from '../../../types.repository-tests';
+import {
+  Contact,
+  ContactRepository,
+  Customer,
+  CustomerRepository,
+  Supplier,
+  SupplierRepository,
+} from '../fixtures/models';
+import {givenBoundCrudRepositories} from '../helpers';
+
+export function belongsToRelationPolymorphicAcceptance(
+  dataSourceOptions: DataSourceOptions,
+  repositoryClass: CrudRepositoryCtor,
+  features: CrudFeatures,
+) {
+  describe('BelongsTo relation (acceptance)', () => {
+    before(deleteAllModelsInDefaultDataSource);
+
+    let customerRepo: CustomerRepository;
+    let supplierRepo: SupplierRepository;
+    let contactRepo: ContactRepository;
+
+    before(
+      withCrudCtx(async function setupRepository(ctx: CrudTestContext) {
+        ({customerRepo, supplierRepo, contactRepo} = givenBoundCrudRepositories(
+          ctx.dataSource,
+          repositoryClass,
+          features,
+        ));
+        const models = [Customer, Supplier, Contact];
+        await ctx.dataSource.automigrate(models.map(m => m.name));
+      }),
+    );
+    beforeEach(async () => {
+      await contactRepo.deleteAll();
+    });
+
+    it('can find customer from contact', async () => {
+      const customer = await customerRepo.create({
+        name: 'McForder customer',
+      });
+      const contact = await contactRepo.create({
+        stakeholderId: customer.id,
+        stakeholderType: 'Customer',
+      });
+
+      const result = await contactRepo.stakeholder(contact.id, 'Customer');
+      // adding parentId to customer so MySQL doesn't complain about null vs
+      // undefined
+      expect(toJSON(result)).to.deepEqual(
+        toJSON({...customer, parentId: features.emptyValue}),
+      );
+    });
+
+    it('can find supplier from contact', async () => {
+      const supplier = await supplierRepo.create({
+        name: 'McForder supplier',
+      });
+      const contact = await contactRepo.create({
+        stakeholderId: supplier.id,
+        stakeholderType: 'Supplier',
+      });
+
+      const result = await contactRepo.stakeholder(contact.id, 'Supplier');
+      // adding parentId to customer so MySQL doesn't complain about null vs
+      // undefined
+      expect(toJSON(result)).to.deepEqual(
+        toJSON({...supplier, parentId: features.emptyValue}),
+      );
+    });
+  });
+}

package/src/crud/relations/acceptance/belongs-to.relation.acceptance.ts

@@ -1,4 +1,4 @@
-// Copyright IBM Corp. 2019,2020. All Rights Reserved.
+// Copyright IBM Corp. and LoopBack contributors 2019,2020. All Rights Reserved.
 // Node module: @loopback/repository-tests
 // This file is licensed under the MIT License.
 // License text available at https://opensource.org/licenses/MIT

package/src/crud/relations/acceptance/has-many-inclusion-resolver.relation.acceptance.ts

@@ -1,4 +1,4 @@
-// Copyright IBM Corp. 2019,2020. All Rights Reserved.
+// Copyright IBM Corp. and LoopBack contributors 2019,2020. All Rights Reserved.
 // Node module: @loopback/repository-tests
 // This file is licensed under the MIT License.
 // License text available at https://opensource.org/licenses/MIT

package/src/crud/relations/acceptance/has-many-through-inclusion-resolver.acceptance.ts

@@ -1,4 +1,4 @@
-// Copyright IBM Corp. 2020. All Rights Reserved.
+// Copyright IBM Corp. and LoopBack contributors 2020. All Rights Reserved.
 // Node module: @loopback/repository-tests
 // This file is licensed under the MIT License.
 // License text available at https://opensource.org/licenses/MIT

package/src/crud/relations/acceptance/has-many-through-inclusion-resolver.polymorphic.acceptance.ts

@@ -0,0 +1,255 @@
+// Copyright IBM Corp. and LoopBack contributors 2020. All Rights Reserved.
+// Node module: @loopback/repository-tests
+// This file is licensed under the MIT License.
+// License text available at https://opensource.org/licenses/MIT
+
+import {expect, skipIf, toJSON} from '@loopback/testlab';
+import {Suite} from 'mocha';
+import {
+  CrudFeatures,
+  CrudRepositoryCtor,
+  CrudTestContext,
+  DataSourceOptions,
+} from '../../..';
+import {
+  deleteAllModelsInDefaultDataSource,
+  withCrudCtx,
+} from '../../../helpers.repository-tests';
+import {
+  Customer,
+  CustomerPromotionLink,
+  CustomerPromotionLinkRepository,
+  CustomerRepository,
+  FreeDelivery,
+  FreeDeliveryRepository,
+  HalfPrice,
+  HalfPriceRepository,
+} from '../fixtures/models';
+import {givenBoundCrudRepositories} from '../helpers';
+
+export function hasManyThroughInclusionResolverPolymorphicAcceptance(
+  dataSourceOptions: DataSourceOptions,
+  repositoryClass: CrudRepositoryCtor,
+  features: CrudFeatures,
+) {
+  skipIf<[(this: Suite) => void], void>(
+    !features.supportsInclusionResolvers,
+    describe,
+    'HasManyThrough inclusion resolvers - polymorphic - acceptance',
+    suite,
+  );
+  function suite() {
+    describe('HasManyThrough inclusion resolver', () => {
+      before(deleteAllModelsInDefaultDataSource);
+      let customerRepo: CustomerRepository;
+      let freeDeliveryRepo: FreeDeliveryRepository;
+      let halfPriceRepo: HalfPriceRepository;
+      let customerPromotionLinkRepo: CustomerPromotionLinkRepository;
+
+      before(
+        withCrudCtx(async function setupRepository(ctx: CrudTestContext) {
+          // this helper should create the inclusion resolvers and also
+          // register inclusion resolvers for us
+          ({
+            customerRepo,
+            freeDeliveryRepo,
+            halfPriceRepo,
+            customerPromotionLinkRepo,
+          } = givenBoundCrudRepositories(
+            ctx.dataSource,
+            repositoryClass,
+            features,
+          ));
+          expect(customerRepo.promotions.inclusionResolver).to.be.Function();
+
+          await ctx.dataSource.automigrate([
+            Customer.name,
+            FreeDelivery.name,
+            HalfPrice.name,
+            CustomerPromotionLink.name,
+          ]);
+        }),
+      );
+
+      beforeEach(async () => {
+        await customerRepo.deleteAll();
+        await freeDeliveryRepo.deleteAll();
+        await halfPriceRepo.deleteAll();
+        await customerPromotionLinkRepo.deleteAll();
+      });
+
+      it('throws an error if tries to query nonexistent relation names', async () => {
+        const customer = await customerRepo.create({name: 'customer'});
+        await customerRepo
+          .promotions(customer.id)
+          .create({description: 'crown'}, {polymorphicType: 'HalfPrice'});
+
+        await expect(
+          customerRepo.find({include: ['crown']}),
+        ).to.be.rejectedWith(`Invalid "filter.include" entries: "crown"`);
+      });
+
+      it('returns single model instance including single related instance', async () => {
+        const zelda = await customerRepo.create({name: 'Zelda'});
+        const freeDelivery = await customerRepo.promotions(zelda.id).create(
+          {description: 'crown'},
+          {
+            throughData: {promotiontype: 'FreeDelivery'},
+            polymorphicType: 'FreeDelivery',
+          },
+        );
+
+        const result = await customerRepo.find({
+          include: ['promotions'],
+        });
+
+        expect(toJSON(result)).to.deepEqual([
+          toJSON({
+            ...zelda,
+            parentId: features.emptyValue,
+            promotions: [freeDelivery],
+          }),
+        ]);
+      });
+
+      it('returns multiple model instances including related instances', async () => {
+        const link = await customerRepo.create({name: 'Link'});
+        const halfPrice = await customerRepo.promotions(link.id).create(
+          {description: 'halfPrice'},
+          {
+            throughData: {promotiontype: 'HalfPrice'},
+            polymorphicType: 'HalfPrice',
+          },
+        );
+        const freeDelivery = await customerRepo.promotions(link.id).create(
+          {description: 'freeDelivery'},
+          {
+            throughData: {promotiontype: 'FreeDelivery'},
+            polymorphicType: 'FreeDelivery',
+          },
+        );
+        const freeDelivery2 = await customerRepo.promotions(link.id).create(
+          {description: 'freeDelivery 2'},
+          {
+            throughData: {promotiontype: 'FreeDelivery'},
+            polymorphicType: 'FreeDelivery',
+          },
+        );
+
+        const result = await customerRepo.find({
+          include: ['promotions'],
+        });
+
+        const expected = [
+          {
+            ...link,
+            parentId: features.emptyValue,
+            promotions: [halfPrice, freeDelivery, freeDelivery2],
+          },
+        ];
+
+        expect(toJSON(result)).to.deepEqual(toJSON(expected));
+      });
+
+      it('returns a specified instance including its related model instances', async () => {
+        const link = await customerRepo.create({name: 'Link'});
+        const zelda = await customerRepo.create({name: 'Zelda'});
+
+        await customerRepo.promotions(link.id).create(
+          {description: 'crown'},
+          {
+            throughData: {promotiontype: 'HalfPrice'},
+            polymorphicType: 'HalfPrice',
+          },
+        );
+        const zeldaPromotion1 = await customerRepo.promotions(zelda.id).create(
+          {description: 'shield'},
+          {
+            throughData: {promotiontype: 'FreeDelivery'},
+            polymorphicType: 'FreeDelivery',
+          },
+        );
+        const zeldaPromotion2 = await customerRepo.promotions(zelda.id).create(
+          {description: 'green hat'},
+          {
+            throughData: {promotiontype: 'FreeDelivery'},
+            polymorphicType: 'FreeDelivery',
+          },
+        );
+
+        const result = await customerRepo.findById(zelda.id, {
+          include: ['promotions'],
+        });
+        const expected = {
+          ...zelda,
+          parentId: features.emptyValue,
+          promotions: [zeldaPromotion1, zeldaPromotion2],
+        };
+        expect(toJSON(result)).to.deepEqual(toJSON(expected));
+      });
+
+      it('honours field scope when returning a model', async () => {
+        const link = await customerRepo.create({name: 'Link'});
+        const zelda = await customerRepo.create({name: 'Zelda'});
+        const sword = await customerRepo.promotions(link.id).create(
+          {description: 'master sword'},
+          {
+            throughData: {promotiontype: 'HalfPrice'},
+            polymorphicType: 'HalfPrice',
+          },
+        );
+        const shield = await customerRepo.promotions(zelda.id).create(
+          {description: 'shield'},
+          {
+            throughData: {promotiontype: 'FreeDelivery'},
+            polymorphicType: 'FreeDelivery',
+          },
+        );
+        const hat = await customerRepo.promotions(zelda.id).create(
+          {description: 'hat'},
+          {
+            throughData: {promotiontype: 'HalfPrice'},
+            polymorphicType: 'HalfPrice',
+          },
+        );
+
+        const result = await customerRepo.find({
+          include: [{relation: 'promotions', scope: {fields: {id: false}}}],
+        });
+
+        const expected = [
+          {
+            ...link,
+            parentId: features.emptyValue,
+            promotions: [{description: sword.description}],
+          },
+          {
+            ...zelda,
+            parentId: features.emptyValue,
+            promotions: [
+              {description: shield.description},
+              {description: hat.description},
+            ],
+          },
+        ];
+
+        expect(toJSON(result)).to.deepEqual(toJSON(expected));
+      });
+
+      it('honours limit scope when returning a model', async () => {
+        const link = await customerRepo.create({name: 'Link'});
+        await customerRepo
+          .cartItems(link.id)
+          .create({description: 'master sword'});
+        await customerRepo.cartItems(link.id).create({description: 'shield'});
+
+        const result = await customerRepo.find({
+          include: [{relation: 'cartItems', scope: {limit: 1}}],
+        });
+
+        expect(result.length).to.eql(1);
+        expect(result[0].cartItems.length).to.eql(1);
+      });
+    });
+  }
+}

package/src/crud/relations/acceptance/has-many-through.relation.acceptance.ts

@@ -1,4 +1,4 @@
-// Copyright IBM Corp. 2020. All Rights Reserved.
+// Copyright IBM Corp. and LoopBack contributors 2020. All Rights Reserved.
 // Node module: @loopback/repository-tests
 // This file is licensed under the MIT License.
 // License text available at https://opensource.org/licenses/MIT
@@ -23,9 +23,9 @@ import {
   CustomerCartItemLinkRepository,
   CustomerRepository,
   User,
-  UserRepository,
   UserLink,
   UserLinkRepository,
+  UserRepository,
 } from '../fixtures/models';
 import {givenBoundCrudRepositories} from '../helpers';