@juzi/wechaty-puppet-service 1.0.42 → 1.0.44

package/src/deprecated/conversation-id-file-box.spec.ts

@@ -1,131 +0,0 @@
-#!/usr/bin/env -S node --no-warnings --loader ts-node/esm
-
-/**
- *   Wechaty Chatbot SDK - https://github.com/wechaty/wechaty
- *
- *   @copyright 2016 Huan LI (李卓桓) <https://github.com/huan>, and
- *                   Wechaty Contributors <https://github.com/wechaty>.
- *
- *   Licensed under the Apache License, Version 2.0 (the "License");
- *   you may not use this file except in compliance with the License.
- *   You may obtain a copy of the License at
- *
- *       http://www.apache.org/licenses/LICENSE-2.0
- *
- *   Unless required by applicable law or agreed to in writing, software
- *   distributed under the License is distributed on an "AS IS" BASIS,
- *   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- *   See the License for the specific language governing permissions and
- *   limitations under the License.
- *
- */
-import {
-  puppet,
-}                                       from '@juzi/wechaty-grpc'
-
-import { test }         from 'tstest'
-import { PassThrough }  from 'stream'
-import { FileBox }      from 'file-box'
-
-import { nextData }     from './next-data.js'
-import {
-  packConversationIdFileBoxToPb,
-  unpackConversationIdFileBoxArgsFromPb,
-}                                         from './conversation-id-file-box.js'
-
-test('unpackConversationIdFileBoxArgsFromPb()', async t => {
-  const FILE_BOX_DATA = 'test'
-  const FILE_BOX_NAME = 'test.dat'
-  const CONVERSATION_ID = 'conversation_id'
-
-  const fileBox = FileBox.fromBuffer(
-    Buffer.from(FILE_BOX_DATA),
-    FILE_BOX_NAME,
-  )
-
-  const stream = new PassThrough({ objectMode: true })
-
-  const req1 = new puppet.MessageSendFileStreamRequest()
-  req1.setConversationId(CONVERSATION_ID)
-  stream.write(req1)
-
-  const req2 = new puppet.MessageSendFileStreamRequest()
-  const chunk1 = new puppet.FileBoxChunk()
-  chunk1.setName(fileBox.name)
-  req2.setFileBoxChunk(chunk1)
-  stream.write(req2)
-
-  const fileBoxStream = await fileBox.toStream()
-  fileBoxStream.on('data', chunk => {
-    const fileBoxChunk = new puppet.FileBoxChunk()
-    fileBoxChunk.setData(chunk)
-    const req3 = new puppet.MessageSendFileStreamRequest()
-    req3.setFileBoxChunk(fileBoxChunk)
-    stream.write(req3)
-  })
-  fileBoxStream.on('end', () => stream.end())
-
-  const args = await unpackConversationIdFileBoxArgsFromPb(stream)
-  const data = (await args.fileBox.toBuffer()).toString()
-
-  t.equal(args.conversationId, CONVERSATION_ID, 'should get conversation id')
-  t.equal(args.fileBox.name, FILE_BOX_NAME, 'should get file box name')
-  t.equal(data, FILE_BOX_DATA, 'should get file box data')
-})
-
-test('packConversationIdFileBoxToPb()', async t => {
-  const FILE_BOX_DATA = 'test'
-  const FILE_BOX_NAME = 'test.dat'
-  const CONVERSATION_ID = 'conv_id'
-
-  const fileBox = FileBox.fromBuffer(
-    Buffer.from(FILE_BOX_DATA),
-    FILE_BOX_NAME,
-  )
-
-  const stream = await packConversationIdFileBoxToPb(puppet.MessageSendFileStreamRequest)(
-    CONVERSATION_ID,
-    fileBox,
-  )
-
-  const data1 = await nextData(stream)
-  t.equal(data1.getConversationId(), CONVERSATION_ID, 'match conversation id')
-
-  const data2 = await nextData(stream)
-  t.ok(data2.hasFileBoxChunk(), 'has file box chunk')
-  t.ok(data2.getFileBoxChunk()!.hasName(), 'has file box name')
-  t.equal(data2.getFileBoxChunk()!.getName(), FILE_BOX_NAME, 'match file box name')
-
-  let data = ''
-  stream.on('data', (chunk: puppet.MessageSendFileStreamRequest) => {
-    if (!chunk.hasFileBoxChunk()) {
-      throw new Error('no file box chunk')
-    }
-    if (!chunk.getFileBoxChunk()!.hasData()) {
-      throw new Error('no file box chunk data')
-    }
-    data += chunk.getFileBoxChunk()!.getData()
-  })
-
-  await new Promise(resolve => stream.on('end', resolve))
-
-  t.equal(data.toString(), FILE_BOX_DATA, 'should get file box data')
-})
-
-test('unpackConversationIdFileBoxArgsFromPb() <-> packConversationIdFileBoxToPb()', async t => {
-  const FILE_BOX_DATA = 'test'
-  const FILE_BOX_NAME = 'test.dat'
-  const CONVERSATION_ID = 'conv_id'
-
-  const fileBox = FileBox.fromBuffer(
-    Buffer.from(FILE_BOX_DATA),
-    FILE_BOX_NAME,
-  )
-
-  const stream = await packConversationIdFileBoxToPb(puppet.MessageSendFileStreamRequest)(CONVERSATION_ID, fileBox)
-  const args = await unpackConversationIdFileBoxArgsFromPb(stream)
-
-  t.equal(args.conversationId, CONVERSATION_ID, 'should match conversation id')
-  t.equal(args.fileBox.name, FILE_BOX_NAME, 'should be same name')
-  t.equal((await args.fileBox.toBuffer()).toString(), FILE_BOX_DATA, 'should be same content')
-})

