Skip to content

Commit 985a7d8

Browse files
yyanwangyyanwang
authored
Merge branch 'master' into ywang/chore/DGHT-287
2 parents 2f814e0 + 68d30a7 commit 985a7d8

File tree

43 files changed

+592
-137
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

43 files changed

+592
-137
lines changed

‎packages/cmf-cqrs/CHANGELOG.md‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,12 @@
11
# @talend/react-cmf-cqrs
22

3+
## 11.0.1
4+
5+
### Patch Changes
6+
7+
- Updated dependencies [816bb91]
8+
- @talend/react-cmf@11.0.0
9+
310
## 11.0.0
411

512
### Major Changes

‎packages/cmf-cqrs/package.json‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@
3232
},
3333
"homepage": "https://github.com/Talend/ui/cmf-cqrs#readme",
3434
"dependencies": {
35-
"@talend/react-cmf": "^10.0.1",
35+
"@talend/react-cmf": "^11.0.0",
3636
"@talend/utils": "^3.2.3",
3737
"immutable": "^3.8.2",
3838
"redux-saga": "^1.3.0"
@@ -60,5 +60,5 @@
6060
"publishConfig": {
6161
"access": "public"
6262
},
63-
"version": "11.0.0"
63+
"version": "11.0.1"
6464
}

‎packages/cmf-router/CHANGELOG.md‎

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,57 @@
11
# Changelog
22

