Giter Club home page Giter Club logo

grunt-perfbudget's Introduction

What is Octopress?

Octopress is Jekyll blogging at its finest.

  1. Octopress sports a clean responsive theme written in semantic HTML5, focused on readability and friendliness toward mobile devices.
  2. Code blogging is easy and beautiful. Embed code (with Solarized styling) in your posts from gists, jsFiddle or from your filesystem.
  3. Third party integration is simple with built-in support for Twitter, Pinboard, Delicious, GitHub Repositories, Disqus Comments and Google Analytics.
  4. It's easy to use. A collection of rake tasks simplifies development and makes deploying a cinch.
  5. Ships with great plug-ins some original and others from the Jekyll community — tested and improved.

Documentation

Check out Octopress.org for guides and documentation.

Contributing

We love to see people contributing to Octopress, whether it's a bug report, feature suggestion or a pull request. At the moment, we try to keep the core slick and lean, focusing on basic blogging needs, so some of your suggestions might not find their way into Octopress. For those ideas, we started a list of 3rd party plug-ins, where you can link your own Octopress plug-in repositories. For the future, we're thinking about ways to easier add them them into our main releases.

License

(The MIT License)

Copyright © 2009-2011 Brandon Mathis

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the ‘Software’), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED ‘AS IS’, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

If you want to be awesome.

  • Proudly display the 'Powered by Octopress' credit in the footer.
  • Add your site to the Wiki so we can watch the community grow.

grunt-perfbudget's People

Contributors

fitsallun avatar jmtavares avatar mavrck avatar snyk-bot avatar tkadlec avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

grunt-perfbudget's Issues

Make a release

Hey guys,

Can you please make a release? The last was made 1 year ago.

Cheers,
João

Unit tests

Need to get some unit tests up and running.

Number of runs

Hello,

I have a question about "runs", and depending on the answer we can either enhance the documentation, or make a feature enhancement.

Question: If I specify a speedIndex budget of 1000 and runs of 5, does it perform 5 runs and then check that the average is <= 1000? If so, we should update the documentation to specify that the number of runs is used to compute an average. If not, I'd like to make that a feature request, as the averaging will remove some noise.

Also - It would be nice to have a max value for the budget items. For example "ignore all results where the render time is >= 5000" if I know that is an unreasonable value. That or some other way to remove erroneous results.

Thanks!

Stepping through the documentation

I'm new to Grunt. I'm missing something. Seems like I've got a Gruntfile.js & package.json in a directory.

npm = v6.4.1

The Gruntfile.js is the text from your example with my API key.

I get this:
$ npm install
npm WARN [email protected] requires a peer of grunt@>=0.4.0 but none is installed. You must install peer dependencies yourself.
npm WARN [email protected] No description
npm WARN [email protected] No repository field.

audited 264 packages in 1.339s
found 0 vulnerabilities

Mikes-MacBook-Pro-2:Grunt mikegifford$ grunt
Loading "Gruntfile.js" tasks...ERROR

SyntaxError: Unexpected token default
Warning: Task "default" not found. Use --force to continue.

Aborted due to warnings.

Support for Multiple Tests

My particular use case involves running several tests for various types of pages as opposed to testing a single url. I'm not sure what the best way to implement this would be, but I'm envisioning something like:

perfbudget: {
    default: {
        options: {
            url: 'http://google.com',
            key: 'YOUR_KEY_HERE',
            paths: [
                '/',
                '/category',
                '/category/item'
            ]
        }
    }
}

Where the plugin would iterate over the paths provided, append them to the base URL, and kick off a test for each of the full URLs created.

Paths would be an optional parameter, and when not specified the plugin would default to the current behavior.

Update README

'Cuz it is pretty sparse there right now and people have a right to know WTH they need to do. Am I right?

First vs Repeat view

Add support for an configuration option that specified whether the budget applies to the first view or the repeat view. Right now it seems to only apply to first view

Test pending... timeout

I'd like to be able to specify a timeout for "Test pending...". I launched a test about 5-10 minutes ago, and it still says "Test pending..."

