fix(warn): should not warn missing optional params in aliases

posva · posva · commit 92f8901f5477 · 2021-01-15T10:13:45.000+01:00
diff --git a/__tests__/matcher/addingRemoving.spec.ts b/__tests__/matcher/addingRemoving.spec.ts
@@ -391,10 +391,25 @@ describe('Matcher: adding and removing records', () => {
   describe('warnings', () => {
     mockWarn()
 
-    // TODO: add warnings for invalid records
-    it.skip('warns if alias is missing a required param', () => {
+    it('warns if alias is missing a required param', () => {
       createRouterMatcher([{ path: '/:id', alias: '/no-id', component }], {})
-      expect('TODO').toHaveBeenWarned()
+      expect('same param named "id"').toHaveBeenWarned()
+    })
+
+    it('does not warn for optional param on alias', () => {
+      createRouterMatcher(
+        [{ path: '/:id', alias: '/:id-:suffix?', component }],
+        {}
+      )
+      expect('same param named').not.toHaveBeenWarned()
+    })
+
+    it('does not warn for optional param on main record', () => {
+      createRouterMatcher(
+        [{ alias: '/:id', path: '/:id-:suffix?', component }],
+        {}
+      )
+      expect('same param named').not.toHaveBeenWarned()
     })
   })
 })
diff --git a/src/matcher/index.ts b/src/matcher/index.ts
@@ -425,15 +425,21 @@ function isSameParam(a: ParamKey, b: ParamKey): boolean {
   )
 }
 
+/**
+ * Check if a path and its alias have the same required params
+ *
+ * @param a - original record
+ * @param b - alias record
+ */
 function checkSameParams(a: RouteRecordMatcher, b: RouteRecordMatcher) {
   for (let key of a.keys) {
-    if (!b.keys.find(isSameParam.bind(null, key)))
+    if (!key.optional && !b.keys.find(isSameParam.bind(null, key)))
       return warn(
         `Alias "${b.record.path}" and the original record: "${a.record.path}" should have the exact same param named "${key.name}"`
       )
   }
   for (let key of b.keys) {
-    if (!a.keys.find(isSameParam.bind(null, key)))
+    if (!key.optional && !a.keys.find(isSameParam.bind(null, key)))
       return warn(
         `Alias "${b.record.path}" and the original record: "${a.record.path}" should have the exact same param named "${key.name}"`
       )

Original file line number	Diff line number	Diff line change
`@@ -425,15 +425,21 @@ function isSameParam(a: ParamKey, b: ParamKey): boolean {`
`425`	`425`	`)`
`426`	`426`	`}`
`427`	`427`
	`428`	`+/**`
	`429`	`+ * Check if a path and its alias have the same required params`
	`430`	`+ *`
	`431`	`+ * @param a - original record`
	`432`	`+ * @param b - alias record`
	`433`	`+ */`
`428`	`434`	`function checkSameParams(a: RouteRecordMatcher, b: RouteRecordMatcher) {`
`429`	`435`	`for (let key of a.keys) {`
`430`		`- if (!b.keys.find(isSameParam.bind(null, key)))`
	`436`	`+ if (!key.optional && !b.keys.find(isSameParam.bind(null, key)))`
`431`	`437`	`return warn(`
`432`	`438`	`Alias "${b.record.path}" and the original record: "${a.record.path}" should have the exact same param named "${key.name}"`
`433`	`439`	`)`
`434`	`440`	`}`
`435`	`441`	`for (let key of b.keys) {`
`436`		`- if (!a.keys.find(isSameParam.bind(null, key)))`
	`442`	`+ if (!key.optional && !a.keys.find(isSameParam.bind(null, key)))`
`437`	`443`	`return warn(`
`438`	`444`	`Alias "${b.record.path}" and the original record: "${a.record.path}" should have the exact same param named "${key.name}"`
`439`	`445`	`)`