aboutsummaryrefslogtreecommitdiff
path: root/src/background/completion/impl
diff options
context:
space:
mode:
Diffstat (limited to 'src/background/completion/impl')
-rw-r--r--src/background/completion/impl/BookmarkRepositoryImpl.ts46
-rw-r--r--src/background/completion/impl/HistoryRepositoryImpl.ts55
-rw-r--r--src/background/completion/impl/PrefetchAndCache.ts105
-rw-r--r--src/background/completion/impl/TabRepositoryImpl.ts41
-rw-r--r--src/background/completion/impl/filters.ts68
5 files changed, 315 insertions, 0 deletions
diff --git a/src/background/completion/impl/BookmarkRepositoryImpl.ts b/src/background/completion/impl/BookmarkRepositoryImpl.ts
new file mode 100644
index 0000000..3b80b93
--- /dev/null
+++ b/src/background/completion/impl/BookmarkRepositoryImpl.ts
@@ -0,0 +1,46 @@
+import BookmarkRepository, {BookmarkItem} from "../BookmarkRepository";
+import {HistoryItem} from "../HistoryRepository";
+import PrefetchAndCache from "./PrefetchAndCache";
+
+const COMPLETION_ITEM_LIMIT = 10;
+
+export default class CachedBookmarkRepository implements BookmarkRepository {
+ private bookmarkCache: PrefetchAndCache<BookmarkItem>;
+
+ constructor() {
+ this.bookmarkCache = new PrefetchAndCache(this.getter, this.filter, 10,);
+ }
+
+ queryBookmarks(query: string): Promise<BookmarkItem[]> {
+ return this.bookmarkCache.get(query);
+ }
+
+ private async getter(query: string): Promise<BookmarkItem[]> {
+ const items = await browser.bookmarks.search({query});
+ return items
+ .filter(item => item.title && item.title.length > 0)
+ .filter(item => item.type === 'bookmark' && item.url)
+ .filter((item) => {
+ let url = undefined;
+ try {
+ url = new URL(item.url!!);
+ } catch (e) {
+ return false;
+ }
+ return url.protocol !== 'place:';
+ })
+ .slice(0, COMPLETION_ITEM_LIMIT)
+ .map(item => ({
+ title: item.title!!,
+ url: item.url!!,
+ }));
+ }
+
+ private filter(items: HistoryItem[], query: string) {
+ return items.filter(item => {
+ return query.split(' ').every(keyword => {
+ return item.title.toLowerCase().includes(keyword.toLowerCase()) || item.url!!.includes(keyword)
+ });
+ })
+ };
+}
diff --git a/src/background/completion/impl/HistoryRepositoryImpl.ts b/src/background/completion/impl/HistoryRepositoryImpl.ts
new file mode 100644
index 0000000..cd55cd0
--- /dev/null
+++ b/src/background/completion/impl/HistoryRepositoryImpl.ts
@@ -0,0 +1,55 @@
+import * as filters from "./filters";
+import HistoryRepository, {HistoryItem} from "../HistoryRepository";
+import PrefetchAndCache from "./PrefetchAndCache";
+
+const COMPLETION_ITEM_LIMIT = 10;
+
+export default class CachedHistoryRepository implements HistoryRepository {
+ private historyCache: PrefetchAndCache<browser.history.HistoryItem>;
+
+ constructor() {
+ this.historyCache = new PrefetchAndCache(this.getter, this.filter, 10)
+ }
+
+ async queryHistories(keywords: string): Promise<HistoryItem[]> {
+ const items = await this.historyCache.get(keywords);
+
+ const filterOrKeep = <T>(source: T[], filter: (items: T[]) => T[], min: number): T[] => {
+ const filtered = filter(source);
+ if (filtered.length < min) {
+ return source;
+ }
+ return filtered;
+ };
+
+ return [items]
+ .map(items => filterOrKeep(items, filters.filterByPathname, COMPLETION_ITEM_LIMIT))
+ .map(items => filterOrKeep(items, filters.filterByOrigin, COMPLETION_ITEM_LIMIT))[0]
+ .sort((x, y) => Number(y.visitCount) - Number(x.visitCount))
+ .slice(0, COMPLETION_ITEM_LIMIT)
+ .map(item => ({
+ title: item.title!!,
+ url: item.url!!,
+ }));
+ }
+
+ private async getter (keywords: string): Promise<browser.history.HistoryItem[]> {
+ const items = await browser.history.search({
+ text: keywords,
+ startTime: 0,
+ });
+
+ return [items]
+ .map(filters.filterBlankTitle)
+ .map(filters.filterHttp)
+ .map(filters.filterByTailingSlash)[0]
+ }
+
+ private filter(items: browser.history.HistoryItem[], query: string) {
+ return items.filter(item => {
+ return query.split(' ').every(keyword => {
+ return item.title!!.toLowerCase().includes(keyword.toLowerCase()) || item.url!!.includes(keyword)
+ });
+ })
+ };
+}
diff --git a/src/background/completion/impl/PrefetchAndCache.ts b/src/background/completion/impl/PrefetchAndCache.ts
new file mode 100644
index 0000000..3c074c2
--- /dev/null
+++ b/src/background/completion/impl/PrefetchAndCache.ts
@@ -0,0 +1,105 @@
+type Getter<T> = (query: string) => Promise<T[]>;
+type Filter<T> = (src: T[], query: string) => T[];
+
+const WHITESPACE = /\s/;
+
+// `shortKey` returns a shorten key to pre-fetch completions and store in the
+// cache. The shorten key is generated by the following rules:
+//
+// 1. If the query contains a space in the middle: i.e. the query consists of
+// multiple words, the method removes the last word from the query, and
+// returns joined remaining words with space.
+//
+// 2. If the query is a single word and it's an URL, the method returns a new
+// URL excluding search query with the upper path of the original URL.
+//
+// 3. If the query is a single word and it's not an URL, the method returns a
+// word with the half-length of the original query.
+//
+// Examples:
+//
+// shortKey("hello world good bye")
+// => "hello world good"
+//
+// shortKey("https://example.com/path/to/resource?q=hello")
+// => "https://example.com/path/to/"
+//
+// shortKey("the-query-with-super-long-word")
+// => "the-query-with-"
+//
+export const shortKey = (query: string): string => {
+ if (WHITESPACE.test(query)) {
+ return query.split(WHITESPACE).filter(word => word.length > 0).slice(0, -1).join(' ');
+ }
+ let url;
+ try {
+ url = new URL(query)
+ } catch (e) {
+ return query.slice(0, query.length / 2);
+ }
+
+ if (url.origin === query) {
+ // may be on typing or removing URLs such as "such as https://goog"
+ return query.slice(0, query.length / 2);
+ }
+ if (url.pathname.endsWith('/')) {
+ // remove parameters and move to upper path
+ return new URL('..', url).href;
+ }
+ // remove parameters
+ return new URL('.', url).href;
+};
+
+export default class PrefetchAndCache<T> {
+ private shortKey: string | undefined;
+
+ private shortKeyCache: T[] = [];
+
+ constructor(
+ private getter: Getter<T>,
+ private filter: Filter<T>,
+ private prefetchThrethold: number = 1,
+ ) {
+ }
+
+ async get(query: string): Promise<T[]> {
+ query = query.trim();
+ if (query.length < this.prefetchThrethold) {
+ this.shortKey = undefined;
+ return this.getter(query);
+ }
+
+ if (this.needToRefresh(query)) {
+ this.shortKey = shortKey(query);
+ this.shortKeyCache = await this.getter(this.shortKey);
+ }
+ return this.filter(this.shortKeyCache, query);
+ }
+
+ private needToRefresh(query: string): boolean {
+ if (!this.shortKey) {
+ // no cache
+ return true
+ }
+
+ if (query.length < this.shortKey.length) {
+ // query: "hello"
+ // cache: "hello_world"
+ return true;
+ }
+
+ if (!query.startsWith(this.shortKey)) {
+ // queyr: "hello_w"
+ // shorten: "hello_morning"
+ return true
+ }
+
+ if (query.slice(this.shortKey.length).includes(' ')) {
+ // queyr: "hello x"
+ // shorten: "hello"
+ return true;
+ }
+
+ return false
+ }
+}
diff --git a/src/background/completion/impl/TabRepositoryImpl.ts b/src/background/completion/impl/TabRepositoryImpl.ts
new file mode 100644
index 0000000..adcaba7
--- /dev/null
+++ b/src/background/completion/impl/TabRepositoryImpl.ts
@@ -0,0 +1,41 @@
+import TabRepository, { Tab } from "../TabRepository";
+
+const COMPLETION_ITEM_LIMIT = 10;
+
+export default class TabRepositoryImpl implements TabRepository {
+ async queryTabs(query: string, excludePinned: boolean): Promise<Tab[]> {
+ const tabs = await browser.tabs.query({ currentWindow: true });
+ return tabs
+ .filter((t) => {
+ return t.url && t.url.toLowerCase().includes(query.toLowerCase()) ||
+ t.title && t.title.toLowerCase().includes(query.toLowerCase());
+ })
+ .filter((t) => {
+ return !(excludePinned && t.pinned);
+ })
+ .filter(item => item.id && item.title && item.url)
+ .slice(0, COMPLETION_ITEM_LIMIT)
+ .map(TabRepositoryImpl.toEntity);
+ }
+
+ async getAllTabs(excludePinned: boolean): Promise<Tab[]> {
+ if (excludePinned) {
+ return (await browser.tabs.query({ currentWindow: true, pinned: true }))
+ .map(TabRepositoryImpl.toEntity)
+
+ }
+ return (await browser.tabs.query({ currentWindow: true }))
+ .map(TabRepositoryImpl.toEntity)
+ }
+
+ private static toEntity(tab: browser.tabs.Tab,): Tab {
+ return {
+ id: tab.id!!,
+ url: tab.url!!,
+ active: tab.active,
+ title: tab.title!!,
+ faviconUrl: tab.favIconUrl,
+ index: tab.index,
+ }
+ }
+}
diff --git a/src/background/completion/impl/filters.ts b/src/background/completion/impl/filters.ts
new file mode 100644
index 0000000..3aa56e4
--- /dev/null
+++ b/src/background/completion/impl/filters.ts
@@ -0,0 +1,68 @@
+type Item = browser.history.HistoryItem;
+
+const filterHttp = (items: Item[]): Item[] => {
+ const httpsHosts = items.map(x => new URL(x.url as string))
+ .filter(x => x.protocol === 'https:')
+ .map(x => x.host);
+ const hostsSet = new Set(httpsHosts);
+
+ return items.filter((item: Item) => {
+ const url = new URL(item.url as string);
+ return url.protocol === 'https:' || !hostsSet.has(url.host);
+ });
+};
+
+const filterBlankTitle = (items: Item[]): Item[] => {
+ return items.filter(item => item.title && item.title !== '');
+};
+
+const filterByTailingSlash = (items: Item[]): Item[] => {
+ const urls = items.map(item => new URL(item.url as string));
+ const simplePaths = urls
+ .filter(url => url.hash === '' && url.search === '')
+ .map(url => url.origin + url.pathname);
+ const pathsSet = new Set(simplePaths);
+
+ return items.filter((item) => {
+ const url = new URL(item.url as string);
+ if (url.hash !== '' || url.search !== '' ||
+ url.pathname.slice(-1) !== '/') {
+ return true;
+ }
+ return !pathsSet.has(url.origin + url.pathname.slice(0, -1));
+ });
+};
+
+const filterByPathname = (items: Item[]): Item[] => {
+ const hash: {[key: string]: Item} = {};
+ for (const item of items) {
+ const url = new URL(item.url as string);
+ const pathname = url.origin + url.pathname;
+ if (!hash[pathname]) {
+ hash[pathname] = item;
+ } else if ((hash[pathname].url as string).length >
+ (item.url as string).length) {
+ hash[pathname] = item;
+ }
+ }
+ return Object.values(hash);
+};
+
+const filterByOrigin = (items: Item[]): Item[] => {
+ const hash: {[key: string]: Item} = {};
+ for (const item of items) {
+ const origin = new URL(item.url as string).origin;
+ if (!hash[origin]) {
+ hash[origin] = item;
+ } else if ((hash[origin].url as string).length >
+ (item.url as string).length) {
+ hash[origin] = item;
+ }
+ }
+ return Object.values(hash);
+};
+
+export {
+ filterHttp, filterBlankTitle, filterByTailingSlash,
+ filterByPathname, filterByOrigin
+};