task fails due to webpagetest.org running under SSL

Hey,
I'm experiencing 301 redirect messages for some weeks now. First I wondered whether my local credentials or redirects would be wrong but it turned out that inside the plugin all calls to webpagetest.org are made with HTTP calls. As the domain is delivered via SSL I changed all occurences in /lib to https and it worked again. So maybe you want to have a look into it?

Standalone node module

It would be great if this was its own module, without the Grunt dependency. It could be then used as is or other modules could be created to simply wrap it in code specific to any build system (Grunt, Gulp, Broccoli, etc.), if even required. Take most Gulp plugins for example; they're only about 20 something lines long and there are plenty modules out there that are compatible with Gulp without any effort, see gulp-browser-sync. Overall, it would make this much more usable / pluggable and accessible.

Support of Grunt 1.0.x

Hi :)

Thank you a lot for this awesome grunt task ! 👍

Do you plan the support of Grunt 1.0.x ?

Thank you :)

Suggestions for how to work this into a dev workflow?

Hey Tim,

So I got this running on a project that typically scores anywhere from a 500 to a 1100 Speed Index (with Dulles Chrome selected in the Web interface of WPT).

Running it via this task seems to produce widely varying results, and so far, I've yet to reproduce a speed index lower than 1100, after 5 tries (again, I'm using 'Dulles:Chrome' for the location option). I'm not sure if this is a bug or a network fluctuation issue. Could be nothing at all. Figured I'd note it.

More broadly, with this test failing frequently on an unchanged codebase that sometimes passes our budget (say, a 1000 speed index) but often fails, I wonder how to include it in our workflow. Running it post-commit seems like an option, maybe with some help from Jenkins to report back the most recent runs (ala https://github.com/scottjehl/picturefill#picturefill)?

Maybe having something like this in our readme.md would be a good way to work this in? "Last time the performance budget was checked, this project was over budget. Details | Run again"

Anyway we're curious how you envision including this into your workflow.

Great work, once again. This is awesome.

incorrect url for results of timed out test

>> Test 141106_F3_6 has timed out. You can still view the results online at http://servername/result/141106_F3_6.

a working results url is reported for the summary:

>> Summary: http://servername/results.php?test=141106_DB_7

HTTP auth?

We typically run webpagetest.org with authentication. Is it possible to do that with this yet, or do we need to figure out an extension?

Thanks!

Save test data

Should allow folks to save the test data locally so they can analyze.

Reducing need for WPT API keys

Using grunt-perfbudget at the moment requires either a private instance of WebPageTest or an API key. The private instance is awesome, but WPT isn't exactly plug-and-play which is a barrier for many, particularly if the primary use is for budgeting.

The public key is great, but it does require emailing to request it, and then that key is only good for 200 page loads per day. Each run, both first and repeat views, count as a page load (10 runs, first and repeat view = 20 page loads). Depending on how you're budgeting and how many pages you're testing, that may or may not be enough. In addition, this slows down setup (as noted here: http://cognition.happycog.com/article/grunt-plugins-reviewed).

I was talking to @pmeenan about finding ways to simplify and speed up the process by removing the API key step. His suggestion was to perhaps allow the option for people to use AWS to accomplish the same thing. Basically, we could have a micro instance with WPT on it, as well as pre-configured agents. grunt-perfbudget would accept your Amazon API key, spin up the instances, and run the tests.

There'd be a minor cost associated through Amazon but you'd no longer have to get a WPT API key for each project, it would potentially speed up the time needed for setup, and it would also kill the daily load limit.

Good idea? Bad? Got a better one?

running all tests even if some fail

per
gruntjs/grunt#1163
seems like this is a grunt issue/discussion, question here is whether it is worth putting in a specific fix here until grunt provides the needed functionality.
note the need for non zero exit code also.

currently we can't both run all the tests to capture the data in a systematic way and exit with a non zero exit code if any one test failed.

expose tsviewdb options to persist data

similar #3 but different in terms of reusing what is already there, albeit tied to a particular timeseries database that is not currently maintianed or supported, and pending fixes until WPT 2.16 is released

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.