RubyGems - spectator_sport - Versions diffs - 0.2.0 → 0.4.0 - Mend

spectator_sport 0.2.0 → 0.4.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (38) hide show

checksums.yaml CHANGED Viewed

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 04ef1fe5b218478993467e2b24f8279ce6385978ae57800ecc27dd8a98afa9af
-  data.tar.gz: b3730a2d748d434c36264ae7018a3c40a217c16dca9ba12c2956143f01a535f7
+  metadata.gz: ae07042f4d65dd617066efe9e6ac3f90f6a8726dec741b9e3965c6d76eef1648
+  data.tar.gz: 7c2fc362efbea72b71dc61b99568577d554e47f5b4a63e77298af5e5879355c5
 SHA512:
-  metadata.gz: bdd63ac25ccfcf26e8e237ae925793ce186a3b1c13882fdb07f598d53f677661dca139e4f4085529b4214ea34547d812e0a80b531415c43c76d48752aad02cfb
-  data.tar.gz: b02788e838fc6d7d5190bfa0e47f70a02d78c919bf80f3166d7a332187f8e487a039380d3ebce8a07dd0fcccf5ff6eb0d31f0d6d7b6b4ffae9d78be4bb7fed88
+  metadata.gz: 35962025a9098a0d9fe0a1e113ee8c9036a4c24f6cd7f1fa7fddb00c8fc923eba9102f54fbfe56e2f4080704dacc27762d18e59845e6257ff4a4e3decbb18b97
+  data.tar.gz: 2eb708af1cf7e0e59ec60aa82b5940846869e36d91834b9a63e3d59b8d8b20f180fc030576deb34e3d4fb91fc9b81baca46e582a89acf45e28d5eadebe5bfcab

data/README.md CHANGED Viewed

@@ -38,7 +38,7 @@ To install Spectator Sport in your Rails application:
     bundle add spectator_sport
     ```
 2. Install Spectator Sport in your application. _🚧 This will change on the path to v1._ Explore the `/demo` app as live example:
-    - Create database migrations with `bin/rails g spectator_sport:install:migrations`. Apply migrations with `bin/rails db:prepare`
+    - Create database migrations with `bin/rails spectator_sport:install:migrations`. Apply migrations with `bin/rails db:prepare`
     - Mount the recorder API in your application's routes with `mount SpectatorSport::Engine, at: "/spectator_sport, as: :spectator_sport"`
     - Add the `spectator_sport_script_tags` helper to the bottom of the `<head>` of `layout/application.rb`. Example:
         ```erb
@@ -57,17 +57,37 @@ To install Spectator Sport in your Rails application:
         ```
   3. To view recordings, you will want to mount the Player Dashboard in your application and set up authorization to limit access. See the section on [Dashboard authorization](#dashboard-authorization) for instructions.
-## Tagging recordings
+## Labeling recordings
-You can associate a string tag (e.g. a user ID or account identifier) with the current recording by calling `spectator_sport_tag_recording` in any template:
+You can associate key-value labels with the current recording by calling `spectator_sport_label_recording` in any template:
 ```erb
