Merge pull request #8342 from opencrvs/chore/lint-and-type-events-ser…

…vice Chore/lint and type events service
opencrvs · Jan 17, 2025 · c71f4b9 · c71f4b9
2 parents c11de6e + 499e193
commit c71f4b9
Show file tree

Hide file tree

Showing 32 changed files with 395 additions and 316 deletions.
diff --git a/.eslintrc.events.js b/.eslintrc.events.js
@@ -0,0 +1,60 @@
+/*
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at https://mozilla.org/MPL/2.0/.
+ *
+ * OpenCRVS is also distributed under the terms of the Civil Registration
+ * & Healthcare Disclaimer located at http://opencrvs.org/license.
+ *
+ * Copyright (C) The OpenCRVS Authors located at https://github.com/opencrvs/opencrvs-core/blob/master/AUTHORS.
+ */
+module.exports = {
+  rules: {
+    '@typescript-eslint/await-thenable': 2,
+    '@typescript-eslint/no-empty-function': 'warn',
+    '@typescript-eslint/consistent-type-definitions': 1,
+    '@typescript-eslint/default-param-last': 2,
+    '@typescript-eslint/no-dynamic-delete': 2,
+    '@typescript-eslint/no-explicit-any': 1,
+    '@typescript-eslint/no-floating-promises': 2,
+    '@typescript-eslint/no-misused-promises': 2,
+    '@typescript-eslint/no-unnecessary-boolean-literal-compare': 2,
+    '@typescript-eslint/no-non-null-assertion': 2,
+    '@typescript-eslint/no-unnecessary-condition': 1,
+    '@typescript-eslint/no-unsafe-argument': 1,
+    '@typescript-eslint/no-unsafe-return': 1,
+    '@typescript-eslint/prefer-includes': 1,
+    '@typescript-eslint/promise-function-async': 2,
+    '@typescript-eslint/require-await': 2,
+    '@typescript-eslint/return-await': 2,
+    '@typescript-eslint/switch-exhaustiveness-check': 2,
+    'func-style': [
+      'error',
+      'declaration',
+      {
+        allowArrowFunctions: true
+      }
+    ],
+    'no-restricted-syntax': [
+      'error',
+      {
+        selector:
+          ':matches(Program > VariableDeclaration) > VariableDeclarator > ArrowFunctionExpression',
+        message: 'Top-level arrow functions are not allowed.'
+      }
+    ],
+    'no-shadow': 1,
+    'no-undef-init': 2,
+    'no-return-assign': 2,
+    'vars-on-top': 1,
+    'block-spacing': ['warn', 'always'],
+    curly: ['warn', 'all'],
+    'no-nested-ternary': 'warn',
+    'no-multiple-empty-lines': 1,
+    'prefer-const': 1,
+    'block-scoped-var': 1,
+    'import/no-cycle': 1,
+    'max-lines': ['warn', 600]
+  },
+  parser: '@typescript-eslint/parser'
+}
diff --git a/packages/client/package.json b/packages/client/package.json
@@ -15,7 +15,7 @@
     "test:watch": "vitest",
     "lint": "yarn lint:css && yarn lint:ts",
     "lint:css": "stylelint 'src/**/*.{ts,tsx}'",
-    "lint:ts": "eslint --fix './src/**/*.{ts,tsx}' --max-warnings=353",
+    "lint:ts": "eslint --fix './src/**/*.{ts,tsx}' --max-warnings=314",
     "test:compilation": "tsc --noEmit",
     "extract:translations": "bash extract-translations.sh",
     "generate-gateway-types": "NODE_OPTIONS=--dns-result-order=ipv4first graphql-codegen --config codegen.ts && prettier --write src/utils/gateway.ts",

