Release Resin-SDK v7.0.0 #420

pimterry · 2017-10-12T10:39:48Z

This includes lots of breaking changes, notably including the upgrade to the new API v3.

All these changes have previously been reviewed, this PR is just merging them all together and using versionbot to actually ship them to npm.

For posterity, this PR includes:

Breaking: Don't allow creating devices with discontinued device types #398
Break everything we can pre-v3 #407
Replace generateApiKey with generateProvisioningKey #410 (plus some changes after rebasing over Add application.generateProvisioningKey() #419)
*BREAKING*: Stop actively supporting node 4. #417
Move to API v3 #418
a couple of last extra changes and bugfixes on the end
---- Autogenerated Waffleboard Connection: Connects to Creating an application with a discontinued device type should fail #358

…length These were slightly convenient, but hacky and inconsistent with any data retrieved manually with $expands. One day we might bring these back, but for now it's much cleaner for everybody if we keep this simple. Change-Type: major

Both of these were generated from expanded data we'd like to remove, and somewhat messily at that. You can easily generate them by hand by expanding application yourself and looking at the name and id there by hand. Change-Type: major

….' } options to opt in instead. Change-Type: major

… types (not just Error) Change-Type: patch

…e types Connects-To: #358 Change-Type: major

Change-Type: major

Breaking: Don't allow creating devices with discontinued device types

Change-Type: major

Break everything we can pre-v3

Change-Type: major

Node 4 may well still work with the SDK for quite a while, but we'll no longer actively test against it, and it's quite possible that it may stop working entirely in any future release. Change-Type: major

Replace generateApiKey with generateProvisioningKey

*BREAKING*: Stop actively supporting node 4.

option) Change-Type: major

…& result properties now include verbs (e.g. device.application is now device.belongs_to__application). Change-Type: major

Move to API v3

thgreasi · 2017-10-12T10:41:09Z

Woohoo! I'm on it!

pimterry · 2017-10-12T11:08:11Z

@thgreasi I've been doing my own review of the codebase - I think I've actually found a couple of bugs in here in the untested device methods (things that do stuff with real devices, like shutdown/reboot) from the combination of changing the relationships and removing the expands. I'm going to do some quick testing to confirm, fix them, and then update this PR with the results soon.

ghost · 2017-10-12T11:16:47Z

@pimterry, status checks have failed for this PR. Please make appropriate changes and recommit.

thgreasi · 2017-10-12T11:46:21Z

lib/models/device.coffee

@@ -421,7 +428,7 @@ getDeviceModel = (deps, opts) ->
 	exports.getApplicationInfo = (uuidOrId, callback) ->
 		exports.get(uuidOrId).then (device) ->
 			ensureSupervisorCompatibility(device.supervisor_version, MIN_SUPERVISOR_APPS_API).then ->
-				appId = device.application[0].id
+				appId = device.belongs_to__application[0].id


I think that this needs to change since we are not expanding the belongs_to__application.
I guess that we should either expand it or use device.belongs_to__application.__id.

thgreasi · 2017-10-12T11:48:50Z

lib/models/device.coffee

@@ -812,7 +819,7 @@ getDeviceModel = (deps, opts) ->
 	exports.startApplication = (uuidOrId, callback) ->
 		exports.get(uuidOrId).then (device) ->
 			ensureSupervisorCompatibility(device.supervisor_version, MIN_SUPERVISOR_APPS_API).then ->
-				appId = device.application[0].id
+				appId = device.belongs_to__application[0].id


Like above

I think that this needs to change since we are not expanding the belongs_to__application.
I guess that we should either expand it or use device.belongs_to__application.__id.

thgreasi · 2017-10-12T11:48:57Z

lib/models/device.coffee

@@ -855,7 +862,7 @@ getDeviceModel = (deps, opts) ->
 	exports.stopApplication = (uuidOrId, callback) ->
 		exports.get(uuidOrId).then (device) ->
 			ensureSupervisorCompatibility(device.supervisor_version, MIN_SUPERVISOR_APPS_API).then ->
-				appId = device.application[0].id
+				appId = device.belongs_to__application[0].id


Like above

