Jira Issue Collector is not activated for Custom trigger style [#2804373]

Hi,

Seems the code for the action button which triggers the Jira Issue Collector is not being injected.

In the admin form section in "Code" field we have this code:

<script type="text/javascript" src="<jira_js_url>"></script>
<script type="text/javascript">
jQuery(document).ready(function() {
window.ATL_JQ_PAGE_PROPS =  {
  "triggerFunction": function(showCollectorDialog) {
    //Requires that jQuery is available! 
    jQuery("#myTrigger").click(function(e) {
      e.preventDefault();
      showCollectorDialog();
    });
}};
});
</script>

The url is generated and is injected properly in the code, but the function which triggers the showCollectorDialog() is not being embedded.

In the page where we need the JIC, we added a button with this code:

<p><button class="btn btn-info" id="myTrigger">Click to Report</button></p>

When we click it, nothing happens, no errors shown in console.

We tried to add manually the JS which reacts to the button click in jira_issue_collector.js file and it works.
But I'm not sure if that's the way to go.

Is this a problem of the module?
Or am I using it in the wrong way?

Thanks in advance.

Comment	File	Size	Author
#10	jic_custom.patch	4.91 KB	SalvadorP
#3	JIRA Issue Collector \| Site-Install 2016-09-24 16-39-47.png	143.86 KB	kasperg
#3	Test issue collector - JIRA 2016-09-24 16-38-54.png	161.23 KB	kasperg

Support from Acquia helps fund testing for Drupal Acquia logo

Comments

Comment #1

22 September 2016 at 08:40

SalvadorP created an issue. See original summary.

Comment #2

SalvadorP CreditAttribution: SalvadorP as a volunteer commented 22 September 2016 at 09:13

Issue summary:

View changes

Comment #3

kasperg CreditAttribution: kasperg at Reload commented 24 September 2016 at 14:43

File	Size
Test issue collector - JIRA 2016-09-24 16-38-54.png	161.23 KB
JIRA Issue Collector \| Site-Install 2016-09-24 16-39-47.png	143.86 KB

The code you pasted does not look right to me. I wonder how you ended up with that?

I would expect it to be in the format:

// Requires jQuery!
jQuery.ajax({
    url: "<jira-js-url>",
    type: "get",
    cache: true,
    dataType: "script"
});

The <jira-js-url> should be picked up when pasted in the JIRA Issue Collector module settings form.

I have attached screenshots of how I would expect it to appear in the JIRA administration and in the Drupal module settings page. Perhaps that will be helpful to you.

Comment #4

SalvadorP CreditAttribution: SalvadorP as a volunteer commented 26 September 2016 at 10:55

Hi @kasperg,

Thanks for your answer, and the screen captures!

The code I'm using is the one which the Jira Issue Collector generator page gives. (Tried with both versions HTML and JS)
But does not work, I tried with the format you say, but it's the same, no errors, but no button or button reaction to launch the issue collector.

Looking at the JIRA documentation, seems that starting from version 1.2 they included this extra code to personalize the trigger.

I'm using version 1.4 of the Jira Issue Collector, maybe that's the reason why is not working for me.

If I include the "extra" code at the JS file or in the rendered page the issue collector works and appears when clicking the button.

Comment #5

SalvadorP CreditAttribution: SalvadorP as a volunteer commented 7 October 2016 at 09:32

Hi @kasperg,

Your module works fine always if you select "Prominent, Subtle or Vertical" in the Trigger style options of the Jira Issue Collector.

The problem comes when you select the Custom format.
In that format you need to attach the custom code for the trigger.
And the module is not attaching it, I suppose is out of the scope of the module.

So, the module seems to be working as expected always you use the other 3 options.
I'll close the ticket as working as expected.

Thanks for your time,

Kind Regards.

Comment #6

SalvadorP CreditAttribution: SalvadorP as a volunteer commented 7 October 2016 at 09:32

Status:

Active

» Closed (works as designed)

Comment #7

kasperg CreditAttribution: kasperg at Reload commented 7 October 2016 at 13:05

Title:	Jira Issue Collector Button Code not injected	» Jira Issue Collector is not activated for Custom trigger style
Status:	Closed (works as designed)	» Active

@SalvadorP: Good catch.

We could add an option to the JIRA Issue Collector module mentioning the "Custom" option. If the user checks the "Use custom trigger style" checkbox and enters the ID for the trigger element, then the trigger is added.

Comment #8

SalvadorP CreditAttribution: SalvadorP as a volunteer commented 7 October 2016 at 14:03

Hi @kasperg,

Thanks!

I think it will be a really good addition to the module, it will provide more flexibility to it.

Maybe it will be better to add a textarea to let the user add all the Custom JS code.
This will allow the user to personalize the behaviour of the button or fill some fields by default with some data.

In case you need some help with this, just tell me, I'll gladly help you.

Comment #9

kasperg CreditAttribution: kasperg at Reload commented 9 October 2016 at 18:47

I get your point but I would like to avoid injection of arbitrary code in the module.

Arbitrary code injection is a potential security problem. If users really want to inject code there are better solutions for that. Either through development or modules like JS injector.

Filling fields by default is interesting but I would prefer settings for that as well. Combining this with Tokens could be quite neat - but that is a topic for another issue.

If you are up for it I would appreciate a patch for better handling of the "Custom" trigger style.