refactor(core): replace arbitrary data guard type with arbitrary object guard (#290)

packages/core/src/connectors/types.ts

@@ -1,5 +1,5 @@
 import { Languages } from '@logto/phrases';
-import { ConnectorConfig, Connector, PasscodeType } from '@logto/schemas';
+import { ArbitraryObject, Connector, PasscodeType } from '@logto/schemas';
 import { z } from 'zod';
 
 export enum ConnectorType {
@@ -92,7 +92,7 @@ export class ConnectorError extends Error {
   }
 }
 
-export type ValidateConfig<T extends ConnectorConfig = ConnectorConfig> = (
+export type ValidateConfig<T extends ArbitraryObject = ArbitraryObject> = (
   config: T
 ) => Promise<void>;
 

packages/core/src/connectors/utilities/index.ts

@@ -1,9 +1,9 @@
-import { ConnectorConfig } from '@logto/schemas';
+import { ArbitraryObject } from '@logto/schemas';
 
 import RequestError from '@/errors/RequestError';
 import { findConnectorById, updateConnector } from '@/queries/connector';
 
-export const getConnectorConfig = async <T extends ConnectorConfig>(id: string): Promise<T> => {
+export const getConnectorConfig = async <T extends ArbitraryObject>(id: string): Promise<T> => {
   const connector = await findConnectorById(id);
 
   // FIXME:
@@ -20,7 +20,7 @@ export const getConnectorConfig = async <T extends ConnectorConfig>(id: string):
   return connector.config as T;
 };
 
-export const updateConnectorConfig = async <T extends ConnectorConfig>(
+export const updateConnectorConfig = async <T extends ArbitraryObject>(
   id: string,
   config: T
 ): Promise<void> => {

packages/core/src/routes/admin-user.test.ts

@@ -308,11 +308,27 @@ describe('adminUserRoutes', () => {
       }
     });
     await expect(
-      userRequest.patch(`/users/${notExistedUserId}/roleNames`).send({ roleNames: ['admin'] })
+      userRequest.patch(`/users/${notExistedUserId}/custom-data`).send({ customData: { level: 1 } })
     ).resolves.toHaveProperty('status', 500);
     expect(updateUserById).not.toHaveBeenCalled();
   });
 
+  it('PATCH /users/:userId/custom-data should throw if customData is not an object', async () => {
+    await expect(
+      userRequest.patch(`/users/foo/custom-data`).send({ customData: 123_456 })
+    ).resolves.toHaveProperty('status', 400);
+
+    await expect(
+      userRequest.patch(`/users/foo/custom-data`).send({ customData: ['customDataContent'] })
+    ).resolves.toHaveProperty('status', 400);
+
+    await expect(
+      userRequest.patch(`/users/foo/custom-data`).send({ customData: 'customDataContent' })
+    ).resolves.toHaveProperty('status', 400);
+
+    expect(updateUserById).not.toHaveBeenCalled();
+  });
+
   it('DELETE /users/:userId/custom-data', async () => {
     const response = await userRequest.delete('/users/foo/custom-data');
     expect(findUserById).toHaveBeenCalledTimes(1);

packages/core/src/routes/admin-user.ts

@@ -1,4 +1,4 @@
-import { customDataGuard, userInfoSelectFields } from '@logto/schemas';
+import { arbitraryObjectGuard, userInfoSelectFields } from '@logto/schemas';
 import pick from 'lodash.pick';
 import { InvalidInputError } from 'slonik';
 import { object, string } from 'zod';
@@ -218,7 +218,7 @@ export default function adminUserRoutes<T extends AuthedRouter>(router: T) {
     '/users/:userId/custom-data',
     koaGuard({
       params: object({ userId: string() }),
-      body: object({ customData: customDataGuard }),
+      body: object({ customData: arbitraryObjectGuard }),
     }),
     async (ctx, next) => {
       const {

packages/schemas/src/db-entries/connector.ts

@@ -2,26 +2,26 @@
 
 import { z } from 'zod';
 
-import { ConnectorConfig, connectorConfigGuard, GeneratedSchema, Guard } from '../foundations';
+import { ArbitraryObject, arbitraryObjectGuard, GeneratedSchema, Guard } from '../foundations';
 
 export type CreateConnector = {
   id: string;
   enabled?: boolean;
-  config?: ConnectorConfig;
+  config?: ArbitraryObject;
   createdAt?: number;
 };
 
 export type Connector = {
   id: string;
   enabled: boolean;
-  config: ConnectorConfig;
+  config: ArbitraryObject;
   createdAt: number;
 };
 
 const createGuard: Guard<CreateConnector> = z.object({
   id: z.string(),
   enabled: z.boolean().optional(),
-  config: connectorConfigGuard.optional(),
+  config: arbitraryObjectGuard.optional(),
   createdAt: z.number().optional(),
 });
 

packages/schemas/src/db-entries/user.ts

@@ -7,8 +7,8 @@ import {
   roleNamesGuard,
   Identities,
   identitiesGuard,
-  CustomData,
-  customDataGuard,
+  ArbitraryObject,
+  arbitraryObjectGuard,
   GeneratedSchema,
   Guard,
 } from '../foundations';
@@ -26,7 +26,7 @@ export type CreateUser = {
   avatar?: string | null;
   roleNames?: RoleNames;
   identities?: Identities;
-  customData?: CustomData;
+  customData?: ArbitraryObject;
 };
 
 export type User = {
@@ -41,7 +41,7 @@ export type User = {
   avatar: string | null;
   roleNames: RoleNames;
   identities: Identities;
-  customData: CustomData;
+  customData: ArbitraryObject;
 };
 
 const createGuard: Guard<CreateUser> = z.object({
@@ -56,7 +56,7 @@ const createGuard: Guard<CreateUser> = z.object({
   avatar: z.string().nullable().optional(),
   roleNames: roleNamesGuard.optional(),
   identities: identitiesGuard.optional(),
-  customData: customDataGuard.optional(),
+  customData: arbitraryObjectGuard.optional(),
 });
 
 export const Users: GeneratedSchema<CreateUser> = Object.freeze({

packages/schemas/src/foundations/jsonb-types.ts

@@ -54,11 +54,6 @@ export const identitiesGuard = z.record(identityGuard);
 export type Identity = z.infer<typeof identityGuard>;
 export type Identities = z.infer<typeof identitiesGuard>;
 
-// TODO: LOG-1553 support empty shape of object
-export const customDataGuard = z.object({}).catchall(z.unknown());
-
-export type CustomData = z.infer<typeof customDataGuard>;
-
 /**
  * User Logs
  */
@@ -73,15 +68,6 @@ export const userLogPayloadGuard = z.object({
 
 export type UserLogPayload = z.infer<typeof userLogPayloadGuard>;
 
-/**
- * Connectors
- */
-
-// TODO: support empty shape of object
-export const connectorConfigGuard = z.object({}).catchall(z.unknown());
-
-export type ConnectorConfig = z.infer<typeof connectorConfigGuard>;
-
 /**
  * Settings
  */
@@ -148,3 +134,11 @@ export const signInMethodSettingsGuard = z.object({
 });
 
 export type SignInMethodSettings = z.infer<typeof signInMethodSettingsGuard>;
+
+/**
+ * Commonly Used
+ */
+
+export const arbitraryObjectGuard = z.object({}).catchall(z.unknown());
+
+export type ArbitraryObject = z.infer<typeof arbitraryObjectGuard>;

packages/schemas/tables/connectors.sql

@@ -1,7 +1,7 @@
 create table connectors (
   id varchar(128) not null,
   enabled boolean not null default TRUE,
-  config jsonb /* @use ConnectorConfig */ not null default '{}'::jsonb,
+  config jsonb /* @use ArbitraryObject */ not null default '{}'::jsonb,
   created_at timestamptz not null default(now()),
   primary key (id)
 );

packages/schemas/tables/users.sql

@@ -12,6 +12,6 @@ create table users (
   avatar varchar(256),
   role_names jsonb /* @use RoleNames */ not null default '[]'::jsonb,
   identities jsonb /* @use Identities */ not null default '{}'::jsonb,
-  custom_data jsonb /* @use CustomData */ not null default '{}'::jsonb,
+  custom_data jsonb /* @use ArbitraryObject */ not null default '{}'::jsonb,
   primary key (id)
 );