Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[17.0][MIG] auth_signup_verify_email: Migration to 17.0 #681

Merged
merged 23 commits into from
Aug 23, 2024
Merged

[17.0][MIG] auth_signup_verify_email: Migration to 17.0 #681

merged 23 commits into from
Aug 23, 2024

Conversation

pedrobaeza
Copy link
Member

Resumed from #592, squashing some commits, removing offending pandoc*.deb file, and fixing pre-commit.

@Tecnativa TT50109

yajo and others added 23 commits August 23, 2024 18:53
@yajo @pedrobaeza
[9.0][MIG][auth_signup_verify_email] Migration. (OCA#436)
c9c7d5b 
* Add module auth_signup_verify_email.

* Import module following guidelines.

* README typos.

* OCA Transbot updated translations from Transifex

* Credit creator.

* author name correction

* [9.0][MIG][auth_signup_verify_email] Migration.

Migrate to v9.

* [FIX] auth_signup_verify_email: Python library requirement

* Add tests, fix xml tags, fix credits.

* Fix test.
@sharkende @pedrobaeza
[MIG][10] auth_signup_verify_email
ba81423 
* Module set to installable
* Odoo don't let signup without password
@oca-transbot @pedrobaeza
OCA Transbot updated translations from Transifex
a0055ae
@simahawk @pedrobaeza
[MIG][11] auth_signup_verify_email
b0cc992
@yajo @pedrobaeza
[FIX+REF] auth_signup_verify_email: Fix tests + Skip mail send in tes…
1a884c4 
…ts and use email_validator (OCA#29)

This addon introduced an integration conflict when tested in a database that had `mail_tracking_mass_mailing` installed, producing this failure:

    Traceback (most recent call last):
    File "/opt/odoo/auto/addons/auth_signup_verify_email/controllers/main.py", line 44, in passwordless_signup
        sudo_users.reset_password(values.get("login"))
    File "/usr/lib/python2.7/contextlib.py", line 24, in __exit__
        self.gen.next()
    File "/opt/odoo/custom/src/odoo/odoo/sql_db.py", line 419, in savepoint
        self.execute('RELEASE SAVEPOINT "%s"' % name)
    File "/opt/odoo/custom/src/odoo/odoo/sql_db.py", line 154, in wrapper
        return f(self, *args, **kwargs)
    File "/opt/odoo/custom/src/odoo/odoo/sql_db.py", line 231, in execute
        res = self._obj.execute(query, params)
    InternalError: no such savepoint

Which in turn produced the following in the next test:

    InternalError: current transaction is aborted, commands ignored until end of transaction block

The problem comes from the fact that one cannot rollback to a nested savepoint if the parent savepoint was released. It became a problem because that's the strategy that both this addon and upstream's `TestCursor` follow.

To avoid that, tests now mock the `send_mail` method. This results also in having a predictable outcome from the test `test_good_email`, so it is more meaningful now.

Besides, previously we were using the `validate_email` package, which is currently a dead project that can silently fail under certain environments, as seen in syrusakbary/validate_email#80.

There's the `email_validator` package, freely available, supported, and it provides a human-readable error message whenever some format from the email fails.

As such, here I'm switching the dependency, while still adding a backwards compatibility layer for preexisting installations.
@zaoral @pedrobaeza
[FIX] auth_signup_verify_email: Improve signup error messages
4e9feb2 
* When try to login with a not valid email domain it raised a 500 server
  error. Now we shwt the proper message "The domain name <domain> does not
  exist."
* If there is any error we do not have catched when we do the email
  validation then we manage it and show the error message to the user instead
  of 500 server error.
* When we try to register with a already registered email it raise "Something
  went wrong, please try again later or contact us". Now shows the message
  as odoo regular signup does: "Another user is already registered using this
  email address" which is more specific and clear for this case.
@Tardo @pedrobaeza
[MIG] auth_signup_verify_email: Migration to 12.0
f5b3ebe
@pedrobaeza
Translated using Weblate (Portuguese (Brazil))
5311710 
Currently translated at 100.0% (4 of 4 strings)

Translation: server-auth-12.0/server-auth-12.0-auth_signup_verify_email
Translate-URL: https://translation.odoo-community.org/projects/server-auth-12-0/server-auth-12-0-auth_signup_verify_email/pt_BR/
@badbole @pedrobaeza
Translated using Weblate (Croatian)
a71dde5 
Currently translated at 100.0% (4 of 4 strings)

Translation: server-auth-12.0/server-auth-12.0-auth_signup_verify_email
Translate-URL: https://translation.odoo-community.org/projects/server-auth-12-0/server-auth-12-0-auth_signup_verify_email/hr/
@Tardo @pedrobaeza
[IMP] auth_signup_verify_email: Remove hack
4a0fab3
@pedrobaeza
[FIX] auth_signup_verify_email: make tests compatible with website
ce5e4a5 
This commit fixes 2 problems:

1.  `auth_signup.allow_uninvited` ICP is no longer used.
    The new equivalent is `auth_signup.invitation_scope=b2c`.
2.  If running tests in an environment where `website` is installed,
    the website needs to get public signup enabled or tests here would
    fail with an error like this:

        2020-02-19 12:36:31,686 35 INFO prod odoo.modules.module: odoo.addons.auth_signup_verify_email.tests.test_verify_email running tests.
        2020-02-19 12:36:31,686 35 INFO prod odoo.addons.auth_signup_verify_email.tests.test_verify_email: test_bad_email (odoo.addons.auth_signup_verify_email.tests.test_verify_email.UICase)
        2020-02-19 12:36:31,686 35 INFO prod odoo.addons.auth_signup_verify_email.tests.test_verify_email: ` Test rejection of bad emails.
        2020-02-19 12:36:31,735 35 INFO ? odoo.http: HTTP Configuring static files
        2020-02-19 12:36:31,738 35 INFO prod odoo.addons.base.models.ir_http: Generating routing map
        2020-02-19 12:36:34,227 35 INFO prod werkzeug: 127.0.0.1 - - [19/Feb/2020 12:36:34] "GET /web/signup HTTP/1.1" 404 - 763 0.262 2.227
        2020-02-19 12:36:34,231 35 ERROR prod odoo.addons.auth_signup_verify_email.tests.test_verify_email: ERROR
        2020-02-19 12:36:34,231 35 INFO prod odoo.addons.auth_signup_verify_email.tests.test_verify_email: test_good_email (odoo.addons.auth_signup_verify_email.tests.test_verify_email.UICase)
        2020-02-19 12:36:34,231 35 INFO prod odoo.addons.auth_signup_verify_email.tests.test_verify_email: ` Test acceptance of good emails.
        2020-02-19 12:36:36,293 35 INFO prod werkzeug: 127.0.0.1 - - [19/Feb/2020 12:36:36] "GET /web/signup HTTP/1.1" 404 - 759 0.258 1.797
        2020-02-19 12:36:36,296 35 ERROR prod odoo.addons.auth_signup_verify_email.tests.test_verify_email: ERROR
        2020-02-19 12:36:36,297 35 INFO prod odoo.addons.auth_signup_verify_email.tests.test_verify_email: ======================================================================
        2020-02-19 12:36:36,297 35 ERROR prod odoo.addons.auth_signup_verify_email.tests.test_verify_email: ERROR: test_bad_email (odoo.addons.auth_signup_verify_email.tests.test_verify_email.UICase)
        2020-02-19 12:36:36,297 35 ERROR prod odoo.addons.auth_signup_verify_email.tests.test_verify_email: ` Test rejection of bad emails.
        2020-02-19 12:36:36,297 35 ERROR prod odoo.addons.auth_signup_verify_email.tests.test_verify_email: Traceback (most recent call last):
        2020-02-19 12:36:36,297 35 ERROR prod odoo.addons.auth_signup_verify_email.tests.test_verify_email: `   File "/opt/odoo/auto/addons/auth_signup_verify_email/tests/test_verify_email.py", line 20, in setUp
        2020-02-19 12:36:36,297 35 ERROR prod odoo.addons.auth_signup_verify_email.tests.test_verify_email: `     "csrf_token": self.csrf_token(),
        2020-02-19 12:36:36,297 35 ERROR prod odoo.addons.auth_signup_verify_email.tests.test_verify_email: `   File "/opt/odoo/auto/addons/auth_signup_verify_email/tests/test_verify_email.py", line 33, in csrf_token
        2020-02-19 12:36:36,297 35 ERROR prod odoo.addons.auth_signup_verify_email.tests.test_verify_email: `     return doc.xpath("//input[@name='csrf_token']")[0].get("value")
        2020-02-19 12:36:36,297 35 ERROR prod odoo.addons.auth_signup_verify_email.tests.test_verify_email: ` IndexError: list index out of range
        2020-02-19 12:36:36,297 35 INFO prod odoo.addons.auth_signup_verify_email.tests.test_verify_email: ======================================================================
        2020-02-19 12:36:36,298 35 ERROR prod odoo.addons.auth_signup_verify_email.tests.test_verify_email: ERROR: test_good_email (odoo.addons.auth_signup_verify_email.tests.test_verify_email.UICase)
        2020-02-19 12:36:36,298 35 ERROR prod odoo.addons.auth_signup_verify_email.tests.test_verify_email: ` Test acceptance of good emails.
        2020-02-19 12:36:36,298 35 ERROR prod odoo.addons.auth_signup_verify_email.tests.test_verify_email: Traceback (most recent call last):
        2020-02-19 12:36:36,298 35 ERROR prod odoo.addons.auth_signup_verify_email.tests.test_verify_email: `   File "/opt/odoo/auto/addons/auth_signup_verify_email/tests/test_verify_email.py", line 20, in setUp
        2020-02-19 12:36:36,298 35 ERROR prod odoo.addons.auth_signup_verify_email.tests.test_verify_email: `     "csrf_token": self.csrf_token(),
        2020-02-19 12:36:36,298 35 ERROR prod odoo.addons.auth_signup_verify_email.tests.test_verify_email: `   File "/opt/odoo/auto/addons/auth_signup_verify_email/tests/test_verify_email.py", line 33, in csrf_token
        2020-02-19 12:36:36,298 35 ERROR prod odoo.addons.auth_signup_verify_email.tests.test_verify_email: `     return doc.xpath("//input[@name='csrf_token']")[0].get("value")
        2020-02-19 12:36:36,298 35 ERROR prod odoo.addons.auth_signup_verify_email.tests.test_verify_email: ` IndexError: list index out of range
        2020-02-19 12:36:36,298 35 INFO prod odoo.addons.auth_signup_verify_email.tests.test_verify_email: Ran 2 tests in 4.611s
        2020-02-19 12:36:36,298 35 ERROR prod odoo.addons.auth_signup_verify_email.tests.test_verify_email: FAILED
        2020-02-19 12:36:36,298 35 INFO prod odoo.addons.auth_signup_verify_email.tests.test_verify_email:  (errors=2)
        2020-02-19 12:36:36,298 35 ERROR prod odoo.modules.module: Module auth_signup_verify_email: 0 failures, 2 errors

@Tecnativa TT21005
@em230418 @pedrobaeza
[IMP] auth_signup_verify_email: black, isort, prettier
1359061
@em230418 @pedrobaeza
[MIG] auth_signup_verify_email: Migration to 13.0
657631f
@RachidAlassir @pedrobaeza
Added translation using Weblate (Arabic)
7506b25 
Currently translated at 100.0% (4 of 4 strings)

Translation: server-auth-13.0/server-auth-13.0-auth_signup_verify_email
Translate-URL: https://translation.odoo-community.org/projects/server-auth-13-0/server-auth-13-0-auth_signup_verify_email/ar/
@em230418 @pedrobaeza
[IMP] auth_signup_verify_email: black, isort, prettier
ad914f7
@em230418 @pedrobaeza
[MIG] auth_signup_verify_email: Migration to 14.0
4c0cb25
@pedrobaeza
[FIX] auth_signup_verify_email: Use real email address for tests
3220edd 
In one part of the CI pipeline, the IANA example domains are not
accepted, getting this message from `email_validator` library:

The domain name example.com does not accept email

So we switch to a real domain for avoiding the problem, using our
famous main OCA list address, which at the end, it's not secret and
won't be disabled in a short future.
@em230418 @pedrobaeza
[MIG] auth_signup_verify_email: Migration to 15.0
7f41cfe
@bruno-zanotti @pedrobaeza
[IMP] auth_signup_verify_email: pre-commit stuff
cd061cd
@bruno-zanotti @pedrobaeza
[MIG] auth_signup_verify_email: Migration to 16.0
0ee50ce
@Ivorra78 @pedrobaeza
Translated using Weblate (Spanish)
707978c 
Currently translated at 100.0% (4 of 4 strings)

Translation: server-auth-16.0/server-auth-16.0-auth_signup_verify_email
Translate-URL: https://translation.odoo-community.org/projects/server-auth-16-0/server-auth-16-0-auth_signup_verify_email/es/
@augusto-weiss @pedrobaeza
[IMP] auth_signup_verify_email: pre-commit execution
f5f5af4
@augusto-weiss @pedrobaeza
[MIG] auth_signup_verify_email: Migration to 17.0
f426dfe
@pedrobaeza pedrobaeza mentioned this pull request Aug 23, 2024
Closed
@pedrobaeza
Copy link
Member Author

/ocabot migration auth_signup_verify_email

@OCA-git-bot OCA-git-bot added this to the 17.0 milestone Aug 23, 2024
@OCA-git-bot OCA-git-bot mentioned this pull request Aug 23, 2024
Open
19 tasks
@pedrobaeza
Copy link
Member Author

/ocabot merge nobump

@OCA-git-bot
Copy link
Contributor

On my way to merge this fine PR!
Prepared branch 17.0-ocabot-merge-pr-681-by-pedrobaeza-bump-nobump, awaiting test results.

@OCA-git-bot OCA-git-bot merged commit a5174dd into OCA:17.0 Aug 23, 2024
5 of 7 checks passed
@OCA-git-bot
Copy link
Contributor

Congratulations, your PR was merged at e23a843. Thanks a lot for contributing to OCA. ❤️

@pedrobaeza pedrobaeza deleted the 17.0-mig-auth_signup_verify_email branch August 23, 2024 17:21
@mac-adhoc
Copy link

@pedrobaeza would you mind to update the current Readme text by the following one in order to make ir clearer?

This module add an email verification process during new users Sign up process from /web/signup page, admiting "valid" email addresses only. In this verification process the module tries to send an invitation email to the new user with a unique access link which allows the new user to create a password (same email template than "reset password" mail).
This module also hides the "password" and "confirm password" fields from sign up form because the password would be set for the very first time when user clicks on the unique access link recieved by email.

Thanks in advanced!

@pedrobaeza
Copy link
Member Author

@mac-adhoc you can go to https://github.com/OCA/server-auth/blob/16.0/auth_signup_verify_email/readme/DESCRIPTION.rst, press . (the dot) to access to a VSCode environment, perform the modifications, and propose yourself a PR. Please give it a try to see if it's difficult.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
merged 🎉
Projects
None yet
Milestone
17.0
Development

Successfully merging this pull request may close these issues.