Merge pull request #1351 from shlinkio/develop

Release 3.0.0

.dockerignore

@@ -9,6 +9,7 @@ data/GeoLite2-City*
 data/database.sqlite
 data/shlink-tests.db
 CHANGELOG.md
+CONTRIBUTING.md
 UPGRADE.md
 composer.lock
 vendor

.github/ISSUE_TEMPLATE/Bug.md

@@ -18,7 +18,7 @@ With that said, please fill in the information requested next. More information
 
 * Shlink Version: x.y.z
 * PHP Version: x.y.z
-* How do you serve Shlink: Self-hosted Apache|Self-hosted nginx|Self-hosted swoole|Docker image
+* How do you serve Shlink: Self-hosted Apache|Self-hosted nginx|Self-hosted openswoole|Docker image
 * Database engine used: MySQL|MariaDB|PostgreSQL|MicrosoftSQL|SQLite (x.y.z)
 
 #### Summary

.github/ISSUE_TEMPLATE/Question_Support.md

@@ -18,7 +18,7 @@ With that said, please fill in the information requested next. More information
 
 * Shlink Version: x.y.z
 * PHP Version: x.y.z
-* How do you serve Shlink: Self-hosted Apache|Self-hosted nginx|Self-hosted swoole|Docker image
+* How do you serve Shlink: Self-hosted Apache|Self-hosted nginx|Self-hosted openswoole|Docker image
 * Database engine used: MySQL|MariaDB|PostgreSQL|MicrosoftSQL|SQLite (x.y.z)
 
 #### Summary

.github/workflows/ci.yml

@@ -6,6 +6,7 @@ on:
     branches:
       - main
       - develop
+      - 2.x
 
 jobs:
   static-analysis:
@@ -22,7 +23,7 @@ jobs:
         with:
           php-version: ${{ matrix.php-version }}
           tools: composer
-          extensions: openswoole-4.8.1
+          extensions: openswoole-4.9.1
           coverage: none
       - run: composer install --no-interaction --prefer-dist
       - run: composer ${{ matrix.command }}
@@ -44,7 +45,7 @@ jobs:
         with:
           php-version: ${{ matrix.php-version }}
           tools: composer
-          extensions: openswoole-4.8.1
+          extensions: openswoole-4.9.1
           coverage: pcov
           ini-values: pcov.directory=module
       - run: composer install --no-interaction --prefer-dist
@@ -79,7 +80,7 @@ jobs:
         with:
           php-version: ${{ matrix.php-version }}
           tools: composer
-          extensions: openswoole-4.8.1, pdo_sqlsrv-5.10.0beta2
+          extensions: openswoole-4.9.1, pdo_sqlsrv-5.10.0beta2
           coverage: pcov
           ini-values: pcov.directory=module
       - run: composer install --no-interaction --prefer-dist
@@ -114,7 +115,7 @@ jobs:
         with:
           php-version: ${{ matrix.php-version }}
           tools: composer
-          extensions: openswoole-4.8.1
+          extensions: openswoole-4.9.1
           coverage: pcov
           ini-values: pcov.directory=module
       - run: composer install --no-interaction --prefer-dist

.github/workflows/publish-release.yml

@@ -20,7 +20,7 @@ jobs:
         with:
           php-version: ${{ matrix.php-version }}
           tools: composer
