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.

Sign up for GitHub

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

feat: Add MDS support for index pattern validate script #9371

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

feat: Add MDS support for index pattern validate script #9371

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e6aa068
feat: add MDS support for validate script
raintygao Feb 12, 2025
aaaf852
Changeset file for PR #9371 created/updated
opensearch-changeset-bot[bot] Feb 12, 2025
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
2 changes: 2 additions & 0 deletions changelogs/fragments/9371.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
feat:
- Add MDS support for index pattern validate script ([#9371](https://github.com/opensearch-project/OpenSearch-Dashboards/pull/9371))
1 change: 1 addition & 0 deletions ...ttern_management/public/components/field_editor/components/scripting_help/test_script.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -122,6 +122,7 @@ export class TestScript extends Component<TestScriptProps, TestScriptState> {
query,
additionalFields: this.state.additionalFields.map((option: AdditionalField) => option.value),
http: this.context.services.http,
dataSourceId: indexPattern.dataSourceRef?.id,
});

if (scriptResponse.status !== 200) {
Expand Down
3 changes: 3 additions & 0 deletions src/plugins/index_pattern_management/public/components/field_editor/field_editor.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -136,6 +136,7 @@ export interface FieldEditorState {
errors?: string[];
format: any;
spec: IndexPatternField['spec'];
dataSourceId?: string;
}

export interface FieldEdiorProps {
Expand Down Expand Up @@ -176,6 +177,7 @@ export class FieldEditor extends PureComponent<FieldEdiorProps, FieldEditorState
isSaving: false,
format: props.indexPattern.getFormatterForField(spec),
spec: { ...spec },
dataSourceId: indexPattern.dataSourceRef?.id,
};
this.supportedLangs = getSupportedScriptingLanguages();
this.deprecatedLangs = getDeprecatedScriptingLanguages();
Expand Down Expand Up @@ -799,6 +801,7 @@ export class FieldEditor extends PureComponent<FieldEdiorProps, FieldEditorState
script: field.script as string,
indexPatternTitle: indexPattern.title,
http: this.context.services.http,
dataSourceId: this.state.dataSourceId,
Copy link
Member

Choose a reason for hiding this comment

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

Should we use props.indexPattern.dataSourceRef?.id? I do not think a dataSourceId state is necessary for this component.

});

if (!isValid) {
Expand Down
7 changes: 7 additions & 0 deletions src/plugins/index_pattern_management/public/components/field_editor/lib/validate_script.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,7 @@ export const executeScript = async ({
query,
additionalFields = [],
http,
dataSourceId,
}: ExecuteScriptParams): Promise<ExecuteScriptResult> => {
return http
.post('/internal/index-pattern-management/preview_scripted_field', {
Expand All @@ -48,6 +49,9 @@ export const executeScript = async ({
query,
additionalFields,
}),
query: {
dataSourceId,
},
})
.then((res) => ({
status: res.statusCode,
Expand All @@ -64,17 +68,20 @@ export const isScriptValid = async ({
script,
indexPatternTitle,
http,
dataSourceId,
}: {
name: string;
script: string;
indexPatternTitle: string;
http: HttpStart;
dataSourceId?: string;
}) => {
const scriptResponse = await executeScript({
name,
script,
indexPatternTitle,
http,
dataSourceId,
});

if (scriptResponse.status !== 200) {
Expand Down
1 change: 1 addition & 0 deletions src/plugins/index_pattern_management/public/components/field_editor/types.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,7 @@ export interface ExecuteScriptParams {
query?: Query['query'];
additionalFields?: string[];
http: HttpStart;
dataSourceId?: string;
}

export interface ExecuteScriptResult {
Expand Down
9 changes: 8 additions & 1 deletion src/plugins/index_pattern_management/server/routes/preview_scripted_field.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,11 +43,18 @@ export function registerPreviewScriptedFieldRoute(router: IRouter): void {
query: schema.maybe(schema.object({}, { unknowns: 'allow' })),
additionalFields: schema.maybe(schema.arrayOf(schema.string())),
}),
query: schema.object({
dataSourceId: schema.maybe(schema.string()),
}),
},
},
async (context, request, res) => {
const client = context.core.opensearch.client.asCurrentUser;
const { index, name, script, query, additionalFields } = request.body;
const { dataSourceId } = request.query;
const client =
dataSourceId && context.dataSource
? await context.dataSource.opensearch.getClient(dataSourceId)
Copy link
Contributor

Choose a reason for hiding this comment

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

Do we need to handle the error during getClient?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I think there may be no need because if the remote client can't be got, it should throw error as expected.

Copy link
Member

Choose a reason for hiding this comment

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

We may need to wrap the getClient or the http request may give statusCode of 500.

: context.core.opensearch.client.asCurrentUser;

try {
const response = await client.search({
Expand Down
Loading