merge dev to main (v2.9.4) (#1892)

ymc9 · web-flow · commit 251c699095eb · 2024-11-27T01:08:13.000-08:00
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
     "name": "zenstack-monorepo",
-    "version": "2.9.3",
+    "version": "2.9.4",
     "description": "",
     "scripts": {
         "build": "pnpm -r build",
diff --git a/packages/ide/jetbrains/build.gradle.kts b/packages/ide/jetbrains/build.gradle.kts
@@ -9,7 +9,7 @@ plugins {
 }
 
 group = "dev.zenstack"
-version = "2.9.3"
+version = "2.9.4"
 
 repositories {
     mavenCentral()
diff --git a/packages/ide/jetbrains/package.json b/packages/ide/jetbrains/package.json
@@ -1,6 +1,6 @@
 {
   "name": "jetbrains",
-  "version": "2.9.3",
+  "version": "2.9.4",
   "displayName": "ZenStack JetBrains IDE Plugin",
   "description": "ZenStack JetBrains IDE plugin",
   "homepage": "https://zenstack.dev",
diff --git a/packages/language/package.json b/packages/language/package.json
@@ -1,6 +1,6 @@
 {
     "name": "@zenstackhq/language",
-    "version": "2.9.3",
+    "version": "2.9.4",
     "displayName": "ZenStack modeling language compiler",
     "description": "ZenStack modeling language compiler",
     "homepage": "https://zenstack.dev",
diff --git a/packages/misc/redwood/package.json b/packages/misc/redwood/package.json
@@ -1,7 +1,7 @@
 {
     "name": "@zenstackhq/redwood",
     "displayName": "ZenStack RedwoodJS Integration",
-    "version": "2.9.3",
+    "version": "2.9.4",
     "description": "CLI and runtime for integrating ZenStack with RedwoodJS projects.",
     "repository": {
         "type": "git",
diff --git a/packages/plugins/openapi/package.json b/packages/plugins/openapi/package.json
@@ -1,7 +1,7 @@
 {
   "name": "@zenstackhq/openapi",
   "displayName": "ZenStack Plugin and Runtime for OpenAPI",
-  "version": "2.9.3",
+  "version": "2.9.4",
   "description": "ZenStack plugin and runtime supporting OpenAPI",
   "main": "index.js",
   "repository": {
diff --git a/packages/plugins/openapi/src/rest-generator.ts b/packages/plugins/openapi/src/rest-generator.ts
@@ -857,10 +857,8 @@ export class RESTfulOpenAPIGenerator extends OpenAPIGeneratorBase {
 
     private generateModelEntity(model: DataModel, mode: 'read' | 'create' | 'update'): OAPI.SchemaObject {
         const idFields = model.fields.filter((f) => isIdField(f));
-        // For compound ids each component is also exposed as a separate fields for read operations,
-        // but not required for write operations
-        const fields =
-            idFields.length > 1 && mode === 'read' ? model.fields : model.fields.filter((f) => !isIdField(f));
+        // For compound ids each component is also exposed as a separate fields.
+        const fields = idFields.length > 1 ? model.fields : model.fields.filter((f) => !isIdField(f));
 
         const attributes: Record<string, OAPI.SchemaObject> = {};
         const relationships: Record<string, OAPI.ReferenceObject | OAPI.SchemaObject> = {};
@@ -911,7 +909,7 @@ export class RESTfulOpenAPIGenerator extends OpenAPIGeneratorBase {
         if (mode === 'create') {
             // 'id' is required if there's no default value
             const idFields = model.fields.filter((f) => isIdField(f));
-            if (idFields.length && idFields.every((f) => !hasAttribute(f, '@default'))) {
+            if (idFields.length === 1 && !hasAttribute(idFields[0], '@default')) {
                 properties = { id: { type: 'string' }, ...properties };
                 toplevelRequired.unshift('id');
             }
diff --git a/packages/plugins/openapi/tests/baseline/rest-3.0.0.baseline.yaml b/packages/plugins/openapi/tests/baseline/rest-3.0.0.baseline.yaml
@@ -3123,14 +3123,11 @@ components:
                     type: object
                     description: The "PostLike" model
                     required:
-                        - id
                         - type
                         - attributes
                     properties:
                         type:
                             type: string
-                        attributes:
-                            type: object
                         relationships:
                             type: object
                             properties:
diff --git a/packages/plugins/openapi/tests/baseline/rest-3.1.0.baseline.yaml b/packages/plugins/openapi/tests/baseline/rest-3.1.0.baseline.yaml
@@ -3135,7 +3135,6 @@ components:
                     type: object
                     description: The "PostLike" model
                     required:
-                        - id
                         - type
                         - attributes
                     properties:
diff --git a/packages/plugins/swr/package.json b/packages/plugins/swr/package.json
@@ -1,7 +1,7 @@
 {
     "name": "@zenstackhq/swr",
     "displayName": "ZenStack plugin for generating SWR hooks",
-    "version": "2.9.3",
+    "version": "2.9.4",
     "description": "ZenStack plugin for generating SWR hooks",
     "main": "index.js",
     "repository": {
diff --git a/packages/plugins/tanstack-query/package.json b/packages/plugins/tanstack-query/package.json
@@ -1,7 +1,7 @@
 {
     "name": "@zenstackhq/tanstack-query",
     "displayName": "ZenStack plugin for generating tanstack-query hooks",
-    "version": "2.9.3",
+    "version": "2.9.4",
     "description": "ZenStack plugin for generating tanstack-query hooks",
     "main": "index.js",
     "exports": {
diff --git a/packages/plugins/tanstack-query/tests/react-hooks-v5.test.tsx b/packages/plugins/tanstack-query/tests/react-hooks-v5.test.tsx
@@ -387,7 +387,7 @@ describe('Tanstack Query React Hooks V5 Test', () => {
             expect(userResult.current.data).toHaveLength(1);
         });
 
-        // pupulate the cache with a category
+        // populate the cache with a category
         const categoryData: any[] = [{ id: '1', name: 'category1', posts: [] }];
 
         nock(BASE_URL)
@@ -501,7 +501,7 @@ describe('Tanstack Query React Hooks V5 Test', () => {
     it('optimistic update with optional one-to-many relationship', async () => {
         const { queryClient, wrapper } = createWrapper();
 
-        // populate the cache with a post, with an optional category relatonship
+        // populate the cache with a post, with an optional category relationship
         const postData: any = {
             id: '1',
             title: 'post1',
diff --git a/packages/plugins/tanstack-query/tests/test-model-meta.ts b/packages/plugins/tanstack-query/tests/test-model-meta.ts
@@ -59,7 +59,6 @@ export const modelMeta: ModelMeta = {
                     type: 'Category',
                     name: 'category',
                     isDataModel: true,
-                    isOptional: true,
                     isRelationOwner: true,
                     backLink: 'posts',
                     foreignKeyMapping: { id: 'categoryId' },
diff --git a/packages/plugins/trpc/package.json b/packages/plugins/trpc/package.json
@@ -1,7 +1,7 @@
 {
     "name": "@zenstackhq/trpc",
     "displayName": "ZenStack plugin for tRPC",
-    "version": "2.9.3",
+    "version": "2.9.4",
     "description": "ZenStack plugin for tRPC",
     "main": "index.js",
     "repository": {
diff --git a/packages/runtime/package.json b/packages/runtime/package.json
@@ -1,7 +1,7 @@
 {
     "name": "@zenstackhq/runtime",
     "displayName": "ZenStack Runtime Library",
-    "version": "2.9.3",
+    "version": "2.9.4",
     "description": "Runtime of ZenStack for both client-side and server-side environments.",
     "repository": {
         "type": "git",
diff --git a/packages/schema/package.json b/packages/schema/package.json
@@ -3,7 +3,7 @@
     "publisher": "zenstack",
     "displayName": "ZenStack Language Tools",
     "description": "FullStack enhancement for Prisma ORM: seamless integration from database to UI",
-    "version": "2.9.3",
+    "version": "2.9.4",
     "author": {
         "name": "ZenStack Team"
     },
diff --git a/packages/sdk/package.json b/packages/sdk/package.json
@@ -1,6 +1,6 @@
 {
     "name": "@zenstackhq/sdk",
-    "version": "2.9.3",
+    "version": "2.9.4",
     "description": "ZenStack plugin development SDK",
     "main": "index.js",
     "scripts": {
diff --git a/packages/server/package.json b/packages/server/package.json
@@ -1,6 +1,6 @@
 {
     "name": "@zenstackhq/server",
-    "version": "2.9.3",
+    "version": "2.9.4",
     "displayName": "ZenStack Server-side Adapters",
     "description": "ZenStack server-side adapters",
     "homepage": "https://zenstack.dev",
diff --git a/packages/server/src/api/rest/index.ts b/packages/server/src/api/rest/index.ts
@@ -209,6 +209,13 @@ class RequestHandler extends APIHandlerBase {
         data: z.array(z.object({ type: z.string(), id: z.union([z.string(), z.number()]) })),
     });
 
+    private upsertMetaSchema = z.object({
+        meta: z.object({
+            operation: z.literal('upsert'),
+            matchFields: z.array(z.string()).min(1),
+        }),
+    });
+
     // all known types and their metadata
     private typeMap: Record<string, ModelInfo>;
 
@@ -309,8 +316,29 @@ class RequestHandler extends APIHandlerBase {
 
                     let match = this.urlPatterns.collection.match(path);
                     if (match) {
-                        // resource creation
-                        return await this.processCreate(prisma, match.type, query, requestBody, modelMeta, zodSchemas);
+                        const body = requestBody as any;
+                        const upsertMeta = this.upsertMetaSchema.safeParse(body);
+                        if (upsertMeta.success) {
+                            // resource upsert
+                            return await this.processUpsert(
+                                prisma,
+                                match.type,
+                                query,
+                                requestBody,
+                                modelMeta,
+                                zodSchemas
+                            );
+                        } else {
+                            // resource creation
+                            return await this.processCreate(
+                                prisma,
+                                match.type,
+                                query,
+                                requestBody,
+                                modelMeta,
+                                zodSchemas
+                            );
+                        }
                     }
 
                     match = this.urlPatterns.relationship.match(path);
@@ -809,6 +837,90 @@ class RequestHandler extends APIHandlerBase {
         };
     }
 
+    private async processUpsert(
+        prisma: DbClientContract,
+        type: string,
+        _query: Record<string, string | string[]> | undefined,
+        requestBody: unknown,
+        modelMeta: ModelMeta,
+        zodSchemas?: ZodSchemas
+    ) {
+        const typeInfo = this.typeMap[type];
+        if (!typeInfo) {
+            return this.makeUnsupportedModelError(type);
+        }
+
+        const { error, attributes, relationships } = this.processRequestBody(type, requestBody, zodSchemas, 'create');
+
+        if (error) {
+            return error;
+        }
+
+        const matchFields = this.upsertMetaSchema.parse(requestBody).meta.matchFields;
+
+        const uniqueFields = Object.values(modelMeta.models[type].uniqueConstraints || {}).map((uf) => uf.fields);
+
+        if (
+            !uniqueFields.some((uniqueCombination) => uniqueCombination.every((field) => matchFields.includes(field)))
+        ) {
+            return this.makeError('invalidPayload', 'Match fields must be unique fields', 400);
+        }
+
+        const upsertPayload: any = {
+            where: this.makeUpsertWhere(matchFields, attributes, typeInfo),
+            create: { ...attributes },
+            update: {
+                ...Object.fromEntries(Object.entries(attributes).filter((e) => !matchFields.includes(e[0]))),
+            },
+        };
+
+        if (relationships) {
+            for (const [key, data] of Object.entries<any>(relationships)) {
+                if (!data?.data) {
+                    return this.makeError('invalidRelationData');
+                }
+
+                const relationInfo = typeInfo.relationships[key];
+                if (!relationInfo) {
+                    return this.makeUnsupportedRelationshipError(type, key, 400);
+                }
+
+                if (relationInfo.isCollection) {
+                    upsertPayload.create[key] = {
+                        connect: enumerate(data.data).map((item: any) =>
+                            this.makeIdConnect(relationInfo.idFields, item.id)
+                        ),
+                    };
+                    upsertPayload.update[key] = {
+                        set: enumerate(data.data).map((item: any) =>
+                            this.makeIdConnect(relationInfo.idFields, item.id)
+                        ),
+                    };
+                } else {
+                    if (typeof data.data !== 'object') {
+                        return this.makeError('invalidRelationData');
+                    }
+                    upsertPayload.create[key] = {
+                        connect: this.makeIdConnect(relationInfo.idFields, data.data.id),
+                    };
+                    upsertPayload.update[key] = {
+                        connect: this.makeIdConnect(relationInfo.idFields, data.data.id),
+                    };
+                }
+            }
+        }
+
+        // include IDs of relation fields so that they can be serialized.
+        this.includeRelationshipIds(type, upsertPayload, 'include');
+
+        const entity = await prisma[type].upsert(upsertPayload);
+
+        return {
+            status: 201,
+            body: await this.serializeItems(type, entity),
+        };
+    }
+
     private async processRelationshipCRUD(
         prisma: DbClientContract,
         mode: 'create' | 'update' | 'delete',
@@ -959,7 +1071,7 @@ class RequestHandler extends APIHandlerBase {
                         return this.makeError('invalidRelationData');
                     }
                     updatePayload.data[key] = {
-                        set: {
+                        connect: {
                             [this.makePrismaIdKey(relationInfo.idFields)]: data.data.id,
                         },
                     };
@@ -1296,6 +1408,24 @@ class RequestHandler extends APIHandlerBase {
         return idFields.map((idf) => item[idf.name]).join(this.idDivider);
     }
 
+    private makeUpsertWhere(matchFields: any[], attributes: any, typeInfo: ModelInfo) {
+        const where = matchFields.reduce((acc: any, field: string) => {
+            acc[field] = attributes[field] ?? null;
+            return acc;
+        }, {});
+
+        if (
+            typeInfo.idFields.length > 1 &&
+            matchFields.some((mf) => typeInfo.idFields.map((idf) => idf.name).includes(mf))
+        ) {
+            return {
+                [this.makePrismaIdKey(typeInfo.idFields)]: where,
+            };
+        }
+
+        return where;
+    }
+
     private includeRelationshipIds(model: string, args: any, mode: 'select' | 'include') {
         const typeInfo = this.typeMap[model];
         if (!typeInfo) {
diff --git a/packages/server/tests/api/rest.test.ts b/packages/server/tests/api/rest.test.ts
diff --git a/packages/testtools/package.json b/packages/testtools/package.json

Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "zenstack-monorepo",`
`3`		`- "version": "2.9.3",`
	`3`	`+ "version": "2.9.4",`
`4`	`4`	`"description": "",`
`5`	`5`	`"scripts": {`
`6`	`6`	`"build": "pnpm -r build",`
Original file line number	Diff line number	Diff line change
`@@ -9,7 +9,7 @@ plugins {`
`9`	`9`	`}`
`10`	`10`
`11`	`11`	`group = "dev.zenstack"`
`12`		`-version = "2.9.3"`
	`12`	`+version = "2.9.4"`
`13`	`13`
`14`	`14`	`repositories {`
`15`	`15`	`mavenCentral()`
Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "jetbrains",`
`3`		`- "version": "2.9.3",`
	`3`	`+ "version": "2.9.4",`
`4`	`4`	`"displayName": "ZenStack JetBrains IDE Plugin",`
`5`	`5`	`"description": "ZenStack JetBrains IDE plugin",`
`6`	`6`	`"homepage": "https://zenstack.dev",`
Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "@zenstackhq/language",`
`3`		`- "version": "2.9.3",`
	`3`	`+ "version": "2.9.4",`
`4`	`4`	`"displayName": "ZenStack modeling language compiler",`
`5`	`5`	`"description": "ZenStack modeling language compiler",`
`6`	`6`	`"homepage": "https://zenstack.dev",`
Original file line number	Diff line number	Diff line change
`@@ -1,7 +1,7 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "@zenstackhq/redwood",`
`3`	`3`	`"displayName": "ZenStack RedwoodJS Integration",`
`4`		`- "version": "2.9.3",`
	`4`	`+ "version": "2.9.4",`
`5`	`5`	`"description": "CLI and runtime for integrating ZenStack with RedwoodJS projects.",`
`6`	`6`	`"repository": {`
`7`	`7`	`"type": "git",`
Original file line number	Diff line number	Diff line change
`@@ -1,7 +1,7 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "@zenstackhq/openapi",`
`3`	`3`	`"displayName": "ZenStack Plugin and Runtime for OpenAPI",`
`4`		`- "version": "2.9.3",`
	`4`	`+ "version": "2.9.4",`
`5`	`5`	`"description": "ZenStack plugin and runtime supporting OpenAPI",`
`6`	`6`	`"main": "index.js",`
`7`	`7`	`"repository": {`
Original file line number	Diff line number	Diff line change
`@@ -1,7 +1,7 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "@zenstackhq/swr",`
`3`	`3`	`"displayName": "ZenStack plugin for generating SWR hooks",`
`4`		`- "version": "2.9.3",`
	`4`	`+ "version": "2.9.4",`
`5`	`5`	`"description": "ZenStack plugin for generating SWR hooks",`
`6`	`6`	`"main": "index.js",`
`7`	`7`	`"repository": {`