Open Apparel Registry

The Open Apparel Registry (OAR) is a tool to identify every apparel facility worldwide.

• Requirements
• Setup
  • Google Maps Platform
• Development
  • Hot Reloading 🔥
  • Debugging Django
  • Ports
  • Parallel Development of OGR
    • Parallel PR Workflow
• Scripts 🧰
• Management
  • Making Superusers

Requirements

• Vagrant 2.1+
• VirtualBox 5.0+

AWS Region

This project is hosted in eu-west-1 (ireland)

Setup

Run setup to bring up the development environment:

./scripts/setup

setup will provision a virtual machine (VM) that contains the tools needed to get started.

After executing setup, you can access the VM with:

$ vagrant ssh
vagrant@vagrant:/vagrant$

Google Maps Platform

The OAR requires a Google Maps Platform API key to interface with the Maps JavaScript API, Maps Static API, and Maps Geocoding API.

Without an API key, facility detail maps will not load on the client and geocoding will not function on the server. The basemap will also be low-resolution and watermarked with "for development purposes only."

See Getting Started with Google Maps Platform and Get the API key for an overview on how to get setup.

setup will stub out an environment variables file (.env) in the root of the project. To wire up your API key, simply update .env:

-GOOGLE_SERVER_SIDE_API_KEY=
-REACT_APP_GOOGLE_CLIENT_SIDE_API_KEY=
+GOOGLE_SERVER_SIDE_API_KEY=YOUR_API_KEY
+REACT_APP_GOOGLE_CLIENT_SIDE_API_KEY=YOUR_API_KEY
 REACT_APP_GOOGLE_ANALYTICS_KEY=

Note: Google Maps Platfom requires creation of a billing account, but they offer $200 of free monthly usage, which is enough to support development.

Development

To destroy the existing development database and load fresh fixture data, including users, facility lists, facility matches, and facilities, run:

# Access the VM console
$ vagrant ssh

# Load fixtures
vagrant@vagrant:/vagrant$ ./scripts/resetdb

To start the application, run:

vagrant@vagrant:/vagrant$ ./scripts/server

Hot Reloading 🔥

The frontend uses Create React App. When running server, the page will automatically reload if you make changes to the code.

The Django app runs inside a Gunicorn worker. The worker will restart if you make changes to the code.

Debugging Django

Breakpoint debugging of the Python back-end is available via Visual Studio Code. To get started, run the Django development server by passing the --debug flag to the server script. Note that you have to run the application in Docker for Mac directly and not within Vagrant to be able to debug.

./scripts/server --debug

In Visual Studio Code, select the "Run and Debug" view from the sidebar. At the top of the "Run and Debug" pane, click the green arrow next to the "Debug Django" menu item.

If Visual Studio Code can connect, you should see a play/pause/next menu bar in the top right of the window.

Set a breakpoint by clicking in the column next to the line numbers for a .py file. A red dot should appear. Now, if the breakpoint is hit when you visit a page of the app in the browser (note that you must access the site via the React development server port), Visual Studio Code should highlight the line in the file, the "Run and Debug" window should be populated with information about currently set variables, and execution of the code should be paused.

Note that, due to the way static files are managed for the normal development environment, the Django server at 8081 is not available when running the server script with the --debug flag.

Embedded Maps

Three users in development have embedded map access by default. User [email protected] has Embed Deluxe / Custom Embed permissions, the highest level; user [email protected] has Embed+ permissions; and user [email protected] has general Embed permissions, the lowest level.

In order to access the embedded map for a user with permissions, you must go to their Settings page and set up the basic map configuration, including height and width. A preview will then be available on their page, or you can visit http://localhost:6543/?embed=1&contributors=id where 'id' is the contributor's id.

Ports

Service	Port
React development server	6543
Gunicorn for Django app	8081

Parallel Development of OGR

The Open Goods Registry is the successor to OAR, and OGR will replace OAR when it is launched. During the beta period, both applications will be deployed and developed in parallel. Features development for OAR also need to be included in OGR, but there are OGR-specific features and related architectural changes that are not appropriate to be included in OAR. Too support this parallel development process, there are 4 main branches in the repository:

• develop
• master
• ogr/develop
• ogr/master

When OGR is released we will return to a single pair of develop and master branches by replacing their content with ogr/develop and ogr/master.

Parallel PR Workflow

• Is the new feature of fix specific to OGR?
  • Yes
    • Create a branch starting from ogr/develop
    • Create a pull request targeted at ogr/develop
    • Have the PR reviewed and merge it into ogr/develop
  • No
    • Create a branch starting from develop
    • Create a pull request targeted at develop
    • Have the PR reviewed
    • If the feature also applies to OGR
      • Create a new branch off of ogr/develop and git cherry-pick the clean, rebased commits from the PR branch
      • Verify that code still works in the context of OGR and add any additional commits required
      • Create a second PR targeted at ogr/develop
      • Have the PR reviewed, preferably by the same reviewer
      • Merge the second PR into ogr/develop
    • Merge the original PR into develop

Scripts 🧰

Name	Description
bootstrap	Update environment variables file
infra	Plan and apply remote infrastructure changes
resetdb	Clear development database & load fixture data including users, facility lists, matches, and facilities
server	Run docker-compose.yml services
setup	Provision Vagrant VM and run update
test	Run tests
update	Build container images and execute database migrations

Tools ⚒️

Name	Description
batch_process	Given a list id argument run parse, geocode, and match via the batch_process Django management command
devhealthcheck.sh	Simulate application load balancer health checks in development
postfacilitiescsv.py	POST the rows of a CSV containing facility information to the facilities API

Management

Making Superusers

In staging and production we do not have access to the Django Shell so granting superuser permissions to a member of the OAR team or development team that needs to manage the system requires the use SQL statements to adjust the permissions.

• Connect to the staging or production database via the bastion instance
• Run the following command

UPDATE api_user
SET is_staff = true, is_superuser = true
WHERE email ilike '{the user's email address}';

• You should see UPDATE 1 printed to the console. If not, check the email address and verify that the user has in fact registered an account in the environment (staging or production).