Merge pull request #794 from atom-minimap/type-safe-decorations-api

Author: aminya

babel.config.json

@@ -0,0 +1,6 @@
+{
+  "presets": ["babel-preset-atomic"],
+  "plugins": [],
+  "exclude": "node_modules/**",
+  "sourceMap": "inline"
+}

lib/decoration.js

@@ -88,8 +88,7 @@ export default class Decoration {
       return
     }
 
-    this.markerDestroyDisposable.dispose()
-    this.markerDestroyDisposable = null
+    this.markerDestroyDisposable?.dispose?.()
     this.destroyed = true
     this.emitter.emit("did-destroy")
     this.emitter.dispose()
@@ -114,6 +113,9 @@ export default class Decoration {
    * @return {Disposable} a disposable to stop listening to the event
    */
   onDidChangeProperties(callback) {
+    if (this.destroyed) {
+      return
+    }
     return this.emitter.on("did-change-properties", callback)
   }
 
@@ -125,6 +127,9 @@ export default class Decoration {
    * @return {Disposable} a disposable to stop listening to the event
    */
   onDidDestroy(callback) {
+    if (this.destroyed) {
+      return
+    }
     return this.emitter.on("did-destroy", callback)
   }
 

lib/minimap.js

@@ -1,11 +1,21 @@
 "use strict"
 
-import { Emitter, CompositeDisposable } from "atom"
+import { Emitter, CompositeDisposable, Disposable } from "atom"
+import Decoration from "./decoration"
 import StableAdapter from "./adapters/stable-adapter"
 import { editorsMinimaps } from "./main"
 
 let nextModelId = 1
 
+// returned in the decorations API when minimap is destoryed
+const disposedDisposable = new Disposable()
+disposedDisposable.dispose()
+const markerMock = {
+  onDidDestroy: () => disposedDisposable,
+  getScreenRange: () => new Range(),
+}
+const dummyDecoration = new Decoration(markerMock, null, {})
+
 /**
  * The Minimap class is the underlying model of a <MinimapElement>.
  * Most manipulations of the minimap is done through the model.
@@ -1108,60 +1118,52 @@ export default class Minimap {
 
   /**
    *  get the DecorationManagement API for the current minimapElement
-   * @return {DecorationManagement}
+   * @return {DecorationManagement | undefined}
    */
   getDecorationManagement() {
     if (!this.DecorationManagement) {
-      if (this.minimapElement) {
+      if (this.minimapElement?.DecorationManagement) {
         this.DecorationManagement = this.minimapElement.DecorationManagement
-      } else {
-        // TODO: find why this becomes null: https://github.com/atom-minimap/minimap/issues/766
-        throw new Error(`getDecorationManagement failed.
-       this.DecorationManagement: ${JSON.stringify(this.DecorationManagement)}
-       this.minimapElement: ${JSON.stringify(this.minimapElement)}
-       this.textEditor: ${this.getTextEditor()}
-       this: ${JSON.stringify(this)}
-     `)
       }
     }
     return this.DecorationManagement
   }
 
   // Decoration API duplicated for backward compatibility in the service
   getDecorations() {
-    return this.getDecorationManagement().getDecorations()
+    return this.getDecorationManagement()?.getDecorations() ?? []
   }
   onDidAddDecoration(...args) {
-    return this.getDecorationManagement().onDidAddDecoration(...args)
+    return this.getDecorationManagement()?.onDidAddDecoration(...args) ?? disposedDisposable
   }
   onDidRemoveDecoration(...args) {
-    return this.getDecorationManagement().onDidRemoveDecoration(...args)
+    return this.getDecorationManagement()?.onDidRemoveDecoration(...args) ?? disposedDisposable
   }
   onDidChangeDecorationRange(...args) {
-    return this.getDecorationManagement().onDidChangeDecorationRange(...args)
+    return this.getDecorationManagement()?.onDidChangeDecorationRange(...args) ?? disposedDisposable
   }
   onDidUpdateDecoration(...args) {
-    return this.getDecorationManagement().onDidUpdateDecoration(...args)
+    return this.getDecorationManagement()?.onDidUpdateDecoration(...args) ?? disposedDisposable
   }
   decorationForId(...args) {
-    return this.getDecorationManagement().decorationForId(...args)
+    return this.getDecorationManagement()?.decorationForId(...args) ?? dummyDecoration
   }
   decorationsForScreenRowRange(...args) {
-    return this.getDecorationManagement().decorationsForScreenRowRange(...args)
+    return this.getDecorationManagement()?.decorationsForScreenRowRange(...args) ?? dummyDecoration
   }
   decorationsByTypeThenRows() {
-    return this.getDecorationManagement().decorationsByTypeThenRows()
+    return this.getDecorationManagement()?.decorationsByTypeThenRows() ?? dummyDecoration
   }
   decorateMarker(...args) {
-    return this.getDecorationManagement().decorateMarker(...args)
+    return this.getDecorationManagement()?.decorateMarker(...args) ?? dummyDecoration
   }
   removeDecoration(...args) {
-    return this.getDecorationManagement().removeDecoration(...args)
+    return this.getDecorationManagement()?.removeDecoration(...args)
   }
   removeAllDecorationsForMarker(...args) {
-    return this.getDecorationManagement().removeAllDecorationsForMarker(...args)
+    return this.getDecorationManagement()?.removeAllDecorationsForMarker(...args)
   }
   removeAllDecorations() {
-    return this.getDecorationManagement().removeAllDecorations()
+    return this.getDecorationManagement()?.removeAllDecorations()
   }
 }

package.json

@@ -68,6 +68,7 @@
   "devDependencies": {
     "@types/atom": "^1.40.10",
     "@types/jasmine": "3.6.9",
+    "babel-preset-atomic": "^4.1.0",
     "build-commit": "^0.1.4",
     "cross-env": "^7.0.3",
     "esdoc": "^1.1.0",
@@ -77,8 +78,7 @@
     "jasmine-expect": "^5.0.0",
     "npm-check-updates": "latest",
     "prettier-config-atomic": "^1.0.1",
-    "rollup": "2.44.0",
-    "rollup-plugin-atomic": "^2.1.2",
+    "rollup-plugin-atomic": "^2.3.1",
     "shx": "^0.3.3",
     "underscore-plus": "^1.7.0"
   },