How to use shouldLog method in Cypress

1// Copyright 2016 The Chromium Authors. All rights reserved.2// Use of this source code is governed by a BSD-style license that can be3// found in the LICENSE file.4/**5 * @typedef {{6 *   onlineUrl: string,7 *   creationTime: number,8 *   id: string,9 *   namespace: string,10 *   size: string,11 *   filePath: string,12 *   lastAccessTime: number,13 *   accessCount: number,14 *   isExpired: string,15 *   requestOrigin: string16 * }}17 */18var OfflinePage;19/**20 * @typedef {{21 *   status: string,22 *   onlineUrl: string,23 *   creationTime: number,24 *   id: string,25 *   namespace: string,26 *   lastAttemptTime: number,27 *   requestOrigin: string28 * }}29 */30var SavePageRequest;31/**32 * @typedef {{33 *   modelIsLogging: boolean,34 *   queueIsLogging: boolean,35 *   prefetchIsLogging: boolean36 * }}37 */38var IsLogging;39cr.define('offlineInternals', function() {40  /** @interface */41  function OfflineInternalsBrowserProxy() {}42  OfflineInternalsBrowserProxy.prototype = {43    /**44     * Gets current list of stored pages.45     * @return {!Promise<!Array<OfflinePage>>} A promise firing when the46     *     list is fetched.47     */48    getStoredPages: function() {},49    /**50     * Gets current offline queue requests.51     * @return {!Promise<!Array<SavePageRequest>>} A promise firing when the52     *     request queue is fetched.53     */54    getRequestQueue: function() {},55    /**56     * Deletes a set of pages from stored pages57     * @param {!Array<string>} ids A list of page IDs to delete.58     * @return {!Promise<!string>} A promise firing when the selected59     *     pages are deleted.60     */61    deleteSelectedPages: function(ids) {},62    /**63     * Deletes a set of requests from the request queue64     * @param {!Array<string>} ids A list of request IDs to delete.65     * @return {!Promise<!string>} A promise firing when the selected66     *     pages are deleted.67     */68    deleteSelectedRequests: function(ids) {},69    /**70     * Sets whether to record logs for stored pages.71     * @param {boolean} shouldLog True if logging should be enabled.72     */73    setRecordPageModel: function(shouldLog) {},74    /**75     * Sets whether to record logs for scheduled requests.76     * @param {boolean} shouldLog True if logging should be enabled.77     */78    setRecordRequestQueue: function(shouldLog) {},79    /**80     * Sets whether to record logs for prefetching.81     * @param {boolean} shouldLog True if logging should be enabled.82     */83    setRecordPrefetchService: function(shouldLog) {},84    /**85     * Gets the currently recorded logs.86     * @return {!Promise<!Array<string>>} A promise firing when the87     *     logs are retrieved.88     */89    getEventLogs: function() {},90    /**91     * Gets the state of logging (on/off).92     * @return {!Promise<!IsLogging>} A promise firing when the state93     *     is retrieved.94     */95    getLoggingState: function() {},96    /**97     * Adds the given url to the background loader queue.98     * @param {string} url Url of the page to load later.99     * @return {!Promise<boolean>} A promise firing after added to queue.100     *     Promise will return true if url has been successfully added.101     */102    addToRequestQueue: function(url) {},103    /**104     * Gets the current network status in string form.105     * @return {!Promise<string>} A promise firing when the network status106     *     is retrieved.107     */108    getNetworkStatus: function() {},109    /**110     * Schedules the default NWake task.  The returned Promise will reject if111     *     there is an error while scheduling.112     * @return {!Promise<string>} A promise firing when the task has been113     *     scheduled.114     */115    scheduleNwake: function() {},116    /**117     * Cancels NWake task.118     * @return {!Promise} A promise firing when the task has been cancelled. The119     *     returned Promise will reject if there is an error.120     */121    cancelNwake: function() {},122    /**123     * Shows the prefetching notification with an example origin.124     * @return {!Promise<string>} A promise firing when the notification has125     *   been shown.126     */127    showPrefetchNotification: function() {},128    /**129     * Sends and processes a request to generate page bundle.130     * @param {string} urls A list of comma-separated URLs.131     * @return {!Promise<string>} A string describing the result.132     */133    generatePageBundle: function(urls) {},134    /**135     * Sends and processes a request to get operation.136     * @param {string} name Name of operation.137     * @return {!Promise<string>} A string describing the result.138     */139    getOperation: function(name) {},140    /**141     * Downloads an archive.142     * @param {string} name Name of archive to download.143     */144    downloadArchive: function(name) {},145  };146  /**147   * @constructor148   * @implements {offlineInternals.OfflineInternalsBrowserProxy}149   */150  function OfflineInternalsBrowserProxyImpl() {}151  cr.addSingletonGetter(OfflineInternalsBrowserProxyImpl);152  OfflineInternalsBrowserProxyImpl.prototype = {153    /** @override */154    getStoredPages: function() {155      return cr.sendWithPromise('getStoredPages');156    },157    /** @override */158    getRequestQueue: function() {159      return cr.sendWithPromise('getRequestQueue');160    },161    /** @override */162    deleteSelectedPages: function(ids) {163      return cr.sendWithPromise('deleteSelectedPages', ids);164    },165    /** @override */166    deleteSelectedRequests: function(ids) {167      return cr.sendWithPromise('deleteSelectedRequests', ids);168    },169    /** @override */170    setRecordPageModel: function(shouldLog) {171      chrome.send('setRecordPageModel', [shouldLog]);172    },173    /** @override */174    setRecordRequestQueue: function(shouldLog) {175      chrome.send('setRecordRequestQueue', [shouldLog]);176    },177    /** @override */178    setRecordPrefetchService: function(shouldLog) {179      chrome.send('setRecordPrefetchService', [shouldLog]);180    },181    /** @override */182    getEventLogs: function() {183      return cr.sendWithPromise('getEventLogs');184    },185    /** @override */186    getLoggingState: function() {187      return cr.sendWithPromise('getLoggingState');188    },189    /** @override */190    addToRequestQueue: function(url) {191      return cr.sendWithPromise('addToRequestQueue', url);192    },193    /** @override */194    getNetworkStatus: function() {195      return cr.sendWithPromise('getNetworkStatus');196    },197    /** @override */198    scheduleNwake: function() {199      return cr.sendWithPromise('scheduleNwake');200    },201    /** @override */202    cancelNwake: function() {203      return cr.sendWithPromise('cancelNwake');204    },205    /** @override */206    showPrefetchNotification: function() {207      return cr.sendWithPromise('showPrefetchNotification');208    },209    /** @override */210    generatePageBundle: function(urls) {211      return cr.sendWithPromise('generatePageBundle', urls);212    },213    /** @override */214    getOperation: function(name) {215      return cr.sendWithPromise('getOperation', name);216    },217    /** @override */218    downloadArchive: function(name) {219      chrome.send('downloadArchive', [name]);220    },221  };222  return {223    OfflineInternalsBrowserProxy: OfflineInternalsBrowserProxy,224    OfflineInternalsBrowserProxyImpl: OfflineInternalsBrowserProxyImpl225  };...

...14                });15            });16            describe(': shouldLog', function(){17                it('should not log by default', function(){18                    expect($console.shouldLog('none')).not.toBeTruthy();19                });20                it('should always log if !!force', function(){21                    $console.force = true;22                    expect($console.shouldLog('none')).toBeTruthy();23                });24                it('should respect level', function(){25                    $console.settings.tags = 'all';26                    $console.settings.level = 'info';27                    expect($console.shouldLog('error')).toBeTruthy();28                    expect($console.shouldLog('warn')).toBeTruthy();29                    expect($console.shouldLog('info')).toBeTruthy();30                    expect($console.shouldLog('log')).not.toBeTruthy();31                    expect($console.shouldLog('debug')).not.toBeTruthy();32                });33                it('should respect settings.tags (String)', function(){34                    $console.settings.tags = 'question';35                    $console.tags = ['not question'];36                    expect($console.shouldLog('error')).not.toBeTruthy();37                    $console.tags = ['question'];38                    expect($console.shouldLog('error')).toBeTruthy();39                });40                it('should respect settings.tags (Array)', function(){41                    $console.settings.tags = ['question','manager'];42                    $console.tags = ['not question'];43                    expect($console.shouldLog('error')).not.toBeTruthy();44                    $console.tags = ['question'];45                    expect($console.shouldLog('error')).toBeTruthy();46                });47                it('should respect tags', function(){48                    $console.settings.tags = ['bling','rocket'];49                    $console.tags = ['bling'];50                    expect($console.shouldLog('error')).toBeTruthy();51                    $console.tags = ['chiwawa'];52                    expect($console.shouldLog('error')).not.toBeTruthy();53                });54                it('should respect tags == "all"', function(){55                    $console.settings.tags = 'all';56                    expect($console.shouldLog('error')).toBeTruthy();57                });58                it('should treat tags as "all" by default', function(){59                    expect($console.shouldLog('error')).toBeTruthy();60                });61            });62			// we assume all loggers are the same so we test only plain log (can always test them all with a loop...)63            describe(': loggers', function(){64                beforeEach(function(){65                    $console.shouldLog = jasmine.createSpy('log').andReturn(true); // just automatically log everything...66                });67                it('should $log all arguments', function(){68                    var args = [1,2,3,4,5,6,7];69                    $console.log.apply($console,args);70                    expect($log.log.logs[0]).toEqual(args);71                });72                it('should not log if !shouldLog', function(){73                    $console.shouldLog.andReturn(false); // deactivate shouldlog...

