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
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
use std::{fs, net::Shutdown, path::PathBuf, sync::Arc};

use http::Uri;
use serde::Serialize;
use tokio::{
    io::{AsyncReadExt, AsyncWriteExt},
    net::TcpStream,
};
use uuid::Uuid;

use crate::{
    error::{InitializationError, RenderingError},
    worker::{Port, Worker},
};

/// Enum that instructs which JS renderer to use when [`ssr.render`](Ssr::render) gets called.
pub enum JsRenderer {
    /// Global JS renderer that was passed to [`Ssr::new`](Ssr::new) during initialization via
    /// [`SsrConfig`](SsrConfig::global_js_renderer).
    Global,
    /// JS renderer specific to the current request.
    PerRequest {
        /// A path to JS renderer
        path: PathBuf,
    },
}

/// A global configuration for [`Ssr`](Ssr) instance.
pub struct SsrConfig {
    /// A port that Node.js worker will be listening on.
    pub port: u16,
    /// Path to Node.js worker installed from `npm`. It should be relative to the
    /// [`std::env::current_dir`](std::env::current_dir).
    pub js_worker: PathBuf,
    /// If your web app is a SPA (Single Page Application), then you should have a single entry
    /// point for all rendering requests. If it's the case, provide a path to this file here and it
    /// will be used by the worker to render all responses. Another option is to provide a JS
    /// renderer per request but keep in mind that it would introduce additional runtime overhead
    /// since JS module has to be required during a request as opposed to requiring it once on
    /// application startup.
    pub global_js_renderer: Option<PathBuf>,
}

/// The main struct of the crate that manages Node.js process and handles rendering.
#[derive(Clone)]
pub struct Ssr {
    worker: Arc<Worker>,
    js_worker: PathBuf,
    global_js_renderer: Option<PathBuf>,
}

impl Ssr {
    /// Creates an [`Ssr`](Ssr) instance.
    ///
    /// # Example
    ///
    /// ```rust
    /// let ssr =
    ///   Ssr::new(
    ///     SsrConfig {
    ///       port: 9000,
    ///       js_worker: PathBuf::from("./node_modules/ssr-rs/worker.js"),
    ///       global_js_renderer: Some(PathBuf::from("./js/ssr.js")),
    ///     }
    ///   );
    /// ```
    pub async fn new(cfg: SsrConfig) -> Result<Self, InitializationError> {
        let port = Port::new(cfg.port);
        let js_worker = match fs::canonicalize(cfg.js_worker) {
            Ok(path) => path,
            Err(err) => return Err(InitializationError::InvalidJsWorkerPath(err)),
        };
        let global_js_renderer = match cfg.global_js_renderer {
            Some(path) => match fs::canonicalize(path) {
                Ok(path) => Some(path),
                Err(err) => return Err(InitializationError::InvalidGlobalJsRendererPath(err)),
            },
            None => None,
        };
        let worker = Worker::new(&port, &js_worker, &global_js_renderer).await?;
        Ok(Self {
            worker: Arc::new(worker),
            js_worker,
            global_js_renderer,
        })
    }

