quilt_rails 1.9.1 → 1.9.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 875ee204d6daad074946aec06f288627aa5481dfe59f28769462083f99215a66
-  data.tar.gz: 4335d6f6a9ef4dd9a3ad457b96dd3fbf67cfa0a69a8ca30e78d65926a23d24c5
+  metadata.gz: 19ed91c686fab67ad1642a071a8d62214c154c246cf4d8cb4027ac3a50483620
+  data.tar.gz: 73ad8104d3e54a5b3ba56aa912fa7147eaeab671f75e310c5dd1dcb6d297471b
 SHA512:
-  metadata.gz: f3f2d9043a75979e5c7f45fc25f1e159930610b7d158256ab144dd5ac3f5decd5f0a15cbe7d054fc844a54f97eb572974f1464c3f121f8c56ac5819e2a288983
-  data.tar.gz: aa91a0d734eed1e1c74ccd3a299edbe8a70cbab01af24fcde5818d0fc7d86942014bb22eaf7d13b329a17daff88ce83cdd156a9b3ab299dc4148b26bb90fbe35
+  metadata.gz: 10618fcc4252375f45e54b98ed366c47fa06de9541b57e748081dab0ba66d0817f78e38c4d3a8e23315f2402c79d4dde5c86c85132e3b7e97534a0165166fee0
+  data.tar.gz: 838be176ef13ae501f40c2eb6763a7d0416d42ce6908650dd03ecfdcc6039dc35d7769518b60f977dda0d3fa81cffc10a7e6656beeda9e510c74e4c5587d0321

data/README.md

@@ -420,9 +420,9 @@ class PerformanceReportController < ActionController::Base
   def create
     process_report
 
-    render json: { result: 'success' }, status: 200
+    render(json: { result: 'success' }, status: 200)
   rescue ActionController::ParameterMissing => error
-    render json: { error: error.message, status: 422 }
+    render(json: { error: error.message }, status: 422)
   end
 end
 ```
@@ -439,20 +439,17 @@ post '/performance_report', to: 'performance_report#create'
 
 ### Add annotations
 
-Add a [`<PerformanceMark />`](https://github.com/Shopify/quilt/tree/master/packages/react-performance#performancemark) to each of your route-level components.
+Add a [`usePerformanceMark`](https://github.com/Shopify/quilt/tree/master/packages/react-performance#useperformancemark) call to each of your route-level components.
 
 ```tsx
 // app/ui/features/Home/Home.tsx
-import {PerformanceMark} from '@shopify/react-performance';
+import {usePerformanceMark} from '@shopify/react-performance';
 
 export function Home() {
-  return (
-    <div>
-      My Cool Home Page
-      {/* tell the library the page has finished rendering completely */}
-      <PerformanceMark stage="complete" id="Home" />
-    </div>
-  );
+  // tell the library the page has finished rendering completely
+  usePerformanceMark('complete', 'Home');
+
+  return <>{/* your Home page JSX goes here*/}</>;
 }
 ```
 
@@ -592,15 +589,42 @@ The params sent to the controller are expected to be of type `application/json`.
 }
 ```
 
-the above controller would send the following metrics:
+given the the above controller input, the library would send the following metrics:
 
 ```ruby
-StatsD.distribution('time_to_first_byte', 2, ['browser_connection_type:3g'])
-StatsD.distribution('time_to_first_byte', 2, ['browser_connection_type:3g'])
-StatsD.distribution('navigation_complete', 23924, ['browser_connection_type:3g'])
-StatsD.distribution('navigation_usable', 23924, ['browser_connection_type:3g'])
+StatsD.distribution('time_to_first_byte', 2, tags: {
+  browser_connection_type:'3g',
+})
+StatsD.distribution('time_to_first_byte', 2, tags: {
+  browser_connection_type:'3g' ,
+})
+StatsD.distribution('navigation_complete', 23924, tags: {
+  browser_connection_type:'3g' ,
+})
+StatsD.distribution('navigation_usable', 23924, tags: {
+  browser_connection_type:'3g' ,
+})
 ```
 
+##### Default Metrics
+
+The full list of metrics sent by default are as follows:
+
+###### For full-page load
+
+- `AppName.time_to_first_byte`, representing the time from the start of the request to when the server began responding with data.
+- `AppName.time_to_first_paint`, representing the time from the start of the request to when the browser rendered anything to the screen.
+- `AppName.time_to_first_contentful_paint` representing the time from the start of the request to when the browser rendered meaningful content to the screen.
+- `AppName.dom_content_loaded` representing the time from the start of the request to when the browser fired the [DOMContentLoaded](https://developer.mozilla.org/en-US/docs/Web/API/Window/DOMContentLoaded_event) event.
+- `AppName.dom_load` representing the time from the start of the request to when the browser fired the [window.load](https://developer.mozilla.org/en-US/docs/Web/API/Window/load_event) event.
+
+###### For both full-page navigations and client-side page transitions
+
+- `AppName.navigation_usable`, representing the time it took before for the page to be rendered in a usable state. Usually this does not include data fetching or asynchronous tasks.
+- `AppName.navigation_complete` representing the time it took for the page to be fully loaded, including any data fetching which blocks above-the-fold content.
+- `AppName.navigation_download_size`, representing the total weight of all client-side assets (eg. CSS, JS, images). This will only be sent if there are any events with a `type` of `script` or `style`.
+- `AppName.navigation_cache_effectiveness`, representing what percentage of client-side assets (eg. CSS, JS, images) were returned from the browser's cache. This will only be sent if there are any events with a `type` of `script` or `style`.
+
 ##### Customizing `process_report` with a block
 
 The behaviour of `process_report` can be customized by manipulating the `Quilt::Performance::Client` instance yielded into its implicit block parameter.
@@ -639,6 +663,10 @@ client.on_navigation do |navigation, tags|
   tags[:connection_rtt] = navigation.connection.rtt
   tags[:connection_type] = navigation.connection.type
   tags[:navigation_target] = navigation.target
+
+  # add a tag to allow filtering out navigations that are too long
+  # this is useful when you are unable to rule out missing performance marks on some pages
+  tags[:too_long_dont_read] = navigation.duration > 30.seconds.in_milliseconds
 end
 ```
 

data/lib/quilt_rails/version.rb

@@ -1,4 +1,4 @@
 # frozen_string_literal: true
 module Quilt
-  VERSION = "1.9.1"
+  VERSION = "1.9.2"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: quilt_rails
 version: !ruby/object:Gem::Version
-  version: 1.9.1
+  version: 1.9.2
 platform: ruby
 authors:
 - Mathew Allen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-10-24 00:00:00.000000000 Z
+date: 2019-12-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties
@@ -42,16 +42,16 @@ dependencies:
   name: statsd-instrument
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 2.7.0
+        version: 2.8.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 2.7.0
+        version: 2.8.0
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement