fix: remove test coverage map (#4862)

Turns out there were three files that still had no test coverage because of the combination of the mocks in tests and the coverage map. Removing the map altogether exposed them. This PR removes the coverage map and fixes test to cover all lines that were being missed. While adding coverage to the `npm search` codebase multiple unneeded guards and at least one bug was found (it was impossible to exclude searches based on username). These were fixed. The `npm view` tests were also refactored to use the real npm object. Finally, a small inlining of lib/utils/file-exists.js was done.

Author: wraithgar

lib/commands/completion.js

@@ -29,18 +29,26 @@
 // as an array.
 //
 
+constfs=require('@npmcli/fs')
+constnopt=require('nopt')
+
 const{ definitions, shorthands }=require('../utils/config/index.js')
 const{ aliases, cmdList, plumbing }=require('../utils/cmd-list.js')
 constaliasNames=Object.keys(aliases)
 constfullList=cmdList.concat(aliasNames).filter(c=>!plumbing.includes(c))
-constnopt=require('nopt')
 constconfigNames=Object.keys(definitions)
 constshorthandNames=Object.keys(shorthands)
 constallConfs=configNames.concat(shorthandNames)
 const{ isWindowsShell }=require('../utils/is-windows.js')
-constfileExists=require('../utils/file-exists.js')
+constfileExists=async(file)=>{
+try{
+conststat=awaitfs.stat(file)
+returnstat.isFile()
+}catch{
+returnfalse
+}
+}
 
-const{ promisify }=require('util')
 constBaseCommand=require('../base-command.js')
 
 classCompletionextendsBaseCommand{
@@ -189,12 +197,10 @@ class Completion extends BaseCommand{
 }
 
 constdumpScript=async()=>{
-constfs=require('fs')
-constreadFile=promisify(fs.readFile)
 const{ resolve }=require('path')
 constp=resolve(__dirname,'..','utils','completion.sh')
 
-constd=(awaitreadFile(p,'utf8')).replace(/^#!.*?\n/,'')
+constd=(awaitfs.readFile(p,'utf8')).replace(/^#!.*?\n/,'')
 awaitnewPromise((res,rej)=>{
 letdone=false
 process.stdout.on('error',er=>{

lib/commands/search.js

@@ -3,26 +3,33 @@ const Pipeline = require('minipass-pipeline')
 constlibSearch=require('libnpmsearch')
 constlog=require('../utils/log-shim.js')
 
-constformatPackageStream=require('../search/format-package-stream.js')
-constpackageFilter=require('../search/package-filter.js')
+constformatSearchStream=require('../utils/format-search-stream.js')
+
+functionfilter(data,include,exclude){
+constwords=[data.name]
+.concat(data.maintainers.map(m=>`=${m.username}`))
+.concat(data.keywords||[])
+.map(f=>f&&f.trim&&f.trim())
+.filter(f=>f)
+.join(' ')
+.toLowerCase()
+
+if(exclude.find(e=>match(words,e))){
+returnfalse
+}
 
-functionprepareIncludes(args){
-returnargs
-.map(s=>s.toLowerCase())
-.filter(s=>s)
+returntrue
 }
 
-functionprepareExcludes(searchexclude){
-varexclude
-if(typeofsearchexclude==='string'){
-exclude=searchexclude.split(/\s+/)
-}else{
-exclude=[]
+functionmatch(words,pattern){
+if(pattern.startsWith('/')){
+if(pattern.endsWith('/')){
+pattern=pattern.slice(0,-1)
+}
+pattern=newRegExp(pattern.slice(1))
+returnwords.match(pattern)
 }
-
-returnexclude
-.map(s=>s.toLowerCase())
-.filter(s=>s)
+returnwords.indexOf(pattern)!==-1
 }
 
 constBaseCommand=require('../base-command.js')
@@ -50,8 +57,8 @@ class Search extends BaseCommand{
 constopts={
  ...this.npm.flatOptions,
  ...this.npm.flatOptions.search,
-include: prepareIncludes(args),
-exclude: prepareExcludes(this.npm.flatOptions.search.exclude),
+include: args.map(s=>s.toLowerCase()).filter(s=>s),
+exclude: this.npm.flatOptions.search.exclude.split(/\s+/),
 }
 
 if(opts.include.length===0){
@@ -63,7 +70,7 @@ class Search extends BaseCommand{
 
 classFilterStreamextendsMinipass{
 write(pkg){
-if(packageFilter(pkg,opts.include,opts.exclude)){
+if(filter(pkg,opts.include,opts.exclude)){
 super.write(pkg)
 }
 }
@@ -73,7 +80,7 @@ class Search extends BaseCommand{
 
 // Grab a configured output stream that will spit out packages in the
 // desired format.
-constoutputStream=formatPackageStream({
+constoutputStream=formatSearchStream({
  args,// --searchinclude options are not highlighted
  ...opts,
 })

lib/commands/view.js

@@ -57,9 +57,6 @@ class View extends BaseCommand{
 
 functiongetFields(d,f,pref){
 f=f||[]
-if(!d){
-returnf
-}
 pref=pref||[]
 Object.keys(d).forEach((k)=>{
 if(k.charAt(0)==='_'||k.indexOf('.')!==-1){

lib/search/package-filter.js

@@ -1856,7 +1856,7 @@ define('searchexclude',{
  `,
 flatten(key,obj,flatOptions){
 flatOptions.search=flatOptions.search||{limit: 20}
-flatOptions.search.exclude=obj[key]
+flatOptions.search.exclude=obj[key].toLowerCase()
 },
 })
 

lib/utils/config/definitions.js

@@ -23,6 +23,7 @@ const formatBytes = (bytes, space = true) =>{
 return`${(bytes/1000000).toFixed(1)}${spacer}MB`
 }
 
+// GB
 return`${(bytes/1000000000).toFixed(1)}${spacer}GB`
 }
 

lib/utils/file-exists.js

@@ -1,6 +1,3 @@
-// XXX these output classes should not live in here forever. it'd be good to
-// split them out, perhaps to libnpmsearch
-
 constMinipass=require('minipass')
 constcolumnify=require('columnify')
 
@@ -18,32 +15,26 @@ const columnify = require('columnify')
 // The returned stream will format this package data
 // into a byte stream of formatted, displayable output.
 
-module.exports=(opts={})=>
-opts.json ? newJSONOutputStream() : newTextOutputStream(opts)
+module.exports=(opts)=>{
+returnopts.json ? newJSONOutputStream() : newTextOutputStream(opts)
+}
 
 classJSONOutputStreamextendsMinipass{
-constructor(){
-super()
-this._didFirst=false
-}
+ #didFirst =false
 
 write(obj){
-if(!this._didFirst){
+if(!this.#didFirst){
 super.write('[\n')
-this._didFirst=true
+this.#didFirst=true
 }else{
 super.write('\n,\n')
 }
 
-try{
-returnsuper.write(JSON.stringify(obj))
-}catch(er){
-returnthis.emit('error',er)
-}
+returnsuper.write(JSON.stringify(obj))
 }
 
 end(){
-super.write(this._didFirst ? ']\n' : '\n[]\n')
+super.write(this.#didFirst ? ']\n' : '\n[]\n')
 super.end()
 }
 }
@@ -61,22 +52,22 @@ class TextOutputStream extends Minipass{
 }
 
 functionprettify(data,num,opts){
-opts=opts||{}
 vartruncate=!opts.long
 
 varpkg=normalizePackage(data,opts)
 
-varcolumns=opts.description
- ? ['name','description','author','date','version','keywords']
- : ['name','author','date','version','keywords']
+varcolumns=['name','description','author','date','version','keywords']
 
 if(opts.parseable){
 returncolumns.map(function(col){
 returnpkg[col]&&(''+pkg[col]).replace(/\t/g,' ')
 }).join('\t')
 }
 
-varoutput=columnify(
+// stdout in tap is never a tty
+/* istanbul ignore next */
+constmaxWidth=process.stdout.isTTY ? process.stdout.getWindowSize()[0] : Infinity
+letoutput=columnify(
 [pkg],
 {
 include: columns,
@@ -92,8 +83,8 @@ function prettify (data, num, opts){
 keywords: {maxWidth: Infinity},
 },
 }
-)
-output=trimToMaxWidth(output)
+).split('\n').map(line=>line.slice(0,maxWidth)).join('\n')
+
 if(opts.color){
 output=highlightSearchTerms(output,opts.args)
 }
@@ -140,26 +131,6 @@ function colorize (line){
 returnline.split('\u0000').join(uncolor)
 }
 
-functiongetMaxWidth(){
-varcols
-try{
-vartty=require('tty')
-varstdout=process.stdout
-cols=!tty.isatty(stdout.fd) ? Infinity : process.stdout.getWindowSize()[0]
-cols=(cols===0) ? Infinity : cols
-}catch(ex){
-cols=Infinity
-}
-returncols
-}
-
-functiontrimToMaxWidth(str){
-varmaxWidth=getMaxWidth()
-returnstr.split('\n').map(function(line){
-returnline.slice(0,maxWidth)
-}).join('\n')
-}
-
 functionhighlightSearchTerms(str,terms){
 terms.forEach(function(arg,i){
 str=addColorMarker(str,arg,i)
@@ -169,13 +140,10 @@ function highlightSearchTerms (str, terms){
 }
 
 functionnormalizePackage(data,opts){
-opts=opts||{}
 return{
 name: data.name,
-description: opts.description ? data.description : '',
-author: (data.maintainers||[]).map(function(m){
-return'='+m.username
-}).join(' '),
+description: data.description,
+author: data.maintainers.map((m)=>`=${m.username}`).join(' '),
 keywords: Array.isArray(data.keywords)
  ? data.keywords.join(' ')
  : typeofdata.keywords==='string'

lib/utils/format-bytes.js

@@ -230,8 +230,13 @@
  ],
 "color": 1,
 "files": "test/{lib,bin,index.js}",
-"coverage-map": "test/coverage-map.js",
-"timeout": 600
+"timeout": 600,
+"nyc-arg": [
+"--exclude",
+"workspaces/**",
+"--exclude",
+"tap-snapshots/**"
+ ]
  },
 "templateOSS":{
 "rootRepo": false,