expose jwt package

[samtuga1]

Resolves #60

Description

Turns out jsonEncode used in res.json cannot encode DateTime(is not serializable).
So I created a custom encoder to encode DateTime but whenever we find out about something else
then we add it for now

Type of Change

• ✨ New feature (non-breaking change which adds functionality)
• 🛠️ Bug fix (non-breaking change which fixes an issue)
• ❌ Breaking change (fix or feature that would cause existing functionality to change)
• 🧹 Code refactor
• ✅ Build configuration change
• 📝 Documentation
• 🗑️ Chore

[codekeyz]

Awesome stuff @samtuga1. Tho we'll need to relook at a few stuffs.

[codekeyz]

Looks like the CI is failing for some Dart Analyze issues. @samtuga1

[samtuga1]

Looks like the CI is failing for some Dart Analyze issues. @samtuga1

$ melos exec
  └> dart analyze . --fatal-infos
     └> FAILED (in 1 packages)
        └> pharaoh_jwt_auth (with exit code 1)

melos run analyze
  └> melos exec -c 1 -- \
       dart analyze . --fatal-infos
     └> FAILED
ScriptException: The script analyze failed to execute.

Do you know what is happening? maybe its coming from the export i did

[samtuga1]

Looks like the CI is failing for some Dart Analyze issues. @samtuga1

$ melos exec
  └> dart analyze . --fatal-infos
     └> FAILED (in 1 packages)
        └> pharaoh_jwt_auth (with exit code 1)

melos run analyze
  └> melos exec -c 1 -- \
       dart analyze . --fatal-infos
     └> FAILED
ScriptException: The script analyze failed to execute.

Do you know what is happening? maybe its coming from the export i did

@codekeyz check this out invertase/melos#303 (comment)

[codekeyz]

Okay. Taking a look. Give me a moment

[codekeyz]

Looks like the CI is failing for some Dart Analyze issues. @samtuga1

$ melos exec
  └> dart analyze . --fatal-infos
     └> FAILED (in 1 packages)
        └> pharaoh_jwt_auth (with exit code 1)

melos run analyze
  └> melos exec -c 1 -- \
       dart analyze . --fatal-infos
     └> FAILED
ScriptException: The script analyze failed to execute.

Do you know what is happening? maybe its coming from the export i did

@codekeyz check this out invertase/melos#303 (comment)

This is the issue. @samtuga1 Aren't you able to view the CI-logs on here?

[codekeyz]

You left an unused import in the JWT Example project @samtuga1

[samtuga1]

You left an unused import in the JWT Example project @samtuga1

should be fixed now

[samtuga1]

Looks like the CI is failing for some Dart Analyze issues. @samtuga1

$ melos exec
  └> dart analyze . --fatal-infos
     └> FAILED (in 1 packages)
        └> pharaoh_jwt_auth (with exit code 1)

melos run analyze
  └> melos exec -c 1 -- \
       dart analyze . --fatal-infos
     └> FAILED
ScriptException: The script analyze failed to execute.

Do you know what is happening? maybe its coming from the export i did

@codekeyz check this out invertase/melos#303 (comment)

This is the issue. @samtuga1 Aren't you able to view the CI-logs on here?

It totally skipped me...did not check the top

[codekeyz]

There's another unused import in a test file. @samtuga1 See Here: https://github.com/codekeyz/pharaoh/actions/runs/7054414617/job/19203239631?pr=62

[samtuga1]

There's another unused import in a test file. @samtuga1 See Here: https://github.com/codekeyz/pharaoh/actions/runs/7054414617/job/19203239631?pr=62

There's another unused import in a test file. @samtuga1 See Here: https://github.com/codekeyz/pharaoh/actions/runs/7054414617/job/19203239631?pr=62

There's another unused import in a test file. @samtuga1 See Here: https://github.com/codekeyz/pharaoh/actions/runs/7054414617/job/19203239631?pr=62

There's another unused import in a test file. @samtuga1 See Here: https://github.com/codekeyz/pharaoh/actions/runs/7054414617/job/19203239631?pr=62

I dont know how those imports are appearing in the first place but should be fixed now 👍🏽

[codekeyz]

CI is failing again. I think something broke somewhere. Please try resolve, ping me if you need assistance. @samtuga1

[samtuga1]

