Request organization account #11184

divbzero · 2022-04-15T08:25:32Z

Create data models for organizations.
Define services to create and retrieve organizations.
Add form to request new organization to /manage/organizations/ page.
Record events for new organization request.
Send emails to user and admins for new organization request.
Closes Create an Organization account #11070.

Testing Setup

make serve to run locally.
make initdb to initialize the database.
Uncheck and save the disable-organizations admin flag at http://localhost/admin/flags/.

Testing Steps

Submit the Create new organization form at http://localhost/manage/organizations/.
Submit the same form again with the same organization name.

Expected Behavior

Notification emails to admins and the requesting user appear in the maildev interface at http://localhost:1080/.
Form displays validation error when submitted again with the same organization name.
New organization is inserted into the warehouse.organizations database table with is_active IS FALSE and is_approved IS NULL.

On second thought, we probably don't want localization for admin emails.

docker-compose run web python -m warehouse db revision --autogenerate --message "Create Organization models" make reformat Forced to regenerate migrations due to recent database changes (pypi#11157).

- Organization account name - Organization name - Organization URL - Organization description - Organization type

Found the droids that we're looking for.

This is a placeholder so we can reference `admin.organization.approve` as a route in the admin-new-organization-requested email.

- `ManageOrganizationsViews.default_response` - `ManageOrganizationsViews.manage_organizations()`

make translations

- `ManageOrganizationsViews.create_organization()`

Co-Authored-By: sterbo <matt.sterba@gmail.com>

divbzero · 2022-04-18T20:30:08Z

@ewdurbin I think this PR is ready for review again — and ready for merge too if everything looks good. Please let us know if there are other issues or questions we should address. Thank you!

The next PR for approving the organization account (#11208) is ready for review too as soon as this PR is merged.

divbzero · 2022-04-18T20:42:28Z

We also added the disable-organizations admin flag with 5034ac0 and 161ab19.

ewdurbin

I would like to see us store references to users in the OrganizationEvents as User.id rather than sticking with the status quo, so that is a blocker on merge for me.

As far as the Enum questions go, I believe that can be a migration if we decide down the line, so it's more of a preference.

Otherwise this is 👍🏼 for me.

ewdurbin · 2022-04-19T14:10:07Z

warehouse/manage/views.py

+            )
+            self.organization_service.add_organization_role(
+                "Owner", self.request.user.id, organization.id
+            )


For the purposes of traceability we should use User IDs and reconstitute the user on display.

We should also do this elsewhere, since username changes are something that we want to support in the future, but that's not on you :)

ewdurbin · 2022-04-19T14:16:06Z

warehouse/organizations/models.py

+    )
+
+
+class OrganizationInvitationStatus(enum.Enum):


I should have done some research up front rather than ask the question, but SQLAlchemy has support for proper postgres enums, I think the biggest advantage is that if we utilize that we get actual types in the DB and it becomes possible to inspect them as well as ensure that columns don't contain references to out of date values since when using a naive enum.Enum we get a varchar/int field that isn't validated.

warehouse/organizations/models.py

- `make translations` for warehouse/locale/messages.pot - Update migration parent for 614a7fcb40ed_create_organization_models.py

- Remove `OrganizationEvents` class - Add `HasEvents` mixing to `Organization` - Update references {OrganizationEvents => Organization.Events} - Update database migration {organization_id => source_id}

`Organization.Event` with tag: - organization:create - organization:catalog_entry:add - organization:organization_role:invite - organization:organization_role:accepted `User.Event` with tag: - account:organization_role:accepted

If there is a validation error, return the existing invalid form instead of a new blank form so user can actually see that validation error.

@ewdurbin

- {created_by_id => created_by_user_id} - {submitted_by_id => submitted_by_user_id} Discussed with @ewdurbin. Using `*_user_id` seems more clear.

ewdurbin

I'm really happy with where this is at.

If there are no objections, I plan to merge.

divbzero · 2022-04-25T23:46:40Z

