Skip to content

Make code.jelly compatible with CSP in Jenkins 2.539+ #458

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
timja merged 2 commits into from
Dec 16, 2025
Merged

Make code.jelly compatible with CSP in Jenkins 2.539+ #458

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0629a0b
Make code.jelly compatible with CSP in Jenkins 2.539+
daniel-beck Dec 15, 2025
51978c5
prettier:fix; but why did the build pass???
daniel-beck Dec 15, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions src/main/resources/io/jenkins/plugins/designlibrary/Dialogs/index.jelly
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<?jelly escape-by-default='true'?>
<j:jelly xmlns:j="jelly:core" xmlns:l="/lib/layout" xmlns:s="/lib/samples" xmlns:f="/lib/form">
<j:jelly xmlns:j="jelly:core" xmlns:l="/lib/layout" xmlns:s="/lib/samples" xmlns:f="/lib/form" xmlns:st="jelly:stapler">
<s:layout>
<s:section title="Alerts">
<s:group>
Expand All @@ -15,7 +15,7 @@
</div>
</dialog>
</s:preview>
<s:code language="java" file="alert.js" code="showAlert()" executable="true"/>
<s:code language="java" file="alert.js" callback="showAlert"/>
</s:group>
<p class="jdl-paragraph">${%alerts}</p>
</s:section>
Expand All @@ -35,7 +35,7 @@
</div>
</dialog>
</s:preview>
<s:code language="java" file="prompt.js" code="showPrompt()" executable="true"/>
<s:code language="java" file="prompt.js" callback="showPrompt"/>
</s:group>
<p class="jdl-paragraph">${%prompts}</p>
</s:section>
Expand All @@ -52,7 +52,7 @@
</div>
</dialog>
</s:preview>
<s:code language="java" file="confirm.js" code="showConfirm()" executable="true"/>
<s:code language="java" file="confirm.js" code="showConfirm()" callback="showConfirm"/>
Copy link
Member Author

