feat: support for log level

BREAKING CHANGE: now we can move to v1.0.0!

Author: wuct

README.md

@@ -43,7 +43,8 @@ const webpackConfig = {
       serviceVersion: 'SERVICE_VERSION',
       serverURL: 'https://ELASTIC_APM_SERVER_URL',
       publicPath: PUBLIC_PATH,
-      secret: 'SECRET'
+      secret: 'SECRET',
+      logLevel: 'debug'
     })
   ]
 };
@@ -73,6 +74,10 @@ Required. The base path for the assets.
 
 Optional. The secret token for uploading sourcemaps. This field is required if the APM server needs it.
 
+#### logLevel?: 'info' | 'warn' | 'error' | 'trace' | 'debug' | 'silent'
+
+Optional. Default to `'warn'`. Level of the messages that `ElasticAPMSourceMapPlugin` will log.
+
 ## License
 
 [MIT](/LICENSE.md)

package.json

@@ -132,7 +132,8 @@
     "shelljs": "^0.8.3",
     "typedoc": "^0.14.2",
     "typescript": "^3.0.3",
-    "webpack": "^4.29.5"
+    "webpack": "^4.29.5",
+    "webpack-log": "^2.0.0"
   },
   "peerDependencies": {
     "webpack": "^4.0.0"

src/elastic-apm-sourcemap-webpack-plugin.ts

@@ -2,13 +2,15 @@ import * as R from 'ramda';
 import fetch from 'node-fetch';
 import FormData from 'form-data';
 import webpack from 'webpack';
+import webpackLog, { Level } from 'webpack-log';
 
 export interface Config {
   serviceName: string;
   serviceVersion: string;
   publicPath: string;
   serverURL: string;
   secret?: string;
+  logLevel?: Level;
 }
 
 export default class ElasticAPMSourceMapPlugin implements webpack.Plugin {
@@ -18,11 +20,24 @@ export default class ElasticAPMSourceMapPlugin implements webpack.Plugin {
   }
 
   apply(compiler: webpack.Compiler): void {
+    const logger = webpackLog({
+      name: 'ElasticAPMSourceMapPlugin',
+      level: this.config.logLevel || 'warn'
+    });
+
     compiler.hooks.afterEmit.tapPromise('ElasticAPMSourceMapPlugin', compilation => {
+      logger.debug(`starting uploading sourcemaps with configs: ${JSON.stringify(this.config)}.`);
+
       const { chunks } = compilation.getStats().toJson();
 
       return R.compose(
-        (promises: Array<Promise<void>>) => Promise.all(promises),
+        (promises: Array<Promise<void>>) =>
+          Promise.all(promises)
+            .then(() => logger.debug('finished uploading sourcemaps.'))
+            .catch(err => {
+              logger.error(err);
+              throw err;
+            }),
         R.map(({ sourceFile, sourceMap }) => {
           const formData = new FormData();
           formData.append('sourcemap', compilation.assets[sourceMap].source());
@@ -42,11 +57,13 @@ export default class ElasticAPMSourceMapPlugin implements webpack.Plugin {
             .then(response => {
               if (response.ok) return response.json();
               else {
-                throw new Error(`Error while uploading ${sourceMap} to Elastic APM`);
+                const errMessage = `Error while uploading ${sourceMap} to Elastic APM`;
+                logger.error(errMessage);
+                throw new Error(errMessage);
               }
             })
             .then(() => {
-              console.info(`Uploaded ${sourceMap} to Elastic APM`); // eslint-disable-line no-console
+              logger.debug(`uploaded ${sourceMap} to Elastic APM.`);
             });
         }),
         R.map(({ files }) => {

src/types/webpack-log.d.ts

@@ -0,0 +1,19 @@
+declare module 'webpack-log' {
+  export interface Logger {
+    info: (value?: any) => void;
+    warn: (value?: any) => void;
+    error: (value?: any) => void;
+    trace: (value?: any) => void;
+    debug: (value?: any) => void;
+    silent: (value?: any) => void;
+  }
+
+  export type Level = 'info' | 'warn' | 'error' | 'trace' | 'debug' | 'silent';
+
+  export default function(options: {
+    name: string;
+    level?: Level;
+    unique?: boolean;
+    timestamp?: boolean;
+  }): Logger;
+}

test/integration.test.ts

@@ -55,7 +55,8 @@ test('failed', cb => {
       serviceName: 'mock-service',
       serviceVersion: 'mock-version',
       publicPath: '/mock-folder',
-      serverURL: 'mock-url'
+      serverURL: 'mock-url',
+      logLevel: 'silent'
     }),
     err => {
       expect(fetch.mock.calls.length).toEqual(1);
@@ -75,7 +76,8 @@ test('400', cb => {
       serviceName: 'mock-service',
       serviceVersion: 'mock-version',
       publicPath: '/mock-folder',
-      serverURL: 'mock-url'
+      serverURL: 'mock-url',
+      logLevel: 'silent'
     }),
     err => {
       expect(fetch.mock.calls.length).toEqual(1);
@@ -96,7 +98,8 @@ test('with secret', cb => {
       serviceVersion: 'mock-version',
       publicPath: '/mock-folder',
       serverURL: 'mock-url',
-      secret: 'mock-secret'
+      secret: 'mock-secret',
+      logLevel: 'silent'
     }),
     () => {
       expect(fetch.mock.calls[0][1].headers).toEqual({ Authorization: 'Bearer mock-secret' });

yarn.lock

@@ -1376,6 +1376,11 @@ ansi-align@^2.0.0:
   dependencies:
     string-width "^2.0.0"
 
+ansi-colors@^3.0.0:
+  version "3.2.3"
+  resolved "https://registry.yarnpkg.com/ansi-colors/-/ansi-colors-3.2.3.tgz#57d35b8686e851e2cc04c403f1c00203976a1813"
+  integrity sha512-LEHHyuhlPY3TmuUYMh2oz89lTShfvgbmzaBcxve9t/9Wuy7Dwf4yoAKcND7KFT1HAQfqZ12qtc+DUrBMeKF9nw==
+
 ansi-escapes@^3.0.0, ansi-escapes@^3.1.0, ansi-escapes@^3.2.0:
   version "3.2.0"
   resolved "https://registry.yarnpkg.com/ansi-escapes/-/ansi-escapes-3.2.0.tgz#8780b98ff9dbf5638152d1f1fe5c1d7b4442976b"
@@ -9305,6 +9310,14 @@ webidl-conversions@^4.0.2:
   resolved "https://registry.yarnpkg.com/webidl-conversions/-/webidl-conversions-4.0.2.tgz#a855980b1f0b6b359ba1d5d9fb39ae941faa63ad"
   integrity sha512-YQ+BmxuTgd6UXZW3+ICGfyqRyHXVlD5GtQr5+qjiNW7bF0cqrzX500HVXPBOvgXb5YnzDd+h0zqyv61KUD7+Sg==
 
+webpack-log@^2.0.0:
+  version "2.0.0"
+  resolved "https://registry.yarnpkg.com/webpack-log/-/webpack-log-2.0.0.tgz#5b7928e0637593f119d32f6227c1e0ac31e1b47f"
+  integrity sha512-cX8G2vR/85UYG59FgkoMamwHUIkSSlV3bBMRsbxVXVUk2j6NleCKjQ/WE9eYg9WY4w25O9w8wKP4rzNZFmUcUg==
+  dependencies:
+    ansi-colors "^3.0.0"
+    uuid "^3.3.2"
+
 webpack-sources@^1.1.0, webpack-sources@^1.3.0:
   version "1.3.0"
   resolved "https://registry.yarnpkg.com/webpack-sources/-/webpack-sources-1.3.0.tgz#2a28dcb9f1f45fe960d8f1493252b5ee6530fa85"