refactor all logging to go through a logger object

microsoft · Oct 29, 2024 · b979f2d · b979f2d
1 parent 0088816
commit b979f2d
Show file tree

Hide file tree

Showing 80 changed files with 394 additions and 273 deletions.
diff --git a/pxtblocks/codecardRenderer.ts b/pxtblocks/codecardRenderer.ts
@@ -59,7 +59,7 @@ export function renderCodeCard(card: pxt.CodeCard, options: CodeCardRenderOption
     if (card.blocksXml) {
         const svg = render(card.blocksXml);
         if (!svg) {
-            console.error("failed to render blocks");
+            pxt.error("failed to render blocks");
             pxt.debug(card.blocksXml);
         } else {
             let holder = div(img, ''); holder.setAttribute('style', 'width:100%; min-height:10em');

diff --git a/pxtblocks/compiler/util.ts b/pxtblocks/compiler/util.ts
@@ -25,11 +25,11 @@ export function forEachStatementInput(block: Blockly.Block, cb: (block: Blockly.
 export function printScope(scope: Scope, depth = 0) {
     const declared = Object.keys(scope.declaredVars).map(k => `${k}(${scope.declaredVars[k].id})`).join(",");
     const referenced = scope.referencedVars.join(", ");
-    console.log(`${mkIndent(depth)}SCOPE: ${scope.firstStatement ? scope.firstStatement.type : "TOP-LEVEL"}`)
+    pxt.log(`${mkIndent(depth)}SCOPE: ${scope.firstStatement ? scope.firstStatement.type : "TOP-LEVEL"}`)
     if (declared.length) {
-        console.log(`${mkIndent(depth)}DECS: ${declared}`)
+        pxt.log(`${mkIndent(depth)}DECS: ${declared}`)
     }
-    // console.log(`${mkIndent(depth)}REFS: ${referenced}`)
+    // pxt.log(`${mkIndent(depth)}REFS: ${referenced}`)
     scope.children.forEach(s => printScope(s, depth + 1));
 }
 

diff --git a/pxtblocks/diff.ts b/pxtblocks/diff.ts
@@ -72,7 +72,7 @@ function diffWorkspace(oldWs: Blockly.Workspace, newWs: Blockly.Workspace, optio
 
 function logger() {
     const log = pxt.options.debug || (window && /diffdbg=1/.test(window.location.href))
-        ? console.log : (message?: any, ...args: any[]) => { };
+        ? pxt.log : (message?: any, ...args: any[]) => { };
     return log;
 
 }

diff --git a/pxtblocks/fields/fieldEditorRegistry.ts b/pxtblocks/fields/fieldEditorRegistry.ts
@@ -82,7 +82,7 @@ export function registerFieldEditor(selector: string, field: FieldCustomConstruc
 
 export function createFieldEditor(selector: string, text: string, params: any): FieldCustom {
     if (registeredFieldEditors[selector] == undefined) {
-        console.error(`Field editor ${selector} not registered`);
+        pxt.error(`Field editor ${selector} not registered`);
         return null;
     }
 

diff --git a/pxtblocks/fields/field_numberdropdown.ts b/pxtblocks/fields/field_numberdropdown.ts
@@ -208,7 +208,7 @@ function parseDropdownOptions(options: FieldTextDropdownOptions): [string, any][
         return result;
     }
     else {
-        console.warn("Could not parse numberdropdown data field");
+        pxt.warn("Could not parse numberdropdown data field");
     }
 
     return [];

diff --git a/pxtblocks/fields/field_textdropdown.ts b/pxtblocks/fields/field_textdropdown.ts
@@ -240,7 +240,7 @@ function validateOptions(options: Blockly.MenuOption[]) {
         const tuple = options[i];
         if (!Array.isArray(tuple)) {
             foundError = true;
-            console.error(
+            pxt.error(
                 'Invalid option[' +
                 i +
                 ']: Each FieldDropdown option must be an ' +
@@ -249,7 +249,7 @@ function validateOptions(options: Blockly.MenuOption[]) {
             );
         } else if (typeof tuple[1] !== 'string') {
             foundError = true;
-            console.error(
+            pxt.error(
                 'Invalid option[' +
                 i +
                 ']: Each FieldDropdown option id must be ' +
@@ -264,7 +264,7 @@ function validateOptions(options: Blockly.MenuOption[]) {
             typeof tuple[0].src !== 'string'
         ) {
             foundError = true;
-            console.error(
+            pxt.error(
                 'Invalid option[' +
                 i +
                 ']: Each FieldDropdown option must have a ' +
@@ -323,7 +323,7 @@ function parseDropdownOptions(options: FieldTextDropdownOptions): [string, strin
             return result;
         }
         else {
-            console.warn("Could not parse textdropdown data field");
+            pxt.warn("Could not parse textdropdown data field");
         }
     }
 

diff --git a/pxtblocks/fields/field_tileset.ts b/pxtblocks/fields/field_tileset.ts
@@ -205,7 +205,7 @@ export class FieldTileset extends FieldImages implements FieldCustom {
             }
 
             if (this.sourceBlock_) {
-                console.warn(`Trying to set tile reference to nonexistent tile. Block type: ${this.sourceBlock_.type}, Field name: ${this.name}, Value: ${newValue}`)
+                pxt.warn(`Trying to set tile reference to nonexistent tile. Block type: ${this.sourceBlock_.type}, Field name: ${this.name}, Value: ${newValue}`)
             }
 
             return null;

diff --git a/pxtblocks/importer.ts b/pxtblocks/importer.ts
@@ -406,7 +406,7 @@ function createBlockFromShadow(shadow: Element) {
 export function patchShadows(root: Element, inShadow: boolean) {
     if (root.tagName === "shadow") {
         if (root.parentElement?.tagName === "xml") {
-            console.warn(`Shadow block of type '${root.getAttribute("type")}' found at top level. Converting to non-shadow block`);
+            pxt.warn(`Shadow block of type '${root.getAttribute("type")}' found at top level. Converting to non-shadow block`);
             pxt.tickEvent(`blocks.import.topLevelShadow`, { blockId: root.getAttribute("type") });
 
             const newBlock = createBlockFromShadow(root);

diff --git a/pxtblocks/layout.ts b/pxtblocks/layout.ts
@@ -469,7 +469,7 @@ async function convertIconsToPngAsync(xsg: Document): Promise<void> {
         let href = imageIconCache[svgUri];
         if (!href) {
             href = await pxt.BrowserUtils.encodeToPngAsync(svgUri, { width, height, pixelDensity: 2 });
-            console.log(`HREF: ${href}`);
+            pxt.log(`HREF: ${href}`);
         }
 
         imageIconCache[svgUri] = href;

diff --git a/pxtblocks/legacyMutations.ts b/pxtblocks/legacyMutations.ts
@@ -74,22 +74,22 @@ export function addMutation(b: MutatingBlock, info: pxtc.SymbolInfo, mutationTyp
     switch (mutationType) {
         case MutatorTypes.ObjectDestructuringMutator:
             if (!info.parameters || info.parameters.length < 1) {
-                console.error("Destructuring mutations require at least one parameter")
+                pxt.error("Destructuring mutations require at least one parameter")
             }
             else {
                 let found = false;
                 for (const param of info.parameters) {
                     if (param.type.indexOf("=>") !== -1) {
                         if (!param.properties || param.properties.length === 0) {
-                            console.error("Destructuring mutations only supported for functions with an event parameter that has multiple properties");
+                            pxt.error("Destructuring mutations only supported for functions with an event parameter that has multiple properties");
                             return;
                         }
                         found = true;
                     }
                 }
 
                 if (!found) {
-                    console.error("Destructuring mutations must have an event parameter");
+                    pxt.error("Destructuring mutations must have an event parameter");
                     return;
                 }
             }
@@ -102,7 +102,7 @@ export function addMutation(b: MutatingBlock, info: pxtc.SymbolInfo, mutationTyp
             m = new DefaultInstanceMutator(b, info);
             break;
         default:
-            console.warn("Ignoring unknown mutation type: " + mutationType);
+            pxt.warn("Ignoring unknown mutation type: " + mutationType);
             return;
     }
 
@@ -126,7 +126,7 @@ export function mutateToolboxBlock(block: Node, mutationType: string, mutation:
         case MutatorTypes.DefaultInstanceMutator:
             mutationElement.setAttribute(DefaultInstanceMutator.attributeName, mutation);
         default:
-            console.warn("Ignoring unknown mutation type: " + mutationType);
+            pxt.warn("Ignoring unknown mutation type: " + mutationType);
             return;
     }
 
@@ -366,7 +366,7 @@ class DestructuringMutator extends MutatorHelper {
                     this.parameterRenames = JSON.parse(xmlElement.getAttribute(DestructuringMutator.renameAttributeName));
                 }
                 catch (e) {
-                    console.warn("Ignoring invalid rename map in saved block mutation");
+                    pxt.warn("Ignoring invalid rename map in saved block mutation");
                 }
             }
 

diff --git a/pxtblocks/loader.ts b/pxtblocks/loader.ts
@@ -135,7 +135,7 @@ function injectBlockDefinition(info: pxtc.BlocksInfo, fn: pxtc.SymbolInfo, comp:
     }
 
     if (Blockly.Blocks[fn.attributes.blockId]) {
-        console.error("duplicate block definition: " + id);
+        pxt.error("duplicate block definition: " + id);
         return false;
     }
 
@@ -342,7 +342,7 @@ function initBlock(block: Blockly.Block, info: pxtc.BlocksInfo, fn: pxtc.SymbolI
 
         if (fn.attributes.shim === "ENUM_GET" || fn.attributes.shim === "KIND_GET") {
             if (comp.parameters.length > 1 || comp.thisParameter) {
-                console.warn(`Enum blocks may only have 1 parameter but ${fn.attributes.blockId} has ${comp.parameters.length}`);
+                pxt.warn(`Enum blocks may only have 1 parameter but ${fn.attributes.blockId} has ${comp.parameters.length}`);
                 return;
             }
         }
@@ -383,7 +383,7 @@ function initBlock(block: Blockly.Block, info: pxtc.BlocksInfo, fn: pxtc.SymbolI
 
                     firstParam = false;
                     if (!pr) {
-                        console.error("block " + fn.attributes.blockId + ": unknown parameter " + part.name + (part.ref ? ` (${part.ref})` : ""));
+                        pxt.error("block " + fn.attributes.blockId + ": unknown parameter " + part.name + (part.ref ? ` (${part.ref})` : ""));
                         return;
                     }
 
@@ -424,7 +424,7 @@ function initBlock(block: Blockly.Block, info: pxtc.BlocksInfo, fn: pxtc.SymbolI
                         }
 
                         if (syms.length == 0) {
-                            console.error(`no instances of ${typeInfo.qName} found`)
+                            pxt.error(`no instances of ${typeInfo.qName} found`)
                         }
                         const dd: Blockly.MenuOption[] = syms.map(v => {
                             let k = v.attributes.block || v.attributes.blockId || v.name;

diff --git a/pxtblocks/plugins/functions/blocks/functionDeclarationBlock.ts b/pxtblocks/plugins/functions/blocks/functionDeclarationBlock.ts
@@ -211,7 +211,7 @@ const FUNCTION_DECLARATION_MIXIN: FunctionDeclarationMixin = {
                     });
                     break;
                 default:
-                    console.warn("Unexpected input type on a function mutator root: " + input.type);
+                    pxt.warn("Unexpected input type on a function mutator root: " + input.type);
             }
         }
     },

diff --git a/pxtblocks/plugins/functions/extensions.ts b/pxtblocks/plugins/functions/extensions.ts
@@ -99,7 +99,7 @@ const variableReporterMixin = {
                     callback: () => {
                         let variableField = this.getField('VAR') as Blockly.FieldVariable;
                         if (!variableField) {
-                          console.log("Tried to get a variable field on the wrong type of block.");
+                          pxt.log("Tried to get a variable field on the wrong type of block.");
                         }
                         variableField.setValue(variable.getId());
                     }

diff --git a/pxtblocks/plugins/functions/functionManager.ts b/pxtblocks/plugins/functions/functionManager.ts
@@ -46,7 +46,7 @@ export class FunctionManager {
             this._editFunctionExternal(mutation, cb);
         }
         else {
-            console.warn('External function editor must be overriden: Blockly.Functions.editFunctionExternalHandler', mutation, cb);
+            pxt.warn('External function editor must be overriden: Blockly.Functions.editFunctionExternalHandler', mutation, cb);
         }
     }
 }
diff --git a/pxtblocks/plugins/functions/utils.ts b/pxtblocks/plugins/functions/utils.ts
@@ -241,7 +241,7 @@ export function mutateCallersAndDefinition(name: string, ws: Blockly.Workspace,
         });
         Blockly.Events.setGroup(false);
     } else {
-        console.warn("Attempted to change function " + name + ", but no definition block was found on the workspace");
+        pxt.warn("Attempted to change function " + name + ", but no definition block was found on the workspace");
     }
 }
 

diff --git a/pxtcompiler/emitter/backbase.ts b/pxtcompiler/emitter/backbase.ts
@@ -283,8 +283,8 @@ ${baseLabel}_nochk:
                     if (bi) {
                         let off = U.lookup(th.stackAtLabel, `__brkp_${bi.id}`)
                         if (off !== this.proc.debugInfo.localsMark) {
-                            console.log(bi)
-                            console.log(th.stackAtLabel)
+                            pxt.log(bi)
+                            pxt.log(th.stackAtLabel)
                             U.oops(`offset doesn't match: ${off} != ${this.proc.debugInfo.localsMark}`)
                         }
                     }
@@ -312,17 +312,17 @@ ${baseLabel}_nochk:
 
             for (let i = 0; i < this.proc.body.length; ++i) {
                 let s = this.proc.body[i]
-                // console.log("STMT", s.toString())
+                // pxt.log("STMT", s.toString())
                 switch (s.stmtKind) {
                     case ir.SK.Expr:
                         this.emitExpr(s.expr)
                         break;
                     case ir.SK.StackEmpty:
                         if (this.exprStack.length > 0) {
                             for (let stmt of this.proc.body.slice(i - 4, i + 1))
-                                console.log(`PREVSTMT ${stmt.toString().trim()}`)
+                                pxt.log(`PREVSTMT ${stmt.toString().trim()}`)
                             for (let e of this.exprStack)
-                                console.log(`EXPRSTACK ${e.currUses}/${e.totalUses} E: ${e.toString()}`)
+                                pxt.log(`EXPRSTACK ${e.currUses}/${e.totalUses} E: ${e.toString()}`)
                             oops("stack should be empty")
                         }
                         this.write("@stackempty locals")
@@ -387,7 +387,7 @@ ${baseLabel}_nochk:
         private terminate(expr: ir.Expr) {
             assert(expr.exprKind == ir.EK.SharedRef)
             let arg = expr.args[0]
-            // console.log("TERM", arg.sharingInfo(), arg.toString(), this.dumpStack())
+            // pxt.log("TERM", arg.sharingInfo(), arg.toString(), this.dumpStack())
             U.assert(arg.currUses != arg.totalUses)
             // we should have the terminated expression on top
             U.assert(this.exprStack[0] === arg, "term at top")
@@ -407,14 +407,14 @@ ${baseLabel}_nochk:
         }
 
         private validateJmpStack(lbl: ir.Stmt, off = 0) {
-            // console.log("Validate:", off, lbl.lblName, this.dumpStack())
+            // pxt.log("Validate:", off, lbl.lblName, this.dumpStack())
             let currSize = this.exprStack.length - off
             if (lbl.lblStackSize == null) {
                 lbl.lblStackSize = currSize
             } else {
                 if (lbl.lblStackSize != currSize) {
-                    console.log(lbl.lblStackSize, currSize)
-                    console.log(this.dumpStack())
+                    pxt.log(lbl.lblStackSize, currSize)
+                    pxt.log(this.dumpStack())
                     U.oops("stack misaligned at: " + lbl.lblName)
                 }
             }
@@ -542,7 +542,7 @@ ${baseLabel}_nochk:
 
         // result in R0
         private emitExpr(e: ir.Expr): void {
-            //console.log(`EMITEXPR ${e.sharingInfo()} E: ${e.toString()}`)
+            //pxt.log(`EMITEXPR ${e.sharingInfo()} E: ${e.toString()}`)
 
             switch (e.exprKind) {
                 case ir.EK.JmpValue:
@@ -930,8 +930,8 @@ ${baseLabel}_nochk:
             let allArgs = nonRefs.concat(refs)
             for (let r of allArgs) {
                 if (r.currUses != 0 || r.totalUses != 1) {
-                    console.log(r.toString())
-                    console.log(allArgs.map(a => a.toString()))
+                    pxt.log(r.toString())
+                    pxt.log(allArgs.map(a => a.toString()))
                     U.oops(`wrong uses: ${r.currUses} ${r.totalUses}`)
                 }
                 r.currUses = 1

diff --git a/pxtcompiler/emitter/backjs.ts b/pxtcompiler/emitter/backjs.ts
@@ -455,7 +455,7 @@ function ${id}(s) {
 
         // result in R0
         function emitExpr(e: ir.Expr): void {
-            //console.log(`EMITEXPR ${e.sharingInfo()} E: ${e.toString()}`)
+            //pxt.log(`EMITEXPR ${e.sharingInfo()} E: ${e.toString()}`)
 
             switch (e.exprKind) {
                 case EK.JmpValue:
@@ -607,7 +607,7 @@ function ${id}(s) {
                 write(`${frameRef} = ${id}(s);`)
             }
 
-            //console.log("PROCCALL", topExpr.toString())
+            //pxt.log("PROCCALL", topExpr.toString())
             topExpr.args.forEach((a, i) => {
                 let arg = `arg${i}`
                 if (isLambda) {