forgejo-docs/docs/contributor/adr/adr-activity-for-like.md at next

mirror of https://codeberg.org/forgejo/docs.git synced 2024-11-21 17:36:59 -05:00

Otto Richter 64fe34712f Update contributing sections (#821 )

Rename Developer to Contributor guide
- I believe this sounds more inclusive and likely improves the diversity of contributors.
Separate translation section
clarify external resources
Add links to UI/UX and user research repos
Separate issue tracker and discussions
- I imagine this is part of the confusion for people who report bugs to the discussion tracker.
Add welcome section

Reviewed-on: https://codeberg.org/forgejo/docs/pulls/821
Reviewed-by: Gusted <gusted@noreply.codeberg.org>
Co-authored-by: Otto Richter <git@otto.splvs.net>
Co-committed-by: Otto Richter <git@otto.splvs.net>

2024-08-25 16:15:48 +00:00

4.1 KiB

Raw Permalink Blame History

title	license
ADR: Activity for Like	CC-BY-SA-4.0

Status

Active

Context

While implementing the star activity we have to take several decisions which will impact all other activities. Due to this relevance we will discuss decision with as many federation contributors as possible.

Decision

We decided to use "2. Like Activity while source information comes from NodeInfo"

Choices

1. Star Activity derived from AP Like with additional source information

# edn notation
{@context [
    "as":    "https://www.w3.org/ns/activitystreams#",
    "forge": "https://forgefed.org/ns#",],
  ::as/id "https://repo.prod.meissa.de/api/v1/activitypub/user-id/1/outbox/12345",
  ::as/type "Star",
  ::forge/source "forgejo",
  ::as/actor "https://repo.prod.meissa.de/api/v1/activitypub/user-id/1",
  ::as/object "https://codeberg.org/api/v1/activitypub/repository-id/12"
}

# json notation
{"id": "https://repo.prod.meissa.de/api/v1/activitypub/user-id/1/outbox/12345",
  "type": "Star",
  "source": "forgejo",
  "actor": "https://repo.prod.meissa.de/api/v1/activitypub/user-id/1",
  "object": "https://codeberg.org/api/v1/activitypub/repository-id/1",
  "startTime": "2014-12-31T23:00:00-08:00",
}

This way of expressing stars will have the following features:

Actor & object may be dereferenced by (ap-)api
The activity can be referenced itself (e.g. in order to express a result of the triggered action)
Star is a special case of a Like. Star only happens in ForgeFed context. Different things should be named different ...
With the source given it would be more easy to distinguish the uri layout for object and actor id's and make implementation more straight forward
1. The source field reflects the software sending an activity. Values of it may be forgejo, gitlab, ...
2. Knowing the sending system will make it easier to interact with:
  1. We know exactly how the actor can be dereferenced - names may be filled & used different (see: 7cac9806f8/routers/api/v1/activitypub/repository.go (L180))
  2. We know how we can validate the given references - valid uris will be different in details (see: 7cac9806f8/models/forgefed/actor.go (L121))
startTime protects against The Reply Attack discussed in threat-analysis

2. Like Activity while source information comes from NodeInfo

# NodeInfo
{
  "version": "2.1",
  "software": {
    "name": "gitea",
    "version": "1.20.0+dev-2539-g5840cc6d3",
  },
  "protocols": [
    "activitypub"
  ],
}

# Like Activity
{"id": "https://repo.prod.meissa.de/api/v1/activitypub/user-id/1/outbox/12345",
  "type": "Like",
  "actor": "https://repo.prod.meissa.de/api/v1/activitypub/user-id/1",
  "object": "https://codeberg.org/api/v1/activitypub/repository-id/1",
  "startTime": "2014-12-31T23:00:00-08:00"
}