Wrong column name in Column.getReferences() when dealing with composite REFBACK

[svandenhoek]

Have you checked if this issue already exists?

• yes

Molgenis EMX2 version

Software version: v11.40.0-SNAPSHOT. Database version: 23.

Description

When I try to retrieve the reference column names for a composite refback, the given column names do not match the actually retrieved column names through Query.retrieveRows(). In contrary to REF_ARRAY, a refback uses a different separator for composite keys (. vs -).

Reproduction steps

This test should not fail:

@Test
  void wrongColName() {
    Database database = TestDatabaseFactory.getTestDatabase();
    Schema schema = database.dropCreateSchema("testCompositeRefbackColname");
    schema.create(
        table(
            "table1",
            column("id1", ColumnType.STRING).setPkey(),
            column("id2", ColumnType.STRING).setPkey(),
            column("ref", ColumnType.REF).setRefTable("table2")),
        table("table2", column("id", ColumnType.STRING).setPkey()));
    schema
        .getTable("table2")
        .getMetadata()
        .add(column("refback", ColumnType.REFBACK).setRefTable("table1").setRefBack("ref"));
    schema.getTable("table2").insert(row("id", "x"));
    schema
        .getTable("table1")
        .insert(row("id1", "a", "id2", "aa", "ref", "x"), row("id1", "b", "id2", "bb", "ref", "x"));

    Set<String> expectedColNames = new HashSet<>();
    expectedColNames.add("id");
    schema
        .getTable("table2")
        .getMetadata()
        .getColumn("refback")
        .getReferences()
        .forEach(r -> expectedColNames.add(r.getName()));

    Set<String> actualColNames =
        schema
            .getTable("table2")
            .query()
            .select(s("id"), s("refback", s("id1"), s("id2")))
            .retrieveRows()
            .get(0)
            .getColumnNames();

    Assertions.assertEquals(expectedColNames, actualColNames);
  }

Currently it returns:

org.opentest4j.AssertionFailedError: 
Expected :[id, refback.id2, refback.id1]
Actual   :[id, refback-id1, refback-id2]

Expected behaviour

While it is debatable whether getReferences() is incorrect or the given column names by Query, fact is that they do not match while expected would be that getReferences().getNames() should allow for retrieving the columns belonging to a composite foreign key.

System configuration

No response

[svandenhoek]

A fix is needed for properly merging #4566 without implementing some temporary work-around.

[svandenhoek]

Actual issue might be more complicated, see: #4569 (comment)