Specify listeners in config file #155

Kevin-Mok · 2020-08-03T23:47:55Z

Desired Behavior

Each bot instance should have specified listeners for their specific purpose.

Current Behavior

Each bot instance includes all listeners.

Additional Info

I noticed that the current 4 bots all are using the same configuration that includes all the listeners, even though 3 of the bots have very niche purposes (games in their specific channel). For example, we don't need say !fortune for CountdownB0t1. As such, I thought it would be more efficient and make sense to be able to create different configurations for each bot instance so they only use the listeners they need.

Another use case I had in mind for this would be to setup a lightweight bot instance where its only job is to periodically says a command. For example, RepeatB0t1 could say !weather every hour in the #weatherTO channel to prompt WeatherB0t1 to output the weather (bots can't trigger their own commands). WeatherB0t1 would also only need one listener, and I thought it would be overkill to spawn these bots with every single listener.

Implementation

I refactored the part of the code that sets up each bot's configs. It now reads the listenersX property from vilebot.conf, which is a comma-separated list of class name values. An example list would be Karma,Weather or all. It currently only adds the all the admin handlers to each instance.

I also implemented the fix for this unwieldy line as suggested by @amisevsk, as well as using the addListeners method to make each line a much more reasonable length:

VileBot/vilebot/src/main/java/com/oldterns/vilebot/Vilebot.java

Lines 120 to 121 in aff8a83

    
           new Configuration.Builder().setName( ircNick ).setLogin( ircUser ).setRealName( ircRealName ).addServer( ircServerAddress, 
        
                                                                                                                    ircPort ).addAutoJoinChannel( ircChannel ).setAutoReconnect( true ).addListener( new Vilebot() ).addListener( new AdminManagement() ).addListener( new AdminPing() ).addListener( new Auth() ).addListener( new DownOrJustMe() ).addListener( new GetLog() ).addListener( new com.oldterns.vilebot.handlers.admin.Help() ).addListener( new NickChange() ).addListener( new com.oldterns.vilebot.handlers.admin.Ops() ).addListener( new Quit() ).addListener( new AnswerQuestion() ).addListener( new Ascii() ).addListener( new ChatLogger() ).addListener( new Church() ).addListener( new Countdown() ).addListener( new Decide() ).addListener( new Excuses() ).addListener( new FakeNews() ).addListener( new Fortune() ).addListener( new GetInfoOn() ).addListener( new Help() ).addListener( new ImageToAscii() ).addListener( new Inspiration() ).addListener( new Jaziz() ).addListener( new Jokes() ).addListener( new Kaomoji() ).addListener( new Karma() ).addListener( new KarmaRoll() ).addListener( new KarmaTransfer() ).addListener( new LastMessageSed() ).addListener( new LastSeen() ).addListener( new Markov() ).addListener( new News() ).addListener( new Omgword() ).addListener( new Ops() ).addListener( new QuotesAndFacts() ).addListener( new RemindMe() ).addListener( new RockPaperScissors() ).addListener( new Summon() ).addListener( new Trivia() ).addListener( new Ttc() ).addListener( new TwitterCorrection() ).addListener( new UrlTitleAnnouncer() ).addListener( new UrlTweetAnnouncer() ).addListener( new Userlists() ).addListener( new UserPing() ).addListener( new Weather() ).buildConfiguration();

Tests

I setup 2 bot instances with the following config:

ircNick1=kmokVileBot1
listeners1=Karma
.
.
.
ircNick2=kmokVileBot2
listeners2=all

And tried the following commands with both of them in the same room:

2020-08-03 19:04:49	@kmok	!rank
2020-08-03 19:04:50	kmokVileBot1	kmok is ranked at #11 with 1581 points of karma.
2020-08-03 19:04:50	kmokVileBot2	kmok is ranked at #11 with 1581 points of karma.
2020-08-03 19:04:51	@kmok	!fortune
2020-08-03 19:04:51	kmokVileBot2	Never regret anything that made you smile
2020-08-03 19:04:54	@kmok	!excuse
2020-08-03 19:04:54	kmokVileBot2	I remember that IBM had a project to do that back in the 70s.

Next Steps

Dynamically generated !help commands for each bot instance.

Kevin-Mok · 2020-08-03T23:49:06Z

@Christopher-Chianelli, I can't actually request your review for whatever reason, but could I get your review on this as well?

Christopher-Chianelli

I recommend using Classes instead of Strings to make missing classes a compile time error + make renaming classes via refactoring easier.

