Release 10.4.0 (#456)

* updating cache

Author: iruzevic

CHANGELOG.md

@@ -4,6 +4,15 @@ All notable changes to this project will be documented in this file.
 
 This projects adheres to [Semantic Versioning](https://semver.org/) and [Keep a CHANGELOG](https://keepachangelog.com/).
 
+## [10.4.0]
+
+### Changed
+
+- Internal caching mechanism for manifests.
+- All caching is now stored in the `eightshift` folder in the root of the theme or plugin.
+- All manifest caching is now stored on the disk and not in the transients.
+- `Render` method for faster rendering time.
+
 ## [10.3.1]
 
 ### Added
@@ -859,6 +868,7 @@ Init setup
 - Gutenberg Blocks Registration.
 - Assets Manifest data.
 
+[10.4.0]: https://github.com/infinum/eightshift-libs/compare/10.3.1...10.4.0
 [10.3.1]: https://github.com/infinum/eightshift-libs/compare/10.3.0...10.3.1
 [10.3.0]: https://github.com/infinum/eightshift-libs/compare/10.2.0...10.3.0
 [10.2.0]: https://github.com/infinum/eightshift-libs/compare/10.1.0...10.2.0

src/Cache/AbstractManifestCache.php

@@ -56,17 +56,6 @@ abstract public function getCacheName(): string;
 	 */
 	abstract public function getVersion(): string;
 
-	/**
-	 * Get cache duration.
-	 * Default is 0 = infinite.
-	 *
-	 * @return int Cache duration.
-	 */
-	public function getDuration(): int
-	{
-		return 0;
-	}
-
 	/**
 	 * Set all cache.
 	 *
@@ -78,7 +67,6 @@ public function setAllCache(): void
 			$this->getCacheBuilder(),
 			$this->getCacheName(),
 			$this->getVersion(),
-			$this->getDuration()
 		);
 	}
 

src/Helpers/CacheTrait.php

@@ -47,18 +47,18 @@ trait CacheTrait
 	private static $version = '';
 
 	/**
-	 * Cache duration.
+	 * Namespace for blocks.
 	 *
-	 * @var int
+	 * @var string
 	 */
-	private static $duration = 0;
+	private static $blocksNamespace = '';
 
 	/**
-	 * Namespace for blocks.
+	 * Cache file name.
 	 *
 	 * @var string
 	 */
-	private static $blocksNamespace = '';
+	private static $cacheFileName = '';
 
 	// -----------------------------------------------------
 	// CACHE
@@ -70,26 +70,19 @@ trait CacheTrait
 	 * @param array<mixed> $cacheBuilder Cache builder.
 	 * @param string $cacheName Cache name.
 	 * @param string $version Cache version.
-	 * @param int $duration Cache duration.
 	 *
 	 * @return void
 	 */
 	public static function setCacheDetails(
 		array $cacheBuilder,
 		string $cacheName,
-		string $version,
-		int $duration,
+		string $version
 	): void {
 		self::$cacheBuilder = $cacheBuilder;
 		self::$cacheName = $cacheName;
 		self::$version = $version;
-		self::$duration = $duration;
-
-		if (!Helpers::isCacheVersionValid() || !Helpers::shouldCache()) {
-			Helpers::deleteAllCache();
-		}
+		self::$cacheFileName = \str_replace(' ', '', "{$cacheName}Manifests{$version}.json");
 
-		Helpers::setCacheVersion();
 		Helpers::setAllCache();
 	}
 
@@ -109,30 +102,19 @@ public static function setAllCache(): void
 			return;
 		}
 
-		$data = \get_transient(Helpers::getCacheTransientName());
+		$cacheFile = Helpers::getEightshiftOutputPath(self::$cacheFileName);
 
-		if (!$data) {
-			$data = self::getAllManifests();
-
-			\set_transient(
-				Helpers::getCacheTransientName(),
-				\wp_json_encode($data),
-				self::$duration
-			);
-
-			self::$cache = $data;
+		if (\file_exists($cacheFile)) {
+			$handle = \fopen($cacheFile, 'r');
+			$output = \stream_get_contents($handle);
 
+			self::$cache = \json_decode($output, true);
 			return;
 		}
 
-		$data = \json_decode($data, true);
-		if (!$data) {
-			self::$cache = [];
-			return;
-		}
-
+		$data = self::getAllManifests();
+		\file_put_contents($cacheFile, \wp_json_encode($data)); // phpcs:ignore WordPress.WP.AlternativeFunctions.file_system_operations_file_put_contents
 		self::$cache = $data;
-
 		return;
 	}
 
@@ -156,77 +138,6 @@ public static function getCacheName(): string
 		return self::$cacheName;
 	}
 
