OXYGENHUB
# 0ca942a9a1e4 oxygenhub-android / app / src / main / java / io / oxygenhub / android / api / HubClient.kt
20.7 KiB · last changed Assign issues from the phone: the Assignees action, with Assign me and any username, saved as the whole set (refs #4) 8 days ago source blame history raw
1
package io.oxygenhub.android.api
2
3
import java.io.IOException
4
import kotlinx.serialization.KSerializer
5
import kotlinx.serialization.builtins.ListSerializer
6
import kotlinx.serialization.json.JsonArray
7
import kotlinx.serialization.json.JsonObject
8
import kotlinx.serialization.json.JsonPrimitive
9
import kotlinx.serialization.json.buildJsonObject
10
import kotlinx.serialization.json.put
11
import okhttp3.HttpUrl
12
import okhttp3.HttpUrl.Companion.toHttpUrl
13
import okhttp3.OkHttpClient
14
import okhttp3.Request
15
import okhttp3.RequestBody.Companion.toRequestBody
16
17
/**
18
 * What the app asks of a hub, signed in. The view models see only this, so
19
 * their tests give them a fake. Later screens (oxygenhub-android#3–#5) add
20
 * to it: a repository's tree, history, proposals, runs.
21
 */
22
interface HubApi {
23
    /** The signed-in account (`GET /user`, scope `user:read`). */
24
    suspend fun user(): User
25
26
    /** Every repository the caller can read (`GET /repos`). */
27
    suspend fun repositories(): List<Repository>
28
29
    /** A repository's issues (`GET /repos/{owner}/{name}/issues?state=`). */
30
    suspend fun issues(owner: String, name: String, state: IssueState = IssueState.Open): List<Issue>
31
32
    /** The inbox: the unread count and the newest entries (`GET /notifications`). */
33
    suspend fun inbox(limit: Int = 50): Inbox
34
35
    /** Marks one notification read (`POST /notifications/{id}/read`). */
36
    suspend fun markRead(id: Long)
37
38
    /** Marks the whole inbox read (`POST /notifications/read`). */
39
    suspend fun markAllRead()
40
41
    /** Revokes the token this client signs in with (`DELETE /user/token`). */
42
    suspend fun revokeToken()
43
44
    /**
45
     * This phone takes alerts (#16): its Cloud Messaging [fcmToken] and its
46
     * alert key's [publicKey] (hex), for the token it signed in with
47
     * (`PUT /user/push`). Whether the hub sends alerts at all.
48
     */
49
    suspend fun registerPush(fcmToken: String, publicKey: String): Boolean
50
51
    /**
52
     * The proposals the caller should act on, across repositories (the hub's
53
     * dashboard); with [landable], also those it can land now (#20, oxygenhub#311).
54
     */
55
    suspend fun userProposals(landable: Boolean = false): UserProposals
56
57
    /** A repository's proposals: open (with drafts), landed, closed or all. */
58
    suspend fun proposals(owner: String, name: String, state: ProposalState = ProposalState.Open): List<Proposal>
59
60
    suspend fun proposal(owner: String, name: String, number: Long): Proposal
61
62
    /** The checks on a proposal's projected state. */
63
    suspend fun checks(owner: String, name: String, number: Long): List<Check>
64
65
    /**
66
     * Land it (`repo:write`); the proposal as landed. The hub refuses with 409
67
     * and its reason when it may not land, and 403 when the token lacks the scope.
68
     */
69
    suspend fun land(owner: String, name: String, number: Long): Proposal
70
71
    /** Land it by itself when its checks pass, or not (`repo:write`); the proposal after. */
72
    suspend fun setAutoLand(owner: String, name: String, number: Long, on: Boolean): Proposal
73
74
    /** A one-time token registering this phone as a runner for the account's repositories (`repo:write`). */
75
    suspend fun runnerToken(): RunnerToken
76
77
    suspend fun issue(owner: String, name: String, number: Long): Issue
78
79
    /** A repository's runs, newest first. */
80
    suspend fun runs(owner: String, name: String): List<FlowRun>
81
82
    /** One run, with its jobs. */
83
    suspend fun run(owner: String, name: String, number: Long): FlowRun
84
85
    /** A job's log lines after [after] (0: from the start). */
86
    suspend fun jobLog(owner: String, name: String, number: Long, job: String, after: Long): List<LogLine>
87
88
    suspend fun rerunRun(owner: String, name: String, number: Long)
89
90
    /** Run [job] again in the same run, with the jobs that depend on it. */
91
    suspend fun rerunJob(owner: String, name: String, number: Long, job: String)
92
93
    suspend fun cancelRun(owner: String, name: String, number: Long)
94
95
    /** Approve, or reject, a job that waits for a person (#5, oxygenflow#57); its approval rules decide who may. */
96
    suspend fun decideJob(owner: String, name: String, number: Long, job: String, approve: Boolean)
97
98
    /** Make a run urgent, saying why (#5, oxygenhub#244): a maintainer's, within the owner's cap. */
99
    suspend fun expediteRun(owner: String, name: String, number: Long, reason: String)
100
101
    /** [owner]'s project boards the caller can see. */
102
    suspend fun projects(owner: String): List<Project>
103
104
    suspend fun board(owner: String, number: Long): Board
105
106
    /** Move a card to the column named [column]. */
107
    suspend fun moveCard(owner: String, number: Long, card: Long, column: String)
108
109
    suspend fun issueComments(owner: String, name: String, number: Long): List<Comment>
110
111
    suspend fun comment(owner: String, name: String, number: Long, body: String): Comment
112
113
    /** Close (with why: `completed` or `not_planned`) or reopen. */
114
    suspend fun setIssueState(owner: String, name: String, number: Long, open: Boolean, reason: String = "completed"): Issue
115
116
    suspend fun createIssue(owner: String, name: String, title: String, body: String): Issue
117
118
    /** The repository's labels, to choose from. */
119
    suspend fun labels(owner: String, name: String): List<Label>
120
121
    /** The issue's whole set of labels (triage). */
122
    suspend fun setIssueLabels(owner: String, name: String, number: Long, labels: List<String>): Issue
123
124
    /** The issue's whole set of assignees (triage, #4). */
125
    suspend fun setIssueAssignees(owner: String, name: String, number: Long, assignees: List<String>): Issue
126
127
    /** One repository (`GET /repos/{owner}/{name}`): its default bookmark, for the code browser. */
128
    suspend fun repository(owner: String, name: String): Repository
129
130
    /** A directory of the tree at [ref] (a bookmark, tag or change), [path] "" for the top. */
131
    suspend fun tree(owner: String, name: String, ref: String, path: String = ""): List<TreeEntry>
132
133
    /** A file's bytes at [ref], as text. */
134
    suspend fun file(owner: String, name: String, ref: String, path: String): String
135
136
    /** [ref]'s history, newest first; only changes to [path] when given. */
137
    suspend fun history(owner: String, name: String, ref: String, path: String? = null, offset: Int = 0, limit: Int = 50): History
138
139
    suspend fun change(owner: String, name: String, hash: String): ChangeDetail
140
141
    /** Review a proposal (#4): [verdict] is `approve`, `changes` or `comment`, with [body] said. */
142
    suspend fun review(owner: String, name: String, number: Long, verdict: String, body: String)
143
144
    /** The files a proposal changes, each with its diff, as the proposal page shows them (#4). */
145
    suspend fun proposalDiff(owner: String, name: String, number: Long): List<FileChange>
146
147
    /** The repository's bookmarks and tags, to browse at. */
148
    suspend fun refs(owner: String, name: String): Pair<List<String>, List<String>>
149
150
    /** An account's picture (`/avatar/{name}`, public); null when the hub has none this app can draw. */
151
    suspend fun avatar(name: String): Avatar?
152
153
    /** An account's public profile, and an organisation's (with its members). */
154
    suspend fun account(name: String): User
155
156
    suspend fun organisation(name: String): Organisation
157
}
158
159
/**
160
 * The hub's JSON API over OkHttp. [onUnauthorized] runs when the hub
161
 * refuses the token (revoked on the web, or 90 days unused), so the app
162
 * can drop the session and ask for a new sign-in.
163
 */
164
class HubClient(
165
    hub: String,
166
    private val token: String,
167
    private val http: OkHttpClient,
168
    private val onUnauthorized: () -> Unit = {},
169
) : HubApi {
170
    private val base: HttpUrl = "${hub.trimEnd('/')}/api/v1/".toHttpUrl()
171
    private val root: HttpUrl = "${hub.trimEnd('/')}/".toHttpUrl()
172
173
    override suspend fun user(): User = get("user", User.serializer())
174
175
    override suspend fun repositories(): List<Repository> = get("repos", ListSerializer(Repository.serializer()))
176
177
    override suspend fun issues(owner: String, name: String, state: IssueState): List<Issue> =
178
        get(url("repos", owner, name, "issues") { addQueryParameter("state", state.query) }, ListSerializer(Issue.serializer()))
179
180
    override suspend fun inbox(limit: Int): Inbox =
181
        get(url("notifications") { addQueryParameter("limit", limit.coerceIn(1, 200).toString()) }, Inbox.serializer())
182
183
    override suspend fun runnerToken(): RunnerToken = send("POST", url("user", "runner-token"), RunnerToken.serializer())
184
185
    override suspend fun runs(owner: String, name: String): List<FlowRun> =
186
        get(url("repos", owner, name, "flow", "runs"), ListSerializer(FlowRun.serializer()))
187
188
    override suspend fun run(owner: String, name: String, number: Long): FlowRun =
189
        get(url("repos", owner, name, "flow", "runs", number.toString()), FlowRun.serializer())
190
191
    override suspend fun jobLog(owner: String, name: String, number: Long, job: String, after: Long): List<LogLine> =
192
        get(
193
            url("repos", owner, name, "flow", "runs", number.toString(), "jobs", job, "log") { addQueryParameter("after", after.toString()) },
194
            ListSerializer(LogLine.serializer()),
195
        )
196
197
    override suspend fun rerunRun(owner: String, name: String, number: Long) {
198
        send("POST", url("repos", owner, name, "flow", "runs", number.toString(), "rerun"))
199
    }
200
201
    override suspend fun rerunJob(owner: String, name: String, number: Long, job: String) {
202
        send("POST", url("repos", owner, name, "flow", "runs", number.toString(), "jobs", job, "rerun"))
203
    }
204
205
    override suspend fun cancelRun(owner: String, name: String, number: Long) {
206
        send("POST", url("repos", owner, name, "flow", "runs", number.toString(), "cancel"))
207
    }
208
209
    override suspend fun decideJob(owner: String, name: String, number: Long, job: String, approve: Boolean) {
210
        send("POST", url("repos", owner, name, "flow", "runs", number.toString(), "jobs", job, if (approve) "approve" else "reject"))
211
    }
212
213
    override suspend fun expediteRun(owner: String, name: String, number: Long, reason: String) {
214
        sendJson("POST", url("repos", owner, name, "flow", "runs", number.toString(), "expedite"), buildJsonObject {
215
            put("reason", reason)
216
        }, Expedited.serializer())
217
    }
218
219
    override suspend fun projects(owner: String): List<Project> = get(url("projects", owner), ListSerializer(Project.serializer()))
220
221
    override suspend fun board(owner: String, number: Long): Board = get(url("projects", owner, number.toString()), Board.serializer())
222
223
    override suspend fun moveCard(owner: String, number: Long, card: Long, column: String) {
224
        val json = buildJsonObject { put("column", column) }
225
        call(request(url("projects", owner, number.toString(), "cards", card.toString())).method("PATCH", json.toString().toRequestBody(JsonMedia)).build(), true)
226
    }
227
228
    override suspend fun issue(owner: String, name: String, number: Long): Issue =
229
        get(url("repos", owner, name, "issues", number.toString()), Issue.serializer())
230
231
    override suspend fun issueComments(owner: String, name: String, number: Long): List<Comment> =
232
        get(url("repos", owner, name, "issues", number.toString(), "comments"), ListSerializer(Comment.serializer()))
233
234
    override suspend fun comment(owner: String, name: String, number: Long, body: String): Comment =
235
        sendJson("POST", url("repos", owner, name, "issues", number.toString(), "comments"), buildJsonObject { put("body", body) }, Comment.serializer())
236
237
    override suspend fun setIssueState(owner: String, name: String, number: Long, open: Boolean, reason: String): Issue =
238
        sendJson(
239
            "POST",
240
            url("repos", owner, name, "issues", number.toString()),
241
            buildJsonObject {
242
                put("state", if (open) "open" else "closed")
243
                if (!open) put("reason", reason)
244
            },
245
            Issue.serializer(),
246
        )
247
248
    override suspend fun createIssue(owner: String, name: String, title: String, body: String): Issue =
249
        sendJson("POST", url("repos", owner, name, "issues"), buildJsonObject {
250
            put("title", title)
251
            put("body", body)
252
        }, Issue.serializer())
253
254
    override suspend fun labels(owner: String, name: String): List<Label> =
255
        get(url("repos", owner, name, "labels"), ListSerializer(Label.serializer()))
256
257
    override suspend fun setIssueAssignees(owner: String, name: String, number: Long, assignees: List<String>): Issue =
258
        sendJson("PATCH", url("repos", owner, name, "issues", number.toString()), buildJsonObject {
259
            put("assignees", JsonArray(assignees.map { JsonPrimitive(it) }))
260
        }, Issue.serializer())
261
262
    override suspend fun setIssueLabels(owner: String, name: String, number: Long, labels: List<String>): Issue =
263
        sendJson("PATCH", url("repos", owner, name, "issues", number.toString()), buildJsonObject {
264
            put("labels", JsonArray(labels.map { JsonPrimitive(it) }))
265
        }, Issue.serializer())
266
267
    override suspend fun account(name: String): User = get(url("users", name), User.serializer())
268
269
    override suspend fun organisation(name: String): Organisation = get(url("orgs", name), Organisation.serializer())
270
271
    override suspend fun repository(owner: String, name: String): Repository = get(url("repos", owner, name), Repository.serializer())
272
273
    private fun parts(path: String): Array<String> = path.split('/').filter { it.isNotEmpty() }.toTypedArray()
274
275
    override suspend fun tree(owner: String, name: String, ref: String, path: String): List<TreeEntry> =
276
        get(url("repos", owner, name, "tree", ref, *parts(path)), ListSerializer(TreeEntry.serializer()))
277
278
    override suspend fun file(owner: String, name: String, ref: String, path: String): String =
279
        call(request(url("repos", owner, name, "file", ref, *parts(path))).get().build(), notifyUnauthorized = true)
280
281
    override suspend fun history(owner: String, name: String, ref: String, path: String?, offset: Int, limit: Int): History =
282
        get(
283
            url("repos", owner, name, "history", ref) {
284
                path?.let { addQueryParameter("path", it) }
285
                addQueryParameter("offset", offset.toString())
286
                addQueryParameter("limit", limit.toString())
287
            },
288
            History.serializer(),
289
        )
290
291
    override suspend fun review(owner: String, name: String, number: Long, verdict: String, body: String) {
292
        sendJson("POST", url("repos", owner, name, "proposals", number.toString(), "reviews"), buildJsonObject {
293
            put("verdict", verdict)
294
            put("body", body)
295
        }, ReviewPosted.serializer())
296
    }
297
298
    override suspend fun proposalDiff(owner: String, name: String, number: Long): List<FileChange> =
299
        get(url("repos", owner, name, "proposals", number.toString(), "diff"), ListSerializer(FileChange.serializer()))
300
301
    override suspend fun change(owner: String, name: String, hash: String): ChangeDetail =
302
        get(url("repos", owner, name, "changes", hash), ChangeDetail.serializer())
303
304
    override suspend fun refs(owner: String, name: String): Pair<List<String>, List<String>> {
305
        val bookmarks = get(url("repos", owner, name, "bookmarks"), ListSerializer(NamedRef.serializer())).map { it.name }
306
        val tags = get(url("repos", owner, name, "tags"), ListSerializer(NamedRef.serializer())).map { it.name }
307
        return bookmarks to tags
308
    }
309
310
    override suspend fun userProposals(landable: Boolean): UserProposals =
311
        get(url("user", "proposals") { if (landable) addQueryParameter("landable", "true") }, UserProposals.serializer())
312
313
    override suspend fun proposals(owner: String, name: String, state: ProposalState): List<Proposal> =
314
        get(url("repos", owner, name, "proposals") { addQueryParameter("state", state.query) }, ListSerializer(Proposal.serializer()))
315
316
    override suspend fun proposal(owner: String, name: String, number: Long): Proposal =
317
        get(url("repos", owner, name, "proposals", number.toString()), Proposal.serializer())
318
319
    override suspend fun checks(owner: String, name: String, number: Long): List<Check> =
320
        get(url("repos", owner, name, "proposals", number.toString(), "checks"), ListSerializer(Check.serializer()))
321
322
    override suspend fun land(owner: String, name: String, number: Long): Proposal =
323
        send("POST", url("repos", owner, name, "proposals", number.toString(), "land"), Proposal.serializer())
324
325
    override suspend fun setAutoLand(owner: String, name: String, number: Long, on: Boolean): Proposal =
326
        send(if (on) "POST" else "DELETE", url("repos", owner, name, "proposals", number.toString(), "auto-land"), Proposal.serializer())
327
328
    override suspend fun markRead(id: Long) {
329
        send("POST", url("notifications", id.toString(), "read"))
330
    }
331
332
    override suspend fun markAllRead() {
333
        send("POST", url("notifications", "read"))
334
    }
335
336
    override suspend fun revokeToken() {
337
        send("DELETE", url("user", "token"), notifyUnauthorized = false)
338
    }
339
340
    override suspend fun registerPush(fcmToken: String, publicKey: String): Boolean =
341
        sendJson("PUT", url("user", "push"), buildJsonObject {
342
            put("fcm_token", fcmToken)
343
            put("public_key", publicKey)
344
        }, PushRegistered.serializer()).alerts
345
346
    override suspend fun avatar(name: String): Avatar? {
347
        val url = root.newBuilder().addPathSegment("avatar").addPathSegment(name).build()
348
        // A public picture: no token goes with it.
349
        val response = try {
350
            http.newCall(Request.Builder().url(url).get().build()).await()
351
        } catch (e: IOException) {
352
            throw HubException.Network(e)
353
        }
354
        response.use { r ->
355
            if (r.code == 404) return null
356
            val bytes = try {
357
                r.body?.bytes() ?: ByteArray(0)
358
            } catch (e: IOException) {
359
                throw HubException.Network(e)
360
            }
361
            if (!r.isSuccessful) throw HubException.Http(r.code, errorDetail(bytes.decodeToString()))
362
            return Avatar.parse(r.header("Content-Type"), bytes)
363
        }
364
    }
365
366
    // The bearer token is never part of a string anything prints.
367
    override fun toString(): String = "HubClient(${base})"
368
369
    private fun url(vararg segments: String, query: HttpUrl.Builder.() -> Unit = {}): HttpUrl {
370
        val b = base.newBuilder()
371
        // Each segment is encoded on its own: an owner or name never adds a path level.
372
        segments.forEach { b.addPathSegment(it) }
373
        b.query()
374
        return b.build()
375
    }
376
377
    private suspend fun <T> get(path: String, serializer: KSerializer<T>): T = get(url(*path.split('/').toTypedArray()), serializer)
378
379
    private suspend fun <T> get(url: HttpUrl, serializer: KSerializer<T>): T {
380
        val body = call(request(url).get().build(), notifyUnauthorized = true)
381
        return try {
382
            HubJson.decodeFromString(serializer, body)
383
        } catch (e: IllegalArgumentException) {
384
            // kotlinx.serialization's errors are IllegalArgumentExceptions.
385
            throw HubException.Unreadable("GET ${url.encodedPath}", e)
386
        }
387
    }
388
389
    private suspend fun send(method: String, url: HttpUrl, notifyUnauthorized: Boolean = true): String {
390
        val body = if (method == "DELETE") null else "{}".toRequestBody(JsonMedia)
391
        return call(request(url).method(method, body).build(), notifyUnauthorized)
392
    }
393
394
    private suspend fun <T> send(method: String, url: HttpUrl, serializer: KSerializer<T>): T {
395
        val body = send(method, url)
396
        return try {
397
            HubJson.decodeFromString(serializer, body)
398
        } catch (e: IllegalArgumentException) {
399
            throw HubException.Unreadable("$method ${url.encodedPath}", e)
400
        }
401
    }
402
403
    /** [json] as the body; the answer read with [serializer]. */
404
    private suspend fun <T> sendJson(method: String, url: HttpUrl, json: JsonObject, serializer: KSerializer<T>): T {
405
        val body = call(request(url).method(method, json.toString().toRequestBody(JsonMedia)).build(), notifyUnauthorized = true)
406
        return try {
407
            HubJson.decodeFromString(serializer, body)
408
        } catch (e: IllegalArgumentException) {
409
            throw HubException.Unreadable("$method ${url.encodedPath}", e)
410
        }
411
    }
412
413
    private fun request(url: HttpUrl): Request.Builder = Request.Builder()
414
        .url(url)
415
        .header("Accept", "application/json")
416
        .header("Authorization", "Bearer $token")
417
418
    private suspend fun call(request: Request, notifyUnauthorized: Boolean): String {
419
        val response = try {
420
            http.newCall(request).await()
421
        } catch (e: IOException) {
422
            throw HubException.Network(e)
423
        }
424
        response.use { r ->
425
            val text = try {
426
                r.body?.string().orEmpty()
427
            } catch (e: IOException) {
428
                throw HubException.Network(e)
429
            }
430
            if (!r.isSuccessful) {
431
                if (r.code == 401 && notifyUnauthorized) onUnauthorized()
432
                throw HubException.Http(r.code, errorDetail(text))
433
            }
434
            return text
435
        }
436
    }
437
}