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

Change class component ConfigEditor to functional component #227

Merged
merged 1 commit into from
Dec 18, 2023
Merged

Change class component ConfigEditor to functional component #227

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
336 changes: 175 additions & 161 deletions src/ui/ConfigEditor.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
import { DataSourcePluginOptionsEditorProps, SelectableValue } from '@grafana/data';
import { Alert, FieldSet, InlineField, LegacyForms, Select } from '@grafana/ui';
import React, { ChangeEvent, PureComponent } from 'react';
import React, { ChangeEvent, useCallback } from 'react';

import { Backend, DataSourceOptions, Edition, SecureJsonData } from '../types';

Expand All @@ -9,61 +9,88 @@ const { SecretFormField, FormField } = LegacyForms;
// eslint-disable-next-line @typescript-eslint/no-empty-interface
interface Props extends DataSourcePluginOptionsEditorProps<DataSourceOptions, SecureJsonData> {}

// eslint-disable-next-line @typescript-eslint/no-empty-interface
interface State {}

export class ConfigEditor extends PureComponent<Props, State> {
onUrlChange = (event: ChangeEvent<HTMLInputElement>): void => {
const { onOptionsChange, options } = this.props;
const jsonData = {
...options.jsonData,
url: event.target.value,
};
onOptionsChange({ ...options, jsonData });
};

onEditionChange = ({ value }: SelectableValue<Edition>): void => {
const { onOptionsChange, options } = this.props;
const jsonData = {
...options.jsonData,
edition: value,
};
onOptionsChange({ ...options, jsonData });
};

onBackendChange = ({ value }: SelectableValue<Backend>): void => {
const { onOptionsChange, options } = this.props;
onOptionsChange({
...options,
jsonData: {
interface EditionOption {
value: Edition;
label: string;
}

const cmkEditions: EditionOption[] = [
{ value: 'CEE', label: 'Commercial editions' },
{ value: 'RAW', label: 'Raw Edition' },
];

const cmkBackends: Array<SelectableValue<Backend>> = [
{ value: 'rest', label: '>= 2.2' },
{ value: 'web', label: '< 2.2' },
];

export const ConfigEditor = (props: Props) => {
const onUrlChange = useCallback(
(event: ChangeEvent<HTMLInputElement>): void => {
const { onOptionsChange, options } = props;
const jsonData = {
...options.jsonData,
backend: value,
},
});
};
url: event.target.value,
};
onOptionsChange({ ...options, jsonData });
},
[props]
);

const onEditionChange = useCallback(
({ value }: SelectableValue<Edition>): void => {
const { onOptionsChange, options } = props;
const jsonData = {
...options.jsonData,
edition: value,
};
onOptionsChange({ ...options, jsonData });
},
[props]
);

const onBackendChange = useCallback(
({ value }: SelectableValue<Backend>): void => {
const { onOptionsChange, options } = props;
onOptionsChange({
...options,
jsonData: {
...options.jsonData,
backend: value,
},
});
},
[props]
);

onUsernameChange = (event: ChangeEvent<HTMLInputElement>): void => {
const { onOptionsChange, options } = this.props;
const jsonData = {
...options.jsonData,
username: event.target.value,
};
onOptionsChange({ ...options, jsonData });
};
const onUsernameChange = useCallback(
(event: ChangeEvent<HTMLInputElement>): void => {
const { onOptionsChange, options } = props;
const jsonData = {
...options.jsonData,
username: event.target.value,
};
onOptionsChange({ ...options, jsonData });
},
[props]
);

// Secure field (only sent to the backend)
onSecretChange = (event: ChangeEvent<HTMLInputElement>): void => {
const { onOptionsChange, options } = this.props;
onOptionsChange({
...options,
secureJsonData: {
secret: event.target.value,
},
});
};
const onSecretChange = useCallback(
(event: ChangeEvent<HTMLInputElement>): void => {
const { onOptionsChange, options } = props;
onOptionsChange({
...options,
secureJsonData: {
secret: event.target.value,
},
});
},
[props]
);

onResetSecret = (): void => {
const { onOptionsChange, options } = this.props;
const onResetSecret = useCallback((): void => {
const { onOptionsChange, options } = props;
onOptionsChange({
...options,
secureJsonFields: {
Expand All @@ -75,114 +102,101 @@ export class ConfigEditor extends PureComponent<Props, State> {
secret: '',
},
});
};

render(): JSX.Element {
const { options } = this.props;
const { jsonData, secureJsonFields } = options;
const secureJsonData = options.secureJsonData || {};
interface EditionOption {
value: Edition;
label: string;
}

const cmkEditions: EditionOption[] = [
{ value: 'CEE', label: 'Commercial editions' },
{ value: 'RAW', label: 'Raw Edition' },
];
if (!jsonData.edition) {
this.onEditionChange(cmkEditions[0]);
}
const cmkBackends: Array<SelectableValue<Backend>> = [
{ value: 'rest', label: '>= 2.2' },
{ value: 'web', label: '< 2.2' },
];
if (!jsonData.backend) {
this.onBackendChange(cmkBackends[0]);
}

return (
<>
<FieldSet label="Monitoring Site">
<div className="gf-form">
<FormField
label="URL"
labelWidth={6}
inputWidth={20}
onChange={this.onUrlChange}
value={jsonData.url || ''}
tooltip="Which Checkmk Server to connect to. (Example: https://checkmk.server/site)"
data-test-id="checkmk-url"
/>
</div>
{process.env.BUILD_EDITION !== 'CLOUD' ? (
<>
<InlineField label="Edition" labelWidth={12}>
<Select
width={32}
options={cmkEditions}
onChange={this.onEditionChange}
value={jsonData.edition}
placeholder="Select your checkmk edition"
inputId="checkmk-edition"
/>
</InlineField>
<InlineField
label="Version"
labelWidth={12}
tooltip="Choose the appropriate version for your Checkmk installation"
>
<Select
width={32}
options={cmkBackends}
onChange={this.onBackendChange}
value={jsonData.backend}
placeholder="Select your checkmk version"
inputId="checkmk-version"
/>
</InlineField>
{jsonData.backend === 'web' && (
<Alert title="Feature degration warning" severity="warning">
Note that versions older than 2.1.0 are not officially supported:
<ul>
<li>- Version 2.0.0 may work, but not all features are available.</li>
<li>- Version 1.6.0 and earlier will not work at all.</li>
</ul>
</Alert>
)}
</>
) : (
<></>
)}
</FieldSet>
<FieldSet label="Authentication">
<div className="gf-form">
<FormField
label="Username"
labelWidth={6}
inputWidth={20}
onChange={this.onUsernameChange}
value={jsonData.username || ''}
tooltip="A checkmk monitoring user. Don't use 'automation' user, because it has admin rights."
data-test-id="checkmk-username"
/>
</div>
<div className="gf-form">
<SecretFormField
isConfigured={(secureJsonFields && secureJsonFields.secret) as boolean}
value={secureJsonData.secret || ''}
label="Secret"
placeholder=""
labelWidth={6}
inputWidth={20}
onReset={this.onResetSecret}
onChange={this.onSecretChange}
tooltip="You can find the secret for your user in your checkmk server under Users."
data-test-id="checkmk-password"
/>
</div>
</FieldSet>
</>
);
}, [props]);

const { options } = props;
const { jsonData, secureJsonFields } = options;
const secureJsonData = options.secureJsonData || {};

if (!jsonData.edition) {
onEditionChange(cmkEditions[0]);
}
}

if (!jsonData.backend) {
onBackendChange(cmkBackends[0]);
}

return (
<>
<FieldSet label="Monitoring Site">
<div className="gf-form">
<FormField
label="URL"
labelWidth={6}
inputWidth={20}
onChange={onUrlChange}
value={jsonData.url || ''}
tooltip="Which Checkmk Server to connect to. (Example: https://checkmk.server/site)"
data-test-id="checkmk-url"
/>
</div>
{process.env.BUILD_EDITION !== 'CLOUD' ? (
<>
<InlineField label="Edition" labelWidth={12}>
<Select
width={32}
options={cmkEditions}
onChange={onEditionChange}
value={jsonData.edition}
placeholder="Select your checkmk edition"
inputId="checkmk-edition"
/>
</InlineField>
<InlineField
label="Version"
labelWidth={12}
tooltip="Choose the appropriate version for your Checkmk installation"
>
<Select
width={32}
options={cmkBackends}
onChange={onBackendChange}
value={jsonData.backend}
placeholder="Select your checkmk version"
inputId="checkmk-version"
/>
</InlineField>
{jsonData.backend === 'web' && (
<Alert title="Feature degration warning" severity="warning">
Note that versions older than 2.1.0 are not officially supported:
<ul>
<li>- Version 2.0.0 may work, but not all features are available.</li>
<li>- Version 1.6.0 and earlier will not work at all.</li>
</ul>
</Alert>
)}
</>
) : (
<></>
)}
</FieldSet>
<FieldSet label="Authentication">
<div className="gf-form">
<FormField
label="Username"
labelWidth={6}
inputWidth={20}
onChange={onUsernameChange}
value={jsonData.username || ''}
tooltip="A checkmk monitoring user. Don't use 'automation' user, because it has admin rights."
data-test-id="checkmk-username"
/>
</div>
<div className="gf-form">
<SecretFormField
isConfigured={(secureJsonFields && secureJsonFields.secret) as boolean}
value={secureJsonData.secret || ''}
label="Secret"
placeholder=""
labelWidth={6}
inputWidth={20}
onReset={onResetSecret}
onChange={onSecretChange}
tooltip="You can find the secret for your user in your checkmk server under Users."
data-test-id="checkmk-password"
/>
</div>
</FieldSet>
</>
);
};
Loading