Merge pull request #815 from ember-learn/prember

Use prember

Author: mansona

.eslintignore

@@ -20,3 +20,6 @@
 /.node_modules.ember-try/
 /bower.json.ember-try
 /package.json.ember-try
+
+# data git checkout
+/ember-api-docs-data/

.github/workflows/ci.yml

@@ -57,6 +57,8 @@ jobs:
       - name: Install dependencies
         run: npm ci
 
+      - run: npm run clone
+
       - name: Test
         env:
           PERCY_PARALLEL_NONCE: ${{ env.PERCY_PARALLEL_NONCE }}

.gitignore

@@ -40,3 +40,6 @@ local.log
 /.node_modules.ember-try/
 /bower.json.ember-try
 /package.json.ember-try
+
+/ember-api-docs-data/
+/ember-api-docs-data

app/adapters/application.js

@@ -1,12 +1,10 @@
 import { inject as service } from '@ember/service';
 import JSONAPIAdapter from '@ember-data/adapter/json-api';
 import fetch from 'fetch';
-import ENV from 'ember-api-docs/config/environment';
 import { pluralize } from 'ember-inflector';
 import { isBlank } from '@ember/utils';
 
 export default class Application extends JSONAPIAdapter {
-  host = ENV.API_HOST;
   currentProject = '';
   currentProjectVersion = '';
 
@@ -47,7 +45,7 @@ export default class Application extends JSONAPIAdapter {
 
   async findRecord(store, { modelName }, id) {
     let url;
-    let host = this.host;
+    // let host = this.host;
     let projectName = this.currentProject;
 
     if (['namespace', 'class', 'module'].indexOf(modelName) > -1) {
@@ -85,7 +83,7 @@ export default class Application extends JSONAPIAdapter {
       throw new Error('Unexpected model lookup');
     }
 
-    url = `${host}/${url}.json`;
+    url = `/${url}.json`;
 
     let response = await fetch(url);
     let json = await response.json();

app/router.js

@@ -34,7 +34,6 @@ class AppRouter extends EmberRouter {
 }
 
 AppRouter.map(function () {
-  this.route('404');
   this.route('ember-cli');
   this.route('project', { path: '/:project' });
 
@@ -92,4 +91,39 @@ AppRouter.map(function () {
   this.route('data-module', { path: '/data/modules/:module' });
 });
 
+/*
+404
+ember-cli
+project
+
+/:project/:project_version
+  /classes/:class
+    /methods, /properties, /events
+  /functions/:module (no sub routes)
+  /namespaces/:namespace
+    /methods, /properties, /events
+  /modules/:module
+    /methods, /properties, /events
+
+SUB ROUTES
+
+Instead of https://api.emberjs.com/ember/4.6/classes/Engine/methods/unregister?anchor=unregister
+We can do https://api.emberjs.com/ember/4.6/classes/Engine/methods?anchor=unregister
+
+  /methods/:method
+  /properties/:property
+  /events/:event
+
+OTHER STATES
+private, deprecated, inherited, protected
+inherited is not reflected in URL state but it's checked by default
+
+MAYBE REDIRECTS
+
+/data/modules/:module
+/data/classes/:class
+/modules/:module
+/classes/:class
+*/
+
 export default AppRouter;

app/routes/project-version/classes/class.js

@@ -81,7 +81,13 @@ export default class ClassRoute extends Route.extend(ScrollTracker) {
     }
 
     if (model.isError) {
-      this.router.transitionTo('404');
+      let error = new Error(
+        'Error retrieving model in routes/project-version/classes/class'
+      );
+
+      error.status = 404;
+
+      throw error;
     }
   }
 

app/serializers/application.js

@@ -5,6 +5,18 @@ export default class Application extends JSONAPISerializer {
   @service
   metaStore;
 
+  extractId(_, hash) {
+    return hash.id.toLowerCase();
+  }
+
+  extractRelationship(relationship) {
+    // for some reason we only need to update the id to lowercase when it's an object relationship and not an array 🤷
+    if (relationship?.data?.id) {
+      relationship.data.id = relationship.data.id.toLowerCase();
+    }
+    return super.extractRelationship(relationship);
+  }
+
   normalizeFindRecordResponse(store, primaryModelClass, payload, id) {
     let normalizedDocument = super.normalizeFindRecordResponse(...arguments);
 

app/services/meta-store.js

@@ -22,8 +22,14 @@ export default class MetaStoreService extends Service {
   }
 
   getRevId(project, version, type, id) {
-    let encodedId = encodeURIComponent(id);
-    return this.projectRevMap[`${project}-${version}`][type][encodedId];
+    let encodedId = id;
+    let revType = this.projectRevMap[`${project}-${version}`][type];
+
+    let matchingKey = Object.keys(revType).find(
+      (key) => key.toLowerCase() === encodedId.toLowerCase()
+    );
+
+    return this.projectRevMap[`${project}-${version}`][type][matchingKey];
   }
 
   getEncodedModulesFromProjectRev(id) {

app/templates/404.hbs

@@ -4,9 +4,13 @@ const EmberApp = require('ember-cli/lib/broccoli/ember-app');
 const Funnel = require('broccoli-funnel');
 const mergeTrees = require('broccoli-merge-trees');
 const envIsProduction = process.env.EMBER_ENV === 'production';
+const premberUrls = require('./prember-urls');
 
 module.exports = function (defaults) {
   let app = new EmberApp(defaults, {
+    prember: {
+      urls: premberUrls(),
+    },
     fingerprint: {
       extensions: [
         'js',
@@ -63,5 +67,6 @@ module.exports = function (defaults) {
     include: ['mappings.json'],
     destDir: '/assets/',
   });
+
   return mergeTrees([app.toTree(), mappingsTree]);
 };

ember-cli-build.js

@@ -0,0 +1,17 @@
+'use strict';
+
+const Funnel = require('broccoli-funnel');
+
+module.exports = {
+  name: require('./package').name,
+
+  isDevelopingAddon() {
+    return true;
+  },
+
+  treeForPublic() {
+    return new Funnel('ember-api-docs-data', {
+      include: ['**/json-docs/**', '**/rev-index/**'],
+    });
+  },
+};

lib/api-docs-data/index.js

@@ -0,0 +1,9 @@
+{
+  "name": "api-docs-data",
+  "keywords": [
+    "ember-addon"
+  ],
+  "peerDependencies": {
+    "broccoli-funnel": "*"
+  }
+}