DefinitelyTyped icon indicating copy to clipboard operation
DefinitelyTyped copied to clipboard

Added AWS Lambda stream type to `aws-lambda`.

Open lancejpollard opened this issue 1 year ago • 5 comments

Getting the ball rolling on this, need some help to complete, not sure exactly if I got it right (plus then need to test). Please hint at the types of tests I should add. And I wasn't 100% sure I nailed the types correctly, the code is kind of messy haha. But I am 99% sure.

The types I added come from https://github.com/aws/aws-lambda-nodejs-runtime-interface-client/blob/7374a4e338fc3b070811d55ee337740f3f6cb382/src/ResponseStream.js#L37-L64

  • Hints at the API: https://betterdev.blog/lambda-response-streaming-flush-content/

  • [x] Use a meaningful title for the pull request. Include the name of the package modified.

  • [ ] Test the change in your own code. (Compile and run.)

    • I am not sure about this, did I do things right? How do I import stream properly?
  • [ ] Add or edit tests to reflect the change.

  • [ ] Follow the advice from the readme.

  • [ ] Avoid common mistakes.

  • [ ] Run pnpm test <package to test>.

If changing an existing definition:

  • [x] Provide a URL to documentation or source code which provides context for the suggested changes: <>
  • [ ] If this PR brings the type definitions up to date with a new version of the JS library, update the version number in the package.json.

lancejpollard avatar Feb 05 '24 19:02 lancejpollard

@lancejpollard Thank you for submitting this PR! I see this is your first time submitting to DefinitelyTyped 👋 — I'm the local bot who will help you through the process of getting things through.

This is a live comment which I will keep updated.

1 package in this PR

Code Reviews

Because this is a widely-used package, a DT maintainer will need to review it before it can be merged.

You can test the changes of this PR in the Playground.

Status

  • ✅ No merge conflicts
  • ✅ Continuous integration tests have passed
  • 🕐 Only a DT maintainer can approve changes without tests

Once every item on this list is checked, I'll ask you for permission to merge and publish the changes.

Inactive

This PR has been inactive for 31 days — it is considered abandoned, and therefore closed!


Diagnostic Information: What the bot saw about this PR
{
  "type": "info",
  "now": "-",
  "pr_number": 68490,
  "author": "lancejpollard",
  "headCommitOid": "9f4b9deaf53b83a3f7b5422c4ce95502505af893",
  "mergeBaseOid": "b539e7017f7fd31c524ed5e68a1783276dc3441e",
  "lastPushDate": "2024-02-05T19:20:39.000Z",
  "lastActivityDate": "2024-02-26T01:14:46.000Z",
  "hasMergeConflict": false,
  "isFirstContribution": true,
  "tooManyFiles": false,
  "hugeChange": false,
  "popularityLevel": "Critical",
  "pkgInfo": [
    {
      "name": "aws-lambda",
      "kind": "edit",
      "files": [
        {
          "path": "types/aws-lambda/handler.d.ts",
          "kind": "definition"
        },
        {
          "path": "types/aws-lambda/package.json",
          "kind": "package-meta-ok"
        }
      ],
      "owners": [
        "darbio",
        "skarum",
        "StefH",
        "buggy",
        "wwwy3y3",
        "OrthoDex",
        "MichaelMarner",
        "daniel-cottone",
        "kostya-misura",
        "coderbyheart",
        "palmithor",
        "daniloraisi",
        "simonbuchan",
        "Haydabase",
        "repl-chris",
        "aneilbaboo",
        "jeznag",
        "louislarry",
        "dpapukchiev",
        "ohookins",
        "trevor-leach",
        "jagregory",
        "dalen",
        "loikg",
        "skyzenr",
        "redlickigrzegorz",
        "juancarbonel",
        "pwmcintyre",
        "alex-bolenok-centralreach",
        "marianzange",
        "apalumbo",
        "SachinShekhar",
        "ivanmartos",
        "zach-anthony",
        "savnik",
        "bboure",
        "jamesorlakin",
        "aphex",
        "joeykilpatrick",
        "lmanerich"
      ],
      "addedOwners": [],
      "deletedOwners": [],
      "popularityLevel": "Critical"
    }
  ],
  "reviews": [
    {
      "type": "changereq",
      "reviewer": "simonbuchan",
      "date": "2024-02-26T01:14:46.000Z"
    },
    {
      "type": "stale",
      "reviewer": "codershiba",
      "date": "2024-02-22T12:32:53.000Z",
      "abbrOid": "0dbdd54"
    }
  ],
  "mainBotCommentID": 1927873241,
  "ciResult": "pass"
}

