@prisma/extension-optimize 0.0.0-dev.202408261522 → 0.0.0-dev.202408261524

package/dist/index.d.ts

@@ -9,29 +9,40 @@ type OptimizeOptions = {
      */
     enable?: boolean;
     /**
-     * The URL of the ingestion service of Prisma Optimize.
+     * A Prisma Optimize API token. Head to the Prisma Optimize dashboard to
+     * create one.
      */
-    ingestionUrl?: string;
+    token: string;
     /**
-     * The URL of the dashboard of Prisma Optimize
+     * The minimum interval (in milliseconds) for sending batched Prisma
+     * operations to the Prisma Optimize interface.
+     *
+     * @default 500
+     * @remarks setting this value too low may impact your app performance.
      */
-    dashboardUrl?: string;
+    sendInterval?: number;
     /**
-     * A Prisma Optimize API token. Head to the Prisma Optimize dashboard to
-     * create one.
+     * The maximum time a query can be waited for before being discarded. If a
+     * query takes too long to complete, it will be discarded. Increase this if
+     * you have very slow queries.
+     *
+     * @default 10000
+     * @remarks when below `minSendInterval`, it defaults to `minSendInterval`.
      */
-    token: string;
+    sendTimeout?: number;
+    /**
+     * The URL of the ingestion service of Prisma Optimize.
+     */
+    ingestionUrl?: string;
     /**
-     * The minimum interval in milliseconds between sending batched requests to the ingestion service.
-     * This is only currently used when tracing is enabled. When tracing is disabled, the requests
-     * are not batched, and are sent immediately on the next event loop tick.
+     * The URL of the dashboard of Prisma Optimize
      */
-    minSendInterval?: number;
+    dashboardUrl?: string;
     /**
      * Whether to show a toast notification when the dashboard is ready.
      */
-    showToast?: boolean;
+    showNotification?: boolean;
 };
-declare function withOptimize({ enable, ingestionUrl, dashboardUrl, minSendInterval, showToast, token, }: OptimizeOptions): (client: any) => _prisma_client_extension.PrismaClientExtends<_prisma_client_runtime_library.InternalArgs<{}, {}, {}, {}> & _prisma_client_runtime_library.DefaultArgs>;
+declare function withOptimize({ enable, ingestionUrl, dashboardUrl, sendInterval, sendTimeout, showNotification, token, }: OptimizeOptions): (client: any) => _prisma_client_extension.PrismaClientExtends<_prisma_client_runtime_library.InternalArgs<{}, {}, {}, {}> & _prisma_client_runtime_library.DefaultArgs>;
 
 export { type OptimizeOptions, PROD_DASHBOARD_URL, PROD_INGESTION_URL, withOptimize };

package/dist/index.js

