Merge pull request #74 from kaythomas0/v0.7.0

v0.7.0

.github/dependabot.yml

@@ -0,0 +1,8 @@
+version: 2
+updates:
+  - package-ecosystem: "npm"
+    directory: "/"
+    schedule:
+      interval: "daily"
+    # Disable version updates for npm dependencies
+    open-pull-requests-limit: 0

Dockerfile

@@ -1,8 +1,8 @@
-FROM node:14
+FROM node:20
 LABEL maintainer="kaythomas@pm.me"
 WORKDIR /var/noisedash
 COPY package*.json ./
-RUN npm install
+RUN npm install --force
 COPY . .
 ENV NODE_ENV production
 RUN npm run build

README.md

@@ -23,6 +23,9 @@ Requires docker and docker-compose
 
 * Download the provided [docker-compose.yml file](https://github.com/kaythomas0/noisedash/blob/main/docker-compose.yml)
 * In the same directory as the docker-compose file, created a folder called `config`, and inside it, put the provided [config file](https://github.com/kaythomas0/noisedash/blob/main/config/default.json)
+  * `maxSampleSize` is in bytes - 10GB by default
+  * Keep `tls` as `false` if using an external web server like nginx
+  * `production.json` exists in the source code and is left empty intentionally for the reason outlined here: https://github.com/node-config/node-config/wiki/Strict-Mode#node_env-value-of-node_env-did-not-match-any-deployment-config-file-names=
 * Edit the config file to your preference
 * Bring the container up:
 
@@ -34,9 +37,26 @@ docker-compose up -d
 
 (Raspberry Pi compatible images are available, see armv7 images on [Docker Hub](https://hub.docker.com/repository/docker/noisedash/noisedash))
 
+## Kubernetes
+
+You can apply the manifest.yaml in the kubernetes folder to install Noisedash into your Kubernetes cluster.
+
+Optionally, uncomment the last lines in the file to also create an ingress.  The ingress, commented out by default, needs to have the clusterIssuser annotation set to your cluster issuer (default: letsencrypt-prod) and the ingress class set to your Ingress class (default: Nginx)
+
+
+``` bash
+$ kubectl apply -f ./kubernetes/manifest.yaml
+persistentvolumeclaim/db-pvc created
+persistentvolumeclaim/samples-pvc created
+deployment.apps/noisedash created
+service/noisedash created
+configmap/noisedashcfg created
+ingress.networking.k8s.io/noisedashingress created
+```
+
 ## From Source
 
-Requires node 14 and npm
+Requires node 20 and npm
 
 * Clone the repo:
 

config/default.json

@@ -3,9 +3,9 @@
     "listeningPort": 1432,
     "sessionFileStorePath": "sessions",
     "sampleUploadPath": "samples",
-    "maxSampleSize": 10737418240, // In bytes, 10GB by default
+    "maxSampleSize": 10737418240,
     "logFile": "log/noisedash.log",
-    "tls": false, // Keep this as false if using an external web server like nginx
+    "tls": false,
     "tlsKey": "certs/key.pem",
     "tlsCert": "certs/cert.pem"
   }

config/production.json

@@ -1 +1 @@
-{} // Left empty intentionally: https://github.com/node-config/node-config/wiki/Strict-Mode#node_env-value-of-node_env-did-not-match-any-deployment-config-file-names=
+{}

kubernetes/manifest.yaml

@@ -0,0 +1,240 @@
+apiVersion: v1
+kind: PersistentVolumeClaim
+metadata:
+  name: db-pvc
+spec:
+  accessModes:
+    - ReadWriteOnce
+  resources:
+    requests:
+      storage: 10Gi
+---
+apiVersion: v1
+kind: PersistentVolumeClaim
+metadata:
+  name: samples-pvc
+spec:
+  accessModes:
+    - ReadWriteOnce
+  resources:
+    requests:
+      storage: 10Gi
+---
+apiVersion: apps/v1
+kind: Deployment
+metadata:
+  name: noisedash
+spec:
+  replicas: 1
+  selector:
+    matchLabels:
+      app: noisedash
+  template:
+    metadata:
+      labels:
+        app: noisedash
+    spec:
+      containers:
+      - name: noisedash
+        image: noisedash/noisedash:latest
+        ports:
+        - containerPort: 1432
+        volumeMounts:
+        - name: db
+          mountPath: /var/noisedash/db
+        - name: samples
+          mountPath: /var/noisedash/samples
+        - name: config
+          mountPath: /var/noisedash/config/default.json
+          subPath: config.json
+      volumes:
+      - name: db
+        persistentVolumeClaim:
+          claimName: db-pvc
+      - name: samples
+        persistentVolumeClaim:
+          claimName: samples-pvc
+      - name: config
+        configMap:
+          name: noisedashcfg
+---
+apiVersion: v1
+kind: Service
+metadata:
+  name: noisedash
+spec:
+  selector:
+    app: noisedash
+  ports:
+    - protocol: TCP
+      port: 80
+      targetPort: 1432
+---
+apiVersion: v1
+kind: ConfigMap
+metadata:
+  name: noisedashcfg
+data:
+  config.json: |
+    {
+      "Server": {
+        "listeningPort": 1432,
+        "sessionFileStorePath": "sessions",
+        "sampleUploadPath": "samples",
+        "maxSampleSize": 10737418240,
+        "logFile": "log/noisedash.log",
+        "tls": false,
+        "tlsKey": "certs/key.pem",
+        "tlsCert": "certs/cert.pem"
+      }
+    }
+---
+apiVersion: networking.k8s.io/v1
+kind: Ingress
+metadata:
+  annotations:
+    cert-manager.io/cluster-issuer: letsencrypt-prod
+    kubernetes.io/ingress.class: nginx
+    kubernetes.io/tls-acme: "true"
+    nginx.ingress.kubernetes.io/proxy-read-timeout: "3600"
+    nginx.ingress.kubernetes.io/proxy-send-timeout: "3600"
+  labels:
+    app.kubernetes.io/instance: noisedash
+  name: noisedashingress
+spec:
+  rules:
+  - host: noisedash.freshbrewed.science
+    http:
+      paths:
+      - backend:
+          service:
+            name: noisedash
+            port:
+              number: 80
+        path: /
+        pathType: ImplementationSpecific
+  tls:
+  - hosts:
+    - noisedash.freshbrewed.science
+    secretName: noisedash-tls
+builder@DESKTOP-QADGF36:~/Workspaces/pyplanereport$
+builder@DESKTOP-QADGF36:~/Workspaces/pyplanereport$ cat noiseall.yaml
+apiVersion: v1
+kind: PersistentVolumeClaim
+metadata:
+  name: db-pvc
+spec:
+  accessModes:
+    - ReadWriteOnce
+  resources:
+    requests:
+      storage: 10Gi
+---
+apiVersion: v1
+kind: PersistentVolumeClaim
+metadata:
+  name: samples-pvc
+spec:
+  accessModes:
+    - ReadWriteOnce
+  resources:
+    requests:
+      storage: 10Gi
+---
+apiVersion: apps/v1
+kind: Deployment
+metadata:
+  name: noisedash
+spec:
+  replicas: 1
+  selector:
+    matchLabels:
+      app: noisedash
+  template:
+    metadata:
+      labels:
+        app: noisedash
+    spec:
+      containers:
+      - name: noisedash
+        image: noisedash/noisedash:latest
+        ports:
+        - containerPort: 1432
+        volumeMounts:
+        - name: db
+          mountPath: /var/noisedash/db
+        - name: samples
+          mountPath: /var/noisedash/samples
+        - name: config
+          mountPath: /var/noisedash/config/default.json
+          subPath: config.json
+      volumes:
+      - name: db
+        persistentVolumeClaim:
+          claimName: db-pvc
+      - name: samples
+        persistentVolumeClaim:
+          claimName: samples-pvc
+      - name: config
+        configMap:
+          name: noisedashcfg
+---
+apiVersion: v1
+kind: Service
+metadata:
+  name: noisedash
+spec:
+  selector:
+    app: noisedash
+  ports:
+    - protocol: TCP
+      port: 80
+      targetPort: 1432
+---
+apiVersion: v1
+kind: ConfigMap
+metadata:
+  name: noisedashcfg
+data:
+  config.json: |
+    {
+      "Server": {
+        "listeningPort": 1432,
+        "sessionFileStorePath": "sessions",
+        "sampleUploadPath": "samples",
+        "maxSampleSize": 10737418240,
+        "logFile": "log/noisedash.log",
+        "tls": false,
+        "tlsKey": "certs/key.pem",
+        "tlsCert": "certs/cert.pem"
+      }
+    }
+# ---
+# apiVersion: networking.k8s.io/v1
+# kind: Ingress
+# metadata:
+#   annotations:
+#     cert-manager.io/cluster-issuer: letsencrypt-prod
+#     kubernetes.io/ingress.class: nginx
+#     kubernetes.io/tls-acme: "true"
+#     nginx.ingress.kubernetes.io/proxy-read-timeout: "3600"
+#     nginx.ingress.kubernetes.io/proxy-send-timeout: "3600"
+#   labels:
+#     app.kubernetes.io/instance: noisedash
+#   name: noisedashingress
+# spec:
+#   rules:
+#   - host: noisedash.freshbrewed.science
+#     http:
+#       paths:
+#       - backend:
+#           service:
+#             name: noisedash
+#             port:
+#               number: 80
+#         path: /
+#         pathType: ImplementationSpecific
+#   tls:
+#   - hosts:
+#     - noisedash.freshbrewed.science
+#     secretName: noisedash-tls

package.json

@@ -1,6 +1,6 @@
 {
   "name": "noisedash",
-  "version": "0.6.0",
+  "version": "0.7.0",
   "private": true,
   "author": "Kay Thomas <kaythomas@pm.me> (https://kaythomas.dev)",
   "scripts": {
@@ -12,11 +12,11 @@
   },
   "dependencies": {
     "@vscode/sqlite3": "^5.0.8",
-    "axios": "^0.21.4",
+    "axios": "^1.6.0",
     "config": "^3.3.6",
     "connect-history-api-fallback": "^1.6.0",
     "cookie-parser": "^1.4.5",
-    "core-js": "^3.22.7",
+    "core-js": "^3.23.5",
     "express": "^4.18.1",
     "express-session": "^1.17.3",
     "multer": "^1.4.5-lts.1",
@@ -25,18 +25,18 @@
     "path": "^0.12.7",
     "session-file-store": "^1.5.0",
     "tone": "^14.7.77",
-    "vue": "^2.6.11",
+    "vue": "^2.7.16",
     "vue-router": "^3.5.4",
-    "vuetify": "^2.6.6",
+    "vuetify": "^2.6.10",
     "winston": "^3.3.3"
   },
   "devDependencies": {
     "@babel/core": "^7.12.16",
     "@babel/eslint-parser": "^7.12.16",
-    "@vue/cli-plugin-babel": "^5.0.4",
+    "@vue/cli-plugin-babel": "^5.0.8",
-    "@vue/cli-plugin-eslint": "^5.0.4",
+    "@vue/cli-plugin-eslint": "^5.0.8",
-    "@vue/cli-plugin-router": "^5.0.4",
+    "@vue/cli-plugin-router": "^5.0.8",
-    "@vue/cli-service": "^5.0.4",
+    "@vue/cli-service": "^5.0.8",
     "@vue/eslint-config-standard": "^6.1.0",
     "eslint": "^7.32.0",
     "eslint-plugin-html": "^6.2.0",
@@ -44,11 +44,11 @@
     "eslint-plugin-node": "^11.1.0",
     "eslint-plugin-promise": "^5.1.0",
     "eslint-plugin-standard": "^4.0.0",
-    "eslint-plugin-vue": "^8.0.3",
+    "eslint-plugin-vue": "^7.20.0",
     "sass": "~1.32.0",
     "sass-loader": "^10.0.0",
-    "vue-cli-plugin-vuetify": "^2.5.0",
+    "vue-cli-plugin-vuetify": "^2.5.8",
-    "vue-template-compiler": "^2.6.11",
+    "vue-template-compiler": "^2.7.16",
     "vuetify-loader": "^1.7.3"
   },
   "bugs": "https://github.com/kaythomas0/noisedash/issues",

server/app.js

@@ -36,7 +36,8 @@ app.use(session({
   store: new FileStore(fileStoreOptions),
   secret: sessionSecret,
   resave: true,
-  saveUninitialized: true
+  saveUninitialized: true,
+  cookie: { sameSite: 'strict' }
 }))
 app.use((req, res, next) => {
   const msgs = req.session.messages || []

src/components/NoisePage.vue

@@ -50,7 +50,7 @@
             label="Profiles"
             class="mx-3 mb-5"
             :disabled="playDisabled"
-            @change="loadProfile"
+            @change="loadProfile(true)"
           />
         </v-row>
 
@@ -297,7 +297,7 @@
               <v-card-text>
                 <v-container>
                   <v-row>
-                    <p>Select profile to record audio for. This is only supported on Chrome and Firefox.</p>
+                    <p>Select profile to record audio for. This is only supported on Chrome and Firefox. Current profile will be saved before recording.</p>
                   </v-row>
                   <v-row>
                     <v-select
@@ -788,7 +788,7 @@
                   value="continuous"
                 />
                 <v-radio
-                  label="Sporadic (Not Looped, Plays Randomly Within Interval"
+                  label="Sporadic (Not Looped, Plays Randomly Within Interval)"
                   value="sporadic"
                 />
               </v-radio-group>
@@ -1026,7 +1026,7 @@
                     <v-text-field
                       v-model="previewSampleFadeIn"
                       type="number"
-                      label="Fade In Time"
+                      label="Fade In Time (In continuous mode, this only effects first playback)"
                       :disabled="previewSamplePlaying"
                       :rules="[rules.gt(-1)]"
                       @change="updatePreviewSamplePlayerFadeIn"

src/components/noise.js

@@ -188,6 +188,18 @@ export default {
         this.lfo.connect(this.filter.frequency).start()
       }
 
+      if (this.isTimerEnabled) {
+        this.duration = parseInt((this.hours * 3600)) + parseInt((this.minutes * 60)) + parseInt(this.seconds)
+        this.timeRemaining = this.duration
+        this.transportInterval = setInterval(() => this.stop(), this.duration * 1000 + 100)
+        this.timeRemainingInterval = setInterval(() => this.startTimer(), 1000)
+        Tone.Transport.loopEnd = this.duration
+
+        this.noise.sync().start(0).stop(this.duration)
+      } else {
+        this.noise.sync().start(0)
+      }
+
       this.loadedSamples.forEach(s => {
         this.players.player(s.id).loop = true
         this.players.player(s.id).fadeIn = s.fadeIn
@@ -206,39 +218,27 @@ export default {
         } else {
           this.players.player(s.id).toDestination()
         }
-      })
 
-      if (this.isTimerEnabled) {
+        if (s.playbackMode === 'sporadic') {
-        this.duration = parseInt((this.hours * 3600)) + parseInt((this.minutes * 60)) + parseInt(this.seconds)
+          this.players.player(s.id).loop = false
-        this.noise.sync().start(0).stop(this.duration)
-        Tone.Transport.loopEnd = this.duration
-        this.timeRemaining = this.duration
-        this.transportInterval = setInterval(() => this.stop(), this.duration * 1000 + 100)
-        this.timeRemainingInterval = setInterval(() => this.startTimer(), 1000)
 
-        this.loadedSamples.forEach(s => {
+          const maxInt = parseInt(s.sporadicMax, 10)
-          this.players.player(s.id).unsync().sync().start(0).stop(this.duration)
+          const minInt = parseInt(s.sporadicMin, 10)
-        })
-      } else {
-        this.noise.sync().start(0)
 
-        this.loadedSamples.forEach(s => {
+          if (minInt <= maxInt) {
-          if (s.playbackMode === 'sporadic') {
+            const rand = Math.floor(Math.random() * (maxInt - minInt + 1) + minInt)
-            this.players.player(s.id).loop = false
+            s.initialSporadicPlayInterval = setInterval(() => this.playSporadicSample(s.id), rand * 1000)
+          }
+        } else {
+          this.players.player(s.id).loop = true
 
-            const maxInt = parseInt(s.sporadicMax, 10)
+          if (this.isTimerEnabled) {
-            const minInt = parseInt(s.sporadicMin, 10)
+            this.players.player(s.id).unsync().sync().start(0).stop(this.duration)
-
-            if (minInt <= maxInt) {
-              const rand = Math.floor(Math.random() * (maxInt - minInt + 1) + minInt)
-              s.initialSporadicPlayInterval = setInterval(() => this.playSporadicSample(s.id), rand * 1000)
-            }
           } else {
-            this.players.player(s.id).loop = true
             this.players.player(s.id).unsync().sync().start(0)
           }
-        })
+        }
-      }
+      })
 
       Tone.Transport.start('+0.1')
     },
@@ -344,7 +344,7 @@ export default {
               }
               this.exportedProfile = this.profileItems[0]
               this.recordedProfile = this.profileItems[0]
-              this.loadProfile()
+              this.loadProfile(true)
             }
           }
         })
