LDEV-6340 stop logging "failed to resolve parent entity" for mappedSuperClass parents

Author: zspitzer

CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changelog
 
+## 5.6.15.17
+
+- [LDEV-6340](https://luceeserver.atlassian.net/browse/LDEV-6340) — Entities extending a `mappedSuperClass="true"` parent no longer log `failed to resolve parent entity` warnings on every SessionFactory build. Mapped superclasses aren't entities, so "parent not registered" is the expected state, not an error
+
 ## 5.6.15.16
 
 - [LDEV-1697](https://luceeserver.atlassian.net/browse/LDEV-1697) — Overlapping `ormSettings.cfclocation` entries (parent + child directory) registered the same CFC twice and triggered an ambiguity error. Now deduped by canonical file path, matching ACF behaviour

README.md

@@ -8,10 +8,10 @@ Install via Lucee Admin, or pin in your environment:
 
 ```bash
 # Lucee 7.0+ (Maven coordinates, auto-updates to latest snapshot)
-LUCEE_EXTENSIONS=org.lucee:hibernate-extension:5.6.15.16-SNAPSHOT
+LUCEE_EXTENSIONS=org.lucee:hibernate-extension:5.6.15.17-SNAPSHOT
 
 # Lucee 6.2 (extension GUID, pinned version)
-LUCEE_EXTENSIONS=FAD1E8CB-4F45-4184-86359145767C29DE;version=5.6.15.16-SNAPSHOT
+LUCEE_EXTENSIONS=FAD1E8CB-4F45-4184-86359145767C29DE;version=5.6.15.17-SNAPSHOT
 ```
 
 ## History

pom.xml

@@ -4,7 +4,7 @@
     <modelVersion>4.0.0</modelVersion>
     <groupId>org.lucee</groupId>
     <artifactId>hibernate-extension</artifactId>
-    <version>5.6.15.16-SNAPSHOT</version>
+    <version>5.6.15.17-SNAPSHOT</version>
     <packaging>jar</packaging>
     <name>Hibernate Extension</name>
 

source/java/src/org/lucee/extension/orm/hibernate/HibernateSessionFactory.java

@@ -318,15 +318,14 @@ private static String assembleMappingForCFC(String key, CFCInfo value, Set<Strin
 		StringBuilder mappings = new StringBuilder();
 		String ext = value.getCFC().getExtends();
 		if (!Util.isEmpty(ext)) {
-			try {
-				Component parent = data.getEntityByCFCName(ext, false);
+			// LDEV-6340: mappedSuperClass / persistent="false" / non-CFC parents
+			// legitimately aren't registered as entities — their properties get
+			// inlined by HBMCreator.loadForeignCFC during HBM generation, so
+			// there's no parent <class> to prepend here. Don't throw, don't log.
+			Component parent = data.getEntityByCFCName(ext, false, null);
+			if (parent != null) {
 				ext = HibernateCaster.getEntityName(parent);
 			}
-			catch (Exception e) {
-				Log log = CommonUtil.getORMLog();
-				if ( log != null ) log.log( Log.LEVEL_WARN, "hibernate",
-					"failed to resolve parent entity [" + ext + "] for entity [" + HibernateCaster.getEntityName( value.getCFC() ) + "]", e );
-			}
 
 			ext = HibernateUtil.id(CommonUtil.last(ext, ".").trim());
 			if (!done.contains(ext)) {

source/java/src/org/lucee/extension/orm/hibernate/SessionFactoryData.java

@@ -161,6 +161,53 @@ public Component getEntityByEntityName(String entityName, boolean unique) throws
 		throw ExceptionUtil.createException((ORMSession) null, null, "Entity [" + entityName + "] does not exist", "");
 	}
 
+	/**
+	 * Non-throwing overload — returns {@code defaultValue} when the CFC isn't
+	 * registered as an entity (e.g. {@code mappedSuperClass="true"} or
+	 * {@code persistent="false"} parents). Use this when "parent isn't an
+	 * entity" is a legitimate state, not an error (LDEV-6340).
+	 */
+	public Component getEntityByCFCName(String cfcName, boolean unique, Component defaultValue) {
+		String name = cfcName;
+		int pointIndex = cfcName.lastIndexOf('.');
+		if (pointIndex != -1) {
+			name = cfcName.substring(pointIndex + 1);
+		}
+		else cfcName = null;
+
+		Component cfc;
+
+		if (hasTempCFCs()) {
+			Iterator<Component> it2 = tmpList.iterator();
+			while (it2.hasNext()) {
+				cfc = it2.next();
+				if (HibernateUtil.isEntity(ormConf, cfc, cfcName, name))
+					return unique ? (Component) cfc.duplicate(false) : cfc;
+			}
+		}
+		else {
+			Iterator<Map<String, CFCInfo>> it = cfcs.values().iterator();
+			Map<String, CFCInfo> _cfcs;
+			while (it.hasNext()) {
+				_cfcs = it.next();
+				Iterator<CFCInfo> _it = _cfcs.values().iterator();
+				while (_it.hasNext()) {
+					cfc = _it.next().getCFC();
+					if (HibernateUtil.isEntity(ormConf, cfc, cfcName, name))
+						return unique ? (Component) cfc.duplicate(false) : cfc;
+				}
+			}
+		}
+
+		CFCInfo info = getCFC(name, null);
+		if (info != null) {
+			cfc = info.getCFC();
+			return unique ? (Component) cfc.duplicate(false) : cfc;
+		}
+
+		return defaultValue;
+	}
+
 	public Component getEntityByCFCName(String cfcName, boolean unique) throws PageException {
 		String name = cfcName;
 		int pointIndex = cfcName.lastIndexOf('.');

tests/mapping/mappedSuperClass.cfc

@@ -0,0 +1,97 @@
+component extends="org.lucee.cfml.test.LuceeTestCase" labels="orm" {
+
+	function beforeAll() {
+		// Need WARN-or-lower for the LDEV-6340 bug message to land in orm.log;
+		// default server level may be ERROR. logging.cfc uses the same pattern.
+		configImport( type: "server", password: request.SERVERADMINPASSWORD, data: {
+			loggers: {
+				orm: {
+					appender         : "resource",
+					appenderArguments: { path: "{lucee-config}/logs/orm.log" },
+					level            : "trace",
+					layout           : "classic"
+				}
+			}
+		});
+	}
+
+	function run( testResults, testBox ) {
+
+		describe( "mappedSuperClass — LDEV-6340 log noise", function() {
+
+			it( "User extends mappedSuperClass BaseEntity — entity ops work and log stays clean", function() {
+				var appId = createUUID();
+				var offsetBefore = getLogLength();
+
+				var result = _InternalRequest(
+					template: "#uri( "basic" )#/index.cfm",
+					url     : { appId: appId }
+				);
+				expect( trim( result.filecontent ) ).toBe( "ok" );
+
+				var logContent = getLogContentSince( offsetBefore );
+				systemOutput( "LDEV-6340 LOG: [#logContent#]", true );
+
+				expect( logContent ).notToInclude( "failed to resolve parent entity" );
+				expect( logContent ).notToInclude( "Entity [BaseEntity] does not exist" );
+			});
+
+		});
+
+		describe( "mappedSuperClass — property inheritance shapes", function() {
+
+			it( "parent declares @Id — child inherits the id field", function() {
+				var result = _InternalRequest(
+					template: "#uri( "parentId" )#/index.cfm",
+					url     : { appId: createUUID() }
+				);
+				expect( trim( result.filecontent ) ).toBe( "ok" );
+			});
+
+			it( "multi-level chain — child inherits properties from grand-mappedSuperClass", function() {
+				var result = _InternalRequest(
+					template: "#uri( "multiLevel" )#/index.cfm",
+					url     : { appId: createUUID() }
+				);
+				expect( trim( result.filecontent ) ).toBe( "ok" );
+			});
+
+			it( "mappedSuperClass + real entity TPH inheritance — Car gets mappedSuperClass props two levels up", function() {
+				var result = _InternalRequest(
+					template: "#uri( "mixedInheritance" )#/index.cfm",
+					url     : { appId: createUUID() }
+				);
+				expect( trim( result.filecontent ) ).toBe( "ok" );
+			});
+
+			it( "child redeclares parent property with different column + length — child wins", function() {
+				var result = _InternalRequest(
+					template: "#uri( "attrOverride" )#/index.cfm",
+					url     : { appId: createUUID() }
+				);
+				expect( trim( result.filecontent ) ).toBe( "ok" );
+			});
+
+		});
+
+	}
+
+	private string function uri( required string scenario ) {
+		return getDirectoryFromPath( contractPath( getCurrentTemplatePath() ) ) & "mappedSuperClass/" & arguments.scenario;
+	}
+
+	private numeric function getLogLength() {
+		var logFile = expandPath( "{lucee-config}/logs/orm.log" );
+		if ( !fileExists( logFile ) ) return 0;
+		return len( fileRead( logFile ) );
+	}
+
+	private string function getLogContentSince( required numeric offset ) {
+		var logFile = expandPath( "{lucee-config}/logs/orm.log" );
+		if ( !fileExists( logFile ) ) return "";
+		var content = fileRead( logFile );
+		if ( len( content ) <= arguments.offset ) return "";
+		return content.mid( arguments.offset + 1, len( content ) );
+	}
+
+}

tests/mapping/mappedSuperClass/attrOverride/Application.cfc

@@ -0,0 +1,11 @@
+component {
+
+	this.name = "orm-msuper-attrOverride-#url.appId ?: hash( getCurrentTemplatePath() )#";
+	this.datasource = server.getDatasource( "h2", server._getTempDir( "orm-msuper-attrOverride" ) );
+	this.ormEnabled = true;
+	this.ormSettings = {
+		dbcreate: "dropcreate",
+		cfclocation: [ getDirectoryFromPath( getCurrentTemplatePath() ) ]
+	};
+
+}

tests/mapping/mappedSuperClass/attrOverride/Customer.cfc

@@ -0,0 +1,17 @@
+// Child entity redeclares `title` with different `column` + `length`.
+// JPA's @AttributeOverride equivalent in CFML — same property name, new attrs.
+component
+	persistent="true"
+	extends   ="Named"
+	accessors ="true"
+	table     ="msuper_customer"
+{
+
+	property name="id" fieldtype="id" ormtype="string";
+	property
+		name   ="title"
+		ormtype="string"
+		length ="200"
+		column ="customer_title";
+
+}

tests/mapping/mappedSuperClass/attrOverride/Named.cfc

@@ -0,0 +1,14 @@
+// mappedSuperClass with a default column name and short length.
+// Child overrides both via redeclaration.
+component
+	mappedSuperClass="true"
+	accessors       ="true"
+{
+
+	property
+		name   ="title"
+		ormtype="string"
+		length ="50"
+		column ="default_title";
+
+}

tests/mapping/mappedSuperClass/attrOverride/index.cfm

@@ -0,0 +1,39 @@
+<cfscript>
+// Child redeclared `title` with column="customer_title" and length=200.
+// Parent's was column="default_title" length=50. Child's wins.
+
+// Verify the schema honoured the override: column must be `customer_title`, not `default_title`.
+import org.hibernate.Session;
+
+ormFlush();
+
+// Probe the H2 schema. column names are uppercased by default.
+schema = queryExecute(
+	"SELECT COLUMN_NAME FROM INFORMATION_SCHEMA.COLUMNS WHERE UPPER(TABLE_NAME) = 'MSUPER_CUSTOMER' ORDER BY COLUMN_NAME"
+);
+cols = [];
+for ( row in schema ) {
+	cols.append( lCase( row.COLUMN_NAME ) );
+}
+if ( !cols.find( "customer_title" ) )
+	throw( message="schema missing override column [customer_title], got #serializeJSON( cols )#" );
+if ( cols.find( "default_title" ) )
+	throw( message="schema still has parent's column [default_title] — override didn't take" );
+
+// Round-trip a value longer than the parent's 50-char limit (proves length override too).
+longTitle = repeatString( "mango ", 20 );  // 120 chars
+c = entityNew( "Customer" );
+c.setId( createUUID() );
+c.setTitle( longTitle );
+entitySave( c );
+ormFlush();
+ormClearSession();
+
+loaded = entityLoadByPK( "Customer", c.getId() );
+if ( isNull( loaded ) )
+	throw( message="Customer not loaded after save" );
+if ( loaded.getTitle() != longTitle )
+	throw( message="title round-trip mismatch — expected [#longTitle#], got [#loaded.getTitle()#]" );
+
+echo( "ok" );
+</cfscript>