Merge pull request 'Implement a caching mechanism' (#26) from feature/cache into master

Reviewed-on: #26

.gitignore

@@ -1,5 +1,5 @@
 /vendor/
 .idea
-database.sqlite
+*.sqlite
 var/cache/
 .env.local

Dockerfile

@@ -1,8 +1,8 @@
 FROM php:8.3-cli
 
 WORKDIR /usr/src/app
-ENV PHP_MEMORY_LIMIT=512M
+ENV PHP_MEMORY_LIMIT=1500M
-RUN echo "memory_limit=512M" > /usr/local/etc/php/conf.d/memory-limit.ini
+RUN echo "memory_limit=1500M" > /usr/local/etc/php/conf.d/memory-limit.ini
 RUN apt-get update && apt-get install -y \
     git \
     unzip \

README.md

@@ -17,10 +17,17 @@
 3. Refresh cache on production by removing cache directory: `rm -rf var/cache`
 4. Start and build image in one go with command: `docker compose up -d --build --force-recreate`
 
+## Bonus 
+
+### Install composer package
+
+1. Run `bin/composer require vendor/package-name`
+
+
 ## Running Cron
 
 For now only way of running `app:scrape` command on schedule is to use host crontab.
-1. Run `crontab -e` command to edit host crontab job file
+1. Run `crontab -e` command to edit a host crontab job file
 2. Add a new line with e.g. line like this `0 1 * * * cd /var/project/directory/ && docker compose exec php-app php console.php app:scrape`
 3. Save and exit file editor. Cron will execute `app:scrape` once per day.
 

bin/cacheclean

@@ -0,0 +1,2 @@
+#!/usr/bin/env bash
+bin/cli rm -rf var/cache

bin/composer

@@ -0,0 +1,3 @@
+#!/usr/bin/env bash
+[ -z "$1" ] && echo "Please specify a Composer command (ex. install)" && exit
+bin/cli composer "$@"

composer.json

@@ -11,7 +11,9 @@
         "symfony/twig-bundle": "^7.1",
         "symfony/dotenv": "^7.1",
         "twig/intl-extra": "^3.13",
-        "twig/extra-bundle": "^3.13"
+        "twig/extra-bundle": "^3.13",
+        "symfony/cache": "^7.2",
+        "twig/cache-extra": "^3.21"
     },
     "autoload": {
         "psr-4": {

console.php

@@ -2,18 +2,16 @@
 
 include_once 'vendor/autoload.php';
 
-use Krzysiej\RyobiCrawler\Command\Migrate;
+use Krzysiej\RyobiCrawler\Kernel;
-use Krzysiej\RyobiCrawler\Command\ScrapeWebsite;
+use Symfony\Bundle\FrameworkBundle\Console\Application;
-
-use Symfony\Component\Console\Application;
 
 if (php_sapi_name() !== 'cli') {
     header('Location: browser.php');
     echo 'Execute this script in cli only';
     exit;
 }
-
+$kernel = new Kernel('dev', true);
-$application = new Application('Ryobi website scraper application', '1.1.1');
+$application = new Application($kernel);
-$application->add(new ScrapeWebsite());
+$application->setName('Ryobi website scraper application');
-$application->add(new Migrate());
+$application->setVersion('1.2.0');
 $application->run();

index.php

@@ -1,46 +1,11 @@
 <?php
 
-use Krzysiej\RyobiCrawler\Twig\AppExtension;
+use Krzysiej\RyobiCrawler\Kernel;
-use Symfony\Bundle\FrameworkBundle\Kernel\MicroKernelTrait;
-use Symfony\Component\DependencyInjection\Loader\Configurator\ContainerConfigurator;
 use Symfony\Component\Dotenv\Dotenv;
 use Symfony\Component\HttpFoundation\Request;
-use Symfony\Component\HttpKernel\Kernel as BaseKernel;
-use Symfony\Component\Routing\Loader\Configurator\RoutingConfigurator;
 
 require 'vendor/autoload.php';
 
-class Kernel extends BaseKernel
-{
-    use MicroKernelTrait;
-
-    public function registerBundles(): iterable
-    {
-        return [
-            new Symfony\Bundle\FrameworkBundle\FrameworkBundle(),
-            new Symfony\Bundle\TwigBundle\TwigBundle(),
-            new Twig\Extra\TwigExtraBundle\TwigExtraBundle(),
-        ];
-    }
-
-    protected function configureContainer(ContainerConfigurator $container): void
-    {
-        $container->extension('framework', [
-            'secret' => 'S0ME_SECRET'
-        ]);
-        $container->services()
-            ->load('Krzysiej\\RyobiCrawler\\Controller\\', __DIR__.'/src/Controller/*')
-            ->autowire()
-            ->autoconfigure()
-        ;
-        $container->services()->set(AppExtension::class)->tag('twig.extension');
-    }
-
-    protected function configureRoutes(RoutingConfigurator $routes): void
-    {
-        $routes->import(__DIR__.'/src/Controller/', 'attribute');
-    }
-}
 (new Dotenv())->bootEnv(__DIR__.'/.env');
 
 $kernel = new Kernel($_SERVER['APP_ENV'], (bool) $_SERVER['APP_DEBUG']);

src/Command/CacheWarmCommand.php

@@ -0,0 +1,84 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Krzysiej\RyobiCrawler\Command;
+
+use Symfony\Component\Console\Helper\ProgressBar;
+use Symfony\Component\HttpFoundation\Request;
+use Illuminate\Database\Capsule\Manager as Capsule;
+use Krzysiej\RyobiCrawler\Models\Product;
+use Symfony\Component\Cache\Adapter\FilesystemAdapter;
+use Symfony\Component\Console\Attribute\AsCommand;
+use Symfony\Component\Console\Command\Command;
+use Symfony\Component\Console\Input\InputInterface;
+use Symfony\Component\Console\Output\OutputInterface;
+use Symfony\Component\HttpFoundation\RequestStack;
+use Twig\Environment;
+
+#[AsCommand(name: 'app:cache:warm-twig', description: '')]
+class CacheWarmCommand extends Command
+{
+    public function __construct(
+        private Environment $twig,
+        private RequestStack $requestStack,
+        private FilesystemAdapter $cache,
+    ) {
+        parent::__construct();
+    }
+
+    public function execute(InputInterface $input, OutputInterface $output): int
+    {
+        $this->cache->clear();
+
+        $capsule = new Capsule;
+        $capsule->addConnection([
+            'driver' => 'sqlite',
+            'database' => __DIR__ . '/../../database.sqlite',
+        ]);
+        $capsule->setAsGlobal();
+        $capsule->bootEloquent();
+
+        $progress = new ProgressBar($output);
+        $progress->start();
+        $products = Product::with([
+            'price' => fn($query) => $query->orderBy('created_at', 'desc'),
+            'stock' => fn($query) => $query->orderBy('created_at', 'desc'),
+        ])->get();
+        $progress->setMaxSteps(count($products));
+
+        $request = Request::create('/cache-warm');
+        $this->requestStack->push($request);
+
+        foreach ($products as $product) {
+            $priceList = $product->price()->pluck('price');
+            $stockList = $product->stock()->pluck('stock');
+            $priceDates = $product->price()->pluck('created_at')->map(fn($date) => $date->format('Y-m-d'))->toArray();
+            $stockDates = $product->stock()->pluck('created_at')->map(fn($date) => $date->format('Y-m-d'))->toArray();
+            $this->twig->render('product.html.twig', [
+                'product' => $product,
+                'price_list' => $this->prepareChartData($priceDates, $priceList),
+                'stock_list' => $this->prepareChartData($stockDates, $stockList),
+                'price_dates' => implode("','", $priceDates),
+            ]);
+            $progress->advance();
+        }
+
+        $progress->finish();
+        $output->writeln('');
+        $output->writeln('DONE');
+
+        return Command::SUCCESS;
+    }
+
+    private function prepareChartData($set1, $set2): string
+    {
+        $data = [];
+        foreach ($set1 as $key => $value) {
+            $data[] = ['x' => $value, 'y' => $set2[$key]];
+        }
+        $stringData = json_encode($data);
+
+        return str_replace(['"x"', '"y"'], ['x', 'y'], $stringData);
+    }
+}

src/Controller/BaseController.php

@@ -3,6 +3,7 @@
 namespace Krzysiej\RyobiCrawler\Controller;
 
 use Symfony\Bundle\FrameworkBundle\Controller\AbstractController;
+use Symfony\Component\Cache\Adapter\FilesystemAdapter;
 use Twig\Environment;
 use Illuminate\Database\Capsule\Manager as Capsule;
 
@@ -10,7 +11,7 @@ class BaseController extends AbstractController
 {
     protected Environment $twig;
 
-    public function __construct()
+    public function __construct(protected FilesystemAdapter $cache)
     {
         $capsule = new Capsule;
         $capsule->addConnection(['driver' => 'sqlite', 'database' => __DIR__ . '/../../database.sqlite']);

src/Controller/CategoryController.php

@@ -11,6 +11,10 @@ final class CategoryController extends BaseController
     #[Route('/category/{category}', name: 'app_category')]
     public function __invoke(string $category): Response
     {
+        if($this->cache->getItem('list_category_'.$category)->isHit()) {
+            return $this->render('productList.html.twig', ['listType' => 'category_'.$category]);
+        }
+
         $products = Product::with('price')
             ->selectRaw('products.*')
             ->distinct('products.id')
@@ -19,6 +23,7 @@ final class CategoryController extends BaseController
             ->orderByDesc('starred')
             ->orderByDesc('created_by')
             ->get();
-        return $this->render('productList.html.twig', ['products' => $products]);
+
+        return $this->render('productList.html.twig', ['products' => $products, 'listType' => 'category_'.$category]);
     }
 }

src/Controller/DiscontinuedController.php

@@ -13,12 +13,15 @@ final class DiscontinuedController extends BaseController
     #[Route('/discontinued', name: 'app_discontinued')]
     public function __invoke(): Response
     {
+        if($this->cache->getItem('list_discontinued')->isHit()) {
+            return $this->render('productList.html.twig', ['listType' => 'discontinued']);
+        }
 
         $products = Product::where('updated_at', '<', now()->format('Y-m-d'))
             ->orderByDesc('starred')
             ->orderByDesc('created_by')
             ->with(['currentPrice'])
             ->get();
-        return $this->render('productList.html.twig', ['products' => $products]);
+        return $this->render('productList.html.twig', ['products' => $products, 'listType' => 'discontinued']);
     }
 }

src/Controller/IndexController.php

@@ -11,10 +11,14 @@ final class IndexController extends BaseController
     #[Route('/', name: 'app_home')]
     public function __invoke(): Response
     {
+        if($this->cache->getItem('list_all')->isHit()) {
+            return $this->render('productList.html.twig', ['listType' => 'all']);
+        }
         $products = Product::with(['currentStock', 'price'])
             ->orderByDesc('starred')
             ->orderByDesc('created_by')
             ->get();
-        return $this->render('productList.html.twig', ['products' => $products]);
+
+        return $this->render('productList.html.twig', ['products' => $products, 'listType' => 'all']);
     }
 }

src/Controller/NewController.php

@@ -14,11 +14,15 @@ final class NewController extends BaseController
     #[Route('/new', name: 'app_new')]
     public function __invoke(): Response
     {
+        if($this->cache->getItem('list_new')->isHit()) {
+            return $this->render('productList.html.twig', ['listType' => 'new']);
+        }
+
         $products = Product::where('created_at', '>', now()->modify('-30 days')->format('Y-m-d'))
             ->orderByDesc('starred')
             ->orderByDesc('created_by')
             ->with(['currentPrice'])
             ->get();
-        return $this->render('productList.html.twig', ['products' => $products]);
+        return $this->render('productList.html.twig', ['products' => $products, 'listType' => 'new']);
     }
 }

