-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat: added interceptAccessorFactory()
- removed FirestoreDocumentDataAccessor typing from FirestoreDocument - added modifyModelMapFunctions/modifiers to snapshot converter - added AbstractFirestoreDocumentDataAccessorWrapper - added ModifyBeforeSetFirestoreDocumentDataAccessorWrapper and related content - added copyUserRelatedDataAccessorFactoryFunction() - added tests for copyUserRelatedDataAccessorFactoryFunction() usage - added mockItemUser - flattenArray() now uses flat() to flatten, instead of accumulator
- Loading branch information
Showing
16 changed files
with
489 additions
and
36 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
131 changes: 131 additions & 0 deletions
131
packages/firebase/src/lib/common/firestore/accessor/accessor.wrap.modify.ts
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,131 @@ | ||
| import { ArrayOrValue, asArray, mergeModifiers, ModifierFunction, cachedGetter } from '@dereekb/util'; | ||
| import { UserRelated } from '../../../model/user'; | ||
| import { DocumentReferenceRef } from '../reference'; | ||
| import { SetOptionsMerge, SetOptionsMergeFields, DocumentData, PartialWithFieldValue, SetOptions, WithFieldValue } from '../types'; | ||
| import { FirestoreDocumentDataAccessor, FirestoreDocumentDataAccessorSetFunction } from './accessor'; | ||
| import { AbstractFirestoreDocumentDataAccessorWrapper, interceptAccessorFactoryFunction, InterceptAccessorFactoryFunction } from './accessor.wrap'; | ||
|
|
||
| // MARK: Set Wrapper | ||
| export type ModifyBeforeSetFistoreDataAccessorMode = 'always' | 'update' | 'set'; | ||
|
|
||
| /** | ||
| * Input fora ModifyBeforeSetFirestoreDocumentDataAccessorWrapper | ||
| */ | ||
| export interface ModifyBeforeSetFistoreDataAccessorInput<T> extends DocumentReferenceRef<T> { | ||
| /** | ||
| * Data to pass to the modifyAndSet function. | ||
| */ | ||
| readonly data: Partial<T>; | ||
| /** | ||
| * Set options passed to the set function, if available. | ||
| */ | ||
| readonly options?: SetOptions; | ||
| } | ||
|
|
||
| export type ModifyBeforeSetModifierFunction<T> = ModifierFunction<ModifyBeforeSetFistoreDataAccessorInput<T>>; | ||
|
|
||
| export interface ModifyBeforeSetConfig<T extends object> { | ||
| /** | ||
| * When to modify the input data. | ||
| */ | ||
| readonly when: ModifyBeforeSetFistoreDataAccessorMode; | ||
| /** | ||
| * Modifier or array of modifier functions to apply to input data. | ||
| */ | ||
| readonly modifier: ArrayOrValue<ModifyBeforeSetModifierFunction<T>>; | ||
| } | ||
|
|
||
| /** | ||
| * FirestoreDocumentDataAccessorWrapper that applies a modifier function to data being set. When the modifier functions are applied can be changed by the mode. | ||
| */ | ||
| export class ModifyBeforeSetFirestoreDocumentDataAccessorWrapper<T extends object, D = DocumentData> extends AbstractFirestoreDocumentDataAccessorWrapper<T, D> { | ||
| readonly modifier: ModifierFunction<ModifyBeforeSetFistoreDataAccessorInput<T>>; | ||
| readonly set: FirestoreDocumentDataAccessorSetFunction<T>; | ||
|
|
||
| constructor(accessor: FirestoreDocumentDataAccessor<T, D>, readonly config: ModifyBeforeSetConfig<T>) { | ||
| super(accessor); | ||
| const when = config.when; | ||
| this.modifier = mergeModifiers(asArray(config.modifier)); | ||
|
|
||
| let setFn: FirestoreDocumentDataAccessorSetFunction<T>; | ||
|
|
||
| const modifyAndSet: FirestoreDocumentDataAccessorSetFunction<T> = (data: PartialWithFieldValue<T> | WithFieldValue<T>, options?: SetOptions) => { | ||
| const copy = { ...data }; | ||
| const input: ModifyBeforeSetFistoreDataAccessorInput<T> = { | ||
| data: copy, | ||
| documentRef: this.documentRef, | ||
| options | ||
| }; | ||
|
|
||
| this.modifier(input); | ||
| return super.set(input.data, options as SetOptions); | ||
| }; | ||
|
|
||
| switch (when) { | ||
| case 'always': | ||
| setFn = modifyAndSet; | ||
| break; | ||
| case 'set': | ||
| setFn = (data: PartialWithFieldValue<T> | WithFieldValue<T>, options?: SetOptions) => { | ||
| const isSetForNewModel = Boolean(!options); | ||
| if (isSetForNewModel) { | ||
| return modifyAndSet(data); | ||
| } else { | ||
| return super.set(data, options as SetOptions); | ||
| } | ||
| }; | ||
| break; | ||
| case 'update': | ||
| setFn = (data: PartialWithFieldValue<T> | WithFieldValue<T>, options?: SetOptions) => { | ||
| const isUpdateForExistingModel = options && (Boolean((options as SetOptionsMergeFields).mergeFields) || Boolean((options as SetOptionsMerge).merge)); | ||
| if (isUpdateForExistingModel) { | ||
| return modifyAndSet(data); | ||
| } else { | ||
| return super.set(data, options as SetOptions); | ||
| } | ||
| }; | ||
| break; | ||
| } | ||
|
|
||
| this.set = setFn; | ||
| } | ||
| } | ||
|
|
||
| // MARK: Modifier Functions | ||
| /** | ||
| * Creates a ModifyBeforeSetModifierFunction<T> to copy the documentRef's id to the target field on the data. | ||
| * | ||
| * @param fieldName | ||
| * @returns | ||
| */ | ||
| export function copyDocumentIdToFieldModifierFunction<T extends object>(fieldName: keyof T): ModifyBeforeSetModifierFunction<T> { | ||
| return ({ data, documentRef }) => { | ||
| (data as unknown as Record<any, string>)[fieldName] = documentRef.id; // copy the id to the target field | ||
| }; | ||
| } | ||
|
|
||
| export function modifyBeforeSetInterceptAccessorFactoryFunction<T extends object, D = DocumentData>(config: ModifyBeforeSetConfig<T>): InterceptAccessorFactoryFunction<T, D> { | ||
| return interceptAccessorFactoryFunction((accessor) => new ModifyBeforeSetFirestoreDocumentDataAccessorWrapper(accessor, config)); | ||
| } | ||
|
|
||
| // MARK: Templates | ||
| export function copyDocumentIdForUserRelatedModifierFunction<T extends UserRelated>(): ModifyBeforeSetModifierFunction<T> { | ||
| return copyDocumentIdToFieldModifierFunction<T>('uid'); | ||
| } | ||
|
|
||
| /** | ||
| * Returns a pre-configured ModifyBeforeSetConfig<T> for UserRelated models | ||
| * @returns | ||
| */ | ||
| export function copyUserRelatedDataModifierConfig<T extends UserRelated>(): ModifyBeforeSetConfig<T> { | ||
| return { | ||
| when: 'set', | ||
| modifier: copyDocumentIdForUserRelatedModifierFunction() | ||
| }; | ||
| } | ||
|
|
||
| export const COPY_USER_RELATED_DATA_ACCESSOR_FACTORY_FUNCTION = cachedGetter(() => modifyBeforeSetInterceptAccessorFactoryFunction(copyUserRelatedDataModifierConfig())); | ||
|
|
||
| export function copyUserRelatedDataAccessorFactoryFunction<T extends UserRelated, D = DocumentData>(): InterceptAccessorFactoryFunction<T, D> { | ||
| return COPY_USER_RELATED_DATA_ACCESSOR_FACTORY_FUNCTION() as InterceptAccessorFactoryFunction<T, D>; | ||
| } |
53 changes: 53 additions & 0 deletions
53
packages/firebase/src/lib/common/firestore/accessor/accessor.wrap.ts
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,53 @@ | ||
| import { Observable } from 'rxjs'; | ||
| import { DocumentData, DocumentReference, DocumentSnapshot, PartialWithFieldValue, SetOptions, UpdateData, WithFieldValue, WriteResult } from '../types'; | ||
| import { FirestoreDocumentDataAccessor, FirestoreDocumentDataAccessorFactory, FirestoreDocumentDeleteParams, FirestoreDocumentUpdateParams } from './accessor'; | ||
|
|
||
| // MARK: Abstract Wrapper | ||
| /** | ||
| * Abstract wrapper for a FirestoreDocumentDataAccessor. | ||
| * | ||
| * Forwards all non-overridden accessor functions to the wrapped accessor by default. | ||
| */ | ||
| export abstract class AbstractFirestoreDocumentDataAccessorWrapper<T, D = DocumentData> implements FirestoreDocumentDataAccessor<T, D> { | ||
| constructor(readonly accessor: FirestoreDocumentDataAccessor<T, D>) {} | ||
|
|
||
| get documentRef(): DocumentReference<T> { | ||
| return this.accessor.documentRef; | ||
| } | ||
|
|
||
| stream(): Observable<DocumentSnapshot<T>> { | ||
| return this.accessor.stream(); | ||
| } | ||
|
|
||
| get(): Promise<DocumentSnapshot<T>> { | ||
| return this.accessor.get(); | ||
| } | ||
|
|
||
| exists(): Promise<boolean> { | ||
| return this.accessor.exists(); | ||
| } | ||
|
|
||
| delete(params?: FirestoreDocumentDeleteParams): Promise<void | WriteResult> { | ||
| return this.accessor.delete(params); | ||
| } | ||
|
|
||
| set(data: PartialWithFieldValue<T>, options: SetOptions): Promise<WriteResult | void>; | ||
| set(data: WithFieldValue<T>): Promise<WriteResult | void>; | ||
| set(data: PartialWithFieldValue<T> | WithFieldValue<T>, options?: SetOptions): Promise<void | WriteResult> { | ||
| return this.accessor.set(data, options as SetOptions); | ||
| } | ||
|
|
||
| update(data: UpdateData<D>, params?: FirestoreDocumentUpdateParams): Promise<void | WriteResult> { | ||
| return this.update(data, params); | ||
| } | ||
| } | ||
|
|
||
| // MARK: Factory | ||
| export type WrapFirestoreDocumentDataAccessorFunction<T, D = DocumentData> = (input: FirestoreDocumentDataAccessor<T, D>) => FirestoreDocumentDataAccessor<T, D>; | ||
| export type InterceptAccessorFactoryFunction<T, D = DocumentData> = (input: FirestoreDocumentDataAccessorFactory<T, D>) => FirestoreDocumentDataAccessorFactory<T, D>; | ||
|
|
||
| export function interceptAccessorFactoryFunction<T, D = DocumentData>(wrap: WrapFirestoreDocumentDataAccessorFunction<T, D>): InterceptAccessorFactoryFunction<T, D> { | ||
| return (input: FirestoreDocumentDataAccessorFactory<T, D>) => ({ | ||
| accessorFor: (ref) => wrap(input.accessorFor(ref)) | ||
| }); | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.