feat: exposed entity and criteria properties on EntityNotFoundError (#…

…10202) These properties can be used by consumers to aid in rendering human-readable error messages.
typeorm · Dec 29, 2023 · bafcd17 · bafcd17
1 parent b53e410
commit bafcd17
Show file tree

Hide file tree

Showing 2 changed files with 21 additions and 9 deletions.
diff --git a/src/error/EntityNotFoundError.ts b/src/error/EntityNotFoundError.ts
@@ -7,9 +7,15 @@ import { InstanceChecker } from "../util/InstanceChecker"
  * Thrown when no result could be found in methods which are not allowed to return undefined or an empty set.
  */
 export class EntityNotFoundError extends TypeORMError {
+    public readonly entityClass: EntityTarget<any>
+    public readonly criteria: any
+
     constructor(entityClass: EntityTarget<any>, criteria: any) {
         super()
 
+        this.entityClass = entityClass
+        this.criteria = criteria
+
         this.message =
             `Could not find any entity of type "${this.stringifyTarget(
                 entityClass,

diff --git a/test/functional/repository/find-methods/repostiory-find-methods.ts b/test/functional/repository/find-methods/repostiory-find-methods.ts
@@ -1,5 +1,5 @@
 import "reflect-metadata"
-import { expect } from "chai"
+import { assert, expect } from "chai"
 import {
     closeTestingConnections,
     createTestingConnections,
@@ -751,14 +751,20 @@ describe("repository > find methods", () => {
                     loadedUser!.firstName.should.be.equal("name #0")
                     loadedUser!.secondName.should.be.equal("Doe")
 
-                    await userRepository
-                        .findOneOrFail({
-                            where: {
-                                id: 1,
-                                secondName: "Dorian",
-                            },
-                        })
-                        .should.eventually.be.rejectedWith(EntityNotFoundError)
+                    const options = {
+                        where: {
+                            id: 1,
+                            secondName: "Dorian",
+                        },
+                    }
+                    try {
+                        await userRepository.findOneOrFail(options)
+                        assert.fail("Should have thrown an error.")
+                    } catch (err) {
+                        expect(err).to.be.an.instanceOf(EntityNotFoundError)
+                        expect(err).to.have.property("entityClass", "User")
+                        expect(err).to.have.property("criteria", options)
+                    }
                 }),
             ))