src/Controller/ProductController.php

@@ -3,6 +3,7 @@
 namespace Krzysiej\RyobiCrawler\Controller;
 
 use Krzysiej\RyobiCrawler\Models\Product;
+use Symfony\Component\Cache\Adapter\FilesystemAdapter;
 use Symfony\Component\HttpFoundation\Response;
 use Symfony\Component\Routing\Attribute\Route;
 use Twig\Error\LoaderError;
@@ -19,6 +20,10 @@ final class ProductController extends BaseController
     #[Route('/product/{productId<\d+>}', name: 'app_product')]
     public function __invoke(int $productId): Response
     {
+        if($this->cache->getItem('product'.$productId)->isHit()) {
+            return $this->render('product.html.twig', ['product' => ['id' => $productId]]);
+        }
+
         $product = Product::with([
             'price' => fn($query) => $query->orderBy('created_at', 'desc'),
             'stock' => fn($query) => $query->orderBy('created_at', 'desc'),

src/Controller/PromosController.php

@@ -12,11 +12,15 @@ final class PromosController extends BaseController
     #[Route('/promos', name: 'app_promos')]
     public function __invoke(): Response
     {
+        if($this->cache->getItem('list_promos')->isHit()) {
+            return $this->render('productList.html.twig', ['listType' => 'promos']);
+        }
+
         $products = Product::whereHas('currentPrice', fn(Builder $query) => $query->whereColumn('price', '<', 'productStandardPrice'))
             ->orderByDesc('starred')
             ->orderByDesc('created_by')
             ->with(['currentPrice'])
             ->get();
-        return $this->render('productList.html.twig', ['products' => $products]);
+        return $this->render('productList.html.twig', ['products' => $products, 'listType' => 'promos']);
     }
 }

src/Kernel.php

@@ -0,0 +1,53 @@
+<?php
+
+namespace Krzysiej\RyobiCrawler;
+
+use Krzysiej\RyobiCrawler\Twig\AppExtension;
+use Symfony\Bundle\FrameworkBundle\FrameworkBundle;
+use Symfony\Bundle\FrameworkBundle\Kernel\MicroKernelTrait;
+use Symfony\Bundle\TwigBundle\TwigBundle;
+use Symfony\Component\Cache\Adapter\FilesystemAdapter;
+use Symfony\Component\DependencyInjection\Loader\Configurator\ContainerConfigurator;
+use Symfony\Component\DependencyInjection\Reference;
+use Symfony\Component\HttpKernel\Kernel as BaseKernel;
+use Symfony\Component\Routing\Loader\Configurator\RoutingConfigurator;
+use Twig\Extra\Cache\CacheExtension;
+use Twig\Extra\Cache\CacheRuntime;
+use Twig\Extra\TwigExtraBundle\TwigExtraBundle;
+
+class Kernel extends BaseKernel
+{
+    use MicroKernelTrait;
+
+    public function registerBundles(): iterable
+    {
+        return [
+            new FrameworkBundle(),
+            new TwigBundle(),
+            new TwigExtraBundle(),
+        ];
+    }
+
+    protected function configureContainer(ContainerConfigurator $container): void
+    {
+        $container->extension('framework', [
+            'secret' => 'S0ME_SECRET'
+        ]);
+        $services = $container->services()->defaults()->autowire()->autoconfigure();
+        $services->load('Krzysiej\\RyobiCrawler\\Controller\\', __DIR__ . '/Controller/*');
+        $services->load('Krzysiej\\RyobiCrawler\\Command\\', __DIR__ . '/Command/*')->tag('console.command');
+        $services->set('twig.extension.cache', AppExtension::class)->tag('twig.extension');
+        $services->set(CacheExtension::class)->tag('twig.extension');
+        $services->set(FilesystemAdapter::class)->args([
+                '',      // namespace
+                0,       // default lifetime
+                __DIR__ . '/../var/cache/twig_blocks'  // custom path
+            ]);
+        $services->set('twig.runtime.cache', CacheRuntime::class)->args([new Reference(FilesystemAdapter::class)])->tag('twig.runtime');
+    }
+
+    protected function configureRoutes(RoutingConfigurator $routes): void
+    {
+        $routes->import(__DIR__ . '/Controller/', 'attribute');
+    }
+}

src/Twig/AppExtension.php

@@ -19,6 +19,7 @@ class AppExtension extends AbstractExtension
     {
         return [
             new TwigFunction('promosCount', [$this, 'promosCount']),
+            new TwigFunction('allCount', [$this, 'allCount']),
             new TwigFunction('newCount', [$this, 'newCount']),
             new TwigFunction('discontinuedCount', [$this, 'discontinuedCount']),
         ];
@@ -30,10 +31,14 @@ class AppExtension extends AbstractExtension
             new TwigFilter('findByCreatedAtDate', [$this, 'findByCreatedAtDate']),
         ];
     }
+    public function allCount(): int
+    {
+        return Product::count();
+    }
 
     public function promosCount(): int
     {
-        return Product::whereHas('currentPrice', fn(Builder $query) => $query->whereColumn('price', '<', 'productStandardPrice'))->with(['currentPrice'])->count();
+        return Product::whereHas('currentPrice', fn(Builder $query) => $query->whereColumn('price', '<', 'productStandardPrice'))->count();
     }
 
     public function newCount(): int

templates/product.html.twig

@@ -1,6 +1,7 @@
 {% extends "template.html.twig" %}
 
 {% block content %}
+{% cache 'product' ~ product.id %}
     <div class="table-responsive">
         <table class='table table-hover'>
             <tr>
@@ -129,5 +130,6 @@
             }
         });
     </script>
