MatrixEvent.getRoomId() can return undefined

[jaller94]

I've lost some hours trusting the TypeScript annotation.

The return type should say string|undefined.

matrix-js-sdk/src/models/event.ts

Lines 350 to 356 in 67b8da7

	/**
	* Get the room_id for this event. This will return <code>undefined</code>
	* for <code>m.presence</code> events.
	* @return {string} The room ID, e.g. <code>!cURbafjkfsMDVwdRDQ:matrix.org
	* </code>
	*/
	public getRoomId(): string {

btw. I didn't get this on a m.presence but on a m.bad.encrypted:

MatrixEvent {
  _events: [Object: null prototype] {
    'Event.decrypted': [ [Function: forSource], [Function] ],
    'Event.replaced': [Function: forSource]
  },
  _eventsCount: 2,
  _maxListeners: undefined,
  event: {
    content: {
      algorithm: 'm.olm.v1.curve25519-aes-sha2',
      sender_key: '8LgWTZ5yFIawz80ylkAl1Mc9BX1oUZGAAAl3z0E7lXM',
      ciphertext: [Object]
    },
    type: 'm.room.encrypted',
    sender: '@jaller94:localhost'
  },
  pushActions: { notify: true, tweaks: { highlight: false } },
  _replacingEvent: null,
  _localRedactionEvent: null,
  _isCancelled: false,
  clearEvent: {
    type: 'm.room.message',
    content: {
      msgtype: 'm.bad.encrypted',
      body: '** Unable to decrypt: Not included in recipients **'
    }
  },
  senderCurve25519Key: null,
  claimedEd25519Key: null,
  forwardingCurve25519KeyChain: [],
  untrusted: false,
  _decryptionPromise: null,
  retryDecryption: false,
  txnId: null,
  thread: null,
  localTimestamp: NaN,
  sender: null,
  target: null,
  status: null,
  error: null,
  forwardLooking: true,
  verificationRequest: null,
  reEmitter: ReEmitter { target: [Circular *1] },
  [Symbol(kCapture)]: false
}

[ShadowJonathan]

This sounds more like a bug on m.bad.encrypted's side than a typescript type omission.

[jaller94]

Still, the JSDoc of the method says:

Get the room_id for this event. This will return undefined for m.presence events.