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

[@types/react-adal v0.5.0] endpoint in adalConfig is no longer optional due to #69 in react-adal library #44168

Closed
wants to merge 3 commits into from

Conversation

njomb
Copy link

@njomb njomb commented Apr 24, 2020

  • 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.)
  • Add or edit tests to reflect the change. (Run with npm test.)
  • Follow the advice from the readme.
  • Avoid common mistakes.
  • Run npm run lint package-name (or tsc if no tslint.json is present).

Select one of these and delete the others:
If changing an existing definition:

  • Provide a URL to documentation or source code which provides context for the suggested changes: Add invalidation of resource cache on new login salvoravida/react-adal#69
  • If this PR brings the type definitions up to date with a new version of the JS library, update the version number in the header.
  • Include tests for your changes
  • If you are making substantial changes, consider adding a tslint.json containing { "extends": "dtslint/dt.json" }. If for reason the any rule need to be disabled, disable it for that line using // tslint:disable-next-line [ruleName] and not for whole package so that the need for disabling can be reviewed.

@njomb
Copy link
Author

njomb commented Apr 24, 2020

Simple change to type definition due to relatively new functionality in react-adal version 0.5.0. Code change is documented at salvoravida/react-adal#69

Thanks to @shermayne for delving into this with me.

@typescript-bot
Copy link
Contributor

👋 Hi there! I’ve run some quick measurements against master and your PR. These metrics should help the humans reviewing this PR gauge whether it might negatively affect compile times or editor responsiveness for users who install these typings.

Let’s review the numbers, shall we?

Comparison details 📊
master #44168 diff
Batch compilation
Memory usage (MiB) 91.3 91.6 +0.3%
Type count 15966 15970 0%
Assignability cache size 34390 34391 0%
Language service
Samples taken 105 111 +6%
Identifiers in tests 105 111 +6%
getCompletionsAtPosition
    Mean duration (ms) 260.2 263.5 +1.3%
    Mean CV 10.4% 11.1%
    Worst duration (ms) 344.6 351.7 +2.0%
    Worst identifier ErrorPage exact
getQuickInfoAtPosition
    Mean duration (ms) 256.9 255.9 -0.4%
    Mean CV 10.8% 10.7% -1.2%
    Worst duration (ms) 345.3 321.8 -6.8%
    Worst identifier path exact

It looks like nothing changed too much. I won’t post performance data again unless it gets worse.

@typescript-bot typescript-bot added the Perf: Same typescript-bot determined that this PR will not significantly impact compilation performance. label Apr 24, 2020
@typescript-bot typescript-bot added this to Waiting for Reviewers in Pull Request Status Board Apr 24, 2020
@typescript-bot
Copy link
Contributor

typescript-bot commented Apr 24, 2020

@njomb Thank you for submitting this PR!

🔔 @dkorolev1 - 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.

If no reviewer appears after a week, a DefinitelyTyped maintainer will review the PR instead.

@typescript-bot typescript-bot added this to Needs Maintainer Review in New Pull Request Status Board Apr 30, 2020
@typescript-bot
Copy link
Contributor

typescript-bot commented Apr 30, 2020

@njomb Thank you for submitting this PR! I see this is your first time submitting to DefinitelyTyped 👋 - keep an eye on this comment as I'll be updating it with information as things progress.

Code Reviews

Because you edited one package and updated the tests (👏), I can help you merge this PR once someone else signs off on it.

Status

  • ✅ No merge conflicts
  • ✅ Continuous integration tests have passed
  • ❌ Most recent commit is approved by type definition owners, DT maintainers or others

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


Diagnostic Information: What the bot saw about this PR
{
  "type": "info",
  "now": "-",
  "pr_number": 44168,
  "author": "njomb",
  "owners": [
    "dkorolev1"
  ],
  "dangerLevel": "ScopedAndTested",
  "headCommitAbbrOid": "aca7278",
  "headCommitOid": "aca7278d4a45674c6ebe49e1a5c848f4c6d511d7",
  "mergeIsRequested": false,
  "stalenessInDays": 10,
  "lastCommitDate": "2020-04-24T04:30:59.000Z",
  "lastAuthorCommentDate": "2020-04-24T04:29:00.000Z",
  "reviewLink": "https://github.com/DefinitelyTyped/DefinitelyTyped/pull/44168/files",
  "hasMergeConflict": false,
  "authorIsOwner": false,
  "isFirstContribution": true,
  "popularityLevel": "Well-liked by everyone",
  "anyPackageIsNew": false,
  "packages": [
    "react-adal"
  ],
  "files": [
    {
      "filePath": "types/react-adal/index.d.ts",
      "kind": "definition",
      "package": "react-adal"
    },
    {
      "filePath": "types/react-adal/react-adal-tests.tsx",
      "kind": "test",
      "package": "react-adal"
    }
  ],
  "hasDismissedReview": false,
  "travisResult": "pass",
  "reviewersWithStaleReviews": [],
  "approvalFlags": 0,
  "isChangesRequested": false
}

@typescript-bot
Copy link
Contributor

🔔 @dkorolev1 - 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.

1 similar comment
@typescript-bot
Copy link
Contributor

🔔 @dkorolev1 - 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.

@dkorolov1
Copy link
Contributor

dkorolov1 commented May 3, 2020

Hi @njomb ,

Since the endpoints parameter can still be optional in the original implementation of the adal lib (based on this condition) to support some scenarios, I think it would be more reasonable to check for null this parameter here as well, than just change the TS definition.

@salvoravida, what do you think?

Thanks

@weswigham
Copy link
Contributor

@dkorolev1 's suggestion seems on point - at least right now, the library seems like it (mostly) handles omitting the endpoint option, so it should remain optional.

@weswigham weswigham closed this May 5, 2020
@typescript-bot typescript-bot removed this from Needs Maintainer Review in New Pull Request Status Board May 5, 2020
@elibarzilay elibarzilay removed this from Waiting for Reviewers in Pull Request Status Board Jul 13, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Perf: Same typescript-bot determined that this PR will not significantly impact compilation performance.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants