Bootstrap the Remote SPA for SPA Editor

Öppna SPA på ~/Code/aem-guides-wknd-graphql/remote-spa-tutorial/react-app i din IDE

Öppna filen .env.development

Var särskilt uppmärksam på knapparna i filen och uppdatera efter behov:

REACT_APP_HOST_URI=http://localhost:4502

REACT_APP_USE_PROXY=true

REACT_APP_AUTH_METHOD=basic

REACT_APP_BASIC_AUTH_USER=admin
REACT_APP_BASIC_AUTH_PASS=admin

Kom ihåg att anpassade miljövariabler i React måste ha prefixet REACT_APP_.

• REACT_APP_HOST_URI: schemat och värddatorn för den AEM tjänsten som fjärr-SPA ansluter till.

  • Det här värdet ändras baserat på om AEM (lokal, Dev, Stage eller Production) och AEM Service Type (Author vs. Publish) ändras

• REACT_APP_USE_PROXY: På så sätt undviker du CORS-problem under utvecklingen genom att tala om för responsutvecklingsservern att proxybegäranden AEM till exempel /content, /graphql, .model.json med modulen http-proxy-middleware.

• REACT_APP_AUTH_METHOD: autentiseringsmetod för AEM hanterade begäranden, alternativ är service-token, dev-token, basic eller lämna tomt för no-auth-användningsfall

  • Krävs för användning med AEM författare
  • Krävs eventuellt för användning med AEM Publish (om innehållet skyddas)
  • Utvecklingar mot AEM SDK har stöd för lokala konton via Basic Auth. Det här är den metod som används i den här självstudien.
  • Använd åtkomsttoken när du integrerar med AEM as a Cloud Service

• REACT_APP_BASIC_AUTH_USER: AEM användarnamn av SPA som ska autentiseras när AEM hämtas.

• REACT_APP_BASIC_AUTH_PASS: AEM password av SPA som ska autentiseras när AEM hämtas.

Öppna SPA i IDE

Öppna filen src/index.js

Lägg till import ModelManager och initiera den före anropet root.render(..),

...
import { ModelManager } from "@adobe/aem-spa-page-model-manager";

// Initialize the ModelManager before invoking root.render(..).
ModelManager.initializeAsync();

const container = document.getElementById('root');
const root = createRoot(container);
root.render(<App />);

Öppna SPA i IDE

Öppna filen på src/proxy/setupProxy.spa-editor.auth.basic.js

Uppdatera filen med följande kod:

const { createProxyMiddleware } = require('http-proxy-middleware');
const {REACT_APP_HOST_URI, REACT_APP_BASIC_AUTH_USER, REACT_APP_BASIC_AUTH_PASS } = process.env;

/*
    Set up a proxy with AEM for local development
    In a production environment this proxy should be set up at the webserver level or absolute URLs should be used.
*/
module.exports = function(app) {

    /**
    * Filter to check if the request should be re-routed to AEM. The paths to be re-routed at:
    * - Starts with /content (AEM content)
    * - Starts with /graphql (AEM graphQL endpoint)
    * - Ends with .model.json (AEM Content Services)
    *
    * @param {*} path the path being requested of the SPA
    * @param {*} req the request object
    * @returns true if the SPA request should be re-routed to AEM
    */
    const toAEM = function(path, req) {
        return path.startsWith('/content') ||
            path.startsWith('/graphql') ||
            path.endsWith('.model.json')
    }

    /**
    * Re-writes URLs being proxied to AEM such that they can resolve to real AEM resources
    * - The "root" case of `/.model.json` are rewritten to the SPA's home page in AEM
    * - .model.json requests for /adventure:xxx routes are rewritten to their corresponding adventure page under /content/wknd-app/us/en/home/adventure/
    *
    * @param {*} path the path being requested of the SPA
    * @param {*} req the request object
    * @returns returns a re-written path, or nothing to use the @param path
    */
    const pathRewriteToAEM = function (path, req) {
        if (path === '/.model.json') {
            return '/content/wknd-app/us/en/home.model.json';
        } else if (path.startsWith('/adventure/') && path.endsWith('.model.json')) {
            return '/content/wknd-app/us/en/home/adventure/' + path.split('/').pop();
        }
    }

    /**
    * Register the proxy middleware using the toAEM filter and pathRewriteToAEM rewriter
    */
    app.use(
        createProxyMiddleware(
            toAEM, // Only route the configured requests to AEM
            {
                target: REACT_APP_HOST_URI,
                changeOrigin: true,
                // Pass in credentials when developing against an Author environment
                auth: `${REACT_APP_BASIC_AUTH_USER}:${REACT_APP_BASIC_AUTH_PASS}`,
                pathRewrite: pathRewriteToAEM // Rewrite SPA paths being sent to AEM
            }
        )
    );

    /**
    * Enable CORS on requests from the SPA to AEM
    *
    * If this rule is not in place, CORS errors will occur when running the SPA on http://localhost:3000
    */
    app.use((req, res, next) => {
        res.header("Access-Control-Allow-Origin", REACT_APP_HOST_URI);
        next();
    });
};

