Skip to content

Switch away from deprecated Route.transitionTo #830

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Nov 20, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 0 additions & 11 deletions app/mixins/hash-redirect.js

This file was deleted.

10 changes: 7 additions & 3 deletions app/routes/class.js
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,10 @@ import { inject as service } from '@ember/service';
import Route from '@ember/routing/route';

export default class ClassRoute extends Route {
/** @type {import('@ember/routing/router-service').default} */
@service
router;

@service
legacyModuleMappings;

Expand Down Expand Up @@ -29,14 +33,14 @@ export default class ClassRoute extends Route {
if (!mappedInfo.error && model.className !== mappedInfo.newName) {
let { itemType, newName, newModule } = mappedInfo;
if (itemType === 'class') {
return this.transitionTo(
return this.router.transitionTo(
`project-version.classes.class`,
'ember',
'release',
newName
);
} else {
return this.transitionTo(
return this.router.transitionTo(
`project-version.functions.function`,
'ember',
'release',
Expand All @@ -45,6 +49,6 @@ export default class ClassRoute extends Route {
);
}
}
return this.transitionTo('project-version', 'ember', 'release');
return this.router.transitionTo('project-version', 'ember', 'release');
}
}
8 changes: 6 additions & 2 deletions app/routes/data-class.js
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,10 @@ import { inject as service } from '@ember/service';
import Route from '@ember/routing/route';

export default class DataClassRoute extends Route {
/** @type {import('@ember/routing/router-service').default} */
@service
router;

@service
legacyModuleMappings;

Expand Down Expand Up @@ -30,14 +34,14 @@ export default class DataClassRoute extends Route {
newName = newName.substr(3);
}
if (!mappingInfo.error) {
return this.transitionTo(
return this.router.transitionTo(
`project-version.classes.class`,
'ember-data',
'release',
newName
);
} else {
return this.transitionTo('project-version', 'ember', 'release');
return this.router.transitionTo('project-version', 'ember', 'release');
}
}
}
12 changes: 10 additions & 2 deletions app/routes/data-module.js
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,10 @@ import { inject as service } from '@ember/service';
import Route from '@ember/routing/route';

export default class DataModuleRoute extends Route {
/** @type {import('@ember/routing/router-service').default} */
@service
router;

@service
legacyModuleMappings;

Expand All @@ -27,9 +31,13 @@ export default class DataModuleRoute extends Route {
mappings
);
if (mappingInfo.module === '@ember-data') {
return this.transitionTo(`project-version`, 'ember-data', 'release');
return this.router.transitionTo(
`project-version`,
'ember-data',
'release'
);
} else {
return this.transitionTo(
return this.router.transitionTo(
`project-version.modules.module`,
'ember-data',
'release',
Expand Down
7 changes: 6 additions & 1 deletion app/routes/index.js
Original file line number Diff line number Diff line change
@@ -1,7 +1,12 @@
import Route from '@ember/routing/route';
import { inject as service } from '@ember/service';

export default class IndexRoute extends Route {
/** @type {import('@ember/routing/router-service').default} */
@service
router;

redirect() {
return this.transitionTo('project', 'ember');
return this.router.transitionTo('project', 'ember');
}
}
8 changes: 6 additions & 2 deletions app/routes/module.js
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,10 @@ import { inject as service } from '@ember/service';
import Route from '@ember/routing/route';

export default class ModuleRoute extends Route {
/** @type {import('@ember/routing/router-service').default} */
@service
router;

@service
legacyModuleMappings;

Expand All @@ -23,13 +27,13 @@ export default class ModuleRoute extends Route {
model.mappings
);
if (!mappingInfo.error && model.moduleName !== mappingInfo.module) {
return this.transitionTo(
return this.router.transitionTo(
`project-version.modules.module`,
'ember',
'release',
mappingInfo.module
);
}
return this.transitionTo('project-version', 'ember', 'release');
return this.router.transitionTo('project-version', 'ember', 'release');
}
}
13 changes: 8 additions & 5 deletions app/routes/project-version.js
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ export default class ProjectVersionRoute extends Route {
@service
metaStore;

/** @type {import('@ember/routing/router-service').default} */
@service
router;

Expand Down Expand Up @@ -83,7 +84,7 @@ export default class ProjectVersionRoute extends Route {
model.get('project.id') === 'ember-data' &&
modules.indexOf('ember-data-overview') !== -1
) {
return this.transitionTo(
return this.router.transitionTo(
'project-version.modules.module',
model.get('project.id'),
transitionVersion,
Expand All @@ -92,14 +93,14 @@ export default class ProjectVersionRoute extends Route {
}

// ember / ember-cli / ember-data if no @main declaration exists for ember-data-overview
return this.transitionTo('project-version.index');
return this.router.transitionTo('project-version.index');
} else {
// else go to the version specified
let moduleRevs = this.metaStore.getEncodedModulesFromProjectRev(
model.get('id')
);
let module = this.getFirstModule(moduleRevs);
return this.transitionTo(
return this.router.transitionTo(
'project-version.modules.module',
model.get('project.id'),
transitionVersion,
Expand Down Expand Up @@ -218,9 +219,11 @@ export default class ProjectVersionRoute extends Route {
);
let isEmberProject = project === 'ember';
if (!isEmberProject || !shouldConvertPackages) {
this.transitionTo(`/${project}/${projectVersionID}/${endingRoute}`);
this.router.transitionTo(
`/${project}/${projectVersionID}/${endingRoute}`
);
} else {
this.transitionTo(`/${project}/${projectVersionID}`);
this.router.transitionTo(`/${project}/${projectVersionID}`);
}
}

Expand Down
8 changes: 6 additions & 2 deletions app/routes/project-version/classes/class.js
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,10 @@ import getFullVersion from 'ember-api-docs/utils/get-full-version';
import createExcerpt from 'ember-api-docs/utils/create-excerpt';

export default class ClassRoute extends Route.extend(ScrollTracker) {
/** @type {import('@ember/routing/router-service').default} */
@service
router;

@service
headData;

Expand Down Expand Up @@ -67,7 +71,7 @@ export default class ClassRoute extends Route.extend(ScrollTracker) {

if (queryParams.anchor && queryParams.type) {
let type = queryParams.type;
this.transitionTo(
this.router.transitionTo(
`project-version.classes.class.${pluralize(type)}.${type}`,
lookupParams('project-version').project,
lookupParams('project-version').project_version,
Expand All @@ -77,7 +81,7 @@ export default class ClassRoute extends Route.extend(ScrollTracker) {
}

if (model.isError) {
this.transitionTo('404');
this.router.transitionTo('404');
}
}

Expand Down
13 changes: 11 additions & 2 deletions app/routes/project.js
Original file line number Diff line number Diff line change
@@ -1,7 +1,12 @@
import Route from '@ember/routing/route';
import ScrollTracker from 'ember-api-docs/mixins/scroll-tracker';
import { inject as service } from '@ember/service';

export default class ProjectRoute extends Route.extend(ScrollTracker) {
/** @type {import('@ember/routing/router-service').default} */
@service
router;

model({ project: projectName }) {
let projectNameToLookUp = 'ember';

Expand All @@ -11,7 +16,7 @@ export default class ProjectRoute extends Route.extend(ScrollTracker) {
}

if (projectName.indexOf('cli') !== -1) {
return this.transitionTo('ember-cli');
return this.router.transitionTo('ember-cli');
}

return this.store.findRecord('project', projectNameToLookUp, {
Expand All @@ -21,6 +26,10 @@ export default class ProjectRoute extends Route.extend(ScrollTracker) {

// Using redirect instead of afterModel so transition succeeds and returns 307 in fastboot
redirect(project /*, transition */) {
return this.transitionTo('project-version', project.get('id'), 'release');
return this.router.transitionTo(
'project-version',
project.get('id'),
'release'
);
}
}
17 changes: 13 additions & 4 deletions tests/acceptance/convert-legacy-url-to-current-test.js
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,10 @@ module('Acceptance | convert legacy url to current', function (hooks) {

test('should convert url for legacy Ember class', async function (assert) {
await visit('/classes/Ember.Application.html');
assert.equal(currentURL(), '/ember/release/classes/Application');
assert.equal(
currentURL(),
'/ember/release/classes/Application?show=inherited'
);
});

test('should convert url for legacy Ember class to function', async function (assert) {
Expand All @@ -20,19 +23,25 @@ module('Acceptance | convert legacy url to current', function (hooks) {

test('should convert url for legacy ember data class', async function (assert) {
await visit('/data/classes/DS.Adapter.html');
assert.equal(currentURL(), '/ember-data/release/classes/Adapter');
assert.equal(
currentURL(),
'/ember-data/release/classes/Adapter?show=inherited'
);
});

test('should convert url for legacy ember module', async function (assert) {
await visit('/modules/ember-application.html');
assert.equal(currentURL(), '/ember/release/modules/@ember%2Fapplication');
assert.equal(
currentURL(),
'/ember/release/modules/@ember%2Fapplication?show=inherited'
);
});

test('should convert url for legacy ember data module to overview', async function (assert) {
await visit('/data/modules/ember-data.html');
assert.equal(
currentURL(),
'/ember-data/release/modules/ember-data-overview'
'/ember-data/release/modules/ember-data-overview?show=inherited'
);
});

Expand Down
2 changes: 1 addition & 1 deletion tests/acceptance/redirects-test.js
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ module('Acceptance | redirects', function (hooks) {

assert.equal(
currentURL(),
'/ember/1.0/modules/ember',
'/ember/1.0/modules/ember?show=inherited',
'routes to the first module of the project-version'
);
});
Expand Down
2 changes: 1 addition & 1 deletion tests/acceptance/switch-versions-test.js
Original file line number Diff line number Diff line change
Expand Up @@ -250,7 +250,7 @@ module('Acceptance | version navigation', function (hooks) {
await waitForSettled();
assert.equal(
currentURL(),
'/ember/2.11/modules/ember',
'/ember/2.11/modules/ember?show=inherited',
'navigated to v2.11 ember module'
);
});
Expand Down