MapColonies / MapColonies/config-server

Add top-level config ref

Open
#99 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement
Dominant language
TypeScript
Stars
0
Forks
0
PR merge metrics
No merged PRs in 30d

Description

**Is your feature request related to a problem? Please describe.**
We at Vector team deploy the same service with 99% the same config for different projects (e.g. Metatile-Queue-Populator/ Retiler). The only difference might be the queue which I'm subscribing to or DB name/ S3 Bucket/ directory in a S3 bucket. Currently, I'll have to create config-per-instance and maintain each one of them (which will result in duplicate config - in the current state of schema and service).
I also expect that I would be able to override properties from the shared config.

**Describe the solution you'd like**
I would like to be able to top-level `$ref` a "shared" config in the specific project config's and inherit it's config and override the properties which are project-specific.

**Describe alternatives you've considered**
Change the schema (again).

**Additional context**
This will enable us to create ts-server-boilerplate shared config and many more copy-paste config
An example
```
// shared schema
{
"foo": {
"type": "string"
},
"bar": {
"type": "string"
}
}

// shared config
{
"foo": "avi1",
"bar": "avi2"
}

// "full" schema
{
"$ref": "#/ref/to/shared/schema",
"baz": {
"type": "string"
}
}
// => which results to
{
"foo": {
"type": "string"
},
"bar": {
"type": "string"
},
"baz": {
"type": "string"
}
}

// "full" config
{
"$ref": "#/ref/to/shared/config",
"baz": "avi3"
}
// => which results to
{
"foo": "avi1",
"bar": "avi2",
"baz": "avi3"
}

//another valid edge-case option
{
"$ref": "#/ref/to/shared/config",
"foo": "avi420"
"baz": "avi3"
}
// => which results to
{
"foo": "avi420",
"bar": "avi2",
"baz": "avi3"
}

```

Points to consider:
I think we should also have [Pick](https://www.typescriptlang.org/docs/handbook/utility-types.html#picktype-keys)-[Omit](https://www.typescriptlang.org/docs/handbook/utility-types.html#omittype-keys) `$ref` support in order to, as you probably already guessed, pick a config value/ omit one.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

No files, tests, or entry points are named in the issue. Start by reviewing the existing schema and config resolution behavior, then clarify how top-level $ref inheritance, property overrides, and Pick/Omit should interact. Done means the supported semantics and edge cases are specified and covered by tests.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
tooling
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.