Skip to content

feat(repository): add link and unlink methods for hasManyThrough repository #5719

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
agnes512 merged 2 commits into from
Jun 28, 2020
Merged

feat(repository): add link and unlink methods for hasManyThrough repository #5719

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2d43642
feat(repository): add link and unlink methods
Jun 11, 2020
633f1bd
test(repository): add tests for hasManyThrough link and unlink methods
Jun 11, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
189 changes: 90 additions & 99 deletions packages/repository/src/__tests__/integration/repositories/relation.factory.integration.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ let db: juggler.DataSource;
let customerRepo: EntityCrudRepository<Customer, typeof Customer.prototype.id>;
let orderRepo: EntityCrudRepository<Order, typeof Order.prototype.id>;
let cartItemRepo: EntityCrudRepository<CartItem, typeof CartItem.prototype.id>;
let CustomerCartItemLinkRepo: EntityCrudRepository<
let customerCartItemLinkRepo: EntityCrudRepository<
CustomerCartItemLink,
typeof CustomerCartItemLink.prototype.id
>;
Expand Down Expand Up @@ -232,40 +232,30 @@ describe('HasManyThrough relation', () => {

beforeEach(async function resetDatabase() {
await customerRepo.deleteAll();
await CustomerCartItemLinkRepo.deleteAll();
await customerCartItemLinkRepo.deleteAll();
await cartItemRepo.deleteAll();
});

it('creates a target instance alone with the corresponding through model', async () => {
const cartItem = await customerCartItemRepo.create(
{
description: 'an item hasManyThrough',
},
{
throughData: {id: 99},
},
);
it('creates a target instance along with the corresponding through model', async () => {
const cartItem = await customerCartItemRepo.create({
description: 'an item hasManyThrough',
});
const persistedItem = await cartItemRepo.findById(cartItem.id);
const persistedLink = await CustomerCartItemLinkRepo.find();
const persistedLink = await customerCartItemLinkRepo.find();

expect(cartItem).to.deepEqual(persistedItem);
expect(persistedLink).have.length(1);
const expected = {
id: 99,
customerId: existingCustomerId,
itemId: cartItem.id,
};
expect(toJSON(persistedLink[0])).to.deepEqual(toJSON(expected));
expect(toJSON(persistedLink[0])).to.containEql(toJSON(expected));
});

it('finds an instance via through model', async () => {
const item = await customerCartItemRepo.create(
{
description: 'an item hasManyThrough',
},
{
throughData: {id: 99},
},
);
const item = await customerCartItemRepo.create({
description: 'an item hasManyThrough',
});
const notMyItem = await cartItemRepo.create({
description: "someone else's item desc",
});
Expand All @@ -277,22 +267,10 @@ describe('HasManyThrough relation', () => {
});

it('finds instances via through models', async () => {
const item1 = await customerCartItemRepo.create(
{
description: 'group 1',
},
{
throughData: {id: 99},
},
);
const item2 = await customerCartItemRepo.create(
{
description: 'group 2',
},
{
throughData: {id: 98},
},
);
const item1 = await customerCartItemRepo.create({description: 'group 1'});
const item2 = await customerCartItemRepo.create({
description: 'group 2',
});
const items = await customerCartItemRepo.find();

expect(items).have.length(2);
Expand All @@ -304,34 +282,24 @@ describe('HasManyThrough relation', () => {
});

it('deletes an instance, then deletes the through model', async () => {
await customerCartItemRepo.create(
{
description: 'customer 1',
},
{
throughData: {id: 98},
},
);
await customerCartItemRepo.create({
description: 'customer 1',
});
const anotherHasManyThroughRepo = customerCartItemFactory(
existingCustomerId + 1,
);
const item2 = await anotherHasManyThroughRepo.create(
{
description: 'customer 2',
},
{
throughData: {id: 99},
},
);
const item2 = await anotherHasManyThroughRepo.create({
description: 'customer 2',
});
let items = await cartItemRepo.find();
let links = await CustomerCartItemLinkRepo.find();
let links = await customerCartItemLinkRepo.find();

expect(items).have.length(2);
expect(links).have.length(2);

await customerCartItemRepo.delete();
items = await cartItemRepo.find();
links = await CustomerCartItemLinkRepo.find();
links = await customerCartItemLinkRepo.find();

expect(items).have.length(1);
expect(links).have.length(1);
Expand All @@ -341,41 +309,31 @@ describe('HasManyThrough relation', () => {
});

it('deletes through model when corresponding target gets deleted', async () => {
const item1 = await customerCartItemRepo.create(
{
description: 'customer 1',
},
{
throughData: {id: 98},
},
);
const item1 = await customerCartItemRepo.create({
description: 'customer 1',
});
const anotherHasManyThroughRepo = customerCartItemFactory(
existingCustomerId + 1,
);
const item2 = await anotherHasManyThroughRepo.create(
{
description: 'customer 2',
},
{
throughData: {id: 99},
},
);
const item2 = await anotherHasManyThroughRepo.create({
description: 'customer 2',
});
// when order1 gets deleted, this through instance should be deleted too.
const through = await CustomerCartItemLinkRepo.create({
const through = await customerCartItemLinkRepo.create({
id: 1,
customerId: existingCustomerId + 1,
itemId: item1.id,
});
let items = await cartItemRepo.find();
let links = await CustomerCartItemLinkRepo.find();
let links = await customerCartItemLinkRepo.find();

expect(items).have.length(2);
expect(links).have.length(3);

await customerCartItemRepo.delete();

items = await cartItemRepo.find();
links = await CustomerCartItemLinkRepo.find();
links = await customerCartItemLinkRepo.find();

expect(items).have.length(1);
expect(links).have.length(1);
Expand All @@ -386,22 +344,12 @@ describe('HasManyThrough relation', () => {
});

it('patches instances that belong to the same source model (same source fk)', async () => {
const item1 = await customerCartItemRepo.create(
{
description: 'group 1',
},
{
throughData: {id: 99},
},
);
const item2 = await customerCartItemRepo.create(
{
description: 'group 1',
},
{
throughData: {id: 98},
},
);
const item1 = await customerCartItemRepo.create({
description: 'group 1',
});
const item2 = await customerCartItemRepo.create({
description: 'group 1',
});

const count = await customerCartItemRepo.patch({description: 'group 2'});
expect(count).to.match({count: 2});
Expand All @@ -413,6 +361,51 @@ describe('HasManyThrough relation', () => {
]),
);
});

it('links a target instance to the source instance', async () => {
const item = await cartItemRepo.create({description: 'an item'});
let targets = await customerCartItemRepo.find();
expect(targets).to.deepEqual([]);

await customerCartItemRepo.link(item.id);
targets = await customerCartItemRepo.find();
expect(toJSON(targets)).to.containDeep(toJSON([item]));
const link = await customerCartItemLinkRepo.find();
expect(toJSON(link[0])).to.containEql(
toJSON({customerId: existingCustomerId, itemId: item.id}),
);
});

it('links a target instance to the source instance with specified ThroughData', async () => {
const item = await cartItemRepo.create({description: 'an item'});

await customerCartItemRepo.link(item.id, {
throughData: {description: 'a through'},
});
const targets = await customerCartItemRepo.find();
expect(toJSON(targets)).to.containDeep(toJSON([item]));
const link = await customerCartItemLinkRepo.find();
expect(toJSON(link[0])).to.containEql(
toJSON({
customerId: existingCustomerId,
itemId: item.id,
description: 'a through',
}),
);
});

it('unlinks a target instance from the source instance', async () => {
const item = await customerCartItemRepo.create({description: 'an item'});
let targets = await customerCartItemRepo.find();
expect(toJSON(targets)).to.containDeep(toJSON([item]));

await customerCartItemRepo.unlink(item.id);
targets = await customerCartItemRepo.find();
expect(targets).to.deepEqual([]);
// the through model should be deleted
const thoughs = await customerCartItemRepo.find();
expect(thoughs).to.deepEqual([]);
});
//--- HELPERS ---//

async function givenPersistedCustomerInstance() {
Expand Down Expand Up @@ -443,7 +436,7 @@ describe('HasManyThrough relation', () => {
},
} as HasManyDefinition,
Getter.fromValue(cartItemRepo),
Getter.fromValue(CustomerCartItemLinkRepo),
Getter.fromValue(customerCartItemLinkRepo),
);

customerCartItemRepo = customerCartItemFactory(existingCustomerId);
Expand Down Expand Up @@ -537,22 +530,20 @@ class CustomerCartItemLink extends Entity {
id: number;
customerId: number;
itemId: number;
description: string;
static definition = new ModelDefinition('CustomerCartItemLink')
.addProperty('id', {
type: 'number',
id: true,
required: true,
})
Copy link
Member

@bajtos bajtos Jun 22, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is actually an interesting discussion point. Should "through" models have their own primary key (id), or should we use a composite primary key composed from source & target keys (e.g. itemId + customerId)?

@raymondfeng What's your opinion?

Copy link
Contributor

@raymondfeng raymondfeng Jun 22, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Imagine we have Appointment as the through model to connect Doctor and Patient, a patient may have multiple appointments with the same doctor. So doctorId + patientId won't be unique in Appointment model, which should have its PK.

For the relation, we need to use two FKs (doctorId and patientId) instead of PK for Appointment.

.addProperty('id', {type: 'number', id: true})
.addProperty('itemId', {type: 'number'})
.addProperty('customerId', {type: 'number'});
.addProperty('customerId', {type: 'number'})
.addProperty('description', {type: 'string'});
}
function givenCrudRepositories() {
db = new juggler.DataSource({connector: 'memory'});

customerRepo = new DefaultCrudRepository(Customer, db);
orderRepo = new DefaultCrudRepository(Order, db);
cartItemRepo = new DefaultCrudRepository(CartItem, db);
CustomerCartItemLinkRepo = new DefaultCrudRepository(
customerCartItemLinkRepo = new DefaultCrudRepository(
CustomerCartItemLink,
db,
);
Expand Down
Loading