fix: make mss check logger before use (#2261)

Check logger is present before use. This should have gone out as a breaking change.
libp2p · Nov 29, 2023 · d1ee2f0 · d1ee2f0
1 parent 61eebfe
commit d1ee2f0
Show file tree

Hide file tree

Showing 6 changed files with 69 additions and 69 deletions.
diff --git a/.github/workflows/examples.yml b/.github/workflows/examples.yml
@@ -19,38 +19,38 @@ jobs:
  node-version: lts/*
  - uses: ipfs/aegir/actions/cache-node-modules@master
 
- test-examples:
- name: Test example ${{ matrix.example.name }}
- runs-on: ubuntu-latest
- needs: build
- continue-on-error: true
- strategy:
- matrix:
- example:
- - name: js-libp2p-example-chat
- repo: https:/libp2p/js-libp2p-example-chat.git
- deps:
- - '@libp2p/peer-id-factory@$PWD/packages/peer-id-factory'
- - '@libp2p/tcp@$PWD/packages/transport-tcp'
- - '@libp2p/websockets@$PWD/packages/transport-websockets'
- - 'libp2p@$PWD/packages/libp2p'
- # disabled until @libp2p/identify and @libp2p/circuit-relay are published
- # - name: js-libp2p-example-circuit-relay
- # repo: https:/libp2p/js-libp2p-example-circuit-relay.git
- # deps:
- # - '@libp2p/circuit-relay@$PWD/packages/transport-circuit-relay'
- # - '@libp2p/identify@$PWD/packages/protocol-identify'
- # - '@libp2p/websockets@$PWD/packages/transport-websockets'
- # - 'libp2p@$PWD/packages/libp2p'
- - name: js-libp2p-example-connection-encryption
- repo: https:/libp2p/js-libp2p-example-connection-encryption.git
- deps:
- - '@libp2p/tcp@$PWD/packages/transport-tcp'
- - 'libp2p@$PWD/packages/libp2p'
- steps:
- - uses: actions/checkout@v3
- - uses: actions/setup-node@v3
- with:
- node-version: lts/*
- - uses: ipfs/aegir/actions/cache-node-modules@master
- - run: npx xvfb-maybe aegir test-dependant ${{ matrix.example.repo }} --deps ${{ join(matrix.example.deps, ',') }}
+ # test-examples:
+ #  name: Test example ${{ matrix.example.name }}
+ #  runs-on: ubuntu-latest
+ #  needs: build
+ #  continue-on-error: true
+ #  strategy:
+ #  matrix:
+ #  example:
+ #  - name: js-libp2p-example-chat
+ #  repo: https:/libp2p/js-libp2p-example-chat.git
+ #  deps:
+ #  - '@libp2p/peer-id-factory@$PWD/packages/peer-id-factory'
+ #  - '@libp2p/tcp@$PWD/packages/transport-tcp'
+ #  - '@libp2p/websockets@$PWD/packages/transport-websockets'
+ #  - 'libp2p@$PWD/packages/libp2p'
+ #  # disabled until @libp2p/identify and @libp2p/circuit-relay are published
+ #  # - name: js-libp2p-example-circuit-relay
+ #  # repo: https:/libp2p/js-libp2p-example-circuit-relay.git
+ #  # deps:
+ #  # - '@libp2p/circuit-relay@$PWD/packages/transport-circuit-relay'
+ #  # - '@libp2p/identify@$PWD/packages/protocol-identify'
+ #  # - '@libp2p/websockets@$PWD/packages/transport-websockets'
+ #  # - 'libp2p@$PWD/packages/libp2p'
+ #  - name: js-libp2p-example-connection-encryption
+ #  repo: https:/libp2p/js-libp2p-example-connection-encryption.git
+ #  deps:
+ #  - '@libp2p/tcp@$PWD/packages/transport-tcp'
+ #  - 'libp2p@$PWD/packages/libp2p'
+ #  steps:
+ #  - uses: actions/checkout@v3
+ #  - uses: actions/setup-node@v3
+ #  with:
+ #  node-version: lts/*
+ #  - uses: ipfs/aegir/actions/cache-node-modules@master
+ #  - run: npx xvfb-maybe aegir test-dependant ${{ matrix.example.repo }} --deps ${{ join(matrix.example.deps, ',') }}
diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml
@@ -227,7 +227,6 @@ jobs:
  - uses: GoogleCloudPlatform/release-please-action@v2
  id: release
  with:
- token: ${{ secrets.GITHUB_TOKEN }}
  command: manifest
  release-type: node
  manifest-file: .release-please-manifest.json

diff --git a/.release-please.json b/.release-please.json
@@ -1,4 +1,5 @@
 {
+ "last-release-sha": "a7eb258e0ef2147671acba73d9febc2f882a484a",
  "plugins": ["node-workspace"],
  "group-pull-request-title-pattern": "chore: release ${component}",
  "packages": {

diff --git a/packages/multistream-select/src/handle.ts b/packages/multistream-select/src/handle.ts
@@ -55,7 +55,7 @@ import type { Duplex } from 'it-stream-types'
  */
 export async function handle <Stream extends Duplex<any, any, any>> (stream: Stream, protocols: string | string[], options: MultistreamSelectInit): Promise<ProtocolStream<Stream>> {
  protocols = Array.isArray(protocols) ? protocols : [protocols]
- options.log.trace('handle: available protocols %s', protocols)
+ options?.log?.trace('handle: available protocols %s', protocols)
 
  const lp = lpStream(stream, {
  ...options,
@@ -64,21 +64,21 @@ export async function handle <Stream extends Duplex<any, any, any>> (stream: Str
  })
 
  while (true) {
- options?.log.trace('handle: reading incoming string')
+ options?.log?.trace('handle: reading incoming string')
  const protocol = await multistream.readString(lp, options)
- options.log.trace('handle: read "%s"', protocol)
+ options?.log?.trace('handle: read "%s"', protocol)
 
  if (protocol === PROTOCOL_ID) {
- options.log.trace('handle: respond with "%s" for "%s"', PROTOCOL_ID, protocol)
+ options?.log?.trace('handle: respond with "%s" for "%s"', PROTOCOL_ID, protocol)
  await multistream.write(lp, uint8ArrayFromString(`${PROTOCOL_ID}\n`), options)
- options.log.trace('handle: responded with "%s" for "%s"', PROTOCOL_ID, protocol)
+ options?.log?.trace('handle: responded with "%s" for "%s"', PROTOCOL_ID, protocol)
  continue
  }
 
  if (protocols.includes(protocol)) {
- options.log.trace('handle: respond with "%s" for "%s"', protocol, protocol)
+ options?.log?.trace('handle: respond with "%s" for "%s"', protocol, protocol)
  await multistream.write(lp, uint8ArrayFromString(`${protocol}\n`), options)
- options.log.trace('handle: responded with "%s" for "%s"', protocol, protocol)
+ options?.log?.trace('handle: responded with "%s" for "%s"', protocol, protocol)
 
  return { stream: lp.unwrap(), protocol }
  }
@@ -90,14 +90,14 @@ export async function handle <Stream extends Duplex<any, any, any>> (stream: Str
  uint8ArrayFromString('\n')
  )
 
- options.log.trace('handle: respond with "%s" for %s', protocols, protocol)
+ options?.log?.trace('handle: respond with "%s" for %s', protocols, protocol)
  await multistream.write(lp, protos, options)
- options.log.trace('handle: responded with "%s" for %s', protocols, protocol)
+ options?.log?.trace('handle: responded with "%s" for %s', protocols, protocol)
  continue
  }
 
- options.log('handle: respond with "na" for "%s"', protocol)
+ options?.log?.('handle: respond with "na" for "%s"', protocol)
  await multistream.write(lp, uint8ArrayFromString('na\n'), options)
- options.log('handle: responded with "na" for "%s"', protocol)
+ options?.log?.('handle: responded with "na" for "%s"', protocol)
  }
 }
diff --git a/packages/multistream-select/src/multistream.ts b/packages/multistream-select/src/multistream.ts
@@ -30,7 +30,7 @@ export async function read (reader: LengthPrefixedStream<Duplex<AsyncGenerator<U
  const buf = await reader.read(options)
 
  if (buf.byteLength === 0 || buf.get(buf.byteLength - 1) !== NewLine[0]) {
- options?.log.error('Invalid mss message - missing newline', buf)
+ options?.log?.error('Invalid mss message - missing newline', buf)
  throw new CodeError('missing newline', 'ERR_INVALID_MULTISTREAM_SELECT_MESSAGE')
  }
 

diff --git a/packages/multistream-select/src/select.ts b/packages/multistream-select/src/select.ts
@@ -78,20 +78,20 @@ export async function select <Stream extends SelectStream> (stream: Stream, prot
  throw new Error('At least one protocol must be specified')
  }
 
- options?.log.trace('select: write ["%s", "%s"]', PROTOCOL_ID, protocol)
+ options?.log?.trace('select: write ["%s", "%s"]', PROTOCOL_ID, protocol)
  const p1 = uint8ArrayFromString(`${PROTOCOL_ID}\n`)
  const p2 = uint8ArrayFromString(`${protocol}\n`)
  await multistream.writeAll(lp, [p1, p2], options)
 
- options?.log.trace('select: reading multistream-select header')
+ options?.log?.trace('select: reading multistream-select header')
  let response = await multistream.readString(lp, options)
- options?.log.trace('select: read "%s"', response)
+ options?.log?.trace('select: read "%s"', response)
 
  // Read the protocol response if we got the protocolId in return
  if (response === PROTOCOL_ID) {
- options?.log.trace('select: reading protocol response')
+ options?.log?.trace('select: reading protocol response')
  response = await multistream.readString(lp, options)
- options?.log.trace('select: read "%s"', response)
+ options?.log?.trace('select: read "%s"', response)
  }
 
  // We're done
@@ -101,11 +101,11 @@ export async function select <Stream extends SelectStream> (stream: Stream, prot
 
  // We haven't gotten a valid ack, try the other protocols
  for (const protocol of protocols) {
- options?.log.trace('select: write "%s"', protocol)
+ options?.log?.trace('select: write "%s"', protocol)
  await multistream.write(lp, uint8ArrayFromString(`${protocol}\n`), options)
- options?.log.trace('select: reading protocol response')
+ options?.log?.trace('select: reading protocol response')
  const response = await multistream.readString(lp, options)
- options?.log.trace('select: read "%s" for "%s"', response, protocol)
+ options?.log?.trace('select: read "%s" for "%s"', response, protocol)
 
  if (response === protocol) {
  return { stream: lp.unwrap(), protocol }
@@ -163,7 +163,7 @@ function optimisticSelect <Stream extends SelectStream> (stream: Stream, protoco
  if (!sentProtocol) {
  sendingProtocol = true
 
- options?.log.trace('optimistic: write ["%s", "%s", data(%d)] in sink', PROTOCOL_ID, protocol, buf.byteLength)
+ options?.log?.trace('optimistic: write ["%s", "%s", data(%d)] in sink', PROTOCOL_ID, protocol, buf.byteLength)
 
  const protocolString = `${protocol}\n`
 
@@ -176,7 +176,7 @@ function optimisticSelect <Stream extends SelectStream> (stream: Stream, protoco
  buf
  ).subarray()
 
- options?.log.trace('optimistic: wrote ["%s", "%s", data(%d)] in sink', PROTOCOL_ID, protocol, buf.byteLength)
+ options?.log?.trace('optimistic: wrote ["%s", "%s", data(%d)] in sink', PROTOCOL_ID, protocol, buf.byteLength)
 
  sentProtocol = true
  sendingProtocol = false
@@ -198,7 +198,7 @@ function optimisticSelect <Stream extends SelectStream> (stream: Stream, protoco
 
  async function negotiate (): Promise<void> {
  if (negotiating) {
- options?.log.trace('optimistic: already negotiating %s stream', protocol)
+ options?.log?.trace('optimistic: already negotiating %s stream', protocol)
  await doneNegotiating.promise
  return
  }
@@ -208,13 +208,13 @@ function optimisticSelect <Stream extends SelectStream> (stream: Stream, protoco
  try {
  // we haven't sent the protocol yet, send it now
  if (!sentProtocol) {
- options?.log.trace('optimistic: doing send protocol for %s stream', protocol)
+ options?.log?.trace('optimistic: doing send protocol for %s stream', protocol)
  await doSendProtocol()
  }
 
  // if we haven't read the protocol response yet, do it now
  if (!readProtocol) {
- options?.log.trace('optimistic: doing read protocol for %s stream', protocol)
+ options?.log?.trace('optimistic: doing read protocol for %s stream', protocol)
  await doReadProtocol()
  }
  } finally {
@@ -233,12 +233,12 @@ function optimisticSelect <Stream extends SelectStream> (stream: Stream, protoco
  sendingProtocol = true
 
  try {
- options?.log.trace('optimistic: write ["%s", "%s", data] in source', PROTOCOL_ID, protocol)
+ options?.log?.trace('optimistic: write ["%s", "%s", data] in source', PROTOCOL_ID, protocol)
  await lp.writeV([
  uint8ArrayFromString(`${PROTOCOL_ID}\n`),
  uint8ArrayFromString(`${protocol}\n`)
  ])
- options?.log.trace('optimistic: wrote ["%s", "%s", data] in source', PROTOCOL_ID, protocol)
+ options?.log?.trace('optimistic: wrote ["%s", "%s", data] in source', PROTOCOL_ID, protocol)
  } finally {
  sentProtocol = true
  sendingProtocol = false
@@ -255,15 +255,15 @@ function optimisticSelect <Stream extends SelectStream> (stream: Stream, protoco
  readingProtocol = true
 
  try {
- options?.log.trace('optimistic: reading multistream select header')
+ options?.log?.trace('optimistic: reading multistream select header')
  let response = await multistream.readString(lp, options)
- options?.log.trace('optimistic: read multistream select header "%s"', response)
+ options?.log?.trace('optimistic: read multistream select header "%s"', response)
 
  if (response === PROTOCOL_ID) {
  response = await multistream.readString(lp, options)
  }
 
- options?.log.trace('optimistic: read protocol "%s", expecting "%s"', response, protocol)
+ options?.log?.trace('optimistic: read protocol "%s", expecting "%s"', response, protocol)
 
  if (response !== protocol) {
  throw new CodeError('protocol selection failed', 'ERR_UNSUPPORTED_PROTOCOL')
@@ -279,7 +279,7 @@ function optimisticSelect <Stream extends SelectStream> (stream: Stream, protoco
  // make sure we've done protocol negotiation before we read stream data
  await negotiate()
 
- options?.log.trace('optimistic: reading data from "%s" stream', protocol)
+ options?.log?.trace('optimistic: reading data from "%s" stream', protocol)
  yield * lp.unwrap().source
  })()
 
@@ -291,7 +291,7 @@ function optimisticSelect <Stream extends SelectStream> (stream: Stream, protoco
  // this before closing the readable end of the stream
  if (!negotiated) {
  await negotiate().catch(err => {
- options?.log.error('could not negotiate protocol before close read', err)
+ options?.log?.error('could not negotiate protocol before close read', err)
  })
  }
 
@@ -308,7 +308,7 @@ function optimisticSelect <Stream extends SelectStream> (stream: Stream, protoco
  // this before closing the writable end of the stream
  if (!negotiated) {
  await negotiate().catch(err => {
- options?.log.error('could not negotiate protocol before close write', err)
+ options?.log?.error('could not negotiate protocol before close write', err)
  })
  }