You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@druid.apache.org by GitBox <gi...@apache.org> on 2020/09/04 17:11:31 UTC

[GitHub] [druid] AshishKapoor opened a new pull request #10357: [web-console] Update README.md

AshishKapoor opened a new pull request #10357:
URL: https://github.com/apache/druid/pull/10357


   <!-- Thanks for trying to help us make Apache Druid be the best it can be! Please fill out as much of the following information as is possible (where relevant, and remove it when irrelevant) to help make the intention and scope of this PR clear in order to ease review. -->
   Added a step to compile scss files before npm start step.
   
   <!-- If you are a committer, follow the PR action item checklist for committers:
   https://github.com/apache/druid/blob/master/dev/committer-instructions.md#pr-and-issue-action-item-checklist-for-committers. -->
   
   ### Description
   
   <!-- Describe the goal of this PR, what problem are you fixing. If there is a corresponding issue (referenced above), it's not necessary to repeat the description here, however, you may choose to keep one summary sentence. -->
   
   <!-- Describe your patch: what did you change in code? How did you fix the problem? -->
   
   <!-- If there are several relatively logically separate changes in this PR, create a mini-section for each of them. For example: -->
   
   #### Compile the scss files before npm start step.
   
   <hr>
   
   This PR has:
   - [x] been self-reviewed.
   - [x] added documentation for new or modified features or behaviors.
   - [ ] added Javadocs for most classes and all non-trivial methods. Linked related entities via Javadoc links.
   - [ ] added or updated version, license, or notice information in [licenses.yaml](https://github.com/apache/druid/blob/master/licenses.yaml)
   - [ ] added comments explaining the "why" and the intent of the code wherever would not be obvious for an unfamiliar reader.
   - [ ] added unit tests or modified existing tests to cover new code paths, ensuring the threshold for [code coverage](https://github.com/apache/druid/blob/master/dev/code-review/code-coverage.md) is met.
   - [ ] added integration tests.
   - [ ] been tested in a test Druid cluster.
   
   <!-- Check the items by putting "x" in the brackets for the done things. Not all of these items apply to every PR. Remove the items which are not done or not relevant to the PR. None of the items from the checklist above are strictly necessary, but it would be very helpful if you at least self-review the PR. -->
   
   <hr>
   
   ##### Key changed/added classes in this PR
    * Updated web-console readme file.
   


----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@druid.apache.org
For additional commands, e-mail: commits-help@druid.apache.org


[GitHub] [druid] AshishKapoor commented on a change in pull request #10357: [web-console] Update README.md

Posted by GitBox <gi...@apache.org>.
AshishKapoor commented on a change in pull request #10357:
URL: https://github.com/apache/druid/pull/10357#discussion_r489570036



##########
File path: web-console/README.md
##########
@@ -25,7 +25,9 @@ This is the unified Druid web console that servers as a data management layer fo
 
 1. You need to be withing the `web-console` directory
 2. Install the modules with `npm install`
-3. Run `npm start` will start in development mode and will proxy druid requests to `localhost:8888`
+3. Run `npm run compile` to compile the scss files

Review comment:
       There you go!
   
   ```
   WARNING in ./src/views/home-view/home-view.scss (./node_modules/css-loader/dist/cjs.js!./node_modules/postcss-loader/src??postcss!./node_modules/sass-loader/dist/cjs.js!./src/views/home-view/home-view.scss)
   Module Warning (from ./node_modules/postcss-loader/src/index.js):
   Warning
   
   (37:3) grid-gap only works if grid-template(-areas) is being used
    @ ./src/views/home-view/home-view.scss 1:14-193 20:4-31:5 23:25-204
    @ ./src/views/home-view/home-view.tsx
    @ ./src/views/index.ts
    @ ./src/console-application.tsx
    @ ./src/entry.ts
   
   ERROR in ./src/entry.scss (./node_modules/css-loader/dist/cjs.js!./node_modules/postcss-loader/src??postcss!./node_modules/sass-loader/dist/cjs.js!./src/entry.scss)
   Module build failed (from ./node_modules/sass-loader/dist/cjs.js):
   SassError: File to import not found or unreadable: ../lib/react-table.
           on line 22 of /Users/ashishkapoor/Downloads/druid-master/web-console/src/entry.scss
   >> @import '../lib/react-table';
   
      ^
   
    @ ./src/entry.scss 1:14-171 20:4-31:5 23:25-182
    @ ./src/entry.ts
   
   ERROR in ./src/views/query-view/query-input/query-input.tsx
   Module not found: Error: Can't resolve '../../../../lib/sql-docs' in '/Users/ashishkapoor/Downloads/druid-master/web-console/src/views/query-view/query-input'
    @ ./src/views/query-view/query-input/query-input.tsx 10:17-52
    @ ./src/views/query-view/query-view.tsx
    @ ./src/views/index.ts
    @ ./src/console-application.tsx
    @ ./src/entry.ts
   
   ERROR in ./src/ace-modes/dsql.js
   Module not found: Error: Can't resolve '../../lib/sql-docs' in '/Users/ashishkapoor/Downloads/druid-master/web-console/src/ace-modes'
    @ ./src/ace-modes/dsql.js 25:21-50
    @ ./src/entry.ts
   ```




----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@druid.apache.org
For additional commands, e-mail: commits-help@druid.apache.org


[GitHub] [druid] AshishKapoor commented on a change in pull request #10357: [web-console] Update README.md

Posted by GitBox <gi...@apache.org>.
AshishKapoor commented on a change in pull request #10357:
URL: https://github.com/apache/druid/pull/10357#discussion_r488031187



##########
File path: web-console/README.md
##########
@@ -25,7 +25,9 @@ This is the unified Druid web console that servers as a data management layer fo
 
 1. You need to be withing the `web-console` directory
 2. Install the modules with `npm install`
-3. Run `npm start` will start in development mode and will proxy druid requests to `localhost:8888`
+3. Run `npm run compile` to compile the scss files

Review comment:
       Hi, @suneet-s as requested:
   ```
   Build failed with error code: 1
   npm WARN optional SKIPPING OPTIONAL DEPENDENCY: fsevents@1.2.9 (node_modules/fsevents):
   npm WARN optional SKIPPING OPTIONAL DEPENDENCY: fsevents@1.2.9 install: `node install`
   npm WARN optional SKIPPING OPTIONAL DEPENDENCY: Exit status 1
   
   npm ERR! code ELIFECYCLE
   npm ERR! errno 1
   npm ERR! node-sass@4.13.1 postinstall: `node scripts/build.js`
   npm ERR! Exit status 1
   npm ERR! 
   npm ERR! Failed at the node-sass@4.13.1 postinstall script.
   npm ERR! This is probably not a problem with npm. There is likely additional logging output above.
   
   npm ERR! A complete log of this run can be found in:
   npm ERR!     /Users/ashishkapoor/.npm/_logs/2020-09-14T15_36_01_509Z-debug.log
   ➜  web-console 
   ```




----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@druid.apache.org
For additional commands, e-mail: commits-help@druid.apache.org


[GitHub] [druid] suneet-s commented on a change in pull request #10357: [web-console] Update README.md

Posted by GitBox <gi...@apache.org>.
suneet-s commented on a change in pull request #10357:
URL: https://github.com/apache/druid/pull/10357#discussion_r490329932



##########
File path: web-console/README.md
##########
@@ -25,7 +25,9 @@ This is the unified Druid web console that servers as a data management layer fo
 
 1. You need to be withing the `web-console` directory
 2. Install the modules with `npm install`
-3. Run `npm start` will start in development mode and will proxy druid requests to `localhost:8888`
+3. Run `npm run compile` to compile the scss files

Review comment:
       Thanks @AshishKapoor I haven't run into this issue when I ran through these instructions. The update seems reasonable to me.
   
   I'll let someone more familiar with front-end dev chime in, I've only compiled and run the web console locally, a handful of times.




----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@druid.apache.org
For additional commands, e-mail: commits-help@druid.apache.org


[GitHub] [druid] AshishKapoor commented on a change in pull request #10357: [web-console] Update README.md

Posted by GitBox <gi...@apache.org>.
AshishKapoor commented on a change in pull request #10357:
URL: https://github.com/apache/druid/pull/10357#discussion_r489570036



##########
File path: web-console/README.md
##########
@@ -25,7 +25,9 @@ This is the unified Druid web console that servers as a data management layer fo
 
 1. You need to be withing the `web-console` directory
 2. Install the modules with `npm install`
-3. Run `npm start` will start in development mode and will proxy druid requests to `localhost:8888`
+3. Run `npm run compile` to compile the scss files

Review comment:
       @suneet-s There you go! It works fine only after a compile run as mentioned in the docs for me.
   
   ```
   WARNING in ./src/views/home-view/home-view.scss (./node_modules/css-loader/dist/cjs.js!./node_modules/postcss-loader/src??postcss!./node_modules/sass-loader/dist/cjs.js!./src/views/home-view/home-view.scss)
   Module Warning (from ./node_modules/postcss-loader/src/index.js):
   Warning
   
   (37:3) grid-gap only works if grid-template(-areas) is being used
    @ ./src/views/home-view/home-view.scss 1:14-193 20:4-31:5 23:25-204
    @ ./src/views/home-view/home-view.tsx
    @ ./src/views/index.ts
    @ ./src/console-application.tsx
    @ ./src/entry.ts
   
   ERROR in ./src/entry.scss (./node_modules/css-loader/dist/cjs.js!./node_modules/postcss-loader/src??postcss!./node_modules/sass-loader/dist/cjs.js!./src/entry.scss)
   Module build failed (from ./node_modules/sass-loader/dist/cjs.js):
   SassError: File to import not found or unreadable: ../lib/react-table.
           on line 22 of /Users/ashishkapoor/Downloads/druid-master/web-console/src/entry.scss
   >> @import '../lib/react-table';
   
      ^
   
    @ ./src/entry.scss 1:14-171 20:4-31:5 23:25-182
    @ ./src/entry.ts
   
   ERROR in ./src/views/query-view/query-input/query-input.tsx
   Module not found: Error: Can't resolve '../../../../lib/sql-docs' in '/Users/ashishkapoor/Downloads/druid-master/web-console/src/views/query-view/query-input'
    @ ./src/views/query-view/query-input/query-input.tsx 10:17-52
    @ ./src/views/query-view/query-view.tsx
    @ ./src/views/index.ts
    @ ./src/console-application.tsx
    @ ./src/entry.ts
   
   ERROR in ./src/ace-modes/dsql.js
   Module not found: Error: Can't resolve '../../lib/sql-docs' in '/Users/ashishkapoor/Downloads/druid-master/web-console/src/ace-modes'
    @ ./src/ace-modes/dsql.js 25:21-50
    @ ./src/entry.ts
   ```




----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@druid.apache.org
For additional commands, e-mail: commits-help@druid.apache.org


[GitHub] [druid] czyzykowski commented on a change in pull request #10357: [web-console] Update README.md

Posted by GitBox <gi...@apache.org>.
czyzykowski commented on a change in pull request #10357:
URL: https://github.com/apache/druid/pull/10357#discussion_r493473678



##########
File path: web-console/README.md
##########
@@ -25,7 +25,9 @@ This is the unified Druid web console that servers as a data management layer fo
 
 1. You need to be withing the `web-console` directory
 2. Install the modules with `npm install`
-3. Run `npm start` will start in development mode and will proxy druid requests to `localhost:8888`
+3. Run `npm run compile` to compile the scss files

Review comment:
       I can confirm that without running `npm run compile` `npm start` fails with the mentioned errors. And I do have Xcode.




----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@druid.apache.org
For additional commands, e-mail: commits-help@druid.apache.org


[GitHub] [druid] AshishKapoor commented on a change in pull request #10357: [web-console] Update README.md

Posted by GitBox <gi...@apache.org>.
AshishKapoor commented on a change in pull request #10357:
URL: https://github.com/apache/druid/pull/10357#discussion_r489570036



##########
File path: web-console/README.md
##########
@@ -25,7 +25,9 @@ This is the unified Druid web console that servers as a data management layer fo
 
 1. You need to be withing the `web-console` directory
 2. Install the modules with `npm install`
-3. Run `npm start` will start in development mode and will proxy druid requests to `localhost:8888`
+3. Run `npm run compile` to compile the scss files

Review comment:
       @suneet-s There you go! It works fine after a compile run as mentioned in the docs for me.
   
   ```
   WARNING in ./src/views/home-view/home-view.scss (./node_modules/css-loader/dist/cjs.js!./node_modules/postcss-loader/src??postcss!./node_modules/sass-loader/dist/cjs.js!./src/views/home-view/home-view.scss)
   Module Warning (from ./node_modules/postcss-loader/src/index.js):
   Warning
   
   (37:3) grid-gap only works if grid-template(-areas) is being used
    @ ./src/views/home-view/home-view.scss 1:14-193 20:4-31:5 23:25-204
    @ ./src/views/home-view/home-view.tsx
    @ ./src/views/index.ts
    @ ./src/console-application.tsx
    @ ./src/entry.ts
   
   ERROR in ./src/entry.scss (./node_modules/css-loader/dist/cjs.js!./node_modules/postcss-loader/src??postcss!./node_modules/sass-loader/dist/cjs.js!./src/entry.scss)
   Module build failed (from ./node_modules/sass-loader/dist/cjs.js):
   SassError: File to import not found or unreadable: ../lib/react-table.
           on line 22 of /Users/ashishkapoor/Downloads/druid-master/web-console/src/entry.scss
   >> @import '../lib/react-table';
   
      ^
   
    @ ./src/entry.scss 1:14-171 20:4-31:5 23:25-182
    @ ./src/entry.ts
   
   ERROR in ./src/views/query-view/query-input/query-input.tsx
   Module not found: Error: Can't resolve '../../../../lib/sql-docs' in '/Users/ashishkapoor/Downloads/druid-master/web-console/src/views/query-view/query-input'
    @ ./src/views/query-view/query-input/query-input.tsx 10:17-52
    @ ./src/views/query-view/query-view.tsx
    @ ./src/views/index.ts
    @ ./src/console-application.tsx
    @ ./src/entry.ts
   
   ERROR in ./src/ace-modes/dsql.js
   Module not found: Error: Can't resolve '../../lib/sql-docs' in '/Users/ashishkapoor/Downloads/druid-master/web-console/src/ace-modes'
    @ ./src/ace-modes/dsql.js 25:21-50
    @ ./src/entry.ts
   ```




----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@druid.apache.org
For additional commands, e-mail: commits-help@druid.apache.org


[GitHub] [druid] AshishKapoor commented on a change in pull request #10357: [web-console] Update README.md

Posted by GitBox <gi...@apache.org>.
AshishKapoor commented on a change in pull request #10357:
URL: https://github.com/apache/druid/pull/10357#discussion_r493661381



##########
File path: web-console/README.md
##########
@@ -25,7 +25,9 @@ This is the unified Druid web console that servers as a data management layer fo
 
 1. You need to be withing the `web-console` directory
 2. Install the modules with `npm install`
-3. Run `npm start` will start in development mode and will proxy druid requests to `localhost:8888`
+3. Run `npm run compile` to compile the scss files

Review comment:
       Please take a look at this one too. @vogievetsky 🙏🏼




----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@druid.apache.org
For additional commands, e-mail: commits-help@druid.apache.org


[GitHub] [druid] suneet-s commented on a change in pull request #10357: [web-console] Update README.md

Posted by GitBox <gi...@apache.org>.
suneet-s commented on a change in pull request #10357:
URL: https://github.com/apache/druid/pull/10357#discussion_r488025313



##########
File path: web-console/README.md
##########
@@ -25,7 +25,9 @@ This is the unified Druid web console that servers as a data management layer fo
 
 1. You need to be withing the `web-console` directory
 2. Install the modules with `npm install`
-3. Run `npm start` will start in development mode and will proxy druid requests to `localhost:8888`
+3. Run `npm run compile` to compile the scss files

Review comment:
       I don't remember having to do this step when I ran the web console locally. Can you describe what wasn't working with the instructions before this change




----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@druid.apache.org
For additional commands, e-mail: commits-help@druid.apache.org


[GitHub] [druid] AshishKapoor commented on a change in pull request #10357: [web-console] Update README.md

Posted by GitBox <gi...@apache.org>.
AshishKapoor commented on a change in pull request #10357:
URL: https://github.com/apache/druid/pull/10357#discussion_r490533718



##########
File path: web-console/README.md
##########
@@ -25,7 +25,9 @@ This is the unified Druid web console that servers as a data management layer fo
 
 1. You need to be withing the `web-console` directory
 2. Install the modules with `npm install`
-3. Run `npm start` will start in development mode and will proxy druid requests to `localhost:8888`
+3. Run `npm run compile` to compile the scss files

Review comment:
       That makes sense, thanks! @suneet-s.
   




----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@druid.apache.org
For additional commands, e-mail: commits-help@druid.apache.org


[GitHub] [druid] nishantmonu51 merged pull request #10357: [web-console] Update README.md

Posted by GitBox <gi...@apache.org>.
nishantmonu51 merged pull request #10357:
URL: https://github.com/apache/druid/pull/10357


   


----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@druid.apache.org
For additional commands, e-mail: commits-help@druid.apache.org


[GitHub] [druid] AshishKapoor commented on a change in pull request #10357: [web-console] Update README.md

Posted by GitBox <gi...@apache.org>.
AshishKapoor commented on a change in pull request #10357:
URL: https://github.com/apache/druid/pull/10357#discussion_r488031187



##########
File path: web-console/README.md
##########
@@ -25,7 +25,9 @@ This is the unified Druid web console that servers as a data management layer fo
 
 1. You need to be withing the `web-console` directory
 2. Install the modules with `npm install`
-3. Run `npm start` will start in development mode and will proxy druid requests to `localhost:8888`
+3. Run `npm run compile` to compile the scss files

Review comment:
       ```
   Build failed with error code: 1
   npm WARN optional SKIPPING OPTIONAL DEPENDENCY: fsevents@1.2.9 (node_modules/fsevents):
   npm WARN optional SKIPPING OPTIONAL DEPENDENCY: fsevents@1.2.9 install: `node install`
   npm WARN optional SKIPPING OPTIONAL DEPENDENCY: Exit status 1
   
   npm ERR! code ELIFECYCLE
   npm ERR! errno 1
   npm ERR! node-sass@4.13.1 postinstall: `node scripts/build.js`
   npm ERR! Exit status 1
   npm ERR! 
   npm ERR! Failed at the node-sass@4.13.1 postinstall script.
   npm ERR! This is probably not a problem with npm. There is likely additional logging output above.
   
   npm ERR! A complete log of this run can be found in:
   npm ERR!     /Users/ashishkapoor/.npm/_logs/2020-09-14T15_36_01_509Z-debug.log
   ➜  web-console 
   ```




----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@druid.apache.org
For additional commands, e-mail: commits-help@druid.apache.org


[GitHub] [druid] AshishKapoor commented on a change in pull request #10357: [web-console] Update README.md

Posted by GitBox <gi...@apache.org>.
AshishKapoor commented on a change in pull request #10357:
URL: https://github.com/apache/druid/pull/10357#discussion_r488034132



##########
File path: web-console/README.md
##########
@@ -25,7 +25,9 @@ This is the unified Druid web console that servers as a data management layer fo
 
 1. You need to be withing the `web-console` directory
 2. Install the modules with `npm install`
-3. Run `npm start` will start in development mode and will proxy druid requests to `localhost:8888`
+3. Run `npm run compile` to compile the scss files

Review comment:
       Wait, @suneet-s  Let me verify this again. I believe it's because there's no Xcode on the machine in use.




----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@druid.apache.org
For additional commands, e-mail: commits-help@druid.apache.org