From 2bf4f39ca1129c5587b065e222563e09574c3599 Mon Sep 17 00:00:00 2001 From: Laurent Cozic Date: Fri, 5 Jan 2024 14:15:47 +0000 Subject: [PATCH] Chore: Moved search files from "searchengine" namespace to just "search" --- .eslintignore | 22 +++++++++---------- .gitignore | 22 +++++++++---------- .../screens/ConfigScreen/ConfigScreen.tsx | 2 +- .../app-mobile/components/screens/search.tsx | 4 ++-- packages/app-mobile/root.tsx | 2 +- packages/lib/BaseApplication.ts | 4 ++-- packages/lib/migrations/33.js | 2 +- packages/lib/migrations/35.js | 2 +- packages/lib/models/ItemChange.test.ts | 2 +- packages/lib/reducer.ts | 2 +- packages/lib/services/ResourceService.test.ts | 2 +- packages/lib/services/ResourceService.ts | 2 +- packages/lib/services/rest/Api.test.ts | 2 +- packages/lib/services/rest/routes/search.ts | 2 +- .../SearchEngine.resources.test.ts | 0 .../SearchEngine.test.ts | 2 +- .../{searchengine => search}/SearchEngine.ts | 0 .../SearchEngineUtils.test.ts | 6 ++--- .../SearchEngineUtils.ts | 0 .../SearchFilter.test.ts | 8 +++---- .../filterParser.test.ts | 0 .../{searchengine => search}/filterParser.ts | 0 .../gotoAnythingStyleQuery.test.ts | 2 +- .../gotoAnythingStyleQuery.ts | 0 .../{searchengine => search}/queryBuilder.ts | 0 readme/dev/spec/architecture.md | 2 +- 26 files changed, 46 insertions(+), 46 deletions(-) rename packages/lib/services/{searchengine => search}/SearchEngine.resources.test.ts (100%) rename packages/lib/services/{searchengine => search}/SearchEngine.test.ts (99%) rename packages/lib/services/{searchengine => search}/SearchEngine.ts (100%) rename packages/lib/services/{searchengine => search}/SearchEngineUtils.test.ts (95%) rename packages/lib/services/{searchengine => search}/SearchEngineUtils.ts (100%) rename packages/lib/services/{searchengine => search}/SearchFilter.test.ts (99%) rename packages/lib/services/{searchengine => search}/filterParser.test.ts (100%) rename packages/lib/services/{searchengine => search}/filterParser.ts (100%) rename packages/lib/services/{searchengine => search}/gotoAnythingStyleQuery.test.ts (91%) rename packages/lib/services/{searchengine => search}/gotoAnythingStyleQuery.ts (100%) rename packages/lib/services/{searchengine => search}/queryBuilder.ts (100%) diff --git a/.eslintignore b/.eslintignore index 4a1387d6cf..71e5bcb190 100644 --- a/.eslintignore +++ b/.eslintignore @@ -913,17 +913,17 @@ packages/lib/services/rest/utils/paginatedResults.js packages/lib/services/rest/utils/readonlyProperties.js packages/lib/services/rest/utils/requestFields.js packages/lib/services/rest/utils/requestPaginationOptions.js -packages/lib/services/searchengine/SearchEngine.resources.test.js -packages/lib/services/searchengine/SearchEngine.test.js -packages/lib/services/searchengine/SearchEngine.js -packages/lib/services/searchengine/SearchEngineUtils.test.js -packages/lib/services/searchengine/SearchEngineUtils.js -packages/lib/services/searchengine/SearchFilter.test.js -packages/lib/services/searchengine/filterParser.test.js -packages/lib/services/searchengine/filterParser.js -packages/lib/services/searchengine/gotoAnythingStyleQuery.test.js -packages/lib/services/searchengine/gotoAnythingStyleQuery.js -packages/lib/services/searchengine/queryBuilder.js +packages/lib/services/search/SearchEngine.resources.test.js +packages/lib/services/search/SearchEngine.test.js +packages/lib/services/search/SearchEngine.js +packages/lib/services/search/SearchEngineUtils.test.js +packages/lib/services/search/SearchEngineUtils.js +packages/lib/services/search/SearchFilter.test.js +packages/lib/services/search/filterParser.test.js +packages/lib/services/search/filterParser.js +packages/lib/services/search/gotoAnythingStyleQuery.test.js +packages/lib/services/search/gotoAnythingStyleQuery.js +packages/lib/services/search/queryBuilder.js packages/lib/services/share/ShareService.test.js packages/lib/services/share/ShareService.js packages/lib/services/share/reducer.js diff --git a/.gitignore b/.gitignore index 8ad65de246..708de6c1e9 100644 --- a/.gitignore +++ b/.gitignore @@ -893,17 +893,17 @@ packages/lib/services/rest/utils/paginatedResults.js packages/lib/services/rest/utils/readonlyProperties.js packages/lib/services/rest/utils/requestFields.js packages/lib/services/rest/utils/requestPaginationOptions.js -packages/lib/services/searchengine/SearchEngine.resources.test.js -packages/lib/services/searchengine/SearchEngine.test.js -packages/lib/services/searchengine/SearchEngine.js -packages/lib/services/searchengine/SearchEngineUtils.test.js -packages/lib/services/searchengine/SearchEngineUtils.js -packages/lib/services/searchengine/SearchFilter.test.js -packages/lib/services/searchengine/filterParser.test.js -packages/lib/services/searchengine/filterParser.js -packages/lib/services/searchengine/gotoAnythingStyleQuery.test.js -packages/lib/services/searchengine/gotoAnythingStyleQuery.js -packages/lib/services/searchengine/queryBuilder.js +packages/lib/services/search/SearchEngine.resources.test.js +packages/lib/services/search/SearchEngine.test.js +packages/lib/services/search/SearchEngine.js +packages/lib/services/search/SearchEngineUtils.test.js +packages/lib/services/search/SearchEngineUtils.js +packages/lib/services/search/SearchFilter.test.js +packages/lib/services/search/filterParser.test.js +packages/lib/services/search/filterParser.js +packages/lib/services/search/gotoAnythingStyleQuery.test.js +packages/lib/services/search/gotoAnythingStyleQuery.js +packages/lib/services/search/queryBuilder.js packages/lib/services/share/ShareService.test.js packages/lib/services/share/ShareService.js packages/lib/services/share/reducer.js diff --git a/packages/app-mobile/components/screens/ConfigScreen/ConfigScreen.tsx b/packages/app-mobile/components/screens/ConfigScreen/ConfigScreen.tsx index 0b764ba89d..132c584b9d 100644 --- a/packages/app-mobile/components/screens/ConfigScreen/ConfigScreen.tsx +++ b/packages/app-mobile/components/screens/ConfigScreen/ConfigScreen.tsx @@ -2,7 +2,7 @@ import * as React from 'react'; import { Platform, Linking, View, Switch, ScrollView, Text, TouchableOpacity, Alert, PermissionsAndroid, Dimensions, AccessibilityInfo } from 'react-native'; import Setting, { AppType, SettingMetadataSection } from '@joplin/lib/models/Setting'; import NavService from '@joplin/lib/services/NavService'; -import SearchEngine from '@joplin/lib/services/searchengine/SearchEngine'; +import SearchEngine from '@joplin/lib/services/search/SearchEngine'; import checkPermissions from '../../../utils/checkPermissions'; import setIgnoreTlsErrors from '../../../utils/TlsUtils'; import { reg } from '@joplin/lib/registry'; diff --git a/packages/app-mobile/components/screens/search.tsx b/packages/app-mobile/components/screens/search.tsx index 87a1eddc4f..dc0fdcebdd 100644 --- a/packages/app-mobile/components/screens/search.tsx +++ b/packages/app-mobile/components/screens/search.tsx @@ -10,8 +10,8 @@ const { NoteItem } = require('../note-item.js'); const { BaseScreenComponent } = require('../base-screen'); const { themeStyle } = require('../global-style.js'); const DialogBox = require('react-native-dialogbox').default; -import SearchEngineUtils from '@joplin/lib/services/searchengine/SearchEngineUtils'; -import SearchEngine from '@joplin/lib/services/searchengine/SearchEngine'; +import SearchEngineUtils from '@joplin/lib/services/search/SearchEngineUtils'; +import SearchEngine from '@joplin/lib/services/search/SearchEngine'; import { AppState } from '../../utils/types'; import { NoteEntity } from '@joplin/lib/services/database/types'; diff --git a/packages/app-mobile/root.tsx b/packages/app-mobile/root.tsx index 7523684700..88b8cb3e51 100644 --- a/packages/app-mobile/root.tsx +++ b/packages/app-mobile/root.tsx @@ -75,7 +75,7 @@ import { reg } from '@joplin/lib/registry'; const { defaultState } = require('@joplin/lib/reducer'); const { FileApiDriverLocal } = require('@joplin/lib/file-api-driver-local'); import ResourceFetcher from '@joplin/lib/services/ResourceFetcher'; -import SearchEngine from '@joplin/lib/services/searchengine/SearchEngine'; +import SearchEngine from '@joplin/lib/services/search/SearchEngine'; import WelcomeUtils from '@joplin/lib/WelcomeUtils'; const { themeStyle } = require('./components/global-style.js'); import SyncTargetRegistry from '@joplin/lib/SyncTargetRegistry'; diff --git a/packages/lib/BaseApplication.ts b/packages/lib/BaseApplication.ts index 6f00ff45b4..7dd2483872 100644 --- a/packages/lib/BaseApplication.ts +++ b/packages/lib/BaseApplication.ts @@ -38,8 +38,8 @@ const SyncTargetDropbox = require('./SyncTargetDropbox.js'); const SyncTargetAmazonS3 = require('./SyncTargetAmazonS3.js'); import EncryptionService from './services/e2ee/EncryptionService'; import ResourceFetcher from './services/ResourceFetcher'; -import SearchEngineUtils from './services/searchengine/SearchEngineUtils'; -import SearchEngine, { ProcessResultsRow } from './services/searchengine/SearchEngine'; +import SearchEngineUtils from './services/search/SearchEngineUtils'; +import SearchEngine, { ProcessResultsRow } from './services/search/SearchEngine'; import RevisionService from './services/RevisionService'; import ResourceService from './services/ResourceService'; import DecryptionWorker from './services/DecryptionWorker'; diff --git a/packages/lib/migrations/33.js b/packages/lib/migrations/33.js index 96d34ab3f4..b21c4d3118 100644 --- a/packages/lib/migrations/33.js +++ b/packages/lib/migrations/33.js @@ -1,4 +1,4 @@ -const SearchEngine = require('../services/searchengine/SearchEngine').default; +const SearchEngine = require('../services/search/SearchEngine').default; const script = {}; diff --git a/packages/lib/migrations/35.js b/packages/lib/migrations/35.js index 96d34ab3f4..b21c4d3118 100644 --- a/packages/lib/migrations/35.js +++ b/packages/lib/migrations/35.js @@ -1,4 +1,4 @@ -const SearchEngine = require('../services/searchengine/SearchEngine').default; +const SearchEngine = require('../services/search/SearchEngine').default; const script = {}; diff --git a/packages/lib/models/ItemChange.test.ts b/packages/lib/models/ItemChange.test.ts index c589f54e03..5d784d232f 100644 --- a/packages/lib/models/ItemChange.test.ts +++ b/packages/lib/models/ItemChange.test.ts @@ -1,5 +1,5 @@ import { revisionService, setupDatabaseAndSynchronizer, db, switchClient, msleep } from '../testing/test-utils'; -import SearchEngine from '../services/searchengine/SearchEngine'; +import SearchEngine from '../services/search/SearchEngine'; import ResourceService from '../services/ResourceService'; import ItemChangeUtils from '../services/ItemChangeUtils'; import Note from '../models/Note'; diff --git a/packages/lib/reducer.ts b/packages/lib/reducer.ts index ecc6f705b6..d20e5b35f2 100644 --- a/packages/lib/reducer.ts +++ b/packages/lib/reducer.ts @@ -9,7 +9,7 @@ import { ProfileConfig } from './services/profileConfig/types'; import * as ArrayUtils from './ArrayUtils'; import { FolderEntity } from './services/database/types'; import { getListRendererIds } from './services/noteList/renderers'; -import { ProcessResultsRow } from './services/searchengine/SearchEngine'; +import { ProcessResultsRow } from './services/search/SearchEngine'; const fastDeepEqual = require('fast-deep-equal'); const { ALL_NOTES_FILTER_ID } = require('./reserved-ids'); const { createSelectorCreator, defaultMemoize } = require('reselect'); diff --git a/packages/lib/services/ResourceService.test.ts b/packages/lib/services/ResourceService.test.ts index a9f65a5d78..691b79fb22 100644 --- a/packages/lib/services/ResourceService.test.ts +++ b/packages/lib/services/ResourceService.test.ts @@ -6,7 +6,7 @@ import { resourceService, decryptionWorker, supportDir, encryptionService, loadE import Folder from '../models/Folder'; import Note from '../models/Note'; import Resource from '../models/Resource'; -import SearchEngine from '../services/searchengine/SearchEngine'; +import SearchEngine from './search/SearchEngine'; import { loadMasterKeysFromSettings, setupAndEnableEncryption } from './e2ee/utils'; describe('services/ResourceService', () => { diff --git a/packages/lib/services/ResourceService.ts b/packages/lib/services/ResourceService.ts index 99cf75f385..7668db7a97 100644 --- a/packages/lib/services/ResourceService.ts +++ b/packages/lib/services/ResourceService.ts @@ -6,7 +6,7 @@ import shim from '../shim'; import ItemChange from '../models/ItemChange'; import Note from '../models/Note'; import Resource from '../models/Resource'; -import SearchEngine from './searchengine/SearchEngine'; +import SearchEngine from './search/SearchEngine'; import ItemChangeUtils from './ItemChangeUtils'; import time from '../time'; const { sprintf } = require('sprintf-js'); diff --git a/packages/lib/services/rest/Api.test.ts b/packages/lib/services/rest/Api.test.ts index 0792cbee08..5cfabbd65c 100644 --- a/packages/lib/services/rest/Api.test.ts +++ b/packages/lib/services/rest/Api.test.ts @@ -9,7 +9,7 @@ import Note from '../../models/Note'; import Tag from '../../models/Tag'; import NoteTag from '../../models/NoteTag'; import ResourceService from '../../services/ResourceService'; -import SearchEngine from '../../services/searchengine/SearchEngine'; +import SearchEngine from '../search/SearchEngine'; const { MarkupToHtml } = require('@joplin/renderer'); import { ResourceEntity } from '../database/types'; diff --git a/packages/lib/services/rest/routes/search.ts b/packages/lib/services/rest/routes/search.ts index 20bc2f05aa..2641cf0daf 100644 --- a/packages/lib/services/rest/routes/search.ts +++ b/packages/lib/services/rest/routes/search.ts @@ -6,7 +6,7 @@ import requestFields from '../utils/requestFields'; import collectionToPaginatedResults from '../utils/collectionToPaginatedResults'; import BaseItem from '../../../models/BaseItem'; import { NoteEntity } from '../../database/types'; -import SearchEngineUtils, { NotesForQueryOptions } from '../../searchengine/SearchEngineUtils'; +import SearchEngineUtils, { NotesForQueryOptions } from '../../search/SearchEngineUtils'; export default async function(request: Request) { if (request.method !== 'GET') throw new ErrorMethodNotAllowed(); diff --git a/packages/lib/services/searchengine/SearchEngine.resources.test.ts b/packages/lib/services/search/SearchEngine.resources.test.ts similarity index 100% rename from packages/lib/services/searchengine/SearchEngine.resources.test.ts rename to packages/lib/services/search/SearchEngine.resources.test.ts diff --git a/packages/lib/services/searchengine/SearchEngine.test.ts b/packages/lib/services/search/SearchEngine.test.ts similarity index 99% rename from packages/lib/services/searchengine/SearchEngine.test.ts rename to packages/lib/services/search/SearchEngine.test.ts index 120d4eef96..242e6af3b1 100644 --- a/packages/lib/services/searchengine/SearchEngine.test.ts +++ b/packages/lib/services/search/SearchEngine.test.ts @@ -1,5 +1,5 @@ import { setupDatabaseAndSynchronizer, db, sleep, switchClient, msleep } from '../../testing/test-utils'; -import SearchEngine from '../../services/searchengine/SearchEngine'; +import SearchEngine from './SearchEngine'; import Note from '../../models/Note'; import Folder from '../../models/Folder'; import ItemChange from '../../models/ItemChange'; diff --git a/packages/lib/services/searchengine/SearchEngine.ts b/packages/lib/services/search/SearchEngine.ts similarity index 100% rename from packages/lib/services/searchengine/SearchEngine.ts rename to packages/lib/services/search/SearchEngine.ts diff --git a/packages/lib/services/searchengine/SearchEngineUtils.test.ts b/packages/lib/services/search/SearchEngineUtils.test.ts similarity index 95% rename from packages/lib/services/searchengine/SearchEngineUtils.test.ts rename to packages/lib/services/search/SearchEngineUtils.test.ts index 359e0835c3..38f2cb1251 100644 --- a/packages/lib/services/searchengine/SearchEngineUtils.test.ts +++ b/packages/lib/services/search/SearchEngineUtils.test.ts @@ -1,7 +1,7 @@ import { setupDatabaseAndSynchronizer, db, switchClient } from '../../testing/test-utils.js'; -import SearchEngine from '../../services/searchengine/SearchEngine'; -import SearchEngineUtils from '../../services/searchengine/SearchEngineUtils'; -import Setting from '../../models/Setting'; +import SearchEngine from './SearchEngine.js'; +import SearchEngineUtils from './SearchEngineUtils.js'; +import Setting from '../../models/Setting.js'; const Note = require('../../models/Note').default; diff --git a/packages/lib/services/searchengine/SearchEngineUtils.ts b/packages/lib/services/search/SearchEngineUtils.ts similarity index 100% rename from packages/lib/services/searchengine/SearchEngineUtils.ts rename to packages/lib/services/search/SearchEngineUtils.ts diff --git a/packages/lib/services/searchengine/SearchFilter.test.ts b/packages/lib/services/search/SearchFilter.test.ts similarity index 99% rename from packages/lib/services/searchengine/SearchFilter.test.ts rename to packages/lib/services/search/SearchFilter.test.ts index 437eec21e7..c2cfda15f4 100644 --- a/packages/lib/services/searchengine/SearchFilter.test.ts +++ b/packages/lib/services/search/SearchFilter.test.ts @@ -1,14 +1,14 @@ /* @typescript-eslint/prefer-const */ import time from '../../time'; -import { setupDatabaseAndSynchronizer, supportDir, db, createNTestNotes, switchClient } from '../../testing//test-utils'; -import SearchEngine from '../../services/searchengine/SearchEngine'; +import { setupDatabaseAndSynchronizer, supportDir, db, createNTestNotes, switchClient } from '../../testing/test-utils'; +import SearchEngine from './SearchEngine'; import Note from '../../models/Note'; import Folder from '../../models/Folder'; import Tag from '../../models/Tag'; import shim from '../../shim'; -import ResourceService from '../../services/ResourceService'; -import { NoteEntity } from '../../services/database/types'; +import ResourceService from '../ResourceService'; +import { NoteEntity } from '../database/types'; let engine: any = null; diff --git a/packages/lib/services/searchengine/filterParser.test.ts b/packages/lib/services/search/filterParser.test.ts similarity index 100% rename from packages/lib/services/searchengine/filterParser.test.ts rename to packages/lib/services/search/filterParser.test.ts diff --git a/packages/lib/services/searchengine/filterParser.ts b/packages/lib/services/search/filterParser.ts similarity index 100% rename from packages/lib/services/searchengine/filterParser.ts rename to packages/lib/services/search/filterParser.ts diff --git a/packages/lib/services/searchengine/gotoAnythingStyleQuery.test.ts b/packages/lib/services/search/gotoAnythingStyleQuery.test.ts similarity index 91% rename from packages/lib/services/searchengine/gotoAnythingStyleQuery.test.ts rename to packages/lib/services/search/gotoAnythingStyleQuery.test.ts index 3db0b1a409..1db38a23bb 100644 --- a/packages/lib/services/searchengine/gotoAnythingStyleQuery.test.ts +++ b/packages/lib/services/search/gotoAnythingStyleQuery.test.ts @@ -1,6 +1,6 @@ import gotoAnythingStyleQuery from './gotoAnythingStyleQuery'; -describe('searchengine/gotoAnythingStyleQuery', () => { +describe('search/gotoAnythingStyleQuery', () => { it('should prepare queries', () => { const testCases: [string, string][] = [ diff --git a/packages/lib/services/searchengine/gotoAnythingStyleQuery.ts b/packages/lib/services/search/gotoAnythingStyleQuery.ts similarity index 100% rename from packages/lib/services/searchengine/gotoAnythingStyleQuery.ts rename to packages/lib/services/search/gotoAnythingStyleQuery.ts diff --git a/packages/lib/services/searchengine/queryBuilder.ts b/packages/lib/services/search/queryBuilder.ts similarity index 100% rename from packages/lib/services/searchengine/queryBuilder.ts rename to packages/lib/services/search/queryBuilder.ts diff --git a/readme/dev/spec/architecture.md b/readme/dev/spec/architecture.md index 4d0bba6678..0773b3b147 100644 --- a/readme/dev/spec/architecture.md +++ b/readme/dev/spec/architecture.md @@ -16,7 +16,7 @@ The overall architecture for each application is as such: - Back end: This is shared by all applications. It is made of: - - Services: Provide high-level functionalities, such as the [search engine](https://github.com/laurent22/joplin/tree/dev/packages/lib/services/searchengine), [plugin system](https://github.com/laurent22/joplin/tree/dev/packages/lib/services/plugins) or [synchroniser](https://github.com/laurent22/joplin/blob/dev/packages/lib/Synchronizer.ts). + - Services: Provide high-level functionalities, such as the [search engine](https://github.com/laurent22/joplin/tree/dev/packages/lib/services/search), [plugin system](https://github.com/laurent22/joplin/tree/dev/packages/lib/services/plugins) or [synchroniser](https://github.com/laurent22/joplin/blob/dev/packages/lib/Synchronizer.ts). - Models: The model layer sits between the services and database. They provide a higher level abstraction than SQL and utility functions to easily save data, such as notes, notebooks, etc.