Story #8964

[SDKs] Design more idiomatic and convenient Go SDK

Added by Tom Clegg over 4 years ago. Updated 7 months ago.

Assigned To:
Target version:
Start date:
Due date:
% Done:


Estimated time:
Story points:


Sketches of client code


Packages (which features go where)


Specific features


Related issues

Related to Arvados - Story #9374: [Crunch2] [SDKs] Refactor duplicate code from crunch-dispatch and crunch-run into the Go SDKResolved06/08/2016

Related to Arvados - Story #14467: [SDK] Merge Go ArvadosClient and arvados.Client and migrate to arvados.ClientNew


#1 Updated by Tom Clegg over 4 years ago

  • Description updated (diff)
  • Category set to SDKs
Some wish-list items:
  • stub API server (for testing client code without bringing up a real server)
  • stub Keep server
  • use more stdlib interfaces like Reader and Writer
  • create new client from env vars
  • create new client from config file
  • thread safety (and clear docs about which things are thread-safe)
  • configurable logging
  • no globals (should be able to run tests in parallel -- except, where necessary, "run test server"-like integration tests that rely on external state)
  • convenient event listener that automatically reconnects after failures (without missing any events) and offers a "timestamp of most recent message" function to test freshness

#2 Updated by Tom Clegg about 4 years ago

TBD: the existing SDK uses map[string]string for request bodies, so you can do things like "update 'state' attribute to 'Running', without touching other attributes". When we use real types for arvados database records, though, we send all attributes with every update request, which can result in unnecessary lost updates. A better way to avoid lost updates is to use Etag and If-Matches. This would have to be implemented on both the client side and the API side.

#3 Updated by Peter Amstutz about 3 years ago

  • Status changed from New to In Progress

#4 Updated by Peter Amstutz over 1 year ago

  • Related to Story #14467: [SDK] Merge Go ArvadosClient and arvados.Client and migrate to arvados.Client added

#5 Updated by Tom Morris over 1 year ago

  • Release deleted (12)

#6 Updated by Peter Amstutz 7 months ago

  • Status changed from In Progress to Closed

Also available in: Atom PDF