🔖 Feature description

The proposed feature involves building a separate API SDK - "Appwrite.Core" based on the existing API SDK to make it compatible with modern .NET versions (specifically .NET 6 and beyond). The new approach will utilize the Refit library, System.Text, and HttpClientFactory to optimize the SDK's performance, simplify the development process, and provide a seamless integration experience for developers.

🎤 Pitch

Why Implement this Feature:

Upgrading the API SDK for modern .NET versions is essential to keep up with the latest advancements and ensure that our SDK remains relevant and efficient. By rebuilding the SDK using Refit, System.Text, and HttpClientFactory, we can leverage their capabilities to enhance the overall development experience and the quality of our SDK.

Advantages of the Proposed Approach:

a) Refit Integration:
Refit is a powerful library that simplifies the creation of type-safe API clients. By utilizing Refit, we can eliminate the need for writing boilerplate code to handle HTTP requests and responses. Instead, developers can define API interfaces with attributes, making the SDK more concise and expressive. This will improve the readability and maintainability of the codebase.

Example of using Refit:

[Headers("User-Agent: MyApp")]
public interface IApiClient
{
    [Get("/posts/{id}")]
    Task<Post> GetPostById(int id);
}

b) System.Text for JSON Serialization:
.NET 6 includes significant improvements in System.Text.Json for JSON serialization and deserialization. By adopting System.Text.Json as the default JSON serializer for the SDK, we can benefit from its superior performance and reduced memory allocation compared to third-party libraries. This will lead to faster data processing and a more efficient SDK.

c) HttpClientFactory Integration:
The HttpClientFactory is designed to manage HttpClient instances efficiently, minimizing the overhead of creating new connections for each API request. By integrating HttpClientFactory, we can improve the SDK's performance and mitigate potential issues related to HttpClient misuse, such as socket exhaustion and connection leaks.

Example Implementation details

Get Account

using Refit;

namespace Appwrite.Core.Apis;

internal interface IAccount
{
    [Get("/account")]
    Task<User> Get(CancellationToken cancellationToken = default);
}

namespace Appwrite.Core.Services;

public class Account : HttpClientProvider
{
    private readonly IAccount _accountApi;

    public Account(Client client)
    {
        _accountApi = base.GetRestService<IAccount>(client);
    }

    /// <summary>
    /// Get Account
    /// </summary>
    /// <para>Get currently logged in user data as JSON object.</para>
    /// <param name="cancellationToken">Cancellation Token</param>
    /// <returns>User</returns>
    public async Task<User> Get(CancellationToken cancellationToken = default)
    {
        return await _accountApi.Get(cancellationToken);
    }
}

The SDK will automatically handle the HTTP request and response, making the integration process intuitive and efficient.

Example Client invocation:

using Appwrite.Core;
using Appwrite.Core.Services;

var endpoint = String.Empty;
var project = String.Empty;
var apikey = String.Empty;

var client = new Client()
    .SetEndpoint(endpoint)
    .SetProject(project)
    .SetKey(apikey);
try
{
    var account = new Account(client);

    // optional
    CancellationTokenSource newSource = new CancellationTokenSource();
    newSource.Cancel();

    var newTeam = await account.Get(newSource.Token);

    Console.WriteLine("Done !");
}
catch (TaskCanceledException ex)
{
    Console.WriteLine($"TaskCanceledException - {ex.Message}");
}
catch (AppwriteException ex)
{
    Console.WriteLine($"AppwriteException - {ex.Message}");
}
catch (Exception ex)
{
    Console.WriteLine($"Exception - {ex.Message}");
}

🚧 For more implementation details checkout - https://github.com/initinll-forks/sdk-for-dotnet/tree/dotnet-6

👀 Have you spent some time to check if this issue has been raised before?

• I checked and didn't find similar issue

🏢 Have you read the Code of Conduct?

• I have read the Code of Conduct

👟 Reproduction steps

Hi. I asked this on discord already with no success for an answer. Maybe I got wrong what I found in the documents, but when I

