Skip to content

Commit

Permalink
feat: make post db recoverable
Browse files Browse the repository at this point in the history
  • Loading branch information
@Jack-Works
Jack-Works committed Dec 19, 2019
1 parent cde7167 commit d989abc
Show file tree
Hide file tree
Showing 3 changed files with 102 additions and 89 deletions.
36 changes: 15 additions & 21 deletions src/database/Persona/Persona.db.ts
View file
Expand Up @@ -6,6 +6,7 @@ import { DBSchema, openDB, IDBPDatabase, IDBPTransaction } from 'idb/with-async-
import { IdentifierMap } from '../IdentifierMap'
import { PrototypeLess, restorePrototype } from '../../utils/type'
import { MessageCenter } from '../../utils/messages'
import { createDBAccess } from '../helpers/openDB'
/**
* Database structure:
*
Expand All @@ -22,27 +23,20 @@ import { MessageCenter } from '../../utils/messages'
* @keys inline, {@link ProfileRecord.identifier}
*/

const db = (function() {
let db: IDBPDatabase<PersonaDB> = undefined as any
return async () => {
OnlyRunInContext('background', 'Persona db')
if (typeof db === 'undefined')
return openDB<PersonaDB>('maskbook-persona', 1, {
upgrade(db, oldVersion, newVersion, transaction) {
function v0_v1() {
db.createObjectStore('personas', { keyPath: 'identifier' })
db.createObjectStore('profiles', { keyPath: 'identifier' })
transaction.objectStore('profiles').createIndex('network', 'network', { unique: false })
transaction
.objectStore('personas')
.createIndex('hasPrivateKey', 'hasPrivateKey', { unique: false })
}
if (oldVersion < 1) v0_v1()
},
}).then(x => (db = x))
else return db
}
})()
const db = createDBAccess(() => {
OnlyRunInContext('background', 'Persona db')
return openDB<PersonaDB>('maskbook-persona', 1, {
upgrade(db, oldVersion, newVersion, transaction) {
function v0_v1() {
db.createObjectStore('personas', { keyPath: 'identifier' })
db.createObjectStore('profiles', { keyPath: 'identifier' })
transaction.objectStore('profiles').createIndex('network', 'network', { unique: false })
transaction.objectStore('personas').createIndex('hasPrivateKey', 'hasPrivateKey', { unique: false })
}
if (oldVersion < 1) v0_v1()
},
})
})

export const PersonaDBAccess = db

Expand Down
11 changes: 11 additions & 0 deletions src/database/helpers/openDB.ts
View file
@@ -0,0 +1,11 @@
import { IDBPDatabase } from 'idb'

export function createDBAccess<DBSchema>(opener: () => Promise<IDBPDatabase<DBSchema>>) {
let db: IDBPDatabase<DBSchema> | undefined = undefined
return async () => {
if (db) return db
db = await opener()
db.addEventListener('close', e => (db = undefined))
return db
}
}
144 changes: 76 additions & 68 deletions src/database/post.ts
View file
@@ -1,10 +1,12 @@
/// <reference path="./global.d.ts" />
import { PostIdentifier, ProfileIdentifier, Identifier, PostIVIdentifier, GroupIdentifier } from './type'
import { openDB, DBSchema } from 'idb/with-async-ittr'
import { openDB, DBSchema, IDBPTransaction, IDBPDatabase } from 'idb/with-async-ittr'
import { restorePrototype, restorePrototypeArray } from '../utils/type'
import { IdentifierMap } from './IdentifierMap'
import { OnlyRunInContext } from '@holoflows/kit/es'
import { createDBAccess } from './helpers/openDB'

