codeoverflow-org / chatoverflow Goto Github PK

Description

When I try to add an entry to a credential, the GUI gives me the following Error:

How to reproduce

1. Create a credentials object
2. Try to add an entry

Error Log

No Error Log

I added an instance and then tried to save it with the "save" command.

save
282703 21:00:55.359 [main] INFO configuration.CredentialsService - Found 1 credential objects to save.
282724 21:00:55.380 [main] ERROR configuration.CredentialsService - Unable to save credentials. An exception occurred: config\credentials (Das System kann den angegebenen Pfad nicht finden)
282724 21:00:55.380 [main] INFO configuration.ConfigurationService - Started saving current configuration.
282730 21:00:55.386 [main] ERROR configuration.ConfigurationService - Unable to save configuration. Exception thrown: config\config.xml (Das System kann den angegebenen Pfad nicht finden)
282730 21:00:55.386 [main] INFO chatoverflow.ChatOverflow - Saving took 28 ms.

The gui is originally licensed under MIT. Should be checked if the relicensing under EPL is possible and then the new license should be added.

Right now, only string parameters are available.

Other parameter types would be numbers, lists/array, key-value-pairs, ...

Description

Connection to the YouTube API, e.g. to change video settings, upload content and so on.

Note: There is a LOT to implement, way more than is probably usefull. For now, it should be enough to give a basic implementation and show how the generic communication works.

References

Getting started: https://developers.google.com/youtube/v3/code_samples/java
Usage example: https://developers.google.com/youtube/v3/docs/videos/update

The plugin creation sbt task (sbt create) should also generate the future metadata file and the class file. This should be implemented after the plugin structure rework.

See:

This should be solved before: #41

Since the beginning of version 2 of chat overflow, plugins are identified by a pluggable holding all metadata and a plugin class, holding the execution information and requirements.

This should be reworked. Pluggable should not be needed and replaced by a metadata file in the plugin jars resources. The class loader and framework could has to be updated.

The Crypto Util encapsulates all functionality for symmetric encryption of saved and send credentials. It should be reviewed by an expert.

See: https://github.com/codeoverflow-org/chatoverflow/blob/038eddc2b5639b39899dd137cf30ed3ad2bbcb9e/src/main/scala/org/codeoverflow/chatoverflow/configuration/CryptoUtil.scala

Create a proper and good looking readme.html in the deployment files.

Version numbers (framework, api, client, gui) should be generated in the deployment process.

Quick guides, links and information should be available.

See: https://github.com/codeoverflow-org/chatoverflow/blob/2cde2f93003bf007d1f6cfd6c509c3922ae620c8/deployment-files/README.html

Right now, connectors are started when needed from at least one plugin. But there is no functionality to stop connectors, when they are not needed any more, e.g. if a plugin is stopped or crashes.

Should go after this:

After the great success of the "Better REPL"-GUI a real, full-size GUI should be developed.

To enable simple web overlays, e.g. for OBS Studio, a HTML overlay output is needed. The communication should be easy through a generated rest interface or websocket. The output should be hosted from the framework web service itself.

To improve the scalability of the plugin development, we need a possibility to connect in- and output of different plugins. This could be achieved using a loopback connector, which connects the output of one plugin to the input of another plugin.

Advanced feature, though.

Description

We are nearly feature-finished, but there is still some last steps left, until we can push the release.

• Write proper release notes
• Move relevant branches to a new layout then delete all other branches
• Write new README.md
• Test Twitch Chat, Discord Chat and Tipeeestream in 100+ viewer stream
• Change API major from 1 -> 2
• Push release!
• Create new branch develop containing all new features for pre-alpha 3. Increment all version numbers (API major 2 -> 3, framework 0.2 -> 0.3, rest-api-version 1.0 -> 0.3, npm 0.2.5 -> 0.3.0, gui package version 1.0.0 -> 0.3.0)

The loop()-function is not a real looping function. It assumes that the execution of the work inside the loop-function takes 0ms to execute, which is not realistic.

Instead, the execution time of the loop method should be mesured and the sleep time calculated. If the execution time is greater than the loop interval, the thread should not be set asleep.

See:

Description