An alternative approach would be to use Quarkus to run VileBot1, and each service would be @ApplicationScoped, then you don't need to specify the services in Vilebot.java.

The third approach is to containerize the services using PodIRCBot (which is what I will do, one day...).

Christopher-Chianelli · 2020-08-03T23:58:03Z

vilebot/src/main/java/com/oldterns/vilebot/Vilebot.java

@@ -79,6 +81,12 @@

    private static Map<String, String> cfg = getConfigMap();

+    private static final String[] allListenerClasses = { "AnswerQuestion", "Ascii", "ChatLogger", "Church", "Countdown",


I recommend this being a Class array instead of a String array, so that a missing class is a compile time error and to make it easier to rename classes when refactoring.

Christopher-Chianelli · 2020-08-04T00:09:10Z

In regards to "Dynamically generated !help commands for each bot instance.", each service would need to implement an interface. Since help is separated into categories, we need to be able to identify what category to put it help section in.

Proposal:

interface ServiceInfo {
    String getCategory();
    String getHelp();
}

and then build a Map<String,String> using map.computeIfAbsent(category, category -> new ArrayList<>()).add(help);. This would be a one-to-one correspondence to the current way help works. With some additional methods, we could add more services to help. For instance,
!help jeopardy would tell you what jeopardy about. !help church would tell you what church about. !help roll would tell you about the roll command.

cuijulian

Nice work @Kevin-Mok! Left some minor comments in the PR.

cuijulian · 2020-08-05T01:31:54Z

vilebot/src/main/java/com/oldterns/vilebot/Vilebot.java

@@ -113,20 +121,73 @@ public static void main( String[] args )
            String ircServerAddress = cfg.get( "ircServerAddress" + i );
            int ircPort = Integer.parseInt( cfg.get( "ircPort" + i ) );
            String ircChannel = cfg.get( "ircChannel" + i );
+            String listenerCsvString = cfg.get( "listeners" + i );


This additional cfg entry should also be added in vilebot/cfg/vilebot.conf.example (ie. listeners1=all).

cuijulian · 2020-08-05T01:33:24Z

vilebot/src/main/java/com/oldterns/vilebot/Vilebot.java

        }

        botManager.start();
        // Done
    }

+    /**
+     * Returns list of Listener object based on a CSV string of Listener class names.


Suggested change

* Returns list of Listener object based on a CSV string of Listener class names.

* Returns list of Listener objects based on a CSV string of Listener class names.

Kevin-Mok requested a review from cuijulian August 3, 2020 23:47

Specify listeners in config file

5441264

Kevin-Mok force-pushed the diff-listeners branch from b186f50 to 5441264 Compare August 3, 2020 23:54

Christopher-Chianelli suggested changes Aug 4, 2020

View reviewed changes

cuijulian requested changes Aug 5, 2020

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Specify listeners in config file #155

Specify listeners in config file #155

Kevin-Mok commented Aug 3, 2020 •

edited

Loading

Kevin-Mok commented Aug 3, 2020

Christopher-Chianelli left a comment

Christopher-Chianelli Aug 3, 2020

Christopher-Chianelli commented Aug 4, 2020 •

edited

Loading

cuijulian left a comment

cuijulian Aug 5, 2020

cuijulian Aug 5, 2020

		@@ -79,6 +81,12 @@

		private static Map<String, String> cfg = getConfigMap();

		private static final String[] allListenerClasses = { "AnswerQuestion", "Ascii", "ChatLogger", "Church", "Countdown",

	* Returns list of Listener object based on a CSV string of Listener class names.
	* Returns list of Listener objects based on a CSV string of Listener class names.

Specify listeners in config file #155

Are you sure you want to change the base?

Specify listeners in config file #155

Conversation

Kevin-Mok commented Aug 3, 2020 • edited Loading

Desired Behavior

Current Behavior

Additional Info

Implementation

Tests

Next Steps

Kevin-Mok commented Aug 3, 2020

Christopher-Chianelli left a comment

Choose a reason for hiding this comment

Christopher-Chianelli Aug 3, 2020

Choose a reason for hiding this comment

Christopher-Chianelli commented Aug 4, 2020 • edited Loading

cuijulian left a comment

Choose a reason for hiding this comment

cuijulian Aug 5, 2020

Choose a reason for hiding this comment

cuijulian Aug 5, 2020

Choose a reason for hiding this comment

Kevin-Mok commented Aug 3, 2020 •

edited

Loading

Christopher-Chianelli commented Aug 4, 2020 •

edited

Loading