CI is failing again. I think something broke somewhere. Please try resolve, ping me if you need assistance. @samtuga1

Seems like its coming from the test

❌ ./test/middleware/session_mw_test.dart: session_middleware should create a new session (failed)
  Expected: <200>
    Actual: <500>
  
  package:matcher                                 expect
  package:spookie/src/http_expectation.dart 81:7  HttpResponseExpection.test
  ===== asynchronous gap ===========================
  test/middleware/session_mw_test.dart 144:7      main.<fn>.<fn>
✅ ./test/middleware/cookie_parser_test.dart: cookieParser when cookies are sent should populate req.cookies

Something is happening there

[codekeyz]

CI is failing again. I think something broke somewhere. Please try resolve, ping me if you need assistance. @samtuga1

Seems like its coming from the test

❌ ./test/middleware/session_mw_test.dart: session_middleware should create a new session (failed)
  Expected: <200>
    Actual: <500>
  
  package:matcher                                 expect
  package:spookie/src/http_expectation.dart 81:7  HttpResponseExpection.test
  ===== asynchronous gap ===========================
  test/middleware/session_mw_test.dart 144:7      main.<fn>.<fn>
✅ ./test/middleware/cookie_parser_test.dart: cookieParser when cookies are sent should populate req.cookies

Something is happening there

@samtuga1 It's prolly something to do with your changes. Because Session has a some related DateTime info i think. Please verify in the test that is failing to be sure what is happening.

[codekeyz]

CI is failing again. I think something broke somewhere. Please try resolve, ping me if you need assistance. @samtuga1

Seems like its coming from the test

❌ ./test/middleware/session_mw_test.dart: session_middleware should create a new session (failed)
  Expected: <200>
    Actual: <500>
  
  package:matcher                                 expect
  package:spookie/src/http_expectation.dart 81:7  HttpResponseExpection.test
  ===== asynchronous gap ===========================
  test/middleware/session_mw_test.dart 144:7      main.<fn>.<fn>
✅ ./test/middleware/cookie_parser_test.dart: cookieParser when cookies are sent should populate req.cookies

Something is happening there

@samtuga1 It's prolly something to do with your changes. Because Session has a some related DateTime info i think. Please verify in the test that is failing to be sure what is happening.

