Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $
You can buy this project and download/modify it how often you want.
org.openmetadata.service.resources.bots.BotResource Maven / Gradle / Ivy
/*
* Copyright 2021 Collate
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
* http://www.apache.org/licenses/LICENSE-2.0
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.openmetadata.service.resources.bots;
import static org.openmetadata.common.utils.CommonUtil.listOrEmpty;
import io.swagger.v3.oas.annotations.ExternalDocumentation;
import io.swagger.v3.oas.annotations.Operation;
import io.swagger.v3.oas.annotations.Parameter;
import io.swagger.v3.oas.annotations.media.Content;
import io.swagger.v3.oas.annotations.media.ExampleObject;
import io.swagger.v3.oas.annotations.media.Schema;
import io.swagger.v3.oas.annotations.parameters.RequestBody;
import io.swagger.v3.oas.annotations.responses.ApiResponse;
import io.swagger.v3.oas.annotations.tags.Tag;
import java.io.IOException;
import java.util.List;
import java.util.UUID;
import javax.json.JsonPatch;
import javax.validation.Valid;
import javax.validation.constraints.Max;
import javax.validation.constraints.Min;
import javax.ws.rs.Consumes;
import javax.ws.rs.DELETE;
import javax.ws.rs.DefaultValue;
import javax.ws.rs.GET;
import javax.ws.rs.PATCH;
import javax.ws.rs.POST;
import javax.ws.rs.PUT;
import javax.ws.rs.Path;
import javax.ws.rs.PathParam;
import javax.ws.rs.Produces;
import javax.ws.rs.QueryParam;
import javax.ws.rs.core.Context;
import javax.ws.rs.core.MediaType;
import javax.ws.rs.core.Response;
import javax.ws.rs.core.SecurityContext;
import javax.ws.rs.core.UriInfo;
import lombok.extern.slf4j.Slf4j;
import org.openmetadata.schema.EntityInterface;
import org.openmetadata.schema.api.CreateBot;
import org.openmetadata.schema.api.data.RestoreEntity;
import org.openmetadata.schema.entity.Bot;
import org.openmetadata.schema.entity.teams.User;
import org.openmetadata.schema.type.EntityHistory;
import org.openmetadata.schema.type.Include;
import org.openmetadata.schema.type.Relationship;
import org.openmetadata.schema.utils.EntityInterfaceUtil;
import org.openmetadata.service.Entity;
import org.openmetadata.service.OpenMetadataApplicationConfig;
import org.openmetadata.service.exception.CatalogExceptionMessage;
import org.openmetadata.service.jdbi3.BotRepository;
import org.openmetadata.service.jdbi3.CollectionDAO.EntityRelationshipRecord;
import org.openmetadata.service.jdbi3.EntityRepository;
import org.openmetadata.service.jdbi3.ListFilter;
import org.openmetadata.service.jdbi3.UserRepository;
import org.openmetadata.service.resources.Collection;
import org.openmetadata.service.resources.EntityResource;
import org.openmetadata.service.resources.teams.RoleResource;
import org.openmetadata.service.security.Authorizer;
import org.openmetadata.service.security.SecurityUtil;
import org.openmetadata.service.util.EntityUtil;
import org.openmetadata.service.util.ResultList;
import org.openmetadata.service.util.UserUtil;
@Slf4j
@Path("/v1/bots")
@Tag(
name = "Bots",
description =
"A `Bot` automates tasks, such as ingesting metadata, and running data quality "
+ "It performs this task as a special user in the system.")
@Produces(MediaType.APPLICATION_JSON)
@Consumes(MediaType.APPLICATION_JSON)
@Collection(name = "bots", order = 4, requiredForOps = true) // initialize after user resource
public class BotResource extends EntityResource {
public static final String COLLECTION_PATH = "/v1/bots/";
public BotResource(Authorizer authorizer) {
super(Entity.BOT, authorizer);
}
@Override
public void initialize(OpenMetadataApplicationConfig config) throws IOException {
String domain = SecurityUtil.getDomain(config);
// First, load the bot users and assign their roles
UserRepository userRepository = (UserRepository) Entity.getEntityRepository(Entity.USER);
List botUsers = userRepository.getEntitiesFromSeedData(".*json/data/botUser/.*\\.json$");
for (User botUser : botUsers) {
User user =
UserUtil.user(botUser.getName(), domain, botUser.getName())
.withIsBot(true)
.withIsAdmin(false);
user.setRoles(
listOrEmpty(botUser.getRoles()).stream()
.map(entityReference -> RoleResource.getRole(entityReference.getName()))
.toList());
// Add or update User Bot
UserUtil.addOrUpdateBotUser(user);
}
// Then, load the bots and bind them to the users
List bots = repository.getEntitiesFromSeedData();
for (Bot bot : bots) {
String userName = bot.getBotUser().getName();
bot.withBotUser(
userRepository
.getByName(null, userName, userRepository.getFields("id"))
.getEntityReference());
repository.initializeEntity(bot);
}
}
@Override
public Bot addHref(UriInfo uriInfo, Bot entity) {
super.addHref(uriInfo, entity);
Entity.withHref(uriInfo, entity.getBotUser());
return entity;
}
public static class BotList extends ResultList {
/* Required for serde */
}
@GET
@Operation(
operationId = "listBots",
summary = "List bots",
description = "Get a list of Bot.",
responses = {
@ApiResponse(
responseCode = "200",
description = "List of Bot",
content =
@Content(
mediaType = "application/json",
schema = @Schema(implementation = BotList.class)))
})
public ResultList list(
@Context UriInfo uriInfo,
@Context SecurityContext securityContext,
@DefaultValue("10") @Min(0) @Max(1000000) @QueryParam("limit") int limitParam,
@Parameter(
description = "Returns list of Bot before this cursor",
schema = @Schema(type = "string"))
@QueryParam("before")
String before,
@Parameter(
description = "Returns list of Bot after this cursor",
schema = @Schema(type = "string"))
@QueryParam("after")
String after,
@Parameter(
description = "Include all, deleted, or non-deleted entities.",
schema = @Schema(implementation = Include.class))
@QueryParam("include")
@DefaultValue("non-deleted")
Include include) {
return listInternal(
uriInfo, securityContext, "", new ListFilter(include), limitParam, before, after);
}
@GET
@Path("/{id}")
@Operation(
operationId = "getBotByID",
summary = "Get a bot by Id",
description = "Get a bot by `Id`.",
responses = {
@ApiResponse(
responseCode = "200",
description = "The bot",
content =
@Content(
mediaType = "application/json",
schema = @Schema(implementation = Bot.class))),
@ApiResponse(responseCode = "404", description = "Bot for instance {id} is not found")
})
public Bot get(
@Context UriInfo uriInfo,
@Context SecurityContext securityContext,
@QueryParam("include") @DefaultValue("non-deleted") Include include,
@Parameter(description = "Id of the bot", schema = @Schema(type = "UUID")) @PathParam("id")
UUID id) {
return getInternal(uriInfo, securityContext, id, "", include);
}
@GET
@Path("/name/{name}")
@Operation(
operationId = "getBotByFQN",
summary = "Get a bot by name",
description = "Get a bot by `name`.",
responses = {
@ApiResponse(
responseCode = "200",
description = "bot",
content =
@Content(
mediaType = "application/json",
schema = @Schema(implementation = Bot.class))),
@ApiResponse(responseCode = "404", description = "Bot for instance {name} is not found")
})
public Bot getByName(
@Context UriInfo uriInfo,
@Context SecurityContext securityContext,
@Parameter(description = "Name of the bot", schema = @Schema(type = "string"))
@PathParam("name")
String name,
@Parameter(
description = "Include all, deleted, or non-deleted entities.",
schema = @Schema(implementation = Include.class))
@QueryParam("include")
@DefaultValue("non-deleted")
Include include) {
return getByNameInternal(
uriInfo, securityContext, EntityInterfaceUtil.quoteName(name), "", include);
}
@GET
@Path("/{id}/versions")
@Operation(
operationId = "listAllBotVersion",
summary = "List bot versions",
description = "Get a list of all the versions of a bot identified by `Id`",
responses = {
@ApiResponse(
responseCode = "200",
description = "List of bot versions",
content =
@Content(
mediaType = "application/json",
schema = @Schema(implementation = EntityHistory.class)))
})
public EntityHistory listVersions(
@Context UriInfo uriInfo,
@Context SecurityContext securityContext,
@Parameter(description = "Id of the bot", schema = @Schema(type = "UUID")) @PathParam("id")
UUID id) {
return super.listVersionsInternal(securityContext, id);
}
@GET
@Path("/{id}/versions/{version}")
@Operation(
operationId = "listSpecificBotVersion",
summary = "Get a version of the bot",
description = "Get a version of the bot by given `Id`",
responses = {
@ApiResponse(
responseCode = "200",
description = "bot",
content =
@Content(
mediaType = "application/json",
schema = @Schema(implementation = Bot.class))),
@ApiResponse(
responseCode = "404",
description = "Bot for instance {id} and version {version} is not found")
})
public Bot getVersion(
@Context UriInfo uriInfo,
@Context SecurityContext securityContext,
@Parameter(description = "Id of the bot", schema = @Schema(type = "UUID")) @PathParam("id")
UUID id,
@Parameter(
description = "bot version number in the form `major`.`minor`",
schema = @Schema(type = "string", example = "0.1 or 1.1"))
@PathParam("version")
String version) {
return super.getVersionInternal(securityContext, id, version);
}
@POST
@Operation(
operationId = "createBot",
summary = "Create a bot",
description = "Create a new bot.",
responses = {
@ApiResponse(
responseCode = "200",
description = "The bot ",
content =
@Content(
mediaType = "application/json",
schema = @Schema(implementation = Bot.class))),
@ApiResponse(responseCode = "400", description = "Bad request")
})
public Response create(
@Context UriInfo uriInfo, @Context SecurityContext securityContext, @Valid CreateBot create) {
Bot bot = getBot(securityContext, create);
return create(uriInfo, securityContext, bot);
}
@PUT
@Operation(
operationId = "createOrUpdateBot",
summary = "Create or update a bot",
description = "Create a bot, if it does not exist. If a bot already exists, update the bot.",
responses = {
@ApiResponse(
responseCode = "200",
description = "The bot",
content =
@Content(
mediaType = "application/json",
schema = @Schema(implementation = Bot.class))),
@ApiResponse(responseCode = "400", description = "Bad request")
})
public Response createOrUpdate(
@Context UriInfo uriInfo, @Context SecurityContext securityContext, @Valid CreateBot create) {
Bot bot = getBot(securityContext, create);
return createOrUpdate(uriInfo, securityContext, bot);
}
@PATCH
@Path("/{id}")
@Operation(
operationId = "patchBot",
summary = "Update a bot",
description = "Update an existing bot using JsonPatch.",
externalDocs =
@ExternalDocumentation(
description = "JsonPatch RFC",
url = "https://tools.ietf.org/html/rfc6902"))
@Consumes(MediaType.APPLICATION_JSON_PATCH_JSON)
public Response patch(
@Context UriInfo uriInfo,
@Context SecurityContext securityContext,
@Parameter(description = "Id of the bot", schema = @Schema(type = "UUID")) @PathParam("id")
UUID id,
@RequestBody(
description = "JsonPatch with array of operations",
content =
@Content(
mediaType = MediaType.APPLICATION_JSON_PATCH_JSON,
examples = {
@ExampleObject("[{op:remove, path:/a},{op:add, path: /b, value: val}]")
}))
JsonPatch patch) {
return patchInternal(uriInfo, securityContext, id, patch);
}
@PATCH
@Path("/name/{fqn}")
@Operation(
operationId = "patchBot",
summary = "Update a bot by name.",
description = "Update an existing bot using JsonPatch.",
externalDocs =
@ExternalDocumentation(
description = "JsonPatch RFC",
url = "https://tools.ietf.org/html/rfc6902"))
@Consumes(MediaType.APPLICATION_JSON_PATCH_JSON)
public Response patch(
@Context UriInfo uriInfo,
@Context SecurityContext securityContext,
@Parameter(description = "Name of the bot", schema = @Schema(type = "string"))
@PathParam("fqn")
String fqn,
@RequestBody(
description = "JsonPatch with array of operations",
content =
@Content(
mediaType = MediaType.APPLICATION_JSON_PATCH_JSON,
examples = {
@ExampleObject("[{op:remove, path:/a},{op:add, path: /b, value: val}]")
}))
JsonPatch patch) {
return patchInternal(uriInfo, securityContext, fqn, patch);
}
@DELETE
@Path("/{id}")
@Operation(
operationId = "deleteBot",
summary = "Delete a bot by Id",
description = "Delete a bot by `Id`.",
responses = {
@ApiResponse(responseCode = "200", description = "OK"),
@ApiResponse(responseCode = "404", description = "Bot for instance {id} is not found")
})
public Response delete(
@Context UriInfo uriInfo,
@Context SecurityContext securityContext,
@Parameter(description = "Hard delete the entity. (Default = `false`)")
@QueryParam("hardDelete")
@DefaultValue("false")
boolean hardDelete,
@Parameter(description = "Id of the bot", schema = @Schema(type = "UUID")) @PathParam("id")
UUID id) {
return delete(uriInfo, securityContext, id, true, hardDelete);
}
@DELETE
@Path("/name/{name}")
@Operation(
operationId = "deleteBotByFQN",
summary = "Delete a bot by name",
description = "Delete a bot by `name`.",
responses = {
@ApiResponse(responseCode = "200", description = "OK"),
@ApiResponse(responseCode = "404", description = "Bot for instance {name} is not found")
})
public Response delete(
@Context UriInfo uriInfo,
@Context SecurityContext securityContext,
@Parameter(description = "Hard delete the entity. (Default = `false`)")
@QueryParam("hardDelete")
@DefaultValue("false")
boolean hardDelete,
@Parameter(description = "Name of the bot", schema = @Schema(type = "string"))
@PathParam("name")
String name) {
return deleteByName(
uriInfo, securityContext, EntityInterfaceUtil.quoteName(name), true, hardDelete);
}
@PUT
@Path("/restore")
@Operation(
operationId = "restore",
summary = "Restore a soft deleted bot",
description = "Restore a soft deleted bot.",
responses = {
@ApiResponse(
responseCode = "200",
description = "Successfully restored the Bot ",
content =
@Content(
mediaType = "application/json",
schema = @Schema(implementation = Bot.class)))
})
public Response restoreBot(
@Context UriInfo uriInfo,
@Context SecurityContext securityContext,
@Valid RestoreEntity restore) {
return restoreEntity(uriInfo, securityContext, restore.getId());
}
private Bot getBot(CreateBot create, String user) {
return repository
.copy(new Bot(), create, user)
.withBotUser(getEntityReference(Entity.USER, create.getBotUser()))
.withProvider(create.getProvider())
.withFullyQualifiedName(create.getName());
}
private boolean userHasRelationshipWithAnyBot(User user, Bot botUser) {
if (user == null) {
return false;
}
List userBotRelationship = retrieveBotRelationshipsFor(user);
return !userBotRelationship.isEmpty()
&& (botUser == null
|| userBotRelationship.stream()
.anyMatch(relationship -> !relationship.getId().equals(botUser.getId())));
}
private List retrieveBotRelationshipsFor(User user) {
return repository.findFromRecords(user.getId(), Entity.USER, Relationship.CONTAINS, Entity.BOT);
}
private Bot getBot(SecurityContext securityContext, CreateBot create) {
Bot bot = getBot(create, securityContext.getUserPrincipal().getName());
Bot originalBot = retrieveBot(bot.getName());
User botUser = retrieveUser(bot);
if (botUser != null && !Boolean.TRUE.equals(botUser.getIsBot())) {
throw new IllegalArgumentException(
String.format("User [%s] is not a bot user", botUser.getName()));
}
if (userHasRelationshipWithAnyBot(botUser, originalBot)) {
List userBotRelationship = retrieveBotRelationshipsFor(botUser);
bot =
repository.get(
null,
userBotRelationship.stream().findFirst().orElseThrow().getId(),
EntityUtil.Fields.EMPTY_FIELDS);
throw new IllegalArgumentException(
CatalogExceptionMessage.userAlreadyBot(botUser.getName(), bot.getName()));
}
// TODO: review this flow on https://github.com/open-metadata/OpenMetadata/issues/8321
if (originalBot != null) {
bot.setProvider(originalBot.getProvider());
}
return bot;
}
private User retrieveUser(Bot bot) {
EntityRepository userRepository =
Entity.getEntityRepository(Entity.USER);
return (User)
userRepository.findByNameOrNull(
bot.getBotUser().getFullyQualifiedName(), Include.NON_DELETED);
}
private Bot retrieveBot(String botName) {
return repository.findByNameOrNull(botName, Include.NON_DELETED);
}
}
