fabric8-services / fabric8-notification Goto Github PK

View Code? Open in Web Editor NEW

0.0 0.0 18.0 322 KB

License: Apache License 2.0

HTML 20.83% Go 58.99% Makefile 17.16% Ruby 0.38% Shell 2.64%

fabric8-notification's People

Contributors

Watchers

Forkers

adamj aslakknutsen hectorj2f vpavlin pranavgore09 fche sbose78 alexeykazakov jmelis dipak-pawar sbryzak nurali-techie invinciblejai surajssd geetikabatra matousjobanek jaybatra26 xcoulon

fabric8-notification's Issues

Design WorkItem Comment Updated notification email

CI is broken due to failing tests

See #61

Create brief for notification service enhancements

Prepare summary document describing the enhancements we would like to introduce to the notification service.

Unknown value work-item.name

The workitem templates refer to a [work-item.name] value. Not sure which value this is intended to be. Using woritem-type.name for now (e.g. bug, scenario etc)

Inconsistent use of Number-Name

Some locations use Number-Name while other use Name-Number.

add title and readme outlining how other components should use notification service

see $subject :)

Design WorkItem Updated notification email

Add graceful shutdown

Avoid the process being killed during rolling update before emails for currently received requests are scheduled.

Design WorkItem Comment Created notification email

Scale Profile images correctly

When user has an imageURL from gravatar we can easily append "?s=22" to the URL and we're good, but some have imageURL from github which contain another URL parameter "?v=n" appending "?s=22" to that has no effect.

The image size function need to take the additional parameter into account

Comment messages are sent as Pointer refs

Fail to parse template on missing system.description

{
	"err": "template: workitem.create:75:49: executing \"workitem.create\" at <\"system.description....>: invalid value; expected string",
	"file": "/tmp/go/src/github.com/fabric8-services/fabric8-notification/email/notifier.go",
	"func": "github.com/fabric8-services/fabric8-notification/email.(*AsyncWorkerNotifier).do",
	"id": "workitem.create",
	"identity_id": "46e9afce-5e0d-44fd-aa2b-2040357a4efb",
	"level": "error",
	"line": 89,
	"msg": "failed to render template",
	"pid": 1,
	"pkg": "github.com/fabric8-services/fabric8-notification/email",
	"req_headers": {
		"Accept-Encoding": [
			"gzip"
		],
		"Authorization": "*****",
		"Content-Length": [
			"162"
		],
		"Content-Type": [
			"application/json"
		],
		"User-Agent": [
			"Go-http-client/1.1"
		]
	},
	"req_id": "MwdOyF7UZn-73647",
	"req_payload": "{\"data\":{\"attributes\":{\"id\":\"d3e78d1f-bf18-4a21-9fca-968675d7a91f\",\"type\":\"workitem.create\"},\"id\":\"af2ccbfc-cb07-4376-a150-36afce7143fd\",\"type\":\"notifications\"}}",
	"time": "2017-08-01 08:53:06",
	"type": "d3e78d1f-bf18-4a21-9fca-968675d7a91f"
}

Design WorkItem Created notification email

Add direct link to comment on comment.create|update

"Open this" links to the WorkItem details. It would be handy if this linked directly to the comment.

Require some additional UI / Backend changes:

Support anchor in HTML to scroll to the comment
Backend might need some support to 'fetch all up until this point' or similar. As the requested comment might not be part of the '5 last' comments.

Parameterize Web URLs in templates

Create initial Notification service

Support receiving events from WIT

Create Workitem
Update WorkItem
Create Comment
Update Comment

Should email Collaborators, WorkItem Assignees, WorkItem Creator and Commenters

Add pagination support for Collaborators call

support cico test coverage job

Issue:
For PR #99, we have observed that the ci.centos.org PR build (coverage) check is failing with following error.

/bin/bash: cico_run_coverage.sh: No such file or directory

Link: https://ci.centos.org/job/devtools-fabric8-notification-coverage/1/console

Fix:
Check whether we can run_tests_with_coverage and get meaningful metrics out of it. If yes, plz add support for run_tests_with_coverage. If we find that the run_tests_with_coverage take similar (almost same) build time as compared to run_tests_without_coverage then we can only have run_tests_with_coverage.

Don't notify the user that has done the action

Use service account token issued by Auth to get user's email from Auth service

As an offshoot of fabric8-services/fabric8-auth#237 (comment)

When notification service comes up, call Auth service API to request for service account token, and keep it in memory.
Subsequently use the token from configuration memory object.
On the auth side, check for service account token, and based on that show the email .

 func (a *AsyncWorkerNotifier) do(cn contextualNotification) { 

 ctx, notification := cn.context, cn.notification 

 receivers, vars, err := notification.Resolver(ctx, notification.ID) 

 if err != nil { 

 log.Error(ctx, map[string]interface{}{ 

 "type": notification.Type, 

 "id": notification.ID, 

 "err": err, 

 }, "failed to resolve receivers") 

 return 

 } 

 if receivers == nil || len(receivers) == 0 { 

 log.Info(ctx, map[string]interface{}{ 

 "type": notification.Type, 

 "id": notification.ID, 

 }, "skipping send email as no receivers resolved") 

 return 

 } 

 if vars == nil { 

 vars = map[string]interface{}{} 

 } 

 vars["custom"] = notification.CustomAttributes 

 subject, body, headers, err := notification.Template.Render(vars) 

 if err != nil { 

 log.Error(ctx, map[string]interface{}{ 

 "type": notification.Type, 

 "id": notification.ID, 

 "err": err, 

 }, "failed to render template") 

 return 

 } 

 a.Sender.Send(ctx, subject, body, headers, receivers)

, if there is no receiver, no email is sent, but there's also no error returned to the caller, which can result in opening issues such as openshiftio/openshift.io#4605

	func (a *AsyncWorkerNotifier) do(cn contextualNotification) {
	ctx, notification := cn.context, cn.notification

	receivers, vars, err := notification.Resolver(ctx, notification.ID)
	if err != nil {
	log.Error(ctx, map[string]interface{}{
	"type": notification.Type,
	"id": notification.ID,
	"err": err,
	}, "failed to resolve receivers")

	return
	}
	if receivers == nil \|\| len(receivers) == 0 {
	log.Info(ctx, map[string]interface{}{
	"type": notification.Type,
	"id": notification.ID,
	}, "skipping send email as no receivers resolved")
	return
	}

	if vars == nil {
	vars = map[string]interface{}{}
	}

	vars["custom"] = notification.CustomAttributes

	subject, body, headers, err := notification.Template.Render(vars)
	if err != nil {
	log.Error(ctx, map[string]interface{}{
	"type": notification.Type,
	"id": notification.ID,
	"err": err,
	}, "failed to render template")

	return
	}
	a.Sender.Send(ctx, subject, body, headers, receivers)

fabric8-services / fabric8-notification Goto Github PK

fabric8-notification's People

Contributors

Watchers

Forkers

fabric8-notification's Issues

Recommend Projects

Recommend Topics

Recommend Org