panda_pal 5.19.0.beta2 → 5.19.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b8433b20262277ab9a0e66156b4fb2b865919cbfe73701202c163b1dd4c063c9
-  data.tar.gz: fba4d18d40156ccf1799c33b4b2a5aed33b71c6e0e772a65df04c586f207503f
+  metadata.gz: d04030accc6fd45997f3e37c3c91f9bdfe77f7cf7f4898cf54e4dae47f45886e
+  data.tar.gz: db21a419ad8d77e68b670b292cd22bbe3432c097bd6b0663fbe8e012790ad1cf
 SHA512:
-  metadata.gz: 33e70423978afce311e1e0d4a5eecddc17e8814e922bea12e854b1b57135cc336e1c418b6f8d0fcca061c4a25485164dab1468805639d16abd6f1c1951f7b4cb
-  data.tar.gz: fa08843f3ad5d268203908c22725c546825102127cce6858c907a84b21e0a58561fab5f1e017b569cb95abd5e42c1715045b699b7790f899e7bbabfbf8f9693c
+  metadata.gz: '02434851f52dc132ceab53754675b8e3ef54bc5dc0ee6b3e74e2d24aa7d3bd023bad5bd798aa87387365d37b2fe18d66ab89525c9121c1c495433e036e7c0796'
+  data.tar.gz: 1d102580d5599677921de881a487ada5880e278e46e2563fd4c77bea69c96ad7fb4395411d58a8be1047af29715c9ced56895b7ddbac7c995a285f3a7f3df68f

data/app/models/panda_pal/platform/canvas.rb

@@ -80,6 +80,7 @@ module PandaPal
       def _parse_lti_context(context)
         context = context.to_s
         context = 'account/self' if context == 'root_account'
+        context = "account/#{canvas_account_id}" if context == 'org_account'
         cid, ctype = context.split(/[\.\/]/).reverse
         ctype ||= 'account'
 
@@ -89,7 +90,7 @@ module PandaPal
       # `tool:` installs one of the tools registered with PandaPal.define_tool
       # instead of the default one. In LTI 1.3 each tool is its own Developer Key,
       # tracked by an LtiRegistration rather than by this Organization's `key`.
-      def _install_lti(host: nil, context: :root_account, version: nil, exists: :error, dedicated_deployment: false, tool: PandaPal::DEFAULT_TOOL)
+      def _install_lti(host: nil, context: :org_account, version: nil, exists: :error, dedicated_deployment: false, tool: PandaPal::DEFAULT_TOOL)
         outer_install = @current_lti_install
         raise "Automatically installing this LTI requires Bearcat." unless defined?(Bearcat)
 
@@ -148,28 +149,16 @@ module PandaPal
             scope_tool = existing_installs[0]
 
             # Don't need to do an update if it already exists - Settings are stored on the LTI Key instead of the installation
-            if tool != PandaPal::DEFAULT_TOOL
-              scope_tool ||= bearcat_client.send(:"create_#{ctype}_external_tool", cid, {
+            new_install = !scope_tool
+            scope_tool ||= _with_lti_registration_unlocked(ekey) do
+              bearcat_client.send(:"create_#{ctype}_external_tool", cid, {
                 client_id: ekey[:id],
               })
+            end
 
-              lti_registrations.find_or_create_by!(
-                tool: tool.to_s,
-                client_id: ekey[:id].to_s,
-                deployment_id: (scope_tool[:deployment_id].presence&.to_s if dedicated_deployment),
-              )
-            elsif !scope_tool
-              scope_tool = bearcat_client.send(:"create_#{ctype}_external_tool", cid, {
-                client_id: ekey[:id],
-              })
-
-              new_client_id = "#{ekey[:id]}"
-              new_client_id += "/#{scope_tool[:deployment_id]}" if dedicated_deployment
-
-              self.key = new_client_id
-              self.secret = ekey[:api_key]
-
-              save! if changed?
+            # The default tool's key only moves with a new install; other tools always (re)register
+            if new_install || tool != PandaPal::DEFAULT_TOOL
+              _register_lti_v1p3_key(tool, ekey, deployment_id: (scope_tool[:deployment_id].presence&.to_s if dedicated_deployment))
             end
 
             @new_lti_installation = scope_tool
@@ -244,7 +233,8 @@ module PandaPal
 
         valid_redirect_uris.uniq!
 
-        if !ekey
+        created = !ekey
+        if created
           # Create New
           ekey = bearcat_client.post("api/lti/accounts/self/developer_keys/tool_configuration", {
             developer_key: {
@@ -270,6 +260,10 @@ module PandaPal
 
         ekey = ekey[:developer_key] || ekey
 
+        # Record a new key right away, so a failed install is retried against
+        # this key instead of creating yet another one.
+        _register_lti_v1p3_key(tool, ekey) if created
+
         if ekey[:developer_key_account_binding][:workflow_state] == "off"
           bearcat_client.post("api/v1/accounts/self/developer_keys/#{ekey[:id]}/developer_key_account_bindings", {
             developer_key_account_binding: {
@@ -281,6 +275,42 @@ module PandaPal
         ekey
       end
 
+      # Points this Organization (default tool) or an LtiRegistration (other
+      # tools) at a v1.3 Developer Key.
+      def _register_lti_v1p3_key(tool, ekey, deployment_id: nil)
+        client_id = ekey[:id].to_s
+
+        if tool == PandaPal::DEFAULT_TOOL
+          self.key = deployment_id ? "#{client_id}/#{deployment_id}" : client_id
+          self.secret = ekey[:api_key] if ekey[:api_key].present?
+          save! if changed?
+        else
+          lti_registrations.find_or_create_by!(tool: tool.to_s, client_id: client_id, deployment_id: deployment_id)
+          # Drop the deployment-less placeholder recorded when the key was created
+          lti_registrations.where(tool: tool.to_s, client_id: client_id, deployment_id: nil).delete_all if deployment_id
+        end
+      end
+
+      # Canvas creates LTI Registrations with lock_deploying on, which blocks
+      # installing by client_id (when lock_lti_registrations is enabled). Unlock
+      # for the duration of the block, then put the lock back as it was.
+      def _with_lti_registration_unlocked(ekey)
+        registration_id = ekey[:lti_registration_id]
+        return yield unless registration_id.present?
+
+        registration_url = "api/v1/accounts/self/lti_registrations/#{registration_id}"
+        registration = bearcat_client.get(registration_url)
+        # Inherited registrations can only be changed by their owning account
+        return yield unless registration[:lock_deploying] && !registration[:inherited]
+
+        bearcat_client.put(registration_url, { lock_deploying: false })
+        begin
+          yield
+        ensure
+          bearcat_client.put(registration_url, { lock_deploying: true })
+        end
+      end
+
       def _find_existing_installs(context, exists: nil, &matcher)
         ctype, cid = _parse_lti_context(context)
 
@@ -363,7 +393,7 @@ module PandaPal
         end
       end
 
-      def lti_installations(context= :root_account)
+      def lti_installations(context= :org_account)
         _find_existing_installs(context)
       end
 
@@ -389,7 +419,7 @@ module PandaPal
           context_path = "#{context_name}s/#{context.canvas_id}"
         else
           placement ||= "account_navigation"
-          context_path = "accounts/#{current_organization.canvas_account_id}"
+          context_path = "accounts/#{canvas_account_id}"
         end
 
         if %w[global account course user].include?(placement)

data/lib/panda_pal/version.rb

@@ -1,3 +1,3 @@
 module PandaPal
-  VERSION = '5.19.0.beta2'
+  VERSION = '5.19.0'
 end

metadata

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