panda_pal 5.16.0 → 5.16.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c78eb783dcf56cb075ce23d1218500128e6ac1ac58c3049bcfa13f6409835554
-  data.tar.gz: bb555a130fdab3e1805013700e04bddfe24a6c3460750ac2201a06f9dfe96c1d
+  metadata.gz: 7c39df6be8d76f63ab12597a80696f629aac5da4a400adfa30119f303177251c
+  data.tar.gz: 2ab2639ea53d3e698244d65313f94b5ebc6c5edcb5039efc0b7dd801658a1603
 SHA512:
-  metadata.gz: 5378ea91ce63e263dc93368f4d87cec35a14273b74f37452cec2b1dea67ff8bbb3a261e609bbc550bbcc4f08dac8c1de09e387e6ec8691e3d4901ac7b2af1e0a
-  data.tar.gz: aef30aa2d98b20f502a9274ce31c5bf17e66111c8a628cd61ce2765c06ef7fe280af459069a3fafe0a13aa885e9ba915f048553f14714e3ad274537b7bd4cfe3
+  metadata.gz: '06705595bcabf1959f7a2d72e7174d6944acc0876770878aa700d926d5b4beefdbb4a8af9462009a253d6eaf4a3fc3870f915291baa6490f5d2ecd756f84a275'
+  data.tar.gz: dac25e88efe02b2982e6441506e5d17328b3ee4500627d400523f37da6f7e6093c2a5d85492a73eb5946e616bc0ae7839730620ed66deb8986c952e416fc8f83

data/README.md

@@ -166,7 +166,7 @@ PandaPal.stage_placement(:content_selection, {
 })
 ```
 
-2. **Include helpers** in your controller and build content items:
+2. **Include helpers** in your controller and build content items with **required `launch_type`**:
 ```ruby
 class ContentSelectionController < ApplicationController
   include PandaPal::DeepLinkingHelpers
@@ -174,8 +174,12 @@ class ContentSelectionController < ApplicationController
   def create
     content_items = [
       build_link_content_item(
-        url: launch_url_for_content(params[:content_id]),
-        title: 'Selected Content'
+        url: panda_pal.v1p3_resource_link_request_url,
+        title: 'Selected Content',
+        custom: {
+          content_id: params[:content_id],
+          launch_type: :content_launch  # REQUIRED for proper routing
+        }
       )
     ]
     render_deep_linking_response(content_items)
