From 21ce8df89b4aa8b7781caf07531533a6bd4842c0 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Janek=20G=C3=B3ral?= <jan.goral@gogoapps.io>
Date: Wed, 17 Mar 2021 07:22:05 +0100
Subject: [PATCH] Add Artifacts to steps.md

---
 docs/refactor/steps.md | 43 +++++++++++++++++++++++++++++++++++++++++-
 1 file changed, 42 insertions(+), 1 deletion(-)

diff --git a/docs/refactor/steps.md b/docs/refactor/steps.md
index 22b5914b82..29d0192d5e 100644
--- a/docs/refactor/steps.md
+++ b/docs/refactor/steps.md
@@ -473,6 +473,7 @@ object RemoteStorage {
 * `SavedMatrix`
 * `TestOutcome`
 * `TestSuiteOverviewData`
+* `MatrixMap`
 * `CancelCommand` -> `cancelLastRun` -> `cancelMatrices` -> `GcTestMatrix/cancel`
 * `RefreshCommand` -> `refreshLastRun`
     * `refreshMatrices`
@@ -491,7 +492,13 @@ object RemoteStorage {
 
 ```kotlin
 object TestMatrix {
+    
     data class Result(
+        val runPath: String,
+        val map: Map<String, Data>,
+    )
+    
+    data class Data(
         val matrixId: String = "",
         val state: String = "",
         val gcsPath: String = "",
@@ -546,7 +553,7 @@ object TestMatrix {
     )
 
     interface Cancel : (Identity) -> Unit
-    interface Refresh : (Identity) -> Result
+    interface Refresh : (Identity) -> Data
 }
 ```
 
@@ -841,6 +848,7 @@ object JUnitTest {
 `ftl/data/PerfMetrics.kt`
 
 ```kotlin
+package ftl.data
 
 object PerfMetrics {
 
@@ -906,4 +914,37 @@ object PerfMetrics {
 
     interface Fetch : (Identity) -> Summary
 }
+```
+
+### Fetching Artifacts
+
+#### Target
+
+* `FetchArtifacts.kt`
+
+#### Interface
+
+`ftl/data/PerfMetrics.kt`
+
+```kotlin
+package ftl.data
+
+object Artifacts {
+    
+    data class Identity(
+        val gcsPathWithoutRootBucket: String,
+        val gcsRootBucket: String,
+        val regex: List<Regex>,
+        val blobPath: String,
+        val downloadPath: DownloadPath,
+    )
+    
+    data class DownloadPath(
+        val localResultDir: String,
+        val useLocalResultDir: Boolean,
+        val keepFilePath: Boolean,
+    )
+    
+    interface Fetch: (Identity) -> List<String> 
+}
 ```
\ No newline at end of file