feat: replace obsolete components (#99)

* feat: replace obsolete components * Fix: remove deprecated components
michelin · Dec 4, 2024 · de87cf5 · de87cf5
1 parent 6f291cc
commit de87cf5
Show file tree

Hide file tree

Showing 7 changed files with 112 additions and 110 deletions.
diff --git a/.eslintcache b/.eslintcache
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,8 +1,9 @@
 # Changelog
 
-## 2.0.0 (not released yet)
-
+## 1.9.1
 
+### 🔨 Changed
+- Remove deprecated UI components
 
 ## 1.9.0
 

diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "michelin-snowflake-datasource",
-  "version": "2.0.0",
+  "version": "1.9.1",
   "description": "Data source for Snowflake",
   "scripts": {
     "build": "webpack -c ./.config/webpack/webpack.config.ts --env production",

diff --git a/src/ConfigEditor.tsx b/src/ConfigEditor.tsx
@@ -1,14 +1,23 @@
 import React, { ChangeEvent, PureComponent } from 'react';
-import {Checkbox, ControlledCollapse, LegacyForms} from '@grafana/ui';
+import {
+  Checkbox,
+  ControlledCollapse,
+  InlineField,
+  Input,
+  SecretInput,
+  SecretTextArea,
+  Switch
+} from '@grafana/ui';
 import { DataSourcePluginOptionsEditorProps } from '@grafana/data';
 import { SnowflakeOptions, SnowflakeSecureOptions } from './types';
 
-const { SecretFormField, FormField, Switch } = LegacyForms;
-
 interface Props extends DataSourcePluginOptionsEditorProps<SnowflakeOptions> {}
 
 interface State {}
 
+const LABEL_WIDTH = 30
+const INPUT_WIDTH = 40
+
 export class ConfigEditor extends PureComponent<Props, State> {
   onAccountChange = (event: ChangeEvent<HTMLInputElement>) => {
     const { onOptionsChange, options } = this.props;
@@ -21,7 +30,7 @@ export class ConfigEditor extends PureComponent<Props, State> {
     }
 
     // Sanitize value to avoid error
-    const regex = new RegExp('https?://');
+    const regex = /https?:\/\//;
     value = value.replace(regex, '');
 
     const jsonData = {
@@ -139,7 +148,7 @@ export class ConfigEditor extends PureComponent<Props, State> {
     });
   };
 
-  onPrivateKeyChange = (event: ChangeEvent<HTMLInputElement>) => {
+  onPrivateKeyChange = (event: ChangeEvent<HTMLTextAreaElement>) => {
     const { onOptionsChange, options } = this.props;
     onOptionsChange({
       ...options,
@@ -174,140 +183,134 @@ export class ConfigEditor extends PureComponent<Props, State> {
         <div className="gf-form-group">
           <h3 className="page-heading">Connection</h3>
 
-          <div className="gf-form">
-            <FormField
-                label="Account name"
-                labelWidth={10}
-                inputWidth={30}
+          <InlineField label="Account name"
+                       tooltip="All access to Snowflake is either through your account name (provided by Snowflake) or a URL that uses the following format: `xxxxx.snowflakecomputing.com`"
+                       labelWidth={LABEL_WIDTH}>
+            <Input
                 onChange={this.onAccountChange}
-                tooltip="All access to Snowflake is either through your account name (provided by Snowflake) or a URL that uses the following format: `xxxxx.snowflakecomputing.com`"
-                value={jsonData.account || ''}
+                value={jsonData.account ?? ''}
                 placeholder="xxxxxx.snowflakecomputing.com"
+                width={INPUT_WIDTH}
             />
-          </div>
-
-          <div className="gf-form">
-            <FormField
-                label="Username"
-                labelWidth={10}
-                inputWidth={20}
+          </InlineField>
+          <InlineField label="Username"
+                       labelWidth={LABEL_WIDTH}>
+            <Input
                 onChange={this.onUsernameChange}
-                value={jsonData.username || ''}
+                value={jsonData.username ?? ''}
                 placeholder="Username"
+                width={INPUT_WIDTH}
             />
-          </div>
-
-          <div className="gf-form">
+          </InlineField>
+          <InlineField label="basic or key pair authentication"
+                       style={{alignItems: 'center'}}
+                       labelWidth={LABEL_WIDTH}>
             <Switch
-                label="basic or key pair authentication"
-                checked={jsonData.basicAuth}
+                checked={jsonData.basicAuth ?? false}
+                style={{ textAlign: 'center' }}
                 onChange={this.onAuthenticationChange}
             />
-          </div>
-          <div className="gf-form">
-            {!jsonData.basicAuth && (
-                <SecretFormField
-                    isConfigured={(secureJsonFields && secureJsonFields.password) as boolean}
-                    value={secureJsonData.password || ''}
-                    label="Password"
+          </InlineField>
+          {!jsonData.basicAuth && (
+              <InlineField label="Password"
+                           labelWidth={LABEL_WIDTH}>
+                <SecretInput
+                    isConfigured={secureJsonFields?.password}
+                    value={secureJsonData.password ?? ''}
                     placeholder="password"
-                    labelWidth={10}
-                    inputWidth={20}
+                    width={INPUT_WIDTH}
                     onReset={this.onResetPassword}
                     onChange={this.onPasswordChange}
                 />
-            )}
-            {jsonData.basicAuth && (
-                <SecretFormField
-                    isConfigured={(secureJsonFields && secureJsonFields.privateKey) as boolean}
-                    value={secureJsonData.privateKey || ''}
-                    tooltip="The private key must be encoded in base 64 URL encoded pkcs8 (remove PEM header '----- BEGIN PRIVATE KEY -----' and '----- END PRIVATE KEY -----', remove line space and replace '+' with '-' and '/' with '_')"
-                    label="Private key"
+              </InlineField>
+          )}
+          {jsonData.basicAuth && (
+              <InlineField label="Private key"
+                           tooltip="The private key must be encoded in base 64 URL encoded pkcs8 (remove PEM header '----- BEGIN PRIVATE KEY -----' and '----- END PRIVATE KEY -----', remove line space and replace '+' with '-' and '/' with '_')"
+                           labelWidth={LABEL_WIDTH}>
+                <SecretTextArea
+                    isConfigured={secureJsonFields?.privateKey}
+                    value={secureJsonData.privateKey ?? ''}
                     placeholder="MIIB..."
-                    labelWidth={10}
-                    inputWidth={20}
                     onReset={this.onResetPrivateKey}
                     onChange={this.onPrivateKeyChange}
+                    cols={38}
+                    rows={5}
                 />
-            )}
-          </div>
-          <div className="gf-form">
-            <FormField
-                label="Role"
-                labelWidth={10}
-                inputWidth={20}
+              </InlineField>
+          )}
+          <InlineField label="Role"
+                       labelWidth={LABEL_WIDTH}>
+            <Input
+                width={INPUT_WIDTH}
                 onChange={this.onRoleChange}
-                value={jsonData.role || ''}
+                value={jsonData.role ?? ''}
                 placeholder="Role"
             />
-          </div>
+          </InlineField>
           <br/>
           <h3 className="page-heading">Parameter configuration</h3>
 
-          <div className="gf-form">
-            <FormField
-                label="Warehouse"
-                labelWidth={10}
-                inputWidth={20}
+          <InlineField label="Warehouse"
+                       labelWidth={LABEL_WIDTH}>
+            <Input
+                width={INPUT_WIDTH}
                 onChange={this.onWarehouseChange}
-                value={jsonData.warehouse || ''}
+                value={jsonData.warehouse ?? ''}
                 placeholder="Default warehouse"
             />
-          </div>
+          </InlineField>
 
-          <div className="gf-form">
-            <FormField
-                label="Database"
-                labelWidth={10}
-                inputWidth={20}
+          <InlineField label="Database"
+                       labelWidth={LABEL_WIDTH}>
+            <Input
+                width={INPUT_WIDTH}
                 onChange={this.onDatabaseChange}
-                value={jsonData.database || ''}
+                value={jsonData.database ?? ''}
                 placeholder="Default database"
             />
-          </div>
+          </InlineField>
 
-          <div className="gf-form">
-            <FormField
-                label="Schema"
-                labelWidth={10}
-                inputWidth={20}
+          <InlineField label="Schema"
+                       labelWidth={LABEL_WIDTH}>
+            <Input
+                width={INPUT_WIDTH}
                 onChange={this.onSchemaChange}
-                value={jsonData.schema || ''}
+                value={jsonData.schema ?? ''}
                 placeholder="Default Schema"
             />
-          </div>
+          </InlineField>
           <br/>
           <h3 className="page-heading">Session configuration</h3>
 
-          <div className="gf-form">
-            <FormField
-                label="Extra options"
-                labelWidth={10}
-                inputWidth={30}
+          <InlineField label="Extra options"
+                       labelWidth={LABEL_WIDTH}>
+            <Input
+                width={INPUT_WIDTH}
                 onChange={this.onExtraOptionChange}
-                value={jsonData.extraConfig || ''}
+                value={jsonData.extraConfig ?? ''}
                 placeholder="TIMESTAMP_OUTPUT_FORMAT=MM-DD-YYYY&XXXXX=yyyyy&..."
             />
-          </div>
+          </InlineField>
           <br/>
           <ControlledCollapse label="Experimental">
-            <div className="gf-form">
-              <FormField
-                  label="Max Chunk Download Workers"
-                  labelWidth={15}
-                  inputWidth={3}
+            <InlineField label="Max Chunk Download Workers"
+                         labelWidth={LABEL_WIDTH}>
+              <Input
+                  width={INPUT_WIDTH}
                   onChange={this.onMaxChunkDownloadWorkersChange}
-                  value={jsonData.maxChunkDownloadWorkers || '10'}
+                  value={jsonData.maxChunkDownloadWorkers ?? '10'}
               />
-            </div>
+            </InlineField>
             <br/>
-            <div className="gf-form">
-                <Checkbox
-                    value={jsonData.customJSONDecoderEnabled}
-                    onChange={this.onCustomJSONDecoderEnabledChange}
-                    label="Enable Custom JSON Decoder"
-                    />
-            </div>
+            <InlineField label="Enable Custom JSON Decoder"
+                         style={{alignItems: 'center'}}
+                         labelWidth={LABEL_WIDTH}>
+              <Checkbox
+                  value={jsonData.customJSONDecoderEnabled ?? false}
+                  onChange={this.onCustomJSONDecoderEnabledChange}
+              />
+            </InlineField>
           </ControlledCollapse>
         </div>
     );

diff --git a/src/QueryEditor.tsx b/src/QueryEditor.tsx
@@ -14,11 +14,12 @@ export class QueryEditor extends PureComponent<Props> {
   onQueryTextChange = (newQuery: string) => {
     const { onChange, query } = this.props;
     onChange({ ...query, queryText: newQuery });
+    this.props.onRunQuery();
   };
 
   onFormat = () => {
     try {
-      let formatted = format(this.props.query.queryText || "", { 
+      let formatted = format(this.props.query.queryText ?? "", {
         language: 'snowflake', 
         denseOperators: false, 
         keywordCase: 'upper',
@@ -38,7 +39,7 @@ export class QueryEditor extends PureComponent<Props> {
     const { onChange, query } = this.props;
     onChange({
       ...query,
-      queryType: value.value || 'table',
+      queryType: value.value ?? 'table',
     });
 
     this.props.onRunQuery();
@@ -78,11 +79,11 @@ export class QueryEditor extends PureComponent<Props> {
     const query = defaults(this.props.query, defaultQuery);
     const { queryText, queryType, fillMode, timeColumns } = query;
     const selectedOption = this.options.find((options) => options.value === queryType) || this.options;
-    const selectedFillMode = this.optionsFillMode.find((options) => options.value === fillMode)?.value || this.optionsFillMode[0].value;
+    const selectedFillMode = this.optionsFillMode.find((options) => options.value === fillMode)?.value ?? this.optionsFillMode[0].value;
 
     return (
       <div>
-        <div className="gf-form max-width-25" role="query-type-container">
+        <div className="gf-form max-width-25">
           <InlineFormLabel width={10}>Query Type</InlineFormLabel>
           <Select
             width={20}
@@ -96,14 +97,12 @@ export class QueryEditor extends PureComponent<Props> {
         <Field>
           <div>
             <CodeEditor
-              value={queryText || ''}
-              onBlur={this.props.onRunQuery}
-              onChange={this.onQueryTextChange}
+              value={queryText ?? ''}
+              onBlur={this.onQueryTextChange}
               language="sql"
               showLineNumbers={true}
               height={'200px'}
               showMiniMap={false}
-              onSave={this.props.onRunQuery}
             />
             <Button variant="secondary" icon="repeat" onClick={this.onFormat}>Format Query</Button>
           </div>

diff --git a/src/datasource.ts b/src/datasource.ts
@@ -36,9 +36,9 @@ export class DataSource extends DataSourceWithBackend<SnowflakeQuery, SnowflakeO
     } as DataQueryRequest<SnowflakeQuery>)
       .pipe(
         switchMap((response) => {
-          if (response.error) {
-            console.log('Error: ' + response.error.message);
-            throw new Error(response.error.message);
+          if (response.errors) {
+            console.log('Error: ' + response.errors?.map(value => value.message ?? '').join(','));
+            throw new Error(response.errors?.map(value => value.message ?? '').join(','));
           }
           return response.data;
         }),

diff --git a/src/types.ts b/src/types.ts
@@ -1,4 +1,4 @@
-import { DataQuery, DataSourceJsonData } from '@grafana/data';
+import { DataQuery, DataSourceJsonData } from '@grafana/schema';
 
 export interface SnowflakeQuery extends DataQuery {
   queryText?: string;