Note about PostgreSQL enums for future reference: SQLAlchemy supports PostgreSQL enums as @ewdurbin mentioned, but it looks like there have been issues with Alembic supporting PostgreSQL enums (sqlalchemy/alembic#278).

@ewdurbin

* admin-new-organization-requested email template * new-orgnization-requested email template * Test admin-new-organization-requested email * Test new-organization-requested email * Translate *-organization-requested consistently * `make translations` for *-organization-requested * Remove translations from admin-* emails On second thought, we probably don't want localization for admin emails. * Initial cut at db model architecture * Ran code thru make reformat and lint (pypa#11070) * Added tests for new db models (pypa#11070) * Numerous tweaks to db models * Require value for is_active and ran reformat. * Regenerate migrations for Organization models docker-compose run web python -m warehouse db revision --autogenerate --message "Create Organization models" make reformat Forced to regenerate migrations due to recent database changes (pypi#11157). * Numerous tweaks to alembic scripts * Initial implementation of organization service. * Implementing organization events functionality. * Added tests for organization services. * Added OrganizationFactory class for model. * Blank /manage/organizations/ page * Create organization form on /manage/organizations/ - Organization account name - Organization name - Organization URL - Organization description - Organization type * Register DatabaseOrganizationService Found the droids that we're looking for. * POST /manage/organizations/ database updates * Add .get_admins method to user service * POST /manage/organizations/ email notifications * Blank /admin/organizations/approve/ page This is a placeholder so we can reference `admin.organization.approve` as a route in the admin-new-organization-requested email. * Test GET /manage/organizations/ - `ManageOrganizationsViews.default_response` - `ManageOrganizationsViews.manage_organizations()` * Translations for /manage/organizations/ make translations * Fixed OrganizationType enum. * Test POST /manage/organizations/ - `ManageOrganizationsViews.create_organization()` * Test CreateOrganizationForm * Placeholder to test /admin/organizations/approve/ Provides code coverage for the blank page added in 2c70616. * Test `DatabaseUserService.get_admins()` * NFC: Add comments about intentionally blank page * Record events for POST /manage/organizations/ Co-Authored-By: sterbo <matt.sterba@gmail.com> * Test record events for POST /manage/organizations/ * Functional test for POST /manage/organizations/ * Comment out `OrganizationFactory` for future use Co-Authored-By: sterbo <matt.sterba@gmail.com> * NFC: Fix camel case for class names * Converted OrganizationRoleType to SQLAlchemy Enum * Add disable-organizations global admin flag * Add `AdminFlagValue.DISABLE_ORGANIZATIONS` * Modified org name catalog to store normalized name * {OrganizationEvents => Organization.Events} - Remove `OrganizationEvents` class - Add `HasEvents` mixing to `Organization` - Update references {OrganizationEvents => Organization.Events} - Update database migration {organization_id => source_id} * Store id instead of username in new events `Organization.Event` with tag: - organization:create - organization:catalog_entry:add - organization:organization_role:invite - organization:organization_role:accepted `User.Event` with tag: - account:organization_role:accepted * Display CreateOrganizationForm errors If there is a validation error, return the existing invalid form instead of a new blank form so user can actually see that validation error. * Tweak naming in events data {*_id => *_user_id} - {created_by_id => created_by_user_id} - {submitted_by_id => submitted_by_user_id} Discussed with @ewdurbin. Using `*_user_id` seems more clear. Co-authored-by: sterbo <matt.sterba@gmail.com>

divbzero and others added 30 commits April 15, 2022 01:34

admin-new-organization-requested email template

a9f6c66

new-orgnization-requested email template

aa2a939

Test admin-new-organization-requested email

0bde7fa

Test new-organization-requested email

6fb99e7

Translate *-organization-requested consistently

e8f1b5c

make translations for *-organization-requested

d7d7923

Remove translations from admin-* emails

bec7058

On second thought, we probably don't want localization for admin emails.

Initial cut at db model architecture

08fb166

Ran code thru make reformat and lint (pypa#11070)

28edd0f

Added tests for new db models (pypa#11070)

9de28f6

Numerous tweaks to db models

6efcb99

Require value for is_active and ran reformat.

086e2c7

Regenerate migrations for Organization models

df033eb

docker-compose run web python -m warehouse db revision --autogenerate --message "Create Organization models" make reformat Forced to regenerate migrations due to recent database changes (pypi#11157).

Numerous tweaks to alembic scripts

054b6c7

Initial implementation of organization service.

540bce5

Implementing organization events functionality.

0a95425

Added tests for organization services.

e0eb6e2

Added OrganizationFactory class for model.

0b0acc5

Blank /manage/organizations/ page

8d9cb8f

Create organization form on /manage/organizations/

99975f9

- Organization account name - Organization name - Organization URL - Organization description - Organization type

Register DatabaseOrganizationService

c9fb07d

Found the droids that we're looking for.

POST /manage/organizations/ database updates

e33b8ca

Add .get_admins method to user service

b2b0ec2

POST /manage/organizations/ email notifications

d4664d3

Blank /admin/organizations/approve/ page

5d9bcc5

This is a placeholder so we can reference `admin.organization.approve` as a route in the admin-new-organization-requested email.

Test GET /manage/organizations/

88663d7

- `ManageOrganizationsViews.default_response` - `ManageOrganizationsViews.manage_organizations()`

Translations for /manage/organizations/

f29a97d

make translations

Fixed OrganizationType enum.

e15e280

Test POST /manage/organizations/

67d3a28

- `ManageOrganizationsViews.create_organization()`

Test CreateOrganizationForm

acbfac6

divbzero and others added 8 commits April 15, 2022 20:38

Record events for POST /manage/organizations/

3b373b4

Co-Authored-By: sterbo <matt.sterba@gmail.com>

Test record events for POST /manage/organizations/

d9de8b3

Functional test for POST /manage/organizations/

1f40800

Comment out OrganizationFactory for future use

faa73f4

Co-Authored-By: sterbo <matt.sterba@gmail.com>

NFC: Fix camel case for class names

1163b5e

Converted OrganizationRoleType to SQLAlchemy Enum

eecf5de

Add disable-organizations global admin flag

5034ac0

Add AdminFlagValue.DISABLE_ORGANIZATIONS

161ab19

divbzero mentioned this pull request Apr 18, 2022

Request organization email templates #11166

Closed

divbzero mentioned this pull request Apr 18, 2022

Approve organization account #11208

Merged

ewdurbin requested changes Apr 19, 2022

View reviewed changes

di reviewed Apr 19, 2022

View reviewed changes

warehouse/organizations/models.py Outdated Show resolved Hide resolved

sterbo and others added 6 commits April 19, 2022 11:02

Modified org name catalog to store normalized name

0cb26b0

Merge branch 'main' into feature/request-organization-account

354f24d

- `make translations` for warehouse/locale/messages.pot - Update migration parent for 614a7fcb40ed_create_organization_models.py

{OrganizationEvents => Organization.Events}

c73674c

- Remove `OrganizationEvents` class - Add `HasEvents` mixing to `Organization` - Update references {OrganizationEvents => Organization.Events} - Update database migration {organization_id => source_id}

Store id instead of username in new events

db0ec20

`Organization.Event` with tag: - organization:create - organization:catalog_entry:add - organization:organization_role:invite - organization:organization_role:accepted `User.Event` with tag: - account:organization_role:accepted

Display CreateOrganizationForm errors

49fafee

If there is a validation error, return the existing invalid form instead of a new blank form so user can actually see that validation error.

Tweak naming in events data {*_id => *_user_id}

c37c786

- {created_by_id => created_by_user_id} - {submitted_by_id => submitted_by_user_id} Discussed with @ewdurbin. Using `*_user_id` seems more clear.

ewdurbin approved these changes Apr 20, 2022

View reviewed changes

ewdurbin merged commit 3ab750d into pypi:main Apr 20, 2022

woodruffw mentioned this pull request Apr 22, 2022

warehouse/migrations: add missing migrations for organizations #11238

Closed

divbzero added the organizations label Apr 26, 2022

sterbo added a commit to sterbo/warehouse that referenced this pull request Apr 27, 2022

Fix erroneous migration originating from pypi#11184

723927c

di pushed a commit that referenced this pull request Apr 27, 2022

Fix erroneous migration originating from #11184 (#11271)

47d25b3

domdfcoding pushed a commit to domdfcoding/warehouse that referenced this pull request Jun 7, 2022

Fix erroneous migration originating from pypi#11184 (pypi#11271)

e35d3d0

stephenfin mentioned this pull request Jul 11, 2022

Support Groups/Organizations #201

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Request organization account #11184

Request organization account #11184

divbzero commented Apr 15, 2022 •

edited

Loading

divbzero commented Apr 18, 2022

divbzero commented Apr 18, 2022

ewdurbin left a comment •

edited

Loading

ewdurbin Apr 19, 2022

ewdurbin Apr 19, 2022

ewdurbin left a comment

divbzero commented Apr 25, 2022

Request organization account #11184

Request organization account #11184

Conversation

divbzero commented Apr 15, 2022 • edited Loading

divbzero commented Apr 18, 2022

divbzero commented Apr 18, 2022

ewdurbin left a comment • edited Loading

Choose a reason for hiding this comment

ewdurbin Apr 19, 2022

Choose a reason for hiding this comment

ewdurbin Apr 19, 2022

Choose a reason for hiding this comment

ewdurbin left a comment

Choose a reason for hiding this comment

divbzero commented Apr 25, 2022

divbzero commented Apr 15, 2022 •

edited

Loading

ewdurbin left a comment •

edited

Loading