spectator_sport 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 04ef1fe5b218478993467e2b24f8279ce6385978ae57800ecc27dd8a98afa9af
-  data.tar.gz: b3730a2d748d434c36264ae7018a3c40a217c16dca9ba12c2956143f01a535f7
+  metadata.gz: ce7e9837080e5b1f96455b0f135fda0aff65832e57ef01c9cc42763be9579a46
+  data.tar.gz: be3679d719d26e852867510b223983e763de348c5c3c44bb58592e4960ae7fd2
 SHA512:
-  metadata.gz: bdd63ac25ccfcf26e8e237ae925793ce186a3b1c13882fdb07f598d53f677661dca139e4f4085529b4214ea34547d812e0a80b531415c43c76d48752aad02cfb
-  data.tar.gz: b02788e838fc6d7d5190bfa0e47f70a02d78c919bf80f3166d7a332187f8e487a039380d3ebce8a07dd0fcccf5ff6eb0d31f0d6d7b6b4ffae9d78be4bb7fed88
+  metadata.gz: 3c076b0fd70e3667bf2d8b19f939995589332ee853d63dd30d0281248416df8788f627b7d5ca15bd534bdaf63d4fca377befe8a58941c69769c3d38dbd1b42d3
+  data.tar.gz: e8e8901c34d153bbe77a4718bc9da962d89d91e52d6f618be9d524a1bb045f2f907245a9b89888c5d4f9b7602268cf58089666aa2cbe0bb3db5b7f2d72e17de0

data/README.md

@@ -69,6 +69,18 @@ This renders a hidden `<meta>` element signed by the server. The recording clien
 
 **Note:** this requires the `spectator_sport_session_window_tags` migration to be applied (`bin/rails spectator_sport:install:migrations && bin/rails db:migrate`). If the migration hasn't been run, the feature is silently disabled.
 
+## Stopping recording
+
+You can pause recording for a page by calling `spectator_sport_stop_recording` in any template:
+
+```erb
+<%= spectator_sport_stop_recording %>
+```
+
+This renders a hidden `<meta>` element that the recording client detects on page load. When present, rrweb recording is stopped and no events are buffered or sent. Recording automatically resumes when the user navigates to a page that does not have this tag.
+
+This is useful when navigating via Turbo to pages that shouldn't be recorded — without this tag the recorder would continue running across navigations.
+
 ## Dashboard authorization
 
 It is advisable to manually install and set up authorization for the **Player Dashboard** and refrain from making it public. 
@@ -153,6 +165,21 @@ open http://localhost:3000
 # 6. Make changes, see the result, commit and make a PR!
 ```
 
+## Releasing a new version
+
+1. Update the version in `lib/spectator_sport/version.rb`
+2. Run `bundle install` to update `Gemfile.lock`
+3. Commit the version bump and updated `Gemfile.lock`:
+    ```bash
+    git add lib/spectator_sport/version.rb Gemfile.lock
+    git commit -m "Bump version to x.y.z"
+    ```
+3. Build and publish to RubyGems, tag, and push to GitHub:
+    ```bash
+    bundle exec rake release
+    ```
+4. Create a GitHub Release at https://github.com/bensheldon/spectator_sport/releases using the new `vx.y.z` tag.
+
 ## License
 
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/app/helpers/spectator_sport/script_helper.rb

@@ -8,5 +8,9 @@ module SpectatorSport
       signed = Rails.application.message_verifier(:spectator_sport_tag_recording).generate(tag_value)
       tag.meta(name: "spectator-sport-recording-tag", content: signed)
     end
+
+    def spectator_sport_stop_recording
+      tag.meta(name: "spectator-sport-stop")
+    end
   end
 end

data/app/views/spectator_sport/events/index.js

@@ -29,6 +29,8 @@ function log(...args) {
 const POST_URL = new URL("./events", document.currentScript.src).href;
 const POST_INTERVAL_SECONDS = 15;
 const KEEPALIVE_BYTE_LIMIT = 60000; // Fetch payloads >64kb cannot use keepalive: true
+const RECORDING_TAG_SELECTOR = 'meta[name="spectator-sport-recording-tag"]';
+const STOP_SELECTOR = 'meta[name="spectator-sport-stop"]';
 
 class Recorder {
   constructor() {
@@ -173,7 +175,7 @@ class TagWatcher {
   }
 
   start() {
-    document.querySelectorAll('meta[name="spectator-sport-recording-tag"]').forEach(el => {
+    document.querySelectorAll(RECORDING_TAG_SELECTOR).forEach(el => {
       this.enqueue(el.content);
     });
 
@@ -181,10 +183,10 @@ class TagWatcher {
       for (const mutation of mutations) {
         for (const node of mutation.addedNodes) {
           if (node.nodeType !== Node.ELEMENT_NODE) continue;
-          if (node.matches('meta[name="spectator-sport-recording-tag"]')) {
+          if (node.matches(RECORDING_TAG_SELECTOR)) {
             this.enqueue(node.content);
           }
-          node.querySelectorAll('meta[name="spectator-sport-recording-tag"]').forEach(el => {
+          node.querySelectorAll(RECORDING_TAG_SELECTOR).forEach(el => {
             this.enqueue(el.content);
           });
         }
@@ -222,15 +224,62 @@ class TagWatcher {
   }
 }
 
+class StopWatcher {
+  constructor(recorder) {
+    this.recorder = recorder;
+    this.observer = null;
+  }
+
+  start() {
+    this.observer = new MutationObserver((mutations) => {
+      let changed = false;
+      for (const mutation of mutations) {
+        for (const node of [...mutation.addedNodes, ...mutation.removedNodes]) {
+          if (node.nodeType !== Node.ELEMENT_NODE) continue;
+          if (node.matches(STOP_SELECTOR) ||
+              node.querySelector(STOP_SELECTOR)) {
+            changed = true;
+          }
+        }
+      }
+      if (changed) {
+        this.update();
+      }
+    });
+    this.observer.observe(document.documentElement, { childList: true, subtree: true });
+  }
+
+  update() {
+    if (document.querySelector(STOP_SELECTOR)) {
+      this.recorder.stop();
+    } else {
+      this.recorder.start();
+    }
+  }
+}
+
+function isStopped() {
+  return !!document.querySelector(STOP_SELECTOR);
+}
+
 const recorder = new Recorder();
-recorder.start();
+if (!isStopped()) {
+  recorder.start();
+}
 
 const tagWatcher = new TagWatcher(recorder.sessionId, recorder.windowId);
 tagWatcher.start();
 
+const stopWatcher = new StopWatcher(recorder);
+stopWatcher.start();
+
 window.addEventListener("pageshow", function(_event) {
   log("pageshow");
-  recorder.start();
+  if (isStopped()) {
+    recorder.stop();
+  } else {
+    recorder.start();
+  }
 });
 
 window.addEventListener("pagehide", function(_event) {
@@ -241,7 +290,9 @@ window.addEventListener("pagehide", function(_event) {
 document.addEventListener("visibilitychange", function(_event) {
   log("visibilitychange", document.visibilityState);
   if (document.visibilityState === "visible") {
-    recorder.unpause();
+    if (!isStopped()) {
+      recorder.unpause();
+    }
   } else if (document.visibilityState === "hidden") {
     recorder.pause();
   }

data/lib/spectator_sport/version.rb

@@ -1,3 +1,3 @@
 module SpectatorSport
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: spectator_sport
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Ben Sheldon