Enforce camelCase format for a plugin id (elastic#53759) (elastic#55270)

* add isCamelCase  function

* add a warning if id is not in camelCase

* document pluginId expected in camelCase

* regen docs

* add a test for logging

* update tests. warn can be called several times for different reasons

* pluginPath falls back to plugin id in snake_case

* update tests

* update docs

* add example with id & configPath different formats

Co-authored-by: Elastic Machine <elasticmachine@users.noreply.github.com>

Co-authored-by: Elastic Machine <elasticmachine@users.noreply.github.com>

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

@@ -4,7 +4,7 @@
 
 ## DiscoveredPlugin.configPath property
 
-Root configuration path used by the plugin, defaults to "id".
+Root configuration path used by the plugin, defaults to "id" in snake\_case format.
 
 <b>Signature:</b>
 

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

@@ -16,7 +16,7 @@ export interface DiscoveredPlugin
 
 |  Property | Type | Description |
 |  --- | --- | --- |
-|  [configPath](./kibana-plugin-server.discoveredplugin.configpath.md) | <code>ConfigPath</code> | Root configuration path used by the plugin, defaults to "id". |
+|  [configPath](./kibana-plugin-server.discoveredplugin.configpath.md) | <code>ConfigPath</code> | Root configuration path used by the plugin, defaults to "id" in snake\_case format. |
 |  [id](./kibana-plugin-server.discoveredplugin.id.md) | <code>PluginName</code> | Identifier of the plugin. |
 |  [optionalPlugins](./kibana-plugin-server.discoveredplugin.optionalplugins.md) | <code>readonly PluginName[]</code> | An optional list of the other plugins that if installed and enabled \*\*may be\*\* leveraged by this plugin for some additional functionality but otherwise are not required for this plugin to work properly. |
 |  [requiredPlugins](./kibana-plugin-server.discoveredplugin.requiredplugins.md) | <code>readonly PluginName[]</code> | An optional list of the other plugins that \*\*must be\*\* installed and enabled for this plugin to function properly. |

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

@@ -4,10 +4,15 @@
 
 ## PluginManifest.configPath property
 
-Root [configuration path](./kibana-plugin-server.configpath.md) used by the plugin, defaults to "id".
+Root [configuration path](./kibana-plugin-server.configpath.md) used by the plugin, defaults to "id" in snake\_case format.
 
 <b>Signature:</b>
 
 ```typescript
 readonly configPath: ConfigPath;
 ```
+
+## Example
+
+id: myPlugin configPath: my\_plugin
+

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

@@ -4,7 +4,7 @@
 
 ## PluginManifest.id property
 
-Identifier of the plugin.
+Identifier of the plugin. Must be a string in camelCase. Part of a plugin public contract. Other plugins leverage it to access plugin API, navigate to the plugin, etc.
 
 <b>Signature:</b>
 

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

@@ -20,8 +20,8 @@ Should never be used in code outside of Core but is exported for documentation p
 
 |  Property | Type | Description |
 |  --- | --- | --- |
-|  [configPath](./kibana-plugin-server.pluginmanifest.configpath.md) | <code>ConfigPath</code> | Root [configuration path](./kibana-plugin-server.configpath.md) used by the plugin, defaults to "id". |
-|  [id](./kibana-plugin-server.pluginmanifest.id.md) | <code>PluginName</code> | Identifier of the plugin. |
+|  [configPath](./kibana-plugin-server.pluginmanifest.configpath.md) | <code>ConfigPath</code> | Root [configuration path](./kibana-plugin-server.configpath.md) used by the plugin, defaults to "id" in snake\_case format. |
+|  [id](./kibana-plugin-server.pluginmanifest.id.md) | <code>PluginName</code> | Identifier of the plugin. Must be a string in camelCase. Part of a plugin public contract. Other plugins leverage it to access plugin API, navigate to the plugin, etc. |
 |  [kibanaVersion](./kibana-plugin-server.pluginmanifest.kibanaversion.md) | <code>string</code> | The version of Kibana the plugin is compatible with, defaults to "version". |
 |  [optionalPlugins](./kibana-plugin-server.pluginmanifest.optionalplugins.md) | <code>readonly PluginName[]</code> | An optional list of the other plugins that if installed and enabled \*\*may be\*\* leveraged by this plugin for some additional functionality but otherwise are not required for this plugin to work properly. |
 |  [requiredPlugins](./kibana-plugin-server.pluginmanifest.requiredplugins.md) | <code>readonly PluginName[]</code> | An optional list of the other plugins that \*\*must be\*\* installed and enabled for this plugin to function properly. |

src/core/CONVENTIONS.md

@@ -32,6 +32,7 @@ my_plugin/
     ├── index.ts
     └── plugin.ts
 ```
+- [Manifest file](/docs/development/core/server/kibana-plugin-server.pluginmanifest.md) should be defined on top level.
 - Both `server` and `public` should have an `index.ts` and a `plugin.ts` file:
   - `index.ts` should only contain:
     - The `plugin` export

src/core/server/config/integration_tests/config_deprecation.test.ts

@@ -36,7 +36,13 @@ describe('configuration deprecations', () => {
     await root.setup();
 
     const logs = loggingServiceMock.collect(mockLoggingService);
-    expect(logs.warn).toMatchInlineSnapshot(`Array []`);
+    const warnings = logs.warn.flatMap(i => i);
+    expect(warnings).not.toContain(
+      '"optimize.lazy" is deprecated and has been replaced by "optimize.watch"'
+    );
+    expect(warnings).not.toContain(
+      '"optimize.lazyPort" is deprecated and has been replaced by "optimize.watchPort"'
+    );
   });
 
   it('should log deprecation warnings for core deprecations', async () => {
@@ -50,15 +56,12 @@ describe('configuration deprecations', () => {
     await root.setup();
 
     const logs = loggingServiceMock.collect(mockLoggingService);
-    expect(logs.warn).toMatchInlineSnapshot(`
-      Array [
-        Array [
-          "\\"optimize.lazy\\" is deprecated and has been replaced by \\"optimize.watch\\"",
-        ],
-        Array [
-          "\\"optimize.lazyPort\\" is deprecated and has been replaced by \\"optimize.watchPort\\"",
-        ],
-      ]
-    `);
+    const warnings = logs.warn.flatMap(i => i);
+    expect(warnings).toContain(
+      '"optimize.lazy" is deprecated and has been replaced by "optimize.watch"'
+    );
+    expect(warnings).toContain(
+      '"optimize.lazyPort" is deprecated and has been replaced by "optimize.watchPort"'
+    );
   });
 });

src/core/server/plugins/discovery/is_camel_case.test.ts

@@ -0,0 +1,42 @@
+/*
+ * 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 { isCamelCase } from './is_camel_case';
+
+describe('isCamelCase', () => {
+  it('matches a string in camelCase', () => {
+    expect(isCamelCase('foo')).toBe(true);
+    expect(isCamelCase('foo1')).toBe(true);
+    expect(isCamelCase('fooBar')).toBe(true);
+    expect(isCamelCase('fooBarBaz')).toBe(true);
+    expect(isCamelCase('fooBAR')).toBe(true);
+  });
+
+  it('does not match strings in other cases', () => {
+    expect(isCamelCase('AAA')).toBe(false);
+    expect(isCamelCase('FooBar')).toBe(false);
+    expect(isCamelCase('3Foo')).toBe(false);
+    expect(isCamelCase('o_O')).toBe(false);
+    expect(isCamelCase('foo_bar')).toBe(false);
+    expect(isCamelCase('foo_')).toBe(false);
+    expect(isCamelCase('_fooBar')).toBe(false);
+    expect(isCamelCase('fooBar_')).toBe(false);
+    expect(isCamelCase('_fooBar_')).toBe(false);
+  });
+});

src/core/server/plugins/discovery/is_camel_case.ts

@@ -0,0 +1,22 @@
+/*
+ * 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.
+ */
+const camelCaseRegExp = /^[a-z]{1}([a-zA-Z0-9]{1,})$/;
+export function isCamelCase(candidate: string) {
+  return camelCaseRegExp.test(candidate);
+}