Merge pull request #16 from brown-ccv/develop

Develop

.github/workflows/build_at_home.yaml

@@ -5,6 +5,7 @@ on:
     paths:
       - 'src/**'
       - '.github/workflows/main.yml'
+      - 'public/**'
 
 jobs:
   build:
@@ -26,12 +27,11 @@ jobs:
     # install, test, build package
     - name: npm install
       run: npm install
+    - name: get git revision and branch
+      run: node version.js
     - name: npm build
       run: npm run build:win:home
-    - name: npm test
-      run: npm test
       env:
-        CI: true
         REACT_APP_AT_HOME: true
 
     # Build electron app package installers

.github/workflows/main.yml

@@ -5,6 +5,7 @@ on:
     paths:
       - 'src/**'
       - '.github/workflows/main.yml'
+      - 'public/**'
 
 jobs:
   build:
@@ -32,10 +33,7 @@ jobs:
       run: npm install
     - name: npm build
       run: npm run build
-    - name: npm test
-      run: npm test
-      env:
-        CI: true
+
 
     # Build electron app package installers
     - name: package electron - windows

.gitignore

@@ -21,3 +21,5 @@ yarn-debug.log*
 yarn-error.log*
 
 psiturkit/*_turk
+
+public/config/version.json

README.md

@@ -64,7 +64,7 @@ This file contains all of the code relating to the electron app. This includes t
 
 The `config` directory contains the config files needed for the electron app.  This includes the event-marker details and event codes.
 
-Note: the productId can be overwritten by the environment variable EVENT_MARKER_PRODUCT_ID
+Note: the `comName` can be overwritten by the environment variable COMNAME.
 
 ### `src/`
 

package.json

@@ -6,7 +6,7 @@
     "email": "[email protected]",
     "url": "ccv.brown.edu"
   },
-  "version": "1.1.0",
+  "version": "1.2.1",
   "license": "MIT",
   "private": true,
   "main": "public/electron.js",
@@ -18,7 +18,8 @@
     "cross-env": "^6.0.3",
     "electron-log": "^3.0.9",
     "electron-squirrel-startup": "^1.0.0",
-    "event-marker": "git+https://github.com/brown-ccv/event-marker.git#bump-version",
+    "event-marker": "git+https://github.com/brown-ccv/event-marker.git",
+    "execa": "^4.0.3",
     "fs-extra": "^9.0.0",
     "jquery": "^3.4.1",
     "jspsych-react": "^0.2.2",
@@ -80,7 +81,8 @@
     "eslint-plugin-promise": "^4.2.1",
     "eslint-plugin-react": "^7.14.3",
     "eslint-plugin-standard": "^4.0.1",
-    "require-context.macro": "^1.1.1"
+    "require-context.macro": "^1.1.1",
+    "semantic-release": "^17.1.1"
   },
   "babel": {
     "plugin": [

public/config/trigger.js

@@ -1,7 +1,5 @@
 // Event trigger settings - used in both the react app (renderer) and the electron app (main)
-const manufacturer = 'Teensyduino'
-const vendorId = '16c0'
-const productId = '0487'
+const comName = 'COM3'
 
 // Values to send to the 'USB event marker' arduino when an event happens.
 // Make sure the 'open_resting_task' value doesn't conflict with any value sent
@@ -33,8 +31,6 @@ const eventCodes = {
 
 // this is module.exports isntead of just exports as it is also imported into the electron app
 module.exports = {
-	manufacturer,
-	vendorId,
-	productId,
+	comName,
 	eventCodes
 }

public/electron.js

@@ -12,13 +12,13 @@ const log = require('electron-log');
 
 const AT_HOME = (process.env.REACT_APP_AT_HOME === 'true')
 // Event Trigger
-const { eventCodes, manufacturer, vendorId, productId } = require('./config/trigger')
+const { eventCodes, comName } = require('./config/trigger')
 
-// Override product ID if environment variable set
-const activeProductId = process.env.EVENT_MARKER_PRODUCT_ID || productId
-log.info("Active product ID", activeProductId)
+// Override comName if environment variable set
+const activeComName = process.env.COMNAME || comName
+log.info("Active comName", activeComName)
 
-const { isPort, getPort, sendToPort } = require('event-marker')
+const { getPort, sendToPort } = require('event-marker')
 log.info(AT_HOME)
 
 // Data Saving
@@ -83,7 +83,7 @@ let portAvailable
 let SKIP_SENDING_DEV = false
 
 const setUpPort = async () => {
-  p = await getPort(vendorId, activeProductId)
+  p = await getPort(activeComName)
   if (p) {
     triggerPort = p
     portAvailable = true
@@ -150,6 +150,9 @@ ipc.on('trigger', (event, args) => {
   }
 })
 
+// Read version file (git sha and branch)
+var git = JSON.parse(fs.readFileSync(path.resolve(__dirname, 'config/version.json')));
+
 // INCREMENTAL FILE SAVING
 let stream = false
 let fileName = ''
@@ -181,7 +184,7 @@ ipc.on('data', (event, args) => {
     }
 
     //write the data
-    stream.write(JSON.stringify(args))
+    stream.write(JSON.stringify({...args, git}))
 
     // Copy provocation images to patient's data folder
     if (args.trial_type === 'image_keyboard_response') images.push(args.stimulus.slice(7))

version.js

@@ -0,0 +1,26 @@
+// Get Git Commit SHA and Branch
+
+const fs = require('fs-extra')
+const execa = require('execa');
+
+let git;
+
+if (process.env.CI) {
+    const sha = process.env.GITHUB_SHA
+    const ref = process.env.GITHUB_REF
+    git = {sha, ref}
+}
+else {
+    const sha = execa.commandSync('git rev-parse HEAD').stdout
+    const ref = execa.commandSync('git branch --show-current').stdout  
+    git = {sha, ref}
+}
+
+
+fs.writeFile('public/config/version.json', JSON.stringify(git))
+  .then(() => {
+      console.log(`Saved version file with rev: ${git.sha}, branch: ${git.ref}`);
+  })
+  .catch((err) => {
+      console.log(err);
+  });