Spaces:

AUXteam
/

Midday

Paused

Midday / packages /cache /src /widget-preferences-cache.ts

Jules

Final deployment with all fixes and verified content

c09f67c 8 months ago

5.94 kB

import { RedisCache } from "./redis-client";

export const WIDGET_TYPES = [
  // Critical financial health (default primary widgets)
  "runway",
  "cash-flow",
  "account-balances",
  "profit-analysis",
  "revenue-forecast",
  "revenue-summary",
  "growth-rate",

  // Financial position
  "net-position",

  // Customer insights
  "customer-lifetime-value",
  "top-customer",

  // Receivables & invoices
  "outstanding-invoices",
  "overdue-invoices-alert",
  "invoice-payment-score",

  // Expenses & spending
  "monthly-spending",
  "recurring-expenses",
  "category-expenses",

  // Profitability metrics
  "profit-margin",

  // Operations
  "time-tracker",
  "billable-hours",

  // Admin & documents
  "inbox",
  "vault",
  "tax-summary",
] as const;

export type WidgetType = (typeof WIDGET_TYPES)[number];

export interface WidgetPreferences {
  primaryWidgets: WidgetType[];
  availableWidgets: WidgetType[];
}

export const DEFAULT_WIDGET_ORDER: WidgetType[] = [...WIDGET_TYPES];

export const DEFAULT_WIDGET_PREFERENCES: WidgetPreferences = {
  primaryWidgets: DEFAULT_WIDGET_ORDER.slice(0, 7), // First 7 widgets (insights is separate)
  availableWidgets: DEFAULT_WIDGET_ORDER.slice(7), // Remaining widgets
};

class WidgetPreferencesCache extends RedisCache {
  constructor() {
    super("widget-preferences");
  }

  private getWidgetPreferencesKey(teamId: string, userId: string): string {
    return `${teamId}:${userId}`;
  }

  async getWidgetPreferences(
    teamId: string,
    userId: string,
  ): Promise<WidgetPreferences> {
    const key = this.getWidgetPreferencesKey(teamId, userId);
    const preferences = await this.get<WidgetPreferences>(key);

    if (!preferences) {
      // Return default preferences if none exist
      return DEFAULT_WIDGET_PREFERENCES;
    }

    // Validate the preferences and ensure all widgets are accounted for
    const allWidgets = [
      ...preferences.primaryWidgets,
      ...preferences.availableWidgets,
    ];
    const missingWidgets = DEFAULT_WIDGET_ORDER.filter(
      (widget) => !allWidgets.includes(widget),
    );
    const extraWidgets = allWidgets.filter(
      (widget) => !DEFAULT_WIDGET_ORDER.includes(widget),
    );

    // Handle migrations when widgets are added or removed
    if (missingWidgets.length > 0 || extraWidgets.length > 0) {
      console.info(
        `Migrating widget preferences for team ${teamId}, user ${userId}. Missing: ${missingWidgets.join(", ") || "none"}, Extra: ${extraWidgets.join(", ") || "none"}`,
      );

      // Remove deprecated widgets from both lists
      const migratedPrimaryWidgets = preferences.primaryWidgets.filter(
        (widget) => !extraWidgets.includes(widget),
      );

      const migratedAvailableWidgets = preferences.availableWidgets.filter(
        (widget) => !extraWidgets.includes(widget),
      );

      // Add new widgets to available widgets (they can be moved to primary by the user)
      const updatedAvailableWidgets = [
        ...migratedAvailableWidgets,
        ...missingWidgets,
      ];

      const migratedPreferences: WidgetPreferences = {
        primaryWidgets: migratedPrimaryWidgets,
        availableWidgets: updatedAvailableWidgets,
      };

      // Save the migrated preferences
      await this.setWidgetPreferences(teamId, userId, migratedPreferences);

      return migratedPreferences;
    }

    return preferences;
  }

