Skip to content

The easy-to-use open source Business Intelligence and Embedded Analytics tool that lets everyone work with data :bar_chart:

3.2 KB
Raw Blame
import { createSelector } from "@reduxjs/toolkit";
import { P, match } from "ts-pattern";

import { getUser, getUserPersonalCollectionId } from "metabase/current-user";
import type { CollectionId, RegularCollectionId } from "metabase-types/api";

import type {
  SdkBrowserCollectionId,
  SdkCollectionId,
} from "../types/collection";

export const getUserTenantCollectionId = createSelector(
  [getUser],
  (user) => user?.tenant_collection_id,
);

/**
 * Converts "personal", "tenant", and "root" to the ids accepted by the api
 * For the root collection id, the API expects null.
 */
export const getCollectionIdValueFromReference = createSelector(
  [
    getUserPersonalCollectionId,
    getUserTenantCollectionId,
    (_, collectionReference: SdkCollectionId) => collectionReference,
  ],
  (
    personalCollectionId,
    tenantCollectionId,
    collectionReference,
  ): CollectionId | null => {
    return (
      match(collectionReference)
        // Unjustified type cast. FIXME
        .with("personal", () => personalCollectionId as RegularCollectionId)
        .with("tenant", () => {
          if (!tenantCollectionId) {
            throw new Error(
              "You must be a tenant member to access the tenant collection.",
            );
          }

          return tenantCollectionId;
        })
        .with("root", () => null)
        .with(P.union(P.number, P.string), (id) => id)
        .otherwise(() => {
          throw new Error(
            "Invalid collection id, expected `number | string | 'root' | 'personal' | 'tenant'`",
          );
        })
    );
  },
);

/**
 * Returns an "id"/"slug" for `/api/collection/{:id}` — unlike when creating a
 * dashboard, the root collection is `"root"` here rather than null.
 *
 * Nullish when `"personal"` can't be resolved: `undefined` while `currentUser` hasn't loaded,
 * `null` for a user the backend gives no personal collection — an API-key user, which is how
 * the data-app dev server authenticates. Callers must handle both (e.g. with `skipToken`);
 * `/api/collection/undefined` and `/api/collection/null` are each a 404.
 *
 * `"all"` is the virtual top level and resolves to `undefined`: there is no
 * collection to fetch. Its branch has to stay above the string one, which would
 * otherwise match it as an entity id.
 */
export const getCollectionIdSlugFromReference = createSelector(
  [
    getUserPersonalCollectionId,
    getUserTenantCollectionId,
    (_, collectionReference: SdkBrowserCollectionId) => collectionReference,
  ],
  (
    personalCollectionId,
    tenantCollectionId,
    collectionReference,
  ): CollectionId | null | undefined => {
    return match(collectionReference)
      .with("personal", () => personalCollectionId)
      .with("tenant", () => {
        if (!tenantCollectionId) {
          throw new Error(
            "You must be a tenant member to access the tenant collection.",
          );
        }

        return tenantCollectionId;
      })
      .with("root", () => "root" as const)
      .with("all", () => undefined)
      .with(P.union(P.number, P.string), (id) => id)
      .otherwise(() => {
        throw new Error(
          "Invalid collection id, expected `number | string | 'root' | 'personal' | 'tenant' | 'all'`",
        );
      });
  },
);