[FEATURE] Introduce SpecificationVersion class #431

larskissel · 2021-11-19T13:38:25Z

Introduce a utility module which handles SpecVersion
comparators for an easier SpecVersion maintainance
within the UI5 Tooling source code.
This utility is a kind of semver compatibility layer which
allows using semver functions with the SpecVersion
typical format "Major.Minor".

JIRA: CPOUI5FOUNDATION-224

coveralls · 2021-11-19T13:39:39Z

Coverage increased (+0.1%) to 94.71% when pulling f1e97b7 on SpecVersionUtil into 89ae940 on main.

RandomByte

LGTM. But as discussed, let's not merge this yet and wait for the consuming part to be implemented.

RandomByte · 2022-11-23T09:52:55Z

I changed the implementation towards a "SpecVersionComparator" class, which is instantiated with a given Specification Version and can be used to compare that to other versions or ranges.

Instances of the class can then be provided directly by project-instances (getSpecVersionComparator()). Allowing consumers to not have to handle the project's specVersion themselves.

matz3

Maybe not a [FEATURE], as this is (currently) just used internally, right?

RandomByte · 2022-11-24T12:24:34Z

The Specification.js getSpecVersionComparator function is public though 🤔

matz3

Okay, true

Introduce a utility module which handles SpecVersion comparators for an easier SpecVersion maintainance within the UI5 Tooling source code. This utility is a kind of semver compatibility layer which allows using semver functions with the SpecVersion typical format "Major.Minor". JIRA: CPOUI5FOUNDATION-224

Add factory function to Specification class

Static methods now create an instance and always throw for unsupported versions (except isSupportedSpecVersion)

RandomByte · 2022-11-24T16:30:14Z

Rebased onto main

… specVersion string

lib/specifications/utils/SpecVersionComparator.js

Co-authored-by: Günter Klatt <57760635+KlattG@users.noreply.github.com>

KlattG · 2022-11-25T09:54:36Z

lib/specifications/Specification.js

@@ -151,6 +143,17 @@ class Specification {
 		return this._specVersion;
 	}

