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