Pawel/signed url (#10)

Author: pawelsz-rb

README.md

@@ -31,6 +31,8 @@ Options:
   --url-prefix    Base part of the stack trace URLs          [string] [required]
   --code-version  Code version string must match value in the Rollbar item
                                                              [string] [required]
+  --next          Next version. Zip all the source map files and upload as one
+                  file                                                 [boolean]
   -D, --dry-run   Scan and validate source maps without uploading      [boolean]
 ```
 
@@ -52,10 +54,17 @@ and it must exactly match the URLs in the error stack frames. See `minified_url`
 error payload, which is usually set in the config options for Rollbar.js.
 See [Source Maps](https://docs.rollbar.com/docs/source-maps) for more information.
 
+`--next`: This is an optional parameter triggering next version. When specified, all source map files 
+are compressed and uploaded as one zip file directly.
+
 Example:
 ```
 rollbar-cli upload-sourcemaps ./dist --access-token 638d... --url-prefix 'http://example.com/' --code-version 123.456
 ```
+or
+```
+rollbar-cli upload-sourcemaps ./dist --access-token 638d... --url-prefix 'http://example.com/' --code-version 123.456 --signed-url
+```
 
 ### notify-deploy
 Notify deploy to Rollbar.

package.json

@@ -6,10 +6,11 @@
     "rollbar-cli": "bin/rollbar"
   },
   "scripts": {
-    "lint": "./node_modules/.bin/eslint . --ext .js",
+    "lint": "eslint . --ext .js",
     "test": "nyc --reporter=html --reporter=text mocha './test/{,!(fixtures)/**/}*test.js'"
   },
   "dependencies": {
+    "adm-zip": "^0.5.2",
     "axios": "^0.19.2",
     "chalk": "^4.1.0",
     "form-data": "^3.0.0",
@@ -23,5 +24,20 @@
     "mocha": "^7.2.0",
     "nyc": "^15.1.0",
     "sinon": "^9.0.3"
-  }
+  },
+  "description": "![build](https://github.com/rollbar/rollbar-cli/workflows/Node.js%20CI/badge.svg)",
+  "main": "index.js",
+  "directories": {
+    "test": "test"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/rollbar/rollbar-cli.git"
+  },
+  "keywords": [],
+  "author": "",
+  "bugs": {
+    "url": "https://github.com/rollbar/rollbar-cli/issues"
+  },
+  "homepage": "https://github.com/rollbar/rollbar-cli#readme"
 }

src/common/rollbar-api.js

@@ -36,6 +36,14 @@ class RollbarAPI {
     return this.processResponse(resp);
   }
 
+  async sigendURLsourcemaps(request) {
+
+    const resp = await this.axios.post(
+      '/signed_url/sourcemap_bundle',  { version: request.version , prefix_url: request.baseUrl}
+    );
+    return this.processSignedURLResponse(resp);
+  }
+
   async sourcemaps(request) {
     output.verbose('', 'minified_url: ' + request.minified_url);
 
@@ -70,6 +78,11 @@ class RollbarAPI {
     return form;
   }
 
+  processSignedURLResponse(resp) {
+    output.verbose('', 'response:', resp.data, resp.status, resp.statusText);
+    return resp.data;
+  }
+
   processResponse(resp) {
     output.verbose('', 'response:', resp.data, resp.status, resp.statusText);
     if (resp.status === 200) {

src/sourcemaps/command.js

@@ -2,6 +2,8 @@
 
 const Scanner = require('./scanner');
 const Uploader = require('./uploader');
+const SignedUrlUploader = require('./signed-url-uploader');
+const Requester = require('./requester');
 const Output = require('../common/output.js');
 
 exports.command = 'upload-sourcemaps <path> [options]'
@@ -28,6 +30,12 @@ exports.builder = function (yargs) {
     type: 'string',
     demandOption: true
   })
+  .option('next', {
+    describe: 'Next version. Zip all the source map files and upload as one file',
+    requiresArg: false,
+    type: 'boolean',
+    demandOption: false
+  })
   .option('D', {
     alias: 'dry-run',
     describe: 'Scan and validate source maps without uploading',
@@ -50,13 +58,30 @@ exports.handler = async function (argv) {
 
   await scanner.scan();
 
-  const uploader = new Uploader({
-    accessToken: argv['access-token'],
-    baseUrl: argv['url-prefix'],
-    codeVersion: argv['code-version']
-  })
+  if (argv['next']) {
+    const requester = new Requester({
+      accessToken: argv['access-token'],
+      baseUrl: argv['url-prefix'],
+      codeVersion: argv['code-version'],
+      dryRun: argv['dry-run']
+    });
+
+    await requester.requestSignedUrl();
+    const signedUrlUploader = new SignedUrlUploader(requester);
+    if (requester.data && requester.data['err'] === 0) {
+      requester.setProjectID();
+      requester.createManifestData();
+      await signedUrlUploader.upload(argv['dry-run'], scanner.files, requester.data['result']['signed_url']);
+    }
+  } else {
+    const uploader = new Uploader({
+      accessToken: argv['access-token'],
+      baseUrl: argv['url-prefix'],
+      codeVersion: argv['code-version']
+    });
 
-  uploader.mapFiles(scanner.files);
+    uploader.mapFiles(scanner.files);
 
-  await uploader.upload(argv['dry-run']);
+    await uploader.upload(argv['dry-run']);
+  }
 }

src/sourcemaps/requester.js

@@ -0,0 +1,62 @@
+'use strict';
+
+const RollbarAPI = require('../common/rollbar-api');
+
+class Requester {
+  constructor(options) {
+    this.data = null;
+    this.rollbarAPI = new RollbarAPI(options.accessToken);
+    this.baseUrl = options.baseUrl;
+    this.version = options.codeVersion;
+    this.projectID = 0;
+    this.dryRun = options.dryRun;
+    this.manifestData = '';
+  }
+
+  async requestSignedUrl() {
+    if (this.dryRun) {
+      // TODO: Maybe more can be done here, but the important part is just to
+      // return without sending. The bulk of validation is done earlier
+      // in the scanning phase.
+      return this;
+    }
+
+    try {
+      const data = await this.rollbarAPI.sigendURLsourcemaps(this.buildRequest());
+
+      this.data = data;
+      if (data && data['err'] === 0) {
+        output.success('', 'Requested for signed URL successfully');
+      } else {
+        output.error('Error', data.message);
+      }
+
+    } catch (e) {
+      output.error('Error', e.message);
+    }
+  }
+
+  buildRequest() {
+    return {
+      version: this.version,
+      baseUrl: this.baseUrl,
+    };
+  }
+
+  setProjectID() {
+    this.projectID = this.data['result']['project_id'];
+  }
+
+  createManifestData() {
+    const data = {
+      projectID: this.projectID,
+      version: this.version,
+      baseUrl: this.baseUrl,
+    };
+
+    const strData = JSON.stringify(data, null, 2);
+    this.manifestData = strData;
+  }
+}
+
+module.exports = Requester;

src/sourcemaps/scanner.js

@@ -43,6 +43,8 @@ class Scanner {
       output.status('', mapPath);
       file.mapPathName = mapPath;
       file.sourceMappingURL = true;
+      file.mappedFile = path.join(this.targetPath, mapPath);
+
     } else {
       output.warn('', 'map not found');
     }

src/sourcemaps/signed-url-uploader.js

@@ -0,0 +1,79 @@
+'use strict';
+
+const AdmZip = require('adm-zip');
+const axios = require('axios');
+const zipFile = new AdmZip();
+
+class SignedUrlUploader {
+  constructor(requester) {
+     this.zippedMapFile = '';
+     this.files = [];
+     this.requester = requester;
+     this.zipBuffer = Buffer;
+
+  }
+
+  mapFiles(files) {
+    this.files = files;
+
+    return this;
+  }
+
+  zipFiles() {
+
+    try {
+      zipFile.addFile('manifest.json', this.requester.manifestData);
+    } catch (e) {
+      output.status('Error', e.message);
+    }
+      for (const file of this.files) {
+        try {
+          if (file.validated) {
+            zipFile.addLocalFile(file.mappedFile);
+          }
+        } catch(e) {
+          output.status('Error', e.message);
+        }
+      }
+      try {
+        this.zipBuffer = zipFile.toBuffer();
+        if (this.zipBuffer.length != 0) {
+          output.success('', 'Zipped all the source map files successfully');
+        } else {
+          output.error('', 'Zip was unsuccessful');
+        }
+      } catch(e) {
+        output.status('Error', e.message);
+      }
+  }
+
+  async upload(dryRun, files, signedUrl) {
+    if (dryRun) {
+      // TODO: Maybe more can be done here, but the important part is just to
+      // return without sending. The bulk of validation is done earlier
+      // in the scanning phase.
+      return this.files;
+    }
+
+    try {
+      this.mapFiles(files);
+      this.zipFiles();
+
+      const resp = await axios.put(signedUrl, this.zipBuffer, {
+        headers: {
+          'Content-Type': 'application/octet-stream',
+        },
+      });
+      if (resp.status === 200) {
+        output.status('Success', 'Uploaded zip file successfully');
+      } else {
+        output.status('Error', 'Could not upload the zip file');
+      }
+
+    } catch (e) {
+      output.status('Error', e.message);
+    }
+  }
+}
+
+module.exports = SignedUrlUploader;

test/common/rollbar-api.test.js

@@ -35,6 +35,41 @@ describe('.sourcemaps()', function() {
     this.currentTest.stub.restore();
   });
 
+  it('should send well formed request for signed URL', async function() {
+    const rollbarAPI = this.test.rollbarAPI;
+    const stub = this.test.stub;
+
+    stub.resolves({
+      status: 200,
+      statusText: 'Success',
+      data: { err: 0, result: { uuid: 'd4c7acef55bf4c9ea95e4fe9428a8287'}}
+    });
+
+    const request = {
+      version: '123',
+      prefix_url: 'https://example.com/',
+      source_map: '{ \
+        "version" : 3, \
+        "file": "out.js", \
+        "sourceRoot": "", \
+        "sources": ["foo.js", "bar.js"], \
+        "sourcesContent": [null, null], \
+        "names": ["src", "maps", "are", "fun"], \
+        "mappings": "A,AAAB;;ABCDE;" \
+        }',
+      sources: []
+    };
+
+    const response = await rollbarAPI.sigendURLsourcemaps(request);
+
+    expect(response).to.be.not.null;
+    expect(stub.calledOnce).to.be.true;
+
+    const body = stub.getCall(0).args;
+    expect(body[0]).to.equal('/signed_url/sourcemap_bundle');
+    expect(body[1]).to.be.a('Object');
+  });
+
   it('should send well formed request', async function() {
     const rollbarAPI = this.test.rollbarAPI;
     const stub = this.test.stub;

test/sourcemaps.test.js

@@ -28,4 +28,18 @@ describe('rollbar-cli upload-sourcemaps', function() {
       expect(lines[i]).to.have.string('[Found ]');
     }
   });
+
+  it('uploads react project via signed URL', function() {
+    this.timeout(5000);
+
+    const stdout = execSync('./bin/rollbar upload-sourcemaps ./test/fixtures/builds/react16/build --access-token 1234 --url-prefix "http://localhost:3000/" --code-version react16 -D --signed-url');
+
+    const lines = stdout.toString().split('\n');
+
+    expect(lines.length).to.equal(14);
+
+    for(let i; i < lines.length; i+=2) {
+      expect(lines[i]).to.have.string('[Found ]');
+    }
+  });
 });