For easier use every Event Input should have an individual method that registers an handler for each Event. This method should be defined in the input as default method and should call the more generic registerEventHandler().

To save some time and prevent repetative work there should be an sbt task to auto generate these methods.

References

#36 - Rework stat and event input in the API

Plugins should have the possibility to display their own gui to the user. This does not mean stream overlays but rather options and forms for the user to configure the plugins behaviour.

The PluginManagerImpl and GUI do only save and show log messages from plugins, not their origin datetime. Should be added to enable better log output to the end user.

See:

Support for the twitch api / pubsub / events and stats. Already beeing developed by @Renxiem.

Besides writing an Input or Output inside the API project for a new platform source, these in/outputs have also to be registered inside the API. There should be a solution, generating this files, since their content holds no new information.

Another idea would be overloading methods.

See, e.g.: https://github.com/codeoverflow-org/chatoverflow-api/blob/master/src/main/java/org/codeoverflow/chatoverflow/api/plugin/configuration/Input.java

The stat and event input seems to be unfinished and raw. Should be refactored while the implementing process of PubSub and Tipeeestream.

There are several sample plugins to add to the public-plugins repo:

• A all-optional testing plugin to test several connectors, developed by @joblo2213

• A simple placeholder plugin for testing purposes

• Existing plugins should be removed

Description

Right now, the GUI may be cached due to the lack of cache-control.

How to reproduce

Just change something in the gui and wonder why sbt gui does not refresh your version. It does. Your browser may not.

Right now, the MockupChatConnector and Input are completely wrecked. The code was copied from an way earlier version of chat overflow and lack at every point.

A completely new implementation for the new framework is needed, only the parsing might be the same. Also MockupChatOutput etc. should be added.

See: https://github.com/codeoverflow-org/chatoverflow/blob/4e40b6d12f91f24b7d346f993c17a2f8e438d657/src/main/scala/org/codeoverflow/chatoverflow/requirement/service/mockup/MockUpChatConnector.scala

The FTP output, beeing started at the hacktival, is currently unfinished.

Branch: https://github.com/codeoverflow-org/chatoverflow/tree/feature/46-ftp-output

Description

Support for tipeeestream stats. It should be possible to retrive:

• Recent subscriptions, follows , donations and cheers
• Total subscriptions, follows, donations and cheers
• Total follows & subscriptions per service (twitch/youtube/...)

References

https://api.tipeeestream.com/api-doc/events
Issue #43 - Add Tipeeestream platform support

To help the user while adding / filling new connectors (aka plattform connections) in the new GUI, connectors should encapsulate more metadata, e.g. by using traits. Helpful would be display name, description and display icon / symbol.

Progress:

• Update REST API
• Rework styling
• Move api type string stuff to requirements card
• Add metadata display to connectors
• Add edit button to connector types
• Add edit button to plugin types
• Add more details button to connectors to display credentials
• Add (small) edit button for each credential key
• Try to declutter everything

Added tipeeestream platform support for events and stats.

Branch: https://github.com/codeoverflow-org/chatoverflow/tree/tipeeestream

By using reflection, Impl-Annotations are searched inside the classpath to create the type registry at runtime.

This does also find Impl-Annotations in different libraries, which is considered beeing a security issue. All found classes should be filtered afterwards.

See:

Loots is a growing platform for in-stream ads for streamer. Unfortunately, the dashboard is very minimalistic and there is no public API.

There is, however, the possibility to connecto to the platform through websockets. This should be finished.

Branch: https://github.com/codeoverflow-org/chatoverflow/tree/loots

Right now, the framework, its connectors and all plugins can not be tested automaticaly, e.g. trough unit tests. This is a major drawback and should be discussed for future versions.

There are TODOs left in the SerialConnector.

This could crash:

The start method might need an actor:

This should be best resolved by @joblo2213.

The TwitchAPIConnector, also known as PubSub, is totaly broken in the moment. It was cherry picked from the pre pre-alpha 1 release code and should be completly beeing reworked.

This is already in the making by @Renxiem.

The copy plugins sbt command should not just clean the plugins folder. This would also delete third-party plugins. Existent plugins should be overwritten, though.