package/src/deprecated/conversation-id-file-box.ts

@@ -1,72 +0,0 @@
-import type {
-  FileBoxInterface,
-}                               from 'file-box'
-import { PassThrough }          from 'stream'
-import type { Readable }             from 'stronger-typed-streams'
-
-import { nextData }                 from './next-data.js'
-import {
-  packFileBoxToPb,
-  unpackFileBoxFromPb,
-}                                  from './file-box-pb.js'
-import type { ConversationIdFileBoxPb } from './file-box-pb.type.js'
-
-interface ConversationIdFileBoxArgs {
-  conversationId: string,
-  fileBox: FileBoxInterface,
-}
-
-/**
- * MessageSendFileStreamRequest to Args
- * @deprecated Will be removed after Dec 31, 2022
- */
-async function unpackConversationIdFileBoxArgsFromPb (
-  stream: Readable<ConversationIdFileBoxPb>,
-): Promise<ConversationIdFileBoxArgs> {
-  const chunk = await nextData(stream)
-  if (!chunk.hasConversationId()) {
-    throw new Error('no conversation id')
-  }
-  const conversationId = chunk.getConversationId()
-
-  // unpackFileBoxFromChunk(unpackFileBoxChunkFromPb(stream))
-  const fileBox = await unpackFileBoxFromPb(stream)
-
-  return {
-    conversationId,
-    fileBox,
-  }
-}
-
-/**
- * Args to MessageSendFileStreamRequest
- * @deprecated Will be removed after Dec 31, 2022
- */
-function packConversationIdFileBoxToPb<T extends ConversationIdFileBoxPb> (
-  PbConstructor: { new(): T },
-) {
-  return async (
-    conversationId: string,
-    fileBox:        FileBoxInterface,
-  ): Promise<
-    Readable<T>
-  > => {
-    const stream = new PassThrough({ objectMode: true })
-
-    const first = new PbConstructor()
-    first.setConversationId(conversationId)
-    stream.write(first)
-
-    // const fileBoxChunkStream = await packFileBoxToChunk(fileBox)
-    // packFileBoxChunkToPb(MessageSendFileStreamRequest)(fileBoxChunkStream)
-    const pbStream = await packFileBoxToPb(PbConstructor)(fileBox)
-    pbStream.pipe(stream)
-
-    return stream
-  }
-}
-
-export {
-  unpackConversationIdFileBoxArgsFromPb,
-  packConversationIdFileBoxToPb,
-}

package/src/deprecated/file-box-chunk.spec.ts

