|
| 1 | +/* |
| 2 | + * Copyright 2019 Square Inc. |
| 3 | + * |
| 4 | + * Licensed under the Apache License, Version 2.0 (the "License"); |
| 5 | + * you may not use this file except in compliance with the License. |
| 6 | + * You may obtain a copy of the License at |
| 7 | + * |
| 8 | + * http://www.apache.org/licenses/LICENSE-2.0 |
| 9 | + * |
| 10 | + * Unless required by applicable law or agreed to in writing, software |
| 11 | + * distributed under the License is distributed on an "AS IS" BASIS, |
| 12 | + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 13 | + * See the License for the specific language governing permissions and |
| 14 | + * limitations under the License. |
| 15 | + */ |
| 16 | +package com.squareup.workflow.debugging |
| 17 | + |
| 18 | +import com.squareup.workflow.debugging.WorkflowHierarchyDebugSnapshot.Child |
| 19 | +import com.squareup.workflow.internal.WorkflowId |
| 20 | +import kotlin.LazyThreadSafetyMode.PUBLICATION |
| 21 | + |
| 22 | +/** |
| 23 | + * Describes a tree of snapshots of the states of the entire workflow tree after a particular render |
| 24 | + * pass. |
| 25 | + * |
| 26 | + * Emitted from [com.squareup.workflow.WorkflowSession.debugInfo]. |
| 27 | + * |
| 28 | + * @param workflowType A string representation of the type of this workflow. |
| 29 | + * @param state The actual state value of the workflow. |
| 30 | + * @param children All the child workflows that were rendered by this workflow in the last render |
| 31 | + * pass. See [Child]. |
| 32 | + */ |
| 33 | +data class WorkflowHierarchyDebugSnapshot( |
| 34 | + val workflowType: String, |
| 35 | + val props: Any?, |
| 36 | + val state: Any?, |
| 37 | + val rendering: Any?, |
| 38 | + val children: List<Child> |
| 39 | +) { |
| 40 | + /** Convenience constructor to get the workflow type string the right way. */ |
| 41 | + constructor( |
| 42 | + workflowId: WorkflowId<*, *, *>, |
| 43 | + props: Any?, |
| 44 | + state: Any?, |
| 45 | + rendering: Any?, |
| 46 | + children: List<Child> |
| 47 | + ) : this(workflowId.typeDebugString, props, state, rendering, children) |
| 48 | + |
| 49 | + /** |
| 50 | + * Represents a workflow that was rendered by the workflow represented by a particular |
| 51 | + * [WorkflowHierarchyDebugSnapshot]. |
| 52 | + * |
| 53 | + * @param key The string key that was used to render this child. |
| 54 | + * @param snapshot The [WorkflowHierarchyDebugSnapshot] that describes the state of this child. |
| 55 | + */ |
| 56 | + data class Child( |
| 57 | + val key: String, |
| 58 | + val snapshot: WorkflowHierarchyDebugSnapshot |
| 59 | + ) |
| 60 | + |
| 61 | + /** |
| 62 | + * This formatted string is expensive to generate, so cache it. |
| 63 | + */ |
| 64 | + private val lazyDescription by lazy(PUBLICATION) { |
| 65 | + buildString { |
| 66 | + writeSnapshot(this@WorkflowHierarchyDebugSnapshot) |
| 67 | + } |
| 68 | + } |
| 69 | + |
| 70 | + override fun toString(): String = """ |
| 71 | + |WorkflowHierarchyDebugSnapshot( |
| 72 | + ${toDescriptionString().trimEnd().prependIndent("| ")} |
| 73 | + |) |
| 74 | + """.trimMargin("|") |
| 75 | + |
| 76 | + /** |
| 77 | + * Generates a multi-line, recursive string describing the update. |
| 78 | + */ |
| 79 | + fun toDescriptionString(): String = lazyDescription |
| 80 | +} |
| 81 | + |
| 82 | +private fun StringBuilder.writeSnapshot(snapshot: WorkflowHierarchyDebugSnapshot) { |
| 83 | + append("workflowType: ") |
| 84 | + appendln(snapshot.workflowType) |
| 85 | + |
| 86 | + append("props: ") |
| 87 | + appendln(snapshot.props) |
| 88 | + |
| 89 | + append("state: ") |
| 90 | + appendln(snapshot.state) |
| 91 | + |
| 92 | + append("rendering: ") |
| 93 | + append(snapshot.rendering) |
| 94 | + |
| 95 | + if (snapshot.children.isNotEmpty()) { |
| 96 | + appendln() |
| 97 | + appendln("children (${snapshot.children.size}):") |
| 98 | + |
| 99 | + val childIndent = "| " |
| 100 | + for ((index, child) in snapshot.children.withIndex()) { |
| 101 | + append("| key: ") |
| 102 | + appendln(child.key.ifEmpty { "{no key}" }) |
| 103 | + append( |
| 104 | + child.snapshot.toDescriptionString() |
| 105 | + .prependIndent(childIndent) |
| 106 | + ) |
| 107 | + if (index < snapshot.children.size - 1) appendln() |
| 108 | + } |
| 109 | + } |
| 110 | +} |
0 commit comments