[Enterprise Search] Add preferences to connectors

[navarone-feekery]

Summary

Add support for new field preferences in .elastic-connectors.

Related PRs:

• Update connector protocol connectors-ruby#527
• https://github.com/elastic/ent-search/pull/7292

Checklist

• Unit or functional tests were updated or added to match the most common scenarios

[sphilipse]

Ah, I don't think we need the 'label'/'value' construction for these, I don't think we'll pull the name or description for these preferences from the document in any case. We can just give these straight values.

[navarone-feekery]

@sphilipse I've changed it to a generic key:value pair, thanks for the feedback!

[sphilipse]

I'd consider making the contents of preferences explicitly mapped so that we can potentially search over them, like "get me all connectors that have this setting".

[navarone-feekery]

@sphilipse I've added extract_full_html as a boolean to the mappings

[sphilipse]

Should update this type too :)
Something like:

export interface ConnectorPreferences {
  extract_full_html: boolean | null;
}

[navarone-feekery]

@sphillipse Would something like this work? (keeping in mind that there may be more fields added in the future)

export interface Preferences {
  extract_full_html: boolean;
}
export type ConnectorPreferences = Preferences | Record<string, unknown>;

[navarone-feekery]

Didn't see your edit, will add. Cheers!

[sphilipse]

If you wanted to do it in an extensible way, you'd do something like:

export interface ConnectorPreferences extends Record<string, unknown> {
  extract_full_html: boolean | null;
}

Your way is almost correct, but means it's either an object with the defined properties, or an object of shape Record<string, unknown>. In the second case, extract_full_html could be anything--so you lose the advantage of typing. Extending it gets rid of that issue.

[navarone-feekery]

I like this extensible way so I'm going to use it

[navarone-feekery]

@elasticmachine merge upstream

[kibana-ci]

💚 Build Succeeded

• Buildkite Build
• Commit: 6d73ba6

Metrics [docs]

✅ unchanged

History

• 💔 Build #105167 failed 337f5d4
• 💔 Build #105125 failed b7c5a08

To update your PR or re-run it, just comment with:
@elasticmachine merge upstream