Merge master

Author: fadrian06

.gitignore

@@ -11,3 +11,5 @@ biome.*
 node_modules/
 tests/cache/
 .coverage
+.runway-config.json
+apm.db*

.runway-config-sample.json

@@ -0,0 +1,6 @@
+{
+    "apm": {
+        "source_type": "sqlite",
+        "dest_db_dsn": "sqlite::memory:"
+    }
+}

app/config/services.php

@@ -1,6 +1,8 @@
 <?php
 
 use app\utils\Translator;
+use flight\Apm;
+use flight\apm\logger\LoggerFactory;
 use Latte\Engine as LatteEngine;
 use Latte\Essential\TranslatorExtension;
 use Latte\Loaders\FileLoader;
@@ -29,3 +31,8 @@
 
 // Parsedown is a markdown parser
 Flight::register('parsedown', Parsedown::class);
+
+// Register the APM
+$ApmLogger = LoggerFactory::create(__DIR__ . '/../../.runway-config.json');
+$Apm = new Apm($ApmLogger);
+$Apm->bindEventsToFlightInstance(Flight::app());

app/controllers/DocsController.php

@@ -6,6 +6,7 @@
 use app\utils\DocsLogic;
 use app\utils\Text;
 use Exception;
+use flight\core\EventDispatcher;
 use RecursiveDirectoryIterator;
 use RecursiveIteratorIterator;
 