@@ -1,184 +0,0 @@
-#!/usr/bin/env -S node --no-warnings --loader ts-node/esm
-
-/**
- *   Wechaty Chatbot SDK - https://github.com/wechaty/wechaty
- *
- *   @copyright 2016 Huan LI (李卓桓) <https://github.com/huan>, and
- *                   Wechaty Contributors <https://github.com/wechaty>.
- *
- *   Licensed under the Apache License, Version 2.0 (the "License");
- *   you may not use this file except in compliance with the License.
- *   You may obtain a copy of the License at
- *
- *       http://www.apache.org/licenses/LICENSE-2.0
- *
- *   Unless required by applicable law or agreed to in writing, software
- *   distributed under the License is distributed on an "AS IS" BASIS,
- *   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- *   See the License for the specific language governing permissions and
- *   limitations under the License.
- *
- */
-import { test } from 'tstest'
-
-import { PassThrough }  from 'stream'
-import type { Duplex }       from 'stronger-typed-streams'
-import { FileBox }      from 'file-box'
-
-import {
-  puppet,
-}                 from '@juzi/wechaty-grpc'
-
-import {
-  unpackFileBoxFromChunk,
-  packFileBoxToChunk,
-}                         from './file-box-chunk.js'
-import { nextData }       from './next-data.js'
-
-test('unpackFileBoxFromChunk()', async t => {
-  const FILE_BOX_DATA = 'test'
-  const FILE_BOX_NAME = 'test.dat'
-
-  const stream = await getFileBoxStreamStub(FILE_BOX_DATA, FILE_BOX_NAME)
-
-  const decodedFileBox = await unpackFileBoxFromChunk(stream)
-  const data = (await decodedFileBox.toBuffer()).toString()
-
-  t.equal(decodedFileBox.name, FILE_BOX_NAME, 'should get file box name')
-  t.equal(data, FILE_BOX_DATA, 'should get file box data')
-
-})
-
-test('packFileBoxToChunk()', async t => {
-  const FILE_BOX_DATA = 'test'
-  const FILE_BOX_NAME = 'test.dat'
-
-  const fileBox = FileBox.fromBuffer(
-    Buffer.from(FILE_BOX_DATA),
-    FILE_BOX_NAME,
-  )
-
-  const stream = await packFileBoxToChunk(fileBox)
-
-  const fileBoxChunk = await nextData(stream)
-  t.ok(fileBoxChunk.hasName(), 'has name')
-
-  const fileName = fileBoxChunk.getName()
-  t.equal(fileName, FILE_BOX_NAME, 'should get name')
-
-  let data = ''
-  stream.on('data', (chunk: puppet.FileBoxChunk) => {
-    if (!chunk.hasData()) {
-      throw new Error('no data')
-    }
-    data += chunk.getData()
-  })
-
-  await new Promise(resolve => stream.on('end', resolve))
-
-  t.equal(data, FILE_BOX_DATA, 'should get file box data')
-})
-
-test('packFileBoxToChunk() <-> unpackFileBoxFromChunk()', async t => {
-  const FILE_BOX_DATA = 'test'
-  const FILE_BOX_NAME = 'test.dat'
-
-  const fileBox = FileBox.fromBuffer(
-    Buffer.from(FILE_BOX_DATA),
-    FILE_BOX_NAME,
-  )
-
-  const stream = await packFileBoxToChunk(fileBox)
-  const restoredBox = await unpackFileBoxFromChunk(stream)
-
-  t.equal(fileBox.name, restoredBox.name, 'should be same name')
-  t.equal(await fileBox.toBase64(), await restoredBox.toBase64(), 'should be same content')
-})
-
-test('should handle no name error in catch', async t => {
-  t.plan(1)
-  const FILE_BOX_DATA = 'test'
-  const FILE_BOX_NAME = 'test.dat'
-
-  const stream = await getFileBoxStreamStub(FILE_BOX_DATA, FILE_BOX_NAME, true)
-
-  try {
-    await unpackFileBoxFromChunk(stream)
-  } catch (e) {
-    t.equal((e as Error).message, 'no name')
-  }
-})
-
-test('should handle first error catch', async t => {
-  t.plan(1)
-  const FILE_BOX_DATA = 'test'
-  const FILE_BOX_NAME = 'test.dat'
-
-  const stream = await getFileBoxStreamStub(FILE_BOX_DATA, FILE_BOX_NAME, false, true)
-
-  try {
-    await unpackFileBoxFromChunk(stream)
-  } catch (e) {
-    t.equal((e as Error).message, 'first exception')
-  }
-})
-
-test('should handle middle error in further ops', async t => {
-  t.plan(1)
-  const FILE_BOX_DATA = 'test'
-  const FILE_BOX_NAME = 'test.dat'
-
-  const stream = await getFileBoxStreamStub(FILE_BOX_DATA, FILE_BOX_NAME, false, false, true)
-
-  const fileBox = await unpackFileBoxFromChunk(stream)
-  try {
-    await fileBox.toBuffer()
-  } catch (e) {
-    t.equal((e as Error).message, 'middle exception')
-  }
-})
-
-async function getFileBoxStreamStub (
-  data: string,
-  name: string,
-  noname = false,
-  firstException = false,
-  middleException = false,
-) {
-  const fileBox = FileBox.fromBuffer(
-    Buffer.from(data),
-    name,
-  )
-
-  const stream: Duplex<puppet.FileBoxChunk, puppet.FileBoxChunk> = new PassThrough({ objectMode: true })
-
-  if (firstException) {
-    stream.pause()
-    setImmediate(() => {
-      stream.emit('error', new Error('first exception'))
-      stream.resume()
-    })
-  } else {
-    const chunk1 = new puppet.FileBoxChunk()
-    if (!noname) {
-      chunk1.setName(fileBox.name)
-    }
-    setTimeout(() => stream.write(chunk1), 10)
-  }
-
-  if (middleException) {
-    setTimeout(() => {
-      stream.emit('error', new Error('middle exception'))
-    }, 100)
-  }
-
-  const fileBoxStream = await fileBox.toStream()
-  fileBoxStream.on('data', chunk => {
-    const fileBoxChunk = new puppet.FileBoxChunk()
-    fileBoxChunk.setData(chunk)
-    setTimeout(() => stream.write(fileBoxChunk), 200)
-  })
-  fileBoxStream.on('end', () => setTimeout(() => stream.end(), 250))
-
-  return stream
-}

