From c08bf02a26643e3be05333da112f45680a3a250e Mon Sep 17 00:00:00 2001 From: Devin Nusbaum Date: Tue, 8 Nov 2022 12:42:46 -0500 Subject: [PATCH 1/3] [JENKINS-70044] Add telemetry for activation of optional permissions --- .../telemetry/impl/OptionalPermissions.java | 89 +++++++++++++++++++ 1 file changed, 89 insertions(+) create mode 100644 core/src/main/java/jenkins/telemetry/impl/OptionalPermissions.java diff --git a/core/src/main/java/jenkins/telemetry/impl/OptionalPermissions.java b/core/src/main/java/jenkins/telemetry/impl/OptionalPermissions.java new file mode 100644 index 000000000000..759937f0f748 --- /dev/null +++ b/core/src/main/java/jenkins/telemetry/impl/OptionalPermissions.java @@ -0,0 +1,89 @@ +/* + * The MIT License + * + * Copyright (c) 2022, CloudBees, Inc. + * + * Permission is hereby granted, free of charge, to any person obtaining a copy + * of this software and associated documentation files (the "Software"), to deal + * in the Software without restriction, including without limitation the rights + * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell + * copies of the Software, and to permit persons to whom the Software is + * furnished to do so, subject to the following conditions: + * + * The above copyright notice and this permission notice shall be included in + * all copies or substantial portions of the Software. + * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR + * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, + * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE + * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER + * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, + * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN + * THE SOFTWARE. + */ + +package jenkins.telemetry.impl; + +import hudson.Extension; +import hudson.model.Computer; +import hudson.model.Item; +import hudson.model.Run; +import hudson.security.Permission; +import java.time.LocalDate; +import java.util.Map; +import java.util.Set; +import java.util.TreeMap; +import jenkins.model.Jenkins; +import jenkins.telemetry.Telemetry; +import net.sf.json.JSONObject; +import org.kohsuke.accmod.Restricted; +import org.kohsuke.accmod.restrictions.NoExternalUse; + +/** + * Telemetry implementation that gathers information about optional permissions. + */ +@Extension +@Restricted(NoExternalUse.class) +public class OptionalPermissions extends Telemetry { + private static final Set OPTIONAL_PERMISSION_IDS = Set.of( + // Defined in core + Computer.EXTENDED_READ.getId(), + Item.EXTENDED_READ.getId(), + Item.WIPEOUT.getId(), + Jenkins.MANAGE.getId(), + Jenkins.SYSTEM_READ.getId(), + Run.ARTIFACTS.getId(), + // Defined in credentials + "com.cloudbees.plugins.credentials.CredentialsProvider.UseOwn", + "com.cloudbees.plugins.credentials.CredentialsProvider.UseItem"); + + @Override + public String getDisplayName() { + return "Activation of permissions that are not enabled by default"; + } + + @Override + public LocalDate getStart() { + return LocalDate.of(2022, 11, 1); + } + + @Override + public LocalDate getEnd() { + return LocalDate.of(2023, 3, 1); + } + + @Override + public JSONObject createContent() { + Map permissions = new TreeMap<>(); + for (Permission p : Permission.getAll()) { + if (OPTIONAL_PERMISSION_IDS.contains(p.getId())) { + permissions.put(p.getId(), p.getEnabled()); + } + } + JSONObject payload = new JSONObject(); + payload.put("components", buildComponentInformation()); + payload.put("permissions", permissions); + return payload; + } + +} From 1386a2b91fd2f83309ef57fa2ba07ad3bbec322c Mon Sep 17 00:00:00 2001 From: Devin Nusbaum Date: Tue, 8 Nov 2022 15:10:14 -0500 Subject: [PATCH 2/3] [JENKINS-70044] Add description.jelly for OptionalPermissions telemetry collector --- .../telemetry/impl/OptionalPermissions/description.jelly | 6 ++++++ 1 file changed, 6 insertions(+) create mode 100644 core/src/main/resources/jenkins/telemetry/impl/OptionalPermissions/description.jelly diff --git a/core/src/main/resources/jenkins/telemetry/impl/OptionalPermissions/description.jelly b/core/src/main/resources/jenkins/telemetry/impl/OptionalPermissions/description.jelly new file mode 100644 index 000000000000..e1662374b4f9 --- /dev/null +++ b/core/src/main/resources/jenkins/telemetry/impl/OptionalPermissions/description.jelly @@ -0,0 +1,6 @@ + + + Some permissions in Jenkins core and plugins are disabled by default and must be activated by setting a system property or installing a special plugin. + This trial collects information about these properties to understand how frequently they are activated. + This data will be used to understand whether these permissions are activated frequently enough to justify their maintenance cost, and to see if any of the permissions are popular enough to consider enabling them by default. + From f46823bdff626c744cd035271e1c06a0ce82b2e6 Mon Sep 17 00:00:00 2001 From: Devin Nusbaum Date: Wed, 9 Nov 2022 09:24:42 -0500 Subject: [PATCH 3/3] [JENKINS-70044] Improve phrasing in description.jelly Co-authored-by: Daniel Beck <1831569+daniel-beck@users.noreply.github.com> --- .../telemetry/impl/OptionalPermissions/description.jelly | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/core/src/main/resources/jenkins/telemetry/impl/OptionalPermissions/description.jelly b/core/src/main/resources/jenkins/telemetry/impl/OptionalPermissions/description.jelly index e1662374b4f9..bc7f4e0602bc 100644 --- a/core/src/main/resources/jenkins/telemetry/impl/OptionalPermissions/description.jelly +++ b/core/src/main/resources/jenkins/telemetry/impl/OptionalPermissions/description.jelly @@ -1,6 +1,6 @@ Some permissions in Jenkins core and plugins are disabled by default and must be activated by setting a system property or installing a special plugin. - This trial collects information about these properties to understand how frequently they are activated. + This trial collects which of these permissions are enabled and disabled, as well as the list of installed plugins. This data will be used to understand whether these permissions are activated frequently enough to justify their maintenance cost, and to see if any of the permissions are popular enough to consider enabling them by default.