Cannot set property 'doc' of undefined #3

rashidshkh · 2015-09-04T05:13:22Z

When i use sails-swagger it says :- error: The bootstrap function threw an error after its callback was called :: Ty peError: Cannot set property 'doc' of undefined. Do you have any documentation about how to implement.

I dig more into code and found
this.sails.hooks.swagger get undefined
in node_modules\sails-swagger\dist\api\hooks\swagger\index.js

jekiii · 2015-09-06T01:51:01Z

I experienced the same issue. The hook was loaded successfully but was not added to sails.hooks.

tjwebb · 2015-09-12T08:42:26Z

Sorry, updating documentation. This hooks currently works only with sails master

yankeeinlondon · 2015-09-13T21:40:15Z

Will this make its way into v0.11? I'm not really sure on the timetable for v0.12 and happy to start on 0.12 if it's a relatively mature beta.

tjwebb · 2015-09-13T22:32:08Z

0.12 is in "release candidate" stage at the moment. I'm running it in production in a couple of places.

yankeeinlondon · 2015-09-13T22:46:00Z

I'm running into problems getting it running with handlebars templates so for now I've reverted to 0.11.1; how painful is the migration to 0.12.x?

tjwebb · 2015-09-14T01:04:11Z

The upgrade path to 0.12 should be pretty painless. Can you file a more specific issue in the Sails repo?

yankeeinlondon · 2015-09-14T07:31:01Z

@tjwebb, sure will do. thanks for your feedback here.

Glavin001 · 2015-09-30T15:40:34Z

Is there migration from v0.11.x to v0.12.x instructions?

I am really excited to use sails-swagger however it is erroring with this issue.

drewlio · 2015-10-08T09:16:57Z

Following. Just got the same thing on 0.11.2 and 0.12.0-rc3.

AlexisNo · 2015-10-09T20:12:53Z

Works on master for me, but not 0.12.0-rc3

devildeveloper · 2015-10-11T07:50:44Z

sails is now on 0.11.2 as master, and i have te same error

muhammadghazali · 2015-10-11T15:41:16Z

Got the same error here:

sails lift

info: Starting app...