package/src/deprecated/file-box-chunk.ts

@@ -1,87 +0,0 @@
-import { FileBox }      from 'file-box'
-import type { FileBoxInterface } from 'file-box'
-import { PassThrough }  from 'stream'
-import {
-  Readable,
-  Transform,
-}                       from 'stronger-typed-streams'
-
-import { puppet } from '@juzi/wechaty-grpc'
-
-import { nextData } from './next-data.js'
-
-/**
- * @deprecated Will be removed after Dec 31, 2022
- */
-const decoder = () => new Transform<puppet.FileBoxChunk, any>({
-  objectMode: true,
-  transform: (chunk: puppet.FileBoxChunk, _: any, callback: any) => {
-    if (!chunk.hasData()) {
-      callback(new Error('no data'))
-      return
-    }
-    const data = chunk.getData()
-    callback(null, data)
-  },
-})
-
-/**
- * @deprecated Will be removed after Dec 31, 2022
- */
-async function unpackFileBoxFromChunk (
-  stream: Readable<puppet.FileBoxChunk>,
-): Promise<FileBox> {
-  const chunk = await nextData(stream)
-  if (!chunk.hasName()) {
-    throw new Error('no name')
-  }
-  const fileName = chunk.getName()
-
-  const fileStream = new PassThrough({ objectMode: true })
-  const transformedStream = stream.pipe(decoder())
-  transformedStream.pipe(fileStream)
-  stream.on('error', e => fileStream.emit('error', e))
-  transformedStream.on('error', e => fileStream.emit('error', e))
-
-  const fileBox = FileBox.fromStream(fileStream, fileName)
-
-  return fileBox
-}
-
-/**
- * @deprecated Will be removed after Dec 31, 2022
- */
-const encoder = () => new Transform<any, puppet.FileBoxChunk>({
-  objectMode: true,
-  transform: (chunk: any, _: any, callback: any) => {
-    const fileBoxChunk = new puppet.FileBoxChunk()
-    fileBoxChunk.setData(chunk)
-    callback(null, fileBoxChunk)
-  },
-})
-
-/**
- * @deprecated Will be removed after Dec 31, 2022
- */
-async function packFileBoxToChunk (
-  fileBox: FileBoxInterface,
-): Promise<Readable<puppet.FileBoxChunk>> {
-  const stream = new PassThrough({ objectMode: true })
-
-  const chunk = new puppet.FileBoxChunk()
-  chunk.setName(fileBox.name)
-
-  // FIXME: Huan(202010) write might return false
-  stream.write(chunk)
-
-  fileBox
-    .pipe(encoder())
-    .pipe(stream)
-
-  return stream
-}
-
-export {
-  unpackFileBoxFromChunk,
-  packFileBoxToChunk,
-}

package/src/deprecated/file-box-pb.spec.ts

@@ -1,31 +0,0 @@
-#!/usr/bin/env -S node --no-warnings --loader ts-node/esm
-
-import { test } from 'tstest'
-
-import { FileBox } from 'file-box'
-
-import {
-  puppet,
-}                                 from '@juzi/wechaty-grpc'
-
-import {
-  packFileBoxToPb,
-  unpackFileBoxFromPb,
-}                             from './file-box-pb.js'
-
-test('packFileBoxToPb()', async t => {
-  const FILE_BOX_DATA = 'test'
-  const FILE_BOX_NAME = 'test.dat'
-
-  const fileBox = FileBox.fromBuffer(
-    Buffer.from(FILE_BOX_DATA),
-    FILE_BOX_NAME,
-  )
-
-  const pb = await packFileBoxToPb(puppet.MessageFileStreamResponse)(fileBox)
-  const restoredFileBox = await unpackFileBoxFromPb(pb)
-  t.ok(restoredFileBox instanceof FileBox, 'should get an instance of FileBOX')
-
-  t.equal(restoredFileBox.name, fileBox.name, 'should get the right file box name')
-  t.equal(await restoredFileBox.toBase64(), await fileBox.toBase64(), 'should get the right file box content')
-})