-          extensions: openswoole-4.8.1
+          extensions: openswoole-4.9.1
       - if: ${{ matrix.swoole == 'yes' }}
         run: ./build.sh ${GITHUB_REF#refs/tags/v}
       - if: ${{ matrix.swoole == 'no' }}

.github/workflows/publish-swagger-spec.yml

@@ -23,7 +23,7 @@ jobs:
         with:
           php-version: ${{ matrix.php-version }}
           tools: composer
-          extensions: openswoole-4.8.1
+          extensions: openswoole-4.9.1
           coverage: none
       - run: composer install --no-interaction --prefer-dist
       - run: composer swagger:inline

CHANGELOG.md

@@ -4,6 +4,54 @@ All notable changes to this project will be documented in this file.
 
 The format is based on [Keep a Changelog](https://keepachangelog.com), and this project adheres to [Semantic Versioning](https://semver.org).
 
+## [3.0.0] - 2022-01-28
+### Added
+* [#767](https://github.com/shlinkio/shlink/issues/767) Added full support to use emojis everywhere, whether it is custom slugs, titles, referrers, etc.
+* [#1274](https://github.com/shlinkio/shlink/issues/1274) Added support to filter short URLs lists by all provided tags.
+
+  The `GET /short-urls` endpoint now accepts a `tagsMode=all` param which will make only short URLs matching **all** the tags in the `tags[]` query param, to be returned.
+
+  The `short-urls:list` command now accepts a `-i`/`--including-all-tags` flag which behaves the same.
+
+* [#1273](https://github.com/shlinkio/shlink/issues/1273) Added support for pagination in tags lists, allowing to improve performance by loading subsets of tags.
+
+  For backwards compatibility, lists continue returning all items by default, but the `GET /tags` endpoint now supports `page` and `itemsPerPage` query params, to make sure only a subset of the tags is returned.
+
+  This is supported both when invoking the endpoint with and without `withStats=true` query param.
+
+  Additionally, the endpoint also supports filtering by `searchTerm` query param. When provided, only tags matching it will be returned.
+
+* [#1063](https://github.com/shlinkio/shlink/issues/1063) Added new endpoint that allows fetching all existing non-orphan visits, in case you need a global view of all visits received by your Shlink instance.
+
+  This can be achieved using the `GET /visits/non-orphan` endpoint.
+
+### Changed
+* [#1277](https://github.com/shlinkio/shlink/issues/1277) Reduced docker image size to 45% of the original size.
+* [#1268](https://github.com/shlinkio/shlink/issues/1268) Updated dependencies, including symfony/console 6 and mezzio/mezzio-swoole 4.
+* [#1283](https://github.com/shlinkio/shlink/issues/1283) Changed behavior of `DELETE_SHORT_URL_THRESHOLD` env var, disabling the feature if a value was not provided.
+* [#1300](https://github.com/shlinkio/shlink/issues/1300) Changed default ordering for short URLs list, returning always from newest to oldest.
+* [#1299](https://github.com/shlinkio/shlink/issues/1299) Updated to the latest base docker images, based in PHP 8.1.1, and bumped openswoole to v4.9.1.
+* [#1282](https://github.com/shlinkio/shlink/issues/1282) Env vars now have precedence over installer options.
+* [#1328](https://github.com/shlinkio/shlink/issues/1328) Refactored ShortUrlsRepository to use DTOs in methods with too many arguments.
+
+### Deprecated
+* [#1315](https://github.com/shlinkio/shlink/issues/1315) Deprecated `GET /tags?withStats=true` endpoint. Use `GET /tags/stats` instead.
+
+### Removed
+* [#1275](https://github.com/shlinkio/shlink/issues/1275) Removed everything that was deprecated in Shlink 2.x.
+
+  See [UPGRADE](UPGRADE.md#from-v2x-to-v3x) doc in order to get details on how to migrate to this version.
+
+* [#1347](https://github.com/shlinkio/shlink/issues/1347) Dropped support for regular swoole in favor of openswoole.
+
+  Since openswoole support was introduced in the previous release version, Shlink will still consider the swoole extension as openswoole, as at the moment, functionality hasn't deviated too much, and will simplify migrating to Shlink 3.0.0
+
+  However, there's no longer active testing with regular swoole, and it is considered no longer supported. If some incompatibility arises, the only supported solution will be to migrate to openswoole.
+
+### Fixed
+* *Nothing*
+
+
 ## [2.10.3] - 2022-01-23
 ### Added
 * *Nothing*
@@ -906,7 +954,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com), and this
     * Preview generation feature completely removed.
     * Authentication against REST API using JWT is no longer supported.
 
-    See [UPGRADE](UPGRADE.md) doc in order to get details on how to migrate to this version.
+    See [UPGRADE](UPGRADE.md#from-v1x-to-v2x) doc in order to get details on how to migrate to this version.
 
 ### Fixed
 * [#600](https://github.com/shlinkio/shlink/issues/600) Fixed health action so that it works with and without version in the path.

CONTRIBUTING.md

@@ -31,7 +31,7 @@ Then you will have to follow these steps:
 * Run `./indocker bin/cli db:migrate` to get database migrations up to date.
 * Run `./indocker bin/cli api-key:generate` to get your first API key generated.
 
-Once you finish this, you will have the project exposed in ports `8000` through nginx+php-fpm and `8080` through swoole.
+Once you finish this, you will have the project exposed in ports `8000` through nginx+php-fpm and `8080` through openswoole.
 
 > Note: The `indocker` shell script is a helper tool used to run commands inside the main docker container.
 
@@ -80,7 +80,7 @@ The purposes of every folder are:
 * `data`: Common runtime-generated git-ignored assets, like logs, caches, etc.
 * `docs`: Any project documentation is stored here, like API spec definitions or architectural decision records.
 * `module`: Contains a subfolder for every module in the project. Modules contain the source code, tests and configurations for every context in the project.
-* `public`: Few assets (like `favicon.ico` or `robots.txt`) and the web entry point are stored here. This web entry point is not used when serving the app with swoole.
+* `public`: Few assets (like `favicon.ico` or `robots.txt`) and the web entry point are stored here. This web entry point is not used when serving the app with openswoole.
 
 ## Project tests
 
@@ -96,7 +96,7 @@ In order to ensure stability and no regressions are introduced while developing
 
     The project provides some tooling to run them against any of the supported database engines.
 
-* **API tests**: These are E2E tests that spin up an instance of the app with swoole, and test it from the outside by interacting with the REST API.
+* **API tests**: These are E2E tests that spin up an instance of the app with openswoole, and test it from the outside by interacting with the REST API.
 
     These are the best tests to catch regressions, and to verify everything behaves as expected.
 

Dockerfile

@@ -1,8 +1,8 @@
-FROM php:8.1.0-alpine3.15 as base
+FROM php:8.1.1-alpine3.15 as base
 
 ARG SHLINK_VERSION=latest
 ENV SHLINK_VERSION ${SHLINK_VERSION}
-ENV OPENSWOOLE_VERSION 4.8.1
+ENV OPENSWOOLE_VERSION 4.9.1
 ENV PDO_SQLSRV_VERSION 5.10.0beta2
 ENV MS_ODBC_SQL_VERSION 17.5.2.2
 ENV LC_ALL "C"
@@ -11,42 +11,28 @@ WORKDIR /etc/shlink
 
 # Install required PHP extensions
 RUN \
-    # Install extensions with no extra dependencies
-    docker-php-ext-install -j"$(nproc)" pdo_mysql calendar sockets bcmath && \
-    # Install sqlite
-    apk add --no-cache sqlite-libs sqlite-dev && \
+    # Temp install dev dependencies needed to compile the extensions
+    apk add --no-cache --virtual .dev-deps sqlite-dev postgresql-dev icu-dev libzip-dev zlib-dev libpng-dev && \
+    docker-php-ext-install -j"$(nproc)" pdo_mysql pdo_pgsql intl calendar sockets bcmath zip gd && \
+    apk add --no-cache sqlite-libs && \
     docker-php-ext-install -j"$(nproc)" pdo_sqlite && \
-    # Install postgres
-    apk add --no-cache postgresql-dev && \
-    docker-php-ext-install -j"$(nproc)" pdo_pgsql && \
-    # Install intl
-    apk add --no-cache icu-dev && \
-    docker-php-ext-install -j"$(nproc)" intl && \
-    # Install zip and gd
-    apk add --no-cache libzip-dev zlib-dev libpng-dev && \
-    docker-php-ext-install -j"$(nproc)" zip gd && \
-    # Install gmp
-    apk add --no-cache gmp-dev && \
-    docker-php-ext-install -j"$(nproc)" gmp
+    # Remove temp dev extensions, and install prod equivalents that are required at runtime
+    apk del .dev-deps && \
+    apk add --no-cache postgresql icu libzip libpng
 
-# Install sqlsrv driver
-RUN if [ $(uname -m) == "x86_64" ]; then \
+# Install openswoole and sqlsrv driver for x86_64 builds
+RUN apk add --no-cache --virtual .phpize-deps ${PHPIZE_DEPS} unixodbc-dev && \
+    pecl install openswoole-${OPENSWOOLE_VERSION} && \
+    docker-php-ext-enable openswoole && \
+    if [ $(uname -m) == "x86_64" ]; then \
       wget https://download.microsoft.com/download/e/4/e/e4e67866-dffd-428c-aac7-8d28ddafb39b/msodbcsql17_${MS_ODBC_SQL_VERSION}-1_amd64.apk && \
-      apk add --allow-untrusted msodbcsql17_${MS_ODBC_SQL_VERSION}-1_amd64.apk && \
-      apk add --no-cache --virtual .phpize-deps ${PHPIZE_DEPS} unixodbc-dev && \
+      apk add --no-cache --allow-untrusted msodbcsql17_${MS_ODBC_SQL_VERSION}-1_amd64.apk && \
       pecl install pdo_sqlsrv-${PDO_SQLSRV_VERSION} && \
       docker-php-ext-enable pdo_sqlsrv && \
-      apk del .phpize-deps && \
       rm msodbcsql17_${MS_ODBC_SQL_VERSION}-1_amd64.apk ; \
-    fi
-
-# Install openswoole
-RUN apk add --no-cache --virtual .phpize-deps ${PHPIZE_DEPS} && \
-    pecl install openswoole-${OPENSWOOLE_VERSION} && \
-    docker-php-ext-enable openswoole && \
+    fi; \
     apk del .phpize-deps
 
-
 # Install shlink
 FROM base as builder
 COPY . .

README.md

@@ -6,9 +6,10 @@
 [![Latest Stable Version](https://img.shields.io/github/release/shlinkio/shlink.svg?style=flat-square)](https://packagist.org/packages/shlinkio/shlink)
 [![Docker pulls](https://img.shields.io/docker/pulls/shlinkio/shlink.svg?logo=docker&style=flat-square)](https://hub.docker.com/r/shlinkio/shlink/)
 [![License](https://img.shields.io/github/license/shlinkio/shlink.svg?style=flat-square)](https://github.com/shlinkio/shlink/blob/main/LICENSE)
+[![Twitter](https://img.shields.io/twitter/follow/shlinkio?color=blue&label=follow&logo=twitter&style=flat-square)](https://twitter.com/shlinkio)
 [![Paypal donate](https://img.shields.io/badge/Donate-paypal-blue.svg?style=flat-square&logo=paypal&colorA=aaaaaa)](https://slnk.to/donate)
 
-A PHP-based self-hosted URL shortener that can be used to serve shortened URLs under your own custom domain.
+A PHP-based self-hosted URL shortener that can be used to serve shortened URLs under your own domain.
 
 ## Table of Contents
 
@@ -26,7 +27,7 @@ This document contains the very basics to get started with Shlink. If you want t
 
 ## Docker image
 
-Starting with version 1.15.0, an official docker image is provided. You can learn how to use it by reading [the docs](https://shlink.io/documentation/install-docker-image/).
+You can learn how to use the official docker image by reading [the docs](https://shlink.io/documentation/install-docker-image/).
 
 The idea is that you can just generate a container using the image and provide the custom config via env vars.
 
@@ -36,11 +37,11 @@ First, make sure the host where you are going to run shlink fulfills these requi
 
 * PHP 8.0 or 8.1
 * The next PHP extensions: json, curl, pdo, intl, gd and gmp.
-    * apcu extension is recommended if you don't plan to use swoole or openswoole.
+    * apcu extension is recommended if you don't plan to use openswoole.
     * xml extension is required if you want to generate QR codes in svg format.
     * sockets and bcmath extensions are required if you want to integrate with a RabbitMQ instance.
 * MySQL, MariaDB, PostgreSQL, Microsoft SQL Server or SQLite.
-* The web server of your choice with PHP integration (Apache or Nginx recommended).
+* [Openswoole](https://openswoole.com/) or the web server of your choice with PHP integration (Apache or Nginx recommended).
 
 ### Download
 
@@ -50,7 +51,7 @@ In order to run Shlink, you will need a built version of the project. There are
 
     The easiest way to install shlink is by using one of the pre-bundled distributable packages.
 
-    Go to the [latest version](https://github.com/shlinkio/shlink/releases/latest) and download the `shlink*_dist.zip` file that suits your needs. You will find one for every supported PHP version and with/without swoole/openswoole integration.
+    Go to the [latest version](https://github.com/shlinkio/shlink/releases/latest) and download the `shlink*_dist.zip` file that suits your needs. You will find one for every supported PHP version and with/without openswoole integration.
 
     Finally, decompress the file in the location of your choice.
 
@@ -60,7 +61,7 @@ In order to run Shlink, you will need a built version of the project. There are
 
     * Clone the project with git (`git clone https://github.com/shlinkio/shlink.git`), or download it by clicking the **Clone or download** green button.
     * Download the [Composer](https://getcomposer.org/download/) PHP package manager inside the project folder.
-    * Run `./build.sh 1.0.0`, replacing the version with the version number you are going to build (the version number is used as part of the generated dist file name, and to set the value returned when running `shlink -V` from the command line).
+    * Run `./build.sh 3.0.0`, replacing the version with the version number you are going to build (the version number is used as part of the generated dist file name, and to set the value returned when running `shlink -V` from the command line).
 
     After that, you will have a dist file inside the `build` directory, that you need to decompress in the location of your choice.
 
@@ -72,24 +73,24 @@ Despite how you built the project, you now need to configure it, by following th
 
 * If you are going to use MySQL, MariaDB, PostgreSQL or Microsoft SQL Server, create an empty database with the name of your choice.
 * Recursively grant write permissions to the `data` directory. Shlink uses it to cache some information.
-* Setup the application by running the `bin/install` script. It is a command line tool that will guide you through the installation process. **Take into account that this tool has to be run directly on the server where you plan to host Shlink. Do not run it before uploading/moving it there.**
-* Generate your first API key by running `bin/cli api-key:generate`. You will need the key in order to interact with shlink's API.
+* Set up the application by running the `vendor/bin/shlink-installer install` script. It is a command line tool that will guide you through the installation process. **Take into account that this tool has to be run directly on the server where you plan to host Shlink. Do not run it before uploading/moving it there.**
+* Generate your first API key by running `bin/cli api-key:generate`. You will need the key in order to interact with Shlink's API.
 
 ## Using shlink
 
 Once shlink is installed, there are two main ways to interact with it:
 
-* **The command line**. Try running `bin/cli` and see all the [available commands](#shlink-cli-help).
+* **The command line**: Try running `bin/cli` to see all the available commands.
 
-    All of those commands can be run with the `--help`/`-h` flag in order to see how to use them and all the available options.
+    All of them can be run with the `--help`/`-h` flag in order to see how to use them and all the available options.
 
     It is probably a good idea to symlink the CLI entry point (`bin/cli`) to somewhere in your path, so that you can run shlink from any directory.
 
-* **The REST API**. The complete docs on how to use the API can be found [here](https://shlink.io/documentation/api-docs), and a sandbox which also documents every endpoint can be found in the [API Spec](https://api-spec.shlink.io/) portal.
+* **The REST API**: The complete docs on how to use the API can be found [here](https://shlink.io/documentation/api-docs), and a sandbox which also documents every endpoint can be found in the [API Spec](https://api-spec.shlink.io/) portal.
 
     However, you probably don't want to consume the raw API yourself. That's why a nice [web client](https://github.com/shlinkio/shlink-web-client) is provided that can be directly used from [https://app.shlink.io](https://app.shlink.io), or hosted by yourself.
 
-Both the API and CLI allow you to do the same operations, except for API key management, which can be done from the command line interface only.
+Both the API and CLI allow you to do mostly the same operations, except for API key management, which can be done from the command line interface only.
 
 ## Contributing