Skip to content

fix(exposition): export internal package for OSGi resolution #2415

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

Open
arimu1 wants to merge 4 commits into
base: main
Choose a base branch
from
Open

fix(exposition): export internal package for OSGi resolution #2415

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
687e885
fix(exposition): export internal package for OSGi resolution
arimu1 Aug 24, 2026
991921d
Merge branch 'main' into fix/2395-osgi-expositionformats-internal
jaydeluca Aug 24, 2026
bc2860e
test(exposition): assert OSGi export of internal package
arimu1 Aug 26, 2026
0e7138a
fix(exposition): drop SNAPSHOT OSGi versions and optional import
arimu1 Aug 26, 2026
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
26 changes: 26 additions & 0 deletions prometheus-metrics-exposition-formats-shaded/pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,32 @@

<build>
<plugins>
<plugin>
<groupId>org.apache.felix</groupId>
<artifactId>maven-bundle-plugin</artifactId>
<configuration>
<instructions>
<Export-Package>
io.prometheus.metrics.expositionformats.generated*
</Export-Package>
<!-- Required for OSGi: textformats loads protobuf impl via Class.forName -->
<_exportcontents>
io.prometheus.metrics.expositionformats.internal
</_exportcontents>
Comment thread
zeitlinger marked this conversation as resolved.
<Import-Package>
!com.google.protobuf,*
</Import-Package>
</instructions>
Comment thread
zeitlinger marked this conversation as resolved.
</configuration>
<executions>
<execution>
<!-- Write MANIFEST.MF in process-classes for OSGi header tests. -->
<goals>
<goal>manifest</goal>
</goals>
</execution>
</executions>
</plugin>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-resources-plugin</artifactId>
Expand Down
23 changes: 23 additions & 0 deletions prometheus-metrics-exposition-formats/pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,29 @@

<build>
<plugins>
<plugin>
<groupId>org.apache.felix</groupId>
<artifactId>maven-bundle-plugin</artifactId>
<configuration>
<instructions>
<Export-Package>
io.prometheus.metrics.expositionformats.generated*
</Export-Package>
<!-- Required for OSGi: textformats loads protobuf impl via Class.forName -->
<_exportcontents>
io.prometheus.metrics.expositionformats.internal
</_exportcontents>
</instructions>
</configuration>
<executions>
<execution>
<!-- Write MANIFEST.MF in process-classes for OSGi header tests. -->
<goals>
<goal>manifest</goal>
</goals>
</execution>
</executions>
</plugin>
<plugin>
<groupId>org.codehaus.mojo</groupId>
<artifactId>build-helper-maven-plugin</artifactId>
Expand Down
180 changes: 180 additions & 0 deletions ...formats/src/test/java/io/prometheus/metrics/expositionformats/OsgiBundleManifestTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,180 @@
package io.prometheus.metrics.expositionformats;

import static org.assertj.core.api.Assertions.assertThat;

import io.prometheus.metrics.expositionformats.internal.PrometheusProtobufWriterImpl;
import java.io.InputStream;
import java.net.URI;
import java.nio.file.Files;
import java.nio.file.Path;
import java.security.CodeSource;
import java.util.ArrayList;
import java.util.LinkedHashMap;
import java.util.List;
import java.util.Map;
import java.util.jar.JarFile;
import java.util.jar.Manifest;
import org.junit.jupiter.api.Test;