function outDb(db: PostDBRecord): PostRecord {
function postOutDB(db: PostDBRecord): PostRecord {
const { identifier, ...rest } = db
for (const key in rest.recipients) {
const detail = rest.recipients[key]
Expand All @@ -18,7 +20,7 @@ function outDb(db: PostDBRecord): PostRecord {
),
}
}
function toDb(out: PostRecord): PostDBRecord {
function postToDB(out: PostRecord): PostDBRecord {
return { ...out, identifier: out.identifier.toText() }
}
export interface PostRecord extends Omit<PostDBRecord, 'identifier'> {
Expand Down Expand Up @@ -98,80 +100,88 @@ interface PostDB extends DBSchema {
key: string
}
}
const db = openDB<PostDB>('maskbook-post-v2', 3, {
async upgrade(db, oldVersion, newVersion, transaction) {
if (oldVersion < 1) {
// inline keys
return void db.createObjectStore('post', { keyPath: 'identifier' })
}
/**
* In the version 1 we use PostIdentifier to store post that identified by post iv
* After upgrade to version 2, we use PostIVIdentifier to store it.
* So we transform all old data into new data.
*/
if (oldVersion <= 1) {
const store = transaction.objectStore('post')
store.getAll().then(values => {
store.clear()
for (const each of values) {
const id = Identifier.fromString(each.identifier, PostIdentifier).value
if (id) {
each.identifier = new PostIVIdentifier(
(id.identifier as ProfileIdentifier).network,
id.postId,
).toText()
const db = createDBAccess(() => {
OnlyRunInContext('background', 'Post db')
return openDB<PostDB>('maskbook-post-v2', 3, {
async upgrade(db, oldVersion, newVersion, transaction) {
if (oldVersion < 1) {
// inline keys
return void db.createObjectStore('post', { keyPath: 'identifier' })
}
/**
* In the version 1 we use PostIdentifier to store post that identified by post iv
* After upgrade to version 2, we use PostIVIdentifier to store it.
* So we transform all old data into new data.
*/
if (oldVersion <= 1) {
const store = transaction.objectStore('post')
store.getAll().then(values => {
store.clear()
for (const each of values) {
const id = Identifier.fromString(each.identifier, PostIdentifier).value
if (id) {
each.identifier = new PostIVIdentifier(
(id.identifier as ProfileIdentifier).network,
id.postId,
).toText()
store.add(each)
}
}
store.add(each)
}
})
}
})
}

/**
* In the version 2 we use `recipients?: ProfileIdentifier[]`
* After upgrade to version 3, we use `recipients: Record<string, RecipientDetail>`
*/
if (oldVersion <= 2) {
const store = transaction.objectStore('post')
for await (const cursor of store) {
const oldType = (cursor.value.recipients as unknown) as ProfileIdentifier[] | undefined
oldType && restorePrototypeArray(oldType, ProfileIdentifier.prototype)
const newType: PostDBRecord['recipients'] = {}
if (oldType !== undefined)
for (const each of oldType) {
newType[each.toText()] = { reason: [{ type: 'direct', at: new Date(0) }] }
/**
* In the version 2 we use `recipients?: ProfileIdentifier[]`
* After upgrade to version 3, we use `recipients: Record<string, RecipientDetail>`
*/
if (oldVersion <= 2) {
const store = transaction.objectStore('post')
for await (const cursor of store) {
const oldType = (cursor.value.recipients as unknown) as ProfileIdentifier[] | undefined
oldType && restorePrototypeArray(oldType, ProfileIdentifier.prototype)
const newType: PostDBRecord['recipients'] = {}
if (oldType !== undefined)
for (const each of oldType) {
newType[each.toText()] = { reason: [{ type: 'direct', at: new Date(0) }] }
}
const next: PostDBRecord = {
...cursor.value,
recipients: newType,
postBy: ProfileIdentifier.unknown,
foundAt: new Date(0),
recipientGroups: [],
}
const next: PostDBRecord = {
...cursor.value,
recipients: newType,
postBy: ProfileIdentifier.unknown,
foundAt: new Date(0),
recipientGroups: [],
cursor.update(next)
}
cursor.update(next)
}
}
},
},
})
})
export async function createPostDB(record: PostRecord) {
const t = (await db).transaction('post', 'readwrite')
const toSave = toDb(record)
export const PostDBAccess = db

type PostTransaction = IDBPTransaction<PostDB, ['post']>
export async function createPostDB(record: PostRecord, t?: PostTransaction) {
t = t || (await db()).transaction('post', 'readwrite')
const toSave = postToDB(record)
await t.objectStore('post').add(toSave)
}
export async function updatePostDB(
updateRecord: Partial<PostRecord> & Pick<PostRecord, 'identifier'>,
mode: 'append' | 'override',
t?: PostTransaction,
): Promise<void> {
t = t || (await db()).transaction('post', 'readwrite')
const emptyRecord: PostRecord = {
identifier: updateRecord.identifier,
recipients: {},
postBy: ProfileIdentifier.unknown,
foundAt: new Date(),
recipientGroups: [],
}
const currentRecord = (await queryPostDB(updateRecord.identifier)) || emptyRecord
const currentRecord = (await queryPostDB(updateRecord.identifier, t)) || emptyRecord
const nextRecord: PostRecord = { ...currentRecord, ...updateRecord }
const nextRecipients: PostDBRecord['recipients'] =
mode === 'override' ? toDb(nextRecord).recipients : toDb(currentRecord).recipients
mode === 'override' ? postToDB(nextRecord).recipients : postToDB(currentRecord).recipients
if (mode === 'append') {
if (updateRecord.recipients) {
for (const [id, detail] of Object.entries(updateRecord.recipients)) {
Expand All @@ -185,22 +195,20 @@ export async function updatePostDB(
}
}
}
const t = (await db).transaction('post', 'readwrite')
const nextRecordInDBType = toDb(nextRecord)
const nextRecordInDBType = postToDB(nextRecord)
await t.objectStore('post').put(nextRecordInDBType)
}
export async function queryPostDB(record: PostIVIdentifier): Promise<PostRecord | null> {
const t = (await db).transaction('post')
export async function queryPostDB(record: PostIVIdentifier, t?: PostTransaction): Promise<PostRecord | null> {
t = t || (await db()).transaction('post')
const result = await t.objectStore('post').get(record.toText())
if (result) return outDb(result)
if (result) return postOutDB(result)
return null
}
export async function queryPostsDB(network: string): Promise<PostRecord[]>
export async function queryPostsDB(query: (data: PostRecord, id: PostIVIdentifier) => boolean): Promise<PostRecord[]>
export async function queryPostsDB(
query: string | ((data: PostRecord, id: PostIVIdentifier) => boolean),
t?: PostTransaction,
): Promise<PostRecord[]> {
const t = (await db).transaction('post')
t = t || (await db()).transaction('post')
const selected: PostRecord[] = []
for await (const { value } of t.store) {
const id = Identifier.fromString(value.identifier, PostIVIdentifier).value
Expand All @@ -209,16 +217,16 @@ export async function queryPostsDB(
continue
}
if (typeof query === 'string') {
if (id.network === query) selected.push(outDb(value))
if (id.network === query) selected.push(postOutDB(value))
} else {
const v = outDb(value)
const v = postOutDB(value)
if (query(v, id)) selected.push(v)
}
}
return selected
}
export async function deletePostCryptoKeyDB(record: PostIVIdentifier) {
const t = (await db).transaction('post', 'readwrite')
export async function deletePostCryptoKeyDB(record: PostIVIdentifier, t?: PostTransaction) {
t = t || (await db()).transaction('post', 'readwrite')
await t.objectStore('post').delete(record.toText())
}

Expand Down

0 comments on commit d989abc

Please sign in to comment.