Reject annotation publish/delete without a type (RSAN1a3)

The spec requires a client-side type check so callers get 40003 instead
of a request that is missing the only required annotation field.

Author: cpruijsen

src/common/lib/client/restannotations.ts

@@ -57,6 +57,15 @@ export function constructValidateAnnotation(
   }
 
   const annotation = Annotation.fromValues(annotationValues);
+  if (!annotation.type || typeof annotation.type !== 'string') {
+    throw new ErrorInfo({
+      message: 'The annotation argument of annotations.' + methodName + '() must include a non-empty string `type`',
+      code: 40003,
+      statusCode: 400,
+      remediation:
+        'Set type on the annotation object, e.g. { type: "reaction:unique.v1", name: "👍" }. Other fields are optional.',
+    });
+  }
   annotation.messageSerial = messageSerial;
   if (!annotation.action) {
     annotation.action = 'annotation.create';

test/uts/deviations.md

@@ -86,18 +86,6 @@ These tests assert spec behavior but are skipped by default because they are kno
 
 ---
 
-### annotations: RSAN1a3 - type validation missing
-
-**Spec (RSAN1a3)**: The SDK must validate that the user supplied a `type`.
-
-**ably-js behavior**: `constructValidateAnnotation()` does not validate that `type` is present.
-
-**Tests**: `RSAN1a3 - type required` (realtime), `RTAN1a - publish validates type is required` (REST).
-
-**Issue**: [#2194](https://github.com/ably/ably-js/issues/2194)
-
----
-
 ### annotations: RSAN1c4 / RSC22d - idempotent IDs not generated
 
 **Spec (RSAN1c4)**: Annotations with empty `id` should get a generated idempotent ID. **Spec (RSC22d)**: Same for batch publish.

test/uts/realtime/unit/channels/channel_annotations.test.ts

@@ -610,10 +610,11 @@ describe('uts/realtime/unit/channels/channel_annotations', function () {
   /**
    * RTAN1a - publish validates type is required
    *
-   * Publishing an annotation without a type field should throw an error.
+   * Publishing an annotation without a type field should throw an error
+   * with code 40003.
    */
   // UTS: realtime/unit/RTAN1a/validates-type-required-1
-  it('RTAN1a - publish validates type is required (deviation: ably-js does not validate type client-side)', async function () {
+  it('RTAN1a - publish validates type is required', async function () {
     const { mock } = setupMock({
       onMessage: (msg, conn) => {
         if (msg.action === 21) {
@@ -642,22 +643,13 @@ describe('uts/realtime/unit/channels/channel_annotations', function () {
     const channel = client.channels.get('test-RTAN1a-validate', { attachOnSubscribe: false });
     await channel.attach();
 
-    // Deviation: ably-js does not validate that type is required client-side.
-    // The annotation is sent to the server without type validation.
-    if (!process.env.RUN_DEVIATIONS) {
-      this.skip();
-      return;
-    }
-
     try {
       await channel.annotations.publish('msg-serial-1', {
         name: 'like',
-        // type is missing
       } as any);
-      expect.fail('Should have thrown');
+      expect.fail('Expected publish without type to throw with code 40003');
     } catch (err: any) {
-      expect(err).to.exist;
-      expect(err.code).to.be.a('number');
+      expect(err.code).to.equal(40003);
     }
     client.close();
   });

test/uts/rest/unit/channel/annotations.test.ts

@@ -77,31 +77,18 @@ describe('uts/rest/unit/channel/annotations', function () {
    *
    * Publishing an annotation without a type field should throw an error
    * with code 40003.
-   *
-   * NOTE: ably-js does not currently validate the type field in
-   * constructValidateAnnotation(). This test documents the spec
-   * requirement (RSAN1a3) as a known deviation — the publish succeeds
-   * without a type instead of throwing.
    */
   // UTS: rest/unit/RSAN1a3/publish-type-required-0
   it('RSAN1a3 - type required', async function () {
-    // DEVIATION: see deviations.md
-    if (!process.env.RUN_DEVIATIONS) this.skip();
-    const captured: any[] = [];
     const mock = new MockHttpClient({
       onConnectionAttempt: (conn) => conn.respond_with_success(),
-      onRequest: (req) => {
-        captured.push(req);
-        req.respond_with(201, {});
-      },
+      onRequest: (req) => req.respond_with(201, {}),
     });
     installMockHttp(mock);
 
     const client = new Ably.Rest({ key: 'appId.keyId:keySecret', useBinaryProtocol: false });
     const ch = client.channels.get('test');
 
-    // Spec (RSAN1a3): publishing without a type MUST throw with code 40003.
-    // DEVIATION: ably-js does not validate type. See deviations.md.
     try {
       await ch.annotations.publish('msg-serial-1', { name: 'like' });
       expect.fail('Expected publish without type to throw with code 40003');