@codesandbox/sandpack-client
Version:
<img style="width:100%" src="https://user-images.githubusercontent.com/4838076/143581035-ebee5ba2-9cb1-4fe8-a05b-2f44bd69bb4b.gif" alt="Component toolkit for live running code editing experiences" />
482 lines • 19.2 kB
JavaScript
;
var __extends = (this && this.__extends) || (function () {
var extendStatics = function (d, b) {
extendStatics = Object.setPrototypeOf ||
({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||
function (d, b) { for (var p in b) if (Object.prototype.hasOwnProperty.call(b, p)) d[p] = b[p]; };
return extendStatics(d, b);
};
return function (d, b) {
if (typeof b !== "function" && b !== null)
throw new TypeError("Class extends value " + String(b) + " is not a constructor or null");
extendStatics(d, b);
function __() { this.constructor = d; }
d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
};
})();
Object.defineProperty(exports, "__esModule", { value: true });
var file_system_1 = require("../core/file_system");
var api_error_1 = require("../core/api_error");
var file_flag_1 = require("../core/file_flag");
var util_1 = require("../core/util");
var node_fs_stats_1 = require("../core/node_fs_stats");
var preload_file_1 = require("../generic/preload_file");
var xhr_1 = require("../generic/xhr");
var fetch_1 = require("../generic/fetch");
var file_index_1 = require("../generic/file_index");
/**
* Try to convert the given buffer into a string, and pass it to the callback.
* Optimization that removes the needed try/catch into a helper function, as
* this is an uncommon case.
* @hidden
*/
function tryToString(buff, encoding, cb) {
try {
cb(null, buff.toString(encoding));
}
catch (e) {
cb(e);
}
}
function syncNotAvailableError() {
throw new api_error_1.ApiError(api_error_1.ErrorCode.ENOTSUP, "Synchronous HTTP download methods are not available in this environment.");
}
/**
* A simple filesystem backed by HTTP downloads. You must create a directory listing using the
* `make_http_index` tool provided by BrowserFS.
*
* If you install BrowserFS globally with `npm i -g browserfs`, you can generate a listing by
* running `make_http_index` in your terminal in the directory you would like to index:
*
* ```
* make_http_index > index.json
* ```
*
* Listings objects look like the following:
*
* ```json
* {
* "home": {
* "jvilk": {
* "someFile.txt": null,
* "someDir": {
* // Empty directory
* }
* }
* }
* }
* ```
*
* *This example has the folder `/home/jvilk` with subfile `someFile.txt` and subfolder `someDir`.*
*/
var BundledHTTPRequest = /** @class */ (function (_super) {
__extends(BundledHTTPRequest, _super);
function BundledHTTPRequest(index, bundle, prefixUrl, preferXHR, logReads) {
if (bundle === void 0) { bundle = {}; }
if (prefixUrl === void 0) { prefixUrl = ''; }
if (preferXHR === void 0) { preferXHR = false; }
if (logReads === void 0) { logReads = false; }
var _this = _super.call(this) || this;
// prefix_url must end in a directory separator.
if (prefixUrl.length > 0 && prefixUrl.charAt(prefixUrl.length - 1) !== '/') {
prefixUrl = prefixUrl + '/';
}
_this.prefixUrl = prefixUrl;
_this._logReads = logReads;
_this._index = file_index_1.FileIndex.fromListing(index);
_this._index.fileIterator(function (file, path) {
var bundleInfo = bundle[path];
if (bundleInfo !== undefined) {
if (typeof bundleInfo === 'number') {
file.size = bundleInfo;
}
else if (!file.fileData) {
var buffer = new Buffer(bundleInfo);
file.size = buffer.length;
file.fileData = buffer;
}
}
});
if (fetch_1.fetchIsAvailable && (!preferXHR || !xhr_1.xhrIsAvailable)) {
_this._requestFileAsyncInternal = fetch_1.fetchFileAsync;
_this._requestFileSizeAsyncInternal = fetch_1.fetchFileSizeAsync;
}
else {
_this._requestFileAsyncInternal = xhr_1.asyncDownloadFile;
_this._requestFileSizeAsyncInternal = xhr_1.getFileSizeAsync;
}
if (xhr_1.xhrIsAvailable) {
_this._requestFileSyncInternal = xhr_1.syncDownloadFile;
_this._requestFileSizeSyncInternal = xhr_1.getFileSizeSync;
}
else {
_this._requestFileSyncInternal = syncNotAvailableError;
_this._requestFileSizeSyncInternal = syncNotAvailableError;
}
return _this;
}
/**
* Construct an HTTPRequest file system backend with the given options.
*/
BundledHTTPRequest.Create = function (opts, cb) {
if (opts.index === undefined) {
opts.index = "index.json";
}
if (typeof (opts.index) === "string") {
(0, xhr_1.asyncDownloadFile)(opts.index, "json", function (e, data) {
if (e) {
cb(e);
}
else {
if (typeof opts.bundle === 'string') {
(0, xhr_1.asyncDownloadFile)(opts.bundle, "json", function (e, bundleData) {
if (e) {
console.error("Couldn't preload bundle", e);
}
cb(null, new BundledHTTPRequest(data, bundleData || {}, opts.baseUrl, opts.preferXHR, opts.logReads));
});
}
else {
cb(null, new BundledHTTPRequest(data, (opts.bundle || {}), opts.baseUrl, opts.preferXHR, opts.logReads));
}
}
});
}
else {
var index_1 = opts.index;
if (typeof opts.bundle === 'string') {
(0, xhr_1.asyncDownloadFile)(opts.bundle, "json", function (e, bundleData) {
if (e) {
console.error("Couldn't preload bundle", e);
}
cb(null, new BundledHTTPRequest(index_1, bundleData || {}, opts.baseUrl, opts.preferXHR, opts.logReads));
});
}
else {
cb(null, new BundledHTTPRequest(index_1, (opts.bundle || {}), opts.baseUrl, opts.preferXHR, opts.logReads));
}
}
};
BundledHTTPRequest.isAvailable = function () {
return xhr_1.xhrIsAvailable || fetch_1.fetchIsAvailable;
};
BundledHTTPRequest.prototype.empty = function () {
this._index.fileIterator(function (file) {
file.fileData = null;
});
};
BundledHTTPRequest.prototype.getName = function () {
return BundledHTTPRequest.Name;
};
BundledHTTPRequest.prototype.diskSpace = function (path, cb) {
// Read-only file system. We could calculate the total space, but that's not
// important right now.
cb(0, 0);
};
BundledHTTPRequest.prototype.isReadOnly = function () {
return true;
};
BundledHTTPRequest.prototype.supportsLinks = function () {
return false;
};
BundledHTTPRequest.prototype.supportsProps = function () {
return false;
};
BundledHTTPRequest.prototype.supportsSynch = function () {
// Synchronous operations are only available via the XHR interface for now.
return xhr_1.xhrIsAvailable;
};
BundledHTTPRequest.prototype.logRead = function (path, content) {
var ctx = (self || global);
ctx.fileReads = ctx.fileReads || {};
if (!ctx.fileReads[path] || typeof ctx.fileReads[path] === 'number') {
ctx.fileReads[path] = content;
}
};
/**
* Special HTTPFS function: Preload the given file into the index.
* @param [String] path
* @param [BrowserFS.Buffer] buffer
*/
BundledHTTPRequest.prototype.preloadFile = function (path, buffer) {
var inode = this._index.getInode(path);
if ((0, file_index_1.isFileInode)(inode)) {
if (inode === null) {
throw api_error_1.ApiError.ENOENT(path);
}
var stats = inode.getData();
stats.size = buffer.length;
stats.fileData = buffer;
}
else {
throw api_error_1.ApiError.EISDIR(path);
}
};
BundledHTTPRequest.prototype.stat = function (path, isLstat, cb) {
var _this = this;
var inode = this._index.getInode(path);
if (inode === null) {
return cb(api_error_1.ApiError.ENOENT(path));
}
var stats;
if ((0, file_index_1.isFileInode)(inode)) {
stats = inode.getData();
// At this point, a non-opened file will still have default stats from the listing.
if (stats.size < 0) {
this._requestFileSizeAsync(path, function (e, size) {
if (e) {
return cb(e);
}
if (_this._logReads) {
// Log the read
_this.logRead(path, size);
}
stats.size = size;
cb(null, node_fs_stats_1.default.clone(stats));
});
}
else {
cb(null, node_fs_stats_1.default.clone(stats));
}
}
else if ((0, file_index_1.isDirInode)(inode)) {
stats = inode.getStats();
cb(null, stats);
}
else {
cb(api_error_1.ApiError.FileError(api_error_1.ErrorCode.EINVAL, path));
}
};
BundledHTTPRequest.prototype.statSync = function (path, isLstat) {
var inode = this._index.getInode(path);
if (inode === null) {
throw api_error_1.ApiError.ENOENT(path);
}
var stats;
if ((0, file_index_1.isFileInode)(inode)) {
stats = inode.getData();
// At this point, a non-opened file will still have default stats from the listing.
if (stats.size < 0) {
var size = this._requestFileSizeSync(path);
if (this._logReads) {
// Log the read
this.logRead(path, size);
}
stats.size = size;
}
}
else if ((0, file_index_1.isDirInode)(inode)) {
stats = inode.getStats();
}
else {
throw api_error_1.ApiError.FileError(api_error_1.ErrorCode.EINVAL, path);
}
return stats;
};
BundledHTTPRequest.prototype.open = function (path, flags, mode, cb) {
// INVARIANT: You can't write to files on this file system.
if (flags.isWriteable()) {
return cb(new api_error_1.ApiError(api_error_1.ErrorCode.EPERM, path));
}
var self = this;
// Check if the path exists, and is a file.
var inode = this._index.getInode(path);
if (inode === null) {
return cb(api_error_1.ApiError.ENOENT(path));
}
if ((0, file_index_1.isFileInode)(inode)) {
var stats_1 = inode.getData();
switch (flags.pathExistsAction()) {
case file_flag_1.ActionType.THROW_EXCEPTION:
case file_flag_1.ActionType.TRUNCATE_FILE:
return cb(api_error_1.ApiError.EEXIST(path));
case file_flag_1.ActionType.NOP:
// Use existing file contents.
// XXX: Uh, this maintains the previously-used flag.
if (stats_1.fileData) {
return cb(null, new preload_file_1.NoSyncFile(self, path, flags, node_fs_stats_1.default.clone(stats_1), stats_1.fileData));
}
// @todo be lazier about actually requesting the file
this._requestFileAsync(path, 'buffer', function (err, buffer) {
if (err) {
return cb(err);
}
// we don't initially have file sizes
stats_1.size = buffer.length;
stats_1.fileData = buffer;
return cb(null, new preload_file_1.NoSyncFile(self, path, flags, node_fs_stats_1.default.clone(stats_1), buffer));
});
break;
default:
return cb(new api_error_1.ApiError(api_error_1.ErrorCode.EINVAL, 'Invalid FileMode object.'));
}
}
else {
return cb(api_error_1.ApiError.EISDIR(path));
}
};
BundledHTTPRequest.prototype.openSync = function (path, flags, mode) {
// INVARIANT: You can't write to files on this file system.
if (flags.isWriteable()) {
throw new api_error_1.ApiError(api_error_1.ErrorCode.EPERM, path);
}
// Check if the path exists, and is a file.
var inode = this._index.getInode(path);
if (inode === null) {
throw api_error_1.ApiError.ENOENT(path);
}
if ((0, file_index_1.isFileInode)(inode)) {
var stats = inode.getData();
switch (flags.pathExistsAction()) {
case file_flag_1.ActionType.THROW_EXCEPTION:
case file_flag_1.ActionType.TRUNCATE_FILE:
throw api_error_1.ApiError.EEXIST(path);
case file_flag_1.ActionType.NOP:
// Use existing file contents.
// XXX: Uh, this maintains the previously-used flag.
if (stats.fileData) {
return new preload_file_1.NoSyncFile(this, path, flags, node_fs_stats_1.default.clone(stats), stats.fileData);
}
// @todo be lazier about actually requesting the file
var buffer = this._requestFileSync(path, 'buffer');
// we don't initially have file sizes
stats.size = buffer.length;
stats.fileData = buffer;
return new preload_file_1.NoSyncFile(this, path, flags, node_fs_stats_1.default.clone(stats), buffer);
default:
throw new api_error_1.ApiError(api_error_1.ErrorCode.EINVAL, 'Invalid FileMode object.');
}
}
else {
throw api_error_1.ApiError.EISDIR(path);
}
};
BundledHTTPRequest.prototype.readdir = function (path, cb) {
try {
cb(null, this.readdirSync(path));
}
catch (e) {
cb(e);
}
};
BundledHTTPRequest.prototype.readdirSync = function (path) {
// Check if it exists.
var inode = this._index.getInode(path);
if (inode === null) {
throw api_error_1.ApiError.ENOENT(path);
}
else if ((0, file_index_1.isDirInode)(inode)) {
return inode.getListing();
}
else {
throw api_error_1.ApiError.ENOTDIR(path);
}
};
/**
* We have the entire file as a buffer; optimize readFile.
*/
BundledHTTPRequest.prototype.readFile = function (fname, encoding, flag, cb) {
var _this = this;
// Wrap cb in file closing code.
var oldCb = cb;
// Get file.
this.open(fname, flag, 0x1a4, function (err, fd) {
if (err) {
return cb(err);
}
cb = function (err, arg) {
fd.close(function (err2) {
if (!err) {
err = err2;
}
return oldCb(err, arg);
});
};
var fdCast = fd;
var fdBuff = fdCast.getBuffer();
if (_this._logReads) {
// Log the read
_this.logRead(fname, fdBuff.toString());
}
if (encoding === null) {
cb(err, (0, util_1.copyingSlice)(fdBuff));
}
else {
tryToString(fdBuff, encoding, cb);
}
});
};
/**
* Specially-optimized readfile.
*/
BundledHTTPRequest.prototype.readFileSync = function (fname, encoding, flag) {
// Get file.
var fd = this.openSync(fname, flag, 0x1a4);
try {
var fdCast = fd;
var fdBuff = fdCast.getBuffer();
if (this._logReads) {
// Log the read
this.logRead(fname, fdBuff.toString());
}
if (encoding === null) {
return (0, util_1.copyingSlice)(fdBuff);
}
return fdBuff.toString(encoding);
}
finally {
fd.closeSync();
}
};
BundledHTTPRequest.prototype._getHTTPPath = function (filePath) {
if (filePath.charAt(0) === '/') {
filePath = filePath.slice(1);
}
return this.prefixUrl + filePath;
};
BundledHTTPRequest.prototype._requestFileAsync = function (p, type, cb) {
this._requestFileAsyncInternal(this._getHTTPPath(p), type, cb);
};
BundledHTTPRequest.prototype._requestFileSync = function (p, type) {
return this._requestFileSyncInternal(this._getHTTPPath(p), type);
};
/**
* Only requests the HEAD content, for the file size.
*/
BundledHTTPRequest.prototype._requestFileSizeAsync = function (path, cb) {
this._requestFileSizeAsyncInternal(this._getHTTPPath(path), cb);
};
BundledHTTPRequest.prototype._requestFileSizeSync = function (path) {
return this._requestFileSizeSyncInternal(this._getHTTPPath(path));
};
BundledHTTPRequest.Name = "BundledHTTPRequest";
BundledHTTPRequest.Options = {
index: {
type: ["string", "object"],
optional: true,
description: "URL to a file index as a JSON file or the file index object itself, generated with the make_http_index script. Defaults to `index.json`."
},
bundle: {
type: ["string", "object"],
optional: true,
description: "URL to a JSON file with the files preloaded."
},
baseUrl: {
type: "string",
optional: true,
description: "Used as the URL prefix for fetched files. Default: Fetch files relative to the index."
},
preferXHR: {
type: "boolean",
optional: true,
description: "Whether to prefer XmlHttpRequest or fetch for async operations if both are available. Default: false"
},
logReads: {
type: "boolean",
optional: true,
description: "Whether to log all reads of files and put them in an object, this is useful for getting initial bundles that you can put in 'bundle' option. Values are put on `global.readFiles`. Default: false."
}
};
return BundledHTTPRequest;
}(file_system_1.BaseFileSystem));
exports.default = BundledHTTPRequest;