squash_javascript 1.0.0

data/LICENSE.txt

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed 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.

data/README.md

@@ -0,0 +1,282 @@
+Squash Client Library: JavaScript
+=================================
+
+This client library reports front-end JavaScript exceptions to Squash, the
+Squarish exception reporting and management system.
+
+Documentation
+-------------
+
+For an overview of the various components of Squash, see the website
+documentation at https://github.com/SquareSquash/web.
+
+### JavaScript client
+
+Documentation is written in Codo format. HTML documentation can be generated by
+running `rake doc:js`. Note that Codo is still a work in progress, and the
+generated docs will have some formatting errors. The documentation is written to
+the `doc/js` directory.
+
+If you do not have Codo installed in your path, you can download a project-local
+install with `rake setup`.
+
+### Ruby library
+
+Markdown-formatted YARD documentation is available by running 'rake doc:ruby`.
+The documentation is written to the `doc/ruby` directory.
+
+Compatibility
+-------------
+
+The JavaScript library is compatible with any modern JavaScript engine,
+including any version of V8, Nitro, and Chakra.
+
+The Rails engine (allowing the library to be easily used in a Rails app) is
+compatible with Rails 3.1 and later.
+
+Requirements
+------------
+
+The JavaScript library uses TraceKit for cross-platform stack trace extraction.
+The library is included in this project. For Rails projects, a Sprockets include
+file is provided. For non-Rails projects, the output of `rake minify` rolls in
+the library.
+
+Unfortunately, TraceKit was causing unexpected behavior on Chrome and Firefox,
+and parts of it are commented out. (The jQuery hooks were disabled.)
+
+Installation
+-----
+
+### Rails
+
+For Rails applications, add the Squash client engine to your Gemfile with
+`gem 'squash_javascript', require: 'squash/javascript'`, and then include the
+JavaScript into your application.js file (or other JavaScript manifest):
+
+```` javascript
+//= require squash/javascript
+````
+
+### Other projects
+
+For other projects, you may need to compile the CoffeeScript file first. If you
+do not have the `coffee` binary installed in your path, you can download and
+install a copy of CoffeeScript by running `rake setup`. This task uses npm (the
+Node package manager) to perform the installation; you will need to install npm
+first if you haven't already.  CoffeeScript will be installed into a
+project-local directory.
+
+Once you have the `coffee` binary, you can run `rake minify` to generate a
+JavaScript file that you can use in your project. If you would like a
+non-minified JavaScript file without dependencies, run `rake compile`.
+
+Place the compiled `squash_javascript.min.js` file in a Web-public directory and
+include it using a `<script>` tag:
+
+```` html
+<script type="text/javascript" href="http://url.to.your/squash_javascript.min.js" />
+````
+
+The file defines a `SquashJavascript` singleton which is accessible using
+`SquashJavascript.instance()`.
+
+Usage
+-----
+
+Before you can use Squash, you must configure it (see **Configuration** below).
+At a minimum, you must specify
+
+* the host on which Squash is running,
+* your project's API key,
+* the environment, and
+* the SHA of the Git revision currently deployed.
+
+Use `SquashJavascript.instance().configure` to set up the Squash JavaScript client:
+
+```` javascript
+SquashJavascript.instance().configure({APIHost: 'YOUR_API_HOST',
+                                   APIKey: 'YOUR_API_KEY',
+                                   environment: 'production',
+                                   revision: '8718e4336990f9ea0198c2ff5668bbb673befd65'})
+````
+
+Squash will automatically install a listener that will trap exceptions, send
+them to the server, and re-throw them. Note that the client will only notify for
+instances of the `Error` class.
+
+There are many additional features you can take advantage of; see **Additional
+Features** below.
+
+### Additional Features
+
+There are a number of other features you can take advantage of to help you debug
+your exceptions:
+
+#### User Data
+
+Exceptions can be annotated with freeform user data. This data can take any
+format and have any meaning, typically being relevant to the exception at hand.
+
+There are multiple ways to add user data to an exception. The most
+straightforward way is to include the user data as the second argument to the
+`notify` method:
+
+```` javascript
+SquashJavascript.instance().notify(error, {event: e, arguments: arguments});
+````
+
+You can apply user data to a block of code using the
+`SquashJavascript.instance().addUserData` method:
+
+```` javascript
+$(window).resize(function(e) {
+  SquashJavascript.instance().addUserData({event: e}, function() {
+    // ... process event ...
+  });
+});
+````
+
+If that's too verbose, there's additionally a curry function, `addingUserData`,
+that takes a function, applies the `addUserData` behavior to it, and returns a
+new function:
+
+```` javascript
+$(window).resize(SquashJavascript.instance().addingUserData({event: e}, function(e) {
+  // ... process event ...
+});
+````
+
+And lastly, you can add user data directly to the exception:
+
+```` javascript
+function myFunction(value) {
+  if (value < 0) {
+    var err = new Error("value was less than 0");
+    err._squash_user_data = { value: value };
+    throw err;
+  }
+
+  // ... do the thing ...
+}
+````
+
+You can also add user data to exceptions you catch and re-throw:
+
+```` javascript
+try {
+  doSomethingWithInput(input);
+} catch (err) {
+  if (!err._squash_user_data) err._squash_user_data = new Object();
+  err._squash_user_data.input = input;
+  throw err; // assumed that SquashJavascript.instance().notify is called somewhere further up in the stack
+}
+````
+
+#### Ignoring Exceptions
+
+You can ignore certain error classes within a block of code if those exceptions
+are not worth sending to Squash. Use the
+`SquashJavascript.instance().ignore_exceptions` method:
+
+```` javascript
+SquashJavascript.instance().ignoreExceptions(EvalError, SyntaxError, function() {
+  // ... some code ...
+});
+````
+
+The curry-type syntax is also supported here:
+
+```` javascript
+$(window).resize(SquashJavascript.instance().ignoringExceptions(EvalError, SyntaxError, function(e) {
+  /// ... some code ...
+});
+````
+
+The exceptions _will_ be raised (not eaten) but will _not_ be reported to
+Squash.
+
+You can also globally ignore exceptions using the `ignored_exceptions`
+configuration; see **Configuration** below.
+
+Configuration
+-------------
+
+You can configure the client with the `SquashJavascript.instance().configure`
+method. Calling this method multiple times will merge new values in with the
+existing configuration. The method takes a hash, which accepts the following
+keys:
+
+### General
+
+* `disabled`: If `true`, the Squash client will not report any errors.
+* `APIKey`: The API key of the project that exceptions will be associated with.
+  This configuration option is required. The value can be found by going to the
+  project's home page on Squash.
+* `environment`: The environment that exceptions will be associated with. This
+  configuration option is required.
+* `revision`: The SHA1 of the current Git revision. This is the revision of the
+  code that is currently running. This configuration option is required.
+
+### Error Transmission
+
+* `APIHost`: The host on which Squash is running. Required.
+* `notifyPath`: The path to post new exception notifications to. By default
+  it's set to `/api/1.0/notify`.
+* `transmitTimeout`: The amount of time to wait before giving up on trasmitting
+  an error. By default this is treated as both an open and a read timeout.
+
+### Ignored Exceptions
+
+* `ignoredExceptionClasses`: An array of exception class names that will not
+  be reported to Squash.
+* `ignoredExceptionMessages`: A hash mapping an exception class name to an
+  array of regexes. Exceptions of that class whose messages match a regex in the
+  list will not be reported to Squash.
+
+Error Transmission
+------------------
+
+Exceptions are transmitted to Squash using JSON-over-XMLHttpRequest. A default
+API endpoint is pre-configured, though you can always set your own (see
+**Configuration** above).
+
+Failsafe Reporting
+------------------
+
+In the event that the Squash client itself raises an exception when processing
+an exception, it will log that exception to the console. Both the original
+exception and the failsafe error will be logged. The original exception will
+still be re-raised, but the failsafe error will be "eaten."
+
+Source Mapping
+--------------
+
+If you can generate a source map for your minified JavaScript files (Clojure
+can), you can use this gem to upload that source map to Squash, where it will
+be used to convert minified stack traces to their original format, which can
+then benefit from Git-blaming, context, and other features of Squash.
+
+To upload the source map to squash, run the `upload_source_map` binary included
+with this gem, and pass it four arguments: 1) your API key, 2) the environment
+name, 3) the path to the JSON source map, and 4) the URL where this file will be
+hosted. Example:
+
+````
+upload_source_map abc-123-abc-123-abc-123 production artifacts/mapping.json https://my.application/assets/minified.js
+````
+
+Specs
+-----
+
+### JavaScript client
+
+Jasmine unit and integration tests are implemented in the `spec/js` directory.
+To run these tests, run `rake spec:js` (Mac OS X required), or simply compile
+the CoffeeScript source and open the `SpecRunner.html` file in your favorite Web
+browser.
+
+### Ruby library
+
+RSpec unit tests are implemented in the `spec/ruby` directory. To run these
+tests, run `rake spec:ruby`.

