hasura/graphql-engine
1
0
Fork 0
mirror of https://github.com/hasura/graphql-engine.git synced 2024-09-20 15:09:02 +03:00
Code Issues Projects Releases Wiki Activity

console: support naming convention in source customization for postgres DB [CON-297]

Browse Source 
PR-URL: https://github.com/hasura/graphql-engine-mono/pull/4823
GitOrigin-RevId: a6a3bfcb9c7e16dd551d14dde3d424d07b8f1d15
This commit is contained in:
Varun Choudhary 2022-06-23 12:20:15 +05:30 committed by hasura-bot
parent fbfa32207d
commit 866164357c
13 changed files with 79 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
CHANGELOG.md
View File

@ -4,7 +4,8 @@
### Bug fixes and improvements
console: Hide TimescaleDB internal schema from data tab
- console: Hide TimescaleDB internal schema from data tab
- console: support naming convention in source customization for postgres DB [CON-297]
## v2.9.0-beta.1

2
console/src/components/Services/Data/DataSources/ConnectDBForm.tsx
View File

@ -423,7 +423,9 @@ const ConnectDatabaseForm: React.FC<ConnectDatabaseFormProps> = ({
<GraphQLFieldCustomizationContainer
rootFields={connectionDBState.customization?.rootFields}
typeNames={connectionDBState.customization?.typeNames}
namingConvention={connectionDBState.customization?.namingConvention}
connectionDBStateDispatch={connectionDBStateDispatch}
connectionDBState={connectionDBState}
/>
)}
</div>

2
console/src/components/Services/Data/DataSources/ConnectDatabase.tsx
View File

@ -96,6 +96,8 @@ const ConnectDatabase: React.FC<ConnectDatabaseProps> = props => {
customization: {
rootFields: currentSourceInfo?.customization?.root_fields,
typeNames: currentSourceInfo?.customization?.type_names,
namingConvention:
currentSourceInfo?.customization?.naming_convention,
},
},
});

38
console/src/components/Services/Data/DataSources/GraphQLFieldCustomization/GraphQLFieldCustomization.tsx
View File

