[Feature] Ad hoc email command

[petertgiles]

🤖 Resolves #11542

👋 Introduction

Adds an Artisan command and Laravel notification for sending ad hoc emails with just the first name and last name.

🕵️ Details

The command will select users to notify by one of three criteria:

• specific email addresses
• specific notification families
• all users

🧪 Testing

1. Update your api/.env file with the "team" api key
2. Rerun ./artisan optimize:clear
3. Start a queue worker
4. Update one user to have your GCNotify registered email address
5. Test various forms of the Artisan command

• Can use email criteria
  ./artisan send-notifications:ad-hoc-email cdaa82f1-7f76-4d9e-a82e-328c41a6ab62 0831e036-8dfb-4f5e-8b31-867b2c526d77 [email protected] [email protected]
• Can use notification family criteria
  ./artisan send-notifications:ad-hoc-email cdaa82f1-7f76-4d9e-a82e-328c41a6ab62 0831e036-8dfb-4f5e-8b31-867b2c526d77 --notificationFamily=JOB_ALERT --notificationFamily=APPLICATION_UPDATE
• Can use notify all criteria (OR logic)
  ./artisan send-notifications:ad-hoc-email cdaa82f1-7f76-4d9e-a82e-328c41a6ab62 0831e036-8dfb-4f5e-8b31-867b2c526d77 --notifyAllUsers
• Respects language preferences
• Can not use 0 or 2 or 3 criteria types
• Warns of missing email addresses
• Errors on invalid notification families
• first and last name passed to GC Notify

📸 Screenshot

[brindasasi]

Code looks good so far. Will verify in dev

[brindasasi]

minor typo - builderFromNotificationFamilies

[petertgiles]

Good catch!
fix function name typo

[brindasasi]

This can simply use InvalidArgumentException .. but your choice :)

[petertgiles]

You're right - that's more descriptive.
switch to InvalidArgumentException

[brindasasi]

oo.. progressbar!!!

[petertgiles]

Trying out some of the new Laravel 11 features. 😉

[brindasasi]

Sorry for delaying on this what I noticed so far

• If I gave wrong template ID but valid email addresses , it gives me success message even though email doesn't get sent out
• separtating the email id params indivdiaully like. this are not very practical when we have to send bulk emails.
  --emailAddress=[email protected] --emailAddress=[email protected]
  It would be better to have an array with comma separated

testing few more things

[brindasasi]

As mentioned, when the template is mistakenly given it is failing silently

when there is multiple critieras given , I got different exception rather than the invalidargument .. but I'm not too worried about this .. as long as it breaks we know
But if the above one is fixed , would be great.

Also if we can have comma separated emails for bulk email would be great.
Other than that this looks awesome!

[petertgiles]

Thanks for the review! Some feedback on your requests:

If I gave wrong template ID but valid email addresses , it gives me success message even though email doesn't get sent out

This is because sending emails is an asynchronous process. They aren't sent out when the command is run so we can't immediately display API errors like invalid template ID. That will be logged in log files when the queue worker tries to send it. I don't think we want to make this synchronous either. We need to be able to slow it down to satisfy the API rate limiter and be able to retry later if the service goes offline. This is easy to forget so updated the messages to try to be a bit clearer:
use word queue in messages

separtating the email id params indivdiaully like. this are not very practical when we have to send bulk emails.
--emailAddress=[email protected] --emailAddress=[email protected]
It would be better to have an array with comma separated

The AC of the issue didn't specify how the options should be sent so I went with the built-in Laravel option: When defining an option that expects multiple input values, each option value passed to the command should be prefixed with the option name. If we want to manually parse a comma separated list we can do that but let's decide on a method and add it to the AC. @tristan-orourke , preferences?

when there is multiple critieras given , I got different exception rather than the invalidargument

In your screenshot it looks like your log file is not writable which is an unrelated error. I think we will get the right exception for multiple criteria.

[tristan-orourke]

Ah, I didn't realize Laravel had a built-in option like that for list inputs. Hmmm. When we need to use this command, we're likely to be starting from a comma-separated list of emails... However, it would only take a bit of find/replace in a text editor to modify that. Let's stick to the Laravel spec, and keep it as is.

[brindasasi]

Thanks for the review! Some feedback on your requests:

If I gave wrong template ID but valid email addresses , it gives me success message even though email doesn't get sent out

This is because sending emails is an asynchronous process. They aren't sent out when the command is run so we can't immediately display API errors like invalid template ID. That will be logged in log files when the queue worker tries to send it. I don't think we want to make this synchronous either. We need to be able to slow it down to satisfy the API rate limiter and be able to retry later if the service goes offline. This is easy to forget so updated the messages to try to be a bit clearer: use word queue in messages

separtating the email id params indivdiaully like. this are not very practical when we have to send bulk emails.
--emailAddress=[email protected] --emailAddress=[email protected]
It would be better to have an array with comma separated

The AC of the issue didn't specify how the options should be sent so I went with the built-in Laravel option: When defining an option that expects multiple input values, each option value passed to the command should be prefixed with the option name. If we want to manually parse a comma separated list we can do that but let's decide on a method and add it to the AC. @tristan-orourke , preferences?

when there is multiple critieras given , I got different exception rather than the invalidargument

In your screenshot it looks like your log file is not writable which is an unrelated error. I think we will get the right exception for multiple criteria.

This error was on dev. I can try again. Could be related to the issue you solved yesterday

[brindasasi]

Thanks for the review! Some feedback on your requests:

If I gave wrong template ID but valid email addresses , it gives me success message even though email doesn't get sent out

This is because sending emails is an asynchronous process. They aren't sent out when the command is run so we can't immediately display API errors like invalid template ID. That will be logged in log files when the queue worker tries to send it. I don't think we want to make this synchronous either. We need to be able to slow it down to satisfy the API rate limiter and be able to retry later if the service goes offline. This is easy to forget so updated the messages to try to be a bit clearer: use word queue in messages

separtating the email id params indivdiaully like. this are not very practical when we have to send bulk emails.
--emailAddress=[email protected] --emailAddress=[email protected]
It would be better to have an array with comma separated

The AC of the issue didn't specify how the options should be sent so I went with the built-in Laravel option: When defining an option that expects multiple input values, each option value passed to the command should be prefixed with the option name. If we want to manually parse a comma separated list we can do that but let's decide on a method and add it to the AC. @tristan-orourke , preferences?

when there is multiple critieras given , I got different exception rather than the invalidargument

In your screenshot it looks like your log file is not writable which is an unrelated error. I think we will get the right exception for multiple criteria.

This error was on dev. I can try again. Could be related to the issue you solved yesterday

It works now in dev!

[brindasasi]

LGTM!