rip out records subscribe

build/compile-validators.js

@@ -45,7 +45,6 @@ import RecordsDelete from '../json-schemas/interface-methods/records-delete.json
 import RecordsFilter from '../json-schemas/interface-methods/records-filter.json' assert { type: 'json' };
 import RecordsQuery from '../json-schemas/interface-methods/records-query.json' assert { type: 'json' };
 import RecordsRead from '../json-schemas/interface-methods/records-read.json' assert { type: 'json' };
-import RecordsSubscribe from '../json-schemas/interface-methods/records-subscribe.json' assert { type: 'json' };
 import RecordsWrite from '../json-schemas/interface-methods/records-write.json' assert { type: 'json' };
 import RecordsWriteSignaturePayload from '../json-schemas/signature-payloads/records-write-signature-payload.json' assert { type: 'json' };
 import RecordsWriteUnidentified from '../json-schemas/interface-methods/records-write-unidentified.json' assert { type: 'json' };
@@ -56,7 +55,6 @@ const schemas = {
   AuthorizationOwner,
   RecordsDelete,
   RecordsQuery,
-  RecordsSubscribe,
   RecordsWrite,
   RecordsWriteUnidentified,
   EventsFilter,

json-schemas/interface-methods/protocol-rule-set.json

@@ -66,7 +66,6 @@
                 "enum": [
                   "delete",
                   "query",
-                  "subscribe",
                   "read",
                   "update",
                   "write"

json-schemas/permissions/permissions-definitions.json

@@ -28,9 +28,6 @@
         },
         {
           "$ref": "https://identity.foundation/dwn/json-schemas/permissions/scopes.json#/definitions/records-query-scope"
-        },
-        {
-          "$ref": "https://identity.foundation/dwn/json-schemas/permissions/scopes.json#/definitions/records-subscribe-scope"
         }
       ]
     },

json-schemas/permissions/scopes.json

@@ -106,24 +106,6 @@
           "type": "string"
         }
       }
-    },
-    "records-subscribe-scope": {
-      "type": "object",
-      "required": [
-        "interface",
-        "method"
-      ],
-      "properties": {
-        "interface": {
-          "const": "Records"
-        },
-        "method": {
-          "const": "Subscribe"
-        },
-        "protocol": {
-          "type": "string"
-        }
-      }
     }
   }
 }

src/core/dwn-error.ts

@@ -101,9 +101,6 @@ export enum DwnErrorCode {
   RecordsQueryFilterMissingRequiredProperties = 'RecordsQueryFilterMissingRequiredProperties',
   RecordsReadReturnedMultiple = 'RecordsReadReturnedMultiple',
   RecordsReadAuthorizationFailed = 'RecordsReadAuthorizationFailed',
-  RecordsSubscribeFilterMissingRequiredProperties = 'RecordsSubscribeFilterMissingRequiredProperties',
-  RecordsSubscribeUnauthorized = 'RecordsSubscribeUnauthorized',
-  RecordsSubscribeUnknownError = 'RecordsSubscribeUnknownError',
   RecordsSchemasDerivationSchemeMissingSchema = 'RecordsSchemasDerivationSchemeMissingSchema',
   RecordsValidateIntegrityDelegatedGrantAndIdExistenceMismatch = 'RecordsValidateIntegrityDelegatedGrantAndIdExistenceMismatch',
   RecordsValidateIntegrityGrantedToAndSignerMismatch = 'RecordsValidateIntegrityGrantedToAndSignerMismatch',

src/core/protocol-authorization.ts

@@ -3,7 +3,6 @@ import type { MessageStore } from '../types/message-store.js';
 import type { RecordsDelete } from '../interfaces/records-delete.js';
 import type { RecordsQuery } from '../interfaces/records-query.js';
 import type { RecordsRead } from '../interfaces/records-read.js';
-import type { RecordsSubscribe } from '../interfaces/records-subscribe.js';
 import type { RecordsWriteMessage } from '../types/records-types.js';
 import type { ProtocolActionRule, ProtocolDefinition, ProtocolRuleSet, ProtocolsConfigureMessage, ProtocolType, ProtocolTypes } from '../types/protocols-types.js';
 
@@ -153,47 +152,6 @@ export class ProtocolAuthorization {
     );
   }
 
