/**
* Adds a bookmarkDoc entry into specified index doc.
* NOTE: Assumes the existence of indexed `pageId`.
*
* @param {bool} pageExist PageExist or not.
* @param {string} pageId ID of page doc to associate with.
* @param {object} pageDoc page doc associated with pageId.
* @param {object} bookmarkDoc bookmark doc associated with pageId.
*/
async function addBookmarkDoc(pageExist, pageId, pageDoc, bookmarkDoc) {
if (pageExist) {
return await Promise.all([
index.addBookmarkConcurrent(pageId),
db.put(bookmarkDoc),
])
} else {
return await Promise.all([
await index.addPageConcurrent({
pageDoc: pageDoc,
bookmarkDocs: [bookmarkDoc],
}),
await db.put(bookmarkDoc),
])
}
}
/**
* Creates a page stub in PouchDB (or re-uses existing doc) and attempts to fill it out with current page content
* sourced from browser tab via `page-analysis` module if specified.
*
* @param {number} args.tabId
* @param {string} args.url
* @param {any} args.* Any further static property values to include in stored page.
* @param {boolean} [args.runAnalysis=true] Whether or not to run complex analysis via content script to extract
* further content data.
* @returns {Promise<IPageDoc>} Resolves to the page doc stored, either with basic or post-analysis data depending on
* `runAnalysis` arg.
*/
export default async function storePage({
tabId,
url,
runAnalysis = true,
...pageData
}) {
const pageDocId = generatePageDocId({ url })
let pageDoc
// Ensure at least a stub for this page exists in Pouch, else re-use existing
try {
pageDoc = await db.get(pageDocId)
} catch (error) {
// Create a new page doc stub in the database if not found
if (error.status === 404) {
pageDoc = { _id: pageDocId, url, ...pageData }
await db.put(pageDoc)
} else {
throw error // Can't handle other errors; throw up stack
}
}
// Run analysis if needed
if (runAnalysis) {
pageDoc = await analysePage({ tabId, pageId: pageDoc._id })
}
return pageDoc
}
// Store the visit in PouchDB.
async function storeVisit({timestamp, url, page}) {
const visitId = generateVisitDocId({timestamp})
const visit = {
_id: visitId,
visitStart: timestamp,
url,
page: {_id: page._id}, // store only a reference to the page
}
await db.put(visit)
return {visit}
}