Skip to content

Commit

Permalink
[Synthetics] Private location better error handling (elastic#152695)
Browse files Browse the repository at this point in the history 
Co-authored-by: Dominique Clarke <dominique.clarke@elastic.co>
(cherry picked from commit 1aba7df)
  • Loading branch information
@shahzad31
shahzad31 committed May 5, 2023
1 parent 592fc0d commit a218fa0
Show file tree
Hide file tree
Showing 31 changed files with 1,098 additions and 521 deletions.
65 changes: 47 additions & 18 deletions x-pack/plugins/fleet/server/services/package_policy.test.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,11 @@ import type {
} from '../../common/types';
import { packageToPackagePolicy } from '../../common/services';

import { FleetError, PackagePolicyIneligibleForUpgradeError } from '../errors';
import {
FleetError,
PackagePolicyIneligibleForUpgradeError,
PackagePolicyValidationError,
} from '../errors';

import { PACKAGE_POLICY_SAVED_OBJECT_TYPE } from '../constants';

Expand Down Expand Up @@ -1725,32 +1729,47 @@ describe('Package policy service', () => {
],
});

savedObjectsClient.update.mockImplementation(
savedObjectsClient.bulkUpdate.mockImplementation(
async (
type: string,
id: string,
attrs: any
): Promise<SavedObjectsUpdateResponse<PackagePolicySOAttributes>> => {
savedObjectsClient.get.mockResolvedValue({
objs: Array<{
type: string;
id: string;
attributes: any;
}>
) => {
const newObjs = objs.map((obj) => ({
id: 'test',
type: 'abcd',
references: [],
version: 'test',
attributes: attrs,
attributes: obj.attributes,
}));
savedObjectsClient.bulkGet.mockResolvedValue({
saved_objects: newObjs,
});
return attrs;
return {
saved_objects: newObjs,
};
}
);

const elasticsearchClient = elasticsearchServiceMock.createClusterClient().asInternalUser;

const res = packagePolicyService.bulkUpdate(
const toUpdate = { ...mockPackagePolicy, inputs: inputsUpdate };

const res = await packagePolicyService.bulkUpdate(
savedObjectsClient,
elasticsearchClient,

[{ ...mockPackagePolicy, inputs: inputsUpdate }]
[toUpdate]
);

await expect(res).rejects.toThrow('cat is a frozen variable and cannot be modified');
expect(res.failedPolicies).toHaveLength(1);
expect(res.updatedPolicies).toHaveLength(0);
expect(res.failedPolicies[0].packagePolicy).toEqual(toUpdate);
expect(res.failedPolicies[0].error).toEqual(
new PackagePolicyValidationError(`cat is a frozen variable and cannot be modified`)
);
});

it('should allow to update input vars that are frozen with the force flag', async () => {
Expand Down Expand Up @@ -1882,7 +1901,11 @@ describe('Package policy service', () => {
{ force: true }
);

const [modifiedInput] = result![0].inputs;
expect(result.updatedPolicies).toHaveLength(1);

const updatedPolicy = result.updatedPolicies?.[0]!;

const [modifiedInput] = updatedPolicy.inputs;
expect(modifiedInput.enabled).toEqual(true);
expect(modifiedInput.vars!.dog.value).toEqual('labrador');
expect(modifiedInput.vars!.cat.value).toEqual('tabby');
Expand Down Expand Up @@ -2016,7 +2039,11 @@ describe('Package policy service', () => {
[{ ...mockPackagePolicy, inputs: inputsUpdate }]
);

const [modifiedInput] = result![0].inputs;
expect(result.updatedPolicies).toHaveLength(1);

const updatedPolicy = result.updatedPolicies?.[0]!;

const [modifiedInput] = updatedPolicy.inputs;
expect(modifiedInput.enabled).toEqual(true);
expect(modifiedInput.vars!.dog.value).toEqual('labrador');
expect(modifiedInput.vars!.cat.value).toEqual('siamese');
Expand Down Expand Up @@ -2082,13 +2109,15 @@ describe('Package policy service', () => {

const elasticsearchClient = elasticsearchServiceMock.createClusterClient().asInternalUser;

const result = await packagePolicyService.bulkUpdate(
const { updatedPolicies } = await packagePolicyService.bulkUpdate(
savedObjectsClient,
elasticsearchClient,
[{ ...mockPackagePolicy, inputs: [] }]
);

expect(result![0].elasticsearch).toMatchObject({ privileges: { cluster: ['monitor'] } });
expect(updatedPolicies![0].elasticsearch).toMatchObject({
privileges: { cluster: ['monitor'] },
});
});

it('should not mutate packagePolicyUpdate object when trimming whitespace', async () => {
Expand Down Expand Up @@ -2138,7 +2167,7 @@ describe('Package policy service', () => {

const elasticsearchClient = elasticsearchServiceMock.createClusterClient().asInternalUser;

const result = await packagePolicyService.bulkUpdate(
const { updatedPolicies } = await packagePolicyService.bulkUpdate(
savedObjectsClient,
elasticsearchClient,
// this mimics the way that OSQuery plugin create immutable objects
Expand All @@ -2150,7 +2179,7 @@ describe('Package policy service', () => {
]
);

expect(result![0].name).toEqual('test');
expect(updatedPolicies![0].name).toEqual('test');
});

it('should send telemetry event when upgrading a package policy', async () => {
Expand Down
136 changes: 109 additions & 27 deletions x-pack/plugins/fleet/server/services/package_policy.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,8 @@ import type {
SavedObjectsClientContract,
Logger,
RequestHandlerContext,
SavedObjectsBulkCreateObject,
SavedObjectsBulkUpdateObject,
} from '@kbn/core/server';
import { SavedObjectsUtils } from '@kbn/core/server';
import { v4 as uuidv4 } from 'uuid';
Expand All @@ -27,6 +29,8 @@ import { type AuthenticatedUser } from '@kbn/security-plugin/server';

import pMap from 'p-map';

import type { SavedObjectError } from '@kbn/core-saved-objects-common';

import { HTTPAuthorizationHeader } from '../../common/http_authorization_header';

import {
Expand Down Expand Up @@ -301,7 +305,10 @@ class PackagePolicyClientImpl implements PackagePolicyClient {
bumpRevision?: boolean;
force?: true;
}
): Promise<PackagePolicy[]> {
): Promise<{
created: PackagePolicy[];
failed: Array<{ packagePolicy: NewPackagePolicy; error?: Error | SavedObjectError }>;
}> {
for (const packagePolicy of packagePolicies) {
if (!packagePolicy.id) {
packagePolicy.id = SavedObjectsUtils.generateId();
Expand All @@ -323,9 +330,24 @@ class PackagePolicyClientImpl implements PackagePolicyClient {
const packageInfos = await getPackageInfoForPackagePolicies(packagePolicies, soClient);

const isoDate = new Date().toISOString();
// eslint-disable-next-line @typescript-eslint/naming-convention
const { saved_objects } = await soClient.bulkCreate<PackagePolicySOAttributes>(
await pMap(packagePolicies, async (packagePolicy) => {

const policiesToCreate: Array<SavedObjectsBulkCreateObject<PackagePolicySOAttributes>> = [];
const failedPolicies: Array<{
packagePolicy: NewPackagePolicyWithId;
error: Error | SavedObjectError;
}> = [];

const logger = appContextService.getLogger();

const packagePoliciesWithIds = packagePolicies.map((p) => {
if (!p.id) {
p.id = SavedObjectsUtils.generateId();
}
return p;
});

await pMap(packagePoliciesWithIds, async (packagePolicy) => {
try {
const packagePolicyId = packagePolicy.id ?? uuidv4();
const agentPolicyId = packagePolicy.policy_id;

Expand All @@ -348,7 +370,7 @@ class PackagePolicyClientImpl implements PackagePolicyClient {
elasticsearch = pkgInfo?.elasticsearch;
}

return {
policiesToCreate.push({
type: SAVED_OBJECT_TYPE,
id: packagePolicyId,
attributes: {
Expand All @@ -365,12 +387,32 @@ class PackagePolicyClientImpl implements PackagePolicyClient {
updated_at: isoDate,
updated_by: options?.user?.username ?? 'system',
},
};
})
});
} catch (error) {
failedPolicies.push({ packagePolicy, error });
logger.error(error);
}
});

const { saved_objects: createdObjects } = await soClient.bulkCreate<PackagePolicySOAttributes>(
policiesToCreate
);

// Filter out invalid SOs
const newSos = saved_objects.filter((so) => !so.error && so.attributes);
const newSos = createdObjects.filter((so) => !so.error && so.attributes);

packagePoliciesWithIds.forEach((packagePolicy) => {
const hasCreatedSO = newSos.find((so) => so.id === packagePolicy.id);
const hasFailed = failedPolicies.some(
({ packagePolicy: failedPackagePolicy }) => failedPackagePolicy.id === packagePolicy.id
);
if (hasCreatedSO?.error && !hasFailed) {
failedPolicies.push({
packagePolicy,
error: hasCreatedSO?.error ?? new Error('Failed to create package policy.'),
});
}
});

// Assign it to the given agent policy

Expand All @@ -382,11 +424,14 @@ class PackagePolicyClientImpl implements PackagePolicyClient {
}
}

return newSos.map((newSo) => ({
id: newSo.id,
version: newSo.version,
...newSo.attributes,
}));
return {
created: newSos.map((newSo) => ({
id: newSo.id,
version: newSo.version,
...newSo.attributes,
})),
failed: failedPolicies,
};
}

public async get(
Expand Down Expand Up @@ -730,7 +775,13 @@ class PackagePolicyClientImpl implements PackagePolicyClient {
packagePolicyUpdates: Array<NewPackagePolicy & { version?: string; id: string }>,
options?: { user?: AuthenticatedUser; force?: boolean },
currentVersion?: string
): Promise<PackagePolicy[] | null> {
): Promise<{
updatedPolicies: PackagePolicy[] | null;
failedPolicies: Array<{
packagePolicy: NewPackagePolicyWithId;
error: Error | SavedObjectError;
}>;
}> {
for (const packagePolicy of packagePolicyUpdates) {
auditLoggingService.writeCustomSoAuditLog({
action: 'update',
Expand All @@ -749,8 +800,14 @@ class PackagePolicyClientImpl implements PackagePolicyClient {

const packageInfos = await getPackageInfoForPackagePolicies(packagePolicyUpdates, soClient);

const { saved_objects: newPolicies } = await soClient.bulkUpdate<PackagePolicySOAttributes>(
await pMap(packagePolicyUpdates, async (packagePolicyUpdate) => {
const policiesToUpdate: Array<SavedObjectsBulkUpdateObject<PackagePolicySOAttributes>> = [];
const failedPolicies: Array<{
packagePolicy: NewPackagePolicyWithId;
error: Error | SavedObjectError;
}> = [];

await pMap(packagePolicyUpdates, async (packagePolicyUpdate) => {
try {
const id = packagePolicyUpdate.id;
const packagePolicy = { ...packagePolicyUpdate, name: packagePolicyUpdate.name.trim() };
const oldPackagePolicy = oldPackagePolicies.find((p) => p.id === id);
Expand Down Expand Up @@ -786,7 +843,7 @@ class PackagePolicyClientImpl implements PackagePolicyClient {
// Handle component template/mappings updates for experimental features, e.g. synthetic source
await handleExperimentalDatastreamFeatureOptIn({ soClient, esClient, packagePolicy });

return {
policiesToUpdate.push({
type: SAVED_OBJECT_TYPE,
id,
attributes: {
Expand All @@ -803,8 +860,14 @@ class PackagePolicyClientImpl implements PackagePolicyClient {
updated_by: options?.user?.username ?? 'system',
},
version,
};
})
});
} catch (error) {
failedPolicies.push({ packagePolicy: packagePolicyUpdate, error });
}
});

const { saved_objects: updatedPolicies } = await soClient.bulkUpdate<PackagePolicySOAttributes>(
policiesToUpdate
);

const agentPolicyIds = new Set(packagePolicyUpdates.map((p) => p.policy_id));
Expand Down Expand Up @@ -839,14 +902,32 @@ class PackagePolicyClientImpl implements PackagePolicyClient {

sendUpdatePackagePolicyTelemetryEvent(soClient, packagePolicyUpdates, oldPackagePolicies);

return newPolicies.map(
(soPolicy) =>
({
id: soPolicy.id,
version: soPolicy.version,
...soPolicy.attributes,
} as PackagePolicy)
);
updatedPolicies.forEach((policy) => {
if (policy.error) {
const hasAlreadyFailed = failedPolicies.some(
(failedPolicy) => failedPolicy.packagePolicy.id === policy.id
);
if (!hasAlreadyFailed) {
failedPolicies.push({
packagePolicy: packagePolicyUpdates.find((p) => p.id === policy.id)!,
error: policy.error,
});
}
}
});

const updatedPoliciesSuccess = updatedPolicies
.filter((policy) => !policy.error && policy.attributes)
.map(
(soPolicy) =>
({
id: soPolicy.id,
version: soPolicy.version,
...soPolicy.attributes,
} as PackagePolicy)
);

return { updatedPolicies: updatedPoliciesSuccess, failedPolicies };
}

public async delete(
Expand Down Expand Up @@ -1920,6 +2001,7 @@ function _enforceFrozenVars(
export interface NewPackagePolicyWithId extends NewPackagePolicy {
id?: string;
policy_id: string;
version?: string;
}

export const packagePolicyService: PackagePolicyClient = new PackagePolicyClientImpl();
Expand Down
Loading

0 comments on commit a218fa0

Please sign in to comment.