@equinor/fusion-framework-module-service-discovery

Resolves service endpoint URIs and authentication scopes from a central service discovery API so that application code can request named services without hard-coding URLs.

When to Use

Use this module when your application needs to:

• Look up backend service base URIs at runtime instead of baking them into config
• Obtain OAuth scopes for token acquisition automatically
• Create pre-configured HTTP clients for discovered services

Prerequisites

The module depends on @equinor/fusion-framework-module-http for HTTP transport. An HTTP client pointing at the service discovery backend must be registered before service discovery is enabled.

Warning

The HTTP module must be enabled in the runtime (e.g. Portal). If you are building a sub-module such as an Application, the portal typically inherits this configuration for you.

Quick Start

1. Register an HTTP client for the service discovery API

Skip this step if the runtime already provides an HTTP client keyed "service_discovery".

import { configureHttpClient } from '@equinor/fusion-framework-module-http';
import type { ModulesConfigurator } from '@equinor/fusion-framework-module';

const configurator = new ModulesConfigurator();
configurator.addConfig(
  configureHttpClient('service_discovery', {
    baseUri: 'https://discovery.example.com',
    defaultScopes: ['https://discovery.example.com/.default'],
  }),
);

2. Enable service discovery

import { enableServiceDiscovery } from '@equinor/fusion-framework-module-service-discovery';

// Auto-detects the 'service_discovery' HTTP client
enableServiceDiscovery(configurator);

3. Resolve services at runtime

// Resolve a single service
const contextService = await modules.serviceDiscovery.resolveService('context');
console.log(contextService.uri); // 'https://api.example.com/context'

// Create a ready-to-use HTTP client for a discovered service
const client = await modules.serviceDiscovery.createClient('people');
const data = await client.fetchAsync('/persons?search=Jane');

Documentation

Guide	Covers
Configuration	Custom HTTP client keys, custom clients, and replacing the discovery client
Testing	The /mock entry point: an in-memory registry, local mock servers, and spying
Session Overrides	Redirecting services to local or staging URLs during development
API Reference	Exports and the Service shape

Testing

Import from @equinor/fusion-framework-module-service-discovery/mock to resolve services from an in-memory registry instead of the service registry. The real configurator, provider and validation still run — only the boundary that would contact the registry is substituted.

import { enableServiceDiscoveryMock } from '@equinor/fusion-framework-module-service-discovery/mock';

enableServiceDiscoveryMock(configurator);

Baseline services (apps, people, context, bookmarks, notification) resolve out of the box. The configurator owns the registry, so pointing every service at a locally running mock server takes no client:

enableServiceDiscoveryMock(configurator, (builder) => {
  builder.setBaseUri('http://localhost:6669');
  builder.addService({ key: 'my-api' });
});

The entry point has no test-runner dependency, and ships no mocking API of its own — spying on a call is your test runner's job.

See Testing for the full builder API, local-mock-server setup and runner guidance, or @equinor/fusion-framework/mock to mock every framework boundary at once.

Key Concepts

Inheritance

When used inside a sub-module (e.g. an Application), the Service Discovery module inherits the parent module's discovery client by default. This means:

• The child shares the parent's cache, avoiding duplicate API calls
• The child sees the same session overrides
• Breaking changes in the parent's client could affect the child

Caching

The built-in ServiceDiscoveryClient caches results for 5 minutes via @equinor/fusion-query. The allow_cache parameter on resolveService / resolveServices controls whether to return the first cached snapshot (true) or wait for the latest response (false, the default).

Services

[
  {
    "key": "people",
    "name": "Fusion people service"
  },
  {
    "key": "org",
    "name": "Fusion organisation chart service"
  },
  {
    "key": "data-proxy",
    "name": "Fusion general data proxy service"
  },
  {
    "key": "tasks",
    "name": "Fusion task service"
  },
  {
    "key": "notification",
    "name": "Fusion notification service"
  },
  {
    "key": "meeting-v2",
    "name": "Fusion meeting (new version) service"
  },
  {
    "key": "projects",
    "name": "Fusion project service"
  },
  {
    "key": "portal",
    "name": "Fusion portal service"
  },
  {
    "key": "mail",
    "name": "Fusion mail service"
  },
  {
    "key": "commonlib",
    "name": "Fusion CommonLib Service"
  },
  {
    "key": "reports",
    "name": "Fusion Reports integration service"
  },
  {
    "key": "query",
    "name": "Query api"
  },
  {
    "key": "context",
    "name": "Context api"
  },
  {
    "key": "roles",
    "name": "Roles api"
  },
  {
    "key": "fusion-tasks",
    "name": "Fusion task service v2"
  },
  {
    "key": "line-org",
    "name": "Fusion line organisation service"
  },
  {
    "key": "info-app",
    "name": null
  },
  {
    "key": "az-function-utility",
    "name": "Fusion utility azure function"
  },
  {
    "key": "meeting",
    "name": null
  },
  {
    "key": "bookmarks",
    "name": null
  },
  {
    "key": "contract-personnel",
    "name": null
  }
]