chore: prevent injecting plugins if URL is not supplied (#19)

* chore: prevent injecting plugins if URL is not supplied

* chore: notify the user via error log if URL is missing

Author: james-deepsource

example/nuxt.config.js

@@ -1,4 +1,7 @@
 export default {
   buildModules: ['@nuxtjs/tailwindcss'],
-  modules: ['@nuxt/typescript-build', '../src/module.ts']
+  modules: ['@nuxt/typescript-build', '../src/module.ts'],
+  websocket: {
+    url: 'wss://echo.websocket.events/'
+  }
 }

example/pages/index.vue

@@ -69,7 +69,7 @@
         <button
           :disabled="isSendDisabled"
           class="btn btn-blue"
-          :class="{ 'cursor-not-allowed opacity-50': isSendDisabled}"
+          :class="{ 'cursor-not-allowed opacity-50': isSendDisabled }"
           @click.prevent="sendMessage"
         >
           Send message

src/templates/plugin.ts

@@ -17,13 +17,21 @@ import WebSocketManager from './WebSocketManager'
 
 const reconnectInterval = Number('<%= options.reconnectInterval %>') || 1000
 const urlFromOptions = '<%= options.url %>'
+
 export default ({ app }: { app: NuxtAppOptions }, inject: Inject): void => {
   /* istanbul ignore next */
   const runtimeConfig = (app.$config && app.$config.websocket) || {}
 
   /* istanbul ignore next */
-  const url =
-    runtimeConfig.url || urlFromOptions || 'wss://echo.websocket.events/'
+  const url = runtimeConfig.url || urlFromOptions
+
+  /* istanbul ignore next */
+  if (!url) {
+    // eslint-disable-next-line no-console
+    return console.error(
+      'WebSocket connection URL is required. Please specify it via options or runtime configuration.'
+    )
+  }
 
   const emitter = new Vue()
   const manager = new WebSocketManager(url, emitter, reconnectInterval)

test/module.test.ts

@@ -1,4 +1,8 @@
-import { expectModuleToBeCalledWith, setupTest } from '@nuxt/test-utils'
+import {
+  expectModuleToBeCalledWith,
+  getNuxt,
+  setupTest
+} from '@nuxt/test-utils'
 
 describe('module', () => {
   setupTest({
@@ -10,15 +14,15 @@ describe('module', () => {
     expectModuleToBeCalledWith('addPlugin', {
       src: 'src/templates/plugin.ts',
       fileName: 'nuxt-websocket/websocket.client.ts',
-      options: {}
+      options: getNuxt().options.websocket
     })
   })
 
   test('should render the template', () => {
     expectModuleToBeCalledWith('addTemplate', {
       src: 'src/templates/WebSocketManager.ts',
       fileName: 'nuxt-websocket/WebSocketManager.ts',
-      options: {}
+      options: getNuxt().options.websocket
     })
   })
 })