package/src/deprecated/file-box-pb.ts

@@ -1,41 +0,0 @@
-import type { FileBoxInterface }      from 'file-box'
-import type { Readable }     from 'stronger-typed-streams'
-
-import {
-  packFileBoxToChunk,
-  unpackFileBoxFromChunk,
-}                           from './file-box-chunk.js'
-import {
-  packFileBoxChunkToPb,
-  unpackFileBoxChunkFromPb,
-}                           from './chunk-pb.js'
-import type { FileBoxPb }        from './file-box-pb.type.js'
-
-/**
- * @deprecated Will be removed after Dec 31, 2022
- */
-function packFileBoxToPb<T extends FileBoxPb> (
-  PbConstructor: { new(): T },
-) {
-  return async (fileBox: FileBoxInterface) => {
-    const fileBoxChunkStream = await packFileBoxToChunk(fileBox)
-    const pbFileBox = packFileBoxChunkToPb(PbConstructor)(fileBoxChunkStream)
-    return pbFileBox
-  }
-}
-
-/**
- * @deprecated Will be removed after Dec 31, 2022
- */
-async function unpackFileBoxFromPb<T extends FileBoxPb> (
-  pbStream: Readable<T>,
-): Promise<FileBoxInterface> {
-  const fileBoxChunkStream = unpackFileBoxChunkFromPb(pbStream)
-  const fileBox = await unpackFileBoxFromChunk(fileBoxChunkStream)
-  return fileBox
-}
-
-export {
-  packFileBoxToPb,
-  unpackFileBoxFromPb,
-}

package/src/deprecated/file-box-pb.type.ts

@@ -1,16 +0,0 @@
-import type { puppet } from '@juzi/wechaty-grpc'
-
-/**
- * Any Protocol Buffer message that include a FileBoxChunk
- */
-export interface FileBoxPb {
-  hasFileBoxChunk(): boolean
-  getFileBoxChunk(): puppet.FileBoxChunk | undefined
-  setFileBoxChunk(value?: puppet.FileBoxChunk): void
-}
-
-export interface ConversationIdFileBoxPb extends FileBoxPb {
-  hasConversationId(): boolean
-  getConversationId(): string
-  setConversationId(value: string): void
-}

package/src/deprecated/mod.ts

@@ -1,8 +0,0 @@
-export {
-  packConversationIdFileBoxToPb,
-  unpackConversationIdFileBoxArgsFromPb,
-}                                         from './conversation-id-file-box.js'
-export {
-  packFileBoxToPb,
-  unpackFileBoxFromPb,
-}                                         from './file-box-pb.js'

package/src/deprecated/next-data.ts

@@ -1,35 +0,0 @@
-import type {
-  Readable,
-}           from 'stronger-typed-streams'
-
-/**
- * windmemory(20201027): generating fileBox data in server side might take longer.
- * Set to 60 sec to avoid unexpected timeout.
- */
-const TIMEOUT = 60 * 1000
-
-/**
- * @deprecated Will be removed after Dec 31, 2022
- */
-async function nextData<T> (
-  stream: Readable<T>,
-): Promise<T> {
-  const chunk = await new Promise<T>((resolve, reject) => {
-    const timer = setTimeout(reject, TIMEOUT)
-    stream.once('data', chunk => {
-      stream.pause()
-      clearTimeout(timer)
-
-      resolve(chunk)
-    })
-    stream.once('error', reject)
-
-  })
-
-  stream.resume()
-  return chunk
-}
-
-export {
-  nextData,
-}

package/src/deprecated/serialize-file-box.ts

@@ -1,24 +0,0 @@
-import {
-  FileBox,
-  FileBoxType,
-}                     from 'file-box'
-import type {
-  FileBoxInterface,
-}                     from 'file-box'
-
-/**
- * @deprecated Will be removed after Dec 31, 2022
- */
-export const serializeFileBox = async (fileBox: FileBoxInterface): Promise<string> => {
-  const serializableFileBoxTypes = [
-    FileBoxType.Base64,
-    FileBoxType.Url,
-    FileBoxType.QRCode,
-  ]
-  if (serializableFileBoxTypes.includes(fileBox.type)) {
-    return JSON.stringify(fileBox)
-  }
-  const base64 = await fileBox.toBase64()
-  const name = fileBox.name
-  return JSON.stringify(FileBox.fromBase64(base64, name))
-}