  async setWidgetPreferences(
    teamId: string,
    userId: string,
    preferences: WidgetPreferences,
  ): Promise<void> {
    // Validate preferences before saving
    const allWidgets = [
      ...preferences.primaryWidgets,
      ...preferences.availableWidgets,
    ];

    // Check that we have exactly the right widgets
    if (allWidgets.length !== DEFAULT_WIDGET_ORDER.length) {
      throw new Error(
        "Invalid widget preferences: incorrect number of widgets",
      );
    }

    // Check that all default widgets are present and no extras
    const missingWidgets = DEFAULT_WIDGET_ORDER.filter(
      (widget) => !allWidgets.includes(widget),
    );
    const extraWidgets = allWidgets.filter(
      (widget) => !DEFAULT_WIDGET_ORDER.includes(widget),
    );

    if (missingWidgets.length > 0) {
      throw new Error(
        `Invalid widget preferences: missing widgets ${missingWidgets.join(", ")}`,
      );
    }

    if (extraWidgets.length > 0) {
      throw new Error(
        `Invalid widget preferences: unknown widgets ${extraWidgets.join(", ")}`,
      );
    }

    // Check that primary widgets doesn't exceed 7 (insights is separate)
    if (preferences.primaryWidgets.length > 7) {
      throw new Error(
        "Invalid widget preferences: primary widgets cannot exceed 7",
      );
    }

    // Check for duplicates
    const duplicates = allWidgets.filter(
      (widget, index) => allWidgets.indexOf(widget) !== index,
    );
    if (duplicates.length > 0) {
      throw new Error(
        `Invalid widget preferences: duplicate widgets ${duplicates.join(", ")}`,
      );
    }

    const key = this.getWidgetPreferencesKey(teamId, userId);
    await this.set(key, preferences);
  }

  async updatePrimaryWidgets(
    teamId: string,
    userId: string,
    newPrimaryWidgets: WidgetType[],
  ): Promise<WidgetPreferences> {
    if (newPrimaryWidgets.length > 7) {
      throw new Error("Primary widgets cannot exceed 7");
    }

    const _currentPreferences = await this.getWidgetPreferences(teamId, userId);

    // Calculate available widgets (all widgets not in primary)
    const availableWidgets = DEFAULT_WIDGET_ORDER.filter(
      (widget) => !newPrimaryWidgets.includes(widget),
    );

    const newPreferences: WidgetPreferences = {
      primaryWidgets: newPrimaryWidgets,
      availableWidgets,
    };

    await this.setWidgetPreferences(teamId, userId, newPreferences);
    return newPreferences;
  }
}

