FacultyAWS

This is a template for new gems. The first thing you should do is to rename everything. Use underscores, not hyphens:

rake rename name=data_wrangler

Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file lib/faculty_aws. To experiment with that code, run bin/console for an interactive prompt.

TODO: Update details in the gemspec file

TODO: Set the GEMFURY_PUSH_TOKEN secret (see LastPass).

TODO: Delete this and the text above, and describe your gem

Installation

Add these lines to your application's Gemfile:

source 'https://gem.fury.io/universityofyork/' do
  gem 'uoy-faculty_aws', '~> 0.1', require: 'faculty_aws'
end

And then execute:

$ bundle

Or install it yourself as:

$ gem install uoy-faculty_aws

Usage

BackgroundTask

This module handles background tasks by sending them via an SQS FIFO queue.

Set ENV['BACKGROUND_QUEUE'] to the queue URL. In development mode, set ENV['BACKGROUND_INLINE'] (to yes, true or 1) - this bypasses the queue.

There is a lambda handler which you can set as the lambda handler in cloudformation:

  BackgroundTaskFunction:
    Type: AWS::Serverless::Function
    Properties:
      Handler: <filename>.FacultyAWS::BackgroundTask::LambdaHandler.background_task_handler

You'll need to set up a file that loads all of your required libraries and code, and filename should refer to this file. For sinatra apps, this should not be part of lambda.rb as this loads rack and sinatra, and you probably don't want those in the background tasks; see FlexiLeave for an example of how to do this. For other apps (e.g. mailing list generator), this can go as part of the existing lambda.rb.

To register a task in your app:

# Register a task handler
FacultyAWS::BackgroundTask.new :my_task do |required:, optional: 'world'|
  puts "#{required}, #{optional}"
end

By default, exceptions raised in the handler will cause the lambda to exit with an exception, and notify the developers. These behaviours can be disabled individually:

FacultyAWS::BackgroundTask.new :my_task, notify_on_failure: false do ...
FacultyAWS::BackgroundTask.new :my_task, raise_on_failure: false do ...

To queue the task to run in the background:

# Queue an event
FacultyAWS::BackgroundTask.enqueue(:simple_task_with_no_params)
FacultyAWS::BackgroundTask.enqueue(:my_task, required: 'Hello')
FacultyAWS::BackgroundTask.enqueue(:my_task, required: 'Goodbye', optional: 'everyone')

You can optionally specify the message group ID and/or deduplication ID. The group ID defaults to the task name (one "lane" per task), and the deduplication ID is a hash of the message body by default.

FacultyAWS::BackgroundTask.enqueue(:foo, param: 'arg', message_group_id: 'group 2')
FacultyAWS::BackgroundTask.enqueue(:foo, message_deduplication_id: '9a8b7c')

To run background tasks out of cron, set EventBridge to submit a JSON payload to SQS. It should be of the following form (params can be omitted):

{
  "task": "my_task",
  "params": {
    "named_parameter": "argument"
  }
}

Development

Versioning

Your Gem's version is picked up automatically from lib/faculty_aws.rb. When any changes are pushed to master, after the normal CI tasks the pipeline will push to gemfury automatically. The usual workflow is:

• For minor changes, update VERSION and make the change in a single commit

• For anything else, create a branch and set VERSION to the version you're aiming to release for. Make the changes; when the branch is merged, the gem will be uploaded.

Note that gemfury will never overwrite an existing gem version, even if the old one is yanked!

Running tests

Tests can be run via rake: bundle exec rake spec - this doesn't run performance tests; they can be run separately via bundle exec rake perf.

You can also run rspec normally e.g. bundle exec rspec -fd.

Identifying Performance Tests

If you have performance tests that take a while, tag the context / describe block like this:

context 'when foo is bar baz', :perf do
  ...
end

Contributing

Bug reports and pull requests are welcome at https://github.com/university-of-york/faculty-dev-faculty_aws-gem