Register `EnvironmentType`s using their classes by serhii-lekariev · Pull Request #545 · SpineEventEngine/base-libraries

serhii-lekariev · 2020-06-10T14:26:37Z

This PR introduces several changes to Environment and EnvironmentTypes.

Tests and Production now have package-private constructors;
Environment now caches the class of the active EnvironmentType instead of an instance;
Environment now exposes an @Internal method to register an EnvironmentType by class. Classes to be registered using this method must have a parameterless constructor. This limitation is caused by the fact that we have to instantiate the specified EnvironmentType.

This leads to a signature change: public EnvironmentType type() -> public Class<? extends EnvironmentType> type().
It also allows to add a setTo(Class<? extends EnvironmentType>) method, which is now necessary, as users can no longer setTo(new Tests()), as Tests now has a package-private constructor.

`Invokables`

This PR also extracts some of the reflection-related utilities into an Invokables class.

Users of Methods may found the utilities there.

Bring back missing `@Immutable`s. Bump version.

…env-api

…registration by class works.

serhii-lekariev · 2020-06-10T14:43:05Z

@armiol, PTAL.

codecov · 2020-06-10T14:49:44Z

Codecov Report

Merging #545 into master will increase coverage by 0.03%.
The diff coverage is 90.00%.

@@             Coverage Diff              @@
##             master     #545      +/-   ##
============================================
+ Coverage     73.79%   73.82%   +0.03%     
- Complexity     2951     2959       +8     
============================================
  Files           506      506              
  Lines         11943    11972      +29     
  Branches        669      669              
============================================
+ Hits           8813     8838      +25     
- Misses         2903     2907       +4     
  Partials        227      227

armiol · 2020-06-10T19:42:08Z

base/src/main/java/io/spine/base/Environment.java

