testground / sync-service

Testground Sync Service

This repository contains the service that Testground uses for synchronization between multiple test instances.

Issues

Please report issues in the testground/testground repo.

License

Dual-licensed: MIT, Apache Software License v2, by way of the Permissive License Stack.

sync-service's Issues

The sync service

Hey y'all,

In the current state of Testground, the SDKs are connecting directly to Redis. We want to build an SDK for JavaScript that also works on the browser. However, we cannot connect to Redis directly from the browser as it does not provide a native HTTP interface. Thus, works on sdk-js are paused until this issue here is closed.

The goal is to create a sync service that can be used by Testground. The sync service provides an HTTP interface and it is a bridge to Redis - or virtually any other backend that we might want to use in the future. Due to the dimension of Testground, this needs to be well tested and we must make sure everything works flawlessly during the transition.

Required

• Implement the sync service (this repository)
• Review this repository code
  • @hacdias
  • @nonsense
• Setup auto builds for Docker: docker pull iptestground/sync-service
• Replace Redis by custom implementation:
  • PR: #7
  • Discussion testground/testground#1229
• testground/sdk-go: testground/sdk-go#37
• testground/testground: testground/testground#1187
• testground/infra: testground/infra#66

Work on after

• testground/sdk-js: testground/sdk-js#17

A few months after release

• Remove backwards compatibility of Redis: #10

Replace Redis by custom implementation

Since we're moving to our own sync service, we decided to also ditch Redis instead of having yet one more layer. By using our own implementation, we can reduce the code complexity significantly since the portion of Redis we use is quite small.

A link to a more descriptive discussion regarding the decision process is going to be added soon.

Remove Redis backwards compatibility in 3 months

After 2/3 months after the sync service being released (#4), we should remove the backwards compatibility with the old SDK versions from Testground. The required repositories to change are:

• https://github.com/testground/infra: Remove any Redis instance and variables.
• https://github.com/testground/testground: Remove any Redis healthcheck, variables and related.

sync service memory leak?

If a test creates one barrier or more, then fails, it looks like we'll never GC it.

testground is a cyclic dependency

We depend on testground here https://github.com/testground/sync-service/blob/master/go.mod#L8 while testground depends on sync-service through sdk-go https://github.com/testground/testground/blob/master/go.mod#L33 and https://github.com/testground/sdk-go/blob/master/go.mod#L14

This prevented me from updating plan-templates in https://github.com/testground/testground/blob/master/go.mod#L32

cc @laurentsenta