Implement get_object_by_id() method in message factory

[jdgrimes]

Otherwise the create_and_get() method doesn't work.

Introduced in [8504].

[jdgrimes]

I haven't attempted to implement update_object() as well, because I'm not sure how to update a message (fairly new to BuddyPress's codebase).

[jdgrimes]

I've discovered that the factory really doesn't work at all (it doesn't generate any default values). It always fails (silently) because the $default_generation_definitions are only allowed to contain scalar values or WP_UnitTest_Generator_Sequence instances, but 'recipients' is included in the defaults there as array(). The solution is to omit the default for 'recipients', as it really isn't needed there. I've done this in 7234.2.diff​. Better yet, the defaults for the recipients could be set in create_object() instead, with a recipient created on the fly if none are specified, since messages_new_message() requires that there be a recipient of the message.

[jdgrimes]

7234.3.diff​ updates the create_object() method to create a sender and recipient on the fly if these values are empty. I think that this is the correct behavior for the factory, because if either of these values are empty the message won't be created by messages_new_message().

Note that the sender does default to the current user, but this value is not always set during the unit tests (actually, I think that it is unset by default as of now).

[DJPaul]

Sounds like we need tests for our tests. ;) ;)

This looks good and is an improvement over what we have. Let's get @boonebgorges' input in case he remembers something pertinent from 2 years ago about this, but I think we can commit this.

[boonebgorges]

@jdgrimes Thanks for the patch!

The technique you've used for fetching the message ID after creation is not quite right. messages_new_message() returns a *thread* ID. In fact, I don't think there's a way to get the ID of the created message from the return value of messages_new_message(). Needless to say, this is truly awful. But we can fix the factory by fetching the last item in the thread's messages array (end()). Let's maybe try to break messages_new_message() into pieces in a different thread (no pun intended).

[boonebgorges]

In 11042:

Tests: Fix message factory create/get methods.

Previously, message creation was failing because no 'sender_id' or
'recipients' were set. We now create senders and recipients when none
are passed to the create() method.

This changeset also fixes the return value of create_object(), so that
create_and_get() works for messages.

Props jdgrimes.
Fixes #7234.

[jdgrimes]

@boonebgorges I'd just noticed that and was getting ready to correct the patch. :-) [11042] looks great. Thanks for the quick work on this.

[boonebgorges]

Oy, this broke some tests that relied on the thread_id rather than the message ID being returned from the factory. These are tests that @r-a-y introduced in [9846], [9186]. I am going to guess that no one else in the universe has ever looked at these factory methods, so the backward compatibility break seems OK, and I'm going to fix the tests. If anyone disagrees, speak now, etc.

[r-a-y]

Go ahead and fix the tests! :)

[boonebgorges]

In 11044:

Update Messages tests to work after the changes in [11042].

See #7234.