export const widgetPreferencesCache = new WidgetPreferencesCache();

	import { RedisCache } from "./redis-client";

	export const WIDGET_TYPES = [
	// Critical financial health (default primary widgets)
	"runway",
	"cash-flow",
	"account-balances",
	"profit-analysis",
	"revenue-forecast",
	"revenue-summary",
	"growth-rate",

	// Financial position
	"net-position",

	// Customer insights
	"customer-lifetime-value",
	"top-customer",

	// Receivables & invoices
	"outstanding-invoices",
	"overdue-invoices-alert",
	"invoice-payment-score",

	// Expenses & spending
	"monthly-spending",
	"recurring-expenses",
	"category-expenses",

	// Profitability metrics
	"profit-margin",

	// Operations
	"time-tracker",
	"billable-hours",

	// Admin & documents
	"inbox",
	"vault",
	"tax-summary",
	] as const;

	export type WidgetType = (typeof WIDGET_TYPES)[number];

	export interface WidgetPreferences {
	primaryWidgets: WidgetType[];
	availableWidgets: WidgetType[];
	}

	export const DEFAULT_WIDGET_ORDER: WidgetType[] = [...WIDGET_TYPES];

	export const DEFAULT_WIDGET_PREFERENCES: WidgetPreferences = {
	primaryWidgets: DEFAULT_WIDGET_ORDER.slice(0, 7), // First 7 widgets (insights is separate)
	availableWidgets: DEFAULT_WIDGET_ORDER.slice(7), // Remaining widgets
	};

	class WidgetPreferencesCache extends RedisCache {
	constructor() {
	super("widget-preferences");
	}

	private getWidgetPreferencesKey(teamId: string, userId: string): string {
	return `${teamId}:${userId}`;
	}

	async getWidgetPreferences(
	teamId: string,
	userId: string,
	): Promise<WidgetPreferences> {
	const key = this.getWidgetPreferencesKey(teamId, userId);
	const preferences = await this.get<WidgetPreferences>(key);

	if (!preferences) {
	// Return default preferences if none exist
	return DEFAULT_WIDGET_PREFERENCES;
	}

	// Validate the preferences and ensure all widgets are accounted for
	const allWidgets = [
	...preferences.primaryWidgets,
	...preferences.availableWidgets,
	];
	const missingWidgets = DEFAULT_WIDGET_ORDER.filter(
	(widget) => !allWidgets.includes(widget),
	);
	const extraWidgets = allWidgets.filter(
	(widget) => !DEFAULT_WIDGET_ORDER.includes(widget),
	);

	// Handle migrations when widgets are added or removed
	if (missingWidgets.length > 0 \|\| extraWidgets.length > 0) {
	console.info(
	`Migrating widget preferences for team ${teamId}, user ${userId}. Missing: ${missingWidgets.join(", ") \|\| "none"}, Extra: ${extraWidgets.join(", ") \|\| "none"}`,
	);

	// Remove deprecated widgets from both lists
	const migratedPrimaryWidgets = preferences.primaryWidgets.filter(
	(widget) => !extraWidgets.includes(widget),
	);

	const migratedAvailableWidgets = preferences.availableWidgets.filter(
	(widget) => !extraWidgets.includes(widget),
	);

	// Add new widgets to available widgets (they can be moved to primary by the user)
	const updatedAvailableWidgets = [
	...migratedAvailableWidgets,
	...missingWidgets,
	];

	const migratedPreferences: WidgetPreferences = {
	primaryWidgets: migratedPrimaryWidgets,
	availableWidgets: updatedAvailableWidgets,
	};

	// Save the migrated preferences
	await this.setWidgetPreferences(teamId, userId, migratedPreferences);

	return migratedPreferences;
	}

	return preferences;
	}

	async setWidgetPreferences(
	teamId: string,
	userId: string,
	preferences: WidgetPreferences,
	): Promise<void> {
	// Validate preferences before saving
	const allWidgets = [
	...preferences.primaryWidgets,
	...preferences.availableWidgets,
	];

	// Check that we have exactly the right widgets
	if (allWidgets.length !== DEFAULT_WIDGET_ORDER.length) {
	throw new Error(
	"Invalid widget preferences: incorrect number of widgets",
	);
	}

	// Check that all default widgets are present and no extras
	const missingWidgets = DEFAULT_WIDGET_ORDER.filter(
	(widget) => !allWidgets.includes(widget),
	);
	const extraWidgets = allWidgets.filter(
	(widget) => !DEFAULT_WIDGET_ORDER.includes(widget),
	);

	if (missingWidgets.length > 0) {
	throw new Error(
	`Invalid widget preferences: missing widgets ${missingWidgets.join(", ")}`,
	);
	}

	if (extraWidgets.length > 0) {
	throw new Error(
	`Invalid widget preferences: unknown widgets ${extraWidgets.join(", ")}`,
	);
	}

	// Check that primary widgets doesn't exceed 7 (insights is separate)
	if (preferences.primaryWidgets.length > 7) {
	throw new Error(
	"Invalid widget preferences: primary widgets cannot exceed 7",
	);
	}

	// Check for duplicates
	const duplicates = allWidgets.filter(
	(widget, index) => allWidgets.indexOf(widget) !== index,
	);
	if (duplicates.length > 0) {
	throw new Error(
	`Invalid widget preferences: duplicate widgets ${duplicates.join(", ")}`,
	);
	}

	const key = this.getWidgetPreferencesKey(teamId, userId);
	await this.set(key, preferences);
	}

	async updatePrimaryWidgets(
	teamId: string,
	userId: string,
	newPrimaryWidgets: WidgetType[],
	): Promise<WidgetPreferences> {
	if (newPrimaryWidgets.length > 7) {
	throw new Error("Primary widgets cannot exceed 7");
	}

	const _currentPreferences = await this.getWidgetPreferences(teamId, userId);

	// Calculate available widgets (all widgets not in primary)
	const availableWidgets = DEFAULT_WIDGET_ORDER.filter(
	(widget) => !newPrimaryWidgets.includes(widget),
	);

	const newPreferences: WidgetPreferences = {
	primaryWidgets: newPrimaryWidgets,
	availableWidgets,
	};

	await this.setWidgetPreferences(teamId, userId, newPreferences);
	return newPreferences;
	}
	}

	export const widgetPreferencesCache = new WidgetPreferencesCache();