@ -1,5 +1,8 @@
import { getSupportedDrivers } from '@/dataSources';
import { namingConventionOptions } from '@/metadata/types';
import { Collapse } from '@/new-components/Collapse';
import React from 'react';
import { ConnectDBState } from '../state';
type FormRowProps = {
name: string;
@ -62,7 +65,8 @@ export type CustomizationFieldName =
| 'rootFields.prefix'
| 'rootFields.suffix'
| 'typeNames.prefix'
| 'typeNames.suffix';
| 'typeNames.suffix'
| 'namingConvention';
export type GraphQLFieldCustomizationProps = {
rootFields?: {
@ -74,13 +78,17 @@ export type GraphQLFieldCustomizationProps = {
prefix?: string;
suffix?: string;
};
namingConvention?: namingConventionOptions;
onChange: (fieldName: CustomizationFieldName, fieldValue: string) => void;
connectionDBState?: ConnectDBState;
};
export const GraphQLFieldCustomization: React.FC<GraphQLFieldCustomizationProps> = ({
rootFields,
typeNames,
namingConvention,
onChange,
connectionDBState,
}) => {
return (
<div>
@ -94,6 +102,34 @@ export const GraphQLFieldCustomization: React.FC<GraphQLFieldCustomizationProps>
tooltip="Set a namespace or add a prefix / suffix to the root fields and types for the database's objects in the GraphQL API"
>
<Collapse.Content>
{connectionDBState?.dbType &&
getSupportedDrivers(
'connectDbForm.namingConvention'
).includes(connectionDBState?.dbType) && (
<div className="grid gap-0 grid-cols-2 grid-rows">
<label className="p-sm text-gray-600 font-semibold py-xs w-1/3">
Naming Convention
</label>
<span className="px-sm py-xs">
<select
className="form-control font-normal cursor-pointer"
onChange={e => {
if (namingConvention) {
onChange('namingConvention', e.target.value);
}
}}
value={namingConvention}
>
<option value="hasura-default">
hasura-default
</option>
<option value="graphql-default">
graphql-default
</option>
</select>
</span>
</div>
)}
<div>
<div className="p-sm text-gray-600 font-semibold">
Root Fields

5
console/src/components/Services/Data/DataSources/GraphQLFieldCustomization/GraphQLFieldCustomizationContainer.tsx
View File

@ -22,6 +22,7 @@ const CustomizationFieldNameToActionTypeMap: Record<
'rootFields.suffix': 'UPDATE_CUSTOMIZATION_ROOT_FIELDS_SUFFIX',
'typeNames.prefix': 'UPDATE_CUSTOMIZATION_TYPE_NAMES_PREFIX',
'typeNames.suffix': 'UPDATE_CUSTOMIZATION_TYPE_NAMES_SUFFIX',
namingConvention: 'UPDATE_CUSTOMIZATION_NAMING_CONVENTION',
};
export const getActionType = (
@ -32,7 +33,9 @@ export const getActionType = (
export const GraphQLFieldCustomizationContainer: React.FC<GraphQLFieldCustomizationContainerProps> = ({
rootFields,
typeNames,
namingConvention,
connectionDBStateDispatch,
connectionDBState,
}) => {
const onChange = (fieldName: CustomizationFieldName, fieldValue: string) => {
const actionType = getActionType(fieldName);
@ -47,7 +50,9 @@ export const GraphQLFieldCustomizationContainer: React.FC<GraphQLFieldCustomizat
<GraphQLFieldCustomization
rootFields={rootFields}
typeNames={typeNames}
namingConvention={namingConvention}
onChange={onChange}
connectionDBState={connectionDBState}
/>
);
};

18
console/src/components/Services/Data/DataSources/state.ts
View File

@ -10,6 +10,7 @@ import {
SSLConfigOptions,
IsolationLevelOptions,
GraphQLFieldCustomization,
namingConventionOptions,
} from '../../../../metadata/types';
export const connectionTypes = {
@ -71,6 +72,9 @@ export const defaultState: ConnectDBState = {
},
preparedStatements: false,
isolationLevel: 'read-committed',
customization: {
namingConvention: 'hasura-default',
},
};
type DefaultStateProps = {
@ -156,7 +160,6 @@ export const connectDataSource = (
...currentState.connectionParamState,
});
}
const data = {
driver: currentState.dbType,
payload: {
@ -190,6 +193,7 @@ export const connectDataSource = (
...(checkEmpty(currentState.customization?.typeNames) && {
typeNames: currentState.customization?.typeNames,
}),
namingConvention: currentState.customization?.namingConvention,
},
}),
},
@ -254,6 +258,10 @@ export type ConnectDBActions =
| { type: 'UPDATE_PREPARED_STATEMENTS'; data: boolean }
| { type: 'UPDATE_ISOLATION_LEVEL'; data: IsolationLevelOptions }
| { type: 'RESET_INPUT_STATE' }
| {
type: 'UPDATE_CUSTOMIZATION_NAMING_CONVENTION';
data: namingConventionOptions;
}
| { type: 'UPDATE_CUSTOMIZATION_ROOT_FIELDS_NAMESPACE'; data: string }
| { type: 'UPDATE_CUSTOMIZATION_ROOT_FIELDS_PREFIX'; data: string }
| { type: 'UPDATE_CUSTOMIZATION_ROOT_FIELDS_SUFFIX'; data: string }
@ -483,6 +491,14 @@ export const connectDBReducer = (
projectId: action.data,
},
};
case 'UPDATE_CUSTOMIZATION_NAMING_CONVENTION':
return {
...state,
customization: {
...state.customization,
namingConvention: action.data,
},
};
case 'UPDATE_CUSTOMIZATION_ROOT_FIELDS_NAMESPACE':
return {
...state,

1
console/src/dataSources/services/bigquery/index.tsx
View File

@ -216,6 +216,7 @@ export const supportedFeatures: DeepRequired<SupportedFeaturesType> = {
pool_timeout: false,
connection_lifetime: false,
ssl_certificates: false,
namingConvention: false,
},
};

4
console/src/dataSources/services/citus/index.tsx
View File

@ -22,6 +22,10 @@ import {
export const supportedFeatures: DeepRequired<SupportedFeaturesType> = {
...PgSupportedFeatures,
connectDbForm: {
...PgSupportedFeatures?.connectDbForm,
namingConvention: false,
},
driver: {
name: 'citus',
fetchVersion: {

1
console/src/dataSources/services/mssql/index.tsx
View File

@ -236,6 +236,7 @@ export const supportedFeatures: DeepRequired<SupportedFeaturesType> = {
pool_timeout: false,
connection_lifetime: false,
ssl_certificates: false,
namingConvention: false,
},
};

1
console/src/dataSources/services/postgresql/index.tsx
View File

@ -742,6 +742,7 @@ export const supportedFeatures: DeepRequired<SupportedFeaturesType> = {
retries: true,
pool_timeout: true,
connection_lifetime: true,
namingConvention: true,
ssl_certificates:
globals.consoleType === 'cloud' || globals.consoleType === 'pro',
},

1
console/src/dataSources/types.ts
View File

@ -422,6 +422,7 @@ export type SupportedFeaturesType = {
pool_timeout: boolean;
connection_lifetime: boolean;
ssl_certificates: boolean;
namingConvention: boolean;
};
};

4
console/src/metadata/sourcesUtils.ts
View File

@ -12,7 +12,7 @@ type CustomizationPayloadSlice = {
customization: {
root_fields?: GraphQLFieldCustomization['rootFields'];
type_names?: GraphQLFieldCustomization['typeNames'];
naming_convention: 'hasura-default';
naming_convention?: GraphQLFieldCustomization['namingConvention'];
};
};
@ -35,7 +35,7 @@ const adaptCustomizations = (
customization: {
...rootFields,
...typeNames,
naming_convention: 'hasura-default',
naming_convention: customization?.namingConvention,
},
};
};

4
console/src/metadata/types.ts
View File

@ -1010,6 +1010,8 @@ export type IsolationLevelOptions =
| 'repeatable-read'
| 'serializable';
export type namingConventionOptions = 'hasura-default' | 'graphql-default';
export interface SSLConfigOptions {
sslmode?: SSLModeOptions;
sslrootcert?: {
@ -1052,6 +1054,7 @@ export type GraphQLFieldCustomization = {
prefix?: string;
suffix?: string;
};
namingConvention?: namingConventionOptions;
};
export interface SourceConnectionInfo {
@ -1090,6 +1093,7 @@ export interface HasuraMetadataV2 {
type GraphQLCustomizationMetadata = {
root_fields: GraphQLFieldCustomization['rootFields'];
type_names: GraphQLFieldCustomization['typeNames'];
naming_convention: GraphQLFieldCustomization['namingConvention'];
};
export interface MetadataDataSource {