Rename protocol.isHandledProtocol to protocol.isProtocolHandled

atom/browser/api/atom_api_protocol.cc

@@ -57,7 +57,7 @@ mate::ObjectTemplateBuilder Protocol::GetObjectTemplateBuilder(
       .SetMethod("registerHttpProtocol",
                  &Protocol::RegisterProtocol<URLRequestFetchJob>)
       .SetMethod("unregisterProtocol", &Protocol::UnregisterProtocol)
-      .SetMethod("isHandledProtocol", &Protocol::IsHandledProtocol)
+      .SetMethod("isProtocolHandled", &Protocol::IsProtocolHandled)
       .SetMethod("interceptStringProtocol",
                  &Protocol::InterceptProtocol<URLRequestStringJob>)
       .SetMethod("interceptBufferProtocol",
@@ -94,16 +94,16 @@ Protocol::ProtocolError Protocol::UnregisterProtocolInIO(
   return PROTOCOL_OK;
 }
 
-void Protocol::IsHandledProtocol(const std::string& scheme,
+void Protocol::IsProtocolHandled(const std::string& scheme,
-                                 const BooleanCallback& callback) {
+                                    const BooleanCallback& callback) {
   content::BrowserThread::PostTaskAndReplyWithResult(
       content::BrowserThread::IO, FROM_HERE,
-      base::Bind(&Protocol::IsHandledProtocolInIO,
+      base::Bind(&Protocol::IsProtocolHandledInIO,
                  base::Unretained(this), scheme),
       callback);
 }
 
-bool Protocol::IsHandledProtocolInIO(const std::string& scheme) {
+bool Protocol::IsProtocolHandledInIO(const std::string& scheme) {
   return job_factory_->IsHandledProtocol(scheme);
 }
 

atom/browser/api/atom_api_protocol.h

@@ -125,9 +125,9 @@ class Protocol : public mate::Wrappable {
   ProtocolError UnregisterProtocolInIO(const std::string& scheme);
 
   // Whether the protocol has handler registered.
-  void IsHandledProtocol(const std::string& scheme,
+  void IsProtocolHandled(const std::string& scheme,
                          const BooleanCallback& callback);
-  bool IsHandledProtocolInIO(const std::string& scheme);
+  bool IsProtocolHandledInIO(const std::string& scheme);
 
   // Replace the protocol handler with a new one.
   template<typename RequestJob>

spec/api-protocol-spec.coffee

@@ -1,278 +1,257 @@
 assert   = require 'assert'
-ipc      = require 'ipc'
 http     = require 'http'
 path     = require 'path'
 remote   = require 'remote'
 protocol = remote.require 'protocol'
 
 describe 'protocol module', ->
-  describe 'protocol.registerProtocol', ->
+  protocolName = 'sp'
-    it 'error when scheme is already registered', (done) ->
+  text = 'valar morghulis'
-      register = ->
-        protocol.registerProtocol 'test1', ((request) ->), (error, scheme) ->
-          if error?
-            protocol.unregisterProtocol 'test1', (error, scheme) ->
-              assert.equal scheme, 'test1'
-              done()
-          else
-            assert.equal scheme, 'test1'
-            register()
-      register()
 
-    it 'calls the callback when scheme is visited', (done) ->
+  afterEach (done) ->
-      protocol.registerProtocol 'test2', (request) ->
+    protocol.unregisterProtocol protocolName, -> done()
-        assert.equal request.url, 'test2://test2'
-        protocol.unregisterProtocol 'test2'
-        done()
-      $.get 'test2://test2', ->
 
   describe 'protocol.unregisterProtocol', ->
-    it 'throws error when scheme does not exist', ->
+    it 'returns error when scheme does not exist', (done) ->
-      protocol.unregisterProtocol 'test3', (->), (error, scheme) ->
+      protocol.unregisterProtocol 'not-exist', (error) ->
-        if (error)
+        assert.notEqual error, null
-          assert.equal scheme, 'test3'
+        done()
+
+  describe 'protocol.register(Any)Protocol', ->
+    emptyHandler = (request, callback) -> callback()
+    it 'throws error when scheme is already registered', (done) ->
+      protocol.registerStringProtocol protocolName, emptyHandler, (error) ->
+        assert.equal error, null
+        protocol.registerBufferProtocol protocolName, emptyHandler, (error) ->
+          assert.notEqual error, null
           done()
 
-  describe 'registered protocol callback', ->
+    it 'does not crash when handler is called twice', (done) ->
-    it 'returns string should send the string as request content', (done) ->
+      doubleHandler = (request, callback) ->
-      handler = remote.createFunctionWithReturnValue 'valar morghulis'
+        callback(text)
-      protocol.registerProtocol 'atom-string', handler
+        callback()
+      protocol.registerStringProtocol protocolName, doubleHandler, (error) ->
+        $.ajax
+          url: "#{protocolName}://fake-host"
+          success: (data) ->
+            assert.equal data, text
+            done()
+          error: (xhr, errorType, error) ->
+            done(error)
 
-      $.ajax
+    it 'sends error when callback is called with nothing', (done) ->
-        url: 'atom-string://fake-host'
+      protocol.registerBufferProtocol protocolName, emptyHandler, (error) ->
-        success: (data) ->
+        $.ajax
-          assert.equal data, handler()
+          url: "#{protocolName}://fake-host"
-          protocol.unregisterProtocol 'atom-string'
+          success: (data) ->
-          done()
+            done('request succeeded but it should not')
-        error: (xhr, errorType, error) ->
+          error: (xhr, errorType, error) ->
-          assert false, 'Got error: ' + errorType + ' ' + error
+            assert.equal errorType, 'error'
-          protocol.unregisterProtocol 'atom-string'
+            done()
 
-    it 'returns RequestStringJob should send string', (done) ->
+    it 'does not crash when callback is called in next tick', (done) ->
-      data = 'valar morghulis'
+      handler = (request, callback) ->
-      job = new protocol.RequestStringJob(mimeType: 'text/html', data: data)
+        setImmediate -> callback(text)
-      handler = remote.createFunctionWithReturnValue job
+      protocol.registerStringProtocol protocolName, handler, (error) ->
-      protocol.registerProtocol 'atom-string-job', handler
+        $.ajax
+          url: "#{protocolName}://fake-host"
+          success: (data) ->
+            assert.equal data, text
+            done()
+          error: (xhr, errorType, error) ->
+            done(error)
 
-      $.ajax
+  describe 'protocol.registerStringProtocol', ->
-        url: 'atom-string-job://fake-host'
+    it 'sends string as response', (done) ->
-        success: (response) ->
+      handler = (request, callback) -> callback(text)
-          assert.equal response, data
+      protocol.registerStringProtocol protocolName, handler, (error) ->
-          protocol.unregisterProtocol 'atom-string-job'
+        $.ajax
-          done()
+          url: "#{protocolName}://fake-host"
-        error: (xhr, errorType, error) ->
+          success: (data) ->
-          assert false, 'Got error: ' + errorType + ' ' + error
+            assert.equal data, text
-          protocol.unregisterProtocol 'atom-string-job'
+            done()
+          error: (xhr, errorType, error) ->
+            done(error)
 
-    it 'returns RequestErrorJob should send error', (done) ->
+    it 'sends object as response', (done) ->
-      data = 'valar morghulis'
+      handler = (request, callback) -> callback(data: text, mimeType: 'text/html')
-      job = new protocol.RequestErrorJob(-6)
+      protocol.registerStringProtocol protocolName, handler, (error) ->
-      handler = remote.createFunctionWithReturnValue job
+        $.ajax
-      protocol.registerProtocol 'atom-error-job', handler
+          url: "#{protocolName}://fake-host"
+          success: (data, statux, request) ->
+            assert.equal data, text
+            done()
+          error: (xhr, errorType, error) ->
+            done(error)
 
-      $.ajax
+    it 'fails when sending object other than string', (done) ->
-        url: 'atom-error-job://fake-host'
+      handler = (request, callback) -> callback(new Date)
-        success: (response) ->
+      protocol.registerBufferProtocol protocolName, handler, (error) ->
-          assert false, 'should not reach here'
+        $.ajax
-        error: (xhr, errorType, error) ->
+          url: "#{protocolName}://fake-host"
-          assert errorType, 'error'
+          success: (data) ->
-          protocol.unregisterProtocol 'atom-error-job'
+            done('request succeeded but it should not')
-          done()
+          error: (xhr, errorType, error) ->
+            assert.equal errorType, 'error'
+            done()
 
-    it 'returns RequestHttpJob should send respone', (done) ->
+  describe 'protocol.registerBufferProtocol', ->
+    buffer = new Buffer(text)
+
+    it 'sends Buffer as response', (done) ->
+      handler = (request, callback) -> callback(buffer)
+      protocol.registerBufferProtocol protocolName, handler, (error) ->
+        $.ajax
+          url: "#{protocolName}://fake-host"
+          success: (data) ->
+            assert.equal data, text
+            done()
+          error: (xhr, errorType, error) ->
+            done(error)
+
+    it 'sends object as response', (done) ->
+      handler = (request, callback) -> callback(data: buffer, mimeType: 'text/html')
+      protocol.registerBufferProtocol protocolName, handler, (error) ->
+        $.ajax
+          url: "#{protocolName}://fake-host"
+          success: (data, statux, request) ->
+            assert.equal data, text
+            done()
+          error: (xhr, errorType, error) ->
+            done(error)
+
+    it 'fails when sending string', (done) ->
+      handler = (request, callback) -> callback(text)
+      protocol.registerBufferProtocol protocolName, handler, (error) ->
+        $.ajax
+          url: "#{protocolName}://fake-host"
+          success: (data) ->
+            done('request succeeded but it should not')
+          error: (xhr, errorType, error) ->
+            assert.equal errorType, 'error'
+            done()
+
+  describe 'protocol.registerFileProtocol', ->
+    filePath = path.join __dirname, 'fixtures', 'asar', 'a.asar', 'file1'
+    fileContent = require('fs').readFileSync(filePath)
+
+    normalPath = path.join __dirname, 'fixtures', 'pages', 'a.html'
+    normalContent = require('fs').readFileSync(normalPath)
+
+    it 'sends file path as response', (done) ->
+      handler = (request, callback) -> callback(filePath)
+      protocol.registerFileProtocol protocolName, handler, (error) ->
+        $.ajax
+          url: "#{protocolName}://fake-host"
+          success: (data) ->
+            assert.equal data, String(fileContent)
+            done()
+          error: (xhr, errorType, error) ->
+            done(error)
+
+    it 'sends object as response', (done) ->
+      handler = (request, callback) -> callback(path: filePath)
+      protocol.registerFileProtocol protocolName, handler, (error) ->
+        $.ajax
+          url: "#{protocolName}://fake-host"
+          success: (data, statux, request) ->
+            assert.equal data, String(fileContent)
+            done()
+          error: (xhr, errorType, error) ->
+            done(error)
+
+    it 'can send normal file', (done) ->
+      handler = (request, callback) -> callback(normalPath)
+      protocol.registerFileProtocol protocolName, handler, (error) ->
+        $.ajax
+          url: "#{protocolName}://fake-host"
+          success: (data) ->
+            assert.equal data, String(normalContent)
+            done()
+          error: (xhr, errorType, error) ->
+            done(error)
+
+    it 'fails when sending unexist-file', (done) ->
+      fakeFilePath = path.join __dirname, 'fixtures', 'asar', 'a.asar', 'not-exist'
+      handler = (request, callback) -> callback(fakeFilePath)
+      protocol.registerBufferProtocol protocolName, handler, (error) ->
+        $.ajax
+          url: "#{protocolName}://fake-host"
+          success: (data) ->
+            done('request succeeded but it should not')
+          error: (xhr, errorType, error) ->
+            assert.equal errorType, 'error'
+            done()
+
+    it 'fails when sending unsupported content', (done) ->
+      handler = (request, callback) -> callback(new Date)
+      protocol.registerBufferProtocol protocolName, handler, (error) ->
+        $.ajax
+          url: "#{protocolName}://fake-host"
+          success: (data) ->
+            done('request succeeded but it should not')
+          error: (xhr, errorType, error) ->
+            assert.equal errorType, 'error'
+            done()
+
+  describe 'protocol.registerHttpProtocol', ->
+    it 'sends url as response', (done) ->
       server = http.createServer (req, res) ->
         assert.notEqual req.headers.accept, ''
-        res.writeHead(200, {'Content-Type': 'text/plain'})
+        res.end(text)
-        res.end('hello')
         server.close()
       server.listen 0, '127.0.0.1', ->
         {port} = server.address()
         url = "http://127.0.0.1:#{port}"
-        job = new protocol.RequestHttpJob({url})
+        handler = (request, callback) -> callback({url})
-        handler = remote.createFunctionWithReturnValue job
+        protocol.registerHttpProtocol protocolName, handler, (error) ->
-        protocol.registerProtocol 'atom-http-job', handler
+          $.ajax
+            url: "#{protocolName}://fake-host"
+            success: (data) ->
+              assert.equal data, text
+              done()
+            error: (xhr, errorType, error) ->
+              done(error)
 
+    it 'fails when sending invalid url', (done) ->
+      handler = (request, callback) -> callback({url: 'url'})
+      protocol.registerHttpProtocol protocolName, handler, (error) ->
         $.ajax
-          url: 'atom-http-job://fake-host'
+          url: "#{protocolName}://fake-host"
           success: (data) ->
-            assert.equal data, 'hello'
+            done('request succeeded but it should not')
-            protocol.unregisterProtocol 'atom-http-job'
-            done()
           error: (xhr, errorType, error) ->
-            assert false, 'Got error: ' + errorType + ' ' + error
+            assert.equal errorType, 'error'
-            protocol.unregisterProtocol 'atom-http-job'
+            done()
 
-    it 'returns RequestBufferJob should send buffer', (done) ->
+    it 'fails when sending unsupported content', (done) ->
-      data = new Buffer("hello")
+      handler = (request, callback) -> callback(new Date)
-      job = new protocol.RequestBufferJob(data: data)
+      protocol.registerHttpProtocol protocolName, handler, (error) ->
-      handler = remote.createFunctionWithReturnValue job
+        $.ajax
-      protocol.registerProtocol 'atom-buffer-job', handler
+          url: "#{protocolName}://fake-host"
-
+          success: (data) ->
-      $.ajax
+            done('request succeeded but it should not')
-        url: 'atom-buffer-job://fake-host'
+          error: (xhr, errorType, error) ->
-        success: (response) ->
+            assert.equal errorType, 'error'
-          assert.equal response.length, data.length
+            done()
-          buf = new Buffer(response.length)
-          buf.write(response)
-          assert buf.equals(data)
-          protocol.unregisterProtocol 'atom-buffer-job'
-          done()
-        error: (xhr, errorType, error) ->
-          assert false, 'Got error: ' + errorType + ' ' + error
-          protocol.unregisterProtocol 'atom-buffer-job'
-
-    it 'returns RequestFileJob should send file', (done) ->
-      job = new protocol.RequestFileJob(__filename)
-      handler = remote.createFunctionWithReturnValue job
-      protocol.registerProtocol 'atom-file-job', handler
-
-      $.ajax
-        url: 'atom-file-job://' + __filename
-        success: (data) ->
-          content = require('fs').readFileSync __filename
-          assert.equal data, String(content)
-          protocol.unregisterProtocol 'atom-file-job'
-          done()
-        error: (xhr, errorType, error) ->
-          assert false, 'Got error: ' + errorType + ' ' + error
-          protocol.unregisterProtocol 'atom-file-job'
-
-    it 'returns RequestFileJob should send file from asar archive', (done) ->
-      p = path.join __dirname, 'fixtures', 'asar', 'a.asar', 'file1'
-      job = new protocol.RequestFileJob(p)
-      handler = remote.createFunctionWithReturnValue job
-      protocol.registerProtocol 'atom-file-job', handler
-
-      $.ajax
-        url: 'atom-file-job://' + p
-        success: (data) ->
-          content = require('fs').readFileSync(p)
-          assert.equal data, String(content)
-          protocol.unregisterProtocol 'atom-file-job'
-          done()
-        error: (xhr, errorType, error) ->
-          assert false, 'Got error: ' + errorType + ' ' + error
-          protocol.unregisterProtocol 'atom-file-job'
-
-    it 'returns RequestFileJob should send file from asar archive with unpacked file', (done) ->
-      p = path.join __dirname, 'fixtures', 'asar', 'unpack.asar', 'a.txt'
-      job = new protocol.RequestFileJob(p)
-      handler = remote.createFunctionWithReturnValue job
-      protocol.registerProtocol 'atom-file-job', handler
-
-      $.ajax
-        url: 'atom-file-job://' + p
-        success: (response) ->
-          data = require('fs').readFileSync(p)
-          assert.equal response.length, data.length
-          buf = new Buffer(response.length)
-          buf.write(response)
-          assert buf.equals(data)
-          protocol.unregisterProtocol 'atom-file-job'
-          done()
-        error: (xhr, errorType, error) ->
-          assert false, 'Got error: ' + errorType + ' ' + error
-          protocol.unregisterProtocol 'atom-file-job'
 
   describe 'protocol.isHandledProtocol', ->
-    it 'returns true if the file scheme can be handled', (done) ->
+    it 'returns true for file:', (done) ->
       protocol.isHandledProtocol 'file', (result) ->
         assert.equal result, true
         done()
-    it 'returns true if the http scheme can be handled', (done) ->
+
+    it 'returns true for http:', (done) ->
       protocol.isHandledProtocol 'http', (result) ->
         assert.equal result, true
         done()
-    it 'returns true if the https scheme can be handled', (done) ->
+
+    it 'returns true for https:', (done) ->
       protocol.isHandledProtocol 'https', (result) ->
         assert.equal result, true
         done()
-    it 'returns false if the atom scheme cannot be handled', (done) ->
+
+    it 'returns false when scheme is not registred', (done) ->
       protocol.isHandledProtocol 'atom', (result) ->
         assert.equal result, false
         done()
-
-  describe 'protocol.interceptProtocol', ->
-    it 'throws error when scheme is not a registered one', (done) ->
-      protocol.interceptProtocol 'test-intercept', ( ->), (error, scheme) ->
-        if error?
-          assert.equal scheme, 'test-intercept'
-          done()
-
-    it 'throws error when scheme is a custom protocol', (done) ->
-      protocol.once 'unregistered', (scheme) ->
-        assert.equal scheme, 'atom'
-        done()
-      protocol.once 'registered', (scheme) ->
-        assert.equal scheme, 'atom'
-        protocol.interceptProtocol 'test-intercept', (->), (error, newScheme) ->
-          if error?
-            assert.equal newScheme, 'test-intercept'
-            protocol.unregisterProtocol scheme
-      protocol.registerProtocol('atom', ->)
-
-    it 'returns original job when callback returns nothing', (done) ->
-      targetScheme = 'file'
-      protocol.once 'intercepted', (scheme) ->
-        assert.equal scheme, targetScheme
-        free = -> protocol.uninterceptProtocol targetScheme
-        $.ajax
-          url: "#{targetScheme}://#{__filename}",
-          success: ->
-            protocol.once 'unintercepted', (scheme) ->
-              assert.equal scheme, targetScheme
-              done()
-            free()
-          error: (xhr, errorType, error) ->
-            free()
-            assert false, 'Got error: ' + errorType + ' ' + error
-      protocol.interceptProtocol targetScheme, (request) ->
-        if process.platform is 'win32'
-          pathInUrl = path.normalize request.url.substr(8)
-          assert.equal pathInUrl.toLowerCase(), __filename.toLowerCase()
-        else
-          assert.equal request.url, "#{targetScheme}://#{__filename}"
-
-    it 'can override original protocol handler', (done) ->
-      handler = remote.createFunctionWithReturnValue 'valar morghulis'
-      protocol.once 'intercepted', ->
-        free = -> protocol.uninterceptProtocol 'file'
-        $.ajax
-          url: 'file://fake-host'
-          success: (data) ->
-            protocol.once 'unintercepted', ->
-              assert.equal data, handler()
-              done()
-            free()
-          error: (xhr, errorType, error) ->
-            assert false, 'Got error: ' + errorType + ' ' + error
-            free()
-      protocol.interceptProtocol 'file', handler
-
-    it 'can override http protocol handler', (done) ->
-      handler = remote.createFunctionWithReturnValue 'valar morghulis'
-      protocol.once 'intercepted', ->
-        protocol.uninterceptProtocol 'http'
-        done()
-      protocol.interceptProtocol 'http', handler
-
-    it 'can override https protocol handler', (done) ->
-      handler = remote.createFunctionWithReturnValue 'valar morghulis'
-      protocol.once 'intercepted', ->
-        protocol.uninterceptProtocol 'https'
-        done()
-      protocol.interceptProtocol 'https', handler
-
-    it 'can override ws protocol handler', (done) ->
-      handler = remote.createFunctionWithReturnValue 'valar morghulis'
-      protocol.once 'intercepted', ->
-        protocol.uninterceptProtocol 'ws'
-        done()
-      protocol.interceptProtocol 'ws', handler
-
-    it 'can override wss protocol handler', (done) ->
-      handler = remote.createFunctionWithReturnValue 'valar morghulis'
-      protocol.once 'intercepted', ->
-        protocol.uninterceptProtocol 'wss'
-        done()
-      protocol.interceptProtocol 'wss', handler

spec/static/main.js

@@ -135,7 +135,7 @@ app.on('ready', function() {
   app.setApplicationMenu(menu);
 
   // Test if using protocol module would crash.
-  require('protocol').registerProtocol('test-if-crashes', function() {});
+  require('protocol').registerStringProtocol('test-if-crashes', function() {});
 
   window = new BrowserWindow({
     title: 'Electron Tests',