type safety! part 1

Author: ak--47

.prettierrc

@@ -1,9 +1,20 @@
 {
-  "tabWidth": 4,
-  "useTabs": false,
-  "printWidth": 150,
-  "arrowParens": "avoid",
-  "trailingComma": "none",
-  "embeddedLanguageFormatting": "off"
-
-}
+	"tabWidth": 4,
+	"useTabs": false,
+	"printWidth": 112,
+	"arrowParens": "avoid",
+	"trailingComma": "none",
+	"embeddedLanguageFormatting": "off",
+	"overrides": [
+		{
+			"files": [
+				"package-lock.json",
+				"package.json"
+			],
+			"options": {
+				"requirePragma": true,
+				"parser": "json"
+			}
+		}
+	]
+}

.vscode/launch.json

@@ -1,16 +1,39 @@
 {
 	"configurations": [
 		{
-			"command": "npm run test-watch",
+			"command": "npm run test-local-watch",
 			"name": "local tests",
 			"request": "launch",
 			"type": "node-terminal"
 		},
+		{
+			"command": "npm run build-types-watch",
+			"name": "build types",
+			"request": "launch",
+			"type": "node-terminal"
+		},
+		{
+			"command": "npm run push-watch",
+			"name": "auto push",
+			"request": "launch",
+			"type": "node-terminal"
+		}
 		{
 			"command": "npm run test-server",
 			"name": "server tests",
 			"request": "launch",
 			"type": "node-terminal"
 		}
+	],
+	"compounds": [
+		{
+			"name": "all watchers",
+			"configurations": [
+				"local tests",
+				"build types",
+				"auto push"
+			],
+			"stopAll": true
+		}
 	]
 }

.vscode/tasks.json

@@ -3,14 +3,14 @@
 	"tasks": [
 		{
 			"type": "npm",
-			"script": "debug",
+			"script": "debug-watch",
 			"problemMatcher": [],
 			"label": "REPL",
 			"detail": "runs one-off functions in GAS"
 		},
 		{
 			"type": "npm",
-			"script": "test-watch",
+			"script": "test-local-watch",
 			"problemMatcher": [],
 			"label": "LOCAL TEST",
 			"detail": "runs local tests"
@@ -28,6 +28,14 @@
 			"problemMatcher": [],
 			"label": "OPEN LOGGER",
 			"detail": "show GCP console"
+		},
+		{
+			"type": "npm",
+			"script": "push-watch",
+			"group": "build",
+			"problemMatcher": [],
+			"label": "npm: push-watch",
+			"detail": "clasp push --watch --force"
 		}
 	]
 }

Code.js

@@ -26,8 +26,7 @@ TODOs
 ----
 */
 
-// todo: ui for export
-// todo: hourly syncs, sync display, & sync logs
+// todo: syncs + sync logs
 // todo: docs
 
 /*
@@ -97,11 +96,16 @@ function SheetToMixpanelView() {
  *
  * @param  {SheetMpConfig} config if not supplied, last known will be used
  * @param {SheetInfo} sheetInfo the source sheet which contains the data
- * @returns {[ImportResponse[], Summary]}
+ * @returns {[ImportResponse[], ImportResults, string]}
  */