typescript-bot avatar Feb 05 '24 19:02 typescript-bot

Hey @lancejpollard,

:unamused: Your PR doesn't modify any tests, so it's hard to know what's being fixed, and your changes might regress in the future. Please consider adding tests to cover the change you're making. Including tests allows this PR to be merged by yourself and the owners of this module.

This can potentially save days of time for you!

typescript-bot avatar Feb 05 '24 19:02 typescript-bot

🔔 @darbio @skarum @StefH @buggy @wwwy3y3 @OrthoDex @MichaelMarner @daniel-cottone @kostya-misura @coderbyheart @palmithor @daniloraisi @simonbuchan @Haydabase @repl-chris @aneilbaboo @jeznag @louislarry @dpapukchiev @ohookins @trevor-leach @jagregory @dalen @loikg @skyzenr @redlickigrzegorz @juancarbonel @pwmcintyre @alex-bolenok-centralreach @marianzange @apalumbo @SachinShekhar @ivanmartos @zach-anthony @savnik @bboure @jamesorlakin @aphex @joeykilpatrick @lmanerich — please review this PR in the next few days. Be sure to explicitly select Approve or Request Changes in the GitHub UI so I know what's going on.

typescript-bot avatar Feb 05 '24 19:02 typescript-bot

@lancejpollard The CI build failed! Please review the logs for more information.

Once you've pushed the fixes, the build will automatically re-run. Thanks!

Note: builds which are failing do not end up on the list of PRs for the DT maintainers to review.

typescript-bot avatar Feb 05 '24 19:02 typescript-bot

@lancejpollard The CI build failed! Please review the logs for more information.

Once you've pushed the fixes, the build will automatically re-run. Thanks!

Note: builds which are failing do not end up on the list of PRs for the DT maintainers to review.

typescript-bot avatar Feb 05 '24 19:02 typescript-bot

It has been more than two weeks and this PR still has no reviews.

I'll bump it to the DT maintainer queue. Thank you for your patience, @lancejpollard.

(Ping @darbio, @skarum, @StefH, @buggy, @wwwy3y3, @OrthoDex, @MichaelMarner, @daniel-cottone, @kostya-misura, @coderbyheart, @palmithor, @daniloraisi, @simonbuchan, @Haydabase, @repl-chris, @aneilbaboo, @jeznag, @louislarry, @dpapukchiev, @ohookins, @trevor-leach, @jagregory, @dalen, @loikg, @skyzenr, @redlickigrzegorz, @juancarbonel, @pwmcintyre, @alex-bolenok-centralreach, @marianzange, @apalumbo, @SachinShekhar, @ivanmartos, @zach-anthony, @savnik, @bboure, @jamesorlakin, @aphex, @joeykilpatrick, @lmanerich.)

typescript-bot avatar Feb 25 '24 23:02 typescript-bot

Formatting

The following files are not formatted:

  1. types/aws-lambda/handler.d.ts

Consider running pnpm dprint fmt on these files to make review easier.

Generated by :no_entry_sign: dangerJS against 9f4b9deaf53b83a3f7b5422c4ce95502505af893

DangerBotOSS avatar Feb 25 '24 23:02 DangerBotOSS

@codershiba Thank you for reviewing this PR! The author has pushed new commits since your last review. Could you take another look and submit a fresh review?

typescript-bot avatar Feb 25 '24 23:02 typescript-bot

@lancejpollard One or more reviewers has requested changes. Please address their comments. I'll be back once they sign off or you've pushed new commits. Thank you!

typescript-bot avatar Feb 26 '24 01:02 typescript-bot

@lancejpollard I haven't seen any activity on this PR in more than three weeks, and it still has problems that prevent it from being merged. The PR will be closed on Mar 27th (in a week) if the issues aren't addressed.

typescript-bot avatar Mar 20 '24 04:03 typescript-bot

@lancejpollard To keep things tidy, we have to close PRs that aren't mergeable and don't have activity in the last month. No worries, though — please open a new PR if you'd like to continue with this change. Thank you!

typescript-bot avatar Mar 28 '24 01:03 typescript-bot