Skip to content

Use REST instead of gRPC for tenants.getByName when available due to filtering issues with rbac #281

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

Merged
merged 2 commits into from
Apr 2, 2025
Merged
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
27 changes: 18 additions & 9 deletions src/collections/tenants/index.ts
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
import { ConnectionGRPC } from '../../connection/index.js';
import { WeaviateUnsupportedFeatureError } from '../../errors.js';
import { WeaviateUnexpectedStatusCodeError, WeaviateUnsupportedFeatureError } from '../../errors.js';
import { Tenant as TenantREST } from '../../openapi/types.js';
import { TenantsCreator, TenantsDeleter, TenantsGetter, TenantsUpdater } from '../../schema/index.js';
import { DbVersionSupport } from '../../utils/dbVersion.js';
Expand All @@ -17,12 +17,10 @@ const parseValueOrValueArray = <V>(value: V | V[]) => (Array.isArray(value) ? va
const parseStringOrTenant = <T extends TenantBase>(tenant: string | T) =>
typeof tenant === 'string' ? tenant : tenant.name;

const parseTenantREST = (tenant: TenantREST): Tenant => {
return {
name: tenant.name!,
activityStatus: Deserialize.activityStatusREST(tenant.activityStatus),
};
};
const parseTenantREST = (tenant: TenantREST): Tenant => ({
name: tenant.name!,
activityStatus: Deserialize.activityStatusREST(tenant.activityStatus),
});

const tenants = (
connection: ConnectionGRPC,
Expand Down Expand Up @@ -53,9 +51,20 @@ const tenants = (
return check.supports ? getGRPC() : getREST();
},
getByNames: <T extends TenantBase>(tenants: (string | T)[]) => getGRPC(tenants.map(parseStringOrTenant)),
getByName: <T extends TenantBase>(tenant: string | T) => {
getByName: async <T extends TenantBase>(tenant: string | T) => {
const tenantName = parseStringOrTenant(tenant);
return getGRPC([tenantName]).then((tenants) => tenants[tenantName] || null);
if (await dbVersionSupport.supportsTenantGetRESTMethod().then((check) => !check.supports)) {
return getGRPC([tenantName]).then((tenants) => tenants[tenantName] ?? null);
}
return connection
.get<TenantREST>(`/schema/${collection}/tenants/${tenantName}`)
.then(parseTenantREST)
.catch((err) => {
if (err instanceof WeaviateUnexpectedStatusCodeError && err.code === 404) {
return null;
}
throw err;
});
},
remove: <T extends TenantBase>(tenants: string | T | (string | T)[]) =>
new TenantsDeleter(
Expand Down
9 changes: 8 additions & 1 deletion src/utils/dbVersion.ts
Original file line number Diff line number Diff line change
Expand Up @@ -151,11 +151,18 @@ export class DbVersionSupport {
return {
version: version,
supports: version.isAtLeast(1, 25, 0),
message: this.errorMessage('Tenants get method', version.show(), '1.25.0'),
message: this.errorMessage('Tenants get method over gRPC', version.show(), '1.25.0'),
};
});
};

supportsTenantGetRESTMethod = () =>
this.dbVersionProvider.getVersion().then((version) => ({
version: version,
supports: version.isAtLeast(1, 28, 0),
message: this.errorMessage('Tenant get method over REST', version.show(), '1.28.0'),
}));

supportsDynamicVectorIndex = () => {
return this.dbVersionProvider.getVersion().then((version) => {
return {
Expand Down
Loading