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鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

Introduction of CreateV4ApiUseCase #6827

Merged
merged 10 commits into from Mar 7, 2024
Expand Up @@ -25,6 +25,7 @@
import io.gravitee.apim.core.audit.model.ApiAuditLogEntity;
import io.gravitee.apim.core.audit.model.AuditInfo;
import io.gravitee.apim.core.audit.model.event.ApiAuditEvent;
import io.gravitee.apim.core.datetime.TimeProvider;
import io.gravitee.apim.core.flow.crud_service.FlowCrudService;
import io.gravitee.apim.core.membership.domain_service.ApiPrimaryOwnerDomainService;
import io.gravitee.apim.core.membership.domain_service.ApiPrimaryOwnerFactory;
Expand All @@ -36,6 +37,7 @@
import io.gravitee.apim.core.workflow.crud_service.WorkflowCrudService;
import io.gravitee.rest.api.model.parameters.Key;
import io.gravitee.rest.api.model.parameters.ParameterReferenceType;
import io.gravitee.rest.api.service.common.UuidString;
import java.util.Collections;

public class CreateApiDomainServiceImpl implements CreateApiDomainService {
Expand Down Expand Up @@ -93,7 +95,13 @@ public ApiWithFlows create(Api api, AuditInfo auditInfo) {
auditInfo.organizationId()
);

var created = apiCrudService.create(sanitized);
var created = apiCrudService.create(
sanitized
.setId(UuidString.generateRandom())
.setEnvironmentId(auditInfo.environmentId())
.setCreatedAt(TimeProvider.now())
.setUpdatedAt(TimeProvider.now())
);

createAuditLog(created, auditInfo);

Expand Down
Expand Up @@ -27,12 +27,15 @@
import lombok.Builder;
import lombok.Data;
import lombok.NoArgsConstructor;
import lombok.Setter;
import lombok.experimental.Accessors;
import lombok.experimental.SuperBuilder;

@Data
@NoArgsConstructor
@AllArgsConstructor
@SuperBuilder(toBuilder = true)
@Accessors(chain = true)
jgiovaresco marked this conversation as resolved.
Show resolved Hide resolved
public class Api {

/**
Expand Down Expand Up @@ -165,6 +168,17 @@ public Set<String> getTags() {
}
}

public Api setId(String id) {
this.id = id;
if (apiDefinitionV4 != null) {
apiDefinitionV4.setId(id);
}
if (apiDefinition != null) {
apiDefinition.setId(id);
}
return this;
}

public Api setApiDefinitionV4(io.gravitee.definition.model.v4.Api apiDefinitionV4) {
this.apiDefinitionV4 = apiDefinitionV4;
this.definitionVersion = apiDefinitionV4.getDefinitionVersion();
Expand Down
Expand Up @@ -21,9 +21,11 @@
import lombok.Data;
import lombok.EqualsAndHashCode;
import lombok.NoArgsConstructor;
import lombok.ToString;
import lombok.experimental.SuperBuilder;

@Data
@ToString(callSuper = true)
@EqualsAndHashCode(callSuper = true)
@SuperBuilder(toBuilder = true)
@NoArgsConstructor
Expand Down
@@ -0,0 +1,88 @@
/*
* Copyright 漏 2015 The Gravitee team (http://gravitee.io)
*
* 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 io.gravitee.apim.core.api.model;

import io.gravitee.definition.model.DefinitionVersion;
import io.gravitee.definition.model.v4.ApiType;
import io.gravitee.definition.model.v4.analytics.Analytics;
import io.gravitee.definition.model.v4.endpointgroup.EndpointGroup;
import io.gravitee.definition.model.v4.flow.Flow;
import io.gravitee.definition.model.v4.flow.execution.FlowExecution;
import io.gravitee.definition.model.v4.listener.Listener;
import java.util.List;
import java.util.Set;
import lombok.Builder;
import lombok.Data;

@Data
@Builder(toBuilder = true)
public class NewApi {

private String name;

private String apiVersion;

@Builder.Default
private DefinitionVersion definitionVersion = DefinitionVersion.V4;

private ApiType type;

private String description;

@Builder.Default
private Set<String> tags = Set.of();

private List<Listener> listeners;

private List<EndpointGroup> endpointGroups;

private Analytics analytics;

private FlowExecution flowExecution;

@Builder.Default
private List<Flow> flows = List.of();

@Builder.Default
private Set<String> groups = Set.of();
jgiovaresco marked this conversation as resolved.
Show resolved Hide resolved

public Api toApi() {
return Api
.builder()
.name(name)
.version(apiVersion)
.definitionVersion(definitionVersion)
.description(description)
.groups(groups)
.apiDefinitionV4(toApiDefinition())
.build();
}

public io.gravitee.definition.model.v4.Api toApiDefinition() {
return io.gravitee.definition.model.v4.Api
.builder()
.name(name)
.apiVersion(apiVersion)
.definitionVersion(definitionVersion)
.analytics(analytics)
.tags(tags)
.listeners(listeners)
.endpointGroups(endpointGroups)
.flows(flows)
.flowExecution(flowExecution)
.build();
}
ytvnr marked this conversation as resolved.
Show resolved Hide resolved
}
@@ -0,0 +1,70 @@
/*
* Copyright 漏 2015 The Gravitee team (http://gravitee.io)
*
* 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 io.gravitee.apim.core.api.use_case;

import io.gravitee.apim.core.TransactionalUseCase;
import io.gravitee.apim.core.api.domain_service.CreateApiDomainService;
import io.gravitee.apim.core.api.domain_service.ValidateApiDomainService;
import io.gravitee.apim.core.api.model.Api;
import io.gravitee.apim.core.api.model.ApiWithFlows;
import io.gravitee.apim.core.api.model.NewApi;
import io.gravitee.apim.core.audit.model.AuditInfo;
import io.gravitee.apim.core.datetime.TimeProvider;
import io.gravitee.apim.core.membership.domain_service.ApiPrimaryOwnerFactory;
import io.gravitee.rest.api.service.common.UuidString;

@TransactionalUseCase
public class CreateV4ApiUseCase {
jgiovaresco marked this conversation as resolved.
Show resolved Hide resolved

private final ValidateApiDomainService validateApiDomainService;
private final ApiPrimaryOwnerFactory apiPrimaryOwnerFactory;
private final CreateApiDomainService createApiDomainService;

public CreateV4ApiUseCase(
ValidateApiDomainService validateApiDomainService,
ApiPrimaryOwnerFactory apiPrimaryOwnerFactory,
CreateApiDomainService createApiDomainService
) {
this.validateApiDomainService = validateApiDomainService;
this.apiPrimaryOwnerFactory = apiPrimaryOwnerFactory;
this.createApiDomainService = createApiDomainService;
}

public record Input(NewApi newApi, AuditInfo auditInfo) {}

public record Output(ApiWithFlows api) {}

public Output execute(Input input) {
var auditInfo = input.auditInfo;

var primaryOwner = apiPrimaryOwnerFactory.createForNewApi(
auditInfo.organizationId(),
auditInfo.environmentId(),
auditInfo.actor().userId()
);

var sanitized = validateApiDomainService.validateAndSanitizeForCreation(
input.newApi.toApi(),
primaryOwner,
auditInfo.environmentId(),
auditInfo.organizationId()
);

var created = createApiDomainService.create(sanitized, auditInfo);

return new Output(created);
}
}
Expand Up @@ -22,11 +22,13 @@
import io.gravitee.apim.core.api.domain_service.CreateApiDomainService;
import io.gravitee.apim.core.api.domain_service.DeployApiDomainService;
import io.gravitee.apim.core.api.domain_service.UpdateApiDomainService;
import io.gravitee.apim.core.api.domain_service.ValidateApiDomainService;
import io.gravitee.apim.core.api.domain_service.VerifyApiHostsDomainService;
import io.gravitee.apim.core.api.domain_service.VerifyApiPathDomainService;
import io.gravitee.apim.core.api.query_service.ApiEventQueryService;
import io.gravitee.apim.core.api.query_service.ApiMetadataQueryService;
import io.gravitee.apim.core.api.query_service.ApiQueryService;
import io.gravitee.apim.core.api.use_case.CreateV4ApiUseCase;
import io.gravitee.apim.core.api.use_case.GetApiMetadataUseCase;
import io.gravitee.apim.core.api.use_case.ImportCRDUseCase;
import io.gravitee.apim.core.api.use_case.UpdateDynamicPropertiesUseCase;
Expand Down Expand Up @@ -71,6 +73,7 @@
import io.gravitee.apim.core.log.use_case.SearchConnectionLogUseCase;
import io.gravitee.apim.core.log.use_case.SearchConnectionLogsUseCase;
import io.gravitee.apim.core.log.use_case.SearchMessageLogsUseCase;
import io.gravitee.apim.core.membership.domain_service.ApiPrimaryOwnerFactory;
import io.gravitee.apim.core.parameters.domain_service.ParametersDomainService;
import io.gravitee.apim.core.plan.crud_service.PlanCrudService;
import io.gravitee.apim.core.plan.domain_service.CreatePlanDomainService;
Expand Down Expand Up @@ -418,4 +421,13 @@ public UpdateDynamicPropertiesUseCase updateDynamicPropertiesUsecase(
public GetApiMetadataUseCase getApiMetadataUseCase(ApiCrudService apiCrudService, ApiMetadataQueryService apiMetadataQueryService) {
return new GetApiMetadataUseCase(apiCrudService, apiMetadataQueryService);
}

@Bean
CreateV4ApiUseCase createV4ApiUseCase(
ValidateApiDomainService validateApiDomainService,
ApiPrimaryOwnerFactory apiPrimaryOwnerFactory,
CreateApiDomainService createApiDomainService
) {
return new CreateV4ApiUseCase(validateApiDomainService, apiPrimaryOwnerFactory, createApiDomainService);
}
}
@@ -0,0 +1,73 @@
/*
* Copyright 漏 2015 The Gravitee team (http://gravitee.io)
*
* 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 fixtures.core.model;

import io.gravitee.apim.core.api.model.NewApi;
import io.gravitee.definition.model.DefinitionVersion;
import io.gravitee.definition.model.v4.ApiType;
import io.gravitee.definition.model.v4.endpointgroup.Endpoint;
import io.gravitee.definition.model.v4.endpointgroup.EndpointGroup;
import io.gravitee.definition.model.v4.listener.entrypoint.Entrypoint;
import io.gravitee.definition.model.v4.listener.http.HttpListener;
import io.gravitee.definition.model.v4.listener.http.Path;
import java.util.List;
import java.util.function.Supplier;

public class NewApiFixtures {

private NewApiFixtures() {}

public static final String MY_API = "my-api";
private static final Supplier<NewApi.NewApiBuilder> BASE = () -> NewApi.builder().name("My API").apiVersion("1.0");

public static NewApi aProxyApiV4() {
return BASE
.get()
.definitionVersion(DefinitionVersion.V4)
.type(ApiType.PROXY)
.listeners(
List.of(
HttpListener
.builder()
.paths(List.of(Path.builder().path("/http_proxy").build()))
.entrypoints(List.of(Entrypoint.builder().type("http-proxy").configuration("{}").build()))
.build()
)
)
.endpointGroups(
List.of(
EndpointGroup
.builder()
.name("default-group")
.type("http-proxy")
.sharedConfiguration("{}")
.endpoints(
List.of(
Endpoint
.builder()
.name("default-endpoint")
.type("http-proxy")
.inheritConfiguration(true)
.configuration("{\"target\":\"https://api.gravitee.io/echo\"}")
.build()
)
)
.build()
)
)
.build();
}
}