Skip to content

fix(openmetrics): Allow openmetrics in info.xml #57781

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
nickvergessen wants to merge 2 commits into
base: master
Choose a base branch
from
+64 −18
Open

fix(openmetrics): Allow openmetrics in info.xml #57781

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
45bae0e
fix(openmetrics): Allow openmetrics in info.xml
nickvergessen Jan 24, 2026
cc6f49b
fix(openmetrics): Make openmetrics always an array like all other inf…
nickvergessen Jan 24, 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
3 changes: 3 additions & 0 deletions lib/private/App/InfoParser.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -196,6 +196,9 @@ public function parse(string $file): ?array {
if (isset($array['dependencies']['backend']) && !is_array($array['dependencies']['backend'])) {
$array['dependencies']['backend'] = [$array['dependencies']['backend']];
}
if (isset($array['openmetrics']['exporter']) && !is_array($array['openmetrics']['exporter'])) {
$array['openmetrics']['exporter'] = [$array['openmetrics']['exporter']];
}

// Ensure some fields are always arrays
if (isset($array['screenshot']) && !is_array($array['screenshot'])) {
Expand Down
5 changes: 1 addition & 4 deletions lib/private/OpenMetrics/ExporterManager.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,10 +63,7 @@ public function export(): Generator {
if (!isset($appInfo[self::XML_ENTRY]) || !is_array($appInfo[self::XML_ENTRY])) {
continue;
}
foreach ($appInfo[self::XML_ENTRY] as $classEntries) {
// When multiple exporters are specified, $classEntries will be an array, instead of a string
$classnames = is_array($classEntries) ? $classEntries : [$classEntries];

foreach ($appInfo[self::XML_ENTRY] as $classnames) {
foreach ($classnames as $classname) {
if (isset($this->skippedClasses[$classname])) {
continue;
Expand Down
22 changes: 18 additions & 4 deletions resources/app-info-shipped.xsd
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,6 +67,8 @@
maxOccurs="1"/>
<xs:element name="collaboration" type="collaboration" minOccurs="0"
maxOccurs="1" />
<xs:element name="openmetrics" type="openmetrics" minOccurs="0"
maxOccurs="1" />
<xs:element name="sabre" type="sabre" minOccurs="0"
maxOccurs="1" />
<xs:element name="public" type="public" minOccurs="0"
Expand Down Expand Up @@ -408,16 +410,16 @@

<xs:complexType name="settings">
<xs:sequence>
<xs:element name="admin" minOccurs="0" maxOccurs="unbounded"/>
<xs:element name="admin" minOccurs="0" maxOccurs="unbounded"/>
<xs:element name="admin-section" type="php-class" minOccurs="0"
maxOccurs="unbounded"/>
<xs:element name="personal" type="php-class" minOccurs="0"
maxOccurs="unbounded"/>
<xs:element name="personal-section" type="php-class" minOccurs="0"
maxOccurs="unbounded"/>
<xs:element name="admin-delegation" type="php-class" minOccurs="0"
maxOccurs="unbounded"/>
<xs:element name="admin-delegation-section" type="php-class" minOccurs="0"
<xs:element name="admin-delegation" type="php-class" minOccurs="0"
maxOccurs="unbounded"/>
<xs:element name="admin-delegation-section" type="php-class" minOccurs="0"
maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>
Expand Down Expand Up @@ -529,6 +531,18 @@
</xs:restriction>
</xs:simpleType>

<xs:complexType name="openmetrics">
<xs:sequence>
<xs:element name="exporter" type="openmetrics-exporter" maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>

<xs:complexType name="openmetrics-exporter">
<xs:simpleContent>
<xs:extension base="php-class"/>
</xs:simpleContent>
</xs:complexType>

<xs:complexType name="sabre">
<xs:sequence>
<xs:element name="collections" type="sabre-collections" minOccurs="0" maxOccurs="1"/>
Expand Down
24 changes: 19 additions & 5 deletions resources/app-info.xsd
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,6 +65,8 @@
maxOccurs="1"/>
<xs:element name="collaboration" type="collaboration" minOccurs="0"
maxOccurs="1" />
<xs:element name="openmetrics" type="openmetrics" minOccurs="0"
maxOccurs="1" />
<xs:element name="sabre" type="sabre" minOccurs="0"
maxOccurs="1" />
<xs:element name="trash" type="trash" minOccurs="0"
Expand Down Expand Up @@ -404,16 +406,16 @@

<xs:complexType name="settings">
<xs:sequence>
<xs:element name="admin" minOccurs="0" maxOccurs="unbounded"/>
<xs:element name="admin-section" type="php-class" minOccurs="0"
<xs:element name="admin" minOccurs="0" maxOccurs="unbounded"/>
<xs:element name="admin-section" type="php-class" minOccurs="0"
maxOccurs="unbounded"/>
<xs:element name="personal" type="php-class" minOccurs="0"
maxOccurs="unbounded"/>
<xs:element name="personal-section" type="php-class" minOccurs="0"
maxOccurs="unbounded"/>
<xs:element name="admin-delegation" type="php-class" minOccurs="0"
maxOccurs="unbounded"/>
<xs:element name="admin-delegation-section" type="php-class" minOccurs="0"
<xs:element name="admin-delegation" type="php-class" minOccurs="0"
maxOccurs="unbounded"/>
<xs:element name="admin-delegation-section" type="php-class" minOccurs="0"
maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>
Expand Down Expand Up @@ -525,6 +527,18 @@
</xs:restriction>
</xs:simpleType>

<xs:complexType name="openmetrics">
<xs:sequence>
<xs:element name="exporter" type="openmetrics-exporter" maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>

<xs:complexType name="openmetrics-exporter">
<xs:simpleContent>
<xs:extension base="php-class"/>
</xs:simpleContent>
</xs:complexType>

<xs:complexType name="sabre">
<xs:sequence>
<xs:element name="collections" type="sabre-collections" minOccurs="0" maxOccurs="1"/>
Expand Down
6 changes: 6 additions & 0 deletions tests/data/app/expected-info.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -91,5 +91,11 @@
"admin-section": [],
"personal": [],
"personal-section": []
},
"openmetrics": {
"exporter": [
"OC\\OpenMetrics\\Exporters\\ActiveSessions",
"OC\\OpenMetrics\\Exporters\\ActiveUsers"
]
}
}
5 changes: 5 additions & 0 deletions tests/data/app/valid-info.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,4 +35,9 @@
<owncloud min-version="7.0.1" max-version="8" />
<backend>caldav</backend>
</dependencies>

<openmetrics>
<exporter>OC\OpenMetrics\Exporters\ActiveSessions</exporter>
<exporter>OC\OpenMetrics\Exporters\ActiveUsers</exporter>
</openmetrics>
</info>
7 changes: 6 additions & 1 deletion tests/data/app/various-single-item.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,5 +46,10 @@
"personal-section": []
},
"two-factor-providers": [],
"types": []
"types": [],
"openmetrics": {
"exporter": [
"OC\\OpenMetrics\\Exporters\\ActiveUsers"
]
}
}
4 changes: 4 additions & 0 deletions tests/data/app/various-single-item.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,4 +19,8 @@
<dependencies>
<nextcloud min-version="16" max-version="16"/>
</dependencies>

<openmetrics>
<exporter>OC\OpenMetrics\Exporters\ActiveUsers</exporter>
</openmetrics>
</info>
2 changes: 0 additions & 2 deletions tests/lib/App/InfoParserTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,8 +45,6 @@ public function testParsingValidXmlWithCache($expectedJson, $xmlFile): void {

public static function providesInfoXml(): array {
return [
['expected-info.json', 'valid-info.xml'],
[null, 'invalid-info.xml'],
['expected-info.json', 'valid-info.xml'],
[null, 'invalid-info.xml'],
['navigation-one-item.json', 'navigation-one-item.xml'],
Expand Down
4 changes: 2 additions & 2 deletions tests/lib/InfoXmlTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -132,8 +132,8 @@ public function testClasses($app): void {
}
}

if (isset($appInfo['openmetrics'])) {
foreach ($appInfo['openmetrics'] as $class) {
if (isset($appInfo['openmetrics']['exporter'])) {
foreach ($appInfo['openmetrics']['exporter'] as $class) {
$this->assertTrue(class_exists($class), 'Asserting exporter "' . $class . '"exists');
$exporter = Server::get($class);
$this->assertInstanceOf($class, $exporter);
Expand Down
Loading