Feat: class based addon api (ember-tooling#131)

* feat: class-based addon api * remove some any
saravanak · May 30, 2020 · e74f11f · e74f11f
1 parent 8fcac46
commit e74f11f
Show file tree

Hide file tree

Showing 3 changed files with 125 additions and 2 deletions.
diff --git a/src/utils/addon-api.ts b/src/utils/addon-api.ts
@@ -63,6 +63,7 @@ interface PublicAddonAPI {
   onCodeAction?: CodeActionResolveFunction;
   onInit?: InitFunction;
 }
+
 interface HandlerObject {
   handler: PublicAddonAPI;
   updateHandler: () => void;
@@ -113,12 +114,47 @@ export function initBuiltinProviders(): ProjectProviders {
   };
 }
 
+export function isConstructor(obj: any) {
+  return !!obj.prototype && !!obj.prototype.constructor.name;
+}
+
+function create<T>(model: new () => T): T {
+  return new model();
+}
+
 function requireUncached(module: string) {
   delete require.cache[require.resolve(module)];
   let result = {};
 
   try {
     result = require(module);
+
+    if (isConstructor(result)) {
+      const instance: PublicAddonAPI = create(result as any);
+      const instanceResult: PublicAddonAPI = {};
+
+      if (typeof instance.onInit === 'function') {
+        instanceResult.onInit = instance.onInit.bind(instance);
+      }
+
+      if (typeof instance.onCodeAction === 'function') {
+        instanceResult.onCodeAction = instance.onCodeAction.bind(instance);
+      }
+
+      if (typeof instance.onComplete === 'function') {
+        instanceResult.onComplete = instance.onComplete.bind(instance);
+      }
+
+      if (typeof instance.onDefinition === 'function') {
+        instanceResult.onDefinition = instance.onDefinition.bind(instance);
+      }
+
+      if (typeof instance.onReference === 'function') {
+        instanceResult.onReference = instance.onReference.bind(instance);
+      }
+
+      return instance;
+    }
   } catch (e) {
     logError(e);
   }
@@ -129,8 +165,8 @@ function requireUncached(module: string) {
 export function collectProjectProviders(root: string, addons: string[]): ProjectProviders {
   const roots = addons
     .concat([root])
-    .concat(getProjectAddonsRoots(root) as any, getProjectInRepoAddonsRoots(root) as any)
-    .filter((pathItem: any) => typeof pathItem === 'string');
+    .concat(getProjectAddonsRoots(root), getProjectInRepoAddonsRoots(root))
+    .filter((pathItem) => typeof pathItem === 'string');
   const dagMap: DAGMap<HandlerObject> = new DAGMap();
 
   roots.forEach((packagePath: string) => {

diff --git a/test/__snapshots__/integration-test.ts.snap b/test/__snapshots__/integration-test.ts.snap
@@ -632,6 +632,33 @@ Object {
 }
 `;
 
+exports[`integration Able to use classes for API support dummy class-based addon definition:template 1`] = `
+Object {
+  "registry": Object {
+    "component": Object {
+      "hello": Array [
+        "app/components/hello/index.hbs",
+      ],
+    },
+  },
+  "response": Array [
+    Object {
+      "range": Object {
+        "end": Object {
+          "character": 0,
+          "line": 0,
+        },
+        "start": Object {
+          "character": 0,
+          "line": 0,
+        },
+      },
+      "uri": "/app/components/hello/index.hbs",
+    },
+  ],
+}
+`;
+
 exports[`integration Autocomplete works for broken templates autocomplete information for component #1 {{ 1`] = `
 Array [
   Object {

diff --git a/test/integration-test.ts b/test/integration-test.ts
@@ -1165,6 +1165,66 @@ describe('integration', function () {
     });
   });
 
+  describe('Able to use classes for API', () => {
+    it('support dummy class-based addon definition:template', async () => {
+      const result = await getResult(
+        DefinitionRequest.type,
+        connection,
+        {
+          node_modules: {
+            provider: {
+              lib: {
+                'langserver.js': `
+                  module.exports = class Boo { onDefinition(root) {
+                    let path = require("path");
+                    let filePath = path.resolve(path.normalize(path.join(__dirname, "./../../../app/components/hello/index.hbs")));
+                    return [ {
+                      "range": {
+                        "end": {
+                          "character": 0,
+                          "line": 0,
+                        },
+                        "start": {
+                          "character": 0,
+                          "line": 0,
+                        }
+                      },
+                      "uri": filePath
+                    } ];
+                  }}
+                `,
+              },
+              'package.json': JSON.stringify({
+                name: 'provider',
+                'ember-language-server': {
+                  entry: './lib/langserver',
+                  capabilities: {
+                    definitionProvider: true,
+                  },
+                },
+              }),
+            },
+          },
+          'package.json': JSON.stringify({
+            dependencies: {
+              provider: '*',
+            },
+          }),
+          app: {
+            components: {
+              hello: {
+                'index.hbs': '{{this}}',
+              },
+            },
+          },
+        },
+        'app/components/hello/index.hbs',
+        { line: 0, character: 3 }
+      );
+
+      expect(result).toMatchSnapshot();
+    });
+  });
   describe('Able to provide API:Definition', () => {
     it('support dummy addon definition:template', async () => {
       const result = await getResult(