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