-	/**
-	 * Get cache transient name.
-	 *
-	 * @param string $type Type of the cache.
-	 *
-	 * @return string
-	 */
-	public static function getCacheTransientName(string $type = ''): string
-	{
-		$name = AbstractManifestCache::TRANSIENT_PREFIX_NAME . '_' . self::$cacheName;
-
-		if (!$type) {
-			return $name;
-		}
-
-		return "{$name}_{$type}";
-	}
-
-	/**
-	 * Check if cache version is valid.
-	 *
-	 * @return bool
-	 */
-	public static function isCacheVersionValid(): bool
-	{
-		return self::getCacheVersion() === self::$version;
-	}
-
-	/**
-	 * Set version cache.
-	 *
-	 * @return void
-	 */
-	public static function setCacheVersion(): void
-	{
-		$name = self::getCacheTransientName(AbstractManifestCache::VERSION_KEY);
-
-		$cache = \get_transient($name);
-
-		if (!$cache) {
-			\set_transient($name, self::$version);
-		}
-	}
-
-	/**
-	 * Get cache version.
-	 *
-	 * @return string
-	 */
-	public static function getCacheVersion(): string
-	{
-		$cache = \get_transient(self::getCacheTransientName(AbstractManifestCache::VERSION_KEY)) ?: ''; // phpcs:ignore WordPress.PHP.DisallowShortTernary.Found
-
-		if (!$cache) {
-			self::setCacheVersion();
-		}
-
-		return $cache;
-	}
-
-	/**
-	 * Unset all manifest cache.
-	 *
-	 * @return void
-	 */
-	public static function deleteAllCache(): void
-	{
-		\delete_transient(self::getCacheTransientName());
-		\delete_transient(self::getCacheTransientName(AbstractManifestCache::VERSION_KEY));
-	}
-
 	/**
 	 * Check if we should cache the service classes.
 	 *
@@ -236,7 +147,7 @@ public static function shouldCache(): bool
 	{
 		return !(
 			(\defined('WP_ENVIRONMENT_TYPE') &&
-			(\WP_ENVIRONMENT_TYPE === 'development' || \WP_ENVIRONMENT_TYPE === 'local')) ||
+				(\WP_ENVIRONMENT_TYPE === 'development' || \WP_ENVIRONMENT_TYPE === 'local')) ||
 			\defined('WP_CLI')
 		);
 	}

src/Helpers/Helpers.php

@@ -98,6 +98,13 @@ class Helpers
 		'pluginRoot',
 	];
 
+	/**
+	 * Cached flipped array for faster lookups.
+	 *
+	 * @var array<string, int>|null
+	 */
+	private static ?array $allowedNamesFlipped = null;
+
 	/**
 	 * Renders a components and (optionally) passes some attributes to it.
 	 *
@@ -120,62 +127,70 @@ public static function render(
 		string $renderPrefixPath = '',
 		string $renderContent = ''
 	): string {
-		$manifest = [];
-
+		// Set default path name if not provided.
 		if (!$renderPathName) {
 			$renderPathName = Helpers::getConfigUseLegacyComponents() ? 'components' : 'blocks';
 		}
 
+		// Validate path name early.
+		if (self::$allowedNamesFlipped === null) {
+			self::$allowedNamesFlipped = \array_flip(self::PROJECT_RENDER_ALLOWED_NAMES);
+		}
+
+		if (!isset(self::$allowedNamesFlipped[$renderPathName])) {
+			throw InvalidPath::wrongOrNotAllowedParentPathException($renderPathName, \implode(', ', self::PROJECT_RENDER_ALLOWED_NAMES));
+		}
+
+		// Initialize variables.
+		$manifest = [];
+		$renderPath = '';
+		$componentName = '';
+
+		// Extract component/block name once if needed.
+		if ($renderPrefixPath && ($renderPathName === 'components' || $renderPathName === 'blocks')) {
+			$componentName = \explode(\DIRECTORY_SEPARATOR, $renderPrefixPath)[0] ?? '';
+		}
+
+		// Build path and get manifest based on path type.
 		switch ($renderPathName) {
 			case 'components':
-				$componentName = \explode(\DIRECTORY_SEPARATOR, $renderPrefixPath)[0] ?? '';
-
 				if ($componentName) {
 					$renderPath = Helpers::getProjectPaths('components', [$renderPrefixPath, "{$renderName}.php"]);
 					$manifest = Helpers::getComponent($componentName);
 				} else {
 					$renderPath = Helpers::getProjectPaths('components', [$renderPrefixPath, $renderName, "{$renderName}.php"]);
 					$manifest = Helpers::getComponent($renderName);
 				}
-
-				unset($componentName);
-
 				break;
 			case 'wrapper':
-				$manifest = Helpers::getWrapper();
 				$renderPath = Helpers::getProjectPaths('wrapper', ["{$renderName}.php"]);
+				$manifest = Helpers::getWrapper();
 				break;
 			case 'blocks':
-				$blockName = \explode(\DIRECTORY_SEPARATOR, $renderPrefixPath)[0] ?? '';
-
-				if ($blockName) {
+				if ($componentName) {
 					$renderPath = Helpers::getProjectPaths('blocks', [$renderPrefixPath, "{$renderName}.php"]);
-					$manifest = Helpers::getBlock($blockName);
+					$manifest = Helpers::getBlock($componentName);
 				} else {
 					$renderPath = Helpers::getProjectPaths('blocks', [$renderPrefixPath, $renderName, "{$renderName}.php"]);
 					$manifest = Helpers::getBlock($renderName);
 				}
-
-				unset($blockName);
 				break;
 			default:
 				$renderPath = Helpers::getProjectPaths('', [$renderPathName, $renderPrefixPath, "{$renderName}.php"]);
 				break;
 		}
 
-		if (!isset(\array_flip(self::PROJECT_RENDER_ALLOWED_NAMES)[$renderPathName])) {
-			throw InvalidPath::wrongOrNotAllowedParentPathException($renderPathName, \implode(', ', self::PROJECT_RENDER_ALLOWED_NAMES));
-		}
-
+		// Check if file exists.
 		if (!\file_exists($renderPath)) {
 			throw InvalidPath::missingFileException($renderPath);
 		}
 
-		// Merge default attributes with the component attributes.
+		// Merge default attributes with the component attributes if needed.
 		if ($renderUseComponentDefaults && !empty($manifest)) {
 			$renderAttributes = Helpers::getDefaultRenderAttributes($manifest, $renderAttributes);
 		}
 
+		// Start output buffering and include the file.
 		\ob_start();
 
 		// Allowed variables are $attributes, $renderAttributes, $renderContent, $renderPath, $manifest, $globalManifest.
@@ -184,15 +199,16 @@ public static function render(
 
 		unset(
 			$renderName,
+			$renderAttributes,
 			$renderPathName,
 			$renderUseComponentDefaults,
 			$renderPrefixPath,
+			$componentName,
 		);
 
 		include $renderPath;
 
 		unset(
-			$renderAttributes,
 			$attributes,
 			$renderContent,
 			$renderPath,
@@ -226,7 +242,7 @@ public static function getProjectPaths(string $type = '', array|string $suffix =
 			case 'root':
 				return self::joinPaths([$projectRoot, ...$suffix]);
 			case 'eightshift':
-				return self::joinPaths([$projectRoot, 'eightshift', ...$suffix]);
+				return self::joinPaths([$root, 'eightshift', ...$suffix]);
 			case 'src':
 				return self::joinPaths([$root, 'src', ...$suffix]);
 			case 'public':
@@ -285,7 +301,7 @@ public static function getEightshiftOutputPath($fileName = ''): string
 		}
 
 		if ($fileName) {
-			return $filePath . \DIRECTORY_SEPARATOR . $fileName;
+			return "{$filePath}{$fileName}";
 		}
 
 		return $filePath;