Exchange aspires to be responsible for the various types of e-commerce interactions available on the Artsy platform. It's currently a prototype, with legacy e-commerce still handled by Gravity. It uses Ruby, Rails, Postgresql, and exposes a GraphQL API.
- State: production
- Production: https://exchange.artsy.net, Admin Dashboard | Sidekiq Dashboard
- Staging: https://exchange-staging.artsy.net, Admin Dashboard | Sidekiq Dashboard
- GitHub: https://github.com/artsy/exchange/
- Point People: @sweir27, @ansor4
- CI/Deploys: CircleCi; merged PRs to
artsy/exchange#masterare automatically deployed to staging; PRs from
releaseare automatically deployed to production. Start a deploy...
Fork the project to your GitHub account
Clone your fork:
$ git clone firstname.lastname@example.org:your-github-username/exchange.git
$ bundle install
Once setup, you can run the tests like this:
$ bundle exec rspec
If this is your first time starting the app, make sure your database is setup first by running:
rails db:create rails db:setup
Then run Procfile.dev via foreman to start the web (rails) and worker (sidekiq) services:
foreman start -f Procfile.dev
Did You Change Models?
We use the PaperTrail gem to maintain a log of data changes to important models within the main relational database.
If you changed something in the
/models make sure to inform #data (analytics) team about it in case it impacts their reports.
Did You Change GraphQL Schema?
Metaphysics is the current consumer of Exchange GraphQL schema and keeps a copy of latest schema in https://github.com/artsy/metaphysics/tree/master/src/data, if you have changed Exchange GraphQL schema, make sure you also update the copy of this schema in Metaphysics. In order to do so follow these steps:
- In exchange run
schema.graphqlfile generated ☝🏼 to
mv schema.graphql exchange.graphql
- copy file above to your local update Metaphysics under
src/dataand make a PR to Metaphysics with this change.
There is a guide on how to add exchange operations to Metaphysics here
Talking to Exchange
In order to talk to Exchange GraphQL endpoint:
- Update the
REPLACEvalues in the
.envfile. You can reference the values used on staging with
hokusai staging env getor use copy_env to automate the task.
gem install dotenv
- Start local server
dotenv rails s
- If you work at Artsy, get proper Gravity User Token following these instructions (the client application name is "Exchange Staging").
- Install and run GraphiQL app
brew cask install graphiql
- In GraphiQL app, go to http://localhost:3000/api/graphql, you should ge unauthorized error
- Edit HTTP Headers and add
Authorizationheader and set it to
<token>is your Gravity token generated few steps above.
Working at Artsy?
Get Access To Exchange
Access to Exchange Admin is limited to users with the role "Sales Admin". Ask someone with Role Manager permissions to grant your user "Sales Admin" permissions.
Something went wrong? Ideally in the JSON response returned from Exchange there will be enough info to describe what went wrong. In case that was not useful, you can:
- Check Sentry (password in 1Pass) and look for Exchange (staging or production) and see the error.
- Follow exchange logs by doing
hokusai staging logs -f
If you think there is something we could improve in this error case, feel free to open an issue with details about what you did and what went wrong.