Project Tags:
@@ -134,10 +145,10 @@ function updateProjectButton(selectedOption: string) {
if (selectedOption == 'update') {
const projectData = {
project: {
- name: promptStore.getProjectName,
- tag_list: promptStore.getProjectTags, // assuming getProjectTags returns a comma separated string
- project_access_type: promptStore.getProjectType,
- description: promptStore.getProjectDescription,
+ name: promptStore.getProjectName, // returns string (project name)
+ tag_list: promptStore.getProjectTags, // getProjectTags must return a comma separated string (in case of multiple tags)
+ project_access_type: promptStore.getProjectType, // returns string (Public, Private, Limited access)
+ description: promptStore.getProjectDescription, // returns html text
},
}
diff --git a/src/simulator/src/data/project.js b/src/simulator/src/data/project.js
index e5ca610f..37d5b346 100644
--- a/src/simulator/src/data/project.js
+++ b/src/simulator/src/data/project.js
@@ -9,10 +9,7 @@ import { checkIfBackup } from './backupCircuit'
import { generateSaveData, getProjectName, setProjectName } from './save'
import load from './load'
import { SimulatorStore } from '#/store/SimulatorStore/SimulatorStore'
-import {
- confirmOption,
- confirmSingleOption,
-} from '#/components/helpers/confirmComponent/ConfirmComponent.vue'
+import { confirmOption } from '#/components/helpers/confirmComponent/ConfirmComponent.vue'
/**
* Helper function to recover unsaved data
From e468b1598e6a78fd4aea53dbad2de6c892ca3159 Mon Sep 17 00:00:00 2001
From: Arnabdaz <96580571+Arnabdaz@users.noreply.github.com>
Date: Tue, 27 Jun 2023 22:16:10 +0530
Subject: [PATCH 14/22] feat(gsoc): update setup fucntion and fix linting
issues, remove setTimeout of 1 second for testing
Signed-off-by: Arnabdaz <96580571+Arnabdaz@users.noreply.github.com>
---
src/pages/simulatorHandler.vue | 2 +
src/simulator/src/setup.js | 89 +++++++++++++++++++---------------
2 files changed, 51 insertions(+), 40 deletions(-)
diff --git a/src/pages/simulatorHandler.vue b/src/pages/simulatorHandler.vue
index d2e16699..8103d83a 100644
--- a/src/pages/simulatorHandler.vue
+++ b/src/pages/simulatorHandler.vue
@@ -69,6 +69,8 @@ async function getLoginData() {
const data = await response.json()
authStore.setUserInfo(data.data)
;(window as any).isUserLoggedIn = true
+ } else if (response.status === 401) {
+ ;(window as any).isUserLoggedIn = false
}
} catch (err) {
console.error(err)
diff --git a/src/simulator/src/setup.js b/src/simulator/src/setup.js
index 65e774c1..e35109e4 100644
--- a/src/simulator/src/setup.js
+++ b/src/simulator/src/setup.js
@@ -90,7 +90,7 @@ function setupEnvironment() {
const projectId = generateId()
window.projectId = projectId
updateSimulationSet(true)
- const DPR = window.devicePixelRatio || 1
+ // const DPR = window.devicePixelRatio || 1 // unused variable
newCircuit('Main')
window.data = {}
resetup()
@@ -121,6 +121,11 @@ function setupElementLists() {
window.renderOrder = [...moduleList.slice().reverse(), 'wires', 'allNodes'] // Order of render
}
+/**
+ * Fetches project data from API and loads it into the simulator.
+ * @param {number} projectId The ID of the project to fetch data for
+ * @category setup
+ */
async function fetchProjectData(projectId) {
try {
const response = await fetch(`/api/v1/simulator/${projectId}/data`, {
@@ -139,18 +144,56 @@ async function fetchProjectData(projectId) {
}
} catch (error) {
console.error(error)
- // alert('Error: Could not load.')
confirmSingleOption('Error: Could not load.')
$('.loadingIcon').fadeOut()
}
}
/**
- * The first function to be called to setup the whole simulator
+ * Load project data immediately when available.
+ * Improvement to eliminate delay caused by setTimeout in previous implementation revert if issues arise.
+ * @category setup
+ */
+async function loadProjectData() {
+ window.logixProjectId = window.logixProjectId ?? 0
+ if (window.logixProjectId !== 0) {
+ $('.loadingIcon').fadeIn()
+ await fetchProjectData(window.logixProjectId)
+ } else if (localStorage.getItem('recover_login') && window.isUserLoggedIn) {
+ // Restore unsaved data and save
+ var data = JSON.parse(localStorage.getItem('recover_login'))
+ await load(data)
+ localStorage.removeItem('recover')
+ localStorage.removeItem('recover_login')
+ await save()
+ } else if (localStorage.getItem('recover')) {
+ // Restore unsaved data which didn't get saved due to error
+ showMessage(
+ "We have detected that you did not save your last work. Don't worry we have recovered them. Access them using Project->Recover"
+ )
+ }
+}
+
+/**
+ * Show tour guide if it hasn't been completed yet.
+ * The tour is shown after a delay of 2 seconds.
+ * @category setup
+ */
+function showTour() {
+ if (!localStorage.tutorials_tour_done && !embed) {
+ setTimeout(() => {
+ showTourGuide()
+ }, 2000)
+ }
+}
+
+/**
+ * The first function to be called to setup the whole simulator.
+ * This function sets up the simulator environment, the UI, the listeners,
+ * loads the project data, and shows the tour guide.
* @category setup
*/
export function setup() {
- // console.log('hello from set up')
let embed = false
const startListeners = embed ? startEmbedListeners : startMainListeners
setupElementLists()
@@ -158,41 +201,7 @@ export function setup() {
if (!embed) {
setupUI()
}
- // console.log('start_lis')
startListeners()
- // if (!embed) {
- // keyBinder()
- // }
-
- // Load project data after 1 second - needs to be improved, delay needs to be eliminated
- setTimeout(() => {
- // let __logix_project_id
- if (!window.logixProjectId) {
- // __logix_project_id = window.logixProjectId
- window.logixProjectId = 0
- }
- // else { __logix_project_id = 0 }
- if (logixProjectId != 0) {
- $('.loadingIcon').fadeIn()
- fetchProjectData(logixProjectId)
- } else if (localStorage.getItem('recover_login') && isUserLoggedIn) {
- // Restore unsaved data and save
- var data = JSON.parse(localStorage.getItem('recover_login'))
- load(data)
- localStorage.removeItem('recover')
- localStorage.removeItem('recover_login')
- save()
- } else if (localStorage.getItem('recover')) {
- // Restore unsaved data which didn't get saved due to error
- showMessage(
- "We have detected that you did not save your last work. Don't worry we have recovered them. Access them using Project->Recover"
- )
- }
- }, 1000)
-
- if (!localStorage.tutorials_tour_done && !embed) {
- setTimeout(() => {
- showTourGuide()
- }, 2000)
- }
+ loadProjectData()
+ showTour()
}
From dea9ee2497afb9df6822e9ad941e1a7c6674e921 Mon Sep 17 00:00:00 2001
From: Arnabdaz <96580571+Arnabdaz@users.noreply.github.com>
Date: Tue, 27 Jun 2023 22:18:54 +0530
Subject: [PATCH 15/22] fix(gsoc): recover project not saving to localStorage
due to generateSaveData being async function
Signed-off-by: Arnabdaz <96580571+Arnabdaz@users.noreply.github.com>
---
src/simulator/src/data/project.js | 6 +++---
1 file changed, 3 insertions(+), 3 deletions(-)
diff --git a/src/simulator/src/data/project.js b/src/simulator/src/data/project.js
index 37d5b346..5a88fdd5 100644
--- a/src/simulator/src/data/project.js
+++ b/src/simulator/src/data/project.js
@@ -119,7 +119,7 @@ function checkToSave() {
* Prompt user to save data if unsaved
* @category data
*/
-window.onbeforeunload = function () {
+window.onbeforeunload = async function () {
if (projectSaved || embed) return
if (!checkToSave()) return
@@ -130,8 +130,8 @@ window.onbeforeunload = function () {
// await confirmSingleOption(
// 'You have unsaved changes on this page. Do you want to leave this page and discard your changes or stay on this page?'
// )
- const data = generateSaveData('Untitled')
- localStorage.setItem('recover', data)
+ const data = await generateSaveData('Untitled')
+ localStorage.setItem('recover', await data)
// eslint-disable-next-line consistent-return
return 'Are u sure u want to leave? Any unsaved changes may not be recoverable'
}
From 6047127a647e25f00d8128a2b2219ef831caf99d Mon Sep 17 00:00:00 2001
From: Arnabdaz <96580571+Arnabdaz@users.noreply.github.com>
Date: Tue, 27 Jun 2023 22:27:51 +0530
Subject: [PATCH 16/22] fix(lint): fix linting issues in save.js & remove var
from setup.js for const
Signed-off-by: Arnabdaz <96580571+Arnabdaz@users.noreply.github.com>
---
src/simulator/src/data/save.js | 4 ++--
src/simulator/src/setup.js | 2 +-
2 files changed, 3 insertions(+), 3 deletions(-)
diff --git a/src/simulator/src/data/save.js b/src/simulator/src/data/save.js
index 388cb209..eabd4d70 100644
--- a/src/simulator/src/data/save.js
+++ b/src/simulator/src/data/save.js
@@ -374,7 +374,7 @@ export default async function save() {
window.location.href = '/users/sign_in'
else $('.loadingIcon').fadeOut()
// eslint-disable-next-line camelcase
- } else if (logixProjectId == '0') {
+ } else if (window.logixProjectId === 0) {
// Create new project - this part needs to be improved and optimised
// const form = $('
', {
// action: '/api/v1/simulator/create',
@@ -486,7 +486,7 @@ export default async function save() {
},
body: JSON.stringify({
data,
- id: logixProjectId,
+ id: window.logixProjectId,
image: imageData,
name: projectName,
}),
diff --git a/src/simulator/src/setup.js b/src/simulator/src/setup.js
index e35109e4..4cf69efd 100644
--- a/src/simulator/src/setup.js
+++ b/src/simulator/src/setup.js
@@ -161,7 +161,7 @@ async function loadProjectData() {
await fetchProjectData(window.logixProjectId)
} else if (localStorage.getItem('recover_login') && window.isUserLoggedIn) {
// Restore unsaved data and save
- var data = JSON.parse(localStorage.getItem('recover_login'))
+ const data = JSON.parse(localStorage.getItem('recover_login'))
await load(data)
localStorage.removeItem('recover')
localStorage.removeItem('recover_login')
From df9a0bfc0a31720b1d0163bb50cb0cc853bdd471 Mon Sep 17 00:00:00 2001
From: Arnabdaz <96580571+Arnabdaz@users.noreply.github.com>
Date: Wed, 28 Jun 2023 00:38:49 +0530
Subject: [PATCH 17/22] feat(jwt): add jwt in Authorization header
Signed-off-by: Arnabdaz <96580571+Arnabdaz@users.noreply.github.com>
---
.../helpers/createNewProject/UpdateProjectDetail.vue | 3 ++-
src/pages/simulatorHandler.vue | 9 +++++++++
src/simulator/src/data/save.js | 8 +++++---
src/simulator/src/setup.js | 2 ++
4 files changed, 18 insertions(+), 4 deletions(-)
diff --git a/src/components/helpers/createNewProject/UpdateProjectDetail.vue b/src/components/helpers/createNewProject/UpdateProjectDetail.vue
index 90591b50..94327f0b 100644
--- a/src/components/helpers/createNewProject/UpdateProjectDetail.vue
+++ b/src/components/helpers/createNewProject/UpdateProjectDetail.vue
@@ -91,6 +91,7 @@ import {
confirmMultiOption,
confirmSingleOption,
} from '../confirmComponent/ConfirmComponent.vue'
+import { getToken } from '#/pages/simulatorHandler.vue'
interface dataType {
project: {
@@ -159,7 +160,7 @@ function updateProjectButton(selectedOption: string) {
headers: {
'Content-Type': 'application/json',
Accept: 'application/json',
- Authorization: `Token`,
+ Authorization: `Token ${getToken('cvt')}`,
},
body: projectJson,
})
diff --git a/src/pages/simulatorHandler.vue b/src/pages/simulatorHandler.vue
index 8103d83a..561be14f 100644
--- a/src/pages/simulatorHandler.vue
+++ b/src/pages/simulatorHandler.vue
@@ -10,6 +10,13 @@
+
+