@@ -420,8 +420,8 @@ export default {
           this.errorSnackbar = true
         })
     },
-    loadProfile () {
+    loadProfile (checkForUnsavedWork) {
-      if (this.unsavedWork) {
+      if (checkForUnsavedWork && this.unsavedWork) {
         this.confirmSwitchProfileDialog = true
       } else {
         this.$http.get('/profiles/'.concat(this.selectedProfile.id))
@@ -736,7 +736,16 @@ export default {
       }).then(response => {
         if (response.status === 200) {
           this.getSamples()
-          this.loadProfile()
+
+          //  Update sample if it's already loaded in current profile
+          const sample = this.loadedSamples.find(s => s.id === this.selectedPreviewSample.id)
+          if (sample) {
+            sample.fadeIn = this.previewSampleFadeIn
+            sample.loopPointsEnabled = this.previewSampleLoopPointsEnabled
+            sample.loopStart = this.previewSampleLoopStart
+            sample.loopEnd = this.previewSampleLoopEnd
+          }
+
           this.closeEditSampleForm()
           this.infoSnackbarText = 'Sample Saved'
           this.infoSnackbar = true
@@ -760,6 +769,9 @@ export default {
       this.profileMoreDialog = false
     },
     startRecording () {
+      // Save current profile before recording
+      this.updateProfile()
+
       this.$http.get('/profiles/'.concat(this.recordedProfile.id))
         .then(async response => {
           if (response.status === 200) {
@@ -866,7 +878,7 @@ export default {
       const recording = await this.recorder.stop()
 
       // Set active profile back to the selected one
-      this.loadProfile()
+      this.loadProfile(false)
 
       const url = URL.createObjectURL(recording)
       const anchor = document.createElement('a')
@@ -890,7 +902,7 @@ export default {
       await this.recorder.stop()
 
       // Set active profile back to the selected one
-      this.loadProfile()
+      this.loadProfile(false)
 
       clearInterval(this.recordingInterval)
       this.recordingDialog = false
@@ -898,7 +910,7 @@ export default {
     },
     discardChanges () {
       this.unsavedWork = false
-      this.loadProfile()
+      this.loadProfile(true)
       this.confirmSwitchProfileDialog = false
     },
     saveChanges () {