I think that this needs to change since we are not expanding the belongs_to__application.
I guess that we should either expand it or use device.belongs_to__application.__id.

thgreasi · 2017-10-12T11:53:08Z

lib/models/device.coffee

@@ -982,7 +989,7 @@ getDeviceModel = (deps, opts) ->
 				baseUrl: apiUrl
 				body:
 					deviceId: device.id
-					appId: device.application[0].id
+					appId: device.belongs_to__application[0].id


thgreasi · 2017-10-12T11:53:29Z

lib/models/device.coffee

 					data:
-						appId: device.application[0].id
+						appId: device.belongs_to__application[0].id


Like above twice

thgreasi · 2017-10-12T11:53:35Z

lib/models/device.coffee

@@ -1071,7 +1078,7 @@ getDeviceModel = (deps, opts) ->
 				baseUrl: apiUrl
 				body:
 					deviceId: device.id
-					appId: device.application[0].id
+					appId: device.belongs_to__application[0].id


Like above and actually I think that's the same for the rest of the occurrences in this file.
Sorry for the noise.

Change-Type: patch

…directly instead Change-Type: major

pimterry · 2017-10-12T14:33:10Z

@thgreasi See the last 4 commits - I've been through and manually tested every untested method in the devices file with a real pi. I've fixed the few that were broken by missing relationships, plus fixing a couple of preexisting bugs and mess in some of the others.

I've also stopped exposing the weird ensureSupervisorCompatibility method (though we still use it internally), which just did a semver comparison and and then threw an exception, and didn't really know anything about supervisor versions at all.

Rereview please!

thgreasi

Have some questions but already LGTM 👍 🎊

thgreasi · 2017-10-12T14:38:32Z

lib/models/device.coffee

 			return request.send
-				method: 'DELETE'
+				method: 'POST'


I guess that this changed at some point

As far as I can tell, it's needed this since basically forever, so it's never worked... The API supervisor proxy requires a POST, plus the real method to use in the body.

Horia fixed the same issue in ping recently. The problem is we just don't have automated tests for this stuff right now, so any useful but rarely used methods like this that require real devices can be silently broken 😢

thgreasi · 2017-10-12T14:39:49Z

lib/models/device.coffee

@@ -1070,8 +1085,13 @@ getDeviceModel = (deps, opts) ->
 	# 	if (error) throw error;
 	# });
 	###
-	exports.update = (uuidOrId, options, callback) ->
-		exports.get(uuidOrId).then (device) ->
+	exports.update = (uuidOrId, options = {}, callback) ->


What happens when updating with an empty object? Does it serve like a ping?

Update options are actually only allowed to be force: true/false (or nothing). All this method does is ping a device to get it to check for an update. I'm not 100% sure why that's useful, but it's a feature the supervisor supports, so I'm happy to leave it here for now.

thgreasi · 2017-10-12T14:41:15Z

lib/models/device.coffee

@@ -101,7 +101,7 @@ getDeviceModel = (deps, opts) ->
 	# 	console.log('Is compatible');
 	# });
 	###
-	exports.ensureSupervisorCompatibility = ensureSupervisorCompatibility = Promise.method (version, minVersion) ->
+	ensureSupervisorCompatibility = Promise.method (version, minVersion) ->


It seems that we don't use it in the dashboard, so 👍

ghost · 2017-10-12T15:02:34Z

VersionBot failed to carry out a status check for the above pull request here: #420. The reason for this is:
2 of 5 required status checks are pending.
Please carry out relevant changes or alert an appropriate admin.

pimterry · 2017-10-12T15:03:30Z

pimterry added 18 commits October 12, 2017 12:23

*BREAKING*: Don't expand relationships by default. Pass { expand: '..…

d809e82

….' } options to opt in instead. Change-Type: major

Update yarn.lock

b7e9445

Make device.move throw ResinInvalidDeviceType for incompatible device…

89afe7b

… types (not just Error) Change-Type: patch

*BREAKING*: Don't allow creating applications with discontinued devic…

4391099

…e types Connects-To: #358 Change-Type: major

*BREAKING*: Rename getAppWithOwner to getAppByOwner

c1b1497

Change-Type: major

Merge pull request #398 from resin-io/358-discontinued-device-types

