Merge pull request #36 from appsignal/usability-improvements

Usability improvements

.tool-versions

@@ -0,0 +1 @@
+nodejs 16.13.1

README.md

@@ -6,11 +6,18 @@ This repository contains a set of frontend apps to test with.
 
 ## Setup
 
-Make sure you have have a working local Node.js install.
-Install geckodriver and install the bundle:
+Make sure you have have a working local Node.js install. The
+Node.js version should match the one in the `.tool-versions` file.
+
+The `yarn` package manager should be globally installed:
+
+```
+npm i -g yarn
+```
+
+Install the dependencies with bundle:
 
 ```
-brew install geckodriver
 bundle install
 ```
 
@@ -54,7 +61,17 @@ Then navigate to http://localhost:5001 to trigger an error.
 
 ## Running tests
 
-Run `bundle exec rspec` to run an integration test on all test setups.
+To run the tests, you must have `geckodriver` installed:
+
+```
+brew install geckodriver
+```
+
+To run an integration test on all test setups:
+
+```
+bundle exec rspec
+```
 
 ## Adding a new app
 

Rakefile

@@ -13,7 +13,11 @@ namespace :app do
     # Check if we have all input
     @frontend_key = @keys["frontend_key"] or raise "No frontend key set in keys.yml"
     @push_key = @keys["push_key"] or raise "No push key set in keys.yml"
-    @revision = ENV["revision"] or raise "No revision set in env"
+    @revision = ENV["revision"]
+    if @revision.nil?
+      @revision = demo_revision
+      puts "No revision set in env; using demo revision #{@revision.inspect}"
+    end
     # Use uris from keys.yml, or the default production ones
     @uri = @keys["uri"] || "https://appsignal-endpoint.net/collect"
     @sourcemap_uri = @keys["sourcemaps_uri"] || "https://appsignal.com/api/sourcemaps"

frameworks/angular/14/angular.json

@@ -98,5 +98,8 @@
         }
       }
     }
+  },
+  "cli": {
+    "analytics": false
   }
 }

support/helpers.rb

@@ -57,6 +57,10 @@ def get_keys
   YAML.load_file("keys.yml")
 end
 
+def demo_revision
+  "0123456789abcdef".chars.sample(7).join + "-demo"
+end
+
 def render_erb(file, binding)
   ERB.new(File.read(file)).result(binding)
 end
@@ -73,7 +77,7 @@ def write_appsignal_config(app, frontend_key, revision, uri)
              end
   File.write(
     "frameworks/#{app}/src/#{filename}",
-    render_erb("support/templates/appsignal.js.erb", binding)
+    render_erb("support/templates/#{filename}.erb", binding)
   )
 end
 

support/templates/appsignal.js.erb

@@ -2,8 +2,12 @@
 
 import Appsignal from "@appsignal/javascript";
 
-export default new Appsignal({
+const appsignal = new Appsignal({
   key: "<%= @frontend_key %>",
   revision: "<%= @revision %>",
   uri: "<%= @uri %>"
 });
+
+export default appsignal;
+
+globalThis.appsignal = appsignal;

support/templates/appsignal.ts.erb

@@ -0,0 +1,17 @@
+// This file is autogenerated when running rake app:run
+
+import Appsignal from "@appsignal/javascript";
+
+const appsignal = new Appsignal({
+  key: "<%= @frontend_key %>",
+  revision: "<%= @revision %>",
+  uri: "<%= @uri %>"
+});
+
+export default appsignal;
+
+declare global {
+  var appsignal: Appsignal
+}
+
+globalThis.appsignal = appsignal;