Skip to content

Add password configuration to datasource settings #17

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

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all 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
4 changes: 4 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0

## [Unreleased]

### Added

- Add a 'password' field to the datasource settings and pass this when connecting to Materialize. This is required for Materialize Cloud.
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
- Add a 'password' field to the datasource settings and pass this when connecting to Materialize. This is required for Materialize Cloud.
- Add a `password` field to the datasource settings and pass this when connecting to Materialize. This is required for Materialize Cloud.


## [0.1.1] - 2022-08-12

### Changed
Expand Down
14 changes: 10 additions & 4 deletions backend/src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -38,12 +38,18 @@ impl MaterializePlugin {
let settings: MaterializeDatasourceSettings =
serde_json::from_value(datasource_settings.json_data.clone())
.map_err(Error::InvalidDatasourceSettings)?;
let (client, connection) = Config::new()
let mut config = Config::new();
config
.user(&settings.username)
.host(&settings.host)
.port(settings.port)
.connect(NoTls)
.await?;
.port(settings.port);
if let Some(p) = &datasource_settings
.decrypted_secure_json_data
.get("password")
{
config.password(p);
}
let (client, connection) = config.connect(NoTls).await?;
tokio::spawn(async move {
if let Err(e) = connection.await {
eprintln!("connection error: {}", e);
Expand Down
2 changes: 1 addition & 1 deletion docker-compose.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ version: "3"

services:
grafana:
image: grafana/grafana:9.0.7
image: grafana/grafana:9.1.6
ports:
- "3000:3000"
restart: on-failure
Expand Down
10 changes: 5 additions & 5 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -13,14 +13,14 @@
"author": "Ben Sully",
"license": "Apache-2.0",
"devDependencies": {
"@grafana/data": "^9.0.0",
"@grafana/runtime": "^9.0.0",
"@grafana/toolkit": "^9.0.0",
"@grafana/ui": "^9.0.0",
"@grafana/data": "^9.1.0",
"@grafana/runtime": "^9.1.0",
"@grafana/toolkit": "^9.1.0",
"@grafana/ui": "^9.1.0",
"@types/lodash": "^4.14.177"
},
"resolutions": {
"rxjs": "7.5.5"
"rxjs": "7.5.6"
},
"engines": {
"node": ">=14"
Expand Down
19 changes: 15 additions & 4 deletions src/ConfigEditor.tsx
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
import React, { useCallback } from 'react';
import { DataSourcePluginOptionsEditorProps, DataSourceSettings } from '@grafana/data';
import { DataSourceOptions } from './types';
import { FieldSet, Form, InlineField, Input } from '@grafana/ui';
import { DataSourceOptions, DataSourceSecureOptions } from './types';
import { FieldSet, Form, InlineField, Input, SecretInput } from '@grafana/ui';

interface Props extends DataSourcePluginOptionsEditorProps<DataSourceOptions> {}
interface Props extends DataSourcePluginOptionsEditorProps<DataSourceOptions, DataSourceSecureOptions> { }

export const ConfigEditor = ({ options, onOptionsChange }: Props): JSX.Element => {
const onSettingsChange = useCallback(
(change: Partial<DataSourceSettings<DataSourceOptions>>) => {
(change: Partial<DataSourceSettings<DataSourceOptions, DataSourceSecureOptions>>) => {
onOptionsChange({
...options,
...change,
Expand Down Expand Up @@ -52,6 +52,17 @@ export const ConfigEditor = ({ options, onOptionsChange }: Props): JSX.Element =
}
/>
</InlineField>

<InlineField label="Password" labelWidth={20}>
<SecretInput
isConfigured={!!options.secureJsonData?.password ?? false}
onReset={() => onSettingsChange({ secureJsonData: { ...options.secureJsonData, password: undefined } })}
value={options.secureJsonData?.password}
onBlur={(event) =>
onSettingsChange({ secureJsonData: { ...options.secureJsonData, password: event.currentTarget.value } })
}
/>
</InlineField>
</FieldSet>
</>
)}
Expand Down
7 changes: 7 additions & 0 deletions src/types.ts
Original file line number Diff line number Diff line change
Expand Up @@ -70,3 +70,10 @@ export interface DataSourceOptions extends DataSourceJsonData {
port?: number;
username?: string;
}

/**
* These are secure options configured for each DataSource instance.
*/
export interface DataSourceSecureOptions extends DataSourceJsonData {
password?: string;
}
Loading