Skip to content
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.

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

Fix/plugin doc for logshipper and taskrunners #6985

Merged
merged 4 commits into from
Jan 28, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
Original file line number Diff line number Diff line change
Expand Up @@ -520,14 +520,14 @@ protected List<ResolvedType> subtypeResolver(ResolvedType declaredType, TypeCont
.stream()
.flatMap(registeredPlugin -> registeredPlugin.getTaskRunners().stream())
.filter(Predicate.not(io.kestra.core.models.Plugin::isInternal))
.flatMap(clz -> safelyResolveSubtype(declaredType, clz, typeContext).stream())
.map(typeContext::resolve)
.toList();
} else if (declaredType.getErasedType() == LogExporter.class) {
return getRegisteredPlugins()
.stream()
.flatMap(registeredPlugin -> registeredPlugin.getLogExporters().stream())
.filter(Predicate.not(io.kestra.core.models.Plugin::isInternal))
.flatMap(clz -> safelyResolveSubtype(declaredType, clz, typeContext).stream())
.map(typeContext::resolve)
.toList();
} else if (declaredType.getErasedType() == Chart.class) {
return getRegisteredPlugins()
Expand Down
2 changes: 2 additions & 0 deletions core/src/main/java/io/kestra/core/docs/Plugin.java
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,7 @@ public class Plugin {
private List<String> appBlocks;
private List<String> charts;
private List<String> dataFilters;
private List<String> logExporters;
private List<PluginSubGroup.PluginCategory> categories;
private String subGroup;

Expand Down Expand Up @@ -89,6 +90,7 @@ public static Plugin of(RegisteredPlugin registeredPlugin, @Nullable String subg
plugin.appBlocks = filterAndGetClassName(registeredPlugin.getAppBlocks()).stream().filter(c -> subgroup == null || c.startsWith(subgroup)).toList();
plugin.charts = filterAndGetClassName(registeredPlugin.getCharts()).stream().filter(c -> subgroup == null || c.startsWith(subgroup)).toList();
plugin.dataFilters = filterAndGetClassName(registeredPlugin.getDataFilters()).stream().filter(c -> subgroup == null || c.startsWith(subgroup)).toList();
plugin.logExporters = filterAndGetClassName(registeredPlugin.getLogExporters()).stream().filter(c -> subgroup == null || c.startsWith(subgroup)).toList();

return plugin;
}
Expand Down
4 changes: 2 additions & 2 deletions ui/src/stores/plugins.js
Original file line number Diff line number Diff line change
Expand Up @@ -17,14 +17,14 @@ export default {
list({commit}) {
return this.$http.get(`${apiUrl(this)}/plugins`, {}).then(response => {
commit("setPlugins", response.data)
commit("setPluginSingleList", response.data.map(plugin => plugin.tasks.concat(plugin.triggers, plugin.conditions, plugin.controllers, plugin.storages, plugin.taskRunners, plugin.charts, plugin.dataFilters, plugin.aliases)).flat())
commit("setPluginSingleList", response.data.map(plugin => plugin.tasks.concat(plugin.triggers, plugin.conditions, plugin.controllers, plugin.storages, plugin.taskRunners, plugin.charts, plugin.dataFilters, plugin.aliases, plugin.logExporters)).flat())
return response.data;
})
},
listWithSubgroup({commit}) {
return this.$http.get(`${apiUrl(this)}/plugins/groups/subgroups`, {}).then(response => {
commit("setPlugins", response.data)
commit("setPluginSingleList", response.data.map(plugin => plugin.tasks.concat(plugin.triggers, plugin.conditions, plugin.controllers, plugin.storages, plugin.taskRunners, plugin.charts, plugin.dataFilters, plugin.aliases)).flat())
commit("setPluginSingleList", response.data.map(plugin => plugin.tasks.concat(plugin.triggers, plugin.conditions, plugin.controllers, plugin.storages, plugin.taskRunners, plugin.charts, plugin.dataFilters, plugin.aliases, plugin.logExporters)).flat())
return response.data;
})
},
Expand Down
30 changes: 12 additions & 18 deletions ui/src/utils/yamlUtils.js
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
import JsYaml from "js-yaml";
import yaml, {Document, YAMLMap, isSeq, isMap, Pair, Scalar, YAMLSeq, LineCounter, isPair} from "yaml";
import yaml, {Document, isMap, isPair, isSeq, LineCounter, Pair, Scalar, YAMLMap, YAMLSeq} from "yaml";
import _cloneDeep from "lodash/cloneDeep"
import {SECTIONS} from "./constants.js";

Expand Down Expand Up @@ -191,23 +191,21 @@ export default class YamlUtils {
}
}

static extractFieldFromMaps(source, fieldName, yamlDocPredicate = (_) => true) {
static extractFieldFromMaps(source, fieldName, parentPathPredicate = (_) => true) {
const yamlDoc = yaml.parseDocument(source);
const maps = [];
if (yamlDocPredicate(yamlDoc)) {
yaml.visit(yamlDoc, {
Map(_, map) {
if (map.items) {
for (const item of map.items) {
if (item.key.value === fieldName) {
const fieldValue = item.value?.value ?? item.value?.items;
maps.push({[fieldName]: fieldValue, range: map.range});
}
yaml.visit(yamlDoc, {
Map(_, map, parent) {
if (parentPathPredicate(parent.filter(p => yaml.isPair(p)).map(p => p.key.value).join(".")) && map.items) {
for (const item of map.items) {
if (item.key.value === fieldName) {
const fieldValue = item.value?.value ?? item.value?.items;
maps.push({[fieldName]: fieldValue, range: map.range});
}
}
}
})
}
}
})
return maps;
}

Expand Down Expand Up @@ -247,12 +245,8 @@ export default class YamlUtils {
return maps;
}

static extractAllTaskIds(source) {
return this.extractFieldFromMaps(source, "id", (yamlDoc) => yamlDoc.contents && yamlDoc.contents.items && yamlDoc.contents.items.find(e => ["tasks"].includes(e.key?.value)))
}

static extractAllTypes(source) {
return this.extractFieldFromMaps(source, "type", (yamlDoc) => yamlDoc.contents && yamlDoc.contents.items && yamlDoc.contents.items.find(e => ["tasks", "triggers", "errors"].includes(e.key?.value)))
return this.extractFieldFromMaps(source, "type", (parentKey) => ["tasks", "triggers", "errors", "tasks.logExporters"].some(k => k === parentKey))
}

static getTaskType(source, position) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -145,7 +145,8 @@ public MutableHttpResponse<Map<String, PluginIcon>> icons() {
plugin.getTasks().stream(),
plugin.getTriggers().stream(),
plugin.getConditions().stream(),
plugin.getTaskRunners().stream()
plugin.getTaskRunners().stream(),
plugin.getLogExporters().stream()
)
.flatMap(i -> i)
.map(e -> new AbstractMap.SimpleEntry<>(
Expand Down
Loading