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

Remove deprecations 2 #1885

Merged
merged 2 commits into from
May 28, 2020
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
@@ -1,5 +1,5 @@
/*
* Copyright (c) 2019 Oracle and/or its affiliates. All rights reserved.
* Copyright (c) 2019, 2020 Oracle and/or its affiliates.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
Expand Down Expand Up @@ -106,21 +106,6 @@ public Optional<SpanContext> findParent() {
.or(() -> parentSpanContext);
}

/**
* Find closes parent span.
*
* @return span context if found
* @deprecated will be removed once security context works
* with {@link io.opentracing.SpanContext}. Needed for
* backward compatibility
*/
@Deprecated
public Optional<Span> findParentSpan() {
Optional<Span> closest = closestSecuritySpan();

return closest.or(() -> parentSpan);
}

/**
* Log response status.
* This is to be used by authorization, authentication and outbound
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -90,7 +90,6 @@ public void applyRequestMetadata(RequestInfo requestInfo, Executor appExecutor,
OutboundSecurityClientBuilder clientBuilder = context.outboundClientBuilder()
.outboundEnvironment(outboundEnv)
.tracingSpan(tracing.findParent().orElse(null))
.tracingSpan(tracing.findParentSpan().orElse(null))
.outboundEndpointConfig(outboundEp)
.explicitProvider(explicitProvider);

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/*
* Copyright (c) 2019 Oracle and/or its affiliates. All rights reserved.
* Copyright (c) 2019, 2020 Oracle and/or its affiliates.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
Expand Down Expand Up @@ -60,7 +60,6 @@
import io.grpc.ServerCallHandler;
import io.grpc.ServerInterceptor;
import io.grpc.Status;
import io.opentracing.Span;
import io.opentracing.SpanContext;

import static io.helidon.security.AuditEvent.AuditParam.plain;
Expand Down Expand Up @@ -457,8 +456,7 @@ private CompletionStage<AtxResult> processAuthentication(ServerCall<?, ?> call,
SecurityClientBuilder<AuthenticationResponse> clientBuilder = securityContext.atnClientBuilder();

configureSecurityRequest(clientBuilder,
atnTracing.findParent().orElse(null),
atnTracing.findParentSpan().orElse(null));
atnTracing.findParent().orElse(null));

clientBuilder.explicitProvider(explicitAuthenticator.orElse(null)).submit().thenAccept(response -> {
switch (response.status()) {
Expand Down Expand Up @@ -534,12 +532,10 @@ private void atnFinish(CompletableFuture<AtxResult> future) {
}

private void configureSecurityRequest(SecurityRequestBuilder<? extends SecurityRequestBuilder<?>> request,
SpanContext parentSpanContext,
Span parentSpan) {
SpanContext parentSpanContext) {

request.optional(authenticationOptional.orElse(false))
.tracingSpan(parentSpanContext)
.tracingSpan(parentSpan);
.tracingSpan(parentSpanContext);
}

private CompletionStage<AtxResult> processAuthorization(
Expand Down Expand Up @@ -577,8 +573,7 @@ private CompletionStage<AtxResult> processAuthorization(

client = context.atzClientBuilder();
configureSecurityRequest(client,
atzTracing.findParent().orElse(null),
atzTracing.findParentSpan().orElse(null));
atzTracing.findParent().orElse(null));

client.explicitProvider(explicitAuthorizer.orElse(null)).submit().thenAccept(response -> {
atzTracing.logStatus(response.status());
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -112,7 +112,6 @@ private void outboundSecurity(ClientRequestContext requestContext, SecurityConte
OutboundSecurityClientBuilder clientBuilder = securityContext.outboundClientBuilder()
.outboundEnvironment(outboundEnv)
.tracingSpan(tracing.findParent().orElse(null))
.tracingSpan(tracing.findParentSpan().orElse(null))
.outboundEndpointConfig(outboundEp);

explicityProvider.ifPresent(clientBuilder::explicitProvider);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -139,9 +139,7 @@ protected void authenticate(SecurityFilter.FilterContext context, SecurityContex
SecurityClientBuilder<AuthenticationResponse> clientBuilder = securityContext
.atnClientBuilder()
.optional(methodSecurity.authenticationOptional())
.tracingSpan(atnTracing.findParent().orElse(null))
// backward compatibility - remove in 2.0
.tracingSpan(atnTracing.findParentSpan().orElse(null));
.tracingSpan(atnTracing.findParent().orElse(null));

clientBuilder.explicitProvider(methodSecurity.getAuthenticator());
processAuthentication(context, clientBuilder, methodSecurity, atnTracing);
Expand Down Expand Up @@ -254,8 +252,6 @@ protected void authorize(FilterContext context,
// access
if (context.getMethodSecurity().requiresAuthorization()) {
SecurityClientBuilder<AuthorizationResponse> clientBuilder = securityContext.atzClientBuilder()
// TODO remove in 2.0 - backward compatibility until then
.tracingSpan(atzTracing.findParentSpan().orElse(null))
.tracingSpan(atzTracing.findParent().orElse(null))
.explicitProvider(context.getMethodSecurity().getAuthorizer());

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,6 @@
import io.helidon.webserver.ServerRequest;
import io.helidon.webserver.ServerResponse;

import io.opentracing.Span;
import io.opentracing.SpanContext;

import static io.helidon.security.AuditEvent.AuditParam.plain;
Expand Down Expand Up @@ -442,8 +441,7 @@ private CompletionStage<AtxResult> processAuthentication(ServerResponse res,

SecurityClientBuilder<AuthenticationResponse> clientBuilder = securityContext.atnClientBuilder();
configureSecurityRequest(clientBuilder,
atnTracing.findParent().orElse(null),
atnTracing.findParentSpan().orElse(null));
atnTracing.findParent().orElse(null));

clientBuilder.explicitProvider(explicitAuthenticator.orElse(null)).submit().thenAccept(response -> {
switch (response.status()) {
Expand Down Expand Up @@ -556,12 +554,10 @@ private void abortRequest(ServerResponse res,
}

private void configureSecurityRequest(SecurityRequestBuilder<? extends SecurityRequestBuilder<?>> request,
SpanContext parentSpanContext,
Span parentSpan) {
SpanContext parentSpanContext) {

request.optional(authenticationOptional.orElse(false))
.tracingSpan(parentSpanContext)
.tracingSpan(parentSpan);
.tracingSpan(parentSpanContext);
}

@SuppressWarnings("ThrowableNotThrown")
Expand Down Expand Up @@ -603,8 +599,7 @@ private CompletionStage<AtxResult> processAuthorization(ServerRequest req,

client = context.atzClientBuilder();
configureSecurityRequest(client,
atzTracing.findParent().orElse(null),
atzTracing.findParentSpan().orElse(null));
atzTracing.findParent().orElse(null));

client.explicitProvider(explicitAuthorizer.orElse(null)).submit().thenAccept(response -> {
atzTracing.logStatus(response.status());
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,6 @@
import java.util.Optional;
import java.util.function.Supplier;

import io.opentracing.Span;
import io.opentracing.SpanContext;

/**
Expand All @@ -38,17 +37,6 @@ default boolean isOptional() {
return false;
}

/**
* Get the span to trace subsequent requests.
*
* @return Open tracing Span instance (started) of the parent of the current request, never null.
* @see io.opentracing.util.GlobalTracer#get()
* @see io.opentracing.Tracer#buildSpan(String)
* @deprecated use {@link #tracingSpanContext()} instead
*/
@Deprecated
Span tracingSpan();

