From 01cb23f56621e888caefb7de07094fea6890ef95 Mon Sep 17 00:00:00 2001
From: David Sehnal <dsehnal@users.noreply.github.com>
Date: Mon, 20 Mar 2023 09:24:45 +0100
Subject: [PATCH] add setFSModule (#755)
---
CHANGELOG.md | 1 +
src/examples/image-renderer/index.ts | 3 +++
src/mol-util/data-source.ts | 15 +++++++++------
3 files changed, 13 insertions(+), 6 deletions(-)
diff --git a/CHANGELOG.md b/CHANGELOG.md
index 2a9286f9e..b065baa57 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -16,6 +16,7 @@ Note that since we don't clearly distinguish between a public and private interf
- Add exposure parameter to renderer
- Only trigger marking when mouse is directly over canvas
- Fix blurry occlusion in screenshots
+- [breaking] Add `setFSModule` to `mol-util/data-source` instead of trying to trick WebPack
## [v3.31.4] - 2023-02-24
diff --git a/src/examples/image-renderer/index.ts b/src/examples/image-renderer/index.ts
index 4acaa96cd..a4f696111 100644
--- a/src/examples/image-renderer/index.ts
+++ b/src/examples/image-renderer/index.ts
@@ -19,8 +19,11 @@ import { StructureRepresentation3D } from '../../mol-plugin-state/transforms/rep
import { HeadlessPluginContext } from '../../mol-plugin/headless-plugin-context';
import { DefaultPluginSpec } from '../../mol-plugin/spec';
import { STYLIZED_POSTPROCESSING } from '../../mol-plugin/util/headless-screenshot';
+import { setFSModule } from '../../mol-util/data-source';
+setFSModule(fs);
+
interface Args {
pdbId: string,
outDirectory: string
diff --git a/src/mol-util/data-source.ts b/src/mol-util/data-source.ts
index 3d66dbf74..759e5b644 100644
--- a/src/mol-util/data-source.ts
+++ b/src/mol-util/data-source.ts
@@ -300,14 +300,17 @@ function ajaxGetInternal<T extends DataType>(title: string | undefined, url: str
});
}
-// NOTE: lazy imports cannot be used here because WebPack complains since this
-// is part of the "browser" build.
+// NOTE: a workaround for using this in Node.js
let _fs: (typeof import ('fs')) | undefined = undefined;
function getFS() {
- if (_fs) return _fs!;
- const req = require; // To fool webpack
- _fs = req('fs');
- return _fs!;
+ if (!_fs) {
+ throw new Error('When running in Node.js and reading from files, call mol-util/data-source\'s setFSModule function first.');
+ }
+ return _fs;
+}
+
+export function setFSModule(fs: typeof import ('fs')) {
+ _fs = fs;
}
/** Alternative implementation of ajaxGetInternal (because xhr2 does not support file:// protocol) */
--
GitLab