TabifyDocs: Allow Formatter Parameters

[tsullivan]

Summary

This PR allows src/plugins/data/common/search/tabify/tabify_docs to pass given parameters for Formatters. This unblocks CSV Export from using tabify on the server-side and have the date strings formatted to the desired timezone.

Checklist

Delete any items that are not applicable to this PR.

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

For maintainers

• This was checked for breaking API changes and was labeled appropriately

[tsullivan]

This is needed for https://github.com/elastic/kibana/pull/88303/files#diff-a86296d9011252ff17c1007bb3de66763c43af633f7daff1207151da34838e7fR225

But I am interested to know if there is a better way to set the timezone for field formatters in my other PR.

[elasticmachine]

Pinging @elastic/kibana-app-services (Team:AppServices)

[kibanamachine]

💚 Build Succeeded

• continuous-integration/kibana-ci/pull-request
• Commit: a539cde
• Documentation Changes

Metrics [docs]

Page load bundle

Size of the bundles that are downloaded on every page load. Target size is below 100kb

id	before	after	diff
data	797.7KB	797.8KB	+114.0B

History

• 💔 Build #104946 failed 12f8b8c
• 💔 Build #104935 failed 5db78d2

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

[ppisljar]

another possibility would be updating index pattern, so fieldFormatMap would contain 'correct' formatSpec (and of course not persisting that change):

// update the timezone for all date fields:
indexPatterns.fields.getByType('date').forEach(field => {
  indexPattern.setFieldFormat(field.name, { ...indexPattern.fieldFormatMap[field.name], timezone: myTimezone });
}

const table = tabify(await searchSource.fetch());

[ppisljar]

I don't think we should allow overriding field format params on the index pattern level, that opens up a lot of new possibilities.

[ppisljar]

could we investigate how to override uiSetting on the server ? if you could do something like:

 uiSettings.override('timezone', myStoredTimezone);
 const table = tabify(await searchSource.fetch());

would that solve the problems ?

[tsullivan]

Closing this because the suggested technique works:

      // apply timezone from the job to all date field formatters
      index.fields.getByType('date').forEach(({ name }) => {
        this.logger.debug(`setting timezone on ${name}`);
        const format: FieldFormatConfig = {
          ...index.fieldFormatMap[name],
          id: index.fieldFormatMap[name]?.id || 'date', // allow id: date_nanos
          params: {
            ...index.fieldFormatMap[name]?.params,
            timezone: settings.timezone,
          },
        };
        index.setFieldFormat(name, format);
      });