Record nodes internal ID #293

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft

SteRiccio wants to merge 7 commits into master from feat/record-nodes-internal-id

.npmrc

-Original file line number
+Diff line change
@@ -1,2 +1,2 @@
     @openforis:registry=https://npm.pkg.github.com
-    always-auth = true
+    # always-auth = true

src/job/JobBase.ts

-Original file line number
+Diff line change
@@ Expand Up @@
         }
         this.emitSummaryUpdateEvent = throttle(() => this.emit(JobMessageOutType.summaryUpdate, this.summary), 500)
-        this.jobs.forEach((job) => job.on(JobMessageOutType.summaryUpdate, this.onInnerJobSummaryUpdate.bind(this)))
+        for (const job of jobs) {
+          job.on(JobMessageOutType.summaryUpdate, this.onInnerJobSummaryUpdate.bind(this))
+        }
       }
       async cancel(): Promise<void> {
@@ Expand Down @@

src/node/factory.ts

            
                      Original file line number
                      Diff line number
                      Diff line change
                  
    @@ -1,33 +1,42 @@
  
    import { Factory } from '../common'

    import { Dates, UUIDs } from '../utils'

    import { Record } from '../record'

    import { Dates } from '../utils'

    import { Node } from './node'

    export type NodeFactoryParams = {

      record: Record

      nodeDefUuid: string

      recordUuid: string

      parentNode?: Node

      surveyUuid?: string

      value?: any

    }

    export const NodeFactory: Factory<Node, NodeFactoryParams> = {

      createInstance: (params: NodeFactoryParams): Node => {

        const { nodeDefUuid, recordUuid, parentNode, surveyUuid, value } = params

        const { nodeDefUuid, record, parentNode, surveyUuid, value } = params

        const iId = (record.lastInternalId ?? 0) + 1

        const now = Dates.nowFormattedForStorage()

        const { iId: pId, meta: pMeta } = parentNode ?? {}

        const h = [...(pMeta?.h ?? [])]

        if (pId) {

          h.push(pId)

        }

        return {

          created: true,

          dateCreated: now,

          dateModified: now,

          meta: {

            h: [...(parentNode?.meta?.h ?? []), ...(parentNode?.uuid ? [parentNode?.uuid] : [])],

          },

          iId,

          meta: { h },

          nodeDefUuid,

          parentUuid: parentNode?.uuid,

          recordUuid,

          pIId: parentNode?.iId,

          recordUuid: record.uuid,

          surveyUuid,

          value,

          uuid: UUIDs.v4(),

        }

      },

    }

src/node/node.test.ts

            
                      Original file line number
                      Diff line number
                      Diff line change
                  
    @@ -1,14 +1,18 @@
  
    import { RecordFactory } from '../record'

    import { NodeFactory, NodeFactoryParams, NodePlaceholderFactory } from './factory'

    import { Node } from './node'

    import { createTestAdminUser } from '../tests/data'

    const user = createTestAdminUser()

    const checkNode = (node: Node, nodeParams: NodeFactoryParams) => {

      expect(node).toHaveProperty('uuid')

      expect(node).toHaveProperty('iId')

      expect(node).toHaveProperty('nodeDefUuid')

      expect(node.nodeDefUuid).toBe(nodeParams.nodeDefUuid)

      expect(node).toHaveProperty('recordUuid')

      expect(node.recordUuid).toBe(nodeParams.recordUuid)

      expect(node).toHaveProperty('parentUuid')

      expect(node.parentUuid).toBe(nodeParams.parentNode?.uuid)

      expect(node.recordUuid).toBe(nodeParams.record.uuid)

      expect(node).toHaveProperty('pIId')

      expect(node.pIId).toBe(nodeParams.parentNode?.iId)

      expect(node).toHaveProperty('value')

      expect(node.value).toBe(nodeParams.value)

    @@ -21,7 +25,7 @@ const checkNode = (node: Node, nodeParams: NodeFactoryParams) => {
  
      const expectedHierarchy = [

        ...(nodeParams.parentNode?.meta?.h ?? []),

        ...(nodeParams.parentNode?.uuid ? [nodeParams.parentNode?.uuid] : []),

        ...(nodeParams.parentNode?.iId ? [nodeParams.parentNode.iId] : []),

      ]

      const nodeHierarchy = [...(node.meta?.h ?? [])]

      expect(nodeHierarchy.length).toBe(expectedHierarchy.length)

    @@ -30,15 +34,16 @@ const checkNode = (node: Node, nodeParams: NodeFactoryParams) => {
  
    describe('NodeFactory', () => {

      test('createInstence - node', () => {

        const record = RecordFactory.createInstance({ surveyUuid: 'survey-uuid', user })

        const nodeParams: NodeFactoryParams = {

          nodeDefUuid: 'nodedef-uuid-0001-test',

          recordUuid: 'record-uuid-0001-test',

          record,

          parentNode: {

            uuid: 'parent-node-uuid',

            iId: 2,

            nodeDefUuid: 'nodeDefUuid',

            recordUuid: 'nodeDefUuid',

            meta: {

              h: ['uuid-prev'],

              h: [1],

            },

          },

          value: 'VALUE',

    @@ -49,9 +54,10 @@ describe('NodeFactory', () => {
  
      })

      test('createInstence - parent node', () => {

        const record = RecordFactory.createInstance({ surveyUuid: 'survey-uuid', user })

        const nodeParams: NodeFactoryParams = {

          nodeDefUuid: 'nodedef-uuid-0001-test',

          recordUuid: 'record-uuid-0001-test',

          record,

          value: 'VALUE',

        }

    @@ -60,15 +66,16 @@ describe('NodeFactory', () => {
  
      })

      test('createInstence - placeholder', () => {

        const record = RecordFactory.createInstance({ surveyUuid: 'survey-uuid', user })

        const nodeParams: NodeFactoryParams = {

          nodeDefUuid: 'nodedef-uuid-0001-test',

          recordUuid: 'record-uuid-0001-test',

          record,

          parentNode: {

            uuid: 'parent-node-uuid',

            iId: 3,

            nodeDefUuid: 'nodeDefUuid',

            recordUuid: 'nodeDefUuid',

            meta: {

              h: ['uuid-prev'],

              h: [2],

            },

          },

          value: 'VALUE',

src/node/node.ts

            
                      Original file line number
                      Diff line number
                      Diff line change
                  
    @@ -11,11 +11,11 @@ export enum NodeMetaKeys {
  
    }

    export interface NodeMeta {

      childApplicability?: { [uuid: string]: boolean }

      childrenMaxCount?: { [uuid: string]: number }

      childrenMinCount?: { [uuid: string]: number }

      h?: string[]

      hCode?: string[]

      childApplicability?: { [nodeDefUuid: string]: boolean }

      childrenMaxCount?: { [nodeDefUuid: string]: number }

      childrenMinCount?: { [nodeDefUuid: string]: number }

      h?: number[]

      hCode?: number[]

      defaultValueApplied?: boolean

    }

    @@ -27,13 +27,22 @@ export interface NodeRefData {
  
    export interface Node {

      dateCreated?: string

      dateModified?: string

      /**

       * ID used when node is stored (unique relatively to the entire survey; e.g. DB table PK).

       */

      id?: number

      /**

       * Internal ID (unique relatively to the record).

       */

      iId: number

      meta?: NodeMeta

      nodeDefUuid: string

      parentUuid?: string

      /**

       * Parent node internal ID.

       */

      pIId?: number

      recordUuid: string

      refData?: NodeRefData

      uuid: string

      value?: any

      placeholder?: boolean

      surveyUuid?: string

    @@ -54,5 +63,5 @@ export interface Node {
  
    }

    export interface NodesMap {

      [key: string]: Node

      [internalId: number]: Node

    }

src/node/nodes.ts

            
                      Original file line number
                      Diff line number
                      Diff line change
                  
    @@ -2,9 +2,9 @@ import { NodeDef, NodeDefCountType, NodeDefs } from '../nodeDef'
  
    import { Dates, Objects } from '../utils'

    import { Node } from './node'

    const isRoot = (node: Node): boolean => !node.parentUuid

    const isRoot = (node: Node): boolean => !node.pIId

    const areEqual = (nodeA: Node, nodeB: Node): boolean => nodeA.uuid === nodeB.uuid

    const areEqual = (nodeA: Node, nodeB: Node): boolean => nodeA.iId === nodeB.iId

    const isChildApplicable = (node: Node, nodeDefUuid: string): boolean => {

      // if child applicability is not defined for a node definition, consider it applicable

    @@ -34,9 +34,9 @@ const getChildrenMaxCount = (params: { parentNode: Node; nodeDef: NodeDef<any> }
  
    const getChildrenMinCount = (params: { parentNode: Node; nodeDef: NodeDef<any> }): number =>

      getChildrenMinOrMaxCount({ ...params, countType: NodeDefCountType.min })

    const getHierarchy = (node: Node): string[] => [...(node.meta?.h ?? [])]

    const getHierarchy = (node: Node): number[] => [...(node.meta?.h ?? [])]

    const getHierarchyCode = (node: Node): string[] => [...(node.meta?.hCode ?? [])]

    const getHierarchyCode = (node: Node): number[] => [...(node.meta?.hCode ?? [])]

    const mergeNodes = (target: Node, ...sources: Node[] | object[]): Node =>

      Objects.deepMerge(target, ...sources) as unknown as Node

src/node/service.ts

            
                      Original file line number
                      Diff line number
                      Diff line change
                  
    @@ -7,14 +7,14 @@ export interface NodeService extends ArenaService {
  
      create(options: { filePath?: string; node: Node; socketId: string; surveyId: number; user: User }): Promise<Node>

      // ==== READ

      get(options: { surveyId: number; nodeUuid: string }): Promise<Node>

      get(options: { surveyId: number; nodeInternalId: number }): Promise<Node>

      // ==== UPDATE

      update(options: { filePath?: string; node: Node; socketId: string; surveyId: number; user: User }): Promise<Node>

      // ==== DELETE

      delete(options: {

        nodeUuid: string

        nodeInternalId: number

        recordUuid: string

        socketId: string

        surveyId: number

src/nodeDefExpressionEvaluator/node/identifier.ts

-Original file line number
+Diff line change
@@ Expand Up @@
         while (!queue.isEmpty()) {
           const entityDefCurrent = queue.dequeue()
           const entityDefCurrentChildren = getNodeDefChildren({ survey, nodeDef: entityDefCurrent, includeAnalysis })
-          entityDefCurrentChildren.forEach((childDef) => (reachableNodeDefsByUuid[childDef.uuid] = childDef))
+          for (const childDef of entityDefCurrentChildren) {
+            reachableNodeDefsByUuid[childDef.uuid] = childDef
+          }
           // visit nodes inside single entities
           queue.enqueueItems(entityDefCurrentChildren.filter(NodeDefs.isSingleEntity))
@@ Expand Down @@

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Record nodes internal ID #293

Uh oh!

Diff view

Diff view

There are no files selected for viewing

Uh oh!

Record nodes internal ID #293

Are you sure you want to change the base?

Uh oh!

Record nodes internal ID #293

Uh oh!

Uh oh!

Diff view

Diff view

There are no files selected for viewing

Uh oh!