1const puppeteer = require('puppeteer')2const colors = require('colors')3const spinner = require('ora')4const { apiUrl, debugPort, productionApiUrl } = require('./env')5const { error, success } = require('log-symbols')6const terminal = {7    lineFails (text) {8        this.error(text)9    },10    lineSuccess (text) {11        console.log(colors.green(success), colors.green(text))12    },13    scenarioStarts (text) {14        console.log('[SCENARIO]', text)15    },16    error (text) {17        console.log(colors.red(error), colors.red(text))18    },19    info (text) {20        console.log(colors.green(success), colors.green(text))21    },22    log (text) {23        console.log(text)24    },25    stats (passes, fails) {26        console.log('')27        console.log(28            colors.bgGreen.white.bold(` passes: ${passes} `),29            colors.bgRed.white.bold(` fails: ${fails} `)30        )31        console.log('')32    }33}34module.exports = (urls, consoleTextPrefix = '[CLI] ') => new Promise(async resolve => {35    const debuggingPort = debugPort()36    const isProduction = apiUrl() === productionApiUrl37    const args = [38        '--disable-dev-shm-usage',39        '--no-sandbox',40        '--disable-setuid-sandbox'41    ]42    if (!isProduction) {43        args.push(`--remote-debugging-port=${debuggingPort}`)44        args.push('--remote-debugging-address=0.0.0.0')45    }46    const browser = await puppeteer.launch.call(puppeteer, { args })47    const doneLogText = 'FINISHED'48    const loader = spinner('Starting up')49    const shouldLog = urls.length === 150    if (!isProduction) {51        console.log(`Remote debugging: http://localhost:${debuggingPort}`)52    }53    if (!shouldLog) {54        loader.start()55    }56    let done = urls.length57    const closeBrowser = () => {58        done--59        if (done) {60            return61        }62        loader.clear()63        loader.stop()64        browser.close()65        resolve()66    }67    urls.forEach(async url => {68        try {69            loader.start()70            const page = await browser.newPage()71            let passes = 072            let fails = 073            page.on('error', error => {74                if (shouldLog) {75                    terminal.info('on error')76                    terminal.error(error)77                }78                closeBrowser()79            })80            page.on('console', msg => {81                const type = msg.type()82                let text = msg.text()83                if (!text.startsWith(consoleTextPrefix)) {84                    return85                }86                text = text.replace(consoleTextPrefix, '').trim()87                if (text === doneLogText) {88                    if (shouldLog) {89                        loader.clear()90                        loader.stop()91                        if (passes || fails) {92                            terminal.stats(passes, fails)93                        }94                    }95                    if (fails || !passes) {96                        if (shouldLog && !passes) {97                            loader.fail('No action was taken')98                        }99                        process.exit(1)100                    }101                    return closeBrowser()102                }103                if (!terminal[type]) {104                    return105                }106                if (shouldLog) {107                    loader.clear()108                }109                if (type === 'info') {110                    if (text.startsWith('SCENARIO:')) {111                        if (shouldLog) {112                            console.log('')113                            terminal.scenarioStarts(text.replace('SCENARIO: ', ''))114                            console.log('')115                        }116                    } else {117                        passes++118                        if (shouldLog) {119                            loader.succeed(text)120                        }121                    }122                } else {123                    fails++124                    if (shouldLog) {125                        loader.fail(text)126                    }127                }128                if (shouldLog) {129                    loader.start('running')130                }131            })132            await page.goto(`${url}&logPrefix=${encodeURIComponent(consoleTextPrefix)}&doneLogText=${encodeURIComponent(doneLogText)}`)133        } catch ({ message }) {134            if (shouldLog) {135                loader.clear()136                loader.stop()137                terminal.error(message)138            }139            closeBrowser()140        }141    })...

1const Q = require('q');2const PythonShell = require('python-shell');3const rootDirectory = require('path').dirname(require.main.filename);4module.exports.run = function(scriptName, scriptArguments, shouldLog = true) {5  let deferred = Q.defer();6  let shell = this.shell(scriptName, scriptArguments);7  var result;8  let errors = [];9  let logs = [];10  shell.on('message', message => {11    if (message.errors) {12      if (shouldLog) {13        console.log(scriptName + ' python script errors:', message.errors);14      }15      errors = errors.concat(message.errors);16    }17    if (message.log) {18      if (shouldLog) {19        console.log(scriptName + ' python script log: ' + message.log);20      }21      logs.push(message.log);22    }23    if (message.result) {24      result = message.result;25    }26  });27  shell.end(scriptError => {28    if (scriptError) {29      if (shouldLog) {30        console.log(scriptName + ' python script error:', scriptError);31      }32      errors.unshift(scriptError);33    }34    if (result) {35      deferred.resolve({36        result: result,37        errors: errors,38        logs: logs,39      })40    } else {41      let error = scriptName + ' python script completed without returning a result.';42      if (shouldLog) {43        console.log(error + '\nArgs:\n' + JSON.stringify(JSON.stringify(scriptArguments)));44      }45      errors.unshift(error);46      deferred.reject({ errors: errors, logs: logs });47    }48  });49  return deferred.promise;50};51module.exports.interact = function(scriptName, scriptArguments, resultHandler, errorHandler, closeHandler, shouldLog = true) {52  let shell = this.shell(scriptName, scriptArguments);53  shell.on('message', message => {54    if (message.errors) {55      if (shouldLog) {56        console.log(scriptName + ' python script errors:', message.errors);57      }58    }59    if (message.log) {60      if (shouldLog) {61        console.log(scriptName + ' python script log: ' + message.log);62      }63    }64    if (resultHandler) {65      let response = resultHandler(message, shell);66      if (response !== undefined) {67        shell.send(response);68      }69    }70  });71  shell.on('error', error => {72    if (shouldLog) {73      console.log(scriptName + ' python script error:', error);74    }75    if (errorHandler) {76      errorHandler(error, shell);77    }78  });79  shell.on('close', () => {80    if (closeHandler) {81      closeHandler(shell);82    }83  });84  return shell;85};86module.exports.shell = function(scriptName, scriptArguments) {87  let options = {88    mode: 'json',89    pythonPath: rootDirectory + '/python/environment/bin/python',90    scriptPath: __dirname + '/../scripts',91    args: [JSON.stringify(scriptArguments)]92  };93  let shell = new PythonShell(scriptName, options);94  return shell;95};96module.exports.runCommand = function(command, commandArguments, shouldLog = true) {97  let scriptArguments = Object.assign(98    {99      command: command,100    },101    commandArguments102  );103  return module.exports.run('../datadragon_api.py', scriptArguments, shouldLog);...

1const { calculateAllConnectivity } = require("../api_access/calculate_connectivity");2const { insertDataIntoDatabaseAndLog } = require("../api_access/main");3const { defineSchema } = require("../api_access/reset_schema");4const { readFileLineByLine, readLastLineOfFile } = require("./file_io");5const { createMetadata } = require("./meta");6const { promisedExec, promisedExecInFolder } = require("./util");7const initialScrap = async (shouldLog, dataPath, metaName, repoPath) => {8    // Reset database9    await defineSchema(true);10    shouldLog && console.log("Resetting database...");11    shouldLog && console.log("Commencing initial scrape...");12    // Clear data and metadata13    shouldLog && console.log("Removing existing data and metadata if any...");14    try {15        await promisedExec(`rm -rf ${dataPath} && rm ${dataPath + metaName}`);16    } catch (e) {}17    // Create data18    shouldLog && console.log("Creating data folder...");19    await promisedExec(`mkdir -p ${dataPath}`);20    // Create necessary data files21    shouldLog && console.log(`Creating intermediate data files...`);22    await promisedExec(`touch ${dataPath}paths`);23    // Store all crate files in an array24    await promisedExec(`find ${repoPath}/* -type f >> ${dataPath}paths`);25    const allFilePaths = [];26    await readFileLineByLine(27        `${dataPath}paths`,28        (line) => {29            // There should be no "." in the file path30            if (!line.substring(repoPath.length).includes(".")) {31                allFilePaths.push(line);32            }33        });34    shouldLog && console.log("All file paths loaded.");35    // Store the last entry of each crate file into entries36    const numPaths = allFilePaths.length;37    const entries = [];38    for (let i = 0; i < numPaths; ++i) {39        shouldLog40        && ((i+1) % 10000 === 0 || (i+1) === numPaths)41        && console.log(`Data entries loading... ${i+1}/${numPaths}`);42        43        const entry = await readLastLineOfFile(allFilePaths[i]);44        entries.push(JSON.parse(entry));45    };46    shouldLog && console.log(`${entries.length} data entries loaded from ${numPaths} paths.`);47    // Store all crate names in an array for later use48    require('fs').writeFileSync(dataPath + "crate_names.json", JSON.stringify(entries.map((entry) => entry.name)));49    await insertDataIntoDatabaseAndLog(50        entries,51        dataPath,52        {53            batchReleaseThreshold: 10000,54            shouldLog55        }56    );57    shouldLog && console.log("Calculating connectivities...");58    await calculateAllConnectivity();59    // Create metadata when everything is ready60    shouldLog && console.log("Creating metadata...");61    await createMetadata(dataPath + metaName, shouldLog, repoPath);62    // Clean up63    await promisedExecInFolder(dataPath, `rm paths`);64};65module.exports = {66    initialScrap...

1const { calculateAllConnectivity } = require("../api_access/calculate_connectivity");2const { insertDataIntoDatabaseAndLog } = require("../api_access/main");3const { readFileLineByLine } = require("./file_io");4const { createMetadata } = require("./meta");5const { promisedExecInFolder } = require("./util");6const updateScrap = async (shouldLog, metadata, dataPath, repoPath) => {7    const lastCommitHash = metadata.lastCommitHash;8    shouldLog && console.log(`${lastCommitHash} (Last update commit hash)`);9    const mostRecentCommitHash = (await promisedExecInFolder(repoPath, "git rev-parse --verify HEAD"))[0];10    shouldLog && console.log(`${mostRecentCommitHash} (Most recent commit hash)`);11    if (lastCommitHash === mostRecentCommitHash) {12        shouldLog && console.log("Commit hashes match. No need to update.");13        return;14    }15    // Do a git diff from last commit to the most recent commit16    await promisedExecInFolder(repoPath, `git diff ${lastCommitHash}...${mostRecentCommitHash} > ../${dataPath}diff`);17    18    // Keep only the last entry for each crate name19    const dataMap = new Map();20    await readFileLineByLine(dataPath + "diff", (line) => {21        // Keep only lines starting with exactly 1 '+'22        if (line.length >= 2 && line[0] === '+' && line[1] !== '+') {23            // Remove the '+'24            const datum = JSON.parse(line.substring(1));25            dataMap.set(datum.name, datum);26        }27    });28    const data = Array.from(dataMap.values());29    shouldLog && console.log("Updating crates: ", data.map((datum) => datum.name));30    await insertDataIntoDatabaseAndLog(data, dataPath, { shouldLog });31    shouldLog && console.log("Recalculating connectivities...");32    await calculateAllConnectivity();33    // Update metadata when everything is ready34    shouldLog && console.log("Updating metadata...");35    await createMetadata(metadata.filePath, shouldLog, repoPath);36    // Clean up37    await promisedExecInFolder(dataPath, "rm diff");38};39module.exports = {40    updateScrap...

1var logLevel = "info";2function dummy() {}3function shouldLog(level) {4	var shouldLog =5		(logLevel === "info" && level === "info") ||6		(["info", "warning"].indexOf(logLevel) >= 0 && level === "warning") ||7		(["info", "warning", "error"].indexOf(logLevel) >= 0 && level === "error");8	return shouldLog;9}10function logGroup(logFn) {11	return function(level, msg) {12		if (shouldLog(level)) {13			logFn(msg);14		}15	};16}17module.exports = function(level, msg) {18	if (shouldLog(level)) {19		if (level === "info") {20			console.log(msg);21		} else if (level === "warning") {22			console.warn(msg);23		} else if (level === "error") {24			console.error(msg);25		}26	}27};28/* eslint-disable node/no-unsupported-features/node-builtins */29var group = console.group || dummy;30var groupCollapsed = console.groupCollapsed || dummy;31var groupEnd = console.groupEnd || dummy;32/* eslint-enable node/no-unsupported-features/node-builtins */...

...9  logFunction() {10    console.log(...arguments);11  }12  error(txt) {13    if (!(this.shouldLog('error'))) {14      return;15    }16    this.logFunction(txt.red);17  }18  warn(txt) {19    if (!(this.shouldLog('warn'))) {20      return;21    }22    this.logFunction(txt.yellow);23  }24  info(txt) {25    if (!(this.shouldLog('info'))) {26      return;27    }28    this.logFunction(txt.green);29  }30  debug(txt) {31    if (!(this.shouldLog('debug'))) {32      return;33    }34    this.logFunction(txt);35  }36  trace(txt) {37    if (!(this.shouldLog('trace'))) {38      return;39    }40    this.logFunction(txt);41  }42  shouldLog(level) {43    return (this.logLevels.indexOf(level) <= this.logLevels.indexOf(this.logLevel));44  }...