Move common type guards into core-util #22872

dgetu · 2022-08-10T21:56:47Z

A few type guards had duplicate identical definitions in multiple packages. This change moves the common functions to core-util.

Fixes #21734

A few type guards had duplicate definitions in multiple packages. This change moves the common functions to `core-util`. Fixes Azure#21734

azure-sdk · 2022-08-10T22:06:48Z

API change check

APIView has identified API level changes in this PR and created following API reviews.

azure-core-util

joheredi

Thanks for taking this work @dgetu! The PR is looking great! The only thing I am not too sure about and would love to see removed from the PR, are the changes under /common.

Other than that it would be really cool if you can write a few unit tests for the typeguards in core-util. You can take a look at these tests to see how they are setup in core-util

joheredi · 2022-08-11T01:29:41Z

.../@azure-rest/agrifood-farming/core-move-typeguard-utils-into-core-util_2022-08-10-21-54.json

@@ -0,0 +1,10 @@
+{


I'm not sure about these changes under common/*. Is it possible to remove these changes?

This looks like the rush change feature that we don't use (but the CADL team does, which is the only reason I know about it.)

joheredi · 2022-08-11T01:31:33Z

sdk/core/core-auth/package.json

@@ -63,6 +63,8 @@
  "sideEffects": false,
  "dependencies": {
    "@azure/abort-controller": "^1.0.0",
+    "@azure/core-util": "^1.0.1",
+    "@azure/dev-tool": "^1.0.0",


Can we remove this dev-tool dependency?

joheredi · 2022-08-11T01:43:24Z

It may be good to add a Changelog.md entry in @azure/core-util with these changes

deyaaeldeen

Looks great! Always in favor of deleting duplicate code 😄

I left one minor comment.

deyaaeldeen · 2022-08-11T02:53:12Z

sdk/test-utils/recorder/package.json

@@ -68,7 +68,7 @@
    "@azure/core-http": "^2.0.0",
    "@azure/core-rest-pipeline": "^1.1.0",
    "@azure/core-auth": "^1.3.2",
-    "@azure/core-util": "^1.0.0",
+    "@azure/core-util": "^1.0.1",


Is this change necessary?

I think it may be because core-util 1.0.0 doesn't have the new functions so code using it will break if 1.0.0 is installed which meets the ^

Yeah but I don't see the recorder using any of the new stuff.

I added a few unnecessary dependency bumps and missed this one when I reverted them. Fixed!

This reverts commit 7771acb.

… core/move-typeguard-utils-into-core-util

xirzec

Great stuff! I'm happy to get these consolidated

xirzec · 2022-08-11T18:53:08Z

Seeing some odd build failures in storage-blob due to the changes to storage-internal-avro:

Not sure at all how what changes in the files which looks like just whitespace could have affected this, but since it doesn't appear that there are any core-util related changes to that code, maybe we just revert them?

joheredi · 2022-08-11T19:39:58Z

Seeing some odd build failures in storage-blob due to the changes to storage-internal-avro:

Not sure at all how what changes in the files which looks like just whitespace could have affected this, but since it doesn't appear that there are any core-util related changes to that code, maybe we just revert them?

Yeah lets remove changes in common and storage. I guess a quick git checkout upstream/main -- sdk/storage and git checkout upstream/main -- common/tools should be enough

… core/move-typeguard-utils-into-core-util

objectHasProperty fails at runtime when it is passed a null or undefined value. This change causes these inputs to instead return false

joheredi

Looks awesome :) Thanks for the great tests

xirzec

Love the tests!

xirzec · 2022-08-12T19:27:44Z

sdk/core/core-util/test/public/typeGuards.spec.ts

+import { isDefined, isObjectWithProperties, objectHasProperty } from "../../src/index";
+import { assert } from "chai";
+
+describe("Type guards", function () {


mikeharder · 2022-09-16T05:53:39Z

@dgetu: Should the definitions of isDefined() outside of core-util be deleted now?

https://github.com/Azure/azure-sdk-for-js/search?l=TypeScript&q=%22function+isdefined%22

I'm not sure about monitor-query and notification-hubs, but I'm pretty sure the copy under test-utils can be deleted.

dgetu added 2 commits August 10, 2022 21:46

Move common type guards to core-util

bc7378e

A few type guards had duplicate definitions in multiple packages. This change moves the common functions to `core-util`. Fixes Azure#21734

Add changelogs

7771acb

ghost added Azure.Core App Configuration Azure.ApplicationModel.Configuration Communication Event Hubs Azure.Identity KeyVault labels Aug 10, 2022

ghost added Service Bus Storage Storage Service (Queues, Blobs, Files) AgriFood Remote Rendering dev-tool Issues related to the Azure SDK for JS dev-tool eslint plugin labels Aug 10, 2022

Remove unnecessary version bumps

66e31a3

joheredi reviewed Aug 11, 2022

View reviewed changes

deyaaeldeen reviewed Aug 11, 2022

View reviewed changes

dgetu added 4 commits August 11, 2022 17:23

Revert "Add changelogs"

9d82c18

This reverts commit 7771acb.

Remove unnecessary version changes

da1d6ef

Add changelog

80fb762

Merge branch 'main' of https://github.com/Azure/azure-sdk-for-js into…

e4b1a0b

… core/move-typeguard-utils-into-core-util

xirzec reviewed Aug 11, 2022

View reviewed changes

dgetu added 6 commits August 11, 2022 21:39

Merge branch 'main' of https://github.com/Azure/azure-sdk-for-js into…

ecaf2dc

… core/move-typeguard-utils-into-core-util

Revert whitespace changes to storage package

559f48d

Merge branch 'main' of https://github.com/Azure/azure-sdk-for-js into…

2ded11d

… core/move-typeguard-utils-into-core-util

Add unit tests

749c2c1

Fix objectHasProperty behavior for null, undefined

2e832d6

objectHasProperty fails at runtime when it is passed a null or undefined value. This change causes these inputs to instead return false

Revert formatting changes

94930dc

joheredi approved these changes Aug 12, 2022

View reviewed changes

Add copyright header

992e3b1

dgetu changed the title ~~Move common type guards to core-util~~ Move common type guards into core-util Aug 12, 2022

xirzec approved these changes Aug 12, 2022

View reviewed changes

dgetu merged commit f6c54e1 into Azure:main Aug 12, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Move common type guards into core-util #22872

Move common type guards into core-util #22872

dgetu commented Aug 10, 2022

azure-sdk commented Aug 10, 2022 •

edited

Loading

joheredi left a comment

joheredi Aug 11, 2022

dgetu Aug 11, 2022

xirzec Aug 11, 2022

joheredi Aug 11, 2022

dgetu Aug 11, 2022

joheredi commented Aug 11, 2022

deyaaeldeen left a comment

deyaaeldeen Aug 11, 2022

joheredi Aug 11, 2022

deyaaeldeen Aug 11, 2022

dgetu Aug 11, 2022

xirzec left a comment

xirzec commented Aug 11, 2022

joheredi commented Aug 11, 2022

joheredi left a comment

xirzec left a comment

xirzec Aug 12, 2022

mikeharder commented Sep 16, 2022

Move common type guards into core-util #22872

Move common type guards into core-util #22872

Conversation

dgetu commented Aug 10, 2022

azure-sdk commented Aug 10, 2022 • edited Loading

joheredi left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

joheredi commented Aug 11, 2022

deyaaeldeen left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

xirzec left a comment

Choose a reason for hiding this comment

xirzec commented Aug 11, 2022

joheredi commented Aug 11, 2022

joheredi left a comment

Choose a reason for hiding this comment

xirzec left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mikeharder commented Sep 16, 2022

azure-sdk commented Aug 10, 2022 •

edited

Loading