Troubleshooting¶

UI5 Server¶

Chrome Redirects HTTP URLs to HTTPS (ERR_SSL_PROTOCOL_ERROR)¶

An HTTPS server or proxy that was previously running on a domain (e.g. localhost), might have set an HSTS header, enforcing Chrome to always use HTTPS for this domain. See https://www.chromium.org/hsts. This makes it impossible to connect to an HTTP-only server running on the same domain.

Resolution¶

You need to delete the HSTS mapping in chrome://net-internals/#hsts by entering the domain name (e.g. localhost) and pressing "delete".

Issues Not Listed Here¶

Please follow our Contribution Guidelines on how to report an issue.

UI5 Project¶

Corrupt Framework Dependencies¶

When using the UI5 CLI in versions lower than v2.9.1 or the @ui5/project module in versions lower than v2.2.6 you might experience build- or runtime issues caused by missing or corrupt files in one or more UI5 framework dependencies. Note that this does not affect other project dependencies, such as reuse libraries, which are installed via external package managers like npm or Yarn.

These issues can be the result of an aborted install during a preceding UI5 Tooling execution. Because of a bug that has since been fixed, UI5 Tooling assumes that the preceding install was successful and uses the potentially corrupted dependency.

Resolution¶

Remove the .ui5/framework/ directory from your user's home directory.

rm -rf ~/.ui5/framework/

Any missing framework dependencies will be downloaded again during the next UI5 Tooling invocation.

~/.ui5 Taking too Much Disk Space¶

There are possibly many versions of UI5 framework dependencies installed on your system, taking a large amount of disk space.

Resolution¶

Remove the .ui5/framework/ directory from your user's home directory:

rm -rf ~/.ui5/framework/

Any missing framework dependencies will be downloaded again during the next UI5 Tooling invocation.

Benchmarking UI5 Tooling¶

For benchmarking UI5 Tooling we typically make use of the open source tool hyperfine.

In general we only benchmark calls to the UI5 CLI. However, we might add scripted benchmarks for some components in the future.

The following is a walk-through on how to evaluate the performance impact of an imaginary change in the UI5 Builder project.

Setup¶

1. Install hyperfine

2. Prepare the UI5 Tooling projects you want to measure (optional if your development environment already reflects this):

   1. Start in an empty directory

      mkdir ui5-tooling-benchmark && cd ui5-tooling-benchmark/
      

   2. Clone UI5 CLI

      git clone git@github.com:SAP/ui5-cli.git
      

   3. Clone UI5 Builder (or your fork)

      git clone git@github.com:SAP/ui5-builder.git
      

      Make sure you check out the master branch, since we'll perform the baseline test first
   4. Install npm dependencies in both directories

      (cd ui5-cli && npm install)
      (cd ui5-builder && npm install)
      

   5. Create global npm links for both projects

      (cd ui5-cli && npm link)
      (cd ui5-builder && npm link)
      

   6. Link UI5 Builder into UI5 CLI

      (cd ui5-cli && npm link @ui5/builder)
      

   7. Verify your setup

      ui5 --version
      

      This should output the version and location of the UI5 CLI you just cloned.

      For example:

      2.6.6 (from /my/home/ui5-tooling-benchmark/ui5-cli/bin/ui5.js)
      

3. Prepare your test project (we choose the openui5-sample-app)

   1. Clone the project

      git clone git@github.com:SAP/openui5-sample-app.git
      

   2. Navigate into the project

      cd openui5-sample-app
      

   3. Install any required npm dependencies

      npm install
      

      Note: We won't link UI5 CLI into this project. Instead, we'll call it directly.
   4. Verify that the previously installed UI5 CLI can be called with the following command:

      UI5_CLI_NO_LOCAL=X node /my/home/ui5-tooling-benchmark/ui5-cli/bin/ui5.js --version
      

      On Windows:

      set UI5_CLI_NO_LOCAL=X node /my/home/ui5-tooling-benchmark/ui5-cli/bin/ui5.js --version
      

      (Replace the path to ui5.js with the one shown in the previous ui5 --version output)

Benchmarking¶

1. Depending on how reliable you'd like the measurements to be, consider preparing your system:

   1. Connect your computer to a power supply
   2. Make sure no updates or anti-virus scans are taking place
   3. Close all applications. This includes your IDE, since it might start indexing any new files created during the build, thus impacting I/O
   4. Don't interact with your system wile the benchmarking is running

2. Perform the baseline measurement

   1. In the project, start your first benchmark

      hyperfine --warmup 1 \
      'UI5_CLI_NO_LOCAL=X node /my/home/ui5-tooling-benchmark/ui5-cli/bin/ui5.js build' \
      --export-markdown ./baseline.md
      

      On Windows:

      hyperfine --warmup 1 \
      'set UI5_CLI_NO_LOCAL=X node /my/home/ui5-tooling-benchmark/ui5-cli/bin/ui5.js build' \
      --export-markdown ./baseline.md
      

   2. Your baseline benchmark is now stored in baseline.md and should look similar to this:

      Command	Mean [s]	Min [s]	Max [s]	Relative
      UI5_CLI_NO_LOCAL=X node /my/home/ui5-tooling-benchmark/ui5-cli/bin/ui5.js build	1.439 ± 0.036	1.400	1.507	1.00

3. Prepare your change

   1. Switch to the branch that contains your change

      (cd ../ui5-builder && git checkout my-change)
      

   2. If your change requires different npm dependencies, reinstall them

      (cd ../ui5-builder && npm install)
      

   3. The link from UI5 CLI is still in place. However, if you have changes in multiple UI5 Tooling modules, you might need to npm link those again

4. Perform the change measurement

   1. In the project, start your second benchmark

      hyperfine --warmup 1 \
      'UI5_CLI_NO_LOCAL=X node /my/home/ui5-tooling-benchmark/ui5-cli/bin/ui5.js build' \
      --export-markdown ./my_change.md
      

      On Windows:

      hyperfine --warmup 1 \
      'set UI5_CLI_NO_LOCAL=X node /my/home/ui5-tooling-benchmark/ui5-cli/bin/ui5.js build' \
      --export-markdown ./my_change.md
      

   2. Your change's benchmark is now stored in my_change.md

Compile Results¶

1. Merge both measurements into one markdown

   1. Either remove the Relative column or calculate the relative difference yourself.

   2. You should end up with a markdown like this:

      | Command | Mean [s] | Min [s] | Max [s] |
      |:---|---:|---:|---:|
      | `UI5_CLI_NO_LOCAL=X node /my/home/ui5-tooling-benchmark/ui5-cli/bin/ui5.js build` | 1.439 ± 0.036 | 1.400 | 1.507 |
      | `UI5_CLI_NO_LOCAL=X node /my/home/ui5-tooling-benchmark/ui5-cli/bin/ui5.js build` | 1.584 ± 0.074 | 1.477 | 1.680 |
      

      Rendering like this:

      Command	Mean [s]	Min [s]	Max [s]
      UI5_CLI_NO_LOCAL=X node /my/home/ui5-tooling-benchmark/ui5-cli/bin/ui5.js build	1.439 ± 0.036	1.400	1.507
      UI5_CLI_NO_LOCAL=X node /my/home/ui5-tooling-benchmark/ui5-cli/bin/ui5.js build	1.584 ± 0.074	1.477	1.680

2. You can now share these results on GitHub or wherever you might need them.

Happy benchmarking! 🏎