A lightweight timer/cron agents framework for Java applications
License: Apache License 2.0
![dependabot[bot] avatar](https://avatars.githubusercontent.com/in/29110?v=4 "dependabot[bot]")
Is your feature request related to a problem? Please describe.
No.
Describe the solution you'd like
A new flag (suggested name: modulate) that enables/disables interval modulation for the first execution of an agent.
Describe alternatives you've considered
Not applicable.
Currently, there is a sort of "modulation" applied by default for all agents. For example: if the current hour is 3 am and the agent interval is 4 hours then the first execution will occur at 4 am, and then the next ones will occur at 8 am, noon, 4 pm, etc.
The new flag would indicate whether the interval should be adjusted to cause the next execution to occur on the interval boundary.
(modulate=true): if the current hour is 3h25 am and the agent interval is 4 hours then the first execution will occur at 4 am, and then the next ones will occur at 8 am, noon, 4 pm, etc.
(modulate=false): if the current hour is 3h25 am and the agent interval is 4 hours then the first execution will occur at 3h25 am, and then the next ones will occur at 7h25 am, 11h25, 15h25 pm, etc.
By default, if the modulation flag shall be false (if not specified via annotation or the property is not available in XML/JSON/YAML).
issue/0010 branch.The following criteria will be observed during the Code Review:
Upgrade project configuration and badges:
issue/0007 branch.The following criteria will be observed during the Code Review:
Upgrade JaCoCo dependency from 0.8.6 to 0.8.7 to fix build issues with JDK 17-ea.
issue/0001 branch.The following criteria will be observed during the Code Review:
This enhancement introduces the possibility to set up agents' configurations, such as name, interval, and type via YAML file.
So, for every annotated agent, the system shall search for an optional XML, JSON, and YAML configuration, considering the following precedence:
Configuration source precedence (for each and every agent): annotation < XML file < JSON file < YAML file
An example of a valid YAML file with two agents specified:
agents:
- class: com.mycompany.agents.Agent1
type: timer
interval: 30s
- class: com.mycompany.agents.Agent2
type: cron
interval: 0 0 * * SUN
Notes:
issue/0005 branch.The following criteria will be observed during the Code Review:
Is your feature request related to a problem? Please describe.
No.
Describe the solution you'd like
Enable/disable statistic data processing for an agent.
Describe alternatives you've considered
Not applicable.
issue/0015 branch.The following criteria will be observed during the Code Review:
Describe the bug
When none of .yaml,.json or .xml are supplied and we try to autowire a bean for AgentManager using AgentManager.defaultInstance() then a NullPointerException is thrown.
This happens because a container.getBean(..) is invoked in the fillAuxiliaryObjects() function call in ConfigurationHolder class and when none of the external configurations are present then getBean() returns null. This causes the following line of initialising agentsByClassName to throw a null pointer exceptin as the config is null.
Expected behavior
Even when no external configuration is supplied, a default instance of AgentManager should be wired with no agents and a global configuration. This is due to the fact that user may invoke scanPackages("..") programatically after a default instance is wired.
Additional context
Stack Trace:
Caused by: org.springframework.beans.BeanInstantiationException: Failed to instantiate [net.obvj.agents.conf.ConfigurationHolder]: Constructor threw exception; nested exception is java.lang.NullPointerException: Cannot invoke "net.obvj.agents.conf.Configuration.getGlobalConfiguration()" because "config" is null at org.springframework.beans.BeanUtils.instantiateClass(BeanUtils.java:224) ~[spring-beans-5.3.16.jar:5.3.16] at org.springframework.beans.factory.support.SimpleInstantiationStrategy.instantiate(SimpleInstantiationStrategy.java:87) ~[spring-beans-5.3.16.jar:5.3.16] at org.springframework.beans.factory.support.AbstractAutowireCapableBeanFactory.instantiateBean(AbstractAutowireCapableBeanFactory.java:1326) ~[spring-beans-5.3.16.jar:5.3.16] ... 45 common frames omitted Caused by: java.lang.NullPointerException: Cannot invoke "net.obvj.agents.conf.Configuration.getGlobalConfiguration()" because "config" is null at net.obvj.agents.conf.ConfigurationHolder.fillAuxiliaryObjects(ConfigurationHolder.java:96) ~[classes/:na] at net.obvj.agents.conf.ConfigurationHolder.<init>(ConfigurationHolder.java:61) ~[classes/:na] at net.obvj.agents.conf.ConfigurationHolder.<init>(ConfigurationHolder.java:55) ~[classes/:na] at java.base/jdk.internal.reflect.NativeConstructorAccessorImpl.newInstance0(Native Method) ~[na:na] at java.base/jdk.internal.reflect.NativeConstructorAccessorImpl.newInstance(NativeConstructorAccessorImpl.java:77) ~[na:na] at java.base/jdk.internal.reflect.DelegatingConstructorAccessorImpl.newInstance(DelegatingConstructorAccessorImpl.java:45) ~[na:na] at java.base/java.lang.reflect.Constructor.newInstanceWithCaller(Constructor.java:499) ~[na:na] at java.base/java.lang.reflect.Constructor.newInstance(Constructor.java:480) ~[na:na] at org.springframework.beans.BeanUtils.instantiateClass(BeanUtils.java:211) ~[spring-beans-5.3.16.jar:5.3.16] ... 47 common frames omitted
This enhancement introduces the possibility to set up agents' configurations, such as name, interval, and type via XML file.
So, for every annotated agent, the system shall search for an optional XML configuration, which will always have more precedence than the annotation configuration. In other words, the XML configuration, if available, will overwrite the original annotation parameters.
The agents' class name must be used to associate a unique agent between XML and annotation configuration sources.
An example of XML file:
<agents>
<agent>
<class>com.mycompany.agents.MyAgent</class>
<type>timer</type>
<interval>10s</interval> <!-- every 10 seconds -->
</agent>
<agent>
<class>com.mycompany.agents.MyAgent2</class>
<type>cron</type>
<interval>0 0 * * SUN</interval> <!-- once a week, on Sundays, at 0h00 -->
</agent>
<agents>Notes:
issue/0003 branch.The following criteria will be observed during the Code Review:
Is your feature request related to a problem? Please describe.
No.
Describe the solution you'd like
Add confectory-datamapper-jackson2-* and remove boilerplate code present for configuration files loading.
Describe alternatives you've considered
Not applicable.
issue/0011 branch.The following criteria will be observed during the Code Review:
This enhancement introduces the possibility to set up agents' configurations, such as name, interval, and type via JSON file.
So, for every annotated agent, the system shall search for an optional XML and JSON configuration, which will always have more precedence than the annotation configuration.
In other words, the XML configuration, if available, will overwrite the original annotation parameters. And the JSON configuration, if available, will overwrite either the annotation or the XML configuration parameters.
An example of a valid JSON file with two agents specified:
{
"agents": [
{
"class": "com.mycompany.agents.Agent1",
"type": "timer",
"interval": "30s"
},
{
"class": "com.mycompany.agents.Agent2",
"type": "cron",
"interval": "0 0 * * SUN"
}
]
}Configuration source precedence (for each and every agent): annotation < XML file < JSON file
Notes:
issue/0004 branch.The following criteria will be observed during the Code Review:
We have developed a tool (NameSpotter) for identifying non-descriptive method names, and using this tool we find a non-descriptive method name in your repository:
/* Non-descriptive Method Name in src/main/java/net/obvj/agents/util/TimeInterval.java */
public static TimeInterval of (String input)
{
int digits = extractFirstDigitGroupFrom(input);
String timeUnitDescription = extractFirstLetterGroupFrom(input);
TimeUnit timeUnit = timeUnitDescription.isEmpty() ? TimeUnit.DEFAULT
: TimeUnit.findByIdentifier(timeUnitDescription);
return new TimeInterval(digits, timeUnit);
}We considered "of" as non-descriptive because it is too generic, and we can not infer the function of this method until we look into the method body or the comments above. We proposed renaming the method name to "parseString2TimeInterval". Consequently, when we look at this method name, we will be informed that this method is written for parsing a String input into a TimeInterval object.
Do you agree with the judgment?
If not, could you please leave your valuable opinion?
If you do agree, the relevant modification has been submitted as a PR, and thanks for your precious time to consider it.
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
An Open Source Machine Learning Framework for Everyone
Django
The Web framework for perfectionists with deadlines.
Laravel
A PHP framework for web artisans
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
Some thing interesting about web. New door for the world.
A server is a program made to process requests and deliver data to clients.
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
Some thing interesting about visualization, use data art
Some thing interesting about game, make everyone happy.
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
Microsoft
Open source projects and samples from Microsoft.
Google
Google ❤️ Open Source for everyone.
Alibaba
Alibaba Open Source for everyone
D3
Data-Driven Documents codes.
Tencent
China tencent open source team.