Missing class definition in output.py

[jeastham1993]

Describe the bug
There is a missing class InvalidRestApiRequest in the output.py file. The handle_create_order.py tries to import this but doesn't actually use it. I'm not sure if the class needs to be created, or it's been removed and the imports haven't been cleaned up.

To Reproduce
Steps to reproduce the behavior:

1. Bootstrap a new service
2. Deploy to AWS
3. Try to invoke the API endpoints, returns internal server error
4. Error message is Unable to import module 'activity_service.handlers.handle_create_order': cannot import name 'InvalidRestApiRequest' from 'activity_service.models.output' (/var/task/activity_service/models/output.py)

Expected behavior
The API returns

Screenshots

Desktop (please complete the following information):

• OS: [e.g. iOS]
• Browser [e.g. chrome, safari]
• Version [e.g. 22]

Smartphone (please complete the following information):

• Device: [e.g. iPhone6]
• OS: [e.g. iOS8.1]
• Browser [e.g. stock browser, safari]
• Version [e.g. 22]

Additional context

[github-actions]

Thank you for opening this issue, we'll review it ASAP.

[jeastham1993]

@ran-isenberg I'm happy to contribute the fix if you could let me know whether the class should or shouldn't be there.

[ran-isenberg]

Hey @jeastham1993 , InvalidRestApiRequest doesnt exist and didnt exist i think for over 10 months. There are zero references for it in the code (i dont see imports). InvalidRestApiRequest was replaced with Powertool's built-in invalid request schema validation as can seen by the deployed service (live) on AWS:
https://ran-isenberg.github.io/aws-lambda-handler-cookbook/swagger/swagger/
is it possible that you are using not the latest branch or had some merge issues from an older version?

In addition, for every PR there are linters, import checks and full deployment to AWS followed by E2E tests, so i know the API is valid and has no import errors.

Can you check on your side again?

[jeastham1993]

Hey @ran-isenberg , I've just created a brand new project using cookiecutter gh:ran-isenberg/cookiecutter-serverless-python. And this is the contents of the handle_create_order.py

from typing import Annotated, Any


from aws_lambda_env_modeler import get_environment_variables, init_environment_variables
from aws_lambda_powertools.event_handler.openapi.params import Body
from aws_lambda_powertools.logging import correlation_paths
from aws_lambda_powertools.metrics import MetricUnit
from aws_lambda_powertools.utilities.typing import LambdaContext

from service.handlers.models.dynamic_configuration import MyConfiguration
from service.handlers.models.env_vars import MyHandlerEnvVars
from service.handlers.utils.dynamic_configuration import parse_configuration
from service.handlers.utils.observability import logger, metrics, tracer
from service.handlers.utils.rest_api_resolver import ORDERS_PATH, app
from service.logic.create_order import create_order
from service.models.input import CreateOrderRequest
from service.models.output import CreateOrderOutput, InternalServerErrorOutput, InvalidRestApiRequest

[ran-isenberg]

ah! coockiecutter! damn i need to fix the code there, i might have missed that part when i synced the projects and forgot to deploy it there.
There's not enough automation there. Most people just use this project via github template option.
so the issue is actually in the second repo of cookiecutter.
Thanks!

[ran-isenberg]

@jeastham1993 fixed in https://github.com/ran-isenberg/cookiecutter-serverless-python/releases/tag/7.0.5

Thanks for the clarification. The code here has full github deployment and automation, cookiecutter, not so much (maybe i should vibe code it!).

You can create a new project and the code should be fine, i tested scaffolding and ran make pr to see it run all the tests and deployment.

[jeastham1993]

That makes a lot of sense @ran-isenberg 👍 as you know, Python is definitely not a first language for me 😆 maybe update the README to be clearer that cookiecutter is the least preferred option? I just opened the repo, scrolled down and saw the command and thought that was 'the way' to get started.

[ran-isenberg]

Well, cookiecutter gives the best experience for scaffolding but de facto people prefer to either copy code snippets from here or fork this project instead of using cookiecutter. My bad for missing that import when syncing the files though!
I'll think about the readme phrasing.

[ran-isenberg]

@jeastham1993 the cookiecutter project now has a pipeline ran-isenberg/cookiecutter-serverless-python#31
now, every change will be tested properly and deployed to an AWS account. Thanks for alerting me on the issue :)