-  public static async authorizeSubscription(
-    tenant: string,
-    incomingMessage: RecordsSubscribe,
-    messageStore: MessageStore,
-  ): Promise<void> {
-    // validate that required properties exist in subscription filter
-    const { protocol, protocolPath, contextId } = incomingMessage.message.descriptor.filter;
-
-    // fetch the protocol definition
-    const protocolDefinition = await ProtocolAuthorization.fetchProtocolDefinition(
-      tenant,
-      protocol!, // `authorizeSubscription` is only called if `protocol` is present
-      messageStore,
-    );
-
-    // get the rule set for the inbound message
-    const inboundMessageRuleSet = ProtocolAuthorization.getRuleSet(
-      protocolPath!, // presence of `protocolPath` is verified in `parse()`
-      protocolDefinition,
-    );
-
-    // If the incoming message has `protocolRole` in the descriptor, validate the invoked role
-    await ProtocolAuthorization.verifyInvokedRole(
-      tenant,
-      incomingMessage,
-      protocol!,
-      contextId,
-      protocolDefinition,
-      messageStore,
-    );
-
-    // verify method invoked against the allowed actions
-    await ProtocolAuthorization.verifyAllowedActions(
-      tenant,
-      incomingMessage,
-      inboundMessageRuleSet,
-      [], // ancestor chain is not relevant to subscriptions
-      messageStore,
-    );
-  }
-
   /**
    * Performs protocol-based authorization against the incoming RecordsQuery message.
    * @throws {Error} if authorization fails.
@@ -465,7 +423,7 @@ export class ProtocolAuthorization {
    */
   private static async verifyInvokedRole(
     tenant: string,
-    incomingMessage: RecordsDelete | RecordsQuery | RecordsRead | RecordsSubscribe | RecordsWrite,
+    incomingMessage: RecordsDelete | RecordsQuery | RecordsRead | RecordsWrite,
     protocolUri: string,
     contextId: string | undefined,
     protocolDefinition: ProtocolDefinition,
@@ -523,7 +481,7 @@ export class ProtocolAuthorization {
    */
   private static async getActionsSeekingARuleMatch(
     tenant: string,
-    incomingMessage: RecordsDelete | RecordsQuery | RecordsRead | RecordsSubscribe | RecordsWrite,
+    incomingMessage: RecordsDelete | RecordsQuery | RecordsRead | RecordsWrite,
     messageStore: MessageStore,
   ): Promise<ProtocolAction[]> {
 
@@ -537,9 +495,6 @@ export class ProtocolAuthorization {
     case DwnMethodName.Read:
       return [ProtocolAction.Read];
 
-    case DwnMethodName.Subscribe:
-      return [ProtocolAction.Subscribe];
-
     case DwnMethodName.Write:
       const incomingRecordsWrite = incomingMessage as RecordsWrite;
       if (await incomingRecordsWrite.isInitialWrite()) {
@@ -564,7 +519,7 @@ export class ProtocolAuthorization {
    */
   private static async verifyAllowedActions(
     tenant: string,
-    incomingMessage: RecordsDelete | RecordsQuery | RecordsRead | RecordsSubscribe | RecordsWrite,
+    incomingMessage: RecordsDelete | RecordsQuery | RecordsRead | RecordsWrite,
     inboundMessageRuleSet: ProtocolRuleSet,
     ancestorMessageChain: RecordsWriteMessage[],
     messageStore: MessageStore,

src/core/records-grant-authorization.ts

@@ -1,7 +1,7 @@
 import type { MessageStore } from '../types/message-store.js';
 import type { RecordsPermissionScope } from '../types/permissions-grant-descriptor.js';
 import type { PermissionsGrantMessage, RecordsPermissionsGrantMessage } from '../types/permissions-types.js';
-import type { RecordsDeleteMessage, RecordsQueryMessage, RecordsReadMessage, RecordsSubscribeMessage, RecordsWriteMessage } from '../types/records-types.js';
+import type { RecordsDeleteMessage, RecordsQueryMessage, RecordsReadMessage, RecordsWriteMessage } from '../types/records-types.js';
 
 import { GrantAuthorization } from './grant-authorization.js';
 import { PermissionsConditionPublication } from '../types/permissions-grant-descriptor.js';
@@ -96,40 +96,6 @@ export class RecordsGrantAuthorization {
     }
   }
 
-  /**
-   * Authorizes the scope of a PermissionsGrant for RecordsSubscribe.
-   * @param messageStore Used to check if the grant has been revoked.
-   */
-  public static async authorizeSubscribe(input: {
-    recordsSubscribeMessage: RecordsSubscribeMessage,
-    expectedGrantedToInGrant: string,
-    expectedGrantedForInGrant: string,
-    permissionsGrantMessage: PermissionsGrantMessage,
-    messageStore: MessageStore,
-  }): Promise<void> {
-    const {
-      recordsSubscribeMessage, expectedGrantedToInGrant, expectedGrantedForInGrant, permissionsGrantMessage, messageStore
-    } = input;
-
-    await GrantAuthorization.performBaseValidation({
-      incomingMessage: recordsSubscribeMessage,
-      expectedGrantedToInGrant,
-      expectedGrantedForInGrant,
-      permissionsGrantMessage,
-      messageStore
-    });
-
-    // If the grant specifies a protocol, the query must specify the same protocol.
-    const protocolInGrant = (permissionsGrantMessage.descriptor.scope as RecordsPermissionScope).protocol;
-    const protocolInSubscribe = recordsSubscribeMessage.descriptor.filter.protocol;
-    if (protocolInGrant !== undefined && protocolInSubscribe !== protocolInGrant) {
-      throw new DwnError(
-        DwnErrorCode.RecordsGrantAuthorizationSubscribeProtocolScopeMismatch,
-        `Grant protocol scope ${protocolInGrant} does not match protocol in subscribe ${protocolInSubscribe}`
-      );
-    }
-  }
-
   /**
    * Authorizes the scope of a PermissionsGrant for RecordsDelete.
    * @param messageStore Used to check if the grant has been revoked.

src/dwn.ts

@@ -11,7 +11,7 @@ import type { GenericMessage, GenericMessageReply } from './types/message-types.
 import type { MessagesGetMessage, MessagesGetReply } from './types/messages-types.js';
 import type { PermissionsGrantMessage, PermissionsRequestMessage, PermissionsRevokeMessage } from './types/permissions-types.js';
 import type { ProtocolsConfigureMessage, ProtocolsQueryMessage, ProtocolsQueryReply } from './types/protocols-types.js';
-import type { RecordsDeleteMessage, RecordsQueryMessage, RecordsQueryReply, RecordsReadMessage, RecordsReadReply, RecordsSubscribeMessage, RecordsSubscribeReply, RecordsWriteMessage } from './types/records-types.js';
+import type { RecordsDeleteMessage, RecordsQueryMessage, RecordsQueryReply, RecordsReadMessage, RecordsReadReply, RecordsWriteMessage } from './types/records-types.js';
 
 import { AllowAllTenantGate } from './core/tenant-gate.js';
 import { DidResolver } from './did/did-resolver.js';
@@ -30,7 +30,6 @@ import { ProtocolsQueryHandler } from './handlers/protocols-query.js';
 import { RecordsDeleteHandler } from './handlers/records-delete.js';
 import { RecordsQueryHandler } from './handlers/records-query.js';
 import { RecordsReadHandler } from './handlers/records-read.js';
-import { RecordsSubscribeHandler } from './handlers/records-subscribe.js';
 import { RecordsWriteHandler } from './handlers/records-write.js';
 import { DwnInterfaceName, DwnMethodName } from './enums/dwn-interface-method.js';
 
@@ -116,11 +115,6 @@ export class Dwn {
         this.messageStore,
         this.dataStore
       ),
-      [DwnInterfaceName.Records + DwnMethodName.Subscribe]: new RecordsSubscribeHandler(
-        this.didResolver,
-        this.messageStore,
-        this.eventStream
-      ),
       [DwnInterfaceName.Records + DwnMethodName.Write]: new RecordsWriteHandler(
         this.didResolver,
         this.messageStore,
@@ -174,7 +168,6 @@ export class Dwn {
   public async processMessage(tenant: string, rawMessage: PermissionsRevokeMessage): Promise<GenericMessageReply>;
   public async processMessage(tenant: string, rawMessage: RecordsDeleteMessage): Promise<GenericMessageReply>;
   public async processMessage(tenant: string, rawMessage: RecordsQueryMessage): Promise<RecordsQueryReply>;
-  public async processMessage(tenant: string, rawMessage: RecordsSubscribeMessage): Promise<RecordsSubscribeReply>;
   public async processMessage(tenant: string, rawMessage: RecordsReadMessage): Promise<RecordsReadReply>;
   public async processMessage(tenant: string, rawMessage: RecordsWriteMessage, dataStream?: Readable): Promise<GenericMessageReply>;
   public async processMessage(tenant: string, rawMessage: unknown, dataStream?: Readable): Promise<UnionMessageReply>;

src/event-log/event-stream.ts

@@ -3,14 +3,11 @@ import type { EventsSubscribeMessage, EventsSubscription } from '../types/events
 import type { EventStream, SubscriptionHandler } from '../types/subscriptions.js';
 import type { Filter, KeyValues } from '../types/query-types.js';
 import type { GenericMessage, GenericMessageSubscription } from '../types/message-types.js';
-import type { RecordsSubscribeMessage, RecordsSubscription } from '../types/records-types.js';
 
 import { EventEmitter } from 'events';
 import { EventsSubscribe } from '../interfaces/events-subscribe.js';
 import { EventsSubscriptionHandler } from '../handlers/events-subscribe.js';
 import { Message } from '../core/message.js';
-import { RecordsSubscribe } from '../interfaces/records-subscribe.js';
-import { RecordsSubscriptionHandler } from '../handlers/records-subscribe.js';
 import { DwnError, DwnErrorCode } from '../core/dwn-error.js';
 
 const eventChannel = 'events';
@@ -45,25 +42,14 @@ export class EventStreamEmitter implements EventStream {
   };
 
   async subscribe(tenant: string, message: EventsSubscribeMessage, filters: Filter[], messageStore: MessageStore): Promise<EventsSubscription>;
-  async subscribe(tenant: string, message: RecordsSubscribeMessage, filters: Filter[], messageStore: MessageStore): Promise<RecordsSubscription>;
   async subscribe(tenant: string, message: GenericMessage, filters: Filter[], messageStore: MessageStore): Promise<GenericMessageSubscription> {
     const messageCid = await Message.getCid(message);
     let subscription = this.subscriptions.get(messageCid);
     if (subscription !== undefined) {
       return subscription;
     }
 
-    if (RecordsSubscribe.isRecordsSubscribeMessage(message)) {
-      subscription = await RecordsSubscriptionHandler.create({
-        tenant,
-        message,
-        filters,
-        messageStore,
-        unsubscribe        : () => this.unsubscribe(messageCid),
-        eventEmitter       : this.eventEmitter,
-        reauthorizationTTL : this.reauthorizationTTL,
-      });
-    } else if (EventsSubscribe.isEventsSubscribeMessage(message)) {
+    if (EventsSubscribe.isEventsSubscribeMessage(message)) {
       subscription = await EventsSubscriptionHandler.create({
         tenant,
         message,

src/event-log/subscription.ts

@@ -9,8 +9,6 @@ import { FilterUtility } from '../utils/filter.js';
 
 /**
  * Base class to extend default subscription behavior.
- *
- * ie. `RecordsSubscriptionHandler` has different rules for authorization and only matches specific message types.
  */
 export class SubscriptionHandlerBase implements SubscriptionHandler {
   protected eventEmitter: EventEmitter;