I guess I should also provide some kind of a migration path and a note on update ... will do shortly.

Thanks @t1gor! You can post it as a comment on this PR and I'll include it in the release notes :)

@t1gor Do you have some time to write some migration path? If not tell me please :)
Btw I really appreciate your help on the issues, thanks!

@Minishlink sorry, totally lost it in a daily routine. Sure, the migration path should be something like the following:

====================================

Breaking changes

The way you handle the results of the flush() method should be changed. Since X.X.X (embedd version here) the flush always returns a Generator object. This mean that you can still iterate over it, but you wouldn't be able to store it, at least not as-is. Using the example from the docs, the responses would now look different:

PLEASE NOTE:
\Generator is returned even if you only send one message.

BEFORE:

$res = [
    [ // first notification (failed)
        'success' => false,
        'endpoint' => $theEndpointToDeleteInYourDatabaseIfExpired,
        'message' => $responseMessage,
        'statusCode' => $responseStatusCode,
        'headers' => $responseHeaders,
        'content' => $responseContent, // you may have more infos here
        'expired' => $isTheEndpointWrongOrExpired,
    ],
    [ // second notification (succeeded)
        'success' => true,
    ],
    [ // third notification
        ...
    ], ...
];

AFTER:

var_dump($res); // \Generator

/** \Minishlink\WebPush\MessageSentReport */
foreach ($res as $result) {
    // you now have access to request & response objects

    /** @var \Psr\Http\Message\RequestInterface $request */
    $request = $result-> getRequest();
    /** @var \Psr\Http\Message\ResponseInterface $response */
    $response = $result->getResponse();

    if ($result->isSuccess()) {
        // process successful message sent
        $logger->log('Notification with payload %s successfully sent for endpoint %s.' [
            json_decode((string) $response->getBody()),
            $result->getEndpoint()
        ]);
    } else {
        // or a failed one - check expiration first
        if ($result->isSubscriptionExpired()) {
            // this is just an example code, not included in library!
            $db->markExpired($result->getEndpoint());
        } else {
            // process faulty message
            $logger->log('Notification failed: %s. Payload: %s, endpoint: %s' [
                $result->getReason(),
                json_decode((string) $response->getBody()),
                $result->getEndpoint()
            ]);
        }
    }
}

====================================

This should do the job. Please let me know if I forgot something.

Cheers.

@Minishlink would you be able to merge this any time soon? The migration path provided in the thread above.

@t1gor Thanks! Sure, I'll try to fix the test suite before though. Let's say if I haven't succeeded by next Saturday night, I'll test manually and merge it :)

@t1gor Oops, 1 week late, sorry :o
Travis tests are fixed though! Could you rebase please?

@Minishlink really not sure with the re-base :/ could you please check it? Seems like something went wrong ...

@t1gor Looks like it's good except for a "Vagrantfile" that appears?

@Minishlink my bad, removed.

@t1gor This is in v5 :) Can you do a quick update of https://github.com/web-push-libs/web-push-php#server-errors please? You either forgot to edit it or the rebase cut it :o

@t1gor This is in v5 :) Can you do a quick update of https://github.com/web-push-libs/web-push-php#server-errors please? You either forgot to edit it or the rebase cut it :o

Seems like I did forget, thanks for pointing out. Would you like another merge request?