Fix email issues #171

jrha · 2019-08-14T12:48:52Z

Depends on #238

Fixes #64, fixes #163 and fixes #168.

gregcorbett · 2021-05-19T15:34:06Z

I've added a few commits that fix some bugs I found while trying to put together a sanity check that this was working as I would expect.

gregcorbett · 2021-05-20T15:21:10Z

I've had my hands all over this now, so I'd appreciate a review from @tofu-rocketry or @ineilson.

For my own future reference:

~~This doesn't seem to email a GOCDB admin if they are the only person who can approve a role~~ If no other user can approve a role request, email the GOCDB admins #306
~~Not sure how it behaves with ServiceGroups (I'll investigate, but that should hold up merging the PR)~~ it behaves as expected, alerting user with a role over the ServiceGroup.

gregcorbett · 2021-05-20T15:23:50Z

Looking at Travis - I should merge #238 first.

lib/Gocdb_Services/NotificationService.php

gregcorbett · 2021-08-26T16:01:55Z

As a note to Future Greg, one of these commits reverts another one of these commits - that at least can be squashed.

~~One conversation currently unresolved needing input from @ineilson.~~ Resolved.

gregcorbett · 2021-08-26T16:05:27Z

As a further note to Future Greg, print_r is also discouraged by codacy - but in a less severe way... so progress?

lib/Gocdb_Services/NotificationService.php

* Add the entity the role was requested on into the message * Add context and personalise role request emails Co-authored-by: ineilson <ian.neilson@stfc.ac.uk>

This somewhat improves readability.

gregcorbett · 2021-09-30T15:52:55Z

I've squashed some of my more "bug-fixy" commits into other commits but decided to leave the majority to not conflate moving code about and changing behaviour.

As a further note to Future Greg, print_r is also discouraged by codacy - but in a less severe way... so progress?

~~Just this and a final test (can it still send emails after the rebase) between us and GOCDB 5.8!~~ DONE!

This seems to have originally been factored out as part of 229a0e8 and has been sitting around since then.

Fixes GOCDB#168 (emails "from GOCDB" should come from gocdb-admins@mailman.egi.eu).

Co-Authored-By: ineilson <ian.neilson@stfc.ac.uk>

- this way, if a site role request gets passed up to an NGI level user, they will see the site name in the request (not the NGI name).

- I guess this logic was somewhat there to test /stop recursion if you didn't want to send an email. - The logic of whether to send an email or just print what would have been sent has been factored out already, so we don't need this if statement anymore.

- to support different views of GOCDB being served by the same instance. Co-authored-by: ineilson <ian.neilson@stfc.ac.uk>

- the behaviour of recursing this function is repeated further down.

- `if ( empty( $array_name ) )` is more readable. I think we previously got away with it because `[] == null` returns true, or because the code interchanged empty arrays and `null`.

gregcorbett · 2021-10-01T12:51:38Z

@ineilson could I get your seal of approval? 🦭

lib/Gocdb_Services/NotificationService.php

Co-authored-by: ineilson <ian.neilson@stfc.ac.uk>

- for later reuse.

Co-authored-by: ineilson <ian.neilson@stfc.ac.uk>

- for clarity, as the email could be someone outside their entity. - i.e, a Site role request email going to someone with a role over an NGI.

- this check is part of the `else` of an `if (count($authorisingUserIds) == 0)` statement. - `array_unique` won't empty `$authorisingUserIds`. - hence, the check here isn't needed. Co-authored-by: ineilson <ian.neilson@stfc.ac.uk>

gregcorbett · 2021-10-04T12:43:52Z

Suggestions applied, @ineilson could I get a fresh seal of approval?

- as per GOCDB#171

jrha force-pushed the emails branch 4 times, most recently from 4e942cd to 690aa0f Compare August 15, 2019 11:33

jrha force-pushed the emails branch 2 times, most recently from b4d9057 to e93cd6d Compare August 26, 2020 10:42

jrha marked this pull request as ready for review August 26, 2020 10:47

jrha requested a review from gregcorbett November 9, 2020 10:58

gregcorbett added this to the 5.8.0 milestone Apr 23, 2021

jrha requested a review from a team as a code owner May 19, 2021 15:33

gregcorbett mentioned this pull request May 21, 2021

Add manual test for testing role request emails #282

Draft

ineilson suggested changes Jun 29, 2021

View reviewed changes

gregcorbett force-pushed the emails branch 5 times, most recently from f64884e to 3aabc41 Compare August 26, 2021 16:01

ineilson previously approved these changes Sep 8, 2021

View reviewed changes

lib/Gocdb_Services/NotificationService.php Outdated Show resolved Hide resolved

lib/Gocdb_Services/NotificationService.php Outdated Show resolved Hide resolved

lib/Gocdb_Services/NotificationService.php Outdated Show resolved Hide resolved

pjcon mentioned this pull request Sep 20, 2021

Remove inactive users #305

Merged

gregcorbett dismissed ineilson’s stale review via e968aac September 30, 2021 14:09

DeckChairs and others added 3 commits September 30, 2021 16:27

Enrich and personalise the role request emails.

a8b6022

* Add the entity the role was requested on into the message * Add context and personalise role request emails Co-authored-by: ineilson <ian.neilson@stfc.ac.uk>

Factor out preparation and sending of email to a seperate function

e1ef4cd

This somewhat improves readability.

Remove commented out code cruft

08b7a7a

gregcorbett force-pushed the emails branch from 4359f64 to e7e941b Compare September 30, 2021 15:51

jrha and others added 11 commits October 1, 2021 12:46

Move headers next to where it is used

f2f02ac

Remove redundant code paths

3c9bbd9

This seems to have originally been factored out as part of 229a0e8 and has been sitting around since then.

Don't create single-use local variable for entity name

d755b31

Fix from header and set email address to admin list

7df9d51

Fixes GOCDB#168 (emails "from GOCDB" should come from gocdb-admins@mailman.egi.eu).

Handle case where no user has a role over entity

b156c28

Co-Authored-By: ineilson <ian.neilson@stfc.ac.uk>

Use the role requested object to populate email

9b8b9f2

- this way, if a site role request gets passed up to an NGI level user, they will see the site name in the request (not the NGI name).

Move enablingRoles initialisation closer to use

845a027

Use the Factory to access local config

0deddb5

- to support different views of GOCDB being served by the same instance. Co-authored-by: ineilson <ian.neilson@stfc.ac.uk>

Remove un-needed code.

eb54ec4

- the behaviour of recursing this function is repeated further down.

Check array is empty rather than null

c49b00c

- `if ( empty( $array_name ) )` is more readable. I think we previously got away with it because `[] == null` returns true, or because the code interchanged empty arrays and `null`.

gregcorbett force-pushed the emails branch from 211d72a to 35e5cf5 Compare October 1, 2021 12:46

ineilson previously approved these changes Oct 4, 2021

View reviewed changes

lib/Gocdb_Services/NotificationService.php Outdated Show resolved Hide resolved

lib/Gocdb_Services/NotificationService.php Outdated Show resolved Hide resolved

lib/Gocdb_Services/NotificationService.php Outdated Show resolved Hide resolved

gregcorbett dismissed ineilson’s stale review via 010ce8b October 4, 2021 12:35

gregcorbett force-pushed the emails branch from 010ce8b to d035280 Compare October 4, 2021 12:37

gregcorbett and others added 7 commits October 4, 2021 12:39

Simplify determination of users with GRANT_ROLE

6efb29b

Co-authored-by: ineilson <ian.neilson@stfc.ac.uk>

Improve comments around recursion

eac6b74

Use camelCase throughout

34bf0a8

Factor out email sending into its own service

569fcde

- for later reuse.

Update documentation of NotificationService class

1e0ad98

Co-authored-by: ineilson <ian.neilson@stfc.ac.uk>

Capitalise "GocDB" in lib/Gocdb_Services/NotificationService.php

82abbed

Co-authored-by: ineilson <ian.neilson@stfc.ac.uk>

Add requesting User's surname to emails

6f6d342

- for clarity, as the email could be someone outside their entity. - i.e, a Site role request email going to someone with a role over an NGI.

gregcorbett force-pushed the emails branch from ebc8b56 to 6f6d342 Compare October 4, 2021 12:39

Remove unneeded check for emptiness

1dce398

- this check is part of the `else` of an `if (count($authorisingUserIds) == 0)` statement. - `array_unique` won't empty `$authorisingUserIds`. - hence, the check here isn't needed. Co-authored-by: ineilson <ian.neilson@stfc.ac.uk>

ineilson approved these changes Oct 5, 2021

View reviewed changes

gregcorbett merged commit 815b777 into GOCDB:dev Oct 5, 2021

gregcorbett added a commit to ElliottKasoar/gocdb that referenced this pull request Feb 8, 2022

Update FROM header used

126af81

- as per GOCDB#171

gregcorbett added a commit to gregcorbett/gocdb that referenced this pull request May 24, 2022

Update FROM header used

c52838b

- as per GOCDB#171

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fix email issues #171

Fix email issues #171

jrha commented Aug 14, 2019 •

edited by gregcorbett

gregcorbett commented May 19, 2021

gregcorbett commented May 20, 2021 •

edited

gregcorbett commented May 20, 2021

gregcorbett commented Aug 26, 2021 •

edited

gregcorbett commented Aug 26, 2021

gregcorbett commented Sep 30, 2021 •

edited

gregcorbett commented Oct 1, 2021

gregcorbett commented Oct 4, 2021

Fix email issues #171

Fix email issues #171

Conversation

jrha commented Aug 14, 2019 • edited by gregcorbett

gregcorbett commented May 19, 2021

gregcorbett commented May 20, 2021 • edited

gregcorbett commented May 20, 2021

gregcorbett commented Aug 26, 2021 • edited

gregcorbett commented Aug 26, 2021

gregcorbett commented Sep 30, 2021 • edited

gregcorbett commented Oct 1, 2021

gregcorbett commented Oct 4, 2021

jrha commented Aug 14, 2019 •

edited by gregcorbett

gregcorbett commented May 20, 2021 •

edited

gregcorbett commented Aug 26, 2021 •

edited

gregcorbett commented Sep 30, 2021 •

edited