feat!: add dependency manager

[jonaslagoni]

Description
Up until now, dependencies have been part of the renderer instance as it was only the presets and renderers that needed to add dependencies, however, there is a need to let the type constrainer add dependencies. This creates a bit of a dilemma, as the renderer expects a constrained model, and to create a constrained model it needs a renderer...

So therefore I suggest we split out the dependency functionality into its own instance where each language can create its own custom logic for handling dependencies. For example, TypeScript needs specific functions to more efficiently make imports based on the options from the user.

I would love to have alternatives, and if you have something please let me know, cause it does create somewhat of a complexity 🙃 But maybe this is for version 2? 🤷

Alternatives I considered:

• We could use something like a singleton pattern instead of passing the instance across the entire flow, but it's not possible because each rendering needs its own set of dependencies.
• Redoing the renderer + constrained model dependency so they would no longer be dependent on each other and we could then pass the renderer to the container. This just seems more complex to do than this...
• ??

Changes introduced:

• Introduce the concept of dependency managers which you have access to in constraints and presets.

Related issue(s)
Fixes #851

[magicmatatjahu]

For me these solution can be, but the AbstractDependencyManager itself should have a method that renders all dependencies as output like renderDependencies(). In addition, a better solution would be if we could pass the dependency manager class as generator option (definition of it) and create it during rendering - currently someone can pass this via an argument to the method, and it should be passed to the constructor option.

[jonaslagoni]

For me these solution can be, but the AbstractDependencyManager itself should have a method that renders all dependencies as output like renderDependencies()

I think that makes sense, let me try to look into that!

In addition, a better solution would be if we could pass the dependency manager class as generator option (definition of it) and create it during rendering - currently someone can pass this via an argument to the method, and it should be passed to the constructor option.

I don't quite understand this suggestion, can you clarify it?

[magicmatatjahu]

@jonaslagoni

I don't quite understand this suggestion, can you clarify it?

For example. you have signature:

public abstract render(model: MetaModel, inputModel: InputMetaModel, dependencyManager?: AbstractDependencyManager): Promise<RenderOutput>;

I think that's would be better if people would pass AbstractDependencyManager definition to the Generator class, not to the function signature, so CommonGeneratorOptions should have this new field:

{
  dependencyManager?: typeof AbstractDependencyManager // definition of class not instance!
}

and then if someone will run render function, we will create AbstractDependencyManager instance based on options.dependencyManager like:

render(...) {
  const dependencyManager = new options.dependencyManager(...)
}

Is it clarify? :D

[jonaslagoni]

Is it clarify? :D

Yes! Actually, that's brilliant!

Let me try out that approach 😄

[magicmatatjahu]

Few comments :)

[magicmatatjahu]

One thing, we discussed about it as I remember 😅

[magicmatatjahu]

I like it. A couple of things I don't like is that you add too many things through class arguments and not through some single object, such as here https://github.com/asyncapi/modelina/pull/947/files#diff-a6a5c62c72e934883df999f53c7335c2b386754b04ca5222520015351537d546R20 but it's ok 👌🏼

[jonaslagoni]

@magicmatatjahu lets merge it into a separate branch to allow each generator and maintainer to review the changes more easily.

[sonarcloud]

Kudos, SonarCloud Quality Gate passed!   

0 Bugs
0 Vulnerabilities
0 Security Hotspots
0 Code Smells

No Coverage information
No Duplication information

[magicmatatjahu]

@jonaslagoni Yeah, good idea. If new feature has a bugs that I don't see, it will be easier to fix :)