Major v3.0.0 release

.dockerignore

@@ -1,13 +1,13 @@
-/vendor
-/node_modules
-/.vscode
-/public/build
-/public/hot
-/public/storage
-/public/app_images
-/storage/*.key
-/database/database.sqlite
-/storage/database.sqlite
+vendor
+node_modules
+.vscode
+.github
+public/storage
+public/uploads
+storage/logs/*
+storage/http_cache/*
+storage/debugbar/*
+storage/bar-assistant
 .env
 
 Dockerfile

.env.dist

@@ -22,8 +22,8 @@ REDIS_PORT=6379
 SCOUT_DRIVER=meilisearch
 MEILISEARCH_HOST=
 MEILISEARCH_KEY=
+MEILISEARCH_API_KEY=
 
 SANCTUM_STATEFUL_DOMAINS=
 
-#DISABLE_LOGIN=true
 PARENT_INGREDIENT_SUBSTITUTE=false

.github/workflows/build-dev-image.yml

@@ -29,6 +29,7 @@ jobs:
         uses: docker/build-push-action@v3
         with:
           context: .
+          target: dist
           platforms: linux/amd64
           push: true
           tags: barassistant/server:dev

.github/workflows/build-image.yml

@@ -12,6 +12,19 @@ jobs:
       -
         name: Checkout
         uses: actions/checkout@v3
+      -
+        name: Docker meta
+        id: meta
+        uses: docker/metadata-action@v5
+        with:
+          images: |
+            barassistant/server
+          flavor: |
+            latest=false
+          tags: |
+            type=semver,pattern={{version}}
+            type=semver,pattern={{major}}.{{minor}}
+            type=semver,pattern=v{{major}}
       -
         name: Set up QEMU
         uses: docker/setup-qemu-action@v2
@@ -29,9 +42,10 @@ jobs:
         uses: docker/build-push-action@v3
         with:
           context: .
+          target: dist
           platforms: linux/amd64,linux/arm64
           push: true
-          tags: barassistant/server:latest, barassistant/server:${{github.ref_name}}
+          tags: ${{ steps.meta.outputs.tags }}
           build-args: BAR_ASSISTANT_VERSION=${{github.ref_name}}
           cache-from: type=gha
           cache-to: type=gha,mode=max

CHANGELOG.md

@@ -1,3 +1,82 @@
+# v3.0.0
+## Multiple bars
+- Bar Assistant now supports multiple bars.
+    - With this change a lot of endpoints now require to have bar reference, this comes in a form of `bar_id` query parameter
+    - Please refer to the new schema specification to see what endpoints now require `bar_id` query parameter
+- This update also changed a lot database table schemas, so I advise you to create a backup of your data before you update to v3
+- Users can be invited or join with invite code to specific bars
+
+## Improved user control
+- Users can have one of the following roles in a bar:
+    - Guest
+        - Rate and favorite cocktails
+        - Create personal collections
+    - General
+        - Everything as "Guest"
+        - Can add cocktails and ingredients
+    - Moderator
+        - Everything as "General"
+        - Can not modify bar
+        - Can not change user roles
+    - Admin
+        - Everything as "Moderator"
+        - Full access to all bar actions
+
+## Breaking changes
+- Updated a lot of schemas, refer to openapi specification to see the changes
+- Token response is now wrapped with `data` object like the rest of the endpoints endpoint
+- Removed POST `shelf/ingredients` endpoint
+- Removed POST `shelf/ingredients/{ingredientId}` endpoint
+    - **Upgrade guide**: Use `shelf/ingredients/batch-store` endpoint
+- Removed DELETE `shelf/ingredients/{ingredientId}` endpoint
+    - **Upgrade guide**: Use `shelf/ingredients/batch-delete` endpoint
+- Removed `notes` property from `Cocktail` schema
+    - **Upgrade guide**: Use `notes/` endpoint to get users notes
+- Removed `glasses/find` endpoint
+    - **Upgrade guide**: Use `glasses/` endpoint with `filter[name]` query string
+- Removed GET `/images` endpoint
+- Removed `bar:make-admin` command
+- Removed `bar:open` command
+- Removed `bar:refresh-user-search-keys` command
+- Removed `bar:import-zip` command
+- Removed `bar:export-zip` command
+- Removed `bar:scrape` command
+- Renamed `/user` endpoint to `/profile`
+- Renamed `user_id` filter on `cocktails` endpoint to `created_user_id`
+- Renamed `user_id` filter on `ingredients` endpoint to `created_user_id`
+- Ingredient category is not required anymore when adding an ingredient
+
+## New
+- Added `bars/` endpoint
+- Added GET `notes/` endpoint
+- Stats now have users top 5 favorite ingredients, calculated from favorite cocktails
+- Importing cocktails from collection now has actions on how to handle duplicates
+- Added `bar:backup {barId}` command
+- Cocktail ingredient now supports variable amounts, you can add max amount with `amount_max` attribute
+- Cocktail ingredient now can have a note attached
+- Cocktail substitutes now have the following attributes: `ingredient_id`, `amount`, `amount_max`, `units`
+- Added options on how to handle duplicated recipes when importing collection
+    - Duplicates are matched by recipe name
+    - Possible actions:
+        - Do nothing
+        - Overwrite duplicated
+        - Skip duplicates
+- Added `average_rating_min` filter to `cocktails` endpoint
+- Added `average_rating_max` filter to `cocktails` endpoint
+
+## Changes
+- Default database filename changed to `database.ba3.sqlite`
+- Optimized base images of cocktails and ingredients
+- Cocktail and ingredient images are now categorized in folders by bar id
+- Merged all migrations to a single one
+- Meilisearch API keys are now generating tenant tokens
+- Changed the way slugs are generated, they now include bar id
+- Changed what attributes are searchable
+    - Removed from `cocktails` index: `garnish`, `image_hash`, `main_image_id`, `user_id`, `glass`, `average_rating`, `main_ingredient_name`, `calculated_abv`, `method`, `has_public_link`
+    - Added to `cocktails` index: `bar_id`
+    - Removed from `ingredients` index: `strength_abv`, `color`
+    - Added to `ingredients` index: `bar_id`
+
 # v2.6.0
 ## New
 - Added export options for version 3: `php artisan bar:export-zip --version3`
@@ -155,6 +234,7 @@
 - Updated `UserIngredient` schema
 - Updated `Ingredient` schema
     - Moved `parent_ingredient_id` to `parent_ingredient` object, accessible via `parent_ingredient.id`
+- Removed `DISABLE_LOGIN` env variable
 
 ## New
 - Meilisearch is no longer mandatory dependency for API to work
@@ -165,6 +245,8 @@
     - This will remove the need to authenticate with token to access the api
 - Added GET `/images` endpoint
 - `ImageRequest` schema now supports `image_url` parameter to upload image from URL
+- Added `MAX_USER_BARS` env variable, defaults to 50
+    - This limits how many bars can a single user create
 
 ## Fixes
 - Fixed openapi swagger docs url

Dockerfile

@@ -1,9 +1,16 @@
-FROM php:8.2-fpm
+FROM php:8.2-fpm as php-base
 
 ARG BAR_ASSISTANT_VERSION
-ENV BAR_ASSISTANT_VERSION=${BAR_ASSISTANT_VERSION:-v0-dev}
+ENV BAR_ASSISTANT_VERSION=${BAR_ASSISTANT_VERSION:-develop}
+
+ARG PGID=1000
+ENV PGID=${PGID}
+ARG PUID=1000
+ENV PUID=${PUID}
+
+# Add php extension manager
+ADD https://github.com/mlocati/docker-php-extension-installer/releases/latest/download/install-php-extensions /usr/local/bin/
 
-# Add dependencies
 RUN apt update \
     && apt-get install -y \
     git \
@@ -13,45 +20,51 @@ RUN apt update \
     nginx \
     gosu \
     && apt-get autoremove -y \
-    && apt-get clean
-
-ADD https://github.com/mlocati/docker-php-extension-installer/releases/latest/download/install-php-extensions /usr/local/bin/
-RUN chmod +x /usr/local/bin/install-php-extensions && \
-    install-php-extensions imagick opcache redis zip
-
-# Setup custom php config
-COPY ./resources/docker/php.ini $PHP_INI_DIR/php.ini
-
-# Setup nginx
-COPY ./resources/docker/nginx.conf /etc/nginx/sites-enabled/default
-RUN echo "access.log = /dev/null" >> /usr/local/etc/php-fpm.d/www.conf
-
-# Add container entrypoint script
-COPY ./resources/docker/entrypoint.sh /usr/local/bin/entrypoint
-RUN chmod +x /usr/local/bin/entrypoint
+    && apt-get clean \
+    && chmod +x /usr/local/bin/install-php-extensions && \
+    install-php-extensions imagick opcache redis zip && \
+    echo "access.log = /dev/null" >> /usr/local/etc/php-fpm.d/www.conf
 
 # Add composer
 COPY --from=composer:latest /usr/bin/composer /usr/local/bin/composer
 
-USER www-data:www-data
+FROM php-base as dist
 
 WORKDIR /var/www/cocktails
 
-COPY --chown=www-data:www-data . .
+COPY . .
 
-RUN sed -i "s/{{VERSION}}/$BAR_ASSISTANT_VERSION/g" ./docs/open-api-spec.yml
+# Configure nginx
+COPY ./resources/docker/nginx.conf /etc/nginx/sites-enabled/default
 
-RUN chmod +x /var/www/cocktails/resources/docker/run.sh
+# Configure php
+COPY ./resources/docker/php.ini $PHP_INI_DIR/php.ini
 
-RUN composer install --optimize-autoloader --no-dev
+# Add container entrypoint script
+COPY ./resources/docker/entrypoint.sh /usr/local/bin/entrypoint
 
-RUN mkdir -p /var/www/cocktails/storage/bar-assistant/
+RUN chmod +x /usr/local/bin/entrypoint \
+    && chmod +x /var/www/cocktails/resources/docker/run.sh \
+    && sed -i "s/{{VERSION}}/$BAR_ASSISTANT_VERSION/g" ./docs/open-api-spec.yml \
+    && composer install --optimize-autoloader --no-dev \
+    && mkdir -p /var/www/cocktails/storage/bar-assistant/
 
 EXPOSE 3000
 
 VOLUME ["/var/www/cocktails/storage/bar-assistant"]
 
-USER root:root
-
 ENTRYPOINT ["entrypoint"]
-CMD ["/bin/bash", "-c", "php-fpm & nginx -g 'daemon off;'"]
+
+FROM php-base as localdev
+
+RUN useradd -G www-data,root -u $PUID -d /home/developer developer
+RUN mkdir -p /home/developer/.composer && \
+    chown -R developer:developer /home/developer
+
+USER developer
+
+WORKDIR /var/www/cocktails
+
+EXPOSE 9000
+
+CMD ["php-fpm"]

README.md

@@ -25,6 +25,8 @@ This repository only contains the API server, if you are looking for easy to use
 ## Features
 - Includes all current IBA cocktails
 - Over 100 ingredients
+- Add and manage multiple bars
+- Fine grained control with user roles
 - Endpoints for managing of ingredients and cocktails
 - Mark ingredients you have and get all cocktails that you can make
 - Detailed cocktail and ingredient information
@@ -61,7 +63,6 @@ $ docker compose exec app composer install
 $ docker compose exec app php artisan key:generate
 $ docker compose exec app php artisan storage:link
 $ docker compose exec app php artisan migrate
-$ docker compose exec app php artisan bar:open
 ```
 
 Xdebug vscode launch config:

app/BarContext.php

@@ -0,0 +1,19 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Kami\Cocktail;
+
+use Kami\Cocktail\Models\Bar;
+
+class BarContext
+{
+    public function __construct(private readonly Bar $currentBar)
+    {
+    }
+
+    public function getBar(): Bar
+    {
+        return $this->currentBar;
+    }
+}