more updates

Author: sproutleaf

src/core/friendly_errors/sketch_verifier.js

@@ -47,7 +47,6 @@ function sketchVerifier(p5, fn) {
   const p5Constructors = {};
 
   fn.loadP5Constructors = function () {
-    console.log("loading...");
     // Make a list of all p5 classes to be used for argument validation
     // This must be done only when everything has loaded otherwise we get
     // an empty array
@@ -58,7 +57,6 @@ function sketchVerifier(p5, fn) {
         p5Constructors[key] = p5[key];
       }
     }
-    console.log('p5Constructors:', p5Constructors);
   }
 
   /**
@@ -188,18 +186,22 @@ function sketchVerifier(p5, fn) {
       ...userDefinitions.variables,
       ...userDefinitions.functions
     ];
-    console.log(allDefinitions);
 
+    // Helper function that generates a friendly error message that contains
+    // the type of redefinition (constant or function), the name of the
+    // redefinition, the line number in user's code, and a link to its
+    // reference on the p5.js website.
     function generateFriendlyError(errorType, name, line) {
       const url = `https://p5js.org/reference/#/p5/${name}`;
       const message = `${errorType} "${name}" on line ${line} is being redeclared and conflicts with a p5.js ${errorType.toLowerCase()}. JavaScript does not declaring a ${errorType.toLowerCase()} more than once. p5.js reference: ${url}.`;
       return message;
     }
 
+    // Helper function that checks if a user definition has already been defined
+    // in the p5.js library, either as a constant or as a function.
     function checkForRedefinition(name, libValue, line, type) {
-      console.log('name:', name, 'libValue:', libValue, 'line:', line, 'type:', type);
       try {
-        const userValue = eval(name);
+        const userValue = eval("name");
         if (libValue !== userValue) {
           let message = generateFriendlyError(type, name, line);
           console.log(message);
@@ -212,6 +214,7 @@ function sketchVerifier(p5, fn) {
       return false;
     }
 
+    // Checks for constant redefinitions.
     for (let { name, line } of allDefinitions) {
       const libDefinition = constants[name];
       if (libDefinition !== undefined) {

test/unit/core/sketch_overrides.js

@@ -3,10 +3,9 @@ import sketchVerifier from '../../../src/core/friendly_errors/sketch_verifier.js
 suite('Sketch Verifier', function () {
   const mockP5 = {
     _validateParameters: vi.fn(),
-    Render: function () {
-      return 'mock render';
-    },
+    Renderer: function () { },
   };
+  mockP5.Renderer.prototype.rect = vi.fn();
   const mockP5Prototype = {};
 
   beforeAll(function () {
@@ -184,34 +183,53 @@ suite('Sketch Verifier', function () {
   });
 
   suite('checkForConstsAndFuncs()', function () {
+    // Set up for this suite of tests
+    let consoleSpy;
+
+    beforeEach(function () {
+      consoleSpy = vi.spyOn(console, 'log').mockImplementation(() => { });
+    });
+
+    afterEach(function () {
+      consoleSpy.mockRestore();
+    });
+
     test('Detects conflict with p5.js constant', function () {
       const userDefinitions = {
         variables: [{ name: 'PI', line: 1 }],
         functions: []
       };
-      const consoleSpy = vi.spyOn(console, 'log').mockImplementation(() => { });
-
       const result = mockP5Prototype.checkForConstsAndFuncs(userDefinitions);
 
       expect(result).toBe(true);
       expect(consoleSpy).toHaveBeenCalledWith(expect.stringContaining('Constant "PI" on line 1 is being redeclared and conflicts with a p5.js constant'));
-
-      consoleSpy.mockRestore();
     });
 
     test('Detects conflict with p5.js global function', function () {
       const userDefinitions = {
         variables: [],
-        functions: [{ name: 'setup', line: 2 }]
+        functions: [{ name: 'rect', line: 2 }]
       };
-      //const consoleSpy = vi.spyOn(console, 'log').mockImplementation(() => { });
-
       const result = mockP5Prototype.checkForConstsAndFuncs(userDefinitions);
 
       expect(result).toBe(true);
-      //expect(consoleSpy).toHaveBeenCalledWith(expect.stringContaining('Function "setup" on line 2 is being redeclared and conflicts with a p5.js function'));
+      expect(consoleSpy).toHaveBeenCalledWith(expect.stringContaining('Function "rect" on line 2 is being redeclared and conflicts with a p5.js function'));
+    });
+
+    test('allows redefinition of whitelisted functions', function () {
+      const userDefinitions = {
+        variables: [],
+        functions: [
+          { name: 'setup', line: 1 },
+          { name: 'draw', line: 2 },
+          { name: 'preload', line: 3 }
+        ]
+      };
 
-      //consoleSpy.mockRestore();
+      const result = mockP5Prototype.checkForConstsAndFuncs(userDefinitions);
+
+      expect(result).toBe(false);
+      expect(consoleSpy).not.toHaveBeenCalled();
     });
 
     test('Returns false when no conflicts are found', function () {