<p>Two days ago I released the first major version in almost 2 years for <a target="_blank" rel="noopener noreferrer" href="https://github.com/shlinkio/shlink-web-client">shlink-web-client</a>, a web UI for <a target="_blank" rel="noopener noreferrer" href="https://shlink.io">shlink</a>, my self-hosted URL shortener.</p><p>This new version introduces several improvements to the project, and I thought it was worth writing a post to explain all of them in depth.</p><h3>New design</h3><p>The project has been using the same design almost since the beginning. It was clean, but it laked a bit of contrast and consistency in many sections.</p><p>Now the main background is light-gray, with components composed in white cards with a slight box shadow, that makes them easier to spot inside the app.</p><p>Also, the main area has now a max-width that prevents components from stretching too much on wide screens.</p><div class="row"><div class="col-md-6  "><img alt="Before" src="/assets/img/shlink-web-client-3/design-before.png" class="gallery-item"/><p class="text-center"><small>Before</small></p></div><div class="col-md-6  "><img alt="After" src="/assets/img/shlink-web-client-3/design-after.png" class="gallery-item"/><p class="text-center"><small>After</small></p></div></div><h3>Overview page</h3><p>Up until now, after connecting to a Shlink server, you went directly to the list of short URLs.</p><p>With this new version, you now see an overview page first, which displays some general stats, a quick short URL creation form, and the latest 5 short URLs.</p><p>From there, you can navigate to the full list of short URLs, with filtering capabilities, or go to the advanced short URL creation form.</p><div class="row"><div class="col-md-8 col-md-offset-2 "><img alt="Overview" src="/assets/img/shlink-web-client-3/overview.png" class="gallery-item"/><p class="text-center"><small>Overview</small></p></div></div><h3>Improved short URL creation form</h3><p>One of the sections with more room for improvement was the short URL creation form. It had all the inputs mixed, displaying just the &quot;long url&quot; one, with the option to un-collapsing the rest at will.</p><p>The new design groups the inputs by context, which makes it more clear. It also displays the inputs all the time, since the &quot;quick form&quot; is now located in the overview page.</p><div class="row"><div class="col-md-6  "><img alt="Before" src="/assets/img/shlink-web-client-3/creation-form-before.png" class="gallery-item"/><p class="text-center"><small>Before</small></p></div><div class="col-md-6  "><img alt="After" src="/assets/img/shlink-web-client-3/creation-form-after.png" class="gallery-item"/><p class="text-center"><small>After</small></p></div></div><h3>Enhanced visits page</h3><p>The visits page had a problem, it was trying to display too much information in a single place.</p><ul><li>Visits over time</li><li>Visits from every platform</li><li>Visits from every location</li><li>A list of visits as a table</li></ul><p>The new approach splits those in subsections with their own sub-route each (<code>/by-location</code>, <code>/by-context</code>, etc). This helps to render a smaller amount of charts at once, since they are a bit CPU greedy.</p><p>Also, only the visits from the last 30 days are loaded by default, making it load way faster for URLs with a lot of visits.</p><div class="row"><div class="col-md-6  "><img alt="Before" src="/assets/img/shlink-web-client-3/visits-before.png" class="gallery-item"/><p class="text-center"><small>Before</small></p></div><div class="col-md-6  "><img alt="After" src="/assets/img/shlink-web-client-3/visits-after.png" class="gallery-item"/><p class="text-center"><small>After</small></p></div></div><h3>Outer sections</h3><p>The app has some sections which are not related to a specific server, like creating/editing servers, or the settings page.</p><p>These sections have also been adapted to the new style, and they also have a max-width for wide screens.</p><div class="row"><div class="col-md-6  "><img alt="Before" src="/assets/img/shlink-web-client-3/create-server-before.png" class="gallery-item"/><p class="text-center"><small>Before</small></p></div><div class="col-md-6  "><img alt="After" src="/assets/img/shlink-web-client-3/create-server-after.png" class="gallery-item"/><p class="text-center"><small>After</small></p></div></div><h3>Date range selector</h3><p>A new component allows selecting date ranges either by relative time ranges (last 30 days, last 90 days...) or by selecting absolute start and end dates.</p><p>This component is used to filter both short URL lists and visits lists.</p><div class="row"><div class="col-md-6  col-md-offset-3"><img alt="Date range selector" src="/assets/img/shlink-web-client-3/date-range-selector.png" class=""/><p class="text-center"><small>Date range selector</small></p></div></div><h3>Domain selector</h3><p>Shlink has had multi-domain support for some versions, but changing the domain from the web client required to set the value manually, which is a bit error-prone.</p><p>This version introduces a new component which allows selecting from domains already used in the past (which is what you will want in most of the cases), preventing accidental typos.</p><p>It also allows setting new values in case you want to use a new domain that you never used before. This domain will then appear in the list the next time.</p><div class="row"><div class="col-md-6  "><img alt="Existing domains" src="/assets/img/shlink-web-client-3/domains-existing.png" class=""/><p class="text-center"><small>Existing domains</small></p></div><div class="col-md-6  "><img alt="New domain" src="/assets/img/shlink-web-client-3/domains-new.png" class=""/><p class="text-center"><small>New domain</small></p></div></div><h3>Other improvements</h3><p>The changes described so far were the major ones. However, v3.0.0 includes a few other minor improvements.</p><ul><li>Result and loading messages have been standardized: They are now more consistent and use the same set of components, which also ensures consistency in the future.</li><li>Error messages are now more descriptive: Instead of showing generic error messages when API calls fail, the actual error message is now always displayed, so that it&#x27;s easier to know what failed.</li><li>Dropped support for Shlink v1: All major versions come with some breaking changes that improve code maintainability. This one drops Shlink v1 support, which allows removing some conditional paths here and there.</li></ul><p>Other than the last point, Shlink v3.0.0 is mostly backwards compatible, so it&#x27;s safe to upgrade if you are already using Shlink v2.x</p><h3>Next steps</h3><p>Of course this doesn&#x27;t end here, and I have a lot of ideas to improve it even further.</p><ul><li>Dark theme: It&#x27;s what the cool kids do these days, and I have already done some experiments around it.</li><li>Shlink dashboard: Next gen web app for Shlink. You can read the whole reasoning in <a target="_blank" rel="noopener noreferrer" href="https://github.com/shlinkio/shlink-web-client/issues/338">this issue</a>.</li><li>Filtering in lists added to URL: Many sections allow filtering lists, but the state is saved in memory, which means it gets lost if the page is refreshed, and it cannot be bookmarked. The intention is to make all filtering params to become part of the URL.</li><li>Exporting visits in CSV: It&#x27;s cool to see charts full of info, but sometimes admins need to feed other services with the data, and consuming the original API is not always an option. Exporting visits to a CSV file will be supported soon by shlink-web-client.</li></ul>

Released shlink-web-client v3.0.0

<p>Let&#x27;s not deny that <a target="_blank" rel="noopener noreferrer" href="https://github.com/features/actions">GitHub actions</a> are hitting hard in the tech community, and many projects are transitioning from other continuous integration systems like <a target="_blank" rel="noopener noreferrer" href="https://circleci.com/">Circle CI</a> or <a target="_blank" rel="noopener noreferrer" href="https://travis-ci.org/">Travis CI</a>.</p><p>Personally I have been using Travis a lot during the past years, for all my OSS projects, and I have gotten very used to it.</p><p>However, people seem to be &quot;abandoning&quot; travis in favor of GitHub Actions, for different reasons. &quot;It&#x27;s faster&quot;, &quot;I can run smaller tasks in parallel&quot;, etc.</p><p>In my case, I have moved a few very specific tasks there, where travis was becoming a bottleneck, but I still have mixed feelings about the very-verbose yaml-based config needed to configure a few GitHub Actions, compared to the more concise travis one.</p><p>In this article I&#x27;ll explain how I improved a travis build to run several smaller tasks in parallel jobs, without having to completely move away from it.</p><h3>Initial state</h3><p>This project&#x27;s travis config is relatively simple. It is used to build a JS project for the web browser, and it has to run the next tasks:</p><ul><li>Lint the code, to make sure it fulfils the project&#x27;s coding standards.</li><li>Run unit tests.</li><li>Run mutation tests.</li><li>Build the docker image, to make sure none of the new changes broke it.</li><li>Conditionally publish a release on GitHub, with a dist file attached to it, if the build is being run for a git tag.</li></ul><pre><pre><code class="language-yaml">dist: bionic

language: node_js

branches:
  only:
    - /.*/

cache:
  directories:
    - node_modules

services:
  - docker

node_js:
  - &#x27;12.16.3&#x27;

install: npm ci

before_script:
  - echo &quot;Building commit range ${TRAVIS_COMMIT_RANGE}&quot;
  - export MUTATION_FILES=$(git diff ${TRAVIS_COMMIT_RANGE:-origin/main} --name-only | grep -E &#x27;src\/(.*).(ts|tsx)$&#x27; | paste -sd &quot;,&quot;)

script:
  - npm run lint
  - npm run test:ci
  - npm run mutate:ci
  - docker build -t project:test .

after_success:
  - node_modules/.bin/ocular coverage/clover.xml

before_deploy: npm run build ${TRAVIS_TAG#?}

deploy:
  - provider: releases
    api_key:
      secure: &lt;key&gt;
    file: &quot;./dist/project_${TRAVIS_TAG#?}_dist.zip&quot;
    skip_cleanup: true
    on:
      tags: true
</code></pre></pre><h3>Problems with this approach</h3><p>This is more or less ok, but the last two commands in <code>script</code> can be relatively slow and can delay the whole process.</p><p>Also, specially the mutation tests one, which is currently always considered successful regardless the result, can make the build reach the maximum run time allowed by travis, making the whole build falsely fail.</p><blockquote><p>The reason for the <code>before_script</code> step is to determine which source code files changed, and run mutation tests on them only, in order to mitigate this.</p></blockquote><p>Other than this, the build config defines &quot;global&quot; customizations that are actually only used for some tasks:</p><ul><li>Running <code>npm ci</code> is not required for the <code>docker build</code> task.</li><li>Getting the <code>docker</code> service is not required by any of the other tasks.</li><li>Determining changed files is only used by the <code>mutation tests</code> task.</li></ul><h3>Making use of jobs</h3><p>One cool feature travis supports is the use of a job <a target="_blank" rel="noopener noreferrer" href="https://docs.travis-ci.com/user/build-matrix/">build matrix</a>, that lets you define multiple jobs that run in parallel as part of the same build, and make each one of them do unrelated tasks.</p><p>Using this feature it is possible to improve the <code>.travis.yml</code> file, making it look like this:</p><pre><pre><code class="language-yaml">dist: bionic

language: node_js

branches:
  only:
    - /.*/

cache:
  directories:
    - node_modules

node_js:
  - &#x27;12.16.3&#x27;

jobs:
  fast_finish: true
  allow_failures:
    - name: &#x27;Mutation tests&#x27;
  include:

    - name: &#x27;Lint&#x27;
      install: npm ci
      script: npm run lint

    - name: &#x27;Unit tests&#x27;
      install: npm ci
      script: npm run test:ci
      after_success:
        - node_modules/.bin/ocular coverage/clover.xml

    - name: &#x27;Mutation tests&#x27;
      install: npm ci
      before_script:
        - echo &quot;Building commit range ${TRAVIS_COMMIT_RANGE}&quot;
        - export MUTATION_FILES=$(git diff ${TRAVIS_COMMIT_RANGE:-origin/main} --name-only | grep -E &#x27;src\/(.*).(ts|tsx)$&#x27; | paste -sd &quot;,&quot;)
      script: npm run mutate:ci

    - name: &#x27;Build docker image&#x27;
      services:
        - docker
      install: skip
      script: docker build -t project:test .

    - name: &#x27;Publish release&#x27;
      if: tag IS present
      install: skip
      script: skip
      before_deploy: npm run build ${TRAVIS_TAG#?}
      deploy:
        - provider: releases
          api_key:
            secure: &lt;key&gt;
          file: &quot;./dist/project_${TRAVIS_TAG#?}_dist.zip&quot;
          skip_cleanup: true
          on:
            tags: true
</code></pre></pre><p>This approach introduces all these benefits:</p><ul><li>Now linting, testing, mutation testing and building the docker image run in parallel, making the build finish earlier.</li><li>The mutation testing step is allowed to fail, and thanks to the <code>fast_finish</code> flag, travis won&#x27;t even wait for it to finish, considering the build successful once the rest have passed.</li><li>Configs that are only meaningful for certain jobs are defined in the job itself, instead of globally.</li><li>The &quot;publish release&quot; job only runs conditionally if the build is for a tag, thanks to the <code>if: tag IS present</code> condition. (More info about <a target="_blank" rel="noopener noreferrer" href="https://docs.travis-ci.com/user/conditional-builds-stages-jobs/">conditional jobs</a> in travis).</li><li>As soon as any of the jobs fails, the whole build fails and you don&#x27;t have to continue waiting. Before this, if the third task failed, you still had to wait for the previous two to finish.</li><li>Each job can have a name, making it more clear in travis UI what tasks are being run:</li></ul><p><img src="/assets/img/travis-multiple-jobs/travis-jobs.png" alt="Travis CI jobs"/></p><h3>Conclusion</h3><p>The main purpose of this article was to showcase that travis still has a lot to give. Github Actions are definitely cool, but there&#x27;s usually no silver bullet for everything, and a combination with other tools might be more suitable.</p><p>Also, this allows people using travis to improve their builds without having to change everything. Then, once you have split your tasks, if you still want to move to Github Actions, it should be easier.</p><blockquote><p>If you are curious, this is the project in which I use this travis configuration: <a target="_blank" rel="noopener noreferrer" href="https://github.com/shlinkio/shlink-web-client">shlinkio/shlink-web-client</a>.</p></blockquote>

Running several steps of a Travis CI build in parallel

<p>Asynchronous and non-blocking runtimes are pretty usual in many programming languages, as well as long-lived web apps that stay in memory and are capable of dispatching multiple HTTP requests without having to be fully bootstrapped every time. This has not been traditionally the case with PHP apps. </p><p>However, many projects are starting to get some adoption, that bring this long-lived approach to the PHP world.</p><p>The problem with this is that PHP developers are not used to this, and they tend to continue acting as they have always done. Also, libraries might have made some assumptions, making them not work as expected when used under this context.</p><p>Some of these projects are <a target="_blank" rel="noopener noreferrer" href="https://www.swoole.co.uk">swoole</a>, <a target="_blank" rel="noopener noreferrer" href="https://reactphp.org/">ReactPHP</a> or <a target="_blank" rel="noopener noreferrer" href="https://amphp.org/">Amphp</a>, to give some examples.</p><p>In this article, I will be focusing on the first one, and explain how to approach some of the pain points I have found after using it for a year and a half on an <a target="_blank" rel="noopener noreferrer" href="https://github.com/shlinkio/shlink">existing PHP project</a>.</p><h3>Introducing Swoole</h3><p>The main difference swoole has compared to other similar projects is that it&#x27;s written as a native PHP extension, and needs to be installed with <code>pecl</code>.</p><p>This is obviously a bit cumbersome, but the benefit is that, since it&#x27;s written in C++, it has a better handling of memory allocation, which is very important to achieve what it tries to do.</p><p>What swoole does is running a main process which bootstraps the PHP application once, and then keeps it in memory so that it can continue dispatching requests without having to load resources every time. This makes it really fast.</p><p>Those HTTP requests are handled by a set of child processes called &quot;web workers&quot;. Swoole forks the contents in memory for the main process to each one of the workers, so each worker has a &quot;copy&quot; of the application in memory.</p><p>Each worker is independent, but each one of them can only handle one request at a time, so you have to increase the number of workers if you expect a lot of concurrent traffic.</p><p>Other than web workers, swoole also has another set of child processes called &quot;task workers&quot;, which can be used to delegate long tasks at runtime to prevent web workers from getting blocked.</p><p>Here you can see a diagram of swoole&#x27;s architecture.</p><p><img src="https://www.swoole.co.uk/images/how-swoole-works.png" alt="How Swoole works"/></p><blockquote><p>More information can be found in <a target="_blank" rel="noopener noreferrer" href="https://www.swoole.co.uk/how-it-works">Swoole&#x27;s website</a>.</p></blockquote><h3>Problems to solve</h3><p>Now that we know how swoole works, let&#x27;s see some of the challanges I have faced in th past, which are usually not that ovbious when you are used to think in terms of &quot;blocking&quot; and &quot;short-lived&quot;.</p><h4>Database connections are kept open</h4><p>One of the first things you find out is that, since the application stays in memory, any database connection that has been opened by a worker (either web or task worker), will be kept open and reused in subsequent executions or HTTP requests served by the app.</p><p>This, which is in theory good, has a side effect, which is not obvious during development: <strong>the opened connection will eventually expire</strong>.</p><p>Since most of the popular database abstraction layers in PHP are coming from the times in which PHP was just a bootstrap-on-every-request technology, they never cared too much about expired database connections, as they would be opened again on next request.</p><p>However, when using swoole and the like, you have to implement some mechanism which takes care of reconnecting or gracefully recovering when this happens.</p><blockquote><p>I wrote an article explaining how I solved this on a middleware-based app served with swoole and using doctrine: <a href="/2019/11/04/how-to-properly-handle-a-doctrine-entity-manager-on-an-expressive-application-served-with-swoole/">How to properly handle a doctrine entity manager on an expressive application served with swoole</a></p></blockquote><p>Obviously, swoole (and also others) provides some tools to work with databases (like this <a target="_blank" rel="noopener noreferrer" href="https://www.swoole.co.uk/docs/modules/swoole-async-mysql-client">MySQL client</a>), which I&#x27;m sure do not have this problem (although, I haven&#x27;t personally tried this), but they are more limited than other well adopted libraries.</p><h4>In-memory caches don&#x27;t behave as expected</h4><p>It is a frequent practice to use local in-memory caches, like APCu, to improve applications performance in production.</p><p>Usually APCu is faster than other options, like redis or memcached, so it&#x27;s the choice when you only have one instance of your app running (meaning, you don&#x27;t have a cluster behind a load balancer).</p><p>However, even if you are running your app on just one server with swoole, because of the web worker system explained earlier, you actually have several copies of your app in memory, and each one of them will have a separated and not shared cache when using APCu.</p><p>This can lead to inconsistencies which are hard to debug, so you need to have it in mind.</p><p>Also, since the information that is being loaded is kept in memory anyway, you will not notice such a big improvement by using APCu or other in-memory caches.</p><blockquote><p>Notice that this problem does not happen when using distributed/centralized caching solutions, such as redis or memcached, as in that case, the caching technology is shared by all workers.</p></blockquote><h4>No need to optimize file including/requiring</h4><p>Many projects have complex configuration systems which are spread into several files. While this make it more maintainable, it also has a performance impact when all those files need to be loaded on every request.</p><p>Because of that, there are libraries like <a target="_blank" rel="noopener noreferrer" href="https://github.com/laminas/laminas-config-aggregator">laminas-config-aggregator</a> that can dynamically load config from many sources and, if some conditions are met, they can merge the result in a single bigger file that can be used in later requests.</p><p>In the case of swoole, as all the files will be kept in memory once loaded for the first time, there&#x27;s no need for this kind of optimization.</p><h4>Class autoloading happens once</h4><p>This point is very related with the previous one.</p><p>Composer offers a lot of optimization options so that class autoloading is faster in production. While you usually will still want to use some of those so that the first time a class is being loaded it is still reasonably fast, any subsequent hits will just use the class which is already in memory.</p><p>One of the composer flags you will probably don&#x27;t want use with swoole is <code>--apcu-autoloader</code>, because of the reasons mentioned two points above this one.</p><h4>Services should be truly stateless</h4><p>This is something that you should always do anyway, but it&#x27;s specially important when a service instance is kept in memory between HTTP requests.</p><p>Sometimes it&#x27;s easy to end up having some small piece of internal state on a service, where we save something as a side effect of a method call, to end up using it when another one of the public methods is invoked.</p><p>While this could seem harmless when the whole app is bootstrapped on every request, it can have very dangerous side effects when the app is served with swoole, because the instance will persist until another request is dispatched by the same web worker.</p><p>Just imagine you saved some user data on a service, and it ends up being served to another user on the next request. That won&#x27;t look good.</p><p>Because of this, make sure your services are truly stateless, and if for any reason that&#x27;s not possible, at least remember to have some mechanism in place that flushes the data just before finishing the request.</p><h4>Hot reloading for dev envs is not that good</h4><p>One thing we usually take for granted is that we can modify a PHP file and just by making a new request, the new code will be executed. However, when the code is kept in memory, it&#x27;s not that straightforward.</p><p>When you are developing a project which is served with swoole, you will have to restart the server every time to get your changes applied.</p><p>Swoole has a mechanism to do a light server reload, which is faster. You can find the docs in <a target="_blank" rel="noopener noreferrer" href="https://www.swoole.co.uk/docs/modules/swoole-server-reload">it&#x27;s website</a>.</p><p>The problem with this is that you need to implement the mechanism to invoke that when a file is changed, or use some library that does it for you.</p><p>Also, I have noticed that even calling that and seeing that the server is reloaded, does not always have the expected effect, and you have to still end up doing a hard reload. It&#x27;s something I don&#x27;t fully understand and I still need to investigate a bit further.</p><h3>Conclusion</h3><p>As it always happens when new technologies appear, it takes some time to get used to them, but I strongly suggest you to give a try to swoole or any other non-blocking runtime, because it makes your apps super fast.</p><p>Just remember to have all of the above in mind ;-)</p><p>That said, here you can find some libraries that will make your life easier when trying to serve existing projects with swoole, without having to couple with it and being able to continue using your favourite framework:</p><ul><li>IDE helper: <a target="_blank" rel="noopener noreferrer" href="https://github.com/swoft-cloud/swoole-ide-helper">https://github.com/swoft-cloud/swoole-ide-helper</a></li><li>Mezzio (formerly Zend Expressive): <a target="_blank" rel="noopener noreferrer" href="https://github.com/mezzio/mezzio-swoole">https://github.com/mezzio/mezzio-swoole</a></li><li>Symfony: <a target="_blank" rel="noopener noreferrer" href="https://github.com/k911/swoole-bundle">https://github.com/k911/swoole-bundle</a></li><li>Laravel: <a target="_blank" rel="noopener noreferrer" href="https://github.com/swooletw/laravel-swoole">https://github.com/swooletw/laravel-swoole</a></li></ul><p>Also, here you can find some more articles talking about this topic:</p><ul><li><a target="_blank" rel="noopener noreferrer" href="https://www.zend.com/blog/why-you-should-use-asynchronous-php">https://www.zend.com/blog/why-you-should-use-asynchronous-php</a></li><li><a target="_blank" rel="noopener noreferrer" href="https://samsonasik.wordpress.com/2020/04/05/using-swoole-in-mezzio-application-with-sdebug/">https://samsonasik.wordpress.com/2020/04/05/using-swoole-in-mezzio-application-with-sdebug/</a></li></ul>

Considerations when working with async PHP runtimes like swoole

<p>Some of you probably know that I have a pet project in which I like to work from time to time. This project is a self-hosted URL shortener called <a target="_blank" rel="noopener noreferrer" href="https://shlink.io">Shlink</a>.</p><p>Shlink is built using expressive as the base framework for the HTTP-dispatching task. A while ago, an expressive module was released to officially support serving expressive apps with <a target="_blank" rel="noopener noreferrer" href="https://www.swoole.co.uk/">swoole</a>, and I decided to include it on Shlink.</p><h3>How does swoole work?</h3><p>Swoole is an asynchronous non-blocking I/O framework which works in a similar way as node.js, but for PHP apps.</p><p>It has been conceived in a way that the app stays in memory between requests, removing the bootstrapping step and making apps to be served much faster.</p><p>Swoole can serve as many simultaneous requests as you tell it to. For this it makes use of workers. Each worker can serve one request at a time, and every worker has a separate instance of the app loaded in memory (this is something I <a target="_blank" rel="noopener noreferrer" href="https://twitter.com/dominikzogg/status/1189403552399134720">learned recently</a>).</p><p>Because of this, you have to sometimes change a bit the way you design your code. For example, if a service needs to be stateful (it shouldn&#x27;t, but shit happens), you will have to remember that the state will persist between requests, and you will want to somehow reset it to avoid unexpected side effects.</p><h3>How does this affect the EntityManager?</h3><p>One of the main services that keeps this internal state in Shlink is the doctrine <a target="_blank" rel="noopener noreferrer" href="https://www.doctrine-project.org/projects/doctrine-orm/en/current/tutorials/getting-started.html#obtaining-the-entitymanager">EntityManager</a>.</p><p>Due to the fact that it was originally designed to be used on a classical web server + CGI context, assuming it would be recreated on every request, there are a few considerations to take into account:</p><ul><li>It implements the unit of work pattern. It internally keeps track of all the entities that have been created/changed until you decide to flush it.</li><li>If something fails, the <code>EntityManager</code> can get closed, which makes it unusable after that moment.</li><li>If the database connection expires, the <code>EntityManager</code> will not gracefully recover. Instead, it will fail, since it&#x27;s not aware of the connection not being usable, getting yourself in previous point.</li></ul><h3>How to workaround it</h3><p>I learned about these issues by try and error, by using it on the app and getting the failures. Now, I want to share how I workaround those issues.</p><p>The first one I faced was the one making the app unusable after the <code>EntityManager</code> was closed. In order to solve this I created a decorated instance (naming, an object implementing <code>EntityManagerInterface</code> which in turn was wrapping an actual <code>EntityManager</code>), which was making sure the wrapped instance was transparently recreated if at some point it was closed.</p><p>However, this caused some side effects, and I finally realized that it was better to make the <code>EntityManager</code> to have to be reopened from the outside, and only once per request (this is closer to how it would behave on a classical set-up).</p><p>That&#x27;s how I came up with the <code>ReopeningEntityManager</code> Shlink is currently using (as of v1.20.0):</p><pre><pre><code class="language-php">&lt;?php

declare(strict_types=1);

namespace Shlinkio\Shlink\Common\Doctrine;

use Doctrine\ORM\Decorator\EntityManagerDecorator;

class ReopeningEntityManager extends EntityManagerDecorator
{
    /** @var callable */
    private $createEm;

    public function __construct(callable $createEm)
    {
        parent::__construct($createEm());
        $this-&gt;createEm = $createEm;
    }

    public function open(): void
    {
        if (! $this-&gt;wrapped-&gt;isOpen()) {
            $this-&gt;wrapped = ($this-&gt;createEm)();
        }
    }
}
</code></pre></pre><blockquote><p>You can find the actual code in <a target="_blank" rel="noopener noreferrer" href="https://github.com/shlinkio/shlink-common/blob/master/src/Doctrine/ReopeningEntityManager.php">shlink-common</a>.</p></blockquote><p>It just expects a factory that creates the actual <code>EntityManager</code>, and exposes an <code>open</code> public method which re-creates the wrapped instance if closed.</p><p>This method is called from a <a target="_blank" rel="noopener noreferrer" href="https://www.php-fig.org/psr/psr-15/">PSR-15</a> middleware which needs to be registered early in the middleware pipeline. It makes sure the method is called before the next middleware on the stack is invoked:</p><pre><pre><code class="language-php">&lt;?php

declare(strict_types=1);

namespace Shlinkio\Shlink\Common\Middleware;

use Psr\Http\Message\ResponseInterface;
use Psr\Http\Message\ServerRequestInterface;
use Psr\Http\Server\MiddlewareInterface;
use Psr\Http\Server\RequestHandlerInterface;
use Shlinkio\Shlink\Common\Doctrine\ReopeningEntityManager;

class CloseDbConnectionMiddleware implements MiddlewareInterface
{
    /** @var ReopeningEntityManager */
    private $em;

    public function __construct(ReopeningEntityManager $em)
    {
        $this-&gt;em = $em;
    }

    public function process(ServerRequestInterface $request, RequestHandlerInterface $handler): ResponseInterface
    {
        $this-&gt;em-&gt;open();

        try {
            return $handler-&gt;handle($request);
        } finally {
            $this-&gt;em-&gt;getConnection()-&gt;close();
            $this-&gt;em-&gt;clear();
        }
    }
}
</code></pre></pre><blockquote><p>Again, the code can be found in <a target="_blank" rel="noopener noreferrer" href="https://github.com/shlinkio/shlink-common/blob/master/src/Middleware/CloseDbConnectionMiddleware.php">shlink-common</a></p></blockquote><p>This middleware also does two more things (this time, after calling the next middleware on the stack, and making sure it does it even if an exception is thrown).</p><ul><li>It first closes the database connection. By doing it so, we make sure the <code>EntityManager</code> will reconnect the next time it needs to interact with the database, and therefore, we avoid the &quot;expired connection&quot; issue.</li><li>Then it clears the <code>EntityManager</code> itself. This avoids memory leaks, and also prevents that any orphan/non-flushed entity &quot;transcends&quot; to the next request, solving the first problem.</li></ul><h3>Further considerations</h3><p>This approach has been working well so far, but it&#x27;s important to assume that the <code>EntityManager</code> was not really designed for this non-blocking kind of context.</p><p>You need to know that the worker making use of it will not be able to serve any request until the <code>EntityManager</code> finishes its job. Because of this you might want to increase the number of swoole workers.</p><p>Also, closing the DB connection on every request is not the most optimal approach. It would be perfect to have a connection pool that was able to recreate connections when expired, and to keep them open as long as possible for faster operations. However, the <code>EntityManager</code> was not designed for that, so it&#x27;s better to close it.</p><p>You also need a <code>callable</code> to pass to the <code>ReopeningEntityManager</code>. The way you solve this depends on your implementation and the dependencies you use.</p><p>In my case, in Shlink I make use of the <code>ServiceManager</code>, so I have a delegator factory which takes the actual factory and passes it to the <code>ReopeningEntityManager</code>:</p><pre><pre><code class="language-php">&lt;?php

declare(strict_types=1);

namespace Shlinkio\Shlink\Common\Doctrine;

use Psr\Container\ContainerInterface;

class ReopeningEntityManagerDelegator
{
    public function __invoke(ContainerInterface $container, string $name, callable $createEm): ReopeningEntityManager
    {
        return new ReopeningEntityManager($createEm);
    }
}
</code></pre></pre><blockquote><p>You can find the actual code in <a target="_blank" rel="noopener noreferrer" href="https://github.com/shlinkio/shlink-common/blob/master/src/Doctrine/ReopeningEntityManagerDelegator.php">shlink-common</a>.</p></blockquote><h3>Conclusion</h3><p>I wanted to write this article as a recap for myself too, since I had to ask and investigate many times, and I couldn&#x27;t find a single source of truth explaining everything.</p><p>I hope that, if you ended up here, this article served you well.</p>

How to properly handle a doctrine entity manager on an expressive application served with swoole

<p>For a long time, I have been trying to include tests in every project in which I&#x27;ve worked on.</p><p>There are several types of automated tests (or what should actually be called <a target="_blank" rel="noopener noreferrer" href="https://abstracta.us/insights/guide-continuous-testing/automated-checks">automated checks</a>). From unit tests, integration and functional tests, to end-to-end tests.</p><p>Each one of them differs from the rest by the scope they try to cover. From small units of code which are tested completely detached from external dependencies, to a whole app which is tested as a black box like if an end consumer was using it.</p><p>I&#x27;m not going to deeply discuss the semantics behind this, or where an integration test ends and an end-to-end test starts, because it&#x27;s quite frequently a blurry line.</p><p>I want to focus on unit tests, and a frequently used practice (even in my own tests), which I have read (and felt) several times, it might not be the best approach.</p><blockquote><p>This article is not focused on any particular technology, since I have found this in a lot of different projects.</p></blockquote><h3>What&#x27;s a unit test</h3><p>According to <a target="_blank" rel="noopener noreferrer" href="https://en.wikipedia.org/wiki/Unit_testing">Wikipedia</a>, unit testing is a &quot;method by which individual units of source code [...] are tested to determine whether they are fit for use&quot;.</p><p>While this might look like a clear definition, it&#x27;s actually quite open because, what&#x27;s a &quot;unit&quot; in the context of unit testing?</p><p>Very often, in object oriented programming projects, people take a class as a unit to test, and create a unit test for every class. In other paradigms, like functional programming, you might consider a function as the unit to be tested, or a set of functions which you have decided to put together in a module.</p><p>This is not really important for the purpose of this article. What&#x27;s really important is to take into account that, in order to properly &quot;unit test&quot; a &quot;unit of source code&quot;, you have to do it by isolating it from any dependency of that unit.</p><p>One of the better ways to achieve this is by following the <strong><a target="_blank" rel="noopener noreferrer" href="https://en.wikipedia.org/wiki/Dependency_inversion_principle">Dependency Injection Principle</a></strong>. Without it you will probably end up trying to hack yourself in order to detach a &quot;unit&quot; from its dependencies.</p><blockquote><p>You can find other articles about <a href="/tag/dependency-injection/">Dependency Injection</a> in my blog.</p></blockquote><h3>Replacing dependencies</h3><p>A very frequent practice when unit testing a unit of source code is to replace its dependencies with <a target="_blank" rel="noopener noreferrer" href="https://en.wikipedia.org/wiki/Test_double">test doubles</a>, in order to properly isolate every unit when testing it.</p><p>Test doubles are basically objects compatible with the dependencies of the subject under test, that are created just for the purpose of the test and have some useful capabilities, like capturing how they have been called, or what should they return when called.</p><p>When you use one of those test doubles to assert how they were called as part of the test itself, you are using them as &quot;spies&quot;.</p><h3>Over-trusting spies</h3><p>All this introduction and contextualization had a single purpose.</p><p>I find myself (and others) in the situation in which you prepare a test double to behave in a certain way, then you call your subject under test, and then assert that your expectations on how the test double was called are correct, by spying on it.</p><p>This sometimes feels wrong, since it seems you are testing the test double/s instead of the subject under test.</p><p>I have read many times that, in a unit test, we should not actually know the internal implementation of the subject under test, but only test that, based on certain input, the expected output is returned (so, trust its public API).</p><p>However, there are cases in which some function/method does not really have any output, and we can only verify everything is going right by spying on the test doubles.</p><p>So, at the end of the day, I have mixed feelings about this practice.</p><h3>Conclusion</h3><p>Sadly, I cannot state a clear conclusion. This is actually an open article, and I would love to get your point of view in the form of a <a href="#comments-box">comment</a>.</p><p>It would be great to see how others face this, if you use other kinds of test doubles instead of spies, or if you are just ok with the implications.</p>

Is spying on mocks a bad practice for unit tests?

<p>Some time ago I wrote the most successful article of this blog, <a href="/2014/10/09/advanced-usage-of-service-manager-in-zend-framework-2/">Advanced usage of ServiceManager in Zend Framework 2</a>, explaining all the ways a service can be created by making use of <code>Zend\ServiceManager</code>, the service container component in Zend Framework 2.</p><p>On this article I&#x27;m going to show a real example where objects and services are all managed and created with a <code>ServiceManager</code> instance, which makes decoupling components and dependency injection very easy.</p><p>It is not a Zend Framework 2 application, because the <code>ServiceManager</code> is so integrated there that its power could go unnoticed. Instead, I&#x27;m using a <a target="_blank" rel="noopener noreferrer" href="http://www.slimframework.com/">Slim</a> framework based application, which solves some common problems that has nothing to do with this article (like routing and request dispatching) and allows us to concentrate on what&#x27;s important.</p><p>The project is just a simple application to perform a <a target="_blank" rel="noopener noreferrer" href="https://es.wikipedia.org/wiki/CRUD">CRUD</a> over two fictitious entities, <em>users</em> and <em>items</em>. Very simple.</p><h3>Getting the application</h3><p>As usual, I have hosted the example application on github. Clone it from <a target="_blank" rel="noopener noreferrer" href="https://github.com/acelaya-blog/service-manager-example">here</a>, install dependencies by running <code>composer install</code> and  start the built-in web server by running <code>php -S 0.0.0.0:8000 -t public</code>.</p><blockquote><p>If you are not familiar with composer, take a look at this <a href="/2014/07/19/dependency-management-and-autoloading-in-php-projects-with-composer/">article</a>.</p></blockquote><p>If you are used to modern PHP applications, the project structure shouldn&#x27;t be a problem. There is a <code>src</code> folder with the source code, a <code>public</code> folder which is the document root of the application, a <code>config</code> folder with some configuration files and a <code>tests</code> folder with the unit tests.</p><h3>Dependency injection</h3><p>Let&#x27;s start with some thoughts about dependency injection.</p><p>In the past, when I had to learn dependency injection, I found out that many tutorials just explain that it is important to decouple componentes from the application, and pass elements to objects instead of letting them to create those elements inside themselves.</p><p>That&#x27;s a good theory, but introduces another problem. Without dependency injection, creating an object is as easy as <code>new FooBar()</code>, and all dependencies will be automatically created on the inside, but with dependency injection I could end with something like this.</p><pre><pre><code class="language-php">$logger = new Logger(&#x27;/var/log/mylogs.log&#x27;);
$serviceOne = new ServiceOne(&#x27;foo&#x27;, &#x27;bar&#x27;);

$config = include __DIR__ . &#x27;/config/config_file.php&#x27;);
$serviceTwo = new ServiceTwo($serviceOne, $config[&#x27;param&#x27;], $config[&#x27;another_param&#x27;]);

$fooBar = new FooBar($serviceTwo, $logger);
</code></pre></pre><p>Now I have to pass two dependencies to my <code>FooBar</code> object. One of them also dependes on another object and a raw configuration. And this process could even be more complex.</p><p>When I try to explain dependency injection, people usually tries to mentally adapt their old code and substitute the <code>new FooBar()</code> with the previous code snippet, and their reaction is usually &quot;<em>Dependency injection is hard! I will need to duplicate a lot of code!</em>&quot;.</p><p>What those tutorials don&#x27;t explain is how to solve this new problem, and that we now should define the way the objects are created just in one place, and have some mechanism to access to that objects anywhere else once created.</p><p>That task is usually performed by an object, the &quot;inversion of control&quot; container, in plenty of forms, a service locator, service container, dependency injection container...</p><p>The <code>ServiceManager</code> is going to act as the &quot;inversion of control&quot; container of this project. Let&#x27;s see how.</p><h3>Solving the problem</h3><p>Now that we have identified the problem, let&#x27;s take a look at the example, and how the <code>ServiceManager</code> is capable of managing the whole application, making the task of creating objects much easier and without code duplication.</p><h4>Bootstrapping</h4><p>The project&#x27;s front controller is the <code>public/index.php</code> file, which only includes the <code>src/bootstrap.php</code> file. The first thing we do is create the <code>ServiceManager</code> instance (there is no need for more than one in the whole project) by consuming the configuration in <code>config/services.php</code>.</p><pre><pre><code class="language-php">$sm = new ServiceManager(new Config(include __DIR__ . &#x27;/../config/services.php&#x27;));

// ...
</code></pre></pre><p>After that, we use the <code>ServiceManager</code> to get the <strong>app</strong> instance, the main object in Slim framework.</p><pre><pre><code class="language-php">// ...

/** @var Slim $app */
$app = $sm-&gt;get(&#x27;app&#x27;);

// ...
</code></pre></pre><p>Thanks to the <code>ServiceManager</code>, we have obtained the <strong>app</strong> object with just one instruction, <code>$sm-&gt;get(&#x27;app&#x27;)</code>, as easy as doing <code>new \Slim\Slim()</code>, but the <code>ServiceManager</code> has customized and cached our object, we just had to previously tell it how to do it.</p><p>If we go to the <code>config/services.php</code> file, we&#x27;ll see that there is an &#x27;app&#x27; service defined as an alias of the <code>Slim::class</code> service, which in turn is an <strong>invokable</strong>, which means that it will be constructed by the <code>ServiceManager</code> just by instantiating the object with no arguments in the constructor.</p><p>But we said that the object has been customized. Where did that happen?</p><p>If we go to the <strong>delegators</strong> block, we&#x27;ll see that there is defined one delegator for the <code>Slim::class</code> service. Delegators are called by the <code>ServiceManager</code>, allowing us to customize certain service when it is going to be created.</p><p>Our SlimDelegator sets some configuration options in the Slim instance after it is created and before it is returned by the <code>ServiceManager</code>.</p><blockquote><p>The name of a service can be anything as long as it is unique. Using the fully qualified class name is just a convention when there is only one way to create the object returned.</p></blockquote><p>The final step of the bootstrap process is to use the <strong>app</strong> object to register a couple routes.</p><pre><pre><code class="language-php">// ...

// Homepage
$app-&gt;get(&#x27;/&#x27;, function () use ($app) {
    $app-&gt;render(&#x27;home.phtml&#x27;);
})-&gt;name(&#x27;home&#x27;);

// Users pages
$app-&gt;addControllerRoute(&#x27;/users/list&#x27;, UserController::class . &#x27;:list&#x27;)
    -&gt;name(&#x27;users-list&#x27;)
    -&gt;via(&#x27;GET&#x27;);
// ...

// Items pages
$app-&gt;addControllerRoute(&#x27;/items/list&#x27;, ItemController::class . &#x27;:list&#x27;)
    -&gt;name(&#x27;items-list&#x27;)
    -&gt;via(&#x27;GET&#x27;);
// ...
</code></pre></pre><p>The first route is the home page, which is only used to select between <em>users</em> and <em>items</em>.</p><p>The rest of the routes are endpoints to perform each operation of both <em>users</em> and <em>items</em> CRUDs. They are resolved to a controller&#x27;s action.</p><h4>Controllers</h4><p>Since Slim does not support controllers I&#x27;ve used the <a target="_blank" rel="noopener noreferrer" href="https://github.com/fortrabbit/slimcontroller">slimcontroller</a> package which allows us to dynamically load controllers from Slim&#x27;s container.</p><p>I&#x27;ve also used this useful <a target="_blank" rel="noopener noreferrer" href="https://github.com/acelaya/slim-container-sm">package</a> I created some days ago, which replaces Slim&#x27;s container with another object which wraps a <code>ServiceManager</code> which is similar but much more powerful. In combination with <strong>slimcontroller</strong> makes controllers to be loaded from the <code>ServiceManager</code>.</p><p>That is to say, the last two routes will fetch a <code>UserController::class</code> or <code>ItemController::class</code> service from the <code>ServiceManager</code> and use it as the controller for that route.</p><p>Those two controllers are defined in <code>config/services.php</code> as factories. A <strong>factory</strong> is the easiest way to perform dependency injection in a service.</p><p>For example, the UserControllerFactory looks like this.</p><pre><pre><code class="language-php">namespace Acelaya\Controller;

use Acelaya\Service\UserService;
use Slim\Slim;
use Zend\ServiceManager\FactoryInterface;
use Zend\ServiceManager\ServiceLocatorInterface;

class UserControllerFactory implements FactoryInterface
{
    public function createService(ServiceLocatorInterface $serviceLocator)
    {
        /** @var UserService $userService */
        $userService = $serviceLocator-&gt;get(UserService::class);
        return new UserController($userService);
    }
}
</code></pre></pre><p>It creates the UserController instance and returns it, but it also injects its only dependency on it.</p><p>That dependency is also fetched from the <code>ServiceManager</code>, because that <code>$serviceLocator</code> is the <code>ServiceManager</code> which injects itself in factories when calling the <code>createService</code> method. That is really usefull, because we can access services easily in a recursive way.</p><p>At this point we don&#x27;t need to know how the <code>UserService::class</code> service is created, and we can focus on creating the UserController. That&#x27;s a good example of <a target="_blank" rel="noopener noreferrer" href="https://en.wikipedia.org/wiki/Single_responsibility_principle">Single Responsibility Principle</a>.</p><p>The ItemController is created in a very similar way. You can take a look at the class <code>src/Controller/ItemControllerFactory.php</code>.</p><p>But this is not all. Controllers extending the AbstractController depend also on a <code>Slim\Http\Request</code>, a <code>Slim\Http\Response</code> and a <code>Slim\View</code> that are not injected on their respective factories.</p><p>For this purpose we have defined three <strong>initializers</strong> in the <code>config/services.php</code> file, which will inject those objects on any instance implementing certain interfaces. The AbstractController implements all the interfaces, so creating a UserController or ItemController will result in all the initializers to inject those dependencies via setters.</p><p>This is one of the initializers, but the rest are very similar.</p><pre><pre><code class="language-php">namespace Acelaya\Mvc;

use Zend\ServiceManager\InitializerInterface;
use Zend\ServiceManager\ServiceLocatorInterface;

class RequestAwareInitializer implements InitializerInterface
{
    public function initialize($instance, ServiceLocatorInterface $serviceLocator)
    {
        if ($instance instanceof RequestAwareInterface) {
            $app = $serviceLocator-&gt;get(&#x27;app&#x27;);
            $instance-&gt;setRequest($app-&gt;request);
        }
    }
}
</code></pre></pre><p>We are fetching the <strong>app</strong> here. Since it is already created at this point, the <code>ServiceManager</code> will return the same instance.</p><p>Now we know that any route starting with <strong>/users</strong> will end with a fully configured UserController fetched from the <code>ServiceManager</code>, and any route starting with <strong>/items</strong> will do the same with an ItemController.</p><h4>Other services</h4><p>We saw that creating any controller will fetch another service from the <code>ServiceManager</code>. Those are the <code>UserService::class</code> or the <code>ItemService::class</code> respectively.</p><p>If we go to the <code>config/services.php</code> file we won&#x27;t find those services defined, but the <code>ServiceManager</code> is capable of creating them. And how is that?</p><p>In the <strong>abstract_factories</strong> block, we have defined a ServiceAbstractFactory. Abstract factories are used as last resort to create services that are not explicitly defined.</p><p>In our case both services extend the <code>AbstractService</code> and have the same dependencies. This abstract factory checks if the service that is going to be created extends that class, and in that case creates it by injecting another two dependencies fetched from the <code>ServiceManager</code> again (recursivity is awesome!), which will run their own factories.</p><p>This abstract factory is in <code>src/Service/ServiceAbstractFactory.php</code>, if you want to take a look at its implementation.</p><h4>Everything is running</h4><p>And thats all the theory. The application works now in theory. Check it.</p><p>The most powerful aspect of the <code>ServiceManager</code> is that objects are recursively created in different ways. The creation implementation is defined just in one place without code duplication.</p><p>We have performed dependency injection and the code wasn&#x27;t harder to handle.</p><h3>Unit tests</h3><p>The project now works, but we can&#x27;t remember to manually test everything every time we refactor the code or add new features. That&#x27;s where unit tests come.</p><p>Having a good test suite is hard, but it is even harder without dependency injection. Tests end running almost the whole application, with too many objects created under the hood when the subject under test is created.</p><p>With dependency injection, we can inject fake harmless objects in the subject under test, making sure we are going to test just a small piece of code. Indeed, one of the most important reasons to use dependency injection is to be able to test your code without wanting to kill yourself.</p><p>For example. On this project, both UserService and ItemService depend on an instance of <code>Doctrine\ORM\EntityManager</code>. That object performs operations against a database, but we don&#x27;t want to connect to the database every time we run our tests.</p><p>If you take a look at <code>tests/Service/UserServiceTest.php</code> you will see how the EntityManager is faked by using phpunit&#x27;s mocks API.</p><pre><pre><code class="language-php">// ...

public function setUp()
{
    $repository = $this-&gt;getMock(&#x27;Doctrine\Common\Persistence\ObjectRepository&#x27;);
    $repository-&gt;expects($this-&gt;any())
               -&gt;method(&#x27;findAll&#x27;)
               -&gt;willReturn([]);

    $objectManager = $this-&gt;getMock(&#x27;Doctrine\Common\Persistence\ObjectManager&#x27;);
    $objectManager-&gt;expects($this-&gt;any())
                  -&gt;method(&#x27;getRepository&#x27;)
                  -&gt;willReturn($repository);
    $objectManager-&gt;expects($this-&gt;any())
                  -&gt;method(&#x27;persist&#x27;)
                  -&gt;willReturn(null);
    $objectManager-&gt;expects($this-&gt;any())
                  -&gt;method(&#x27;flush&#x27;)
                  -&gt;willReturn(null);
    $objectManager-&gt;expects($this-&gt;any())
                  -&gt;method(&#x27;find&#x27;)
                  -&gt;willReturn(new User());

    $this-&gt;userService = new UserService(
        $objectManager,
        new Logger(new Filesystem(new NullAdapter()), &#x27;fake.log&#x27;)
    );
}

// ...
</code></pre></pre><p>If I wasn&#x27;t injecting the EntityManager, the UserService would be tightly coupled with the database. Instead, the UserService expects an object of an abstract type to be injected on it, so it is decoupled with the system that saves the data.</p><h3>Conclusion</h3><p>You have seen a real example which uses the <code>ServiceManager</code>. There is no theory, you can check it yourself. I have used each object creation strategy at least once (invokables, factories, initializers, abstract_factories and delegators) so that you can see how it works.</p><p>As I mentioned earlier, I already wrote a more theoretical article on the <code>ServiceManager</code> subject a while ago. You can find it <a href="/2014/10/09/advanced-usage-of-service-manager-in-zend-framework-2/">here</a> if you need it (indeed I recommend you to read it).</p><p>I hope you use dependency injection in your projects from now on. There is no excuse not to do it, you just need to change your point of view.</p><p>By the way, I have not explained everything of this project. If you start digging into the code and have any comment, feel free to post it here.</p>

Managing objects creation and dependency injection with Zend\ServiceManager

<p>Any medium and large project has to deal at some point with the problem of translating the application itself to other languages. There are many tools and standards to do this, but one of my favourite components is <a target="_blank" rel="noopener noreferrer" href="https://zf2.readthedocs.org/en/latest/modules/zend.i18n.translating.html">Zend\I18n</a>.</p><p>Everybody who knows me is aware that I love Zend Framework, but unfortunately it&#x27;s been a while since the last time I worked on a project based on it.</p><p>But nowadays that is not a problem. <a target="_blank" rel="noopener noreferrer" href="https://getcomposer.org/">Composer</a> allows you to install any component or library on any project, so I&#x27;m indeed constantly using many ZF2 components.</p><p>I&#x27;m going to explain how to use one of those components, Zend\I18n, to manage application translations, which is a component that internally uses the <code>intl</code> PHP extension, so make sure to have it installed.</p><h3>Installation</h3><p>As usual, this component is easily installable with composer by running this command.</p><pre><pre><code>composer require zendframework/zend-i18n:~2.2
</code></pre></pre><p>If you want, I&#x27;ve created an example project that I&#x27;m going to use on this article. You can find it <a target="_blank" rel="noopener noreferrer" href="https://github.com/acelaya-blog/internationalization">here</a>, just clone it and run <code>composer update</code>.</p><p>Then go to the public directory, run <code>php -S 0.0.0.0:8000</code> and navigate to <a target="_blank" rel="noopener noreferrer" href="http://localhost:8000">localhost:8000</a></p><blockquote><p>If you are not familiar with composer, take a look at this <a href="/2014/07/19/dependency-management-and-autoloading-in-php-projects-with-composer/">article</a>.</p></blockquote><h3>Translation files</h3><p>The first we need to decide is the way we are going to store translations. There are many supported formats, from plain PHP arrays where we set a translation key and the text in a language, to <a target="_blank" rel="noopener noreferrer" href="https://www.gnu.org/software/gettext/">gettext</a> files that can be automatically updated with new strings to be translated, but we could also use xml or ini files.</p><p>The preferred method when using Zend\I18n is gettext (and it would be also my choice). It is easy to configure, uses super fast binary files in production and we don&#x27;t need to define translations immediately, we can leave it for then, so that it doesn&#x27;t break the development flow.</p><p>Gettext files are usually handled with an external tool, <a target="_blank" rel="noopener noreferrer" href="https://poedit.net/">poedit</a>, an open source cross-platform application that can inspect our project and find new translations, deleted translations and updated translations, syncing our translation files (usually those with <code>po</code> extension) so that we don&#x27;t need to remember where we added or updated internationalizable texts.</p><p>To do this we just need to tell the program the name of the functions we use to translate strings (usually <code>translate</code>, <code>gettext</code>, <code>_</code> and such) and the files it needs to scan for new translations.</p><p>It also compiles and generates the binary <code>.mo</code> files, which are the ones used by the application.</p><h3>The translator</h3><p>Once we have decided the format of the files that are going to store translations, we have to create the main <code>Zend\I18n\Translator\Translator</code> object that is going to be used to find translations by consuming certain configuration.</p><p>In the example, the <code>src/translator.php</code> file generates and returns a <code>Translator</code> instance. You will need to register your object in some kind of service container so that you can inject it anywhere. This example is so simple, that I just included the file in the index.php.</p><p>The <code>Translator</code> has a factory method that is able to consume a configuration to generate the instance. It looks like this.</p><pre><pre><code class="language-php">use Zend\I18n\Translator\Translator;

return Translator::factory([
    &#x27;locale&#x27; =&gt; &#x27;en&#x27;,
    &#x27;translation_file_patterns&#x27; =&gt; [
        [
            &#x27;base_dir&#x27; =&gt; __DIR__ . &#x27;/../languages&#x27;,
            &#x27;type&#x27;     =&gt; &#x27;gettext&#x27;,
            &#x27;pattern&#x27;  =&gt; &#x27;%s.mo&#x27;,
        ],
        [
            &#x27;base_dir&#x27; =&gt; __DIR__ . &#x27;/../more_languages&#x27;,
            &#x27;type&#x27;     =&gt; &#x27;phpArray&#x27;,
            &#x27;pattern&#x27;  =&gt; &#x27;%s.lang.php&#x27;,
        ],
    ],
]);
</code></pre></pre><p>In the configuration we have to define the default locale. It can be only one or an array with many of them, so that the translator can load another language if it is not able to find the first one. The locale can be changed later, but it is a good idea to have a language by default.</p><p>Then we have to define a list of places to find translation files. Each specification must include the directory which stores the files, the format of the translations in that directory (we can mix gettext with arrays and ini files if we want) and finally the pattern used to find certain translation file. The first mask will be replaced with the locale that is being used at each moment. This way, if we try to translate a message to the locale en, in the first directory, it will look for a file with the name <code>en.mo</code></p><p>I have not included it in the example, but we could also set a cache storage to be used with each translations directory under the &#x27;cache&#x27; key, but then we will need to install <code>zendframework/zend-cache</code> too.</p><h3>Translating texts</h3><p>Our translator is now ready to be used. In the example, the <code>public/index.php</code> file makes use of the translator to translate a couple strings.</p><p>The translator works this way, when you call the methods <code>translate</code> or <code>translatePlural</code> with a string, it tries to find the translation in current locale. If it does, it will return it, otherwise it will return the original string.</p><p>This way we can use the default language (usually english) for keys and avoid to generate translation files for that language.</p><p>I have configured my <code>po</code> files so that poedit looks for the usage of the <code>translate</code> method inside the public directory, and assume the first argument is the string to be translated.</p><p>At the top of the file you will see that I get a <code>lang</code> query param to use it as the current locale. If it is not defined or you define one that is invalid, the default locale <code>en</code> will be used.</p><p>Now you can test it. It has three valid locales, en, es and fr. Use them to see the texts in English, Spanish and French. You can try to use an invalid locale too and you will see the texts in english.</p><p>The last string is not included in any translation file, so you will see it always in english.</p><h3>Conclusion</h3><p>This is it. The translator is a simple component to use on any PHP project. It has more power in Zend Framework based applications, since it can be created by using the ServiceManager, and includes view helpers and integration with forms, but even so it can be used in isolation.</p><p>I would like to discuss about advanced concpets of the translator, like text domains, plural forms and even some kind of front-end integration to use the same translation files under javascript environments, but that will be done in another article.</p>

Translations and internationalization in PHP projects with Zend\I18n

<p>We are all very used to file uploads in plenty of web applications. From simple image uploads to a social network to multiple file uploads to file management applications like Dropbox.</p><p>On this article I&#x27;m going to explain how to handle asynchronous multifile uploads from a jQuery powered front-end to a Zend Framework 2 back-end, including HTML5 upload progress and file validation (type, size, and such).</p><p>You will need a modern browser to do this, since asynchronous file uploads are not supported by old browsers. </p><h3>Installing example project</h3><p>I have created a project which is fully functional. I&#x27;m going to use it across this article so feel free to clone it from here <a target="_blank" rel="noopener noreferrer" href="https://github.com/acelaya-blog/file-uploads">https://github.com/acelaya-blog/file-uploads</a>.</p><blockquote><p>Notice that I&#x27;ve simplified the usual Zend Framework 2 project structure. It&#x27;s enough for this example, but maybe difficult to maintain if your project grows, so better use the <a target="_blank" rel="noopener noreferrer" href="https://github.com/zendframework/ZendSkeletonApplication">Skeleton Application</a> structure in real applications.</p></blockquote><p>Once you have it, open a terminal, go to the directory and run <code>php composer.phar selfupdate &amp;&amp; php composer.phar install</code>.</p><p>Finally start the PHP built-in web server by running <code>cd public &amp;&amp; php -S localhost:8000</code>. Access to <a target="_blank" rel="noopener noreferrer" href="http://localhost:8000">localhost:8000</a> in order to see the application.</p><h3>The front-end</h3><p>I assume you are familiar with file uploads in web environments. All we need is a file input with the attribute multiple, wrapped inside a form with enctype multipart/form-data. This will make the browser to send files to the server.</p><pre><pre><code class="language-html">&lt;form name=&quot;uploadFiles&quot; id=&quot;uploadFiles&quot; method=&quot;post&quot;
      action=&quot;/upload-files&quot; enctype=&quot;multipart/form-data&quot;&gt;
    &lt;input type=&quot;file&quot; name=&quot;files[]&quot; multiple&gt;
    &lt;button type=&quot;submit&quot; className=&quot;btn btn-primary&quot;&gt;Upload files&lt;/button&gt;
&lt;/form&gt;
</code></pre></pre><p>It&#x27;s important to add brackets to the name attribute in the file input, so that the content is treated like an array and the server can properly manage all the files.</p><p>In this example I captured the form submit with javascript event handlers so that we can track the progress of the upload. It&#x27;s been set in <code>public/js/main.js</code>. In the <code>acelaya.uploadFiles</code> function I have defined what has to be done when the form is sent.</p><pre><pre><code class="language-javascript">// [..]

uploadFiles: function ($form) {
    var action = $form.attr(&#x27;action&#x27;),
        method = $form.attr(&#x27;method&#x27;);

    $.ajax({
        url: action,
        type: method,
        data: new FormData($form[0]),
        cache: false,
        contentType: false,
        processData: false,
        xhr: function () {
            // This will make the ajax request to use a custom XHR object which will handle the progress
            var myXhr = $.ajaxSettings.xhr();
            if (myXhr.upload) {
                var progressBar = acelaya.createProgressBar($form);

                // Add progress event handler
                myXhr.upload.addEventListener(&#x27;progress&#x27;, function(e) {
                    acelaya.handleUploadProgress(e, progressBar);
                }, false);
                myXhr.upload.addEventListener(&#x27;load&#x27;, function() {
                    // Firefox does not trigger the &#x27;progress&#x27; event when upload is 100%.
                    // This forces progress to end when upload is successful
                    progressBar.find(&#x27;.progress-bar&#x27;).css({width : &#x27;100%&#x27;});
                }, false);
            }

            return myXhr;
        }
    }).done(function (resp) {
        if (resp.code === &#x27;success&#x27;) {
            acelaya.refreshFilesList();
        } else {
            $form.after(
                &#x27;&lt;div className=&quot;alert alert-danger alert-dismissable&quot; style=&quot;margin-top: 20px&quot;&gt;&#x27; +
                    &#x27;&lt;button type=&quot;button&quot; className=&quot;close&quot; data-dismiss=&quot;alert&quot;&gt;&lt;span&gt;&amp;times;&lt;/span&gt;&lt;/button&gt;&#x27; +
                    &#x27;&lt;div&gt;An error occurred with uploaded files&lt;/div&gt;&#x27; +
                &#x27;&lt;/div&gt;&#x27;
            )
        }
    });
},

// [..]
</code></pre></pre><p>If you are familiar with <code>jQuery</code> you have probably used the <code>ajax</code> method.</p><p>In this case I&#x27;ve used the HTML5 <code>FormData</code> object to encapsulate the form element. This way any information on it will be serialized and sent to the server asynchronously, including files.</p><p>By default the <code>ajax</code> method creates a <code>jqXHR</code> object (a wrapper of the native <code>XMLHttpRequest</code> object) with default behavior, but we need to extend that behavior, so we have to create a new one which will handle the upload progress too.</p><p>What we do is to add a <code>progress</code> event listener which will increase a <a target="_blank" rel="noopener noreferrer" href="https://getbootstrap.com/components/#progress">bootstrap styled</a> progress bar as long as the content is sent to the server. The method <code>acelaya.createProgressBar</code> will create that progress bar and add it to the DOM.</p><pre><pre><code class="language-javascript">handleUploadProgress: function (e, progressBar) {
    if (! e.lengthComputable) {
        return;
    }

    var percent = e.total &gt; 0 ? e.loaded * 100 / e.total : 100;
    progressBar.find(&#x27;.progress-bar&#x27;).css({width : percent + &#x27;%&#x27;});
    progressBar.find(&#x27;.progress-bar&#x27;).text(parseInt(percent) + &#x27;%&#x27;);
},
</code></pre></pre><p>The method attached to the <code>progress</code> listener will be called by the browser for every chunk of data sent to the server. The number of times it is called dependes on the browser. For example, Firefox will call it more frequently than Chrome.</p><p>The event object contains the total size of the data and the size that has been already sent, but also it has a boolean property lengthComputable that tells if size could be calculated.</p><p>In the method <code>acelaya.handleUploadProgress</code> we calculate the percentage of the data that has been sent to display it in the progress bar.</p><blockquote><p>When you test this application, make sure to use big files, at least 1 GB in total, since you are going to &quot;upload&quot; them to your local machine, which is pretty fast. I already managed the server side to allow up to 1.5GB of POST data.</p></blockquote><p>Once files are uploaded, if the server returns a success response, we refresh the list of files, otherwise an error message is displayed.</p><p>And this is everything for the front-end, but this is not enough to make a usable application since files uplaoded will be discarded at the end of the request if the server does nothing with them.</p><h3>The back-end</h3><p>Zend Framework 2 has some mechanisms to deal with uploaded files. Once we have defined our routes and controllers, we have to get those files and move them to its final location, which is pretty simple with the <code>Params</code> controller plugin.</p><pre><pre><code class="language-php">public function uploadAction()
{
    $files = $this-&gt;params()-&gt;fromFiles(&#x27;files&#x27;);
    $code = $this-&gt;filesService-&gt;persistFiles($files);
    return new JsonModel([
        &#x27;code&#x27; =&gt; $code
    ]);
}
</code></pre></pre><p>I have created a FilesService (<code>src/Service/FilesService.php</code> in the project) which gets injected in the controller to handle operations with files. In this case I call the method <code>persistFiles</code>, which should store the files in a folder and return a status code which is in turn returned to the client in a JSON response. This is what the method <code>persistFiles</code> does.</p><pre><pre><code class="language-php">public function persistFiles(array $files)
{
    foreach ($files as $file) {
        move_uploaded_file($file[&#x27;tmp_name&#x27;], $this-&gt;options-&gt;getBasePath() . &#x27;/&#x27; . $file[&#x27;name&#x27;]);
    }
    return self::CODE_SUCCESS;
}
</code></pre></pre><p>As you can see, it is pretty simple. It just iterates the list of files and performs a <code>move_uploaded_file</code> over each one of them. The options object wrapps the base path, which can be set at <code>config/config.php</code> by changing the <code>files.base_path</code> directive, and it is the <code>files</code> directory by default.</p><p>This is functional, but we could need to validate something, like filesizes, mimetypes and such. We could even want to apply a hash to ensure an uploaded file&#x27;s integrity or check an uploaded image resolution.</p><p>Zend Framework 2 comes with a full set of file validators that we can use on this example. </p><h3>Filtering and validation</h3><p>Let&#x27;s imagine we don&#x27;t want to allow files greater than 1.5GB (which is actually the maximum I&#x27;ve set by php configuration, but they don&#x27;t need to coincide) and that a file with the same name doesn&#x27;t exist yet. We are also going to ensure the file has been uploaded.</p><p>We need now to define an <code>InputFilter</code> object that the <code>FileService</code> will apply to all the files. If any one of them fails validation, an error will be returned.</p><pre><pre><code class="language-php">&lt;?php
namespace Acelaya\Files;

use Zend\Filter\File\RenameUpload;
use Zend\InputFilter\FileInput;
use Zend\InputFilter\InputFilter;
use Zend\Validator\File\Size;

class FilesInputFilter extends InputFilter
{
    const FILE = &#x27;file&#x27;;

    public function __construct(FilesOptions $options)
    {
        $input = new FileInput(self::FILE);
        $input-&gt;getValidatorChain()-&gt;attach(new Size([&#x27;max&#x27; =&gt; $options-&gt;getMaxSize()]));
        $input-&gt;getFilterChain()-&gt;attach(new RenameUpload([
            &#x27;overwrite&#x27;         =&gt; false,
            &#x27;use_upload_name&#x27;   =&gt; true,
            &#x27;target&#x27;            =&gt; $options-&gt;getBasePath()
        ]));

        $this-&gt;add($input);
    }
}
</code></pre></pre><p>This filter will check each file has a file size no greater than what we defined in our configuration by using the <code>Size</code> validator.</p><p>Also, the <code>RenameUpload</code> filter will try to move the file to our previously defined base path by calling the <code>move_uploaded_file</code> function, which will only work with uploaded files, and throw an exception if we try to override an existing file.</p><p>We just need to adapt our <code>FilesService::persistFiles</code> method to use this <code>InputFilter</code>.</p><pre><pre><code class="language-php">public function persistFiles(array $files)
{
    foreach ($files as $file) {
        $filter = clone $this-&gt;getInputFilter();
        $filter-&gt;setData([FilesInputFilter::FILE =&gt; $file]);
        try {
            if (! $filter-&gt;isValid()) {
                return self::CODE_ERROR;
            }
            $data = $filter-&gt;getValues();
        } catch (InvalidArgumentException $e) {
            return self::CODE_ERROR;
        }
    }
    return self::CODE_SUCCESS;
}
</code></pre></pre><p>The <code>getInputFilter()</code> method returns an instance of our <code>FilesInputFilter</code>. After that we apply validation and if no exception is thrown and the method <code>isValid()</code> returns true, then everything worked and we can continue with the next file. If an error occurred we return the ERROR code.</p><p>It is <strong>important</strong> to call <code>$filter-&gt;getValues()</code> even if we are not going to use them, because that is what makes the function <code>move_uploaded_file</code> to be called, otherwise we won&#x27;t get the files moved to their final directory.</p><p>Now the application keeps working, but our uploaded files are filtered and validated.</p><p>Zend Framework 2 has other <a target="_blank" rel="noopener noreferrer" href="https://zf2.readthedocs.org/en/latest/modules/zend.filter.file.html">filters</a> and <a target="_blank" rel="noopener noreferrer" href="http://zf2.readthedocs.org/en/latest/modules/zend.validator.file.html">validators</a> you can use with files. Take a look at them.</p><p>And this is it. We have our fully functional file uploading application.</p>