Catalog search provider

CHANGES.md

@@ -9,6 +9,8 @@
   - Upgrade babel packages to latest versions (7.28.0/7.29.0).
   - Upgrade webpack to version 5.105.4.
 - Upgrade eslint to v10 and migrate to eslint flat config.
+- We no longer start terriajs-server when running `yarn gulp dev` as it is not needed for running tests in the browser with jasmine-browser-runner. If you need terriajs-server, you can start it separately by running `yarn gulp terriajs-server` in another terminal.
+- Move catalog-search-provider instance from SearchBarModel to Catalog class.
 
 #### 8.12.2 - 2026-03-27
 

gulpfile.js

@@ -292,9 +292,9 @@ serveTests.description =
   "Start jasmine-browser-runner server for interactive testing.";
 serveTests.displayName = "serve-tests";
 
-const dev = gulp.parallel(terriajsServer, watch, serveTests);
+const dev = gulp.parallel(watch, serveTests);
 dev.description =
-  "Start TerriaJS server, watch for source changes, and serve tests.";
+  "Watch for source changes, and serve tests with jasmine-browser-runner.";
 
 const postNpmInstall = copyCesiumAssets;
 postNpmInstall.description = "Copy Cesium assets after installation.";

lib/Models/Catalog/Catalog.ts

@@ -7,18 +7,33 @@ import Terria from "../Terria";
 import Group from "./Group";
 import { BaseModel } from "../Definition/Model";
 import isDefined from "../../Core/isDefined";