@@ -1,2 +1,2 @@
-"use strict";var se=Object.create;var h=Object.defineProperty;var re=Object.getOwnPropertyDescriptor;var oe=Object.getOwnPropertyNames;var ae=Object.getPrototypeOf,pe=Object.prototype.hasOwnProperty;var de=(n,e)=>{for(var t in e)h(n,t,{get:e[t],enumerable:!0})},x=(n,e,t,i)=>{if(e&&typeof e=="object"||typeof e=="function")for(let s of oe(e))!pe.call(n,s)&&s!==t&&h(n,s,{get:()=>e[s],enumerable:!(i=re(e,s))||i.enumerable});return n};var m=(n,e,t)=>(t=n!=null?se(ae(n)):{},x(e||!n||!n.__esModule?h(t,"default",{value:n,enumerable:!0}):t,n)),ce=n=>x(h({},"__esModule",{value:!0}),n);var Se={};de(Se,{PROD_DASHBOARD_URL:()=>ee,PROD_INGESTION_URL:()=>K,withOptimize:()=>ge});module.exports=ce(Se);var X=require("@opentelemetry/api"),Y=require("@prisma/client/extension"),Z=m(require("@prisma/debug"));function me(n,e){let t;return async function(i,s,o){let a=new URL(i,n),p=new Headers({"Content-Type":"application/json",Authorization:`Bearer ${e}`});t&&p.set("prisma-optimize-jwt",t);let r=await fetch(a,{method:s,headers:p,body:JSON.stringify(o)});if(!r.ok){let d=await r.text().catch(()=>"<unreadable>");console.error(`[optimize] HTTP ${r.status} ${r.statusText}: ${d}`)}let c=r.headers.get("prisma-optimize-jwt");return c&&(t=c),r}}function P(n,e){let t=me(n,e);return{request:t,post:(i,s)=>t(i,"POST",s)}}async function v(n,e){return await(await n.post("/schema",{schema:e})).text()}var l=m(require("fs")),q=m(require("path")),T=require("stream"),E=require("stream/promises"),A=m(require("kleur")),_=require("node-notifier"),O=m(require("xdg-app-paths")),le="https://avatars.githubusercontent.com/u/17219288?s=96",{bold:ue,underline:he}=A.default;async function k(n){let e=new O.default("prisma-optimize").config();l.default.mkdirSync(e,{recursive:!0});let t=q.default.resolve(e,"avatar.png");if(!l.default.existsSync(t)){let r=await fetch(le);if(r.ok&&r.body!=null){let c=l.default.createWriteStream(t,{flags:"wx"});await(0,E.finished)(T.Readable.fromWeb(r.body).pipe(c))}}let i="See your Optimize dashboard at:",s=i.length,o=`${he(ue(n))}`,a=n.length,p=Math.max(s,a)+2;console.log("\u250C"+"\u2500".repeat(p)+"\u2510"),console.log("\u2502 "+i+" ".repeat(p-s-2)+" \u2502"),console.log("\u2502 "+o+" ".repeat(p-a-2)+" \u2502"),console.log("\u2514"+"\u2500".repeat(p)+"\u2518"),(0,_.notify)({timeout:10,open:n,subtitle:"Your dashboard is ready! \u{1F680} ",message:"Click to open",title:"Prisma Optimize",icon:l.default.existsSync(t)?t:void 0,contentImage:l.default.existsSync(t)?t:void 0})}var L=require("@opentelemetry/api"),N=require("@opentelemetry/context-async-hooks"),U=require("@opentelemetry/instrumentation"),$=require("@opentelemetry/resources"),H=require("@opentelemetry/sdk-trace-base"),y=require("@opentelemetry/semantic-conventions"),D=require("@prisma/instrumentation");var F=m(require("@prisma/debug"));async function M(n,e){await n.post("/ingest",e)}function I(n,...e){setTimeout(()=>{n(...e)},0)}function u(n){return n[0]*1e3+n[1]/1e6}var g=(0,F.default)("prisma:extension:optimize"),f="0000000000000000",j=(o=>(o.ClientOperation="prisma:client:operation",o.ClientConnect="prisma:client:connect",o.Engine="prisma:engine",o.EngineConnection="prisma:engine:connection",o.EngineQuery="prisma:engine:db_query",o))(j||{}),w=class{spanId;timestamp;model;operation;args;statementSpans;duration;connect;error;completionFlags={clientSpanClosed:!1,engineSpanClosed:!1};constructor(e){this.spanId=e.spanId,this.timestamp=e.timestamp,this.model=e.model,this.operation=e.operation,this.args=e.args,this.statementSpans=[]}isCompleted(){return this.completionFlags.clientSpanClosed&&this.completionFlags.engineSpanClosed}statementSpansToString(){return this.statementSpans.sort((t,i)=>{let s=u(t.startTime),o=u(i.startTime);return s-o}).reduce((t,i)=>{let s=i.attributes["db.statement"];return typeof s=="string"?`${t}${s}
-`:(g("sql attribute is not a string: %o",s),t)},"")}toIngestRequestItem(e){if(this.duration===void 0)throw new Error("`duration` is `undefined`, this should not happen");return{ts:this.timestamp,model:this.model??null,operation:this.operation,args:this.args,latency:this.duration,connect:this.connect??!1,sql:this.statementSpansToString(),error:this.error??null,hash:e}}},S=class{#t=new Map;#n=new Map;#i=new Map;#o=new Set;#e=[];#a=Promise.resolve();#p=!1;#c;#m;#s=new Set;#l=Promise.resolve();#d=!1;#u;setSchemaHash=()=>{};__test_internalMetrics__={rescheduledCountTotal:0};constructor(e,t){this.#c=e,this.#m=t,this.#u=new Promise(i=>{this.setSchemaHash=i})}createRequest(e){let t=new w(e);this.#t.set(e.spanId,t)}setRequestError(e,t){let i=this.#t.get(e);if(!i)throw new Error(`Unknown request ${e}`);i.error=t}#S(e){for(let t=e;t!==f;t=this.#n.get(t)){if(t===void 0)return{type:"UndeliveredSpanInTree"};let i=this.#t.get(t);if(i)return{type:"Ok",request:i}}return{type:"NotInRequestTree"}}onStart(e,t){if(!z(e))return;let i=e.spanContext().spanId;if(!e.parentSpanId){this.#n.set(i,f);return}if(this.#n.set(i,e.parentSpanId),e.parentSpanId===f)return;let s=this.#i.get(e.parentSpanId);s?s.add(i):this.#i.set(e.parentSpanId,new Set([i])),e.name==="prisma:engine:connection"&&this.#o.add(i)}onEnd(e){z(e)?this.#h(e):(e.parentSpanId===void 0||e.parentSpanId===f)&&this.#r(e.spanContext().spanId)}async forceFlush(){await this.#a,await this.#g()}async shutdown(){await this.forceFlush()}#h(e){let t=e.spanContext().spanId,i,s=this.#S(t);switch(s.type){case"Ok":i=s.request;break;case"UndeliveredSpanInTree":this.#y(e);break;case"NotInRequestTree":this.#r(t);break}i&&(e.name==="prisma:client:connect"&&(i.connect=u(e.duration)),e.name==="prisma:engine"&&(i.completionFlags.engineSpanClosed=!0),e.name==="prisma:engine:db_query"&&!this.#o.has(e.parentSpanId)&&i.statementSpans.push(e),e.name==="prisma:client:operation"&&(i.duration=u(e.duration),i.completionFlags.clientSpanClosed=!0,g("latency otel: %d",i.duration)),i.isCompleted()&&this.#w(i))}#y(e){this.#e.push(e),this.__test_internalMetrics__.rescheduledCountTotal++;let{spanId:t,traceId:i}=e.spanContext();g("rescheduled ",e.name,t,e.parentSpanId,i),!this.#p&&(this.#p=!0,this.#a=Promise.all([this.#a,new Promise(I).then(()=>this.#C())]))}#C(){let e=this.#e;this.#e=[],this.#p=!1;for(let t of e)this.#h(t)}#r(e){this.#n.delete(e),this.#o.delete(e);let t=this.#i.get(e);if(this.#i.delete(e),this.#I(e),t)for(let i of t)this.#r(i)}#I(e){for(let t=this.#f(e);t!==-1;t=this.#f(e))this.#e.splice(t,1)}#f(e){return this.#e.findIndex(t=>t.spanContext().spanId===e)}#w(e){I(()=>{this.#t.delete(e.spanId),this.#r(e.spanId),this.#s.add(e),this.#R()})}async#R(){await this.#l,!this.#d&&(this.#d=!0,setTimeout(()=>{this.#l=this.#g().finally(()=>{this.#d=!1})},this.#m))}async#g(){if(this.#s.size===0)return;let e=await this.#u,t=[...this.#s].map(i=>i.toIngestRequestItem(e));this.#s.clear(),g("sending batch of %d requests",t.length);try{await M(this.#c,t)}catch(i){console.error(i.message??i)}}};function z(n){return Object.values(j).includes(n.name)}function Q(n,e){let t=new N.AsyncHooksContextManager().enable();L.context.setGlobalContextManager(t);let i=new H.BasicTracerProvider({resource:new $.Resource({[y.SEMRESATTRS_SERVICE_NAME]:"extension-optimize",[y.SEMRESATTRS_SERVICE_VERSION]:"0.0.0"})}),s=new S(n,e);return i.addSpanProcessor(s),(0,U.registerInstrumentations)({tracerProvider:i,instrumentations:[new D.PrismaInstrumentation]}),i.register(),s}function B(n){return n._previewFeatures?.includes("tracing")}function J(n){return n._engineConfig.inlineSchema}function V(n){if(n instanceof Error)return n.stack??n.message;switch(typeof n){case"undefined":return"undefined";case"object":{let e;return n!==null&&typeof n.toString=="function"&&(e=n.toString()),typeof e=="string"&&e!=="[object Object]"?e:JSON.stringify(n)}default:return String(n)}}var G=require("@prisma/client/extension"),W=G.Prisma.defineExtension(n=>n.$extends({}));var K="https://optimize-ingestion.datacdn.workers.dev/",ee="https://optimize.prisma.io",fe=(0,Z.default)("prisma:extension:optimize");function ge({enable:n=!0,ingestionUrl:e=K,dashboardUrl:t=ee,minSendInterval:i=50,showToast:s=!0,token:o}){return n?(s&&k(t).then().catch(a=>{console.error("Failed to show toast",a)}),Y.Prisma.defineExtension(a=>{let p=P(e,o),r=Q(p,i);if(!B(a))throw new Error('Please enable the "tracing" preview feature and regenerate the client.');let c=J(a);return v(p,c).then(d=>{fe("uploaded schema with hash",d),r.setSchemaHash(d)},d=>{console.error(d),console.error("Failed to upload the schema, no data will be sent to Prisma Optimize")}),a.$extends({query:{async $allOperations({query:d,model:te,operation:ne,args:R}){let C=X.trace.getActiveSpan()?.spanContext().spanId;if(!C)throw new Error("prisma:client:operation span is expected to be entered in the client extension when tracing is enabled");r.createRequest({spanId:C,timestamp:Date.now(),model:te,operation:ne,args:R});try{return await d(R)}catch(b){let ie=V(b);throw r.setRequestError(C,ie),b}}}})})):W}0&&(module.exports={PROD_DASHBOARD_URL,PROD_INGESTION_URL,withOptimize});
+"use strict";var K=Object.create;var S=Object.defineProperty;var W=Object.getOwnPropertyDescriptor;var X=Object.getOwnPropertyNames;var Y=Object.getPrototypeOf,ee=Object.prototype.hasOwnProperty;var te=(t,e)=>{for(var n in e)S(t,n,{get:e[n],enumerable:!0})},C=(t,e,n,s)=>{if(e&&typeof e=="object"||typeof e=="function")for(let r of X(e))!ee.call(t,r)&&r!==n&&S(t,r,{get:()=>e[r],enumerable:!(s=W(e,r))||s.enumerable});return t};var ne=(t,e,n)=>(n=t!=null?K(Y(t)):{},C(e||!t||!t.__esModule?S(n,"default",{value:t,enumerable:!0}):n,t)),re=t=>C(S({},"__esModule",{value:!0}),t);var ue={};te(ue,{PROD_DASHBOARD_URL:()=>Q,PROD_INGESTION_URL:()=>J,withOptimize:()=>de});module.exports=re(ue);var N=require("@opentelemetry/api"),D=require("@prisma/client/extension");function se(t,e){let n;return async function(s,r,o){let a=new URL(s,t),m=new Headers({"Content-Type":"application/json",Authorization:`Bearer ${e}`});n&&m.set("prisma-optimize-jwt",n);let p=await fetch(a,{method:r,headers:m,body:JSON.stringify(o)});if(!p.ok){let h=await p.text().catch(()=>"<unreadable>");console.error(`[optimize] HTTP ${p.status} ${p.statusText}: ${h}`)}let u=p.headers.get("prisma-optimize-jwt");return u&&(n=u),p}}function w(t,e){let n=se(t,e);return{request:n,post:(s,r)=>n(s,"POST",r)}}var v=ne(require("kleur"));var{bold:ie,underline:oe}=v.default;function R(t){let e="See your Optimize dashboard at:",n=e.length,s=`${oe(ie(t))}`,r=t.length,o=Math.max(n,r)+2;console.log("\u250C"+"\u2500".repeat(o)+"\u2510"),console.log("\u2502 "+e+" ".repeat(o-n-2)+" \u2502"),console.log("\u2502 "+s+" ".repeat(o-r-2)+" \u2502"),console.log("\u2514"+"\u2500".repeat(o)+"\u2518")}var q=require("@opentelemetry/api"),O=require("@opentelemetry/context-async-hooks"),j=require("@opentelemetry/instrumentation"),_=require("@opentelemetry/resources"),z=require("@opentelemetry/sdk-trace-base"),b=require("@opentelemetry/semantic-conventions"),k=require("@prisma/instrumentation");var i=require("zod");async function P(t,e){e.length>0&&await t.post("/ingest",e)}async function E(t,e){return await(await t.post("/schema",{schema:e})).text()}function c(t){return t[0]*1e3+t[1]/1e6}var l=require("zod"),f=class{spans={};rootSpans={};waitSpans={};treeShape;collectedSpans;collectedRootSpans;sendTimeout;sendInterval;pendingSend;constructor(e){this.treeShape=e.treeShape,this.sendTimeout=e.sendTimeout,this.sendInterval=e.sendInterval,this.collectedSpans=e.collectedSpans,this.collectedRootSpans=e.collectedRootSpans,this.onEnd=ae(()=>void this.forceFlush(),this.sendInterval)}onStart(e){let{parentSpanId:n,name:s}=e,{spanId:r}=e.spanContext();if(!this.collectedSpans.includes(s))return this.cleanSpan(this.spans[r]);this.spans[r]&&this.spans[r].kind==="future"?Object.assign(this.spans[r],{kind:"present",value:e}):this.spans[r]={spanId:r,kind:"present",children:[],value:e,retries:0},this.collectedRootSpans.includes(s)&&(this.rootSpans[r]=this.spans[r],this.waitSpans[r]=this.spans[r]),n!==void 0&&(this.spans[n]?this.spans[n].children.push(this.spans[r]):(this.spans[n]={spanId:n,kind:"future",children:[this.spans[r]],retries:0},this.waitSpans[n]=this.spans[n]))}cleanSpan(e){if(e===void 0)return;let n=e.spanId;for(let s of e.children)this.cleanSpan(s);delete this.spans[n],delete this.rootSpans[n],delete this.waitSpans[n],this.onClean(e)}async forceFlush(){await this.pendingSend;let e=Object.values(this.rootSpans).flatMap(n=>{let{data:s}=this.treeShape.safeParse(n);return s?[{original:n,pruned:s}]:[]});e.length>0&&(this.pendingSend=this.onFlush(e).finally(()=>{e.forEach(({original:n})=>this.cleanSpan(n))}));for(let n of Object.values(this.waitSpans))++n.retries*this.sendInterval>this.sendTimeout&&this.cleanSpan(n)}async shutdown(){await this.forceFlush(),this.spans={},this.rootSpans={},this.waitSpans={}}onEnd(){}};function ae(t,e){let n=!1;return()=>{n===!1&&(n=!0,setTimeout(()=>(n=!1)||t(),e))}}var d={ended:l.z.literal(!0),_spanContext:l.z.custom(),spanContext:l.z.custom(),startTime:l.z.custom(),endTime:l.z.custom(),attributes:l.z.custom()};var pe=i.z.object({value:i.z.object({name:i.z.literal("prisma:engine:db_query"),...d})}),y=i.z.object({value:i.z.object({name:i.z.literal("prisma:engine"),...d}),children:i.z.array(pe).nonempty()}),A=i.z.object({value:i.z.object({name:i.z.literal("prisma:client:connect"),...d})}),ce=i.z.object({value:i.z.object({name:i.z.literal("prisma:client:operation"),...d}),children:i.z.union([i.z.tuple([y]),i.z.tuple([A,y]),i.z.tuple([y,A])])}),g=class extends f{requests={};errors={};schemaHash;apiClient;constructor(e){super({treeShape:ce,sendTimeout:e.sendTimeout,sendInterval:e.sendInterval,collectedSpans:["prisma:client:operation","prisma:client:connect","prisma:engine","prisma:engine:db_query"],collectedRootSpans:["prisma:client:operation"]}),this.apiClient=e.apiClient,this.schemaHash=E(this.apiClient,e.schema)}setRequest(e){this.requests[e.spanId]=e}setError(e){this.errors[e.spanId]=e}onClean({spanId:e}){delete this.requests[e],delete this.errors[e]}async onFlush(e){let n=await this.schemaHash,s=[];for(let{pruned:r}of e){let{value:o}=r,a=o.spanContext().spanId;this.requests[a]&&s.push({hash:n,sql:le(r),ts:c(o.startTime),connect:me(r),error:this.errors[a]?.error??null,model:this.requests[a].model??null,operation:this.requests[a].operation,args:this.requests[a].args??{},latency:c(o.endTime)-c(o.startTime)})}await P(this.apiClient,s)}};function le(t){return t.children.find(({value:r})=>r.name==="prisma:engine").children.filter(({value:r})=>r.name==="prisma:engine:db_query").sort((r,o)=>c(r.value.startTime)-c(o.value.startTime)).reduce((r,o)=>{let a=o.value.attributes["db.statement"];return typeof a=="string"?`${r}${a}
+`:r},"")}function me(t){let{value:e}=t.children.find(({value:n})=>n.name==="prisma:client:connect")??{};return e?c(e.endTime)-c(e.startTime):!1}function F(t){let e=new O.AsyncHooksContextManager().enable();q.context.setGlobalContextManager(e);let n=new z.BasicTracerProvider({resource:new _.Resource({[b.SEMRESATTRS_SERVICE_NAME]:"extension-optimize",[b.SEMRESATTRS_SERVICE_VERSION]:"0.0.0"})}),s=new g(t);return n.addSpanProcessor(s),(0,j.registerInstrumentations)({tracerProvider:n,instrumentations:[new k.PrismaInstrumentation]}),n.register(),s}function M(t){return t._previewFeatures?.includes("tracing")}function H(t){return t._engineConfig.inlineSchema}function L(t){if(t instanceof Error)return t.stack??t.message;switch(typeof t){case"undefined":return"undefined";case"object":{let e;return t!==null&&typeof t.toString=="function"&&(e=t.toString()),typeof e=="string"&&e!=="[object Object]"?e:JSON.stringify(t)}default:return String(t)}}var $=require("@prisma/client/extension"),U=$.Prisma.defineExtension(t=>t.$extends({}));var J="https://optimize-ingestion.datacdn.workers.dev/",Q="https://optimize.prisma.io";function de({enable:t=!0,ingestionUrl:e=J,dashboardUrl:n=Q,sendInterval:s=500,sendTimeout:r=1e4,showNotification:o=!0,token:a}){return t?(o&&R(n),D.Prisma.defineExtension(m=>{let p=H(m),u=w(e,a),h=F({schema:p,apiClient:u,sendInterval:s,sendTimeout:r});if(!M(m))throw new Error('Please enable the "tracing" preview feature and regenerate the client.');return m.$extends({query:{async $allOperations({query:V,model:B,operation:G,args:x}){let T=N.trace.getActiveSpan()?.spanContext().spanId;if(!T)throw new Error("prisma:client:operation span is expected to be entered in the client extension when tracing is enabled");h.setRequest({spanId:T,model:B,operation:G,args:x});try{return await V(x)}catch(I){let Z=L(I);throw h.setError({spanId:T,error:Z}),I}}}})})):U}0&&(module.exports={PROD_DASHBOARD_URL,PROD_INGESTION_URL,withOptimize});

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@prisma/extension-optimize",
-  "version": "0.0.0-dev.202408261522",
+  "version": "0.0.0-dev.202408261524",
   "sideEffects": false,
   "description": "",
   "main": "./dist/index.js",
@@ -8,17 +8,16 @@
   "keywords": [],
   "dependencies": {
     "@opentelemetry/api": "^1.8",
-    "@opentelemetry/instrumentation": "^0.49 || ^0.50 || ^0.51",
-    "@opentelemetry/sdk-trace-base": "^1.22",
     "@opentelemetry/context-async-hooks": "1.22.0",
     "@opentelemetry/exporter-trace-otlp-http": "0.49.1",
+    "@opentelemetry/instrumentation": "^0.49 || ^0.50 || ^0.51",
     "@opentelemetry/resources": "1.22.0",
+    "@opentelemetry/sdk-trace-base": "^1.22",
     "@opentelemetry/semantic-conventions": "1.22.0",
     "@prisma/debug": "5.12.1",
     "@prisma/instrumentation": "5.18.0",
     "kleur": "4.1.5",
-    "node-notifier": "10.0.1",
-    "xdg-app-paths": "8.3.0"
+    "zod": "3.23.8"
   },
   "devDependencies": {
     "@hono/node-server": "1.9.1",
@@ -27,7 +26,7 @@
     "hono": "4.4.6",
     "tsup": "8.0.2",
     "vitest": "1.4.0",
-    "common": "0.0.0-dev.202408261522"
+    "common": "0.0.0-dev.202408261524"
   },
   "peerDependencies": {
     "@prisma/client": "5.x"