@lokalise/prisma-utils 1.0.0

package/LICENSE.md

@@ -0,0 +1,13 @@
+Copyright 2024 Lokalise, Inc.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+     http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

package/README.md

@@ -0,0 +1,16 @@
+# Prisma utils
+
+This package provides reusable helpers for Prisma query builder.
+
+# Usage
+
+```typescript
+import { prismaTransaction } from '@lokalise/prisma-utils'
+
+const result: Either<unknown, [Item, Segment]> = await prismaTransaction(prisma, [
+	prisma.item.create({ data: TEST_ITEM_1 }),
+	prisma.segment.create({ data: TEST_SEGMENT_1 }),
+])
+```
+
+This implementation will retry the transaction on P2034 error, which satisfies Prisma recommendations for distributed databases such as CockroachDB.

package/dist/index.cjs

@@ -0,0 +1,2 @@
+"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const i=require("@lokalise/node-core"),o=r=>!!r&&i.isError(r)&&"code"in r&&typeof r.code=="string"&&r.code.startsWith("P"),a="P2025",R="P2034",c="P2002",I=async(r,n,t={retriesAllowed:3})=>{let e,s=0;for(;s<t.retriesAllowed&&(e=await _(r,n,t),!(e.result||!o(e.error)||e.error.code!==R));)s++;return e??{error:new Error("No transaction retry executed")}},_=async(r,n,t)=>{try{return{result:await r.$transaction(n,t)}}catch(e){return{error:e}}};exports.PRISMA_NOT_FOUND_ERROR=a;exports.PRISMA_SERIALIZATION_ERROR=R;exports.PRISMA_UNIQUE_CONSTRAINT_ERROR=c;exports.isPrismaClientKnownRequestError=o;exports.prismaTransaction=I;
+//# sourceMappingURL=index.cjs.map

