feat: Make Controller the middleware API

[ntucker]

Motivation

Simplify interface, make easier to write managers

Solution

Since Controller is now a superset of the normal middlware API, we can just send its entirety

import type { Controller, Manager, Middleware } from '@rest-hooks/core';
import type { EndpointInterface } from '@rest-hooks/endpoint';

export default class WebsocketManager implements Manager {
  protected declare middleware: Middleware;
  protected declare websocket: WebSocket;
  protected declare endpoints: Record<string, EndpointInterface>;
  protected declare controller: Controller;

  constructor(url: string, endpoints: Record<string, EndpointInterface>) {
    this.websocket = new WebSocket(url);
    this.endpoints = endpoints;

    this.middleware = controller => {
      this.controller = controller;
      this.websocket.onmessage = this.handleMessage;
      return next => async action => next(action);
    };
  }

  cleanup() {
    this.websocket.close();
  }

  getMiddleware<T extends WebsocketManager>(this: T) {
    return this.middleware;
  }

  handleMessage = (event: MessageEvent<any>) => {
    const { args, data } = JSON.parse(event.data);
    this.controller.receive(this.endpoints[event.type], ...args, data);
  };
}

Note, since we previously added controller as one of the members, we have to adapt the controller in applyManagers like so:

const API = Object.create(controller, {
  controller: { value: controller },
});
middleware(API)

Open questions

This technically breaks someone trying to call middlewares themselves outside of rest hooks, but I cannot imagine a use case for that.

[codecov-commenter]

Codecov Report

Merging #2290 (e665255) into master (b1be0e1) will decrease coverage by 0.09%.
The diff coverage is 96.00%.

@@            Coverage Diff             @@
##           master    #2290      +/-   ##
==========================================
- Coverage   98.31%   98.21%   -0.10%     
==========================================
  Files         125      125              
  Lines        1955     1963       +8     
  Branches      293      295       +2     
==========================================
+ Hits         1922     1928       +6     
- Misses         16       18       +2     
  Partials       17       17              

Impacted Files	Coverage Δ
packages/core/src/manager/PollingSubscription.ts	100.00% <ø> (ø)
...ore/src/state/legacy-actions/createReceiveError.ts	85.71% <50.00%> (+2.38%)	⬆️
packages/core/src/controller/Controller.ts	95.28% <100.00%> (+0.09%)	⬆️
packages/core/src/manager/NetworkManager.ts	94.94% <100.00%> (-1.93%)	⬇️
packages/core/src/manager/SubscriptionManager.ts	100.00% <100.00%> (ø)
packages/core/src/manager/applyManager.ts	100.00% <100.00%> (ø)
packages/react/src/components/CacheStore.tsx	100.00% <100.00%> (ø)
packages/react/src/hooks/index.ts	100.00% <100.00%> (ø)

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more