debug: hookPath: /home/ghazali/node-app/node_modules/sails-swagger/dist/api/hooks/swagger
debug: marlinspike (swagger): loading config from /home/ghazali/node-app/node_modules/sails-swagger/dist/config
debug: marlinspike (swagger): loading Services from /home/ghazali/node-app/node_modules/sails-swagger/dist/api/services...
warn: marlinspike (swagger): no Services found. skipping
debug: marlinspike (swagger): loading Controllers...
debug: marlinspike (swagger): loading Policies...
warn: marlinspike (swagger): no Policies found. skipping
info: 
info:                .-..-.
info: 
info:    Sails              <|    .-..-.
info:    v0.11.2             |\
info:                       /|.\
info:                      / || \
info:                    ,'  |'  \
info:                 .-'.-==|/_--'
info:                 `--'-------' 
info:    __---___--___---___--___---___--___
info:  ____---___--___---___--___---___--___-__
info: 
info: Server lifted in `/home/ghazali/version-control/actigage/actigage-api`
info: To see your app, visit http://localhost:1337
info: To shut down Sails, press <CTRL> + C at any time.

debug: --------------------------------------------------------
debug: :: Sun Oct 11 2015 22:39:55 GMT+0700 (WIB)

debug: Environment : development
debug: Port        : 1337
debug: --------------------------------------------------------
error: The bootstrap function threw an error after its callback was called :: TypeError: Cannot set property 'doc' of undefined
 at /home/ghazali/node-app/node_modules/sails-swagger/dist/api/hooks/swagger/index.js:49:18
 at /home/ghazali/node-app/node_modules/sails/lib/app/private/after.js:91:14
 at /home/ghazali/node-app/node_modules/sails/node_modules/async/lib/async.js:251:17
 at done (/home/ghazali/node-app/node_modules/sails/node_modules/async/lib/async.js:132:19)
 at /home/ghazali/node-app/node_modules/sails/node_modules/async/lib/async.js:32:16
 at /home/ghazali/node-app/node_modules/sails/node_modules/async/lib/async.js:248:21
 at Sails.<anonymous> (/home/ghazali/node-app/node_modules/sails/node_modules/async/lib/async.js:572:34)
 at Sails.g (events.js:260:16)
 at emitNone (events.js:72:20)
 at Sails.emit (events.js:166:7)
 at Sails.emitter.emit (/home/ghazali/node-app/node_modules/sails/lib/app/private/after.js:50:11)
 at sailsReady (/home/ghazali/node-app/node_modules/sails/lib/app/lift.js:47:11)
 at /home/ghazali/node-app/node_modules/sails/node_modules/async/lib/async.js:251:17
 at /home/ghazali/node-app/node_modules/sails/node_modules/async/lib/async.js:154:25
 at /home/ghazali/node-app/node_modules/sails/node_modules/async/lib/async.js:248:21
 at /home/ghazali/node-app/node_modules/sails/node_modules/async/lib/async.js:612:34 [TypeError: Cannot set property 'doc' of undefined]

Masquer · 2015-10-11T16:02:12Z

This hook currently works only with sails 0.12

kevinblanco · 2015-10-13T02:05:01Z

Any update on this ? I get the same error using 0.11.2 and 0.12.

AlexisNo · 2015-10-20T18:47:03Z

The problem seems to be about the name of the hook. The hook itself assume it is sails.hooks.swagger, but with 0.12.0-rc3, it seems that the name is not cleaned and the hook is available as sails.hooks['sails-swagger']. Using the master branch of Sails, the hook is correctly loaded.

You can change the way sails loads an installable hook to load the hook correctly with 0.12.0-rc3. I didn't test it with 0.11.x.

// config/installedHooks.js
module.exports.installedHooks = {
   "sails-swagger": {
      // load the hook into sails.hooks.swagger instead of sails.hooks['sails-swagger']
      "name": "swagger"
   }
};

Then you can load the swagger document at http://127.0.0.1:1337/swagger/doc/

Edit
You may have to create this file too (Inspired by the permissions-api generator) to access to the hook's actions

// api/controllers/SwaggerController.js

var _ = require('lodash');
var _super = require('sails-swagger/dist/api/controllers/SwaggerController');

_.merge(exports, _super);
_.merge(exports, {

    // Extend with custom logic here by adding additional fields, methods, etc.

});

svenarndt · 2015-11-04T12:45:04Z

I had to create both files in my project directory.
In order to get it to run, I had to install lodash (npm install lodash --save)

lucj · 2015-11-24T22:06:46Z

@AlexisNo I have added both files you described (and also installed lodash). Swagger spec is available form http://localhost:1337/swagger/doc but how do you use swagger-ui then ?

AlexisNo · 2015-11-25T14:46:34Z

Swagger UI is not part of sails-swagger.

From the Swagger UI README file:

Swagger UI is a dependency-free collection of HTML, Javascript, and CSS assets that dynamically generate beautiful documentation and sandbox from a Swagger-compliant API. Because Swagger UI has no dependencies, you can host it in any server environment, or on your local machine.
swagger-ui is independent.

You can quickly have a Swagger UI app running on your local environment using docker

docker build -t swagger-ui-builder .
docker run -p 127.0.0.1:8080:8080 swagger-ui-builder

This will start Swagger UI at http://localhost:8080. By default, CORS should be correctly configured for this address. But I think the current NPM version does not include it. You'll have to configure it yourself in your project.

// config/routes.js
module.exports.routes = {
  '/swagger/doc': {
    cors: {
      origin: 'http://localhost:8080',
      methods: 'GET,OPTIONS,HEAD'
    },
    controller: 'SwaggerController',
    action: 'doc'
  }
}

Also, use config/swagger.js to configure the address where http://localhost:1337/swagger/ui will redirect.

// config/swagger.js
module.exports.swagger = {
  /**
   * require() the package.json file for your Sails app.
   */
  pkg: require('../package'),
  ui: {
    url: 'http://localhost:8080'
  }
};

lucj · 2015-11-25T20:33:39Z

Thanks a lot for the details answer ! Got it working :)

adrien-candiotti · 2015-12-04T10:27:09Z

I got a problem with the CORS, even after doing what you said : the Access-Control-Allow-Origin header coming from my sailsjs app is empty, i can't find anything online.

lucj · 2015-12-04T10:28:51Z

@adrien-candiotti I also have this problem so I copied the swagger-ui elements in an assets/docs folder instead, so ui is on the same machine/port. It seems I did not manage to setup the CORS correctly.

moisesrodriguez · 2015-12-11T17:43:36Z

@adrien-candiotti @lucj the problem with CORS is the config is hard coded #13. I believe the issue has been fixed in further commits in master, but a new released version has not been added to npm to publish the fix

lucj · 2015-12-11T22:50:31Z

@moisesrodriguez Hi, thanks a lot for the update.

manodupont · 2015-12-21T21:33:15Z

So i read all the thread and was wondering if there was a fix for Sails v0.11.3. ?

Thanks.

tjwebb · 2015-12-21T22:40:55Z

I merged #18, I just need to publish to npm. You can use master for now

lucj · 2015-12-22T08:12:41Z

Thanks a lot Travis !

On Mon, Dec 21, 2015 at 11:40 PM, Travis Webb [email protected]
wrote:

I merged #18 #18, I just
need to publish to npm. You can use master for now

—
Reply to this email directly or view it on GitHub
#3 (comment).

Luc Juggery - https://about.me/lucjuggery

ghost · 2015-12-30T11:41:19Z

@AlexisNo I did the steps as you have said but I am not getting the swagger Ui but only the json format document .
I didn't understand the docker part please help me @lucj

moisesrodriguez · 2016-01-13T16:58:25Z

@tjwebb would you mind publishing to npm. I'm getting this error on sails 0.12.0-rc4 and when I try to use master by doing this on my package.json "sails-swagger": "git://github.com/tjwebb/sails-swagger.git", it says it cannot find the module even thought it there.

ralberts · 2016-01-17T15:49:37Z

Thanks @AlexisNo and @lucj - I was able to get it all running with your instructions! Now I need to figure out how to have the swagger-ui allow me to edit the post/put directly in swagger-ui like the demo.

@tjwebb I look forward to the npm push as well. Let me know if I can help.

Since I am not running off master for either project. I combined comments from this thread and hope it helps others:

npm install --save lodash ( thx @svenarndt )
Created the controller

// api/controllers/SwaggerController.js

var _ = require('lodash');
var _super = require('sails-swagger/dist/api/controllers/SwaggerController');

_.merge(exports, _super);
_.merge(exports, {
  // Extend with custom logic here by adding additional fields, methods, etc.
});

Created the installHooks.js

// config/installedHooks.js
module.exports.installedHooks = {
  "sails-swagger": {
    // load the hook into sails.hooks.swagger instead of sails.hooks['sails-swagger']
    "name": "swagger"
  }
};

Create swagger.js hook:

// config/swagger.js
module.exports.swagger = {
  /**
   * require() the package.json file for your Sails app.
   */
  pkg: require('../package'),
  ui: {
      url: 'http://swagger.balderdash.io'
  }
};

Downloaded swagger-ui and copyied the dist/ contents to assets/docs under my current webapp as @lucj did. I am sure the docker way works well but I didn't try it as I wanted it all under the same app.
Done. (At least I hope I got everything).

talamaska · 2016-01-20T14:18:35Z

@ralberts thanks for your summary, the only thing I did not get is how to navigate to /assets/docs to actually open the swagger.io on local server.

blanco217 · 2016-01-28T18:29:14Z

@ralberts Thanks for your explination it helped me get the ui up and running.

@talamaska you will go to http://localhost:1337/docs

ronsuez · 2016-02-01T07:15:36Z

does anyone knows how to enable POST/PUT requests from the local swaggerUI?

pankajdaffodil · 2016-02-04T11:30:09Z

Please let me know how can I send data in query string?

svenarndt mentioned this issue Nov 4, 2015

Error on Server startup #10

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Cannot set property 'doc' of undefined #3

Cannot set property 'doc' of undefined #3

rashidshkh commented Sep 4, 2015

jekiii commented Sep 6, 2015

tjwebb commented Sep 12, 2015

yankeeinlondon commented Sep 13, 2015

tjwebb commented Sep 13, 2015

yankeeinlondon commented Sep 13, 2015

tjwebb commented Sep 14, 2015

yankeeinlondon commented Sep 14, 2015

Glavin001 commented Sep 30, 2015

drewlio commented Oct 8, 2015

AlexisNo commented Oct 9, 2015

devildeveloper commented Oct 11, 2015

muhammadghazali commented Oct 11, 2015

Masquer commented Oct 11, 2015

kevinblanco commented Oct 13, 2015

AlexisNo commented Oct 20, 2015

svenarndt commented Nov 4, 2015

lucj commented Nov 24, 2015

AlexisNo commented Nov 25, 2015

lucj commented Nov 25, 2015

adrien-candiotti commented Dec 4, 2015

lucj commented Dec 4, 2015

moisesrodriguez commented Dec 11, 2015

lucj commented Dec 11, 2015

manodupont commented Dec 21, 2015

tjwebb commented Dec 21, 2015

lucj commented Dec 22, 2015

ghost commented Dec 30, 2015

moisesrodriguez commented Jan 13, 2016

ralberts commented Jan 17, 2016

talamaska commented Jan 20, 2016

blanco217 commented Jan 28, 2016

ronsuez commented Feb 1, 2016

pankajdaffodil commented Feb 4, 2016

Cannot set property 'doc' of undefined #3

Cannot set property 'doc' of undefined #3

Comments

rashidshkh commented Sep 4, 2015

jekiii commented Sep 6, 2015

tjwebb commented Sep 12, 2015

yankeeinlondon commented Sep 13, 2015

tjwebb commented Sep 13, 2015

yankeeinlondon commented Sep 13, 2015

tjwebb commented Sep 14, 2015

yankeeinlondon commented Sep 14, 2015

Glavin001 commented Sep 30, 2015

drewlio commented Oct 8, 2015

AlexisNo commented Oct 9, 2015

devildeveloper commented Oct 11, 2015

muhammadghazali commented Oct 11, 2015

Masquer commented Oct 11, 2015

kevinblanco commented Oct 13, 2015

AlexisNo commented Oct 20, 2015

svenarndt commented Nov 4, 2015

lucj commented Nov 24, 2015

AlexisNo commented Nov 25, 2015

lucj commented Nov 25, 2015

adrien-candiotti commented Dec 4, 2015

lucj commented Dec 4, 2015

moisesrodriguez commented Dec 11, 2015

lucj commented Dec 11, 2015

manodupont commented Dec 21, 2015

tjwebb commented Dec 21, 2015

lucj commented Dec 22, 2015

ghost commented Dec 30, 2015

moisesrodriguez commented Jan 13, 2016

ralberts commented Jan 17, 2016

talamaska commented Jan 20, 2016

blanco217 commented Jan 28, 2016

ronsuez commented Feb 1, 2016

pankajdaffodil commented Feb 4, 2016