See: https://github.com/codeoverflow-org/chatoverflow/blob/master/project/BuildUtility.scala#L122

Right now, the JsonActor is only an proof of concept using json4s.

There should be proper utility functionality beeing implemented and tested, what violates the security rules of the sandbox - so where the actor is really needed.

See: https://github.com/codeoverflow-org/chatoverflow/blob/72efa0b4fdc420bc5267268397f3e70eb2332ec8/src/main/scala/org/codeoverflow/chatoverflow/connector/actor/JsonActor.scala

There is no possibility to shutdown the framework correctly. Only rude killing is possible. The exit functionality should first try to stop plugins and connectors (and the server) and then end the framework process.

See:

and also:

The IRC chat bot of the the TwitchChatConnector should detect wrong credentials, and not simply show a connection error after to much failures.

See:

Build environment should be reworked to enable only a subset of the funcitonality beeing available to plugin developers.

See: https://github.com/codeoverflow-org/chatoverflow/blob/2cde2f93003bf007d1f6cfd6c509c3922ae620c8/project/BuildUtility.scala

Now it's working ^^

Description

A connector that allows remote control of services & games by using the Source RCON Protocol, especially executing commands inside minecraft and receiving the response.

This would allow triggering actions ingame from the codeoverflow framework, but is limited to executing the commands and receiving the responses.
It wouldn't allow getting the ingame chat or the console output.
Furthermore reacting to ingame commands is also not possible.

References

Documentation of the protocol (valve): https://developer.valvesoftware.com/wiki/Source_RCON_Protocol

Documentation of the protocol (minecraft): https://wiki.vg/RCON

Possible library: https://github.com/Kronos666/rkon-core

The twitter output development has been started at the hackathon, but not yet finished.

Branch: https://github.com/codeoverflow-org/chatoverflow/tree/feature_twitter_output

Description

As mentioned from Gerd, there should be bash / bat scripts for windows, mac os and unix to setup the development environment.

First, it should be tested if sbt, git and npm are installed. Then, all steps from the setup guide should be emulated, including the sbt commands. This would leave a ready-to-open project for IntelliJ.

TODOs:

• install script for bash (*nix systems)
• bat install script for windows
• Support for a --dev-option to check out the develop branch directly
• Discuss, if executing the steps from the [Advanced]-run is an additional / good idea
• Update the wiki

References

Setup guide: https://github.com/codeoverflow-org/chatoverflow/wiki/Installation
Setup repository: https://github.com/codeoverflow-org/chatoverflow-setup

The usage of the TwitchChannel (and its creation date) are unclear and should be discussed from @Renxiem and @joblo2213.

Related issue: #36

The readme.md and wiki (incl. installation) should be updated to match the current behaviour of the software.

Additional information about connectors, actors, etc. would also be great!

Description

During tests I now encountered an AccessControlException multiple times.
Often (but not allways) the first thing throwing the exception is one of JDAs RateLimit-Workers.
I suspect that it has some problems with the SandboxSecurityManager but I couldn't figure out till now what is actually causing it.

As I tried debugging it completly disappeared and till now didn't occur again.
We even did some heavy spaming with the badge bot to provoke some errors, but everything was working fine again.

Stack trace

