WCA Live Integration Pre Work #1: Job and Websockets

app/channels/application_cable/channel.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module ApplicationCable
+  class Channel < ActionCable::Channel::Base
+  end
+end

app/channels/application_cable/connection.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module ApplicationCable
+  class Connection < ActionCable::Connection::Base
+    # For Live we don't care about only letting authenticated users connect
+    # We might want to change this for other use cases
+
+    # identified_by :current_user
+    #
+    def connect
+      reject_unauthorized_connection if EnvConfig.WCA_LIVE_SITE?
+    end
+    #
+    # private
+    #
+    # def find_verified_user
+    #   user_id = cookies.encrypted["_WcaOnRails_session"]["warden.user.user.key"][0]
+    #   if (verified_user = User.find_by(id: user_id))
+    #     verified_user
+    #   else
+    #     reject_unauthorized_connection
+    #   end
+    # end
+  end
+end

app/channels/live_results_channel.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+class LiveResultsChannel < ApplicationCable::Channel
+  def subscribed
+    stream_from "results_#{params[:round_id]}"
+  end
+end

app/jobs/add_live_result_job.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+class AddLiveResultJob < ApplicationJob
+  self.queue_adapter = :shoryuken if Rails.env.production? && !EnvConfig.WCA_LIVE_SITE?
+  queue_as EnvConfig.LIVE_QUEUE if Rails.env.production? && !EnvConfig.WCA_LIVE_SITE?
+
+  def perform(params)
+    ActionCable.server.broadcast("results_#{params[:round_id]}",
+                                 { attempts: params[:results], user_id: params[:user_id] })
+  end
+end

app/views/layouts/application.html.erb

@@ -10,6 +10,8 @@
 
   <meta name="og:image" content='<%= asset_url("og-wca_logo.png") %>'/>
 
+  <%= action_cable_meta_tag %>
+
   <meta name="description" content="The World Cube Association governs competitions for mechanical puzzles that are operated by twisting groups of pieces, commonly known as 'twisty puzzles'. The most famous of these puzzles is the Rubik's Cube, invented by professor Rubik from Hungary. A selection of these puzzles are chosen as official events of the WCA.">
 
   <title><%= full_title(yield(:title)) %></title>

env_config.rb

@@ -33,6 +33,7 @@
     mandatory :ASSET_HOST, :string
     mandatory :CDN_ASSETS_DISTRIBUTION_ID, :string
     mandatory :REGISTRATION_QUEUE, :string
+    mandatory :LIVE_QUEUE, :string
 
     if is_compiling_assets
       mandatory :V2_REGISTRATIONS_POLL_URL, :string
@@ -59,6 +60,7 @@
     optional :PAYPAL_BASE_URL, :string, ''
     optional :WRC_WEBHOOK_URL, :string, ''
     optional :REGISTRATION_QUEUE, :string, ''
+    optional :LIVE_QUEUE, :string, ''
 
     optional :V2_REGISTRATIONS_POLL_URL, :string, ''
     optional :V3_REGISTRATIONS_POLL_URL, :string, ''

infra/wca_on_rails/production/rails.tf

@@ -120,6 +120,10 @@ locals {
       name = "REGISTRATION_QUEUE"
       value = aws_sqs_queue.this.url
     },
+    {
+      name = "LIVE_QUEUE"
+      value = aws_sqs_queue.results.url
+    },
     {
       name = "VAULT_APPLICATION"
       value = var.VAULT_APPLICATION

infra/wca_on_rails/production/sqs.tf

@@ -13,3 +13,17 @@ resource "aws_sqs_queue" "this" {
     Env = "Production"
   }
 }
+
+resource "aws_sqs_queue" "results" {
+  name                      = "results-monolith"
+  content_based_deduplication = true
+  deduplication_scope        = "queue"
+  delay_seconds              = 0
+  max_message_size           = 262144
+  message_retention_seconds  = 345600
+  receive_wait_time_seconds  = 0
+  visibility_timeout_seconds = 60
+  tags = {
+    Env = "Production"
+  }
+}

infra/wca_on_rails/staging/rails.tf

@@ -56,6 +56,10 @@ locals {
       name = "REGISTRATION_QUEUE"
       value = aws_sqs_queue.this.url
     },
+    {
+      name = "LIVE_QUEUE"
+      value = aws_sqs_queue.results.url
+    },
     {
       name = "STORAGE_AWS_REGION"
       value = var.region

infra/wca_on_rails/staging/sqs.tf

@@ -13,3 +13,17 @@ resource "aws_sqs_queue" "this" {
     Env = "staging"
   }
 }
+
+resource "aws_sqs_queue" "results" {
+  name                      = "results-staging-monolith"
+  content_based_deduplication = true
+  deduplication_scope        = "queue"
+  delay_seconds              = 0
+  max_message_size           = 262144
+  message_retention_seconds  = 345600
+  receive_wait_time_seconds  = 0
+  visibility_timeout_seconds = 60
+  tags = {
+    Env = "Staging"
+  }
+}

package.json

@@ -25,6 +25,7 @@
     "@fullcalendar/luxon3": "^6.1.15",
     "@fullcalendar/react": "^6.1.15",
     "@fullcalendar/timegrid": "^6.1.15",
+    "@rails/actioncable": "^8.0.100",
     "@rails/ujs": "^7.1.501",
     "@stripe/react-stripe-js": "^3.1.1",
     "@stripe/stripe-js": "^5.5.0",

yarn.lock

@@ -2494,6 +2494,13 @@ __metadata:
   languageName: node
   linkType: hard
 
+"@rails/actioncable@npm:^8.0.100":
+  version: 8.0.100
+  resolution: "@rails/actioncable@npm:8.0.100"
+  checksum: 10c0/ae8870083e5c48448bd1d77268d28a16d7eee6d213dac8a6e20888c47d89ac959c4e835a613beaaa71b13b9aaaea14c4fb6d67120f972d174f1f899dd5a37e45
+  languageName: node
+  linkType: hard
+
 "@rails/ujs@npm:^7.1.501":
   version: 7.1.501
   resolution: "@rails/ujs@npm:7.1.501"
@@ -10225,6 +10232,7 @@ __metadata:
     "@fullcalendar/react": "npm:^6.1.15"
     "@fullcalendar/timegrid": "npm:^6.1.15"
     "@pmmmwh/react-refresh-webpack-plugin": "npm:^0.5.15"
+    "@rails/actioncable": "npm:^8.0.100"
     "@rails/ujs": "npm:^7.1.501"
     "@stripe/react-stripe-js": "npm:^3.1.1"
     "@stripe/stripe-js": "npm:^5.5.0"