/**
* Parent span for tracing. There may be no parent defined (such as when tracing is disabled).
*
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,6 @@

import io.helidon.security.spi.SecurityProvider;

import io.opentracing.Span;
import io.opentracing.SpanContext;

/**
Expand All @@ -38,7 +37,6 @@ public class SecurityRequestBuilder<T extends SecurityRequestBuilder<T>> {
private final Map<String, Supplier<Object>> resources = new HashMap<>();
private String providerName;
private boolean isOptional;
private Span tracingSpan;
private SpanContext tracingSpanContext;

@SuppressWarnings("unchecked")
Expand Down Expand Up @@ -101,22 +99,6 @@ public T object(String key, Supplier<Object> object) {
return myInstance;
}

/**
* Tracing span to support Open tracing. Provider developer can add additional spans as children of this span
* to trace their progress.
*
* @param span span of current security request (e.g. authentication, authorization or outbound)
* @return updated builder instance
* @see io.opentracing.util.GlobalTracer#get()
* @see io.opentracing.Tracer#buildSpan(String)
* @deprecated to be removed in 2.0, now needed for backward compatibility
*/
@Deprecated
public T tracingSpan(Span span) {
this.tracingSpan = span;
return myInstance;
}

/**
* Tracing span to support Open tracing. Provider developer can add additional spans as children of this span
* to trace their progress.
Expand Down Expand Up @@ -168,17 +150,15 @@ String providerName() {
return providerName;
}

private final class SecurityRequestImpl implements SecurityRequest {
private static final class SecurityRequestImpl implements SecurityRequest {
private final String providerName;
private final boolean isOptional;
private final Span tracingSpan;
private final Optional<SpanContext> tracingSpanContext;
private final Map<String, Supplier<Object>> resources = new HashMap<>();

private SecurityRequestImpl(SecurityRequestBuilder<?> builder) {
this.providerName = builder.providerName;
this.isOptional = builder.isOptional;
this.tracingSpan = builder.tracingSpan;
this.tracingSpanContext = Optional.ofNullable(builder.tracingSpanContext);
this.resources.putAll(builder.resources);
}
Expand All @@ -188,11 +168,6 @@ public boolean isOptional() {
return isOptional;
}

@Override
public Span tracingSpan() {
return tracingSpan;
}

@Override
public Optional<SpanContext> tracingSpanContext() {
return tracingSpanContext;
Expand All @@ -207,7 +182,6 @@ public String toString() {
return "SecurityRequestImpl{"
+ "providerName='" + providerName + '\''
+ ", isOptional=" + isOptional
+ ", tracingSpan=" + tracingSpan
+ '}';
}
}
Expand Down