migrate i18n mixin to KP (#81799)

* migrate i18n mixin to KP

* directly load the config from i18n service

* add base tests

* update telemetry schema

* update legacy telemetry schema

* fix server tests

* use paths from config service instead of manually loading the plugin config

* add tests for get_translation_paths

* add tests for i18n service

* add plugin service test

* update generated doc

* improve tsdoc

docs/development/core/server/kibana-plugin-core-server.coresetup.i18n.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [kibana-plugin-core-server](./kibana-plugin-core-server.md) &gt; [CoreSetup](./kibana-plugin-core-server.coresetup.md) &gt; [i18n](./kibana-plugin-core-server.coresetup.i18n.md)
+
+## CoreSetup.i18n property
+
+[I18nServiceSetup](./kibana-plugin-core-server.i18nservicesetup.md)
+
+<b>Signature:</b>
+
+```typescript
+i18n: I18nServiceSetup;
+```

docs/development/core/server/kibana-plugin-core-server.coresetup.md

@@ -21,6 +21,7 @@ export interface CoreSetup<TPluginsStart extends object = object, TStart = unkno
 |  [elasticsearch](./kibana-plugin-core-server.coresetup.elasticsearch.md) | <code>ElasticsearchServiceSetup</code> | [ElasticsearchServiceSetup](./kibana-plugin-core-server.elasticsearchservicesetup.md) |
 |  [getStartServices](./kibana-plugin-core-server.coresetup.getstartservices.md) | <code>StartServicesAccessor&lt;TPluginsStart, TStart&gt;</code> | [StartServicesAccessor](./kibana-plugin-core-server.startservicesaccessor.md) |
 |  [http](./kibana-plugin-core-server.coresetup.http.md) | <code>HttpServiceSetup &amp; {</code><br/><code>        resources: HttpResources;</code><br/><code>    }</code> | [HttpServiceSetup](./kibana-plugin-core-server.httpservicesetup.md) |
+|  [i18n](./kibana-plugin-core-server.coresetup.i18n.md) | <code>I18nServiceSetup</code> | [I18nServiceSetup](./kibana-plugin-core-server.i18nservicesetup.md) |
 |  [logging](./kibana-plugin-core-server.coresetup.logging.md) | <code>LoggingServiceSetup</code> | [LoggingServiceSetup](./kibana-plugin-core-server.loggingservicesetup.md) |
 |  [metrics](./kibana-plugin-core-server.coresetup.metrics.md) | <code>MetricsServiceSetup</code> | [MetricsServiceSetup](./kibana-plugin-core-server.metricsservicesetup.md) |
 |  [savedObjects](./kibana-plugin-core-server.coresetup.savedobjects.md) | <code>SavedObjectsServiceSetup</code> | [SavedObjectsServiceSetup](./kibana-plugin-core-server.savedobjectsservicesetup.md) |

docs/development/core/server/kibana-plugin-core-server.i18nservicesetup.getlocale.md

@@ -0,0 +1,17 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [kibana-plugin-core-server](./kibana-plugin-core-server.md) &gt; [I18nServiceSetup](./kibana-plugin-core-server.i18nservicesetup.md) &gt; [getLocale](./kibana-plugin-core-server.i18nservicesetup.getlocale.md)
+
+## I18nServiceSetup.getLocale() method
+
+Return the locale currently in use.
+
+<b>Signature:</b>
+
+```typescript
+getLocale(): string;
+```
+<b>Returns:</b>
+
+`string`
+

docs/development/core/server/kibana-plugin-core-server.i18nservicesetup.gettranslationfiles.md

@@ -0,0 +1,17 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [kibana-plugin-core-server](./kibana-plugin-core-server.md) &gt; [I18nServiceSetup](./kibana-plugin-core-server.i18nservicesetup.md) &gt; [getTranslationFiles](./kibana-plugin-core-server.i18nservicesetup.gettranslationfiles.md)
+
+## I18nServiceSetup.getTranslationFiles() method
+
+Return the absolute paths to translation files currently in use.
+
+<b>Signature:</b>
+
+```typescript
+getTranslationFiles(): string[];
+```
+<b>Returns:</b>
+
+`string[]`
+

docs/development/core/server/kibana-plugin-core-server.i18nservicesetup.md

@@ -0,0 +1,20 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [kibana-plugin-core-server](./kibana-plugin-core-server.md) &gt; [I18nServiceSetup](./kibana-plugin-core-server.i18nservicesetup.md)
+
+## I18nServiceSetup interface
+
+
+<b>Signature:</b>
+
+```typescript
+export interface I18nServiceSetup 
+```
+
+## Methods
+
+|  Method | Description |
+|  --- | --- |
+|  [getLocale()](./kibana-plugin-core-server.i18nservicesetup.getlocale.md) | Return the locale currently in use. |
+|  [getTranslationFiles()](./kibana-plugin-core-server.i18nservicesetup.gettranslationfiles.md) | Return the absolute paths to translation files currently in use. |
+

docs/development/core/server/kibana-plugin-core-server.md

@@ -89,6 +89,7 @@ The plugin integrates with the core system via lifecycle events: `setup`<!-- -->
 |  [HttpServerInfo](./kibana-plugin-core-server.httpserverinfo.md) |  |
 |  [HttpServiceSetup](./kibana-plugin-core-server.httpservicesetup.md) | Kibana HTTP Service provides own abstraction for work with HTTP stack. Plugins don't have direct access to <code>hapi</code> server and its primitives anymore. Moreover, plugins shouldn't rely on the fact that HTTP Service uses one or another library under the hood. This gives the platform flexibility to upgrade or changing our internal HTTP stack without breaking plugins. If the HTTP Service lacks functionality you need, we are happy to discuss and support your needs. |
 |  [HttpServiceStart](./kibana-plugin-core-server.httpservicestart.md) |  |
+|  [I18nServiceSetup](./kibana-plugin-core-server.i18nservicesetup.md) |  |
 |  [IClusterClient](./kibana-plugin-core-server.iclusterclient.md) | Represents an Elasticsearch cluster API client created by the platform. It allows to call API on behalf of the internal Kibana user and the actual user that is derived from the request headers (via <code>asScoped(...)</code>). |
 |  [IContextContainer](./kibana-plugin-core-server.icontextcontainer.md) | An object that handles registration of context providers and configuring handlers with context. |
 |  [ICspConfig](./kibana-plugin-core-server.icspconfig.md) | CSP configuration for use in Kibana. |

src/core/server/environment/environment_service.mock.ts

@@ -17,8 +17,7 @@
  * under the License.
  */
 import type { PublicMethodsOf } from '@kbn/utility-types';
-
-import { EnvironmentService, InternalEnvironmentServiceSetup } from './environment_service';
+import type { EnvironmentService, InternalEnvironmentServiceSetup } from './environment_service';
 
 const createSetupContractMock = () => {
   const setupContract: jest.Mocked<InternalEnvironmentServiceSetup> = {

src/legacy/server/i18n/constants.ts → src/core/server/i18n/fs.ts

@@ -17,4 +17,7 @@
  * under the License.
  */
 
-export const I18N_RC = '.i18nrc.json';
+import Fs from 'fs';
+import { promisify } from 'util';
+
+export const readFile = promisify(Fs.readFile);

src/core/server/i18n/get_kibana_translation_files.test.ts

@@ -0,0 +1,81 @@
+/*
+ * Licensed to Elasticsearch B.V. under one or more contributor
+ * license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright
+ * ownership. Elasticsearch B.V. licenses this file to you under
+ * the Apache License, Version 2.0 (the "License"); you may
+ * not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *    http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied.  See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+import { getKibanaTranslationFiles } from './get_kibana_translation_files';
+import { getTranslationPaths } from './get_translation_paths';
+
+const mockGetTranslationPaths = getTranslationPaths as jest.Mock;
+
+jest.mock('./get_translation_paths', () => ({
+  getTranslationPaths: jest.fn().mockResolvedValue([]),
+}));
+jest.mock('../utils', () => ({
+  fromRoot: jest.fn().mockImplementation((path: string) => path),
+}));
+
+const locale = 'en';
+
+describe('getKibanaTranslationPaths', () => {
+  beforeEach(() => {
+    jest.clearAllMocks();
+  });
+
+  it('calls getTranslationPaths against kibana root and kibana-extra', async () => {
+    await getKibanaTranslationFiles(locale, []);
+
+    expect(mockGetTranslationPaths).toHaveBeenCalledTimes(2);
+
+    expect(mockGetTranslationPaths).toHaveBeenCalledWith({
+      cwd: '.',
+      nested: true,
+    });
+
+    expect(mockGetTranslationPaths).toHaveBeenCalledWith({
+      cwd: '../kibana-extra',
+      nested: true,
+    });
+  });
+
+  it('calls getTranslationPaths for each config returned in plugin.paths and plugins.scanDirs', async () => {
+    const pluginPaths = ['/path/to/pluginA', '/path/to/pluginB'];
+
+    await getKibanaTranslationFiles(locale, pluginPaths);
+
+    expect(mockGetTranslationPaths).toHaveBeenCalledTimes(2 + pluginPaths.length);
+
+    pluginPaths.forEach((pluginPath) => {
+      expect(mockGetTranslationPaths).toHaveBeenCalledWith({
+        cwd: pluginPath,
+        nested: false,
+      });
+    });
+  });
+
+  it('only return files for specified locale', async () => {
+    mockGetTranslationPaths.mockResolvedValueOnce(['/root/en.json', '/root/fr.json']);
+    mockGetTranslationPaths.mockResolvedValueOnce([
+      '/kibana-extra/en.json',
+      '/kibana-extra/fr.json',
+    ]);
+
+    const translationFiles = await getKibanaTranslationFiles('en', []);
+
+    expect(translationFiles).toEqual(['/root/en.json', '/kibana-extra/en.json']);
+  });
+});

src/legacy/server/i18n/get_kibana_translation_paths.ts → src/core/server/i18n/get_kibana_translation_files.ts

@@ -17,26 +17,27 @@
  * under the License.
  */
 
-import { KibanaConfig } from '../kbn_server';
-import { fromRoot } from '../../../core/server/utils';
-import { I18N_RC } from './constants';
+import { basename } from 'path';
+import { fromRoot } from '../utils';
 import { getTranslationPaths } from './get_translation_paths';
 
-export async function getKibanaTranslationPaths(config: Pick<KibanaConfig, 'get'>) {
-  return await Promise.all([
+export const getKibanaTranslationFiles = async (
+  locale: string,
+  pluginPaths: string[]
+): Promise<string[]> => {
+  const translationPaths = await Promise.all([
     getTranslationPaths({
       cwd: fromRoot('.'),
-      glob: `*/${I18N_RC}`,
+      nested: true,
     }),
-    ...(config.get('plugins.paths') as string[]).map((cwd) =>
-      getTranslationPaths({ cwd, glob: I18N_RC })
-    ),
-    ...(config.get('plugins.scanDirs') as string[]).map((cwd) =>
-      getTranslationPaths({ cwd, glob: `*/${I18N_RC}` })
-    ),
+    ...pluginPaths.map((pluginPath) => getTranslationPaths({ cwd: pluginPath, nested: false })),
     getTranslationPaths({
       cwd: fromRoot('../kibana-extra'),
-      glob: `*/${I18N_RC}`,
+      nested: true,
     }),
   ]);
-}
+
+  return ([] as string[])
+    .concat(...translationPaths)
+    .filter((translationPath) => basename(translationPath, '.json') === locale);
+};

src/core/server/i18n/get_translation_paths.test.mocks.ts

@@ -0,0 +1,26 @@
+/*
+ * Licensed to Elasticsearch B.V. under one or more contributor
+ * license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright
+ * ownership. Elasticsearch B.V. licenses this file to you under
+ * the Apache License, Version 2.0 (the "License"); you may
+ * not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *    http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied.  See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+export const globbyMock = jest.fn();
+jest.doMock('globby', () => globbyMock);
+
+export const readFileMock = jest.fn();
+jest.doMock('./fs', () => ({
+  readFile: readFileMock,
+}));

src/core/server/i18n/get_translation_paths.test.ts

@@ -0,0 +1,90 @@
+/*
+ * Licensed to Elasticsearch B.V. under one or more contributor
+ * license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright
+ * ownership. Elasticsearch B.V. licenses this file to you under
+ * the Apache License, Version 2.0 (the "License"); you may
+ * not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *    http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied.  See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+import { resolve, join } from 'path';
+import { globbyMock, readFileMock } from './get_translation_paths.test.mocks';
+import { getTranslationPaths } from './get_translation_paths';
+
+describe('getTranslationPaths', () => {
+  beforeEach(() => {
+    globbyMock.mockReset();
+    readFileMock.mockReset();
+
+    globbyMock.mockResolvedValue([]);
+    readFileMock.mockResolvedValue('{}');
+  });
+
+  it('calls `globby` with the correct parameters', async () => {
+    getTranslationPaths({ cwd: '/some/cwd', nested: false });
+
+    expect(globbyMock).toHaveBeenCalledTimes(1);
+    expect(globbyMock).toHaveBeenCalledWith('.i18nrc.json', { cwd: '/some/cwd' });
+
+    globbyMock.mockClear();
+
+    await getTranslationPaths({ cwd: '/other/cwd', nested: true });
+
+    expect(globbyMock).toHaveBeenCalledTimes(1);
+    expect(globbyMock).toHaveBeenCalledWith('*/.i18nrc.json', { cwd: '/other/cwd' });
+  });
+
+  it('calls `readFile` for each entry returned by `globby`', async () => {
+    const entries = [join('pathA', '.i18nrc.json'), join('pathB', '.i18nrc.json')];
+    globbyMock.mockResolvedValue(entries);
+
+    const cwd = '/kibana-extra';
+
+    await getTranslationPaths({ cwd, nested: true });
+
+    expect(readFileMock).toHaveBeenCalledTimes(2);
+
+    expect(readFileMock).toHaveBeenNthCalledWith(1, resolve(cwd, entries[0]), 'utf8');
+    expect(readFileMock).toHaveBeenNthCalledWith(2, resolve(cwd, entries[1]), 'utf8');
+  });
+
+  it('returns the absolute path to the translation files', async () => {
+    const entries = ['.i18nrc.json'];
+    globbyMock.mockResolvedValue(entries);
+
+    const i18nFileContent = {
+      translations: ['translations/en.json', 'translations/fr.json'],
+    };
+    readFileMock.mockResolvedValue(JSON.stringify(i18nFileContent));
+
+    const cwd = '/cwd';
+
+    const translationPaths = await getTranslationPaths({ cwd, nested: true });
+
+    expect(translationPaths).toEqual([
+      resolve(cwd, 'translations/en.json'),
+      resolve(cwd, 'translations/fr.json'),
+    ]);
+  });
+
+  it('throws if i18nrc parsing fails', async () => {
+    globbyMock.mockResolvedValue(['.i18nrc.json']);
+    readFileMock.mockRejectedValue(new Error('error parsing file'));
+
+    await expect(
+      getTranslationPaths({ cwd: '/cwd', nested: true })
+    ).rejects.toThrowErrorMatchingInlineSnapshot(
+      `"Failed to parse .i18nrc.json file at /cwd/.i18nrc.json"`
+    );
+  });
+});

src/legacy/server/i18n/get_translation_paths.ts → src/core/server/i18n/get_translation_paths.ts

@@ -17,26 +17,26 @@
  * under the License.
  */
 
-import { promisify } from 'util';
-import { readFile } from 'fs';
 import { resolve, dirname } from 'path';
 import globby from 'globby';
-
-const readFileAsync = promisify(readFile);
+import { readFile } from './fs';
 
 interface I18NRCFileStructure {
   translations?: string[];
 }
 
-export async function getTranslationPaths({ cwd, glob }: { cwd: string; glob: string }) {
+const I18N_RC = '.i18nrc.json';
+
+export async function getTranslationPaths({ cwd, nested }: { cwd: string; nested: boolean }) {
+  const glob = nested ? `*/${I18N_RC}` : I18N_RC;
   const entries = await globby(glob, { cwd });
   const translationPaths: string[] = [];
 
   for (const entry of entries) {
     const entryFullPath = resolve(cwd, entry);
     const pluginBasePath = dirname(entryFullPath);
     try {
-      const content = await readFileAsync(entryFullPath, 'utf8');
+      const content = await readFile(entryFullPath, 'utf8');
       const { translations } = JSON.parse(content) as I18NRCFileStructure;
       if (translations && translations.length) {
         translations.forEach((translation) => {