8483295 15:47:25.857 [ForkJoinPool.commonPool-worker-8] WARN  discord.DiscordChatConnector  - Rest action for connector badge bot failed: -1: java.security.AccessControlException
8586147 15:49:08.709 [JDA MainWS-ReadThread] INFO  manager.PluginManagerImpl  - [badges] Created sub badge for Shatox, saved it under subbadgetemp/Shatox _1.png
8586148 15:49:08.710 [JDA RateLimit-Worker 5] ERROR requests.Requester  - There was an exception while executing a REST request
java.security.AccessControlException: access denied ("java.net.SocketPermission" "discordapp.com" "resolve")
	at java.security.AccessControlContext.checkPermission(AccessControlContext.java:472)
	at java.security.AccessController.checkPermission(AccessController.java:884)
	at java.lang.SecurityManager.checkPermission(SecurityManager.java:549)
	at java.lang.SecurityManager.checkConnect(SecurityManager.java:1048)
	at java.net.InetAddress.getAllByName0(InetAddress.java:1269)
	at java.net.InetAddress.getAllByName(InetAddress.java:1193)
	at java.net.InetAddress.getAllByName(InetAddress.java:1127)
	at okhttp3.Dns.lambda$static$0(Dns.java:39)
	at okhttp3.internal.connection.RouteSelector.resetNextInetSocketAddress(RouteSelector.java:185)
	at okhttp3.internal.connection.RouteSelector.nextProxy(RouteSelector.java:149)
	at okhttp3.internal.connection.RouteSelector.next(RouteSelector.java:84)
	at okhttp3.internal.connection.StreamAllocation.findConnection(StreamAllocation.java:214)
	at okhttp3.internal.connection.StreamAllocation.findHealthyConnection(StreamAllocation.java:135)
	at okhttp3.internal.connection.StreamAllocation.newStream(StreamAllocation.java:114)
	at okhttp3.internal.connection.ConnectInterceptor.intercept(ConnectInterceptor.java:42)
	at okhttp3.internal.http.RealInterceptorChain.proceed(RealInterceptorChain.java:147)
	at okhttp3.internal.http.RealInterceptorChain.proceed(RealInterceptorChain.java:121)
	at okhttp3.internal.cache.CacheInterceptor.intercept(CacheInterceptor.java:94)
	at okhttp3.internal.http.RealInterceptorChain.proceed(RealInterceptorChain.java:147)
	at okhttp3.internal.http.RealInterceptorChain.proceed(RealInterceptorChain.java:121)
	at okhttp3.internal.http.BridgeInterceptor.intercept(BridgeInterceptor.java:93)
	at okhttp3.internal.http.RealInterceptorChain.proceed(RealInterceptorChain.java:147)
	at okhttp3.internal.http.RetryAndFollowUpInterceptor.intercept(RetryAndFollowUpInterceptor.java:125)
	at okhttp3.internal.http.RealInterceptorChain.proceed(RealInterceptorChain.java:147)
	at okhttp3.internal.http.RealInterceptorChain.proceed(RealInterceptorChain.java:121)
	at okhttp3.RealCall.getResponseWithInterceptorChain(RealCall.java:264)
	at okhttp3.RealCall.execute(RealCall.java:93)
	at net.dv8tion.jda.core.requests.Requester.execute(Requester.java:191)
	at net.dv8tion.jda.core.requests.Requester.execute(Requester.java:133)
	at net.dv8tion.jda.core.requests.Requester.execute(Requester.java:116)
	at net.dv8tion.jda.core.requests.ratelimit.BotRateLimiter$Bucket.run(BotRateLimiter.java:350)
	at java.util.concurrent.Executors$RunnableAdapter.call(Executors.java:511)
	at java.util.concurrent.FutureTask.run(FutureTask.java:266)
	at java.util.concurrent.ScheduledThreadPoolExecutor$ScheduledFutureTask.access$201(ScheduledThreadPoolExecutor.java:180)
	at java.util.concurrent.ScheduledThreadPoolExecutor$ScheduledFutureTask.run(ScheduledThreadPoolExecutor.java:293)
	at java.util.concurrent.ThreadPoolExecutor.runWorker(ThreadPoolExecutor.java:1149)
	at java.util.concurrent.ThreadPoolExecutor$Worker.run(ThreadPoolExecutor.java:624)
at java.lang.Thread.run(Thread.java:748)

From my experiences issue templates really improve the quality of bugreports and feature requests.

We could also use them to give our todos a uniform layout.

After the introduction of the "Better REPL"-GUI, the REPL is history.

Delete REPL, update the CLI and move the plugin start after the server start for security reasons.
Also fixup the path layout of the repl parameters to match with the data path.

After this, update the wiki entry about cli & repl.

The configuration service does not support xml caching and loads the XML file two times in the init process. Could be improved.

Also, there is no handling of empty requirements. This might be a problem, further investigation is needed.

See:

The better REPL should have a button to remove previously created requirements.

Currently the only way of removing them is editing the config file manually which is especally annoying when working with the testall plugin.

Description

The GUI should check periodicly if the Server is still available with the current key and if not, invalidate itself.