Merge pull request #10973 from nextcloud/feature/crash-report-breadcrumbs

Add breadcrumb support to crash reporters

lib/composer/composer/autoload_classmap.php

@@ -328,6 +328,7 @@ return array(
     'OCP\\Share_Backend' => $baseDir . '/lib/public/Share_Backend.php',
     'OCP\\Share_Backend_Collection' => $baseDir . '/lib/public/Share_Backend_Collection.php',
     'OCP\\Share_Backend_File_Dependent' => $baseDir . '/lib/public/Share_Backend_File_Dependent.php',
+    'OCP\\Support\\CrashReport\\ICollectBreadcrumbs' => $baseDir . '/lib/public/Support/CrashReport/ICollectBreadcrumbs.php',
     'OCP\\Support\\CrashReport\\IRegistry' => $baseDir . '/lib/public/Support/CrashReport/IRegistry.php',
     'OCP\\Support\\CrashReport\\IReporter' => $baseDir . '/lib/public/Support/CrashReport/IReporter.php',
     'OCP\\SystemTag\\ISystemTag' => $baseDir . '/lib/public/SystemTag/ISystemTag.php',

lib/composer/composer/autoload_static.php

@@ -358,6 +358,7 @@ class ComposerStaticInit53792487c5a8370acc0b06b1a864ff4c
         'OCP\\Share_Backend' => __DIR__ . '/../../..' . '/lib/public/Share_Backend.php',
         'OCP\\Share_Backend_Collection' => __DIR__ . '/../../..' . '/lib/public/Share_Backend_Collection.php',
         'OCP\\Share_Backend_File_Dependent' => __DIR__ . '/../../..' . '/lib/public/Share_Backend_File_Dependent.php',
+        'OCP\\Support\\CrashReport\\ICollectBreadcrumbs' => __DIR__ . '/../../..' . '/lib/public/Support/CrashReport/ICollectBreadcrumbs.php',
         'OCP\\Support\\CrashReport\\IRegistry' => __DIR__ . '/../../..' . '/lib/public/Support/CrashReport/IRegistry.php',
         'OCP\\Support\\CrashReport\\IReporter' => __DIR__ . '/../../..' . '/lib/public/Support/CrashReport/IReporter.php',
         'OCP\\SystemTag\\ISystemTag' => __DIR__ . '/../../..' . '/lib/public/SystemTag/ISystemTag.php',

lib/private/Log.php

@@ -217,6 +217,10 @@ class Log implements ILogger {
 		if ($level >= $minLevel) {
 			$this->writeLog($app, $message, $level);
 		}
+
+		if (!is_null($this->crashReporters)) {
+			$this->crashReporters->delegateBreadcrumb($message, 'log', $context);
+		}
 	}
 
 	private function getLogLevel($context) {

lib/private/Support/CrashReport/Registry.php

@@ -23,6 +23,7 @@
 namespace OC\Support\CrashReport;
 
 use Exception;
+use OCP\Support\CrashReport\ICollectBreadcrumbs;
 use OCP\Support\CrashReport\IRegistry;
 use OCP\Support\CrashReport\IReporter;
 use Throwable;
@@ -41,6 +42,23 @@ class Registry implements IRegistry {
 		$this->reporters[] = $reporter;
 	}
 
+	/**
+	 * Delegate breadcrumb collection to all registered reporters
+	 *
+	 * @param string $message
+	 * @param string $category
+	 * @param array $context
+	 *
+	 * @since 15.0.0
+	 */
+	public function delegateBreadcrumb(string $message, string $category, array $context = []) {
+		foreach ($this->reporters as $reporter) {
+			if ($reporter instanceof ICollectBreadcrumbs) {
+				$reporter->collect($message, $category, $context);
+			}
+		}
+	}
+
 	/**
 	 * Delegate crash reporting to all registered reporters
 	 *

lib/public/Support/CrashReport/ICollectBreadcrumbs.php

@@ -0,0 +1,43 @@
+<?php
+
+declare(strict_types=1);
+
+/**
+ * @author Christoph Wurst <christoph@winzerhof-wurst.at>
+ *
+ * @license GNU AGPL version 3 or any later version
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as
+ * published by the Free Software Foundation, either version 3 of the
+ * License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ *
+ */
+
+namespace OCP\Support\CrashReport;
+
+/**
+ * @since 15.0.0
+ */
+interface ICollectBreadcrumbs extends IReporter {
+
+	/**
+	 * Collect breadcrumbs for crash reports
+	 *
+	 * @param string $message
+	 * @param string $category
+	 * @param array $context
+	 *
+	 * @since 15.0.0
+	 */
+	public function collect(string $message, string $category, array $context = []);
+
+}

lib/public/Support/CrashReport/IRegistry.php

@@ -38,6 +38,17 @@ interface IRegistry {
 	 */
 	public function register(IReporter $reporter);
 
+	/**
+	 * Delegate breadcrumb collection to all registered reporters
+	 *
+	 * @param string $message
+	 * @param string $category
+	 * @param array $context
+	 *
+	 * @since 15.0.0
+	 */
+	public function delegateBreadcrumb(string $message, string $category, array $context = []);
+
 	/**
 	 * Delegate crash reporting to all registered reporters
 	 *

tests/lib/Support/CrashReport/RegistryTest.php

@@ -26,6 +26,7 @@ namespace Test\Support\CrashReport;
 
 use Exception;
 use OC\Support\CrashReport\Registry;
+use OCP\Support\CrashReport\ICollectBreadcrumbs;
 use OCP\Support\CrashReport\IReporter;
 use Test\TestCase;
 
@@ -50,6 +51,20 @@ class RegistryTest extends TestCase {
 		$this->addToAssertionCount(1);
 	}
 
+	public function testDelegateBreadcrumbCollection() {
+		$reporter1 = $this->createMock(IReporter::class);
+		$reporter2 = $this->createMock(ICollectBreadcrumbs::class);
+		$message = 'hello';
+		$category = 'log';
+		$reporter2->expects($this->once())
+			->method('collect')
+			->with($message, $category);
+
+		$this->registry->register($reporter1);
+		$this->registry->register($reporter2);
+		$this->registry->delegateBreadcrumb($message, $category);
+	}
+
 	public function testDelegateToAll() {
 		$reporter1 = $this->createMock(IReporter::class);
 		$reporter2 = $this->createMock(IReporter::class);