-<%= spectator_sport_tag_recording(current_user.id.to_s) %>
+<%= spectator_sport_label_recording(current_user.id.to_s, key: "user_id", strategy: :one) %>
+<%= spectator_sport_label_recording("admin", key: "role", strategy: :many) %>
+<%= spectator_sport_label_recording("vip") %>
 ```
-This renders a hidden `<meta>` element signed by the server. The recording client detects it and immediately sends it to the API, where the signature is verified before the tag is stored. Tags are displayed in the dashboard and can be used to look up all recordings associated with a given value.
+The `key` argument is optional. When omitted, the label behaves like a tag. The `strategy` argument (default `:many`) controls how values are stored per recording:
-**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.
+- `strategy: :many` (default): multiple values for the same key are accumulated per recording.
+- `strategy: :one`: only one value per key is kept per recording. A later call with the same key replaces the stored value. Without a key, behaves like `:many`.
+- `strategy: :first`: only the first value for a key is stored; subsequent calls with the same key are ignored. Requires a key.
+This renders a hidden `<meta>` element signed by the server. The recording client detects it and immediately sends it to the API, where the signature is verified before the label is stored. Labels are displayed in the dashboard and can be used to look up all recordings associated with a given key-value pair.
+**Note:** this requires the `spectator_sport_labels` 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
@@ -153,6 +173,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/controllers/spectator_sport/dashboard/dashboards_controller.rb CHANGED Viewed

@@ -4,6 +4,7 @@ module SpectatorSport
       def index
         @session_windows = SessionWindow.order(:created_at).limit(50).reverse_order
         @session_windows = @session_windows.includes(:session_window_tags) if SpectatorSport::SessionWindowTag.migrated?
+        @session_windows = @session_windows.includes(:labels) if SpectatorSport::Label.migrated?
       end
     end
   end

data/app/controllers/spectator_sport/dashboard/recordings_controller.rb ADDED Viewed

@@ -0,0 +1,50 @@
+module SpectatorSport
+  module Dashboard
+    class RecordingsController < ApplicationController
+      def index
+        @search_query = SpectatorSport::SearchQuery.new(query: params[:query])
+        @recordings = Recording.order(:created_at).limit(50).reverse_order
+        @recordings = @recordings.includes(:labels) if SpectatorSport::Label.migrated?
+        if @search_query.query.present? && SpectatorSport::Label.migrated?
+          if @search_query.valid?
+            @recordings = @search_query.to_scope(base_scope: @recordings)
+          else
+            @recordings = @recordings.none
+          end
+        end
+      end
+      def show
+        @recording = Recording.find(params[:id])
+        @events = @recording.events.page_after(nil)
+        @labels = SpectatorSport::Label.migrated? ? @recording.labels.to_a : []
+      end
+      def stream_events
+        response.content_type = "text/vnd.turbo-stream.html"
+        return head(:ok) if params[:after_event_id].blank?
+        recording = Recording.find(params[:id])
+        previous_event = recording.events.find_by(id: params[:after_event_id])
+        @events = recording.events.page_after(previous_event)
+        render layout: false
+      end
+      def details
+        @recording = Recording.find(params[:id])
+      end
+      def destroy
+        @recording = Recording.find(params[:id])
+        @recording.events.delete_all
+        @recording.labels.delete_all if SpectatorSport::Label.migrated?
+        @recording.delete
+        redirect_to root_path
+      end
+    end
+  end
+end

data/app/controllers/spectator_sport/dashboard/session_windows_controller.rb CHANGED Viewed

@@ -1,10 +1,16 @@
 module SpectatorSport
   module Dashboard
     class SessionWindowsController < ApplicationController
+      def index
+        @session_windows = SessionWindow.order(:created_at).limit(50).reverse_order
+        @session_windows = @session_windows.includes(:session_window_tags) if SpectatorSport::SessionWindowTag.migrated?
+        @session_windows = @session_windows.includes(:labels) if SpectatorSport::Label.migrated?
+      end
       def show
         @session_window = SessionWindow.find(params[:id])
         @events = @session_window.events.page_after(nil)
-        @tags = SpectatorSport::SessionWindowTag.migrated? ? @session_window.session_window_tags.to_a : []
+        @labels = SpectatorSport::Label.migrated? ? @session_window.labels.to_a : []
       end
       def events
@@ -25,6 +31,8 @@ module SpectatorSport
       def destroy
         @session_window = SessionWindow.find(params[:id])
         @session_window.events.delete_all
+        @session_window.session_window_tags.delete_all if SpectatorSport::SessionWindowTag.migrated?
+        @session_window.labels.delete_all if SpectatorSport::Label.migrated?
         @session_window.delete
         redirect_to root_path

data/app/controllers/spectator_sport/dashboard/tags_controller.rb CHANGED Viewed

@@ -3,12 +3,15 @@ module SpectatorSport
     class TagsController < ApplicationController
       def show
         @tag = params[:name]
-        @session_windows = SpectatorSport::SessionWindowTag
-          .where(tag: @tag)
-          .includes(:session_window)
-          .order(created_at: :desc)
+        scope = SessionWindow
+          .joins(:session_window_tags)
+          .where(spectator_sport_session_window_tags: { tag: @tag })
+          .distinct
+          .order(updated_at: :desc)
           .limit(50)
-          .map(&:session_window)
+        scope = scope.includes(:session_window_tags) if SpectatorSport::SessionWindowTag.migrated?
+        scope = scope.includes(:labels) if SpectatorSport::Label.migrated?
+        @session_windows = scope
       end
     end
   end

data/app/controllers/spectator_sport/events_controller.rb CHANGED Viewed

@@ -6,19 +6,61 @@ module SpectatorSport
     end
     def create
-      data = if params.key?(:sessionId) && params.key?(:windowId) && params.key?(:events)
-        params.slice(:sessionId, :windowId, :events, :tags).stringify_keys
+      data = if params.key?(:events) && (params.key?(:recordingId) || params.key?(:windowId))
+        params.slice(:sessionId, :recordingId, :windowId, :events, :tags, :labels).stringify_keys
       else
         # beacon sends JSON in the request body
-        JSON.parse(request.body.read).slice("sessionId", "windowId", "events", "tags")
+        JSON.parse(request.body.read).slice("sessionId", "recordingId", "windowId", "events", "tags", "labels")
       end
-      session_secure_id = data["sessionId"]
-      window_secure_id = data["windowId"]
+      # `windowId` is the legacy name for `recordingId`; accept either for backward compatibility.
+      data["recordingId"] ||= data["windowId"]
+      data["windowId"] ||= data["recordingId"]
       events = data["events"]
-      session = Session.find_or_create_by(secure_id: session_secure_id)
-      window = SessionWindow.find_or_create_by(secure_id: window_secure_id, session: session)
+      if SpectatorSport::Recording.migrated?
+        create_recording(data, events)
+      else
+        create_session_window(data, events)
+      end
+      render json: { message: "ok" }
+    end
+    private
+    def create_recording(data, events)
+      recording = Recording.find_or_create_by(secure_id: data["recordingId"])
+      records_data = events.map do |event|
+        { recording_id: recording.id, event_data: event, created_at: Time.at(event["timestamp"].to_f / 1000.0) }
+      end.to_a
+      Event.insert_all(records_data) if records_data.any?
+      last_event = records_data.max_by { |record| record[:created_at] }
+      recording.update(updated_at: last_event[:created_at]) if last_event
+      if SpectatorSport::Label.migrated?
+        verifier = Rails.application.message_verifier(:spectator_sport_label_recording)
+        Array(data["labels"]).first(20).each do |signed_label|
+          label_data = verifier.verified(signed_label)
+          next unless label_data.is_a?(Hash)
+          Label.record(
+            recording: recording,
+            value: label_data["value"],
+            key: label_data["key"],
+            strategy: label_data["strategy"]
+          )
+        rescue StandardError
+          nil
+        end
+      end
+    end
+    def create_session_window(data, events)
+      session = Session.find_or_create_by(secure_id: data["sessionId"])
+      window = SessionWindow.find_or_create_by(secure_id: data["windowId"], session: session)
       records_data = events.map do |event|
         { session_id: session.id, session_window_id: window.id, event_data: event, created_at: Time.at(event["timestamp"].to_f / 1000.0) }
@@ -39,7 +81,21 @@ module SpectatorSport
         end
       end
-      render json: { message: "ok" }
+      if SpectatorSport::Label.migrated?
+        verifier = Rails.application.message_verifier(:spectator_sport_label_recording)
+        Array(data["labels"]).first(20).each do |signed_label|
+          label_data = verifier.verified(signed_label)
+          next unless label_data.is_a?(Hash)
+          Label.record(
+            session_window: window,
+            value: label_data["value"],
+            key: label_data["key"],
+            strategy: label_data["strategy"]
+          )
+        rescue StandardError
+          nil
+        end
+      end
     end
   end
 end

data/app/frontend/spectator_sport/dashboard/modules/player_controller.js CHANGED Viewed

@@ -10,11 +10,15 @@ export default class extends Controller {
   static targets = [ "player", "events", "linkUrl" ]
   connect() {
+    if (this.eventsValue.length === 0) return;
     this.player = new Player({
       target: this.playerTarget,
       props: {
         events: this.eventsValue,
         liveMode: true,
+        skipInactive: false,
+        speedOption: [1, 2, 4, 8, 16],
       }
     });

data/app/frontend/spectator_sport/dashboard/vendor/rrweb-player/rrweb-player.min.css CHANGED Viewed

@@ -1,2 +1,2 @@
-// https://cdn.jsdelivr.net/npm/rrweb-player@2.0.0-alpha.18/dist/style.min.css
 .switch.svelte-a6h7w7.svelte-a6h7w7.svelte-a6h7w7{height:1em;display:flex;align-items:center}.switch.disabled.svelte-a6h7w7.svelte-a6h7w7.svelte-a6h7w7{opacity:.5}.label.svelte-a6h7w7.svelte-a6h7w7.svelte-a6h7w7{margin:0 8px}.switch.svelte-a6h7w7 input[type=checkbox].svelte-a6h7w7.svelte-a6h7w7{position:absolute;opacity:0}.switch.svelte-a6h7w7 label.svelte-a6h7w7.svelte-a6h7w7{width:2em;height:1em;position:relative;cursor:pointer;display:block}.switch.disabled.svelte-a6h7w7 label.svelte-a6h7w7.svelte-a6h7w7{cursor:not-allowed}.switch.svelte-a6h7w7 label.svelte-a6h7w7.svelte-a6h7w7:before{content:"";position:absolute;width:2em;height:1em;left:.1em;transition:background .1s ease;background:#4950f680;border-radius:50px}.switch.svelte-a6h7w7 label.svelte-a6h7w7.svelte-a6h7w7:after{content:"";position:absolute;width:1em;height:1em;border-radius:50px;left:0;transition:all .2s ease;box-shadow:0 2px 5px #0000004d;background:#fcfff4;animation:switch-off .2s ease-out;z-index:2}.switch.svelte-a6h7w7 input[type=checkbox].svelte-a6h7w7:checked+label.svelte-a6h7w7:before{background:#4950f6}.switch.svelte-a6h7w7 input[type=checkbox].svelte-a6h7w7:checked+label.svelte-a6h7w7:after{animation:switch-on .2s ease-out;left:1.1em}.rr-controller.svelte-189zk2r.svelte-189zk2r{width:100%;height:80px;background:#fff;display:flex;flex-direction:column;justify-content:space-around;align-items:center;border-radius:0 0 5px 5px}.rr-timeline.svelte-189zk2r.svelte-189zk2r{width:80%;display:flex;align-items:center}.rr-timeline__time.svelte-189zk2r.svelte-189zk2r{display:inline-block;width:100px;text-align:center;color:#11103e}.rr-progress.svelte-189zk2r.svelte-189zk2r{flex:1;height:12px;background:#eee;position:relative;border-radius:3px;cursor:pointer;box-sizing:border-box;border-top:solid 4px #fff;border-bottom:solid 4px #fff}.rr-progress.disabled.svelte-189zk2r.svelte-189zk2r{cursor:not-allowed}.rr-progress__step.svelte-189zk2r.svelte-189zk2r{height:100%;position:absolute;left:0;top:0;background:#e0e1fe}.rr-progress__handler.svelte-189zk2r.svelte-189zk2r{width:20px;height:20px;border-radius:10px;position:absolute;top:2px;transform:translate(-50%,-50%);background:#4950f6}.rr-controller__btns.svelte-189zk2r.svelte-189zk2r{display:flex;align-items:center;justify-content:center;font-size:13px}.rr-controller__btns.svelte-189zk2r button.svelte-189zk2r{width:32px;height:32px;display:flex;padding:0;align-items:center;justify-content:center;background:none;border:none;border-radius:50%;cursor:pointer}.rr-controller__btns.svelte-189zk2r button.svelte-189zk2r:active{background:#e0e1fe}.rr-controller__btns.svelte-189zk2r button.active.svelte-189zk2r{color:#fff;background:#4950f6}.rr-controller__btns.svelte-189zk2r button.svelte-189zk2r:disabled{cursor:not-allowed}.replayer-wrapper{position:relative}.replayer-mouse{position:absolute;width:20px;height:20px;transition:left .05s linear,top .05s linear;background-size:contain;background-position:center center;background-repeat:no-repeat;background-image:url(data:image/svg+xml;base64,PHN2ZyBoZWlnaHQ9JzMwMHB4JyB3aWR0aD0nMzAwcHgnICBmaWxsPSIjMDAwMDAwIiB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIGRhdGEtbmFtZT0iTGF5ZXIgMSIgdmlld0JveD0iMCAwIDUwIDUwIiB4PSIwcHgiIHk9IjBweCI+PHRpdGxlPkRlc2lnbl90bnA8L3RpdGxlPjxwYXRoIGQ9Ik00OC43MSw0Mi45MUwzNC4wOCwyOC4yOSw0NC4zMywxOEExLDEsMCwwLDAsNDQsMTYuMzlMMi4zNSwxLjA2QTEsMSwwLDAsMCwxLjA2LDIuMzVMMTYuMzksNDRhMSwxLDAsMCwwLDEuNjUuMzZMMjguMjksMzQuMDgsNDIuOTEsNDguNzFhMSwxLDAsMCwwLDEuNDEsMGw0LjM4LTQuMzhBMSwxLDAsMCwwLDQ4LjcxLDQyLjkxWm0tNS4wOSwzLjY3TDI5LDMyYTEsMSwwLDAsMC0xLjQxLDBsLTkuODUsOS44NUwzLjY5LDMuNjlsMzguMTIsMTRMMzIsMjcuNThBMSwxLDAsMCwwLDMyLDI5TDQ2LjU5LDQzLjYyWiI+PC9wYXRoPjwvc3ZnPg==);border-color:transparent}.replayer-mouse:after{content:"";display:inline-block;width:20px;height:20px;background:#4950f6;border-radius:100%;transform:translate(-50%,-50%);opacity:.3}.replayer-mouse.active:after{animation:click .2s ease-in-out 1}.replayer-mouse.touch-device{background-image:none;width:70px;height:70px;border-width:4px;border-style:solid;border-radius:100%;margin-left:-37px;margin-top:-37px;border-color:#4950f600;transition:left 0s linear,top 0s linear,border-color .2s ease-in-out}.replayer-mouse.touch-device.touch-active{border-color:#4950f6;transition:left .25s linear,top .25s linear,border-color .2s ease-in-out}.replayer-mouse.touch-device:after{opacity:0}.replayer-mouse.touch-device.active:after{animation:touch-click .2s ease-in-out 1}.replayer-mouse-tail{position:absolute;pointer-events:none}@keyframes click{0%{opacity:.3;width:20px;height:20px}50%{opacity:.5;width:10px;height:10px}}@keyframes touch-click{0%{opacity:0;width:20px;height:20px}50%{opacity:.5;width:10px;height:10px}}.rr-player{position:relative;background:#fff;float:left;border-radius:5px;box-shadow:0 24px 48px #11103e1f}.rr-player__frame{overflow:hidden}.replayer-wrapper{float:left;clear:both;transform-origin:top left;left:50%;top:50%}.replayer-wrapper>iframe{border:none}
+/*# sourceMappingURL=style.min.css.map */