data/bin/upload_source_map

@@ -0,0 +1,75 @@
+#!/usr/bin/env ruby
+
+# Copyright 2012 Square Inc.
+#
+#    Licensed 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.
+
+require 'optparse'
+require 'base64'
+require 'zlib'
+require 'yaml'
+
+require 'rubygems'
+require 'squash/uploader'
+require 'squash/javascript'
+
+def git_revision(dir)
+  head = File.read(File.join(dir, '.git', 'HEAD')).chomp
+  if head =~ /^ref: (.+)$/
+    File.read(File.join(dir, '.git', $1)).chomp
+  else
+    raise "Couldn't determine current revision from #{head.inspect}"
+  end
+end
+
+project_dir = Dir.getwd
+ignore_root = false
+revision    = nil
+options     = {}
+
+parser = OptionParser.new do |parser|
+  parser.banner = "Usage: upload_source_map [options] YOUR_SQUASH_HOST YOUR_API_KEY ENVIRONMENT /path/to/mapping.json https://url.for/minified/asset.js"
+  parser.on('-o', '--open-timeout N', Integer, "HTTP connection open timeout") { |ot| options[:open_timeout] = ot }
+  parser.on('-r', '--read-timeout N', Integer, "HTTP connection data received timeout") { |rt| options[:read_timeout] = rt }
+  parser.on('-k', '--[no-]skip-verification', "Do not perform SSL peer verification") { |sv| options[:skip_verification] = sv }
+
+  parser.on('-p', '--project-dir F', "Specify a custom project directory (default current directory)") { |pd| project_dir = pd }
+  parser.on('-i', '--[no]-ignore-root', "Ignore the sourceRoot field in the mapping file; always use --project-dir") { |ir| ignore_root = ir }
+
+  parser.on('-r', '--revision R', "Specify a code revision that was deployed (default current revision)") { |r| revision = r }
+
+  parser.on('-h', '--help', "Show this message") { puts parser; exit }
+  parser.on('--version', "Display version number of this program") { puts "1.0.0"; exit }
+end
+parser.parse!(ARGV)
+
+if ARGV.size != 5
+  puts parser
+  exit 1
+end
+
+host        = ARGV.shift
+api_key     = ARGV.shift
+environment = ARGV.shift
+map_file    = ARGV.shift
+route       = ARGV.shift
+revision    = revision || git_revision(project_dir)
+
+map = Squash::Javascript::SourceMap.from_sourcemap(map_file, route, root: ignore_root ? project_dir : nil)
+Squash::Uploader.new(host, options).transmit '/api/1.0/sourcemap.json',
+                                             {
+                                                 'api_key'     => api_key,
+                                                 'environment' => environment,
+                                                 'revision'    => revision,
+                                                 'sourcemap'   => Base64.encode64(Zlib::Deflate.deflate(map.to_yaml))
+                                             }

data/lib/squash/javascript/engine.rb

@@ -0,0 +1,20 @@
+# Copyright 2012 Square Inc.
+#
+#    Licensed 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.
+
+require 'rails/engine'
+
+# Rails engine for the JavaScript client library assets.
+
+class Squash::Javascript::Engine < Rails::Engine
+end