Make templates work with nonempty baseUrls (e.g., IIS virtual directories)

SteveSandersonMS · SteveSandersonMS · commit e65ecebac6f3 · 2017-07-11T23:56:51.000+01:00
diff --git a/templates/AngularSpa/ClientApp/app/app.module.browser.ts b/templates/AngularSpa/ClientApp/app/app.module.browser.ts
@@ -10,12 +10,12 @@ import { AppComponent } from './components/app/app.component';
         AppModuleShared
     ],
     providers: [
-        { provide: 'ORIGIN_URL', useFactory: getOriginUrl }
+        { provide: 'BASE_URL', useFactory: getBaseUrl }
     ]
 })
 export class AppModule {
 }
 
-export function getOriginUrl() { 
-    return location.origin; 
+export function getBaseUrl() {
+    return document.getElementsByTagName('base')[0].href;
 }
diff --git a/templates/AngularSpa/ClientApp/app/components/fetchdata/fetchdata.component.ts b/templates/AngularSpa/ClientApp/app/components/fetchdata/fetchdata.component.ts
@@ -8,8 +8,8 @@ import { Http } from '@angular/http';
 export class FetchDataComponent {
     public forecasts: WeatherForecast[];
 
-    constructor(http: Http, @Inject('ORIGIN_URL') originUrl: string) {
-        http.get(originUrl + '/api/SampleData/WeatherForecasts').subscribe(result => {
+    constructor(http: Http, @Inject('BASE_URL') baseUrl: string) {
+        http.get(baseUrl + 'api/SampleData/WeatherForecasts').subscribe(result => {
             this.forecasts = result.json() as WeatherForecast[];
         }, error => console.error(error));
     }
diff --git a/templates/AngularSpa/ClientApp/boot.server.ts b/templates/AngularSpa/ClientApp/boot.server.ts
@@ -1,6 +1,7 @@
 import 'reflect-metadata';
 import 'zone.js';
 import 'rxjs/add/operator/first';
+import { APP_BASE_HREF } from '@angular/common';
 import { enableProdMode, ApplicationRef, NgZone, ValueProvider } from '@angular/core';
 import { platformDynamicServer, PlatformState, INITIAL_CONFIG } from '@angular/platform-server';
 import { createServerRenderer, RenderResult } from 'aspnet-prerendering';
@@ -11,7 +12,8 @@ enableProdMode();
 export default createServerRenderer(params => {
     const providers = [
         { provide: INITIAL_CONFIG, useValue: { document: '<app></app>', url: params.url } },
-        { provide: 'ORIGIN_URL', useValue: params.origin }
+        { provide: APP_BASE_HREF, useValue: params.baseUrl },
+        { provide: 'BASE_URL', useValue: params.origin + params.baseUrl },
     ];
 
     return platformDynamicServer(providers).bootstrapModule(AppModule).then(moduleRef => {
diff --git a/templates/AngularSpa/webpack.config.js b/templates/AngularSpa/webpack.config.js
@@ -13,7 +13,7 @@ module.exports = (env) => {
         resolve: { extensions: [ '.js', '.ts' ] },
         output: {
             filename: '[name].js',
-            publicPath: '/dist/' // Webpack dev middleware, if enabled, handles requests for this URL prefix
+            publicPath: 'dist/' // Webpack dev middleware, if enabled, handles requests for this URL prefix
         },
         module: {
             rules: [
diff --git a/templates/AngularSpa/webpack.config.vendor.js b/templates/AngularSpa/webpack.config.vendor.js
@@ -36,7 +36,7 @@ module.exports = (env) => {
             ]
         },
         output: {
-            publicPath: '/dist/',
+            publicPath: 'dist/',
             filename: '[name].js',
             library: '[name]_[hash]'
         },
diff --git a/templates/AureliaSpa/ClientApp/app/components/fetchdata/fetchdata.ts b/templates/AureliaSpa/ClientApp/app/components/fetchdata/fetchdata.ts
@@ -6,7 +6,7 @@ export class Fetchdata {
     public forecasts: WeatherForecast[];
 
     constructor(http: HttpClient) {
-        http.fetch('/api/SampleData/WeatherForecasts')
+        http.fetch('api/SampleData/WeatherForecasts')
             .then(result => result.json() as Promise<WeatherForecast[]>)
             .then(data => {
                 this.forecasts = data;
diff --git a/templates/AureliaSpa/ClientApp/boot.ts b/templates/AureliaSpa/ClientApp/boot.ts
@@ -1,5 +1,6 @@
 import 'isomorphic-fetch';
 import { Aurelia, PLATFORM } from 'aurelia-framework';
+import { HttpClient } from 'aurelia-fetch-client';
 import 'bootstrap/dist/css/bootstrap.css';
 import 'bootstrap';
 declare const IS_DEV_BUILD: boolean; // The value is supplied by Webpack during the build
@@ -11,5 +12,10 @@ export function configure(aurelia: Aurelia) {
         aurelia.use.developmentLogging();
     }
 
+    new HttpClient().configure(config => {
+        const baseUrl = document.getElementsByTagName('base')[0].href;
+        config.withBaseUrl(baseUrl);
+    });
+
     aurelia.start().then(() => aurelia.setRoot(PLATFORM.moduleName('app/components/app/app')));
 }
diff --git a/templates/AureliaSpa/webpack.config.js b/templates/AureliaSpa/webpack.config.js
@@ -14,7 +14,7 @@ module.exports = (env) => {
         },
         output: {
             path: path.resolve(bundleOutputDir),
-            publicPath: '/dist/',
+            publicPath: 'dist/',
             filename: '[name].js'
         },
         module: {
diff --git a/templates/AureliaSpa/webpack.config.vendor.js b/templates/AureliaSpa/webpack.config.vendor.js
@@ -38,7 +38,7 @@ module.exports = ({ prod } = {}) => {
         },
         output: {
             path: path.join(__dirname, 'wwwroot', 'dist'),
-            publicPath: '/dist/',
+            publicPath: 'dist/',
             filename: '[name].js',
             library: '[name]_[hash]',
         },
diff --git a/templates/KnockoutSpa/ClientApp/boot.ts b/templates/KnockoutSpa/ClientApp/boot.ts
@@ -4,12 +4,14 @@ import * as ko from 'knockout';
 import './webpack-component-loader';
 import AppRootComponent from './components/app-root/app-root';
 const createHistory = require('history').createBrowserHistory;
+const baseUrl = document.getElementsByTagName('base')[0].getAttribute('href');
+const basename = baseUrl.substring(0, baseUrl.length - 1); // History component needs no trailing slash
 
 // Load and register the <app-root> component
 ko.components.register('app-root', AppRootComponent);
 
 // Tell Knockout to start up an instance of your application
-ko.applyBindings({ history: createHistory() });
+ko.applyBindings({ history: createHistory({ basename }), basename });
 
 // Basic hot reloading support. Automatically reloads and restarts the Knockout app each time
 // you modify source files. This will not preserve any application state other than the URL.
diff --git a/templates/KnockoutSpa/ClientApp/components/app-root/app-root.html b/templates/KnockoutSpa/ClientApp/components/app-root/app-root.html
@@ -1,7 +1,7 @@
 <div class='container-fluid'>
     <div class='row'>
         <div class='col-sm-3'>
-            <nav-menu params='route: route'></nav-menu>
+            <nav-menu params='router: router'></nav-menu>
         </div>
         <div class='col-sm-9' data-bind='component: { name: route().page, params: route }'></div>
     </div>
diff --git a/templates/KnockoutSpa/ClientApp/components/app-root/app-root.ts b/templates/KnockoutSpa/ClientApp/components/app-root/app-root.ts
@@ -12,12 +12,12 @@ const routes: Route[] = [
 
 class AppRootViewModel {
     public route: KnockoutObservable<Route>;
-    private _router: Router;
+    public router: Router;
 
-    constructor(params: { history: History.History }) {
+    constructor(params: { history: History.History, basename: string }) {
         // Activate the client-side router
-        this._router = new Router(params.history, routes)
-        this.route = this._router.currentRoute;
+        this.router = new Router(params.history, routes, params.basename);
+        this.route = this.router.currentRoute;
 
         // Load and register all the KO components needed to handle the routes
         // The optional 'bundle-loader?lazy!' prefix is a Webpack feature that causes the referenced modules
@@ -32,7 +32,7 @@ class AppRootViewModel {
     // To support hot module replacement, this method unregisters the router and KO components.
     // In production scenarios where hot module replacement is disabled, this would not be invoked.
     public dispose() {
-        this._router.dispose();
+        this.router.dispose();
 
         // TODO: Need a better API for this
         Object.getOwnPropertyNames((<any>ko).components._allRegisteredComponents).forEach(componentName => {
diff --git a/templates/KnockoutSpa/ClientApp/components/fetch-data/fetch-data.ts b/templates/KnockoutSpa/ClientApp/components/fetch-data/fetch-data.ts
@@ -12,7 +12,7 @@ class FetchDataViewModel {
     public forecasts = ko.observableArray<WeatherForecast>();
 
     constructor() {
-        fetch('/api/SampleData/WeatherForecasts')
+        fetch('api/SampleData/WeatherForecasts')
             .then(response => response.json() as Promise<WeatherForecast[]>)
             .then(data => {
                 this.forecasts(data);
diff --git a/templates/KnockoutSpa/ClientApp/components/nav-menu/nav-menu.html b/templates/KnockoutSpa/ClientApp/components/nav-menu/nav-menu.html
@@ -13,17 +13,17 @@
         <div class='navbar-collapse collapse'>
             <ul class='nav navbar-nav'>
                 <li>
-                    <a href='/' data-bind='css: { active: route().page === "home-page" }'>
+                    <a data-bind='attr: { href: router.link("/") }, css: { active: route().page === "home-page" }'>
                         <span class='glyphicon glyphicon-home'></span> Home
                     </a>
                 </li>
                 <li>
-                    <a href='/counter' data-bind='css: { active: route().page === "counter-example" }'>
+                    <a data-bind='attr: { href: router.link("/counter") }, css: { active: route().page === "counter-example" }'>
                         <span class='glyphicon glyphicon-education'></span> Counter
                     </a>
                 </li>
                 <li>
-                    <a href='/fetch-data' data-bind='css: { active: route().page === "fetch-data" }'>
+                    <a data-bind='attr: { href: router.link("/fetch-data") }, css: { active: route().page === "fetch-data" }'>
                         <span class='glyphicon glyphicon-th-list'></span> Fetch data
                     </a>
                 </li>
diff --git a/templates/KnockoutSpa/ClientApp/components/nav-menu/nav-menu.ts b/templates/KnockoutSpa/ClientApp/components/nav-menu/nav-menu.ts
@@ -1,18 +1,20 @@
 import * as ko from 'knockout';
-import { Route } from '../../router';
+import { Route, Router } from '../../router';
 
 interface NavMenuParams {
-    route: KnockoutObservable<Route>;
+    router: Router;
 }
 
 class NavMenuViewModel {
+    public router: Router;
     public route: KnockoutObservable<Route>;
 
     constructor(params: NavMenuParams) {
         // This viewmodel doesn't do anything except pass through the 'route' parameter to the view.
         // You could remove this viewmodel entirely, and define 'nav-menu' as a template-only component.
         // But in most apps, you'll want some viewmodel logic to determine what navigation options appear.
-        this.route = params.route;
+        this.router = params.router;
+        this.route = this.router.currentRoute;
     }
 }
 
diff --git a/templates/KnockoutSpa/ClientApp/router.ts b/templates/KnockoutSpa/ClientApp/router.ts
@@ -16,7 +16,7 @@ export class Router {
     private disposeHistory: () => void;
     private clickEventListener: EventListener;
 
-    constructor(history: History.History, routes: Route[]) {
+    constructor(private history: History.History, routes: Route[], basename: string) {
         // Reset and configure Crossroads so it matches routes and updates this.currentRoute
         crossroads.removeAllRoutes();
         crossroads.resetState();
@@ -33,8 +33,9 @@ export class Router {
             let target: any = evt.currentTarget;
             if (target && target.tagName === 'A') {
                 let href = target.getAttribute('href');
-                if (href && href.charAt(0) == '/') {
-                    history.push(href);
+                if (href && href.indexOf(basename + '/') === 0) {
+                    const hrefAfterBasename = href.substring(basename.length);
+                    history.push(hrefAfterBasename);
                     evt.preventDefault();
                 }
             }
@@ -46,6 +47,10 @@ export class Router {
         crossroads.parse((history as any).location.pathname);
     }
 
+    public link(url: string): string {
+        return this.history.createHref({ pathname: url });
+    }
+
     public dispose() {
         this.disposeHistory();
         $(document).off('click', 'a', this.clickEventListener);
diff --git a/templates/KnockoutSpa/Views/Home/Index.cshtml b/templates/KnockoutSpa/Views/Home/Index.cshtml
@@ -2,7 +2,7 @@
     ViewData["Title"] = "Home Page";
 }
 
-<app-root params="history: history"></app-root>
+<app-root params="history: history, basename: basename"></app-root>
 
 @section scripts {
     <script src="~/dist/main.js" asp-append-version="true"></script>
diff --git a/templates/KnockoutSpa/webpack.config.js b/templates/KnockoutSpa/webpack.config.js
@@ -13,7 +13,7 @@ module.exports = (env) => {
         output: {
             path: path.join(__dirname, bundleOutputDir),
             filename: '[name].js',
-            publicPath: '/dist/'
+            publicPath: 'dist/'
         },
         module: {
             rules: [
diff --git a/templates/KnockoutSpa/webpack.config.vendor.js b/templates/KnockoutSpa/webpack.config.vendor.js
@@ -21,7 +21,7 @@ module.exports = (env) => {
         },
         output: {
             path: path.join(__dirname, 'wwwroot', 'dist'),
-            publicPath: '/dist/',
+            publicPath: 'dist/',
             filename: '[name].js',
             library: '[name]_[hash]',
         },
diff --git a/templates/ReactReduxSpa/ClientApp/boot-client.tsx b/templates/ReactReduxSpa/ClientApp/boot-client.tsx
@@ -12,7 +12,8 @@ import * as RoutesModule from './routes';
 let routes = RoutesModule.routes;
 
 // Create browser history to use in the Redux store
-const history = createBrowserHistory();
+const baseUrl = document.getElementsByTagName('base')[0].getAttribute('href');
+const history = createBrowserHistory({ basename: baseUrl });
 
 // Get the application-wide store instance, prepopulating with state from the server where available.
 const initialState = (window as any).initialReduxState as ApplicationState;
diff --git a/templates/ReactReduxSpa/ClientApp/boot-server.tsx b/templates/ReactReduxSpa/ClientApp/boot-server.tsx
@@ -12,15 +12,17 @@ export default createServerRenderer(params => {
     return new Promise<RenderResult>((resolve, reject) => {
         // Prepare Redux store with in-memory history, and dispatch a navigation event
         // corresponding to the incoming URL
+        const basename = params.baseUrl.substring(0, params.baseUrl.length - 1); // Remove trailing slash
+        const urlAfterBasename = params.url.substring(basename.length);
         const store = configureStore(createMemoryHistory());
-        store.dispatch(replace(params.location));
+        store.dispatch(replace(urlAfterBasename));
 
         // Prepare an instance of the application and perform an inital render that will
         // cause any async tasks (e.g., data access) to begin
         const routerContext: any = {};
         const app = (
             <Provider store={ store }>
-                <StaticRouter context={ routerContext } location={ params.location.path } children={ routes } />
+                <StaticRouter basename={ basename } context={ routerContext } location={ params.location.path } children={ routes } />
             </Provider>
         );
         renderToString(app);
diff --git a/templates/ReactReduxSpa/ClientApp/store/WeatherForecasts.ts b/templates/ReactReduxSpa/ClientApp/store/WeatherForecasts.ts
@@ -45,7 +45,7 @@ export const actionCreators = {
     requestWeatherForecasts: (startDateIndex: number): AppThunkAction<KnownAction> => (dispatch, getState) => {
         // Only load data if it's something we don't already have (and are not already loading)
         if (startDateIndex !== getState().weatherForecasts.startDateIndex) {
-            let fetchTask = fetch(`/api/SampleData/WeatherForecasts?startDateIndex=${ startDateIndex }`)
+            let fetchTask = fetch(`api/SampleData/WeatherForecasts?startDateIndex=${ startDateIndex }`)
                 .then(response => response.json() as Promise<WeatherForecast[]>)
                 .then(data => {
                     dispatch({ type: 'RECEIVE_WEATHER_FORECASTS', startDateIndex: startDateIndex, forecasts: data });
diff --git a/templates/ReactReduxSpa/webpack.config.js b/templates/ReactReduxSpa/webpack.config.js
@@ -13,7 +13,7 @@ module.exports = (env) => {
         resolve: { extensions: ['.js', '.jsx', '.ts', '.tsx'] },
         output: {
             filename: '[name].js',
-            publicPath: '/dist/' // Webpack dev middleware, if enabled, handles requests for this URL prefix
+            publicPath: 'dist/' // Webpack dev middleware, if enabled, handles requests for this URL prefix
         },
         module: {
             rules: [
diff --git a/templates/ReactReduxSpa/webpack.config.vendor.js b/templates/ReactReduxSpa/webpack.config.vendor.js
@@ -33,7 +33,7 @@ module.exports = (env) => {
             ],
         },
         output: {
-            publicPath: '/dist/',
+            publicPath: 'dist/',
             filename: '[name].js',
             library: '[name]_[hash]',
         },
diff --git a/templates/ReactSpa/ClientApp/boot.tsx b/templates/ReactSpa/ClientApp/boot.tsx
@@ -10,9 +10,10 @@ let routes = RoutesModule.routes;
 function renderApp() {
     // This code starts up the React app when it runs in a browser. It sets up the routing
     // configuration and injects the app into a DOM element.
+    const baseUrl = document.getElementsByTagName('base')[0].getAttribute('href');
     ReactDOM.render(
         <AppContainer>
-            <BrowserRouter children={ routes } />
+            <BrowserRouter children={ routes } basename={ baseUrl } />
         </AppContainer>,
         document.getElementById('react-app')
     );
diff --git a/templates/ReactSpa/ClientApp/components/FetchData.tsx b/templates/ReactSpa/ClientApp/components/FetchData.tsx
@@ -11,7 +11,7 @@ export class FetchData extends React.Component<{}, FetchDataExampleState> {
         super();
         this.state = { forecasts: [], loading: true };
 
-        fetch('/api/SampleData/WeatherForecasts')
+        fetch('api/SampleData/WeatherForecasts')
             .then(response => response.json() as Promise<WeatherForecast[]>)
             .then(data => {
                 this.setState({ forecasts: data, loading: false });
diff --git a/templates/ReactSpa/webpack.config.js b/templates/ReactSpa/webpack.config.js
@@ -13,7 +13,7 @@ module.exports = (env) => {
         output: {
             path: path.join(__dirname, bundleOutputDir),
             filename: '[name].js',
-            publicPath: '/dist/'
+            publicPath: 'dist/'
         },
         module: {
             rules: [
diff --git a/templates/ReactSpa/webpack.config.vendor.js b/templates/ReactSpa/webpack.config.vendor.js
@@ -21,7 +21,7 @@ module.exports = (env) => {
         },
         output: {
             path: path.join(__dirname, 'wwwroot', 'dist'),
-            publicPath: '/dist/',
+            publicPath: 'dist/',
             filename: '[name].js',
             library: '[name]_[hash]',
         },
diff --git a/templates/VueSpa/ClientApp/components/fetchdata/fetchdata.ts b/templates/VueSpa/ClientApp/components/fetchdata/fetchdata.ts
@@ -13,7 +13,7 @@ export default class FetchDataComponent extends Vue {
     forecasts: WeatherForecast[] = [];
 
     mounted() {
-        fetch('/api/SampleData/WeatherForecasts')
+        fetch('api/SampleData/WeatherForecasts')
             .then(response => response.json() as Promise<WeatherForecast[]>)
             .then(data => {
                 this.forecasts = data;
diff --git a/templates/VueSpa/webpack.config.js b/templates/VueSpa/webpack.config.js
@@ -23,7 +23,7 @@ module.exports = (env) => {
         output: {
             path: path.join(__dirname, bundleOutputDir),
             filename: '[name].js',
-            publicPath: '/dist/'
+            publicPath: 'dist/'
         },
         plugins: [
             new CheckerPlugin(),
diff --git a/templates/VueSpa/webpack.config.vendor.js b/templates/VueSpa/webpack.config.vendor.js
@@ -28,7 +28,7 @@ module.exports = (env) => {
         },
         output: { 
             path: path.join(__dirname, 'wwwroot', 'dist'),
-            publicPath: '/dist/',
+            publicPath: 'dist/',
             filename: '[name].js',
             library: '[name]_[hash]'
         },

Original file line number	Diff line number	Diff line change
`@@ -10,12 +10,12 @@ import { AppComponent } from './components/app/app.component';`
`10`	`10`	`AppModuleShared`
`11`	`11`	`],`
`12`	`12`	`providers: [`
`13`		`- { provide: 'ORIGIN_URL', useFactory: getOriginUrl }`
	`13`	`+ { provide: 'BASE_URL', useFactory: getBaseUrl }`
`14`	`14`	`]`
`15`	`15`	`})`
`16`	`16`	`export class AppModule {`
`17`	`17`	`}`
`18`	`18`
`19`		`-export function getOriginUrl() {`
`20`		`- return location.origin;`
	`19`	`+export function getBaseUrl() {`
	`20`	`+ return document.getElementsByTagName('base')[0].href;`
`21`	`21`	`}`
Original file line number	Diff line number	Diff line change
`@@ -36,7 +36,7 @@ module.exports = (env) => {`
`36`	`36`	`]`
`37`	`37`	`},`
`38`	`38`	`output: {`
`39`		`- publicPath: '/dist/',`
	`39`	`+ publicPath: 'dist/',`
`40`	`40`	`filename: '[name].js',`
`41`	`41`	`library: '[name]_[hash]'`
`42`	`42`	`},`