Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: reuse subscription library cache in quota library to reduce cross region HTTP requests #7109

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 9 additions & 8 deletions packages/core/src/libraries/quota.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@

import { EnvSet } from '#src/env-set/index.js';
import RequestError from '#src/errors/RequestError/index.js';
import { type SubscriptionLibrary } from '#src/libraries/subscription.js';
import assertThat from '#src/utils/assert-that.js';
import {
getTenantSubscriptionData,
Expand All @@ -28,7 +29,10 @@
) =>
(paidReservedPlans.has(planId) || isEnterprisePlan) && isReportSubscriptionUpdatesUsageKey(key);

export const createQuotaLibrary = (cloudConnection: CloudConnectionLibrary) => {
export const createQuotaLibrary = (
cloudConnection: CloudConnectionLibrary,
subscription: SubscriptionLibrary
) => {
const guardTenantUsageByKey = async (key: keyof SubscriptionUsage) => {
const { isCloud, isIntegrationTest } = EnvSet.values;

Expand All @@ -42,18 +46,15 @@
return;
}

const {
planId,
quota: fullQuota,
usage: fullUsage,
isEnterprisePlan,
} = await getTenantSubscriptionData(cloudConnection);
const { planId, isEnterprisePlan, quota: fullQuota } = await subscription.getSubscriptionData();

Check warning on line 49 in packages/core/src/libraries/quota.ts

View check run for this annotation

Codecov / codecov/patch

packages/core/src/libraries/quota.ts#L49

Added line #L49 was not covered by tests

// Do not block Pro/Enterprise plan from adding add-on resources.
if (shouldReportSubscriptionUpdates(planId, isEnterprisePlan, key)) {
return;
}

const { usage: fullUsage } = await getTenantSubscriptionData(cloudConnection);

Check warning on line 57 in packages/core/src/libraries/quota.ts

View check run for this annotation

Codecov / codecov/patch

packages/core/src/libraries/quota.ts#L56-L57

Added lines #L56 - L57 were not covered by tests
// Type `SubscriptionQuota` and type `SubscriptionUsage` are sharing keys, this design helps us to compare the usage with the quota limit in a easier way.
const { [key]: limit } = fullQuota;
const { [key]: usage } = fullUsage;
Expand Down Expand Up @@ -165,7 +166,7 @@
return;
}

const { planId, isEnterprisePlan } = await getTenantSubscriptionData(cloudConnection);
const { planId, isEnterprisePlan } = await subscription.getSubscriptionData();

Check warning on line 169 in packages/core/src/libraries/quota.ts

View check run for this annotation

Codecov / codecov/patch

packages/core/src/libraries/quota.ts#L169

Added line #L169 was not covered by tests

if (shouldReportSubscriptionUpdates(planId, isEnterprisePlan, key)) {
await reportSubscriptionUpdates(cloudConnection, key);
Expand Down
6 changes: 4 additions & 2 deletions packages/core/src/tenants/Libraries.ts
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@
import { createSignInExperienceLibrary } from '#src/libraries/sign-in-experience/index.js';
import { createSocialLibrary } from '#src/libraries/social.js';
import { createSsoConnectorLibrary } from '#src/libraries/sso-connector.js';
import { type SubscriptionLibrary } from '#src/libraries/subscription.js';
import { createUserLibrary } from '#src/libraries/user.js';
import { createVerificationStatusLibrary } from '#src/libraries/verification-status.js';

Expand All @@ -42,7 +43,7 @@
roleScopes = createRoleScopeLibrary(this.queries);
domains = createDomainLibrary(this.queries);
protectedApps = createProtectedAppLibrary(this.queries);
quota = createQuotaLibrary(this.cloudConnection);
quota = createQuotaLibrary(this.cloudConnection, this.subscription);
ssoConnectors = createSsoConnectorLibrary(this.queries);
signInExperiences = createSignInExperienceLibrary(
this.queries,
Expand All @@ -58,12 +59,13 @@
this.connectors
);

constructor(

Check warning on line 62 in packages/core/src/tenants/Libraries.ts

View workflow job for this annotation

GitHub Actions / ESLint Report Analysis

packages/core/src/tenants/Libraries.ts#L62

[max-params] Constructor has too many parameters (6). Maximum allowed is 4.
public readonly tenantId: string,
private readonly queries: Queries,
// Explicitly passing connector library to eliminate dependency issue
private readonly connectors: ConnectorLibrary,
private readonly cloudConnection: CloudConnectionLibrary,
private readonly logtoConfigs: LogtoConfigLibrary
private readonly logtoConfigs: LogtoConfigLibrary,
private readonly subscription: SubscriptionLibrary
) {}
}
12 changes: 9 additions & 3 deletions packages/core/src/tenants/Tenant.ts
Original file line number Diff line number Diff line change
Expand Up @@ -85,15 +85,21 @@ export default class Tenant implements TenantContext {
public readonly logtoConfigs = createLogtoConfigLibrary(queries),
public readonly cloudConnection = createCloudConnectionLibrary(logtoConfigs),
public readonly connectors = createConnectorLibrary(queries, cloudConnection),
public readonly subscription = new SubscriptionLibrary(
id,
queries,
cloudConnection,
redisCache
),
public readonly libraries = new Libraries(
id,
queries,
connectors,
cloudConnection,
logtoConfigs
logtoConfigs,
subscription
),
public readonly sentinel = new BasicSentinel(envSet.pool),
public readonly subscription = new SubscriptionLibrary(id, queries, cloudConnection, redisCache)
public readonly sentinel = new BasicSentinel(envSet.pool)
) {
const isAdminTenant = id === adminTenantId;
const mountedApps = [
Expand Down
15 changes: 8 additions & 7 deletions packages/core/src/test-utils/tenant.ts
Original file line number Diff line number Diff line change
Expand Up @@ -87,21 +87,22 @@ export class MockTenant implements TenantContext {
...createConnectorLibrary(this.queries, this.cloudConnection),
...connectorsOverride,
};
this.libraries = new Libraries(
this.sentinel = new MockSentinel();
this.subscription = new SubscriptionLibrary(
this.id,
this.queries,
this.connectors,
this.cloudConnection,
this.logtoConfigs
new TtlCache<string, string>(60_000)
);
this.setPartial('libraries', librariesOverride);
this.sentinel = new MockSentinel();
this.subscription = new SubscriptionLibrary(
this.libraries = new Libraries(
this.id,
this.queries,
this.connectors,
this.cloudConnection,
new TtlCache<string, string>(60_000)
this.logtoConfigs,
this.subscription
);
this.setPartial('libraries', librariesOverride);
}

public async invalidateCache() {
Expand Down
9 changes: 2 additions & 7 deletions packages/core/src/utils/subscription/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -30,20 +30,15 @@
export const getTenantSubscriptionData = async (
cloudConnection: CloudConnectionLibrary
): Promise<{
planId: string;
isEnterprisePlan: boolean;
quota: SubscriptionQuota;
usage: SubscriptionUsage;
resources: Record<string, number>;
roles: Record<string, number>;
}> => {
const client = await cloudConnection.getClient();
const [{ planId, isEnterprisePlan }, { quota, usage, resources, roles }] = await Promise.all([
client.get('/api/tenants/my/subscription'),
client.get('/api/tenants/my/subscription-usage'),
]);
const { quota, usage, resources, roles } = await client.get('/api/tenants/my/subscription-usage');

Check warning on line 39 in packages/core/src/utils/subscription/index.ts

View check run for this annotation

Codecov / codecov/patch

packages/core/src/utils/subscription/index.ts#L39

Added line #L39 was not covered by tests

return { planId, isEnterprisePlan, quota, usage, resources, roles };
return { quota, usage, resources, roles };

Check warning on line 41 in packages/core/src/utils/subscription/index.ts

View check run for this annotation

Codecov / codecov/patch

packages/core/src/utils/subscription/index.ts#L41

Added line #L41 was not covered by tests
};

export const reportSubscriptionUpdates = async (
Expand Down
Loading