ldo-compact-fork/packages/solid/src/requester/Requester.ts

import { ANY_KEY, RequestBatcher } from "../util/RequestBatcher";
import type { SolidLdoDatasetContext } from "../SolidLdoDatasetContext";
import type {
  CreateResult,
  CreateResultWithoutOverwrite,
} from "./requests/createDataResource";
import { createDataResource } from "./requests/createDataResource";
import type { ReadResult } from "./requests/readResource";
import { readResource } from "./requests/readResource";
import type {
  UploadResult,
  UploadResultWithoutOverwrite,
} from "./requests/uploadResource";
import { uploadResource } from "./requests/uploadResource";
import type { DeleteResult } from "./requests/deleteResource";
import { deleteResource } from "./requests/deleteResource";

const READ_KEY = "read";
const CREATE_KEY = "createDataResource";
const UPLOAD_KEY = "upload";
const DELETE_KEY = "delete";

export abstract class Requester {
  protected readonly requestBatcher = new RequestBatcher();

  // All intance variables
  readonly uri: string;
  protected context: SolidLdoDatasetContext;

  constructor(uri: string, context: SolidLdoDatasetContext) {
    this.uri = uri;
    this.context = context;
  }

  isLoading(): boolean {
    return this.requestBatcher.isLoading(ANY_KEY);
  }
  isCreating(): boolean {
    return this.requestBatcher.isLoading(CREATE_KEY);
  }
  isUploading(): boolean {
    return this.requestBatcher.isLoading(UPLOAD_KEY);
  }
  isReading(): boolean {
    return this.requestBatcher.isLoading(READ_KEY);
  }
  isDeletinng(): boolean {
    return this.requestBatcher.isLoading(DELETE_KEY);
  }

  /**
   * Read this resource.
   */
  async read(): Promise<ReadResult> {
    const transaction = this.context.solidLdoDataset.startTransaction();
    const result = await this.requestBatcher.queueProcess({
      name: READ_KEY,
      args: [{ uri: this.uri, transaction, fetch: this.context.fetch }],
      perform: readResource,
      modifyQueue: (queue, isLoading) => {
        if (queue.length === 0) {
          return isLoading[READ_KEY];
        } else {
          return queue[queue.length - 1].name === READ_KEY;
        }
      },
    });
    if (result.type !== "error") {
      transaction.commit();
    }
    return result;
  }

  /**
   * Creates a Resource
   * @param overwrite: If true, this will orverwrite the resource if it already
   * exists
   */
  async createDataResource(
    overwrite?: false,
  ): Promise<CreateResultWithoutOverwrite>;
  async createDataResource(overwrite: true): Promise<CreateResult>;
  async createDataResource(
    overwrite?: boolean,
  ): Promise<CreateResultWithoutOverwrite | CreateResult>;
  async createDataResource(
    overwrite?: boolean,
  ): Promise<CreateResultWithoutOverwrite> {
    const transaction = this.context.solidLdoDataset.startTransaction();
    const result = await this.requestBatcher.queueProcess({
      name: CREATE_KEY,
      args: [
        { uri: this.uri, transaction, fetch: this.context.fetch },
        overwrite,
      ],
      perform: createDataResource,
      modifyQueue: (queue, isLoading, args) => {
        const lastElementInQueue = queue[queue.length - 1];
        return (
          lastElementInQueue &&
          lastElementInQueue.name === CREATE_KEY &&
          !!lastElementInQueue.args[1] === !!args[1]
        );
      },
    });
    if (result.type !== "error") {
      transaction.commit();
    }
    return result;
  }

  /**
   * Upload a binary
   * @param blob
   * @param mimeType
   * @param overwrite: If true, will overwrite an existing file
   */
  async upload(
    blob: Blob,
    mimeType: string,
    overwrite?: false,
  ): Promise<UploadResultWithoutOverwrite>;
  async upload(
    blob: Blob,
    mimeType: string,
    overwrite: true,
  ): Promise<UploadResult>;
  async upload(
    blob: Blob,
    mimeType: string,
    overwrite?: boolean,
  ): Promise<UploadResultWithoutOverwrite | UploadResult>;
  async upload(
    blob: Blob,
    mimeType: string,
    overwrite?: boolean,
  ): Promise<UploadResultWithoutOverwrite | UploadResult> {
    const transaction = this.context.solidLdoDataset.startTransaction();
    const result = await this.requestBatcher.queueProcess({
      name: UPLOAD_KEY,
      args: [
        { uri: this.uri, transaction, fetch: this.context.fetch },
        blob,
        mimeType,
        overwrite,
      ],
      perform: uploadResource,
      modifyQueue: (queue, isLoading, args) => {
        const lastElementInQueue = queue[queue.length - 1];
        return (
          lastElementInQueue &&
          lastElementInQueue.name === UPLOAD_KEY &&
          !!lastElementInQueue.args[3] === !!args[3]
        );
      },
    });
    if (result.type !== "error") {
      transaction.commit();
    }
    return result;
  }

  /**
   * Delete this resource
   */
  async delete(): Promise<DeleteResult> {
    const transaction = this.context.solidLdoDataset.startTransaction();
    const result = await this.requestBatcher.queueProcess({
      name: DELETE_KEY,
      args: [{ uri: this.uri, transaction, fetch: this.context.fetch }],
      perform: deleteResource,
      modifyQueue: (queue, isLoading) => {
        if (queue.length === 0) {
          return isLoading[DELETE_KEY];
        } else {
          return queue[queue.length - 1].name === DELETE_KEY;
        }
      },
    });
    if (result.type !== "error") {
      transaction.commit();
    }
    return result;
  }
}