feat: implement dependency injection #87

pollend · 2021-02-27T16:53:13Z

This is partially inspired by some of the patterns adopted with how the current Context Scheme works in Terasology with some inspiration from Dagger, Micronaut and guice.

The BeanContext is created with a Service Registry that defines all the dependencies linked to a given context. Resources request from the context will attempt to resolve dependencies from the current context and then tries to look at a parent context if the dependency is not resolved there.

BeanEnvironment is an internal cache that is used to track loaded in dependencies that are defined from the annotationProcessor. this is loaded in through a META-INF/services config that is generated by classes marked with @Inject/@Introspected/@Singleton/@Transient. the class definitions are fully defined so there is a minimum amount of scanning over the application classpath. This dramatically improves application boot times.

@Singleton/@Transient are not drive by anything without defining a scanner that can be used to search for dependencies that match a given annotation or pattern. A sample is defined in org.terasology.gestalt.di.scanners but more standard ones can be added for convince.

Dependencies are associated with 3 different scopes

Singleton - lives as long as the context is still active
Transient - new instance for every request or injection
Scoped - new instance for every layer

Usage

Class DepA {
   @Inject
   protected DepB;
}

Class DepB {
}


static void main() {
   ServiceRegistry registry = new ServiceRegistry();
   registry.with(DepA.class).lifetime(Lifetime.Singleton);
   registry.with(DepB.class).lifetime(Lifetime.Singleton);

  BeanContext cntx = new DefaultBeanContext(registry);
  DepA  a = cntx.get(DepA.class);
}

features:

keep a stack chain of dependencies and print out a tree with how a dependency failed to resolve
catch cyclic dependencies and throw an exception where depA --> DepB --> DepA
support Lazy type dependencies that can be resolved at a later point.
support Optional type dependencies
for service registry we should have suppliers with multiple inputs that can be resolved.
support Provider type dependencies that can be resolved at request.
replaces Reflections with own ClassIndexProcessor and ResourcesProcessor which works with gradle and idea in same way.
integrated gestalt-module you can use DI inside modules.

Basic and naive BeanDefinitionGeneration.

…annotations value (Maps.newHashMap)

…fiers for generated *BeanDefinition classes

fix NPE when proccessing annotations and make BeanDefinition `public` and `final`

Fix some Override error add exceptions. Create its works test

Fix parent bean resolving Fix default target for inject is null. (after `ServiceRegistry#with` only) Write tests: childBeanContext and BeanDependecies

…on - not dependent libs not compile without it.

…fixes working with `NUI` in `DestSol`

… generic types.

gestalt-di/src/main/java/org/terasology/gestalt/di/BeanEnvironment.java

Gestalt DI: Fixed building and running on Windows

Gestalt DI: Fixed running on android

pollend · 2021-03-30T04:15:17Z

I update master with develop and tagged it v7.0.7 so I think we should be good on that end just need to get approval for this PR @DarkWeird. anything we need to finalize since I think this is in a decent state to develop a v8.0.0 of this library.

BenjaminAmos

Some minor comments here but the code works.

BenjaminAmos · 2021-03-30T17:39:43Z

gestalt-android-testbed/build.gradle

@@ -41,24 +31,15 @@ android {
        sourceCompatibility JavaVersion.VERSION_1_8
        targetCompatibility JavaVersion.VERSION_1_8
    }
