fix: SSR meta data for nested shared documents (#3646)
This commit is contained in:
@@ -1,111 +1,19 @@
|
||||
import fs from "fs";
|
||||
import path from "path";
|
||||
import util from "util";
|
||||
import Koa, { Context, Next } from "koa";
|
||||
import Koa from "koa";
|
||||
import Router from "koa-router";
|
||||
import send from "koa-send";
|
||||
import serve from "koa-static";
|
||||
import { escape } from "lodash";
|
||||
import isUUID from "validator/lib/isUUID";
|
||||
import { languages } from "@shared/i18n";
|
||||
import env from "@server/env";
|
||||
import { NotFoundError } from "@server/errors";
|
||||
import Share from "@server/models/Share";
|
||||
import { opensearchResponse } from "@server/utils/opensearch";
|
||||
import prefetchTags from "@server/utils/prefetchTags";
|
||||
import { robotsResponse } from "@server/utils/robots";
|
||||
import apexRedirect from "../middlewares/apexRedirect";
|
||||
import presentEnv from "../presenters/env";
|
||||
import { renderApp, renderShare } from "./app";
|
||||
|
||||
const isProduction = env.ENVIRONMENT === "production";
|
||||
const isTest = env.ENVIRONMENT === "test";
|
||||
const koa = new Koa();
|
||||
const router = new Router();
|
||||
const readFile = util.promisify(fs.readFile);
|
||||
|
||||
const readIndexFile = async (ctx: Context): Promise<Buffer> => {
|
||||
if (isProduction) {
|
||||
return readFile(path.join(__dirname, "../../app/index.html"));
|
||||
}
|
||||
|
||||
if (isTest) {
|
||||
return readFile(path.join(__dirname, "../static/index.html"));
|
||||
}
|
||||
|
||||
const middleware = ctx.devMiddleware;
|
||||
await new Promise((resolve) => middleware.waitUntilValid(resolve));
|
||||
return new Promise((resolve, reject) => {
|
||||
middleware.fileSystem.readFile(
|
||||
`${ctx.webpackConfig.output.path}/index.html`,
|
||||
(err: Error, result: Buffer) => {
|
||||
if (err) {
|
||||
return reject(err);
|
||||
}
|
||||
|
||||
resolve(result);
|
||||
}
|
||||
);
|
||||
});
|
||||
};
|
||||
|
||||
const renderApp = async (
|
||||
ctx: Context,
|
||||
next: Next,
|
||||
options: { title?: string; description?: string; canonical?: string } = {}
|
||||
) => {
|
||||
const {
|
||||
title = "Outline",
|
||||
description = "A modern team knowledge base for your internal documentation, product specs, support answers, meeting notes, onboarding, & more…",
|
||||
canonical = "",
|
||||
} = options;
|
||||
|
||||
if (ctx.request.path === "/realtime/") {
|
||||
return next();
|
||||
}
|
||||
|
||||
const { shareId } = ctx.params;
|
||||
const page = await readIndexFile(ctx);
|
||||
const environment = `
|
||||
window.env = ${JSON.stringify(presentEnv(env))};
|
||||
`;
|
||||
ctx.body = page
|
||||
.toString()
|
||||
.replace(/\/\/inject-env\/\//g, environment)
|
||||
.replace(/\/\/inject-title\/\//g, escape(title))
|
||||
.replace(/\/\/inject-description\/\//g, escape(description))
|
||||
.replace(/\/\/inject-canonical\/\//g, canonical)
|
||||
.replace(/\/\/inject-prefetch\/\//g, shareId ? "" : prefetchTags)
|
||||
.replace(/\/\/inject-slack-app-id\/\//g, env.SLACK_APP_ID || "");
|
||||
};
|
||||
|
||||
const renderShare = async (ctx: Context, next: Next) => {
|
||||
const { shareId } = ctx.params;
|
||||
// Find the share record if publicly published so that the document title
|
||||
// can be be returned in the server-rendered HTML. This allows it to appear in
|
||||
// unfurls with more reliablity
|
||||
let share;
|
||||
|
||||
if (isUUID(shareId)) {
|
||||
share = await Share.findOne({
|
||||
where: {
|
||||
id: shareId,
|
||||
published: true,
|
||||
},
|
||||
});
|
||||
}
|
||||
|
||||
// Allow shares to be embedded in iframes on other websites
|
||||
ctx.remove("X-Frame-Options");
|
||||
|
||||
// Inject share information in SSR HTML
|
||||
return renderApp(ctx, next, {
|
||||
title: share?.document?.title,
|
||||
description: share?.document?.getSummary(),
|
||||
canonical: share?.team
|
||||
? ctx.request.href.replace(ctx.request.origin, share.team.url)
|
||||
: undefined,
|
||||
});
|
||||
};
|
||||
|
||||
// serve static assets
|
||||
koa.use(
|
||||
@@ -174,7 +82,7 @@ router.get("/opensearch.xml", (ctx) => {
|
||||
});
|
||||
|
||||
router.get("/share/:shareId", renderShare);
|
||||
|
||||
router.get("/share/:shareId/doc/:documentSlug", renderShare);
|
||||
router.get("/share/:shareId/*", renderShare);
|
||||
|
||||
// catch all for application
|
||||
|
||||
Reference in New Issue
Block a user