Skip to content

Added validation of entry type in describeTable method #388

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

Merged
merged 1 commit into from
Apr 10, 2025
Merged

Added validation of entry type in describeTable method #388

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
71 changes: 40 additions & 31 deletions table/src/main/java/tech/ydb/table/impl/BaseSession.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,7 @@
import tech.ydb.proto.ValueProtos;
import tech.ydb.proto.ValueProtos.TypedValue;
import tech.ydb.proto.common.CommonProtos;
import tech.ydb.proto.scheme.SchemeOperationProtos;
import tech.ydb.proto.table.YdbTable;
import tech.ydb.table.Session;
import tech.ydb.table.description.ChangefeedDescription;
Expand Down Expand Up @@ -661,7 +662,7 @@ public CompletableFuture<Result<TableDescription>> describeTable(String path, De
String traceId = getTraceIdOrGenerateNew(settings.getTraceId());
final GrpcRequestSettings grpcRequestSettings = makeGrpcRequestSettings(settings.getTimeoutDuration(), traceId);
return tableRpc.describeTable(request, grpcRequestSettings)
.thenApply(result -> result.map(desc -> mapDescribeTable(desc, settings)));
.thenApply(res -> mapDescribeTable(res, settings));
}

private static TableTtl mapTtlSettings(YdbTable.TtlSettings ttl) {
Expand Down Expand Up @@ -745,12 +746,22 @@ private static ChangefeedDescription.State mapChangefeedState(YdbTable.Changefee
}
}

