Skip to content

Commit

Permalink
fix: Some renaming around KsqlFunction etc (#3747)
Browse files Browse the repository at this point in the history
  • Loading branch information
purplefox authored and Tim Fox committed Nov 5, 2019
1 parent 6ef378f commit b30d965
Show file tree
Hide file tree
Showing 25 changed files with 440 additions and 468 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ public AggregateFunctionFactory(final String functionName) {
"",
KsqlConstants.CONFLUENT_AUTHOR,
"",
KsqlFunction.INTERNAL_PATH,
KsqlScalarFunction.INTERNAL_PATH,
false
));
}
Expand Down
186 changes: 115 additions & 71 deletions ksql-common/src/main/java/io/confluent/ksql/function/KsqlFunction.java
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/*
* Copyright 2018 Confluent Inc.
* Copyright 2019 Confluent Inc.
*
* Licensed under the Confluent Community License (the "License"); you may not use
* this file except in compliance with the License. You may obtain a copy of the
Expand All @@ -15,105 +15,149 @@

package io.confluent.ksql.function;

import io.confluent.ksql.function.udf.Kudf;
import com.google.common.collect.ImmutableList;
import com.google.common.collect.Iterables;
import io.confluent.ksql.name.FunctionName;
import io.confluent.ksql.util.KsqlConfig;
import io.confluent.ksql.schema.ksql.FormatOptions;
import io.confluent.ksql.schema.ksql.SchemaConverters;
import io.confluent.ksql.util.KsqlException;
import io.confluent.ksql.util.SchemaUtil;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.Objects;
import java.util.function.Function;
import java.util.stream.Collectors;
import javax.annotation.concurrent.Immutable;
import org.apache.kafka.connect.data.Schema;
import org.apache.kafka.connect.data.Schema.Type;
import org.apache.kafka.connect.data.SchemaBuilder;

@Immutable
public final class KsqlFunction extends KsqlFunctionBase {
public class KsqlFunction implements FunctionSignature {

static final String INTERNAL_PATH = "internal";
private final Function<List<Schema>, Schema> returnSchemaProvider;
private final Schema javaReturnType;
private final List<Schema> parameters;
private final FunctionName functionName;
private final String description;
private final String pathLoadedFrom;
private final boolean isVariadic;

private final Class<? extends Kudf> kudfClass;
private final Function<KsqlConfig, Kudf> udfFactory;

private KsqlFunction(
final Function<List<Schema>,Schema> returnSchemaProvider,
KsqlFunction(
final Function<List<Schema>, Schema> returnSchemaProvider,
final Schema javaReturnType,
final List<Schema> arguments,
final FunctionName functionName,
final Class<? extends Kudf> kudfClass,
final Function<KsqlConfig, Kudf> udfFactory,
final String description,
final String pathLoadedFrom,
final boolean isVariadic) {
super(returnSchemaProvider, javaReturnType, arguments, functionName, description,
pathLoadedFrom, isVariadic
);
this.kudfClass = Objects.requireNonNull(kudfClass, "kudfClass");
this.udfFactory = Objects.requireNonNull(udfFactory, "udfFactory");
}

/**
* Create built in / legacy function.
*/
@SuppressWarnings("deprecation") // Solution only available in Java9.
public static KsqlFunction createLegacyBuiltIn(
final Schema returnType,
final List<Schema> arguments,
final FunctionName functionName,
final Class<? extends Kudf> kudfClass
final boolean isVariadic
) {
final Function<KsqlConfig, Kudf> udfFactory = ksqlConfig -> {
try {
return kudfClass.newInstance();
} catch (final Exception e) {
throw new KsqlException("Failed to create instance of kudfClass "
+ kudfClass + " for function " + functionName, e);

this.returnSchemaProvider = Objects.requireNonNull(returnSchemaProvider, "schemaProvider");
this.javaReturnType = Objects.requireNonNull(javaReturnType, "javaReturnType");
this.parameters = ImmutableList.copyOf(Objects.requireNonNull(arguments, "arguments"));
this.functionName = Objects.requireNonNull(functionName, "functionName");
this.description = Objects.requireNonNull(description, "description");
this.pathLoadedFrom = Objects.requireNonNull(pathLoadedFrom, "pathLoadedFrom");
this.isVariadic = isVariadic;

if (arguments.stream().anyMatch(Objects::isNull)) {
throw new IllegalArgumentException("KSQL Function can't have null argument types");
}
if (isVariadic) {
if (arguments.isEmpty()) {
throw new IllegalArgumentException(
"KSQL variadic functions must have at least one parameter");
}
if (!Iterables.getLast(arguments).type().equals(Type.ARRAY)) {
throw new IllegalArgumentException(
"KSQL variadic functions must have ARRAY type as their last parameter");
}
};
}
}

public Schema getReturnType(final List<Schema> arguments) {

final Schema returnType = returnSchemaProvider.apply(arguments);

if (returnType == null) {
throw new KsqlException(String.format("Return type of UDF %s cannot be null.", functionName));
}

if (!returnType.isOptional()) {
throw new IllegalArgumentException("KSQL only supports optional field types");
}

if (!GenericsUtil.hasGenerics(returnType)) {
checkMatchingReturnTypes(returnType, javaReturnType);
return returnType;
}

final Map<Schema, Schema> genericMapping = new HashMap<>();
for (int i = 0; i < Math.min(parameters.size(), arguments.size()); i++) {
final Schema schema = parameters.get(i);

// we resolve any variadic as if it were an array so that the type
// structure matches the input type
final Schema instance = isVariadic && i == parameters.size() - 1
? SchemaBuilder.array(arguments.get(i)).build()
: arguments.get(i);

genericMapping.putAll(GenericsUtil.resolveGenerics(schema, instance));
}

return create(
ignored -> returnType, returnType, arguments, functionName, kudfClass, udfFactory, "",
INTERNAL_PATH, false);
final Schema genericSchema = GenericsUtil.applyResolved(returnType, genericMapping);
final Schema genericJavaSchema = GenericsUtil.applyResolved(javaReturnType, genericMapping);
checkMatchingReturnTypes(genericSchema, genericJavaSchema);

return genericSchema;
}

public Class<? extends Kudf> getKudfClass() {
return kudfClass;
private void checkMatchingReturnTypes(final Schema s1, final Schema s2) {
if (!SchemaUtil.areCompatible(s1, s2)) {
throw new KsqlException(String.format(
"Return type %s of UDF %s does not match the declared "
+ "return type %s.",
SchemaConverters.connectToSqlConverter().toSqlType(
s1).toString(),
functionName.toString(FormatOptions.noEscape()),
SchemaConverters.connectToSqlConverter().toSqlType(
s2).toString()
));
}
}

/**
* Create udf.
*
* <p>Can be either built-in UDF or true user-supplied.
*/
static KsqlFunction create(
final Function<List<Schema>,Schema> schemaProvider,
final Schema javaReturnType,
final List<Schema> arguments,
final FunctionName functionName,
final Class<? extends Kudf> kudfClass,
final Function<KsqlConfig, Kudf> udfFactory,
final String description,
final String pathLoadedFrom,
final boolean isVariadic
) {
return new KsqlFunction(
schemaProvider,
javaReturnType,
arguments,
functionName,
kudfClass,
udfFactory,
description,
pathLoadedFrom,
isVariadic);
public List<Schema> getArguments() {
return parameters;
}

public FunctionName getFunctionName() {
return functionName;
}

public String getDescription() {
return description;
}

public String getPathLoadedFrom() {
return pathLoadedFrom;
}

public boolean isVariadic() {
return isVariadic;
}

@Override
public String toString() {
return "KsqlFunction{"
+ ", kudfClass=" + kudfClass
+ "returnType=" + javaReturnType
+ ", arguments=" + parameters.stream().map(Schema::type).collect(Collectors.toList())
+ ", functionName='" + functionName + '\''
+ ", description='" + description + "'"
+ ", pathLoadedFrom='" + pathLoadedFrom + "'"
+ ", isVariadic=" + isVariadic
+ '}';
}

public Kudf newInstance(final KsqlConfig ksqlConfig) {
return udfFactory.apply(ksqlConfig);
}
}
Loading

0 comments on commit b30d965

Please sign in to comment.