Trim alert name in API key name

elastic · Aug 27, 2020 · 1bc964c · 1bc964c
1 parent 8e2cb56
commit 1bc964c
Show file tree

Hide file tree

Showing 2 changed files with 129 additions and 3 deletions.
diff --git a/x-pack/plugins/alerts/server/alerts_client.test.ts b/x-pack/plugins/alerts/server/alerts_client.test.ts
@@ -652,6 +652,70 @@ describe('create()', () => {
  expect(taskManager.schedule).toHaveBeenCalledTimes(0);
  });
 
+ test('should trim alert name when creating API key', async () => {
+ const data = getMockData({ name: ' my alert name ' });
+ unsecuredSavedObjectsClient.bulkGet.mockResolvedValueOnce({
+ saved_objects: [
+ {
+ id: '1',
+ type: 'action',
+ attributes: {
+ actions: [],
+ actionTypeId: 'test',
+ },
+ references: [],
+ },
+ ],
+ });
+ unsecuredSavedObjectsClient.create.mockResolvedValueOnce({
+ id: '1',
+ type: 'alert',
+ attributes: {
+ enabled: false,
+ name: ' my alert name ',
+ alertTypeId: '123',
+ schedule: { interval: 10000 },
+ params: {
+ bar: true,
+ },
+ createdAt: new Date().toISOString(),
+ actions: [
+ {
+ group: 'default',
+ actionRef: 'action_0',
+ actionTypeId: 'test',
+ params: {
+ foo: true,
+ },
+ },
+ ],
+ },
+ references: [
+ {
+ name: 'action_0',
+ type: 'action',
+ id: '1',
+ },
+ ],
+ });
+ taskManager.schedule.mockResolvedValueOnce({
+ id: 'task-123',
+ taskType: 'alerting:123',
+ scheduledAt: new Date(),
+ attempts: 1,
+ status: TaskStatus.Idle,
+ runAt: new Date(),
+ startedAt: null,
+ retryAt: null,
+ state: {},
+ params: {},
+ ownerId: null,
+ });
+
+ await alertsClient.create({ data });
+ expect(alertsClientParams.createAPIKey).toHaveBeenCalledWith('Alerting: 123/my alert name');
+ });
+
  test('should validate params', async () => {
  const data = getMockData();
  alertTypeRegistry.get.mockReturnValue({
@@ -2896,9 +2960,13 @@ describe('update()', () => {
  type: 'alert',
  attributes: {
  enabled: true,
+ tags: ['foo'],
  alertTypeId: 'myType',
+ schedule: { interval: '10s' },
  consumer: 'myApp',
  scheduledTaskId: 'task-123',
+ params: {},
+ throttle: null,
  actions: [
  {
  group: 'default',
@@ -2927,7 +2995,7 @@ describe('update()', () => {
  unsecuredSavedObjectsClient.get.mockResolvedValue(existingAlert);
  encryptedSavedObjects.getDecryptedAsInternalUser.mockResolvedValue(existingDecryptedAlert);
  alertTypeRegistry.get.mockReturnValue({
- id: '123',
+ id: 'myType',
  name: 'Test',
  actionGroups: [{ id: 'default', name: 'Default' }],
  defaultActionGroupId: 'default',
@@ -3489,6 +3557,64 @@ describe('update()', () => {
  );
  });
 
+ it('should trim alert name in the API key name', async () => {
+ unsecuredSavedObjectsClient.bulkGet.mockResolvedValueOnce({
+ saved_objects: [
+ {
+ id: '1',
+ type: 'action',
+ attributes: {
+ actions: [],
+ actionTypeId: 'test',
+ },
+ references: [],
+ },
+ ],
+ });
+ unsecuredSavedObjectsClient.update.mockResolvedValueOnce({
+ id: '1',
+ type: 'alert',
+ attributes: {
+ enabled: false,
+ name: ' my alert name ',
+ schedule: { interval: '10s' },
+ params: {
+ bar: true,
+ },
+ createdAt: new Date().toISOString(),
+ actions: [
+ {
+ group: 'default',
+ actionRef: 'action_0',
+ actionTypeId: 'test',
+ params: {
+ foo: true,
+ },
+ },
+ ],
+ scheduledTaskId: 'task-123',
+ apiKey: null,
+ },
+ updated_at: new Date().toISOString(),
+ references: [
+ {
+ name: 'action_0',
+ type: 'action',
+ id: '1',
+ },
+ ],
+ });
+ await alertsClient.update({
+ id: '1',
+ data: {
+ ...existingAlert.attributes,
+ name: ' my alert name ',
+ },
+ });
+
+ expect(alertsClientParams.createAPIKey).toHaveBeenCalledWith('Alerting: myType/my alert name');
+ });
+
  it('swallows error when invalidate API key throws', async () => {
  alertsClientParams.invalidateAPIKey.mockRejectedValueOnce(new Error('Fail'));
  unsecuredSavedObjectsClient.bulkGet.mockResolvedValueOnce({

diff --git a/x-pack/plugins/alerts/server/alerts_client.ts b/x-pack/plugins/alerts/server/alerts_client.ts
@@ -5,7 +5,7 @@
  */
 
 import Boom from 'boom';
-import { omit, isEqual, map, uniq, pick, truncate } from 'lodash';
+import { omit, isEqual, map, uniq, pick, truncate, trim } from 'lodash';
 import { i18n } from '@kbn/i18n';
 import {
  Logger,
@@ -940,7 +940,7 @@ export class AlertsClient {
  }
 
  private generateAPIKeyName(alertTypeId: string, alertName: string) {
- return truncate(`Alerting: ${alertTypeId}/${alertName}`, { length: 256 });
+ return truncate(`Alerting: ${alertTypeId}/${trim(alertName)}`, { length: 256 });
  }
 }