Merge pull request #604 from shlinkio/develop

Release v2

.gitattributes

@@ -5,8 +5,6 @@
 /module/CLI/test-resources export-ignore
 /module/Core/test export-ignore
 /module/Core/test-db export-ignore
-/module/PreviewGenerator/test export-ignore
-/module/PreviewGenerator/test-db export-ignore
 /module/Rest/test export-ignore
 /module/Rest/test-api export-ignore
 .gitattributes export-ignore

.phpstorm.meta.php

@@ -2,7 +2,7 @@
 namespace PHPSTORM_META;
 
 use Psr\Container\ContainerInterface;
-use Zend\ServiceManager\ServiceLocatorInterface;
+use Laminas\ServiceManager\ServiceLocatorInterface;
 
 /**
  * PhpStorm Container Interop code completion

.travis.yml

@@ -5,14 +5,8 @@ branches:
     - /.*/
 
 php:
-  - '7.2'
-  - '7.3'
   - '7.4'
 
-matrix:
-  allow_failures:
-    - php: '7.4'
-
 services:
   - mysql
   - postgresql
@@ -39,7 +33,7 @@ before_script:
 
 script:
   - composer ci
-  - if [[ ! -z "$DOCKERFILE_CHANGED" && "${TRAVIS_PHP_VERSION}" == "7.2" ]]; then docker build -t shlink-docker-image:temp . ; fi
+  - if [[ ! -z "$DOCKERFILE_CHANGED" && "${TRAVIS_PHP_VERSION}" == "7.4" ]]; then docker build -t shlink-docker-image:temp . ; fi
 
 after_success:
   - rm -f build/clover.xml
@@ -61,4 +55,4 @@ deploy:
     skip_cleanup: true
     on:
       tags: true
-      php: '7.2'
+      php: '7.4'

CHANGELOG.md

@@ -4,6 +4,39 @@ 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).
 
