Fix LTI2 Registration with Canvas

[dac514]

When trying to do LTI2 Registration with Canvas I get back:

{"errors":[{"field":"product_code","message":null,"error_code":"blank"}],"error_report_id":155315614}

The reason is this code:

def create_product_family(tp, account, developer_key)
  vendor_code = tp.tool_profile.product_instance.product_info.product_family.vendor.code
  product_code = tp.tool_profile.product_instance.product_info.product_family.code

Source: https://github.com/instructure/canvas-lms/blob/0063478e81b0175f47ce0698345b3b8f42e6d52a/app/models/lti/tool_proxy_service.rb#L125

When I change ToolProvider/MediaType/ToolProfile.php from:

if (!empty($toolProvider->vendor->id)) { 
  $this->product_instance->product_info->product_family->vendor->code = $toolProvider->vendor->id;	
}

To:

if (!empty($toolProvider->vendor->id)) { 
  $this->product_instance->product_info->product_family->vendor->code = $toolProvider->vendor->id; 
  $this->product_instance->product_info->product_family->code = $toolProvider->vendor->id; }

Ir works.

Unsure if it should be the same vendor ID though. Here's the spec: https://www.imsglobal.org/specs/ltiv2p0/implementation-guide#toc-68

[Izumi-kun]

I think product_code will be an id of Product.

The product family is identified by a code that is unique within the namespace of some vendor

So this:

        if (!empty($toolProvider->vendor)) {
            $this->product_instance->product_info->product_family = new \stdClass;
            $this->product_instance->product_info->product_family->vendor = new \stdClass;
        }

became like this:

        if (!empty($toolProvider->vendor)) {
            $this->product_instance->product_info->product_family = new \stdClass;
            $this->product_instance->product_info->product_family->vendor = new \stdClass;
            if (!empty($toolProvider->product->id)) {
                $this->product_instance->product_info->product_family->code = $toolProvider->product->id;
            }
        }

What do you think?

[dac514]

Yes sounds good. So long as there's an ID (string, int) it seems to work for me.

[Izumi-kun]

Please add extra commit so i can merge this bugfix.

[dac514]

Done.

[Izumi-kun]

Merged. Thanks!

Related: 1EdTech#24