Skip to content

Commit

Permalink
Avoid side effects when loading archive (#1169)
Browse files Browse the repository at this point in the history
  • Loading branch information
@Jaifroid
Jaifroid authored Nov 21, 2023
1 parent 120b74c commit e09fe87
Show file tree
Hide file tree
Showing 3 changed files with 39 additions and 32 deletions.
1 change: 1 addition & 0 deletions tests/unit/index.html
View file
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
<!DOCTYPE html>
<html>
<head>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta charset="utf-8">
<base href="../../">
<title>Kiwix-js Unit tests</title>
Expand Down
4 changes: 2 additions & 2 deletions www/js/lib/cache.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -483,9 +483,9 @@ function getItemFromCacheOrZIM (selectedArchive, key, dirEntry) {
// Since there was no result, post UI messages and look up asset in ZIM
if (/\bx?html\b/.test(mimetype) && !resolvedDirEntry.isAsset &&
!/\.(png|gif|jpe?g|svg|css|js|mpe?g|webp|webm|woff2?|eot|mp[43])(\?|$)/i.test(resolvedDirEntry.url)) {
uiUtil.pollSpinner('Loading ' + shortTitle + '...');
uiUtil.spinnerDisplay(true, 'Loading ' + shortTitle + '...');
} else if (/(css|javascript|video|vtt)/i.test(mimetype)) {
uiUtil.pollSpinner('Getting ' + shortTitle + '...');
uiUtil.spinnerDisplayr(true, 'Getting ' + shortTitle + '...');
}
// Set the read function to use according to filetype
var readFile = /\b(?:x?html|css|javascript)\b/i.test(mimetype)
Expand Down
66 changes: 36 additions & 30 deletions www/js/lib/zimArchive.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -74,15 +74,43 @@ var LZ;
function ZIMArchive (storage, path, callbackReady, callbackError) {
var that = this;
that.file = null;
var whenZimReady = function () {
// Add time-critical metadata from the M/ namespace that you need early access to here
// Note that adding metadata here delays the reporting of the ZIM archive as ready
// Further metadata are added in the background below, and can be accessed later
return Promise.all([
that.addMetadataToZIMFile('Creator'),
that.addMetadataToZIMFile('Language')
]).then(function () {
console.debug('ZIMArchive ready, metadata will be added in the background');
// All listings should be loaded, so we can now call the callback
callbackReady(that);
// Add non-time-critical metadata to archive in background so as not to delay opening of the archive
// DEV: Note that it does not make sense to extract illustration (icon) metadata here. Instead, if you implement use of the illustration
// metadata as icons for the loaded ZIM [kiwix-js #886], you should simply use the ZIMArdhive.getMetadata() function when needed
setTimeout(function () {
Promise.all([
that.addMetadataToZIMFile('Counter'),
that.addMetadataToZIMFile('Date'),
that.addMetadataToZIMFile('Description'),
that.addMetadataToZIMFile('Name'),
that.addMetadataToZIMFile('Publisher'),
that.addMetadataToZIMFile('Title')
]).then(function () {
console.debug('ZIMArchive metadata loaded:', that);
});
}, 2000); // DEV: If you need any of the above earlier, you can alter this delay
});
};
var createZimfile = function (fileArray) {
zimfile.fromFileArray(fileArray).then(function (file) {
return zimfile.fromFileArray(fileArray).then(function (file) {
that.file = file;
// Clear the previous libzimWoker
LZ = null;
// Set a global parameter to report the search provider type
params.searchProvider = 'title';
// File has been created, but we need to add any Listings which extend the archive metadata
that.file.setListings([
return that.file.setListings([
// Provide here any Listings for which we need to extract metadata as key:value obects to be added to the file
// 'ptrName' and 'countName' contain the key names to be set in the archive file object
{
Expand All @@ -105,6 +133,7 @@ function ZIMArchive (storage, path, callbackReady, callbackError) {
countName: 'fullTextIndexSize'
}
]).then(function () {
that.libzimReady = null;
// There is currently an exception thrown in the libzim wasm if we attempt to load a split ZIM archive, so we work around
var isSplitZim = /\.zima.$/i.test(that.file._files[0].name);
if (that.file.fullTextIndex && (params.debugLibzimASM || !isSplitZim && typeof Atomics !== 'undefined' &&
Expand All @@ -113,14 +142,15 @@ function ZIMArchive (storage, path, callbackReady, callbackError) {
var libzimReaderType = params.debugLibzimASM || ('WebAssembly' in self ? 'wasm' : 'asm');
console.log('Instantiating libzim ' + libzimReaderType + ' Web Worker...');
LZ = new Worker('js/lib/libzim-' + libzimReaderType + '.js');
that.callLibzimWorker({ action: 'init', files: that.file._files }).then(function (msg) {
// console.debug(msg);
that.callLibzimWorker({ action: 'init', files: that.file._files }).then(function () {
that.libzimReady = 'ready';
params.searchProvider = 'fulltext: ' + libzimReaderType;
// Update the API panel
uiUtil.reportSearchProviderToAPIStatusPanel(params.searchProvider);
}).catch(function (err) {
uiUtil.reportSearchProviderToAPIStatusPanel(params.searchProvider + ': ERROR');
console.error('The libzim worker could not be instantiated!', err);
that.libzimReady = 'error';
});
} else {
// var message = 'Full text searching is not available because ';
Expand All @@ -141,32 +171,8 @@ function ZIMArchive (storage, path, callbackReady, callbackError) {
}
// Set the archive file type ('open' or 'zimit')
that.setZimType();
// Add time-critical metadata from the M/ namespace that you need early access to here
// Note that adding metadata here delays the reporting of the ZIM archive as ready
// Further metadata are added in the background below, and can be accessed later
Promise.all([
that.addMetadataToZIMFile('Creator'),
that.addMetadataToZIMFile('Language')
]).then(function () {
console.debug('ZIMArchive ready, metadata will be added in the background');
// All listings should be loaded, so we can now call the callback
callbackReady(that);
});
// Add non-time-critical metadata to archive in background so as not to delay opening of the archive
// DEV: Note that it does not make sense to extract illustration (icon) metadata here. Instead, if you implement use of the illustration
// metadata as icons for the loaded ZIM [kiwix-js #886], you should simply use the ZIMArdhive.getMetadata() function when needed
setTimeout(function () {
Promise.all([
that.addMetadataToZIMFile('Counter'),
that.addMetadataToZIMFile('Date'),
that.addMetadataToZIMFile('Description'),
that.addMetadataToZIMFile('Name'),
that.addMetadataToZIMFile('Publisher'),
that.addMetadataToZIMFile('Title')
]).then(function () {
console.debug('ZIMArchive metadata loaded:', that);
});
}, 1500);
// If user is not using libzim for reading the file, we can call the ready callback now
if (!params.useLibzim) whenZimReady();
}).catch(function (err) {
console.warn('Error setting archive listings: ', err);
});
Expand Down

0 comments on commit e09fe87

Please sign in to comment.