Problem/Motivation
At times, it is difficult to figure out why the module appears to not be working, and/or why a particular address is or is not validating.
Proposed resolution
Add an option for adding debugging messages to the log and/or the current page, so that users of this module can figure out if things are working correctly or not.
Remaining tasks
Fix the issueCreate a patchReview the patchCommit the patch
User interface changes
There will at least be a modification to the admin UI for en/disabling the functionality, and there will be updates to the UI for the reporting.
API changes
None.
Data model changes
None.
| Comment | File | Size | Author |
|---|---|---|---|
| #10 | Debugging screenshot.png | 322.37 KB | Patrick Storey |
| #8 | interdiff-2493515-5-8.txt | 5.31 KB | oadaeh |
| #8 | email_verify-add_debugging_logging-2493515-8.patch | 42.12 KB | oadaeh |
| #5 | interdiff-2493515-3-5.txt | 24.69 KB | oadaeh |
| #5 | email_verify-add_debugging_logging-2493515-5.patch | 42.53 KB | oadaeh |
Comments
Comment #1
oadaeh commentedComment #2
oadaeh commentedIt turns out that I actually kind of need this now, so I started working on it.
Comment #3
oadaeh commentedAttached is my initial start at adding debugging logging. It appears to be working fine, but I will do more extensive testing and fine-tuning in the next day or five.
Comment #4
oadaeh commentedComment #5
oadaeh commentedAn updated patch that adds setting the integer-based debugging settings to booleans and sets the defaults to FALSE.
Comment #6
oadaeh commentedComment #7
aimeeraeWow. Fantastic work. I only found nitpicks:
This is a bit hard to read. Might be better on separate lines.
Same as above.
Commented-out code.
This is used more than once so add helper function?
Maybe just 'email_verify' would be better? I think just the module name is typically used.
Use helper function?
Use helper function?
We'll get this tested soon.
Comment #8
oadaeh commented1 and 2: Done. I keep waffling on which is better.
3: Removed.
4, 6, and 7: Okay, done.
5: I did that intentionally to allow people to separate the debug messages from module's other messages.
Updated patch attached.
Comment #9
oadaeh commentedComment #10
Patrick Storey commentedTesting for the patch in comment #8.
Putting the debugging GUI inside /admin/config/system/email_verify is great, and allows for easy customization of the debugging options.
I tested this on a form I had and the output is very good. It printed it right at the top of the page (feels similar to how the devel module would show you debugging outputs which is a positive thing).
I also particularly like how the debugging has a blue background and the reason for why the email address was not validated has the yellow background. This makes things easier to know which is which just based off of background color. I attached a screenshot to point out what I mean by this.
This has passed testing.
Comment #12
oadaeh commentedThis has been committed to the 2.x dev branch. Thanks for the reviews and testing.
Comment #13
oadaeh commentedComment #14
kristen polThanks!
Comment #15
oadaeh commented