{
    int number = 5;
    try
    {
        List<string> queryList = new List<string>{
            {Query.Equal("validated", false)},
            {Query.Equal("language", lang)},
            {Query.Limit(number)}
    } 
[…]
    var quotes = await databases.ListDocuments(
            databaseId: databaseId,
            collectionId: collectionId,
            queries: queryList);
        return Results.Ok(quotes);        
}

👍 Expected behavior

returns 5 Documents where validated is false and language is (whatever is set in query parameter)

👎 Actual Behavior

returns 274 documents. Where validated is false and language is (whatever was set in query parameter)

🎲 Appwrite version

Different version (specify in environment)

💻 Operating system

Linux

🧱 Your Environment

The Api (dotnet api project) runs on ubuntu 22.04.3 LTS and queries another machine running Appwrite 1.4.3 using dotnet-SDK 0.6.0

👀 Have you spent some time to check if this issue has been raised before?

• I checked and didn't find similar issue

🏢 Have you read the Code of Conduct?

• I have read the Code of Conduct

👟 Reproduction steps

this method:

the issue is that when you do this on the server from the JWT token:

var client = new Client()
        .SetEndpoint("https://cloud.appwrite.io/v1")    // Your API Endpoint
        .SetProject(projectid)                     // Your project ID
        .SetJWT(token);

var appWriteUser=(await (new Account(client)).Get());

The way it does this internally is that Get() makes an api call, retrieves a dictionary and then calls the User.From
since the dictionary does not retrieve the password, you get an exception with Key not found "password" and it crashes
meaning you can never retrieve a user on the server side, never
exact exception details details

"error":"System.Collections.Generic.KeyNotFoundException: The given key 'password' was not present in the dictionary.\r\n   at System.Collections.Generic.Dictionary2.get_Item(TKey key)\r\n   at Appwrite.Models.User.From(Dictionary2 map)\r\n   at Appwrite.Services.Account.<Get>g__Convert|1_0(Dictionary2 it)\r\n   at Appwrite.Client.Call[T](String method, String path, Dictionary2 headers, Dictionary2 parameters, Func2 convert)

👍 Expected behavior

it should create an user instance with the missing information (no password)

👎 Actual Behavior

exception as explained, and no user created

🎲 Appwrite version

Version 0.10.x

💻 Operating system

Windows

🧱 Your Environment

No response

👀 Have you spent some time to check if this issue has been raised before?

• I checked and didn't find similar issue

🏢 Have you read the Code of Conduct?

• I have read the Code of Conduct

There are a few potential memory leaks and deferred garbage collection cycle that I identified. I thought of bringing this to community's notice. Also, I will take this opportunity to suggest some better coding practices.

1. The following classes implement the IDisposable interface. If we don't call the Dispose method on them ourselves, then we potentially leave it to the garbage collector to dispose of and then cleanup the memory. This typically happens in 2 cycles of garbage collection(The garbage collector has 3 cycles). However, if we call the dispose method ourselves before exiting a block scope, the garbage collector will then take just one cycle to clean up the memory and end up doing less work. We have to remind ourselves that garbage collection is a very expensive process).

HttpResponseMessage - Docs
HttpRequestMessage - Docs
HttpClient - Docs

2. Newing up the HttpClient in the construction is typically a bad practice. It is always better to rely on Dependency Injection. The typical way to implement it is using this would be to accept IHttpClientFactory in the constructor.

IHttpClientFactory - Docs

then add dependency injection to inject a version of the IHttpClientFactory.

Microsoft.Extensions.DependencyInjection - Nuget

then create a ServiceCollectionExtensions static class and create a method like this -

// Clients of this Nuget package need to utilize this before using the classes.
public static IServiceCollection AddAppWrite(this IServiceCollection serviceCollection, IConfiguration configuration)
{
    // This should add the IHttpClientFactory that you want to register with proper retry policies using Poly.NET
   // This method should also house any other interface and class registrations with the DI system that are needed.
  // If it were me, I would also implement an IAppWriteUriProvider which has methods that returns the URI of all the areas that are needed and inject an implementation here.
}

and then use the IHttpClientFactory.CreateClient method to create the actual HttpClient. This typically is also an extension method. Not the HttpClient is a class that needs eager disposing.

IHttpClientFactory.CreateClient - Docs

Also, I would never expose the underlying HttpResponseMessage directly to the consumer, but instead return the string and let abstract away any other Http only resemblance. The reason I say this is because tomorrow you guys might implement the APIs using gRPC but to the consumer, it should not feel like anything has changed.

I apologize for all the ranting. My only intention is to really help the community with whatever knowledge I have.

💭 Description

The readme states that to install the package in your projects, issue the command Install-Package Appwrite -Version 0.3.0.

This returns the error Install-Package : NU1102: Unable to find package Appwrite with version (>= 0.3.0)

It appears that the nuget repo only has up to version 0.2.0.

👀 Have you spent some time to check if this issue has been raised before?

• I checked and didn't find similar issue

🏢 Have you read the Code of Conduct?

• I read the Code of Conduct

Hello.

So Im trying to use some Storage methods in functions.

So Im trying to use GetFileDownload to finish my work on .net sample function for object detection.
From documentation it creates link like this:
/v1/storage/files/{fileId}/download

for link generated by the Storage class:
http://localhost/v1/storage/files/60f85fa05c655/download?
I get a response :
"{"message":"Missing or unknown project ID","code":400,"version":"0.9.1"}"

BUT works for
http://localhost/v1/storage/files/60f85fa05c655/download?project=60f85f2973fd8

🐛 Bug Report

Have you spent some time to check if this issue has been raised before?

Yup.

To Reproduce

Call
var url = Storage.GetFileDownload("id")

Expected behavior

I'd either:
-get downloaded bytes (the OKeiest solution :D )
-get a request with api_key/projectId in headers and parameters(such as quality) as parameters
-get a string with everything as parameter

Actual Behavior

get a string with parameters but without projectID which is necessary to actually access the file we want.

Your Environment

Appwrite 0.9.1
Appwrite sdk for .net 0.2.0

💭 Description

for .NET there is missing documentation
my question is how to filter ListDocuments() function
database.ListDocuments(String collectionId, list ? filters = null, ...)

my question is how to filter any example pls , i dont know list<object> ? filters = null

but from my flutter and web experience, I was doing like this
queries: [
Query.equal("uid", uid),
],
so how can Filer data inside ListDocuments() function in .NET, thanks.

👀 Have you spent some time to check if this issue has been raised before?

• I checked and didn't find similar issue

🏢 Have you read the Code of Conduct?

• I read the Code of Conduct

Introduction

GitHub has recently rolled out a public beta for their issue forms feature. This would allow you to create interactive issue templates and validate them 🤯.

Appwrite currently uses the older issue template format. Your task is to create GitHub issue forms for this repository. Please use Appwrite's issue templates as a reference for this PR.

Tasks summary:

• Fork & clone this repository
• Prepare bug report issue form in .github/ISSUE_TEMPLATE/bug.yaml
• Prepare documentation issue form in .github/ISSUE_TEMPLATE/documentation.yaml
• Prepare feature request issue form in .github/ISSUE_TEMPLATE/feature.yaml
• Push changes to master and test issue forms on your fork
• Submit pull request

If you need any help, reach out to us on our Discord server.

Are you ready to work on this issue? 🤔 Let us know, and we will assign it to you 😊

Happy Appwriting!

🔖 Feature description

Any plans to officially support the Appwrite server version 1.x, now that it's gone to GA?

🎤 Pitch

Would be nice to support the latest, full release. (Please). :D

👀 Have you spent some time to check if this issue has been raised before?

• I checked and didn't find similar issue

🏢 Have you read the Code of Conduct?

• I have read the Code of Conduct