+import CatalogSearchProviderMixin from "../../ModelMixins/SearchProviders/CatalogSearchProviderMixin";
+import CatalogSearchProvider from "../SearchProviders/CatalogSearchProvider";
 
 export default class Catalog {
   @observable
   group: Group & BaseModel;
 
+  @observable
+  searchProvider: CatalogSearchProviderMixin.Instance | undefined;
+
   readonly terria: Terria;
 
   private _disposeCreateUserAddedGroup: () => void;
 
-  constructor(terria: Terria) {
+  constructor(
+    terria: Terria,
+    searchProvider?: CatalogSearchProviderMixin.Instance
+  ) {
     makeObservable(this);
     this.terria = terria;
+    this.searchProvider =
+      searchProvider ??
+      new CatalogSearchProvider(
+        "catalog-search-provider",
+        terria,
+        terria.searchBarModel.minCharacters
+      );
     this.group = new CatalogGroup("/", this.terria);
     this.terria.addModel(this.group);
 

lib/Models/SearchProviders/CatalogSearchProvider.ts

@@ -110,16 +110,12 @@ export default class CatalogSearchProvider extends CatalogSearchProviderMixin(
   @observable isSearching: boolean = false;
   @observable debounceDurationOnceLoaded: number = 300;
 
-  constructor(id: string | undefined, terria: Terria) {
+  constructor(id: string | undefined, terria: Terria, minCharacters?: number) {
     super(id, terria);
 
     makeObservable(this);
 
-    this.setTrait(
-      CommonStrata.defaults,
-      "minCharacters",
-      terria.searchBarModel.minCharacters
-    );
+    this.setTrait(CommonStrata.defaults, "minCharacters", minCharacters);
   }
 
   get type() {

lib/Models/SearchProviders/SearchBarModel.ts

@@ -10,7 +10,6 @@ import RuntimeError from "terriajs-cesium/Source/Core/RuntimeError";
 import { JsonObject } from "../../Core/Json";
 import Result from "../../Core/Result";
 import TerriaError from "../../Core/TerriaError";
-import CatalogSearchProviderMixin from "../../ModelMixins/SearchProviders/CatalogSearchProviderMixin";
 import LocationSearchProviderMixin from "../../ModelMixins/SearchProviders/LocationSearchProviderMixin";
 import { SearchBarTraits } from "../../Traits/SearchProviders/SearchBarTraits";
 import SearchProviderTraits from "../../Traits/SearchProviders/SearchProviderTraits";
@@ -26,9 +25,6 @@ import upsertSearchProviderFromJson from "./upsertSearchProviderFromJson";
 export class SearchBarModel extends CreateModel(SearchBarTraits) {
   private locationSearchProviders = observable.map<string, BaseModel>();
 
-  @observable
-  catalogSearchProvider: CatalogSearchProviderMixin.Instance | undefined;
-
   constructor(readonly terria: Terria) {
     super("search-bar-model", terria);
 

lib/Models/Terria.ts

@@ -459,9 +459,9 @@ export default class Terria {
   readonly indeterminateTileLoadProgressEvent = new CesiumEvent();
   readonly workbench = new Workbench();
   readonly overlays = new Workbench();
-  readonly catalog = new Catalog(this);
   readonly baseMapsModel = new BaseMapsModel("basemaps", this);
   readonly searchBarModel = new SearchBarModel(this);
+  readonly catalog = new Catalog(this);
   readonly timelineClock = new Clock({ shouldAnimate: false });
   // readonly overrides: any = overrides; // TODO: add options.functionOverrides like in master
 

lib/ReactViewModels/SearchState.ts

@@ -2,22 +2,19 @@ import {
   action,
   computed,
   IReactionDisposer,
-  observable,
-  reaction,
   makeObservable,
-  runInAction
+  observable,
+  reaction
 } from "mobx";
 import filterOutUndefined from "../Core/filterOutUndefined";
+import CatalogSearchProviderMixin from "../ModelMixins/SearchProviders/CatalogSearchProviderMixin";
 import LocationSearchProviderMixin from "../ModelMixins/SearchProviders/LocationSearchProviderMixin";
 import SearchProviderMixin from "../ModelMixins/SearchProviders/SearchProviderMixin";
-import CatalogSearchProvider from "../Models/SearchProviders/CatalogSearchProvider";
 import SearchProviderResults from "../Models/SearchProviders/SearchProviderResults";
 import Terria from "../Models/Terria";
-import CatalogSearchProviderMixin from "../ModelMixins/SearchProviders/CatalogSearchProviderMixin";
 
 interface SearchStateOptions {
   terria: Terria;
-  catalogSearchProvider?: CatalogSearchProviderMixin.Instance;
 }
 
 export default class SearchState {
@@ -50,12 +47,6 @@ export default class SearchState {
 
     this.terria = options.terria;
 
-    runInAction(() => {
-      this.terria.searchBarModel.catalogSearchProvider =
-        options.catalogSearchProvider ||
-        new CatalogSearchProvider("catalog-search-provider", options.terria);
-    });
-
     const self = this;
 
     this._catalogSearchDisposer = reaction(
@@ -121,7 +112,7 @@ export default class SearchState {
 
   @computed
   get catalogSearchProvider(): CatalogSearchProviderMixin.Instance | undefined {
-    return this.terria.searchBarModel.catalogSearchProvider;
+    return this.terria.catalog.searchProvider;
   }
 
   @computed

lib/ReactViewModels/ViewState.ts

@@ -2,12 +2,12 @@ import {
   action,
   computed,
   IReactionDisposer,
+  makeObservable,
   observable,
   reaction,
-  runInAction,
-  makeObservable
+  runInAction
 } from "mobx";
-import { ReactNode, MouseEvent, ComponentType, Ref } from "react";
+import { ComponentType, MouseEvent, ReactNode, Ref } from "react";
 import defined from "terriajs-cesium/Source/Core/defined";
 import addedByUser from "../Core/addedByUser";
 import {
@@ -22,9 +22,12 @@ import CatalogMemberMixin, { getName } from "../ModelMixins/CatalogMemberMixin";
 import GroupMixin from "../ModelMixins/GroupMixin";
 import MappableMixin from "../ModelMixins/MappableMixin";
 import ReferenceMixin from "../ModelMixins/ReferenceMixin";
+import CatalogSearchProviderMixin from "../ModelMixins/SearchProviders/CatalogSearchProviderMixin";
+import CzmlCatalogItem from "../Models/Catalog/CatalogItems/CzmlCatalogItem";
 import CommonStrata from "../Models/Definition/CommonStrata";
 import { BaseModel } from "../Models/Definition/Model";
 import getAncestors from "../Models/getAncestors";
+import { getMarkerCatalogItem } from "../Models/LocationMarkerUtils";
 import { SelectableDimension } from "../Models/SelectableDimensions/SelectableDimensions";
 import Terria from "../Models/Terria";
 import { ViewingControl } from "../Models/ViewingControls";
@@ -37,9 +40,6 @@ import {
   TourPoint
 } from "./defaultTourPoints";
 import SearchState from "./SearchState";
-import CatalogSearchProviderMixin from "../ModelMixins/SearchProviders/CatalogSearchProviderMixin";
-import { getMarkerCatalogItem } from "../Models/LocationMarkerUtils";
-import CzmlCatalogItem from "../Models/Catalog/CatalogItems/CzmlCatalogItem";
 
 export const DATA_CATALOG_NAME = "data-catalog";
 export const USER_DATA_NAME = "my-data";
@@ -50,8 +50,10 @@ export const WORKBENCH_RESIZE_ANIMATION_DURATION = 500;
 
 interface ViewStateOptions {
   terria: Terria;
-  catalogSearchProvider: CatalogSearchProviderMixin.Instance | undefined;
-  errorHandlingProvider?: any;
+  /**
+   * @deprecated
+   */
+  catalogSearchProvider?: CatalogSearchProviderMixin.Instance;
 }
 
 /**
@@ -203,8 +205,6 @@ export default class ViewState {
     }
   }
 
-  errorProvider: any | null = null;
-
   // default value is null, because user has not made decision to show or
   // not show story
   // will be explicitly set to false when user 1. dismiss story
@@ -391,13 +391,14 @@ export default class ViewState {
     makeObservable(this);
     const terria = options.terria;
     this.searchState = new SearchState({
-      terria,
-      catalogSearchProvider: options.catalogSearchProvider
+      terria
     });
+    if (options.catalogSearchProvider) {
+      runInAction(() => {
+        this.terria.catalog.searchProvider = options.catalogSearchProvider;
+      });
+    }
 
-    this.errorProvider = options.errorHandlingProvider
-      ? options.errorHandlingProvider
-      : null;
     this.terria = terria;
 
     // When features are picked, show the feature info panel.

test/Map/StyledHtmlSpec.tsx

@@ -16,8 +16,7 @@ describe("StyledHtml", function () {
       baseUrl: "./"
     });
     viewState = new ViewState({
-      terria: terria,
-      catalogSearchProvider: undefined
+      terria: terria
     });
   });
 

test/Models/TerriaSpec.ts

@@ -565,8 +565,7 @@ describe("TerriaSpec", function () {
       beforeEach(function () {
         newTerria = new Terria({ appBaseHref: "/", baseUrl: "./" });
         viewState = new ViewState({
-          terria: terria,
-          catalogSearchProvider: undefined
+          terria: terria
         });
 
         UrlToCatalogMemberMapping.register(
@@ -793,8 +792,7 @@ describe("TerriaSpec", function () {
         )}`;
         newTerria = new Terria({ baseUrl: "./" });
         viewState = new ViewState({
-          terria: terria,
-          catalogSearchProvider: undefined
+          terria: terria
         });
 
         await Promise.all(
@@ -904,8 +902,7 @@ describe("TerriaSpec", function () {
           "https://magda.example.com/api/v0/registry/records/map-config-example?optionalAspect=terria-config&optionalAspect=terria-init&optionalAspect=group&dereference=true";
 
         viewState = new ViewState({
-          terria: terria,
-          catalogSearchProvider: undefined
+          terria: terria
         });
         newTerria = new Terria({ baseUrl: "./" });
 

test/Models/Workflows/SelectableDimensionWorkflowSpec.ts

@@ -13,8 +13,7 @@ describe("SelectableDimensionWorkflow", function () {
   beforeEach(function () {
     terria = new Terria();
     viewState = new ViewState({
-      terria,
-      catalogSearchProvider: undefined
+      terria
     });
   });
 

test/ReactViewModels/ViewStateSpec.ts

@@ -16,8 +16,7 @@ describe("ViewState", function () {
   beforeEach(function () {
     terria = new Terria();
     viewState = new ViewState({
-      terria,
-      catalogSearchProvider: undefined
+      terria
     });
   });
 
@@ -61,12 +60,6 @@ describe("ViewState", function () {
     });
   });
 
-  describe("error provider", function () {
-    it("creates an empty error provider by default", function () {
-      expect(viewState.errorProvider).toBeNull();
-    });
-  });
-
   describe("tourPointsWithValidRefs", function () {
     it("returns tourPoints ordered by priority", function () {
       runInAction(() => {

test/ReactViews/BottomDock/BottomDockSpec.tsx

@@ -12,8 +12,7 @@ describe("BottomDock", function () {
       baseUrl: "./"
     });
     viewState = new ViewState({
-      terria: terria,
-      catalogSearchProvider: undefined
+      terria: terria
     });
   });
 

test/ReactViews/BottomDock/MapDataCountSpec.tsx

@@ -14,8 +14,7 @@ describe("MapDataCount", function () {
       baseUrl: "./"
     });
     viewState = new ViewState({
-      terria: terria,
-      catalogSearchProvider: undefined
+      terria: terria
     });
   });
 

test/ReactViews/Custom/Chart/BottomDockChartSpec.tsx

@@ -15,8 +15,7 @@ describe("BottomDockChart", function () {
       baseUrl: "./"
     });
     viewState = new ViewState({
-      terria,
-      catalogSearchProvider: undefined
+      terria
     });
     chartItems = [
       {

test/ReactViews/Custom/Chart/FeatureInfoPanelChartSpec.tsx

@@ -33,7 +33,7 @@ describe("FeatureInfoPanelChart", function () {
 
     context = {
       terria: new Terria(),
-      viewState: new ViewState({ terria, catalogSearchProvider: undefined }),
+      viewState: new ViewState({ terria }),
       feature: new TerriaFeature({}),
       catalogItem
     };

test/ReactViews/Custom/Chart/PointOnMapSpec.tsx

@@ -13,8 +13,7 @@ describe("PointOnMap", function () {
       baseUrl: "./"
     });
     viewState = new ViewState({
-      terria,
-      catalogSearchProvider: undefined
+      terria
     });
   });
 

test/ReactViews/Custom/SettingsPanelCustomComponentSpec.ts

@@ -12,8 +12,7 @@ describe("SettingsPanelCustomComponent", function () {
 
   beforeEach(function () {
     viewState = new ViewState({
-      terria: new Terria(),
-      catalogSearchProvider: undefined
+      terria: new Terria()
     });
 
     registerCustomComponentTypes(viewState.terria);

test/ReactViews/DataCatalog/DataCatalogItemSpec.tsx

@@ -27,8 +27,7 @@ describe("DataCatalogItem", () => {
       baseUrl: "./"
     });
     viewState = new ViewState({
-      terria: terria,
-      catalogSearchProvider: undefined
+      terria: terria
     });
     wmsItem = new WebMapServiceCatalogItem("test", terria);
 

test/ReactViews/DataCatalogSpec.tsx

@@ -24,8 +24,7 @@ describe("DataCatalog", function () {
       baseUrl: "./"
     });
     viewState = new ViewState({
-      terria: terria,
-      catalogSearchProvider: undefined
+      terria: terria
     });
   });
 

test/ReactViews/DisclaimerSpec.tsx

@@ -14,8 +14,7 @@ describe("Disclaimer", function () {
       baseUrl: "./"
     });
     viewState = new ViewState({
-      terria: terria,
-      catalogSearchProvider: undefined
+      terria: terria
     });
   });