messaging addition #1195

tulinkry · 2016-09-27T12:57:39Z

The configuration listener seems unemployed most of the time so I added a messaging feature which listens on the same socket.

As a first shot it is capable of two things:

send "normal" and "abort" messages to the web application
display some useful information about projects

The information are displayed:

On the main page just above the project list - for general messages (tag 'main')
In the directory listing just above the listing - for project specific messages (tag $projectName)
In the xref/history/... page just above the content - for project specific messages (tag $projectName)
After the search there is a (!) mark indicating that there are messages in this project

Currently supported messages:

normal
- can display information on the page
- can be general (with tag 'main' - default) or project specific (tag with project name)
- the color can be controlled with the css class
abort
- can erase some messages from the system
- basically it erases all messages with at least one tag from the tags of this abort message

The messages can't enforce any kind of restrictions, they just display/delete some user content - they are useful to notify the clients that index/reindex or anything else is in progress and so some inconsistencies can occur.

All messages disappear with webapp deploy. They are current state of the runtime environment of the OpenGrok

Related to #1187. This is now possible with just implementing Message subclass with desired effect.

It comes with a java main file to automatically send the message to the application and also with a shell wrapper to make it even more easier. The shell wrapper is located under tools.

This shell wrapper only needs to find your opengrok.jar java file so it can run the Messages.java main class in it. This is possible by setting OPENGROK_DISTRIBUTION_BASE environment variable which points to the OpenGrok distribution directory (which contains dist/opengrok.jar). Other options are available through set of switches.

Usage from the command line is simple:

$ tools/Messages --help # see usage and defaults
$ tools/Messages "Hello" # send a message with text "Hello"
$ tools/Messages -e "+1 min" "Hello" # set expiration to 30 minutes from now
$ tools/Messages -e "+30 min" "Hello" # set expiration to 30 minutes from now
$ tools/Messages -c "error" -e "+30 min" "Hello" # display the message as error
$ tools/Messages -c "warning" -e "+30 min" "Hello"  # display the message as warning
$ tools/Messages -c "warning" -e "+30 min" --type abort "Hello" # send abort message

Here come some screenshots:

General message
Warning in project picker
All warnings (!) has mouseover table with the messages
Searching
In project context, the warning is on the top
With the mouseover as well

tulinkry · 2016-09-27T12:59:52Z

I currently can't decide which is better. I also experimented with the message view for particular project in form of a window:

tarzanek · 2016-09-29T11:26:40Z

src/org/opensolaris/opengrok/configuration/RuntimeEnvironment.java

