Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: Fix up handler type #3282

Merged
merged 2 commits into from
Jan 10, 2025
Merged

chore: Fix up handler type #3282

merged 2 commits into from
Jan 10, 2025

Conversation

nalanj
Copy link
Contributor

@nalanj nalanj commented Jan 9, 2025

I kept noticing spots where I was getting eslint errors because of our handlers being async but the handler type expected void and not Promise<void>. This updates the type for handlers and cleans up the resulting type errors.

If you want to see this in action, before switching to this branch check out line 125 in packages/jobs/lib/routes/tasks/putTask.ts. It has an eslint warning because of a misused promise. After this update that eslint warning is gone.

@nalanj nalanj self-assigned this Jan 9, 2025
@@ -12,7 +12,7 @@ export interface Route<E extends Endpoint<any>> {

export interface RouteHandler<E extends Endpoint<any>> extends Route<E> {
validate: (req: EndpointRequest<E>, res: EndpointResponse<E>, next: NextFunction) => void;
handler: (req: EndpointRequest<E>, res: EndpointResponse<E>, next: NextFunction) => void;
handler: (req: EndpointRequest<E>, res: EndpointResponse<E>, next: NextFunction) => void | Promise<void>;
Copy link
Contributor Author

@nalanj nalanj Jan 9, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🍖 You can see down at line 22 that we generally treat it as a promise anyway.

@nalanj nalanj marked this pull request as ready for review January 9, 2025 19:35
@nalanj nalanj requested a review from a team January 9, 2025 19:35
Copy link

gitguardian bot commented Jan 10, 2025

⚠️ GitGuardian has uncovered 1 secret following the scan of your pull request.

Please consider investigating the findings and remediating the incidents. Failure to do so may lead to compromising the associated services or software components.

🔎 Detected hardcoded secret in your pull request
GitGuardian id GitGuardian status Secret Commit Filename
8205899 Triggered Generic Password 46a49ce packages/cli/docker/docker-compose.yaml View secret
🛠 Guidelines to remediate hardcoded secrets
  1. Understand the implications of revoking this secret by investigating where it is used in your code.
  2. Replace and store your secret safely. Learn here the best practices.
  3. Revoke and rotate this secret.
  4. If possible, rewrite git history. Rewriting git history is not a trivial act. You might completely break other contributing developers' workflow and you risk accidentally deleting legitimate data.

To avoid such incidents in the future consider


🦉 GitGuardian detects secrets in your source code to help developers and security teams secure the modern development process. You are seeing this because you or someone else with access to this repository has authorized GitGuardian to scan your pull request.

@nalanj nalanj enabled auto-merge (squash) January 10, 2025 13:35
@nalanj nalanj merged commit 81bd1ad into master Jan 10, 2025
21 checks passed
@nalanj nalanj deleted the alan/handler-type branch January 10, 2025 13:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants