<p>Recently ReactJS v18 was released. I started to look into its improvements, and checked which of my projects could benefit from them.</p><p>The main react-based project I maintain at the moment of writing this article is <a target="_blank" rel="noopener noreferrer" href="https://github.com/shlinkio/shlink-web-client">shlink-web-client</a>, so I naturally created a new branch and started the process.</p><p>The update was quite smooth, as most of the other dependencies I was using from the react ecosystem were already updated to support v18. All but one, <a target="_blank" rel="noopener noreferrer" href="https://enzymejs.github.io/enzyme/">enzyme</a>, the testing framework I was using to unit-test react components.</p><p>To be precise, I was able to continue running my tests, but some of them (those using <code>mount</code> instead of <code>shallow</code>) were still rendering components with the &quot;old&quot; React v17 approach, causing them to behave as in that version and a warning being printed in the console.</p><h3>First fix attempt</h3><p>The way enzyme integrates with the react version you are using is through an adapter library. The last official one supports only React v16, but someone released an <a target="_blank" rel="noopener noreferrer" href="https://github.com/wojtekmaj/enzyme-adapter-react-17">unofficial adapter for v17</a> which, with close to 650k weekly downloads, quickly became the way to go.</p><p>I checked if there was one for React 18, but sadly there wasn&#x27;t.</p><p>Also, the author of the adapter for v17 posted an article indicating <a target="_blank" rel="noopener noreferrer" href="https://dev.to/wojtekmaj/enzyme-is-dead-now-what-ekl">enzyme is dead</a>, he was not going to release one for v18, and publishing one for v17 was a mistake.</p><p>With those facts in mind, I started to face what was probably going to be the moment to migrate to <a target="_blank" rel="noopener noreferrer" href="https://testing-library.com/docs/react-testing-library/intro">react testing library</a>.</p><h3>Migration strategy</h3><p>I decided to follow a migration strategy similar to the one suggested in the article above, but with a couple of modifications:</p><ul><li>I update to React 18 anyway, as tests still pass.</li><li>Migrate right away all tests using <code>mount</code>, as those are the ones behaving differently.</li><li>New tests should be written directly with react testing library (RTL from now on).</li><li>When an existing test needs to be changed, consider migrating it to RTL, and do it if there&#x27;s time.</li><li>Introduce some PR from time to time just migrating a handful of tests.</li><li>Once everything is migrated, get rid of everything related with enzyme.</li></ul><h3>First contact and impressions</h3><p>I was a bit sceptical with RTL, as it was focused more on integration tests, instead of unit tests, which meant I had to completely change the mindset to write tests.</p><p>It also didn&#x27;t support shallow rendering, meaning that you will end up sometimes rendering a bigger component tree when testing container-like components, potentially causing side effects that could affect your test.</p><p>On the other hand there&#x27;s more and more people stating that <a target="_blank" rel="noopener noreferrer" href="https://kentcdodds.com/blog/why-i-never-use-shallow-rendering">shallow rendering is an anti-pattern</a>, and that&#x27;s probably the reason of enzyme getting &quot;discontinued&quot;.</p><p>Also, RTL has become the <a target="_blank" rel="noopener noreferrer" href="https://reactjs.org/docs/testing.html#tools">officially recommended framework</a> to test react components, it has become very popular, and it has even joined a wider group of testing libraries under the <a target="_blank" rel="noopener noreferrer" href="https://testing-library.com/"><code>@testing-library</code></a> organization.</p><p>The thing is that I started to use it, and I was quickly surprised with how it felt to work with it, and all the benefits it was bringing to my tests.</p><h3>Benefits I have experienced</h3><p>Once I started migrating the first tests I noticed some benefits:</p><ul><li>Changing my mindset was actually easier than I thought. The docs are very well written, so it&#x27;s relatively easy to start using RTL.</li><li>My tests got simpler, and required less of those nasty global mocks that jest allows (I&#x27;m looking at you, <a target="_blank" rel="noopener noreferrer" href="https://jestjs.io/es-ES/docs/mock-functions#mocking-modules"><code>jest.mock</code></a>).</li><li>Tests were way less coupled with implementation details. I moved from testing the component props, to test what the user would see on the screen.</li><li>Related with previous point, I started to write my tests by looking at the screen instead of the component&#x27;s implementation.</li><li>Changes in source code led to fewer tests requiring to be changed.</li><li>A progressive migration was possible, where some tests still use enzyme and others are already using RTL.</li></ul><p>And overall, it felt good and I have already dedicated a couple of PRs just to migrate more tests.</p><h3>Challenges I faced</h3><p>But of course, migrating to a new tool always comes with its own challenges, and this was not an exception. I&#x27;ll explain the main ones I have faced so far and how I tackled them:</p><ul><li><p>RTL lets you do some things in a couple of different ways, and the docs may not be super clear about what&#x27;s the recommended option.</p><p>For this I recommend reading <a target="_blank" rel="noopener noreferrer" href="https://acel.me/DCMb1">this article</a> from Kent C. Dodds, RTL&#x27;s author, which explains some common mistakes when using the library.</p></li><li><p>At first, I struggled a bit with asynchronous side effects and state changes in components, which can easily end up printing a warning like <code>Warning: An update to MyComponent inside a test was not wrapped in act</code>.</p><p>The warning also explains how you are supposed to solve this by wrapping your code in <code>act()</code>, but this warning comes from React, not RTL, and what it is not telling you is that RTL already wraps all needed operations in <code>act()</code>.</p><p>What this error usually mean is that you are not waiting for something to happen. <a target="_blank" rel="noopener noreferrer" href="https://acel.me/jnUdT">This other article</a>, also from Kent C. Dodds, explains everything you need to know about the things that can lead to this warning, and how to solve them.</p></li><li><p>Since you start testing from the user point of view, some use cases can be challenging to test without coupling with implementation details. For example, when you have a component which dynamically renders different images or icons, I used to directly check the component properties.</p><p>For this I found the best solution was to use <a target="_blank" rel="noopener noreferrer" href="https://jestjs.io/docs/snapshot-testing">jest snapshots</a>. I didn&#x27;t want to manually check which SVG was being rendered in the DOM, just that different ones were being used in every case.</p><pre><pre><code class="language-tsx">// I went from this...
test(&#x27;...&#x27;, () =&gt; {
  const wrapper = shallow(&lt;MyComp dynamicValue=&quot;foo&quot; /&gt;);
  expect(wrapper.find(FontAwesomeIcon).prop(&#x27;icon&#x27;)).toEqual(someIcon);
})

// To this
test(&#x27;...&#x27;, () =&gt; {
  const { container } = render(&lt;MyComp dynamicValue=&quot;foo&quot; /&gt;);
  expect(container.firstChild).toMatchSnapshot();
})
</code></pre></pre></li><li><p>Something very similar happens if you use some library that renders canvas. There&#x27;s no way to test that from a DOM point of view, which is what RTL does.</p><p>In my case I was using <a target="_blank" rel="noopener noreferrer" href="https://www.chartjs.org/">Chart.js</a> to render some charts, so I used <a target="_blank" rel="noopener noreferrer" href="https://github.com/hustcc/jest-canvas-mock">jest-canvas-mock</a>, which exposes a method on the canvas to see which are all the events invoked from the library.</p><p>Then I used snapshots again to verify they had the expected &quot;shape&quot;.</p><pre><pre><code class="language-tsx">// I went from this...
test(&#x27;...&#x27;, () =&gt; {
  const wrapper = shallow(&lt;MyCompWithCanvas /&gt;);
  expect(wrapper.find(Chart).prop(&#x27;data&#x27;).datasets).toEqual(...);
})

// To this
test(&#x27;...&#x27;, () =&gt; {
  const { container } = render(&lt;MyCompWithCanvas /&gt;);
  const events = container.querySelector(&#x27;canvas&#x27;)?.getContext(&#x27;2d&#x27;)?.__getEvents();

  expect(events).toBeTruthy();
  expect(events).toMatchSnapshot();
})
</code></pre></pre></li></ul><h3>Conclusion</h3><p>For better or worst, enzyme should no longer be considered an option. If you are starting a new project or are using it on small ones, consider migrating to RTL as soon as possible.</p><p>If you are using it in bigger projects, following the process described in this article will probably help you.</p><p>In any case, you will get surprised. React testing library is a great tool and provides many benefits over enzyme.</p><p>Its main issue is that it&#x27;s not a drop-in replacement for enzyme, so you will have to change a bit your mindset.</p>

My experience migrating from enzyme to react testing library

<p>Capturing code coverage for a test suite is a very useful way to know which parts of your source code are actually getting executed by tests.</p><p>This is useful not only to know if you need to add more tests to your project (in case the coverage is too low), but also, if you want to apply technics like mutation testing, having a properly generated code coverage report will dramatically speed up te execution and help you know if a non-killed mutant is relevant.</p><h3>Generating the code coverage</h3><p>Capturing code coverage is usually easy in the most common types of tests, like unit tests, where the source code is executed in the same process.</p><p>Tools like <a target="_blank" rel="noopener noreferrer" href="https://phpunit.de/">PHPUnit</a>, one of the most extended PHP testing frameworks, ships with tools like <a target="_blank" rel="noopener noreferrer" href="https://github.com/sebastianbergmann/php-code-coverage">php-code-coverage</a>, designed to capture the code under execution, just by providing a couple of lines of configuration.</p><p>However, generating a reliable code coverage report is not always that easy for other types of tests.</p><p>In contexts like E2E tests, where you may spin-up an API on a different process, and make your tests just call this API via HTTP and assert on the responses, PHPUnit will not be able to capture the code coverage, because the source code is actually being loaded on a different process.</p><h3>Remote code coverage</h3><p>A couple of weeks ago, I faced the issue described above. I had a web service for which I had a decent API test suite, but I wanted to capture code coverage for two main reasons:</p><ul><li>Be able to merge this coverage with the one generated by other tests suites, to know what&#x27;s the &quot;total&quot; code coverage, regardless the test producing it.</li><li>Apply mutation testing to the API tests, as I was already doing that for the rest of the test suites in the project. For this, I also needed to know exactly what tests were covering every line of the source code.</li></ul><p>After some investigation, I couldn&#x27;t find a built-in feature, where PHPUnit itself was able to &quot;remotely&quot; capture te code under test, so I had to think on a way to manually use <code>php-code-coverage</code> by myself.</p><h3>Code coverage reports</h3><p>In order to be able to capture code coverage, I had to make sure the instances of the objects provided by <code>php-code-coverage</code> where &quot;spin-up&quot; with the server, and then, the code coverage report was dumped at the end.</p><p>Also, you usually define the code to include/exclude from coverage in PHPUnit&#x27;s config, but since this time we are the ones creating the coverage objects, this was not possible.</p><p>I tried a couple of different approaches (more on this at the end), but the most accurate one for me, was to define two routes in my server, that were dynamically configured only when running the server in the context of these tests, and were responsible for creating and dumping the code coverage.</p><pre><pre><code class="language-php">use PHPUnit\Runner\Version;
use SebastianBergmann\CodeCoverage\CodeCoverage;
use SebastianBergmann\CodeCoverage\Driver\Selector;
use SebastianBergmann\CodeCoverage\Filter;
use SebastianBergmann\CodeCoverage\Report\Html\Facade as Html;
use SebastianBergmann\CodeCoverage\Report\PHP;
use SebastianBergmann\CodeCoverage\Report\Xml\Facade as Xml;

// Define directories containing the code you want to cover
$filter = new Filter();
$filter-&gt;includeDirectory(...);
$filter-&gt;includeDirectory(...);
$coverage = new CodeCoverage((new Selector())-&gt;forLineCoverage($filter), $filter);

// This is &quot;pseudo-code&quot;. Defining the routes depends on the framework you use
$app-&gt;get(&#x27;/api-tests/start-coverage&#x27;, function () use (&amp;$coverage) {
    $coverage-&gt;start(&#x27;API tests&#x27;);
    return new EmptyResponse();
});
$app-&gt;get(&#x27;/api-tests/stop-coverage&#x27;, function () use (&amp;$coverage) {
    $basePath = &#x27;...&#x27;; // Wherever you want the reports to be dumped
    $coverage-&gt;stop();

    // I generated coverage reports in a couple of different formats
    (new PHP())-&gt;process($coverage, $basePath . &#x27;/coverage.cov&#x27;);
    (new Xml(Version::getVersionString()))-&gt;process($coverage, $basePath . &#x27;/coverage-xml&#x27;);
    (new Html())-&gt;process($coverage, $basePath . &#x27;/coverage-html&#x27;);

    return new EmptyResponse();
});
</code></pre></pre><p>Then, I added the next snippet to my PHPUnit <code>bootstrap.php</code> file, to make sure the endpoints configured above are invoked at the proper times:</p><pre><pre><code class="language-php">// when starting up the test suite, call the endpoint to start collecting coverage
$httpClient-&gt;request(&#x27;GET&#x27;, &#x27;http://localhost:8080/api-tests/start-coverage&#x27;);

// When the tests process shuts down, call the endpoint to stop the coverage
register_shutdown_function(function () use ($httpClient): void {
    $httpClient-&gt;request(&#x27;GET&#x27;, &#x27;http://localhost:8080/api-tests/stop-coverage&#x27;);
});
</code></pre></pre><blockquote><p>Learn more about how to configure PHPUnit&#x27;s <a target="_blank" rel="noopener noreferrer" href="https://phpunit.readthedocs.io/en/9.5/configuration.html#the-bootstrap-attribute">bootstrap script</a>.</p></blockquote><p>This was fine from a pure code coverage point of view, but if you try it yourself, you will notice the report says all the code has been covered by <code>API tests</code>, which is what we provide when calling <code>$coverage-&gt;start(&#x27;API tests&#x27;);</code></p><p><img src="/assets/img/remote-coverage/invalid-api-coverage.png" alt="Invalid API coverage"/></p><p>To properly do mutation testing we need to know which are the exact tests that cover every part of the code. That requirement took me to the next approach.</p><h3>Supporting mutation testing</h3><p>To be more precise with the generated reports, I needed some way to notify the server about the specific test performing the request.</p><p>One way to do this is by sending a custom header when performing a request from your tests, and registering some event handler or middleware which starts the coverage for that request with the value coming from that header.</p><p>With that, I evolved the configuration above, and added a middleware handler (the framework I use is <a target="_blank" rel="noopener noreferrer" href="https://www.php-fig.org/psr/psr-15/">PSR-15</a> based, but the framework of your choice will probably have a way to do this).</p><pre><pre><code class="language-php">use ...

$coverage = new CodeCoverage();

// This ensures the coverage is started and stopped on every request, using the &quot;x-coverage-id&quot; header as the ID.
$app-&gt;middleware(function (ServerRequestInterface $req, RequestHandlerInterface $handler) use (&amp;$coverage) {
$coverage?-&gt;start(&#x27;API Tests&#x27;);
    $coverage-&gt;start($req-&gt;getHeaderLine(&#x27;x-coverage-id&#x27;));

    try {
        return $handler-&gt;handle($req);
    } finally {
        $coverage-&gt;stop();
    }
});

// This route is no longer needed. You can also remove the request from your bootstrap script
// $app-&gt;get(&#x27;/api-tests/start-coverage&#x27;, ...);
$app-&gt;get(&#x27;/api-tests/stop-coverage&#x27;, ...);
</code></pre></pre><p>Then, inside your test you can do something like this:</p><pre><pre><code class="language-php">use PHPUnit\Framework\TestCase;

class MyApiTest extends TestCase
{
    private ClientInterface $httpClient;

    public function setUp(): void
    {
        $this-&gt;httpClient = ...;
    }

    public function testMyEndpoint(): void
    {
        $resp = $this-&gt;httpClient-&gt;request(&#x27;POST&#x27;, &#x27;...&#x27;, [
            &#x27;headers&#x27; =&gt; [
                &#x27;x-coverage-id&#x27; =&gt; static::class,
            ],
        ])

        // Asserts go here...
    }
}
</code></pre></pre><p>After this, the code coverage reports will properly show the actual tests covering them.</p><p><img src="/assets/img/remote-coverage/valid-api-coverage.png" alt="Valid API coverage"/></p><h3>Alternative approach</h3><p>The approach explained here is functional, but it&#x27;s a bit hacky. I had to do it like this because of limitations with how I serve the API with <a target="_blank" rel="noopener noreferrer" href="https://openswoole.com">openswoole</a>.</p><p>However, instead of defining routes that need to be actively called to start/stop the code coverage (or just to dump the report, as in the second approach), you could try to register the shutdown function directly in the server side.</p><p>If that works for you, it&#x27;s much more straightforward, and you won&#x27;t need to bother changing your tests bootstrap script.</p><h3>Conclusion</h3><p>Even though there&#x27;s room for improvement, this allows to generate code coverage reports for code that&#x27;s running on a different process.</p><p>I plan to apply something similar for E2E tests for a command line app, so maybe I extend this article at some point.</p><p>Also, I decided to write this article, because at the moment of having to implement this myself, I didn&#x27;t find too much useful information out there.</p><p>I hope this helped you, and now you can collect code coverage reports on your API tests.</p>

Capturing remote code coverage in API tests with PHPUnit

<p>In the last couple of days I have been playing around with the idea of combining GitHub Actions and GitHub Pages to be able to dynamically build preview environments every time a pull request is opened against a repository hosting a client-side web app.</p><p>The idea is that you can quickly preview the changes made by some contributor, without having to clone their branch and running everything locally, something specially useful for open source projects.</p><p>In this article I will explain how to set everything up, and what are some considerations and problems you may face during the process.</p><h3>Enable github pages</h3><p>The first thing you need to do is enable your project to publish pages on some branch. I recommend creating a new branch for this, let&#x27;s say <code>preview-env</code>, and then enabling publishing on it.</p><p>In order to do that go to your repository and then <strong>Settings</strong> -&gt; <strong>Pages</strong>, look for the <strong>Source</strong> section, and you should see something like this:</p><p><img src="/assets/img/preview-envs/github-pages-before-enabling.png" alt="GitHub pages before enabling"/></p><p>Click in the dropdown and select your new branch, <code>preview-env</code>. Then click <strong>Save</strong>.</p><p><img src="/assets/img/preview-envs/github-pages-after-enabling.png" alt="GitHub pages after enabling"/></p><p>After saving you will see a message at the top of this section telling you what&#x27;s the URL in which the pages are published. It always follows the same pattern. If your organization is <code>my-org</code> and your repository is <code>my-repo</code>, the url will be <code>https://my-org.github.io/my-repo/</code>.</p><h3>Configure the workflow</h3><p>Now we need to configure a workflow that will &quot;deploy&quot; the preview environment for the branch every time a new pull request is created or updated:</p><p>Let&#x27;s imagine we have a React web app that is built with node.js. The configuration could look like this.</p><pre><pre><code class="language-yml"># .github/workflows/deploy-preview.yml
name: Deploy preview

on:
  pull_request: null

jobs:
  deploy:
    runs-on: ubuntu-20.04
    continue-on-error: true
    steps:
      - name: Checkout code
        uses: actions/checkout@v2
      - name: Use node.js 14.15
        uses: actions/setup-node@v1
        with:
          node-version: 14.15
      - name: Generate slug
        id: generate_slug
        run: echo &quot;##[set-output name=slug;]$(echo ${GITHUB_HEAD_REF#refs/heads/} | sed -r &#x27;s/[~\^]+//g&#x27; | sed -r &#x27;s/[^a-zA-Z0-9]+/-/g&#x27; | sed -r &#x27;s/^-+\|-+$//g&#x27; | tr A-Z a-z)&quot;
      - name: Build
        run: npm ci &amp;&amp; npm run build
      - name: Deploy
        uses: JamesIves/github-pages-deploy-action@4.1.1
        with:
          branch: preview-env
          folder: build
          target-folder: ${{ steps.generate_slug.outputs.slug }}
      - name: Publish env
        uses: marocchino/sticky-pull-request-comment@v2
        with:
          header: Preview environment
          message: |
            ## Preview environment
            https://my-org.github.io/my-repo/${{ steps.generate_slug.outputs.slug }}/
</code></pre></pre><blockquote><p>If you are not familiar with GitHub Actions yet, take a look at the <a target="_blank" rel="noopener noreferrer" href="https://docs.github.com/en/actions">official documentation</a>.</p></blockquote><p>This workflow will follow the next steps:</p><ul><li>Checkout the code from the repository.</li><li>Set-up node.js 14.15</li><li>Based on the branch name, generate a slug that we will use to have separated deployment folders for every pull request we receive. The slug is exposed to next steps as an output.</li><li>Build the project. This step will obviously depend on the needs of your project.</li><li>Using <a target="_blank" rel="noopener noreferrer" href="https://github.com/JamesIves/github-pages-deploy-action">JamesIves/github-pages-deploy-action</a>, deploy the contents we previously built in the GitHub page, under a sub-folder matching the slug we generated a few steps above, and under the branch <code>preview-env</code> (remember we enabled GitHub pages for this branch).</li><li>Finally, using <a target="_blank" rel="noopener noreferrer" href="https://github.com/marocchino/sticky-pull-request-comment">marocchino/sticky-pull-request-comment</a>, post a comment in the pull request with a link to the preview environment, so that you can just click on it and see the deployment.</li></ul><p>The steps may change depending on your needs and how you build your project. For example, I have an extra step to update a property in the <code>package.json</code> that is then used to allow serving the app in a sub-path instead of the root of the domain.</p><p>You may also not build your site with node.js, as you could be using any of the multiple existing static site generators out there, but you get the idea.</p><p>Finally, you have probably noticed the config includes <code>continue-on-error: true</code>. This will allow the pull request to be merged even if this process fails for some reason.</p><h3>Considerations when using forks</h3><p>While the configuration above will work perfectly when creating pull requests inside the same repository, there are some limitations when the pull request comes from a fork (which is the usual in OSS projects).</p><p>For security reasons, the <code>GITHUB_TOKEN</code> injected in those cases doesn&#x27;t have write permissions, which will make the &quot;deploy&quot; step fail.</p><p>Also, you cannot define your own token with more permissions and inject it as a secret, as the secrets are not exposed to workflows running on forks.</p><p>However, with a couple small config changes, we can work around these limitations:</p><h4>Change event</h4><p>The first thing we need to do is use the <code>pull_request_target</code> event instead of the <code>pull_request</code> one.</p><pre><pre><code class="language-diff">on:
-  pull_request: null
+  pull_request_target: null
</code></pre></pre><p>According to the documentation, this is equivalent to the <code>pull_request</code> event, but it runs in the scope of the base repository.</p><p>Thanks to this, the <code>GITHUB_TOKEN</code> will come with write permissions, and we will have access to secrets if needed.</p><h4>Checkout the fork</h4><p>The second thing we are going to change is that we now need to specify the repository to checkout.</p><p>In order to do that, we need to add two inputs to the &quot;Checkout code&quot; step, like this:</p><pre><pre><code class="language-diff">    steps:
      - name: Checkout code
        uses: actions/checkout@v2
+       with:
+         repository: ${{ github.event.pull_request.head.repo.full_name }}
+         ref: ${{ github.event.pull_request.head.ref }}
</code></pre></pre><p>This will ensure we checkout from the fork repository, instead of the base one, which is the default, as it&#x27;s the one where the <code>pull_request_target</code> event is scoped to.</p><p>And that&#x27;s it. With these two changes you can now deploy preview environments for pull requests coming from forks.</p><blockquote><p><strong>IMPORTANT!</strong> The limitations of the <code>pull_request</code> event are there for a reason. People could potentially get access to your secrets or manipulate your code. Proceed at your own risk.</p></blockquote><h3>Other considerations</h3><p>Other than the limitations for forks, there are a few other minor things to take into consideration.</p><ul><li>Changes in GitHub Pages do not reflect immediately. It may take up to a couple of minutes for the deployment to be available, but considering you will usually not review a PR right after it has been created, this should not be a big issue.</li><li>As you have seen, every time a pull request is created, the deployment will generate a new folder in your GitHub Pages branch. This may result in a lot of old folders to pile-up, so you may want to set up some way to clean them up periodically or after the pull request has been merged.</li><li>Due to the fact that GitHub Pages only allows static pages to be served, this process cannot be used with apps that require some kind of back-end or server-side logic.</li><li>If your project is already using GitHub Pages for something else (serve the project&#x27;s website or docs), that may conflict with this, preventing you from having this kind of preview envs.</li></ul>

Setting-up a preview environment for your client-side apps with GitHub Actions and GitHub Pages

<p>I remember many years ago, when I released my first open source project, that every time I had a new release ready, I was never sure what should be the new version number.</p><p>Versioning software is not as straightforward as it might look when you don&#x27;t have a lot of experience.</p><p>In this article I&#x27;ll try to explain the <a target="_blank" rel="noopener noreferrer" href="https://semver.org/">SemVer</a> approach to version software, and some things you might want to take into account on top of that.</p><h3>Semantic Versioning</h3><p>The first thing you need is a solid set of rules that help you decide which should your next version be.</p><p>I remember thinking <em>&quot;is this version big enough as to jump from 1.0 to 2.0?&quot;</em> or <em>&quot;I have seen projects using three numbers for the version, X.Y.Z, should I do the same?&quot;</em></p><p>Those questions are easier to answer if you stick to some standard that tells you what to do, and that will help others more easily understand your intention.</p><p>My recommendation is to use <a target="_blank" rel="noopener noreferrer" href="https://semver.org/">Semantic Versioning</a>, as it defines a solid starting point, and it&#x27;s quite adopted by the community.</p><p>Semantic Versioning states that you should use three numbers to identify versions, <code>MAJOR.MINOR.PATCH</code>, and follow these rules in order to decide which one to increase:</p><ul><li><code>PATCH</code>: the new release includes only bug fixes. People are encouraged to update to this release and no changes are needed in their code bases.</li><li><code>MINOR</code>: the new release includes new backwards-compatible features. People can update to this version without changing their code bases, and make use of the new features afterwards if they wish.</li><li><code>MAJOR</code>: the new release includes <a target="_blank" rel="noopener noreferrer" href="https://en.wikipedia.org/wiki/Backward_compatibility">backward compatibility</a> breaks. Changes in the code base will be needed when updating to this version.</li></ul><blockquote><p>These rules are easier to apply to libraries and frameworks than it is for apps and services. More about this later.</p></blockquote><h3>Try to keep backwards-compatibility</h3><p>Ok, we have some rules now. However, I have seen very frequently people mistaking what <em>can</em> be done with what <em>should</em> be done.</p><p>Yes, if you introduce a breaking change, you can update the major version and that&#x27;s it. However, if you do it too frequently, people won&#x27;t be happy, and you will end up with a fragmented user base, that stop updating to newer versions.</p><p>I remember using a library to deploy stuff that had a new major version every couple of months, changing things like &quot;The <code>host</code> function is now called <code>server</code>&quot;. Yes, ok, but why do I have to change my stuff so frequently.</p><p>It&#x27;s usually better to try to implement things in a backwards-compatible way, and keep track of the things you want to change and do it all at a time.</p><p>You can also deprecate things, and document the way you want those things to be done moving forward. That way you give people the chance to start changing their code and simplify a hypothetical upcoming major release.</p><h3>Provide clear upgrade paths</h3><p>As mentioned above, too frequent major version changes are not desirable, but sooner or later you will want to release a new major version for different reasons.</p><ul><li>Getting rid of that feature which is hard to maintain, introduces lots of bugs, and provides little value.</li><li>Supporting something new which is very hard to implement without breaking backwards compatibility.</li><li>Removing all those deprecated methods you have been dragging for months.</li><li>Fix design issues, where something was architected in the wrong way, and only spotted after some time.</li></ul><p>At the time this happens you will want your users to upgrade to the newer version, as you don&#x27;t want people to report bugs that only affect older versions, or to expect you to backport fixes to older versions because they haven&#x27;t updated to the new one.</p><p>The best way to achieve this is to provide clear and simple upgrade paths:</p><ul><li><p>Prepare your releases for the things to come: If you want to introduce new ways of doing things, do it before the major release, and deprecate the older ones. For example, you can have a new method that gets called by an older one, while you mark the old one as deprecated.</p><p>People will be more willing to update and change their code afterwards. By the time the major release is published, their code will be ready to upgrade.</p></li><li><p>Include a CHANGELOG file in your project, explaining the changes introduced in every version. A very good way to document a change log is the <a target="_blank" rel="noopener noreferrer" href="https://keepachangelog.com/">Keep a changelog</a> initiative.</p><p>You can also use some other platform to document the change log, like GitHub releases.</p></li><li><p>Include documentation on how to upgrade to a major release: This is probably the most important one. Document all the steps that need to be followed and all the required changes to update from a release to the next major one.</p><p>A good way to do this is by including an UPGRADE file in your project. You can see <a target="_blank" rel="noopener noreferrer" href="https://github.com/acmailer/acmailer/blob/main/UPGRADE.md">this example</a>.</p></li></ul><h3>Versioning libraries vs apps</h3><p>Semantic Versioning is a good standard to version software, but it plays much better with libraries and frameworks that are installed using some kind of package manager, than it does with apps and services that are not directly depended on.</p><p>For example, how do you identify a backward compatibility break on a web user interface?</p><p>With this kind of software there are more grey areas, and you will end up using your intuition.</p><p>For example, not long ago I released a <a href="/2020/12/24/released-shlink-web-client-v3-0-0/">new major version</a> for a web app I maintain, and it was completely compatible with the previous one. However, it introduced a larger amount of features than usual, and big UI changes, so I decided it was worth the bump.</p><p>Because of this there are projects that use different approaches to version apps. For example:</p><ul><li>Firefox and Chrome have 6-week cycles, and after each one of them they release a new major version no matter what.</li><li>Jetbrains publishes a few releases of their IDEs every year (I think 3) which always start with the year they were released on, like <code>2020.3.0</code>, and they increase the patch number for bugfixes.</li><li>Ubuntu releases 2 versions every year, one in April and one in October, and they are always identified by the year and month they were released on, like <code>19.04</code> or <code>20.10</code>.</li></ul><h3>Special versions</h3><p>There&#x27;s also a set of special versions that can be used to publish the so-called <strong>pre-release</strong> versions. These <a target="_blank" rel="noopener noreferrer" href="https://semver.org/#spec-item-9">are covered</a> by Semantic Versioning, but sometimes they are not so easy to understand.</p><p>It is also very likely that you never have to use these, as only relatively big projects will need this level of granularity, but it&#x27;s still good to know what&#x27;s their purpose and what do they imply.</p><h4>0.x.y</h4><p>It is possible to release a version of your software where the major number is <code>0</code>. When this happens, it means your software is still in its early stages.</p><p>It does not mean it&#x27;s necessarily unstable, but it means you are still introducing frequent changes on it, and therefore, it might be a bit more fragile than a version starting with a number greater than <code>0</code>.</p><h4>Alpha</h4><p>The intention of an alpha release is that a subset of people con test some new functionality, but you don&#x27;t want people to use it in production</p><p>Alpha versions are on their very early stages. Their public API is very likely to change, and they probably contain bugs.</p><p>Semantic Versioning states that alpha versions are identified by this pattern: <code>MAJOR.MINOR.PATCH-alpha.NUMBER</code>, for example <code>2.0.0-alpha.1</code>.</p><h4>Beta</h4><p>Similar to alpha versions, beta versions are also prone to contain bugs, but their API will in theory not change. That means that you could potentially adapt your software to start using a beta version, and when the corresponding stable release is published, you shouldn&#x27;t need that many changes.</p><p>Semantic Versioning defines a pattern similar to the one for alpha versions: <code>MAJOR.MINOR.PATCH-beta.NUMBER</code>, for example <code>2.0.0-beta.1</code>.</p><h4>Release candidate</h4><p>Release candidates (RC) are pre-release versions that you will want to publish for the general user-base to test an upcoming release. You want to publish a RC so that it&#x27;s battle tested by as many people as possible, in order to find possible bugs and edge cases.</p><p>They should not contain many bugs, but some could be found. The public API should not change anymore.</p><p>According to Semantic Versioning, the pattern to identify a RC is <code>MAJOR.MINOR.PATCH-rc.NUMBER</code>, for example <code>2.0.0-rc.1</code>.</p><h3>Conclusion</h3><p>We have seen some approaches and considerations to properly version your software.</p><p>Versioning is not so straightforward when you don&#x27;t have a lot of experience, but as you have seen, you just need to know a small set of rules and use a bit your intuition.</p><p>With those tools, you will be able to properly version your software.</p>

What to take into account when versioning software

<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>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>