@milaboratories/pframes-rs-serv 1.0.61 → 1.0.63
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/export.cjs +20 -0
- package/dist/export.cjs.map +1 -0
- package/dist/export.d.ts +3 -0
- package/dist/export.d.ts.map +1 -0
- package/dist/export.js +18 -0
- package/dist/export.js.map +1 -0
- package/dist/fs-store.cjs +81 -0
- package/dist/fs-store.cjs.map +1 -0
- package/dist/fs-store.d.ts +14 -0
- package/dist/fs-store.d.ts.map +1 -0
- package/dist/fs-store.js +79 -0
- package/dist/fs-store.js.map +1 -0
- package/dist/handler.cjs +157 -0
- package/dist/handler.cjs.map +1 -0
- package/dist/handler.d.ts +15 -0
- package/dist/handler.d.ts.map +1 -0
- package/dist/handler.js +154 -0
- package/dist/handler.js.map +1 -0
- package/dist/index.cjs +17 -0
- package/dist/index.cjs.map +1 -0
- package/dist/index.d.ts +6 -0
- package/dist/index.d.ts.map +1 -0
- package/dist/index.js +6 -0
- package/dist/index.js.map +1 -0
- package/dist/parquet-server.cjs +53 -0
- package/dist/parquet-server.cjs.map +1 -0
- package/dist/parquet-server.d.ts +6 -0
- package/dist/parquet-server.d.ts.map +1 -0
- package/dist/parquet-server.js +51 -0
- package/dist/parquet-server.js.map +1 -0
- package/dist/serve.cjs +120 -0
- package/dist/serve.cjs.map +1 -0
- package/dist/serve.d.ts +7 -0
- package/dist/serve.d.ts.map +1 -0
- package/dist/serve.js +118 -0
- package/dist/serve.js.map +1 -0
- package/dist/utils/etag.cjs +10 -0
- package/dist/utils/etag.cjs.map +1 -0
- package/dist/utils/etag.d.ts +15 -0
- package/dist/utils/etag.d.ts.map +1 -0
- package/dist/utils/etag.js +8 -0
- package/dist/utils/etag.js.map +1 -0
- package/dist/utils/filename.cjs +15 -0
- package/dist/utils/filename.cjs.map +1 -0
- package/dist/utils/filename.d.ts +4 -0
- package/dist/utils/filename.d.ts.map +1 -0
- package/dist/utils/filename.js +13 -0
- package/dist/utils/filename.js.map +1 -0
- package/dist/utils/headers.cjs +26 -0
- package/dist/utils/headers.cjs.map +1 -0
- package/dist/utils/headers.d.ts +29 -0
- package/dist/utils/headers.d.ts.map +1 -0
- package/dist/utils/headers.js +23 -0
- package/dist/utils/headers.js.map +1 -0
- package/dist/utils/index.d.ts +8 -0
- package/dist/utils/index.d.ts.map +1 -0
- package/dist/utils/method.cjs +16 -0
- package/dist/utils/method.cjs.map +1 -0
- package/dist/utils/method.d.ts +6 -0
- package/dist/utils/method.d.ts.map +1 -0
- package/dist/utils/method.js +12 -0
- package/dist/utils/method.js.map +1 -0
- package/dist/utils/options.cjs +135 -0
- package/dist/utils/options.cjs.map +1 -0
- package/dist/utils/options.d.ts +64 -0
- package/dist/utils/options.d.ts.map +1 -0
- package/dist/utils/options.js +133 -0
- package/dist/utils/options.js.map +1 -0
- package/dist/utils/range.cjs +34 -0
- package/dist/utils/range.cjs.map +1 -0
- package/dist/utils/range.d.ts +4 -0
- package/dist/utils/range.d.ts.map +1 -0
- package/dist/utils/range.js +32 -0
- package/dist/utils/range.js.map +1 -0
- package/dist/utils/status.cjs +20 -0
- package/dist/utils/status.cjs.map +1 -0
- package/dist/utils/status.d.ts +16 -0
- package/dist/utils/status.d.ts.map +1 -0
- package/dist/utils/status.js +18 -0
- package/dist/utils/status.js.map +1 -0
- package/package.json +1 -1
package/dist/export.cjs
ADDED
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
'use strict';
|
|
2
|
+
|
|
3
|
+
var fsStore = require('./fs-store.cjs');
|
|
4
|
+
var handler = require('./handler.cjs');
|
|
5
|
+
var serve = require('./serve.cjs');
|
|
6
|
+
|
|
7
|
+
const HttpHelpers = {
|
|
8
|
+
createFsStore: async (options) => {
|
|
9
|
+
return await fsStore.FileSystemStore.init(options);
|
|
10
|
+
},
|
|
11
|
+
createRequestHandler: (options) => {
|
|
12
|
+
return handler.createRequestHandler(options);
|
|
13
|
+
},
|
|
14
|
+
createHttpServer: async (options) => {
|
|
15
|
+
return await serve.serve(options);
|
|
16
|
+
}
|
|
17
|
+
};
|
|
18
|
+
|
|
19
|
+
exports.HttpHelpers = HttpHelpers;
|
|
20
|
+
//# sourceMappingURL=export.cjs.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"export.cjs","sources":["../src/export.ts"],"sourcesContent":["import { RequestListener } from 'http';\nimport { FileSystemStore } from './fs-store';\nimport { createRequestHandler } from './handler';\nimport { serve } from './serve';\nimport { PFrameInternal } from '@milaboratories/pl-model-middle-layer';\n\nexport const HttpHelpers: PFrameInternal.HttpHelpers = {\n createFsStore: async (\n options: PFrameInternal.FsStoreOptions\n ): Promise<PFrameInternal.ObjectStore> => {\n return await FileSystemStore.init(options);\n },\n createRequestHandler: (\n options: PFrameInternal.RequestHandlerOptions\n ): RequestListener => {\n return createRequestHandler(options);\n },\n createHttpServer: async (\n options: PFrameInternal.HttpServerOptions\n ): Promise<PFrameInternal.HttpServer> => {\n return await serve(options);\n }\n};\n"],"names":["FileSystemStore","createRequestHandler","serve"],"mappings":";;;;;;AAMO,MAAM,WAAW,GAA+B;AACrD,IAAA,aAAa,EAAE,OACb,OAAsC,KACC;AACvC,QAAA,OAAO,MAAMA,uBAAe,CAAC,IAAI,CAAC,OAAO,CAAC;IAC5C,CAAC;AACD,IAAA,oBAAoB,EAAE,CACpB,OAA6C,KAC1B;AACnB,QAAA,OAAOC,4BAAoB,CAAC,OAAO,CAAC;IACtC,CAAC;AACD,IAAA,gBAAgB,EAAE,OAChB,OAAyC,KACH;AACtC,QAAA,OAAO,MAAMC,WAAK,CAAC,OAAO,CAAC;IAC7B;;;;;"}
|
package/dist/export.d.ts
ADDED
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"export.d.ts","sourceRoot":"","sources":["../src/export.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,cAAc,EAAE,MAAM,uCAAuC,CAAC;AAEvE,eAAO,MAAM,WAAW,EAAE,cAAc,CAAC,WAgBxC,CAAC"}
|
package/dist/export.js
ADDED
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
import { FileSystemStore } from './fs-store.js';
|
|
2
|
+
import { createRequestHandler } from './handler.js';
|
|
3
|
+
import { serve } from './serve.js';
|
|
4
|
+
|
|
5
|
+
const HttpHelpers = {
|
|
6
|
+
createFsStore: async (options) => {
|
|
7
|
+
return await FileSystemStore.init(options);
|
|
8
|
+
},
|
|
9
|
+
createRequestHandler: (options) => {
|
|
10
|
+
return createRequestHandler(options);
|
|
11
|
+
},
|
|
12
|
+
createHttpServer: async (options) => {
|
|
13
|
+
return await serve(options);
|
|
14
|
+
}
|
|
15
|
+
};
|
|
16
|
+
|
|
17
|
+
export { HttpHelpers };
|
|
18
|
+
//# sourceMappingURL=export.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"export.js","sources":["../src/export.ts"],"sourcesContent":["import { RequestListener } from 'http';\nimport { FileSystemStore } from './fs-store';\nimport { createRequestHandler } from './handler';\nimport { serve } from './serve';\nimport { PFrameInternal } from '@milaboratories/pl-model-middle-layer';\n\nexport const HttpHelpers: PFrameInternal.HttpHelpers = {\n createFsStore: async (\n options: PFrameInternal.FsStoreOptions\n ): Promise<PFrameInternal.ObjectStore> => {\n return await FileSystemStore.init(options);\n },\n createRequestHandler: (\n options: PFrameInternal.RequestHandlerOptions\n ): RequestListener => {\n return createRequestHandler(options);\n },\n createHttpServer: async (\n options: PFrameInternal.HttpServerOptions\n ): Promise<PFrameInternal.HttpServer> => {\n return await serve(options);\n }\n};\n"],"names":[],"mappings":";;;;AAMO,MAAM,WAAW,GAA+B;AACrD,IAAA,aAAa,EAAE,OACb,OAAsC,KACC;AACvC,QAAA,OAAO,MAAM,eAAe,CAAC,IAAI,CAAC,OAAO,CAAC;IAC5C,CAAC;AACD,IAAA,oBAAoB,EAAE,CACpB,OAA6C,KAC1B;AACnB,QAAA,OAAO,oBAAoB,CAAC,OAAO,CAAC;IACtC,CAAC;AACD,IAAA,gBAAgB,EAAE,OAChB,OAAyC,KACH;AACtC,QAAA,OAAO,MAAM,KAAK,CAAC,OAAO,CAAC;IAC7B;;;;;"}
|
|
@@ -0,0 +1,81 @@
|
|
|
1
|
+
'use strict';
|
|
2
|
+
|
|
3
|
+
var node_fs = require('node:fs');
|
|
4
|
+
var promises = require('node:fs/promises');
|
|
5
|
+
var node_path = require('node:path');
|
|
6
|
+
var plModelMiddleLayer = require('@milaboratories/pl-model-middle-layer');
|
|
7
|
+
var plModelCommon = require('@milaboratories/pl-model-common');
|
|
8
|
+
|
|
9
|
+
/** Object store for serving files from a local directory */
|
|
10
|
+
class FileSystemStore extends plModelMiddleLayer.PFrameInternal.ObjectStore {
|
|
11
|
+
rootDir;
|
|
12
|
+
constructor(options) {
|
|
13
|
+
super(options);
|
|
14
|
+
this.rootDir = options.rootDir;
|
|
15
|
+
}
|
|
16
|
+
static async init(options) {
|
|
17
|
+
const resolvedRootDir = node_path.resolve(options.rootDir);
|
|
18
|
+
const rootStats = await promises.stat(resolvedRootDir).catch(() => {
|
|
19
|
+
throw new Error(`File system store root directory does not exist: ${resolvedRootDir}`);
|
|
20
|
+
});
|
|
21
|
+
if (!rootStats.isDirectory()) {
|
|
22
|
+
throw new Error(`File system store root path is not a directory: ${resolvedRootDir}`);
|
|
23
|
+
}
|
|
24
|
+
return new FileSystemStore({
|
|
25
|
+
...options,
|
|
26
|
+
rootDir: resolvedRootDir
|
|
27
|
+
});
|
|
28
|
+
}
|
|
29
|
+
async request(filename, params) {
|
|
30
|
+
let file;
|
|
31
|
+
try {
|
|
32
|
+
const path = node_path.join(this.rootDir, filename);
|
|
33
|
+
file = await promises.open(path, 'r');
|
|
34
|
+
}
|
|
35
|
+
catch (error) {
|
|
36
|
+
this.logger('error', `File system store failed to open file ${filename}: ${plModelCommon.ensureError(error)}`);
|
|
37
|
+
return await params.callback({ type: 'NotFound' });
|
|
38
|
+
}
|
|
39
|
+
try {
|
|
40
|
+
let size;
|
|
41
|
+
try {
|
|
42
|
+
({ size } = await file.stat());
|
|
43
|
+
}
|
|
44
|
+
catch (error) {
|
|
45
|
+
this.logger('error', `File system store failed to get size of file ${filename}: ${plModelCommon.ensureError(error)}`);
|
|
46
|
+
return await params.callback({ type: 'InternalError' });
|
|
47
|
+
}
|
|
48
|
+
const range = this.translate(size, params.range);
|
|
49
|
+
if (!range) {
|
|
50
|
+
return await params.callback({ type: 'RangeNotSatisfiable', size });
|
|
51
|
+
}
|
|
52
|
+
if (params.method === 'HEAD') {
|
|
53
|
+
return await params.callback({ type: 'Ok', size, range });
|
|
54
|
+
}
|
|
55
|
+
let data;
|
|
56
|
+
try {
|
|
57
|
+
data = node_fs.createReadStream('ignored', {
|
|
58
|
+
fd: file.fd,
|
|
59
|
+
autoClose: false,
|
|
60
|
+
start: range.start,
|
|
61
|
+
end: range.end,
|
|
62
|
+
signal: params.signal
|
|
63
|
+
});
|
|
64
|
+
this.logger('info', `File system store created read stream for ${filename}[${range.start}..=${range.end}]`);
|
|
65
|
+
}
|
|
66
|
+
catch (error) {
|
|
67
|
+
this.logger('error', `File system store failed to create read stream for ${filename}[${range.start}..=${range.end}]: ${plModelCommon.ensureError(error)}`);
|
|
68
|
+
return await params.callback({ type: 'InternalError' });
|
|
69
|
+
}
|
|
70
|
+
return await params
|
|
71
|
+
.callback({ type: 'Ok', size, range, data })
|
|
72
|
+
.catch(() => { });
|
|
73
|
+
}
|
|
74
|
+
finally {
|
|
75
|
+
await file.close();
|
|
76
|
+
}
|
|
77
|
+
}
|
|
78
|
+
}
|
|
79
|
+
|
|
80
|
+
exports.FileSystemStore = FileSystemStore;
|
|
81
|
+
//# sourceMappingURL=fs-store.cjs.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"fs-store.cjs","sources":["../src/fs-store.ts"],"sourcesContent":["import type { Readable } from 'node:stream';\nimport { createReadStream } from 'node:fs';\nimport { stat, open, type FileHandle } from 'node:fs/promises';\nimport { join, resolve } from 'node:path';\nimport { PFrameInternal } from '@milaboratories/pl-model-middle-layer';\nimport { ensureError } from '@milaboratories/pl-model-common';\n\n/** Object store for serving files from a local directory */\nexport class FileSystemStore extends PFrameInternal.ObjectStore {\n private readonly rootDir: string;\n\n private constructor(options: PFrameInternal.FsStoreOptions) {\n super(options);\n\n this.rootDir = options.rootDir;\n }\n\n static async init(\n options: PFrameInternal.FsStoreOptions\n ): Promise<FileSystemStore> {\n const resolvedRootDir = resolve(options.rootDir);\n\n const rootStats = await stat(resolvedRootDir).catch(() => {\n throw new Error(\n `File system store root directory does not exist: ${resolvedRootDir}`\n );\n });\n if (!rootStats.isDirectory()) {\n throw new Error(\n `File system store root path is not a directory: ${resolvedRootDir}`\n );\n }\n\n return new FileSystemStore({\n ...options,\n rootDir: resolvedRootDir\n });\n }\n\n override async request(\n filename: PFrameInternal.ParquetFileName,\n params: {\n method: PFrameInternal.HttpMethod;\n range?: PFrameInternal.HttpRange;\n signal: AbortSignal;\n callback: (response: PFrameInternal.ObjectStoreResponse) => Promise<void>;\n }\n ): Promise<void> {\n let file: FileHandle;\n try {\n const path = join(this.rootDir, filename);\n file = await open(path, 'r');\n } catch (error: unknown) {\n this.logger(\n 'error',\n `File system store failed to open file ${filename}: ${ensureError(error)}`\n );\n return await params.callback({ type: 'NotFound' });\n }\n\n try {\n let size: number;\n try {\n ({ size } = await file.stat());\n } catch (error: unknown) {\n this.logger(\n 'error',\n `File system store failed to get size of file ${filename}: ${ensureError(error)}`\n );\n return await params.callback({ type: 'InternalError' });\n }\n\n const range = this.translate(size, params.range);\n if (!range) {\n return await params.callback({ type: 'RangeNotSatisfiable', size });\n }\n\n if (params.method === 'HEAD') {\n return await params.callback({ type: 'Ok', size, range });\n }\n\n let data: Readable;\n try {\n data = createReadStream('ignored', {\n fd: file.fd,\n autoClose: false,\n start: range.start,\n end: range.end,\n signal: params.signal\n });\n this.logger(\n 'info',\n `File system store created read stream for ${filename}[${range.start}..=${range.end}]`\n );\n } catch (error: unknown) {\n this.logger(\n 'error',\n `File system store failed to create read stream for ${filename}[${range.start}..=${range.end}]: ${ensureError(error)}`\n );\n return await params.callback({ type: 'InternalError' });\n }\n\n return await params\n .callback({ type: 'Ok', size, range, data })\n .catch(() => {});\n } finally {\n await file.close();\n }\n }\n}\n"],"names":["PFrameInternal","resolve","stat","join","open","ensureError","createReadStream"],"mappings":";;;;;;;;AAOA;AACM,MAAO,eAAgB,SAAQA,iCAAc,CAAC,WAAW,CAAA;AAC5C,IAAA,OAAO;AAExB,IAAA,WAAA,CAAoB,OAAsC,EAAA;QACxD,KAAK,CAAC,OAAO,CAAC;AAEd,QAAA,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC,OAAO;IAChC;AAEA,IAAA,aAAa,IAAI,CACf,OAAsC,EAAA;QAEtC,MAAM,eAAe,GAAGC,iBAAO,CAAC,OAAO,CAAC,OAAO,CAAC;QAEhD,MAAM,SAAS,GAAG,MAAMC,aAAI,CAAC,eAAe,CAAC,CAAC,KAAK,CAAC,MAAK;AACvD,YAAA,MAAM,IAAI,KAAK,CACb,oDAAoD,eAAe,CAAA,CAAE,CACtE;AACH,QAAA,CAAC,CAAC;AACF,QAAA,IAAI,CAAC,SAAS,CAAC,WAAW,EAAE,EAAE;AAC5B,YAAA,MAAM,IAAI,KAAK,CACb,mDAAmD,eAAe,CAAA,CAAE,CACrE;QACH;QAEA,OAAO,IAAI,eAAe,CAAC;AACzB,YAAA,GAAG,OAAO;AACV,YAAA,OAAO,EAAE;AACV,SAAA,CAAC;IACJ;AAES,IAAA,MAAM,OAAO,CACpB,QAAwC,EACxC,MAKC,EAAA;AAED,QAAA,IAAI,IAAgB;AACpB,QAAA,IAAI;YACF,MAAM,IAAI,GAAGC,cAAI,CAAC,IAAI,CAAC,OAAO,EAAE,QAAQ,CAAC;YACzC,IAAI,GAAG,MAAMC,aAAI,CAAC,IAAI,EAAE,GAAG,CAAC;QAC9B;QAAE,OAAO,KAAc,EAAE;AACvB,YAAA,IAAI,CAAC,MAAM,CACT,OAAO,EACP,CAAA,sCAAA,EAAyC,QAAQ,CAAA,EAAA,EAAKC,yBAAW,CAAC,KAAK,CAAC,CAAA,CAAE,CAC3E;YACD,OAAO,MAAM,MAAM,CAAC,QAAQ,CAAC,EAAE,IAAI,EAAE,UAAU,EAAE,CAAC;QACpD;AAEA,QAAA,IAAI;AACF,YAAA,IAAI,IAAY;AAChB,YAAA,IAAI;gBACF,CAAC,EAAE,IAAI,EAAE,GAAG,MAAM,IAAI,CAAC,IAAI,EAAE;YAC/B;YAAE,OAAO,KAAc,EAAE;AACvB,gBAAA,IAAI,CAAC,MAAM,CACT,OAAO,EACP,CAAA,6CAAA,EAAgD,QAAQ,CAAA,EAAA,EAAKA,yBAAW,CAAC,KAAK,CAAC,CAAA,CAAE,CAClF;gBACD,OAAO,MAAM,MAAM,CAAC,QAAQ,CAAC,EAAE,IAAI,EAAE,eAAe,EAAE,CAAC;YACzD;AAEA,YAAA,MAAM,KAAK,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,EAAE,MAAM,CAAC,KAAK,CAAC;YAChD,IAAI,CAAC,KAAK,EAAE;AACV,gBAAA,OAAO,MAAM,MAAM,CAAC,QAAQ,CAAC,EAAE,IAAI,EAAE,qBAAqB,EAAE,IAAI,EAAE,CAAC;YACrE;AAEA,YAAA,IAAI,MAAM,CAAC,MAAM,KAAK,MAAM,EAAE;AAC5B,gBAAA,OAAO,MAAM,MAAM,CAAC,QAAQ,CAAC,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC;YAC3D;AAEA,YAAA,IAAI,IAAc;AAClB,YAAA,IAAI;AACF,gBAAA,IAAI,GAAGC,wBAAgB,CAAC,SAAS,EAAE;oBACjC,EAAE,EAAE,IAAI,CAAC,EAAE;AACX,oBAAA,SAAS,EAAE,KAAK;oBAChB,KAAK,EAAE,KAAK,CAAC,KAAK;oBAClB,GAAG,EAAE,KAAK,CAAC,GAAG;oBACd,MAAM,EAAE,MAAM,CAAC;AAChB,iBAAA,CAAC;AACF,gBAAA,IAAI,CAAC,MAAM,CACT,MAAM,EACN,6CAA6C,QAAQ,CAAA,CAAA,EAAI,KAAK,CAAC,KAAK,CAAA,GAAA,EAAM,KAAK,CAAC,GAAG,CAAA,CAAA,CAAG,CACvF;YACH;YAAE,OAAO,KAAc,EAAE;gBACvB,IAAI,CAAC,MAAM,CACT,OAAO,EACP,CAAA,mDAAA,EAAsD,QAAQ,CAAA,CAAA,EAAI,KAAK,CAAC,KAAK,MAAM,KAAK,CAAC,GAAG,CAAA,GAAA,EAAMD,yBAAW,CAAC,KAAK,CAAC,CAAA,CAAE,CACvH;gBACD,OAAO,MAAM,MAAM,CAAC,QAAQ,CAAC,EAAE,IAAI,EAAE,eAAe,EAAE,CAAC;YACzD;AAEA,YAAA,OAAO,MAAM;AACV,iBAAA,QAAQ,CAAC,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE;AAC1C,iBAAA,KAAK,CAAC,MAAK,EAAE,CAAC,CAAC;QACpB;gBAAU;AACR,YAAA,MAAM,IAAI,CAAC,KAAK,EAAE;QACpB;IACF;AACD;;;;"}
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
import { PFrameInternal } from '@milaboratories/pl-model-middle-layer';
|
|
2
|
+
/** Object store for serving files from a local directory */
|
|
3
|
+
export declare class FileSystemStore extends PFrameInternal.ObjectStore {
|
|
4
|
+
private readonly rootDir;
|
|
5
|
+
private constructor();
|
|
6
|
+
static init(options: PFrameInternal.FsStoreOptions): Promise<FileSystemStore>;
|
|
7
|
+
request(filename: PFrameInternal.ParquetFileName, params: {
|
|
8
|
+
method: PFrameInternal.HttpMethod;
|
|
9
|
+
range?: PFrameInternal.HttpRange;
|
|
10
|
+
signal: AbortSignal;
|
|
11
|
+
callback: (response: PFrameInternal.ObjectStoreResponse) => Promise<void>;
|
|
12
|
+
}): Promise<void>;
|
|
13
|
+
}
|
|
14
|
+
//# sourceMappingURL=fs-store.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"fs-store.d.ts","sourceRoot":"","sources":["../src/fs-store.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,cAAc,EAAE,MAAM,uCAAuC,CAAC;AAGvE,4DAA4D;AAC5D,qBAAa,eAAgB,SAAQ,cAAc,CAAC,WAAW;IAC7D,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAS;IAEjC,OAAO;WAMM,IAAI,CACf,OAAO,EAAE,cAAc,CAAC,cAAc,GACrC,OAAO,CAAC,eAAe,CAAC;IAoBZ,OAAO,CACpB,QAAQ,EAAE,cAAc,CAAC,eAAe,EACxC,MAAM,EAAE;QACN,MAAM,EAAE,cAAc,CAAC,UAAU,CAAC;QAClC,KAAK,CAAC,EAAE,cAAc,CAAC,SAAS,CAAC;QACjC,MAAM,EAAE,WAAW,CAAC;QACpB,QAAQ,EAAE,CAAC,QAAQ,EAAE,cAAc,CAAC,mBAAmB,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;KAC3E,GACA,OAAO,CAAC,IAAI,CAAC;CA8DjB"}
|
package/dist/fs-store.js
ADDED
|
@@ -0,0 +1,79 @@
|
|
|
1
|
+
import { createReadStream } from 'node:fs';
|
|
2
|
+
import { stat, open } from 'node:fs/promises';
|
|
3
|
+
import { resolve, join } from 'node:path';
|
|
4
|
+
import { PFrameInternal } from '@milaboratories/pl-model-middle-layer';
|
|
5
|
+
import { ensureError } from '@milaboratories/pl-model-common';
|
|
6
|
+
|
|
7
|
+
/** Object store for serving files from a local directory */
|
|
8
|
+
class FileSystemStore extends PFrameInternal.ObjectStore {
|
|
9
|
+
rootDir;
|
|
10
|
+
constructor(options) {
|
|
11
|
+
super(options);
|
|
12
|
+
this.rootDir = options.rootDir;
|
|
13
|
+
}
|
|
14
|
+
static async init(options) {
|
|
15
|
+
const resolvedRootDir = resolve(options.rootDir);
|
|
16
|
+
const rootStats = await stat(resolvedRootDir).catch(() => {
|
|
17
|
+
throw new Error(`File system store root directory does not exist: ${resolvedRootDir}`);
|
|
18
|
+
});
|
|
19
|
+
if (!rootStats.isDirectory()) {
|
|
20
|
+
throw new Error(`File system store root path is not a directory: ${resolvedRootDir}`);
|
|
21
|
+
}
|
|
22
|
+
return new FileSystemStore({
|
|
23
|
+
...options,
|
|
24
|
+
rootDir: resolvedRootDir
|
|
25
|
+
});
|
|
26
|
+
}
|
|
27
|
+
async request(filename, params) {
|
|
28
|
+
let file;
|
|
29
|
+
try {
|
|
30
|
+
const path = join(this.rootDir, filename);
|
|
31
|
+
file = await open(path, 'r');
|
|
32
|
+
}
|
|
33
|
+
catch (error) {
|
|
34
|
+
this.logger('error', `File system store failed to open file ${filename}: ${ensureError(error)}`);
|
|
35
|
+
return await params.callback({ type: 'NotFound' });
|
|
36
|
+
}
|
|
37
|
+
try {
|
|
38
|
+
let size;
|
|
39
|
+
try {
|
|
40
|
+
({ size } = await file.stat());
|
|
41
|
+
}
|
|
42
|
+
catch (error) {
|
|
43
|
+
this.logger('error', `File system store failed to get size of file ${filename}: ${ensureError(error)}`);
|
|
44
|
+
return await params.callback({ type: 'InternalError' });
|
|
45
|
+
}
|
|
46
|
+
const range = this.translate(size, params.range);
|
|
47
|
+
if (!range) {
|
|
48
|
+
return await params.callback({ type: 'RangeNotSatisfiable', size });
|
|
49
|
+
}
|
|
50
|
+
if (params.method === 'HEAD') {
|
|
51
|
+
return await params.callback({ type: 'Ok', size, range });
|
|
52
|
+
}
|
|
53
|
+
let data;
|
|
54
|
+
try {
|
|
55
|
+
data = createReadStream('ignored', {
|
|
56
|
+
fd: file.fd,
|
|
57
|
+
autoClose: false,
|
|
58
|
+
start: range.start,
|
|
59
|
+
end: range.end,
|
|
60
|
+
signal: params.signal
|
|
61
|
+
});
|
|
62
|
+
this.logger('info', `File system store created read stream for ${filename}[${range.start}..=${range.end}]`);
|
|
63
|
+
}
|
|
64
|
+
catch (error) {
|
|
65
|
+
this.logger('error', `File system store failed to create read stream for ${filename}[${range.start}..=${range.end}]: ${ensureError(error)}`);
|
|
66
|
+
return await params.callback({ type: 'InternalError' });
|
|
67
|
+
}
|
|
68
|
+
return await params
|
|
69
|
+
.callback({ type: 'Ok', size, range, data })
|
|
70
|
+
.catch(() => { });
|
|
71
|
+
}
|
|
72
|
+
finally {
|
|
73
|
+
await file.close();
|
|
74
|
+
}
|
|
75
|
+
}
|
|
76
|
+
}
|
|
77
|
+
|
|
78
|
+
export { FileSystemStore };
|
|
79
|
+
//# sourceMappingURL=fs-store.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"fs-store.js","sources":["../src/fs-store.ts"],"sourcesContent":["import type { Readable } from 'node:stream';\nimport { createReadStream } from 'node:fs';\nimport { stat, open, type FileHandle } from 'node:fs/promises';\nimport { join, resolve } from 'node:path';\nimport { PFrameInternal } from '@milaboratories/pl-model-middle-layer';\nimport { ensureError } from '@milaboratories/pl-model-common';\n\n/** Object store for serving files from a local directory */\nexport class FileSystemStore extends PFrameInternal.ObjectStore {\n private readonly rootDir: string;\n\n private constructor(options: PFrameInternal.FsStoreOptions) {\n super(options);\n\n this.rootDir = options.rootDir;\n }\n\n static async init(\n options: PFrameInternal.FsStoreOptions\n ): Promise<FileSystemStore> {\n const resolvedRootDir = resolve(options.rootDir);\n\n const rootStats = await stat(resolvedRootDir).catch(() => {\n throw new Error(\n `File system store root directory does not exist: ${resolvedRootDir}`\n );\n });\n if (!rootStats.isDirectory()) {\n throw new Error(\n `File system store root path is not a directory: ${resolvedRootDir}`\n );\n }\n\n return new FileSystemStore({\n ...options,\n rootDir: resolvedRootDir\n });\n }\n\n override async request(\n filename: PFrameInternal.ParquetFileName,\n params: {\n method: PFrameInternal.HttpMethod;\n range?: PFrameInternal.HttpRange;\n signal: AbortSignal;\n callback: (response: PFrameInternal.ObjectStoreResponse) => Promise<void>;\n }\n ): Promise<void> {\n let file: FileHandle;\n try {\n const path = join(this.rootDir, filename);\n file = await open(path, 'r');\n } catch (error: unknown) {\n this.logger(\n 'error',\n `File system store failed to open file ${filename}: ${ensureError(error)}`\n );\n return await params.callback({ type: 'NotFound' });\n }\n\n try {\n let size: number;\n try {\n ({ size } = await file.stat());\n } catch (error: unknown) {\n this.logger(\n 'error',\n `File system store failed to get size of file ${filename}: ${ensureError(error)}`\n );\n return await params.callback({ type: 'InternalError' });\n }\n\n const range = this.translate(size, params.range);\n if (!range) {\n return await params.callback({ type: 'RangeNotSatisfiable', size });\n }\n\n if (params.method === 'HEAD') {\n return await params.callback({ type: 'Ok', size, range });\n }\n\n let data: Readable;\n try {\n data = createReadStream('ignored', {\n fd: file.fd,\n autoClose: false,\n start: range.start,\n end: range.end,\n signal: params.signal\n });\n this.logger(\n 'info',\n `File system store created read stream for ${filename}[${range.start}..=${range.end}]`\n );\n } catch (error: unknown) {\n this.logger(\n 'error',\n `File system store failed to create read stream for ${filename}[${range.start}..=${range.end}]: ${ensureError(error)}`\n );\n return await params.callback({ type: 'InternalError' });\n }\n\n return await params\n .callback({ type: 'Ok', size, range, data })\n .catch(() => {});\n } finally {\n await file.close();\n }\n }\n}\n"],"names":[],"mappings":";;;;;;AAOA;AACM,MAAO,eAAgB,SAAQ,cAAc,CAAC,WAAW,CAAA;AAC5C,IAAA,OAAO;AAExB,IAAA,WAAA,CAAoB,OAAsC,EAAA;QACxD,KAAK,CAAC,OAAO,CAAC;AAEd,QAAA,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC,OAAO;IAChC;AAEA,IAAA,aAAa,IAAI,CACf,OAAsC,EAAA;QAEtC,MAAM,eAAe,GAAG,OAAO,CAAC,OAAO,CAAC,OAAO,CAAC;QAEhD,MAAM,SAAS,GAAG,MAAM,IAAI,CAAC,eAAe,CAAC,CAAC,KAAK,CAAC,MAAK;AACvD,YAAA,MAAM,IAAI,KAAK,CACb,oDAAoD,eAAe,CAAA,CAAE,CACtE;AACH,QAAA,CAAC,CAAC;AACF,QAAA,IAAI,CAAC,SAAS,CAAC,WAAW,EAAE,EAAE;AAC5B,YAAA,MAAM,IAAI,KAAK,CACb,mDAAmD,eAAe,CAAA,CAAE,CACrE;QACH;QAEA,OAAO,IAAI,eAAe,CAAC;AACzB,YAAA,GAAG,OAAO;AACV,YAAA,OAAO,EAAE;AACV,SAAA,CAAC;IACJ;AAES,IAAA,MAAM,OAAO,CACpB,QAAwC,EACxC,MAKC,EAAA;AAED,QAAA,IAAI,IAAgB;AACpB,QAAA,IAAI;YACF,MAAM,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,QAAQ,CAAC;YACzC,IAAI,GAAG,MAAM,IAAI,CAAC,IAAI,EAAE,GAAG,CAAC;QAC9B;QAAE,OAAO,KAAc,EAAE;AACvB,YAAA,IAAI,CAAC,MAAM,CACT,OAAO,EACP,CAAA,sCAAA,EAAyC,QAAQ,CAAA,EAAA,EAAK,WAAW,CAAC,KAAK,CAAC,CAAA,CAAE,CAC3E;YACD,OAAO,MAAM,MAAM,CAAC,QAAQ,CAAC,EAAE,IAAI,EAAE,UAAU,EAAE,CAAC;QACpD;AAEA,QAAA,IAAI;AACF,YAAA,IAAI,IAAY;AAChB,YAAA,IAAI;gBACF,CAAC,EAAE,IAAI,EAAE,GAAG,MAAM,IAAI,CAAC,IAAI,EAAE;YAC/B;YAAE,OAAO,KAAc,EAAE;AACvB,gBAAA,IAAI,CAAC,MAAM,CACT,OAAO,EACP,CAAA,6CAAA,EAAgD,QAAQ,CAAA,EAAA,EAAK,WAAW,CAAC,KAAK,CAAC,CAAA,CAAE,CAClF;gBACD,OAAO,MAAM,MAAM,CAAC,QAAQ,CAAC,EAAE,IAAI,EAAE,eAAe,EAAE,CAAC;YACzD;AAEA,YAAA,MAAM,KAAK,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,EAAE,MAAM,CAAC,KAAK,CAAC;YAChD,IAAI,CAAC,KAAK,EAAE;AACV,gBAAA,OAAO,MAAM,MAAM,CAAC,QAAQ,CAAC,EAAE,IAAI,EAAE,qBAAqB,EAAE,IAAI,EAAE,CAAC;YACrE;AAEA,YAAA,IAAI,MAAM,CAAC,MAAM,KAAK,MAAM,EAAE;AAC5B,gBAAA,OAAO,MAAM,MAAM,CAAC,QAAQ,CAAC,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC;YAC3D;AAEA,YAAA,IAAI,IAAc;AAClB,YAAA,IAAI;AACF,gBAAA,IAAI,GAAG,gBAAgB,CAAC,SAAS,EAAE;oBACjC,EAAE,EAAE,IAAI,CAAC,EAAE;AACX,oBAAA,SAAS,EAAE,KAAK;oBAChB,KAAK,EAAE,KAAK,CAAC,KAAK;oBAClB,GAAG,EAAE,KAAK,CAAC,GAAG;oBACd,MAAM,EAAE,MAAM,CAAC;AAChB,iBAAA,CAAC;AACF,gBAAA,IAAI,CAAC,MAAM,CACT,MAAM,EACN,6CAA6C,QAAQ,CAAA,CAAA,EAAI,KAAK,CAAC,KAAK,CAAA,GAAA,EAAM,KAAK,CAAC,GAAG,CAAA,CAAA,CAAG,CACvF;YACH;YAAE,OAAO,KAAc,EAAE;gBACvB,IAAI,CAAC,MAAM,CACT,OAAO,EACP,CAAA,mDAAA,EAAsD,QAAQ,CAAA,CAAA,EAAI,KAAK,CAAC,KAAK,MAAM,KAAK,CAAC,GAAG,CAAA,GAAA,EAAM,WAAW,CAAC,KAAK,CAAC,CAAA,CAAE,CACvH;gBACD,OAAO,MAAM,MAAM,CAAC,QAAQ,CAAC,EAAE,IAAI,EAAE,eAAe,EAAE,CAAC;YACzD;AAEA,YAAA,OAAO,MAAM;AACV,iBAAA,QAAQ,CAAC,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE;AAC1C,iBAAA,KAAK,CAAC,MAAK,EAAE,CAAC,CAAC;QACpB;gBAAU;AACR,YAAA,MAAM,IAAI,CAAC,KAAK,EAAE;QACpB;IACF;AACD;;;;"}
|
package/dist/handler.cjs
ADDED
|
@@ -0,0 +1,157 @@
|
|
|
1
|
+
'use strict';
|
|
2
|
+
|
|
3
|
+
var promises = require('node:stream/promises');
|
|
4
|
+
var node_crypto = require('node:crypto');
|
|
5
|
+
var filename = require('./utils/filename.cjs');
|
|
6
|
+
var etag = require('./utils/etag.cjs');
|
|
7
|
+
var headers = require('./utils/headers.cjs');
|
|
8
|
+
var options = require('./utils/options.cjs');
|
|
9
|
+
var range = require('./utils/range.cjs');
|
|
10
|
+
var method = require('./utils/method.cjs');
|
|
11
|
+
var status = require('./utils/status.cjs');
|
|
12
|
+
|
|
13
|
+
/** Main request handler for parquet files */
|
|
14
|
+
async function handleRequest(request, response, store) {
|
|
15
|
+
// RFC 9110 section 6.6.1: Date header should be present in all responses
|
|
16
|
+
response.sendDate = true;
|
|
17
|
+
// RFC 9110 section 8.6: Content-Length 0 as default for error responses
|
|
18
|
+
response.strictContentLength = true;
|
|
19
|
+
response.setHeader(headers.HeaderName.ContentLength, 0);
|
|
20
|
+
// Note: setting Content-Length disables Node.js default Transfer-Encoding: chunked
|
|
21
|
+
// RFC 9111 section 5.2: Cache-Control header with public allows to cache authenticated responses
|
|
22
|
+
response.setHeader(headers.HeaderName.CacheControl, headers.HeaderValue.CacheControl);
|
|
23
|
+
// RFC 9110 section 15.5.6: Method not allowed
|
|
24
|
+
const method$1 = request.method;
|
|
25
|
+
if (!method.isGetOrHead(method$1)) {
|
|
26
|
+
response.setHeader(headers.HeaderName.Allow, headers.HeaderValue.Allow);
|
|
27
|
+
return void response.writeHead(status.StatusCode.MethodNotAllowed).end();
|
|
28
|
+
}
|
|
29
|
+
const filename$1 = filename.getFilenameFromUrl(request);
|
|
30
|
+
if (filename$1 === null) {
|
|
31
|
+
return void response.writeHead(status.StatusCode.Gone).end();
|
|
32
|
+
}
|
|
33
|
+
// From now on we are sure that the response would be a Parquet file
|
|
34
|
+
response.setHeader(headers.HeaderName.AcceptRanges, headers.HeaderValue.AcceptRanges);
|
|
35
|
+
response.setHeader(headers.HeaderName.ContentType, headers.HeaderValue.ContentType);
|
|
36
|
+
// RFC 9110 section 8.8.3: ETag header is used for cache versioning
|
|
37
|
+
const etag$1 = etag.createETag(filename$1);
|
|
38
|
+
// RFC 9110 section 8.8.2: Last-Modified header field for cache validation
|
|
39
|
+
const mtime = new Date(0); // Using fake fixed date since files are immutable
|
|
40
|
+
// RFC 9111 section 5.2: Cache-Control header with public allows to cache authenticated responses
|
|
41
|
+
response.setHeader(headers.HeaderName.CacheControl, headers.HeaderValue.CacheControl);
|
|
42
|
+
response.setHeader(headers.HeaderName.ETag, etag$1);
|
|
43
|
+
response.setHeader(headers.HeaderName.LastModified, mtime.toUTCString());
|
|
44
|
+
const options$1 = new options.Options(request);
|
|
45
|
+
// RFC 9110 section 13.1.1: If-Match precondition evaluation
|
|
46
|
+
// RFC 9110 section 13.1.4: If-Unmodified-Since precondition evaluation
|
|
47
|
+
if (options$1.preconditionFailed(etag$1, mtime)) {
|
|
48
|
+
return void response.writeHead(status.StatusCode.PreconditionFailed).end();
|
|
49
|
+
}
|
|
50
|
+
// RFC 9110 section 13.1.2: If-None-Match precondition evaluation
|
|
51
|
+
// RFC 9110 section 13.1.3: If-Modified-Since precondition evaluation
|
|
52
|
+
else if (options$1.notModified(etag$1, mtime)) {
|
|
53
|
+
return void response.writeHead(status.StatusCode.NotModified).end();
|
|
54
|
+
}
|
|
55
|
+
const range$1 = range.parseRange(request);
|
|
56
|
+
if (range$1 === null) {
|
|
57
|
+
return void response.writeHead(status.StatusCode.BadRequest).end();
|
|
58
|
+
}
|
|
59
|
+
const abortController = new AbortController();
|
|
60
|
+
request.on('close', () => abortController.abort());
|
|
61
|
+
const signal = abortController.signal;
|
|
62
|
+
store.request(filename$1, {
|
|
63
|
+
method: 'GET',
|
|
64
|
+
range: range$1,
|
|
65
|
+
signal,
|
|
66
|
+
// pipeline automatically destroys the streams if they were not gracefully closed
|
|
67
|
+
callback: async (result) => {
|
|
68
|
+
if (response.destroyed)
|
|
69
|
+
return void response.destroy();
|
|
70
|
+
switch (result.type) {
|
|
71
|
+
case 'InternalError':
|
|
72
|
+
// object store encountered network error, retry by client can help
|
|
73
|
+
return void response.writeHead(status.StatusCode.InternalServerError).end();
|
|
74
|
+
case 'NotFound':
|
|
75
|
+
// RFC 9110 section 15.4.5: Not found
|
|
76
|
+
return void response.writeHead(status.StatusCode.NotFound).end();
|
|
77
|
+
case 'RangeNotSatisfiable':
|
|
78
|
+
// RFC 9110 section 15.5.17: Range not satisfiable
|
|
79
|
+
response.setHeader(headers.HeaderName.ContentRange, `bytes */${result.size}`);
|
|
80
|
+
return void response.writeHead(status.StatusCode.RangeNotSatisfiable).end();
|
|
81
|
+
}
|
|
82
|
+
if (method.isGet(method$1) && !result.data) {
|
|
83
|
+
// object store implementation is incorrect, retry by client cannot help
|
|
84
|
+
return void response.writeHead(status.StatusCode.GatewayTimeout).end();
|
|
85
|
+
}
|
|
86
|
+
if (range$1) {
|
|
87
|
+
// RFC 9110 section 14.4: Partial content response
|
|
88
|
+
response.setHeader(headers.HeaderName.ContentLength, result.range.end - result.range.start + 1);
|
|
89
|
+
response.setHeader(headers.HeaderName.ContentRange, `bytes ${result.range.start}-${result.range.end}/${result.size}`);
|
|
90
|
+
response.writeHead(status.StatusCode.PartialContent);
|
|
91
|
+
}
|
|
92
|
+
else {
|
|
93
|
+
// RFC 9110 section 15.3.1: OK response
|
|
94
|
+
response.setHeader(headers.HeaderName.ContentLength, result.size);
|
|
95
|
+
response.writeHead(status.StatusCode.Ok);
|
|
96
|
+
}
|
|
97
|
+
// RFC 9110 section 9.3.2: HEAD method must not return message body
|
|
98
|
+
if (method.isHead(method$1)) {
|
|
99
|
+
return void response.end();
|
|
100
|
+
}
|
|
101
|
+
return await promises.pipeline(result.data, response, { signal }).catch(() => {
|
|
102
|
+
// Pipeline errors are expected when request is aborted or connection is lost
|
|
103
|
+
// Response head was already written, so we can't change status code
|
|
104
|
+
// Just mute the error - pipeline destroys the response stream
|
|
105
|
+
});
|
|
106
|
+
}
|
|
107
|
+
});
|
|
108
|
+
}
|
|
109
|
+
/**
|
|
110
|
+
* Create a request handler for serving files from an object store
|
|
111
|
+
* compatible with HTTP/1.1 as defined in RFC 9110 and RFC 9111:
|
|
112
|
+
* - <https://datatracker.ietf.org/doc/html/rfc9110>
|
|
113
|
+
* - <https://datatracker.ietf.org/doc/html/rfc9111>
|
|
114
|
+
*
|
|
115
|
+
* Accepts only paths of the form `/<filename>.parquet`, returns 404 otherwise
|
|
116
|
+
* Assumes that files are immutable (and sets cache headers accordingly)
|
|
117
|
+
*/
|
|
118
|
+
function createRequestHandler(options) {
|
|
119
|
+
const { store } = options;
|
|
120
|
+
return (request, response) => void handleRequest(request, response, store);
|
|
121
|
+
}
|
|
122
|
+
/** Request authorization middleware */
|
|
123
|
+
function authorizeRequest(request, response, handler, authHeader) {
|
|
124
|
+
// RFC 9110 section 6.6.1: Date header should be present in all responses
|
|
125
|
+
response.sendDate = true;
|
|
126
|
+
// RFC 9110 section 8.6: Content-Length 0 as default for error responses
|
|
127
|
+
response.strictContentLength = true;
|
|
128
|
+
response.setHeader(headers.HeaderName.ContentLength, 0);
|
|
129
|
+
// Note: setting Content-Length disables Node.js default Transfer-Encoding: chunked
|
|
130
|
+
const actualHeader = request.headers['authorization'];
|
|
131
|
+
// Early length check to avoid unnecessary processing
|
|
132
|
+
if (!actualHeader || actualHeader.length !== authHeader.length) {
|
|
133
|
+
// RFC 9110 section 11.6.1: WWW-Authenticate header field
|
|
134
|
+
response.setHeader(headers.HeaderName.WWWAuthenticate, headers.HeaderValue.WWWAuthenticate);
|
|
135
|
+
return void response.writeHead(status.StatusCode.Unauthorized).end();
|
|
136
|
+
}
|
|
137
|
+
// Use timing-safe comparison to prevent timing attacks
|
|
138
|
+
// <https://developers.cloudflare.com/workers/examples/protect-against-timing-attacks/>
|
|
139
|
+
const encoder = new TextEncoder();
|
|
140
|
+
const receivedBuffer = encoder.encode(actualHeader);
|
|
141
|
+
const expectedBuffer = encoder.encode(authHeader);
|
|
142
|
+
if (receivedBuffer.byteLength !== expectedBuffer.byteLength ||
|
|
143
|
+
!node_crypto.timingSafeEqual(receivedBuffer, expectedBuffer)) {
|
|
144
|
+
response.setHeader(headers.HeaderName.WWWAuthenticate, headers.HeaderValue.WWWAuthenticate);
|
|
145
|
+
return void response.writeHead(status.StatusCode.Unauthorized).end();
|
|
146
|
+
}
|
|
147
|
+
return handler(request, response);
|
|
148
|
+
}
|
|
149
|
+
/** Apply Bearer token authorization to @param handler */
|
|
150
|
+
function authorizeRequestHandler(handler, authToken) {
|
|
151
|
+
const authHeader = `Bearer ${authToken}`;
|
|
152
|
+
return (request, response) => authorizeRequest(request, response, handler, authHeader);
|
|
153
|
+
}
|
|
154
|
+
|
|
155
|
+
exports.authorizeRequestHandler = authorizeRequestHandler;
|
|
156
|
+
exports.createRequestHandler = createRequestHandler;
|
|
157
|
+
//# sourceMappingURL=handler.cjs.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"handler.cjs","sources":["../src/handler.ts"],"sourcesContent":["import type {\n IncomingMessage,\n RequestListener,\n ServerResponse\n} from 'node:http';\nimport { pipeline } from 'node:stream/promises';\nimport { timingSafeEqual } from 'node:crypto';\nimport type { PFrameInternal } from '@milaboratories/pl-model-middle-layer';\nimport {\n createETag,\n getFilenameFromUrl,\n parseRange,\n isGetOrHead,\n isHead,\n Options,\n StatusCode,\n HeaderName,\n HeaderValue,\n isGet\n} from './utils';\n\n/** Main request handler for parquet files */\nasync function handleRequest(\n request: IncomingMessage,\n response: ServerResponse,\n store: PFrameInternal.ObjectStore\n): Promise<void> {\n // RFC 9110 section 6.6.1: Date header should be present in all responses\n response.sendDate = true;\n // RFC 9110 section 8.6: Content-Length 0 as default for error responses\n response.strictContentLength = true;\n response.setHeader(HeaderName.ContentLength, 0);\n // Note: setting Content-Length disables Node.js default Transfer-Encoding: chunked\n\n // RFC 9111 section 5.2: Cache-Control header with public allows to cache authenticated responses\n response.setHeader(HeaderName.CacheControl, HeaderValue.CacheControl);\n\n // RFC 9110 section 15.5.6: Method not allowed\n const method = request.method;\n if (!isGetOrHead(method)) {\n response.setHeader(HeaderName.Allow, HeaderValue.Allow);\n return void response.writeHead(StatusCode.MethodNotAllowed).end();\n }\n\n const filename = getFilenameFromUrl(request);\n if (filename === null) {\n return void response.writeHead(StatusCode.Gone).end();\n }\n\n // From now on we are sure that the response would be a Parquet file\n response.setHeader(HeaderName.AcceptRanges, HeaderValue.AcceptRanges);\n response.setHeader(HeaderName.ContentType, HeaderValue.ContentType);\n\n // RFC 9110 section 8.8.3: ETag header is used for cache versioning\n const etag = createETag(filename);\n // RFC 9110 section 8.8.2: Last-Modified header field for cache validation\n const mtime = new Date(0); // Using fake fixed date since files are immutable\n // RFC 9111 section 5.2: Cache-Control header with public allows to cache authenticated responses\n response.setHeader(HeaderName.CacheControl, HeaderValue.CacheControl);\n response.setHeader(HeaderName.ETag, etag);\n response.setHeader(HeaderName.LastModified, mtime.toUTCString());\n\n const options = new Options(request);\n // RFC 9110 section 13.1.1: If-Match precondition evaluation\n // RFC 9110 section 13.1.4: If-Unmodified-Since precondition evaluation\n if (options.preconditionFailed(etag, mtime)) {\n return void response.writeHead(StatusCode.PreconditionFailed).end();\n }\n // RFC 9110 section 13.1.2: If-None-Match precondition evaluation\n // RFC 9110 section 13.1.3: If-Modified-Since precondition evaluation\n else if (options.notModified(etag, mtime)) {\n return void response.writeHead(StatusCode.NotModified).end();\n }\n\n const range = parseRange(request);\n if (range === null) {\n return void response.writeHead(StatusCode.BadRequest).end();\n }\n\n const abortController = new AbortController();\n request.on('close', () => abortController.abort());\n const signal = abortController.signal;\n\n store.request(filename, {\n method: 'GET',\n range,\n signal,\n // pipeline automatically destroys the streams if they were not gracefully closed\n callback: async (result) => {\n if (response.destroyed) return void response.destroy();\n\n switch (result.type) {\n case 'InternalError':\n // object store encountered network error, retry by client can help\n return void response.writeHead(StatusCode.InternalServerError).end();\n case 'NotFound':\n // RFC 9110 section 15.4.5: Not found\n return void response.writeHead(StatusCode.NotFound).end();\n case 'RangeNotSatisfiable':\n // RFC 9110 section 15.5.17: Range not satisfiable\n response.setHeader(HeaderName.ContentRange, `bytes */${result.size}`);\n return void response.writeHead(StatusCode.RangeNotSatisfiable).end();\n case 'Ok':\n break;\n }\n\n if (isGet(method) && !result.data) {\n // object store implementation is incorrect, retry by client cannot help\n return void response.writeHead(StatusCode.GatewayTimeout).end();\n }\n\n if (range) {\n // RFC 9110 section 14.4: Partial content response\n response.setHeader(\n HeaderName.ContentLength,\n result.range.end - result.range.start + 1\n );\n response.setHeader(\n HeaderName.ContentRange,\n `bytes ${result.range.start}-${result.range.end}/${result.size}`\n );\n response.writeHead(StatusCode.PartialContent);\n } else {\n // RFC 9110 section 15.3.1: OK response\n response.setHeader(HeaderName.ContentLength, result.size);\n response.writeHead(StatusCode.Ok);\n }\n\n // RFC 9110 section 9.3.2: HEAD method must not return message body\n if (isHead(method)) {\n return void response.end();\n }\n\n return await pipeline(result.data!, response, { signal }).catch(() => {\n // Pipeline errors are expected when request is aborted or connection is lost\n // Response head was already written, so we can't change status code\n // Just mute the error - pipeline destroys the response stream\n });\n }\n });\n}\n\n/**\n * Create a request handler for serving files from an object store\n * compatible with HTTP/1.1 as defined in RFC 9110 and RFC 9111:\n * - <https://datatracker.ietf.org/doc/html/rfc9110>\n * - <https://datatracker.ietf.org/doc/html/rfc9111>\n *\n * Accepts only paths of the form `/<filename>.parquet`, returns 404 otherwise\n * Assumes that files are immutable (and sets cache headers accordingly)\n */\nexport function createRequestHandler(\n options: PFrameInternal.RequestHandlerOptions\n): RequestListener {\n const { store } = options;\n return (request, response) => void handleRequest(request, response, store);\n}\n\n/** Request authorization middleware */\nfunction authorizeRequest(\n request: IncomingMessage,\n response: ServerResponse,\n handler: RequestListener,\n authHeader: string\n): void {\n // RFC 9110 section 6.6.1: Date header should be present in all responses\n response.sendDate = true;\n // RFC 9110 section 8.6: Content-Length 0 as default for error responses\n response.strictContentLength = true;\n response.setHeader(HeaderName.ContentLength, 0);\n // Note: setting Content-Length disables Node.js default Transfer-Encoding: chunked\n\n const actualHeader = request.headers['authorization'];\n\n // Early length check to avoid unnecessary processing\n if (!actualHeader || actualHeader.length !== authHeader.length) {\n // RFC 9110 section 11.6.1: WWW-Authenticate header field\n response.setHeader(HeaderName.WWWAuthenticate, HeaderValue.WWWAuthenticate);\n return void response.writeHead(StatusCode.Unauthorized).end();\n }\n\n // Use timing-safe comparison to prevent timing attacks\n // <https://developers.cloudflare.com/workers/examples/protect-against-timing-attacks/>\n const encoder = new TextEncoder();\n const receivedBuffer = encoder.encode(actualHeader);\n const expectedBuffer = encoder.encode(authHeader);\n\n if (\n receivedBuffer.byteLength !== expectedBuffer.byteLength ||\n !timingSafeEqual(receivedBuffer, expectedBuffer)\n ) {\n response.setHeader(HeaderName.WWWAuthenticate, HeaderValue.WWWAuthenticate);\n return void response.writeHead(StatusCode.Unauthorized).end();\n }\n\n return handler(request, response);\n}\n\n/** Apply Bearer token authorization to @param handler */\nexport function authorizeRequestHandler(\n handler: RequestListener,\n authToken: PFrameInternal.HttpAuthorizationToken\n): RequestListener {\n const authHeader = `Bearer ${authToken}`;\n return (request, response) =>\n authorizeRequest(request, response, handler, authHeader);\n}\n"],"names":["HeaderName","HeaderValue","method","isGetOrHead","StatusCode","filename","getFilenameFromUrl","etag","createETag","options","Options","range","parseRange","isGet","isHead","pipeline","timingSafeEqual"],"mappings":";;;;;;;;;;;;AAqBA;AACA,eAAe,aAAa,CAC1B,OAAwB,EACxB,QAAwB,EACxB,KAAiC,EAAA;;AAGjC,IAAA,QAAQ,CAAC,QAAQ,GAAG,IAAI;;AAExB,IAAA,QAAQ,CAAC,mBAAmB,GAAG,IAAI;IACnC,QAAQ,CAAC,SAAS,CAACA,kBAAU,CAAC,aAAa,EAAE,CAAC,CAAC;;;IAI/C,QAAQ,CAAC,SAAS,CAACA,kBAAU,CAAC,YAAY,EAAEC,mBAAW,CAAC,YAAY,CAAC;;AAGrE,IAAA,MAAMC,QAAM,GAAG,OAAO,CAAC,MAAM;AAC7B,IAAA,IAAI,CAACC,kBAAW,CAACD,QAAM,CAAC,EAAE;QACxB,QAAQ,CAAC,SAAS,CAACF,kBAAU,CAAC,KAAK,EAAEC,mBAAW,CAAC,KAAK,CAAC;AACvD,QAAA,OAAO,KAAK,QAAQ,CAAC,SAAS,CAACG,iBAAU,CAAC,gBAAgB,CAAC,CAAC,GAAG,EAAE;IACnE;AAEA,IAAA,MAAMC,UAAQ,GAAGC,2BAAkB,CAAC,OAAO,CAAC;AAC5C,IAAA,IAAID,UAAQ,KAAK,IAAI,EAAE;AACrB,QAAA,OAAO,KAAK,QAAQ,CAAC,SAAS,CAACD,iBAAU,CAAC,IAAI,CAAC,CAAC,GAAG,EAAE;IACvD;;IAGA,QAAQ,CAAC,SAAS,CAACJ,kBAAU,CAAC,YAAY,EAAEC,mBAAW,CAAC,YAAY,CAAC;IACrE,QAAQ,CAAC,SAAS,CAACD,kBAAU,CAAC,WAAW,EAAEC,mBAAW,CAAC,WAAW,CAAC;;AAGnE,IAAA,MAAMM,MAAI,GAAGC,eAAU,CAACH,UAAQ,CAAC;;IAEjC,MAAM,KAAK,GAAG,IAAI,IAAI,CAAC,CAAC,CAAC,CAAC;;IAE1B,QAAQ,CAAC,SAAS,CAACL,kBAAU,CAAC,YAAY,EAAEC,mBAAW,CAAC,YAAY,CAAC;IACrE,QAAQ,CAAC,SAAS,CAACD,kBAAU,CAAC,IAAI,EAAEO,MAAI,CAAC;AACzC,IAAA,QAAQ,CAAC,SAAS,CAACP,kBAAU,CAAC,YAAY,EAAE,KAAK,CAAC,WAAW,EAAE,CAAC;AAEhE,IAAA,MAAMS,SAAO,GAAG,IAAIC,eAAO,CAAC,OAAO,CAAC;;;IAGpC,IAAID,SAAO,CAAC,kBAAkB,CAACF,MAAI,EAAE,KAAK,CAAC,EAAE;AAC3C,QAAA,OAAO,KAAK,QAAQ,CAAC,SAAS,CAACH,iBAAU,CAAC,kBAAkB,CAAC,CAAC,GAAG,EAAE;IACrE;;;SAGK,IAAIK,SAAO,CAAC,WAAW,CAACF,MAAI,EAAE,KAAK,CAAC,EAAE;AACzC,QAAA,OAAO,KAAK,QAAQ,CAAC,SAAS,CAACH,iBAAU,CAAC,WAAW,CAAC,CAAC,GAAG,EAAE;IAC9D;AAEA,IAAA,MAAMO,OAAK,GAAGC,gBAAU,CAAC,OAAO,CAAC;AACjC,IAAA,IAAID,OAAK,KAAK,IAAI,EAAE;AAClB,QAAA,OAAO,KAAK,QAAQ,CAAC,SAAS,CAACP,iBAAU,CAAC,UAAU,CAAC,CAAC,GAAG,EAAE;IAC7D;AAEA,IAAA,MAAM,eAAe,GAAG,IAAI,eAAe,EAAE;AAC7C,IAAA,OAAO,CAAC,EAAE,CAAC,OAAO,EAAE,MAAM,eAAe,CAAC,KAAK,EAAE,CAAC;AAClD,IAAA,MAAM,MAAM,GAAG,eAAe,CAAC,MAAM;AAErC,IAAA,KAAK,CAAC,OAAO,CAACC,UAAQ,EAAE;AACtB,QAAA,MAAM,EAAE,KAAK;eACbM,OAAK;QACL,MAAM;;AAEN,QAAA,QAAQ,EAAE,OAAO,MAAM,KAAI;YACzB,IAAI,QAAQ,CAAC,SAAS;AAAE,gBAAA,OAAO,KAAK,QAAQ,CAAC,OAAO,EAAE;AAEtD,YAAA,QAAQ,MAAM,CAAC,IAAI;AACjB,gBAAA,KAAK,eAAe;;AAElB,oBAAA,OAAO,KAAK,QAAQ,CAAC,SAAS,CAACP,iBAAU,CAAC,mBAAmB,CAAC,CAAC,GAAG,EAAE;AACtE,gBAAA,KAAK,UAAU;;AAEb,oBAAA,OAAO,KAAK,QAAQ,CAAC,SAAS,CAACA,iBAAU,CAAC,QAAQ,CAAC,CAAC,GAAG,EAAE;AAC3D,gBAAA,KAAK,qBAAqB;;AAExB,oBAAA,QAAQ,CAAC,SAAS,CAACJ,kBAAU,CAAC,YAAY,EAAE,CAAA,QAAA,EAAW,MAAM,CAAC,IAAI,CAAA,CAAE,CAAC;AACrE,oBAAA,OAAO,KAAK,QAAQ,CAAC,SAAS,CAACI,iBAAU,CAAC,mBAAmB,CAAC,CAAC,GAAG,EAAE;;YAKxE,IAAIS,YAAK,CAACX,QAAM,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,EAAE;;AAEjC,gBAAA,OAAO,KAAK,QAAQ,CAAC,SAAS,CAACE,iBAAU,CAAC,cAAc,CAAC,CAAC,GAAG,EAAE;YACjE;YAEA,IAAIO,OAAK,EAAE;;gBAET,QAAQ,CAAC,SAAS,CAChBX,kBAAU,CAAC,aAAa,EACxB,MAAM,CAAC,KAAK,CAAC,GAAG,GAAG,MAAM,CAAC,KAAK,CAAC,KAAK,GAAG,CAAC,CAC1C;gBACD,QAAQ,CAAC,SAAS,CAChBA,kBAAU,CAAC,YAAY,EACvB,CAAA,MAAA,EAAS,MAAM,CAAC,KAAK,CAAC,KAAK,CAAA,CAAA,EAAI,MAAM,CAAC,KAAK,CAAC,GAAG,CAAA,CAAA,EAAI,MAAM,CAAC,IAAI,CAAA,CAAE,CACjE;AACD,gBAAA,QAAQ,CAAC,SAAS,CAACI,iBAAU,CAAC,cAAc,CAAC;YAC/C;iBAAO;;gBAEL,QAAQ,CAAC,SAAS,CAACJ,kBAAU,CAAC,aAAa,EAAE,MAAM,CAAC,IAAI,CAAC;AACzD,gBAAA,QAAQ,CAAC,SAAS,CAACI,iBAAU,CAAC,EAAE,CAAC;YACnC;;AAGA,YAAA,IAAIU,aAAM,CAACZ,QAAM,CAAC,EAAE;AAClB,gBAAA,OAAO,KAAK,QAAQ,CAAC,GAAG,EAAE;YAC5B;AAEA,YAAA,OAAO,MAAMa,iBAAQ,CAAC,MAAM,CAAC,IAAK,EAAE,QAAQ,EAAE,EAAE,MAAM,EAAE,CAAC,CAAC,KAAK,CAAC,MAAK;;;;AAIrE,YAAA,CAAC,CAAC;QACJ;AACD,KAAA,CAAC;AACJ;AAEA;;;;;;;;AAQG;AACG,SAAU,oBAAoB,CAClC,OAA6C,EAAA;AAE7C,IAAA,MAAM,EAAE,KAAK,EAAE,GAAG,OAAO;AACzB,IAAA,OAAO,CAAC,OAAO,EAAE,QAAQ,KAAK,KAAK,aAAa,CAAC,OAAO,EAAE,QAAQ,EAAE,KAAK,CAAC;AAC5E;AAEA;AACA,SAAS,gBAAgB,CACvB,OAAwB,EACxB,QAAwB,EACxB,OAAwB,EACxB,UAAkB,EAAA;;AAGlB,IAAA,QAAQ,CAAC,QAAQ,GAAG,IAAI;;AAExB,IAAA,QAAQ,CAAC,mBAAmB,GAAG,IAAI;IACnC,QAAQ,CAAC,SAAS,CAACf,kBAAU,CAAC,aAAa,EAAE,CAAC,CAAC;;IAG/C,MAAM,YAAY,GAAG,OAAO,CAAC,OAAO,CAAC,eAAe,CAAC;;IAGrD,IAAI,CAAC,YAAY,IAAI,YAAY,CAAC,MAAM,KAAK,UAAU,CAAC,MAAM,EAAE;;QAE9D,QAAQ,CAAC,SAAS,CAACA,kBAAU,CAAC,eAAe,EAAEC,mBAAW,CAAC,eAAe,CAAC;AAC3E,QAAA,OAAO,KAAK,QAAQ,CAAC,SAAS,CAACG,iBAAU,CAAC,YAAY,CAAC,CAAC,GAAG,EAAE;IAC/D;;;AAIA,IAAA,MAAM,OAAO,GAAG,IAAI,WAAW,EAAE;IACjC,MAAM,cAAc,GAAG,OAAO,CAAC,MAAM,CAAC,YAAY,CAAC;IACnD,MAAM,cAAc,GAAG,OAAO,CAAC,MAAM,CAAC,UAAU,CAAC;AAEjD,IAAA,IACE,cAAc,CAAC,UAAU,KAAK,cAAc,CAAC,UAAU;AACvD,QAAA,CAACY,2BAAe,CAAC,cAAc,EAAE,cAAc,CAAC,EAChD;QACA,QAAQ,CAAC,SAAS,CAAChB,kBAAU,CAAC,eAAe,EAAEC,mBAAW,CAAC,eAAe,CAAC;AAC3E,QAAA,OAAO,KAAK,QAAQ,CAAC,SAAS,CAACG,iBAAU,CAAC,YAAY,CAAC,CAAC,GAAG,EAAE;IAC/D;AAEA,IAAA,OAAO,OAAO,CAAC,OAAO,EAAE,QAAQ,CAAC;AACnC;AAEA;AACM,SAAU,uBAAuB,CACrC,OAAwB,EACxB,SAAgD,EAAA;AAEhD,IAAA,MAAM,UAAU,GAAG,CAAA,OAAA,EAAU,SAAS,EAAE;AACxC,IAAA,OAAO,CAAC,OAAO,EAAE,QAAQ,KACvB,gBAAgB,CAAC,OAAO,EAAE,QAAQ,EAAE,OAAO,EAAE,UAAU,CAAC;AAC5D;;;;;"}
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
import type { RequestListener } from 'node:http';
|
|
2
|
+
import type { PFrameInternal } from '@milaboratories/pl-model-middle-layer';
|
|
3
|
+
/**
|
|
4
|
+
* Create a request handler for serving files from an object store
|
|
5
|
+
* compatible with HTTP/1.1 as defined in RFC 9110 and RFC 9111:
|
|
6
|
+
* - <https://datatracker.ietf.org/doc/html/rfc9110>
|
|
7
|
+
* - <https://datatracker.ietf.org/doc/html/rfc9111>
|
|
8
|
+
*
|
|
9
|
+
* Accepts only paths of the form `/<filename>.parquet`, returns 404 otherwise
|
|
10
|
+
* Assumes that files are immutable (and sets cache headers accordingly)
|
|
11
|
+
*/
|
|
12
|
+
export declare function createRequestHandler(options: PFrameInternal.RequestHandlerOptions): RequestListener;
|
|
13
|
+
/** Apply Bearer token authorization to @param handler */
|
|
14
|
+
export declare function authorizeRequestHandler(handler: RequestListener, authToken: PFrameInternal.HttpAuthorizationToken): RequestListener;
|
|
15
|
+
//# sourceMappingURL=handler.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"handler.d.ts","sourceRoot":"","sources":["../src/handler.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAEV,eAAe,EAEhB,MAAM,WAAW,CAAC;AAGnB,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,uCAAuC,CAAC;AAuI5E;;;;;;;;GAQG;AACH,wBAAgB,oBAAoB,CAClC,OAAO,EAAE,cAAc,CAAC,qBAAqB,GAC5C,eAAe,CAGjB;AA0CD,yDAAyD;AACzD,wBAAgB,uBAAuB,CACrC,OAAO,EAAE,eAAe,EACxB,SAAS,EAAE,cAAc,CAAC,sBAAsB,GAC/C,eAAe,CAIjB"}
|
package/dist/handler.js
ADDED
|
@@ -0,0 +1,154 @@
|
|
|
1
|
+
import { pipeline } from 'node:stream/promises';
|
|
2
|
+
import { timingSafeEqual } from 'node:crypto';
|
|
3
|
+
import { getFilenameFromUrl } from './utils/filename.js';
|
|
4
|
+
import { createETag } from './utils/etag.js';
|
|
5
|
+
import { HeaderName, HeaderValue } from './utils/headers.js';
|
|
6
|
+
import { Options } from './utils/options.js';
|
|
7
|
+
import { parseRange } from './utils/range.js';
|
|
8
|
+
import { isGetOrHead, isGet, isHead } from './utils/method.js';
|
|
9
|
+
import { StatusCode } from './utils/status.js';
|
|
10
|
+
|
|
11
|
+
/** Main request handler for parquet files */
|
|
12
|
+
async function handleRequest(request, response, store) {
|
|
13
|
+
// RFC 9110 section 6.6.1: Date header should be present in all responses
|
|
14
|
+
response.sendDate = true;
|
|
15
|
+
// RFC 9110 section 8.6: Content-Length 0 as default for error responses
|
|
16
|
+
response.strictContentLength = true;
|
|
17
|
+
response.setHeader(HeaderName.ContentLength, 0);
|
|
18
|
+
// Note: setting Content-Length disables Node.js default Transfer-Encoding: chunked
|
|
19
|
+
// RFC 9111 section 5.2: Cache-Control header with public allows to cache authenticated responses
|
|
20
|
+
response.setHeader(HeaderName.CacheControl, HeaderValue.CacheControl);
|
|
21
|
+
// RFC 9110 section 15.5.6: Method not allowed
|
|
22
|
+
const method = request.method;
|
|
23
|
+
if (!isGetOrHead(method)) {
|
|
24
|
+
response.setHeader(HeaderName.Allow, HeaderValue.Allow);
|
|
25
|
+
return void response.writeHead(StatusCode.MethodNotAllowed).end();
|
|
26
|
+
}
|
|
27
|
+
const filename = getFilenameFromUrl(request);
|
|
28
|
+
if (filename === null) {
|
|
29
|
+
return void response.writeHead(StatusCode.Gone).end();
|
|
30
|
+
}
|
|
31
|
+
// From now on we are sure that the response would be a Parquet file
|
|
32
|
+
response.setHeader(HeaderName.AcceptRanges, HeaderValue.AcceptRanges);
|
|
33
|
+
response.setHeader(HeaderName.ContentType, HeaderValue.ContentType);
|
|
34
|
+
// RFC 9110 section 8.8.3: ETag header is used for cache versioning
|
|
35
|
+
const etag = createETag(filename);
|
|
36
|
+
// RFC 9110 section 8.8.2: Last-Modified header field for cache validation
|
|
37
|
+
const mtime = new Date(0); // Using fake fixed date since files are immutable
|
|
38
|
+
// RFC 9111 section 5.2: Cache-Control header with public allows to cache authenticated responses
|
|
39
|
+
response.setHeader(HeaderName.CacheControl, HeaderValue.CacheControl);
|
|
40
|
+
response.setHeader(HeaderName.ETag, etag);
|
|
41
|
+
response.setHeader(HeaderName.LastModified, mtime.toUTCString());
|
|
42
|
+
const options = new Options(request);
|
|
43
|
+
// RFC 9110 section 13.1.1: If-Match precondition evaluation
|
|
44
|
+
// RFC 9110 section 13.1.4: If-Unmodified-Since precondition evaluation
|
|
45
|
+
if (options.preconditionFailed(etag, mtime)) {
|
|
46
|
+
return void response.writeHead(StatusCode.PreconditionFailed).end();
|
|
47
|
+
}
|
|
48
|
+
// RFC 9110 section 13.1.2: If-None-Match precondition evaluation
|
|
49
|
+
// RFC 9110 section 13.1.3: If-Modified-Since precondition evaluation
|
|
50
|
+
else if (options.notModified(etag, mtime)) {
|
|
51
|
+
return void response.writeHead(StatusCode.NotModified).end();
|
|
52
|
+
}
|
|
53
|
+
const range = parseRange(request);
|
|
54
|
+
if (range === null) {
|
|
55
|
+
return void response.writeHead(StatusCode.BadRequest).end();
|
|
56
|
+
}
|
|
57
|
+
const abortController = new AbortController();
|
|
58
|
+
request.on('close', () => abortController.abort());
|
|
59
|
+
const signal = abortController.signal;
|
|
60
|
+
store.request(filename, {
|
|
61
|
+
method: 'GET',
|
|
62
|
+
range,
|
|
63
|
+
signal,
|
|
64
|
+
// pipeline automatically destroys the streams if they were not gracefully closed
|
|
65
|
+
callback: async (result) => {
|
|
66
|
+
if (response.destroyed)
|
|
67
|
+
return void response.destroy();
|
|
68
|
+
switch (result.type) {
|
|
69
|
+
case 'InternalError':
|
|
70
|
+
// object store encountered network error, retry by client can help
|
|
71
|
+
return void response.writeHead(StatusCode.InternalServerError).end();
|
|
72
|
+
case 'NotFound':
|
|
73
|
+
// RFC 9110 section 15.4.5: Not found
|
|
74
|
+
return void response.writeHead(StatusCode.NotFound).end();
|
|
75
|
+
case 'RangeNotSatisfiable':
|
|
76
|
+
// RFC 9110 section 15.5.17: Range not satisfiable
|
|
77
|
+
response.setHeader(HeaderName.ContentRange, `bytes */${result.size}`);
|
|
78
|
+
return void response.writeHead(StatusCode.RangeNotSatisfiable).end();
|
|
79
|
+
}
|
|
80
|
+
if (isGet(method) && !result.data) {
|
|
81
|
+
// object store implementation is incorrect, retry by client cannot help
|
|
82
|
+
return void response.writeHead(StatusCode.GatewayTimeout).end();
|
|
83
|
+
}
|
|
84
|
+
if (range) {
|
|
85
|
+
// RFC 9110 section 14.4: Partial content response
|
|
86
|
+
response.setHeader(HeaderName.ContentLength, result.range.end - result.range.start + 1);
|
|
87
|
+
response.setHeader(HeaderName.ContentRange, `bytes ${result.range.start}-${result.range.end}/${result.size}`);
|
|
88
|
+
response.writeHead(StatusCode.PartialContent);
|
|
89
|
+
}
|
|
90
|
+
else {
|
|
91
|
+
// RFC 9110 section 15.3.1: OK response
|
|
92
|
+
response.setHeader(HeaderName.ContentLength, result.size);
|
|
93
|
+
response.writeHead(StatusCode.Ok);
|
|
94
|
+
}
|
|
95
|
+
// RFC 9110 section 9.3.2: HEAD method must not return message body
|
|
96
|
+
if (isHead(method)) {
|
|
97
|
+
return void response.end();
|
|
98
|
+
}
|
|
99
|
+
return await pipeline(result.data, response, { signal }).catch(() => {
|
|
100
|
+
// Pipeline errors are expected when request is aborted or connection is lost
|
|
101
|
+
// Response head was already written, so we can't change status code
|
|
102
|
+
// Just mute the error - pipeline destroys the response stream
|
|
103
|
+
});
|
|
104
|
+
}
|
|
105
|
+
});
|
|
106
|
+
}
|
|
107
|
+
/**
|
|
108
|
+
* Create a request handler for serving files from an object store
|
|
109
|
+
* compatible with HTTP/1.1 as defined in RFC 9110 and RFC 9111:
|
|
110
|
+
* - <https://datatracker.ietf.org/doc/html/rfc9110>
|
|
111
|
+
* - <https://datatracker.ietf.org/doc/html/rfc9111>
|
|
112
|
+
*
|
|
113
|
+
* Accepts only paths of the form `/<filename>.parquet`, returns 404 otherwise
|
|
114
|
+
* Assumes that files are immutable (and sets cache headers accordingly)
|
|
115
|
+
*/
|
|
116
|
+
function createRequestHandler(options) {
|
|
117
|
+
const { store } = options;
|
|
118
|
+
return (request, response) => void handleRequest(request, response, store);
|
|
119
|
+
}
|
|
120
|
+
/** Request authorization middleware */
|
|
121
|
+
function authorizeRequest(request, response, handler, authHeader) {
|
|
122
|
+
// RFC 9110 section 6.6.1: Date header should be present in all responses
|
|
123
|
+
response.sendDate = true;
|
|
124
|
+
// RFC 9110 section 8.6: Content-Length 0 as default for error responses
|
|
125
|
+
response.strictContentLength = true;
|
|
126
|
+
response.setHeader(HeaderName.ContentLength, 0);
|
|
127
|
+
// Note: setting Content-Length disables Node.js default Transfer-Encoding: chunked
|
|
128
|
+
const actualHeader = request.headers['authorization'];
|
|
129
|
+
// Early length check to avoid unnecessary processing
|
|
130
|
+
if (!actualHeader || actualHeader.length !== authHeader.length) {
|
|
131
|
+
// RFC 9110 section 11.6.1: WWW-Authenticate header field
|
|
132
|
+
response.setHeader(HeaderName.WWWAuthenticate, HeaderValue.WWWAuthenticate);
|
|
133
|
+
return void response.writeHead(StatusCode.Unauthorized).end();
|
|
134
|
+
}
|
|
135
|
+
// Use timing-safe comparison to prevent timing attacks
|
|
136
|
+
// <https://developers.cloudflare.com/workers/examples/protect-against-timing-attacks/>
|
|
137
|
+
const encoder = new TextEncoder();
|
|
138
|
+
const receivedBuffer = encoder.encode(actualHeader);
|
|
139
|
+
const expectedBuffer = encoder.encode(authHeader);
|
|
140
|
+
if (receivedBuffer.byteLength !== expectedBuffer.byteLength ||
|
|
141
|
+
!timingSafeEqual(receivedBuffer, expectedBuffer)) {
|
|
142
|
+
response.setHeader(HeaderName.WWWAuthenticate, HeaderValue.WWWAuthenticate);
|
|
143
|
+
return void response.writeHead(StatusCode.Unauthorized).end();
|
|
144
|
+
}
|
|
145
|
+
return handler(request, response);
|
|
146
|
+
}
|
|
147
|
+
/** Apply Bearer token authorization to @param handler */
|
|
148
|
+
function authorizeRequestHandler(handler, authToken) {
|
|
149
|
+
const authHeader = `Bearer ${authToken}`;
|
|
150
|
+
return (request, response) => authorizeRequest(request, response, handler, authHeader);
|
|
151
|
+
}
|
|
152
|
+
|
|
153
|
+
export { authorizeRequestHandler, createRequestHandler };
|
|
154
|
+
//# sourceMappingURL=handler.js.map
|