#134 into [email protected] 👹 add 'oneOf' parameter into descriptor #181

MiaInturi · 2024-06-25T13:54:41Z

No description provided.

MiaInturi · 2024-06-25T13:56:17Z

bin/validateMockServerConfig/utils/entitiesSchema/entitiesSchema.test.ts

-describe('plainEntitySchema: checkMode exclude', () => {
-  test('Should return correct error path for descriptor (top and property level) without required value', () => {
-    const incorrectTopLevelDescriptorBodyEntities = {
+test('Should return correct error path with descriptor schema checked before common record schema', () => {


По сути прошлый тест как раз это и смотрел, но было прям неочевидно, что он проверял - сделал более явно, что тест проверяет, мол descriptor schema должна проходить валидацию раньше record schema

MiaInturi · 2024-06-25T14:03:26Z

bin/validateMockServerConfig/utils/extendedDiscriminatedUnion/extendedDiscriminatedUnion.ts

+export const extendedDiscriminatedUnion = <Discriminator extends string>(
+  discriminator: Discriminator,
+  options: [
+    ExtendedDiscriminatedUnionOption,
+    ExtendedDiscriminatedUnionOption,
+    ...ExtendedDiscriminatedUnionOption[]
+  ]
+) =>


По сути эта функция это просто адаптация этой функции из zod https://zod.dev/?id=discriminated-unions.
Т.е. так же принимается первым параметром название свойства, которое должно быть у проверяемого объекта и далее схемы, которые должны соответствовать каждому из возможных значений вышеупомянутого свойства - схемы это массив котрежей из 2 элементов, где первый элемент проверяет совпадение с выбранным свойством (discriminator), а второй элемент проверяет уже весь остальной объект (в случае, если первая схема была успешно провалидирована).
На самом деле супер просто все, это просто расширение обычного discriminatedUnion из zod, т.к. он в силу принципов своей работы вторым аргументом позволял передавать только массив z.object-ов, а это жесткое ограничение, которое по сути заставляло бы нас писать ту валидацию, от которой мы и хотели уйти с помощью zod.

MiaInturi · 2024-06-25T14:04:32Z

src/core/graphql/createGraphQLRoutes/createGraphQLRoutes.test.ts

+                    value: {
+                      key1: 'value1',
+                      key2: { nestedKey1: 'nestedValue1' }
+                    }


Из-за oneOf теперь массивы так не парсятся

Подскажи подробней, а как раньше было. Было тип пройдись по всему массиву и посмотри каждый элемент и тут был был equal для 0 элемента ?

Но теперь у нас есть oneOf и если не указать его в явную, то он будет сверять массив типо

Но тут филосовский вопрос, oneOf по дефалту сейчас false, что наверное правильно

MiaInturi · 2024-06-25T14:04:56Z

src/core/graphql/createGraphQLRoutes/createGraphQLRoutes.ts

+          if (
+            topLevelConvertedDescriptor.checkMode === 'exists' ||
+            topLevelConvertedDescriptor.checkMode === 'notExists'
+          ) {
+            return resolveEntityValues({
+              checkMode: topLevelConvertedDescriptor.checkMode,
+              actualValue: graphQLInput.variables
+            });
+          }


Нужно явно проверять checkMode-ы без descriptorValue для типизации

MiaInturi · 2024-06-25T14:06:10Z

src/utils/constants/checkModes.ts

-export const CHECK_MODES = [
-  ...CHECK_ACTUAL_VALUE_CHECK_MODES,
-  ...COMPARE_WITH_DESCRIPTOR_VALUE_CHECK_MODES,
-  ...CALCULATE_BY_DESCRIPTOR_VALUE_CHECK_MODES
-] as const satisfies readonly CheckMode[];
-
-export const PLAIN_ENTITY_CHECK_MODES = [
-  ...CHECK_ACTUAL_VALUE_CHECK_MODES,
-  ...COMPARE_WITH_DESCRIPTOR_ANY_VALUE_CHECK_MODES,
-  'function'
-] as const satisfies readonly CheckMode[];


Они просто не использовались нигде

MiaInturi · 2024-06-25T14:06:56Z

src/utils/helpers/isRegExp/isRegExp.ts

По сути x instanceof RegExp выполняет ту же самую роль поэтому не вижу смысла в этой функции. Мб раньше TS автоматически не сужал тип, но сейчас все норм

MiaInturi · 2024-06-25T14:07:44Z

src/utils/types/checkModes.ts

+export type EntityDescriptor<
+  Check extends CheckMode = CheckMode,
+  Value = any
+> = Check extends CheckActualValueCheckMode
+  ? { checkMode: Check }
+  :
+      | { checkMode: Check; value: Value[]; oneOf: true }
+      | { checkMode: Check; value: Value; oneOf?: false };


Теперь для CheckMode без descriptorValue типизация стала более явной

MiaInturi · 2024-06-25T14:15:22Z

src/utils/helpers/config/resolveEntityValues/resolveEntityValues.ts

Тут самые большие изменения, но основных 2:

Раньше по сути из-за необычной логики массивов требовалось проверять 9 комбинаций: каждый из actual и descriptor value мог быть примитивом, массивом, объектом, таким образом 3х3 = 9. Теперь же для нас без разницы, массив это или объект, то есть комбинаций становится 4 = 2х2. Нам без разницы, т.к. определение логики, сравнивать ли массив целиком или же только один из элементов, забрал на себя oneOf.

Теперь, когда функция 'resolveEntityValues' вызывается, то мы смотрим какое значение имеет oneOf. Если true, то просто идем по массиву descriptorValue и ищем хотя бы 1 совпадение, если же oneOf=false или не представлен, то сравниваем целиком

1

debabin · 2024-11-10T07:59:39Z

src/core/rest/createRestRoutes/createRestRoutes.ts

+
+              return resolveEntityValues({
+                checkMode: topLevelConvertedDescriptor.checkMode,
+                actualValue,


я бы поставил первым параметром в объекте

debabin · 2024-11-10T08:01:01Z

src/core/rest/createRestRoutes/createRestRoutes.ts

@@ -50,8 +50,7 @@ export const createRestRoutes = ({

          const entries = Object.entries(entities) as Entries<Required<RestEntitiesByEntityName>>;
          return entries.every(([entityName, entityDescriptorOrValue]) => {
-            const { checkMode, value: descriptorValue } =
-              convertToEntityDescriptor(entityDescriptorOrValue);
+            const topLevelConvertedDescriptor = convertToEntityDescriptor(entityDescriptorOrValue);


const entityDescriptor = convertToEntityDescriptor(entityDescriptorOrValue);

а почему вот такой бы нейминг просто не поддержать, мне кажется что top level вообще не обязателен

debabin · 2024-11-10T08:01:41Z

src/core/rest/createRestRoutes/createRestRoutes.ts

+              const actualValue = Object.keys(request.body).length ? request.body : undefined;
+              return resolveEntityValues({
+                checkMode: 'equals',
+                actualValue,


same про поставить выше

debabin · 2024-11-10T08:05:05Z

src/core/rest/createRestRoutes/createRestRoutes.ts

+              const actualEntity = flatten<any, any>(request[entityName]);
+
+              // ✅ important: transform header keys to lower case because browsers send headers in lowercase
+              const actualValue =
+                actualEntity[entityName === 'headers' ? entityKey.toLowerCase() : entityKey];


// ✅ important: transform header keys to lower case because browsers send headers in lowercase
cosnt actualKey = entityName === 'headers' ? entityKey.toLowerCase() : entityKey
const actualValue = actualEntity[actualKey]

debabin · 2024-11-10T08:05:53Z

src/utils/helpers/config/resolveEntityValues/resolveEntityValues.ts

+  | ResolveEntityParamsWithEnabledOneOf
+  | ResolveEntityParamsWithDisabledOneOf;
+
+export const resolveEntityValues = (params: ResolveEntityParams) => {


ResolveEntityValuesParams

debabin · 2024-11-10T08:07:37Z

src/utils/helpers/config/resolveEntityValues/resolveEntityValues.ts

+interface ResolveEntityParamsWithEnabledOneOf {
+  checkMode: Exclude<CheckMode, CheckActualValueCheckMode>;
+  actualValue: any;
+  descriptorValue: any[];
+  oneOf: true;
+}
+
+interface ResolveEntityParamsWithDisabledOneOf {
+  checkMode: Exclude<CheckMode, CheckActualValueCheckMode>;
+  actualValue: any;
+  descriptorValue: any;
+  oneOf?: false;
+}


а разве нам нужно тут union, разве нам не пофиг если сделать вот так

interface ResolveEntityValuesParams {
checkMode: Exclude<CheckMode, CheckActualValueCheckMode>;
actualValue: any;
descriptorValue: any | any[];
oneOf?: boolean;
}

а уже снизу тут в коде один раз захоркодить as any[]

а то приходиться выше костылить true | false

debabin · 2024-11-10T08:11:25Z

src/utils/helpers/config/resolveEntityValues/resolveEntityValues.ts

+  // ✅ important:
+  // recreate RegExp because 'g' flag can be cause of unexpected result
+  // this is about https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/RegExp/lastIndex#avoiding_side_effects


а точно ли стоит такое писать ? просто в коде уже есть такой кейс

debabin · 2024-11-10T08:12:12Z

src/utils/helpers/config/resolveEntityValues/resolveEntityValues.ts

@@ -40,141 +43,91 @@ const checkFunction: CheckFunction = (checkMode, actualValue, descriptorValue?):
  throw new Error('Wrong checkMode');


мб еще добавим значение сюда check mode, ну тип wrong checmode ${checkmode}

debabin · 2024-11-10T08:38:43Z

src/core/graphql/createGraphQLRoutes/createGraphQLRoutes.test.ts

+                    value: {
+                      key1: 'value1',
+                      key2: { nestedKey1: 'nestedValue1' }
+                    }


Подскажи подробней, а как раньше было. Было тип пройдись по всему массиву и посмотри каждый элемент и тут был был equal для 0 элемента ?

Но теперь у нас есть oneOf и если не указать его в явную, то он будет сверять массив типо

Но тут филосовский вопрос, oneOf по дефалту сейчас false, что наверное правильно

MiaInturi added 4 commits June 16, 2024 00:42

#134 👹 add 'oneOf' property type into entities descriptors types

7eeceb2

#134 👹 add 'oneOf' property to validation schemas

63f19e7

#134 👹 rework behavior of 'resolveEntityValues' function

9f4f1b0

#134 👹 rework tests for 'resolveEntityValues' function

30089de

MiaInturi commented Jun 25, 2024

View reviewed changes

MiaInturi requested review from RiceWithMeat and debabin June 25, 2024 14:15

MiaInturi self-assigned this Jun 25, 2024

MiaInturi added the enhancement New feature or request label Jun 25, 2024

#134 👹 update README

ccf1d41

MiaInturi added the [email protected] issues for [email protected] label Jul 1, 2024

MiaInturi linked an issue Jul 1, 2024 that may be closed by this pull request

Add 'oneOf' parameter into descriptor #134

Open

debabin previously approved these changes Oct 25, 2024

View reviewed changes

debabin requested changes Nov 10, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

#134 into [email protected] 👹 add 'oneOf' parameter into descriptor #181

#134 into [email protected] 👹 add 'oneOf' parameter into descriptor #181

MiaInturi commented Jun 25, 2024

MiaInturi Jun 25, 2024

MiaInturi Jun 25, 2024

MiaInturi Jun 25, 2024

debabin Nov 10, 2024

MiaInturi Jun 25, 2024

MiaInturi Jun 25, 2024

MiaInturi Jun 25, 2024

MiaInturi Jun 25, 2024

MiaInturi Jun 25, 2024

debabin Nov 10, 2024

debabin Nov 10, 2024

debabin Nov 10, 2024

debabin Nov 10, 2024

debabin Nov 10, 2024

debabin Nov 10, 2024

debabin Nov 10, 2024

debabin Nov 10, 2024

debabin Nov 10, 2024

		@@ -40,141 +43,91 @@ const checkFunction: CheckFunction = (checkMode, actualValue, descriptorValue?):
		throw new Error('Wrong checkMode');

#134 into [email protected] 👹 add 'oneOf' parameter into descriptor #181

Are you sure you want to change the base?

#134 into [email protected] 👹 add 'oneOf' parameter into descriptor #181

Conversation

MiaInturi commented Jun 25, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment