Just thought of a thing. This could probably benefit from an Adapter pattern so that you don't have to override the actual Search abstraction, but rather have a layer on top that can gather results from different sources.

// Changed core service
import VFSSearchAdapter from './adapters/search/vfs'

class Search {
  constructor(core, options) {
    // The options would come from the Service provider
    const providedAdapters = options.adapters || []
    const useAdapters = [VFSSearchAdapter, ...providedAdapters]
    this.adapters = useAdapters.map(A => new A(core))
  }

  async init() {
    await Promise.all(this.adapters.map(a => a.init()))
  }

  async search(pattern) {
    const results = await Promise.all(this.adapters.map(a => a.search(pattern)))
    // Maybe sorted ?! Maybe provide grouping in UI ?!
    // Start simple with a flat result ?!
    return results.flat(1)
  }
}

// Changed core service initialization
this.search = core.config('search.enabled')
  ? new Search(core, options.search || {})
  : null;

// A custom adapter in the distro
// Uses the standard interface as the rest of OS.js
export default class MySearchAdapter {
  constructor(core) {
    this.core = core

    // If settings are needed it can be provided via a custom config entry
    const config = core.config('search.mySearchAdapterSetttings', {})

    this.settings = deepmerge({
     someDefault: 'value',
    }, config)
  }

  destroy() {}

  async init() {
    // For custom stuff during boot
  }

  async search(pattern) {
    return []
  }
}

// Desktop service provider can now do this
import MySearchAdapter from './SearchAdapter'

osjs.register(DesktopServiceProvider, {
  args: {
    search: {
      adapters: [MySearchAdapter],
    }
  }
});

Uh oh!

Needed Interface for OSjs Search Engine #812

Description

Metadata

Metadata

Assignees

Labels

Type

Projects

Milestone

Relationships

Development

Issue actions