Merge pull request #245 from BitBagCommerce/op-288-es-refactor

OP-288: ES refactor

.docker/fpm.conf

@@ -0,0 +1,21 @@
+[www]
+user = www-data
+group = www-data
+
+listen = /var/run/php-www.sock
+listen.owner = www-data
+listen.group = www-data
+listen.mode = 0660
+
+clear_env = no
+
+pm = dynamic
+pm.max_children = 5
+pm.start_servers = 2
+pm.min_spare_servers = 1
+pm.max_spare_servers = 3
+
+pm.status_path = /status
+catch_workers_output = yes
+
+security.limit_extensions = .php

.docker/nginx.conf

@@ -0,0 +1,48 @@
+user www-data;
+worker_processes auto;
+daemon off;
+pid /run/nginx.pid;
+
+include /etc/nginx/modules-enabled/*.conf;
+
+events {
+ worker_connections 1024;
+}
+
+http {
+ include /etc/nginx/mime.types;
+ default_type application/octet-stream;
+
+ server_tokens off;
+
+ client_max_body_size 64m;
+ sendfile on;
+ tcp_nodelay on;
+ tcp_nopush on;
+
+ gzip_vary on;
+
+ access_log /var/log/nginx/access.log;
+ error_log /var/log/nginx/error.log;
+
+ server {
+ listen 80;
+
+ root /app/tests/Application/public;
+ index index.php;
+
+ location / {
+ try_files $uri /index.php$is_args$args;
+ }
+
+ location ~ \.php$ {
+ include fastcgi_params;
+
+ fastcgi_pass unix:/var/run/php-www.sock;
+ fastcgi_split_path_info ^(.+\.php)(/.*)$;
+
+ fastcgi_param SCRIPT_FILENAME $realpath_root$fastcgi_script_name;
+ fastcgi_param DOCUMENT_ROOT $realpath_root;
+ }
+ }
+}

.docker/php.ini

@@ -0,0 +1,15 @@
+[PHP]
+memory_limit=512M
+
+[date]
+date.timezone=${PHP_DATE_TIMEZONE}
+
+[opcache]
+opcache.enable=0
+opcache.memory_consumption=256
+opcache.max_accelerated_files=20000
+opcache.validate_timestamps=0
+;opcache.preload=/app/config/preload.php
+opcache.preload_user=www-data
+opcache.jit=1255
+opcache.jit_buffer_size=256M

.docker/supervisord.conf

@@ -0,0 +1,14 @@
+[supervisord]
+nodaemon = true
+user = root
+pidfile = /run/supervisord.pid
+
+[program:nginx]
+command = /usr/sbin/nginx
+user = root
+autostart = true
+
+[program:php-fpm]
+command = /usr/sbin/php-fpm -F
+user = root
+autostart = true

.github/workflows/build.yml

@@ -22,8 +22,8 @@ jobs:
  fail-fast: false
  matrix:
  php: [ "8.1", "8.2", "8.3" ]
- symfony: [ "^5.4", "^6.0" ]
- sylius: [ "~1.12.0", "~1.13.0" ]
+ symfony: [ "^6.0" ]
+ sylius: [ "~1.13.0" ]
  node: [ "18.x", "20.x" ]
  mysql: [ "5.7", "8.0" ]
  env:

Dockerfile

@@ -0,0 +1,73 @@
+FROM ubuntu:20.04
+ARG DEBIAN_FRONTEND=noninteractive
+ARG PHP_VERSION=8.1
+ENV LC_ALL=C.UTF-8
+
+# Install basic tools
+RUN apt-get update && apt-get install -y \
+ software-properties-common \
+ curl \
+ make \
+ supervisor \
+ unzip \
+ python2 \
+ g++
+
+# Append NODE, NGINX and PHP repositories
+RUN add-apt-repository ppa:ondrej/php \
+ && add-apt-repository ppa:ondrej/nginx \
+ && curl -sL https://deb.nodesource.com/setup_14.x | bash -
+
+# Install required PHP extensions
+RUN apt-get update && apt-get install -y \
+ nodejs \
+ nginx \
+ php${PHP_VERSION} \
+ php${PHP_VERSION}-apcu \
+ php${PHP_VERSION}-calendar \
+ php${PHP_VERSION}-common \
+ php${PHP_VERSION}-cli \
+ php${PHP_VERSION}-ctype \
+ php${PHP_VERSION}-curl \
+ php${PHP_VERSION}-dom \
+ php${PHP_VERSION}-exif \
+ php${PHP_VERSION}-fpm \
+ php${PHP_VERSION}-gd \
+ php${PHP_VERSION}-intl \
+ php${PHP_VERSION}-mbstring \
+ php${PHP_VERSION}-mysql \
+ php${PHP_VERSION}-opcache \
+ php${PHP_VERSION}-pdo \
+ php${PHP_VERSION}-pgsql \
+ php${PHP_VERSION}-sqlite \
+ php${PHP_VERSION}-xml \
+ php${PHP_VERSION}-xsl \
+ php${PHP_VERSION}-yaml \
+ php${PHP_VERSION}-zip
+
+# Install Composer
+RUN curl -sS https://getcomposer.org/installer | php -- --install-dir=/usr/bin --filename composer
+
+# Cleanup
+RUN apt-get remove --purge -y software-properties-common curl && apt-get clean && rm -rf /var/lib/apt/lists/* /tmp/* /var/tmp/* /usr/share/doc/* /usr/share/man/*
+
+# Create directory for php-fpm socket
+# Link php-fpm binary file without version
+# -p Creates missing intermediate path name directories
+RUN ln -s /usr/sbin/php-fpm${PHP_VERSION} /usr/sbin/php-fpm && mkdir -p /run/php
+
+# Install yarn
+RUN npm install -g yarn && npm cache clean --force
+
+# Initialize config files
+COPY .docker/supervisord.conf /etc/supervisor/conf.d/supervisor.conf
+COPY .docker/nginx.conf /etc/nginx/nginx.conf
+COPY .docker/fpm.conf /etc/php/${PHP_VERSION}/fpm/pool.d/www.conf
+COPY .docker/php.ini /etc/php/${PHP_VERSION}/fpm/php.ini
+COPY .docker/php.ini /etc/php/${PHP_VERSION}/cli/php.ini
+
+WORKDIR /app
+
+EXPOSE 80
+
+CMD ["/usr/bin/supervisord", "-c", "/etc/supervisor/supervisord.conf"]

README.md

@@ -48,13 +48,18 @@ This **open-source plugin was developed to help the Sylius community**. If you h
 [![](https://bitbag.io/wp-content/uploads/2020/10/button-contact.png)](https://bitbag.io/contact-us/?utm_source=github&utm_medium=referral&utm_campaign=plugins_elasticsearch)
 
 
+# Requirements
+
+----
+
+This plugin requires elasticsearch server running. You can install it by following the instructions on the [official website](https://www.elastic.co/guide/en/elasticsearch/reference/current/install-elasticsearch.html).
+In plugin repository there is Docker Compose file that can be used to run Elasticsearch server.
 
 # Installation
 
 ----
 
 We work on stable, supported and up-to-date versions of packages. We recommend you to do the same.
-If you use Sylius 1.4, you might get a compatibility issue for Pagerfanta. Please read [this issue](https://github.com/BitBagCommerce/SyliusElasticsearchPlugin/issues/23) in order to proceed with a workaround.
 
 *Note*: This Plugin supports ElasticSearch 7.0 and above. If you're looking for ElasticSearch Plugin for older versions check SyliusElasticSearchPlugin in version `1.x`.
 
@@ -81,7 +86,6 @@ The final effect should look like the following:
 ```
 use BitBag\SyliusElasticsearchPlugin\Model\ProductVariantInterface as BitBagElasticsearchPluginVariant;
 use BitBag\SyliusElasticsearchPlugin\Model\ProductVariantTrait;
-use Sylius\Component\Core\Model\ProductInterface;
 use Sylius\Component\Core\Model\ProductVariantInterface as BaseProductVariantInterface;
 
 class ProductVariant extends BaseProductVariant implements BaseProductVariantInterface, BitBagElasticsearchPluginVariant
@@ -134,7 +138,7 @@ $ bin/console assets:install
 
 fos_elastica:
  clients:
- default: { host: localhost, port: 9200 }
+ default: { url: '%env(ELASTICSEARCH_URL)%' }
  indexes:
  app: ~
 ```
@@ -143,7 +147,7 @@ should become:
 
 fos_elastica:
  clients:
- default: { host: localhost, port: 9200 }
+ default: { url: '%env(ELASTICSEARCH_URL)%' }
 ```
 In the end, with an elasticsearch server running, execute following commands:
 ```
@@ -203,12 +207,35 @@ webpack_encore:
 
 
 ## Usage
-### Rendering the shop products list
+
+### Scope of the search
+
+This plugin offers a site-wide search feature and taxon search feature. It is easily extendable to add more search scopes. For example in Marketplace suite you can create Vendor specific search scope.
+
+### Searching site-wide products
+
+There is searchbar in the header of the shop. 
+
+<div align="center">
+ <img src="doc/es_browser.png" />
+</div>
+
+You can easily modify it by overriding the `@BitBagSyliusElasticsearchPlugin/Shop/Menu/_searchForm.html.twig` template or disable it by setting:
+```yml
+sylius_ui:
+ events:
+ sylius.shop.layout.header.content:
+ blocks:
+ bitbag_es_search_form:
+ enabled: false
+```
+
+### Searching taxon products
 
 When you go now to the `/{_locale}/products-list/{taxon-slug}` page, you should see a totally new set of filters. You should see something like this:
 
 <div align="center">
- <img src="https://raw.githubusercontent.com/bitbager/BitBagCommerceAssets/master/BitBagElasticesearchProductIndex.jpg" />
+ <img src="doc/es_results.png" />
 </div>
 
 You might also want to refer the horizontal menu to a new product list page. Follow below instructions to do so:
@@ -229,12 +256,52 @@ If you're using vertical menu - follow steps above with `_verticalMenu.html.twig
 You might not want to show some specific options or attributes in the menu. You can set specific parameters for that:
 ```yml
 parameters:
- bitbag_es_excluded_filter_options: []
- bitbag_es_excluded_filter_attributes: ['book_isbn', 'book_pages']
+ bitbag_es_excluded_facet_attributes: ['jeans_material']
+ bitbag_es_excluded_facet_options: ['t_shirt_size']
+```
+
+By default, all options and attributes filters are shown.
+
+It is also possible to disable options and attribute filters autodiscovery by setting the following parameters:
+```yml
+parameters:
+ bitbag_es_facets_auto_discover: false
 ```
 
-By default, all options and attributes are indexed. After you change these parameters, remember to run `bin/console fo:el:po` command again
-(a shortcut for `fos:elastica:populate`).
+Then you have to manually register your filters:
+
+Available filters:
+* [`TaxonFacet`](https://github.com/BitBagCommerce/SyliusElasticsearchPlugin/blob/master/src/Facet/TaxonFacet.php) which allows to filter your search results by taxons using the ElasticSearch [`Terms`](https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-terms-aggregation.html) aggregation.
+* [`AttributeFacet`](https://github.com/BitBagCommerce/SyliusElasticsearchPlugin/blob/master/src/Facet/AttributeFacet.php) which allows to filter your search results by product attributes values using the ElasticSearch [`Terms`](https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-terms-aggregation.html) aggregation.
+* [`OptionFacet`](https://github.com/BitBagCommerce/SyliusElasticsearchPlugin/blob/master/src/Facet/OptionFacet.php) which is the same as `AttributeFacet` but for product options.
+* [`PriceFacet`](https://github.com/BitBagCommerce/SyliusElasticsearchPlugin/blob/master/src/Facet/PriceFacet.php) which allows to filter search results by price range the ElasticSearch [`Histogram`](https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-histogram-aggregation.html) aggregation.
+
+Example of manual registration of filters:
+```yml
+services:
+ bitbag_sylius_elasticsearch_plugin.facet.attribute.t_shirt_brand:
+ class: BitBag\SyliusElasticsearchPlugin\Facet\AttributeFacet
+ arguments:
+ - '@bitbag_sylius_elasticsearch_plugin.property_name_resolver.attribute'
+ - '@=service("sylius.repository.product_attribute").findOneBy({"code": "t_shirt_brand"})'
+ - '@sylius.context.locale'
+
+ bitbag_sylius_elasticsearch_plugin.facet.registry:
+ class: BitBag\SyliusElasticsearchPlugin\Facet\Registry
+ calls:
+ - method: addFacet
+ arguments:
+ - t_shirt_brand
+ - '@bitbag_sylius_elasticsearch_plugin.facet.attribute.t_shirt_brand'
+ - method: addFacet
+ arguments:
+ - price
+ - '@bitbag_sylius_elasticsearch_plugin.facet.price'
+ - method: addFacet
+ arguments:
+ - taxon
+ - '@bitbag_sylius_elasticsearch_plugin.facet.taxon'
+```
 
 ### Reindexing
 
@@ -254,20 +321,6 @@ fos_elastica:
 
 Indexes with `bitbag_shop_product`, `bitbag_attribute_taxons` and `bitbag_option_taxons` keys are available so far.
 
-### Site-wide search
-
-This plugin offers a site-wide search feature as well. You have a search box field where you query all products indexed on ElasticSearch. When you enter a query in the search box the results will appear in the search results page.
-
-### Facets
-
-You can also add search facets (a.k.a. filters) to your search results page, both taxon and site-wide search. To do so you have to add facets to the `bitbag_sylius_elasticsearch_plugin.facet.registry` (for site-wide search) or `bitbag_sylius_elasticsearch_plugin.facet.taxon_registry` (for taxon search) service (see an example of those service definitions [here](https://github.com/BitBagCommerce/SyliusElasticsearchPlugin/blob/master/tests/Application/config/services.yaml)). A facet is a service which implements the `BitBag\SyliusElasticsearchPlugin\Facet\FacetInterface`. You can implement your own facets from scratch or you can [decorate](https://symfony.com/doc/current/service_container/service_decoration.html) one of the basic facet implementation included in this plugin, which are:
-
-* [`TaxonFacet`](https://github.com/BitBagCommerce/SyliusElasticsearchPlugin/blob/master/src/Facet/TaxonFacet.php) which allows to filter your search results by taxons using the ElasticSearch [`Terms`](https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-terms-aggregation.html) aggregation.
-* [`AttributeFacet`](https://github.com/BitBagCommerce/SyliusElasticsearchPlugin/blob/master/src/Facet/AttributeFacet.php) which allows to filter your search results by product attributes values using the ElasticSearch [`Terms`](https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-terms-aggregation.html) aggregation.
-* [`OptionFacet`](https://github.com/BitBagCommerce/SyliusElasticsearchPlugin/blob/master/src/Facet/OptionFacet.php) which is the same as `AttributeFacet` but for product options.
-* [`PriceFacet`](https://github.com/BitBagCommerce/SyliusElasticsearchPlugin/blob/master/src/Facet/PriceFacet.php) which allows to filter search results by price range the ElasticSearch [`Histogram`](https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-histogram-aggregation.html) aggregation.
-
-You can see an example of the definition of all of these facets [here](https://github.com/BitBagCommerce/SyliusElasticsearchPlugin/blob/master/tests/Application/config/services.yaml).
 
 ## Customization
 
@@ -307,10 +360,10 @@ We build **unforgettable**, consistent digital customer journeys on top of the *
 Our team is fluent in **Polish, English, German and, French**. That is why our cooperation with clients from all over the world is smooth.
 
 **Some numbers from BitBag regarding Sylius:**
-- 50+ **experts** including consultants, UI/UX designers, Sylius trained front-end and back-end developers,
-- 120+ projects **delivered** on top of Sylius,
-- 25+ **countries** of BitBag’s customers,
-- 4+ **years** in the Sylius ecosystem.
+- 70+ **experts** including consultants, UI/UX designers, Sylius trained front-end and back-end developers,
+- 150+ projects **delivered** on top of Sylius,
+- 30+ **countries** of BitBag’s customers,
+- 7+ **years** in the Sylius ecosystem.
 
 **Our services:**
 - Business audit/Consulting in the field of **strategy** development,

UPGRADE-4.0.0.md

@@ -0,0 +1,7 @@
+# UPGRADE FROM 3.* TO 4.0.0
+
+#### Changes related to facets:
+
+Since version 4 standard filters are deprecated, and replaced by facets. Facets are a more flexible and powerful way to filter products in the search engine. The main difference is that facets are not limited to the predefined values of the attribute, but they are generated based on the values of the products in the index. This means that the user can filter products by any value of the attribute, not only the predefined ones.
+
+If you still want to use the old filters, you have to manually add them in form extension - they are still in the code: `BitBag\SyliusElasticsearchPlugin\Form\Type\ProductAttributesFilterType` and `BitBag\SyliusElasticsearchPlugin\Form\Type\ProductOptionsFilterType`.

composer.json

@@ -4,10 +4,10 @@
  "description": "BitBag Elasticsearch plugin for Sylius.",
  "license": "MIT",
  "require": {
+ "php": "^8.1",
  "ext-json": "*",
- "php": "^8.0",
  "friendsofsymfony/elastica-bundle": "^6.0",
- "sylius/sylius": ">=1.12.13 || ~1.13.0",
+ "sylius/sylius": "~1.13.0",
  "symfony/property-access": "^5.4 || ^6.0",
  "symfony/webpack-encore-bundle": "^1.15",
  "symfony/proxy-manager-bridge": "^5.4 || ^6.0"
@@ -35,7 +35,7 @@
  "phpstan/phpstan-doctrine": "1.3.69",
  "phpstan/phpstan-strict-rules": "^1.3.0",
  "phpstan/phpstan-webmozart-assert": "^1.2.0",
- "phpunit/phpunit": "^10.5",
+ "phpunit/phpunit": "^9.0 || ^10.0",
  "polishsymfonycommunity/symfony-mocker-container": "^1.0",
  "robertfausk/behat-panther-extension": "^1.1",
  "sylius-labs/coding-standard": "^4.2",