Git Product home page Git Product logo

fabric8-notification's Introduction

Fabric8 Notification service

1. Contributes

1.1. Project Structure

This project is build around Notification Type in center.

To register new notification type and to see list of exisitng notification type check in main.go

1.1.1. Introducing New / Ehnancing Existing - Notification Type

For each kind of Notification, there is one Notification Type is defined. This section will give details on what are the components of Notification Type which helps to introduce new Notification Type or Enhance existing one.

Register

New Notification Type can be registered as below,

resolvers.Register("analytics.notify.cve", collector.ConfiguredVars(config, collector.NewCVEResolver(authClient, witClient)), nil)
  • First arg, Notification Type name (string), here it is "analytics.notify.cve". You need to come up with unique Notification Type name depending on what kind of New Notificatoin you want to support. Later value of this will be used to get registered Resolver and Validator in NotifyController.Send()

  • Second arg, ReceiverResolver, it is used to find out list of users to which email should be sent when Notificatin arrives for given Notification Type, more on this later.

  • Third arg, ParamValidator, it is used to validate parameter received in Notification payload.

Resolver

ReceiverResolver is responsible to return list of email to which notification sent for given Notification Type. Resolver will get ID attribute as input.

The value of ID attibute should be decided such that the related emails can be fetched. For ex, to find notification email list for workitem.create workitem.go type, one would like to get Workitem.ID for newly created workitem.

You can also decide to set ID with value of codebase_url for analytics.notify.cve cve.go type as with url one can find users who have registred for CVE notification on given Codebase URL.

Resolver will generally get initialized with 'WIT Client' and 'Auth Client' which will be used to query data based on ID to get notification email list.

Template

This is about email template which include email body, subject, headers etc. All email templates are maintained in template folder. For each Notification Type there is one folder with its name.

  • body.html - mandatory file which should have email body. It uses golang template link.

  • subject.txt - mandatory file which should have subject like for email. It uses golang template link.

1.2. Notification API

Here is sequence diagram of "/api/notify" API. Client will call this API to send Notification Emails.

NotifyAPI

1.3. Build Project

This project use glide build system.

1.3.1. Prerequisites

One should have go, git, mercurial, make installed on the system.

1.3.2. make commands for local development
make all - build everything

Run make all to build the whole project. After this one can find executable created at ./bin/fabric8-notification and run the same to run the Notification service locally.

While running locally, you need to set mandrill.apikey configuration param. This param used in sending notification email. While doing local devl and testing, you can skip send_email part and thus comment in main.go which validate this param.

make preview - test email generation against template

Run make preview to run preview/main.go. This will execute all template generation defined in main.go file. This is useful when you want to check output of you template. The output email will be stored at ./tmp/ folder with file name having Notification Type name as prefix.

make test-unit-no-coverage - execute unit tests

Run make test-unit-no-coverage to run unit tests without coverage.

make clean

Run make clean clean all artificates generated during build. This is not removing ./tmp/ folder.

1.3.3. Updating WIT/Auth API dependency

This project uses WIT/Auth Client API. Time to time WIT/Auth project dependency should be changed in glide files to get latest WIT/Auth API.

fabric8-notification's People

Contributors

aslakknutsen avatar sbose78 avatar mindreeper2420 avatar nurali-techie avatar geetikabatra avatar jmelis avatar alexeykazakov avatar fche avatar invinciblejai avatar kwk avatar jarifibrahim avatar sbryzak avatar surajssd avatar vpavlin avatar

Watchers

James Cloos avatar Matous Jobanek avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.