fix: improve consistency of generated guard code (#616)

ymc9 · web-flow · commit 1b7b5bda3f51 · 2023-08-05T17:58:15.000+08:00
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
     "name": "zenstack-monorepo",
-    "version": "1.0.0-beta.13",
+    "version": "1.0.0-beta.15",
     "description": "",
     "scripts": {
         "build": "pnpm -r build",
diff --git a/packages/language/package.json b/packages/language/package.json
@@ -1,6 +1,6 @@
 {
     "name": "@zenstackhq/language",
-    "version": "1.0.0-beta.13",
+    "version": "1.0.0-beta.15",
     "displayName": "ZenStack modeling language compiler",
     "description": "ZenStack modeling language compiler",
     "homepage": "https://zenstack.dev",
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": "1.0.0-beta.13",
+  "version": "1.0.0-beta.15",
   "description": "ZenStack plugin and runtime supporting OpenAPI",
   "main": "index.js",
   "repository": {
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": "1.0.0-beta.13",
+    "version": "1.0.0-beta.15",
     "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": "1.0.0-beta.13",
+    "version": "1.0.0-beta.15",
     "description": "ZenStack plugin for generating tanstack-query hooks",
     "main": "index.js",
     "exports": {
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": "1.0.0-beta.13",
+    "version": "1.0.0-beta.15",
     "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": "1.0.0-beta.13",
+    "version": "1.0.0-beta.15",
     "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": "A toolkit for building secure CRUD apps with Next.js + Typescript",
-    "version": "1.0.0-beta.13",
+    "version": "1.0.0-beta.15",
     "author": {
         "name": "ZenStack Team"
     },
diff --git a/packages/schema/src/plugins/access-policy/expression-writer.ts b/packages/schema/src/plugins/access-policy/expression-writer.ts
@@ -43,8 +43,8 @@ type FilterOperators =
 
 // { OR: [] } filters to nothing, { AND: [] } includes everything
 // https://www.prisma.io/docs/concepts/components/prisma-client/null-and-undefined#the-effect-of-null-and-undefined-on-conditionals
-const TRUE = '{ AND: [] }';
-const FALSE = '{ OR: [] }';
+export const TRUE = '{ AND: [] }';
+export const FALSE = '{ OR: [] }';
 
 /**
  * Utility for writing ZModel expression as Prisma query argument objects into a ts-morph writer
diff --git a/packages/schema/src/plugins/access-policy/policy-guard-generator.ts b/packages/schema/src/plugins/access-policy/policy-guard-generator.ts
@@ -50,7 +50,7 @@ import {
     TypeScriptExpressionTransformerError,
 } from '../../utils/typescript-expression-transformer';
 import { ALL_OPERATION_KINDS, getDefaultOutputFolder } from '../plugin-utils';
-import { ExpressionWriter } from './expression-writer';
+import { ExpressionWriter, FALSE, TRUE } from './expression-writer';
 import { isFutureExpr } from './utils';
 
 /**
@@ -414,10 +414,10 @@ export default class PolicyGenerator {
                 });
                 try {
                     denies.forEach((rule) => {
-                        writer.write(`if (${transformer.transform(rule, false)}) { return false; }`);
+                        writer.write(`if (${transformer.transform(rule, false)}) { return ${FALSE}; }`);
                     });
                     allows.forEach((rule) => {
-                        writer.write(`if (${transformer.transform(rule, false)}) { return true; }`);
+                        writer.write(`if (${transformer.transform(rule, false)}) { return ${TRUE}; }`);
                     });
                 } catch (err) {
                     if (err instanceof TypeScriptExpressionTransformerError) {
@@ -426,7 +426,7 @@ export default class PolicyGenerator {
                         throw err;
                     }
                 }
-                writer.write('return false;');
+                writer.write(`return ${FALSE};`);
             });
         } else {
             statements.push((writer) => {
diff --git a/packages/sdk/package.json b/packages/sdk/package.json
@@ -1,6 +1,6 @@
 {
     "name": "@zenstackhq/sdk",
-    "version": "1.0.0-beta.13",
+    "version": "1.0.0-beta.15",
     "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": "1.0.0-beta.13",
+    "version": "1.0.0-beta.15",
     "displayName": "ZenStack Server-side Adapters",
     "description": "ZenStack server-side adapters",
     "homepage": "https://zenstack.dev",
diff --git a/packages/testtools/package.json b/packages/testtools/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@zenstackhq/testtools",
-  "version": "1.0.0-beta.13",
+  "version": "1.0.0-beta.15",
   "description": "ZenStack Test Tools",
   "main": "index.js",
   "publishConfig": {
diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml
diff --git a/tests/integration/tests/plugins/policy.test.ts b/tests/integration/tests/plugins/policy.test.ts
@@ -13,6 +13,9 @@ describe('Policy plugin tests', () => {
         process.chdir(origDir);
     });
 
+    const TRUE = { AND: [] };
+    const FALSE = { OR: [] };
+
     it('short-circuit', async () => {
         const model = `
 model User {
@@ -33,18 +36,18 @@ model M {
 
         const { policy } = await loadSchema(model);
 
-        expect(policy.guard.m.read({ user: undefined })).toEqual(false);
-        expect(policy.guard.m.read({ user: { id: '1' } })).toEqual(true);
+        expect(policy.guard.m.read({ user: undefined })).toEqual(FALSE);
+        expect(policy.guard.m.read({ user: { id: '1' } })).toEqual(TRUE);
 
-        expect(policy.guard.m.create({ user: undefined })).toEqual(false);
-        expect(policy.guard.m.create({ user: { id: '1' } })).toEqual(false);
-        expect(policy.guard.m.create({ user: { id: '1', value: 0 } })).toEqual(false);
-        expect(policy.guard.m.create({ user: { id: '1', value: 1 } })).toEqual(true);
+        expect(policy.guard.m.create({ user: undefined })).toEqual(FALSE);
+        expect(policy.guard.m.create({ user: { id: '1' } })).toEqual(FALSE);
+        expect(policy.guard.m.create({ user: { id: '1', value: 0 } })).toEqual(FALSE);
+        expect(policy.guard.m.create({ user: { id: '1', value: 1 } })).toEqual(TRUE);
 
-        expect(policy.guard.m.update({ user: undefined })).toEqual(false);
-        expect(policy.guard.m.update({ user: { id: '1' } })).toEqual(false);
-        expect(policy.guard.m.update({ user: { id: '1', value: 0 } })).toEqual(false);
-        expect(policy.guard.m.update({ user: { id: '1', value: 1 } })).toEqual(true);
+        expect(policy.guard.m.update({ user: undefined })).toEqual(FALSE);
+        expect(policy.guard.m.update({ user: { id: '1' } })).toEqual(FALSE);
+        expect(policy.guard.m.update({ user: { id: '1', value: 0 } })).toEqual(FALSE);
+        expect(policy.guard.m.update({ user: { id: '1', value: 1 } })).toEqual(TRUE);
     });
 
     it('no short-circuit', async () => {

Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "zenstack-monorepo",`
`3`		`- "version": "1.0.0-beta.13",`
	`3`	`+ "version": "1.0.0-beta.15",`
`4`	`4`	`"description": "",`
`5`	`5`	`"scripts": {`
`6`	`6`	`"build": "pnpm -r build",`
Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "@zenstackhq/language",`
`3`		`- "version": "1.0.0-beta.13",`
	`3`	`+ "version": "1.0.0-beta.15",`
`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/openapi",`
`3`	`3`	`"displayName": "ZenStack Plugin and Runtime for OpenAPI",`
`4`		`- "version": "1.0.0-beta.13",`
	`4`	`+ "version": "1.0.0-beta.15",`
`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": "1.0.0-beta.13",`
	`4`	`+ "version": "1.0.0-beta.15",`
`5`	`5`	`"description": "ZenStack plugin for generating SWR hooks",`
`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/tanstack-query",`
`3`	`3`	`"displayName": "ZenStack plugin for generating tanstack-query hooks",`
`4`		`- "version": "1.0.0-beta.13",`
	`4`	`+ "version": "1.0.0-beta.15",`
`5`	`5`	`"description": "ZenStack plugin for generating tanstack-query hooks",`
`6`	`6`	`"main": "index.js",`
`7`	`7`	`"exports": {`
Original file line number	Diff line number	Diff line change
`@@ -1,7 +1,7 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "@zenstackhq/trpc",`
`3`	`3`	`"displayName": "ZenStack plugin for tRPC",`
`4`		`- "version": "1.0.0-beta.13",`
	`4`	`+ "version": "1.0.0-beta.15",`
`5`	`5`	`"description": "ZenStack plugin for tRPC",`
`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/runtime",`
`3`	`3`	`"displayName": "ZenStack Runtime Library",`
`4`		`- "version": "1.0.0-beta.13",`
	`4`	`+ "version": "1.0.0-beta.15",`
`5`	`5`	`"description": "Runtime of ZenStack for both client-side and server-side environments.",`
`6`	`6`	`"repository": {`
`7`	`7`	`"type": "git",`