Oh right. Something is wrong with the jsonEncode.

    test('should create a new session', () async {
      final app = Pharaoh()
          .use(session(secret: 'foo bar baz'))
          .get('/', (req, res) => res.json(req.session)); // <----- this is failing

This is the test that is failing. @samtuga1

[samtuga1]

CI is failing again. I think something broke somewhere. Please try resolve, ping me if you need assistance. @samtuga1

Seems like its coming from the test

❌ ./test/middleware/session_mw_test.dart: session_middleware should create a new session (failed)
  Expected: <200>
    Actual: <500>
  
  package:matcher                                 expect
  package:spookie/src/http_expectation.dart 81:7  HttpResponseExpection.test
  ===== asynchronous gap ===========================
  test/middleware/session_mw_test.dart 144:7      main.<fn>.<fn>
✅ ./test/middleware/cookie_parser_test.dart: cookieParser when cookies are sent should populate req.cookies

Something is happening there

@samtuga1 It's prolly something to do with your changes. Because Session has a some related DateTime info i think. Please verify in the test that is failing to be sure what is happening.

Oh right. Something is wrong with the jsonEncode.

    test('should create a new session', () async {
      final app = Pharaoh()
          .use(session(secret: 'foo bar baz'))
          .get('/', (req, res) => res.json(req.session)); // <----- this is failing

This is the test that is failing. @samtuga1

why are you not doing session.toJson() I can see you have a toJson method. Right now the type is not Datetime but its an Instance of type Session

[codekeyz]

I think your change is altering how jsonEncode works.

If toEncodable is omitted, it defaults to a function that returns the result of calling .toJson() on the unencodable object.

See here: https://api.flutter.dev/flutter/dart-convert/jsonEncode.html

[codekeyz]

I think you should leave it as it. Any object being passed to res.json(Object) should either be serializable or have a .toJson() method.

If it fails, that's not our responsibility.

What we can do is add some comment to the res.json method to set expectations. @samtuga1

[samtuga1]

I think your change is altering how jsonEncode works.

If toEncodable is omitted, it defaults to a function that returns the result of calling .toJson() on the unencodable object.

See here: https://api.flutter.dev/flutter/dart-convert/jsonEncode.html

So it means its either we make it session.toJson ourselves or check the type in the customEncoder and make it .toJson
I dont know why the toEncodable is changing the behaviour tho hmm...

[codekeyz]

I think you should leave it as it. Any object being passed to res.json(Object) should either be serializable or have a .toJson() method.

If it fails, that's not our responsibility.

What we can do is add some comment to the res.json method to set expectations. @samtuga1

Let's get rid of the custom encoder.

[samtuga1]

I think you should leave it as it. Any object being passed to res.json(Object) should either be serializable or have a .toJson() method.

If it fails, that's not our responsibility.

What we can do is add some comment to the res.json method to set expectations. @samtuga1

yeah so something like /// [params] must be encodable or? and give some examples (a value that is not a number, boolean, string, null, list or a map with string keys)

[samtuga1]

I think you should leave it as it. Any object being passed to res.json(Object) should either be serializable or have a .toJson() method.
If it fails, that's not our responsibility.
What we can do is add some comment to the res.json method to set expectations. @samtuga1

Let's get rid of the custom encoder.

hmm...lets explore some other solutions to see

[samtuga1]

I think you should leave it as it. Any object being passed to res.json(Object) should either be serializable or have a .toJson() method.
If it fails, that's not our responsibility.
What we can do is add some comment to the res.json method to set expectations. @samtuga1

Let's get rid of the custom encoder.

@codekeyz see here...this is dart's implementation of jsonEncode()

  String encode(Object? value, {Object? toEncodable(dynamic object)?}) {
    toEncodable ??= _toEncodable;
    if (toEncodable == null) return encoder.convert(value);

   // it tries to encode the non-encodable Objects below converting when the toEncodable != null
  // that is the problem
    return JsonEncoder(toEncodable).convert(value);
  }

  JsonEncoder get encoder {
    if (_toEncodable == null) return const JsonEncoder();
    return JsonEncoder(_toEncodable);
  }

maybe we can implement our own logic to work for us looking at this

edit: the .convert method uses a private class so not sure its possible

[codekeyz]

I think you should leave it as it. Any object being passed to res.json(Object) should either be serializable or have a .toJson() method.
If it fails, that's not our responsibility.
What we can do is add some comment to the res.json method to set expectations. @samtuga1

Let's get rid of the custom encoder.

@codekeyz see here...this is dart's implementation of jsonEncode()

  String encode(Object? value, {Object? toEncodable(dynamic object)?}) {
    toEncodable ??= _toEncodable;
    if (toEncodable == null) return encoder.convert(value);

   // it tries to encode the non-encodable Objects below converting when the toEncodable != null
  // that is the problem
    return JsonEncoder(toEncodable).convert(value);
  }

  JsonEncoder get encoder {
    if (_toEncodable == null) return const JsonEncoder();
    return JsonEncoder(_toEncodable);
  }

maybe we can implement our own logic to work for us looking at this

Nope. Let's stay close to the language as much as possible. Let's just add the comments.

/// [object] should be json-encodable
Response json(Object? object);

If this comes up again as an issue, we'll look more into this. @samtuga1

[samtuga1]

I think you should leave it as it. Any object being passed to res.json(Object) should either be serializable or have a .toJson() method.
If it fails, that's not our responsibility.
What we can do is add some comment to the res.json method to set expectations. @samtuga1

Let's get rid of the custom encoder.

@codekeyz see here...this is dart's implementation of jsonEncode()

  String encode(Object? value, {Object? toEncodable(dynamic object)?}) {
    toEncodable ??= _toEncodable;
    if (toEncodable == null) return encoder.convert(value);

   // it tries to encode the non-encodable Objects below converting when the toEncodable != null
  // that is the problem
    return JsonEncoder(toEncodable).convert(value);
  }

  JsonEncoder get encoder {
    if (_toEncodable == null) return const JsonEncoder();
    return JsonEncoder(_toEncodable);
  }

maybe we can implement our own logic to work for us looking at this

Nope. Let's stay close to the language as much as possible. Let's just add the comments.

/// [object] should be json-encodable
Response json(Object? object);

If this comes up again as an issue, we'll look more into this. @samtuga1

sure no problem, i'll add that and fix that in the test asap