-function testSyncSheetsToMp(config = {}, sheetInfo = SpreadsheetApp.getActiveSheet()) {
+function testSyncSheetsToMp(config, sheetInfo = getSheetInfo(SpreadsheetApp.getActiveSheet())) {
     const testId = Math.random();
-    const t = tracker({ testId, record_type: config.record_type, project_id: config.project_id, view: "sheet → mixpanel" });
+    const t = tracker({
+        testId,
+        record_type: config?.record_type,
+        project_id: config?.project_id,
+        view: "sheet → mixpanel"
+    });
     try {
         const auth = validateCreds(config);
         config.auth = auth;
@@ -113,19 +117,24 @@ function testSyncSheetsToMp(config = {}, sheetInfo = SpreadsheetApp.getActiveShe
 
     t("test start"); //something happening here... what it is ain't exactly clear
     const [responses, summary] = importData(config, sheet);
-    const { total, success, failed, seconds } = summary.results;
+    const { total, success, failed, seconds } = summary;
     t("test end", { total, success, failed, seconds });
 
+    //store config for future syncs
+    setConfig({ ...config, ...sheetInfo });
+
     return [responses, summary, `https://mixpanel.com/project/${config.project_id}`];
 }
 
 /**
  * called when a user clicks the 'sync' button in the Sheet → Mixpanel UI
  *
  * @param  {SheetMpConfig} config
- * @returns  {[ImportResponse[], Summary] | SheetMpConfig}
+//  * @returns  {[ImportResponse[], ImportResults[], string]}
  */
-function syncSheetsToMp(config) {}
+function syncSheetsToMp(config) {
+    return;
+}
 
 /*
 ----------------
@@ -159,9 +168,9 @@ function MixpanelToSheetView() {
  *
  * @param  {MpSheetConfig} config if not supplied, last known will be used
  */
-function testSyncMpToSheets(config = {}) {
+function testSyncMpToSheets(config) {
     const testId = Math.random();
-    const t = tracker({ testId, record_type: config.record_type, project_id: config.project_id, view: "mixpanel → sheet" });
+    const t = tracker({ testId, project_id: config.project_id, view: "mixpanel → sheet" });
 
     try {
         const auth = validateCreds(config);
@@ -188,7 +197,7 @@ function testSyncMpToSheets(config = {}) {
         }
 
         const destSheet = createSheet(sheetName);
-        const updatedSheet = updateSheet(csvData, destSheet);
+        const updatedSheet = overwriteSheet(csvData, destSheet);
 
         t("test end");
 
@@ -219,3 +228,15 @@ REF DOCS
 // ? delete triggers: https://stackoverflow.com/a/47217237
 // ? tests: https://github.com/WildH0g/UnitTestingApp
 //? bundling npm modules: https://12ft.io/proxy?q=https%3A%2F%2Fmedium.com%2Fgeekculture%2Fthe-ultimate-guide-to-npm-modules-in-google-apps-script-a84545c3f57c
+
+if (typeof module !== "undefined") {
+    const { tracker } = require("./utilities/tracker.js");
+    const {
+        getSheetHeaders,
+        getSheetById,
+        getSheetInfo,
+        createSheet,
+        overwriteSheet
+    } = require("./utilities/sheet");
+    const { validateCreds } = require("./utilities/validate.js");
+}

components/dataExport.js

@@ -8,7 +8,7 @@ DATA OUT OF MP
  * export data; if not called with a config, uses last known
  *
  * @param  {MpSheetConfig} [config={}]
- * @returns {[string, ReportMeta | CohortMeta]} string + metadata `[csv, {}]`
+ * @returns {[string, ReportMeta & CohortMeta]} string + metadata `[csv, {}]`
  */
 function exportData(config = {}) {
     const startTime = Date.now();

components/dataImport.js

@@ -9,7 +9,7 @@ DATA INTO MP
  *
  * @param  {SheetMpConfig} [config={}]
  * @param {GoogleAppsScript.Spreadsheet.Sheet} sheet
- * @returns {[ImportResponse[], Summary]}
+ * @returns {[ImportResponse[], Results]}
  */
 function importData(config = {}, sheet) {
     const runId = Math.random();
@@ -28,23 +28,23 @@ function importData(config = {}, sheet) {
     const sourceData = getJSON(sheet);
 
     // console.log(`TRANSFORM: ${comma(sourceData.length)} ${config.record_type}s`);
-    const targetData = sourceData.slice().map((row) => transform(row, mappings, cleanConfig));
+    const targetData = sourceData.slice().map(row => transform(row, mappings, cleanConfig));
 
     // console.log(`FLUSH: ${comma(targetData.length)} ${config.record_type}s`);
     const imported = flushToMixpanel(targetData, cleanConfig);
     const endTime = Date.now();
-    const runTime = Math.floor(endTime - startTime) / 1000;
+
     // track('FLUSH', { runId, record_type });
 
     // console.log(`FINISHED: ${runTime} seconds`);
-    updateConfig(cleanConfig, imported, runTime, targetData);
+    const summary = summarizeImport(cleanConfig, imported, startTime, endTime, targetData);
 
     if (cleanConfig.results.errors.length > 0) {
         Logger.log("FAILED REQUESTS");
         Logger.log(cleanConfig.results.errors);
     }
 
-    return [imported, cleanConfig];
+    return [imported, summary];
 }
 
 /**
@@ -54,25 +54,15 @@ function importData(config = {}, sheet) {
  * @returns {EventMappings | UserMappings | GroupMappings | TableMappings}
  */
 function getMappings(config) {
-    const {
-        record_type,
-        event_name_col,
-        distinct_id_col,
-        time_col,
-        insert_id_col,
-        name_col,
-        email_col,
-        avatar_col,
-        created_col,
-        profile_operation,
-    } = config;
+    const { record_type, event_name_col, distinct_id_col, time_col, insert_id_col, name_col, email_col, avatar_col, created_col, profile_operation } =
+        config;
 
     if (record_type === "event") {
         return {
             distinct_id_col,
             event_name_col,
             time_col,
-            insert_id_col,
+            insert_id_col
         };
     }
 
@@ -83,7 +73,7 @@ function getMappings(config) {
             email_col,
             avatar_col,
             created_col,
-            profile_operation,
+            profile_operation
         };
     }
 
@@ -94,7 +84,7 @@ function getMappings(config) {
             email_col,
             avatar_col,
             created_col,
-            profile_operation,
+            profile_operation
         };
     }
 
@@ -125,8 +115,8 @@ function getMixpanelConfig(config) {
             failed: 0,
             batches: 0,
             seconds: 0,
-            errors: [],
-        },
+            errors: []
+        }
     };
 
     if (record_type === "group") mixpanel.batchSize = 200;
@@ -151,14 +141,19 @@ function getTransformType(config) {
 }
 
 /**
- * uses the responses to update the config; warning SIDE EFFECTS!!!
- * @param  {MpSheetConfig} config
+ * uses the responses to update the config
+ * @param  {MpSheetConfig} cleanConfig
  * @param  {Responses} responses
- * @param  {number} runTime
+ * @param  {number} startTime
+ * @param  {number} endTime 
  * @param  {mpEvent[] | mpUser[] | mpGroup[] | Object[]} targetData
+ * @returns {Results}
  */
-function updateConfig(config, responses, runTime, targetData) {
-    config.results.seconds = runTime;
+function summarizeImport(cleanConfig, responses, startTime, endTime, targetData) {
+    config = clone(cleanConfig);
+    config.results.startTime = startTime;
+    config.results.endTime = endTime;
+    config.results.seconds = Math.floor(endTime - startTime) / 1000;
     config.results.total = targetData.length;
     config.results.batches = responses.length;
 
@@ -186,4 +181,7 @@ function updateConfig(config, responses, runTime, targetData) {
         if (config.results.success > config.results.total) config.results.success = config.results.total;
         if (config.results.failed > config.results.total) config.results.failed = config.results.total;
     }
+
+    config.results.record_type = config.record_type;
+    return config.results;
 }

jsconfig.json

@@ -1,8 +1,16 @@
 {
 	"compilerOptions": {
 		"module": "None",
-		"checkJs": false,
-		"typeRoots" : ["./node_modules/@types", "./types"]
+		"checkJs": true,
+		"typeRoots": [
+			"./node_modules/@types",
+			"./types"
+		]
 	},
-	"exclude": ["node_modules"]
+	"exclude": [
+		"node_modules"
+	],
+	"typeAcquisition": {
+		"enable": false
+	}
 }

models/modelEvents.js

@@ -57,3 +57,8 @@ function modelMpEvents(row, mappings) {
 
     return mpEvent;
 }
+
+if (typeof module !== "undefined") {
+    const { MD5 } = require("../utilities/md5.js");
+    module.exports = { modelMpEvents };
+}