README.md

Features from the Digital Marketplace platform were migrated to BuyICT.gov.au in May 2022. The DTA no longer maintains a separate Digital Marketplace platform.

---

Digital Marketplace utils

Running Tests

# Initial install
make install

# Linting (with flake8)
make lint

# Testing (with pytest)
make test

# Testing 2 and 3 support (with tox)
make tox

# Full test and lint
make testall

What's in here?

• Digital Marketplace API clients
• Formatting utilities for Digital Marketplace
• Digital Marketplace logging for Flask using JSON Logging
• Utility functions/libraries for Amazon S3, Mailchimp/Mandrill, Cloudwatch
• Helper code for Flask configuration
• A formed version of Flask Feature Flags

Logging from applications

When logging from applications you should write your message as a format string and pass any required arguments to the log method in the extra named argument. This allows our logging to use them as separate fields in our JSON logs making it much easier to search and aggregate on them.

logger.info("the user {user_id} did the thing '{thing}'", extra={
    'user_id': user_id, 'thing': thing
})

Note that apart from not getting the benefit, passing the formatted message can be dangerous. User generated content may be passed, unescaped to the .format method.

Using FeatureFlags

Hide not-ready-to-ship features until they're ready.

Basic implementation

# config.py

class Config(object):
  FEATURE_FLAGS_THING = enabled_since('2015-10-08')

# main/views.py

from .. import flask_featureflags

@main.route('/')
def index():
	return render_template("index.html")

@main.route('/shiny-new-thing')
@flask_featureflags.is_active_feature('THING', redirect_to='/')
def shiny_new_thing():
	return render_template("shiny_new_thing.html")

<!-- templates/index.html -->

<p>Content</p>
{% if 'THING' is active_feature %}
	<a href="{{ url_for('.shiny_new_thing') }}">Check out this cool thing!</a>
{% endif %}

Documentation

Documentation for the extension lives here.

Deviations from source code

1. Only Inline Flags are recognized.

   # Do this
   FEATURE_FLAGS_THING = True
   
   # Not this
   FEATURE_FLAGS: {
   	'thing': True
   }

2. get_flags()

   Returns all of the flags and their values set in our config file (for the current environment), but it doesn't know which ones exist elsewhere in the code. If you define a flag in the code that isn't in the config file, it will throw an error but only once you come across it.

   Hit up the /_status endpoint of each app to see which flags are being used (if any).

3. enabled_since('yyyy-mm-dd')

   Super simple way of tracking how long flags have been turned on. Flags are considered active if they return any truthy value, so by assigning them a date string (ideally, one corresponding to the current date), we'll know when they were activated.

   Accuracy of dates will depend on cognizant developers and vigilant code reviewers.