refactor(builder): Run generateVersionInfo by default

[maxreichmann]

JIRA: CPOUI5FOUNDATION-1157

---

What has been done?

• Exclusion of task generateVersionInforemoved
  • now it will be executed by default for every build of project type application (default, jsdoc, self-contained)
• Tests refactored accordingly
  • +new test verifying exclusion/inclusion of generateVersionInfo: ProjectBuilder.integration.js:2758
• Docs
  • migrate-v5.md: new section explaining new behavior
  • Builder.md: changed generateVersionInfo from disabled to enabled in Standard Tasks table

Info

• for Server:
  • task generateVersionInfo is explicitly NOT executed because middleware versionInfo IS executed (which creates sap-ui-version.json anyways)
  • Test verifying exclusion of generateVersionInfo: BuildServer.integration.js:1030
  • (existing) Test verifying sap-ui-version.json is generated: server/test/lib/server/main.js:204

[matz3]

We should also check how this now relates to the versionInfo middleware. My assumption would be that we need to keep the middleware to serve the file for non-application projects (and when the task was skipped?). For application projects, we should be able to just serve the file from the application build output. This should at least be tested, confirmed and documented.

[maxreichmann]

Update:

• generateVersionInfo is now excluded from server builds (for normal builds, it's executed by default).
• Tests are added and existing ones are adjusted.
• Docs are adjusted.
  --> Main part is done and ready for review.

---

"Side tasks done": I'm also fine to move those changes out to another PR if this eases the review process.

[matz3]

"Side tasks done": I'm also fine to move those changes out to another PR if this eases the review process.

Yes, I think that would help with reviewing the docs changes. Thanks for looking into that!

[matz3]

This handling should be moved to into the @ui5/server code in packages/server/lib/server.js, which does provide an HTTP server with the mentioned versionInfo middleware.

This @ui5/project API only returns the BuildServer, which is the underlying functionality, but it is not opinionated about the integration, and does not know about the versionInfo middleware.

This means that the BuildServer integration tests are likely unaffected by this change, which is fine.

[maxreichmann]

This means that the BuildServer integration tests are likely unaffected by this change, which is fine.

I understand why to move the logic to server.js (originally I also thought about this). But isn't it also fine in ProjectGraph.js? I mean, it'd be in the dedicated serve() function outside of build() and we would have more realistic tests in BuildServer.integration.js. With the other way, the tests are logically correct but tend to be more unit test like.