XEP-0172 Improvement #276

miguelhincapie · 2018-10-18T18:59:48Z

Description

Current XEP-0172 in Smack library only has a minimal implementation Nick class.
With this PR some classes are added in order to make this extension easily to use.

Changes

Added NickManager class
Added NickListener
Added NickFilter

Flowdalic

Thanks for your contribution, please find my remarks inline.

Flowdalic · 2018-10-18T19:03:06Z

smack-extensions/src/main/java/org/jivesoftware/smackx/nick/NickManager.java

+                asyncButOrdered.performAsyncButOrdered(message, new Runnable() {
+                    @Override
+                    public void run() {
+                        for (NickListener listener : nickListeners) {


nickListeners is not synchronized although it should be

you mean something like:

synchronized (nickListeners) { for (NickListener listener : nickListeners) { listener.newNickMessage(message); } }

am I right?

Yes, or some other sort of means to ensure access to the datastructure is properly synchronized.

ok, added a synchronized, tell me if that is enough or you like another kind of synchronized.

smack-extensions/src/main/java/org/jivesoftware/smackx/nick/NickManager.java

smack-extensions/src/main/java/org/jivesoftware/smackx/nick/filter/NickFilter.java

Flowdalic · 2018-10-18T19:20:59Z

smack-extensions/src/main/java/org/jivesoftware/smackx/nick/NickManager.java

+                    SmackException.NotLoggedInException {
+                final Message message = (Message) packet;
+
+                asyncButOrdered.performAsyncButOrdered(message, new Runnable() {


The AsyncButOrdered API is not correctly used. Right now, it assures the runnable is ordered with respect to the message, when it should be ordered with respect to the originating entity.

Can you explain me a little bit more about what could be the originating entiy?
Because there is no much doc about that AsyncButOrdered I have been using it as I saw in others parts of Smack, so it's not much clear to me how should I use it or when or the options I have instead it.

The originating entity is the entity that send the message stanza. So you need to replace message with message.getFrom(). But make sure to add a null check.

and what if it is null? I mean, should I throw an exception?

miguelhincapie · 2018-12-26T19:28:30Z

I hope someday my 2 PRs can be merged ... u_u

Flowdalic · 2018-12-26T21:09:57Z

I am so sorry. Multiple factors (other important things, illness, holiday season) delay that PR, but I have not forgotten about it. I hope to find some time for this before the upcoming XSF Summit.

Flowdalic · 2019-03-16T20:33:57Z

smack-extensions/src/main/java/org/jivesoftware/smackx/nick/NickManager.java

+                    SmackException.NotLoggedInException {
+                final Message message = (Message) packet;
+
+                asyncButOrdered.performAsyncButOrdered(message, new Runnable() {


The originating entity is the entity that send the message stanza. So you need to replace message with message.getFrom(). But make sure to add a null check.

Flowdalic · 2019-03-16T20:34:25Z

smack-extensions/src/main/java/org/jivesoftware/smackx/nick/NickManager.java

+                asyncButOrdered.performAsyncButOrdered(message, new Runnable() {
+                    @Override
+                    public void run() {
+                        for (NickListener listener : nickListeners) {


Yes, or some other sort of means to ensure access to the datastructure is properly synchronized.

smack-extensions/src/main/java/org/jivesoftware/smackx/nick/NickManager.java

smack-extensions/src/main/java/org/jivesoftware/smackx/nick/NickListener.java

miguelhincapie · 2019-03-30T21:27:32Z

smack-extensions/src/test/java/org/jivesoftware/smackx/nick/NickManagerTest.java

+import static org.junit.Assert.assertNotNull;
+
+
+public class NickManagerTest extends InitExtensions {


@Flowdalic I was searching in current tests and I couldn't find anything as a guide or to follow, the most close to it was DeliveryReceiptTest, so please be patient with this part :).

Can I use Mockito?
i.e. for getInstanceFor I wish to:

test if INSTANCES is really working.

test if addSyncStanzaListener is being called inside constructor.

I'm feeling lonely with this u_u'

Can I use Mockito?

Yes, but it is usually a good idea to start with tests that do not require mocking.

miguelhincapie · 2019-03-30T21:37:42Z

smack-extensions/src/test/java/org/jivesoftware/smackx/nick/NickManagerTest.java

+    }
+
+    @Test
+    public void addNickMessageListener() {


I think in order to be able to do this test I will need to add Set<NickListener> nickListeners to parameters constructor because I need to mock it first. What do you think @Flowdalic?

"to parameters constructor"? Depends on what you want to test within the test.

Flowdalic · 2019-05-08T12:51:48Z

smack-extensions/src/test/java/org/jivesoftware/smackx/nick/NickManagerTest.java

+    }
+
+    @Test
+    public void getInstanceFor() throws Exception {


Test methods should be prefixed (or postfixed) with "test".

Flowdalic · 2019-05-08T12:52:01Z

smack-extensions/src/test/java/org/jivesoftware/smackx/nick/NickManagerTest.java

+    @Test
+    public void getInstanceFor() throws Exception {
+        DummyConnection dummyConnection = new DummyConnection();
+        dummyConnection.connect();


Is there any reason for calling connect()?

Flowdalic · 2019-05-08T12:52:45Z

smack-extensions/src/test/java/org/jivesoftware/smackx/nick/NickManagerTest.java

+import static org.junit.Assert.assertNotNull;
+
+
+public class NickManagerTest extends InitExtensions {


Can I use Mockito?

Yes, but it is usually a good idea to start with tests that do not require mocking.

Flowdalic · 2019-05-08T12:53:41Z

smack-extensions/src/test/java/org/jivesoftware/smackx/nick/NickManagerTest.java

+
+
+
+public class NickManagerTest extends InitExtensions {


Please migrate this to JUnit 5.

Flowdalic · 2019-05-08T12:55:02Z

smack-extensions/src/main/java/org/jivesoftware/smackx/nick/NickManager.java

+        return nickManager;
+    }
+
+    public synchronized boolean addNickMessageListener(NickListener listener) {


That synchronization is broken: You are protecting nickListeners with the Manager's object monitor and above you use the nickListeners's monitor.

Flowdalic · 2019-05-08T12:55:40Z

smack-extensions/src/main/java/org/jivesoftware/smackx/nick/NickManager.java

+                final Message message = (Message) packet;
+
+                Jid from = message.getFrom();
+                if (from != null) {


In order to avoid an extra level of indentation use if (from == null) return; here.

Flowdalic · 2019-05-08T12:56:13Z

smack-extensions/src/test/java/org/jivesoftware/smackx/nick/NickManagerTest.java

+    }
+
+    @Test
+    public void addNickMessageListener() {


"to parameters constructor"? Depends on what you want to test within the test.

miguelhincapie added 2 commits October 18, 2018 12:05

Created classes to complement XEP-0172.

86c1d38

javadoc and checkstyle minor changes

f1912cd

Flowdalic requested changes Oct 22, 2018

View reviewed changes

miguelhincapie added 4 commits October 23, 2018 17:52

Merge branch 'master' into XEP-0172-Improvement

e58a3ef

Added elementName in constructor.

fad201c

Changes due comments in PR

647950d

Merge branch 'master' into XEP-0172-Improvement

7ee730d

Flowdalic requested changes Mar 16, 2019

View reviewed changes

miguelhincapie added 6 commits March 30, 2019 14:57

access to datastructure is synchronized

e439bf1

change due PR comments: asyncButOrdered now use a Jid instead a Message

7e0d1e5

added static to createNickMessage()

a2ce275

Removed date from @author

acc1452

Added empty tests for NickManager

da9a9f2

Test for getInstanceFor created

cfc05ae

miguelhincapie commented Mar 30, 2019

View reviewed changes

moved import due checkstyle

9cced75

miguelhincapie commented Mar 30, 2019

View reviewed changes

checkstyle in imports

6b4de5e

Flowdalic requested changes May 8, 2019

View reviewed changes

Flowdalic added Needs caretaker and removed Needs caretaker labels Apr 3, 2020

Flowdalic added the Needs caretaker label May 13, 2020

Flowdalic force-pushed the master branch from 944f8ae to cd40455 Compare February 14, 2021 19:01

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

XEP-0172 Improvement #276

XEP-0172 Improvement #276

miguelhincapie commented Oct 18, 2018

Flowdalic left a comment

Flowdalic Oct 18, 2018

miguelhincapie Oct 23, 2018

Flowdalic Mar 16, 2019

miguelhincapie Mar 30, 2019

Flowdalic Oct 18, 2018

miguelhincapie Oct 23, 2018

Flowdalic Mar 16, 2019

miguelhincapie Mar 30, 2019 •

edited

miguelhincapie commented Dec 26, 2018

Flowdalic commented Dec 26, 2018

Flowdalic Mar 16, 2019

Flowdalic Mar 16, 2019

miguelhincapie Mar 30, 2019

miguelhincapie May 2, 2019

Flowdalic May 8, 2019

miguelhincapie Mar 30, 2019

Flowdalic May 8, 2019

Flowdalic May 8, 2019

Flowdalic May 8, 2019

Flowdalic May 8, 2019

Flowdalic May 8, 2019

Flowdalic May 8, 2019

Flowdalic May 8, 2019

Flowdalic May 8, 2019

		import static org.junit.Assert.assertNotNull;


		public class NickManagerTest extends InitExtensions {

XEP-0172 Improvement #276

Are you sure you want to change the base?

XEP-0172 Improvement #276

Conversation

miguelhincapie commented Oct 18, 2018

Description

Changes

Flowdalic left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

miguelhincapie Mar 30, 2019 • edited

Choose a reason for hiding this comment

miguelhincapie commented Dec 26, 2018

Flowdalic commented Dec 26, 2018

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

miguelhincapie Mar 30, 2019 •

edited