+    packagingOptions {
+        merge 'META-INF/annotations/*'


Just leaving a note here to explain that this merges all the META-INF/annotations files from the jars that are dependencies of gestalt-android-testbed into each other. Android APK files aggregate all dependencies and the main program into a single archive. This might need to be done with META-INF/subtypes in the future but hasn't been needed so-far.

BenjaminAmos · 2021-03-30T17:50:29Z

gestalt-inject-java/build.gradle

+
+repositories {
+    maven {
+        url = 'https://heisluft.tk/maven/'


heisluft.tk isn't the URL for the JSemver dependency anymore. The domain doesn't resolve anymore and was moved to heisluft.de. It was changed elsewhere in bf25da8.

Suggested change

url = 'https://heisluft.tk/maven/'

url = 'https://heisluft.de/maven/'

I talked with @Cervator and I think we are planning on managing it in the Terasology maven.

gestalt-inject-java/build.gradle

BenjaminAmos · 2021-03-30T17:55:14Z

gestalt-inject/src/main/java/org/terasology/context/FindResourcesClassLoader.java

@@ -0,0 +1,8 @@
+package org.terasology.context;


I added this in but looking at it again, maybe it should be in a different package?

gestalt-module/src/main/java/org/terasology/gestalt/module/sandbox/APIScanner.java

BenjaminAmos · 2021-03-30T18:14:16Z

gestalt-module/src/main/java/org/terasology/gestalt/module/ModuleEnvironment.java

        List<Module> orderedModules = getModulesOrderedByDependencies();
        Predicate<Class<?>> classpathModuleClassesPredicate = orderedModules.stream().map(Module::getClassPredicate).reduce(x -> false, Predicate::or);
        for (final Module module : orderedModules) {
-            if (!module.getClasspaths().isEmpty() && !hasClassContent(module)) {
+            // TODO return non-code module handling.


Destination Sol only has one code module that I know of (warp). All the rest are asset-only modules. Would they not work with the current code?

gestalt-di/src/test/java/org/terasology/gestalt/di/singleton/TestBasicSingletonTest.java

BenjaminAmos · 2021-03-30T18:48:07Z

gestalt-di/src/main/java/org/terasology/gestalt/di/index/UrlClassIndex.java

+    private static final String METAINF = "META-INF";
+    // HACK: Android always claims that the URL of the "META-INF" directory or any of its subdirectories doesn't exist.
+    //       It will return the URL of any files within the "META-INF" directory and its subdirectories though.
+    private static final String METAINF_TEST_FILE = METAINF + "/gestalt-indexes-present";


I'm referencing #94 here to explain why the folder checks are done in such an unusual way. I added a work-around especially for android, essentially. The tests still passed though, so I assume this didn't break anything.

umm, that would be a question for @DarkWeird.

BenjaminAmos · 2021-03-30T19:15:17Z

...ect-java/src/main/java/org/terasology/gestalt/annotation/processing/ClassIndexProcessor.java

+            annotationTypeWriter.finish();
+            subtypesTypeWriter.finish();
+            FileObject file = filer.createResource(StandardLocation.CLASS_OUTPUT, "", "META-INF/gestalt-indexes-present");
+            Writer writer = file.openWriter();


I added the gestalt-indexes-present file for android, as it doesn't seem to support querying META-INF directories in an APK. This could possibly be moved to its own TypeWriter class.

BenjaminAmos · 2021-03-30T19:16:28Z

gestalt-inject-java/src/test/java/org/terasology/gestalt/support/Parser.java

+        JavaCompiler compiler = ToolProvider.getSystemJavaCompiler();
+        DiagnosticCollector<JavaFileObject> diagnosticCollector = new DiagnosticCollector<>();
+        final StandardJavaFileManager standardFileManager = compiler.getStandardFileManager(diagnosticCollector, Locale.getDefault(), UTF_8);
+        return null;


Is it the intent of this method to always return null? Is it unfinished?

pollend and others added 30 commits September 5, 2020 23:51

started work on DI model

6ca7a41

update annotation scheme

08e04e9

start work on definition loading

61f57eb

add sterotype helper

239f67f

Basic and naive BeanDefinitionGeneration.

c72bb5b

Merge pull request #1 from DarkWeird/di

34ec17d

Basic and naive BeanDefinitionGeneration.

update annotation metadata

14c87e8

add annotation metadata

6dd08e9

add start of lifecycle model

f728ae1

add lifecycle model

72ac6b6

update registry pattern

00b8575

add introspection scheme and dependency scheme

727733e

add instance model

39d2851

strater on resolution

190f653

started work on context

045cc48

setup object model

39c1e8b

update instance implementation

e845739

update service graph

4dac633

update beankey

e522bc7

fix(gestalt-di): fix NPE at annotations - add DefaultAnnotationValue#…

55bfc02

…annotations value (Maps.newHashMap)

fix(gestalt-di): fix not accessable class - add public and final modi…

35e7079

…fiers for generated *BeanDefinition classes

Merge pull request #2 from DarkWeird/feature/DI

2ac6674

fix NPE when proccessing annotations and make BeanDefinition `public` and `final`

update annotationprocessor

f746a47

Merge branch 'feature/DI' of github.com:pollend/gestalt into feature/DI

8498b02

add beantransation

82a04a2

implement BeanContext

20c63da

Merge branch 'develop' into feature/DI

fcce218

Convert get beans and resolve to returns java.util.Optional

5def158

Fix some Override error add exceptions. Create its works test

Fix Optional<Optional<T>> returns from resolve.

70770c1

Fix parent bean resolving Fix default target for inject is null. (after `ServiceRegistry#with` only) Write tests: childBeanContext and BeanDependecies

chore(gestalt-di): code cleanup, refactor raw-types

6a2a838

pollend and others added 7 commits March 18, 2021 22:07

replaced introspected with Service and added more docs

60dc7cc

update javadocs

95cb2ff

fix(gestalt-di): fix package with target annotation writing.

267abd1

fix(gestalt-di): add underscore as valid part of filename

7c94019

fix(gestalt-di): provide JCIP annotations as api instead implementati…

45519ce

…on - not dependent libs not compile without it.

fix(gestalt-di): UrlClassIndex#byClassloader* loads all resources. …

88c7971

…fixes working with `NUI` in `DestSol`

fix(gestalt-di): make type erasure for writing index. fixes index for…

65ece59

… generic types.

DarkWeird mentioned this pull request Mar 19, 2021

feat(gestalt-di): Compactability with gestalt-di MovingBlocks/TeraNUI#44

Merged

pollend added 2 commits March 20, 2021 10:34

chore: cleanup and organization

db49b97

cleanup argument and add handler for optional

325293f

pollend requested a review from keturn March 21, 2021 01:54

lyndseyBeil reviewed Mar 21, 2021

View reviewed changes

gestalt-di/src/main/java/org/terasology/gestalt/di/BeanEnvironment.java Show resolved Hide resolved

BenjaminAmos and others added 8 commits March 22, 2021 19:39

Fixed gestalt-inject-java annotation processing errors on Windows.

8003208

Fixed gestalt-android and gestalt-android-testbed compilation.

7ef60d5

Fixed ResourceProcessor producing incorrect paths on Windows.

55d057c

Fixed gestalt-android-testbed to work with gestalt-di changes.

a33e8df

Merge pull request #93 from BenjaminAmos/gestalt-di-path-fixes

c7ab1dd

Gestalt DI: Fixed building and running on Windows

Merge pull request #94 from BenjaminAmos/gestalt-di-android-fixes

c09de06

Gestalt DI: Fixed running on android

add annotation test

418603e

update annotation value

821c92a

pollend mentioned this pull request Mar 28, 2021

chore: remove usage of RegisterCopyStrategy MovingBlocks/TeraNUI#50

Open

DarkWeird approved these changes Mar 30, 2021

View reviewed changes

BenjaminAmos approved these changes Mar 30, 2021

View reviewed changes

pollend and others added 3 commits March 30, 2021 20:56

remove reflection and unused test

7c97ac1

chore(gestalt-di): handle di's TODOs

0d2c0a7

chore(gestalt-di): add exception logging instead printStackTrace

e63977e

pollend merged commit 0832d97 into develop Apr 3, 2021

pollend deleted the feature/DI branch April 3, 2021 19:33

pollend mentioned this pull request Nov 20, 2021

feat: implementation of gestalt-DI MovingBlocks/DestinationSol#622

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: implement dependency injection #87

feat: implement dependency injection #87

pollend commented Feb 27, 2021 •

edited by DarkWeird

Loading

pollend commented Mar 30, 2021

BenjaminAmos left a comment

BenjaminAmos Mar 30, 2021

BenjaminAmos Mar 30, 2021

pollend Mar 31, 2021 •

edited

Loading

BenjaminAmos Mar 30, 2021

BenjaminAmos Mar 30, 2021

BenjaminAmos Mar 30, 2021

pollend Mar 31, 2021

BenjaminAmos Mar 30, 2021

BenjaminAmos Mar 30, 2021

	url = 'https://heisluft.tk/maven/'
	url = 'https://heisluft.de/maven/'

feat: implement dependency injection #87

feat: implement dependency injection #87

Conversation

pollend commented Feb 27, 2021 • edited by DarkWeird Loading

pollend commented Mar 30, 2021

BenjaminAmos left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

pollend Mar 31, 2021 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

pollend commented Feb 27, 2021 •

edited by DarkWeird

Loading

pollend Mar 31, 2021 •

edited

Loading