+    private static final String MESSAGES_MAIN_PAGE_TAG = "main";
+    /*
+    initial capacity - default 16
+    initial load factor - default 0.75f


if they are public constants, then take them from there (just in case JDK will change defaults ... )

Impossible, they're private

tarzanek · 2016-09-29T11:28:46Z

src/org/opensolaris/opengrok/configuration/RuntimeEnvironment.java

+                                Message m = ((Message) obj);
+                                if (canAcceptMessage(m)) {
+                                    m.apply(RuntimeEnvironment.getInstance());
+                                    LOGGER.log(Level.INFO, "Message received: {0}",


not INFO, too high, please lower to debug/fine/finer

Resolved in the updated commit

tarzanek · 2016-09-29T11:29:03Z

src/org/opensolaris/opengrok/configuration/RuntimeEnvironment.java

+                                    LOGGER.log(Level.INFO, "Messages in the system: {0}",
+                                            RuntimeEnvironment.getInstance().getMessagesInTheSystem());
+                                } else {
+                                    LOGGER.log(Level.INFO, "Message dropped: {0} - too many messages in the system",


Resolved in the updated commit

tarzanek · 2016-09-29T11:29:12Z

src/org/opensolaris/opengrok/configuration/RuntimeEnvironment.java

+                                    m.apply(RuntimeEnvironment.getInstance());
+                                    LOGGER.log(Level.INFO, "Message received: {0}",
+                                            m.getTags());
+                                    LOGGER.log(Level.INFO, "Messages in the system: {0}",


FINE/FINER ?

Resolved in the updated commit

tarzanek · 2016-09-29T11:33:59Z

tools/Messages

@@ -0,0 +1,317 @@
+#!/bin/bash


we usually use sh or ksh to be portable to other OSes ...

Changed to ksh

vladak · 2016-09-30T14:12:47Z

Some mention of the tool in top-level README would be nice.

vladak · 2016-09-30T14:16:27Z

It would be nice if mouse over the exclamation mark displayed the message.

tarzanek · 2016-09-30T14:17:19Z

@tulinkry can you resolve conflicts please ?

vladak · 2016-09-30T14:26:03Z

Also, it would be nice if the pending messages were reflected in the project list on home page (plus maybe in project picker).

vladak · 2016-09-30T14:26:42Z

Lastly, I'd remove the blue band altogether and replace it with colored background under the path with mouse over displaying all messages. I like that OpenGrok is still looking quite minimalistic; adding more elements would make it cluttered I think (as opposed to increasing density).

vladak · 2016-10-06T11:24:39Z

Also, it would be good to test this change with persistent messages displayed via dtags.eftar.

tarzanek · 2016-10-07T10:10:24Z

@tulinkry ping me , once you resolve conflicts

tulinkry · 2016-10-07T10:55:39Z

I updated the screenshots in the initial PR comment.

Javascript changes are tested in recent Firefox, recent Chrome and IE9.

Some mention of the tool in top-level README would be nice.

solved

It would be nice if mouse over the exclamation mark displayed the message.

all exclamation marks have mouseover

Also, it would be nice if the pending messages were reflected in the project list on home page (plus maybe in project picker).

solved

Also, it would be good to test this change with persistent messages displayed via dtags.eftar.

visually no problem with this (tested also on other places, but this is the most conflicting)

tulinkry · 2016-10-07T11:03:57Z

Internal demo available here, with some messages with expiration +15 days.

tulinkry · 2016-10-07T11:12:06Z

I added the Messages into a Solaris package, I did the same like @vladak yesterday, but I'm not sure if the group shouldn't be also bin like for the OpenGrok script.

 PKG pkgsend add file OpenGrok mode=0555 owner=root group=bin path=/usr/opengrok/bin/OpenGrok
 PKG pkgsend add file tools/Groups mode=0555 owner=root group=sys path=/usr/opengrok/bin/Groups
+PKG pkgsend add file tools/Messages mode=0555 owner=root group=sys path=/usr/opengrok/bin/Messages

vladak · 2016-10-07T11:45:51Z

bin for scripts/binaries probably makes more sense, feel free to change.

tulinkry · 2016-10-07T12:28:04Z

@tarzanek ready

tarzanek · 2016-10-09T11:44:23Z

thank you sir, merging

tulinkry self-assigned this Sep 27, 2016

tulinkry added this to the 0.13 milestone Sep 27, 2016

tulinkry added the enhancement label Sep 27, 2016

tulinkry mentioned this pull request Sep 27, 2016

avoid searching given project based on flag existence #1060

Closed

tarzanek reviewed Sep 29, 2016

View reviewed changes

tulinkry force-pushed the messages branch from 24f34ec to 2614e0f Compare September 29, 2016 15:16

tulinkry mentioned this pull request Oct 6, 2016

package Groups script #1203

Merged

tulinkry force-pushed the messages branch from 2614e0f to 9cfd940 Compare October 7, 2016 10:47

tulinkry force-pushed the messages branch 2 times, most recently from aed876b to b9db44e Compare October 7, 2016 11:35

tulinkry force-pushed the messages branch 2 times, most recently from c26663b to b7ddd6d Compare October 7, 2016 12:27

tulinkry force-pushed the messages branch from b7ddd6d to 5b9f31d Compare October 7, 2016 12:51

tulinkry added 3 commits October 7, 2016 17:37

messaging addition

8389245

extracting additional script downloader into submodule

a7205a5

adding Messages into Solaris package

7321b96

tulinkry force-pushed the messages branch from 5b9f31d to 7321b96 Compare October 7, 2016 15:37

tarzanek merged commit e10f886 into oracle:master Oct 9, 2016

tulinkry deleted the messages branch October 10, 2016 08:59

tulinkry mentioned this pull request Oct 17, 2016

fixing regression for project picker - dblclick not working #1243

Merged

tulinkry mentioned this pull request Nov 3, 2016

Please say something better than "Your search defs:FOOBAR did not match any files" when indexing is in progress #1264

Closed

tulinkry mentioned this pull request Nov 25, 2016

OpenGrok home page not refreshing when index updated (NEW) #1286

Closed

tulinkry mentioned this pull request Feb 13, 2017

Incorrectly terminating timer thread #1407

Closed

messaging addition #1195

messaging addition #1195

Uh oh!

Conversation

tulinkry commented Sep 27, 2016 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

tulinkry commented Sep 27, 2016 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

vladak commented Sep 30, 2016

Uh oh!

vladak commented Sep 30, 2016

Uh oh!

tarzanek commented Sep 30, 2016

Uh oh!

vladak commented Sep 30, 2016

Uh oh!

vladak commented Sep 30, 2016 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

vladak commented Oct 6, 2016

Uh oh!

tarzanek commented Oct 7, 2016

Uh oh!

tulinkry commented Oct 7, 2016 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

tulinkry commented Oct 7, 2016

Uh oh!

tulinkry commented Oct 7, 2016

Uh oh!

vladak commented Oct 7, 2016

Uh oh!

tulinkry commented Oct 7, 2016

Uh oh!

tarzanek commented Oct 9, 2016

Uh oh!

Uh oh!

tulinkry commented Sep 27, 2016 •

edited

Loading

tulinkry commented Sep 27, 2016 •

edited

Loading

vladak commented Sep 30, 2016 •

edited

Loading

tulinkry commented Oct 7, 2016 •

edited

Loading