dp-frontend-search-controller

README

dp-frontend-search-controller

An HTTP service for the controlling of search API

Getting started

• Run make debug

Run new search in the UI:

• run the web journey

• set SearchRoutesEnabled to true and SearchABTestPercentage to 100 in the config of the dp-frontend-router

Dependencies

• generate default content with dp-zebedee-content
• dp-design-system
• dp-search-api
• dp-topic-api
• Run Elasticsearch (version 7.10 runs on port 11200) via dp-compose

No further dependencies other than those defined in go.mod

Configuration

Environment variable	Default	Description
API_ROUTER_URL	http://localhost:23200/v1	The URL of the dp-api-router
AB_TEST_ASPECT_ID	dp-frontend-search-controller	Unique Aspect ID for AB test cookie
AB_TEST_ENABLED	true	If AB testing is switched on - if false, this will default to the new handler
AB_TEST_PERCENTAGE	0	What percentage of traffic goes to the new handler
AB_TEST_EXIT	search-ab-exit	Param to purge the cookie if a user enters in browser
BIND_ADDR	:25000	The port to bind to
CACHE_CENSUS_TOPICS_UPDATE_INTERVAL	30m	The time interval to update cache for census topics (time.Duration format)
CACHE_DATA_TOPICS_UPDATE_INTERVAL	30m	The time interval to update cache for data topics (time.Duration format)
CACHE_NAVIGATION_UPDATE_INTERVAL	30m	The time interval to update cache for navigation bar (time.Duration format)
CENSUS_TOPIC_ID	4445	Unique identifier for the census topic, used to get census topics from Topics API
DEBUG	false	Enable debug mode
DEFAULT_DATASET_SORT	release_date	The default sort for census dataset finder
DEFAULT_LIMIT	10	The default limit of search results in a page
DEFAULT_MAXIMUM_LIMIT	50	The default maximum limit of search results in a page
DEFAULT_MAXIMUM_SEARCH_RESULTS	500	The default maximum search results
DEFAULT_OFFSET	0	The default offset of search results
DEFAULT_PAGE	1	The default current page of search results
DEFAULT_PREVIOUS_RELEASES_SORT	release_date	The default sort for previous releases
DEFAULT_RELATED_DATA_SORT	title	The default sort for related data
DEFAULT_SORT	relevance	The default sort of search results
ENABLE_AGGREGATION_PAGES	false	Enable the aggregation pages, is a combination feature flag with ENABLE_TOPIC_AGGREGATION_PAGES
ENABLE_TOPIC_AGGREGATION_PAGES	false	Enable the topic aggregation pages, is a combination feature flag with ENABLE_AGGREGATION_PAGES. To enable this, the ENABLE_AGGREGATION_PAGES flag has to be enabled.
ENABLE_CENSUS_DIMENSIONS_FILTER_OPTION	false	Enable dimensions filter for census dataset finder
ENABLE_CENSUS_POPULATION_TYPE_FILTER_OPTION	false	Enable populations filter for census dataset finder
ENABLE_CENSUS_TOPIC_FILTER_OPTION	false
ENABLE_FEEDBACK_API	false
ENABLE_NEW_NAV_BAR	false
FEEDBACK_API_URL	http://localhost:23200/v1/feedback
GRACEFUL_SHUTDOWN_TIMEOUT	5s	The graceful shutdown timeout in seconds (time.Duration format)
HEALTHCHECK_CRITICAL_TIMEOUT	90s	Time to wait until an unhealthy dependent propagates its state to make this app unhealthy (time.Duration format)
HEALTHCHECK_INTERVAL	30s	Time between self-healthchecks (time.Duration format)
OTEL_BATCH_TIMEOUT	5s	Interval between pushes to OT Collector
OTEL_EXPORTER_OTLP_ENDPOINT	http://localhost:4317	URL for OpenTelemetry endpoint
OTEL_SERVICE_NAME	"dp-frontend-search-controller"	Service name to report to telemetry tools
OTEL_ENABLED	false	Feature flag to enable OpenTelemetry
IS_PUBLISHING	false	Mode in which service is running
PATTERN_LIBRARY_ASSETS_PATH	""	Pattern library location
SERVICE_AUTH_TOKEN	""	This is required to identify the controller when it calls the topic API via the API router in publishing mode
SITE_DOMAIN	localhost
SUPPORTED_LANGUAGES	[2]string{"en", "cy"}	Supported languages

Contributing

See CONTRIBUTING for details.

License

Copyright © 2020 - 2022, Office for National Statistics (https://www.ons.gov.uk)

Released under MIT license, see LICENSE for details.