Filen setupProxy.spa-editor.auth.basic.js ska se ut så här:

Den här proxykonfigurationen gör två huvudsaker:

1. Proxies-specifika begäranden som gjorts till SPA (http://localhost:3000) till AEM http://localhost:4502

   • Det är bara proxybegäranden vars sökvägar matchar mönster som anger att de ska hanteras av AEM, enligt definitionen i toAEM(path, req).
   • SPA sökvägar skrivs om till motsvarande AEM, enligt definitionen i pathRewriteToAEM(path, req)

2. CORS-huvuden läggs till i alla begäranden om att tillåta åtkomst till AEM innehåll, enligt definitionen av res.header("Access-Control-Allow-Origin", REACT_APP_HOST_URI);

   • Om detta inte läggs till inträffar CORS-fel vid inläsning AEM innehåll i SPA.

Öppna filen src/setupProxy.js

Granska raden som pekar på proxykonfigurationsfilen setupProxy.spa-editor.auth.basic:

...
case BASIC:
// Use user/pass for local development with Local Author Env
return require('./proxy/setupProxy.spa-editor.auth.basic');
...

Öppna SPA i din utvecklingsmiljö

Öppna SPA miljövariabelfilen src/.env.development och lägg till en variabel för SPA offentliga URI:

...
# The base URI the SPA is accessed from
REACT_APP_PUBLIC_URI=http://localhost:3000

När du distribuerar till AEM as a Cloud Service måste du göra samma sak för motsvarande .env-filer.

Öppna filen src/App.js

Importera den SPA offentliga URI:n från SPA miljövariabler

const {  REACT_APP_PUBLIC_URI } = process.env;

function App() { ... }

Använd WKND-logotypen <img src=.../> som prefix för REACT_APP_PUBLIC_URI för att tvinga fram upplösning mot SPA.

<img src={REACT_APP_PUBLIC_URI + '/' +  logo} className="logo" alt="WKND Logo"/>

Gör samma sak när du läser in bild i src/components/Loading.js

const { REACT_APP_PUBLIC_URI } = process.env;

class Loading extends Component {

    render() {
        return (<div className="loading">
            <img src={REACT_APP_PUBLIC_URI + '/' + loadingIcon} alt="Loading..." />
        </div>);
    }
}

Och för två instanser av bakåtknappen i src/components/AdventureDetails.js

const { REACT_APP_PUBLIC_URI } = process.env;

function AdventureDetail(props) {
    ...
    render() {
        <img className="Backbutton-icon" src={REACT_APP_PUBLIC_URI + '/' + backIcon} alt="Return" />
    }
}

Öppna SPA i din utvecklingsmiljö

Hämta och kopiera följande två filer till src/styles

• _grid.scss
  • AEM Responsive Grid SCSS-generator
• _grid-init.scss
  • Anropar _grid.scss med SPA specifika brytpunkter (skrivbord och mobil) och kolumner (12).

Öppna src/App.scss och importera ./styles/grid-init.scss

...
@import './styles/grid-init';
...

Navigera till roten för SPA på kommandoraden

Starta SPA med de vanliga kommandona (om du inte redan har gjort det)

$ cd ~/Code/aem-guides-wknd-graphql/remote-spa-tutorial/react-app
$ npm install
$ npm run start

Bläddra i SPA på http://localhost:3000. Allt borde se bra ut!

Logga in på AEM författare

Navigera till Sites > WKND App > us > en

Markera WKND-appens startsida och tryck på Redigera så visas SPA.

Växla till Förhandsgranska med lägesväljaren i det övre högra hörnet

Klicka runt SPA