Getting POST When I Need PUT

[SubutaDan]

The REST API I am using provides a POST method for new instances and a PUT method for updates to existing instances. I thought I could get Brick to use PUT for my updates by calling upsert after setting the query action to QueryAction.update, but this doesn't seem to work. I think that may possibly be due to this piece of code in RestProvider, although I am not sure:

extension on QueryAction {
  String get httpMethod {
    switch (this) {
      case QueryAction.subscribe:
      case QueryAction.get:
        return 'GET';
      case QueryAction.insert:
      case QueryAction.update:
      case QueryAction.upsert:
        return 'POST';
      case QueryAction.delete:
        return 'DELETE';
    }
  }

How can I get Brick to send a PUT?

Thank you for your help,

[Tim Shedor]

Hey @SubutaDan you can specify the method within your providerArgs['request']:

final query = Query(
  providerArgs: {
    'request': RestRequest(method: 'PUT'),
  },
);
final resp = await provider.upsert<DemoRestModel>(instance, query: query);

You can also do this at the model level using a RestRequestTransformer:

class ModelRequest extends RestRequestTransformer {
  final upsert = RestRequest(url: '/my-path', method: 'PUT');

  ModelRequest(Query? query, Model? instance) : super(query, instance);
}

@ConnectOfflineFirstWithRest(
  restConfig: RestSerializable(
    requestTransformer: ModelRequest.new,
  ),
)
class Model extends OfflineFirstWithRestModel {}

[SubutaDan]

Hi Tim, Thanks very much for your reply. I guess if I made the change in the model then all upserts would be PUTs. Is that correct? I need POST for creates and PUTs for updates, so I am going down the path of setting the HTTP method in the provider args at the request level. I am using OfflineFirstWithRest. For my creates I call upsert on the repository without setting the HTTP method or query action. I get a POST and it seems to be working well. In the code that you sent, upsert is called on "provider". This surprised me because I thought that if I want offline-first behavior I need to call my mutation methods on the Repository. Is that not correct? I have done a lot of testing both ways and have yet to achieve a PUT, but I am still working on it. Thank you as always for your help.

…

-Dan On 2024-06-09 22:39, Tim Shedor wrote:

Hey @SubutaDan [1] you can specify the method within your providerArgs['request']: final query = Query( providerArgs: { 'request': RestRequest(method: 'PUT'), }, ); final resp = await provider.upsert<DemoRestModel>(instance, query: query); You can also do this at the model level [2] using a RestRequestTransformer: class ModelRequest extends RestRequestTransformer { final upsert = RestRequest(url: '/my-path', method: 'PUT'); ModelRequest(Query? query, Model? instance) : super(query, instance); } @ConnectOfflineFirstWithRest( restConfig: RestSerializable( requestTransformer: ModelRequest.new, ), ) class Model extends OfflineFirstWithRestModel {} -- Reply to this email directly, view it on GitHub [3], or unsubscribe [4]. You are receiving this because you were mentioned.Message ID: ***@***.***> Links: ------ [1] https://github.com/SubutaDan [2] https://getdutchie.github.io/brick/#/rest/models?id=restserializablerequesttransformer [3] #389 (comment) [4] https://github.com/notifications/unsubscribe-auth/AETJO2APNBBYHU3IVQ3IGWDZGTDRTAVCNFSM6AAAAABIOQGQPKVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDCNJWHAYDCMJXGI

-- Japan: [phone] US: [phone] UK: [phone]

[Tim Shedor]

@SubutaDan You can get a little crafty with the RestRequestTransformer :

class ModelRequestTransformer extends RestRequestTransformer {
  @override
  RestRequest? get upsert {
    final castModel = instance as Model?;

    // isNewRecord is a Brick method that comes from SQLite. Modify to your own purposes
    // if this doesn't represent a new record
    if (castModel?.isNewRecord ?? true) {
      return RestRequest(url: '/models/${castModel?.id}', method: 'PUT');
    }
    return const RestRequest(url: '/models');
  }

  const ModelRequestTransformer(super.query, super.instance);
}

While we're getting detailed, I noticed that the previous code I sent you was invalid, even by Dart standards. Please refer to the above code block instead.

In the code that you sent, upsert is called on "provider". This surprised me because I thought that if I want offline-first behavior I need to call my mutation methods on the Repository. Is that not correct?

Good catch. I was hastily copy/pasting from the unit tests where I get most of my answers (because I know that code runs). The one I pulled from was on the provider because it didn't need the repository. Still always use the repository instead of the individual provider.

[SubutaDan]

HI Tim, Thanks very much for the follow-up information. The good news is that by forcing the HTTP method to be PUT in my request transformer, I can now see PUTs hitting the API server. The bad news is that I haven't been able to set the method to PUT or POST depending on whether the record is new or not. I tried to make use of your "isNewRecord" trick but I can't figure out how, and I have not yet come up with an alternative. I will keep working on it, but for now I can only run in all PUT or all POST mode. Again, thanks for your help.

…

-Dan

On 2024-06-10 16:14, Tim Shedor wrote: @SubutaDan [1] You can get a little crafty with the RestRequestTransformer : class ModelRequestTransformer extends RestRequestTransformer { @OverRide RestRequest? get upsert { final castModel = instance as Model?; // isNewRecord is a Brick method that comes from SQLite. Modify to your own purposes // if this doesn't represent a new record if (castModel?.isNewRecord ?? true) { return RestRequest(url: '/models/${contact?.id}', method: 'PUT'); } return const RestRequest(url: '/models'); } const ModelRequestTransformer(super.query, super.instance); } While we're getting detailed, I noticed that the previous code I sent you was invalid, even by Dart standards. Please refer to the above code block instead. > In the code that you sent, upsert is called on "provider". This > surprised me because I thought that if I want offline-first behavior > I need to call my mutation methods on the Repository. Is that not > correct? Good catch. I was hastily copy/pasting from the unit tests where I get most of my answers (because I know that code runs). The one I pulled from was on the provider because it didn't need the repository. Still always use the repository instead of the individual provider. -- Reply to this email directly, view it on GitHub [2], or unsubscribe [3]. You are receiving this because you were mentioned.Message ID: ***@***.***> Links: ------ [1] https://github.com/SubutaDan [2] #389 (comment) [3] https://github.com/notifications/unsubscribe-auth/AETJO2GHPKQRWKAJBOM4VYDZGW7GXAVCNFSM6AAAAABIOQGQPKVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDCNJYGYZTCNZUHA

-- Japan: [phone] US: [phone] UK: [phone]

[SubutaDan]

Solved using providerArgs 'request' per your suggestion, @tshedor . Thanks again.

-Dan