03. Upgrade guide

Upgrade Activity-Relay from v1.x.x, v0.x.x to v2.x.x

Activity-Relay v2.x.x has some breaking changes. You need to check this guide to successfully upgrade properly.

What version are you CURRENTLY running Activity-Relay?

~ v1.1.2, <v1.2.0 (v1.2.0 Release Date: Nov 23, 2022)

Problem

The worker's queue name changed in v1.2.0, but until v1.2.6 there was a task drop feature for tasks with the old queue name. In v2.0.0 this feature has been removed. Tasks with the old queue name will not be deleted.

Solution

• Please upgrade to v1.2.0 or above (not including v2.0.0) and run the worker for a while.

What version did you START running Activity-Relay?

~ v0.1.1, <v0.2.0 (v0.2.0 Release Date: Dec 9, 2018)

The Redis schema has changed in v0.2.0, but remains backwards compatible up to v1.2.6. It is no longer compatible with new features.

Solution

If your relay server has subscribers that are following on ~v0.1.1, you'll need to request a refollow.

How to identify such subscribers?

Using the Redis CLI, run hgetall relay:subscription:example@example.com (replacing example@example.com). The result does not have keys 'activity_id' and 'actor_id' (only has 'inbox_url').