    /// Renders a response to an incoming request using Node.js worker.
    ///
    /// # Example
    ///
    /// ```rust
    /// let uri = req.uri();
    /// let data = db::get_data();
    /// match ssr.render(uri, &data, JsRenderer::Global).await {
    ///     Ok(html) => HttpResponse::Ok().body(html),
    ///     Err(error) => {
    ///         error!("Error: {}", error);
    ///         HttpResponse::InternalServerError().finish()
    ///     }
    /// }
    pub async fn render<D: Serialize>(
        &self,
        uri: &Uri,
        data: &D,
        js_renderer: JsRenderer,
    ) -> Result<String, RenderingError> {
        let request_id = Uuid::new_v4();

        trace!("Starting request {}", request_id);

        let worker = &self.worker;

        let mut stream = match worker.connect().await {
            Ok(stream) => stream,
            Err(err) => {
                error!(
                    "{worker}: Failed to connect: {err}",
                    worker = worker.display_with_request_id(&request_id),
                    err = err
                );
                return Err(RenderingError::ConnectionError(err));
            }
        };

        let url = match uri.path_and_query() {
            Some(url) => url,
            None => {
                Self::finalize_rendering_session(&worker, &stream, &request_id);
                return Err(RenderingError::InvalidUri);
            }
        };

        let request_renderer = match (&self.global_js_renderer, js_renderer) {
            (Some(_), JsRenderer::Global) => None,
            (_, JsRenderer::PerRequest { path }) => Some(path),
            (None, JsRenderer::Global) => {
                Self::finalize_rendering_session(&worker, &stream, &request_id);
                return Err(RenderingError::GlobalRendererNotProvided);
            }
        };

        let meta = json!({
          "requestId": request_id,
          "requestRenderer": request_renderer,
          "url": json!({"path": url.path(), "query": url.query()}),
        });
        let meta_bytes = match serde_json::to_vec(&meta) {
            Ok(bytes) => bytes,
            Err(err) => {
                Self::finalize_rendering_session(&worker, &stream, &request_id);
                return Err(RenderingError::UrlSerializationError(err));
            }
        };
        let data = match serde_json::to_string(&data) {
            Ok(data) => data,
            Err(err) => {
                Self::finalize_rendering_session(&worker, &stream, &request_id);
                return Err(RenderingError::DataSerializationError(err));
            }
        };
        let data_bytes = match crate::json::to_vec(&data) {
            Ok(bytes) => bytes,
            Err(err) => {
                Self::finalize_rendering_session(&worker, &stream, &request_id);
                return Err(RenderingError::DataSerializationError(err));
            }
        };
        let meta_len = meta_bytes.len() as u32;
        let data_len = data_bytes.len() as u32;
        let meta_len_bytes = meta_len.to_be_bytes();
        let data_len_bytes = data_len.to_be_bytes();
        let mut input = meta_len_bytes.to_vec();
        input.extend_from_slice(&data_len_bytes);
        input.extend(meta_bytes);
        input.extend(data_bytes);

        let mut res = String::new();

        trace!(
            "{worker}: Writing input to socket",
            worker = worker.display_with_request_id(&request_id),
        );

        if let Err(err) = stream.write_all(input.as_slice()).await {
            Self::finalize_rendering_session(&worker, &stream, &request_id);
            return Err(RenderingError::RenderRequestError(err));
        };

        trace!(
            "{worker}: Input written to socket",
            worker = worker.display_with_request_id(&request_id),
        );

        if let Err(err) = stream.read_to_string(&mut res).await {
            Self::finalize_rendering_session(&worker, &stream, &request_id);
            return Err(RenderingError::RenderResponseError(err));
        };

        trace!(
            "{worker}: Output written to result buffer",
            worker = worker.display_with_request_id(&request_id),
        );

        // No need to shutdown connection as it's already closed by the js worker
        if res.starts_with("ERROR:") {
            trace!(
                "{worker}: Output is an error",
                worker = worker.display_with_request_id(&request_id),
            );
            match res.splitn(2, ':').collect::<Vec<_>>().as_slice() {
                ["ERROR", stack] => Err(RenderingError::JsExceptionDuringRendering(
                    stack.to_string(),
                )),
                _ => unreachable!(),
            }
        } else {
            trace!(
                "{worker}: Output is ok",
                worker = worker.display_with_request_id(&request_id),
            );
            Self::finalize_rendering_session(&worker, &stream, &request_id);
            Ok(res)
        }
    }

    fn finalize_rendering_session(worker: &Worker, connection: &TcpStream, request_id: &Uuid) {
        if let Err(err) = connection.shutdown(Shutdown::Both) {
            warn!(
                "{worker}: Failed to shutdown connection to the js worker: {err}",
                worker = worker.display_with_request_id(&request_id),
                err = err
            );
        };
    }
}