+	/**
+	 * Returns an instance of a helper class allowing for convenient comparison
+	 * operations against this instance's Specification Version


Does everybody know what a Specification Version is? I'm wondering if this whole versioning business is explained somewhere in the documentation.

We have a chapter in our documentation regarding that: https://sap.github.io/ui5-tooling/pages/Configuration/#specification-versions

matz3 · 2022-11-28T12:47:50Z

lib/build/TaskRunner.js

@@ -309,12 +309,13 @@ class TaskRunner {
 					params.dependencies = dependencies;
 				}

-				if (task.getSpecVersion() === "3.0") {
+				const specVersion = task.getSpecVersionComparator();


I struggle a bit with the naming of both the class and the getter. Here it's used with specVersion as local variable which reads fine (specVersion is greater then or equal to 3.0). But specVersionComparator.gte("3.0") would be strange.
But I also don't have a better idea, also as getSpecVersion() already returns the string. My only idea is to combine both to have getSpecVersion().toString() and getSpecVersion().gte("3.0")

I'm not happy with the naming either.

I guess we could make this a SpecificationVersion class and have getSpecVersion() always return an instance of it. Indeed that might make things a bit simpler in the end.

Yes, that sounds good 👍🏻

Done in latest commit. I think this is way better, since the main use of a project's spec version is to compare it anyways 👍

Use it as the main representation of a specification version (instead of the raw string as before). This also helps motivate the use of the helper functions to compare the version. Which is the most common use of the specification version anyways.

See SAP/ui5-project#431

With the latest changes in SAP/ui5-project#431, the method now returns an instance of a "SpecificationVersion" class. This would require an additional specVersion-dependent interface. Since use cases in custom tasks and -middelare are not clear, we should rather keep it simple for now and do not provide this method.

See SAP/ui5-project#431

With the latest changes in SAP/ui5-project#431, the method now returns an instance of a "SpecificationVersion" class. This would require an additional specVersion-dependent interface. Since use cases in custom tasks and -middelare are not clear, we should rather keep it simple for now and do not provide this method.

Introduce a helper class representing a Specification Version. It provides methods for comparing versions, which simplifies version checks across the UI5 Tooling source code. The methods act as a kind of semver-adapter which ultimately allows executing specific semver functions on the SpecVersion format "Major.Minor". Co-authored-by: Günter Klatt <57760635+KlattG@users.noreply.github.com> Co-authored-by: Merlin Beutlberger <m.beutlberger@sap.com>

matz3 changed the base branch from master to next November 22, 2021 08:35

larskissel requested review from RandomByte and matz3 November 24, 2021 10:25

RandomByte previously approved these changes Nov 30, 2021

View reviewed changes

RandomByte dismissed their stale review via 5d3e8d7 June 15, 2022 13:13

RandomByte force-pushed the SpecVersionUtil branch from ba83402 to 5d3e8d7 Compare June 15, 2022 13:13

flovogt changed the base branch from next to main November 3, 2022 13:30

RandomByte force-pushed the SpecVersionUtil branch from 5d3e8d7 to 9fc52ee Compare November 17, 2022 10:36

RandomByte requested a review from flovogt November 17, 2022 10:37

RandomByte force-pushed the SpecVersionUtil branch from 9fc52ee to 8d5273a Compare November 17, 2022 10:39

RandomByte changed the title ~~[FEATURE] Introduce SpecVersionUtil~~ [FEATURE] Introduce SpecVersionComparator Nov 17, 2022

RandomByte force-pushed the SpecVersionUtil branch 2 times, most recently from ba1fce7 to f01bb21 Compare November 17, 2022 10:51

matz3 requested changes Nov 24, 2022

View reviewed changes

matz3 previously approved these changes Nov 24, 2022

View reviewed changes

larskissel and others added 4 commits November 24, 2022 17:25

[INTERNAL] SpecVersionUtil: Transform to SpecVersionComparator class

84807a4

Add factory function to Specification class

[INTERNAL] SpecVersionComparator: Refactor static methods, add JSDoc

af1b134

Static methods now create an instance and always throw for unsupported versions (except isSupportedSpecVersion)

[INTERNAL] Update JSDoc

8074615

RandomByte dismissed matz3’s stale review via 8074615 November 24, 2022 16:30

RandomByte force-pushed the SpecVersionUtil branch from ef871e8 to 8074615 Compare November 24, 2022 16:30

RandomByte requested a review from KlattG November 24, 2022 16:30

[INTERNAL] TaskUtil: Accept SpecVersionComparator instance instead of…

1890a14

… specVersion string

KlattG suggested changes Nov 25, 2022

View reviewed changes

[INTERNAL] Apply suggestions from UA review

e4c2433

Co-authored-by: Günter Klatt <57760635+KlattG@users.noreply.github.com>

RandomByte force-pushed the SpecVersionUtil branch from 3d105ba to e4c2433 Compare November 25, 2022 09:07

KlattG reviewed Nov 25, 2022

View reviewed changes

KlattG previously approved these changes Nov 25, 2022

View reviewed changes

RandomByte dismissed KlattG’s stale review via 0dbaae6 November 25, 2022 16:59

[INTERNAL] TaskRunner: Use SpecVersionComparator

22f62de

RandomByte force-pushed the SpecVersionUtil branch from 0dbaae6 to 22f62de Compare November 25, 2022 17:09

RandomByte added 2 commits November 28, 2022 09:23

[INTERNAL] package.json: Export SpecVersionComparator

7bd4c09

[INTERNAL] TaskUtil: Add missing resourceFactory test

7630ad2

RandomByte mentioned this pull request Nov 28, 2022

[FEATURE] MiddlewareUtil: Add getProject/getDependencies/resourceFactory API to interface SAP/ui5-server#547

Merged

matz3 reviewed Nov 28, 2022

View reviewed changes

RandomByte added a commit to SAP/ui5-builder that referenced this pull request Nov 28, 2022

[INTERNAL] Adapt to new Specification#getSpecVersion implementation

99ae94e

See SAP/ui5-project#431

This was referenced Nov 28, 2022

[INTERNAL] Adapt to new Specification#getSpecVersion implementation SAP/ui5-builder#849

Merged

[INTERNAL] Adapt to new Specification#getSpecVersion implementation SAP/ui5-cli#578

Merged

RandomByte added a commit to SAP/ui5-cli that referenced this pull request Nov 28, 2022

[INTERNAL] Adapt to new Specification#getSpecVersion implementation

421c418

See SAP/ui5-project#431

matz3 approved these changes Nov 28, 2022

View reviewed changes

RandomByte changed the title ~~[FEATURE] Introduce SpecVersionComparator~~ [FEATURE] Introduce SpecificationVersion class Nov 28, 2022

RandomByte merged commit e57842b into main Nov 28, 2022

RandomByte deleted the SpecVersionUtil branch November 28, 2022 15:03

RandomByte added a commit to SAP/ui5-cli that referenced this pull request Nov 28, 2022

[INTERNAL] Adapt to new Specification#getSpecVersion implementation

f2e914c

See SAP/ui5-project#431

RandomByte added a commit to SAP/ui5-builder that referenced this pull request Nov 29, 2022

[INTERNAL] Adapt to new Specification#getSpecVersion implementation

a691cfc

See SAP/ui5-project#431

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[FEATURE] Introduce SpecificationVersion class #431

[FEATURE] Introduce SpecificationVersion class #431

larskissel commented Nov 19, 2021

coveralls commented Nov 19, 2021 •

edited

Loading

RandomByte left a comment •

edited

Loading

RandomByte commented Nov 23, 2022

matz3 left a comment

RandomByte commented Nov 24, 2022

matz3 left a comment

RandomByte commented Nov 24, 2022

KlattG Nov 25, 2022

RandomByte Nov 25, 2022

matz3 Nov 28, 2022 •

edited

Loading

RandomByte Nov 28, 2022 •

edited

Loading

matz3 Nov 28, 2022

RandomByte Nov 28, 2022

[FEATURE] Introduce SpecificationVersion class #431

[FEATURE] Introduce SpecificationVersion class #431

Conversation

larskissel commented Nov 19, 2021

coveralls commented Nov 19, 2021 • edited Loading

RandomByte left a comment • edited Loading

Choose a reason for hiding this comment

RandomByte commented Nov 23, 2022

matz3 left a comment

Choose a reason for hiding this comment

RandomByte commented Nov 24, 2022

matz3 left a comment

Choose a reason for hiding this comment

RandomByte commented Nov 24, 2022

KlattG Nov 25, 2022

Choose a reason for hiding this comment

RandomByte Nov 25, 2022

Choose a reason for hiding this comment

matz3 Nov 28, 2022 • edited Loading

Choose a reason for hiding this comment

RandomByte Nov 28, 2022 • edited Loading

Choose a reason for hiding this comment

matz3 Nov 28, 2022

Choose a reason for hiding this comment

RandomByte Nov 28, 2022

Choose a reason for hiding this comment

coveralls commented Nov 19, 2021 •

edited

Loading

RandomByte left a comment •

edited

Loading

matz3 Nov 28, 2022 •

edited

Loading

RandomByte Nov 28, 2022 •

edited

Loading