rmorawski/standardnotes-app-web
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

refactor: blocks plugins (#1956)

Browse Source
This commit is contained in:
Mo
2022-11-08 13:31:48 -06:00
committed by GitHub
parent bfca244061
commit 70a9dbcea6
73 changed files with 1448 additions and 1049 deletions
Download Patch File Download Diff File Expand all files Collapse all files

45
packages/web/src/javascripts/Controllers/LinkingController.spec.ts
View File

@@ -1,4 +1,6 @@
import { isSearchResultAlreadyLinkedToItem } from '@/Utils/Items/Search/isSearchResultAlreadyLinkedToItem'
import { WebApplication } from '@/Application/Application'
import { doesItemMatchSearchQuery } from '@/Utils/Items/Search/doesItemMatchSearchQuery'
import {
AnonymousReference,
ContentReferenceType,
@@ -7,6 +9,7 @@ import {
FileToNoteReference,
InternalEventBus,
SNNote,
ItemsClientInterface,
} from '@standardnotes/snjs'
import { FilesController } from './FilesController'
import { ItemListController } from './ItemList/ItemListController'
@@ -14,6 +17,7 @@ import { LinkingController } from './LinkingController'
import { NavigationController } from './Navigation/NavigationController'
import { SelectedItemsController } from './SelectedItemsController'
import { SubscriptionController } from './Subscription/SubscriptionController'
import { getLinkingSearchResults } from '@/Utils/Items/Search/getSearchResults'
const createNote = (name: string, options?: Partial<SNNote>) => {
return {
@@ -54,6 +58,8 @@ describe('LinkingController', () => {
application.addSingleEventObserver = jest.fn()
application.streamItems = jest.fn()
Object.defineProperty(application, 'items', { value: {} as jest.Mocked<ItemsClientInterface> })
navigationController = {} as jest.Mocked<NavigationController>
selectionController = {} as jest.Mocked<SelectedItemsController>
@@ -74,7 +80,7 @@ describe('LinkingController', () => {
const file = createFile('anotherFile')
const isFileValidResult = linkingController.isValidSearchResult(file, searchQuery)
const isFileValidResult = doesItemMatchSearchQuery(file, searchQuery, application)
expect(isFileValidResult).toBeFalsy()
})
@@ -86,10 +92,10 @@ describe('LinkingController', () => {
const trashed = createFile('test', { trashed: true })
const isArchivedFileValidResult = linkingController.isValidSearchResult(archived, searchQuery)
const isArchivedFileValidResult = doesItemMatchSearchQuery(archived, searchQuery, application)
expect(isArchivedFileValidResult).toBeFalsy()
const isTrashedFileValidResult = linkingController.isValidSearchResult(trashed, searchQuery)
const isTrashedFileValidResult = doesItemMatchSearchQuery(trashed, searchQuery, application)
expect(isTrashedFileValidResult).toBeFalsy()
})
@@ -98,12 +104,11 @@ describe('LinkingController', () => {
const activeItem = createFile('test', { uuid: 'same-uuid' })
Object.defineProperty(itemListController, 'activeControllerItem', { value: activeItem })
application.items.getItems = jest.fn().mockReturnValue([activeItem])
const result = createFile('test', { uuid: 'same-uuid' })
const results = getLinkingSearchResults(searchQuery, application, activeItem)
const isFileValidResult = linkingController.isValidSearchResult(result, searchQuery)
expect(isFileValidResult).toBeFalsy()
expect([...results.unlinkedItems, ...results.linkedItems]).toHaveLength(0)
})
it('should be valid result if it matches query even case insensitive', () => {
@@ -111,13 +116,15 @@ describe('LinkingController', () => {
const file = createFile('TeSt')
const isFileValidResult = linkingController.isValidSearchResult(file, searchQuery)
application.items.getItems = jest.fn().mockReturnValue([file])
const isFileValidResult = doesItemMatchSearchQuery(file, searchQuery, application)
expect(isFileValidResult).toBeTruthy()
})
})
describe('isSearchResultAlreadyLinked', () => {
describe('isSearchResultAlreadyLinkedToItem', () => {
it('should be true if active item & result are same content type & active item references result', () => {
const activeItem = createFile('test', {
uuid: 'active-item',
@@ -130,9 +137,7 @@ describe('LinkingController', () => {
})
const result = createFile('test', { uuid: 'result', references: [] })
Object.defineProperty(itemListController, 'activeControllerItem', { value: activeItem })
const isFileAlreadyLinked = linkingController.isSearchResultAlreadyLinked(result)
const isFileAlreadyLinked = isSearchResultAlreadyLinkedToItem(result, activeItem)
expect(isFileAlreadyLinked).toBeTruthy()
})
@@ -151,9 +156,7 @@ describe('LinkingController', () => {
],
})
Object.defineProperty(itemListController, 'activeControllerItem', { value: activeItem })
const isFileAlreadyLinked = linkingController.isSearchResultAlreadyLinked(result)
const isFileAlreadyLinked = isSearchResultAlreadyLinkedToItem(result, activeItem)
expect(isFileAlreadyLinked).toBeFalsy()
})
@@ -173,9 +176,7 @@ describe('LinkingController', () => {
],
})
Object.defineProperty(itemListController, 'activeControllerItem', { value: activeNote })
const isFileResultAlreadyLinked = linkingController.isSearchResultAlreadyLinked(fileResult)
const isFileResultAlreadyLinked = isSearchResultAlreadyLinkedToItem(fileResult, activeNote)
expect(isFileResultAlreadyLinked).toBeTruthy()
})
@@ -195,9 +196,7 @@ describe('LinkingController', () => {
references: [],
})
Object.defineProperty(itemListController, 'activeControllerItem', { value: activeFile })
const isNoteResultAlreadyLinked = linkingController.isSearchResultAlreadyLinked(noteResult)
const isNoteResultAlreadyLinked = isSearchResultAlreadyLinkedToItem(noteResult, activeFile)
expect(isNoteResultAlreadyLinked).toBeTruthy()
})
@@ -212,9 +211,7 @@ describe('LinkingController', () => {
references: [],
})
Object.defineProperty(itemListController, 'activeControllerItem', { value: activeFile })
const isNoteResultAlreadyLinked = linkingController.isSearchResultAlreadyLinked(noteResult)
const isNoteResultAlreadyLinked = isSearchResultAlreadyLinkedToItem(noteResult, activeFile)
expect(isNoteResultAlreadyLinked).toBeFalsy()
})
})

