Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Security solution] Data stream resource initialization helper #197893

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from 3 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ import { loggingSystemMock } from '@kbn/core/server/mocks';
import {
createResourceInstallationHelper,
errorResult,
InitializationPromise,
InitializationState,
ResourceInstallationHelper,
successResult,
calculateDelay,
Expand Down Expand Up @@ -54,7 +54,7 @@ const getCommonInitPromise = async (
resolution: boolean,
timeoutMs: number = 1,
customLogString: string = ''
): Promise<InitializationPromise> => {
): Promise<InitializationState> => {
if (timeoutMs < 0) {
throw new Error('fail');
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
import { DEFAULT_NAMESPACE_STRING } from '@kbn/core-saved-objects-utils-server';
import { Logger } from '@kbn/core/server';

export interface InitializationPromise {
export interface InitializationState {
result: boolean;
error?: string;
}
Expand All @@ -23,10 +23,10 @@ export interface ResourceInstallationHelper {
add: (namespace?: string, timeoutMs?: number) => void;
retry: (
namespace?: string,
initPromise?: Promise<InitializationPromise>,
initPromise?: Promise<InitializationState>,
timeoutMs?: number
) => void;
getInitializedResources: (namespace: string) => Promise<InitializationPromise>;
getInitializedResources: (namespace: string) => Promise<InitializationState>;
}

/**
Expand All @@ -42,17 +42,17 @@ export interface ResourceInstallationHelper {
*/
export function createResourceInstallationHelper(
logger: Logger,
commonResourcesInitPromise: Promise<InitializationPromise>,
commonResourcesInitPromise: Promise<InitializationState>,
installFn: (namespace: string, timeoutMs?: number) => Promise<void>
): ResourceInstallationHelper {
let commonInitPromise: Promise<InitializationPromise> = commonResourcesInitPromise;
const initializedResources: Map<string, Promise<InitializationPromise>> = new Map();
let commonInitPromise: Promise<InitializationState> = commonResourcesInitPromise;
const initializedResources: Map<string, Promise<InitializationState>> = new Map();
const lastRetry: Map<string, Retry> = new Map();

const waitUntilResourcesInstalled = async (
namespace: string = DEFAULT_NAMESPACE_STRING,
timeoutMs?: number
): Promise<InitializationPromise> => {
): Promise<InitializationState> => {
try {
const { result: commonInitResult, error: commonInitError } = await commonInitPromise;
if (commonInitResult) {
Expand Down Expand Up @@ -81,7 +81,7 @@ export function createResourceInstallationHelper(
},
retry: (
namespace: string = DEFAULT_NAMESPACE_STRING,
initPromise?: Promise<InitializationPromise>,
initPromise?: Promise<InitializationState>,
timeoutMs?: number
) => {
const key = namespace;
Expand Down Expand Up @@ -109,19 +109,23 @@ export function createResourceInstallationHelper(
);
}
},
getInitializedResources: async (namespace: string): Promise<InitializationPromise> => {
const key = namespace;
return (
initializedResources.has(key)
? initializedResources.get(key)
: errorResult(`Unrecognized spaceId ${key}`)
) as InitializationPromise;
getInitializedResources: async (namespace: string): Promise<InitializationState> => {
try {
const key = namespace;
if (!initializedResources.has(key)) {
return errorResult(`Unrecognized spaceId ${key}`);
}
const initializationState = await initializedResources.get(key);
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Key fix is adding await here

return initializationState ?? errorResult(`Initialize state returned undefined`);
} catch (e) {
return errorResult(`Initialize resources encountered an error: ${e.message}`);
}
},
};
}

export const successResult = () => ({ result: true });
export const errorResult = (error?: string) => ({ result: false, error });
export const errorResult = (error?: string): InitializationState => ({ result: false, error });

export const getShouldRetry = ({ time, attempts }: Retry) => {
const now = new Date().valueOf();
Expand Down