3+
## 8.0.0
4+
5+
### Major Changes
6+
7+
- 816bb91: BREAKING CHANGE: Upgraded path-to-regexp from 3.x to 8.x
8+
9+
This upgrade was necessary to resolve security vulnerabilities. The new version introduces two breaking changes that require updates to your application:
10+
11+
1. Optional Path Parameter Syntax Change
12+
13+
- Old syntax: `/resources/:id?`
14+
- New syntax: `/resources{/id}`
15+
16+
This change is required because in path-to-regexp 8.x, the `?` character is reserved for query parameters and will throw a parsing error when used at the end of a path.
17+
18+
2. Root Path Matching Behavior Change
19+
20+
- In v3.x, root path `/` would match any path starting with `/`
21+
- In v8.x, root path `/` only matches exactly `/`
22+
- To match both root and child paths, use the wildcard pattern `/{*path}`
23+
24+
Example migration:
25+
26+
```javascript
27+
// Before
28+
const routes = {
29+
'/': rootSaga,
30+
'/resources/:id?': resourceSaga
31+
};
32+
33+
// After
34+
const routes = {
35+
'/{*path}': rootSaga, // if you want to match all routes
36+
'/resources{/id}': resourceSaga
37+
};
38+
```
39+
40+
For more details about path matching and troubleshooting, see [path-to-regexp documentation](https://github.com/pillarjs/path-to-regexp#errors).
41+
42+
### Patch Changes
43+
44+
- Updated dependencies [816bb91]
45+
- @talend/react-cmf@11.0.0
46+
47+
## 7.1.1
48+
49+
### Patch Changes
50+
51+
- e2d8899: Revert: upgrade path-to-regexp
52+
- Updated dependencies [e2d8899]
53+
- @talend/react-cmf@10.1.1
54+
355
## 7.1.0
456

557
### Minor Changes

‎packages/cmf-router/package.json‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "@talend/react-cmf-router",
3-
"version": "7.1.0",
3+
"version": "8.0.0",
44
"description": "",
55
"main": "lib/index.js",
66
"module": "./lib-esm/index.js",
@@ -25,7 +25,7 @@
2525
"lint": "talend-scripts lint"
2626
},
2727
"dependencies": {
28-
"@talend/react-cmf": "^10.1.0",
28+
"@talend/react-cmf": "^11.0.0",
2929
"connected-react-router": "^6.9.3",
3030
"history": "^5.3.0",
3131
"lodash": "^4.17.21",

‎packages/cmf-router/src/sagaRouter.md‎

Lines changed: 98 additions & 51 deletions
Original file line numberDiff line numberDiff line change
@@ -48,10 +48,11 @@ yield spawn(routerSaga, history, routes);
4848
```
4949

5050
## Matching pattern
51+
5152
```javascript
5253
const routes = {
53-
"/datasets/add": saga1,
54-
"/connections/:datastoreid/edit/add-dataset": saga2
54+
'/datasets/add': saga1,
55+
'/connections/:datastoreid/edit/add-dataset': saga2,
5556
};
5657
```
5758

@@ -65,9 +66,9 @@ and that we have the following configuration
6566

6667
```javascript
6768
const routes = {
68-
"/datasets": datasets,
69-
"/datasets/add": datasetsSaga,
70-
"/connections/add": connectionsSaga
69+
'/datasets': datasets,
70+
'/datasets/add': datasetsSaga,
71+
'/connections/add': connectionsSaga,
7172
};
7273
```
7374

@@ -90,10 +91,11 @@ and that we have the following configuration
9091

9192
```javascript
9293
const routes = {
93-
"/datasets/add": datasetsSaga,
94-
"/connections/add": connectionsSaga
94+
'/datasets/add': datasetsSaga,
95+
'/connections/add': connectionsSaga,
9596
};
9697
```
98+
9799
only `datasetsSaga` will be executed.
98100

99101
Now the route is changed to `localhost/connections/add`
@@ -116,35 +118,34 @@ so saga of `/datasets` will be restarted when route changes.
116118
Optionally, if you want to run a saga only on exact match, you can pass a configuration `runOnExactMatch` as true,
117119
then saga will be started when its route exactly match current location, and will be stopped when change to any other route.
118120

119-
120121
```javascript
121-
import { sagaRouter } from '@talend/react-cmf';
122122
import { browserHistory as history } from 'react-router';
123123

124+
import { sagaRouter } from '@talend/react-cmf';
125+
124126
const CANCEL_ACTION = 'CANCEL_ACTION';
125127
// route configuration, a url fragment match with a generator
126128
const routes = {
127-
'/datasets': {
128-
// runOnExactMatch: true,
129-
restartOnRouteChange: true,
130-
saga: function* datasets(notUsed, isExact) {
131-
if (!isExact) {
132-
return;
133-
}
134-
yield take(CANCEL_ACTION);
135-
yield put({
136-
type: REDIRECT_CONNECTION_ADD_DATASET_CANCEL,
137-
cmf: {
138-
routerReplace: `/connections/${datastoreId}/edit`,
139-
},
140-
});
141-
},
142-
},
143-
'/datasets/add': function* addDataset() {}
129+
'/datasets': {
130+
// runOnExactMatch: true,
131+
restartOnRouteChange: true,
132+
saga: function* datasets(notUsed, isExact) {
133+
if (!isExact) {
134+
return;
135+
}
136+
yield take(CANCEL_ACTION);
137+
yield put({
138+
type: REDIRECT_CONNECTION_ADD_DATASET_CANCEL,
139+
cmf: {
140+
routerReplace: `/connections/${datastoreId}/edit`,
141+
},
142+
});
143+
},
144+
},
145+
'/datasets/add': function* addDataset() {},
144146
};
145147
```
146148

147-
148149
### Partial route matching
149150

150151
Given the webapp url is `localhost/datasets/add/connection/add`
@@ -153,10 +154,11 @@ and that we have the following configuration
153154

154155
```javascript
155156
const routes = {
156-
"/datasets/add": datasetsSaga,
157-
"/connections/add": connectionsSaga
157+
'/datasets/add': datasetsSaga,
158+
'/connections/add': connectionsSaga,
158159
};
159160
```
161+
160162
only `datasetsSaga` will be executed.
161163

162164
because the route key can be matched on any part of the url.
@@ -171,57 +173,61 @@ and that we have the following configuration
171173

172174
```javascript
173175
const routes = {
174-
"/datasets/add": datasetsSaga,
175-
"/datasets/add/connection/add": datasetConnectionsSaga,
176-
"/connection/add": connectionsSaga,
176+
'/datasets/add': datasetsSaga,
177+
'/datasets/add/connection/add': datasetConnectionsSaga,
178+
'/connection/add': connectionsSaga,
177179
};
178180
```
181+
179182
`datasetsSaga`, `datasetConnectionSaga` and `connectionSaga` are running.
180183

181184
### Route matching and route parameters.
185+
182186
Given the webapp url is `localhost/datasets/50/edit`
183187

184188
and that we have the following configuration
185189

186190
```javascript
187-
function* editDatasetSaga ({datasetId}){
188-
// do something
191+
function* editDatasetSaga({ datasetId }) {
192+
// do something
189193
}
190194

191195
const routes = {
192-
"/datasets/add": datasetsSaga,
193-
"/datasets/:datasetId/edit": editDatasetSaga
196+
'/datasets/add': datasetsSaga,
197+
'/datasets/:datasetId/edit': editDatasetSaga,
194198
};
195199
```
200+
196201
only `editDatasetsSaga` will be executed and :datasetId will be resolved and given to the running saga as a parameter.
197202

198203
url parameters are resolved and given to the executed saga in form of an object, because we can match on many of them.
199204

200205
```javascript
201-
function* connectionSaga ({connectionId, datasetId}){
202-
// do something
206+
function* connectionSaga({ connectionId, datasetId }) {
207+
// do something
203208
}
204209

205210
const routes = {
206-
"/datasets/add": datasetsSaga,
207-
"/datasets/:datasetId/edit": editDatasetSaga,
208-
"/datasets/:datasetId/connections/:connectionId": connectionSaga
211+
'/datasets/add': datasetsSaga,
212+
'/datasets/:datasetId/edit': editDatasetSaga,
213+
'/datasets/:datasetId/connections/:connectionId': connectionSaga,
209214
};
210215
```
211216

212217
### Route matching with route parameter change
218+
213219
Given the webapp url is `localhost/datasets/50/edit`
214220

215221
and that we have the following configuration
216222

217223
```javascript
218-
function* editDatasetSaga ({datasetId}){
219-
// do something
224+
function* editDatasetSaga({ datasetId }) {
225+
// do something
220226
}
221227

222228
const routes = {
223-
"/datasets/add": datasetsSaga,
224-
"/datasets/:datasetId/edit": editDatasetSaga
229+
'/datasets/add': datasetsSaga,
230+
'/datasets/:datasetId/edit': editDatasetSaga,
225231
};
226232
```
227233

@@ -234,24 +240,65 @@ the `editDatasetsSaga` is cancelled, and when its done, restarted with the new v
234240
Only sagas matching on a route which parameter change are restarted.
235241

236242
### Route matching with optionnal parameters
243+
237244
Given the webapp url is `localhost/datasets/add/550`
238245

239246
and that we have the following configuration
240247

241248
```javascript
242-
function* editDatasetSaga ({datasetId}){
243-
// do something
249+
function* editDatasetSaga({ datasetId }) {
250+
// do something
244251
}
245252

246253
const routes = {
247-
"/datasets/add/:connectionId?": datasetsSaga,
248-
"/datasets/:datasetId/edit": editDatasetSaga
254+
'/datasets/add{/:connectionId}': datasetsSaga,
255+
'/datasets/:datasetId/edit': editDatasetSaga,
249256
};
250257
```
258+
251259
datasetSaga will be executed
252260

253261
if the route change to `localhost/datasets/add`
254262

255-
the `datasetsSaga` will be restarted since it still match on `/datasets/add/:connectionId?` route and that the parameter has changed from being a value to being absent.
263+
the `datasetsSaga` will be restarted since it still match on `/datasets/add{/:connectionId}` route and that the parameter has changed from being a value to being absent.
264+
265+
the {/:connectionId} at the end of path means /connectionId is optional.
266+
267+
### Root Path Matching
268+
269+
The root path `/` has special matching behavior that's important to understand:
270+
271+
1. Exact root path matching:
272+
273+
```javascript
274+
const routes = {
275+
'/': function* rootSaga() {
276+
yield take('SOMETHING');
277+
},
278+
};
279+
```
280+
281+
- Only matches exactly `/`
282+
- Does not match child routes like `/tasks` or `/users/123`
283+
- This is because path-to-regexp treats the root path `/` differently than other routes - it won't do partial matching even when `exact` is false
284+
- If you want `/` to match any path that starts with `/`, you need to use a wildcard pattern like `/{*path}`
285+
286+
2. Matching root and all child routes:
287+
288+
```javascript
289+
const routes = {
290+
'/{*path}': function* rootSaga({ path }) {
291+
yield take('SOMETHING');
292+
},
293+
};
294+
```
295+
296+
- Matches both root path `/` and all child routes
297+
- For root path `/`, params will be empty `{}`
298+
- For child routes, `params.path` will contain the remaining path:
299+
- `/tasks` → `{ path: 'tasks' }`
300+
- `/tasks/123` → `{ path: 'tasks/123' }`
301+
302+
This pattern is particularly useful when you need a saga to run for all routes in your application while still being able to access the current route path.
256303

257-
the ? at the end of the parameter define that it is optional.
304+
For more details about path matching and troubleshooting, see [path-to-regexp documentation](https://github.com/pillarjs/path-to-regexp#errors).

0 commit comments

Comments
 (0)