175
packages/web/src/javascripts/Controllers/LinkingController.tsx
View File

@@ -2,14 +2,14 @@ import { WebApplication } from '@/Application/Application'
import { PopoverFileItemActionType } from '@/Components/AttachedFilesPopover/PopoverFileItemAction'
import { AppPaneId } from '@/Components/ResponsivePane/AppPaneMetadata'
import { PrefDefaults } from '@/Constants/PrefDefaults'
import { createLinkFromItem } from '@/Utils/Items/Search/createLinkFromItem'
import { ItemLink } from '@/Utils/Items/Search/ItemLink'
import { LinkableItem } from '@/Utils/Items/Search/LinkableItem'
import {
ApplicationEvent,
ContentType,
DecryptedItemInterface,
FileItem,
IconType,
InternalEventBus,
ItemContent,
naturalSort,
NoteViewController,
PrefKey,
@@ -26,14 +26,6 @@ import { NavigationController } from './Navigation/NavigationController'
import { SelectedItemsController } from './SelectedItemsController'
import { SubscriptionController } from './Subscription/SubscriptionController'
export type LinkableItem = DecryptedItemInterface<ItemContent>
export type ItemLink<ItemType extends LinkableItem = LinkableItem> = {
id: string
item: ItemType
type: 'linked' | 'linked-by'
}
export class LinkingController extends AbstractViewController {
tags: ItemLink<SNTag>[] = []
linkedFiles: ItemLink<FileItem>[] = []
@@ -142,14 +134,6 @@ export class LinkingController extends AbstractViewController {
this.reloadNotesLinkingToItem()
}
createLinkFromItem = <I extends LinkableItem = LinkableItem>(itemA: I, type: 'linked' | 'linked-by'): ItemLink<I> => {
return {
id: `${itemA.uuid}-${type}`,
item: itemA,
type,
}
}
reloadLinkedFiles() {
if (!this.activeItem || this.application.items.isTemplateItem(this.activeItem)) {
this.linkedFiles = []
@@ -168,11 +152,11 @@ export class LinkingController extends AbstractViewController {
)
if (this.activeItem.content_type === ContentType.File) {
this.linkedFiles = referencesOfActiveItem.map((item) => this.createLinkFromItem(item, 'linked'))
this.filesLinkingToActiveItem = referencingActiveItem.map((item) => this.createLinkFromItem(item, 'linked-by'))
this.linkedFiles = referencesOfActiveItem.map((item) => createLinkFromItem(item, 'linked'))
this.filesLinkingToActiveItem = referencingActiveItem.map((item) => createLinkFromItem(item, 'linked-by'))
} else {
this.linkedFiles = referencingActiveItem.map((item) => this.createLinkFromItem(item, 'linked'))
this.filesLinkingToActiveItem = referencesOfActiveItem.map((item) => this.createLinkFromItem(item, 'linked-by'))
this.linkedFiles = referencingActiveItem.map((item) => createLinkFromItem(item, 'linked'))
this.filesLinkingToActiveItem = referencesOfActiveItem.map((item) => createLinkFromItem(item, 'linked-by'))
}
}
@@ -183,7 +167,7 @@ export class LinkingController extends AbstractViewController {
this.tags = this.application.items
.getSortedTagsForItem(this.activeItem)
.map((item) => this.createLinkFromItem(item, 'linked'))
.map((item) => createLinkFromItem(item, 'linked'))
}
reloadLinkedNotes() {
@@ -195,7 +179,7 @@ export class LinkingController extends AbstractViewController {
this.notesLinkedToItem = naturalSort(
this.application.items.referencesForItem(this.activeItem).filter(isNote),
'title',
).map((item) => this.createLinkFromItem(item, 'linked'))
).map((item) => createLinkFromItem(item, 'linked'))
}
reloadNotesLinkingToItem() {
@@ -207,40 +191,7 @@ export class LinkingController extends AbstractViewController {
this.notesLinkingToActiveItem = naturalSort(
this.application.items.itemsReferencingItem(this.activeItem).filter(isNote),
'title',
).map((item) => this.createLinkFromItem(item, 'linked-by'))
}
getTitleForLinkedTag = (item: LinkableItem) => {
const isTag = item instanceof SNTag
if (!isTag) {
return
}
const titlePrefix = this.application.items.getTagPrefixTitle(item)
const longTitle = this.application.items.getTagLongTitle(item)
return {
titlePrefix,
longTitle,
}
}
getLinkedItemIcon = (item: LinkableItem): [IconType, string] => {
if (item instanceof SNNote) {
const editorForNote = this.application.componentManager.editorForNote(item)
const [icon, tint] = this.application.iconsController.getIconAndTintForNoteType(
editorForNote?.package_info.note_type,
)
const className = `text-accessory-tint-${tint}`
return [icon, className]
} else if (item instanceof FileItem) {
const icon = this.application.iconsController.getIconForFileType(item.mimeType)
return [icon, 'text-info']
} else if (item instanceof SNTag) {
return [item.iconString as IconType, 'text-info']
}
throw new Error('Unhandled case in getLinkedItemIcon')
).map((item) => createLinkFromItem(item, 'linked-by'))
}
activateItem = async (item: LinkableItem): Promise<AppPaneId | undefined> => {
@@ -341,110 +292,4 @@ export class LinkingController extends AbstractViewController {
this.reloadLinkedTags()
this.application.sync.sync().catch(console.error)
}
isValidSearchResult = (item: LinkableItem, searchQuery: string) => {
const title = item instanceof SNTag ? this.application.items.getTagLongTitle(item) : item.title ?? ''
const matchesQuery = title.toLowerCase().includes(searchQuery.toLowerCase())
const isActiveItem = this.activeItem?.uuid === item.uuid
const isArchivedOrTrashed = item.archived || item.trashed
const isValidSearchResult = matchesQuery && !isActiveItem && !isArchivedOrTrashed
return isValidSearchResult
}
isSearchResultAlreadyLinked = (item: LinkableItem) => {
if (!this.activeItem) {
return false
}
let isAlreadyLinked = false
const isItemReferencedByActiveItem = this.activeItem.references.some((ref) => ref.uuid === item.uuid)
const isActiveItemReferencedByItem = item.references.some((ref) => ref.uuid === this.activeItem?.uuid)
if (this.activeItem.content_type === item.content_type) {
isAlreadyLinked = isItemReferencedByActiveItem
} else {
isAlreadyLinked = isActiveItemReferencedByItem || isItemReferencedByActiveItem
}
return isAlreadyLinked
}
isSearchResultExistingTag = (result: DecryptedItemInterface<ItemContent>, searchQuery: string) =>
result.content_type === ContentType.Tag && result.title === searchQuery
getSearchResults = (searchQuery: string) => {
let unlinkedResults: LinkableItem[] = []
const linkedResults: ItemLink<LinkableItem>[] = []
let shouldShowCreateTag = false
const defaultReturnValue = {
linkedResults,
unlinkedResults,
shouldShowCreateTag,
}
if (!searchQuery.length) {
return defaultReturnValue
}
if (!this.activeItem) {
return defaultReturnValue
}
const searchableItems = naturalSort(
this.application.items.getItems([ContentType.Note, ContentType.File, ContentType.Tag]),
'title',
)
const unlinkedTags: LinkableItem[] = []
const unlinkedNotes: LinkableItem[] = []
const unlinkedFiles: LinkableItem[] = []
for (let index = 0; index < searchableItems.length; index++) {
const item = searchableItems[index]
if (!this.isValidSearchResult(item, searchQuery)) {
continue
}
if (this.isSearchResultAlreadyLinked(item)) {
if (linkedResults.length < 20) {
linkedResults.push(this.createLinkFromItem(item, 'linked'))
}
continue
}
if (unlinkedTags.length < 5 && item.content_type === ContentType.Tag) {
unlinkedTags.push(item)
continue
}
if (unlinkedNotes.length < 5 && item.content_type === ContentType.Note) {
unlinkedNotes.push(item)
continue
}
if (unlinkedFiles.length < 5 && item.content_type === ContentType.File) {
unlinkedFiles.push(item)
continue
}
}
unlinkedResults = unlinkedTags.concat(unlinkedNotes).concat(unlinkedFiles)
shouldShowCreateTag =
!linkedResults.find((link) => this.isSearchResultExistingTag(link.item, searchQuery)) &&
!unlinkedResults.find((item) => this.isSearchResultExistingTag(item, searchQuery))
return {
unlinkedResults,
linkedResults,
shouldShowCreateTag,
}
}
}