node-appwrite 11.0.0 → 12.0.0-rc.4

package/lib/services/functions.js

@@ -5,6 +5,8 @@ const client = require('../client.js');
 const Stream = require('stream');
 const { promisify } = require('util');
 const fs = require('fs');
+const { File } = require('undici');
+const Query = require('../query.js');
 
 class Functions extends Service {
 
@@ -15,7 +17,7 @@ class Functions extends Service {
 
 
     /**
-     * List Functions
+     * List functions
      *
      * Get a list of all the project's functions. You can use the query params to
      * filter your results.
@@ -43,15 +45,16 @@ class Functions extends Service {
     }
 
     /**
-     * Create Function
+     * Create function
      *
      * Create a new function. You can pass a list of
-     * [permissions](/docs/permissions) to allow different project users or team
-     * with access to execute the function using the client API.
+     * [permissions](https://appwrite.io/docs/permissions) to allow different
+     * project users or team with access to execute the function using the client
+     * API.
      *
      * @param {string} functionId
      * @param {string} name
-     * @param {string} runtime
+     * @param {Runtime} runtime
      * @param {string[]} execute
      * @param {string[]} events
      * @param {string} schedule
@@ -191,7 +194,7 @@ class Functions extends Service {
     }
 
     /**
-     * Get Function
+     * Get function
      *
      * Get a function by its unique ID.
      *
@@ -213,13 +216,13 @@ class Functions extends Service {
     }
 
     /**
-     * Update Function
+     * Update function
      *
      * Update function by its unique ID.
      *
      * @param {string} functionId
      * @param {string} name
-     * @param {string} runtime
+     * @param {Runtime} runtime
      * @param {string[]} execute
      * @param {string[]} events
      * @param {string} schedule
@@ -314,7 +317,7 @@ class Functions extends Service {
     }
 
     /**
-     * Delete Function
+     * Delete function
      *
      * Delete a function by its unique ID.
      *
@@ -336,7 +339,7 @@ class Functions extends Service {
     }
 
     /**
-     * List Deployments
+     * List deployments
      *
      * Get a list of all the project's code deployments. You can use the query
      * params to filter your results.
@@ -369,7 +372,7 @@ class Functions extends Service {
     }
 
     /**
-     * Create Deployment
+     * Create deployment
      *
      * Create a new function code deployment. Use this endpoint to upload a new
      * version of your code function. To execute your newly uploaded code, you'll
@@ -378,7 +381,7 @@ class Functions extends Service {
      * This endpoint accepts a tar.gz file compressed with your code. Make sure to
      * include any dependencies your code has within the compressed file. You can
      * learn more about code packaging in the [Appwrite Cloud Functions
-     * tutorial](/docs/functions).
+     * tutorial](https://appwrite.io/docs/functions).
      * 
      * Use the "command" param to set the entrypoint used to execute your code.
      *
@@ -387,6 +390,7 @@ class Functions extends Service {
      * @param {boolean} activate
      * @param {string} entrypoint
      * @param {string} commands
+     * @param {CallableFunction} onProgress
      * @throws {AppwriteException}
      * @returns {Promise}
      */
@@ -422,8 +426,9 @@ class Functions extends Service {
             payload['activate'] = activate.toString();
         }
 
-        const size = code.size;
 
+        const size = code.size;
+        
         const apiHeaders = {
             'content-type': 'multipart/form-data',
         };
@@ -434,123 +439,83 @@ class Functions extends Service {
         let chunksUploaded = 0;
 
 
-        let currentChunk = Buffer.from('');
-        let currentChunkSize = 0;
-        let currentChunkStart = 0;
-
-        const selfClient = this.client;
+        let currentChunk = 1;
+        let currentPosition = 0;
+        let uploadableChunk = new Uint8Array(client.CHUNK_SIZE);
+    
 
-        async function uploadChunk(lastUpload = false) {
-            if(chunksUploaded - 1 >= currentChunkStart / client.CHUNK_SIZE) {
+        const uploadChunk = async (lastUpload = false) => {
+            if(currentChunk <= chunksUploaded) {
                 return;
             }
-            
-            const start = currentChunkStart;
-            const end = currentChunkStart + currentChunkSize - 1;
 
-            if(!lastUpload || currentChunkStart !== 0) {
+            const start = ((currentChunk - 1) * client.CHUNK_SIZE);
+            let end = start + currentPosition - 1;
+
+            if(!lastUpload || currentChunk !== 1) {
                 apiHeaders['content-range'] = 'bytes ' + start + '-' + end + '/' + size;
             }
 
+            let uploadableChunkTrimmed;
+            
+            if(currentPosition + 1 >= client.CHUNK_SIZE) {
+                uploadableChunkTrimmed = uploadableChunk;
+            } else {
+                uploadableChunkTrimmed = new Uint8Array(currentPosition);
+                for(let i = 0; i <= currentPosition; i++) {
+                    uploadableChunkTrimmed[i] = uploadableChunk[i];
+                }
+            }
+
             if (id) {
                 apiHeaders['x-appwrite-id'] = id;
             }
 
-            payload['code'] = {
-                type: 'file',
-                file: currentChunk,
-                filename: code.filename,
-                size: currentChunkSize
-            };
+            payload['code'] = { type: 'file', file: new File([uploadableChunkTrimmed], code.filename), filename: code.filename };
 
-            response = await selfClient.call('post', apiPath, apiHeaders, payload);
+            response = await this.client.call('post', apiPath, apiHeaders, payload);
 
             if (!id) {
                 id = response['$id'];
             }
-            
+
             if (onProgress !== null) {
                 onProgress({
                     $id: response['$id'],
-                    progress: Math.min((start+client.CHUNK_SIZE) * client.CHUNK_SIZE, size) / size * 100,
+                    progress: Math.min((currentChunk) * client.CHUNK_SIZE, size) / size * 100,
                     sizeUploaded: end+1,
                     chunksTotal: response['chunksTotal'],
                     chunksUploaded: response['chunksUploaded']
                 });
             }
 
-            currentChunkStart += client.CHUNK_SIZE;
-        }
-
-        return await new Promise((resolve, reject) => {
-            const writeStream = new Stream.Writable();
-            writeStream._write = async (mainChunk, encoding, callback) => {
-                try {
-                    // Segment incoming chunk into up to 5MB chunks
-                    const mainChunkSize = Buffer.byteLength(mainChunk);
-                    const chunksCount = Math.ceil(mainChunkSize / client.CHUNK_SIZE);
-                    const chunks = [];
-
-                    for(let i = 0; i < chunksCount; i++) {
-                        const chunk = mainChunk.slice(i * client.CHUNK_SIZE, (i + 1) * client.CHUNK_SIZE);
-                        chunks.push(chunk);
-                    }
-
-                    for (const chunk of chunks) {
-                        const chunkSize = Buffer.byteLength(chunk);
-
-                        if(chunkSize + currentChunkSize == client.CHUNK_SIZE) {
-                            // Upload chunk
-                            currentChunk = Buffer.concat([currentChunk, chunk]);
-                            currentChunkSize = Buffer.byteLength(currentChunk);
-                            await uploadChunk();
-                            currentChunk = Buffer.from('');
-                            currentChunkSize = 0;
-                        } else if(chunkSize + currentChunkSize > client.CHUNK_SIZE) {
-                            // Upload chunk, put rest into next chunk
-                            const bytesToUpload = client.CHUNK_SIZE - currentChunkSize;
-                            const newChunkSection = chunk.slice(0, bytesToUpload);
-                            currentChunk = Buffer.concat([currentChunk, newChunkSection]);
-                            currentChunkSize = Buffer.byteLength(currentChunk);
-                            await uploadChunk();
-                            currentChunk = chunk.slice(bytesToUpload, undefined);
-                            currentChunkSize = chunkSize - bytesToUpload;
-                        } else {
-                            // Append into current chunk
-                            currentChunk = Buffer.concat([currentChunk, chunk]);
-                            currentChunkSize = chunkSize + currentChunkSize;
-                        }
-                    }
-
-                    callback();
-                } catch (e) {
-                    callback(e);
+            uploadableChunk = new Uint8Array(client.CHUNK_SIZE);
+            currentChunk++;
+            currentPosition = 0;
+        }
+
+        for await (const chunk of code.stream) {
+            for(const b of chunk) {
+                uploadableChunk[currentPosition] = b;
+
+                currentPosition++;
+                if(currentPosition >= client.CHUNK_SIZE) {
+                    await uploadChunk();
+                    currentPosition = 0;
                 }
             }
+        }
 
-            writeStream.on("finish", async () => {
-                if(currentChunkSize > 0) {
-                    try {
-                        await uploadChunk(true);
-                    } catch (e) {
-                        reject(e);
-                    }
-                }
-                
-                resolve(response);
-            });
+        if (currentPosition > 0) { // Check if there's any remaining data for the last chunk
+            await uploadChunk(true);
+        }
 
-            writeStream.on("error", (err) => {
-                reject(err);
-            });
-            
-            code.stream.pipe(writeStream);
-        });
+        return response;
 
     }
 
     /**
-     * Get Deployment
+     * Get deployment
      *
      * Get a code deployment by its unique ID.
      *
@@ -577,7 +542,7 @@ class Functions extends Service {
     }
 
     /**
-     * Update Function Deployment
+     * Update function deployment
      *
      * Update the function code deployment ID using the unique function ID. Use
      * this endpoint to switch the code deployment that should be executed by the
@@ -606,7 +571,7 @@ class Functions extends Service {
     }
 
     /**
-     * Delete Deployment
+     * Delete deployment
      *
      * Delete a code deployment by its unique ID.
      *
@@ -633,7 +598,7 @@ class Functions extends Service {
     }
 
     /**
-     * Create Build
+     * Create build
      *
      * Create a new build for an Appwrite Function deployment. This endpoint can
      * be used to retry a failed build.
@@ -668,6 +633,9 @@ class Functions extends Service {
     /**
      * Download Deployment
      *
+     * Get a Deployment's contents by its unique ID. This endpoint supports range
+     * requests for partial or streaming file download.
+     *
      * @param {string} functionId
      * @param {string} deploymentId
      * @throws {AppwriteException}
@@ -691,7 +659,7 @@ class Functions extends Service {
     }
 
     /**
-     * List Executions
+     * List executions
      *
      * Get a list of all the current user function execution logs. You can use the
      * query params to filter your results.
@@ -724,7 +692,7 @@ class Functions extends Service {
     }
 
     /**
-     * Create Execution
+     * Create execution
      *
      * Trigger a function execution. The returned object will return you the
      * current execution status. You can ping the `Get Execution` endpoint to get
@@ -735,7 +703,7 @@ class Functions extends Service {
      * @param {string} body
      * @param {boolean} async
      * @param {string} xpath
-     * @param {string} method
+     * @param {ExecutionMethod} method
      * @param {object} headers
      * @throws {AppwriteException}
      * @returns {Promise}
@@ -774,7 +742,7 @@ class Functions extends Service {
     }
 
     /**
-     * Get Execution
+     * Get execution
      *
      * Get a function execution log by its unique ID.
      *
@@ -801,7 +769,7 @@ class Functions extends Service {
     }
 
     /**
-     * List Variables
+     * List variables
      *
      * Get a list of all variables of a specific function.
      *
@@ -823,7 +791,7 @@ class Functions extends Service {
     }
 
     /**
-     * Create Variable
+     * Create variable
      *
      * Create a new function environment variable. These variables can be accessed
      * in the function at runtime as environment variables.
@@ -864,7 +832,7 @@ class Functions extends Service {
     }
 
     /**
-     * Get Variable
+     * Get variable
      *
      * Get a variable by its unique ID.
      *
@@ -891,7 +859,7 @@ class Functions extends Service {
     }
 
     /**
-     * Update Variable
+     * Update variable
      *
      * Update variable by its unique ID.
      *
@@ -932,7 +900,7 @@ class Functions extends Service {
     }
 
     /**
-     * Delete Variable
+     * Delete variable
      *
      * Delete a variable by its unique ID.
      *

package/lib/services/graphql.js

@@ -5,6 +5,8 @@ const client = require('../client.js');
 const Stream = require('stream');
 const { promisify } = require('util');
 const fs = require('fs');
+const { File } = require('undici');
+const Query = require('../query.js');
 
 class Graphql extends Service {
 
@@ -15,7 +17,7 @@ class Graphql extends Service {
 
 
     /**
-     * GraphQL Endpoint
+     * GraphQL endpoint
      *
      * Execute a GraphQL mutation.
      *
@@ -42,7 +44,7 @@ class Graphql extends Service {
     }
 
     /**
-     * GraphQL Endpoint
+     * GraphQL endpoint
      *
      * Execute a GraphQL mutation.
      *