Skip to content

Commit 60049f3

Browse files
authored
Merge pull request #94 from strongloop/Link_to_migration_steps
Add link to migration steps
2 parents 148bb73 + 97bc224 commit 60049f3

File tree

1 file changed

+38
-24
lines changed

1 file changed

+38
-24
lines changed

pages/en/lb3/3.0-Release-Notes.md

Lines changed: 38 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,9 @@ We have reworked loopback-datasource-juggler and connectors to not rely on
2828
a single juggler instance anymore. As the last step, juggler became a regular
2929
dependency.
3030

31-
See [loopback#275](https://github.com/strongloop/loopback/issues/275).
31+
Please See [loopback#275](https://github.com/strongloop/loopback/issues/275).
32+
33+
Please see [how to migrate](http://loopback.io/doc/en/lb3/Migrating-to-3.0.html#loopback-datasource-juggler-is-a-regular-dependency-now)
3234

3335
## Use bluebird as *the* Promise library
3436

@@ -37,9 +39,11 @@ instead of `global.Promise`.
3739
We consider Bluebird API a part of LoopBack API from now on,
3840
you are welcome to use any Bluebird-specific methods in your applications.
3941

40-
See [loopback#1896](https://github.com/strongloop/loopback/pull/1896) and
42+
Please See [loopback#1896](https://github.com/strongloop/loopback/pull/1896) and
4143
[loopback-datasource-juggler#790](https://github.com/strongloop/loopback-datasource-juggler/pull/790).
4244

45+
Please see [how to migrate](http://loopback.io/doc/en/lb3/Migrating-to-3.0.html#no-need-to-polyfill-promise-on-node-v010)
46+
4347
## Cleanup in conversion and coercion of input arguments
4448

4549
We have significantly reworked conversion and coercion of input arguments
@@ -81,7 +85,7 @@ unaffected. If your start seeing unusual amount of 400 error responses after
8185
upgrading to LoopBack 3.x, then please check the client code and ensure it
8286
correctly encodes request parameters.
8387

84-
See the following pull requests for more details:
88+
Please See the following pull requests for more details:
8589

8690
- [strong-remoting#343](https://github.com/strongloop/strong-remoting/pull/343)
8791
- [strong-remoting#347](https://github.com/strongloop/strong-remoting/pull/347)
@@ -120,9 +124,11 @@ will need to change implementation accordingly.
120124
You can learn more about the rationale behind the new handler in
121125
[this comment](https://github.com/strongloop/loopback/issues/1650#issuecomment-161920555)
122126

123-
See [strong-remoting#302](https://github.com/strongloop/strong-remoting/pull/302)
127+
Please See [strong-remoting#302](https://github.com/strongloop/strong-remoting/pull/302)
124128
and [`strong-error-handler`](https://github.com/strongloop/strong-error-handler/).
125129

130+
Please see [how to migrate](http://loopback.io/doc/en/lb3/Migrating-to-3.0.html#new-error-handler-for-rest)
131+
126132
## Full replace vs. partial update
127133

128134
There are two ways to update an existing record (model instance):
@@ -176,11 +182,13 @@ to simplify the upgrade path:
176182
allowing applications to opt into the new 3.x behaviour while still
177183
running on LoopBack 2.x
178184

179-
See [loopback#2316](https://github.com/strongloop/loopback/pull/2316),
185+
Please See [loopback#2316](https://github.com/strongloop/loopback/pull/2316),
180186
[loopback-datasource-juggler#788](https://github.com/strongloop/loopback-datasource-juggler/pull/788),
181187
[replaceOnPUT flag](http://loopback.io/doc/en/lb2/Exposing-models-over-REST.html#replaceonput-flag)
182188
and related documentation.
183189

190+
Please see [how to migrate](http://loopback.io/doc/en/lb3/Migrating-to-3.0.html#put-methods-perform-full-replace-now)
191+
184192
## Current context API and middleware were removed
185193

186194
We have removed the following current-context-related APIs:
@@ -198,15 +206,17 @@ on the first HTTP request received:
198206
```
199207
Unhandled error for request GET /api/Users:
200208
Error: remoting.context option was removed in version 3.0.
201-
See https://docs.strongloop.com/display/APIC/Using%20current%20context for more
209+
Please See https://docs.strongloop.com/display/APIC/Using%20current%20context for more
202210
details.
203211
at restApiHandler (.../node_modules/loopback/server/middleware/rest.js:44:15)
204212
at Layer.handle [as handle_request] (.../node_modules/express/lib/router/layer.js:95:5)
205213
```
206214

207-
See [loopback#2564](https://github.com/strongloop/loopback/pull/2564)
215+
Please See [loopback#2564](https://github.com/strongloop/loopback/pull/2564)
208216
and [documentation](https://docs.strongloop.com/display/APIC/Using+current+context)
209217

218+
Please see [how to migrate](http://loopback.io/doc/en/lb3/Migrating-to-3.0.html#the-current-context-feature-was-moved-to-loopback-context)
219+
210220
## CORS is no longer enabled
211221

212222
There are two types of applications that are commonly built using LoopBack,
@@ -231,9 +241,11 @@ version of `slc loopback` or `apic loopback`, as these applications don't rely
231241
on the built-in CORS middleware and configure CORS explicitly
232242
in `server/middleware.json`.
233243

234-
See [pull request #352](https://github.com/strongloop/strong-remoting/pull/352) and
244+
Please See [pull request #352](https://github.com/strongloop/strong-remoting/pull/352) and
235245
[Security considerations](https://docs.strongloop.com/display/public/LB/Security+considerations).
236246

247+
Please see [how to migrate](http://loopback.io/doc/en/lb3/Migrating-to-3.0.html#check-your-cors-configuration)
248+
237249
## Simpler metadata for remote methods
238250

239251
In 2.x, remote methods were defined as:
@@ -270,7 +282,7 @@ prototype methods (`isStatic: false`).
270282
}
271283
```
272284

273-
See [loopback#2174](https://github.com/strongloop/loopback/pull/2174).
285+
Please See [loopback#2174](https://github.com/strongloop/loopback/pull/2174).
274286

275287
## Unused user properties were removed
276288

@@ -299,7 +311,7 @@ model json file as follows:
299311
}
300312
```
301313

302-
See [loopback#2299](https://github.com/strongloop/loopback/pull/2299).
314+
Please See [loopback#2299](https://github.com/strongloop/loopback/pull/2299).
303315

304316
## Getters for Express 3.x middleware were removed
305317

@@ -327,14 +339,16 @@ removed properties together with the middleware module name to use instead:
327339

328340
We have also removed `loopback.mime`, which was always set to `undefined`.
329341

330-
See [loopback#2349](https://github.com/strongloop/loopback/pull/2394).
342+
Please See [loopback#2349](https://github.com/strongloop/loopback/pull/2394).
331343

332344
## `loopback.errorhandler` was removed
333345

334346
We have removed `loopback#errorhandler` middleware, users should
335347
use `strong-error-handler` instead.
336348

337-
See [loopback#2411](https://github.com/strongloop/loopback/pull/2411).
349+
Please See[loopback#2411](https://github.com/strongloop/loopback/pull/2411).
350+
351+
Please see [how to migrate](http://loopback.io/doc/en/lb3/Migrating-to-3.0.html#new-error-handler-for-rest)
338352

339353
## Serialization of Date values in responses
340354

@@ -368,7 +382,7 @@ regardless of the server timezone settings:
368382
}
369383
```
370384

371-
See [strong-remoting#344](https://github.com/strongloop/strong-remoting/pull/344).
385+
Please See [strong-remoting#344](https://github.com/strongloop/strong-remoting/pull/344).
372386

373387
## `PersistedModel.find` provides `ctx.data` in "loaded" hook now
374388

@@ -383,7 +397,7 @@ This has been fixed in 3.0 and the "loaded" hook now consistently provides
383397
checks `if (ctx.instance)` then you can remove this condition together with
384398
the branch that follows.
385399

386-
See [loopback-datasource-juggler@30283291](https://github.com/strongloop/loopback-datasource-juggler/commit/30283291?w=1).
400+
Please See [loopback-datasource-juggler@30283291](https://github.com/strongloop/loopback-datasource-juggler/commit/30283291?w=1).
387401

388402
## `PersistedModel.create` no longer returns the instance(s) created
389403

@@ -397,7 +411,7 @@ We have changed the API to be consistent with other DAO methods: when invoked
397411
with a callback argument, the method does not return anything. When invoked
398412
without any callback, a promise is returned.
399413

400-
See [loopback-datasource-juggler#918](https://github.com/strongloop/loopback-datasource-juggler/pull/918).
414+
Please See [loopback-datasource-juggler#918](https://github.com/strongloop/loopback-datasource-juggler/pull/918).
401415

402416
## Applying an undefined mixin to a LoopBack model throws an error
403417

@@ -406,7 +420,7 @@ logged regarding the invalid mixin, which needs to be addressed rather than
406420
silently ignored. This has been fixed in 3.0, therefore an undefined mixin
407421
applied to a LoopBack model will throw an error that needs to be handled.
408422

409-
See [loopback-datasource-juggler#944](https://github.com/strongloop/loopback-datasource-juggler/pull/944).
423+
Please See [loopback-datasource-juggler#944](https://github.com/strongloop/loopback-datasource-juggler/pull/944).
410424

411425
## Deprecated model events were removed
412426

@@ -419,15 +433,15 @@ Model events
419433
* deletedAll
420434
* deleted
421435

422-
See [loopback-datasource-juggler#965](https://github.com/strongloop/loopback-datasource-juggler/pull/965).
436+
Please See [loopback-datasource-juggler#965](https://github.com/strongloop/loopback-datasource-juggler/pull/965).
423437

424438
## Model property names with dot(s) generates an error
425439

426440
Instead of showing a deprecation warning for model property names with dots,
427441
for example, `customer.name: 'string'`, an error is thrown in 3.0 for
428442
enforcing use of valid model property names.
429443

430-
See [loopback-datasource-juggler#947](https://github.com/strongloop/loopback-datasource-juggler/pull/947).
444+
Please See [loopback-datasource-juggler#947](https://github.com/strongloop/loopback-datasource-juggler/pull/947).
431445

432446
## Array input for updateOrCreate function is no longer allowed
433447

@@ -438,7 +452,7 @@ create new instances with this method before). If you would like to perform a
438452
bulk `updateOrCreate`, you could use `async.each` or `Promise.all` to
439453
repeatedly call `updateOfCreate` for each instance.
440454

441-
See [related code change](https://github.com/strongloop/loopback-datasource-juggler/pull/889) here.
455+
Please See [related code change](https://github.com/strongloop/loopback-datasource-juggler/pull/889) here.
442456

443457
## Settings `strict: validate` and `strict: throw` were removed
444458

@@ -501,7 +515,7 @@ var johndoe = new User({ name: 'John doe', age: 15, gender: 'm'});
501515
// Details: gender is not defined in the model (value: 'm').
502516
```
503517

504-
See [loopback-datasource-juggler#1084](https://github.com/strongloop/loopback-datasource-juggler/pull/1084).
518+
Please See [loopback-datasource-juggler#1084](https://github.com/strongloop/loopback-datasource-juggler/pull/1084).
505519

506520
## Models with auto-generated ids reject user-provided id values
507521

@@ -530,7 +544,7 @@ now removed in favor of promoting use of:
530544
- `app.registry.createModel(modelName, properties, options)` to create new model
531545
- `app.model(modelCtor, config)` to update existing model and attach it to app
532546

533-
See [loopback#2401](https://github.com/strongloop/loopback/pull/2401).
547+
Please See [loopback#2401](https://github.com/strongloop/loopback/pull/2401).
534548

535549
## `Change.handleError` was removed
536550

@@ -542,7 +556,7 @@ Use `PersistedModel` to report change-tracking errors via the existing method
542556
`PersistedModel.handleChangeError`. This method can be customized on a per-model
543557
basis to provide different error handling.
544558

545-
See [loopback#2308](https://github.com/strongloop/loopback/pull/2308).
559+
Please See [loopback#2308](https://github.com/strongloop/loopback/pull/2308).
546560

547561
## `loopback.autoAttach` is gone
548562

@@ -560,7 +574,7 @@ In LoopBack 3.0, we have removed these two APIs completely.
560574
`DataSource.registerType()` method was removed as it was a deprecated wrapper
561575
for `ModelBuilder.registerType()`.
562576

563-
See [loopback-datasource-juggler#976](https://github.com/strongloop/loopback-datasource-juggler/pull/976).
577+
Please See [loopback-datasource-juggler#976](https://github.com/strongloop/loopback-datasource-juggler/pull/976).
564578

565579
## strong-remoting API changes
566580

@@ -606,7 +620,7 @@ remoteObjectsInstance.defineType(name, converter)
606620
remoteObjectsInstance.defineObjectType(name, factoryFn)
607621
```
608622

609-
See the API docs and
623+
Please See the API docs and
610624
[pull request #343](https://github.com/strongloop/strong-remoting/pull/343)
611625
for more details.
612626

0 commit comments

Comments
 (0)