ndr_browser_timings 0.4.4

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 854da1ea6f19263e30c9ed180150713d14297ad5a3cf55b57cf892b68568e5c2
+  data.tar.gz: 003323ba6b7cacaa9d88f19e81d1d1b32f41d7e74da2ed88ff2caa95a5907448
+SHA512:
+  metadata.gz: 334be5233bd4384d709d4bf23f1650b2876a9d56ef92b1f193c24f4811d62cd80247065b6c089d99a85c6106d763ca9cca0bd7d6cda7f71335434eb3dbdcd61e
+  data.tar.gz: 79d87b31dd0ced5daaf2e1025c0b28d03bcb5c584d6fbf09b1bbc6b14258d65696c8e67447d082458de553377f6fe18cda2bdc4c260f50e3c4cf6d61e241060e

data/CHANGELOG.md

@@ -0,0 +1,42 @@
+## [Unreleased]
+* no unreleased changes
+
+## 0.4.4 / 2026-09-29
+### Fixed
+* Support Ruby 3.4. Drop support for Rails 7.0, Ruby 3.1
+* Support Ruby 4.0, Rails 8.1. Drop support for Ruby 3.2
+
+## 0.4.3 / 2024-11-19
+### Added
+* Support Ruby 3.2. Drop support for Ruby 2.7, Rails 6.0
+* Support Ruby 3.3, Rails 7.1, 7.2 and 8.0. Drop support for Ruby 3.0, Rails 6.1
+
+## 0.4.2 / 2022-12-06
+### Fixed
+* Drop support for Ruby 2.6
+* Support Ruby 3.1, Rails 7.0
+* Replace Public Health England naming with NHS Digital
+
+## 0.4.1 / 2022-04-08
+### Added
+* Support Rails 6.1
+
+## 0.4.0 / 2020-07-23
+### Added
+* Support sampling, to reduce data volumes (#1)
+
+### Fixed
+* Fix typo on meta tag names: s/broser/browser/
+* Stop capturing incomplete timing data from AJAX requests (#2)
+
+## 0.3.0 / 2020-02-11
+### Changed
+* Adjust the `ndr_stats` metric name and tagging
+
+## 0.2.0 / 2020-01-31
+### Added
+* Add belt-n-braces error handling to client library
+
+## 0.1.0 / 2020-01-30
+### Added
+* Initial build

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at josh.pencheon@googlemail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020-2024 NHS England
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,78 @@
+# NdrBrowserTimings [![Build Status](https://github.com/NHSDigital/ndr_browser_timings/workflows/Test/badge.svg)](https://github.com/NHSDigital/ndr_browser_timings/actions?query=workflow%3Atest) [![Gem Version](https://badge.fury.io/rb/ndr_browser_timings.svg)](https://rubygems.org/gems/ndr_browser_timings)
+
+This Rails Engine adds JavaScript that allows for the collection of users' browser timing information.
+
+## Usage
+Once installed (see below), timing information will be submitted from browsers
+via AJAX, back to the mounted engine, and passed to any configured recorders.
+
+Recorders can be any callable object, and can be configured like so:
+
+```ruby
+NdrBrowserTimings.recorders << ->(timing) { MyService.notify(timing) }
+```
+
+This gem bundles some recorders:
+
+```ruby
+# Send info to the Rails log:
+require 'ndr_browser_timings/recorders/logger'
+NdrBrowserTimings.recorders << NdrBrowserTimings::Recorders::Logger.new
+
+# Send info to prometheus:
+require 'ndr_browser_timings/recorders/ndr_stats'
+NdrStats.configure(...)
+NdrBrowserTimings.recorders << NdrBrowserTimings::Recorders::NdrStats.new
+```
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'ndr_browser_timings'
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install ndr_browser_timings
+```
+
+Inject the client library into pages you want timings submitted from:
+
+```javascript
+//=require 'ndr_browser_timings/ndr_browser_timings'
+```
+
+and the `<meta>` tag to provide configuration to the client library:
+
+```ruby
+<%= ndr_browser_timings_meta_tag %>
+```
+
+By default, all requests will be instrumented. You can alternatively elect to only
+sample a fraction of requests, to reduce data collected:
+
+```ruby
+<%= ndr_browser_timings_meta_tag(sample_rate: 0.1) %>
+```
+
+This is an isolated engine, so you'll need to configure with an authentication check:
+
+```ruby
+# Allow all requests through (careful!):
+NdrBrowserTimings.check_current_user_authentication = ->(request) { true }
+```
+
+## License
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+Everyone interacting in the NdrBrowserTimings project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the `CODE_OF_CONDUCT.md`.
+
+## TODO:
+* javascript fallback

data/Rakefile

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'NdrBrowserTimings'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path('test/dummy/Rakefile', __dir__)
+load 'rails/tasks/engine.rake'
+
+load 'rails/tasks/statistics.rake'
+
+require 'bundler/gem_tasks'
+
+require 'rake/testtask'
+require 'ndr_dev_support/tasks'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+task default: :test

data/SECURITY.md

@@ -0,0 +1,35 @@
+# Security
+
+NHS England takes security and the protection of private data extremely seriously. If you believe you have found a vulnerability or other issue which has compromised or could compromise the security of any of our systems and/or private data managed by our systems, please do not hesitate to contact us using the methods outlined below.
+
+## Table of Contents
+
+- [Security](#security)
+  - [Table of Contents](#table-of-contents)
+  - [Reporting a vulnerability](#reporting-a-vulnerability)
+    - [Email](#email)
+    - [NCSC](#ncsc)
+  - [General Security Enquiries](#general-security-enquiries)
+
+## Reporting a vulnerability
+
+Please note, email is our preferred method of receiving reports.
+
+### Email
+
+If you wish to notify us of a vulnerability via email, please include detailed information on the nature of the vulnerability and any steps required to reproduce it.
+
+You can reach us at:
+
+- [Brian.Shand@nhs.net](mailto:Brian.Shand@nhs.net)
+- [cybersecurity@nhs.net](mailto:cybersecurity@nhs.net)
+
+### NCSC
+
+You can send your report to the National Cyber Security Centre, who will assess your report and pass it on to NHS England if necessary.
+
+You can report vulnerabilities here: [https://www.ncsc.gov.uk/information/vulnerability-reporting](https://www.ncsc.gov.uk/information/vulnerability-reporting)
+
+## General Security Enquiries
+
+If you have general enquiries regarding our cybersecurity, please reach out to us at [cybersecurity@nhs.net](mailto:cybersecurity@nhs.net)

data/app/assets/config/ndr_browser_timings_manifest.js

@@ -0,0 +1 @@
+//= link_directory ../stylesheets/ndr_browser_timings .css

data/app/assets/javascripts/ndr_browser_timings/ndr_browser_timings.js

@@ -0,0 +1,84 @@
+/* global XMLHttpRequest */
+
+(function () {
+  function NdrBrowserTimings () {
+    this.bindListeners = function () {
+      window.addEventListener('load', function () {
+        // Defer the timing collection in order to allow the onLoad event to finish first.
+        setTimeout(this.sendPerformanceTimingData, 0)
+
+        // Periodically, send timing for AJAX requests:
+        this.intervalId = setInterval(this.sendNewPerformanceResourceTimingData, 1000)
+      }.bind(this))
+    }
+
+    this.sendPerformanceTimingData = function () {
+      try {
+        if (this.shouldSample()) {
+          this.sendTimingData({
+            pathname: window.location.pathname,
+            performance_timing: window.performance.timing
+          })
+        }
+      } catch (_err) { }
+    }
+
+    this.sendNewPerformanceResourceTimingData = function () {
+      try {
+        var newEntries = window.performance.getEntriesByType('resource')
+          .filter(function (entry) { return entry.responseEnd }) // drop those still in progress
+          .filter(function (entry) { return !~this.recordedEntries.indexOf(JSON.stringify(entry)) }.bind(this))
+          .filter(function (entry) { return !~entry.name.indexOf(this.endpoint) }.bind(this))
+          .filter(function (entry) { return this.shouldSample() }.bind(this))
+
+        if (newEntries.length) {
+          this.sendTimingData({ resource_timings: newEntries })
+
+          // IE11 can't compare the timing objects directly; compare stringified versions instead...
+          newEntries = newEntries.map(function (entry) { return JSON.stringify(entry) })
+          this.recordedEntries = this.recordedEntries.concat(newEntries)
+        }
+      } catch (_err) {
+        this.abort()
+      }
+    }
+
+    this.sendTimingData = function (data) {
+      var request = new XMLHttpRequest()
+      var token = this.readMetaTag('csrf-token')
+
+      data.user_agent = navigator.userAgent
+
+      request.open('POST', this.endpoint)
+      if (token) request.setRequestHeader('X-CSRF-Token', token)
+      request.setRequestHeader('Content-Type', 'application/json;charset=UTF-8')
+      request.send(JSON.stringify(data))
+    }
+
+    this.readMetaTag = function (name) {
+      var metaTag = document.querySelector('meta[name="' + name + '"]')
+      return metaTag && metaTag.content
+    }
+
+    this.abort = function () {
+      if (this.intervalId) clearInterval(this.intervalId)
+    }
+
+    this.shouldSample = function () {
+      return this.sampleRate > Math.random()
+    }
+
+    // resource timings that have been sent:
+    this.recordedEntries = []
+
+    // Path to which data is sent:
+    this.endpoint = this.readMetaTag('ndr_browser_timings_endpoint')
+    // What percentage of requests should we record data for?
+    this.sampleRate = parseFloat(this.readMetaTag('ndr_browser_timings_sample_rate') || 1)
+
+    this.intervalId = null
+    if (this.endpoint) this.bindListeners()
+  }
+
+  NdrBrowserTimings()
+}).call(this)

data/app/assets/stylesheets/ndr_browser_timings/application.css

@@ -0,0 +1,15 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or any plugin's vendor/assets/stylesheets directory can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any other CSS/SCSS
+ * files in this directory. Styles in this file should be added after the last require_* statement.
+ * It is generally better to create a new file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

data/app/controllers/ndr_browser_timings/application_controller.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module NdrBrowserTimings
+  class ApplicationController < ActionController::Base
+    protect_from_forgery with: :exception
+
+    before_action :check_authentication
+
+    private
+
+    def check_authentication
+      return if NdrBrowserTimings.check_current_user_authentication.call(self)
+
+      head :unauthorized
+    end
+  end
+end

data/app/controllers/ndr_browser_timings/timings_controller.rb

@@ -0,0 +1,39 @@
+require_dependency 'ndr_browser_timings/application_controller'
+
+module NdrBrowserTimings
+  # controller for receiving timings sent from clients' browsers.
+  class TimingsController < ApplicationController
+    # POST "/"
+    def receive
+      if params.key?(:performance_timing)
+        source = source_route(params[:pathname])
+        timing = PerformanceTiming.new(source.merge(performance_timing))
+        NdrBrowserTimings.record(timing)
+      elsif params.key?(:resource_timings)
+        resource_timings.each do |data|
+          source = source_route(data.delete('name'))
+          timing = ResourceTiming.new(source.merge(data))
+          NdrBrowserTimings.record(timing)
+        end
+      end
+
+      head :no_content
+    end
+
+    private
+
+    def resource_timings
+      params.require(:resource_timings).map(&:permit!)
+    end
+
+    def performance_timing
+      params.require(:performance_timing).permit!
+    end
+
+    def source_route(path)
+      Rails.application.routes.recognize_path(path)
+    rescue ActionController::RoutingError
+      {}
+    end
+  end
+end

data/app/helpers/ndr_browser_timings/meta_tag_helper.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module NdrBrowserTimings
+  # This helper file is injected into the host application.
+  module MetaTagHelper
+    # Allow engine mount location to be made available to javascript
+    # included by the host application. The alternative would be to
+    # server pre-configured JS through the engine directly, rather than
+    # as an asset.
+    def ndr_browser_timings_meta_tag(sample_rate: 1)
+      tag('meta', name: 'ndr_browser_timings_endpoint', content: ndr_browser_timings.receive_path) +
+        tag('meta', name: 'ndr_browser_timings_sample_rate', content: sample_rate.to_f)
+    end
+  end
+end

data/app/helpers/ndr_browser_timings/timings_helper.rb

@@ -0,0 +1,4 @@
+module NdrBrowserTimings
+  module TimingsHelper
+  end
+end

data/app/jobs/ndr_browser_timings/application_job.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module NdrBrowserTimings
+  class ApplicationJob < ActiveJob::Base
+  end
+end

data/app/mailers/ndr_browser_timings/application_mailer.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module NdrBrowserTimings
+  class ApplicationMailer < ActionMailer::Base
+    default from: 'from@example.com'
+    layout 'mailer'
+  end
+end

data/app/models/ndr_browser_timings/application_record.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module NdrBrowserTimings
+  class ApplicationRecord < ActiveRecord::Base
+    self.abstract_class = true
+  end
+end

data/app/models/ndr_browser_timings/performance_timing.rb

@@ -0,0 +1,58 @@
+module NdrBrowserTimings
+  # Wraps window.performance.timing objects
+  class PerformanceTiming
+    include ActiveModel::Model
+
+    # As defined by https://www.w3.org/TR/navigation-timing/#sec-navigation-timing
+    TIMING_FIELDS = %w[
+      navigationStart unloadEventStart unloadEventEnd redirectStart redirectEnd fetchStart
+      domainLookupStart domainLookupEnd connectStart connectEnd secureConnectionStart
+      requestStart responseStart responseEnd domLoading domInteractive domContentLoadedEventStart
+      domContentLoadedEventEnd domComplete loadEventStart loadEventEnd
+    ].freeze
+
+    attr_accessor :controller, :action
+
+    TIMING_FIELDS.each do |field|
+      attr_accessor field.underscore
+      alias_attribute field, field.underscore if field != field.underscore
+    end
+
+    def tags
+      { controller: controller, action: action }
+    end
+
+    def recordable?
+      tags.values.all?(&:present?)
+    end
+
+    def timeline
+      @timeline ||= {
+        unload: diff(unload_event_end, unload_event_start),
+        redirect: diff(redirect_end, redirect_start),
+        dns: diff(domain_lookup_end, domain_lookup_start),
+        connect: diff(connect_end, connect_start),
+        request: diff(response_start, request_start),
+        response: diff(response_end, response_start),
+        dom_loading: diff(dom_loading, response_start),
+        dom_interactive: diff(dom_interactive, dom_loading),
+        dom_content_loaded_event: diff(dom_content_loaded_event_end, dom_content_loaded_event_start),
+        dom_complete: diff(dom_complete, dom_content_loaded_event_end),
+        load_event: diff(load_event_end, load_event_start)
+      }
+    end
+
+    private
+
+    # Some browsers will report funky extra values; drop them.
+    def sanitize_for_mass_assignment(attributes)
+      super.reject { |attr, _val| !respond_to?("#{attr}=") }
+    end
+
+    def diff(end_time, start_time)
+      return 0 unless start_time && end_time
+
+      (end_time.to_i - start_time.to_i).round
+    end
+  end
+end

data/app/models/ndr_browser_timings/resource_timing.rb

@@ -0,0 +1,17 @@
+module NdrBrowserTimings
+  # Wraps window.performance.getEntry() objects
+  #
+  # These are similar to, but not the same as, the data structure
+  # returned from the primary navigation.
+  class ResourceTiming < PerformanceTiming
+    # As defined by https://www.w3.org/TR/resource-timing-2/#sec-performanceresourcetiming
+    RESOURCE_FIELDS = %w[
+      initiatorType nextHopProtocol workerStart transferSize encodedBodySize decodedBodySize
+    ].freeze
+
+    RESOURCE_FIELDS.each do |field|
+      attr_accessor field.underscore
+      alias_attribute field, field.underscore if field != field.underscore
+    end
+  end
+end

data/app/views/layouts/ndr_browser_timings/application.html.erb

@@ -0,0 +1,15 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Ndr browser timings</title>
+  <%= csrf_meta_tags %>
+  <%= csp_meta_tag %>
+
+  <%= stylesheet_link_tag    "ndr_browser_timings/application", media: "all" %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/config/routes.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+NdrBrowserTimings::Engine.routes.draw do
+  post '/', to: 'timings#receive', as: 'receive'
+end

data/lib/ndr_browser_timings/engine.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module NdrBrowserTimings
+  class Engine < ::Rails::Engine
+    isolate_namespace NdrBrowserTimings
+
+    initializer 'ndr_browser_timings.inject_helpers' do |app|
+      app.config.to_prepare do
+        ::ApplicationHelper.include(MetaTagHelper)
+      end
+    end
+  end
+end

data/lib/ndr_browser_timings/recorders/logger.rb

@@ -0,0 +1,15 @@
+module NdrBrowserTimings
+  module Recorders
+    # Allows timing information to be recorded via the application log.
+    class Logger
+      def call(timing)
+        # Ensure consistent log format, even though Hash#to_s changed in ruby 3.4
+        format_hash = lambda do |hash|
+          format('{%<entries>s}',
+                 entries: hash.collect { |k, v| "#{k.inspect}=>#{v.inspect}" }.join(', '))
+        end
+        Rails.logger.info "NdrBrowserTimings #{format_hash.call(timing.tags)} #{format_hash.call(timing.timeline)}"
+      end
+    end
+  end
+end

data/lib/ndr_browser_timings/recorders/ndr_stats.rb

@@ -0,0 +1,28 @@
+begin
+  require 'ndr_stats'
+rescue LoadError => e
+  raise e, <<~MESSAGE
+    The NdrStats recorder requires the ndr_stats library to be loaded.
+    As an optional codepath it is not an explicit dependency of
+    ndr_browser_timings, so you must add it to your Gemfile separately.
+  MESSAGE
+end
+
+module NdrBrowserTimings
+  module Recorders
+    # Allows timing information to be recorded via ndr_stats.
+    class NdrStats
+      def initialize(raise_unless_configured: true)
+        raise 'ndr_stats is not configured!' if raise_unless_configured && !::NdrStats.configured?
+      end
+
+      def call(timing)
+        tags = timing.tags
+
+        timing.timeline.each do |key, duration|
+          ::NdrStats.timing(:browser_timing, duration, **tags, type: key)
+        end
+      end
+    end
+  end
+end

data/lib/ndr_browser_timings/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module NdrBrowserTimings
+  VERSION = '0.4.4'
+end

data/lib/ndr_browser_timings.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require 'ndr_browser_timings/engine'
+
+# NdrBrowserTimings is a Rails engine that allows clients' browsers
+# timing information to be sent back to the application and captured.
+module NdrBrowserTimings
+  # Callable object (called with controller context) that is used to check
+  # if the current user is authenticated with the host app.
+  mattr_accessor :check_current_user_authentication
+  self.check_current_user_authentication = nil # Must be configured by the host app
+
+  # Recorders are callable objects that receiving timings
+  mattr_accessor :recorders
+  self.recorders = []
+
+  class << self
+    def record(timing)
+      return unless timing.recordable?
+
+      recorders.each { |recorder| recorder.call(timing) }
+    end
+  end
+end

data/lib/tasks/ndr_browser_timings_tasks.rake

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+# desc "Explaining what the task does"
+# task :ndr_browser_timings do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,166 @@
+--- !ruby/object:Gem::Specification
+name: ndr_browser_timings
+version: !ruby/object:Gem::Version
+  version: 0.4.4
+platform: ruby
+authors:
+- NDR Development Team
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.1'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '8.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.1'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '8.2'
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: ndr_dev_support
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.0'
+- !ruby/object:Gem::Dependency
+  name: ndr_stats
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: puma
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sprockets-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- SECURITY.md
+- app/assets/config/ndr_browser_timings_manifest.js
+- app/assets/images/ndr_browser_timings/.keep
+- app/assets/javascripts/ndr_browser_timings/ndr_browser_timings.js
+- app/assets/stylesheets/ndr_browser_timings/application.css
+- app/controllers/ndr_browser_timings/application_controller.rb
+- app/controllers/ndr_browser_timings/timings_controller.rb
+- app/helpers/ndr_browser_timings/meta_tag_helper.rb
+- app/helpers/ndr_browser_timings/timings_helper.rb
+- app/jobs/ndr_browser_timings/application_job.rb
+- app/mailers/ndr_browser_timings/application_mailer.rb
+- app/models/ndr_browser_timings/application_record.rb
+- app/models/ndr_browser_timings/performance_timing.rb
+- app/models/ndr_browser_timings/resource_timing.rb
+- app/views/layouts/ndr_browser_timings/application.html.erb
+- config/routes.rb
+- lib/ndr_browser_timings.rb
+- lib/ndr_browser_timings/engine.rb
+- lib/ndr_browser_timings/recorders/logger.rb
+- lib/ndr_browser_timings/recorders/ndr_stats.rb
+- lib/ndr_browser_timings/version.rb
+- lib/tasks/ndr_browser_timings_tasks.rake
+licenses: []
+metadata: {}
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.3'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.9
+specification_version: 4
+summary: Capture request timing data from clients
+test_files: []