Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

web: ensure snapshots are under 4MB upload limit #4150

Merged
merged 3 commits into from
Feb 1, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
6 changes: 5 additions & 1 deletion web/src/HUD.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,10 @@ type HudProps = {
interfaceVersion: InterfaceVersion
}

// Snapshot logs are capped to 1MB (max upload size is 4MB; this ensures between the rest of state and JSON overhead
// that the snapshot should still fit)
const maxSnapshotLogSize = 1000 * 1000

// The Main HUD view, as specified in
// https://docs.google.com/document/d/1VNIGfpC4fMfkscboW0bjYYFJl07um_1tsFrbN-Fu3FI/edit#heading=h.l8mmnclsuxl1
export default class HUD extends Component<HudProps, HudState> {
Expand Down Expand Up @@ -191,7 +195,7 @@ export default class HUD extends Component<HudProps, HudState> {
snapshotFromState(state: HudState): Proto.webviewSnapshot {
let view = _.cloneDeep(state.view ?? null)
if (view && state.logStore) {
view.logList = state.logStore.toLogList()
view.logList = state.logStore.toLogList(maxSnapshotLogSize)
}
return {
view: view,
Expand Down
47 changes: 47 additions & 0 deletions web/src/LogStore.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -426,4 +426,51 @@ describe("LogStore", () => {
"build ...... 3\nbuild 4\nbuild 5"
)
})

it("truncates output for snapshots", () => {
let logs = new LogStore()

logs.append({
spans: {
"build:1": { manifestName: "fe" },
},
segments: [newManifestSegment("build:1", "build 1\n")],
fromCheckpoint: 0,
toCheckpoint: 1,
})

logs.append({
spans: {
"build:2": { manifestName: "be" },
},
segments: [
newManifestSegment("build:2", "build 2\n"),
newManifestSegment("build:2", "build 3\n"),
],
fromCheckpoint: 1,
toCheckpoint: 3,
})

logs.append({
spans: {
"": {},
},
segments: [newGlobalSegment("global line 1\n")],
fromCheckpoint: 3,
toCheckpoint: 4,
})

const logList = logs.toLogList(28)
// log should be truncated
expect(logList.segments?.length).toEqual(2)
// order should be preserved
expect(logList.segments![0].text).toEqual("build 3\n")
expect(logList.segments![1].text).toEqual("global line 1\n")

// only spans referenced by segments in the truncated output should exist
const spans = logList.spans as { [key: string]: Proto.webviewLogSpan }
expect(Object.keys(spans).length).toEqual(2)
expect(spans["build:2"].manifestName).toEqual("be")
expect(spans["_"].manifestName).toEqual("")
})
})
40 changes: 27 additions & 13 deletions web/src/LogStore.ts
Original file line number Diff line number Diff line change
Expand Up @@ -111,22 +111,36 @@ class LogStore {
return this.warningIndex[spanId] ?? []
}

toLogList(): Proto.webviewLogList {
toLogList(maxSize: number | null | undefined): Proto.webviewLogList {
let spans = {} as { [key: string]: Proto.webviewLogSpan }
for (let key in this.spans) {
spans[key] = { manifestName: this.spans[key].manifestName }
}

let segments = this.segments.map(
(segment): Proto.webviewLogSegment => {
let spanId = segment.spanId
let time = segment.time
let text = segment.text
let level = segment.level
let fields = segment.fields
return { spanId, time, text, level, fields }
let size = 0
const segments = [] as Proto.webviewLogSegment[]
for (let i = this.segments.length - 1; i >= 0; i--) {
let segment = this.segments[i]
size += segment.text?.length || 0
if (maxSize && size > maxSize) {
break
}
)

let spanId = segment.spanId
if (spanId && !spans[spanId]) {
spans[spanId] = { manifestName: this.spans[spanId].manifestName }
}

segments.push({
spanId: spanId,
time: segment.time,
text: segment.text,
level: segment.level,
fields: segment.fields,
})
}

// caller expects segments in chronological order
// (iteration here was done backwards for truncation)
segments.reverse()

return {
spans: spans,
segments: segments,
Expand Down