Merge pull request #1348 from acelaya-forks/feature/drop-swoole-support

Feature/drop swoole support

.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

CHANGELOG.md

@@ -42,6 +42,12 @@ The format is based on [Keep a Changelog](https://keepachangelog.com), and this
 
   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*
 

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.
 

README.md

@@ -37,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
 
@@ -51,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.
 

UPGRADE.md

@@ -46,6 +46,7 @@
 * The docker image no longer accepts providing configuration via json files mounted in the `config/params` folder. Only env vars are supported now.
 * If you were manually serving Shlink with swoole, the entry script has to be changed from `/path/to/shlink/vendor/bin/mezzio-swoole start` to `/path/to/shlink/vendor/bin/laminas mezzio:swoole:start`
 * The `GET /{shortCode}/qr-code/{size}` url has been removed. Use `GET /{shortCode}/qr-code?size={size}` instead.
+* Regular swoole extension is no longer supported. Use openswoole instead, as a direct replacement. In most of the cases you just need to uninstall one and install the other, the rest is transparent.
 
 ## From v1.x to v2.x
 

build.sh

@@ -10,7 +10,7 @@ fi
 version=$1
 noSwoole=$2
 phpVersion=$(php -r 'echo PHP_MAJOR_VERSION . "." . PHP_MINOR_VERSION;')
-[[ $noSwoole ]] && swooleSuffix="" || swooleSuffix="_swoole"
+[[ $noSwoole ]] && swooleSuffix="" || swooleSuffix="_openswoole"
 distId="shlink${version}_php${phpVersion}${swooleSuffix}_dist"
 builtContent="./build/${distId}"
 projectdir=$(pwd)
@@ -34,7 +34,7 @@ ${composerBin} self-update
 ${composerBin} install --no-dev --prefer-dist $composerFlags
 
 if [[ $noSwoole ]]; then
-  # If generating a dist not for swoole, uninstall mezzio-swoole
+  # If generating a dist not for openswoole, uninstall mezzio-swoole
   ${composerBin} remove mezzio/mezzio-swoole --with-all-dependencies --update-no-dev $composerFlags
 fi
 

config/autoload/common.global.php

@@ -8,8 +8,8 @@ return [
 
     'debug' => false,
 
-    // Disabling config cache for cli, ensures it's never used for swoole and also that console commands don't generate
-    // a cache file that's then used by non-swoole web executions
+    // Disabling config cache for cli, ensures it's never used for openswoole and also that console commands don't
+    // generate a cache file that's then used by non-openswoole web executions
     ConfigAggregator::ENABLE_CACHE => PHP_SAPI !== 'cli',
 
 ];

data/infra/examples/shlink-daemon-logrotate.conf

@@ -1,4 +1,4 @@
-/var/log/shlink/shlink_swoole.log {
+/var/log/shlink/shlink_openswoole.log {
     su root root
     daily
     missingok
@@ -8,6 +8,6 @@
     notifempty
     create 0640 root root
     postrotate
-        /etc/init.d/shlink_swoole restart
+        /etc/init.d/shlink_openswoole restart
     endscript
 }

data/infra/examples/shlink-daemon.sh

@@ -1,26 +1,26 @@
 #!/bin/bash
 ### BEGIN INIT INFO
-# Provides:          shlink_swoole
+# Provides:          shlink_openswoole
 # Required-Start:    $local_fs $network $named $time $syslog
 # Required-Stop:     $local_fs $network $named $time $syslog
 # Default-Start:     2 3 4 5
 # Default-Stop:      0 1 6
-# Description:       Shlink non-blocking server with swoole
+# Description:       Shlink non-blocking server with openswoole
 ### END INIT INFO
 
 SCRIPT=/path/to/shlink/vendor/bin/laminas\ mezzio:swoole:start
 RUNAS=root
 
-PIDFILE=/var/run/shlink_swoole.pid
+PIDFILE=/var/run/shlink_openswoole.pid
 LOGDIR=/var/log/shlink
-LOGFILE=${LOGDIR}/shlink_swoole.log
+LOGFILE=${LOGDIR}/shlink_openswoole.log
 
 start() {
   if [[ -f "$PIDFILE" ]] && kill -0 $(cat "$PIDFILE"); then
-    echo 'Shlink with swoole already running' >&2
+    echo 'Shlink with openswoole already running' >&2
     return 1
   fi
-  echo 'Starting shlink with swoole' >&2
+  echo 'Starting shlink with openswoole' >&2
   mkdir -p "$LOGDIR"
   touch "$LOGFILE"
   local CMD="$SCRIPT &> \"$LOGFILE\" & echo \$!"
@@ -30,10 +30,10 @@ start() {
 
 stop() {
   if [[ ! -f "$PIDFILE" ]] || ! kill -0 $(cat "$PIDFILE"); then
-    echo 'Shlink with swoole not running' >&2
+    echo 'Shlink with openswoole not running' >&2
     return 1
   fi
-  echo 'Stopping shlink with swoole' >&2
+  echo 'Stopping shlink with openswoole' >&2
   kill -15 $(cat "$PIDFILE") && rm -f "$PIDFILE"
   echo 'Shlink stopped' >&2
 }

docker/README.md

@@ -5,7 +5,7 @@
 
 This image provides an easy way to set up [shlink](https://shlink.io) on a container-based runtime.
 
-It exposes a shlink instance served with [openswoole](https://www.swoole.co.uk/), which can be linked to external databases to persist data.
+It exposes a shlink instance served with [openswoole](https://openswoole.com/), which can be linked to external databases to persist data.
 
 ## Usage