package/dist/index.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.cjs","sources":["../src/prismaError.ts","../src/prismaTransaction.ts"],"sourcesContent":["import { PrismaClientKnownRequestError } from '@prisma/client/runtime/library'\nimport { isError } from '@lokalise/node-core'\n\n/**\n * What is checked?\n * \t1. error is defined and not null\n * \t2. error is an `Error`\n * \t3. error contains the field code which is a string\n * \t4. code starts by `P` ([doc](https://www.prisma.io/docs/reference/api-reference/error-reference#error-codes))\n */\nexport const isPrismaClientKnownRequestError = (\n\terror: unknown,\n): error is PrismaClientKnownRequestError =>\n\t!!error &&\n\tisError(error) &&\n\t'code' in error &&\n\ttypeof error.code === 'string' &&\n\terror.code.startsWith('P')\n\n/*\n * Prisma error code P2025 indicates that the operation failed because it depends on one or more\n * records that were required but not found\n */\nexport const PRISMA_NOT_FOUND_ERROR = 'P2025'\n\n/*\n * Prisma error code P2034 indicates a serialization error and that the transaction must be retried.\n * A different error code would indicate that an internal state error happened and that\n * the cluster itself is experiencing an issue which requires intervention\n */\nexport const PRISMA_SERIALIZATION_ERROR = 'P2034'\n\n/*\n * Prisma error code P2002 indicates that the operation failed because a unique constraint was\n * violated. This can happen if you try to create a record with a unique field that already exists\n */\nexport const PRISMA_UNIQUE_CONSTRAINT_ERROR = 'P2002'\n","import type { Either } from '@lokalise/node-core'\n\nimport type { PrismaClient, Prisma } from '@prisma/client'\nimport type * as runtime from '@prisma/client/runtime/library'\n\nimport { isPrismaClientKnownRequestError, PRISMA_SERIALIZATION_ERROR } from './prismaError'\nimport type { Types } from '@prisma/client/runtime/library'\n\nexport type PrismaTransactionOptions = {\n\tretriesAllowed: number\n\tmaxWait?: number\n\ttimeout?: number\n\tisolationLevel?: string\n}\n\nexport type PrismaTransactionBasicOptions = Pick<\n\tPrismaTransactionOptions,\n\t'retriesAllowed' | 'isolationLevel'\n>\n\nexport type PrismaTransactionClient = Omit<PrismaClient, runtime.ITXClientDenyList>\n\nexport type PrismaTransactionFn<T> = (prisma: PrismaTransactionClient) => Promise<T>\n\ntype PrismaTransactionReturnType<T> = Either<\n\tunknown,\n\tT | Types.Utils.UnwrapTuple<Prisma.PrismaPromise<unknown>[]>\n>\n\n/**\n * Perform a Prisma DB transaction with automatic retries if needed.\n *\n * @template T | T extends Prisma.PrismaPromise<unknown>[]\n * @param {PrismaClient} prisma\n * @param {PrismaTransactionFn<T> | Prisma.PrismaPromise<unknown>[]} arg\t\t operation to perform into the transaction\n * @param {PrismaTransactionOptions | PrismaTransactionBasicOptions} options transaction configuration\n * @return {Promise<PrismaTransactionReturnType<T>>}\n */\nexport const prismaTransaction = (async <T>(\n\tprisma: PrismaClient,\n\targ: PrismaTransactionFn<T>,\n\toptions: PrismaTransactionOptions = { retriesAllowed: 3 },\n): Promise<PrismaTransactionReturnType<T>> => {\n\tlet result: PrismaTransactionReturnType<T> | undefined = undefined\n\n\tlet retries = 0\n\twhile (retries < options.retriesAllowed) {\n\t\tresult = await executeTransactionTry(prisma, arg, options)\n\n\t\tif (\n\t\t\tresult.result ||\n\t\t\t!isPrismaClientKnownRequestError(result.error) ||\n\t\t\tresult.error.code !== PRISMA_SERIALIZATION_ERROR\n\t\t) {\n\t\t\tbreak\n\t\t}\n\n\t\tretries++\n\t}\n\n\treturn result ?? { error: new Error('No transaction retry executed') }\n}) as {\n\t<T>(\n\t\tprisma: PrismaClient,\n\t\tfn: PrismaTransactionFn<T>,\n\t\toptions?: PrismaTransactionOptions,\n\t): Promise<Either<unknown, T>>\n\t<T extends Prisma.PrismaPromise<unknown>[]>(\n\t\tprisma: PrismaClient,\n\t\targs: [...T],\n\t\toptions?: PrismaTransactionBasicOptions,\n\t): Promise<Either<unknown, runtime.Types.Utils.UnwrapTuple<T>>>\n}\n\nconst executeTransactionTry = async <T>(\n\tprisma: PrismaClient,\n\targ: PrismaTransactionFn<T>,\n\toptions: PrismaTransactionOptions,\n): Promise<PrismaTransactionReturnType<T>> => {\n\ttry {\n\t\treturn {\n\t\t\t// @ts-ignore\n\t\t\tresult: await prisma.$transaction<T>(arg, options),\n\t\t}\n\t} catch (error) {\n\t\treturn { error }\n\t}\n}\n"],"names":["isPrismaClientKnownRequestError","error","isError","PRISMA_NOT_FOUND_ERROR","PRISMA_SERIALIZATION_ERROR","PRISMA_UNIQUE_CONSTRAINT_ERROR","prismaTransaction","prisma","arg","options","result","retries","executeTransactionTry"],"mappings":"uHAUaA,EACZC,GAEA,CAAC,CAACA,GACFC,UAAQD,CAAK,GACb,SAAUA,GACV,OAAOA,EAAM,MAAS,UACtBA,EAAM,KAAK,WAAW,GAAG,EAMbE,EAAyB,QAOzBC,EAA6B,QAM7BC,EAAiC,QCEjCC,EAAqB,MACjCC,EACAC,EACAC,EAAoC,CAAE,eAAgB,KACT,CAC7C,IAAIC,EAEAC,EAAU,EACP,KAAAA,EAAUF,EAAQ,iBACxBC,EAAS,MAAME,EAAsBL,EAAQC,EAAKC,CAAO,EAGxD,EAAAC,EAAO,QACP,CAACV,EAAgCU,EAAO,KAAK,GAC7CA,EAAO,MAAM,OAASN,KAKvBO,IAGD,OAAOD,GAAU,CAAE,MAAO,IAAI,MAAM,+BAA+B,CAAE,CACtE,EAaME,EAAwB,MAC7BL,EACAC,EACAC,IAC6C,CACzC,GAAA,CACI,MAAA,CAEN,OAAQ,MAAMF,EAAO,aAAgBC,EAAKC,CAAO,CAAA,QAE1CR,EAAO,CACf,MAAO,CAAE,MAAAA,CAAM,CAChB,CACD"}

package/dist/index.d.ts

@@ -0,0 +1,3 @@
+export * from './prismaError';
+export { prismaTransaction } from './prismaTransaction';
+export type { PrismaTransactionOptions, PrismaTransactionBasicOptions } from './prismaTransaction';

package/dist/index.js

@@ -0,0 +1,10 @@
+import { PRISMA_NOT_FOUND_ERROR as I, PRISMA_SERIALIZATION_ERROR as _, PRISMA_UNIQUE_CONSTRAINT_ERROR as o, isPrismaClientKnownRequestError as O } from "./prismaError.js";
+import { prismaTransaction as E } from "./prismaTransaction.js";
+export {
+  I as PRISMA_NOT_FOUND_ERROR,
+  _ as PRISMA_SERIALIZATION_ERROR,
+  o as PRISMA_UNIQUE_CONSTRAINT_ERROR,
+  O as isPrismaClientKnownRequestError,
+  E as prismaTransaction
+};
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sources":[],"sourcesContent":[],"names":[],"mappings":";;"}

package/dist/prismaError.d.ts

@@ -0,0 +1,13 @@
+import { PrismaClientKnownRequestError } from '@prisma/client/runtime/library';
+
+/**
+ * What is checked?
+ * 	1. error is defined and not null
+ * 	2. error is an `Error`
+ * 	3. error contains the field code which is a string
+ * 	4. code starts by `P` ([doc](https://www.prisma.io/docs/reference/api-reference/error-reference#error-codes))
+ */
+export declare const isPrismaClientKnownRequestError: (error: unknown) => error is PrismaClientKnownRequestError;
+export declare const PRISMA_NOT_FOUND_ERROR = "P2025";
+export declare const PRISMA_SERIALIZATION_ERROR = "P2034";
+export declare const PRISMA_UNIQUE_CONSTRAINT_ERROR = "P2002";

package/dist/prismaError.js

@@ -0,0 +1,9 @@
+import { isError as t } from "@lokalise/node-core";
+const o = (R) => !!R && t(R) && "code" in R && typeof R.code == "string" && R.code.startsWith("P"), n = "P2025", i = "P2034", I = "P2002";
+export {
+  n as PRISMA_NOT_FOUND_ERROR,
+  i as PRISMA_SERIALIZATION_ERROR,
+  I as PRISMA_UNIQUE_CONSTRAINT_ERROR,
+  o as isPrismaClientKnownRequestError
+};
+//# sourceMappingURL=prismaError.js.map

package/dist/prismaError.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"prismaError.js","sources":["../src/prismaError.ts"],"sourcesContent":["import { PrismaClientKnownRequestError } from '@prisma/client/runtime/library'\nimport { isError } from '@lokalise/node-core'\n\n/**\n * What is checked?\n * \t1. error is defined and not null\n * \t2. error is an `Error`\n * \t3. error contains the field code which is a string\n * \t4. code starts by `P` ([doc](https://www.prisma.io/docs/reference/api-reference/error-reference#error-codes))\n */\nexport const isPrismaClientKnownRequestError = (\n\terror: unknown,\n): error is PrismaClientKnownRequestError =>\n\t!!error &&\n\tisError(error) &&\n\t'code' in error &&\n\ttypeof error.code === 'string' &&\n\terror.code.startsWith('P')\n\n/*\n * Prisma error code P2025 indicates that the operation failed because it depends on one or more\n * records that were required but not found\n */\nexport const PRISMA_NOT_FOUND_ERROR = 'P2025'\n\n/*\n * Prisma error code P2034 indicates a serialization error and that the transaction must be retried.\n * A different error code would indicate that an internal state error happened and that\n * the cluster itself is experiencing an issue which requires intervention\n */\nexport const PRISMA_SERIALIZATION_ERROR = 'P2034'\n\n/*\n * Prisma error code P2002 indicates that the operation failed because a unique constraint was\n * violated. This can happen if you try to create a record with a unique field that already exists\n */\nexport const PRISMA_UNIQUE_CONSTRAINT_ERROR = 'P2002'\n"],"names":["isPrismaClientKnownRequestError","error","isError","PRISMA_NOT_FOUND_ERROR","PRISMA_SERIALIZATION_ERROR","PRISMA_UNIQUE_CONSTRAINT_ERROR"],"mappings":";AAUO,MAAMA,IAAkC,CAC9CC,MAEA,CAAC,CAACA,KACFC,EAAQD,CAAK,KACb,UAAUA,KACV,OAAOA,EAAM,QAAS,YACtBA,EAAM,KAAK,WAAW,GAAG,GAMbE,IAAyB,SAOzBC,IAA6B,SAM7BC,IAAiC;"}

package/dist/prismaTransaction.d.ts

@@ -0,0 +1,27 @@
+import { Types } from '@prisma/client/runtime/library';
+import { PrismaClient, Prisma } from '@prisma/client';
+import { Either } from '@lokalise/node-core';
+
+import type * as runtime from '@prisma/client/runtime/library';
+export type PrismaTransactionOptions = {
+    retriesAllowed: number;
+    maxWait?: number;
+    timeout?: number;
+    isolationLevel?: string;
+};
+export type PrismaTransactionBasicOptions = Pick<PrismaTransactionOptions, 'retriesAllowed' | 'isolationLevel'>;
+export type PrismaTransactionClient = Omit<PrismaClient, runtime.ITXClientDenyList>;
+export type PrismaTransactionFn<T> = (prisma: PrismaTransactionClient) => Promise<T>;
+/**
+ * Perform a Prisma DB transaction with automatic retries if needed.
+ *
+ * @template T | T extends Prisma.PrismaPromise<unknown>[]
+ * @param {PrismaClient} prisma
+ * @param {PrismaTransactionFn<T> | Prisma.PrismaPromise<unknown>[]} arg		 operation to perform into the transaction
+ * @param {PrismaTransactionOptions | PrismaTransactionBasicOptions} options transaction configuration
+ * @return {Promise<PrismaTransactionReturnType<T>>}
+ */
+export declare const prismaTransaction: {
+    <T>(prisma: PrismaClient, fn: PrismaTransactionFn<T>, options?: PrismaTransactionOptions): Promise<Either<unknown, T>>;
+    <T_1 extends Prisma.PrismaPromise<unknown>[]>(prisma: PrismaClient, args: [...T_1], options?: PrismaTransactionBasicOptions): Promise<Either<unknown, runtime.UnwrapTuple<T_1>>>;
+};

package/dist/prismaTransaction.js

@@ -0,0 +1,20 @@
+import { isPrismaClientKnownRequestError as n, PRISMA_SERIALIZATION_ERROR as s } from "./prismaError.js";
+const l = async (t, o, e = { retriesAllowed: 3 }) => {
+  let r, a = 0;
+  for (; a < e.retriesAllowed && (r = await i(t, o, e), !(r.result || !n(r.error) || r.error.code !== s)); )
+    a++;
+  return r ?? { error: new Error("No transaction retry executed") };
+}, i = async (t, o, e) => {
+  try {
+    return {
+      // @ts-ignore
+      result: await t.$transaction(o, e)
+    };
+  } catch (r) {
+    return { error: r };
+  }
+};
+export {
+  l as prismaTransaction
+};
+//# sourceMappingURL=prismaTransaction.js.map

package/dist/prismaTransaction.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"prismaTransaction.js","sources":["../src/prismaTransaction.ts"],"sourcesContent":["import type { Either } from '@lokalise/node-core'\n\nimport type { PrismaClient, Prisma } from '@prisma/client'\nimport type * as runtime from '@prisma/client/runtime/library'\n\nimport { isPrismaClientKnownRequestError, PRISMA_SERIALIZATION_ERROR } from './prismaError'\nimport type { Types } from '@prisma/client/runtime/library'\n\nexport type PrismaTransactionOptions = {\n\tretriesAllowed: number\n\tmaxWait?: number\n\ttimeout?: number\n\tisolationLevel?: string\n}\n\nexport type PrismaTransactionBasicOptions = Pick<\n\tPrismaTransactionOptions,\n\t'retriesAllowed' | 'isolationLevel'\n>\n\nexport type PrismaTransactionClient = Omit<PrismaClient, runtime.ITXClientDenyList>\n\nexport type PrismaTransactionFn<T> = (prisma: PrismaTransactionClient) => Promise<T>\n\ntype PrismaTransactionReturnType<T> = Either<\n\tunknown,\n\tT | Types.Utils.UnwrapTuple<Prisma.PrismaPromise<unknown>[]>\n>\n\n/**\n * Perform a Prisma DB transaction with automatic retries if needed.\n *\n * @template T | T extends Prisma.PrismaPromise<unknown>[]\n * @param {PrismaClient} prisma\n * @param {PrismaTransactionFn<T> | Prisma.PrismaPromise<unknown>[]} arg\t\t operation to perform into the transaction\n * @param {PrismaTransactionOptions | PrismaTransactionBasicOptions} options transaction configuration\n * @return {Promise<PrismaTransactionReturnType<T>>}\n */\nexport const prismaTransaction = (async <T>(\n\tprisma: PrismaClient,\n\targ: PrismaTransactionFn<T>,\n\toptions: PrismaTransactionOptions = { retriesAllowed: 3 },\n): Promise<PrismaTransactionReturnType<T>> => {\n\tlet result: PrismaTransactionReturnType<T> | undefined = undefined\n\n\tlet retries = 0\n\twhile (retries < options.retriesAllowed) {\n\t\tresult = await executeTransactionTry(prisma, arg, options)\n\n\t\tif (\n\t\t\tresult.result ||\n\t\t\t!isPrismaClientKnownRequestError(result.error) ||\n\t\t\tresult.error.code !== PRISMA_SERIALIZATION_ERROR\n\t\t) {\n\t\t\tbreak\n\t\t}\n\n\t\tretries++\n\t}\n\n\treturn result ?? { error: new Error('No transaction retry executed') }\n}) as {\n\t<T>(\n\t\tprisma: PrismaClient,\n\t\tfn: PrismaTransactionFn<T>,\n\t\toptions?: PrismaTransactionOptions,\n\t): Promise<Either<unknown, T>>\n\t<T extends Prisma.PrismaPromise<unknown>[]>(\n\t\tprisma: PrismaClient,\n\t\targs: [...T],\n\t\toptions?: PrismaTransactionBasicOptions,\n\t): Promise<Either<unknown, runtime.Types.Utils.UnwrapTuple<T>>>\n}\n\nconst executeTransactionTry = async <T>(\n\tprisma: PrismaClient,\n\targ: PrismaTransactionFn<T>,\n\toptions: PrismaTransactionOptions,\n): Promise<PrismaTransactionReturnType<T>> => {\n\ttry {\n\t\treturn {\n\t\t\t// @ts-ignore\n\t\t\tresult: await prisma.$transaction<T>(arg, options),\n\t\t}\n\t} catch (error) {\n\t\treturn { error }\n\t}\n}\n"],"names":["prismaTransaction","prisma","arg","options","result","retries","executeTransactionTry","isPrismaClientKnownRequestError","PRISMA_SERIALIZATION_ERROR","error"],"mappings":";AAsCa,MAAAA,IAAqB,OACjCC,GACAC,GACAC,IAAoC,EAAE,gBAAgB,QACT;AAC7C,MAAIC,GAEAC,IAAU;AACP,SAAAA,IAAUF,EAAQ,mBACxBC,IAAS,MAAME,EAAsBL,GAAQC,GAAKC,CAAO,GAGxD,EAAAC,EAAO,UACP,CAACG,EAAgCH,EAAO,KAAK,KAC7CA,EAAO,MAAM,SAASI;AAKvB,IAAAH;AAGD,SAAOD,KAAU,EAAE,OAAO,IAAI,MAAM,+BAA+B,EAAE;AACtE,GAaME,IAAwB,OAC7BL,GACAC,GACAC,MAC6C;AACzC,MAAA;AACI,WAAA;AAAA;AAAA,MAEN,QAAQ,MAAMF,EAAO,aAAgBC,GAAKC,CAAO;AAAA,IAAA;AAAA,WAE1CM,GAAO;AACf,WAAO,EAAE,OAAAA,EAAM;AAAA,EAChB;AACD;"}

package/package.json

@@ -0,0 +1,66 @@
+{
+	"name": "@lokalise/prisma-utils",
+	"version": "1.0.0",
+	"type": "module",
+	"license": "Apache-2.0",
+	"files": [
+		"dist",
+		"README.md",
+		"LICENSE.md"
+	],
+	"main": "./dist/index.cjs",
+	"module": "./dist/index.js",
+	"types": "./dist/index.d.ts",
+	"homepage": "https://github.com/lokalise/shared-ts-libs",
+	"repository": {
+		"type": "git",
+		"url": "git://github.com/lokalise/shared-ts-libs.git"
+	},
+	"exports": {
+		".": {
+			"types": "./dist/index.d.ts",
+			"require": "./dist/index.cjs",
+			"import": "./dist/index.js"
+		}
+	},
+	"scripts": {
+		"build": "rimraf dist && npm run db:update-client && vite build",
+		"dev": "vite watch",
+		"clean": "rimraf dist .eslintcache",
+		"lint": "eslint --cache --max-warnings=0  && prettier --check --log-level warn src \\\"**/*.{json,md}\\\" && tsc --noEmit",
+		"lint:fix": "eslint  --fix && prettier --write src \\\"**/*.{json,md}\\\"",
+		"docker:start:ci": "docker compose up -d cockroachdb",
+		"db:migration:dev": "dotenv -c test -- dotenv prisma migrate dev",
+		"db:update-client": "dotenv -c test prisma generate",
+		"db:wait": "while ! echo \"SELECT 1;\" | dotenv -c test -- prisma db execute --stdin; do sleep 1; done",
+		"test": "vitest run",
+		"test:migrate": "cross-env NODE_ENV=test dotenv -c test -- prisma migrate reset --force",
+		"pretest:ci": "npm run docker:start:ci && npm run db:wait && npm run test:migrate",
+		"test:ci": "npm run test -- --coverage",
+		"test:ci:teardown": "docker compose down",
+		"prepublishOnly": "npm run build"
+	},
+	"dependencies": {
+		"@lokalise/node-core": "^9.16.0"
+	},
+	"peerDependencies": {
+		"prisma": "^5.12.1",
+		"@prisma/client": "^5.12.1"
+	},
+	"devDependencies": {
+		"@prisma/client": "^5.13.0",
+		"@lokalise/eslint-config": "*",
+		"@lokalise/prettier-config": "*",
+		"@lokalise/package-vite-config": "*",
+		"@vitest/coverage-v8": "^1.5.3",
+		"cross-env": "^7.0.3",
+		"dotenv-cli": "^7.4.1",
+		"prisma": "^5.13.0",
+		"prettier": "^3.2.5",
+		"rimraf": "^5.0.1",
+		"typescript": "5.4.5",
+		"vite": "^5.2.10",
+		"vitest": "^1.5.3"
+	},
+	"prettier": "@lokalise/prettier-config"
+}