medz/spry

Spry - A HTTP middleware framework for Dart to make web applications and APIs server more enjoyable to write.

spry's Issues

3.0 idea

After practicing in many projects, we found many shortcomings of Spry.

I'm planning an optimization for version 3.0 and am eager to hear everyone's suggestions for changes.

merger from

1. spry_json
2. spry_urlencoded
3. spry_multer

Prints content-type in `spry_multer`

When I implemented spry_multer in my project it added unnecessary logs in my command-line.

I don't think that it should be done as it degrades the raw performance and also it pollutes the logs which are not required.

Culprit:
https://github.com/odroe/spry/blob/e904cc7f5fcb6bf8707dfe7fb8f8ed97bec4c2ab/packages/spry_multer/lib/src/_internal/multer_impl.dart#L44

Dependency Dashboard

This issue lists Renovate updates and detected dependencies. Read the Dependency Dashboard docs to learn more.

This repository currently has no open or pending branches.

Detected dependencies

bun

package.json

• vitepress ^1.1.4

github-actions

.github/workflows/test.yml

• actions/checkout v4
• dart-lang/setup-dart v1

pub

packages/spry/pubspec.yaml

• logging ^1.2.0
• path ^1.9.0
• routingkit ^0.2.0
• webfetch ^0.0.16
• lints >=3.0.0 <5.0.0
• test ^1.23.1
• dart ^3.2.0

---

• Check this box to trigger a request for Renovate to run again on this repository

[Proposal] Testing support

Background

When writing HTTP server related tests, in most cases, we don't want actually start a HTTP server and use HTTP client to fetch the response, it will impact the testing execution time and write more redundant code.

Proposal

Provide APIs for single handler testing

Sometime, developers need to test single endpoint without routing to guarantee that the handler is working as expected behavior.

API example:

class SpryTestingServer {
  Future<HttpResponse> sendSingle(FutureOr Function(HttpRequest) handler, [void Function(HttpRequest)? configure]);
}

Usage example:

import 'dart:io';
import 'package:spry/testing.dart';
import 'package:test/test.dart';

void main() {
  test('expect remote server respond correct payload', () {
    final spryServer = SpryTestingServer();

    Future handle(HttpRequest request) async {
      return {'success': 'true', 'data': 'ok'};
    }
    
    final res = await spryServer.sendSingle(handle, (req) {
      req.write(json.encode({'clientId': 'e93b5045-ed30-4eec-aaab-1cd4c9cb8eb5', 'action': 'updateDeviceStatus', 'payload': {'battery': 80, 'voltage': 3.2, 'current': 0.5, 'networkQuality': 'GOOD'}}));
    });
    expect(res.statusCode, equals(200));
    expect(await res.asJson(), equals({'success': true, 'data': 'ok'}))
  });
}

Provide APIs for multiple endpoints testing with routing

API example:

class SpryTestingServer {
  void addHandler(String method, String path, FutureOr Function(HttpRequest) handler);
  Future<HttpResponse> send(String method, String path, [void Function(HttpRequest)? configure]);
}

Usage example:

import 'dart:io';
import 'package:spry/testing.dart';
import 'package:test/test.dart';

void main() {
  test('expect remote server respond correct payload', () {
    final spryServer = SpryTestingServer();

    Future getDevice(HttpRequest request) async {
      return {'success': 'true', 'data': {'deviceId': 'SN2305830131'}};
    }

    Future updateDevice(HttpRequest request) async {
      return {'success': 'true', 'data': 'ok'};
    }

    spryServer.addHandler('GET', '/api/v1/device/{deviceId}', getDevice);
    spryServer.addHandler('POST', '/api/v1/device/{deviceId}', updateDevice);
    
    final res = await spryServer.send('GET', '/api/v1/device/SN2305830131', (req) {
      req.write(json.encode({'clientId': 'e93b5045-ed30-4eec-aaab-1cd4c9cb8eb5', 'action': 'updateDeviceStatus', 'payload': {'battery': 80, 'voltage': 3.2, 'current': 0.5, 'networkQuality': 'GOOD'}}));
    });
    expect(res.statusCode, equals(200));
    expect(await res.asJson(), equals({'success': true, 'data': 'ok'}))
  });
}