wb-revisions: accept ids on stdin

Author: maxlath

bin/wb-revisions.js

@@ -9,6 +9,8 @@ import { get } from '#lib/request'
 import { isPositiveIntegerString } from '#lib/types'
 import { getWbk } from '#lib/wbk'
 
+program.acceptsArgsOnStdin = true
+
 await program
 .option('-s, --start <date>', 'start date')
 .option('-e, --end <date>', 'end date')
@@ -20,49 +22,60 @@ exitOnMissingInstance(program.instance)
 
 const { getRevisions } = getWbk(program)
 
-// Not parsing the ids with ../lib/tolerant_id_parser as that would
-// remove prefixes which are required for entities out of the main namespace
-// Ex: Property:P570
-const ids = program.args
-if (!(ids && ids.length > 0)) program.helpAndExit(0)
-
-ids.forEach(id => {
-  let [ prefix, entityId ] = id.split(':')
-  if (entityId) {
-    if (prefix !== 'Property' && prefix !== 'Item') {
-      throw new Error(`invalid entity prefix: ${prefix}`)
+function fetchAndLogRevisions (ids) {
+  ids.forEach(id => {
+    let [ prefix, entityId ] = id.split(':')
+    if (entityId) {
+      if (prefix !== 'Property' && prefix !== 'Item') {
+        throw new Error(`invalid entity prefix: ${prefix}`)
+      }
+    } else {
+      entityId = prefix
     }
-  } else {
-    entityId = prefix
-  }
-  if (!isEntityId(entityId)) throw new Error(`invalid entity id: ${id}`)
-})
+    if (!isEntityId(entityId)) throw new Error(`invalid entity id: ${id}`)
+  })
 
-const query = {}
-let { start, end, limit, props, verbose } = program
-if (isPositiveIntegerString(start)) start = parseInt(start)
-if (isPositiveIntegerString(end)) end = parseInt(end)
+  const query = {}
+  let { start, end, limit, props, verbose } = program
+  if (isPositiveIntegerString(start)) start = parseInt(start)
+  if (isPositiveIntegerString(end)) end = parseInt(end)
 
-query.start = start
-query.end = end
-query.limit = limit
-if (props) query.prop = props?.split(',')
+  query.start = start
+  query.end = end
+  query.limit = limit
+  if (props) query.prop = props?.split(/[,|]/)
 
-const getAndLogRevisions = id => {
-  const url = getRevisions({ ids: [ id ], ...query })
-  if (verbose) console.log(`revision query: ${id}`, url)
-  return get(url)
-  .then(body => values(body.query.pages)[0])
+  const getAndLogRevisions = id => {
+    const url = getRevisions({ ids: [ id ], ...query })
+    if (verbose) console.log(`revision query: ${id}`, url)
+    return get(url)
+    .then(body => values(body.query.pages)[0])
+  }
+
+  if (ids.length === 1) {
+    getAndLogRevisions(ids[0])
+    .then(data => console.log(JSON.stringify(data)))
+    .catch(errors_.exit)
+  } else {
+    // Getting revisisions data individually to be able to pass parameters
+    // cf https://github.com/maxlath/wikibase-sdk/blob/master/docs/get_revisions.md
+    Promise.all(ids.map(getAndLogRevisions))
+    .then(logNdjson)
+    .catch(errors_.exit)
+  }
 }
 
-if (ids.length === 1) {
-  getAndLogRevisions(ids[0])
-  .then(data => console.log(JSON.stringify(data)))
-  .catch(errors_.exit)
+// process.stdin.isTTY will be undefined if the process is receiving
+// its stdin from another process
+if (program.args.length === 0 && process.stdin.isTTY) {
+  program.helpAndExit(0)
+} else if (program.args.length > 0) {
+  // Not parsing the ids with ../lib/tolerant_id_parser as that would
+  // remove prefixes which are required for entities out of the main namespace
+  // Ex: Property:P570
+  const ids = program.args
+  fetchAndLogRevisions(ids)
 } else {
-  // Getting revisisions data individually to be able to pass parameters
-  // cf https://github.com/maxlath/wikibase-sdk/blob/master/docs/get_revisions.md
-  Promise.all(ids.map(getAndLogRevisions))
-  .then(logNdjson)
-  .catch(errors_.exit)
+  const { readIdsFromStdin } = await import('#lib/read_ids_from_stdin')
+  readIdsFromStdin(fetchAndLogRevisions)
 }

docs/read_operations.md

@@ -545,6 +545,12 @@ wb r <entities ids>
 ```sh
 wd revisions Q3548931
 wd r Q3548931
+wd r Property:P31
+
+# The requested ids can also be passed from stdin
+echo 'Q1032158
+Q2665313
+Q5420639' | wd r
 ```
 
 Options:

lib/read_ids_from_stdin.js

@@ -1,12 +1,15 @@
 import split from 'split'
 import through from 'through'
+import program from '#lib/program'
 
 let ids = []
 
 export function readIdsFromStdin (handleIdsBatch) {
-  const write = function (id) {
+  let count = 0
+  async function write (id) {
     id = id.trim()
     if (id === '') return
+    count++
     ids.push(id)
     if (ids.length < 50) return
 
@@ -15,18 +18,23 @@ export function readIdsFromStdin (handleIdsBatch) {
     const batch = ids
     ids = []
 
-    handleIdsBatch(batch)
-    .then(() => this.resume())
+    await handleIdsBatch(batch)
+    this.resume()
   }
 
-  const end = function () {
+  async function end () {
+    if (count === 0) program.helpAndExit(0)
     if (ids.length === 0) return this.emit('end')
-    handleIdsBatch(ids)
-    .then(this.emit.bind(this, 'end'))
+    await handleIdsBatch(ids)
+    this.emit('end')
   }
 
   process.stdin
   .pipe(split(/\s/))
   .pipe(through(write, end))
   .on('error', console.error)
+
+  setTimeout(() => {
+    if (count === 0) program.helpAndExit(0)
+  }, 500)
 }

test/wb-data.js

@@ -5,14 +5,10 @@ import { shellExec, wdTest } from '#test/lib/utils'
 const attributes = [ 'pageid', 'ns', 'title', 'lastrevid', 'modified', 'type', 'id', 'labels', 'descriptions', 'aliases', 'claims', 'sitelinks' ]
 
 describe('wb data', () => {
-  // This test fails when run from a script as process.stdin.isTTY is undefined
-  // and the script thus will listen for stdin. But it works when run manually,
-  // and no other way to detect a stdin input was found
-
-  // it('should display help', async () => {
-  //   const { stdout } = await shellExec('./bin/wd.js data')
-  //   stdout.should.containEql('Usage:')
-  // })
+  it('should display help', async () => {
+    const { stdout } = await shellExec('./bin/wd.js data')
+    stdout.should.containEql('Usage:')
+  })
 
   it('<entity>', async () => {
     const { stdout } = await shellExec('./bin/wd.js data Q123456')

test/wb-revisions.js

@@ -6,4 +6,20 @@ describe('wb revisions', () => {
     const { stdout } = await shellExec('./bin/wb.js revisions')
     stdout.should.containEql('Usage:')
   })
+
+  it('should accept ids as arguments', async () => {
+    const { stdout } = await shellExec('./bin/wd.js revisions -n 2 Q66636975')
+    const lines = stdout.split('\n')
+    lines.length.should.equal(1)
+    const history = JSON.parse(lines)
+    history.revisions.length.should.equal(2)
+  })
+
+  it('should accept ids on stdin', async () => {
+    const { stdout } = await shellExec('echo Q66636975 | ./bin/wd.js revisions -n 2')
+    const lines = stdout.split('\n')
+    lines.length.should.equal(1)
+    const history = JSON.parse(lines)
+    history.revisions.length.should.equal(2)
+  })
 })