Skip to content

[Fix](udf) fix frontends udf return rows incompatible with show frontends command #60211

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

Open
heguanhui wants to merge 1 commit into
base: master
Choose a base branch
from
+128 −21
Open

[Fix](udf) fix frontends udf return rows incompatible with show frontends command #60211

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
16 changes: 2 additions & 14 deletions fe/fe-core/src/main/java/org/apache/doris/common/proc/FrontendsProcNode.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,9 +26,9 @@
import org.apache.doris.service.FeDiskInfo;
import org.apache.doris.system.Frontend;
import org.apache.doris.system.SystemInfoService.HostInfo;
import org.apache.doris.tablefunction.FrontendsTableValuedFunction;

import com.google.common.base.Strings;
import com.google.common.collect.ImmutableList;
import com.google.common.collect.Lists;
import org.apache.logging.log4j.LogManager;
import org.apache.logging.log4j.Logger;
Expand All @@ -45,18 +45,6 @@
public class FrontendsProcNode implements ProcNodeInterface {
private static final Logger LOG = LogManager.getLogger(FrontendsProcNode.class);

public static final ImmutableList<String> TITLE_NAMES = new ImmutableList.Builder<String>()
.add("Name").add("Host").add("EditLogPort").add("HttpPort").add("QueryPort").add("RpcPort")
.add("ArrowFlightSqlPort").add("Role").add("IsMaster").add("ClusterId").add("Join").add("Alive")
.add("ReplayedJournalId").add("LastStartTime").add("LastHeartbeat").add("IsHelper").add("ErrMsg")
.add("Version").add("CurrentConnected").add("LiveSince")
.build();

public static final ImmutableList<String> DISK_TITLE_NAMES = new ImmutableList.Builder<String>()
.add("Name").add("Host").add("DirType").add("Dir").add("Filesystem")
.add("Capacity").add("Used").add("Available").add("UseRate").add("MountOn")
.build();

private Env env;

public FrontendsProcNode(Env env) {
Expand All @@ -66,7 +54,7 @@ public FrontendsProcNode(Env env) {
@Override
public ProcResult fetchResult() {
BaseProcResult result = new BaseProcResult();
result.setNames(TITLE_NAMES);
result.setNames(FrontendsTableValuedFunction.getFrontendsTitleNames());

List<List<String>> infos = Lists.newArrayList();

Expand Down
6 changes: 4 additions & 2 deletions ...ore/src/main/java/org/apache/doris/nereids/trees/plans/commands/ShowFrontendsCommand.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,8 @@
import org.apache.doris.qe.ShowResultSet;
import org.apache.doris.qe.ShowResultSetMetaData;
import org.apache.doris.qe.StmtExecutor;
import org.apache.doris.tablefunction.FrontendsDisksTableValuedFunction;
import org.apache.doris.tablefunction.FrontendsTableValuedFunction;

import com.google.common.collect.ImmutableList;
import com.google.common.collect.Lists;
Expand All @@ -60,9 +62,9 @@ public ShowFrontendsCommand(String detail) {
public ShowResultSetMetaData getMetaData() {
ShowResultSetMetaData.Builder builder = ShowResultSetMetaData.builder();

ImmutableList<String> titles = FrontendsProcNode.TITLE_NAMES;
ImmutableList<String> titles = FrontendsTableValuedFunction.getFrontendsTitleNames();
if (detail != null && detail.equalsIgnoreCase("disks")) {
titles = FrontendsProcNode.DISK_TITLE_NAMES;
titles = FrontendsDisksTableValuedFunction.getFrontendsDisksTitleNames();
}
for (String title : titles) {
builder.addColumn(new Column(title, ScalarType.createVarchar(30)));
Expand Down
11 changes: 11 additions & 0 deletions ...-core/src/main/java/org/apache/doris/tablefunction/FrontendsDisksTableValuedFunction.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,13 +56,17 @@ public class FrontendsDisksTableValuedFunction extends MetadataTableValuedFuncti
new Column("MountOn", ScalarType.createStringType()));

private static final ImmutableMap<String, Integer> COLUMN_TO_INDEX;
private static final ImmutableList<String> TITLE_NAMES;

static {
ImmutableMap.Builder<String, Integer> builder = new ImmutableMap.Builder();
ImmutableList.Builder<String> immutableListBuilder = ImmutableList.builder();
for (int i = 0; i < SCHEMA.size(); i++) {
builder.put(SCHEMA.get(i).getName().toLowerCase(), i);
immutableListBuilder.add(SCHEMA.get(i).getName());
}
COLUMN_TO_INDEX = builder.build();
TITLE_NAMES = immutableListBuilder.build();
}

public static Integer getColumnIndexFromColumnName(String columnName) {
Expand Down Expand Up @@ -105,4 +109,11 @@ public String getTableName() {
public List<Column> getTableColumns() throws AnalysisException {
return SCHEMA;
}

/**
* unify title names for frontends_disks function and show frontends disks command
*/
public static ImmutableList<String> getFrontendsDisksTitleNames() {
return TITLE_NAMES;
}
}
16 changes: 14 additions & 2 deletions fe/fe-core/src/main/java/org/apache/doris/tablefunction/FrontendsTableValuedFunction.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,16 +62,21 @@ public class FrontendsTableValuedFunction extends MetadataTableValuedFunction {
new Column("IsHelper", ScalarType.createStringType()),
new Column("ErrMsg", ScalarType.createStringType()),
new Column("Version", ScalarType.createStringType()),
new Column("CurrentConnected", ScalarType.createStringType()));

new Column("CurrentConnected", ScalarType.createStringType()),
new Column("LiveSince", ScalarType.createStringType())
Copy link
Contributor

@morningman morningman Jan 26, 2026

Choose a reason for hiding this comment

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

I think we should directly use FrontendsProcNode.TITLE_NAMES to create this SCHEMA, so that we will not miss any in future.

Copy link
Contributor Author

@heguanhui heguanhui Jan 26, 2026

Choose a reason for hiding this comment

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

Your proposal is very good. I will adjust the code according to your suggestion

);
private static final ImmutableMap<String, Integer> COLUMN_TO_INDEX;
private static final ImmutableList<String> TITLE_NAMES;

static {
ImmutableMap.Builder<String, Integer> builder = new ImmutableMap.Builder();
ImmutableList.Builder<String> immutableListBuilder = ImmutableList.builder();
for (int i = 0; i < SCHEMA.size(); i++) {
builder.put(SCHEMA.get(i).getName().toLowerCase(), i);
immutableListBuilder.add(SCHEMA.get(i).getName());
}
COLUMN_TO_INDEX = builder.build();
TITLE_NAMES = immutableListBuilder.build();
}

public static Integer getColumnIndexFromColumnName(String columnName) {
Expand Down Expand Up @@ -114,4 +119,11 @@ public String getTableName() {
public List<Column> getTableColumns() throws AnalysisException {
return SCHEMA;
}

/**
* unify title names for frontends function and show frontends command
*/
public static ImmutableList<String> getFrontendsTitleNames() {
return TITLE_NAMES;
}
}
61 changes: 60 additions & 1 deletion ...src/test/java/org/apache/doris/nereids/trees/plans/commands/ShowFrontendsCommandTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,8 @@

package org.apache.doris.nereids.trees.plans.commands;

import com.google.common.collect.ImmutableList;
import org.apache.doris.catalog.Column;
import org.apache.doris.catalog.Env;
import org.apache.doris.catalog.InfoSchemaDb;
import org.apache.doris.common.AnalysisException;
Expand All @@ -25,12 +27,17 @@
import org.apache.doris.mysql.privilege.AccessControllerManager;
import org.apache.doris.mysql.privilege.PrivPredicate;
import org.apache.doris.qe.ConnectContext;
import org.apache.doris.qe.ShowResultSet;
import org.apache.doris.tablefunction.FrontendsDisksTableValuedFunction;
import org.apache.doris.tablefunction.FrontendsTableValuedFunction;

import mockit.Expectations;
import mockit.Mocked;
import org.junit.jupiter.api.Assertions;
import org.junit.jupiter.api.Test;

import java.util.List;

public class ShowFrontendsCommandTest {
private static final String internalCtl = InternalCatalog.INTERNAL_CATALOG_NAME;
private static final String infoDB = InfoSchemaDb.DATABASE_NAME;
Expand Down Expand Up @@ -80,7 +87,13 @@ private void runBefore() throws Exception {
public void testNormal() throws Exception {
runBefore();
ShowFrontendsCommand command = new ShowFrontendsCommand(null);
Assertions.assertDoesNotThrow(() -> command.doRun(ctx, null));
ShowResultSet showResultSet = command.doRun(ctx, null);
List<Column> columnList = showResultSet.getMetaData().getColumns();
ImmutableList<String> frontendsTitleNames = FrontendsTableValuedFunction.getFrontendsTitleNames();
Assertions.assertTrue(!columnList.isEmpty() && columnList.size() == frontendsTitleNames.size());
for (int i = 0; i < frontendsTitleNames.size(); i++) {
Assertions.assertTrue(columnList.get(i).getName().equalsIgnoreCase(frontendsTitleNames.get(i)));
}
}

@Test
Expand Down Expand Up @@ -115,4 +128,50 @@ public void testNoPrivilege() throws Exception {
ShowFrontendsCommand command = new ShowFrontendsCommand(null);
Assertions.assertThrows(AnalysisException.class, () -> command.doRun(ctx, null));
}

@Test
public void testNormalShowFrontendsDisks() throws Exception {
runBefore();
ShowFrontendsCommand command = new ShowFrontendsCommand("disks");
ShowResultSet showResultSet = command.doRun(ctx, null);
List<Column> columnList = showResultSet.getMetaData().getColumns();
ImmutableList<String> frontendsDisksTitleNames = FrontendsDisksTableValuedFunction.getFrontendsDisksTitleNames();
Assertions.assertTrue(!columnList.isEmpty() && columnList.size() == frontendsDisksTitleNames.size());
for (int i = 0; i < frontendsDisksTitleNames.size(); i++) {
Assertions.assertTrue(columnList.get(i).getName().equalsIgnoreCase(frontendsDisksTitleNames.get(i)));
}
}

@Test
public void testNoPrivilegeShowFrontendsDisks() throws Exception {
new Expectations() {
{
Env.getCurrentEnv();
minTimes = 0;
result = env;

env.getAccessManager();
minTimes = 0;
result = accessControllerManager;

env.getCatalogMgr();
minTimes = 0;
result = catalogMgr;

catalogMgr.getCatalog(anyString);
minTimes = 0;
result = catalog;

ConnectContext.get();
minTimes = 0;
result = ctx;

accessControllerManager.checkDbPriv(ctx, internalCtl, infoDB, PrivPredicate.SELECT);
minTimes = 0;
result = false;
}
};
ShowFrontendsCommand command = new ShowFrontendsCommand("disks");
Assertions.assertThrows(AnalysisException.class, () -> command.doRun(ctx, null));
}
}
13 changes: 13 additions & 0 deletions regression-test/suites/external_table_p0/tvf/test_frontends_disks_tvf.groovy
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,19 @@ suite("test_frontends_disks_tvf", "p0,external,external_docker") {
assertTrue(table.size() > 0)
assertTrue(table[0].size() == 10)

List<List<Object>> titleNames = sql """ describe function frontends_disks(); """

assertTrue(titleNames[0][0] == "Name")
assertTrue(titleNames[1][0] == "Host")
assertTrue(titleNames[2][0] == "DirType")
assertTrue(titleNames[3][0] == "Dir")
assertTrue(titleNames[4][0] == "Filesystem")
assertTrue(titleNames[5][0] == "Capacity")
assertTrue(titleNames[6][0] == "Used")
assertTrue(titleNames[7][0] == "Available")
assertTrue(titleNames[8][0] == "UseRate")
assertTrue(titleNames[9][0] == "MountOn")

// filter columns
table = sql """ select Name from `frontends_disks`();"""
assertTrue(table.size() > 0)
Expand Down
26 changes: 24 additions & 2 deletions regression-test/suites/external_table_p0/tvf/test_frontends_tvf.groovy
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,29 @@ suite("test_frontends_tvf","p0,external,tvf,external_docker") {
List<List<Object>> table = sql """ select * from `frontends`(); """
logger.info("${table}")
assertTrue(table.size() > 0)
assertTrue(table[0].size() == 19)
assertTrue(table[0].size() == 20)

List<List<Object>> titleNames = sql """ describe function frontends(); """
assertTrue(titleNames[0][0] == "Name")
assertTrue(titleNames[1][0] == "Host")
assertTrue(titleNames[2][0] == "EditLogPort")
assertTrue(titleNames[3][0] == "HttpPort")
assertTrue(titleNames[4][0] == "QueryPort")
assertTrue(titleNames[5][0] == "RpcPort")
assertTrue(titleNames[6][0] == "ArrowFlightSqlPort")
assertTrue(titleNames[7][0] == "Role")
assertTrue(titleNames[8][0] == "IsMaster")
assertTrue(titleNames[9][0] == "ClusterId")
assertTrue(titleNames[10][0] == "Join")
assertTrue(titleNames[11][0] == "Alive")
assertTrue(titleNames[12][0] == "ReplayedJournalId")
assertTrue(titleNames[13][0] == "LastStartTime")
assertTrue(titleNames[14][0] == "LastHeartbeat")
assertTrue(titleNames[15][0] == "IsHelper")
assertTrue(titleNames[16][0] == "ErrMsg")
assertTrue(titleNames[17][0] == "Version")
assertTrue(titleNames[18][0] == "CurrentConnected")
assertTrue(titleNames[19][0] == "LiveSince")

// filter columns
table = sql """ select Name from `frontends`();"""
Expand All @@ -46,7 +68,7 @@ suite("test_frontends_tvf","p0,external,tvf,external_docker") {
sql """ select Name, Host, EditLogPort
HttpPort, QueryPort, RpcPort, ArrowFlightSqlPort, `Role`, IsMaster, ClusterId
`Join`, Alive, ReplayedJournalId, LastHeartbeat
IsHelper, ErrMsg, Version, CurrentConnected from frontends();
IsHelper, ErrMsg, Version, CurrentConnected, LiveSince from frontends();
"""

// test exception
Expand Down