class OsgiBundleManifestTest {

private static final String INTERNAL_PACKAGE =
"io.prometheus.metrics.expositionformats.internal";
private static final String GENERATED_PREFIX =
"io.prometheus.metrics.expositionformats.generated";
private static final String SHADED_BSN = "io.prometheus.metrics-exposition-formats";
private static final String TEXTFORMATS_BSN = "io.prometheus.metrics-exposition-textformats";

@Test
void formatsBundleExportsInternalPackage() throws Exception {
Manifest manifest = loadBundleManifest(PrometheusProtobufWriterImpl.class);
assertThat(bundleSymbolicName(manifest)).contains("exposition-formats");
List<PackageClause> exported = parsePackageHeader(manifest, "Export-Package");
assertThat(names(exported)).contains(INTERNAL_PACKAGE);
assertThat(exported).anyMatch(clause -> clause.name.startsWith(GENERATED_PREFIX));
for (PackageClause clause : exported) {
if (!INTERNAL_PACKAGE.equals(clause.name) && !clause.name.startsWith(GENERATED_PREFIX)) {
continue;
}
assertThat(clause.attributes.get("version"))
.as("version of %s", clause.name)
.isNotBlank()
.doesNotContain(".SNAPSHOT")
.doesNotContain("-SNAPSHOT");
}
}

@Test
void textformatsBundleImportsInternalPackageOptionally() throws Exception {
Manifest manifest = loadBundleManifest(PrometheusProtobufWriter.class);
assertThat(bundleSymbolicName(manifest)).isEqualTo(TEXTFORMATS_BSN);
PackageClause internal =
requireClause(parsePackageHeader(manifest, "Import-Package"), INTERNAL_PACKAGE);
assertThat(internal.directives.get("resolution")).isEqualTo("optional");
}

@Test
void protobufImportMatchesShading() throws Exception {
Manifest manifest = loadBundleManifest(PrometheusProtobufWriterImpl.class);
List<String> imported = names(parsePackageHeader(manifest, "Import-Package"));
if (SHADED_BSN.equals(bundleSymbolicName(manifest))) {
assertThat(imported).doesNotContain("com.google.protobuf");
} else {
assertThat(imported).contains("com.google.protobuf");
}
}

private static String bundleSymbolicName(Manifest manifest) {
return manifest.getMainAttributes().getValue("Bundle-SymbolicName");
}

private static Manifest loadBundleManifest(Class<?> type) throws Exception {
CodeSource codeSource = type.getProtectionDomain().getCodeSource();
assertThat(codeSource).as("code source for %s", type.getName()).isNotNull();
URI location = codeSource.getLocation().toURI();
Path path = Path.of(location);
if (Files.isDirectory(path)) {
Path manifestFile = path.resolve("META-INF/MANIFEST.MF");
assertThat(Files.exists(manifestFile))
.as("bnd MANIFEST.MF for %s at %s", type.getName(), manifestFile)
.isTrue();
try (InputStream in = Files.newInputStream(manifestFile)) {
return new Manifest(in);
}
}
try (JarFile jar = new JarFile(path.toFile())) {
Manifest manifest = jar.getManifest();
assertThat(manifest).as("MANIFEST.MF in %s", path).isNotNull();
return manifest;
}
}

private static PackageClause requireClause(List<PackageClause> clauses, String packageName) {
return clauses.stream()
.filter(clause -> packageName.equals(clause.name))
.findFirst()
.orElseThrow(() -> new AssertionError("missing package clause " + packageName));
}

private static List<String> names(List<PackageClause> clauses) {
List<String> names = new ArrayList<>();
for (PackageClause clause : clauses) {
names.add(clause.name);
}
return names;
}

/** OSGi headers are comma-separated clauses; attributes may contain quoted commas. */
private static List<PackageClause> parsePackageHeader(Manifest manifest, String header) {
String value = manifest.getMainAttributes().getValue(header);
assertThat(value).as("%s", header).isNotBlank();
List<PackageClause> clauses = new ArrayList<>();
for (String rawClause : splitRespectingQuotes(value, ',')) {
List<String> parts = splitRespectingQuotes(rawClause, ';');
if (parts.isEmpty()) {
continue;
}
String name = parts.get(0).trim();
if (name.isEmpty()) {
continue;
}
Map<String, String> attributes = new LinkedHashMap<>();
Map<String, String> directives = new LinkedHashMap<>();
for (int i = 1; i < parts.size(); i++) {
String part = parts.get(i).trim();
int directiveEq = part.indexOf(":=");
int attributeEq = part.indexOf('=');
if (directiveEq >= 0 && (attributeEq < 0 || directiveEq <= attributeEq)) {
directives.put(
part.substring(0, directiveEq).trim(),
unquote(part.substring(directiveEq + 2).trim()));
} else if (attributeEq >= 0) {
attributes.put(
part.substring(0, attributeEq).trim(),
unquote(part.substring(attributeEq + 1).trim()));
}
}
clauses.add(new PackageClause(name, attributes, directives));
}
return clauses;
}

private static List<String> splitRespectingQuotes(String value, char separator) {
List<String> parts = new ArrayList<>();
StringBuilder current = new StringBuilder();
boolean inQuote = false;
for (int i = 0; i < value.length(); i++) {
char c = value.charAt(i);
if (c == '"') {
inQuote = !inQuote;
current.append(c);
} else if (!inQuote && c == separator) {
parts.add(current.toString());
current.setLength(0);
} else {
current.append(c);
}
}
parts.add(current.toString());
return parts;
}

private static String unquote(String value) {
if (value.length() >= 2 && value.charAt(0) == '"' && value.charAt(value.length() - 1) == '"') {
return value.substring(1, value.length() - 1);
}
return value;
}

static final class PackageClause {
final String name;
final Map<String, String> attributes;
final Map<String, String> directives;

PackageClause(String name, Map<String, String> attributes, Map<String, String> directives) {
this.name = name;
this.attributes = attributes;
this.directives = directives;
}
}
}
19 changes: 19 additions & 0 deletions prometheus-metrics-exposition-textformats/pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,25 @@

<build>
<plugins>
<plugin>
<groupId>org.apache.felix</groupId>
<artifactId>maven-bundle-plugin</artifactId>
<configuration>
<instructions>
<Import-Package>
io.prometheus.metrics.expositionformats.internal;resolution:=optional,*
</Import-Package>
</instructions>
</configuration>
<executions>
<execution>
<!-- Write MANIFEST.MF in process-classes for OSGi header tests. -->
<goals>
<goal>manifest</goal>
</goals>
</execution>
</executions>
</plugin>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-jar-plugin</artifactId>
Expand Down
Loading