make email_alert field available via services API

[jakubgs]

I've attempted to make it possible to enable email alerts by default by adding email_alert and it did't work.

The addition of is_public worked and makes it possible to create public services via API.

Resolves: #699

[jakubgs]

I can see that email_alert field:

cabot/cabot/cabotapp/models/base.py

Line 146 in 4e4ca0a

email_alert = models.BooleanField(default=False)

Is part of CheckGroupMixin class:

cabot/cabot/cabotapp/models/base.py

Line 94 in 4e4ca0a

class CheckGroupMixin(models.Model):

Which is inherited by the Service class:

cabot/cabot/cabotapp/models/base.py

Line 285 in 4e4ca0a

class Service(CheckGroupMixin):

Which contains the is_public attribute:

cabot/cabot/cabotapp/models/base.py

Lines 316 to 320 in 4e4ca0a

	is_public = models.BooleanField(
	verbose_name='Is Public',
	default=False,
	help_text='The service will be shown in the public home'
	)

So I'm not sure why email_alert doesn't work. They are both BooleanField type.

[jakubgs]

The field overall_status that is included in the services API endpoint:

cabot/cabot/rest_urls.py

Lines 50 to 57 in b18b1a0

	router.register(r'services', create_viewset(
	arg_model=models.Service,
	arg_fields=check_group_mixin_fields + (
	'url',
	'instances',
	'overall_status',
	),
	))

Seems to come from CheckGroupMixin:

cabot/cabot/cabotapp/models/base.py

Line 153 in 4e4ca0a

overall_status = models.TextField(default=PASSING_STATUS)

And that one works fine.

[jakubgs]

Oh, I see, there's a separate alerts field that is a list of types of alerts enabled:

cabot/cabot/cabotapp/models/base.py

Lines 140 to 144 in 4e4ca0a

	alerts = models.ManyToManyField(
	'AlertPlugin',
	blank=True,
	help_text='Alerts channels through which you wish to be notified'
	)

That's a bit confusing, but I figured that out based on the template. And this field is already exported.

[jakubgs]

It appears that 1 is the ID of the email alert type:

  {
    "name": "Websites",
    "users_to_notify": [
      2
    ],
    "alerts_enabled": true,
    "status_checks": [
      31,
    ],
    "alerts": [
      1
    ],
    "hackpad_id": "",
    "url": "https://example.org",
    "instances": [],
    "overall_status": "PASSING",
    "email_alert": true,
    "is_public": true,
    "id": 1
  }

Not sure where that's defined, but I assume it doesn't change.

[jakubgs]

I've dropped the addition of email_alert field.

[hartwork]

The related commit messages says "20.4.5" but the code says "20.3.4" 🤔 😃 How about pip<21? Gave me 20.3.4 in practice over here.