Skip to content
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.

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

fix: Use concrete subclass for saving with single table inheritance #8819

Merged
merged 1 commit into from
Apr 2, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
22 changes: 20 additions & 2 deletions src/persistence/EntityPersistExecutor.ts
Original file line number Diff line number Diff line change
Expand Up @@ -81,10 +81,28 @@ export class EntityPersistExecutor {
if (entityTarget === Object)
throw new CannotDetermineEntityError(this.mode)

let metadata = this.connection.getMetadata(entityTarget)

// Check for single table inheritance and find the correct metadata in that case.
// Goal is to use the correct discriminator as we could have a repository
// for an (abstract) base class and thus the target would not match.
if (
metadata.inheritancePattern === "STI" &&
metadata.childEntityMetadatas.length > 0
) {
const matchingChildMetadata =
metadata.childEntityMetadatas.find(
(meta) =>
entity.constructor === meta.target,
)
if (matchingChildMetadata) {
metadata = matchingChildMetadata
}
}

subjects.push(
new Subject({
metadata:
this.connection.getMetadata(entityTarget),
metadata,
entity: entity,
canBeInserted: this.mode === "save",
canBeUpdated: this.mode === "save",
Expand Down
28 changes: 28 additions & 0 deletions test/github-issues/2927/entity/Content.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
import {
Column,
Entity,
PrimaryGeneratedColumn,
TableInheritance,
} from "../../../../src"

export enum ContentType {
Photo = "photo",
Post = "post",
SpecialPhoto = "special_photo",
}

@Entity()
@TableInheritance({
pattern: "STI",
column: { type: "enum", name: "content_type", enum: ContentType },
})
export class Content {
@PrimaryGeneratedColumn()
id: number

@Column()
title: string

@Column()
description: string
}
8 changes: 8 additions & 0 deletions test/github-issues/2927/entity/Photo.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
import { ChildEntity, Column } from "../../../../src"
import { Content, ContentType } from "./Content"

@ChildEntity(ContentType.Photo)
export class Photo extends Content {
@Column()
size: number
}
8 changes: 8 additions & 0 deletions test/github-issues/2927/entity/Post.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
import { ChildEntity, Column } from "../../../../src"
import { Content, ContentType } from "./Content"

@ChildEntity(ContentType.Post)
export class Post extends Content {
@Column()
viewCount: number
}
9 changes: 9 additions & 0 deletions test/github-issues/2927/entity/SpecialPhoto.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
import { ChildEntity, Column } from "../../../../src"
import { ContentType } from "./Content"
import { Photo } from "./Photo"

@ChildEntity(ContentType.SpecialPhoto)
export class SpecialPhoto extends Photo {
@Column()
specialProperty: number
}
103 changes: 103 additions & 0 deletions test/github-issues/2927/issue-2927.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,103 @@
import "reflect-metadata"
import {
createTestingConnections,
closeTestingConnections,
reloadTestingDatabases,
} from "../../utils/test-utils"
import { DataSource } from "../../../src/data-source/index"
import { expect } from "chai"
import { Content } from "./entity/Content"
import { Photo } from "./entity/Photo"
import { SpecialPhoto } from "./entity/SpecialPhoto"
import { Post } from "./entity/Post"

describe("github issues > #2927 When using base class' custom repository, the discriminator is ignored", () => {
let dataSources: DataSource[]
before(
async () =>
(dataSources = await createTestingConnections({
entities: [__dirname + "/entity/*{.js,.ts}"],
schemaCreate: true,
dropSchema: true,
})),
)
beforeEach(() => reloadTestingDatabases(dataSources))
after(() => closeTestingConnections(dataSources))

it("should use the correct subclass for inheritance when saving and retrieving concrete instance", () =>
Promise.all(
dataSources.map(async (dataSource) => {
const entityManager = dataSource.createEntityManager()
const repository = entityManager.getRepository(Content)

// Create and save a new Photo.
const photo = new Photo()
photo.title = "some title"
photo.description = "some description"
photo.size = 42
await repository.save(photo)

// Retrieve it back from the DB.
const contents = await repository.find()
expect(contents.length).to.equal(1)
expect(contents[0] instanceof Photo).to.equal(true)
const fetchedPhoto = contents[0] as Photo
expect(fetchedPhoto).to.eql(photo)
}),
))

it("should work for deeply nested classes", () =>
Promise.all(
dataSources.map(async (dataSource) => {
const entityManager = dataSource.createEntityManager()
const repository = entityManager.getRepository(Content)

// Create and save a new SpecialPhoto.
const specialPhoto = new SpecialPhoto()
specialPhoto.title = "some title"
specialPhoto.description = "some description"
specialPhoto.size = 42
specialPhoto.specialProperty = 420
await repository.save(specialPhoto)

// Retrieve it back from the DB.
const contents = await repository.find()
expect(contents.length).to.equal(1)
expect(contents[0] instanceof SpecialPhoto).to.equal(true)
const fetchedSpecialPhoto = contents[0] as SpecialPhoto
expect(fetchedSpecialPhoto).to.eql(specialPhoto)
}),
))

it("should work for saving and fetching different subclasses", () =>
Promise.all(
dataSources.map(async (dataSource) => {
const entityManager = dataSource.createEntityManager()
const repository = entityManager.getRepository(Content)

// Create and save a new Post.
const post = new Post()
post.title = "some title"
post.description = "some description"
post.viewCount = 69

// Create and save a new SpecialPhoto.
const specialPhoto = new SpecialPhoto()
specialPhoto.title = "some title"
specialPhoto.description = "some description"
specialPhoto.size = 42
specialPhoto.specialProperty = 420

await repository.save([post, specialPhoto])

// Retrieve them back from the DB.
const contents = await repository.find()
expect(contents.length).to.equal(2)
expect(contents.find((content) => content instanceof Post)).not
.to.be.undefined
expect(
contents.find((content) => content instanceof SpecialPhoto),
).not.to.be.undefined
}),
))
})