feature/websockets

[PaulDalek]

Added a websocket connection possibility, touch #456.

[jszuminski]

Great job!

I'm not sure if that's an error, but when I try to run node ./bin/cli.js --startServer 1 --logLevel 4 with the following .env file:

WS_ENABLE=true
WS_URL=ws://localhost:7777

I get the following error:

ZOD Error related to ENV

file:///Users/jakubszuminski/Documents/Coding/Highcharts/exporting/node-export-server/node_modules/zod/lib/index.mjs:538
                const error = new ZodError(ctx.common.issues);
                              ^
ZodError: [
  {
    "expected": "'true' | 'false'",
    "received": "undefined",
    "code": "invalid_type",
    "path": [
      "WS_RECONNECT"
    ],
    "message": "Required"
  },
  {
    "expected": "'true' | 'false'",
    "received": "undefined",
    "code": "invalid_type",
    "path": [
      "WS_REJECT_UNAUTHORIZED"
    ],
    "message": "Required"
  },
  {
    "code": "invalid_type",
    "expected": "number",
    "received": "nan",
    "path": [
      "WS_PING_TIMEOUT"
    ],
    "message": "Expected number, received nan"
  },
  {
    "code": "invalid_type",
    "expected": "number",
    "received": "nan",
    "path": [
      "WS_RECONNECT_INTERVAL"
    ],
    "message": "Expected number, received nan"
  },
  {
    "code": "invalid_type",
    "expected": "string",
    "received": "undefined",
    "path": [
      "WS_SECRET"
    ],
    "message": "Required"
  }
]
    at Object.get error [as error] (file:///Users/jakubszuminski/Documents/Coding/Highcharts/exporting/node-export-server/node_modules/zod/lib/index.mjs:538:31)
    at ZodObject.parse (file:///Users/jakubszuminski/Documents/Coding/Highcharts/exporting/node-export-server/node_modules/zod/lib/index.mjs:638:22)
    at file:///Users/jakubszuminski/Documents/Coding/Highcharts/exporting/node-export-server/lib/envConfig.js:16:36
    at ModuleJob.run (node:internal/modules/esm/module_job:193:25)
    at async Promise.all (index 0)
    at async ESMLoader.import (node:internal/modules/esm/loader:530:24)
    at async loadESM (node:internal/process/esm_loader:91:5)
    at async handleMainPromise (node:internal/modules/run_main:65:12) {
  issues: [
    {
      expected: "'true' | 'false'",
      received: 'undefined',
      code: 'invalid_type',
      path: [ 'WS_RECONNECT' ],
      message: 'Required'
    },
    {
      expected: "'true' | 'false'",
      received: 'undefined',
      code: 'invalid_type',
      path: [ 'WS_REJECT_UNAUTHORIZED' ],
      message: 'Required'
    },
    {
      code: 'invalid_type',
      expected: 'number',
      received: 'nan',
      path: [ 'WS_PING_TIMEOUT' ],
      message: 'Expected number, received nan'
    },
    {
      code: 'invalid_type',
      expected: 'number',
      received: 'nan',
      path: [ 'WS_RECONNECT_INTERVAL' ],
      message: 'Expected number, received nan'
    },
    {
      code: 'invalid_type',
      expected: 'string',
      received: 'undefined',
      path: [ 'WS_SECRET' ],
      message: 'Required'
    }
  ],
  addIssue: [Function (anonymous)],
  addIssues: [Function (anonymous)],
  errors: [
    {
      expected: "'true' | 'false'",
      received: 'undefined',
      code: 'invalid_type',
      path: [ 'WS_RECONNECT' ],
      message: 'Required'
    },
    {
      expected: "'true' | 'false'",
      received: 'undefined',
      code: 'invalid_type',
      path: [ 'WS_REJECT_UNAUTHORIZED' ],
      message: 'Required'
    },
    {
      code: 'invalid_type',
      expected: 'number',
      received: 'nan',
      path: [ 'WS_PING_TIMEOUT' ],
      message: 'Expected number, received nan'
    },
    {
      code: 'invalid_type',
      expected: 'number',
      received: 'nan',
      path: [ 'WS_RECONNECT_INTERVAL' ],
      message: 'Expected number, received nan'
    },
    {
      code: 'invalid_type',
      expected: 'string',
      received: 'undefined',
      path: [ 'WS_SECRET' ],
      message: 'Required'
    }
  ]
}

Should all of those options be required? Or only some of them? What do you think about including default values for the users?

[PaulDalek]

@jakubSzuminski Nice catch, corrected properties of the config object to optionals.

[jszuminski]

I'm not sure, but shouldn't we add the EnvConfig zod parser to envs.js which has been added here: #498 so that we have all the envs & their validators in one file, in one place?

[PaulDalek]

@jszuminski Yes but I will do it once the test/basic-test-env-setup branch is merged to the master.