aboutsummaryrefslogtreecommitdiffstats
path: root/container-search/src/main/java/com/yahoo/search/rendering/EventRenderer.java
blob: 88a1e6c1485e1875ce3499d30b92b681f6264a56 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
// Copyright Vespa.ai. Licensed under the terms of the Apache 2.0 license. See LICENSE in the project root.
package com.yahoo.search.rendering;

import com.yahoo.search.result.EventStream;
import com.fasterxml.jackson.core.JsonEncoding;
import com.fasterxml.jackson.core.JsonFactory;
import com.fasterxml.jackson.core.JsonFactoryBuilder;
import com.fasterxml.jackson.core.JsonGenerator;
import com.fasterxml.jackson.core.StreamReadConstraints;
import com.fasterxml.jackson.core.io.SerializedString;
import com.fasterxml.jackson.databind.ObjectMapper;
import com.yahoo.processing.rendering.AsynchronousSectionedRenderer;
import com.yahoo.processing.response.Data;
import com.yahoo.processing.response.DataList;
import com.yahoo.search.Result;
import com.yahoo.search.result.ErrorHit;
import com.yahoo.search.result.ErrorMessage;

import java.io.IOException;
import java.io.OutputStream;
import java.util.concurrent.Executor;

import static com.fasterxml.jackson.databind.SerializationFeature.FLUSH_AFTER_WRITE_VALUE;

/**
 * A Server-Sent Events (SSE) renderer for asynchronous events such as
 * tokens from a language model.
 *
 * @author lesters
 */
public class EventRenderer extends AsynchronousSectionedRenderer<Result> {

    private static final JsonFactory generatorFactory = createGeneratorFactory();
    private volatile JsonGenerator generator;

    private static JsonFactory createGeneratorFactory() {
        var factory = new JsonFactoryBuilder()
                .streamReadConstraints(StreamReadConstraints.builder().maxStringLength(Integer.MAX_VALUE).build())
                .build();
        factory.setCodec(new ObjectMapper(factory).disable(FLUSH_AFTER_WRITE_VALUE));
        return factory;
    }

    private static final boolean RENDER_EVENT_HEADER = true;
    private static final boolean RENDER_END_EVENT = true;

    public EventRenderer() {
        this(null);
    }

    public EventRenderer(Executor executor) {
        super(executor);
    }

    @Override
    public void beginResponse(OutputStream outputStream) throws IOException {
        generator = generatorFactory.createGenerator(outputStream, JsonEncoding.UTF8);
        generator.setRootValueSeparator(new SerializedString(""));
    }

    @Override
    public void beginList(DataList<?> dataList) throws IOException {
    }

    @Override
    public void data(Data data) throws IOException {
        if (data instanceof EventStream.ErrorEvent error) {
            generator.writeRaw("event: error\n");
            generator.writeRaw("data: ");
            generator.writeStartObject();
            generator.writeStringField("source", error.source());
            generator.writeNumberField("error", error.code());
            generator.writeStringField("message", error.message());
            generator.writeEndObject();
            generator.writeRaw("\n\n");
            generator.flush();
        } else if (data instanceof EventStream.Event event) {
            if (RENDER_EVENT_HEADER) {
                generator.writeRaw("event: " + event.type() + "\n");
            }
            generator.writeRaw("data: ");
            generator.writeStartObject();
            generator.writeStringField(event.type(), event.toString());
            generator.writeEndObject();
            generator.writeRaw("\n\n");
            generator.flush();
        }
        // Todo: support other types of data such as search results (hits), timing and trace
    }

    @Override
    public void endList(DataList<?> dataList) throws IOException {
    }

    @Override
    public void endResponse() throws IOException {
        if (RENDER_END_EVENT) {
            generator.writeRaw("event: end\n");
        }
        generator.close();
    }

    @Override
    public String getEncoding() {
        return "utf-8";
    }

    @Override
    public String getMimeType() {
        return "text/event-stream";
    }

}