@sjcrh/proteinpaint-front 2.215.0 → 2.216.1

package/init.js

@@ -36,23 +36,27 @@ const BIN_READY = `${BIN_DIR}/.pp-bundle-ready`
 
 console.log('CWD', CWD)
 try {
-	if (!fs.existsSync(PUBLIC_DIR)) {
-		console.log(`making a public directory at ${CWD}`)
-		fs.mkdirSync(PUBLIC_DIR)
-	}
+	// The public dir and its index.html and cards are optional: when they cannot be added, such as to a public/ mount
+	// that this process cannot write to, the server serves the copies in this package instead (see the server's
+	// serverconfig frontPublicDir and app.middlewares.js), so a failure is a warning, not an error.
+	mayAddToPublic(`make a public directory at ${CWD}`, () => {
+		if (!fs.existsSync(PUBLIC_DIR)) fs.mkdirSync(PUBLIC_DIR)
+	})
 	// index.html / cards are ensured independently of the bundle below (idempotent, and needed even when
 	// the bundle is reused), so a skipped regeneration still leaves the public scaffolding in place.
 	if (!publicBinOnly) {
-		if (!fs.existsSync(`${PUBLIC_DIR}/index.html`)) {
+		mayAddToPublic('create a public/index.html file', () => {
+			if (fs.existsSync(`${PUBLIC_DIR}/index.html`)) return
 			console.log(`creating a public/index.html file`)
 			fs.copyFileSync(path.join(__dirname, './public/index.html'), `${PUBLIC_DIR}/index.html`)
-		}
-		if (!fs.existsSync(`${PUBLIC_DIR}/cards`)) {
+		})
+		mayAddToPublic('copy cards into the public/cards folder', () => {
+			if (fs.existsSync(`${PUBLIC_DIR}/cards`)) return
 			console.log(`Copying cards into public/cards folder`)
 			execSync(`cp -r ${CWD}/node_modules/@sjcrh/proteinpaint-front/public/cards ${PUBLIC_DIR}/cards`, {
 				stdio: 'inherit'
 			})
-		}
+		})
 	}
 
 	// Generate the bundle into CWD/bin only if it isn't already there. CWD/bin is in the container's
@@ -92,3 +96,13 @@ try {
 	console.error(e)
 	throw e
 }
+
+function mayAddToPublic(action, fn) {
+	try {
+		fn()
+	} catch (e) {
+		console.warn(
+			`unable to ${action}, the server serves the proteinpaint-front package copy: ${e.code || e.message || e}`
+		)
+	}
+}

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@sjcrh/proteinpaint-front",
-	"version": "2.215.0",
+	"version": "2.216.1",
 	"browser": "src/app.js",
 	"main": "src/index.js",
 	"bin": "init.js",
@@ -14,7 +14,7 @@
 		"test:integration": "echo 'TODO: front integration tests'"
 	},
 	"devDependencies": {
-		"@sjcrh/proteinpaint-client": "2.215.0",
+		"@sjcrh/proteinpaint-client": "2.216.0",
 		"webpack": "^5.76.0",
 		"webpack-cli": "^4.9.2",
 		"webpack-node-externals": "^3.0.0"
@@ -32,5 +32,5 @@
 		"url": "https://github.com/stjude/proteinpaint",
 		"directory": "front"
 	},
-	"_buildTime": "2026-09-30T14:15:39Z"
+	"_buildTime": "2026-10-03T19:06:51Z"
 }

package/public/cards/BCF.json

@@ -47,6 +47,7 @@
         },
         {
             "label": "Remote BCF file",
+            "configFeature": "ALLOW_remotefilefromurl",
             "download": "https://proteinpaint.stjude.org/ppdemo/hg38/bcf/bcfDemoFiles.tar.gz",
             "message": "If the index file is not available at the same URL or named differently, please include <code>.indexURL</code> in the BCF object.",
             "urlparam": "?genome=hg38&gene=p53&mds3bcfurl=remote,https://proteinpaint.stjude.org/ppdemo/hg38/bcf/test.bcf.gz",

package/public/cards/bedj.json

@@ -299,6 +299,7 @@
         },
         {
             "label": "Remote File",
+            "configFeature": "ALLOW_remotefilefromurl",
             "urlparam": "?block=on&genome=hg19&bedjurl=Remote%20file,https://hgdownload.soe.ucsc.edu/gbdb/hg19/knownGene.bb",
             "runargs": {
                 "parseurl": true,

package/public/cards/bigwig.json

@@ -67,6 +67,7 @@
         },
         {
             "label": "Remote File",
+            "configFeature": "ALLOW_remotefilefromurl",
             "urlparam": "?block=on&genome=hg19&bigwigurl=BigWig%20remote%20file,https://hgdownload.soe.ucsc.edu/goldenPath/hg19/phyloP100way/hg19.100way.phyloP100way.bw",
             "runargs":{
                 "parseurl": true,

package/src/index.js

@@ -1 +1,45 @@
-export { runproteinpaint } from '@sjcrh/proteinpaint-client'
+import { runproteinpaint } from '@sjcrh/proteinpaint-client'
+export { runproteinpaint }
+
+// this entry is only bundled as the PP server's /bin/proteinpaint.js, and so
+// the startup check of this page's client version against the served bundle applies
+runproteinpaint.enableBundleCheck?.()
+mayRetryChunkLoads()
+
+/*
+	Chunk filenames have a content hash (see webpack.config.js). A chunk request may fail when:
+	- a new deployment has replaced the chunks that an already loaded page expects, or
+	- during a rolling deployment, an updated page requests a new chunk from a host that
+	  still serves the previous version
+
+	Retry a failed chunk load, which may reach an updated host in the second case,
+	then notify the user if it still fails.
+*/
+function mayRetryChunkLoads() {
+	// __webpack_require__ is replaced by webpack with its runtime, which has
+	// .e() to load a chunk and .u() to get a chunk's filename
+	if (typeof __webpack_require__ != 'function' || !__webpack_require__.e || !__webpack_require__.u) return
+	const ensureChunk = __webpack_require__.e
+	const getChunkFilename = __webpack_require__.u
+	const retryDelays = [1000, 3000] // milliseconds
+	const retries = {} // {chunkId: number of retries}
+
+	// a retried chunk URL has a query parameter, so that a failed response is not reused from a cache
+	__webpack_require__.u = chunkId => getChunkFilename(chunkId) + (retries[chunkId] ? `?retry=${retries[chunkId]}` : '')
+
+	__webpack_require__.e = async (chunkId, ...args) => {
+		for (let i = 0; ; i++) {
+			try {
+				return await ensureChunk(chunkId, ...args)
+			} catch (e) {
+				if (e?.name != 'ChunkLoadError') throw e
+				if (i >= retryDelays.length) {
+					runproteinpaint.onChunkLoadError?.(e)
+					throw e
+				}
+				retries[chunkId] = i + 1
+				await new Promise(resolve => setTimeout(resolve, retryDelays[i]))
+			}
+		}
+	}
+}