arugal commented on a change in pull request #4228: Support Browser protocol at OAP URL: https://github.com/apache/skywalking/pull/4228#discussion_r395953893
########## File path: test/e2e/e2e-test/src/test/java/org/apache/skywalking/e2e/browser/BrowserE2E.java ########## @@ -0,0 +1,353 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You 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.apache.skywalking.e2e.browser; + +import io.grpc.ManagedChannel; +import io.grpc.internal.DnsNameResolverProvider; +import io.grpc.netty.NettyChannelBuilder; +import io.grpc.stub.StreamObserver; +import java.util.List; +import java.util.UUID; +import java.util.concurrent.CountDownLatch; +import lombok.extern.slf4j.Slf4j; +import org.apache.skywalking.apm.network.common.Commands; +import org.apache.skywalking.apm.network.common.KeyIntValuePair; +import org.apache.skywalking.apm.network.common.ServiceType; +import org.apache.skywalking.apm.network.language.agent.BrowserErrorLog; +import org.apache.skywalking.apm.network.language.agent.BrowserPerfData; +import org.apache.skywalking.apm.network.language.agent.BrowserPerfServiceGrpc; +import org.apache.skywalking.apm.network.language.agent.ErrorCategory; +import org.apache.skywalking.apm.network.register.v2.RegisterGrpc; +import org.apache.skywalking.apm.network.register.v2.ServiceInstance; +import org.apache.skywalking.apm.network.register.v2.ServiceInstanceRegisterMapping; +import org.apache.skywalking.apm.network.register.v2.ServiceInstances; +import org.apache.skywalking.apm.network.register.v2.ServiceRegisterMapping; +import org.apache.skywalking.apm.network.register.v2.Services; +import org.apache.skywalking.e2e.annotation.ContainerHostAndPort; +import org.apache.skywalking.e2e.annotation.DockerCompose; +import org.apache.skywalking.e2e.annotation.DockerContainer; +import org.apache.skywalking.e2e.base.SkyWalkingE2E; +import org.apache.skywalking.e2e.base.SkyWalkingTestAdapter; +import org.apache.skywalking.e2e.base.TrafficController; +import org.apache.skywalking.e2e.common.HostAndPort; +import org.apache.skywalking.e2e.retryable.RetryableTest; +import org.apache.skywalking.e2e.service.Service; +import org.apache.skywalking.e2e.service.ServicesMatcher; +import org.apache.skywalking.e2e.service.ServicesQuery; +import org.apache.skywalking.e2e.service.endpoint.Endpoint; +import org.apache.skywalking.e2e.service.endpoint.EndpointQuery; +import org.apache.skywalking.e2e.service.endpoint.Endpoints; +import org.apache.skywalking.e2e.service.endpoint.EndpointsMatcher; +import org.apache.skywalking.e2e.service.instance.Instance; +import org.apache.skywalking.e2e.service.instance.Instances; +import org.apache.skywalking.e2e.service.instance.InstancesMatcher; +import org.apache.skywalking.e2e.service.instance.InstancesQuery; +import org.junit.jupiter.api.BeforeAll; +import org.testcontainers.containers.ContainerState; +import org.testcontainers.containers.DockerComposeContainer; + +import static java.util.Objects.nonNull; +import static org.apache.skywalking.e2e.metrics.BrowserMetricsQuery.ALL_BROWSER_METRICS; +import static org.apache.skywalking.e2e.metrics.BrowserMetricsQuery.ALL_BROWSER_PAGE_METRICS; +import static org.apache.skywalking.e2e.metrics.BrowserMetricsQuery.ALL_BROWSER_PAGE_MULTIPLE_LINEAR_METRICS; +import static org.apache.skywalking.e2e.metrics.BrowserMetricsQuery.ALL_BROWSER_SINGLE_VERSION_METRICS; +import static org.apache.skywalking.e2e.metrics.MetricsMatcher.verifyMetrics; +import static org.apache.skywalking.e2e.metrics.MetricsMatcher.verifyPercentileMetrics; +import static org.apache.skywalking.e2e.utils.Times.now; +import static org.apache.skywalking.e2e.utils.Yamls.load; + +@Slf4j +@SkyWalkingE2E +public class BrowserE2E extends SkyWalkingTestAdapter { + + private static final int MAX_INBOUND_MESSAGE_SIZE = 1024 * 1024 * 50; + + private static final String BROWSER_NAME = "e2e"; + + private static final String BROWSER_SINGLE_VERSION_NAME = "v1.0.0"; + + @SuppressWarnings("unused") + @DockerCompose({ + "docker/browser/docker-compose.${SW_STORAGE}.yml", + }) + protected DockerComposeContainer<?> compose; + + @SuppressWarnings("unused") + @ContainerHostAndPort(name = "ui", port = 8080) + private HostAndPort swWebappHostPort; + + @SuppressWarnings("unused") + @ContainerHostAndPort(name = "oap", port = 11800) + private HostAndPort oapHostPort; + + @SuppressWarnings("unused") + @DockerContainer("oap") + private ContainerState oapContainer; + + private RegisterGrpc.RegisterBlockingStub registerStub; + + private BrowserPerfServiceGrpc.BrowserPerfServiceStub browserPerfServiceStub; + + private volatile int browserId; + + private volatile int browserSingleVersionId; + + @BeforeAll + public void setUp() { + queryClient(swWebappHostPort); + + final ManagedChannel channel = + NettyChannelBuilder.forAddress(oapHostPort.host(), oapHostPort.port()) + .nameResolverFactory(new DnsNameResolverProvider()) + .maxInboundMessageSize(MAX_INBOUND_MESSAGE_SIZE) + .usePlaintext() + .build(); + + registerStub = RegisterGrpc.newBlockingStub(channel); + browserPerfServiceStub = BrowserPerfServiceGrpc.newStub(channel); + + register(); + generateTraffic(); + } + + @RetryableTest + void verify() throws Exception { + final List<Service> services = graphql.browserServices(new ServicesQuery().start(startTime).end(now())); + LOGGER.info("services: {}", services); + + load("expected/browser/services.yml") + .as(ServicesMatcher.class).verify(services); + + for (Service service : services) { + LOGGER.info("verifying service version: {}", service); + // service metrics + verifyBrowserMetrics(service); + + // service version + verifyBrowserSingleVersion(service); + + // service page path + verifyBrowserPagePath(service); + } + } + + private void verifyBrowserMetrics(final Service service) throws Exception { + for (String metricName : ALL_BROWSER_METRICS) { + verifyMetrics(graphql, metricName, service.getKey(), startTime); + } + } + + private Instances verifyBrowserSingleVersion(final Service service) throws Exception { + Instances instances = graphql.instances( + new InstancesQuery().serviceId(service.getKey()).start(startTime).end(now()) + ); + LOGGER.info("instances: {}", instances); + load("expected/browser/version.yml").as(InstancesMatcher.class).verify(instances); + // service version metrics + for (Instance instance : instances.getInstances()) { + verifyBrowserSingleVersionMetrics(instance); + } + return instances; + } + + private void verifyBrowserSingleVersionMetrics(Instance instance) throws Exception { + for (String metricName : ALL_BROWSER_SINGLE_VERSION_METRICS) { + verifyMetrics(graphql, metricName, instance.getKey(), startTime); + } + } + + private Endpoints verifyBrowserPagePath(final Service service) throws Exception { + Endpoints endpoints = graphql.endpoints(new EndpointQuery().serviceId(String.valueOf(service.getKey()))); + LOGGER.info("endpoints: {}", endpoints); + load("expected/browser/pagePath.yml").as(EndpointsMatcher.class).verify(endpoints); + // service page metrics + for (Endpoint endpoint : endpoints.getEndpoints()) { + verifyBrowserPagePathMetrics(endpoint); + } + return endpoints; + } + + private void verifyBrowserPagePathMetrics(Endpoint endpoint) throws Exception { + for (String metricName : ALL_BROWSER_PAGE_METRICS) { + verifyMetrics(graphql, metricName, endpoint.getKey(), startTime); + } + + for (String metricName : ALL_BROWSER_PAGE_MULTIPLE_LINEAR_METRICS) { + verifyPercentileMetrics(graphql, metricName, endpoint.getKey(), startTime); + } + } + + private void generateTraffic() { + trafficController = TrafficController.builder() + .sender(this::sendBrowserData) + .build() + .start(); + } + + private boolean sendBrowserData() { + try { + BrowserPerfData.Builder perfBuilder = BrowserPerfData.newBuilder() + .setServiceId(browserId) + .setServiceVersionId(browserSingleVersionId) + .setPagePath("/e2e-browser") + .setRedirectTime(10) + .setDnsTime(10) + .setReqTime(10) + .setDomAnalysisTime(10) + .setDomReadyTime(10) + .setBlankTime(10); + sendBrowserPerfData(perfBuilder.build()); + + for (ErrorCategory category : ErrorCategory.values()) { + if (category == ErrorCategory.UNRECOGNIZED) { + continue; + } + BrowserErrorLog.Builder errorLogBuilder = BrowserErrorLog.newBuilder() + .setUniqueId(UUID.randomUUID().toString()) + .setServiceId(browserId) + .setServiceVersionId(browserSingleVersionId) + .setPagePath("/e2e-browser") + .setCategory(category) + .setMessage("test") + .setLine(1) + .setCol(1) + .setStack("e2e") + .setErrorUrl("/e2e/browser"); + if (category == ErrorCategory.js) { + errorLogBuilder.setFirstReportedError(true); + } + sendBrowserErrorLog(errorLogBuilder.build()); + } + return true; + } catch (Throwable e) { + LOGGER.warn(e.getMessage(), e); + return false; + } + } + + private void sendBrowserPerfData(BrowserPerfData browserPerfData) throws InterruptedException { + final CountDownLatch latch = new CountDownLatch(1); + + browserPerfServiceStub.collectPerfData(browserPerfData, new StreamObserver<Commands>() { + @Override + public void onNext(Commands commands) { + + } + + @Override + public void onError(Throwable throwable) { + throwable.printStackTrace(); + latch.countDown(); + } + + @Override + public void onCompleted() { + latch.countDown(); + } + }); + latch.await(); + } + + private void sendBrowserErrorLog(BrowserErrorLog browserErrorLog) throws InterruptedException { + final CountDownLatch latch = new CountDownLatch(1); + + StreamObserver<BrowserErrorLog> collectStream = browserPerfServiceStub.collectErrorLogs( + new StreamObserver<Commands>() { + @Override + public void onNext(Commands commands) { + + } + + @Override + public void onError(Throwable throwable) { + throwable.printStackTrace(); + latch.countDown(); + } + + @Override + public void onCompleted() { + latch.countDown(); + } + }); + collectStream.onNext(browserErrorLog); + collectStream.onCompleted(); + latch.await(); + } + + private void register() { + int retryIndex = 0; + while (browserId == 0 || browserSingleVersionId == 0) { + try { + if (browserId == 0) { + browserId = registerBrowser(); + } + if (browserId > 0) { + browserSingleVersionId = registerBrowserSingleVersion(browserId); + } + if (browserId > 0 && browserSingleVersionId > 0) { + break; + } + } catch (Throwable e) { + if (++retryIndex % 5 == 0) { + LOGGER.error(e.getMessage(), e); + } + } + try { + Thread.sleep(1000); + } catch (InterruptedException e) { + // ignore + } + } + } Review comment: Thanks @kezhenxu94. I've changed the code based on the comments :) ---------------------------------------------------------------- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. For queries about this service, please contact Infrastructure at: us...@infra.apache.org With regards, Apache Git Services