private static TableDescription mapDescribeTable(
YdbTable.DescribeTableResult result,
DescribeTableSettings describeTableSettings
) {
private static Result<TableDescription> mapDescribeTable(Result<YdbTable.DescribeTableResult> describeResult,
DescribeTableSettings settings) {
if (!describeResult.isSuccess()) {
return describeResult.map(null);
}
YdbTable.DescribeTableResult desc = describeResult.getValue();
SchemeOperationProtos.Entry.Type entryType = desc.getSelf().getType();

if (entryType != SchemeOperationProtos.Entry.Type.TABLE &&
entryType != SchemeOperationProtos.Entry.Type.COLUMN_TABLE) {
String errorMsg = "Entry " + desc.getSelf().getName() + " with type " + entryType + " is not a table";
return Result.fail(Status.of(StatusCode.SCHEME_ERROR).withIssues(Issue.of(errorMsg, Issue.Severity.ERROR)));
}

TableDescription.Builder description = TableDescription.newBuilder();
switch (result.getStoreType()) {
switch (desc.getStoreType()) {
case STORE_TYPE_ROW:
description = description.setStoreType(TableDescription.StoreType.ROW);
break;
Expand All @@ -763,13 +774,13 @@ private static TableDescription mapDescribeTable(
break;
}

for (int i = 0; i < result.getColumnsCount(); i++) {
YdbTable.ColumnMeta column = result.getColumns(i);
for (int i = 0; i < desc.getColumnsCount(); i++) {
YdbTable.ColumnMeta column = desc.getColumns(i);
description.addNonnullColumn(column.getName(), ProtoType.fromPb(column.getType()), column.getFamily());
}
description.setPrimaryKeys(result.getPrimaryKeyList());
for (int i = 0; i < result.getIndexesCount(); i++) {
YdbTable.TableIndexDescription idx = result.getIndexes(i);
description.setPrimaryKeys(desc.getPrimaryKeyList());
for (int i = 0; i < desc.getIndexesCount(); i++) {
YdbTable.TableIndexDescription idx = desc.getIndexes(i);

if (idx.hasGlobalIndex()) {
description.addGlobalIndex(idx.getName(), idx.getIndexColumnsList(), idx.getDataColumnsList());
Expand All @@ -783,8 +794,8 @@ private static TableDescription mapDescribeTable(
description.addGlobalUniqueIndex(idx.getName(), idx.getIndexColumnsList(), idx.getDataColumnsList());
}
}
YdbTable.TableStats tableStats = result.getTableStats();
if (describeTableSettings.isIncludeTableStats() && tableStats != null) {
YdbTable.TableStats tableStats = desc.getTableStats();
if (settings.isIncludeTableStats() && tableStats != null) {
Timestamp creationTime = tableStats.getCreationTime();
Instant createdAt = creationTime == null ? null : Instant.ofEpochSecond(creationTime.getSeconds(),
creationTime.getNanos());
Expand All @@ -796,26 +807,24 @@ private static TableDescription mapDescribeTable(
description.setTableStats(stats);

List<YdbTable.PartitionStats> partitionStats = tableStats.getPartitionStatsList();
if (describeTableSettings.isIncludePartitionStats() && partitionStats != null) {
if (settings.isIncludePartitionStats() && partitionStats != null) {
for (YdbTable.PartitionStats stat : partitionStats) {
description.addPartitionStat(stat.getRowsEstimate(), stat.getStoreSize());
}
}
}
YdbTable.PartitioningSettings partitioningSettings = result.getPartitioningSettings();
if (partitioningSettings != null) {
PartitioningSettings settings = new PartitioningSettings();
settings.setPartitionSize(partitioningSettings.getPartitionSizeMb());
settings.setMinPartitionsCount(partitioningSettings.getMinPartitionsCount());
settings.setMaxPartitionsCount(partitioningSettings.getMaxPartitionsCount());
settings.setPartitioningByLoad(partitioningSettings.getPartitioningByLoad() == CommonProtos.
FeatureFlag.Status.ENABLED);
settings.setPartitioningBySize(partitioningSettings.getPartitioningBySize() == CommonProtos.
FeatureFlag.Status.ENABLED);
description.setPartitioningSettings(settings);
YdbTable.PartitioningSettings protoPs = desc.getPartitioningSettings();
if (protoPs != null) {
PartitioningSettings ps = new PartitioningSettings();
ps.setPartitionSize(protoPs.getPartitionSizeMb());
ps.setMinPartitionsCount(protoPs.getMinPartitionsCount());
ps.setMaxPartitionsCount(protoPs.getMaxPartitionsCount());
ps.setPartitioningByLoad(protoPs.getPartitioningByLoad() == CommonProtos.FeatureFlag.Status.ENABLED);
ps.setPartitioningBySize(protoPs.getPartitioningBySize() == CommonProtos.FeatureFlag.Status.ENABLED);
description.setPartitioningSettings(ps);
}

List<YdbTable.ColumnFamily> columnFamiliesList = result.getColumnFamiliesList();
List<YdbTable.ColumnFamily> columnFamiliesList = desc.getColumnFamiliesList();
if (columnFamiliesList != null) {
for (YdbTable.ColumnFamily family : columnFamiliesList) {
ColumnFamily.Compression compression;
Expand All @@ -831,8 +840,8 @@ private static TableDescription mapDescribeTable(
);
}
}
if (describeTableSettings.isIncludeShardKeyBounds()) {
List<ValueProtos.TypedValue> shardKeyBoundsList = result.getShardKeyBoundsList();
if (settings.isIncludeShardKeyBounds()) {
List<ValueProtos.TypedValue> shardKeyBoundsList = desc.getShardKeyBoundsList();
if (shardKeyBoundsList != null) {
Optional<Value<?>> leftValue = Optional.empty();
for (ValueProtos.TypedValue typedValue : shardKeyBoundsList) {
Expand All @@ -851,8 +860,8 @@ private static TableDescription mapDescribeTable(
}
}

description.setTtlSettings(mapTtlSettings(result.getTtlSettings()));
for (YdbTable.ChangefeedDescription pb: result.getChangefeedsList()) {
description.setTtlSettings(mapTtlSettings(desc.getTtlSettings()));
for (YdbTable.ChangefeedDescription pb: desc.getChangefeedsList()) {
description.addChangefeed(new ChangefeedDescription(
pb.getName(),
mapChangefeedMode(pb.getMode()),
Expand All @@ -863,7 +872,7 @@ private static TableDescription mapDescribeTable(
));
}

return description.build();
return Result.success(description.build());
}

private static YdbTable.TransactionSettings txSettings(Transaction.Mode transactionMode) {
Expand Down
39 changes: 39 additions & 0 deletions table/src/test/java/tech/ydb/table/integration/DescribeTableTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
package tech.ydb.table.integration;

import org.junit.Assert;
import org.junit.ClassRule;
import org.junit.Test;

import tech.ydb.core.Issue;
import tech.ydb.core.Status;
import tech.ydb.core.StatusCode;
import tech.ydb.table.SessionRetryContext;
import tech.ydb.table.impl.SimpleTableClient;
import tech.ydb.table.rpc.grpc.GrpcTableRpc;
import tech.ydb.test.junit4.GrpcTransportRule;

/**
*
* @author Aleksandr Gorshenin
*/
public class DescribeTableTest {
@ClassRule
public static final GrpcTransportRule YDB_TRANSPORT = new GrpcTransportRule();
private static final SessionRetryContext CTX = SessionRetryContext.create(SimpleTableClient.newClient(
GrpcTableRpc.useTransport(YDB_TRANSPORT)
).build()).build();

@Test
public void wrongTypeTest() {
String databasePath = YDB_TRANSPORT.getDatabase();
Status status = CTX.supplyResult(s -> s.describeTable(databasePath)).join().getStatus();

Assert.assertFalse("Unexpected success", status.isSuccess());
Assert.assertEquals(StatusCode.SCHEME_ERROR, status.getCode());
Issue[] issues = status.getIssues();
Assert.assertEquals(1, issues.length);
String entryName = databasePath.substring(1); // remove lead /
Assert.assertEquals("Entry " + entryName + " with type DIRECTORY is not a table", issues[0].getMessage());
Assert.assertEquals(Issue.Severity.ERROR, issues[0].getSeverity());
}
}