Twenty config integration tests + conversion refactor (#11972)
- In this PR the default value of IS_CONFIG_VARIABLES_IN_DB_ENABLED has
been changed to true,
- This is my first time writing integration tests, so I’d appreciate a
thorough review. :)
I’ve tried to follow the existing test patterns closely, but there might
be some small mistakes I may have missed.
Also let me know if I have missed any important test cases that should
be tested
UPDATE -
### Config Value Converter Refactoring
- Created a centralized type transformers registry with bidirectional
validation
- Refactored ConfigValueConverterService to support validation in both
directions:
- Maintained existing DB-to-app conversion behavior
- Added validation for app-to-DB conversion
- Added integration tests to verify validation works in both directions
---------
Co-authored-by: Félix Malfait <felix@twenty.com>
This commit is contained in:
nitin
@ -0,0 +1,24 @@
|
||||
import { gql } from 'apollo-server-core';
|
||||
import { ConfigVariableValue } from 'twenty-shared/src/types/ConfigVariableValue';
|
||||
|
||||
export type CreateConfigVariableFactoryInput = {
|
||||
key: string;
|
||||
value: ConfigVariableValue;
|
||||
};
|
||||
|
||||
export const createConfigVariableQueryFactory = ({
|
||||
key,
|
||||
value,
|
||||
}: CreateConfigVariableFactoryInput) => {
|
||||
return {
|
||||
query: gql`
|
||||
mutation CreateDatabaseConfigVariable($key: String!, $value: JSON!) {
|
||||
createDatabaseConfigVariable(key: $key, value: $value)
|
||||
}
|
||||
`,
|
||||
variables: {
|
||||
key,
|
||||
value,
|
||||
},
|
||||
};
|
||||
};
|
||||
@ -0,0 +1,33 @@
|
||||
import { PerformTwentyConfigQueryParams } from 'test/integration/twenty-config/types/perform-twenty-config-query.type';
|
||||
|
||||
import {
|
||||
CreateConfigVariableFactoryInput,
|
||||
createConfigVariableQueryFactory,
|
||||
} from './create-config-variable.query-factory.util';
|
||||
import { makeAdminPanelAPIRequest } from './make-admin-panel-api-request.util';
|
||||
|
||||
export const createConfigVariable = async ({
|
||||
input,
|
||||
expectToFail = false,
|
||||
}: PerformTwentyConfigQueryParams<CreateConfigVariableFactoryInput>) => {
|
||||
const graphqlOperation = createConfigVariableQueryFactory({
|
||||
key: input.key,
|
||||
value: input.value,
|
||||
});
|
||||
|
||||
const response = await makeAdminPanelAPIRequest(graphqlOperation);
|
||||
|
||||
if (!expectToFail) {
|
||||
expect(response.body.data).toBeDefined();
|
||||
expect(response.body.errors).toBeUndefined();
|
||||
expect(response.body.data.createDatabaseConfigVariable).toBeDefined();
|
||||
} else {
|
||||
// For failure cases, we'll check in the individual tests
|
||||
}
|
||||
|
||||
return {
|
||||
data: response.body.data,
|
||||
errors: response.body.errors,
|
||||
rawResponse: response,
|
||||
};
|
||||
};
|
||||
@ -0,0 +1,20 @@
|
||||
import { gql } from 'apollo-server-core';
|
||||
|
||||
export type DeleteConfigVariableFactoryInput = {
|
||||
key: string;
|
||||
};
|
||||
|
||||
export const deleteConfigVariableQueryFactory = ({
|
||||
key,
|
||||
}: DeleteConfigVariableFactoryInput) => {
|
||||
return {
|
||||
query: gql`
|
||||
mutation DeleteDatabaseConfigVariable($key: String!) {
|
||||
deleteDatabaseConfigVariable(key: $key)
|
||||
}
|
||||
`,
|
||||
variables: {
|
||||
key,
|
||||
},
|
||||
};
|
||||
};
|
||||
@ -0,0 +1,28 @@
|
||||
import { PerformTwentyConfigQueryParams } from 'test/integration/twenty-config/types/perform-twenty-config-query.type';
|
||||
|
||||
import {
|
||||
DeleteConfigVariableFactoryInput,
|
||||
deleteConfigVariableQueryFactory,
|
||||
} from './delete-config-variable.query-factory.util';
|
||||
import { makeAdminPanelAPIRequest } from './make-admin-panel-api-request.util';
|
||||
|
||||
export const deleteConfigVariable = async ({
|
||||
input,
|
||||
expectToFail = false,
|
||||
}: PerformTwentyConfigQueryParams<DeleteConfigVariableFactoryInput>) => {
|
||||
const graphqlOperation = deleteConfigVariableQueryFactory({
|
||||
key: input.key,
|
||||
});
|
||||
|
||||
const response = await makeAdminPanelAPIRequest(graphqlOperation);
|
||||
|
||||
if (!expectToFail) {
|
||||
expect(response.body.data).toBeDefined();
|
||||
expect(response.body.errors).toBeUndefined();
|
||||
expect(response.body.data.deleteDatabaseConfigVariable).toBeDefined();
|
||||
} else {
|
||||
expect(response.body.errors).toBeDefined();
|
||||
}
|
||||
|
||||
return { data: response.body.data, errors: response.body.errors };
|
||||
};
|
||||
@ -0,0 +1,29 @@
|
||||
import { gql } from 'apollo-server-core';
|
||||
|
||||
export type GetConfigVariableFactoryInput = {
|
||||
key: string;
|
||||
};
|
||||
|
||||
export const getConfigVariableQueryFactory = ({
|
||||
key,
|
||||
}: GetConfigVariableFactoryInput) => {
|
||||
return {
|
||||
query: gql`
|
||||
query GetDatabaseConfigVariable($key: String!) {
|
||||
getDatabaseConfigVariable(key: $key) {
|
||||
name
|
||||
description
|
||||
value
|
||||
isSensitive
|
||||
isEnvOnly
|
||||
type
|
||||
options
|
||||
source
|
||||
}
|
||||
}
|
||||
`,
|
||||
variables: {
|
||||
key,
|
||||
},
|
||||
};
|
||||
};
|
||||
@ -0,0 +1,31 @@
|
||||
import { PerformTwentyConfigQueryParams } from 'test/integration/twenty-config/types/perform-twenty-config-query.type';
|
||||
|
||||
import {
|
||||
GetConfigVariableFactoryInput,
|
||||
getConfigVariableQueryFactory,
|
||||
} from './get-config-variable.query-factory.util';
|
||||
import { makeAdminPanelAPIRequest } from './make-admin-panel-api-request.util';
|
||||
|
||||
export const getConfigVariable = async ({
|
||||
input,
|
||||
expectToFail = false,
|
||||
}: PerformTwentyConfigQueryParams<GetConfigVariableFactoryInput>) => {
|
||||
const graphqlOperation = getConfigVariableQueryFactory({
|
||||
key: input.key,
|
||||
});
|
||||
|
||||
const response = await makeAdminPanelAPIRequest(graphqlOperation);
|
||||
|
||||
if (!expectToFail) {
|
||||
expect(response.body.data).toBeDefined();
|
||||
expect(response.body.data.getDatabaseConfigVariable).toBeDefined();
|
||||
} else {
|
||||
// For failure cases, we'll check in the individual tests
|
||||
}
|
||||
|
||||
return {
|
||||
data: response.body.data,
|
||||
errors: response.body.errors,
|
||||
rawResponse: response,
|
||||
};
|
||||
};
|
||||
@ -0,0 +1,27 @@
|
||||
import { gql } from 'apollo-server-core';
|
||||
|
||||
export const getConfigVariablesGroupedQueryFactory = () => {
|
||||
return {
|
||||
query: gql`
|
||||
query GetConfigVariablesGrouped {
|
||||
getConfigVariablesGrouped {
|
||||
groups {
|
||||
name
|
||||
description
|
||||
isHiddenOnLoad
|
||||
variables {
|
||||
name
|
||||
description
|
||||
value
|
||||
isSensitive
|
||||
isEnvOnly
|
||||
type
|
||||
options
|
||||
source
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
`,
|
||||
};
|
||||
};
|
||||
@ -0,0 +1,18 @@
|
||||
import { getConfigVariablesGroupedQueryFactory } from './get-config-variables-grouped.query-factory.util';
|
||||
import { makeAdminPanelAPIRequest } from './make-admin-panel-api-request.util';
|
||||
|
||||
export const getConfigVariablesGrouped = async (expectToFail = false) => {
|
||||
const graphqlOperation = getConfigVariablesGroupedQueryFactory();
|
||||
|
||||
const response = await makeAdminPanelAPIRequest(graphqlOperation);
|
||||
|
||||
if (!expectToFail) {
|
||||
expect(response.body.data).toBeDefined();
|
||||
expect(response.body.errors).toBeUndefined();
|
||||
expect(response.body.data.getConfigVariablesGrouped).toBeDefined();
|
||||
} else {
|
||||
expect(response.body.errors).toBeDefined();
|
||||
}
|
||||
|
||||
return { data: response.body.data, errors: response.body.errors };
|
||||
};
|
||||
@ -0,0 +1,24 @@
|
||||
import { ASTNode, print } from 'graphql';
|
||||
import request from 'supertest';
|
||||
|
||||
/* global APP_PORT, ADMIN_ACCESS_TOKEN */
|
||||
|
||||
type GraphqlOperation = {
|
||||
query: ASTNode;
|
||||
variables?: Record<string, unknown>;
|
||||
};
|
||||
|
||||
export const makeAdminPanelAPIRequest = (
|
||||
graphqlOperation: GraphqlOperation,
|
||||
) => {
|
||||
const client = request(`http://localhost:${APP_PORT}`);
|
||||
|
||||
return client
|
||||
.post('/graphql')
|
||||
.set('Authorization', `Bearer ${ADMIN_ACCESS_TOKEN}`)
|
||||
.send({
|
||||
query: print(graphqlOperation.query),
|
||||
variables: graphqlOperation.variables || {},
|
||||
})
|
||||
.expect(200);
|
||||
};
|
||||
@ -0,0 +1,12 @@
|
||||
import request from 'supertest';
|
||||
|
||||
export const makeUnauthenticatedAPIRequest = async (query: string) => {
|
||||
const client = request(`http://localhost:${APP_PORT}`);
|
||||
|
||||
return client
|
||||
.post('/graphql')
|
||||
.send({
|
||||
query,
|
||||
})
|
||||
.expect(200);
|
||||
};
|
||||
@ -0,0 +1,24 @@
|
||||
import { gql } from 'apollo-server-core';
|
||||
import { ConfigVariableValue } from 'twenty-shared/src/types/ConfigVariableValue';
|
||||
|
||||
export type UpdateConfigVariableFactoryInput = {
|
||||
key: string;
|
||||
value: ConfigVariableValue;
|
||||
};
|
||||
|
||||
export const updateConfigVariableQueryFactory = ({
|
||||
key,
|
||||
value,
|
||||
}: UpdateConfigVariableFactoryInput) => {
|
||||
return {
|
||||
query: gql`
|
||||
mutation UpdateDatabaseConfigVariable($key: String!, $value: JSON!) {
|
||||
updateDatabaseConfigVariable(key: $key, value: $value)
|
||||
}
|
||||
`,
|
||||
variables: {
|
||||
key,
|
||||
value,
|
||||
},
|
||||
};
|
||||
};
|
||||
@ -0,0 +1,29 @@
|
||||
import { PerformTwentyConfigQueryParams } from 'test/integration/twenty-config/types/perform-twenty-config-query.type';
|
||||
|
||||
import { makeAdminPanelAPIRequest } from './make-admin-panel-api-request.util';
|
||||
import {
|
||||
UpdateConfigVariableFactoryInput,
|
||||
updateConfigVariableQueryFactory,
|
||||
} from './update-config-variable.query-factory.util';
|
||||
|
||||
export const updateConfigVariable = async ({
|
||||
input,
|
||||
expectToFail = false,
|
||||
}: PerformTwentyConfigQueryParams<UpdateConfigVariableFactoryInput>) => {
|
||||
const graphqlOperation = updateConfigVariableQueryFactory({
|
||||
key: input.key,
|
||||
value: input.value,
|
||||
});
|
||||
|
||||
const response = await makeAdminPanelAPIRequest(graphqlOperation);
|
||||
|
||||
if (!expectToFail) {
|
||||
expect(response.body.data).toBeDefined();
|
||||
expect(response.body.errors).toBeUndefined();
|
||||
expect(response.body.data.updateDatabaseConfigVariable).toBeDefined();
|
||||
} else {
|
||||
expect(response.body.errors).toBeDefined();
|
||||
}
|
||||
|
||||
return { data: response.body.data, errors: response.body.errors };
|
||||
};
|
||||
Reference in New Issue
Block a user