beae7c5

Breaking: Don't allow creating devices with discontinued device types

*BREAKING*: Remove (already deprecated) models.application.getApiKey()

84ad402

Change-Type: major

Merge pull request #407 from resin-io/breaking-improvements

9f7b234

Break everything we can pre-v3

Change device registration to use a provisioning key

a340c22

Change-Type: major

*BREAKING*: Stop actively supporting node 4.

116762c

Node 4 may well still work with the SDK for quite a while, but we'll no longer actively test against it, and it's quite possible that it may stop working entirely in any future release. Change-Type: major

Merge pull request #410 from resin-io/remove-generate-api-key

37151cb

Replace generateApiKey with generateProvisioningKey

Merge pull request #417 from resin-io/deprecate-node-4

3240147

*BREAKING*: Stop actively supporting node 4.

Ignore all .env files

10166ee

*BREAKING*: Tie the SDK to a specific API version (removing apiVersion

0059047

option) Change-Type: major

*BREAKING*: Upgrade to API v3. Main change is that all relationships …

7974dc2

…& result properties now include verbs (e.g. device.application is now device.belongs_to__application). Change-Type: major

Merge pull request #418 from resin-io/api-v3

d6f99f3

Move to API v3

pimterry requested a review from thgreasi October 12, 2017 10:39

thgreasi reviewed Oct 12, 2017

View reviewed changes

lib/models/device.coffee

data:

appId: device.application[0].id

appId: device.belongs_to__application[0].id

Copy link

Member

thgreasi Oct 12, 2017

Choose a reason for hiding this comment

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

Like above twice

thgreasi reviewed Oct 12, 2017

View reviewed changes

pimterry added 2 commits October 12, 2017 16:27

Fix device interacting methods broken by non-automatic relationships

c0e9e7c

Make device.update options optional

8e74381

Change-Type: patch

pimterry added 2 commits October 12, 2017 16:28

Fix breaking bugs in device.enable/disableTcpPing

b949de6

Change-Type: patch

*BREAKING*: Remove device.ensureSupervisorCompatibility - use semver …

ea7e818

…directly instead Change-Type: major

pimterry requested a review from thgreasi October 12, 2017 14:30

thgreasi approved these changes Oct 12, 2017

View reviewed changes

pimterry added the procbots/versionbot/ready-to-merge label Oct 12, 2017

v7.0.0

b446b46

ghost merged commit 25db78a into master Oct 12, 2017

ghost removed the procbots/versionbot/ready-to-merge label Oct 12, 2017

ghost deleted the v7 branch October 12, 2017 16:03

This pull request was closed.

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Release Resin-SDK v7.0.0 #420

Release Resin-SDK v7.0.0 #420

pimterry commented Oct 12, 2017 •

edited by ghost

thgreasi commented Oct 12, 2017

pimterry commented Oct 12, 2017

ghost commented Oct 12, 2017

thgreasi Oct 12, 2017

thgreasi Oct 12, 2017

thgreasi Oct 12, 2017

thgreasi Oct 12, 2017

thgreasi Oct 12, 2017

thgreasi Oct 12, 2017 •

edited

pimterry commented Oct 12, 2017

thgreasi left a comment

thgreasi Oct 12, 2017

pimterry Oct 12, 2017

thgreasi Oct 12, 2017

pimterry Oct 12, 2017

thgreasi Oct 12, 2017

ghost commented Oct 12, 2017

pimterry commented Oct 12, 2017 •

edited

Release Resin-SDK v7.0.0 #420

Release Resin-SDK v7.0.0 #420

Conversation

pimterry commented Oct 12, 2017 • edited by ghost

thgreasi commented Oct 12, 2017

pimterry commented Oct 12, 2017

ghost commented Oct 12, 2017

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

thgreasi Oct 12, 2017 • edited

Choose a reason for hiding this comment

pimterry commented Oct 12, 2017

thgreasi 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

ghost commented Oct 12, 2017

pimterry commented Oct 12, 2017 • edited

pimterry commented Oct 12, 2017 •

edited by ghost

thgreasi Oct 12, 2017 •

edited

pimterry commented Oct 12, 2017 •

edited