The first PR to lovely Telescope

Picking the issue 

 After watching my professor's video A Tour of the Telescope Project and followed through Environment Setup documentation, finally I am able to setup Telescope on my machine successfully, and tried to do my first PR to Telescope project.

When I browsing the existing issue list, I found one Issue-1264 which mentioned in Week 7's video Fixing a bug in Telescope still there. I always afraid that I might fail to fix a back-end bug, so I have tried it before I  ask for the assignee. 

Fix the bug that the setting of LOG_LEVEL in .env is not working properly. Even set LOG_LEVEL=debug, npm start still print as LOG_LEVEL=info. 

Working on the issue

Firstly, I tested the bug by set LOG_LEVEL to debug in .env and confirmed that it only consoled the level of logs. Then I need to find which file consoled those logs. After scan over the back end files. I found logger.js inside utils folder is responded to consoling the  LOG_LEVEL.


require('../lib/config');

// Deal with log levels we don't know, or which are incorrectly formatted
let logLevel = (process.env.LOG_LEVEL || 'info').toLowerCase();
if (!pino.levels.values[logLevel]) {
  // Use `debug` by default in development mode, `info` otherwise.
  logLevel = process.env.NODE_ENV === 'development' ? 'debug' : 'info';
}


 I used console.log() to console process.env.LOG_LEVEL, it still prints "info". That means this file does not receive the setting from .env file. I treplaced require('../lib/config') to require('dotenv')config and it prints debug logs now.  

Sending the pull request

After my professor viewed my pull request, he pointed out that we do include the dotenv in lib/config. So there should be something wrong inside lib/config. Everything in lib/config looks fine. When I googled it, I Found a similar issue online. It says "By requiring .en config at the top,logger.ts will have theLOG_LEVELenvironment variable.".

After my testing, it works as long asdotenv.config()before logger dependency. I followed Professor Humphrey's  suggestion to rip theloggerdependency out of lib/config.js and use console.log() in lib/config file.


After everything is done, my pull request still blocked by failed the TravisCI issue and the macOS issue. I would take a look when I finish my other pull request, but I believed that someone else would pick them up and fixed them by the time. 




















Comments

Post a Comment

Popular posts from this blog

My third pull request for Hacktoberfest

Image
Picking the Issue Since I never deal with bugs for my first and second pull request, I decided to find a bug issue to work for my third pull request. The funny thing is that I just noticed that one of the contributors of my second PR's project  issue-collab  listed a bug about " Page not reloading after clicking next on pagination ". The owner of the repo wants someone to share a video/gif about the issue because he not really clear what the bug exactly is. I tried and uploaded the gif of the bug.  Then the owner reproduced it as following: Click Find Issues Scroll to bottom of page and click Next page Click Find Issues again (observe it doesn't work) Click Find Issues a second time (observe it loads the first page) I asked him assigned the issue to me and he did it immediately. Practice the git commands I checked the requirement of release 0.2, and I am able to work on at least 3 different repos for my PR. That means I can work on this repo twice plus 2 more differe...
Read more

OSD Lab3 Git Merge

Image
In this lab, I need to implement two additional feathers into my release 0.1 project --  urlStatusChecker . I am asked to do each of the feathers in its own branch and then merge them into my master branch in order to learn and get familiar with the git merge processes. I choose to add two of the following  features into my   urlStatusChecker : Add a  -j ,  --json , and/or  \j  flag, which causes the program to output JSON. The JSON output should look like  [ { url: 'https://www.google.com': status '200' }, { url: 'https://bad-link.com': status: '404' } ] Support  --all ,  --good , and  --bad  flags. The  --all  flag is the default, and if none of these are present, it will display good and bad URLs. The  --good  flag causes only good URLs to get displayed; the  --bad  flag causes only bad URLs to get displayed To begin with, I issued the two feathers that I wanted to add in my repository(...
Read more

My PR for release 0.3 External Project

Image
 Picking the issue I am so glad to hear that we are allowed to work on repositories that  we have already worked on in the past. That means we don't need to spend time on set it up and learn the code. I decide to work on  issue-collab  since I am so familiar with the repository. Different than any other issue I have work on, I filed the new issue-76 myself and tried to create a pull request for it. The issue I filed is that add a scroll to the top button. I am trying to add the scroll to the top button into this issue-collab repository just like the one in Telescope. The owner of Issue-collab thinks this is a good idea too. Working on the issue The first time when I tried to work on it, I just tried to study the code from Telescope and some from google and playing the code around. I was so annoying that I can't put some code together successfully in React. After watched some React video, I realized that there are two different components which are Class compone...
Read more