jxmot/github-feeds

This repository contains a "GitHub Feed" browser plug-in.

jxmot

github-feeds's Issues

Github repo description breaks jQuery

jQuery will crash when a github repository description contains any tag. For example:

A PHP script that reads an HTML file, finds all <link> and <script> tags. The local files that are referenced in those tags are concatenated into single CSS and JS files.

Will cause the crash, it's because that text will be embedded into HTML. And the $().html() that used for rendering will see them and try to resolve the tags.

It's unfortunate that jQuery does not provide any usable information. It only says Uncaught SyntaxError: Unexpected identifier.

Investigate data file problems

It seems that retrieving the JSON data locally (anti rate limiting) takes more time than getting the data directly from GitHub.

There is no obvious cause, but the delay is noticeable at 5 to ~15 seconds.

a) Try to find the cause, it's likely something strange on the server.
b) Try to determine where the slow down is happening, could be one or more of:

• Getting the PHP file (gfapi/index.php)
• Getting the JSON data file, one of them is about 360k. It should not matter.

Investigate Repository Topics

Investigate the worth and effort for:

• Collecting repo.topics[] items into a master associative array. And use the topic text as the key and keep a "topic occurrence" count in each.
• Create a function that returns the topic array

README update

update README to match changes

Investigate activity time "ago" updates

Determine effort to update the "time ago" fields in the entries within the activity tab. An update interval of ~5min may be sufficient.

Some repository descriptions are "null"

Detect descriptions that are null and replace with No Description Provided.

Fix renderMD()

The renderMD() function in utils.js needs the string.replace() calls fixed. They should be using regex to replace all occurrences or be changed to replaceAll().

Need to render markdown

Github accepts markdown formatting in issues, and renders on site. Add the ability to do this in the activity entries only.

• determine if there is a minimal markdown to render:
  • back-ticks - convert to and sanitize any embedded html
  • convert "\n" to
    
  • convert "\r" to nothing
  • TBD

Replace Gists tab with...

Potential candidates:

• Starred Repos - use https://api.github.com/users/{user}/starred?per_page=100, add data gather to CRON task
• Following -
• TBD

Github data pagination

It might be necessary to handle "paging" when getting responses from Github. This will not occur if the anti rate limiting feature is being used.

In regards to the bash scripts curl does not understand Github's pagination. Currently we can get only up to 100 repositories, beyond that won't be accessible.

If requests go direct to Github then pagination might be necessary.

// example
nextUrl = ajx.getAllResponseHeaders().match(/<(.*)>; rel="next"/);

Markdown render in repo comments bug

In /assets/js/util.js:renderMD() an error occurs with the backtick. In some cases the rendering gets confused and misses a backtick.

Observe how issue #20 displays the comments. The issue will be seen there.

Mobile Browser(all) Issues

• light/dark switch is not visible, will need to move it.
• Can't bust through the browsers' cache. The won't get new content even after it has changed on the server.

Improve "waiting for non-zero " code

index.php has this loop:

    // if the file is being updated its length
    // will be 0. What until the update is done.
    while(filesize($datafile) === 0) {
        sleep(3);
        clearstatcache();
        error_log('github-feeds: waiting for non-zero :'.$datafile,0);
    }
    $fileid = fopen($datafile,'r');

During certain GitHub API issues (responses are taking to much time) the file will remain at zero-length almost indefinitely. There needs to be a limitation on the loop so that it will generate an error w/o causing much disturbance to the client.

The zero-length file is created by the curl calls in the API scripts. This is because the curl command has its output captured and redirected to a file. That file is recreated each time so it's length will be zero until GitHub sends a response.

In github-feed.js improve handling of options

Combine the arguments and the local variable "options" into a single object. It will replace the arguments.

Mobile browsers: light/dark switch is not visible

It's there, it's just moved out of the way in portrait view. One possible solution would be to change the CSS of the header to use CSS grid.

Add "PullRequestEvent"

"PullRequestEvent" is missing from ibacor_activs()

Investigate using the GitHub API V4 (GraphQL)

Replace all V3 with V4 requests:

• can retrieve info that is grouped better than V3, typically the size of the data returned with V4 is measurably smaller than with V3.
• every request is a POST and requires an auth token
• try replicating the V3 requests used with V4, test with Postman
• reference - https://docs.github.com/en/graphql
• using curl - https://stackoverflow.com/questions/42021113/how-to-use-curl-to-access-the-github-graphql-api

Investigate repo filtering

Investigate whether or not there is value in filtering out specified repos from the list.

Repository Names

Investigate if repository names can contain spaces. If so then check all code that touches the repository name.

If issues are found fix them.

Repo activity is interpreted incorrectly

When a repo is starred (or forked?) then it will appear in [OWNER]repos.json. However there is nothing that the repository record contains that will indicate that either has occurred.

Fix "to top"

The "to top" button does not work correctly when there are 2 feeds (two usernames). This is because there is only one instance and the last "to top" button enabled will have precedence.

Add a dark theme

Using github-feed-default.css as a starting point create github-feed-dark.css and modify the colors for a "dark" theme.

1. Add a "switch" in the feed header to select dark/light themes
2. TBD

Filter repo events

Repositories that are low priority, or are old but receive occasional maintenance are showing in the list.

• gfapi/index.php and gfapi/filter.php - add filterEvents(), it will operate identically to filterRepos(). This will limit events to only repos that are enabled in gfapi/filter.json.

Repo events fail to render

Some "PushEvent" events do not contain any event.payload.commits[]. This causes a failure due to an "undefined" when accessing a item in event.payload.commits[X].

• github-feeds.js - in events() when event.type == "PushEvent" test event.payload.commits.length for 0 and do nothing if true.

Rename functions in github-feed.js

• ibacor_profil() -> profile()
• ibacor_repos() -> repos()
• ibacor_activs() -> events()
• ibacor_gists() -> gists()

Light/Dark switch icons

The light/dark switch icons (🌞 and 🌜) won't display on older(?) browsers.

Evaluate the effort of changing to something more "generic".

Mobile Browser(FireFox) Issues

The Firefox Android browser is a failure. Will need to add:

• browser detection
• adjustments to CSS based on the browser used.
• TBD