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