feat(test): Add cypress for testing

cypress/integration/1-store/setElements.spec.ts

@@ -0,0 +1,87 @@
+import { getElements } from '../../../examples/Stress/utils'
+import { useStore } from '~/composables'
+import { FlowStore } from '~/types'
+import { isGraphEdge, isGraphNode } from '~/utils'
+
+describe('test store action setElements', () => {
+  const setElements = async (store: FlowStore) => {
+    const elements = [
+      { id: '1', type: 'input', data: { label: 'Node 1' }, position: { x: 250, y: 5 } },
+      { id: '2', data: { label: 'Node 2' }, position: { x: 100, y: 100 } },
+      { id: 'e1-2', source: '1', target: '2', animated: true },
+    ]
+    await store.setElements(elements)
+  }
+
+  it('sets elements', async () => {
+    const store = useStore()
+    await setElements(store)
+    expect(store.elements).to.have.length(3)
+    store.$dispose()
+  })
+
+  context('elements pre-set', () => {
+    let store: FlowStore
+    beforeEach(async () => {
+      store = useStore()
+      await setElements(store)
+    })
+    afterEach(() => store.$dispose())
+
+    it('adds elements', () => {
+      store.addElements([{ id: '4', data: { label: 'Node 4' }, position: { x: 500, y: 500 } }])
+      expect(store.elements).to.have.length(4)
+    })
+
+    it('parses elements to flow-elements', () => {
+      store.getEdges.forEach((edge) => expect(!isGraphNode(edge)).to.be.true)
+      store.getNodes.forEach((node) => expect(!isGraphEdge(node)).to.be.true)
+    })
+
+    it('parses elements to flow-elements (199 elements - stress test)', async () => {
+      await store.setElements(getElements())
+      store.getEdges.forEach((edge) => expect(!isGraphNode(edge)).to.be.true)
+      store.getNodes.forEach((node) => expect(!isGraphEdge(node)).to.be.true)
+    })
+
+    it('has correct element ids', () => {
+      store.elements.forEach((el) => expect(['1', '2', 'e1-2']).to.include(el.id))
+    })
+
+    it('has correct element types', () => {
+      store.elements.forEach((el) => expect(['input', 'default']).to.include(el.type))
+    })
+
+    it('nodes have correct label', () => {
+      store.getNodes.forEach((el) => {
+        if (el.id === '1') expect(el.data.label).to.eq('Node 1')
+        else expect(el.data.label).to.eq('Node 2')
+      })
+    })
+
+    it('nodes have correct position', () => {
+      store.getNodes.forEach((el) => {
+        if (el.id === '1') expect(JSON.stringify(el.position)).to.eq(JSON.stringify({ x: 250, y: 5 }))
+        else expect(JSON.stringify(el.position)).to.eq(JSON.stringify({ x: 100, y: 100 }))
+      })
+    })
+
+    it('edge has correct target and source', () => {
+      store.getEdges.forEach((el) => {
+        expect(el.source).to.eq('1')
+        expect(el.target).to.eq('2')
+      })
+    })
+
+    it('edge has correct targetnode and sourceNode', () => {
+      store.getEdges.forEach((el) => {
+        expect(el.sourceNode.id).to.eq('1')
+        expect(el.targetNode.id).to.eq('2')
+      })
+    })
+
+    it('edge is animated', () => {
+      store.getEdges.forEach((el) => expect(el.animated).to.eq(true))
+    })
+  })
+})

cypress/integration/1-store/setState.spec.ts

@@ -0,0 +1,51 @@
+import { useStore } from '~/composables'
+import { initialState } from '~/utils'
+import { FlowState, FlowStore } from '~/types'
+describe('test store state', () => {
+  let store: FlowStore
+
+  beforeEach(() => (store = useStore()))
+  afterEach(() => store.$dispose())
+
+  it('has any initial state', () => {
+    expect(store.$state).to.exist
+  })
+
+  it('has default initial state', () => {
+    const initial = initialState()
+    Object.keys(store.$state).forEach((state) => {
+      const storedState = store[<keyof FlowState>state]
+      const initialVal = initial[<keyof FlowState>state]
+      expect(JSON.stringify(storedState)).to.eq(JSON.stringify(initialVal))
+    })
+  })
+
+  it('sets state', () => {
+    store.setState({
+      zoomOnScroll: false,
+    })
+    expect(store.zoomOnScroll).to.eq(false)
+  })
+
+  it('takes initial options', () => {
+    const store = useStore({
+      zoomOnScroll: false,
+    })
+    expect(store.zoomOnScroll).to.eq(false)
+    store.$dispose()
+  })
+
+  it('gets custom node types', () => {
+    store.setState({
+      nodeTypes: ['custom'],
+    })
+    expect(Object.keys(store.getNodeTypes)).to.contain('custom')
+  })
+
+  it('gets custom edge types', () => {
+    store.setState({
+      edgeTypes: ['custom'],
+    })
+    expect(Object.keys(store.getEdgeTypes)).to.contain('custom')
+  })
+})

cypress/plugins/index.ts

@@ -0,0 +1,15 @@
+import { resolve } from 'path'
+import { startDevServer } from '@cypress/vite-dev-server'
+
+export default ((on, config) => {
+  on('dev-server:start', async (options) =>
+    startDevServer({
+      options,
+      viteConfig: {
+        configFile: resolve(__dirname, '..', '..', 'vite.config.ts'),
+      },
+    }),
+  )
+
+  return config
+}) as Cypress.PluginConfig

cypress/support/commands.js

@@ -0,0 +1,25 @@
+// ***********************************************
+// This example commands.js shows you how to
+// create various custom commands and overwrite
+// existing commands.
+//
+// For more comprehensive examples of custom
+// commands please read more here:
+// https://on.cypress.io/custom-commands
+// ***********************************************
+//
+//
+// -- This is a parent command --
+// Cypress.Commands.add('login', (email, password) => { ... })
+//
+//
+// -- This is a child command --
+// Cypress.Commands.add('drag', { prevSubject: 'element'}, (subject, options) => { ... })
+//
+//
+// -- This is a dual command --
+// Cypress.Commands.add('dismiss', { prevSubject: 'optional'}, (subject, options) => { ... })
+//
+//
+// -- This will overwrite an existing command --
+// Cypress.Commands.overwrite('visit', (originalFn, url, options) => { ... })

cypress/support/index.js

@@ -0,0 +1,19 @@
+// ***********************************************************
+// This example support/index.js is processed and
+// loaded automatically before your test files.
+//
+// This is a great place to put global configuration and
+// behavior that modifies Cypress.
+//
+// You can change the location of this file or turn off
+// automatically serving support files with the
+// 'supportFile' configuration option.
+//
+// You can read more here:
+// https://on.cypress.io/configuration
+// ***********************************************************
+
+// Import commands.js using ES2015 syntax:
+
+// Alternatively you can use CommonJS syntax:
+// require('./commands')

cypress/tsconfig.json

@@ -0,0 +1,7 @@
+{
+  "extends": "../tsconfig.json",
+  "compilerOptions": {
+    "target": "es2018"
+  },
+  "include": ["**/*"]
+}