+## 2.0.0 - 2020-01-08
+
+#### Added
+
+* [#429](https://github.com/shlinkio/shlink/issues/429) Added support for PHP 7.4
+* [#529](https://github.com/shlinkio/shlink/issues/529) Created an UPGRADING.md file explaining how to upgrade from v1.x to v2.x
+* [#594](https://github.com/shlinkio/shlink/issues/594) Updated external shlink packages, including installer v4.0, which adds the option to ask for the redis cluster config.
+
+#### Changed
+
+* [#592](https://github.com/shlinkio/shlink/issues/592) Updated coding styles to use [shlinkio/php-coding-standard](https://github.com/shlinkio/php-coding-standard) v2.1.0.
+* [#530](https://github.com/shlinkio/shlink/issues/530) Migrated project from deprecated `zendframework` components to the new `laminas` and `mezzio` ones.
+
+#### Deprecated
+
+* *Nothing*
+
+#### Removed
+
+* [#429](https://github.com/shlinkio/shlink/issues/429) Dropped support for PHP 7.2 and 7.3
+
+* [#229](https://github.com/shlinkio/shlink/issues/229) Remove everything which was deprecated, including:
+
+    * 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.
+
+#### Fixed
+
+* [#600](https://github.com/shlinkio/shlink/issues/600) Fixed health action so that it works with and without version in the path.
+
+
 ## 1.21.1 - 2020-01-02
 
 #### Added

Dockerfile

@@ -1,7 +1,7 @@
-FROM php:7.3.11-alpine3.10
+FROM php:7.4.1-alpine3.10
 LABEL maintainer="Alejandro Celaya <[email protected]>"
 
-ARG SHLINK_VERSION=1.20.2
+ARG SHLINK_VERSION=2.0.0
 ENV SHLINK_VERSION ${SHLINK_VERSION}
 ENV SWOOLE_VERSION 4.4.12
 ENV COMPOSER_VERSION 1.9.1

LICENSE

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2016-2019 Alejandro Celaya
+Copyright (c) 2016-2020 Alejandro Celaya
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -9,6 +9,8 @@
 
 A PHP-based self-hosted URL shortener that can be used to serve shortened URLs under your own custom domain.
 
+> This document references Shlink 2.x. If you are using an older version and want to upgrade, follow the [UPGRADE](UPGRADE.md) doc.
+
 ## Table of Contents
 
 - [Installation](#installation)
@@ -29,7 +31,7 @@ A PHP-based self-hosted URL shortener that can be used to serve shortened URLs u
 
 First, make sure the host where you are going to run shlink fulfills these requirements:
 
-* PHP 7.2 or greater with JSON, APCu, intl, curl, PDO and gd extensions enabled.
+* PHP 7.4 or greater with JSON, APCu, intl, curl, PDO and gd extensions enabled.
 * MySQL, MariaDB, PostgreSQL or SQLite.
 * The web server of your choice with PHP integration (Apache or Nginx recommended).
 
@@ -121,7 +123,7 @@ Once Shlink is configured, you need to expose it to the web, either by using a t
 
     First you need to install the swoole PHP extension with [pecl](https://pecl.php.net/package/swoole), `pecl install swoole`.
 
-    Once installed, it's actually pretty easy to get shlink up and running with swoole. Run `./vendor/bin/zend-expressive-swoole start -d` and you will get shlink running on port 8080.
+    Once installed, it's actually pretty easy to get shlink up and running with swoole. Run `./vendor/bin/mezzio-swoole start -d` and you will get shlink running on port 8080.
 
     However, by doing it this way, you are loosing all the access logs, and the service won't be automatically run if the server has to be restarted.
 
@@ -138,7 +140,7 @@ Once Shlink is configured, you need to expose it to the web, either by using a t
     # Description:       Shlink non-blocking server with swoole
     ### END INIT INFO
 
-    SCRIPT=/path/to/shlink/vendor/bin/zend-expressive-swoole\ start
+    SCRIPT=/path/to/shlink/vendor/bin/mezzio-swoole\ start
     RUNAS=root
 
     PIDFILE=/var/run/shlink_swoole.pid
@@ -197,31 +199,11 @@ Finally access to [https://app.shlink.io](https://app.shlink.io) and configure y
 
 ### Bonus
 
-Depending on the shlink version you installed and how you serve it, there are a couple of time-consuming tasks that shlink expects you to do manually, or at least it is recommended, since it will improve runtime performance.
-
-Those tasks can be performed using shlink's CLI tool, so it should be easy to schedule them to be run in the background (for example, using cron jobs):
-
-* **For shlink older than 1.18.0 or not using swoole to serve it**: Resolve IP address locations: `/path/to/shlink/bin/cli visit:locate`
-
-    If you don't run this command regularly, the stats will say all visits come from *unknown* locations.
-
-    > If you serve Shlink with swoole and use v1.18.0 at least, visit location is automatically scheduled by Shlink just after the visit occurs, using swoole's task system.
-
-* **For shlink older than v1.17.0**: Update IP geolocation database: `/path/to/shlink/bin/cli visit:update-db`
-
-    When shlink is installed it downloads a fresh [GeoLite2](https://dev.maxmind.com/geoip/geoip2/geolite2/) db file. Running this command will update this file.
-
-    The file is updated the first Tuesday of every month, so it should be enough running this command the first Wednesday.
-
-    > You don't need this if you use Shlink v1.17.0 or newer, since now it downloads/updates the geolocation database automatically just before trying to use it.
-
-* Generate website previews: `/path/to/shlink/bin/cli short-url:process-previews`
-
-    Running this will improve the performance of the `doma.in/abc123/preview` URLs, which return a preview of the site.
+Geo-locating visits to your short links is a time-consuming task. When serving Shlink with swoole, the geo-location task is automatically run asynchronously just after a visit to a short URL happens.
 
-    > **Important!** Generating previews is considered deprecated and the feature will be removed in Shlink v2.
+However, if you are not serving Shlink with swoole, you will have to schedule the geo-location task to be run regularly in the background (for example, using cron jobs):
 
-*Any of these commands accept the `-q` flag, which makes it not display any output. This is recommended when configuring the commands as cron jobs.*
+The command you need to run is `/path/to/shlink/bin/cli visit:locate`, and you can optionally provide the `-q` flag to remove any output and avoid your cron logs to be polluted.
 
 ## Update to new version
 
@@ -274,33 +256,28 @@ Options:
   -v|vv|vvv, --verbose  Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug
 
 Available commands:
-  help                        Displays help for a command
-  list                        Lists commands
+  help                Displays help for a command
+  list                Lists commands
  api-key
-  api-key:disable             Disables an API key.
-  api-key:generate            Generates a new valid API key.
-  api-key:list                Lists all the available API keys.
- config
-  config:generate-charset     [DEPRECATED] Generates a character set sample just by shuffling the default one, "0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ". Then it can be set in the SHORTCODE_CHARS environment variable
-  config:generate-secret      [DEPRECATED] Generates a random secret string that can be used for JWT token encryption
+  api-key:disable     Disables an API key.
+  api-key:generate    Generates a new valid API key.
+  api-key:list        Lists all the available API keys.
  db
-  db:create                   Creates the database needed for shlink to work. It will do nothing if the database already exists
-  db:migrate                  Runs database migrations, which will ensure the shlink database is up to date.
+  db:create           Creates the database needed for shlink to work. It will do nothing if the database already exists
+  db:migrate          Runs database migrations, which will ensure the shlink database is up to date.
  short-url
-  short-url:delete            [short-code:delete] Deletes a short URL
-  short-url:generate          [shortcode:generate|short-code:generate] Generates a short URL for provided long URL and returns it
-  short-url:list              [shortcode:list|short-code:list] List all short URLs
-  short-url:parse             [shortcode:parse|short-code:parse] Returns the long URL behind a short code
-  short-url:process-previews  [shortcode:process-previews|short-code:process-previews] [DEPRECATED] Processes and generates the previews for every URL, improving performance for later web requests.
-  short-url:visits            [shortcode:visits|short-code:visits] Returns the detailed visits information for provided short code
+  short-url:delete    Deletes a short URL
+  short-url:generate  Generates a short URL for provided long URL and returns it
+  short-url:list      List all short URLs
+  short-url:parse     Returns the long URL behind a short code
+  short-url:visits    Returns the detailed visits information for provided short code
  tag
-  tag:create                  Creates one or more tags.
-  tag:delete                  Deletes one or more tags.
-  tag:list                    Lists existing tags.
-  tag:rename                  Renames one existing tag.
+  tag:create          Creates one or more tags.
+  tag:delete          Deletes one or more tags.
+  tag:list            Lists existing tags.
+  tag:rename          Renames one existing tag.
  visit
-  visit:locate                [visit:process] Resolves visits origin locations.
-  visit:update-db             [DEPRECATED] Updates the GeoLite2 database file used to geolocate IP addresses
+  visit:locate        Resolves visits origin locations.
 ```
 
 > This product includes GeoLite2 data created by MaxMind, available from [https://www.maxmind.com](https://www.maxmind.com)

UPGRADE.md

@@ -0,0 +1,70 @@
+# Upgrading
+
+## From v1.x to v2.x
+
+### Preview generation
+
+The ability to generate website previews has been completely removed and has no replacement.
+
+The feature never properly worked, and it wasn't really useful. Because of that, the feature is no longer available on Shlink 2.x
+
+Removing this feature has these implications:
+
+* The `short-url:process-previews` CLI command no longer exists, and an error will be thrown if executed.
+* The `/{shortCode}/preview` path is no longer valid, and will return a 404 status.
+
+### Removed paths
+
+These routes have been removed, but have a direct replacement:
+
+* `/qr/{shortCode}[/{size}]` -> `/{shortCode}/qr-code[/{size}]`
+* `PUT /rest/v{version}/short-urls/{shortCode}` -> `PATCH /rest/v{version}/short-urls/{shortCode}`
+
+When using the old ones, a 404 status will me returned now.
+
+### Removed command and route aliases
+
+All the aliases for the CLI commands in the `short-urls` namespace have been removed. If you were using any of those commands with the `shortcode` or `short-code` prefixes, make sure to update them to use the `short-urls` prefix instead.
+
+The same happens for all REST endpoints starting with `/short-code`. They were previously aliased to `/short-urls` ones, but they will return a 404 now. Make sure to update them accordingly.
+
+### JWT authentication removed
+
+Shlink's REST API no longer accepts authentication using a JWT token. The API key has to be passed now in the `x-api-key` header.
+
+Removing this feature has these implications:
+
+* Shlink will no longer introspect the `Authorization` header for Bearer tokens.
+* The `POST /rest/v{version}/authenticate` endpoint no longer exists and will return a 404.
+
+### API version is now required
+
+Endpoints need to provide a version in the path now. Previously, not providing a version used to fall back to v1. Now, it will return a 404 status, as no route will match.
+
+The only exception is the `/rest/health` endpoint, which will continue working without the version.
+
+### Changes in models
+
+The next REST API models have changed:
+
+* **ShortUrl**: The `originalUrl` property was deprecated and has been removed. Use `longUrl` instead.
+* **Visit**: The `remoteAddr` property was deprecated and has been removed. It has no replacement.
+* **VisitLocation**: The `latitude` and `longitude` properties are no longer strings, but float.
+
+### URL validation
+
+Shlink can verify provided long URLs are valid before trying to shorten them. Starting with v2, it no longer does it by default and needs to be explicitly enabled instead of explicitly disabled.
+
+### Removed config options
+
+The `not_found_redirect_to` config option and the `NOT_FOUND_REDIRECT_TO` env var are no longer taken into consideration for the docker image.
+
+Instead, use `invalid_short_url_redirect_to` and `INVALID_SHORT_URL_REDIRECT_TO` respectively.
+
+### Migrated to Laminas
+
+The project has been using Zend Framework components since the beginning. Since it has been re-branded as [Laminas](https://getlaminas.org/), this version updates to the new set of components.
+
+Updating to Laminas components has these implications:
+
+* If you were manually serving Shlink with swoole, the entry script has to be changed from `/path/to/shlink/vendor/bin/zend-expressive-swoole` to `/path/to/shlink/vendor/bin/mezzio-swoole`

bin/install

@@ -8,5 +8,5 @@ use function chdir;
 use function dirname;
 
 chdir(dirname(__DIR__));
-$run = require __DIR__ . '/../vendor/shlinkio/shlink-installer/bin/run.php';
-$run(false);
+[$install] = require __DIR__ . '/../vendor/shlinkio/shlink-installer/bin/run.php';
+$install();

bin/test/run-api-tests.sh

@@ -3,16 +3,16 @@ export APP_ENV=test
 export DB_DRIVER=mysql
 
 # Try to stop server just in case it hanged in last execution
-vendor/bin/zend-expressive-swoole stop
+vendor/bin/mezzio-swoole stop
 
 echo 'Starting server...'
-vendor/bin/zend-expressive-swoole start -d
+vendor/bin/mezzio-swoole start -d
 sleep 2
 
 vendor/bin/phpunit --order-by=random -c phpunit-api.xml --testdox --colors=always $*
 testsExitCode=$?
 
-vendor/bin/zend-expressive-swoole stop
+vendor/bin/mezzio-swoole stop
 
 # Exit this script with the same code as the tests. If tests failed, this script has to fail
 exit $testsExitCode

bin/update

@@ -8,5 +8,5 @@ use function chdir;
 use function dirname;
 
 chdir(dirname(__DIR__));
-$run = require __DIR__ . '/../vendor/shlinkio/shlink-installer/bin/run.php';
-$run(true);
+[, $update] = require __DIR__ . '/../vendor/shlinkio/shlink-installer/bin/run.php';
+$update();