@daniel-beck daniel-beck Dec 16, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Note to future self (or anyone else who's super bored): Remove the code attribute here and in following tags as cleanup, they're no longer used. In general, file + code does not make sense anymore.

</s:group>
<p class="jdl-paragraph">${%confirmations}</p>
</s:section>
Expand Down Expand Up @@ -87,7 +87,7 @@
</s:preview>
<s:code-panes>
<s:code-pane title="JavaScript">
<s:code language="java" file="modal.js" code="showModal()" executable="true"/>
<s:code language="java" file="modal.js" code="showModal()" callback="showModal"/>
</s:code-pane>
<s:code-pane title="Jelly">
<s:code file="modal.jelly"/>
Expand Down Expand Up @@ -123,7 +123,7 @@
</s:preview>
<s:code-panes>
<s:code-pane title="JavaScript">
<s:code language="java" file="form.js" code="showForm()" executable="true"/>
<s:code language="java" file="form.js" code="showForm()" callback="showForm"/>
</s:code-pane>
<s:code-pane title="Jelly">
<s:code file="form.jelly"/>
Expand Down
19 changes: 19 additions & 0 deletions src/main/resources/io/jenkins/plugins/designlibrary/Notifications/adjunct.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
function showDefault() {
notificationBar.show("Default");
}

function showSuccess() {
notificationBar.show("Success", notificationBar.SUCCESS);
}

function showWarning() {
notificationBar.show("Warning", notificationBar.WARNING);
}

function showError() {
notificationBar.show("Error", notificationBar.ERROR);
}

function hideNotification() {
notificationBar.hide();
}
8 changes: 7 additions & 1 deletion src/main/resources/io/jenkins/plugins/designlibrary/Notifications/index.jelly
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<?jelly escape-by-default='true'?>
<j:jelly xmlns:j="jelly:core" xmlns:s="/lib/samples">
<j:jelly xmlns:j="jelly:core" xmlns:s="/lib/samples" xmlns:st="jelly:stapler">
<s:layout>
<s:section title="Default">
<s:group>
Expand All @@ -17,6 +17,7 @@
</s:preview>
<s:code language="java"
code="notificationBar.show('Default')"
callback="showDefault"
executable="true"/>
</s:group>
</s:section>
Expand All @@ -37,6 +38,7 @@
</s:preview>
<s:code language="java"
code="notificationBar.show('Success', notificationBar.SUCCESS)"
callback="showSuccess"
executable="true"/>
</s:group>
</s:section>
Expand All @@ -57,6 +59,7 @@
</s:preview>
<s:code language="java"
code="notificationBar.show('Warning', notificationBar.WARNING)"
callback="showWarning"
executable="true"/>
</s:group>
</s:section>
Expand All @@ -77,14 +80,17 @@
</s:preview>
<s:code language="java"
code="notificationBar.show('Error', notificationBar.ERROR)"
callback="showError"
executable="true"/>
</s:group>
</s:section>

<s:section title="Closing notifications" description="${%usage.2}">
<s:code language="java"
code="notificationBar.hide()"
callback="hideNotification"
executable="true"/>
</s:section>
</s:layout>
<st:adjunct includes="io.jenkins.plugins.designlibrary.Notifications.adjunct" />
</j:jelly>
15 changes: 15 additions & 0 deletions src/main/resources/io/jenkins/plugins/designlibrary/sample.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,21 @@
document.addEventListener("DOMContentLoaded", () => {
const url = document.querySelector("head").dataset.rooturl;

document.querySelectorAll(".callback-button").forEach((element) => {
let callback = element.dataset.callback;
element.onclick = () => {
if (
callback &&
window[callback] &&
typeof window[callback] === "function"
) {
window[callback]();
} else {
console.warn(`Callback function ${callback} is not defined`);
}
};
});

document.querySelectorAll(".sample-remote").forEach((element) => {
const uiComponentName = element.dataset.componentName;
const fileName = element.dataset.sample;
Expand Down
20 changes: 14 additions & 6 deletions src/main/resources/lib/samples/code.jelly
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,28 +3,36 @@
<st:documentation>
Displays a copyable code snippet.

<st:attribute name="code" />
<st:attribute name="file" />
<st:attribute name="code">
Code snippet to be displayed if and only if "file" is not set.
</st:attribute>
<st:attribute name="callback">
JavaScript function to be called when the "Execute code" button is clicked.
If "code" attribute is set, these two attributes should be in sync ("code" cannot be inline JS anymore due to CSP).
</st:attribute>
<st:attribute name="file">
File containing the code snippet to be displayed.
If the "callback" attribute is set, the file will be referenced in a script tag, so that it can be invoked.
</st:attribute>
<st:attribute name="language" use="optional">
Defaults to 'xml'.
</st:attribute>
<st:attribute name="executable" type="boolean" />
<st:attribute name="previewable" type="boolean" />
</st:documentation>

<div class="jdl-component-code">
<pre class="jdl-component-code__code">
<code class="language-${language != null ? language : 'xml'} ${file != null ? 'sample-remote' : ''}" data-component-name="${it.class.simpleName}" data-sample="${file}" data-executable="${executable}">
<code class="language-${language != null ? language : 'xml'} ${file != null ? 'sample-remote' : ''}" data-component-name="${it.class.simpleName}" data-sample="${file}" data-executable="${callback != null}">
${code}
</code>
</pre>
<div class="jdl-component-code__controls">
<div>
<d:invokeBody />

<j:if test="${executable != null}">
<j:if test="${callback != null}">
<!-- This only works if the 'code' attribute is set -->
<button class="jenkins-button jenkins-button--tertiary jenkins-!-build-color" onclick="${code}" tooltip="${%Execute code}">
<button class="jenkins-button jenkins-button--tertiary jenkins-!-build-color callback-button" data-callback="${callback}" tooltip="${%Execute code}">
<l:icon src="symbol-play" />
</button>
</j:if>
Expand Down
Loading