refactor: move activeSearch to root scope

spraakbanken · Nov 25, 2024 · ae8fab7 · ae8fab7
1 parent 6142f10
commit ae8fab7
Show file tree

Hide file tree

Showing 7 changed files with 24 additions and 41 deletions.
diff --git a/app/scripts/components/frontpage.ts b/app/scripts/components/frontpage.ts
@@ -2,10 +2,8 @@
 import angular from "angular"
 import settings from "@/settings"
 import { RootScope } from "@/root-scope.types"
-import { SearchesService } from "@/services/searches"
 import { html } from "@/util"
 import { isEnabled } from "@/news-service"
-import "@/services/searches"
 import "@/components/corpus-updates"
 import "@/components/newsdesk"
 import "@/components/search-examples"
@@ -35,8 +33,7 @@ export default angular.module("korpApp").component("frontpage", {
     controller: [
         "$rootScope",
         "$scope",
-        "searches",
-        function ($rootScope: RootScope, $scope, searches: SearchesService) {
+        function ($rootScope: RootScope, $scope) {
             const $ctrl = this
             $ctrl.showDescription = false
 
@@ -47,7 +44,7 @@ export default angular.module("korpApp").component("frontpage", {
             $scope.examples = settings.frontpage?.examples
 
             $ctrl.hasResult = () =>
-                searches.activeSearch ||
+                $rootScope.activeSearch ||
                 $rootScope.compareTabs.length ||
                 $rootScope.graphTabs.length ||
                 $rootScope.mapTabs.length

diff --git a/app/scripts/components/results.ts b/app/scripts/components/results.ts
@@ -1,7 +1,6 @@
 /** @format */
 import angular, { IController } from "angular"
 import { html } from "@/util"
-import "@/services/searches"
 import "@/components/korp-error"
 import "@/components/kwic"
 import "@/components/loglike-meter"
@@ -20,7 +19,7 @@ import "@/controllers/text_reader_controller"
 import "@/controllers/trend_diagram_controller"
 import "@/controllers/word_picture_controller"
 import "@/directives/tab-hash"
-import { SearchesService } from "@/services/searches"
+import { RootScope } from "@/root-scope.types"
 
 type ResultsController = IController & {
     onSidebarShow: () => void
@@ -298,12 +297,12 @@ angular.module("korpApp").component("results", {
     `,
     bindings: {},
     controller: [
-        "searches",
-        function (searches: SearchesService) {
+        "$rootScope",
+        function ($rootScope: RootScope) {
             const $ctrl = this as ResultsController
             $ctrl.onSidebarShow = () => ($ctrl.sidebarVisible = true)
             $ctrl.onSidebarHide = () => ($ctrl.sidebarVisible = false)
-            $ctrl.hasResult = () => !!searches.activeSearch
+            $ctrl.hasResult = () => !!$rootScope.activeSearch
         },
     ],
 })
diff --git a/app/scripts/components/search-history.ts b/app/scripts/components/search-history.ts
@@ -7,6 +7,7 @@ import { LocationService, SearchParams } from "@/urlparams"
 import { html, splitFirst, unregescape } from "@/util"
 import angular, { IScope } from "angular"
 import "@/services/search-history"
+import "@/services/searches"
 
 type HistoryScope = IScope & {
     getOptions: () => Option[]

diff --git a/app/scripts/components/simple-search.ts b/app/scripts/components/simple-search.ts
@@ -152,7 +152,7 @@ angular.module("korpApp").component("simpleSearch", {
                 $location.search("isCaseInsensitive", "")
             }
 
-            // triggers watch on searches.activeSearch
+            // triggers watch on activeSearch, via the Searches service
             ctrl.updateSearch = function () {
                 $location.search("in_order", ctrl.freeOrder && ctrl.freeOrderEnabled ? false : null)
                 $location.search("prefix", ctrl.prefix ? true : null)
@@ -161,7 +161,7 @@ angular.module("korpApp").component("simpleSearch", {
                 $location.search("isCaseInsensitive", ctrl.isCaseInsensitive ? true : null)
                 $location.search("within", null)
 
-                // Unset and set query in next time step in order to trigger changes correctly in `searches`.
+                // Unset and set query in next time step in order to trigger changes correctly in the Searches service.
                 $location.search("search", null)
                 $location.replace()
                 $timeout(function () {
@@ -285,12 +285,8 @@ angular.module("korpApp").component("simpleSearch", {
                 })
             }
 
-            // TODO Bad pattern: adding a service to root scope in order to watch a prop on it
-            // TODO Maybe Searches should keep `activeSearch` directly in root scope
-            // @ts-ignore
-            $rootScope.searches = searches
-            $rootScope.$watch("searches.activeSearch", () => {
-                const search = searches.activeSearch
+            $rootScope.$watch("activeSearch", () => {
+                const search = $rootScope.activeSearch
                 if (!search) return
 
                 if (search.type === "word" || search.type === "lemgram") {
@@ -339,7 +335,7 @@ angular.module("korpApp").component("simpleSearch", {
             }
 
             ctrl.doSearch = function () {
-                const search = searches.activeSearch
+                const search = $rootScope.activeSearch
                 ctrl.relatedObj = undefined
                 const cqp = ctrl.getCQP()
                 searches.kwicSearch(cqp)

diff --git a/app/scripts/controllers/word_picture_controller.ts b/app/scripts/controllers/word_picture_controller.ts
@@ -8,8 +8,6 @@ import { RootScope } from "@/root-scope.types"
 import { LocationService } from "@/urlparams"
 import { KorpResponse, ProgressReport } from "@/backend/types"
 import { WordPictureDefItem } from "@/settings/app-settings.types"
-import { SearchesService } from "@/services/searches"
-import "@/services/searches"
 import { TabHashScope } from "@/directives/tab-hash"
 
 type WordpicCtrlScope = TabHashScope & {
@@ -69,14 +67,7 @@ angular.module("korpApp").directive("wordpicCtrl", () => ({
         "$rootScope",
         "$location",
         "$timeout",
-        "searches",
-        (
-            $scope: WordpicCtrlScope,
-            $rootScope: RootScope,
-            $location: LocationService,
-            $timeout: ITimeoutService,
-            searches: SearchesService
-        ) => {
+        ($scope: WordpicCtrlScope, $rootScope: RootScope, $location: LocationService, $timeout: ITimeoutService) => {
             const s = $scope
             s.tabindex = 3
             s.proxy = lemgramProxyFactory.create()
@@ -115,7 +106,7 @@ angular.module("korpApp").directive("wordpicCtrl", () => ({
             s.onProgress = (progressObj) => (s.progress = Math.round(progressObj["stats"]))
 
             s.makeRequest = () => {
-                const search = searches.activeSearch
+                const search = $rootScope.activeSearch
                 if (!s.wordPic || !search || (search.type !== "lemgram" && search.val.includes(" "))) {
                     s.resetView()
                     return

diff --git a/app/scripts/root-scope.types.ts b/app/scripts/root-scope.types.ts
@@ -10,6 +10,11 @@ import { CompareResult, MapRequestResult } from "@/backend/backend"
 /** Extends the Angular Root Scope interface with properties used by this app. */
 export type RootScope = IRootScopeService & {
     _settings: Settings
+    activeSearch: {
+        /** "word", "lemgram" or "cqp" */
+        type: string
+        val: string
+    } | null
     extendedCQP: string | null
     globalFilter: CqpQuery | null
     globalFilterDef: IDeferred<never>

diff --git a/app/scripts/services/searches.ts b/app/scripts/services/searches.ts
@@ -7,11 +7,6 @@ import angular, { IDeferred, IQService, ITimeoutService } from "angular"
 import "@/services/search-history"
 
 export type SearchesService = {
-    activeSearch: {
-        /** "word", "lemgram" or "cqp" */
-        type: string
-        val: string
-    } | null
     /** is resolved when parallel search controller is loaded */
     langDef: IDeferred<never>
     kwicSearch: (cqp: string) => void
@@ -41,19 +36,18 @@ angular.module("korpApp").factory("searches", [
         searchHistory: SearchHistoryService
     ): SearchesService {
         const searches: SearchesService = {
-            activeSearch: null,
             langDef: $q.defer(),
 
             /** Tell result controllers (kwic/statistics/word picture) to send their requests. */
             kwicSearch(cqp: string) {
-                $rootScope.$emit("make_request", cqp, this.activeSearch)
+                $rootScope.$emit("make_request", cqp, $rootScope.activeSearch)
             },
 
             getCqpExpr(): string {
-                if (!this.activeSearch) return ""
-                if (this.activeSearch.type === "word" || this.activeSearch.type === "lemgram")
+                if (!$rootScope.activeSearch) return ""
+                if ($rootScope.activeSearch.type === "word" || $rootScope.activeSearch.type === "lemgram")
                     return $rootScope.simpleCQP || ""
-                return this.activeSearch.val
+                return $rootScope.activeSearch.val
             },
 
             triggerSearch(): void {
@@ -87,7 +81,7 @@ angular.module("korpApp").factory("searches", [
                     }
                     // Update stored search query
                     if (["cqp", "word", "lemgram"].includes(type)) {
-                        searches.activeSearch = { type, val: value }
+                        $rootScope.activeSearch = { type, val: value }
                     }
 
                     // For Extended/Advanced search, merge with global filters and trigger API requests