@@ -171,17 +172,23 @@ public function singlePageGet(string $language, string $version) {
 
 		$Translator = $this->DocsLogic->setupTranslatorService($language, $version);
 
-        $markdown_html = $app->cache()->refreshIfExpired('single_page_html_' . $language . '_' . $version, function () use ($app, $sections, $Translator) {
-            $markdown_html = '';
-
-            foreach ($sections as $section) {
+		$cacheHit = true;
+		$cacheStartTime = microtime(true);
+		$cacheKey = 'single_page_html_' . $language . '_' . $version;
+		$markdown_html = $app->cache()->retrieve($cacheKey);
+		if ($markdown_html === null) {
+			$cacheHit = false;
+			$markdown_html = '';
+			foreach ($sections as $section) {
                 $slugged_section = Text::slugify($section);
                 $markdown_html .= '<h1><a href="/' . $section . '" id="' . $slugged_section . '">' . ucwords($section) . '</a> <a href="/' . $section . '#' . $slugged_section . '" class="bi bi-link-45deg" title="Permalink to this heading"></a></h1>';
                 $markdown_html .= $app->parsedown()->text($Translator->getMarkdownLanguageFile($section . '.md'));
             }
 
-            return $markdown_html;
-        }, 86400); // 1 day
+			$app->cache()->store($cacheKey, $markdown_html, 86400); // 1 day
+		}
+
+		$app->eventDispatcher()->trigger('flight.cache.checked', 'single_page_get_'.$cacheKey, $cacheHit, microtime(true) - $cacheStartTime);
 
         $this->DocsLogic->renderPage('single_page.latte', [
             'page_title' => 'single_page_documentation',

app/utils/CustomFlight.php

@@ -0,0 +1,20 @@
+<?php
+
+namespace app\utils;
+
+use flight\Engine;
+use flight\Cache;
+use Latte\Engine as LatteEngine;
+use Parsedown;
+use app\utils\Translator;
+
+/**
+ * This is only for autocomplete help.
+ *
+ * @method Cache cache()
+ * @method LatteEngine latte()
+ * @method Parsedown parsedown()
+ * @method Translator translator()
+ */
+class CustomEngine extends Engine {
+}

app/utils/DocsLogic.php

@@ -5,6 +5,7 @@
 use app\middleware\HeaderSecurityMiddleware;
 use DOMDocument;
 use DOMXPath;
+use flight\core\EventDispatcher;
 use flight\Engine;
 
 class DocsLogic {
@@ -60,11 +61,18 @@ public function compileSinglePage(string $language, string $version, string $sec
 
 		$Translator = $this->setupTranslatorService($language, $version);
 
-        $markdown_html = $app->cache()->refreshIfExpired($section . '_html_' . $language . '_' . $version, function() use ($app, $section, $Translator) {
+		$cacheStartTime = microtime(true);
+		$cacheHit = true;
+		$cacheKey = $section . '_html_' . $language . '_' . $version;
+		$markdown_html = $app->cache()->retrieve($cacheKey);
+		if ($markdown_html === null) {
+			$cacheHit = false;
 			$markdown_html = $app->parsedown()->text($Translator->getMarkdownLanguageFile($section . '.md'));
 			$markdown_html = Text::addClassesToElements($markdown_html);
-			return $markdown_html;
-		}, 86400); // 1 day
+			$app->cache()->store($cacheKey, $markdown_html, 86400); // 1 day
+		}
+
+		$app->eventDispatcher()->trigger('flight.cache.checked', 'compile_single_page_'.$cacheKey, $cacheHit, microtime(true) - $cacheStartTime);
 
         $markdown_html = $this->wrapContentInDiv($markdown_html);
 
@@ -88,19 +96,26 @@ public function compileScrollspyPage(string $language, string $version, string $
 
 		$Translator = $this->setupTranslatorService($language, $version);
 
-        $section_file_path = str_replace('_', '-', $section);
+		$section_file_path = str_replace('_', '-', $section);
         $sub_section_underscored = str_replace('-', '_', $sub_section);
         $heading_data = $app->cache()->retrieve($sub_section_underscored . '_heading_data_' . $language . '_' . $version);
-        $markdown_html = $app->cache()->refreshIfExpired($sub_section_underscored . '_html_' . $language . '_' . $version, function () use ($app, $section_file_path, $sub_section, $sub_section_underscored, &$heading_data, $language, $Translator, $version) {
-            $parsed_text = $app->parsedown()->text($Translator->getMarkdownLanguageFile('/' . $section_file_path . '/' . $sub_section_underscored . '.md'));
+
+		$cacheStartTime = microtime(true);
+		$cacheHit = true;
+		$cacheKey = $sub_section_underscored . '_html_' . $language . '_' . $version;
+		$markdown_html = $app->cache()->retrieve($cacheKey);
+		if ($markdown_html === null) {
+			$cacheHit = false;
+			$markdown_html = $app->parsedown()->text($Translator->getMarkdownLanguageFile('/' . $section_file_path . '/' . $sub_section_underscored . '.md'));
 
             $heading_data = [];
-            $parsed_text = Text::generateAndConvertHeaderListFromHtml($parsed_text, $heading_data, 'h2', $section_file_path.'/'.$sub_section);
-			$parsed_text = Text::addClassesToElements($parsed_text);
+            $markdown_html = Text::generateAndConvertHeaderListFromHtml($markdown_html, $heading_data, 'h2', $section_file_path.'/'.$sub_section);
+			$markdown_html = Text::addClassesToElements($markdown_html);
             $app->cache()->store($sub_section_underscored . '_heading_data_' . $language . '_' . $version, $heading_data, 86400); // 1 day
+			$app->cache()->store($cacheKey, $markdown_html, 86400); // 1 day
+		}
 
-            return $parsed_text;
-        }, 86400); // 1 day
+		$app->eventDispatcher()->trigger('flight.cache.checked', 'compile_scrollspy_page_'.$cacheKey, $cacheHit, microtime(true) - $cacheStartTime);
 
         // pull the title out of the first h1 tag
         $page_title = '';

composer.json

@@ -18,6 +18,7 @@
         "php": "^8.2",
         "ext-json": "*",
         "erusev/parsedown": "^1.7",
+        "flightphp/apm": "^0.1.1",
         "flightphp/cache": "^1.0",
         "flightphp/container": "^1.1",
         "flightphp/core": "^3.15",
@@ -37,7 +38,8 @@
             "composer check-platform-reqs"
         ],
         "post-autoload-dump": [
-            "php -r \"if (!file_exists('app/config/config.php')) copy('app/config/config_sample.php', 'app/config/config.php');\""
+            "php -r \"if (!file_exists('app/config/config.php')) copy('app/config/config_sample.php', 'app/config/config.php');\"",
+            "php -r \"if (!file_exists('.runway-config.json')) copy('.runway-config-sample.json', '.runway-config.json');\""
         ],
         "pre-update-cmd": [
             "composer check-platform-reqs"