Repository navigation
Expand file tree
/
Copy pathmod.ts
More file actions
565 lines (521 loc) · 14.1 KB
/
Copy pathmod.ts
File metadata and controls
565 lines (521 loc) · 14.1 KB
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
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
import { calculate, extract, log, parse, render, test } from "./deps.ts";
type DocMeta = {
etag: string;
timestamp: number;
body: string;
};
export type SnippetType = {
mdName?: string;
title?: string;
date?: Date;
dateStamp?: string;
teaser?: string;
};
type GenericSnippetFunc = <T extends SnippetType>(args: T) => string;
type Markdown = {
mdName: string;
mdContent: string;
};
type Frontmatter = {
mdName: string;
frontmatter: Record<string, unknown>;
};
export type ExternalLinksType = string[];
type TemplateType = (
html: string,
stylesheetlinks?: ExternalLinksType,
css?: string,
scripttaglinkslinks?: ExternalLinksType,
) => string;
type ServeZettelkastenType = {
conn: Deno.Conn;
template?: TemplateType;
snippet?: GenericSnippetFunc;
stylesheetlinks?: ExternalLinksType;
css?: string;
zettelResource: string;
keyValueStore: string;
ttl: number;
scripttaglinks?: ExternalLinksType;
};
type HomeHandlerType = {
template: TemplateType;
snippet: GenericSnippetFunc;
stylesheetlinks: ExternalLinksType;
css: string;
resource: string;
scripttaglinks?: ExternalLinksType;
};
type PathHandlerType = HomeHandlerType & {
pathname: string;
};
export const simpleTemplate = <TemplateType>(
body = "",
stylesheetlinks: ExternalLinksType = [],
css = "",
scripttaglinks: ExternalLinksType = [],
) => {
const stylesheets = stylesheetlinks.length > 0
? stylesheetlinks.map(
(styl) => `<link rel="stylesheet" href="${styl}" />`,
)
: "";
const scripttags = scripttaglinks.length > 0
? scripttaglinks.map(
(script) => `<script type="module" src="${script}"></script>`,
)
: "";
return `<!doctype html>
<html lang=en>
<head>
<meta charset=utf-8>
<title>Zettelkasten</title>
${stylesheets}
<style>
main {
max-width: 800px;
margin: 0 auto;
}
${css}
</style>
${scripttags}
</head>
<body>
<main data-color-mode="light" data-light-theme="light" data-dark-theme="dark" class="markdown-body">
${body}
</main>
</body>
</html>
`;
};
export const simpleSnippet = ({
mdName = "missing name",
title = "missing title",
date = new Date(),
dateStamp = "",
teaser = "missing teaser",
}: SnippetType) =>
`<section>
<h2><a href="/${mdName}">${title}</a></h2>
<time datetime="${date.toUTCString()}">${dateStamp}</time>
<span>${teaser}</span>
<span> - </span><time datetime="${date.toUTCString()}">${date.getFullYear()}/${date.getMonth()}/${date.getDay()}</time>
</section>`;
export async function validateDocs(
documentResponses: Response[],
documentList: string[],
) {
const validDocs = [];
for (const [i, doc] of documentResponses.entries()) {
const fileName = documentList[i];
try {
checkStatusCode(doc?.status, fileName);
} catch (_err) {
log.error(`HTTP status code ${doc?.status} for file ${fileName}`);
// Error with document, skip to next in loop
continue;
}
// Shave of ".md" file ending from file name
const mdName = fileName.split(".").slice(0, -1).join(".");
validDocs.push({ mdName, mdContent: await doc.text() });
}
return validDocs;
}
export function teaserifyDocs(documents: Markdown[]) {
const teasers: Frontmatter[] = [];
for (const doc of documents) {
if (!(typeof doc?.mdContent === "string")) continue;
if (!test(doc?.mdContent)) continue;
let teaser;
try {
teaser = generateDocument(doc);
} catch (err) {
log.error(`${err.message} while generating article.`);
continue;
}
teasers.push(teaser);
}
return teasers;
}
const checkResponse = (response: Response, resource: string) => {
// check if status code is 200
if (!response) {
throw new Error(`${resource} response is undefined`);
}
if (response.status === 502) {
throw new Error("Status code 502, Bad Gateway", {
cause: `${response.url} does not exist`,
});
}
if (response.status === 404) {
throw new Error(`Status code 404 for ${resource}`, {
cause: `${response.url} does not exist`,
});
}
if (response.status !== 200) {
throw new Error("Status code NOT 200 OK", {
cause: `${response.url} does not exist`,
});
}
};
const checkStatusCode = (statusCode: number | undefined, resource: string) => {
// check if status code is 200
if (statusCode !== 200) {
throw new Error(
`${resource} HTTP status code '${statusCode}' does not equal '200'`,
);
}
};
const checkContentType = (
contentType: string | null | undefined,
resource: string,
) => {
// check if content-type is not 'text/html', because we expect yaml or markdown
if (contentType === "text/html") {
throw new Error(
`${resource} HTTP content-type '${contentType}' is invalid`,
);
}
};
const handleNetworkError = () => {
return new Response("Bad Gateway: Network error while fetching...", {
status: 502,
});
};
const fetchArticles = async (fileName: string, resource: string) =>
await fetch(`${resource}${fileName}`).catch(handleNetworkError);
export const generateDocument = ({ mdName, mdContent }: Markdown) => {
const { attrs: frontmatter, body: markdown } = extract(mdContent);
if (!frontmatter) {
log.error("document doesn't contain front matter");
}
return {
mdName,
frontmatter,
markdown,
};
};
export function markupify(
{ mdName, frontmatter }: Frontmatter,
snippet: GenericSnippetFunc,
) {
const { title, date, teaser } = frontmatter as SnippetType;
const dateObj = date as Date;
const dateStamp = dateObj.toLocaleString("de-de").split(",")[0];
return snippet({
title,
date,
teaser,
mdName,
dateStamp,
});
}
async function homeHandler({
template,
snippet,
stylesheetlinks,
css,
resource,
scripttaglinks,
}: HomeHandlerType) {
const sitemapResource = "sitemap.yaml";
const sitemapResponse = await fetch(`${resource}${sitemapResource}`).catch(
handleNetworkError,
);
checkResponse(sitemapResponse, sitemapResource);
checkStatusCode(sitemapResponse?.status, sitemapResource);
checkContentType(
sitemapResponse?.headers?.get("Content-Type"),
sitemapResource,
);
const sitemapbody = await sitemapResponse?.text();
const parsedYamlDocList = parse(sitemapbody) as string[];
const docs = await Promise.all(
parsedYamlDocList.map((docname) => fetchArticles(docname, resource)),
);
const validDocs = await validateDocs(docs, parsedYamlDocList);
const teasers = await teaserifyDocs(validDocs);
const allSnippets = teasers.map((teaser) => markupify(teaser, snippet));
const body = template(
allSnippets?.join(""),
stylesheetlinks,
css,
scripttaglinks,
);
// back to the client.
const headers = new Headers({
"content-type": "text/html",
});
return { body, headers, status: 200 };
}
export async function pathHandler({
pathname,
template,
snippet,
stylesheetlinks,
css,
resource,
scripttaglinks,
}: PathHandlerType) {
log.info(`PATHNAME: ${pathname}`);
const mdName = pathname.substring(1);
const markdownDocResponse = await fetch(`${resource}${mdName}.md`).catch(
handleNetworkError,
);
checkStatusCode(markdownDocResponse?.status, mdName);
const mdContent = await markdownDocResponse.text();
test(mdContent);
const mdDoc = {
mdName,
mdContent,
};
const document = generateDocument(mdDoc);
const markup = markupify(document, snippet) +
render(document.markdown, {
mediaBaseUrl: resource,
});
const body = template(
markup?.toString(),
stylesheetlinks,
css,
scripttaglinks,
);
const headers = new Headers({
"content-type": "text/html",
});
return { body, headers, status: 200 };
}
async function reply(
ifNoneMatch: string | null,
pathname: string,
kv: Deno.Kv | undefined,
{
body,
headers,
status,
}: {
body: string;
headers: Headers;
status: number;
},
) {
const bodyEtag = await calculate(body);
if (kv) {
log.info("Will cache in KV");
kv.set([pathname], {
etag: `W/${bodyEtag}`,
timestamp: Number(new Date().getTime()),
body,
});
}
if (`W/${bodyEtag}` === ifNoneMatch) {
return new Response(null, {
headers: headers,
status: 304,
});
}
bodyEtag && headers.append("etag", bodyEtag);
return new Response(body, {
headers: headers,
status,
});
}
const smash = {
badImplementation(err: Error) {
log.error(`SMASH("Bad Implementation"): ${err}`);
return {
body: "HIDE ME: Bad Implementation",
headers: new Headers({
"content-type": "text/html",
}),
status: 500,
};
},
notImplemented(err: Error) {
log.error(`SMASH("Not Implemented"): ${err}`);
return {
body: "HIDE ME: Not Implemented",
headers: new Headers({
"content-type": "text/html",
}),
status: 501,
};
},
badGateway(err: Error) {
log.error(`SMASH("Bad Gateway"): ${err}`);
return {
body: "Bad Gateway",
headers: new Headers({
"content-type": "text/html",
}),
status: 502,
};
},
serverUnavailable(err: Error) {
log.error(`SMASH("Server Unavailable"): ${err}`);
return {
body: "Server Unavailable",
headers: new Headers({
"content-type": "text/html",
}),
status: 503,
};
},
gatewayTimeout(err: Error) {
log.error(`SMASH("Gateway Timeout"): ${err}`);
return {
body: "Gateway Timeout",
headers: new Headers({
"content-type": "text/html",
}),
status: 504,
};
},
};
const handleErrorResponse = (err: Error) => {
const { name, message, cause } = err;
// TODO: remove
log.error(`ERROR - caught this error: ${err}`);
log.error(`ERROR - error name: ${name}`);
log.error(`ERROR - error msg: ${message}`);
log.error(`ERROR - error cause: ${cause}`);
log.error(`ERROR - error all: ${err}`);
switch (true) {
// TODO: remove
case err.cause === "Felt sick":
return smash.badGateway(err);
case err.message === "Status code 404":
return smash.gatewayTimeout(err);
case err.message === "Status code 404 for sitemap.yaml":
return smash.gatewayTimeout(err);
case err.message === "parsedYaml.map is not a function":
return smash.badImplementation(err);
case err.name === "YAMLError":
return smash.badGateway(err);
case err.message === "parsedYamlDocList.map is not a function":
return smash.badGateway(err);
case err.message === "Unexpected end of input":
return smash.badImplementation(err);
case err.message === "Unsupported front matter format":
return smash.badImplementation(err);
case err.message === "Unable to test for unknown front matter format":
return smash.badImplementation(err);
default:
return smash.badImplementation(err);
}
};
export async function serveZettelkasten({
conn,
template = simpleTemplate,
snippet = simpleSnippet,
stylesheetlinks = [],
css = "",
zettelResource,
keyValueStore = "DISABLE",
ttl,
scripttaglinks = [],
}: ServeZettelkastenType) {
// TODO: Throw error if zettelResource is undefined
// This "upgrades" a network connection into an HTTP connection.
const httpConn = Deno.serveHttp(conn);
// Each request sent over the HTTP connection will be yielded as an async
// iterator from the HTTP connection.
// Needed until Deno KV is not longer considered experimental and behind --unstable flag
let kv: Deno.Kv | undefined;
const kvIsEnabled = keyValueStore === "ENABLE";
if (kvIsEnabled) {
kv = await Deno.openKv();
}
for await (const { request, respondWith } of httpConn) {
const { pathname } = new URL(request.url);
const ifNoneMatch = request.headers.get("if-none-match");
if (kvIsEnabled && kv && ttl) {
const { value } = await kv.get<DocMeta>([pathname]);
if (value) {
const { timestamp, etag, body } = value;
const isKVCacheHit = timestamp + ttl > Number(new Date().getTime());
if (ifNoneMatch === etag && isKVCacheHit) {
log.info("Hit Etag in KV");
respondWith(
new Response(null, {
headers: new Headers({}),
status: 304,
}),
);
continue;
}
if (isKVCacheHit) {
log.info("Hit body in KV");
respondWith(
new Response(body, {
headers: new Headers({
"content-type": "text/html",
"etag": etag,
}),
status: 200,
}),
);
continue;
}
}
}
if (pathname === "/") {
log.info("Home route '/' was called");
respondWith(
reply(
ifNoneMatch,
pathname,
kv,
await homeHandler({
template,
snippet,
stylesheetlinks,
css,
resource: zettelResource,
scripttaglinks,
}).catch(handleErrorResponse),
),
).catch((err) => {
// TODO: How to handle this error?
log.critical(`Refreshed too fast...🏎️ : ${err}`);
});
}
if (pathname === "/favicon.ico") {
log.info("Favicon route '/favicon.ico' was called");
// TODO: Deliver favicon
respondWith(
reply(ifNoneMatch, pathname, kv, {
body: "404",
headers: new Headers({
"content-type": "text/html",
}),
status: 404,
}),
).catch((err) => {
log.critical(`Refreshed favicon too fast...🏎️ : ${err}`);
});
}
if (pathname !== "/" && pathname !== "/favicon.ico") {
log.info(`Path route '${pathname}' was called`);
respondWith(
reply(
ifNoneMatch,
pathname,
kv,
await pathHandler({
pathname,
template,
snippet,
stylesheetlinks,
css,
resource: zettelResource,
scripttaglinks,
}).catch(handleErrorResponse),
),
).catch((err) => {
// TODO: How to handle this error?
log.critical(`Refreshed too fast, too furious...🏎️ 🚙 : ${err}`);
});
}
}
}