Skip to content

Commit 04e0273

Browse files
posvaposva
committed
refactor(database): reorganize files
1 parent 103b330 commit 04e0273

File tree

6 files changed

+185
-163
lines changed

6 files changed

+185
-163
lines changed

‎src/database/subscribe.ts‎ renamed to ‎src/database/bind.ts‎

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ export interface _DatabaseRefOptions extends _DataSourceOptions {
3737
}
3838

3939
/**
40-
* Global defaults type override options for all database bindings.
40+
* Global defaults type override options for all database bindings. This type remove make some optional values required.
4141
* @internal
4242
*/
4343
interface _DatabaseRefOptionsWithDefaults extends _DatabaseRefOptions {
@@ -59,13 +59,17 @@ const DEFAULT_OPTIONS: _DatabaseRefOptionsWithDefaults = {
5959
wait: true,
6060
}
6161

62-
export { DEFAULT_OPTIONS as databaseOptionsDefaults }
62+
export { DEFAULT_OPTIONS as globalDatabaseOptions }
6363

6464
/**
65-
* Binds a Firebase Database reference as an object
66-
* @param param0
67-
* @param options
68-
* @returns a function to be called to stop listening for changes
65+
* Binds a Firebase database reference or query as an object.
66+
*
67+
* @param target - the target to bind to
68+
* @param document - the document to bind to
69+
* @param resolve - resolve function
70+
* @param reject - reject function
71+
* @param extraOptions - ref binding options
72+
* @returns
6973
*/
7074
export function bindAsObject(
7175
target: Ref<unknown>,

‎src/database/index.ts‎

Lines changed: 8 additions & 152 deletions
Original file line numberDiff line numberDiff line change
@@ -1,163 +1,20 @@
1-
import {
2-
Ref,
3-
ref,
4-
getCurrentScope,
5-
onScopeDispose,
6-
shallowRef,
7-
ShallowRef,
8-
unref,
9-
watch,
10-
isRef,
11-
getCurrentInstance,
12-
onServerPrefetch,
13-
} from 'vue-demi'
1+
import { Ref, ref } from 'vue-demi'
142
import { DatabaseReference, getDatabase, Query } from 'firebase/database'
15-
import {
16-
checkWrittenTarget,
17-
isSSR,
18-
noop,
19-
OperationsType,
20-
ResetOption,
21-
UnbindWithReset,
22-
walkSet,
23-
_MaybeRef,
24-
_Nullable,
25-
_RefWithState,
26-
} from '../shared'
27-
import { databaseUnbinds } from './optionsApi'
28-
import {
29-
bindAsArray,
30-
bindAsObject,
31-
databaseOptionsDefaults,
32-
_DatabaseRefOptions,
33-
} from './subscribe'
3+
import { _MaybeRef, _Nullable, _RefWithState } from '../shared'
4+
import { _DatabaseRefOptions } from './bind'
345
import {
356
VueDatabaseDocumentData,
367
VueDatabaseQueryData,
378
_RefDatabase,
389
} from './utils'
39-
import { addPendingPromise } from '../ssr/plugin'
4010
import { useFirebaseApp } from '../app'
41-
import { getInitialValue } from '../ssr/initialState'
11+
import { UseDatabaseRefOptions, _useDatabaseRef } from './useDatabaseRef'
4212

4313
export { databasePlugin } from './optionsApi'
44-
45-
export interface UseDatabaseRefOptions extends _DatabaseRefOptions {}
46-
47-
export function _useDatabaseRef(
48-
reference: _MaybeRef<_Nullable<DatabaseReference | Query>>,
49-
localOptions: UseDatabaseRefOptions = {}
50-
): _RefDatabase<unknown> {
51-
let unbind!: UnbindWithReset
52-
const options = Object.assign({}, databaseOptionsDefaults, localOptions)
53-
const initialSourceValue = unref(reference)
54-
const data = options.target || ref<unknown | null>()
55-
56-
// dev only warning
57-
if (process.env.NODE_ENV !== 'production') {
58-
// is the target a ref that has already been passed to useDocument() and therefore can't be extended anymore
59-
if (options.target && checkWrittenTarget(data, 'useObject()/useList()')) {
60-
return data as _RefDatabase<unknown>
61-
}
62-
}
63-
64-
// During SSR, we should only get data once
65-
if (isSSR()) {
66-
options.once = true
67-
}
68-
69-
// set the initial value from SSR even if the ref comes from outside
70-
data.value = getInitialValue(initialSourceValue, options.ssrKey, data.value)
71-
72-
const error = ref<Error>()
73-
const pending = ref(true)
74-
// force the type since its value is set right after and undefined isn't possible
75-
const promise = shallowRef() as ShallowRef<Promise<unknown | null>>
76-
const hasCurrentScope = getCurrentScope()
77-
let removePendingPromise = noop
78-
79-
function bindDatabaseRef() {
80-
let referenceValue = unref(reference)
81-
82-
const p = new Promise<unknown | null>((resolve, reject) => {
83-
if (!referenceValue) {
84-
unbind = noop
85-
// resolve to avoid an ever pending promise
86-
return resolve(null)
87-
}
88-
89-
if (Array.isArray(data.value)) {
90-
unbind = bindAsArray(
91-
data as Ref<any>,
92-
referenceValue,
93-
resolve,
94-
reject,
95-
options
96-
)
97-
} else {
98-
unbind = bindAsObject(data, referenceValue, resolve, reject, options)
99-
}
100-
})
101-
102-
promise.value = p
103-
104-
p.catch((reason) => {
105-
error.value = reason
106-
}).finally(() => {
107-
pending.value = false
108-
})
109-
}
110-
111-
let stopWatcher = noop
112-
if (isRef(reference)) {
113-
stopWatcher = watch(reference, bindDatabaseRef, { immediate: true })
114-
} else {
115-
bindDatabaseRef()
116-
}
117-
118-
// only add the first promise to the pending ones
119-
if (initialSourceValue) {
120-
removePendingPromise = addPendingPromise(promise.value, initialSourceValue)
121-
}
122-
123-
if (hasCurrentScope) {
124-
onScopeDispose(stop)
125-
126-
// wait for the promise on SSR
127-
if (getCurrentInstance()) {
128-
onServerPrefetch(() => promise.value)
129-
}
130-
}
131-
132-
function stop(reset: ResetOption = options.reset) {
133-
stopWatcher()
134-
removePendingPromise()
135-
unbind(reset)
136-
}
137-
138-
return Object.defineProperties(data as _RefDatabase<unknown>, {
139-
// allow destructuring without interfering with the ref itself
140-
data: { get: () => data },
141-
error: { get: () => error },
142-
pending: { get: () => pending },
143-
promise: { get: () => promise },
144-
stop: { get: () => stop },
145-
})
146-
}
147-
148-
export function internalUnbind(
149-
key: string,
150-
unbinds: Record<string, UnbindWithReset> | undefined,
151-
reset?: ResetOption
152-
) {
153-
if (unbinds && unbinds[key]) {
154-
unbinds[key](reset)
155-
delete unbinds[key]
156-
}
157-
}
14+
export { globalDatabaseOptions } from './bind'
15+
export type { UseDatabaseRefOptions }
15816

15917
export type UseListOptions = UseDatabaseRefOptions
160-
export type UseObjectOptions = UseDatabaseRefOptions
16118

16219
/**
16320
* Creates a reactive variable connected to the database as an array. Each element in the array will contain an `id`
@@ -178,6 +35,8 @@ export function useList<T = unknown>(
17835
}) as _RefDatabase<VueDatabaseQueryData<T>>
17936
}
18037

38+
export type UseObjectOptions = UseDatabaseRefOptions
39+
18140
/**
18241
* Creates a reactive variable connected to the database as an object. If the reference is a primitive, it will be
18342
* converted to an object containing a `$value` property with the primitive value and an `id` property with the
@@ -197,9 +56,6 @@ export function useObject<T = unknown>(
19756
}) as _RefDatabase<VueDatabaseDocumentData<T>>
19857
}
19958

200-
export const unbind = (target: Ref, reset?: ResetOption) =>
201-
internalUnbind('', databaseUnbinds.get(target), reset)
202-
20359
/**
20460
* Retrieves the Database instance.
20561
*

‎src/database/optionsApi.ts‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,9 @@ import { isVue3 } from 'vue-demi'
55
import { useFirebaseApp } from '../app'
66
import { getGlobalScope } from '../globals'
77
import { ResetOption, UnbindWithReset } from '../shared'
8-
import { internalUnbind, _useDatabaseRef } from './index'
9-
import { _DatabaseRefOptions } from './subscribe'
8+
import { internalUnbind } from './unbind'
9+
import { _DatabaseRefOptions } from './bind'
10+
import { _useDatabaseRef } from './useDatabaseRef'
1011

1112
/**
1213
* Options for the Firebase Database Plugin that enables the Options API such as `$databaseBind` and `$databaseUnbind`.

‎src/database/unbind.ts‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
import type { Ref } from 'vue-demi'
2+
import type { UnbindWithReset, ResetOption } from '../shared'
3+
import { databaseUnbinds } from './optionsApi'
4+
5+
export function internalUnbind(
6+
key: string,
7+
unbinds: Record<string, UnbindWithReset> | undefined,
8+
reset?: ResetOption
9+
) {
10+
if (unbinds && unbinds[key]) {
11+
unbinds[key](reset)
12+
delete unbinds[key]
13+
}
14+
}
15+
16+
export const unbind = (target: Ref, reset?: ResetOption) =>
17+
internalUnbind('', databaseUnbinds.get(target), reset)

‎src/database/useDatabaseRef.ts‎

Lines changed: 138 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,138 @@
1+
import type { DatabaseReference, Query } from 'firebase/database'
2+
import {
3+
unref,
4+
ref,
5+
shallowRef,
6+
ShallowRef,
7+
getCurrentScope,
8+
Ref,
9+
isRef,
10+
watch,
11+
onScopeDispose,
12+
getCurrentInstance,
13+
onServerPrefetch,
14+
} from 'vue-demi'
15+
import {
16+
_MaybeRef,
17+
_Nullable,
18+
UnbindWithReset,
19+
checkWrittenTarget,
20+
isSSR,
21+
noop,
22+
ResetOption,
23+
} from '../shared'
24+
import { getInitialValue } from '../ssr/initialState'
25+
import { addPendingPromise } from '../ssr/plugin'
26+
import {
27+
bindAsArray,
28+
bindAsObject,
29+
globalDatabaseOptions,
30+
_DatabaseRefOptions,
31+
} from './bind'
32+
import { _RefDatabase } from './utils'
33+
34+
/**
35+
* Options when calling `useDatabaseList()` and `useDatabaseObject()`.
36+
*/
37+
export interface UseDatabaseRefOptions extends _DatabaseRefOptions {}
38+
39+
export function _useDatabaseRef(
40+
reference: _MaybeRef<_Nullable<DatabaseReference | Query>>,
41+
localOptions: UseDatabaseRefOptions = {}
42+
): _RefDatabase<unknown> {
43+
let unbind!: UnbindWithReset
44+
const options = Object.assign({}, globalDatabaseOptions, localOptions)
45+
const initialSourceValue = unref(reference)
46+
const data = options.target || ref<unknown | null>()
47+
48+
// dev only warning
49+
if (process.env.NODE_ENV !== 'production') {
50+
// is the target a ref that has already been passed to useDocument() and therefore can't be extended anymore
51+
if (options.target && checkWrittenTarget(data, 'useObject()/useList()')) {
52+
return data as _RefDatabase<unknown>
53+
}
54+
}
55+
56+
// During SSR, we should only get data once
57+
if (isSSR()) {
58+
options.once = true
59+
}
60+
61+
// set the initial value from SSR even if the ref comes from outside
62+
data.value = getInitialValue(initialSourceValue, options.ssrKey, data.value)
63+
64+
const error = ref<Error>()
65+
const pending = ref(true)
66+
// force the type since its value is set right after and undefined isn't possible
67+
const promise = shallowRef() as ShallowRef<Promise<unknown | null>>
68+
const hasCurrentScope = getCurrentScope()
69+
let removePendingPromise = noop
70+
71+
function bindDatabaseRef() {
72+
let referenceValue = unref(reference)
73+
74+
const p = new Promise<unknown | null>((resolve, reject) => {
75+
if (!referenceValue) {
76+
unbind = noop
77+
// resolve to avoid an ever pending promise
78+
return resolve(null)
79+
}
80+
81+
if (Array.isArray(data.value)) {
82+
unbind = bindAsArray(
83+
data as Ref<any>,
84+
referenceValue,
85+
resolve,
86+
reject,
87+
options
88+
)
89+
} else {
90+
unbind = bindAsObject(data, referenceValue, resolve, reject, options)
91+
}
92+
})
93+
94+
promise.value = p
95+
96+
p.catch((reason) => {
97+
error.value = reason
98+
}).finally(() => {
99+
pending.value = false
100+
})
101+
}
102+
103+
let stopWatcher = noop
104+
if (isRef(reference)) {
105+
stopWatcher = watch(reference, bindDatabaseRef, { immediate: true })
106+
} else {
107+
bindDatabaseRef()
108+
}
109+
110+
// only add the first promise to the pending ones
111+
if (initialSourceValue) {
112+
removePendingPromise = addPendingPromise(promise.value, initialSourceValue)
113+
}
114+
115+
if (hasCurrentScope) {
116+
onScopeDispose(stop)
117+
118+
// wait for the promise on SSR
119+
if (getCurrentInstance()) {
120+
onServerPrefetch(() => promise.value)
121+
}
122+
}
123+
124+
function stop(reset: ResetOption = options.reset) {
125+
stopWatcher()
126+
removePendingPromise()
127+
unbind(reset)
128+
}
129+
130+
return Object.defineProperties(data as _RefDatabase<unknown>, {
131+
// allow destructuring without interfering with the ref itself
132+
data: { get: () => data },
133+
error: { get: () => error },
134+
pending: { get: () => pending },
135+
promise: { get: () => promise },
136+
stop: { get: () => stop },
137+
})
138+
}

0 commit comments

Comments
 (0)