+            return register(envTypeInstance);
+        } catch (NoSuchMethodException | IllegalAccessException |
+                InstantiationException | InvocationTargetException e) {
+            String message = "Could not register environment type `%s` by class. You may try " +


Let's say something about the parameterless ctor in the message.

base/src/main/java/io/spine/base/Environment.java

base/src/test/java/io/spine/base/EnvironmentTest.java

warning suppression.

serhii-lekariev · 2020-06-11T08:46:05Z

@armiol, PTAL again.

serhii-lekariev · 2020-06-12T09:52:49Z

@armiol, PTAL again.

only check for it to instantiate it. Clean up, add and tweak documentation.

serhii-lekariev · 2020-06-12T15:37:14Z

@armiol, PTAL.

armiol · 2020-06-12T16:37:56Z

base/src/main/java/io/spine/base/Environment.java

+     * determine whether it's enabled} later.
+     *
+     * <p>The specified {@code type} must have a parameterless constructor.
+     * {@linkplain EnvironmentType#enabled() activity} of the specified environment type is going


activity should start from the capital letter. But I am not sure I understand this sentence:

activity of the specified environment type is going to be checked against an instance created by invoking the parameterless constructor.

Please rewrite into two or more simple sentences.

armiol · 2020-06-12T16:38:59Z

base/src/main/java/io/spine/base/Environment.java

+ *     assertThat(environment.is(AwsLambda.class)).isFalse();
+ * </pre>
+ *
+ * <p>{@linkplain #setTo(EnvironmentType) explicitly setting} the environment type overrides


When set {@linkplain ... explicitly}, ...

Notice the capital letter.

base/src/main/java/io/spine/base/Environment.java

armiol · 2020-06-12T16:41:16Z

base/src/main/java/io/spine/base/Environment.java

+ * <p>{@code Environment} caches the {@code EnvironmentType} once its calculated.
+ * This means that if one environment type has been found to be active, its instance is saved.
+ * If later it becomes logically inactive, e.g. the environment variable that's used to check the
+ * environment type changes, {@code Environment} is still going to return the cached value, unless


Don't use complex sentences.

... going to return the cached value. To overwrite the value (do something). Also, the value may be {@linkplain ... reset}.

serhii-lekariev · 2020-06-12T17:38:50Z

@armiol, PTAL again.

armiol

@serhii-lekariev LGTM with a single comment. Please make sure to bump time after this one is merged as well.

armiol · 2020-06-13T11:37:40Z

base/src/test/java/io/spine/base/EnvironmentTest.java

+        AtomicBoolean envCached = new AtomicBoolean(false);
+        assertThat(environment.is(Tests.class));
+        Thread thread = new Thread(() -> {
+            /*


Please convert this to the method-level comment.

Don't use inline comments except for emergency cases.

armiol

@serhii-lekariev please see my comments to the related PR in core-java first.

serhii-lekariev · 2020-06-13T14:49:13Z

@armiol, PTAL.

armiol · 2020-06-13T14:51:58Z

base/src/main/java/io/spine/base/Environment.java

    /**
     * Sets the current environment type to {@code type.getClass()}. Overrides the current value.
+     *
+     * <p>Calls {@link #register(EnvironmentType)} internally.


If the supplied type was not {@linkplain #register(EnvironmentType) registered} previously, it is registered.

armiol · 2020-06-13T14:52:22Z

base/src/main/java/io/spine/base/Environment.java

    /**
     * Sets the current environment type to the specified one. Overrides the current value.
+     *
+     * <p>Calls {@link #register(Class)} internally.


Same as above.

serhii-lekariev added 4 commits June 10, 2020 16:57

Allow registering env types using their class - @Internal use only.

437dd84

Bring back missing `@Immutable`s. Bump version.

Decrease Production env type access level.

456a039

Fix exception type, add tests.

443fdeb

Check whether the env type has a parameterless ctor.

6760997

serhii-lekariev self-assigned this Jun 10, 2020

serhii-lekariev and others added 6 commits June 10, 2020 17:27

Merge branch 'master' into stricter-env-api

7a22182

Fix PMD.

9b3e077

Merge remote-tracking branch 'origin/stricter-env-api' into stricter-…

d0b36e7

…env-api

Fix documentation.

5453ce2

Fix a wrong method call. Tweak the tests so that they check that the …

b423355

…registration by class works.

Tweak doc wording.

b29fc35

serhii-lekariev requested a review from armiol June 10, 2020 14:42

Fix tests.

9b725ed

Fix warning suppression wording.

0027d3c

armiol requested changes Jun 10, 2020

View reviewed changes

serhii-lekariev added 5 commits June 11, 2020 10:58

Extract a utility.

e7f15bf

Fix formatting.

c1da10f

Test env type caching.

c5cae0c

Add a simpler env type caching test. Also license-report and pom.

a3e5602

Fix formatting, wording, test declaration ordering. Explain a

dd59607

warning suppression.

serhii-lekariev requested a review from armiol June 11, 2020 08:42

serhii-lekariev added 6 commits June 11, 2020 12:45

Extract the instantiation utility.

252817d

Expose a setTo(Class<? extends EnvironmentType>).

323faeb

@Internalize a method.

90e20b2

Fix documentation and naming errors.

a26cd0c

Cache the class of the env type instead of its instance.

7f9655b

Fix documentation errors.

5d79b22

serhii-lekariev added 6 commits June 11, 2020 18:01

Clean up.

db60efe

Mention erasing the registered classes.

044d76e

Fix documentation.

38ff164

Update config.

aa52481

Extract reflection utils into a single Invokables class.

431dd04

Add @throws documentation.

18d3fd1

serhii-lekariev added 2 commits June 12, 2020 16:00

Hide a method that looks for a parameterless constructor. Its users

8c52731

only check for it to instantiate it. Clean up, add and tweak documentation.

Shorten a method name.

e1a1018

armiol requested changes Jun 12, 2020

View reviewed changes

serhii-lekariev added 3 commits June 12, 2020 20:17

Fix Javadoc mistakes.

9013ab8

Fix Javadoc errors.

0da0c93

Rearrange utitlity methods, fix wording mistakes.

f67ff1b

serhii-lekariev requested a review from armiol June 12, 2020 17:38

Fix a wrong link.

2558a82

armiol approved these changes Jun 13, 2020

View reviewed changes

armiol requested changes Jun 13, 2020

View reviewed changes

serhii-lekariev added 4 commits June 13, 2020 15:32

Add a Javadoc paragraph for a @Test method.

e220c60

register an env on setTo.

6b4f302

Prefer register(Class) over register(EnvironmentType) in tests.

858bd7d

Mention the fact that environment types are registered automatically.

459a670

serhii-lekariev requested a review from armiol June 13, 2020 14:49

armiol approved these changes Jun 13, 2020

View reviewed changes

Tweak Javadoc wording.

36868c6

serhii-lekariev merged commit f48c5cd into master Jun 13, 2020

serhii-lekariev deleted the stricter-env-api branch June 13, 2020 15:26

dmitrykuzmin mentioned this pull request Sep 8, 2020

Release 1.6.0 #565

Merged

Conversation

serhii-lekariev commented Jun 10, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Invokables

Uh oh!

serhii-lekariev commented Jun 10, 2020

Uh oh!

codecov bot commented Jun 10, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

armiol Jun 10, 2020

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

serhii-lekariev commented Jun 11, 2020

Uh oh!

serhii-lekariev commented Jun 12, 2020

Uh oh!

serhii-lekariev commented Jun 12, 2020

Uh oh!

armiol Jun 12, 2020

Choose a reason for hiding this comment

Uh oh!

armiol Jun 12, 2020

Choose a reason for hiding this comment

Uh oh!

Uh oh!

armiol Jun 12, 2020

Choose a reason for hiding this comment

Uh oh!

serhii-lekariev commented Jun 12, 2020

Uh oh!

armiol left a comment

Choose a reason for hiding this comment

Uh oh!

armiol Jun 13, 2020

Choose a reason for hiding this comment

Uh oh!

armiol left a comment

Choose a reason for hiding this comment

Uh oh!

serhii-lekariev commented Jun 13, 2020

Uh oh!

armiol Jun 13, 2020

Choose a reason for hiding this comment

Uh oh!

armiol Jun 13, 2020

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

serhii-lekariev commented Jun 10, 2020 •

edited

Loading

`Invokables`

codecov bot commented Jun 10, 2020 •

edited

Loading