Merge branch 'main' of github.com:wpilibsuite/systemcore-blocks-interface into pr_myArray

lizlooney · lizlooney · commit d2e8150e4d2c · 2025-08-29T19:33:05.000-07:00
diff --git a/src/blocks/mrc_call_python_function.ts b/src/blocks/mrc_call_python_function.ts
@@ -150,11 +150,6 @@ type CallPythonFunctionExtraState = {
    * The mechanism class name. Specified only if the function kind is INSTANCE_MECHANISM.
    */
   mechanismClassName?: string,
-
-  // The following fields allow Alan and Liz to load older projects.
-  // TODO(lizlooney): Remove these fields.
-  otherBlockId?: string,
-  mechanismBlockId?: string,
 }
 
 const CALL_PYTHON_FUNCTION = {
@@ -303,7 +298,6 @@ const CALL_PYTHON_FUNCTION = {
       this: CallPythonFunctionBlock,
       extraState: CallPythonFunctionExtraState
   ): void {
-    fixOldExtraState(extraState);
     this.mrcFunctionKind = extraState.functionKind as FunctionKind;
     this.mrcReturnType = extraState.returnType;
     this.mrcArgs = [];
@@ -1276,26 +1270,3 @@ function createFireEventBlock(event: storageModuleContent.Event): toolboxItems.B
   processArgs(args, extraState, inputs);
   return createBlock(extraState, fields, inputs);
 }
-
-// The following function allows Alan and Liz to load older projects.
-// TODO(lizlooney): Remove this function.
-function fixOldExtraState(extraState: CallPythonFunctionExtraState): void {
-  if (extraState.otherBlockId) {
-    switch (extraState.functionKind as FunctionKind) {
-      case FunctionKind.INSTANCE_WITHIN:
-      case FunctionKind.INSTANCE_ROBOT:
-      case FunctionKind.INSTANCE_MECHANISM:
-        extraState.methodId = extraState.otherBlockId;
-        break;
-      case FunctionKind.INSTANCE_COMPONENT:
-        extraState.componentId = extraState.otherBlockId;
-        break;
-      case FunctionKind.EVENT:
-        extraState.eventId = extraState.otherBlockId;
-        break;
-    }
-  }
-  if (extraState.mechanismBlockId) {
-    extraState.mechanismId = extraState.mechanismBlockId;
-  }
-}
diff --git a/src/blocks/mrc_event_handler.ts b/src/blocks/mrc_event_handler.ts
@@ -73,11 +73,6 @@ export interface EventHandlerExtraState {
    * Specified only if the sender type is MECHANISM.
    */
   mechanismId?: string,
-
-  // The following fields allow Alan and Liz to load older projects.
-  // TODO(lizlooney): Remove these fields.
-  otherBlockId?: string,
-  mechanismBlockId?: string,
 }
 
 const EVENT_HANDLER = {
@@ -126,7 +121,6 @@ const EVENT_HANDLER = {
    * Applies the given state to this block.
    */
   loadExtraState(this: EventHandlerBlock, extraState: EventHandlerExtraState): void {
-    fixOldExtraState(extraState);
     this.mrcSenderType = extraState.senderType;
     this.mrcParameters = [];
     this.mrcEventId = extraState.eventId;
@@ -508,14 +502,3 @@ export function renameMechanismName(workspace: Blockly.Workspace, mechanismId: s
     (block as EventHandlerBlock).renameMechanismName(mechanismId, newName);
   });
 }
-
-// The following function allows Alan and Liz to load older projects.
-// TODO(lizlooney): Remove this function.
-function fixOldExtraState(extraState: EventHandlerExtraState): void {
-  if (extraState.otherBlockId) {
-    extraState.eventId = extraState.otherBlockId;
-  }
-  if (extraState.mechanismBlockId) {
-    extraState.mechanismId = extraState.mechanismBlockId;
-  }
-}
diff --git a/src/blocks/mrc_get_python_variable.ts b/src/blocks/mrc_get_python_variable.ts
@@ -40,7 +40,7 @@ import * as toolboxItems from '../toolbox/items';
 
 export const BLOCK_NAME = 'mrc_get_python_variable';
 
-enum VariableKind {
+export enum VariableKind {
   MODULE = 'module',
   CLASS = 'class',
   INSTANCE = 'instance',
diff --git a/src/blocks/mrc_list_add_item.ts b/src/blocks/mrc_list_add_item.ts
@@ -16,7 +16,7 @@
  */
 
 /**
- * @fileoverview Miscellaneous blocks.
+ * @fileoverview Block to add an item to the end of a list.
  * @author lizlooney@google.com (Liz Looney)
  */
 
diff --git a/src/blocks/mrc_math_min_max.ts b/src/blocks/mrc_math_min_max.ts
@@ -16,7 +16,7 @@
  */
 
 /**
- * @fileoverview Miscellaneous blocks.
+ * @fileoverview Blocks for math min and max.
  * @author lizlooney@google.com (Liz Looney)
  */
 
diff --git a/src/blocks/mrc_misc_comment.ts b/src/blocks/mrc_misc_comment.ts
@@ -16,7 +16,7 @@
  */
 
 /**
- * @fileoverview Miscellaneous blocks.
+ * @fileoverview Block for a comment.
  * @author lizlooney@google.com (Liz Looney)
  */
 
diff --git a/src/blocks/mrc_misc_evaluate_but_ignore_result.ts b/src/blocks/mrc_misc_evaluate_but_ignore_result.ts
@@ -16,7 +16,7 @@
  */
 
 /**
- * @fileoverview Miscellaneous blocks.
+ * @fileoverview Blocks for evaluating something, but ignoring the result.
  * @author lizlooney@google.com (Liz Looney)
  */
 
diff --git a/src/blocks/mrc_set_python_variable.ts b/src/blocks/mrc_set_python_variable.ts
@@ -23,6 +23,7 @@
 import * as Blockly from 'blockly';
 import { Order } from 'blockly/python';
 
+import { VariableKind } from './mrc_get_python_variable';
 import { getAllowedTypesForSetCheck } from './utils/python';
 import * as variable from './utils/variable';
 import { ExtendedPythonGenerator } from '../editor/extended_python_generator';
@@ -36,14 +37,6 @@ import * as toolboxItems from '../toolbox/items';
 
 export const BLOCK_NAME = 'mrc_set_python_variable';
 
-// TODO(lizlooney): Consider combining VariableKind here with VariableKind in
-// mrc_get_python_variable.ts. They are identical.
-enum VariableKind {
-  MODULE = 'module',
-  CLASS = 'class',
-  INSTANCE = 'instance',
-}
-
 const FIELD_MODULE_OR_CLASS_NAME = 'MODULE_OR_CLASS';
 const FIELD_VARIABLE_NAME = 'VAR';
 
diff --git a/src/blocks/tokens.ts b/src/blocks/tokens.ts
@@ -41,7 +41,7 @@ export function customTokens(t: (key: string) => string): typeof Blockly.Msg {
     EVENTS: t('BLOCKLY.EVENTS'),
     EVALUATE_BUT_IGNORE_RESULT: t('BLOCKLY.EVALUATE_BUT_IGNORE_RESULT'),
     EVALUATE_BUT_IGNORE_RESULT_TOOLTIP:
-      t('BLOCKLY.EVALUATE_BUT_IGNORE_RESULT_TOOLTIP'),
+      t('BLOCKLY.TOOLTIP.EVALUATE_BUT_IGNORE_RESULT'),
     AUTO: t('BLOCKLY.AUTO'),
     TELEOP: t('BLOCKLY.TELEOP'),
     TEST: t('BLOCKLY.TEST'),
@@ -50,10 +50,10 @@ export function customTokens(t: (key: string) => string): typeof Blockly.Msg {
     DISPLAY_NAME: t('BLOCKLY.DISPLAY_NAME'),
     DISPLAY_GROUP: t('BLOCKLY.DISPLAY_GROUP'),
     NO_MECHANISM_CONTENTS: t('BLOCKLY.NO_MECHANISM_CONTENTS'),
-    OPMODE_TYPE_TOOLTIP: t('BLOCKLY.TOOLTIP.OPMODE_TYPE_TOOLTIP'),
-    OPMODE_ENABLED_TOOLTIP: t('BLOCKLY.TOOLTIP.OPMODE_ENABLED_TOOLTIP'),
-    OPMODE_NAME_TOOLTIP: t('BLOCKLY.TOOLTIP.OPMODE_NAME_TOOLTIP'),
-    OPMODE_GROUP_TOOLTIP: t('BLOCKLY.TOOLTIP.OPMODE_GROUP_TOOLTIP'),
+    OPMODE_TYPE_TOOLTIP: t('BLOCKLY.TOOLTIP.OPMODE_TYPE'),
+    OPMODE_ENABLED_TOOLTIP: t('BLOCKLY.TOOLTIP.OPMODE_ENABLED'),
+    OPMODE_NAME_TOOLTIP: t('BLOCKLY.TOOLTIP.OPMODE_NAME'),
+    OPMODE_GROUP_TOOLTIP: t('BLOCKLY.TOOLTIP.OPMODE_GROUP'),
     MRC_CATEGORY_HARDWARE: t('BLOCKLY.CATEGORY.HARDWARE'),
     MRC_CATEGORY_ROBOT: t('BLOCKLY.CATEGORY.ROBOT'),
     MRC_CATEGORY_COMPONENTS: t('BLOCKLY.CATEGORY.COMPONENTS'),
diff --git a/src/storage/client_side_storage.ts b/src/storage/client_side_storage.ts
@@ -20,8 +20,6 @@
  */
 
 import * as commonStorage from './common_storage';
-import * as storageModuleContent from './module_content';
-import * as storageNames from './names';
 
 // Functions for saving blocks files to client side storage.
 
@@ -58,62 +56,7 @@ export async function openClientSideStorage(): Promise<commonStorage.Storage> {
     };
     openRequest.onsuccess = () => {
       const db = openRequest.result;
-      fixOldModules(db).then(() => {
-        resolve(ClientSideStorage.create(db));
-      })
-    };
-  });
-}
-
-// The following function allows Alan and Liz to load older projects.
-// TODO(lizlooney): Remove this function.
-async function fixOldModules(db: IDBDatabase): Promise<void> {
-  return new Promise((resolve, reject) => {
-    const transaction = db.transaction([FILES_STORE_NAME], 'readwrite');
-    transaction.oncomplete = () => {
-      resolve();
-    };
-    transaction.onabort = () => {
-      console.log('IndexedDB transaction aborted.');
-      reject(new Error('IndexedDB transaction aborted.'));
-    };
-    const filesObjectStore = transaction.objectStore(FILES_STORE_NAME);
-    const openCursorRequest = filesObjectStore.openCursor();
-    openCursorRequest.onerror = () => {
-      console.log('IndexedDB openCursor request failed. openCursorRequest.error is...');
-      console.log(openCursorRequest.error);
-      reject(new Error('IndexedDB openCursor request failed.'));
-    };
-    openCursorRequest.onsuccess = () => {
-      const cursor = openCursorRequest.result;
-      if (cursor) {
-        const value = cursor.value;
-        const regexForOldModulePath = new RegExp('^([A-Z][A-Za-z0-9]*)/([A-Z][A-Za-z0-9]*).json$');
-        const result = regexForOldModulePath.exec(value.path);
-        if (result) {
-          const oldModulePath = value.path;
-          const projectName = result[1];
-          const className = result[2];
-          const moduleType = storageModuleContent.parseModuleContentText(value.content).getModuleType();
-          value.path = storageNames.makeModulePath(projectName, className, moduleType);
-          const putRequest = filesObjectStore.put(value);
-          putRequest.onerror = () => {
-           console.log('IndexedDB put request failed. putRequest.error is...');
-            console.log(putRequest.error);
-            throw new Error('IndexedDB put request failed.');
-          };
-          const deleteRequest = filesObjectStore.delete(oldModulePath);
-          deleteRequest.onerror = () => {
-            console.log('IndexedDB delete request failed. deleteRequest.error is...');
-            console.log(deleteRequest.error);
-            throw new Error('IndexedDB delete request failed.');
-          };
-        }
-        cursor.continue();
-      } else {
-        // The cursor is done. We have finished reading all the files.
-        resolve();
-      }
+      resolve(ClientSideStorage.create(db));
     };
   });
 }
diff --git a/src/storage/module_content.ts b/src/storage/module_content.ts
@@ -146,7 +146,6 @@ export function makeModuleContentText(
 
 export function parseModuleContentText(moduleContentText: string): ModuleContent {
   const parsedContent = JSON.parse(moduleContentText);
-  fixOldParsedContent(parsedContent);
   if (!('moduleType' in parsedContent) ||
       !('moduleId' in parsedContent) ||
       !('blocks' in parsedContent) ||
@@ -166,38 +165,6 @@ export function parseModuleContentText(moduleContentText: string): ModuleContent
       parsedContent.methods);
 }
 
-// The following function allows Alan and Liz to load older projects.
-// TODO(lizlooney): Remove this function.
-function fixOldParsedContent(parsedContent: any): void {
-  if (!('moduleId' in parsedContent)) {
-    parsedContent.moduleId = '';
-  }
-  parsedContent.mechanisms.forEach((mechanism: any) => {
-    if (!('mechanismId' in mechanism) && ('blockId' in mechanism)) {
-      mechanism.mechanismId = mechanism['blockId'];
-      delete mechanism['blockId'];
-    }
-  });
-  parsedContent.components.forEach((component: any) => {
-    if (!('componentId' in component) && ('blockId' in component)) {
-      component.componentId = component['blockId'];
-      delete component['blockId'];
-    }
-  });
-  parsedContent.events.forEach((event: any) => {
-    if (!('eventId' in event) && ('blockId' in event)) {
-      event.eventId = event['blockId'];
-      delete event['blockId'];
-    }
-  });
-  parsedContent.methods.forEach((method: any) => {
-    if (!('methodId' in method) && ('blockId' in method)) {
-      method.methodId = method['blockId'];
-      delete method['blockId'];
-    }
-  });
-}
-
 export class ModuleContent {
   constructor(
       private moduleType: storageModule.ModuleType,
diff --git a/src/storage/project.ts b/src/storage/project.ts
@@ -20,12 +20,12 @@
  */
 
 import JSZip from 'jszip';
-import * as semver from 'semver';
 
 import * as commonStorage from './common_storage';
 import * as storageModule from './module';
 import * as storageModuleContent from './module_content';
 import * as storageNames from './names';
+import { upgradeProjectIfNecessary } from './upgrade_project';
 
 // Types, constants, and functions related to projects, regardless of where the projects are stored.
 
@@ -37,7 +37,7 @@ export type Project = {
 };
 
 const NO_VERSION = '0.0.0';
-const CURRENT_VERSION = '0.0.1';
+export const CURRENT_VERSION = '0.0.1';
 
 type ProjectInfo = {
   version: string,
@@ -62,7 +62,7 @@ export async function listProjectNames(storage: commonStorage.Storage): Promise<
  */
 export async function fetchProject(
     storage: commonStorage.Storage, projectName: string): Promise<Project> {
-  await updateProjectIfNecessary(storage, projectName);
+  await upgradeProjectIfNecessary(storage, projectName);
 
   const modulePaths: string[] = await storage.listFilePaths(
       storageNames.makeModulePathRegexPattern(projectName));
@@ -545,7 +545,7 @@ async function deleteProjectInfo(
   await storage.deleteFile(projectInfoPath);
 }
 
-async function fetchProjectInfo(
+export async function fetchProjectInfo(
     storage: commonStorage.Storage, projectName: string): Promise<ProjectInfo> {
   const projectInfoPath = storageNames.makeProjectInfoPath(projectName);
   let projectInfo: ProjectInfo;
@@ -560,19 +560,3 @@ async function fetchProjectInfo(
   }
   return projectInfo;
 }
-
-// TODO(lizlooney): Move updateProjectIfNecessary to it's own file.
-async function updateProjectIfNecessary(
-    storage: commonStorage.Storage, projectName: string): Promise<void> {
-  const projectInfo = await fetchProjectInfo(storage, projectName);
-  if (semver.lt(projectInfo.version, CURRENT_VERSION)) {
-    switch (projectInfo.version) {
-      case '0.0.0':
-        // Project was saved without a project.info.json file.
-        // Nothing needs to be done to update to '0.0.1';
-        projectInfo.version = '0.0.1';
-        break;
-    }
-    await saveProjectInfo(storage, projectName);
-  }
-}
diff --git a/src/storage/upgrade_project.ts b/src/storage/upgrade_project.ts
@@ -0,0 +1,41 @@
+/**
+ * @license
+ * Copyright 2025 Google LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *    https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+/**
+ * @author lizlooney@google.com (Liz Looney)
+ */
+
+import * as semver from 'semver';
+
+import * as commonStorage from './common_storage';
+import * as storageProject from './project';
+
+
+export async function upgradeProjectIfNecessary(
+    storage: commonStorage.Storage, projectName: string): Promise<void> {
+  const projectInfo = await storageProject.fetchProjectInfo(storage, projectName);
+  if (semver.lt(projectInfo.version, storageProject.CURRENT_VERSION)) {
+    switch (projectInfo.version) {
+      case '0.0.0':
+        // Project was saved without a project.info.json file.
+        // Nothing needs to be done to upgrade to '0.0.1';
+        projectInfo.version = '0.0.1';
+        break;
+    }
+    await storageProject.saveProjectInfo(storage, projectName);
+  }
+}

-Original file line number
+Diff line change
  */
 /**
 - * @fileoverview Miscellaneous blocks.
 + * @fileoverview Block to add an item to the end of a list.
  * @author [email protected] (Liz Looney)
  */