Added some comments to the code #11

BenM-BenM · 2024-01-09T14:20:38Z

No description provided.

gabydd

Left a bunch of longer explanation comments which are hopefully helpful

gabydd · 2024-01-09T14:43:11Z

src/lib/sheet.ts

@@ -1,3 +1,5 @@
+//The name and code suggests this file does the spreadsheet/server stuff


Yeah this file has the function get to fetch the data from the spreadsheet and get it in the correct shape for using in the site, and then also append which turns the response queue into what the server wants. The server is in server/server.js I think and on get requests grabs match data from the sheet as well as the form schema. On post requests it appends each row of data (comes in a list of lists) after the last row of data in a sheet that we specify

gabydd · 2024-01-09T14:48:10Z

src/lib/store.ts

@@ -3,24 +3,44 @@ import type { Form, Response, Team, Match, Field } from "$lib/types";
 import { persisted } from "svelte-local-storage-store";
 import { extractGroups } from "./serialize";

+//Details of which type of form is being used ???


Yeah this is the full schema of the form (the types here are quite helpful for seeing how the schema is specified, the rendering is quite simple we just render whatever the schema tells us) and it is set when we make the get request to the server

gabydd · 2024-01-09T14:50:27Z

src/lib/store.ts

 export const scout = persisted<string>("scout", "");
 export const teams = persisted<Record<number, Team>>("teams", {});
 export const matches = persisted<Record<number, Match>>("matches", {});


These are for autocomplete when adding a new response, scout saves the name so you don't have to type it in again, and teams and matches is used to have a dropdown for them

gabydd · 2024-01-09T14:56:00Z

src/lib/store.ts

+//QR code stuff, worry about it later
 export const code = persisted<number | null>("code", null);


Same with response this is the id of the QR code we are displaying to be scanned, QR code stuff hopefully shouldn't need any changing

gabydd · 2024-01-09T14:58:41Z

src/lib/store.ts

 export const code = persisted<number | null>("code", null);
+
+//list of responses which are "active" eg. can be edited (not yet submitted)


Important part is that this is also structured as a map from the response id to the response, which is useful because we use the id in a bunch of places to refer to the response we are using

gabydd · 2024-01-09T15:03:35Z

src/lib/store.ts

 export const activeResponses = persisted<Record<number, Response>>(
  "activeResponses",
  {}
 );
+
+//something to do with grid, shouldn't be necessary this year


Yeah so the grid won't be necessary but if there is a need for a form field that needs multiple data points then let me know because that is why the grid is much more complicated and needs special handling

gabydd · 2024-01-09T15:06:50Z

src/lib/store.ts

+//these two look like more QR code stuff
 export const keys = persisted<string[]>("keys", []);


Keys is the correct order of the keys for when we need to format the data for appending, you can see how it is populated in setForm(which is called from get to set the form schema) and used in append in sheet.ts

gabydd · 2024-01-09T15:08:20Z

src/lib/store.ts

 export const fields = persisted<Record<number, Record<string, Field>>>(
  "fields",
  {}
 );
+
+//these two look like more QR code stuff
 export const keys = persisted<string[]>("keys", []);
 export const scans = persisted<number[]>("scans", []);


Yeah this is just a list of the ids of responses we have already scanned so we don't double scan anything and send it twice to the sheet

gabydd · 2024-01-09T15:11:18Z

src/lib/store.ts

 export const theme = persisted("theme", "arctos");
+
+//looks like a list of IDs and boolean values for whether or not those forms have errors?


Yeah if a form has any errors then we want to be able to disable the submit button in the home page, key thing here is we initially set the error to true when we create a new response because fields won't populate with default values till the form is actually opened

gabydd · 2024-01-09T15:16:38Z

src/lib/store.ts

 export const responseQueue = persisted<Response[]>("responseQueue", []);
 export const lastGet = persisted("lastGet", 0);
+
+//check is device connected to internet (writable only works online)


Looks like I don't actually use this at all, but both get and append in sheet.ts instead of causing an error when offline will just return false, which for append is important cause only if it returns true do we know it's safe to remove the submitted responses from the response queue

gabydd · 2024-01-09T16:08:47Z

package.json

@@ -14,7 +14,7 @@
  "devDependencies": {
    "@neodrag/svelte": "^2.0.3",
    "@sveltejs/adapter-static": "^1.0.1",
-    "@sveltejs/kit": "1.3.0",
+    "@sveltejs/kit": "^1.11.0",


If you update sveltekit then you will probably need to update vitepwa/sveltekit as well, does it still build properly with this change?

It still builds properly. I think I have a whole bunch of stuff thats been updated since polaris was made in this commit, but it doesn't seem to have any impact.

ah no worries if something breaks I can push a hotfix for it

gabydd

Added some clarification message me on discord if you have any more questions

gabydd · 2024-02-14T23:59:57Z

src/lib/store.ts

 export const fields = persisted<Record<number, Record<string, Field>>>(
  "fields",
  {}
 );
+
+//This is used for formatting responses before they are sent to the server (not quite sure how though)


This is the order of the keys because JavaScript objects aren't ordered when we take the data from it we want them to be in the correct order for the server

gabydd · 2024-02-15T00:04:07Z

src/lib/sheet.ts

@@ -201,5 +207,6 @@ const setMatches = (match_array: number[][]) => {
  matches.set(match_obj);
 };

+//Im not really sure what this does but it is necessary for setform


This is a matrix transpose the data is in a 2d array but the columns and rows are incorrect for what we want to do because Google sheets gives us an array of columns but we want an array of rows I think that's what it is atleast haven't touched this code in a while

BenM-BenM added 3 commits March 20, 2023 09:50

af8df5a

added some comments

4242b8b

Merge branch 'main' of https://github.com/Arctos6135/polaris

0b8ef1b

gabydd reviewed Jan 9, 2024

View reviewed changes

Added some comments

753e834

gabydd reviewed Feb 15, 2024

View reviewed changes

BenM-BenM added 2 commits March 3, 2024 17:05

Code should work now?

2145d54

slightly sketchy fix to finding teams

3997fc1

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Added some comments to the code #11

Added some comments to the code #11

BenM-BenM commented Jan 9, 2024

gabydd left a comment

gabydd Jan 9, 2024

gabydd Jan 9, 2024

gabydd Jan 9, 2024

gabydd Jan 9, 2024

gabydd Jan 9, 2024

gabydd Jan 9, 2024

gabydd Jan 9, 2024

gabydd Jan 9, 2024

gabydd Jan 9, 2024

gabydd Jan 9, 2024

gabydd Jan 9, 2024

BenM-BenM Jan 11, 2024

gabydd Jan 11, 2024

gabydd left a comment

gabydd Feb 14, 2024

gabydd Feb 15, 2024

		@@ -1,3 +1,5 @@
		//The name and code suggests this file does the spreadsheet/server stuff

		//QR code stuff, worry about it later
		export const code = persisted<number \| null>("code", null);

		export const code = persisted<number \| null>("code", null);

		//list of responses which are "active" eg. can be edited (not yet submitted)

		//these two look like more QR code stuff
		export const keys = persisted<string[]>("keys", []);

		export const theme = persisted("theme", "arctos");

		//looks like a list of IDs and boolean values for whether or not those forms have errors?

Added some comments to the code #11

Are you sure you want to change the base?

Added some comments to the code #11

Conversation

BenM-BenM commented Jan 9, 2024

gabydd left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

gabydd left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment