src/plugins/AxiosPlugin.ts

/*!
 *
 * 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.
 *
 */

import SwPlugin from '../core/SwPlugin';
import { URL } from 'url';
import ContextManager from '../trace/context/ContextManager';
import { Component } from '../trace/Component';
import Span from '../trace/span/Span';
import Tag from '../Tag';
import { SpanLayer } from '../proto/language-agent/Tracing_pb';
import { createLogger } from '../logging';
import PluginInstaller from '../core/PluginInstaller';

const logger = createLogger(__filename);

class AxiosPlugin implements SwPlugin {
  readonly module = 'axios';
  readonly versions = '*';

  install(installer: PluginInstaller): void {
    if (logger.isDebugEnabled()) {
      logger.debug('installing axios plugin');
    }
    const axios = installer.require('axios').default;
    this.interceptClientRequest(axios);
  }

  private interceptClientRequest(axios: any) {
    const copyStatusAndStop = (span: Span, response: any) => {
      if (response) {
        if (response.status) {
          span.tag(Tag.httpStatusCode(response.status));
        }
        if (response.statusText) {
          span.tag(Tag.httpStatusMsg(response.statusText));
        }
      }

      span.stop();
    };

    axios.interceptors.request.use(
      (config: any) => {
        // config.span.resync(); // TODO: fix this https://github.com/apache/skywalking-nodejs/pull/20#issuecomment-753323425

        (config.span as Span).inject().items.forEach((item) => {
          config.headers.common[item.key] = item.value;
        });

        return config;
      },

      (error: any) => {
        error.config.span.error(error);
        error.config.span.stop();

        return Promise.reject(error);
      },
    );

    axios.interceptors.response.use(
      (response: any) => {
        copyStatusAndStop(response.config.span, response);

        return response;
      },

      (error: any) => {
        error.config.span.error(error);

        copyStatusAndStop(error.config.span, error.response);

        return Promise.reject(error);
      },
    );

    const _request = axios.Axios.prototype.request;

    axios.Axios.prototype.request = function(config: any) {
      const { host, pathname: operation } = new URL(config.url);  // TODO: this may throw invalid URL
      const span = ContextManager.current.newExitSpan(operation, host).start();

      try {
        span.component = Component.AXIOS;
        span.layer = SpanLayer.HTTP;
        span.peer = host;
        span.tag(Tag.httpURL(host + operation));
        // span.async(); TODO: fix this https://github.com/apache/skywalking-nodejs/pull/20#issuecomment-753323425

        return _request.call(this, { ...config, span });
      } catch (e) {
        span.error(e);
        span.stop();

        throw e;
      }
    };
  }
}

// noinspection JSUnusedGlobalSymbols
export default new AxiosPlugin();