Refactor Project Structure

[harveysanders]

Continuation of #10

• Refactor project structure
• Add CI/CD GitHub workflows
• Remove internal email templates and use Mailgun's template API
• Add tests for existing functionality

Project Structure

There is a signupService struct that has a list of tasks to run on a signup form event from the operationspark.org website.

A task is an interface with run and name methods.

type task interface {
	// Run takes a signup form struct and executes some action.
	// Ex.: Send an email, post a Slack message.
	run(signup Signup) error
	// Name Returns the name of the task.
	name() string
}

When someone signs up for an Info Session, the form is parsed, then passed to a series of tasks for processing.

// function.go

// Set up services/tasks to run when someone signs up for an Info Session.
mgSvc := NewMailgunService(mgDomain, mgAPIKey, "")
glSvc := NewGreenlightService(glWebhookURL)
slackSvc := NewSlackService(slackWebhookURL)

// These registration tasks include:
registrationService := newSignupService(
	// posting a WebHook to Greenlight,
	glSvc,
	// sending a "Welcome Email",
	mgSvc,
	// sending a Slack message to #signups channel,
	slackSvc,
	// TODO:
	// registering the user for the Zoom meeting,
	// sending an SMS confirmation message to the user.
)

server := newSignupServer(registrationService)

// Register executes a series of tasks in order. If one fails, the remaining tasks are cancelled.
func (sc *SignupService) register(su Signup) error {
	// TODO: Create specific errors for each handler
	// TODO: Use context.Context to cancel subsequent requests on any failures
	for _, task := range sc.tasks {
		err := task.run(su)
		if err != nil {
			return fmt.Errorf("task failed: %q: %v", task.name(), err)
		}
	}
	return nil
}

To register a new task, create a service struct and implement the task interface:

Example

package signup

type skywriteService struct {
}

func NewSkyWriteService() *skywriteService {
  return &skywriteService{}
}

func (d skywriteService) run(su Signup) error {
	return d.skyWrite(su.NameFirst)
}

func (d skywriteService) name() string {
	return "dominos service"
}

// SkyWrite sends a drone out to draw someones name in chemtrails.
func (d skywriteService) skyWrite(name string) error {
	// Do the thing
	return nil
}

Then pass the service to the registration service in function.go.

func NewServer() {
	// ...
  registrationService := newSignupService(
    // ... other tasks,
    // (Order matters!)
    NewSkyWriteService()
	)
  // ...
	server := newSignupServer(registrationService)
	return server
}

TODO

• update QA token
• update mailgun templates
• handle "none of these fit my schedule" (gracefully)
• Use context to cancel subsequent requests

[harveysanders]

uber-go/atomic#120