@@ -183,6 +187,14 @@ class ContentSelectionController < ApplicationController
 end
 ```
 
+3. **Add corresponding launch routes**:
+```ruby
+# config/routes.rb
+lti_nav content_launch: 'content#launch'
+```
+
+**⚠️ IMPORTANT**: All content items **MUST** include `launch_type` in the `custom` hash. This is used by the `resource_link_request` action to determine which route to redirect to when Canvas launches your content.
+
 **For complete configuration options, implementation examples, helper method documentation, and troubleshooting, see [DEEP_LINKING.md](DEEP_LINKING.md).**
 
 ## Implementating data segregation

data/app/controllers/panda_pal/lti_v1_p3_controller.rb

@@ -40,7 +40,7 @@ module PandaPal
     end
 
     def resource_link_request
-      ltype = @decoded_lti_jwt[LtiConstants::Canvas::PLACEMENT]
+      ltype = @decoded_lti_jwt[LtiConstants::Canvas::PLACEMENT] || @decoded_lti_jwt[LtiConstants::Claims::CUSTOM]&.dig("launch_type")
 
       if ltype
         current_session.data.merge!({

data/app/lib/panda_pal/deep_linking_helpers.rb

@@ -1,7 +1,26 @@
 module PandaPal
   module DeepLinkingHelpers
     # Build a link content item
-    def build_link_content_item(url:, title: nil, text: nil, icon: nil, thumbnail: nil, **options)
+    # @param url [String] The launch URL for the content
+    # @param title [String] The title of the content item
+    # @param text [String] Optional description text
+    # @param icon [String] Optional icon URL
+    # @param thumbnail [String] Optional thumbnail URL
+    # @param custom [Hash] Custom parameters - MUST include launch_type for proper routing
+    # @param options [Hash] Additional options to merge into the content item
+    #
+    # Example:
+    #   build_link_content_item(
+    #     url: panda_pal.v1p3_resource_link_request_url,
+    #     title: 'My Quiz',
+    #     custom: {
+    #       quiz_id: 123,
+    #       launch_type: :quiz_launch  # REQUIRED for proper routing
+    #     }
+    #   )
+    def build_link_content_item(url:, title: nil, text: nil, icon: nil, thumbnail: nil, custom: {}, **options)
+      validate_custom_launch_type!(custom)
+
       content_item = {
         type: 'link',
         url: url,
@@ -10,11 +29,21 @@ module PandaPal
       content_item[:text] = text if text.present?
       content_item[:icon] = icon if icon.present?
       content_item[:thumbnail] = thumbnail if thumbnail.present?
+      content_item[:custom] = custom if custom.present?
       content_item.merge(options)
     end
 
     # Build a file content item
-    def build_file_content_item(url:, title: nil, text: nil, media_type: nil, icon: nil, **options)
+    # @param url [String] The file URL
+    # @param title [String] The title of the content item
+    # @param text [String] Optional description text
+    # @param media_type [String] Optional media type
+    # @param icon [String] Optional icon URL
+    # @param custom [Hash] Custom parameters - MUST include launch_type for proper routing
+    # @param options [Hash] Additional options to merge into the content item
+    def build_file_content_item(url:, title: nil, text: nil, media_type: nil, icon: nil, custom: {}, **options)
+      validate_custom_launch_type!(custom)
+
       content_item = {
         type: 'file',
         url: url,
@@ -23,17 +52,26 @@ module PandaPal
       content_item[:text] = text if text.present?
       content_item[:mediaType] = media_type if media_type.present?
       content_item[:icon] = icon if icon.present?
+      content_item[:custom] = custom if custom.present?
       content_item.merge(options)
     end
 
     # Build an HTML content item
-    def build_html_content_item(html:, title: nil, text: nil, **options)
+    # @param html [String] The HTML content
+    # @param title [String] The title of the content item
+    # @param text [String] Optional description text
+    # @param custom [Hash] Custom parameters - MUST include launch_type for proper routing
+    # @param options [Hash] Additional options to merge into the content item
+    def build_html_content_item(html:, title: nil, text: nil, custom: {}, **options)
+      validate_custom_launch_type!(custom)
+
       content_item = {
         type: 'html',
         html: html,
         title: title
       }
       content_item[:text] = text if text.present?
+      content_item[:custom] = custom if custom.present?
       content_item.merge(options)
     end
 
@@ -68,6 +106,12 @@ module PandaPal
 
     private
 
+    def validate_custom_launch_type!(custom)
+      unless custom.is_a?(Hash) && custom.key?(:launch_type)
+        raise ArgumentError, "custom parameter must include :launch_type for proper routing. Example: custom: { launch_type: :my_content_type }"
+      end
+    end
+
     def build_deep_link_jwt(content_items, custom_deep_link_data)
       # Get issuer (client_id) and audience from session
       launch_params = current_session[:launch_params]

data/app/lib/panda_pal/launch_url_helpers.rb

@@ -52,7 +52,7 @@ module PandaPal
     def self.launch_route(opts, launch_type: nil)
       if opts.is_a?(Symbol) || opts.is_a?(String)
         launch_type = opts.to_sym
-        opts = PandaPal.lti_paths[launch_type]
+        opts = PandaPal.lti_paths[launch_type] || {}
       end
 
       if opts[:route_helper_key]

data/config/initializers/apartment.rb

@@ -251,29 +251,6 @@ end
 ActiveSupport::Cache::Store.send(:prepend, PandaPal::Plugins::ApartmentCache)
 
 if defined?(ActionCable)
-  module ActionCable
-    module Channel
-      class Base
-        def self.broadcasting_for(model)
-          # Rails 5 #stream_for passes #channel_name as part of model. Rails 6 doesn't and includes it via #broadcasting_for.
-          model = [channel_name, model] unless model.is_a?(Array)
-          serialize_broadcasting([ Apartment::Tenant.current, model ])
-        end
-
-        def self.serialize_broadcasting(object)
-          case
-          when object.is_a?(Array)
-            object.map { |m| serialize_broadcasting(m) }.join(":")
-          when object.respond_to?(:to_gid_param)
-            object.to_gid_param
-          else
-            object.to_param
-          end
-        end
-      end
-    end
-  end
-
   module PandaPal::Plugins::ActionCableApartment
     module Connection
       def tenant=(name)
@@ -283,13 +260,81 @@ if defined?(ActionCable)
       def tenant
         @tenant || 'public'
       end
+    end
+  end
+
+  if Rails.version < '7.0'
+    module ActionCable
+      module Channel
+        class Base
+          def self.broadcasting_for(model)
+            # Rails 5 #stream_for passes #channel_name as part of model. Rails 6 doesn't and includes it via #broadcasting_for.
+            model = [channel_name, model] unless model.is_a?(Array)
+            serialize_broadcasting([ Apartment::Tenant.current, model ])
+          end
+
+          def self.serialize_broadcasting(object)
+            case
+            when object.is_a?(Array)
+              object.map { |m| serialize_broadcasting(m) }.join(":")
+            when object.respond_to?(:to_gid_param)
+              object.to_gid_param
+            else
+              object.to_param
+            end
+          end
+        end
+      end
+    end
 
+    module PandaPal::Plugins::ActionCableApartment::Connection
       def dispatch_websocket_message(*args, **kwargs)
         Apartment::Tenant.switch(tenant) do
           super
         end
       end
     end
+  else
+    module ActionCable
+      module Channel
+        class Base
+          def self.broadcasting_for(*args)
+            cconn = ActionCable.server.worker_pool.connection
+            items = [cconn&.tenant || Apartment::Tenant.current, channel_name, *args]
+            serialize_broadcasting(items)
+          end
+        end
+      end
+    end
+
+    ActionCable::Server::Worker.set_callback :work, :around do |_, blk|
+      pten = Thread.current[:cable_tenant]
+      Thread.current[:cable_tenant] = connection.tenant
+      blk.call
+    ensure
+      Thread.current[:cable_tenant] = pten
+    end
+
+    if Apartment::Tenant.adapter.is_a?(Apartment::Adapters::PostgresqlSchemaAdapter)
+      module ApartmentConnPoolMixin
+        # Allows cable channels to lazy-load the tenant schema on first use
+        #   (Using `switch` will ping the DB even if no queries are made)
+        def acquire_connection(...)
+          super.tap do |conn|
+            if ct = Thread.current[:cable_tenant]
+              Thread.current[:cable_tenant] = nil
+              adapter = Apartment::Tenant.adapter
+              # Apartment::Tenant.switch!(ct)
+              Thread.current[:cable_tenant] = ct
+              adapter.instance_variable_set(:@current, ct)
+              conn.schema_search_path = adapter.send :full_search_path
+            end
+          end
+        end
+      end
+
+      ActiveRecord::ConnectionAdapters::ConnectionPool.prepend(ApartmentConnPoolMixin)
+    end
   end
 
   ActionCable::Connection::Base.prepend(PandaPal::Plugins::ActionCableApartment::Connection)

data/lib/panda_pal/version.rb

@@ -1,3 +1,3 @@
 module PandaPal
-  VERSION = "5.16.0"
+  VERSION = "5.16.2"
 end

data/spec/core/apartment_multidb_spec.rb

@@ -31,6 +31,28 @@ RSpec.describe PandaPal::Organization, type: :model do
       end
     end
 
+    it "creates records on the target shard and schema" do
+      org1.switch_tenant
+      PandaPal::ApiCall.create!(logic: "from_primary")
+      expect(PandaPal::ApiCall.count).to eq(1)
+      expect(PandaPal::ApiCall.first.logic).to eq("from_primary")
+
+      org2.switch_tenant
+      PandaPal::ApiCall.create!(logic: "from_alt")
+      expect(PandaPal::ApiCall.count).to eq(1)
+      expect(PandaPal::ApiCall.first.logic).to eq("from_alt")
+
+      org1.switch_tenant
+      expect(PandaPal::ApiCall.count).to eq(1)
+      expect(PandaPal::ApiCall.first.logic).to eq("from_primary")
+      expect(PandaPal::ApiCall.connection.exec_query("SELECT current_database()").pluck("current_database")[0]).to eq("panda_pal_test1")
+
+      org2.switch_tenant
+      expect(PandaPal::ApiCall.count).to eq(1)
+      expect(PandaPal::ApiCall.first.logic).to eq("from_alt")
+      expect(PandaPal::ApiCall.connection.exec_query("SELECT current_database()").pluck("current_database")[0]).to eq("panda_pal_test2")
+    end
+
     context "load_async" do
       it "works across shards" do
         qs = []

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: panda_pal
 version: !ruby/object:Gem::Version
-  version: 5.16.0
+  version: 5.16.2
 platform: ruby
 authors:
 - Instructure CustomDev