+{% endcache %}
 {% endblock %}
 

templates/productList.html.twig

@@ -1,6 +1,7 @@
 {% extends "template.html.twig" %}
 
 {% block content %}
+{% cache 'list_' ~ listType %}
 <div class="table-responsive">
     <table class='table table-hover'>
         <thead>
@@ -57,4 +58,5 @@
         {% endfor %}
     </table>
 </div>
+{% endcache %}
 {% endblock %}

templates/template.html.twig

@@ -18,6 +18,10 @@
         </button>
         <div class="collapse navbar-collapse" id="navbarNav">
             <ul class="navbar-nav me-auto mb-2 mb-lg-0">
+                {% cache "menu_count" %}
+                    <li class="nav-item">
+                        <a class="nav-link {% if app.request.pathinfo == path('app_home') %}active shadow-sm bg-body rounded{% endif %}" aria-current="page" href="{{ path('app_home') }}">All products <span class="badge text-bg-secondary">{{ allCount() }}</span></a>
+                    </li>
                     <li class="nav-item">
                         <a class="nav-link {% if app.request.pathinfo == path('app_promos') %}active shadow-sm bg-body rounded{% endif %}" aria-current="page" href="{{ path('app_promos') }}">Promos <span class="badge text-bg-secondary">{{ promosCount() }}</span></a>
                     </li>
@@ -27,6 +31,7 @@
                     <li class="nav-item">
                         <a class="nav-link {% if app.request.pathinfo == path('app_discontinued') %}active shadow-sm bg-body rounded{% endif %}" aria-current="page" href="{{ path('app_discontinued') }}">Discontinued <span class="badge text-bg-secondary">{{ discontinuedCount() }}</span></a>
                     </li>
+                {% endcache %}
             </ul>
 
             <form class="form-floating d-flex col-lg-6 col-sm-8" role="search" action="{{ path('app_search') }}">