diff --git a/packages/client/src/v2-events/.eslintrc.js b/packages/client/src/v2-events/.eslintrc.js
@@ -9,52 +9,18 @@
  * Copyright (C) The OpenCRVS Authors located at https://github.com/opencrvs/opencrvs-core/blob/master/AUTHORS.
  */
 module.exports = {
+  extends: '../../../../.eslintrc.events.js',
   rules: {
-    '@typescript-eslint/await-thenable': 2,
-    '@typescript-eslint/no-empty-function': 'warn',
-    '@typescript-eslint/consistent-type-definitions': 1,
-    '@typescript-eslint/default-param-last': 2,
-    '@typescript-eslint/no-dynamic-delete': 2,
-    '@typescript-eslint/no-explicit-any': 1,
-    '@typescript-eslint/no-floating-promises': 2,
-    '@typescript-eslint/no-misused-promises': 2,
-    '@typescript-eslint/no-unnecessary-boolean-literal-compare': 2,
-    '@typescript-eslint/no-non-null-assertion': 2,
-    '@typescript-eslint/no-unnecessary-condition': 1,
-    '@typescript-eslint/no-unsafe-argument': 1,
-    '@typescript-eslint/no-unsafe-return': 1,
-    '@typescript-eslint/prefer-includes': 1,
-    '@typescript-eslint/promise-function-async': 2,
-    '@typescript-eslint/require-await': 2,
-    '@typescript-eslint/return-await': 2,
-    '@typescript-eslint/switch-exhaustiveness-check': 2,
-    'func-style': [
-      'error',
-      'declaration',
-      {
-        allowArrowFunctions: true
-      }
-    ],
-    'no-restricted-syntax': [
-      'error',
+    'react/jsx-no-literals': 1,
+    'react/destructuring-assignment': 1,
+    'react/jsx-sort-props': [
+      1,
       {
-        selector:
-          ':matches(Program > VariableDeclaration) > VariableDeclarator > ArrowFunctionExpression',
-        message: 'Top-level arrow functions are not allowed.'
+        reservedFirst: true,
+        callbacksLast: true,
+        shorthandFirst: true
       }
     ],
-    'react/jsx-no-literals': 1,
-    'no-shadow': 1,
-    'no-undef-init': 2,
-    'no-return-assign': 2,
-    'vars-on-top': 1,
-    'block-spacing': ['warn', 'always'],
-    curly: ['warn', 'all'],
-    'no-nested-ternary': 'warn',
-    'react/destructuring-assignment': 1,
-    'no-multiple-empty-lines': 1,
-    'prefer-const': 1,
-    'block-scoped-var': 1,
     'import/order': [
       'error',
       {
@@ -73,16 +39,6 @@ module.exports = {
         pathGroupsExcludedImportTypes: ['builtin']
       }
     ],
-    'import/no-cycle': 1,
-    'max-lines': ['warn', 600],
-    'react/jsx-sort-props': [
-      1,
-      {
-        reservedFirst: true,
-        callbacksLast: true,
-        shorthandFirst: true
-      }
-    ],
     'no-restricted-imports': [
       'error',
       {

diff --git a/packages/client/src/v2-events/components/forms/utils.ts b/packages/client/src/v2-events/components/forms/utils.ts
@@ -73,7 +73,7 @@ export function evalExpressionInFieldDefinition(
 export function hasInitialValueDependencyInfo(
   value: BaseField['initialValue']
 ): value is DependencyInfo {
-  return typeof value === 'object' && value !== null && 'dependsOn' in value
+  return typeof value === 'object' && 'dependsOn' in value
 }
 
 export function getDependentFields(

diff --git a/packages/client/src/v2-events/features/events/actions/declare/Pages.tsx b/packages/client/src/v2-events/features/events/actions/declare/Pages.tsx
@@ -49,7 +49,7 @@ export function Pages() {
   )
   const formPages = configuration.actions
     .find((action) => action.type === ActionType.DECLARE)
-    ?.forms.find((form) => form.active)?.pages
+    ?.forms.find((f) => f.active)?.pages
 
   if (!formPages) {
     throw new Error('Form configuration not found for type: ' + event.type)

diff --git a/packages/client/src/v2-events/features/events/actions/declare/Review.tsx b/packages/client/src/v2-events/features/events/actions/declare/Review.tsx
@@ -112,10 +112,6 @@ export function Review() {
 
   const { eventConfiguration: config } = useEventConfiguration(event.type)
 
-  if (!config) {
-    throw new Error('Event configuration not found with type: ' + event.type)
-  }
-
   const { forms: formConfigs } = config.actions.filter(
     (action) => action.type === 'DECLARE'
   )[0]

diff --git a/packages/client/src/v2-events/features/events/actions/register/Pages.tsx b/packages/client/src/v2-events/features/events/actions/register/Pages.tsx
@@ -49,7 +49,7 @@ export function Pages() {
   )
   const formPages = configuration.actions
     .find((action) => action.type === ActionType.REGISTER)
-    ?.forms.find((form) => form.active)?.pages
+    ?.forms.find((f) => f.active)?.pages
 
   if (!formPages) {
     throw new Error('Form configuration not found for type: ' + event.type)

diff --git a/packages/client/src/v2-events/features/events/actions/register/Review.tsx b/packages/client/src/v2-events/features/events/actions/register/Review.tsx
@@ -59,10 +59,6 @@ export function Review() {
 
   const { eventConfiguration: config } = useEventConfiguration(event.type)
 
-  if (!config) {
-    throw new Error('Event configuration not found with type: ' + event.type)
-  }
-
   const { forms: formConfigs } = config.actions.filter(
     (action) => action.type === ActionType.REGISTER
   )[0]

diff --git a/packages/client/src/v2-events/features/events/fixtures.ts b/packages/client/src/v2-events/features/events/fixtures.ts
@@ -8,7 +8,7 @@
  *
  * Copyright (C) The OpenCRVS Authors located at https://github.com/opencrvs/opencrvs-core/blob/master/AUTHORS.
  */
-import { EventConfig, FormConfig } from '@opencrvs/commons/client'
+import { EventConfigInput, FormConfig } from '@opencrvs/commons/client'
 
 export const DEFAULT_FORM = {
   label: {
@@ -262,4 +262,4 @@ export const tennisClubMembershipEvent = {
       }
     }
   ]
-} satisfies EventConfig
+} satisfies EventConfigInput
diff --git a/packages/client/src/v2-events/features/events/useEvents/procedures/action.ts b/packages/client/src/v2-events/features/events/useEvents/procedures/action.ts
@@ -33,6 +33,7 @@ function waitUntilEventIsCreated<T extends { eventId: string }, R>(
     const localVersion = utils.event.get.getData(eventId)
 
     if (!localVersion || localVersion.id === localVersion.transactionId) {
+      // eslint-disable-next-line no-console
       console.error(
         'Event that has not been stored yet cannot be actioned upon'
       )

diff --git a/packages/commons/src/events/DeduplicationConfig.ts b/packages/commons/src/events/DeduplicationConfig.ts
@@ -70,41 +70,71 @@ const DateDistanceMatcher = Matcher.extend({
   })
 })
 
-export type And = {
+export type AndInput = {
   type: 'and'
-  clauses: any[]
+  clauses: ClauseInput[]
 }
 
-const And: z.ZodType<And> = z.object({
-  type: z.literal('and'),
-  clauses: z.lazy(() => Clause.array())
-})
+export type AndOutput = {
+  type: 'and'
+  clauses: ClauseOutput[]
+}
 
-export type Or = {
+export type OrInput = {
   type: 'or'
-  clauses: any[]
+  clauses: ClauseInput[]
 }
 
-const Or: z.ZodType<Or> = z.object({
+export type OrOutput = {
+  type: 'or'
+  clauses: ClauseOutput[]
+}
+
+const And = z.object({
+  type: z.literal('and'),
+  clauses: z.lazy(() => Clause.array())
+})
+
+const Or = z.object({
   type: z.literal('or'),
   clauses: z.lazy(() => Clause.array())
 })
 
-export type Clause =
-  | And
-  | Or
-  | z.infer<typeof FuzzyMatcher>
-  | z.infer<typeof StrictMatcher>
-  | z.infer<typeof DateRangeMatcher>
-
-export const Clause = z.union([
-  And,
-  Or,
-  FuzzyMatcher,
-  StrictMatcher,
-  DateRangeMatcher,
-  DateDistanceMatcher
-])
+export type ClauseInput =
+  | AndInput
+  | OrInput
+  | z.input<typeof FuzzyMatcher>
+  | z.input<typeof StrictMatcher>
+  | z.input<typeof DateRangeMatcher>
+  | z.input<typeof DateDistanceMatcher>
+
+export type ClauseOutput =
+  | AndOutput
+  | OrOutput
+  | z.output<typeof FuzzyMatcher>
+  | z.output<typeof StrictMatcher>
+  | z.output<typeof DateRangeMatcher>
+  | z.output<typeof DateDistanceMatcher>
+
+/**
+ * Defines a deduplication clause. Clauses are either matcher clauses or logical clauses. Logical clauses (and, or) are used to combine multiple clauses.
+ * Since the definiton is recursive, we use z.lazy to define the schema.
+ * Zod supports recursive schemas, but needs help with Input and Output types.
+ *
+ * Default assumption is that the ZodType is the input. Markers use default values, so we need to explicitly define output type, too.
+ *
+ */
+export const Clause: z.ZodType<ClauseOutput, z.ZodTypeDef, ClauseInput> =
+  z.lazy(() =>
+    z.discriminatedUnion('type', [
+      And,
+      Or,
+      FuzzyMatcher,
+      StrictMatcher,
+      DateRangeMatcher,
+      DateDistanceMatcher
+    ])
+  )
 
 export const DeduplicationConfig = z.object({
   id: z.string(),

diff --git a/packages/events/.eslintrc.js b/packages/events/.eslintrc.js
@@ -9,7 +9,7 @@
  * Copyright (C) The OpenCRVS Authors located at https://github.com/opencrvs/opencrvs-core/blob/master/AUTHORS.
  */
 module.exports = {
-  extends: '../../.eslintrc.js',
+  extends: '../../.eslintrc.events.js',
   env: {
     es6: true
   },

diff --git a/packages/events/package.json b/packages/events/package.json
@@ -46,7 +46,7 @@
     "testcontainers": "^10.15.0",
     "ts-jest": "27.1.4",
     "ts-node": "^6.1.1",
-    "typescript": "4.9.5",
+    "typescript": "5.6.3",
     "vite-tsconfig-paths": "^3.5.0",
     "vitest": "^2.1.5"
   },